README
1=-----
2LGrind - a source pretty printer for LaTeX
3=-----
4Version 3.67
5
6Welcome to LGrind. LGrind is a descendant of the Unix utility vgrind. It is
7used to produce a beautified version of your source code using LaTeX. Unlike
8other packages this is not pure TeX but an external preprocessor. You run e.g.
9 lgrind example.c > example.tex
10 latex example.tex
11to get a complete listing. Options for producing includable files and pro-
12cessing embedded listings in LaTeX texts are provided.
13
14
15What you need: (Installation part 2)
16^^^^^^^^^^^^^^
17- lgrind (or lgrind.exe) just where you like it
18- lgrind.sty somewhere in LaTeXs reach
19- lgrindef anywhere; (position is semi-fixed in the executable)
20- LaTeX2e the obsolete LaTeX 2.09 is not supported
21- LGrind utilizes by default the fancyhdr package by Piet van Oostrum. You
22 can change this behaviour by modifying the lgrindef file.
23
24
25How to get these files: (Installation part 1)
26^^^^^^^^^^^^^^^^^^^^^^^
27- If your executable is not provided, all the source files are in the source
28 directory, a makefile provided.
29- Run LaTeX or TeX on lgrind.ins. You will obtain lgrind.sty.
30- Or simply run make in the top directory. This also gives lgrind.sty
31
32
33Documentation
34^^^^^^^^^^^^^
35Main documentation is in lgrind.dtx. Run LaTeX on lgrind.dtx and the result is
36lgrind.dvi. There are also manpages lgrind.1 and lgrindef.5 for people who
37prefer those, but notice that I am not always able to keep them up to date.
38To right the wrong impression: parts of the documentation have been written
39by my predecessors, my thanks to them.
40
41
42
43Files in the directories:
44^^^^^^^^^^^^^^^^^^^^^^^^^
45lgrind.ins DocStrip driver
46lgrind.dtx Documented package
47lgrind.gls Glossary and index for the documentation (for the ones with-
48lgrind.ind out MakeIndex, and because it had to be modified by hand)
49lgrindef The language definition file
50
51
52In the directory 'source':
53lgrind.c The source code for the LGrind executable
54lgutil.c
55lgrindef.c
56lgrindef.h
57regexp.c
58regexp.h
59v2lg.c Source code for verbatim to embedded source converter
60retest.c Test program for the regular expression routines
61lgrind.1 Man-pages for the LGrind program
62lgrindef.5 and the language definition file
63Makefile Makefile for Unices
64makefile.dos Makefile for MS-DOS (not tested anymore)
65makefile.emx Makefile for use with DMAKE
66
67
68In the directory 'example':
69c2tex.bat Example batch files for facilitating calls to LGrind
70asm2tex.bat
71c2tex ditto as Bourne shell scripts
72asm2tex
73egmasm.asm Example sources
74egcprog.c
75subst Example substitution file
76lgrindeg.tex Example making use of the above
77
78
79
80Comments, contributions, questions and cheques
81^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
82LGrind contains non-free code written by Van Jacobson, who does not answer
83to any request for changing his licence. This software is therefore not
84maintained. I also do not accept any cheques anymore.
85
86Have Fun!
87
88