summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorgbrandl <devnull@localhost>2007-10-14 11:27:58 +0200
committergbrandl <devnull@localhost>2007-10-14 11:27:58 +0200
commit8bf7b8cb314cc561a4722b96ab262124e06fa05b (patch)
tree06a1cb8f5a25f037844755bc8b05f6e37b0c0fce /docs
parentffa502895d1900ab0e95d754a0ab883ecf84d29a (diff)
downloadpygments-8bf7b8cb314cc561a4722b96ab262124e06fa05b.tar.gz
Add -P option to command line mode.
Diffstat (limited to 'docs')
-rw-r--r--docs/pygmentize.19
-rw-r--r--docs/src/cmdline.txt8
2 files changed, 15 insertions, 2 deletions
diff --git a/docs/pygmentize.1 b/docs/pygmentize.1
index cd75b5fa..71bb6f9c 100644
--- a/docs/pygmentize.1
+++ b/docs/pygmentize.1
@@ -6,10 +6,10 @@ pygmentize \- highlights the input file
.SH SYNOPSIS
.B \fBpygmentize\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]
+.RI [-O\ \fI<options>\fP]\ [-P\ \fI<option=value>\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]
+.RI -S\ \fI<style>\fP\ -f\ \fI<formatter>\fP\ [-a\ \fI<arg>\fP]\ [-O\ \fI<options>\fP]\ [-P\ \fI<option=value>\fP]
.br
.B \fBpygmentize\fP
.RI -L\ [\fI<which>\fP\ ...]
@@ -61,6 +61,11 @@ 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 \-P \fI<option=value>\fP
+This option adds lexer and formatter options like the -O option, but
+you can only give one option per -P. That way, the option value may contain
+commas and equals signs, which it can't with -O.
+.TP
.B \-S \fI<style>\fP
Print out style definitions for style \fI<style>\fP and for formatter \fI<formatter>\fP.
The meaning of the argument given by
diff --git a/docs/src/cmdline.txt b/docs/src/cmdline.txt
index edaa8ee8..6cdec40e 100644
--- a/docs/src/cmdline.txt
+++ b/docs/src/cmdline.txt
@@ -42,6 +42,14 @@ characters, such as spaces or expansion wildcards like ``*``. If an option
expects a list value, separate the list entries with spaces (you'll have to
quote the option value in this case too, so that the shell doesn't split it).
+Since the ``-O`` option argument is split at commas and expects the split values
+to be of the form ``name=value``, you can't give an option value that contains
+commas or equals signs. Therefore, an option ``-P`` is provided that works like
+``-O`` but can only pass one option per ``-P``. Its value can then contain all
+characters::
+
+ $ pygmentize -P "heading=Pygments, the Python highlighter" ...
+
Filters are added to the token stream using the ``-F`` option::
$ pygmentize -f html -l pascal -F keywordcase:case=upper main.pas