Docs/robodoc.1

   1 .de EX          \"Begin example
   2 .ne 5
   3 .if n .sp 1
   4 .if t .sp .5
   5 .nf
   6 .in +.5i
   7 ..
   8 .de EE
   9 .fi
  10 .in -.5i
  11 .if n .sp 1
  12 .if t .sp .5
  13 ..
  14 .TH ROBODoc "1" "Jul 2006" "ROBODoc 4.99.36"
  15
  16 .SH NAME
  17 ROBODoc \- Extract documentation from source code.
  18
  19 .SH SYNOPSIS
  20 .B robodoc
  21 .I --src
  22 <source>
  23 .I --doc
  24 <destination>
  25 .B [options]
  26
  27 .SH DESCRIPTION
  28
  29 ROBODoc extracts specially formated documentation from the source code.
  30 It allows you to maintain a program and its documentation in a single
  31 file.
  32
  33 .SH OPTIONS
  34
  35 .IP -c
  36 Show the copyright message.
  37
  38 .IP --cmode
  39 Use ANSI C grammar in SOURCE items and use this for some syntax
  40 highlighting (HTML only).
  41
  42 .IP --doc
  43 Define the documentation directory or documentation file.
  44 A directory should start with a '/' or a './' and
  45 should not include any '..'.
  46
  47 .IP --src
  48 Define the source directory or source file.  A directory should start
  49 with a '/' or a './' and should not include any '..'.
  50
  51 .IP --ascii
  52 Generate documentation in ASCII format.
  53
  54 .IP --html
  55 Generate documentation in HTML format.
  56
  57 .IP --css
  58 Use to content of the specified file to create the
  59 .IR robodoc.css .
  60 The content of the file is copied into
  61 .IR robodoc.css .
  62
  63 .IP --dbxml
  64 Generate documentation in XML DocBook format.
  65
  66 .IP --latex
  67 Generate documentation in LaTeX format.
  68
  69 .IP --rtf
  70 Generate documentation in RTF format.
  71
  72 .IP --index
  73 Create an additional master index file.
  74
  75 .IP --multidoc
  76 Store all documentation in seperate files.
  77
  78 .IP --singledoc
  79 Store all documentation in a single file.
  80
  81 .IP --singlefile
  82 Generate a single document from a single file
  83
  84 .IP --toc
  85 Add a table of contents. This works in multidoc mode as well as singledoc mode.
  86
  87 .IP --internal
  88 Also include headers marked internal.
  89
  90 .IP --internalonly
  91 Only include headers marked internal.
  92
  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.
  96
  97 .IP --footless
  98 Do not create the food of a document.
  99
 100 .IP --headless
 101 Do not create the head of a document.
 102
 103 .IP --lock
 104 Per source file
 105 .B ROBODoc
 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.
 110
 111 .IP --nosource
 112 Do not include the SOURCE items.
 113
 114 .IP --nodesc
 115 Do not scan any subdirectories, scan only the top level directory
 116 of the source tree.
 117
 118 .IP --nopre
 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.
 122
 123 .IP --rc
 124 Use the specified file instead of
 125 .IR robodoc.rc .
 126 Note that definitions in a configuration file over-ride
 127 built-in settings.
 128
 129 .IP --sections
 130 Create sections based on the module hierarchy.
 131
 132 .IP --tabsize
 133 Lets you specify the tabsize.
 134
 135 .IP --tell
 136 .B ROBODoc
 137 tells you about every step it takes.
 138
 139 .IP --version
 140 Print version information and exit.
 141
 142 .SH EXAMPLES
 143
 144 .EX
 145 robodoc --src ./ --doc myproject --singledoc --html
 146 .EE
 147
 148 Creates a document called myproject.html from all source files
 149 in the current directory.
 150
 151 .EX
 152 robodoc --src ./myproject/
 153       --doc ./myprojectdoc --multidoc --html --index
 154 .EE
 155
 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.
 160
 161 .SH FILES
 162 .SS "Example headers"
 163 .PP
 164 .nf
 165 \fI/usr/local/share/doc/robodoc/Examples\fR
 166 .fi
 167
 168 .SH COPYRIGHT
 169
 170 Copyright \(co 1994-2003 Frans Slothouber, Petteri Kettunen, and Jacco van Weert.
 171
 172 .br
 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.
 175
 176 .SH AUTHORS
 177
 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.
 181
 182 .SH SEE ALSO
 183
 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/.
 187
 188 .BR robohdrs(1)