1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
.de EX \"Begin example
.ne 5
.if n .sp 1
.if t .sp .5
.nf
.in +.5i
..
.de EE
.fi
.in -.5i
.if n .sp 1
.if t .sp .5
..
.TH ROBODoc "1" "January 2004" "ROBODoc 4.0.18"
.SH NAME
ROBODoc \- Extract documentation from source code.
.SH SYNOPSIS
.B robodoc
.I --src
<source>
.I --doc
<destination>
.B [options]
.SH DESCRIPTION
ROBODoc extracts specially formated documentation from the source code.
It allows you to maintain a program and its documentation in a single
file.
.SH OPTIONS
.IP --ascii
Generate documentation in ASCII format.
.IP --doc
Define the documentation directory or documentation file.
A directory should start with a '/' or a './' and
should not include any '..'.
.IP --html
Generate documentation in HTML format.
.IP --index
Create an additional master index file.
.IP --latex
Generate documentation in LaTeX format.
.IP --multidoc
Store all documentation in seperate files.
.IP --rtf
Generate documentation in RTF format.
.IP --singledoc
Store all documentation in a single file.
.IP --src
Define the source directory or source file. A directory should start
with a '/' or a './' and should not include any '..'.
.IP --tell
ROBODoc tells you about every step it takes.
.IP --version
Print version information and exit.
.SH EXAMPLES
.EX
robodoc --src ./ --doc myproject --singledoc --html
.EE
Creates a document called myproject.html from all source files
in the current directory.
.EX
robodoc --src ./myproject/
--doc ./myprojectdoc --multidoc --html --index
.EE
Creates seperate documents for all the source files found in
the directory ./myproject they are stored in the directory ./myprojectdoc.
A master index file called ./myprojectdoc/masterindex.html is also
created. This provides links to all the individual files.
.SH FILES
.SS "Example headers"
.PP
.nf
\fI/usr/share/doc/robodoc/Examples\fR
\fI/usr/share/doc/robodoc/Headers\fR
.fi
.SH COPYRIGHT
Copyright \(co 1994-2003 Frans Slothouber, Petteri Kettunen, and Jacco van Weert.
.br
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.SH AUTHORS
Frans Slothouber, Jacco van Weert, Petteri Kettunen, Bernd Koesling,
Thomas Aglassinger, Anthon Pang, Stefan Kost, David Druffner, Sasha Vasko,
Nathan Prewitt and Dennis Stampfer.
.SH SEE ALSO
The documentation in HTML format that comes with ROBODoc. Latest
version can be found from http://www.xs4all.nl/~rfsber/Robo/ or from
http://sourceforge.net/projects/robodoc/.
.BR robohdrs(1)
|
