ROBODoc(1)

NAME
ROBODoc - Extract documentation from source code.

SYNOPSIS
robodoc --src <source> --doc <destination> [options]

DESCRIPTION
ROBODoc extracts specially formated documentation from the source code. It allows you to maintain a program and its documentation in a single file.

OPTIONS

-c  Show the copyright message.

--cmode
    Use ANSI C grammar in SOURCE items and use this for some syntax highlighting (HTML only).

--doc
    Define the documentation directory or documentation file. A directory should start with a '/' or a './' and should not include any '..'.

--src
    Define the source directory or source file. A directory should start with a '/' or a './' and should not include any '..'.

--ascii
    Generate documentation in ASCII format.

--html
    Generate documentation in HTML format.

--css
    Use to content of the specified file to create the robodoc.css. The content of the file is copied into robodoc.css.

--dbxml
    Generate documentation in XML DocBook format.

--latex
    Generate documentation in LaTeX format.

--rtf
    Generate documentation in RTF format.

--index
    Create an additional master index file.

--multidoc
    Store all documentation in seperate files.

--singledoc
    Store all documentation in a single file.

--singlefile
    Generate a single document from a single file

--toc
    Add a table of contents. This works in multidoc mode as well as singledoc mode.

--folds
    Use fold marks to split a big document into smaller ones.

--internal
    Also include headers marked internal.

--internalonly
    Only include headers marked internal.

--ignore_case_when_linking
    Ignore the case of the symbols when trying to find crosslinks. In this mode FOO and Foo will be linked to foo.

--footless
    Do not create the food of a document.

--headless
    Do not create the head of a document.

--lock
    Per source file ROBODoc locks on the first headermarker it finds and will recognize only that particular headermarker for the remaining part of the file. In addition it locks on the first remark marker in each header and will recognize only that particular remark marker for the remaining part of the header.

--nosource
    Do not include the SOURCE items.

--nodesc
    Do not scan any subdirectories, scan only the top level directory of the source tree.

--nopre
    Do not use <PRE> and </PRE> in the HTML output, instead based on the layout of the text create paragraphs, item lists, and preformatted sections.

--rc
    Use the specified file instead of robodoc.rc.

--sections
    Create sections based on the module hierarchy.

--tabsize
    Lets you specify the tabsize.

--tell
    ROBODoc tells you about every step it takes.

--version
    Print version information and exit.

EXAMPLES
    robodoc --src ./ --doc myproject --singledoc --html
Creates a document called myproject.html from all source files in the current directory.
    robodoc --src ./myproject/
          --doc ./myprojectdoc --multidoc --html --index
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.

FILES

  Example headers

/usr/share/robodoc/Examples

COPYRIGHT
Copyright © 1994-2003 Frans Slothouber, Petteri Kettunen, and Jacco van Weert.
This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

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.

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/. robohdrs(1)