|  3.8.9 Documentation Tool 
lib2docis a utility to generate the stand-alone documentation for
a SINGULAR library in various formats. 
The lib2docutility should be used by developers of SINGULAR
libraries to check the generation of the documentation of their
libraries. 
lib2doccan be downloaded fromftp://www.mathematik.uni-kl.de/pub/Math/Singular/misc/lib2doc.tar.gz
 
Important:
To use
 lib2doc, you need
to haveperl(version 5 or
higher),texinfo(version 3.12 or higher)  andSingularandlibparse(version 1-3-4 or higher) installed on your system. 
To generate the documentation for a library, follow these steps:
 
Unpack lib2doc.tar.gz
and|  | gzip -dc  lib2doc.tar.gz | tar -pxf -
 | 
 
Edit the beginning of the file Makefile, filling in the values forSINGULARandLIBPARSE. Check also the values ofPERLandLATEX2HTML.
Copy your library to the current directory:
|  | cp <path-where-your-lib-is>/mylib.lib .
 | 
 
Now you can run the following commands:
make mylib.hlpGenerates the file mylib.hlp-- the info file for the documentation
ofmylib.lib. This file can be viewed usingmake mylib.dviGenerates the file mylib.dvi-- the dvi file for the documentation
ofmylib.lib. This file can be viewed usingmake mylib.psGenerates the file mylib.ps-- the PostScript file for the documentation
ofmylib.lib. This file can be viewed using (for example)make mylib.htmlGenerates the file mylib.html-- the HTML file for the documentation
ofmylib.lib. This file can be viewed using (for example)make cleanDeletes all generated files.
 
Note that you can safely ignore messages complaining about undefined
references.
 
 
 |