.\" Generated by manscript from t3highlight.1.txt
.TH "T3HIGHLIGHT" "1" "2013/03/21" "Version 0.5.0" "Soure highlighter"
.hw /usr/share/doc/libt3key-0.5.0 http://os.ghalkes.nl/t3/libt3key.html
.SH NAME
t3highlight \- create syntax highlighted document from source file.
.SH SYNOPSIS
\fBt3highlight\fR [OPTION]... [FILE]
.SH DESCRIPTION
\fBt3highlight\fR reads a source file and creates a syntax highlighted document
from it.
.SH OPTIONS
\fBt3highlight\fR accepts the following options:
.PP
.TP
\fB\-d\fR  \fItype\fR, \fB\-\-document\-type\fR=\fItype\fR
For styles which define multiple document types, select a specific type
instead of the default. For example, the \fIhtml\fR style supplied with
\fBt3highlight\fR provides the \fIstandalone\fR, \fIseparate-css\fR and
\fIraw\fR styles. By default the first (\fIstandalone\fR) is chosen. See the
\fB\-D\fR/\fB\-\-list\-document\-types\fR option for finding out the
available document types.
.TP
\fB\-D\fR, \fB\-\-list\-document\-types\fR
Show a list of the available document types for the selected output style, and
exit.
.TP
\fB\-l\fR \fIlang\fR, \fB\-\-language\fR=\fIlang\fR
Use source language \fIlang\fR for highlighting. See the \fB\-L\fR/\fB\-\-list\fR
option for finding out the available languages.
.TP
\fB\-\-language\-file\fR=\fIfile\fR
Use the file \fIfile\fR for highlighting. This option allows loading of
highlighting patterns directly from a file, rather than using a named language
from the lang.map file. This is particularly useful when developing new
highlighting patterns.
.TP
\fB\-L\fR, \fB\-\-list\fR
Show a list of all the available source languages and output styles, and exit.
.TP
\fB\-s\fR \fIstyle\fR, \fB\-\-style\fR=\fIstyle\fR
Use output style \fIstyle\fR to create the output document. The default is the
\fIesc\fR style, which uses escape sequences to provide colored output to the
terminal. See the \fB\-L\fR/\fB\-\-list\fR option for finding out the
available styles.
.TP
\fB\-t\fR \fItag\fR, \fB\-\-tag\fR=\fItag\fR
The header and footer, as defined by the document style, may contain tag
references in the form %{\fIname\fR}. The tags \fIname\fR and \fIcharset\fR
are always defined, but a document style may include more. This option allows
specification of extra values, or overriding of predefined tags. \fItag\fR must
have the form \fIname\fR=\fIvalue\fR.
.IP
Tags in the header or footer that have not been defined will be removed.
An example of a custom tag is the \fIcss\fR tag used in the \fIseparate-css\fR
document style of the \fIhtml\fR output style. This allows insertion of the
desired CSS style sheet URL into the generated file.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Print verbose warning messages.
.SH FILES
\fBlibt3highlight\fR, which is used by \fBt3highlight\fR to do the highlighting, and
\fBt3highlight\fR itself look for their data files in the directory
$HOME/.local/share/libt3highlight and /usr/share/libt3highlight\fI?\fR (where \fI?\fR
is a digit indicating the binary API version). The documentation on how to
write highlighting patterns and style files is normally installed in
/usr/share/doc/libt3highlight.
.SH BUGS
If you think you have found a bug, please check that you are using the latest
version of \fBlibt3highlight\fR <http://os.ghalkes.nl/libt3highlight.html>.
When reporting bugs, please include a minimal example that demonstrates the
problem.
.SH AUTHOR
G.P. Halkes <libt3highlight@ghalkes.nl>
.SH COPYRIGHT
Copyright \(co 2012 G.P. Halkes
.br
\fBlibt3highlight\fR is licensed under the GNU General Public License version\ 3.
.br
For more details on the license, see the file COPYING in the documentation
directory. On Un*x systems this is usually
/usr/share/doc/libt3highlight.