robodoc(1)

1ROBODoc(1)                  General Commands Manual                 ROBODoc(1)
2
3
4

NAME

6       ROBODoc - Extract documentation from source code.
7
8

SYNOPSIS

10       robodoc --src <source> --doc <destination> [options]
11
12

DESCRIPTION

14       ROBODoc extracts specially formated documentation from the source code.
15       It allows you to maintain a program and its documentation in  a  single
16       file.
17
18

OPTIONS

20       -c     Show the copyright message.
21
22
23       --version
24              Print version information and exit.
25
26
27       --doc  Define  the  documentation  directory  or documentation file.  A
28              directory should start with a '/'  or  a  './'  and  should  not
29              include any '..'.
30
31
32       --src  Define  the source directory or source file.  A directory should
33              start with a '/' or a './' and should not include any '..'.
34
35
36       --ascii
37              Generate documentation in ASCII format.
38
39
40       --html Generate documentation in HTML format.
41
42
43       --dbxml
44              Generate documentation in XML DocBook format.
45
46
47       --latex
48              Generate documentation in LaTeX format.
49
50
51       --rtf  Generate documentation in RTF format.
52
53
54       --index
55              Create an additional master index file.
56
57
58       --multidoc
59              Store all documentation in seperate files.
60
61
62       --singledoc
63              Store all documentation in a single file.
64
65
66       --singlefile
67              Generate a single document from a single file
68
69              The complete list of options can be found in the HTML documenta‐
70              tion.  (Reference at the end of this page.)
71
72

EXAMPLES

74       robodoc --src ./ --doc myproject --singledoc --html
75
76       Creates  a  document called myproject.html from all source files in the
77       current directory.
78
79       robodoc --src ./myproject/
80             --doc ./myprojectdoc --multidoc --html --index
81
82       Creates seperate documents for all the source files found in the direc‐
83       tory  ./myproject  they  are stored in the directory ./myprojectdoc.  A
84       master index file called ./myprojectdoc/masterindex.html is  also  cre‐
85       ated.  This provides links to all the individual files.
86
87

COPYRIGHT

89       Copyright © 1994-2008 Frans Slothouber, Petteri Kettunen, Gergely Budai
90       and Jacco van Weert.
91
92       This is free software; see the source for copying conditions.  There is
93       NO  warranty;  not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
94       PURPOSE.
95
96

AUTHORS

98       Frans Slothouber, Jacco van Weert, Petteri  Kettunen,  Bernd  Koesling,
99       Thomas  Aglassinger,  Anthon  Pang,  Stefan Kost, David Druffner, Sasha
100       Vasko, Nathan Prewitt, Gergely Budai and Dennis Stampfer.
101
102