| 1 | @ifclear singularmanual |
|---|
| 2 | This is the README file for lib2doc. |
|---|
| 3 | @end ifclear |
|---|
| 4 | |
|---|
| 5 | @code{lib2doc} is a utility to generate the stand-alone documentation for |
|---|
| 6 | a @sc{Singular} library in various formats. |
|---|
| 7 | |
|---|
| 8 | The @code{lib2doc} utility should be used by developers of @sc{Singular} |
|---|
| 9 | libraries to check the generation of the documentation of their |
|---|
| 10 | libraries. |
|---|
| 11 | |
|---|
| 12 | @code{lib2doc} can ve 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 |
|---|
| 18 | to have @code{Singular}, @code{libparse}, and @code{perl} (version 5 or |
|---|
| 19 | higher) installed on your system. |
|---|
| 20 | |
|---|
| 21 | |
|---|
| 22 | To generate the documentation for a library, follow these steps: |
|---|
| 23 | @enumerate |
|---|
| 24 | @item |
|---|
| 25 | Unpack lib2doc.tar.gz |
|---|
| 26 | @smallexample |
|---|
| 27 | gzip -dc lib2doc.tar.gz | tar -pxf- |
|---|
| 28 | @end smallexample |
|---|
| 29 | and |
|---|
| 30 | @smallexample |
|---|
| 31 | cd lib2doc |
|---|
| 32 | @end smallexample |
|---|
| 33 | |
|---|
| 34 | @item |
|---|
| 35 | Edit 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} |
|---|
| 37 | and @code{LATEX2HTML}. |
|---|
| 38 | |
|---|
| 39 | @item |
|---|
| 40 | Copy your library to the current directory: |
|---|
| 41 | @smallexample |
|---|
| 42 | cp <path-where-your-lib-is>/mylib.lib . |
|---|
| 43 | @end smallexample |
|---|
| 44 | |
|---|
| 45 | @item |
|---|
| 46 | Now you can run the following commands: |
|---|
| 47 | @table @code |
|---|
| 48 | @item make mylib.hlp |
|---|
| 49 | Generates the file @code{mylib.hlp} -- the info file for the documentation |
|---|
| 50 | of @code{mylib.lib}. This file can be viewed with |
|---|
| 51 | @smallexample |
|---|
| 52 | info -f mylib.hlp |
|---|
| 53 | @end smallexample |
|---|
| 54 | @item make mylib.dvi |
|---|
| 55 | Generates the file @code{mylib.dvi} -- the dvi file for the documentation |
|---|
| 56 | of @code{mylib.lib}. This file can be viewed with |
|---|
| 57 | @smallexample |
|---|
| 58 | xdvi mylib.dvi |
|---|
| 59 | @end smallexample |
|---|
| 60 | @item make mylib.ps |
|---|
| 61 | Generates the file @code{mylib.ps} -- the PostScript file for the documentation |
|---|
| 62 | of @code{mylib.lib}. This file can be viewed with (for example) |
|---|
| 63 | @smallexample |
|---|
| 64 | ghostview mylib.dvi |
|---|
| 65 | @end smallexample |
|---|
| 66 | @item make mylib.html |
|---|
| 67 | Generates the file @code{mylib.html} -- the HTML file for the documentation |
|---|
| 68 | of @code{mylib.lib}. This file can be viewed with (for example) |
|---|
| 69 | @smallexample |
|---|
| 70 | netscape mylib.html |
|---|
| 71 | @end smallexample |
|---|
| 72 | @item make clean |
|---|
| 73 | Deletes all generated files. |
|---|
| 74 | @end table |
|---|
| 75 | |
|---|
| 76 | |
|---|
| 77 | Note that you can safely ignore messages complaining about undefined |
|---|
| 78 | references. |
|---|
| 79 | |
|---|
| 80 | @end enumerate |
|---|
| 81 | |
|---|
