diff options
Diffstat (limited to 'docs/pygmentize.1')
| -rw-r--r-- | docs/pygmentize.1 | 48 |
1 files changed, 33 insertions, 15 deletions
diff --git a/docs/pygmentize.1 b/docs/pygmentize.1 index 2c50c7b4..cd75b5fa 100644 --- a/docs/pygmentize.1 +++ b/docs/pygmentize.1 @@ -1,17 +1,24 @@ -.TH PYGMENTIZE 1 "October 30, 2006" +.TH PYGMENTIZE 1 "February 15, 2007" .SH NAME pygmentize \- highlights the input file .SH SYNOPSIS .B \fBpygmentize\fP -.RI [-l\ \fI<lexer>\fP]\ [-f\ \fI<formatter>\fP]\ [-O\ \fI<options>\fP]\ [-o\ \fI<outfile>\fP]\ [\fI<infile>\fP] +.RI [-l\ \fI<lexer>\fP]\ [-F\ \fI<filter>\fP[:\fI<options>\fP]]\ [-f\ \fI<formatter>\fP] +.RI [-O\ \fI<options>\fP]\ [-o\ \fI<outfile>\fP]\ [\fI<infile>\fP] .br .B \fBpygmentize\fP .RI -S\ \fI<style>\fP\ -f\ \fI<formatter>\fP\ [-a\ \fI<arg>\fP]\ [-O\ \fI<options>\fP] .br .B \fBpygmentize\fP -.RI -L\ |\ -h\ |\ -V +.RI -L\ [\fI<which>\fP\ ...] +.br +.B \fBpygmentize\fP +.RI -H\ \fI<type>\fP\ \fI<name>\fP +.br +.B \fBpygmentize\fP +.RI -h\ |\ -V .SH DESCRIPTION Pygments is a generic syntax highlighter for general use in all kinds @@ -32,36 +39,47 @@ write the result to \fI<outfile>\fP. If no \fI<infile>\fP is given, stdin is use A summary of options is included below. .TP .B \-l \fI<lexer>\fP -Set lexer name. If not given, the lexer is guessed from the extension of -the input file name (this obviously doesn't work if the input is stdin). +Set the lexer name. If not given, the lexer is guessed from the extension of the +input file name (this obviously doesn't work if the input is stdin). +.TP +.B \-F \fI<filter>\fP[:\fI<options>\fP] +Add a filter to the token stream. You can give options in the same way as for +-O after a colon (note: there must not be spaces around the colon). +This option can be given multiple times. .TP .B \-f \fI<formatter>\fP -Set formatter name. If not given, it will be guessed from -the extension of the output file name. If no output file is given, -the terminal formatter will be used by default. +Set the formatter name. If not given, it will be guessed from the extension of +the output file name. If no output file is given, the terminal formatter will be +used by default. .TP .B \-o \fI<outfile>\fP Set output file. If not given, stdout is used. .TP .B \-O \fI<options>\fP -With this option, you can give the lexer and formatter a comma- -separated list of options, e.g. "-O bg=light,python=cool". Which options are -valid for which lexers and formatters can be found in the documentation. +With this option, you can give the lexer and formatter a comma-separated list of +options, e.g. "-O bg=light,python=cool". Which options are valid for which +lexers and formatters can be found in the documentation. +This option can be given multiple times. .TP .B \-S \fI<style>\fP -Print out style definitions for style <style> and for formatter <formatter>. +Print out style definitions for style \fI<style>\fP and for formatter \fI<formatter>\fP. The meaning of the argument given by .B \-a \fI<arg>\fP is formatter dependent and can be found in the documentation. .TP -.B \-L -List all available lexers and formatters. +.B \-L [\fI<which>\fP ...] +List lexers, formatters, styles or filters. Set \fI<which>\fP to the thing you want +to list (e.g. "styles"), or omit it to list everything. +.TP +.B \-H \fI<type>\fP \fI<name>\fP +Print detailed help for the object \fI<name>\fP of type \fI<type>\fP, where \fI<type>\fP is one +of "lexer", "formatter" or "filter". .TP .B \-h Show help screen. .TP .B \-V -Show version of the program. +Show version of the Pygments package. .SH SEE ALSO /usr/share/doc/python-pygments/index.html .SH AUTHOR |