diff options
| -rw-r--r-- | docs/pygments.1 | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/pygments.1 b/docs/pygments.1 new file mode 100644 index 00000000..f9a008eb --- /dev/null +++ b/docs/pygments.1 @@ -0,0 +1,71 @@ +.TH PYGMENTIZE 1 "October 30, 2006" + +.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] +.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 + +.SH DESCRIPTION +Pygments aims to be a generic syntax highlighter for general use in all kinds +of software such as forum systems, wikis or other applications that need to +prettify source code. +.PP +Its highlights are: + * a wide range of common languages and markup formats is supported + * special attention is paid to details, increasing quality by a fair amount + * support for new languages and formats are added easily + * a number of output formats, presently HTML, LaTeX and ANSI sequences + * it is usable as a command-line tool and as a library + * ... and it highlights even Brainfuck! +.PP +\fBpygmentize\fP is a command that uses Pygments to highlight the input file and +write the result to \fI<outfile>\fP. If no \fI<infile>\fP is given, stdin is used. +.SH OPTIONS +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). +.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. +.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. +.TP +.B \-S \fI<style>\fP +Print out style definitions for style <style> and for formatter <formatter>. +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. +.TP +.B \-h +Show help screen. +.TP +.B \-V +Show version of the program. +.SH SEE ALSO +/usr/share/doc/python-pygments/index.html +.SH AUTHOR +pygmentize was written by Georg Brandl <g.brandl@gmx.net>. +.PP +This manual page was written by Piotr Ozarowski <ozarow@gmail.com>, +for the Debian project (but may be used by others). |