{ "mode": "man", "parameter": "MAN", "section": "7", "url": "https://www.chedong.com/phpMan.php/man/MAN/7/json", "generated": "2026-10-22T13:29:38Z", "sections": { "Name": { "content": "groffman - compose manual pages with GNU roff\n", "subsections": [] }, "Synopsis": { "content": "groff -man [option ...] [file ...]\ngroff -m man [option ...] [file ...]\n", "subsections": [] }, "Description": { "content": "The GNU implementation of the man macro package is part of the groff document formatting sys‐\ntem. It is used to produce manual pages (“man pages”) like the one you are reading.\n\nThis document presents the macros thematically; for those needing only a quick reference, the\nfollowing table lists them alphabetically, with cross references to appropriate subsections\nbelow.\n\nMan page authors and maintainers who are not already experienced groff users should consult\ngroffmanstyle(7), an expanded version of this document, for additional explanations and ad‐\nvice. It covers only those concepts required for man page document maintenance, and not the\nfull breadth of the groff typesetting system.\n\nMacro Meaning Subsection\n───────────────────────────────────────────────────────────────\n.B Bold Font style macros\n.BI Bold, italic alternating Font style macros\n.BR Bold, roman alternating Font style macros\n.EE Example end Document structure macros\n.EX Example begin Document structure macros\n.I Italic Font style macros\n.IB Italic, bold alternating Font style macros\n.IP Indented paragraph Paragraphing macros\n.IR Italic, roman alternating Font style macros\n.LP Begin paragraph Paragraphing macros\n.ME Mail-to end Hyperlink macros\n.MR Man page cross reference Hyperlink macros\n.MT Mail-to start Hyperlink macros\n.P Begin paragraph Paragraphing macros\n.PP Begin paragraph Paragraphing macros\n.RB Roman, bold alternating Font style macros\n.RE Relative inset end Document structure macros\n.RI Roman, italic alternating Font style macros\n.RS Relative inset start Document structure macros\n.SB Small bold Font style macros\n.SH Section heading Document structure macros\n.SM Small Font style macros\n.SS Subsection heading Document structure macros\n.SY Synopsis start Command synopsis macros\n.TH Title heading Document structure macros\n.TP Tagged paragraph Paragraphing macros\n.TQ Supplemental paragraph tag Paragraphing macros\n.UE URI end Hyperlink macros\n.UR URI start Hyperlink macros\n.YS Synopsis end Command synopsis macros\n\nWe discuss other macros (.AT, .DT, .HP, .OP, .PD, and .UC) in subsection “Deprecated fea‐\ntures” below.\n\nThroughout Unix documentation, a manual entry is referred to simply as a “man page”, regard‐\nless of its length, without gendered implication, and irrespective of the macro package se‐\nlected for its composition.\n", "subsections": [ { "name": "Macro reference preliminaries", "content": "A tagged paragraph describes each macro. We present coupled pairs together, as with .EX and\n.EE.\n\nAn empty macro argument can be specified with a pair of double-quotes (\"\"), but the man pack‐\nage is designed such that this should seldom be necessary. Most macro arguments will be for‐\nmatted as text in the output; exceptions are noted.\n" }, { "name": "Document structure macros", "content": "Document structure macros organize a man page's content. All of them break the output line.\n.TH (title heading) identifies the document as a man page and configures the page headers and\nfooters. Section headings (.SH), one of which is mandatory and many of which are convention‐\nally expected, facilitate location of material by the reader and aid the man page writer to\ndiscuss all essential aspects of the topic. Subsection headings (.SS) are optional and per‐\nmit sections that grow long to develop in a controlled way. Many technical discussions bene‐\nfit from examples; lengthy ones, especially those reflecting multiple lines of input to or\noutput from the system, are usefully bracketed by .EX and .EE. When none of the foregoing\nmeets a structural demand, use .RS/.RE to inset a region within a (sub)section.\n\n.TH topic section [footer-middle] [footer-inside] [header-middle]\nDetermine the contents of the page header and footer. The subject of the man page is\ntopic and the section of the manual to which it belongs is section. See man(1) or\nintro(1) for the manual sectioning applicable to your system. topic and section are\npositioned together at the left and right in the header (with section in parentheses\nimmediately appended to topic). footer-middle is centered in the footer. The\narrangement of the rest of the footer depends on whether double-sided layout is en‐\nabled with the option -rD1. When disabled (the default), footer-inside is positioned\nat the bottom left. Otherwise, footer-inside appears at the bottom left on recto\n(odd-numbered) pages, and at the bottom right on verso (even-numbered) pages. The\noutside footer is the page number, except in the continuous-rendering mode enabled by\nthe option -rcR=1, in which case it is the topic and section, as in the header.\nheader-middle is centered in the header. If section is an integer between 1 and 9\n(inclusive), there is no need to specify header-middle; an.tmac will supply text for\nit. The macro package may also abbreviate topic and footer-inside with ellipses if\nthey would overrun the space available in the header and footer, respectively. For\nHTML output, headers and footers are suppressed.\n\nAdditionally, this macro breaks the page, resetting the number to 1 (unless the -rC1\noption is given). This feature is intended only for formatting multiple man documents\nin sequence.\n\nA valid man document calls .TH once, early in the file, prior to any other macro\ncalls.\n\n.SH [heading-text]\nSet heading-text as a section heading. If no argument is given, a one-line input trap\nis planted; text on the next line becomes heading-text. The left margin is reset to\nzero to set the heading text in bold (or the font specified by the string HF), and, on\ntypesetting devices, slightly larger than the base type size. If the heading font\n\\*[HF] is bold, use of an italic style in heading-text is mapped to the bold-italic\nstyle if available in the font family. The inset level is reset to 1, setting the\nleft margin to the value of the IN register. Text after heading-text is set as an or‐\ndinary paragraph (.P).\n\nThe content of heading-text and ordering of sections follows a set of common prac‐\ntices, as has much of the layout of material within sections. For example, a section\ncalled “Name” or “NAME” must exist, must be the first section after the .TH call, and\nmust contain only text of the form\ntopic[, another-topic]... \\- summary-description\nfor a man page to be properly indexed. See groffmanstyle(7) for suggestions and\nman(7) for the conventions prevailing on your system.\n\n.SS [subheading-text]\nSet subheading-text as a subsection heading indented between a section heading and an\nordinary paragraph (.P). If no argument is given, a one-line input trap is planted;\ntext on the next line becomes subheading-text. The left margin is reset to the value\nof the SN register to set the heading text in bold (or the font specified by the\nstring HF). If the heading font \\*[HF] is bold, use of an italic style in subheading-\ntext is mapped to the bold-italic style if available in the font family. The inset\nlevel is reset to 1, setting the left margin to the value of the IN register. Text\nafter subheading-text is set as an ordinary paragraph (.P).\n" }, { "name": ".EX", "content": ".EE Begin and end example. After .EX, filling is disabled and a constant-width (mono‐\nspaced) font is selected. Calling .EE enables filling and restores the previous font.\n\nThese macros are extensions introduced in Ninth Edition Research Unix. Systems run‐\nning that troff, or those from Documenter's Workbench, Heirloom Doctools, or Plan 9\ntroff support them. To be certain your page will be portable to systems that do not,\ncopy their definitions from the an-ext.tmac file of a groff installation.\n\n.RS [inset-amount]\nStart a new relative inset level. The position of the left margin is saved, then\nmoved right by inset-amount, if specified, and by the amount of the IN register other‐\nwise. Calls to .RS can be nested; each increments by 1 the inset level used by .RE.\nThe level prior to any .RS calls is 1.\n\n.RE [level]\nEnd a relative inset. The left margin corresponding to inset level level is restored.\nIf no argument is given, the inset level is reduced by 1.\n" }, { "name": "Paragraphing macros", "content": "An ordinary paragraph (.P) is set without a first-line indentation at the current left mar‐\ngin. In man pages and other technical literature, definition lists are frequently encoun‐\ntered; these can be set as “tagged paragraphs”, which have one (.TP) or more (.TQ) leading\ntags followed by a paragraph that has an additional indentation. The indented paragraph\n(.IP) macro is useful to continue the indented content of a narrative started with .TP, or to\npresent an itemized or ordered list. All of these macros break the output line. If another\nparagraph macro has occurred since the previous .SH or .SS, they (except for .TQ) follow the\nbreak with a default amount of vertical space, which can be changed by the deprecated .PD\nmacro; see subsection “Horizontal and vertical spacing” below. They also reset the type size\nand font style to defaults (.TQ again excepted); see subsection “Font style macros” below.\n\n.P" }, { "name": ".LP", "content": ".PP Begin a new paragraph; these macros are synonymous. The indentation is reset to the\ndefault value; the left margin, as affected by .RS and .RE, is not.\n\n.TP [indentation]\nSet a paragraph with a leading tag, and the remainder of the paragraph indented. A\none-line input trap is planted; text on the next line, which can be formatted with a\nmacro, becomes the tag, which is placed at the current left margin. The tag can be\nextended with the \\c escape sequence. Subsequent text is indented by indentation, if\nspecified, and by the amount of the IN register otherwise. If the tag is not as wide\nas the indentation, the paragraph starts on the same line as the tag, at the applica‐\nble indentation, and continues on the following lines. Otherwise, the descriptive\npart of the paragraph begins on the line following the tag.\n\n.TQ Set an additional tag for a paragraph tagged with .TP. An input trap is planted as\nwith .TP.\n\nThis macro is a GNU extension not defined on systems running AT&T, Plan 9, or Solaris\ntroff; see an-ext.tmac in section “Files” below.\n\n.IP [tag] [indentation]\nSet an indented paragraph with an optional tag. The tag and indentation arguments, if\npresent, are handled as with .TP, with the exception that the tag argument to .IP can‐\nnot include a macro call.\n" }, { "name": "Command synopsis macros", "content": ".SY and .YS aid you to construct a command synopsis that has the classical Unix appearance.\nThey break the output line.\n\nThese macros are GNU extensions not defined on systems running AT&T, Plan 9, or Solaris\ntroff; see an-ext.tmac in section “Files” below.\n\n.SY command\nBegin synopsis. A new paragraph begins at the left margin unless .SY has already been\ncalled without a corresponding .YS, in which case only a break is performed. Adjust‐\nment and automatic hyphenation are disabled. command is set in bold. If a break is\nrequired, lines after the first are indented by the width of command plus a space.\n\n.YS End synopsis. Indentation, adjustment, and hyphenation are restored to their previous\nstates.\n" }, { "name": "Hyperlink macros", "content": "Man page cross references are best presented with .MR. Text may be hyperlinked to email ad‐\ndresses with .MT/.ME or other URIs with .UR/.UE. Hyperlinked text is supported on HTML and\nterminal output devices; terminals and pager programs must support ECMA-48 OSC 8 escape se‐\nquences (see grotty(1)). When device support is unavailable or disabled with the U register\n(see section “Options” below), .MT and .UR URIs are rendered between angle brackets after the\nlinked text.\n\n.MT, .ME, .UR, and .UE are GNU extensions not defined on systems running AT&T, Plan 9, or So‐\nlaris troff; see an-ext.tmac in section “Files” below. Plan 9 from User Space's troff imple‐\nments .MR.\n\nThe arguments to .MR, .MT, and .UR should be prepared for typesetting since they can appear\nin the output. Use special character escape sequences to encode Unicode basic Latin charac‐\nters where necessary, particularly the hyphen-minus. The formatter removes \\: escape se‐\nquences from hyperlinks when supplying device control commands to output drivers.\n\n.MR topic manual-section [trailing-text]\n(since groff 1.23) Set a man page cross reference as “topic(manual-section)”. If\ntrailing-text (typically punctuation) is specified, it follows the closing parenthesis\nwithout intervening space. Hyphenation is disabled while the cross reference is set.\ntopic is set in the font specified by the MF string. The cross reference hyperlinks\nto a URI of the form “man:topic(manual-section)”.\n\n.MT address\n.ME [trailing-text]\nIdentify address as an RFC 6068 addr-spec for a “mailto:” URI with the text between\nthe two macro calls as the link text. An argument to .ME is placed after the link\ntext without intervening space. address may not be visible in the rendered document\nif hyperlinks are enabled and supported by the output driver. If they are not, ad‐\ndress is set in angle brackets after the link text and before trailing-text. If hy‐\nperlinking is enabled but there is no link text, address is formatted and hyperlinked\nwithout angle brackets.\n\n.UR uri\n.UE [trailing-text]\nIdentify uri as an RFC 3986 URI hyperlink with the text between the two macro calls as\nthe link text. An argument to .UE is placed after the link text without intervening\nspace. uri may not be visible in the rendered document if hyperlinks are enabled and\nsupported by the output driver. If they are not, uri is set in angle brackets after\nthe link text and before trailing-text. If hyperlinking is enabled but there is no\nlink text, uri is formatted and hyperlinked without angle brackets.\n\nThe hyperlinking of .TP paragraph tags with .UR/.UE and .MT/.ME is not yet supported; if at‐\ntempted, the hyperlink will be typeset at the beginning of the indented paragraph even on hy‐\nperlink-supporting devices.\n" }, { "name": "Font style macros", "content": "The man macro package is limited in its font styling options, offering only bold (.B),\nitalic (.I), and roman. Italic text is usually set underscored instead on terminal devices.\nThe .SM and .SB macros set text in roman or bold, respectively, at a smaller type size; these\ndiffer visually from regular-sized roman or bold text only on typesetting devices. It is of‐\nten necessary to set text in different styles without intervening space. The macros .BI,\n.BR, .IB, .IR, .RB, and .RI, where “B”, “I”, and “R” indicate bold, italic, and roman, re‐\nspectively, set their odd- and even-numbered arguments in alternating styles, with no space\nseparating them.\n\nThe default type size and family for typesetting devices is 10-point Times, except on the\nX75-12 and X100-12 devices where the type size is 12 points. The default style is roman.\n\n.B [text]\nSet text in bold. If no argument is given, a one-line input trap is planted; text on\nthe next line, which can be further formatted with a macro, is set in bold.\n\n.I [text]\nSet text in an italic or oblique face. If no argument is given, a one-line input trap\nis planted; text on the next line, which can be further formatted with a macro, is set\nin an italic or oblique face.\n\n.SM [text]\nSet text one point smaller than the default type size on typesetting devices. If no\nargument is given, a one-line input trap is planted; text on the next line, which can\nbe further formatted with a macro, is set smaller.\n\n.SB [text]\nSet text in bold and (on typesetting devices) one point smaller than the default type\nsize. If no argument is given, a one-line input trap is planted; text on the next\nline, which can be further formatted with a macro, is set smaller and in bold. This\nmacro is an extension introduced in SunOS 4.0.\n\nUnlike the above font style macros, the font style alternation macros below set no input\ntraps; they must be given arguments to have effect. Italic corrections are applied as appro‐\npriate.\n\n.BI bold-text italic-text ...\nSet each argument in bold and italics, alternately.\n\n.BR bold-text roman-text ...\nSet each argument in bold and roman, alternately.\n\n.IB italic-text bold-text ...\nSet each argument in italics and bold, alternately.\n\n.IR italic-text roman-text ...\nSet each argument in italics and roman, alternately.\n\n.RB roman-text bold-text ...\nSet each argument in roman and bold, alternately.\n\n.RI roman-text italic-text ...\nSet each argument in roman and italics, alternately.\n" }, { "name": "Horizontal and vertical spacing", "content": "The indentation argument accepted by .IP, .TP, and the deprecated .HP is a number plus an op‐\ntional scaling unit, as is .RS's inset-amount. If no scaling unit is given, the man package\nassumes “n”. An indentation specified in a call to .IP, .TP, or the deprecated .HP persists\nuntil (1) another of these macros is called with an indentation argument, or (2) .SH, .SS, or\n.P or its synonyms is called; these clear the indentation entirely.\n\nThe left margin used by ordinary paragraphs set with .P (and its synonyms) not within an\n.RS/.RE relative inset is 7.2n for typesetting devices and 7n for terminal devices (but see\nthe -rIN option). Headers, footers (both set with .TH), and section headings (.SH) are set\nat the page offset (see groff(7)) and subsection headings (.SS) indented from it by 3n (but\nsee the -rSN option).\n\nSeveral macros insert vertical space: .SH, .SS, .TP, .P (and its synonyms), .IP, and the dep‐\nrecated .HP. The default inter-section and inter-paragraph spacing is is 1v for terminal de‐\nvices and 0.4v for typesetting devices. (The deprecated macro .PD can change this vertical\nspacing, but its use is discouraged.) Between .EX and .EE calls, the inter-paragraph spacing\nis 1v regardless of output device.\n" }, { "name": "Registers", "content": "Registers are described in section “Options” below. They can be set not only on the command\nline but in the site man.local file as well; see section “Files” below.\n" }, { "name": "Strings", "content": "The following strings are defined for use in man pages. None of these is necessary in a con‐\ntemporary man page; see groffmanstyle(7). Others are supported for configuration of ren‐\ndering parameters; see section “Options” below.\n\n\\*R interpolates a special character escape sequence for the “registered sign” glyph,\n\\(rg, if available, and “(Reg.)” otherwise.\n\n\\*S interpolates an escape sequence setting the type size to the document default.\n\n\\*(lq\n\\*(rq interpolate special character escape sequences for left and right double-quotation\nmarks, \\(lq and \\(rq, respectively.\n\n\\*(Tm interpolates a special character escape sequence for the “trade mark sign” glyph,\n\\(tm, if available, and “(TM)” otherwise.\n" }, { "name": "Hooks", "content": "Two macros, both GNU extensions, are called internally by the groff man package to format\npage headers and footers and can be redefined by the administrator in a site's man.local file\n(see section “Files” below). The presentation of .TH above describes the default headers and\nfooters. Because these macros are hooks for groff man internals, man pages have no reason to\ncall them. Such hook definitions will likely consist of “.sp” and “.tl” requests. They must\nalso increase the page length with “.pl” requests in continuous rendering mode; .PT further‐\nmore has the responsibility of emitting a PDF bookmark after writing the first page header in\na document. Consult the existing implementations in an.tmac when drafting replacements.\n\n.BT Set the page footer text (“bottom trap”).\n\n.PT Set the page header text (“page trap”).\n\nTo remove a page header or footer entirely, define the appropriate macro as empty rather than\ndeleting it.\n" }, { "name": "Deprecated features", "content": "Use of the following in man pages for public distribution is discouraged.\n\n.AT [system [release]]\nAlter the footer for use with legacy AT&T man pages, overriding any definition of the\nfooter-inside argument to .TH. This macro exists only to render man pages from his‐\ntorical systems.\n\nsystem can be any of the following.\n\n3 7th edition (default)\n\n4 System III\n\n5 System V\n\nThe optional release argument specifies the release number, as in “System V Re‐\nlease 3”.\n\n.DT Reset tab stops to the default (every 0.5i).\n\nUse of this presentation-oriented macro is deprecated. It translates poorly to HTML,\nunder which exact space control and tabulation are not readily available. Thus, in‐\nformation or distinctions that you use tab stops to express are likely to be lost. If\nyou feel tempted to change the tab stops such that calling this macro later is desir‐\nable to restore them, you should probably be composing a table using tbl(1) instead.\n\n.HP [indentation]\nSet up a paragraph with a hanging left indentation. The indentation argument, if\npresent, is handled as with .TP.\n\nUse of this presentation-oriented macro is deprecated. A hanging indentation cannot\nbe expressed naturally under HTML, and non-roff-based man page interpreters may treat\n.HP as an ordinary paragraph. Thus, information or distinctions you mean to express\nwith indentation may be lost.\n\n.OP option-name [option-argument]\nIndicate an optional command parameter called option-name, which is set in bold. If\nthe option takes an argument, specify option-argument using a noun, abbreviation, or\nhyphenated noun phrase. If present, option-argument is preceded by a space and set in\nitalics. Square brackets in roman surround both arguments.\n\nUse of this quasi-semantic macro, an extension originating in Documenter's Workbench\ntroff, is deprecated. It cannot easily be used to annotate options that take optional\narguments or options whose arguments have internal structure (such as a mixture of\nliteral and variable components). One could work around these limitations with font\nselection escape sequences, but it is preferable to use font style alternation macros,\nwhich afford greater flexibility.\n\n.PD [vertical-space]\nDefine the vertical space between paragraphs or (sub)sections. The optional argument\nvertical-space specifies the amount; the default scaling unit is “v”. Without an ar‐\ngument, the spacing is reset to its default value; see subsection “Horizontal and ver‐\ntical spacing” above.\n\nUse of this presentation-oriented macro is deprecated. It translates poorly to HTML,\nunder which exact control of inter-paragraph spacing is not readily available. Thus,\ninformation or distinctions that you use .PD to express are likely to be lost.\n\n.UC [version]\nAlter the footer for use with legacy BSD man pages, overriding any definition of the\nfooter-inside argument to .TH. This macro exists only to render man pages from his‐\ntorical systems.\n\nversion can be any of the following.\n\n3 3rd Berkeley Distribution (default)\n\n4 4th Berkeley Distribution\n\n5 4.2 Berkeley Distribution\n\n6 4.3 Berkeley Distribution\n\n7 4.4 Berkeley Distribution\n" }, { "name": "History", "content": "M. Douglas McIlroy designed, implemented, and documented the AT&T man macros for Unix Ver‐\nsion 7 (1979) and employed them to edit the first volume of its Programmer's Manual, a compi‐\nlation of all man pages supplied by the system. That man supported the macros listed in this\npage not described as extensions, except .P and the deprecated .AT and .UC. The only strings\ndefined were R and S; no registers were documented.\n\n.UC appeared in 3BSD (1980). Unix System III (1980) introduced .P and exposed the registers\nIN and LL, which had been internal to Seventh Edition Unix man. PWB/UNIX 2.0 (1980) added\nthe Tm string. 4BSD (1980) added lq and rq strings. SunOS 2.0 (1985) recognized C, D, P,\nand X registers. 4.3BSD (1986) added .AT and .P. Ninth Edition Research Unix (1986) intro‐\nduced .EX and .EE. SunOS 4.0 (1988) added .SB.\n\nThe foregoing features were what James Clark implemented in early versions of groff. Later,\ngroff 1.20 (2009) originated .SY/.YS, .TQ, .MT/.ME, and .UR/.UE. Plan 9 from User Space's\ntroff introduced .MR in 2020.\n" } ] }, "Options": { "content": "The following groff options set registers (with -r) and strings (with -d) recognized and used\nby the man macro package. To ensure rendering consistent with output device capabilities and\nreader preferences, man pages should never manipulate them.\n", "subsections": [ { "name": "-dAD=_", "content": "Set line adjustment to adjustment-mode, which is typically “b” for adjustment to both\nmargins (the default), or “l” for left alignment (ragged right margin). Any valid ar‐\ngument to groff's “.ad” request may be used. See groff(7) for less-common choices.\n" }, { "name": "-rcR=1", "content": "long) page is produced. This is the default for terminal and HTML devices. Use\n-rcR=0 to disable it on terminal devices; on HTML devices, it cannot be disabled.\n" }, { "name": "-rC1", "content": "ting the page number to 1 (or the value of register P) with each new man document.\n" }, { "name": "-rCS=1", "content": "is off by default because it discards case distinction information.\n" }, { "name": "-rCT=1", "content": "footers. This transformation is off by default because it discards case distinction\ninformation.\n" }, { "name": "-rD1", "content": "the description of .TH in subsection “Document structure macros” above.\n" }, { "name": "-rFT=_", "content": "Set distance of the footer relative to the bottom of the page to footer-distance; this\namount is always negative. At one half-inch above this location, the page text is\nbroken before writing the footer. Ignored if continuous rendering is enabled. The\ndefault is -0.5i.\n" }, { "name": "-dHF=_", "content": "Set the font used for section and subsection headings; the default is “B” (bold style\nof the default family). Any valid argument to groff's “.ft” request may be used. See\ngroff(7).\n" }, { "name": "-rHY=0", "content": "determined by the groff locale; see section “Localization“ of groff(7).\n" }, { "name": "-rIN=_", "content": "Set the amount of indentation used for ordinary paragraphs (.P and its synonyms) and\nthe default indentation amount used by .IP, .RS, .TP, and the deprecated .HP. See\nsubsection “Horizontal and vertical spacing” above for the default. For terminal de‐\nvices, standard-indentation should always be an integer multiple of unit “n” to get\nconsistent indentation.\n" }, { "name": "-rLL=_", "content": "Set line length; the default is 78n for terminal devices and 6.5i for typesetting de‐\nvices.\n" }, { "name": "-rLT=_", "content": "Set the line length for titles. By default, it is set to the line length (see -rLL\nabove).\n" }, { "name": "-dMF=_", "content": "Set the font used for man page topics named in .TH and .MR calls; the default is “I”\n(italic style of the default family). Any valid argument to groff's “.ft” request may\nbe used. If the MF string ends in “I”, it is assumed to be an oblique typeface, and\nitalic corrections are applied before and after man page topics.\n" }, { "name": "-rP_", "content": "" }, { "name": "-rS_", "content": "Use type-size for the document's body text; acceptable values are 10, 11, or 12\npoints. See subsection “Font style macros” above for the default.\n" }, { "name": "-rSN=_", "content": "Set indentation of subsection headings to subsection-indentation. See subsection\n“Horizontal and vertical spacing” above for the default.\n" }, { "name": "-rU1", "content": "enables them by default; grotty does not, pending more widespread pager support for\nOSC 8 escape sequences. Use -rU0 to disable hyperlinks; this will make the arguments\nto MT and UR calls visible in the document text produced by link-capable drivers.\n" }, { "name": "-rX_", "content": "suffixed page letter uses format “a” (see the “.af” request in groff(7)).\n" } ] }, "Files": { "content": "/usr/share/groff/1.23.0/tmac/an.tmac\nMost man macros are defined in this file. It also loads extensions from an-ext.tmac\n(see below).\n\n/usr/share/groff/1.23.0/tmac/andoc.tmac\nThis brief groff program detects whether the man or mdoc macro package is being used\nby a document and loads the correct macro definitions, taking advantage of the fact\nthat pages using them must call .TH or .Dd, respectively, before any other macros. A\nman program or user typing, for example, “groff -mandoc page.1”, need not know which\npackage the file page.1 uses. Multiple man pages, in either format, can be handled;\nandoc reloads each macro package as necessary.\n\n/usr/share/groff/1.23.0/tmac/an-ext.tmac\nExcept for .SB, definitions of macros described above as extensions are contained in\nthis file; in some cases, they are simpler versions of definitions appearing in\nan.tmac, and are ignored if the formatter is GNU troff. They are written to be com‐\npatible with AT&T troff and permissively licensed—not copylefted. To reduce the risk\nof name space collisions, string and register names begin only with “m”. We encourage\nman page authors who are concerned about portability to legacy Unix systems to copy\nthese definitions into their pages, and maintainers of troff implementations or work-\nalike systems that format man pages to re-use them.\n\nThe definitions for these macros are read after a page calls .TH, so they will replace\nany macros of the same names preceding it in your file. If you use your own implemen‐\ntations of these macros, they must be defined after .TH is called to have any effect.\nFurthermore, it is wise to define such page-local macros (if at all) after the “Name”\nsection to accommodate timid makewhatis or mandb implementations that may give up\ntheir scan for indexing material early.\n\n/usr/share/groff/1.23.0/tmac/man.tmac\nThis is a wrapper that loads an.tmac.\n\n/usr/share/groff/1.23.0/tmac/mandoc.tmac\nThis is a wrapper that loads andoc.tmac.\n\n/usr/share/groff/site-tmac/man.local\nPut site-local changes and customizations into this file.\n", "subsections": [] }, "Authors": { "content": "The initial GNU implementation of the man macro package was written by James Clark. Later,\nWerner Lemberg supplied the S, LT, and cR registers, the last a 4.3BSD-Reno mdoc(7) feature.\nLarry Kollar added the FT, HY, and SN registers; the HF string; and the PT and BT macros. G.\nBranden Robinson implemented the AD and MF strings; CS, CT, and U registers; and the MR\nmacro. Except for .SB, the extension macros were written by Lemberg, Eric S. Raymond, and\nRobinson.\n\nThis document was originally written for the Debian GNU/Linux system by Susan G. Kleinmann.\nIt was corrected and updated by Lemberg and Robinson. The extension macros were documented\nby Raymond and Robinson.\n\nSee also\ntbl(1), eqn(1), and refer(1) are preprocessors used with man pages. man(1) describes the man\npage librarian on your system. groffmdoc(7) details the groff version of the BSD-originated\nalternative macro package for man pages.\n\ngroffmanstyle(7), groff(7), groffchar(7), man(7)\n\ngroff 1.23.0 31 March 2024 groffman(7)", "subsections": [] } }, "flags": [], "examples": [], "see_also": [] }