14 .TH ROBODoc "1" "Jul 2006" "ROBODoc 4.99.28"
17 ROBODoc \- Extract documentation from source code.
29 ROBODoc extracts specially formated documentation from the source code.
30 It allows you to maintain a program and its documentation in a single
36 Show the copyright message.
39 Use ANSI C grammar in SOURCE items and use this for some syntax
40 highlighting (HTML only).
43 Define the documentation directory or documentation file.
44 A directory should start with a '/' or a './' and
45 should not include any '..'.
48 Define the source directory or source file. A directory should start
49 with a '/' or a './' and should not include any '..'.
52 Generate documentation in ASCII format.
55 Generate documentation in HTML format.
58 Use to content of the specified file to create the
60 The content of the file is copied into
64 Generate documentation in XML DocBook format.
67 Generate documentation in LaTeX format.
70 Generate documentation in RTF format.
73 Create an additional master index file.
76 Store all documentation in seperate files.
79 Store all documentation in a single file.
82 Generate a single document from a single file
85 Add a table of contents. This works in multidoc mode as well as singledoc mode.
88 Also include headers marked internal.
91 Only include headers marked internal.
93 .IP --ignore_case_when_linking
94 Ignore the case of the symbols when trying to find crosslinks.
95 In this mode FOO and Foo will be linked to foo.
98 Do not create the food of a document.
101 Do not create the head of a document.
106 locks on the first headermarker it finds and will recognize only that
107 particular headermarker for the remaining part of the file. In addition
108 it locks on the first remark marker in each header and will recognize
109 only that particular remark marker for the remaining part of the header.
112 Do not include the SOURCE items.
115 Do not scan any subdirectories, scan only the top level directory
119 Do not use <PRE> and </PRE> in the HTML output, instead based on
120 the layout of the text create paragraphs, item lists, and
121 preformatted sections.
124 Use the specified file instead of
126 Note that definitions in a configuration file over-ride
130 Create sections based on the module hierarchy.
133 Lets you specify the tabsize.
137 tells you about every step it takes.
140 Print version information and exit.
145 robodoc --src ./ --doc myproject --singledoc --html
148 Creates a document called myproject.html from all source files
149 in the current directory.
152 robodoc --src ./myproject/
153 --doc ./myprojectdoc --multidoc --html --index
156 Creates seperate documents for all the source files found in
157 the directory ./myproject they are stored in the directory ./myprojectdoc.
158 A master index file called ./myprojectdoc/masterindex.html is also
159 created. This provides links to all the individual files.
162 .SS "Example headers"
165 \fI@prefix@/share/doc/robodoc/Examples\fR
170 Copyright \(co 1994-2003 Frans Slothouber, Petteri Kettunen, and Jacco van Weert.
173 This is free software; see the source for copying conditions. There is NO
174 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
178 Frans Slothouber, Jacco van Weert, Petteri Kettunen, Bernd Koesling,
179 Thomas Aglassinger, Anthon Pang, Stefan Kost, David Druffner, Sasha Vasko,
180 Nathan Prewitt and Dennis Stampfer.
184 The documentation in HTML format that comes with ROBODoc. Latest
185 version can be found from http://www.xs4all.nl/~rfsber/Robo/ or from
186 http://sourceforge.net/projects/robodoc/.