# groff_man

## Name



           groff_man - compose manual pages with GNU _roff_
    


## Synopsis



           **groff -man**[_option_ ...] [_file_ ...]
    
           **groff -m man**[_option_ ...] [_file_ ...]
    


## Description



           The GNU implementation of the _man_ macro package is part of the
           _groff_ document formatting system.  It is used to compose manual
           pages (“man pages”) like the one you are reading.  This document
           presents the macros thematically; for those needing only a quick
           reference, the following table lists them alphabetically, with
           references to appropriate subsections below.
    
           Readers who are not already experienced _groff_ users should consult
           _groff_man_style_(7), an expanded version of this document, for
           additional explanations and advice.  It covers only those concepts
           required for man page document maintenance, and not the full
           breadth of the _groff_ typesetting system.
    
           Macro   Meaning                               Subsection
           ────────────────────────────────────────────────────────────────────────
           **.B** Bold                                  Font style macros
           **.BI** Bold, italic alternating              Font style macros
           **.BR** Bold, roman alternating               Font style macros
           **.EE** Example end                           Document structure macros
           **.EX** Example begin                         Document structure macros
           **.HP** Begin paragraph with hanging indent   Paragraphing macros
           **.I** Italic                                Font style macros
           **.IB** Italic, bold alternating              Font style macros
           **.IP** Indented paragraph                    Paragraphing macros
           **.IR** Italic, roman alternating             Font style macros
           **.LP** Begin paragraph                       Paragraphing macros
           **.ME** Mail-to end                           Hyperlink macros
           **.MR** Man page cross reference              Hyperlink macros
           **.MT** Mail-to start                         Hyperlink macros
           **.P** Begin paragraph                       Paragraphing macros
           **.PP** Begin paragraph                       Paragraphing macros
           **.RB** Roman, bold alternating               Font style macros
           **.RE** Relative inset end                    Document structure macros
           **.RI** Roman, italic alternating             Font style macros
           **.RS** Relative inset start                  Document structure macros
           **.SH** Section heading                       Document structure macros
           **.SM** Small                                 Font style macros
           **.SS** Subsection heading                    Document structure macros
           **.SY** Synopsis start                        Synopsis macros
           **.TH** Title heading                         Document structure macros
           **.TP** Tagged paragraph                      Paragraphing macros
           **.TQ** Supplemental paragraph tag            Paragraphing macros
           **.UE** URI end                               Hyperlink macros
           **.UR** URI start                             Hyperlink macros
           **.YS** Synopsis end                          Synopsis macros
    
           We discuss other macros (**AT** , **DT** , **OP** , **PD** , **SB** , and **UC**) in subsection
           “Deprecated features” below.
    
           Throughout Unix documentation, a manual entry is referred to
           simply as a “man page”, regardless of its length, without gendered
           implication, and irrespective of the macro package selected for
           its composition.
    
       **Macro reference preliminaries**
           A tagged paragraph describes each macro.  We present coupled pairs
           together, as with **EX** and **EE**.  If you require an empty macro
           argument, specify it as a pair of neutral double quotes (**""**).
           Most macro arguments are formatted as text in the output;
           exceptions are noted.
    
       **Document structure macros**
           Document structure macros organize a man page's content.  All of
           them break the output line.  **TH**(title heading) identifies the
           document as a man page and configures the page headers and
           footers.  Section headings (**SH**), one of which is mandatory and
           many of which are conventionally expected, facilitate location of
           material by the reader and aid the man page writer to discuss all
           essential aspects of the topics presented.  Subsection headings
           (**SS**) are optional and permit sections that grow long to develop in
           a controlled way.  Many technical discussions benefit from
           examples; lengthy ones, especially those reflecting multiple lines
           of input to or output from the system, are usefully bracketed by
           **EX** and **EE**.  When none of the foregoing meets a structural demand,
           use **RS** /**RE** to inset a region within a (sub)section.
    
           **.TH** _identifier section_ [_footer-middle_ [_footer-inside_ [_header-_
           _middle_]]]
                  Populate the page header and footer.  Together, _identifier_
                  and the _section_ of the manual to which it belongs can
                  uniquely identify a _man_ document on the system.  See _man_(1)
                  or _intro_(1) for the manual sectioning applicable to your
                  system.  _identifier_ and _section_ are positioned at the left
                  and right in the header; the latter is set after the
                  former, in parentheses and without space.  _footer-middle_ is
                  centered in the footer.  By default, _footer-inside_ is
                  positioned at the bottom left.  Use of the double-sided
                  layout option **-rD1** places _footer-inside_ at the bottom left
                  on recto (odd-numbered) pages, and the bottom right on
                  verso (even-numbered) pages.  By default, the outside
                  footer is the page number.  Use of the continuous-rendering
                  option **-rcR=1** replaces it with _identifier_ and _section,_ as
                  in the header.  _header-middle_ is centered in the header.
                  If _section_ is an integer between 1 and 9 (inclusive), there
                  is no need to specify _header-middle; an.tmac_ supplies text
                  for it.  If _identifier_ or _footer-inside_ would overrun the
                  space available in the header and/or footer, this package
                  may abbreviate them with ellipses.  In HTML output, headers
                  and footers are suppressed.
    
                  Additionally, this macro breaks the page, resetting the
                  number to 1 (unless the **-rC1** option is given).  This
                  feature is intended only for formatting multiple _man_
                  documents in sequence.
    
                  A valid _man_ document calls **TH** only once, early in the file,
                  prior to any other macro calls.
    
           **.SH**[_heading-text_]
                  Set _heading-text_ as a section heading.  Given no argument,
                  **SH** plants a one-line input trap; text on the next line
                  becomes _heading-text._  The heading text is set in bold (or
                  the font specified by the string **HF**), and, on typesetters,
                  slightly larger than the base type size.  If the heading
                  font **\*[HF]** is bold, use of an italic style in _heading-text_
                  is mapped to the bold-italic style if available in the font
                  family.  The inset level is reset to 1; see subsection
                  “Horizontal and vertical spacing” below.  Text lines after
                  the call are set as an ordinary paragraph (**P**).
    
                  The content of _heading-text_ and ordering of sections
                  follows a set of common practices, as does much of the
                  layout of material within sections.  For example, a section
                  called “Name” or “NAME” must exist, must be the first
                  section after the **TH** call, and must contain only text of
                  the form
                         _topic_[**,**_another-topic_]... \- _summary-description_
                  for tools like _makewhatis_(8) or _mandb_(8) to index them.
    
           **.SS**[_subheading-text_]
                  Set _subheading-text_ as a subsection heading indented
                  between a section heading and an ordinary paragraph (**P**).
                  Given no argument, **SS** plants a one-line input trap; text on
                  the next line becomes _subheading-text._  The subheading text
                  is set in bold (or the font specified by the string **HF**).
                  If the heading font **\*[HF]** is bold, use of an italic style
                  in _subheading-text_ is mapped to the bold-italic style if
                  available in the font family.  The inset level is reset to
                  1; see subsection “Horizontal and vertical spacing” below.
                  Text lines after the call are set as an ordinary paragraph
                  (**P**).
    
           **.EX**
           **.EE** Begin and end example.  After **EX** , filling is disabled (and,
                  on typesetters, a monospaced font family is selected).
                  Calling **EE** enables filling (and restores the previous
                  family).
    
                  Ninth Edition Unix introduced the **EX** and **EE** extensions.
                  Documenter's Workbench (DWB), Heirloom Doctools, and Plan 9
                  _troff_ s, and _mandoc_ (since 1.12.2) support them.  Solaris 10
                  _troff_ does not.
    
           **.RS**[_inset-amount_]
                  Start new relative inset.  _man_ saves any current inset
                  amount and moves right by: _inset-amount,_ if specified; the
                  _indentation_ amount of the preceding **IP** , **TP** , or **HP** macro
                  call if no (sub-)sectioning or ordinary paragraphing macro
                  has intervened; or the amount of the **IN** register.  **RS** calls
                  can nest; each increments by 1 the _level_ used by **RE**.  The
                  level prior to any **RS** call is 1.
    
           **.RE**[_inset-level_]
                  End a relative inset, restoring the inset amount of _inset-_
                  _level,_ or 1 if none is specified.
    
       **Paragraphing macros**
           These macros break the output line.  An _ordinary_ paragraph (**P**)
           indents all output lines by the same amount.  A hanging paragraph
           (**HP**) is a cosmetic variant of **P** with a hanging indent.  Definition
           lists frequently occur in man pages; these can be set as _tagged_
           _paragraphs,_ which have one (**TP**) or more (**TQ**) leading tags followed
           by a paragraph that has an additional indentation.  The indented
           paragraph (**IP**) macro is useful to continue the indented content of
           a narrative started with **TP** , or to present an itemized or ordered
           list.  If paragraph macro has been called since **SH** or **SS** , all
           except for **TQ** follow the break with vertical space (in an amount
           configured by the deprecated **PD** macro); see subsection “Horizontal
           and vertical spacing” below.  Except for **TQ** , these macros reset
           the type size and font style to defaults, and restore the
           configured hyphenation mode.
    
           **.P**
           **.LP**
           **.PP** Begin a new paragraph; these macros are synonymous.  Any
                  indentation from use of **IP** , **TP** , or **HP** is cleared.  The
                  inset amount, as affected by **RS** and **RE** , is not.
    
           **.HP**[_indentation_]
                  Set a paragraph with a hanging indentation.  Text on output
                  lines after the first is indented by _indentation,_ if
                  specified, and by the amount of the **IN** register otherwise.
    
                  _Caution:_ A hanging indentation cannot be expressed
                  naturally in (pure) HTML, a hanging paragraph is not
                  distinguishable from an ordinary one if it formats on only
                  one output line, and non-_roff_ -based man page interpreters
                  may treat **HP** as an ordinary paragraph anyway.  Thus,
                  information or distinctions you mean to express with
                  indentation may be lost.
    
           **.TP**[_indentation_]
                  Set an indented paragraph with a leading unindented tag.
                  The macro plants a one-line input trap that honors the **\c**
                  escape sequence; text on the next line becomes the tag, set
                  without indentation.  Text on subsequent lines is indented
                  by _indentation,_ if specified, and by the amount of the **IN**
                  register otherwise.  If the tag, plus the “tag spacing”
                  stored in the **TS** register (see section “Options” below) is
                  wider than the indentation, the package breaks the line
                  after the tag.
    
           **.TQ** Set an additional tag for a paragraph tagged with **TP** ,
                  planting a one-line input trap as with **TP**.
    
                  **TQ** is a GNU extension supported by Heirloom Doctools _troff_
                  (since Git snapshot 151220) and _mandoc_ (since 1.14.5) but
                  not by DWB, Plan 9, or Solaris 10 _troff_ s.
    
                  The description of **P** , **LP** , and **PP** above was written using **TP**
                  and **TQ**.
    
           **.IP**[_mark_ [_indentation_]]
                  Set an indented paragraph with an optional mark.
                  Arguments, if present, are handled as with **TP** , except that
                  the _mark_ argument to **IP** cannot include a macro call, and
                  the tag separation amount stored in the **TS** register is not
                  enforced.
    
       **Synopsis macros**
           Use **SY** and **YS** to summarize syntax using familiar Unix conventions.
           Heirloom Doctools _troff_ and _mandoc_ (since 1.14.5) support these
           GNU extensions; DWB, Plan 9, or Solaris 10 _troff_ s do not.
    
           **.SY** _keyword_ [_suffix_]
                  Begin synopsis.  Adjustment and automatic hyphenation are
                  disabled.  If **SY** has already been called without a
                  corresponding **YS** , a break is performed.  _keyword_ and any
                  _suffix_ are set in bold.  When _suffix_ is present, _groff man_
                  sets the next word after it without intervening space.  If
                  a break is required in subsequent text (up to a
                  paragraphing, sectioning, or **YS** macro call), lines after
                  the first are indented.  Unless the previous synopsis's
                  indentation is reused (see **YS** below), output lines after
                  the first indent by the width of the pending output line up
                  to the end of _keyword_ plus a space, if _keyword_ is the only
                  argument, and up to the end of _suffix_ otherwise.
    
           **.YS**[_reuse-indentation_]
                  End synopsis, breaking the line and restoring indentation,
                  adjustment, and hyphenation to their previous states.  If
                  an argument is given, the indentation corresponding to the
                  previous **SY** call is reused by the next **SY** call instead of
                  being computed.
    
       **Hyperlink macros**
           Man page cross references are best presented with **MR**.  Mark email
           addresses with **MT** /**ME** and other sorts of URI with **UR** /**UE**.  To
           hyperlink text, terminals and pager programs must support ECMA-48
           OSC 8 escape sequences (see _grotty_(1)).  When device support is
           unavailable or disabled with the **U** register (see section “Options”
           below), _groff man_ renders these URIs between angle brackets (**⟨ ⟩**)
           after the linked text.
    
           **MT** , **ME** , **UR** , and **UE** are GNU extensions supported by Heirloom
           Doctools and _mandoc_ (**UR** /**UE** since 1.12.3; **MT** /**ME** since 1.14.2) but
           not by DWB, Plan 9 (original), or Solaris 10 _troff_ s.  Plan 9 from
           User Space's _troff_ implements **MR**.
    
           Prepare arguments to **MR** , **MT** , and **UR** for typesetting; they can
           appear in the output.  Use special character escape sequences to
           encode Unicode basic Latin characters where necessary,
           particularly the hyphen-minus.
    
           **.MR** _topic_ [_manual-section_ [_trailing-text_]]
                  _(since_ groff _1.23)_ Set a man page cross reference as
                  “ _topic_**(**_manual-section_**)** ”.  If _manual-section_ is absent, the
                  package omits the surrounding parentheses.  If _trailing-_
                  _text_ (typically punctuation) is specified, it follows the
                  closing parenthesis without intervening space.  Hyphenation
                  is disabled while the cross reference is set.  _topic_ is set
                  in the font specified by the **MF** string.  If _manual-section_
                  is present, the cross reference hyperlinks to a URI of the
                  form “**man:**_topic_(_manual-section_)”.
    
           **.MT** _address_
           **.ME**[_trailing-text_]
                  Identify _address_ as an RFC 6068 _addr-spec_ for a “mailto:”
                  URI with the text between the two macro calls as the link
                  text.  An argument to **ME** is placed after the link text
                  without intervening space.  _address_ may not be visible in
                  the rendered document if hyperlinks are enabled and
                  supported by the output driver.  If they are not, _address_
                  is set in angle brackets after the link text and before
                  _trailing-text._  If hyperlinking is enabled but there is no
                  link text, _address_ is formatted and hyperlinked _without_
                  angle brackets.
    
           **.UR** _uri_
           **.UE**[_trailing-text_]
                  Identify _uri_ as an RFC 3986 URI hyperlink with the text
                  between the two macro calls as the link text.  An argument
                  to **UE** is placed after the link text without intervening
                  space.  _uri_ may not be visible in the rendered document if
                  hyperlinks are enabled and supported by the output driver.
                  If they are not, _uri_ is set in angle brackets after the
                  link text and before _trailing-text._  If hyperlinking is
                  enabled but there is no link text, _uri_ is formatted and
                  hyperlinked _without_ angle brackets.
    
           If a **UR** /**UE** or **MT** /**ME** pair occurs in a **TP** tag and hyperlinking is
           unavailable, _groff man_ sets the link target at the beginning of
           the indented paragraph, not as part of the tag.
    
       **Font style macros**
           The _man_ macro package is limited in its font styling options,
           offering only **bold**(**B**), _italic_ (**I**), and roman.  Italic text may
           instead render underscored on terminals.  **SM** sets text at a
           smaller type size, which differs visually from regular-sized text
           only on typesetters.  The macros **BI** , **BR** , **IB** , **IR** , **RB** , and **RI** set
           their odd- and even-numbered arguments as text in the alternating
           styles their names indicate, with no space separating them.
    
           The default type size and family for typesetters is 10-point
           Times, except on the **X75-12** and **X100-12** devices where the type
           size is 12 points.  The default style is roman.
    
           **.B**[_text_]
                  Set _text_ in bold.  Given no argument, **B** plants a one-line
                  input trap; text on the next line, which can be further
                  formatted with a macro, is set in bold.
    
           **.I**[_text_]
                  Set _text_ in an italic or oblique face.  Given no argument,
                  **I** plants a one-line input trap; text on the next line,
                  which can be further formatted with a macro, is set in an
                  italic or oblique face.
    
           **.SM**[_text_]
                  Set _text_ one point smaller than the default type size on
                  typesetters.  Given no argument, **SM** plants a one-line input
                  trap; text on the next line, which can be further formatted
                  with a macro, is set smaller.
    
           Unlike the above font style macros, the font style alternation
           macros below set no input traps; they must be given arguments to
           have effect.  They apply italic corrections as appropriate.
    
           **.BI** _bold-text italic-text_ ...
                  Set each argument in bold and italics, alternately.
    
           **.BR** _bold-text roman-text_ ...
                  Set each argument in bold and roman, alternately.
    
           **.IB** _italic-text bold-text_ ...
                  Set each argument in italics and bold, alternately.
    
           **.IR** _italic-text roman-text_ ...
                  Set each argument in italics and roman, alternately.
    
           **.RB** _roman-text bold-text_ ...
                  Set each argument in roman and bold, alternately.
    
           **.RI** _roman-text italic-text_ ...
                  Set each argument in roman and italics, alternately.
    
       **Horizontal and vertical spacing**
           The package sets all text inboard of the left edge of the output
           medium by the amount of the _page offset;_ see register **PO** in
           section “Options” below.  Headers, footers (both set with **TH**), and
           section headings (**SH**) lie at the page offset.  _groff man_ indents
           subsection headings (**SS**) by the amount in the **SN** register.
    
           Ordinary paragraphs not within an **RS** /**RE** inset region are inset by
           the amount stored in the **BP** register; see section “Options” below.
           The **IN** register configures the default indentation amount used by
           **RS**(as the _inset-amount_), **IP** , **TP** , and **HP** ; an overriding argument
           is a number plus an optional scaling unit.  If no scaling unit is
           given, the _man_ package assumes “n”.  An indentation specified in a
           call to **IP** , **TP** , or **HP** persists until (1) another of these macros
           is called with an _indentation_ argument, or (2) **SH** , **SS** , or **P** or its
           synonyms is called; these clear the indentation entirely.
    
           Several macros insert vertical space: **SH** , **SS** , **TP** , **P**(and its
           synonyms), **IP** , and **HP**.  The default inter-section and inter-
           paragraph spacing is 1v for terminals and 0.4v for typesetters.
           (The deprecated macro **PD** can change this vertical spacing, but we
           discourage its use.)  Between **EX** and **EE** calls, the inter-paragraph
           spacing is 1v regardless of output device.
    
       **Registers**
           Registers are described in section “Options” below.  They can be
           set not only on the command line but in the site _man.local_ file as
           well; see section “Files” below.
    
       **Strings**
           The following strings are defined for use in man pages.  None of
           these is necessary in a contemporary man page; see
           _groff_man_style_(7).  _groff man_ supports others for configuration
           of rendering parameters; see section “Options” below.
    
           **\*R** interpolates a special character escape sequence for the
                  “registered sign” glyph, **\(rg** , if available, and “(Reg.)”
                  otherwise.
    
           **\*S** interpolates an escape sequence setting the type size to
                  the document default.
    
           **\*(lq**
           **\*(rq** interpolate special character escape sequences for left and
                  right double-quotation marks, **\(lq** and **\(rq** , respectively.
    
           **\*(Tm** interpolates a special character escape sequence for the
                  “trade mark sign” glyph, **\(tm** , if available, and “(TM)”
                  otherwise.
    
       **Hooks**
           Two macros, both GNU extensions, are called internally by the
           _groff man_ package to format page headers and footers and can be
           redefined by the administrator in a site's _man.local_ file (see
           section “Files” below).  The presentation of **TH** above describes
           the default headers and footers.  Because these macros are hooks
           for _groff man_ internals, man pages have no reason to call them.
           Such hook definitions typically consist of “sp” and “tl” requests.
           **PT** furthermore has the responsibility of emitting a PDF bookmark
           after writing the first page header in a document.  Consult the
           existing implementations in _an.tmac_ when drafting replacements.
    
           **.BT** Set the page footer text (“bottom trap”).
    
           **.PT** Set the page header text (“page trap”).
    
           To remove a page header or footer entirely, define the appropriate
           macro as empty rather than deleting it.
    
       **Deprecated features**
           Use of the following in man pages for public distribution is
           discouraged.
    
           **.AT**[_system_ [_release_]]
                  Alter the footer for use with legacy AT&T man pages,
                  overriding any definition of the _footer-inside_ argument to
                  **TH**.  This macro exists only to render man pages from
                  historical systems.
    
                  The inside footer is populated per the value of _system._
    
                         3      7th edition _(default)_
    
                         4      System III
    
                         5      System V
    
                  The optional _release_ argument specifies the release number,
                  as in “System V Release 3”.
    
           **.DT** Reset tab stops to the default (every 0.5i).
    
                  Use of this presentation-oriented macro is deprecated.  It
                  translates poorly to HTML, under which exact space control
                  and tabulation are not readily available.  Thus,
                  information or distinctions that you use tab stops to
                  express are likely to be lost.  If you feel tempted to
                  change the tab stops such that calling this macro later to
                  restore them is desirable, consider composing a table using
                  _tbl_(1) instead.
    
           **.OP** _option-name_ [_option-argument_]
                  Indicate an optional command parameter called _option-name_ ,
                  which is set in bold.  If the option takes an argument,
                  specify _option-argument_ using a noun, abbreviation, or
                  hyphenated noun phrase.  If present, _option-argument_ is
                  preceded by a space and set in italics.  Square brackets in
                  roman surround both arguments.
    
                  Use of this quasi-semantic macro, an extension whose name
                  originated in DWB _troff_ , is deprecated; _groff_ 's
                  implementation differs.  Neither can easily be used to
                  annotate options that take optional arguments or options
                  whose arguments have internal structure (such as a mixture
                  of literal and variable components).  One could work around
                  these limitations with font selection escape sequences, but
                  font style alternation macros are preferable; they are more
                  flexible and perform italic corrections on typesetters.
    
           **.PD**[_vertical-space_]
                  Configure the amount of vertical space between paragraphs
                  or (sub)sections.  The optional argument _vertical-space_
                  specifies the amount; the default scaling unit is “v”.
                  Without an argument, inter-paragraph spacing resets to its
                  default value; see subsection “Horizontal and vertical
                  spacing” above.
    
                  Use of this presentation-oriented macro is deprecated.  It
                  translates poorly to HTML, under which exact control of
                  inter-paragraph spacing is not readily available.  Thus,
                  information or distinctions that you use **PD** to express are
                  likely to be lost.
    
           **.SB**[_text_]
                  Set _text_ in bold and (on typesetters) one point smaller
                  than the default type size.  Given no argument, **SB** plants a
                  one-line input trap; text on the next line, which can be
                  further formatted with a macro, is set smaller and in bold.
                  Use of this macro, an extension originating in SunOS 4.0
                  _troff_ , is deprecated.  **SM** without an argument, followed
                  immediately by “**B** _text_ ”, produces the same output more
                  portably.  The macros' order is interchangeable; put _text_
                  with the latter.
    
           **.UC**[_version_]
                  Alter the footer for use with legacy BSD man pages,
                  overriding any definition of the _footer-inside_ argument to
                  **TH**.  This macro exists only to render man pages from
                  historical systems.
    
                  The inside footer is populated per the value of _version._
    
                         3      3rd Berkeley Distribution _(default)_
    
                         4      4th Berkeley Distribution
    
                         5      4.2 Berkeley Distribution
    
                         6      4.3 Berkeley Distribution
    
                         7      4.4 Berkeley Distribution
    
       **History**
           M. Douglas McIlroy ⟨m.douglas.mcilroy@dartmouth.edu⟩ designed,
           implemented, and documented the AT&T _man_ macros for Unix Version 7
           (1979) and employed them to edit Volume 1 of its _Programmer's_
           _Manual_ , a compilation of all man pages supplied by the system.
           The package supported the macros listed in this page not described
           as extensions, except **P** and the deprecated **AT** and **UC**.  It
           documented no registers and defined only **R** and **S** strings.
    
           **UC** appeared in 3BSD (1980).  Unix System III (1980) introduced **P**
           and exposed the registers **IN** and **LL** , which had been internal to
           Seventh Edition Unix _man_.  PWB/Unix 2.0 (1980) added the **Tm**
           string.  4BSD (1980) added **lq** and **rq** strings.  SunOS 2.0 (1985)
           recognized **C** , **D** , **P** , and **X** registers.  4.3BSD (1986) added **AT** and
           **P**.  Ninth Edition Unix (1986) introduced **EX** and **EE**.  SunOS 4.0
           (1988) added **SB**.
    
           Except for **EX** /**EE** , James Clark implemented the foregoing features
           in early versions of _groff._  Later, _groff_ 1.20 (2009) resurrected
           **EX** /**EE** and originated **SY** /**YS** , **TQ** , **MT** /**ME** , and **UR** /**UE**.  Plan 9 from
           User Space's _troff_ introduced **MR** in 2020.
    


## Options



           The following _groff_ options set registers (with **-r**) and strings
           (with **-d**) recognized and used by the _man_ macro package.  To ensure
           rendering consistent with output device capabilities and reader
           preferences, man pages should never manipulate them.
    
           **-dAD=**_adjustment-mode_
                  Set line adjustment to _adjustment-mode,_ which is typically
                  “**b** ” for adjustment to both margins (the default), or “**l** ”
                  for left alignment (ragged right margin).  Any valid
                  argument to _groff_ 's “ad” request may be used.  See _groff_(7)
                  for less-common choices.
    
           **-rBP=**_base-paragraph-inset_
                  Set the inset amount for ordinary paragraphs not within an
                  **RS** /**RE** inset.  The default is 5n.
    
           **-rcR=1** Enable continuous rendering.  Output is not paginated;
                  instead, one (potentially very long) page is produced.
                  This is the default for terminal and HTML devices.  Use
                  **-rcR=0** to disable it on terminals; on HTML devices, it
                  cannot be disabled.
    
           **-rC1** Number output pages consecutively, in strictly increasing
                  sequence, rather than resetting the page number to 1 (or
                  the value of register **P**) with each new _man_ document.
    
           **-rCHECKSTYLE=**_n_
                  Report problems with usage of this macro package exhibited
                  by the input at verbosity level _n_ , where _n_ is an integer in
                  the range 0–3, inclusive; **0** disables the messages and is
                  the default.  This feature is a development and debugging
                  aid for man page maintainers; the problems diagnosed, and
                  range and meanings of the supported levels, are subject to
                  change.
    
           **-rCS=1** Set section headings (the argument(s) to **SH**) in full
                  capitals.  This transformation is off by default because it
                  discards lettercase distinctions.
    
           **-rCT=1** Set the man page identifier (the first argument to **TH**) in
                  full capitals in headers and footers.  This transformation
                  is off by default because it discards lettercase
                  distinctions.
    
           **-rD1** Enable double-sided layout, formatting footers for even and
                  odd pages differently; see the description of **TH** in
                  subsection “Document structure macros” above.
    
           **-rFT=**_footer-distance_
                  Set distance of the footer relative to the bottom of the
                  page to _footer-distance;_ this amount is always negative.
                  At one half-inch above this location, the page text is
                  broken before writing the footer.  Ignored if continuous
                  rendering is enabled.  The default is “-0.5i - 1v”.
    
           **-dHF=**_heading-font_
                  Select the font used for section and subsection headings;
                  the default is “**B** ” (bold style of the default family).  Any
                  valid argument to _groff_ 's “ft” request may be used.  See
                  _groff_(7).
    
           **-rHY=0** Disable automatic hyphenation.  Normally, it is
                  enabled (1).  The hyphenation mode is determined by the
                  _groff_ locale; see section “Localization“ of _groff_(7).
    
           **-rIN=**_standard-indentation_
                  Set the default indentation amount used by **IP** , **TP** , and **HP** ,
                  and the inset amount used by **RS**.  The default is 7n on
                  terminals and 7.2n on typesetters.  Use only integer
                  multiples of unit “n” on terminals for consistent
                  indentation.
    
           **-rLL=**_line-length_
                  Set line length; the default is 80n on terminals and 6.5i
                  on typesetters.
    
           **-rLT=**_title-length_
                  Set the line length for titles.  By default, it is set to
                  the line length (see **-rLL** above).
    
           **-dMF=**_man-page-topic-font_
                  Select the font used for man page identifiers in **TH** calls
                  and topics named in **MR** calls; the default is “**I** ” (italic
                  style of the default family).  Any valid argument to
                  _groff_ 's “ft” request may be used.  If the **MF** string ends in
                  “I”, the package assumes it to be an oblique typeface, and
                  applies italic corrections before and after man page topics
                  and identifiers.
    
           **-rP** _n_   Start enumeration of pages at _n_.  The default is 1.
    
           **-rPO=**_page-offset_
                  Set page offset; the default is 0 on terminals and 1i on
                  typesetters.
    
           **-rS** _type-size_
                  Use _type-size_ for the document's body text; acceptable
                  values are 10, 11, or 12 points.  See subsection “Font
                  style macros” above for the default.
    
           **-rSN=**_subsection-indentation_
                  Set indentation of subsection headings to _subsection-_
                  _indentation._  The default is 3n.
    
           **-rTS=**_separation_
                  Require the given _separation_ between a **TP** paragraph's tag
                  and its body.  The default is 2n.
    
           **-rU0** Disable generation of URI hyperlinks in output drivers
                  capable of them, making the arguments to **MT** and **UR** calls
                  visible as formatted text.  _grohtml_(1), _gropdf_(1), and
                  _grotty_(1) enable hyperlinks by default (the last only if
                  not in its legacy output mode).
    
           **-rX** _p_   Number successors of page _p_ as _p_ a, _p_ b, _p_ c, and so forth.
                  The register tracking the suffixed page letter uses format
                  “a” (see the “af” request in _groff_(7)).
    


## Files



           _/usr/local/share/groff/1.23.0/tmac/an.tmac_
                  Most _man_ macros are defined in this file.  It also loads
                  extensions from _an-ext.tmac_ (see below).
    
           _/usr/local/share/groff/1.23.0/tmac/andoc.tmac_
                  This brief _groff_ program detects whether the _man_ or _mdoc_
                  macro package is used by a document and loads the correct
                  macro definitions, taking advantage of the fact that pages
                  using them must call **TH** or **Dd** , respectively, before any
                  other macros.  A _man_ program or a user typing, for example,
                  “**groff -mandoc page.1** ”, need not know which package the
                  file _page.1_ uses.  Multiple man pages, in either format,
                  can be handled; _andoc_ reloads each macro package as
                  necessary.  Page-local redefinitions of names used by the
                  _man_ or _mdoc_ packages prior to **TH** or **Dd** calls are
                  “clobbered” by the reloading process.  If you want to
                  provide your own definition of an extension macro to ensure
                  its availability, the _an-ext.tmac_ entry below offers
                  advice.
    
           _/usr/local/share/groff/1.23.0/tmac/an-ext.tmac_
                  Definitions of macros described above as extensions (and
                  not deprecated) are contained in this file; in some cases,
                  they are simpler versions of definitions appearing in
                  _an.tmac_ , and are ignored if the formatter is GNU _troff_.
                  They are written to be compatible with AT&T _troff_ and
                  permissively licensed—not copylefted.  To reduce the risk
                  of name space collisions, string and register names begin
                  only with “**m** ”.  We encourage man page authors who are
                  concerned about portability to legacy Unix systems to copy
                  these definitions into their pages, and maintainers of
                  _troff_ implementations or work-alike systems that format man
                  pages to re-use them.  To ensure reliable rendering, define
                  them after your page calls **TH** ; see the discussion of _andoc_
                  _.tmac_ above.  Further, it is wise to define such page-local
                  macros (if at all) after the “Name” section to accommodate
                  timid _makewhatis_(8) or _mandb_(8) implementations that easily
                  give up scanning for indexing material.
    
           _/usr/local/share/groff/1.23.0/tmac/man.tmac_
                  is a wrapper enabling the package to be loaded with the
                  option “**-m man** ”.
    
           _/usr/local/share/groff/1.23.0/tmac/mandoc.tmac_
                  is a wrapper enabling _andoc.tmac_ to be loaded with the
                  option “**-m mandoc** ”.
    
           _/usr/local/share/groff/site-tmac/man.local_
                  Put site-local changes and customizations into this file.
    


## Authors



           James Clark wrote the initial GNU implementation of the _man_ macro
           package.  Later, Werner Lemberg ⟨wl@gnu.org⟩ supplied the **S** , **LT** ,
           and **cR** registers, the last a 4.3BSD-Reno **mdoc**(7) feature.  Larry
           Kollar ⟨kollar@alltel.net⟩ added the **FT** , **HY** , and **SN** registers; the
           **HF** string; and the **PT** and **BT** macros in _groff_ 1.19 (2003).  Lemberg
           and Eric S. Raymond ⟨esr@thyrsus.com⟩ contributed **EX** /**EE** , **MT** /**ME** ,
           **UR** /**UE** , **TQ** , and an early version of the **SY** /**YS** macros to _groff_ 1.20
           (2009).  G. Branden Robinson ⟨g.branden.robinson@gmail.com⟩
           implemented the **AD** and **MF** strings; **CS** , **CT** , and **U** registers; and
           the **MR** macro for _groff_ 1.23 (2023), and the **BP** , **PO** , and **TS**
           registers and a revised implementation of the **SY** /**YS** macros for
           _groff_ 1.24 (2025).
    
           This document was originally written for the Debian GNU/Linux
           system by Susan G. Kleinmann ⟨sgk@debian.org⟩.  It was corrected
           and updated by Lemberg and Robinson.  The extension macros were
           documented by Raymond and Robinson.
    


## See also



           _tbl_(1), _eqn_(1), and _refer_(1) are preprocessors used with man
           pages.  _man_(1) describes the man page librarian on your system.
           _groff_mdoc_(7) details the _groff_ version of BSD's alternative macro
           package for man pages.
    
           _groff_man_style_(7), _groff_(7), _groff_char_(7)
    


* * *