=-----
LGrind - a source pretty printer for LaTeX
=-----

This directory contains:
^^^^^^^^^^^^^^^^^^^^^^^^
lgrind.ins	DocStrip driver
lgrind.dtx	Documented package
lgrind.gls	Glossary and index for the documentation (for the ones with-
lgrind.ind	out MakeIndex, and because it had to be modified by hand)
lgrindef	The language definition file

In the directory 'source': (not needed by DOS users)
lgrind.c	The source code for the LGrind executable
lgrindef.c
lgrindef.h
regexp.c
regexp.h
v2lg.c		Source code for verbatim to embedded source converter
retest.c	Test program for the regular expression routines
lgrind.1	Man-pages for the LGrind program
lgrindef.5		  and the language definition file
Makefile	Makefile for UN*X
makefile.dos	Makefile for MS-DOS (Borland C++, should work with everything)
makefile.emx	Makefile for use with DMAKE

In the directory 'dos': (not needed by non-DOS users)
lgrind.exe	The executable for MS-DOS and OS/2
c2tex.bat	Example batch files for facilitating calls to LGrind
masm2tex.bat
egcprog.c, egmasm.asm
egcprog.lg, egmasm.lg	Example sources and their LGrind-equivalents
lgrindeg.tex	Example making use of the above


What you need:
^^^^^^^^^^^^^^
- lgrind	(or lgrind.exe for MS-DOS and OS/2) just where you like it
- lgrind.sty	somewhere in LaTeXs reach
- lgrindef 	anywhere; (position is semi-fixed in the executable)
- LaTeX2e	the obsolete LaTeX 2.09 is not supported
- LGrind utilizes by default the fancyhdr package by Piet van Oostrum. You
  can change this behaviour by modifying the lgrindef file.


How to get the files:
^^^^^^^^^^^^^^^^^^^^^
- If you have MS-DOS, your executable is provided. If not, all the source
  files are in the source directory, a makefile provided.
- Run LaTeX or PlainTeX on lgrind.ins. You will obtain lgrind.sty.


Er, mmmmh, documentation?
^^^^^^^^^^^^^^^^^^^^^^^^^
Of course. A lot. Took me days. Run LaTeX on lgrind.dtx and the result is
lgrind.dvi. If you don't want the documentation about all
internal stuff, run LaTeX on something like
\documentclass{ltxdoc}
\OnlyDescription
\DocInput{lgrind.dtx}
\end{document}
To right the wrong impression: parts of the documentation have been written
by my predecessors, my thanks to them.

Michael Piefel
piefel@cs.tu-berlin.de
