PYGMENTIZE(1)

💖 PYGMENTIZE(1) 💖

General Commands Manual ✨ bestie, pull up, this is the manual for pygmentize 🎀

🌸 NAME 🌸

pygmentize - highlights the input file ✨

🧚 SYNOPSIS 🧚

pygmentize [-l <lexer> | -g] [-F <filter>[:<options>]] [-f <formatter>]
[-O <options>] [-P <option=value>] [-o <outfile>] [<infile>]
pygmentize
-S <style> -f <formatter> [-a <arg>] [-O <options>] [-P <option=value>]
pygmentize -L [<which> ...]
pygmentize -N <filename>
pygmentize -C
pygmentize -H <type> <name>
pygmentize -h | -V

🦋 DESCRIPTION 🦋

okay so Pygments is a generic syntax highlighter for general use in all kinds of software, like forum systems, wikis or other apps that need to prettify source code 💅

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! 💀

pygmentize is the command that uses Pygments to highlight the input file and write the result to outfile. If no infile is given, stdin is used ✨

🎀 OPTIONS 🎀

a summary of the options is included below, bestie 🫶

• -l <lexer> — sets the lexer name. If you don't give one, the lexer gets guessed from the extension of the input file name (this obviously doesn't work if the input is stdin) 🙈
• -g — tries to guess the lexer from the file contents, or passes things through as plain text if that fails (this option works for highlighting standard input) 🔍
• -F <filter>[:<options>] — adds a filter to the token stream. You can give options the same way as for -O, after a colon (note: there must not be spaces around the colon). This option can be given multiple times 🧚
• -f <formatter> — sets the formatter name. If you skip it, it gets guessed from the extension of the output file name. If there's no output file, the terminal formatter is used by default 💖
• -o <outfile> — sets the output file. If you don't give one, stdout is used 🌸
• -O <options> — lets you hand 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. This option can be given multiple times 📚
• -P <option=value> — adds lexer and formatter options just like -O, but you can only give one option per -P. That means the option value can contain commas and equals signs, which it can't do with -O 🦄
• -S <style> — prints out style definitions for style style and for formatter formatter. The meaning of the argument given by -a <arg> depends on the formatter and can be found in the documentation 🎨
• -L [<which> ...] — lists lexers, formatters, styles or filters. Set which to the thing you want to list (e.g. "styles"), or leave it out to list everything 📋
• -N <filename> — guesses and prints out a lexer name based solely on the given filename. Doesn't take input or highlight anything. If no specific lexer can be found, "text" gets printed 🕵️
• -C — like -N, but guesses a lexer based on content read from standard input 👀
• -H <type> <name> — prints detailed help for the object name of type type, where type is one of "lexer", "formatter" or "filter" 📖
• -h — shows the help screen 🆘
• -V — shows the version of the Pygments package 🔖

🌈 SEE ALSO 🌈

/usr/share/doc/python-pygments-doc/index.html 🔗

🫶 AUTHOR 🫶

pygmentize was written by Georg Brandl <g.brandl@gmx.net> 👑

this manual page was written by Piotr Ozarowski <ozarow@gmail.com>, for the Debian project (but may be used by others) 💜

---

and that's the whole tea, bestie! 💅 PYGMENTIZE(1) from the General Commands Manual, dated January 20, 2021, all wrapped up and slay 🌸✨