highlight(1)

NAME
Highlight - a universal sourcecode to formatted text converter

SYNOPSIS
highlight [OPTIONS]... [FILES]...

DESCRIPTION
Highlight converts sourcecode to HTML, XHTML, RTF, LaTeX, TeX, XML, SVG, XTERM or ANSI escape sequences. There are 40 colour themes available. Highlight recognizes keywords, numbers, strings, comments, symbols and preprocessor directives. It supports AWK, ABAP/4, Abstract, Action Script, ADA95, Agda, AMPL, AMTrix, Apache Config, AppleScript, Arc, ARM, ASCEND, ASP, Assembler, AutoIt, Avenue, Bash, BibTeX, Bison, Blitz Basic, BM Script, C and C++, C#, ClearBasic, Clipper, Clips, COBOL, ColdFusion MX, CSS, D, Diff, DOS Batch, Dylan, Eiffel, Erlang, Euphoria, Express, FAME, Felix, Fortran 77, Fortran 90, Frink, Graphviz, Haskell, Hecl, Icon, IDL, Informix, INI, IO, Jasmin, Java, Javascript, JSP, LDAP, Lilypond, Linden Script, Lisp, Lotos, Lotus, LUA, Luban, Make, Maple, Matlab, MaxScript, Maya, Microsoft PowerShell, Miranda, Modelica, Modula3, MSSQL, Nasal, Nemerle, Nice, NSIS, Oberon, Object Script, Objective C, Objective Caml, Octave, Open Object Rexx, Paradox, Pascal, PATROL, Perl, PHP, Pike, PL/1, PL/SQL, PostScript, POV-Ray, PowerPC Assembler, Progress, Prolog, Pyrex, Python, Python, Qore, Qu, R, Relax NG, Rexx, RPM Spec, Ruby, SAS, Scala, Scilab, SMALL, Smalltalk, SNMP, SNOBOL, SPIN SQL, Squirrel, Standard ML, SuperX++, Sybase SQL, Tcl/Tk, TCSH, TeX, LaTeX, TTCN3, Verilog, VHDL, Visual Basic, XML and more.

It's easily possible to enhance highlight's database of programming languages and colour themes. See the README file for details.

General options

-B, --batch-recursive=<wildcard>
    convert all files matching the wildcard (uses recursive search)

-D, --data-dir=<path>
    set path to highlight data directory

-E, --add-data-dir=<path>
    set path to an additional data directory, which is searched first

--add-config-dir=<path>
    set path to an additional configuration directory

--help-lang=<lang>
    print help in given language <lng>=[br, cz, en, es, de, fr]

-h, --help
    print this help

-i, --input=<file>
    name of input file

-o, --output=<file>
    name of output file

-O, --outdir=<output directory>
    name of output directory

-P, --progress
    print progress bar in batch mode

-S, --syntax=<type>
    define type of source code, necessary if input filename is unknown

-v, --verbose
    print debug info to stderr

-p, --list-langs
    list installed language definitions

-q, --quiet
    supress progress info in batch mode

-w, --list-themes
    list installed themes

--force
    generate output if language type is unknown

--print-config
    print path configuration

--skip=<list>
    ignore listed unknown file types (Example: --skip='bak;c~;h~')

--validate-input
    test if input is a valid text file

--version
    print version and copyright info

Output formats

-H, --html
    generate HTML file (default)

-A, --ansi
    generate terminal output (16 colours)

-L, --latex
    generate LaTeX file

-M, --xterm256
    generate terminal output (256 colours)

-R, --rtf
    generate RTF file

-T, --tex
    generate TeX file

-X, --xhtml
    generate XHTML 1.1 file

-Z, --xml
    generate XML file

-G, --svg
    generate SVG file (experimental)

--out-format=<format>
    output file in given format. <format>: see long options above

Output formatting options

-c, --style-outfile=<file>
    name of style definition file or output to stdout, if "stdout" is given as file argument

-d, --doc-title
    document title

-e, --style-infile=<file>
    name of file to be included in style-outfile

-f, --fragment
    omit header and footer of the output document

-F, --reformat=<style>
    reformat output in given style. <style>=[ansi, gnu, kr, java, linux]

-I, --include-style
    include style definition in output

-J, --line-length=<num>
    line length before wrapping (see -W, -V)

-j, --line-number-length=<num>
    line number length incl. left padding

-k, --font=<font>
    defines font (specific to output format)

-K, --font-size=<num?>
    defines font size (specific to output format)

-l, --linenumbers
    print line numbers in output file

-m, --line-number-start=<cnt>
    start line numbering with cnt (assumes -l)

-s, --style=<style name>
    define highlighting style (see --list-themes)

-t  --replace-tabs=<num>
    replace tabs by num spaces

-u, --encoding=<enc>
    define output encoding which matches input file encoding; omit encoding information if enc=NONE

-V, --wrap-simple
    wrap long lines without indenting function parameters and statements

-W, --wrap
    wrap long lines (use with caution)

-z, --zeroes
    fill leading space of line numbers with zeroes

--kw-case=<upper|lower|capitalize>
    output all keywords in given case if language is not case sensitive

(X)HTML OPTIONS

-a, --anchors
    attach anchors to line numbers (HTML only)

-y, --anchor-prefix=<str>
    define anchor name prefix

-N, --anchor-filename
    use input file name as anchor name

-C, --print-index
    print index file with links to all output files

--ordered-list
    print lines as ordered list items

--class-name=<str>
    define CSS class name prefix print lines as ordered list items (assumes -l)

--inline-css
    output CSS within each tag (generates verbose output)

--mark-line='n[=txt]; m'
    mark given lines n..m and add optional help texts as tooltips

--enclose-pre
    enclose fragmented output with pre tag (assumes -f)

--ctags-file[=<file>]
    read ctags file to include meta information as tooltips (default value: tags)

LaTeX OPTIONS

-b, --babel
    disable Babel package shorthands

-r, --replace-quotes
    replace double quotes by \dq (assumes -f is set)

RTF OPTIONS

-x, --page-size=<size>
    define page size, <size>=[a3, a4, a5, b4, b5, b6, letter]

--char-styles
    include character stylesheets

SVG OPTIONS

--height=<h>
    define image height (units allowed)

--width=<w>
    define image size (see --height)

GNU SOURCE-HIGHLIGHT COMPATIBILITY OPTIONS

--doc
    create stand alone document

--no-doc
    cancel the --doc option

--css=filename
    the external style sheet filename

--src-lang=STRING
    source language

-t, --tab=INT
    specify tab length

-n, --line-number[=0]
    number all output lines, optional padding

--line-number-ref[=p]
    number all output lines and generate an anchor, made of the specified prefix
     p + the line number (default='line')

--output-dir=path
     output directory

--failsafe
    if no language definition is found for the input, it is simply copied to the output

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, SVG) 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.

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.

FILES
The parsing information of the programming languages is stored in /usr/share/highlight/langDefs/. You may enhance 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 /usr/share/doc/highlight/ , configuration files in /etc/highlight/.

Examples
Single file conversion:

highlight -o hello.html -i hello.c

highlight -o hello.html hello.c

highlight -o hello.html -S c < hello.c

highlight -S c < hello.c > hello.html

Note that a file highlight.css is created in the current directory.

Batch file processing: highlight -X -B '*.cpp' -O /home/you/html_code/

converts all *.cpp files in the current directory and its subdirectories to xhtml files, and stores the output in /home/you/html_code.

highlight -L * -O /home/you/latex_code/

converts all files to LaTeX, stored in /home/you/latex_code/.

Use --quiet to improve performance of batch file processing (recommended for usage in shell scripts).

Use highlight -A <yourfile> | less -R to display a source file in a terminal.

AUTHORS
Andre Simon <as@andre-simon.de>

SEE ALSO
README file and highlight webpage at http://www.andre-simon.de/ and http://wiki.andre-simon.de.