.TH highlight 1 "2008-01-04" "Andre Simon" "user documentation"

.SH NAME
Highlight - a universal sourcecode to formatted text converter

.SH SYNOPSIS
.B highlight
[acdefhiklnopqrstuvwzABCDEHIKLOPRSTXVWZ] [-i input file] [-o output file] [-S syntax] [-O outdir] [-B wildcard] [-H language] [-t num] [-c style_outfile] [-e style_infile] [-s style] [-D data dir] [-E add. data dir] [-F format] [-u encoding] [input files]

.SH DESCRIPTION
.B Highlight
converts sourcecode to HTML, XHTML, RTF, LaTeX, TeX, XML or ANSI escape sequences. There are 40 colour themes available.
.B Highlight
recognizes keywords, numbers, strings, comments, symbols and preprocessor directives.
It supports Action Script, ADA 95, Agda, AMPL, Aspect, Assembler, Amtrix, Avenue, (G)AWK,
Bash, BlitzBasic, BMS, C, C++, C#, ClearBasic, Clipper, Cobol, CSS, DOS-Batch,
Eiffel, Euphoria, Express, Felix, Frink, Forth, Fortran, Haskell, HTML, HTTPD,
IDL, INI, IO, Jasmin, Java, JavaScript, JSP, LaTeX, LDIF, Lotus Script, Lua,
Make, Maya, Matlab, MaxScript, Modelica, Modula 3, Nasal, Nice, Oberon, Object
Script, OCaml, Pascal, Paradox, PATROL, Perl, PHP, Pike, PL/1, PL/SQL, POV Ray,
Progress, Python, Relax NG, Rexx, Ruby, Small, SML, Spin, Sybase, Squirrel,
SuperX++, VHDL, Visual Basic, XML and more.
.PP
It's easily possible to enhance highlight's database of programming languages and colour themes.
See the README file for details.
.SH General options
.IP "-B, --batch-recursive=<wildcard>"
convert all files matching the wildcard (uses recursive search)
.IP "-D, --data-dir=<path>"
set path to highlight data directory
.IP "-E, --add-data-dir=<path>"
set path to an additional data directory, which is searched first
.IP "--add-config-dir=<path>"
set path to an additional configuration directory
.IP "--help-lang=<lang>"
print help in given language
<lng>=[br, cz, en, es, de, fr]
.IP "-h, --help"
print this help
.IP "-i, --input=<file>"
name of input file
.IP "-o, --output=<file>"
name of output file
.IP "-O, --outdir=<output directory>"
name of output directory
.IP "-P, --progress"
print progress bar in batch mode
.IP "-S, --syntax=<type>"
define type of source code, necessary if input filename is unknown
.IP "-v, --verbose"
print debug info to stderr
.IP "-p, --list-langs"
list installed language definitions
.IP "-q, --quiet"
supress progress info in batch mode
.IP "-w, --list-themes"
list installed themes
.IP "--force"
generate output if language type is unknown
.IP "--print-config"
print path configuration
.IP "--validate-input"
test if input is a valid text file
.IP "--version"
print version and copyright info

.SH Output formats
.IP "-H, --html"
generate HTML file (default)
.IP "-A, --ansi"
generate terminal output (16 colours)
.IP "-L, --latex"
generate LaTeX file
.IP "-M, --xterm256"
generate terminal output (256 colours)
.IP "-R, --rtf"
generate RTF file
.IP "-T, --tex"
generate TeX file
.IP "-X, --xhtml"
generate XHTML 1.1 file
.IP "-Z, --xml"
generate XML file


.SH Output formatting options
.IP "-c, --style-outfile=<file>"
name of style definition file or output to stdout, if "stdout" is given as file argument
.IP "-d, --doc-title"
document title
.IP "-e, --style-infile=<file>"
name of file to be included in style-outfile
.IP "-f, --fragment"
omit header and footer of the output document
.IP "-F, --reformat=<style>"
reformat output in given style.
<style>=[ansi, gnu, kr, java, linux]
.IP "-I, --include-style"
include style definition in output
.IP "-J, --line-length=<num>"
line length before wrapping (see -W, -V)
.IP "-j, --line-number-length=<num>"
line number length incl. left padding
.IP "-k, --font=<font>"
defines font (specific to output format)
.IP "-K, --font-size=<num?>"
defines font size (specific to output format)
.IP "-l, --linenumbers"
print line numbers in output file
.IP "-m, --line-number-start=<cnt>"
start line numbering with cnt (assumes -l)
.IP "-s, --style=<style name>"
define highlighting style (see --list-themes)
.IP "-t  --replace-tabs=<num>"
replace tabs by num spaces
.IP "-u, --encoding=<enc>"
define output encoding which matches input file encoding; omit encoding information if enc=NONE
.IP "-V, --wrap-simple"
wrap long lines without indenting function parameters and statements
.IP "-W, --wrap"
wrap long lines (use with caution)
.IP "-z, --zeroes"
fill leading space of line numbers with zeroes
.IP "--kw-case=<upper|lower|capitalize>"
output all keywords in given case if language is not case sensitive

.SH "(X)HTML OPTIONS"
.IP "-a, --anchors"
attach anchors to line numbers (HTML only)
.IP "-y, --anchor-prefix=<str>"
define anchor name prefix
.IP "-N, --anchor-filename"
use input file name as anchor name
.IP "-G, --class-name=<str>"
define CSS class name prefix
.IP "-C, --print-index"
print index file with links to all output files
.IP "--ordered-list"
print lines as ordered list items (assumes -l)
.IP "--inline-css"
output CSS within each tag (generates verbose output)
.IP "--mark-line='n[=txt]; m'"
mark given lines n..m and add optional help texts as tooltips
.IP "--enclose-pre"
enclose fragmented output with pre tag (assumes -f)

.SH "LaTeX OPTIONS"
.IP "-b, --babel"
disable Babel package shorthands
.IP "-r, --replace-quotes"
replace double quotes by \\dq (assumes -f is set)

.SH "RTF OPTIONS"
.IP "-x, --page-size=<size>"
define page size, <size>=[a3, a4, a5, b4, b5, b6, letter]

.PP
If no in- or output files are specified, stdin and stdout will be used for  in- or output.
-t will be ignored if -F is set.
-i and -o will be ignored if -b or -B is set.
-c will be ignored if the output format does not support referenced style files.
HTML will be generated, if no other output format is given  Style definitions are stored in highlight.css (HTML, XHTML) or
highlight.sty (LaTeX, TeX) if neither -c nor -I is given.
Reformatting code will only work with C, C++, C# and java input files.
.SH BUGS
The converter is not able to recognize mixed code like PHP and JavaScript in one file.
The wrapping options might cause faulty highlighting of multi line comments.
.SH FILES
The parsing information of the programming languages is stored in
.I /usr/share/highlight/langDefs/.
You may enhance
.B highlight's
parsing capabilities by adding more *.lang - files to this directory.
You can also define other directories with -D, or add search paths with -E.
Documentation files are stored in
.I /usr/share/doc/highlight/
, configuration files in
.I /etc/highlight/.

.SH Examples
Single file conversion:
.PP
highlight -o hello.html -i hello.c
.PP
highlight -o hello.html hello.c
.PP
highlight -o hello.html -S c < hello.c
.PP
highlight -S c < hello.c > hello.html
.PP
Note that a file highlight.css is created in the current directory.
.PP
Batch file processing:

highlight -X  -B '*.cpp' -O /home/you/html_code/
.PP
converts all *.cpp files in the current directory and its subdirectories to
xhtml files, and stores the output in /home/you/html_code.
.PP
highlight -L  * -O /home/you/latex_code/
.PP
converts all files to LaTeX, stored in /home/you/latex_code/.
.PP
Use --quiet to improve performance of batch file processing (recommended for usage in shell scripts).
.PP
Use highlight -A <yourfile> | less -R to display a source file in a terminal.
.SH AUTHORS
Andre Simon <andre.simon1@gmx.de>
.SH SEE ALSO
README file and highlight webpage at http://www.andre-simon.de/ and http://wiki.andre-simon.de.