summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorgbrandl <devnull@localhost>2007-11-01 11:01:35 +0100
committergbrandl <devnull@localhost>2007-11-01 11:01:35 +0100
commitf54127a5c963bb42b2f2d44d9a362a705b026d05 (patch)
treeb0c9a769a6c16e85d143d7b6368fc042ecd5ad0d
parenta1250b0fa48fd1a7809c1605c70917df600be8cb (diff)
downloadpygments-f54127a5c963bb42b2f2d44d9a362a705b026d05.tar.gz
Clarify quickstart docs.
-rw-r--r--docs/src/quickstart.txt13
1 files changed, 12 insertions, 1 deletions
diff --git a/docs/src/quickstart.txt b/docs/src/quickstart.txt
index 93f32c0f..b3f73ae5 100644
--- a/docs/src/quickstart.txt
+++ b/docs/src/quickstart.txt
@@ -183,9 +183,20 @@ To output HTML, use the ``-f`` option::
$ pygmentize -f html -o test.html test.py
to write an HTML-highlighted version of test.py to the file test.html.
+Note that it will only be a snippet of HTML, if you want a full HTML document,
+use the "full" option::
-The stylesheet can be created with::
+ $ pygmentize -f html -O full -o test.html test.py
+
+This will produce a full HTML document with included stylesheet.
+
+A style can be selected with ``-O style=<name>``.
+
+If you need a stylesheet for an existing HTML file using Pygments CSS classes,
+it can be created with::
$ pygmentize -S default -f html > style.css
+where ``default`` is the style name.
+
More options and tricks and be found in the `command line referene <cmdline.txt>`_.