pygments.formatters.groff.GroffFormatter Class Reference

Inheritance diagram for pygments.formatters.groff.GroffFormatter:

Collaboration diagram for pygments.formatters.groff.GroffFormatter:

Public Member Functions
	__init__ (self, **options)
	format_unencoded (self, tokensource, outfile)
Public Member Functions inherited from pygments.formatter.Formatter
	get_style_defs (self, arg='')
	format (self, tokensource, outfile)
	__class_getitem__ (cls, name)

Public Attributes
	monospaced
	linenos
	wrap
	styles
Public Attributes inherited from pygments.formatter.Formatter
	style
	full
	title
	encoding
	options

Static Public Attributes
str	name = 'groff'
list	aliases = ['groff','troff','roff']
list	filenames = []
Static Public Attributes inherited from pygments.formatter.Formatter
	name = None
list	aliases = []
list	filenames = []
bool	unicodeoutput = True

Protected Member Functions
	_make_styles (self)
	_define_colors (self, outfile)
	_write_lineno (self, outfile)
	_wrap_line (self, line)
	_escape_chars (self, text)

Protected Attributes
	_lineno
	_linelen

Detailed Description

Format tokens with groff escapes to change their color and font style.

.. versionadded:: 2.11

Additional options accepted:

`style`
    The style to use, can be a string or a Style subclass (default:
    ``'default'``).

`monospaced`
    If set to true, monospace font will be used (default: ``true``).

`linenos`
    If set to true, print the line numbers (default: ``false``).

`wrap`
    Wrap lines to the specified number of characters. Disabled if set to 0
    (default: ``0``).

Constructor & Destructor Documentation

__init__()

pygments.formatters.groff.GroffFormatter.__init__	(		self,
		**	options
	)

As with lexers, this constructor takes arbitrary optional arguments,
and if you override it, you should first process your own options, then
call the base class implementation.

Reimplemented from pygments.formatter.Formatter.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/pygments/formatters/groff.py