config-template

# PasHi config file template
# --------------------------
#
# PURPOSE
# -------
#
# PasHi looks for a file named "config" in the %AppData%\DelphiDabbler\PasHi
# directory when it starts up. Any commands it finds in that file are used to
# override the program's defaults. No "config" file is provided as standard: the
# user must provide one if needed.
#
# This file is provided as a template for creating a "config" file. As supplied,
# this file makes makes no changes to PasHi's default state. However it is fully
# commented and lists every available configuration option.
#
# FILE FORMAT
# -----------
#
# Each command must be placed on its own line. Any parameters required by the
# command must follow the command and be separated from it by one or more
# spaces. Parameters containing spaces must not be enclosed in quotes.
#
# Commands must begin with a alphabetic character or a digit and can contain
# only aplphabetic characters, digits or hyphens (minus sign).
#
# Blank lines are ignored, as are lines beginning with #. Leading and trailing
# spaces and tabs are also ignored.
#
# The file must be saved in UTF-8 encoding, with or without BOM (byte order
# mark).
#
# WARNING: Errors in this file will crash PasHi. The program can usually work
# out if an error was caused by this file and will report the fact in its error
# message.
#
# USAGE
# -----
#
# To use this file you must copy it as "config", over-writing any existing file.
# "config" must be placed in the %AppData%\DelphiDabbler\PasHi directory.
#
# WARNING: Any changes to this file before renaming are likely to be overwritten
# by PasHi, so do not run PasHi while editing the original file. Preferrably you
# should make changes to a copy of this file.
#
# Commands entered on PasHi's command line override commands in this file.
#
# VALID COMMANDS
# --------------
#
# Only the commands listed below are valid. Each command is a simile of a long
# form command line command, except that the "--" prefix is omitted.
#
# For example the "doc-type" config command is a simile of the "--doc-type"
# command line command.
#
# Short form command line commands are not permitted.
#
# Not all command line commands may be used here. Certain commands that would
# cause PasHi to fail permanently are "blacklisted" and not permitted in the
# config file. If such a command is present then PasHi will fail with an error
# message.
#
# At present there are three blacklisted commands: "config-show", "help" & 
# "version".
#
# A complete list of valid commands follows. Commands and parameters that are
# slated for removal in the next major release are flagged as deprecated.
#
# For an explanation of what these commands do see the documentation of the
# related command line command in the user guide or in PasHi's help screen,
# accessed by typing "PasHi --help".


# --- Input source commands ---
# Commands:
#   input-stdin
#   input-clipboard
# Default:
#   input-stdin


# --- Input source trimming ---
# Command:
#   trim <param>
#     where <param> is one of "-", "lines", "spaces", "all", "yes" or "no"
#     ** the "yes" and "no" parameters are DEPRECATED
#        use "lines" instead of "yes" and "-" instead of "no"
# Default:
#   trim lines
#   ** the default is DEPRECATED: may change to "all" in next release


# --- Multiple input file separation ---
# Command:
#   separator-lines <param>
#     where <param> is a number in range 0..16
# Default:
#   separator-lines 1


# --- Output sink commands ---
# Commands:
#   output-stdout
#   output-file <param>
#     where <param> is the required file name
#   output-clipboard
# Examples:
#   output-file C:\MyDocs\MyFile.html
#   output-file MyFile.html
# Default:
#   output-stdout


# --- Output document type ---
# Command:
#   doc-type <param>
#     where <param> is one of "xhtml", "html4", "html5" or "fragment"
#     ** The "html4" <param> is DEPRECATED
# Default:
#   doc-type xhtml
#   ** the default is DEPRECATED: may change in next major release


# --- Output file branding ---
# Command:
#   branding <param>
#     where <param> is either "on" or "off"
# Default:
#   branding on


# --- Output file language ---
# Commands:
#   language <param>
#     where <param> is either a valid language code recognised by HTML or
#     "neutral" (or "-") if the file is language neutral
#   language-neutral
#   ** Command DEPRECATED: use "language neutral" instead
#     
# Examples:
#   language en
#   language en-gb
#   language neutral
# Default:
#   language neutral


# --- Output document title ---
# Commands:
#   title <param>
#     where <param> is either the required title text or "-" to use the default
#     title
#   title-default
#   ** Command DEPRECATED: use title "-" instead
# Example
#   title Highlighted Pascal Source Code
#   title -
# Default:
#   title -


# --- Output document encoding ---
# Command:
#   encoding <param>
#     where <param> is one of "utf-8", "utf-16", "windows-1252" or "iso-8859-1"
# Default:
#   encoding utf-8


# --- Style sheets ---
# Commands:
#   embed-css <param>
#     where <param> is the name of a CSS file
#   default-css
#   link-css <param>
#     where <param> is the absolute or relative URL of a CSS file
# Examples:
#   embed-css C:\CSS\style.css
#   embed-css .\style.css
#   embed-css delphi7.css
#   link-css https://example.com/css/example.css
#   link-css example.css
# Default:
#   default-css


# --- Comment out embedded style sheets ---
# Command:
#   hide-css <param>
#   ** Command DEPRECATED
#     where <param> is either "yes" or "no"
# Default:
#   hide-css no


# --- CSS class naming convention ---
# Command:
#   legacy-css <param>
#   ** Command DEPRECATED
#     where <param> is either "yes" of "no"
# Default:
#   legacy-css no


# --- Code generation ---
# Command:
#   inhibit-styling <param>
#     where <param> is either:
#       a set of zero or more of the values, "space", "comment", "kwd", "ident",
#       "sym", "str", "num", "float", "hex", "preproc", "asm" or "err",
#       separated by commas, with no spaces, and enclosed in curly brackets,
#     or:
#       a single one of the above values,
#     or:
#       a minus sign, "-", as an alias for the empty set "{}".
# Examples:
#   inhibit-styling {space}
#   inhibit-styling space
#   inhibit-styling {num,float,hex}
#   inhibit-styling {}
#   inhibit-styling -
# Default:
#   inhibit-styling {}


# --- Line numbering ---
# Commands:
#   line-numbering <param>
#     where <param> is either "on" or "off"
#   line-number-width <param>
#     where <param> is a number in range 1..6
#   line-number-padding <param>
#     where <param> is one of "space", "zero", "dot" or "dash"
#   line-number-start <param>
#     where <param> is a number in range 1...9999
# Defaults:
#   line-numbering off
#   line-number-width 3
#   line-number-padding space
#   line-number-start 1


# --- Line styling ---
# Command:
#   striping <param>
#     where <param> is either "on" or "off"
# Default:
#   striping off


# --- Meta tags ---
# Commands:
#   viewport <param>
#     where <param> is one of "phone" or "none"
#   edge-compatibility <param>
#     where <param> is either "on" or "off"
# Defaults:
#   viewport none
#   ** the viewport default is DEPRECATED: may change in next major release
#   edge-compatibility off


# --- Output verbosity ---
# Commands:
#   verbosity <param>
#     where <param> is either:
#       a set of zero or more of the values "info", "warn" (aka "warning" aka
#       "warnings") or "error" (aka "errors"), separated by commas, with no
#       spaces, and enclosed in curly brackets,
#     or one of:
#       "normal", "no-warn", "quiet", "silent" or a minus sign, "-"
#     ** the "normal" and "no-warn" parameters are DEPRECATED
#        use "{info,warn,error}" instead of "normal" and "{info,errors}" instead
#        of "no-warn"
# Default:
#   verbosity {info,warn,error}
#   ** the default is DEPRECATED: may change in next major release.
# Examples:
#   verbosity {info}
#   verbosity -
#   verbosity {warnings,info}
#   verbosity quiet