Syntax & Description
--
|
End of options. Useful when the last option specified has
optional data that has not been specified. Use to separate
the option from the first source pattern.
Example: perl TekDoc.pl -f -- file1.txt
|
-b [0|1]
|
Enable Bold Uppercase rule.
The rule says to bold and break on any line from the source that
is all uppercase letters or special characters (i.e. does
not contain any lowercase letters, but contains at least one
alpha-numeric character). This is useful for
highlighting paragraph headings.
Option -b with no data enables the option (= 1).
Default: 1 (enabled)
Example: -b 0
See also: BoldUpper variable
|
-c cfg-name
|
Set configuration filename.
Default: Name of the script with .cfg extension.
Example: -c MyProj.cfg
|
-d directory
|
Set documentation output directory.
Can be relative or absolute path specification.
Will be created if necessary.
Default: Doc, relative to current directory.
Example: -d Doc\HTML
See also: Directory variable
|
-e "list"
|
Set list of extensions.
Separated by commas.
Surrounded in double-quotes if more than one extension.
Default: c, cpp, cxx, h, hpp, hxx, pl, jav, java, txt
Example: -e "c,cpp,h,hpp"
See also: Extensions variable
|
-f [0|1]
|
Include source filename at top of node in HTML output file.
Useful for identifying the source of the documentation.
Option -f with no data enables the option (= 1).
Default: 0, do not include.
Example: -f 0
See also: FileIncluded variable
|
-k [0|1]
|
Kill single-line comment characters.
Removes known single-line comment character strings from the
beginning of lines. The comment strings are determined by
association to the file extension. The known associations
are for the default file extensions (see -e).
Default: 1, kill comment characters.
Example: -k 0
See also: KillComments variable
|
-l [0|1|2|3]
|
Link mode. The following modes are available to control the
way links are automatically generated for the bottom of
applicable pages. Forward links are formatted in their
own paragraph with a bulleted list. Backward links are
generated below any forward links.
0 = No links are added.
1 = Include links ONLY for defined sub-nodes (e.g.
`Node My Node/My Node 2). Also include a backward link
to the parent node of the sub-node. The node "Index" is
not placed in the lists. The assumption is Index is the
same as the "Home" link in the navigation bar on the left.
2 = Include links for all sub-nodes generated from the same
source file. No backward link is generated because all
sub-nodes are listed.
3 = Include links for all pages generated in this run,
regardless of the source file.
Default: 1
Example: -l 3
See also: LinkMode variable
|
-o extension
|
Output extension, with no dot. Specifies the output file(s)
extension for all output files and the links on the
navigation bar on the left side of the generated pages.
Default: html
Example: -o htm
See also: OutExtension variable
|
-r [0|1]
|
Perform recursive processing on all subdirectories specified
and encountered. Option -r with no data enables the option (= 1).
Default: 0, not recursive.
Example: -r
See also: Recursive variable
|
-S [0-254]
|
Define what is "Secure". Any entries marked with a
`Security n value greater than or equal to this are marked
with a block on the left side showing the security level to
let readers know they are looking at secure information. See
-s below.
Default: 1, to separate 0 and 1 levels.
Example: -S 3
See also: Secure variable
|
-s [0-254]
|
Set security level to be processed, inclusive. See -S above.
Any entry with a `Security n value greater than this
is not processed.
Default: 0, only process first level.
Example: -s 5
See also: Security variable
|