/usr/share/doc/python-pygments-doc/html/faq.html is in python-pygments-doc 2.0.1+dfsg-1.1+deb8u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Pygments FAQ — Pygments 2.0.1 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2.0.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="top" title="Pygments 2.0.1 documentation" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">Pygments 2.0.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="pygments-faq">
<h1>Pygments FAQ<a class="headerlink" href="#pygments-faq" title="Permalink to this headline">¶</a></h1>
<div class="section" id="what-is-pygments">
<h2>What is Pygments?<a class="headerlink" href="#what-is-pygments" title="Permalink to this headline">¶</a></h2>
<p>Pygments is a syntax highlighting engine written in Python. That means, it will
take source code (or other markup) in a supported language and output a
processed version (in different formats) containing syntax highlighting markup.</p>
<p>Its features include:</p>
<ul class="simple">
<li>a wide range of common languages and markup formats is supported (look here
for a list)</li>
<li>new languages and formats are added easily</li>
<li>a number of output formats is available, including:<ul>
<li>HTML</li>
<li>ANSI sequences (console output)</li>
<li>LaTeX</li>
<li>RTF</li>
</ul>
</li>
<li>it is usable as a command-line tool and as a library</li>
<li>parsing and formatting is fast</li>
</ul>
<p>Pygments is licensed under the BSD license.</p>
</div>
<div class="section" id="where-does-the-name-pygments-come-from">
<h2>Where does the name Pygments come from?<a class="headerlink" href="#where-does-the-name-pygments-come-from" title="Permalink to this headline">¶</a></h2>
<p><em>Py</em> of course stands for Python, while <em>pigments</em> are used for coloring paint,
and in this case, source code!</p>
</div>
<div class="section" id="what-are-the-system-requirements">
<h2>What are the system requirements?<a class="headerlink" href="#what-are-the-system-requirements" title="Permalink to this headline">¶</a></h2>
<p>Pygments only needs a standard Python install, version 2.6 or higher or version
3.3 or higher for Python 3. No additional libraries are needed.</p>
</div>
<div class="section" id="how-can-i-use-pygments">
<h2>How can I use Pygments?<a class="headerlink" href="#how-can-i-use-pygments" title="Permalink to this headline">¶</a></h2>
<p>Pygments is usable as a command-line tool as well as a library.</p>
<p>From the command-line, usage looks like this (assuming the pygmentize script is
properly installed):</p>
<div class="highlight-python"><div class="highlight"><pre>pygmentize -f html /path/to/file.py
</pre></div>
</div>
<p>This will print a HTML-highlighted version of /path/to/file.py to standard output.</p>
<p>For a complete help, please run <tt class="docutils literal"><span class="pre">pygmentize</span> <span class="pre">-h</span></tt>.</p>
<p>Usage as a library is thoroughly demonstrated in the Documentation section.</p>
</div>
<div class="section" id="how-do-i-make-a-new-style">
<h2>How do I make a new style?<a class="headerlink" href="#how-do-i-make-a-new-style" title="Permalink to this headline">¶</a></h2>
<p>Please see the <a class="reference internal" href="docs/styles.html"><em>documentation on styles</em></a>.</p>
</div>
<div class="section" id="how-can-i-report-a-bug-or-suggest-a-feature">
<h2>How can I report a bug or suggest a feature?<a class="headerlink" href="#how-can-i-report-a-bug-or-suggest-a-feature" title="Permalink to this headline">¶</a></h2>
<p>Please report bugs and feature wishes in the tracker at Bitbucket.</p>
<p>You can also e-mail the author or use IRC, see the contact details.</p>
</div>
<div class="section" id="i-want-this-support-for-this-language">
<h2>I want this support for this language!<a class="headerlink" href="#i-want-this-support-for-this-language" title="Permalink to this headline">¶</a></h2>
<p>Instead of waiting for others to include language support, why not write it
yourself? All you have to know is <a class="reference internal" href="docs/lexerdevelopment.html"><em>outlined in the docs</em></a>.</p>
</div>
<div class="section" id="can-i-use-pygments-for-programming-language-processing">
<h2>Can I use Pygments for programming language processing?<a class="headerlink" href="#can-i-use-pygments-for-programming-language-processing" title="Permalink to this headline">¶</a></h2>
<p>The Pygments lexing machinery is quite powerful can be used to build lexers for
basically all languages. However, parsing them is not possible, though some
lexers go some steps in this direction in order to e.g. highlight function names
differently.</p>
<p>Also, error reporting is not the scope of Pygments. It focuses on correctly
highlighting syntactically valid documents, not finding and compensating errors.</p>
</div>
<div class="section" id="who-uses-pygments">
<h2>Who uses Pygments?<a class="headerlink" href="#who-uses-pygments" title="Permalink to this headline">¶</a></h2>
<p>This is an (incomplete) list of projects and sites known to use the Pygments highlighter.</p>
<ul class="simple">
<li><a class="reference external" href="http://pygments.appspot.com/">Pygments API</a>, a HTTP POST interface to Pygments</li>
<li><a class="reference external" href="http://sphinx.pocoo.org/">The Sphinx documentation builder</a>, for embedded source examples</li>
<li><a class="reference external" href="http://code.google.com/p/rst2pdf/">rst2pdf</a>, a reStructuredText to PDF converter</li>
<li><a class="reference external" href="http://zine.pocoo.org/">Zine</a>, a Python blogging system</li>
<li><a class="reference external" href="http://trac.edgewall.org/">Trac</a>, the universal project management tool</li>
<li><a class="reference external" href="http://r1chardj0n3s.googlepages.com/bruce">Bruce</a>, a reStructuredText presentation tool</li>
<li><a class="reference external" href="http://www.methods.co.nz/asciidoc/">AsciiDoc</a>, a text-based documentation generator</li>
<li><a class="reference external" href="http://code.activestate.com/">ActiveState Code</a>, the Python Cookbook successor</li>
<li><a class="reference external" href="http://viewvc.org/">ViewVC</a>, a web-based version control repository browser</li>
<li><a class="reference external" href="http://repo.or.cz/w/bzrfruit.git">BzrFruit</a>, a Bazaar branch viewer</li>
<li><a class="reference external" href="http://bazaar-vcs.org/QBzr">QBzr</a>, a cross-platform Qt-based GUI front end for Bazaar</li>
<li><a class="reference external" href="http://bitbucket.org/">BitBucket</a>, a Mercurial and Git hosting site</li>
<li><a class="reference external" href="http://github.com/">GitHub</a>, a site offering secure Git hosting and collaborative development</li>
<li><a class="reference external" href="http://www.review-board.org/">Review Board</a>, a collaborative code reviewing tool</li>
<li><a class="reference external" href="http://orangoo.com/skeletonz/">skeletonz</a>, a Python powered content management system</li>
<li><a class="reference external" href="http://code.google.com/p/diamanda/">Diamanda</a>, a Django powered wiki system with support for Pygments</li>
<li><a class="reference external" href="http://progopedia.ru/">Progopedia</a> (<a class="reference external" href="http://progopedia.com/">English</a>),
an encyclopedia of programming languages</li>
<li><a class="reference external" href="http://code.google.com/p/postmarkup/">Postmarkup</a>, a BBCode to XHTML generator</li>
<li><a class="reference external" href="http://michaelsilver.us/lc">Language Comparison</a>, a site that compares different programming languages</li>
<li><a class="reference external" href="http://www.noiseforfree.com/bpython/">BPython</a>, a curses-based intelligent Python shell</li>
<li><a class="reference external" href="http://challenge-you.appspot.com/">Challenge-You!</a>, a site offering programming challenges</li>
<li><a class="reference external" href="http://pida.co.uk/">PIDA</a>, a universal IDE written in Python</li>
<li><a class="reference external" href="http://pypi.python.org/pypi/pudb">PuDB</a>, a console Python debugger</li>
<li><a class="reference external" href="http://www.xwiki.org/">XWiki</a>, a wiki-based development framework in Java, using Jython</li>
<li><a class="reference external" href="http://ananelson.com/software/roux/">roux</a>, a script for running R scripts
and creating beautiful output including graphs</li>
<li><a class="reference external" href="http://hurl.it/">hurl</a>, a web service for making HTTP requests</li>
<li><a class="reference external" href="http://colinbarnette.net/projects/wxHTMLPygmentizer">wxHTMLPygmentizer</a> is
a GUI utility, used to make code-colorization easier</li>
<li><a class="reference external" href="http://blog.mirotin.net/?page_id=49">WpPygments</a>, a highlighter plugin for WordPress</li>
<li><a class="reference external" href="http://paste.pocoo.org/">LodgeIt</a>, a pastebin with XMLRPC support and diffs</li>
<li><a class="reference external" href="http://chrisarndt.de/projects/spammcan/">SpammCan</a>, a pastebin (demo see
<a class="reference external" href="http://paste.chrisarndt.de/">here</a>)</li>
<li><a class="reference external" href="http://www.wowace.com/paste/">WowAce.com pastes</a>, a pastebin</li>
<li><a class="reference external" href="http://siafoo.net">Siafoo</a>, a tool for sharing and storing useful code and programming experience</li>
<li><a class="reference external" href="http://www.dsource.org/">D source</a>, a community for the D programming language</li>
<li><a class="reference external" href="http://dumpz.org/">dumpz.org</a>, a pastebin</li>
<li><a class="reference external" href="http://dpaste.com/">dpaste.com</a>, another Django pastebin</li>
<li><a class="reference external" href="http://pylonshq.com/pasties/new">PylonsHQ Pasties</a>, a pastebin</li>
<li><a class="reference external" href="http://www.djangosnippets.org/">Django snippets</a>, a pastebin for Django code</li>
<li><a class="reference external" href="http://www.fayaa.com/code/">Fayaa</a>, a Chinese pastebin</li>
<li><a class="reference external" href="http://incollo.com">Incollo.com</a>, a free collaborative debugging tool</li>
<li><a class="reference external" href="http://p.boxnet.eu/">PasteBox</a>, a pastebin focused on privacy</li>
<li><a class="reference external" href="http://www.xinotes.org/">xinotes.org</a>, a site to share notes, code snippets etc.</li>
<li><a class="reference external" href="http://www.hilite.me/">hilite.me</a>, a site to highlight code snippets</li>
<li><a class="reference external" href="http://patx.me/paste">patx.me</a>, a pastebin</li>
</ul>
<p>If you have a project or web site using Pygments, drop me a line, and I’ll add a
link here.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Pygments FAQ</a><ul>
<li><a class="reference internal" href="#what-is-pygments">What is Pygments?</a></li>
<li><a class="reference internal" href="#where-does-the-name-pygments-come-from">Where does the name Pygments come from?</a></li>
<li><a class="reference internal" href="#what-are-the-system-requirements">What are the system requirements?</a></li>
<li><a class="reference internal" href="#how-can-i-use-pygments">How can I use Pygments?</a></li>
<li><a class="reference internal" href="#how-do-i-make-a-new-style">How do I make a new style?</a></li>
<li><a class="reference internal" href="#how-can-i-report-a-bug-or-suggest-a-feature">How can I report a bug or suggest a feature?</a></li>
<li><a class="reference internal" href="#i-want-this-support-for-this-language">I want this support for this language!</a></li>
<li><a class="reference internal" href="#can-i-use-pygments-for-programming-language-processing">Can I use Pygments for programming language processing?</a></li>
<li><a class="reference internal" href="#who-uses-pygments">Who uses Pygments?</a></li>
</ul>
</li>
</ul>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/faq.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">Pygments 2.0.1 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2014, Georg Brandl.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>
|