source: git/doc/lib2doc.texi @ 2e0b620

jengelh-datetimespielwiese
Last change on this file since 2e0b620 was 2e0b620, checked in by Olaf Bachmann <obachman@…>, 24 years ago
* small changes as we go along git-svn-id: file:///usr/local/Singular/svn/trunk@3396 2c84dea3-7e68-4137-9b89-c4e89433aadc
  • Property mode set to 100644
File size: 2.2 KB
Line 
1@ifclear singularmanual
2This is the README file for lib2doc.
3@end ifclear
4
5@code{lib2doc} is a utility to generate the stand-alone documentation for
6a @sc{Singular} library in various formats.
7
8The @code{lib2doc} utility should be used by developers of @sc{Singular}
9libraries to check the generation of the documentation of their
10libraries.
11
12@code{lib2doc} can be downloaded from
13@url{ftp:/www.mathematik.uni-kl.de/pub/Math/Singular/Misc/lib2doc.tar.gz}
14
15
16@strong{Important:}
17@*To use @code{lib2doc}, you need
18to have @code{perl} (version 5 or
19higher), @code{texinfo} (version 3.12 or higher)  and @code{Singular}
20and @code{libparse} (version 1-3-4 or higher) installed on your system.
21
22To generate the documentation for a library, follow these steps:
23@enumerate
24@item
25Unpack lib2doc.tar.gz
26@smallexample
27gzip -dc  lib2doc.tar.gz | tar -pxf-
28@end smallexample
29and
30@smallexample
31cd lib2doc
32@end smallexample
33
34@item
35Edit the beginning of the file @code{Makefile}, filling in the values for
36@code{SINGULAR} and @code{LIBPARSE}. Check also the values of @code{PERL}
37and @code{LATEX2HTML}.
38
39@item
40Copy your library to the current directory:
41@smallexample
42cp <path-where-your-lib-is>/mylib.lib .
43@end smallexample
44
45@item
46Now you can run the following commands:
47@table @code
48@item make mylib.hlp
49Generates the file @code{mylib.hlp} -- the info file for the documentation
50of @code{mylib.lib}. This file can be viewed with
51@smallexample
52info -f mylib.hlp
53@end smallexample
54@item make mylib.dvi
55Generates the file @code{mylib.dvi} -- the dvi file for the documentation
56of @code{mylib.lib}. This file can be viewed with
57@smallexample
58xdvi mylib.dvi
59@end smallexample
60@item make mylib.ps
61Generates the file @code{mylib.ps} -- the PostScript file for the documentation
62of @code{mylib.lib}. This file can be viewed with (for example)
63@smallexample
64ghostview mylib.dvi
65@end smallexample
66@item make mylib.html
67Generates the file @code{mylib.html} -- the HTML file for the documentation
68of @code{mylib.lib}. This file can be viewed with (for example)
69@smallexample
70netscape mylib.html
71@end smallexample
72@item make clean
73Deletes all generated files.
74@end table
75
76
77Note that you can safely ignore messages complaining about undefined
78references. 
79
80@end enumerate
81
Note: See TracBrowser for help on using the repository browser.