TekDoc
Home
Map
Index
|
|
TekDoc 1.0
GrayHill Systems
Todd R. Hill
|
|
Configuration File Variables
Source: TekDoc.pl
Settings made in the configuration file are overridden by any matching command
line options. Only those variables that can be specified on the command line
are overridden, all other variables in the configuration file are used. All
variables have default values or behaviors if not specified at all (commented
out).
If the configuration file is not available, only the command line options are
used. Any variables that are not available as a command line parameter (such
as Footer) use their default value.
The default configuration filename is the name of the script with a .cfg
extension. If the script is renamed the default configuration filename will
change as well. A different configuration filename may be specified on the
command line with the -c option.
Process Variables
boldUpper = [0|1]
|
See -b. Bold Uppercase rule.
|
directory = [path]
|
See -d. Documentation output directory.
|
extensions = [list]
|
See -e. Extensions to process. No quotes.
|
fileIncluded = [0|1]
|
See -f. Include source filename in output.
|
footer = string
|
Set default footer for the bottom of HTML pages.
Used if the `Footer tag is not found in a file.
No default, and no command line equivalent.
|
killComments = [0|1]
|
See -k. Kill single-line comment character strings.
|
linkMode = [0|1|2|3]
|
See -l. Link mode.
|
outExtension = extension
|
See -o. Output file(s) extension.
|
recursive = [0|1]
|
See -r. Process directories recursively.
|
security = [0-254]
|
See -s. Default security level to process.
|
secure = [0-254]
|
See -S. Definition of "Secure Level".
|
Mail and Logging Variables
mailLevel = [0|1|2|3]
|
Sets the level for when e-mail notification should be
sent from the script. Useful for fully automated processes.
0 = Never send mail (other mail options ignored).
1 = Send on error.
2 = Send on error or warning.
3 = Send always.
Default: 2
|
mailUser = [profile]
|
Defines the e-mail profile name to be used to send a message.
For Windows, this is the name of a profile from Control Panel,
Mail.
Default: none
|
mailRecipient = [account]
|
Defines the e-mail account to receive automated messages.
Default: none
|
log = [filename]
|
The filename to use for logging. The default is the name
of the script with a .log extension. If set with no value
(e.g. log = ) the log is disabled entirely.
Default: none
|
logOverwrite = [0|1]
|
Determines whether the log file should be overwritten (1),
or appended (0). Especially useful if mailLevel = 3.
Default: 0
|
writeNTlog = [0|1]
|
Determines whether completion status entries are written
to the Windows NT system log. This feature only works
on Windows NT and is ignored on other operating systems.
Default: 0
|
RELATED LINKS
|