robodoc man page on DragonFly
[printable version]
ROBODoc(1) 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.
--version
Print version information and exit.
--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.
--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
The complete list of options can be found in the HTML documenta‐
tion. (Reference at the end of this page.)
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 direc‐
tory ./myproject they are stored in the directory ./myprojectdoc. A
master index file called ./myprojectdoc/masterindex.html is also cre‐
ated. This provides links to all the individual files.
COPYRIGHT
Copyright © 1994-2008 Frans Slothouber, Petteri Kettunen, Gergely Budai
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, Gergely Budai and Dennis Stampfer.
SEE ALSO
The documentation in HTML format that comes with ROBODoc. Latest ver‐
sion can be found from http://www.xs4all.nl/~rfsber/Robo/ or from
http://sourceforge.net/projects/robodoc/.
robohdrs(1)
robodoc 4.99.41 May 2010 ROBODoc(1)
[top]
List of man pages available for DragonFly
Copyright (c) for man pages and the logo by the respective OS vendor.
For those who want to learn more, the polarhome community provides shell access and support.
[legal]
[privacy]
[GNU]
[policy]
[cookies]
[netiquette]
[sponsors]
[FAQ]
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
|
|
Vote for polarhome
|
