# pygments - pydoc - phpman

Help on package pygments:

## NAME
    pygments

## DESCRIPTION
    Pygments
    ~~~~~~~~

    Pygments is a syntax highlighting package written in Python.

    It is 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. 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, RTF, SVG, all image
      formats that PIL supports, and ANSI sequences
    * it is usable as a command-line tool and as a library
    * ... and it highlights even Brainfuck!

    The `Pygments master branch`_ is installable with ``easy_install Pygments==dev``.

    .. _Pygments master branch:
       <https://github.com/pygments/pygments/archive/master.zip#egg=Pygments-dev>

    :copyright: Copyright 2006-2021 by the Pygments team, see AUTHORS.
    :license: BSD, see LICENSE for details.

## PACKAGE CONTENTS
    __main__
    cmdline
    console
    filter
    filters (package)
    formatter
    formatters (package)
    lexer
    lexers (package)
    modeline
    plugin
    regexopt
    scanner
    sphinxext
    style
    styles (package)
    token
    unistring
    util

## FUNCTIONS
### format
        Format a tokenlist ``tokens`` with the formatter ``formatter``.

        If ``outfile`` is given and a valid file object (an object
        with a ``write`` method), the result will be written to it, otherwise
        it is returned as a string.

### highlight
        Lex ``code`` with ``lexer`` and format it with the formatter ``formatter``.

        If ``outfile`` is given and a valid file object (an object
        with a ``write`` method), the result will be written to it, otherwise
        it is returned as a string.

### lex
        Lex ``code`` with ``lexer`` and return an iterable of tokens.

## DATA
    __all__ = ['lex', 'format', 'highlight']
    __docformat__ = 'restructuredtext'

## VERSION
    2.11.2

## FILE
    /usr/lib/python3/dist-packages/pygments/__init__.py