Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

naturaldocs(1) [debian man page]

NATURALDOCS(1)						      General Commands Manual						    NATURALDOCS(1)

NAME

       NaturalDocs - an extensible, multi-language documentation generator

SYNOPSIS

       naturaldocs -i <input (source) directory> [-i <input (source) directory> ...] -o <output format> <output directory> [-o <output format>
       <output directory> ...] -p <project directory> [options]

DESCRIPTION

       This manual page documents briefly the .B naturaldocs command. Note that naturaldocs is a wrapper script that on Debian	invokes  the  real
       NaturalDocs perl program. So, the real, original name of the program is NaturalDocs but on Debian systems you invoke it as naturaldocs.

       Natural	Docs  is  is  an  open-source, extensible, multi-language documentation generator. You document your code in a natural syntax that
       reads like plain English. Natural Docs then scans your code and builds high-quality HTML documentation from it.

OPTIONS

       A summary of options, extracted from the help printed by the -h switch is included below.  For a complete description  of  how  NaturalDocs
       works, see the text files in the /usr/share/doc/naturaldocs directory.

       Required parameters:

       -i, --input, --source DIR
	      Specifies an input (source) directory. Required.
	      Can be specified multiple times.

       -o, --output FMT DIR
	      Specifies an output format and directory. Required.
	      Can be specified multiple times, but only once per directory. Possible output formats are HTML and FramedHTML.

       -p, --project DIR
	      Specifies the project directory. Required.
	      There needs to be a unique project directory for every source directory.

       Optional parameters:

       -s, --style STYLE [STYLE ...]
	      Specifies the CSS style when building HTML output. If multiple styles are specified, they will all be included in the order given.

       -img, --image DIR
	      Specifies an image directory. Can be specified multiple times. Start with * to specify a relative directory, as in -img */images.

       -do, --documented-only
	      Specifies only documented code aspects should be included in the output.

       -t, --tab-length LEN
	      Specifies  the  number of spaces tabs should be expanded to. This only needs to be set if you use tabs in example code and text dia-
	      grams. Defaults to 4.

       -xi, --exclude-input, --exclude-source
	      Excludes an input (source) directory from the documentation. Automatically done for the project and output directories. Can be spec-
	      ified multiple times.

       -nag, --no-auto-group
	      Turns off auto-grouping completely.

       -oft, --only-file-titles
	      Source files will only use the file name as the title.

       -r, --rebuild
	      Rebuilds all output and data files from scratch. Does not affect the menu file.

       -ro, --rebuild-output
	      Rebuilds all output files from scratch.

       -q, --quiet
	      Suppresses all non-error output.

       -?, -h, --help
	      Displays syntax reference.

AUTHOR

       NaturalDocs was written by Greg Valure <gregvalure@naturaldocs.org>.

       This manual page was written by Federico Di Gregorio <fog@debian.org>, for the Debian project (but may be used by others).

								     May 2007							    NATURALDOCS(1)

Check Out this Related Man Page

ERIC4_API(1)						      General Commands Manual						      ERIC4_API(1)

NAME

       eric4_api - eric4 API generator

SYNOPSIS

       eric4_api [options] files...

       where files can be be either Python modules, package directories or ordinary directories.

DESCRIPTION

       This  manual  page  documents briefly the eric4_api command.  This manual page was written for the Debian distribution because the original
       program does not have a manual page.

       eric4_api scans Python source code to generate API descriptions files which are used to as tooltips and autocompletion suggestions  by  the
       QScintilla editor widget in eric4.

OPTIONS

       These  programs	follow	the  usual  GNU  command  line	syntax, with long options starting with two dashes (`-').  A summary of options is
       included below.	For a complete description, see the Info files.

       -b name or --base name
	      Use the given name as the name of the base package.

       -h or --help
	      Show this help and exit.

       -o filename or --output=filename
	      Write the API information to the named file. A '%L' placeholder is replaced by the language of the API file (see --language).

       --oldstyle
	      Generate API files for QScintilla prior to 1.7.

       -p or --private
	      Include private methods and functions.

       -R, -r or --recursive
	      Perform a recursive search for Python files.

       -t ext or --extension = ext
	      Add the given extension to the list of file extensions.  This option may be given multiple times.

       -V or --version
	      Show version information and exit.

       -x directory or --exclude=directory
	      Specify a directory basename to be excluded.  This option may be repeated multiple times.

       --exclude-file=pattern
	      Specify a filename pattern of files to be excluded.  This option may be repeated multiple times.

       -l language or --language=language
	      Generate an API file for the given programming language.	Supported programming languages are:
		  * Python
		  * Python3
		  * Ruby The default is 'Python'.  This option may be repeated multiple times.

SEE ALSO

       eric4(1), eric4_compare(1), eric4_configure(1), eric4_diff(1),  eric4_doc(1),  eric4_editor(1),	eric4_helpviewer(1),  eric4_iconeditor(1),
       eric4_plugininstall(1),	  eric4_pluginrepository(1),   eric4_pluginuninstall(1),   eric4_qregexp(1),   eric4_re(1),   eric4_sqlbrowser(1),
       eric4_tray(1), eric4_trpreviewer(1), eric4_uipreviewer(1), eric4_unittest(1), eric4_webbrowser(1)

AUTHOR

       This manual page was written by Torsten Marek <shlomme@gmx.net>, for the Debian project (but may be used by others).

								 January  31, 2010						      ERIC4_API(1)
Man Page