tldr/pages/common/pygmentize.md

# pygmentize

> Python-based syntax highlighter.
> More information: <https://pygments.org/docs/cmdline/>.

- Highlight file syntax and print to `stdout` (language is inferred from the file extension):

`pygmentize {{file.py}}`

- Explicitly set the language for syntax highlighting:

`pygmentize -l {{javascript}} {{input_file}}`

- List available lexers (processors for input languages):

`pygmentize -L lexers`

- Save output to a file in HTML format:

`pygmentize -f html -o {{output_file.html}} {{input_file.py}}`

- List available output formats:

`pygmentize -L formatters`

- Output an HTML file, with additional formatter options (full page, with line numbers):

`pygmentize -f html -O "full,linenos=True" -o {{output_file.html}} {{input_file}}`
add pygmentize 2017-04-17 20:03:00 +02:00			`# pygmentize`

pygmentize: various tweaks (#1355) * pygmentize: various tweaks - adjust punctuation in main description and first example's description - mention "list" (rather than "show") in the -L examples, to improve memorability - explain what lexers are - clarify which of the parameters are input and output filenames - simplify last example * make -O example more didactic References: - http://pygments.org/docs/cmdline/#options-and-filters - http://pygments.org/docs/formatters/#HtmlFormatter * pygmentize: changes per code review * pygentize: fix typos 2017-05-03 20:54:49 +01:00			`> Python-based syntax highlighter.`
ps, pv, pygmentize, quota, rabin2: add link (#6830) 2021-10-06 14:51:52 -07:00			`> More information: <https://pygments.org/docs/cmdline/>.`
add pygmentize 2017-04-17 20:03:00 +02:00
pages/: add backticks around I/O streams (#10436) as suggested in #10428 * standard input => `stdin` * standard output => `stdout` * standard error => `stderr` Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> 2023-08-09 07:29:02 +02:00			- Highlight file syntax and print to `stdout` (language is inferred from the file extension):
add pygmentize 2017-04-17 20:03:00 +02:00
Simplify pygmentize - Simplify main description - Mentioning that language is inferred from file extension - Giving a concrete example for another lexer. 2017-04-24 12:03:27 +05:30			`pygmentize {{file.py}}`
add pygmentize 2017-04-17 20:03:00 +02:00
pygmentize: various tweaks (#1355) * pygmentize: various tweaks - adjust punctuation in main description and first example's description - mention "list" (rather than "show") in the -L examples, to improve memorability - explain what lexers are - clarify which of the parameters are input and output filenames - simplify last example * make -O example more didactic References: - http://pygments.org/docs/cmdline/#options-and-filters - http://pygments.org/docs/formatters/#HtmlFormatter * pygmentize: changes per code review * pygentize: fix typos 2017-05-03 20:54:49 +01:00			`- Explicitly set the language for syntax highlighting:`
add pygmentize 2017-04-17 20:03:00 +02:00
pygmentize: various tweaks (#1355) * pygmentize: various tweaks - adjust punctuation in main description and first example's description - mention "list" (rather than "show") in the -L examples, to improve memorability - explain what lexers are - clarify which of the parameters are input and output filenames - simplify last example * make -O example more didactic References: - http://pygments.org/docs/cmdline/#options-and-filters - http://pygments.org/docs/formatters/#HtmlFormatter * pygmentize: changes per code review * pygentize: fix typos 2017-05-03 20:54:49 +01:00			`pygmentize -l {{javascript}} {{input_file}}`
add pygmentize 2017-04-17 20:03:00 +02:00
pygmentize: various tweaks (#1355) * pygmentize: various tweaks - adjust punctuation in main description and first example's description - mention "list" (rather than "show") in the -L examples, to improve memorability - explain what lexers are - clarify which of the parameters are input and output filenames - simplify last example * make -O example more didactic References: - http://pygments.org/docs/cmdline/#options-and-filters - http://pygments.org/docs/formatters/#HtmlFormatter * pygmentize: changes per code review * pygentize: fix typos 2017-05-03 20:54:49 +01:00			`- List available lexers (processors for input languages):`
add pygmentize 2017-04-17 20:03:00 +02:00
			`pygmentize -L lexers`

minor changes 2017-04-24 18:23:05 +02:00			`- Save output to a file in HTML format:`
add pygmentize 2017-04-17 20:03:00 +02:00
pygmentize: various tweaks (#1355) * pygmentize: various tweaks - adjust punctuation in main description and first example's description - mention "list" (rather than "show") in the -L examples, to improve memorability - explain what lexers are - clarify which of the parameters are input and output filenames - simplify last example * make -O example more didactic References: - http://pygments.org/docs/cmdline/#options-and-filters - http://pygments.org/docs/formatters/#HtmlFormatter * pygmentize: changes per code review * pygentize: fix typos 2017-05-03 20:54:49 +01:00			`pygmentize -f html -o {{output_file.html}} {{input_file.py}}`
add pygmentize 2017-04-17 20:03:00 +02:00
pygmentize: various tweaks (#1355) * pygmentize: various tweaks - adjust punctuation in main description and first example's description - mention "list" (rather than "show") in the -L examples, to improve memorability - explain what lexers are - clarify which of the parameters are input and output filenames - simplify last example * make -O example more didactic References: - http://pygments.org/docs/cmdline/#options-and-filters - http://pygments.org/docs/formatters/#HtmlFormatter * pygmentize: changes per code review * pygentize: fix typos 2017-05-03 20:54:49 +01:00			`- List available output formats:`
add pygmentize 2017-04-17 20:03:00 +02:00
			`pygmentize -L formatters`

pygmentize: various tweaks (#1355) * pygmentize: various tweaks - adjust punctuation in main description and first example's description - mention "list" (rather than "show") in the -L examples, to improve memorability - explain what lexers are - clarify which of the parameters are input and output filenames - simplify last example * make -O example more didactic References: - http://pygments.org/docs/cmdline/#options-and-filters - http://pygments.org/docs/formatters/#HtmlFormatter * pygmentize: changes per code review * pygentize: fix typos 2017-05-03 20:54:49 +01:00			`- Output an HTML file, with additional formatter options (full page, with line numbers):`
add pygmentize 2017-04-17 20:03:00 +02:00
pygmentize: various tweaks (#1355) * pygmentize: various tweaks - adjust punctuation in main description and first example's description - mention "list" (rather than "show") in the -L examples, to improve memorability - explain what lexers are - clarify which of the parameters are input and output filenames - simplify last example * make -O example more didactic References: - http://pygments.org/docs/cmdline/#options-and-filters - http://pygments.org/docs/formatters/#HtmlFormatter * pygmentize: changes per code review * pygentize: fix typos 2017-05-03 20:54:49 +01:00			`pygmentize -f html -O "full,linenos=True" -o {{output_file.html}} {{input_file}}`