summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/tclldoc/examples/README.txt
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/tclldoc/examples/README.txt
Initial commit
Diffstat (limited to 'macros/latex/contrib/tclldoc/examples/README.txt')
-rw-r--r--macros/latex/contrib/tclldoc/examples/README.txt40
1 files changed, 40 insertions, 0 deletions
diff --git a/macros/latex/contrib/tclldoc/examples/README.txt b/macros/latex/contrib/tclldoc/examples/README.txt
new file mode 100644
index 0000000000..2d3d8abe5d
--- /dev/null
+++ b/macros/latex/contrib/tclldoc/examples/README.txt
@@ -0,0 +1,40 @@
+README for the parsetcl and writepdf packages:
+==============================================
+
+The parsetcl package implements basic parsing
+of Tcl scripts, and is written completely in
+Tcl. To generate parsetcl.tcl, run LaTeX on
+parsetcl.ins. To typeset the documentation,
+run LaTeX on parsetcl.dtx. To see an example
+of what it does, you can try the following
+commands in a Tcl shell:
+
+ source parsetcl.tcl
+ auto_load parray
+ set tree [parsetcl::simple_parse_script [info body parray]]
+ parsetcl::format_tree $tree {} { }
+
+The tree variable will be set to a parser tree
+for the body of the parray procedure. The last
+command reformats this tree (mostly replacing
+whitespace between list elements) to make the
+structure more visible.
+
+
+The writepdf package is written completely in
+Tcl and provides basic commands for writing
+well-formed PDF files. To generate writepdf.tcl,
+run LaTeX on pdf.ins. To typeset the
+documentation, run LaTeX on pdf.dtx. To see an
+example of what it does, you can try the following
+commands in a Tcl shell:
+
+ source writepdf.tcl
+ source hellopdf.tcl
+
+This will generate a file hello.pdf that contains
+a single page with the two words "Hello world!".
+
+
+Lars Hellström,
+20 July 2003