#
# TekDoc.cfg
#
# Used by TekDoc.pl to set process and mail variables.
# Comments begin with a pound sign "#".
#############################################################
# Set the default output directory.
# Overridden by the -d command line option.
# May be relative or absolute path specification.
# Will be created if necessary.
# Default: Doc
#directory = HTML
# Set the default list of file extensions to be processed.
# Overridden by the -e command line option.
# No quotes, no periods.
# Comma separated.
# Default: c, cpp, cxx, h, hpp, hxx, pl, jav, java, txt
#extensions = cpp, hpp, pl, java
# Set recursive operation.
# If enabled will recurse through all subdirectories of any source directory.
# Overridden by the -r command line option.
# Does not recurse any subdirectories if only specific source files are
# specified on the command line, but no directories are specified.
# Default: 0 (disabled)
#recursive = 1
# Set whether the source file name is included in the HTML output.
# Overridden by the -f command line option.
# Will insert the name of the source file for each output node.
# Default: 0 (disabled)
#fileIncluded = 1
# Set the Bold Uppercase rule.
# The rule says to bold any line from the source that
# is all uppercase letters or special characters (i.e. does
# not contain any lowercase letters, but does contain at least
# one alpha-numeric character). Useful for highlighting paragraph headings.
# Default: 1 (enabled)
#boldUpper = 1
# Set the Kill Comments option.
# If enabled, this option will strip leading single-line comments
# from source file lines. The comment character(s) are determined
# by filename extension association for known extensions (c, cpp, etc.).
# Default: 1 (enabled)
#killComments = 0
# Set default page footer.
# Used if a footer tag is not specified in a source file.
# Some useful special character entity names (without the space after the &):
# & copy; Insert the (C) copyright symbol,
# & reg; Insert the (R) registered trademark symbol.
# Default:
#footer =
# Set the Link Mode
# The following modes are available to control the formatting
# of links added at the bottom of applicable pages.
# Modes
# 0 = No links are added.
# 1 = Include links at the bottom of pages ONLY for defined
# sub-nodes (e.g. `Node My Node/My Node 2) in their own paragraph
# and bulleted list titled RELATED LINKS.
# Also include a link to the parent node of a sub-node in
# it's own paragraph and bulleted list titled BACK placed below
# any RELATED LINKS paragraph.
# The node "Index" is never listed in the RELATED LINKS or BACK paragraphs.
# 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 BACK paragraph 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
#linkMode = 3
# Set the security level of nodes to be processed.
# Any node designated with a `Security n value greater than this default
# will not be processed.
# Overridden by the -s command line option.
# Default: 0
#security = 100
# Set the definition of what security level is "secure".
# Any nodes processed with a `Security n value equal to or greater than
# this value are marked in the HTML page as being secure.
# See the -s and -S command line options.
# Overridden by the -S command line option.
# Default: 1
#secure = 2
# Set the mail level.
# Sends a message from mailUser to mailRecipient with
# the current log file attached.
# 0 = never send mail (other mail options ignored)
# 1 = send on error
# 2 = send on error or warning
# 3 = send always
# Default: 2
mailLevel = 0
# Set the mail profile the message is sent from.
# This is the name of the profile in Control Panel, Mail
# to be used to send the message.
# Default: no default
#mailUser = Todd Hill
# Set the mail recipient to receive messages.
# May be multiple recipients separated by semicolons,
# e.g. Buckaroo Banzai; Bill Gates, but be careful of
# overrunning the 127 character command line restriction.
# Default: no default
#mailRecipient = Todd Hill
# Set the log path and filename.
# If set as "log =" with no value the log is disabled.
# If commented out the default is used.
# Default: Configuration filename with .log extension
#log =
# Overwrite log file flag.
# Handy if mailLevel 3 is used.
# 0 = False
# 1 = True
# Default: 0
logOverwrite = 1
# Write to the Windows NT event log flag.
# 0 = False
# 1 = True
# Default: 0
#WriteNTlog = 0
|