source: git/doc/lib2doc.texi @ 26644b1

@ifclear singularmanual
This is the README file for lib2doc.
@end ifclear

@code{lib2doc} is a utility to generate the stand-alone documentation for
a @sc{Singular} library in various formats.

The @code{lib2doc} utility should be used by developers of @sc{Singular}
libraries to check the generation of the documentation of their
libraries.

@code{lib2doc} can be downloaded from @*
@url{ftp://www.mathematik.uni-kl.de/pub/Math/Singular/misc/lib2doc.tar.gz}


@strong{Important:}
@*To use @code{lib2doc}, you need
to have @code{perl} (version 5 or
higher), @code{texinfo} (version 3.12 or higher)  and @code{Singular}
and @code{libparse} (version 1-3-4 or higher) installed on your system.

To generate the documentation for a library, follow these steps:
@enumerate
@item
Unpack lib2doc.tar.gz
@smallexample
gzip -dc  lib2doc.tar.gz | tar -pxf -
@end smallexample
and
@smallexample
cd lib2doc
@end smallexample

@item
Edit the beginning of the file @code{Makefile}, filling in the values for
@code{SINGULAR} and @code{LIBPARSE}. Check also the values of @code{PERL}
and @code{LATEX2HTML}.

@item
Copy your library to the current directory:
@smallexample
cp <path-where-your-lib-is>/mylib.lib .
@end smallexample

@item
Now you can run the following commands:
@table @code
@item make mylib.hlp
Generates the file @code{mylib.hlp} -- the info file for the documentation
of @code{mylib.lib}. This file can be viewed using
@smallexample
info -f mylib.hlp
@end smallexample
@item make mylib.dvi
Generates the file @code{mylib.dvi} -- the dvi file for the documentation
of @code{mylib.lib}. This file can be viewed using
@smallexample
xdvi mylib.dvi
@end smallexample
@item make mylib.ps
Generates the file @code{mylib.ps} -- the PostScript file for the documentation
of @code{mylib.lib}. This file can be viewed using (for example)
@smallexample
ghostview mylib.dvi
@end smallexample
@item make mylib.html
Generates the file @code{mylib.html} -- the HTML file for the documentation
of @code{mylib.lib}. This file can be viewed using (for example)
@smallexample
firefox mylib.html
@end smallexample
@item make clean
Deletes all generated files.
@end table


Note that you can safely ignore messages complaining about undefined
references.

@end enumerate