[BACK]Return to mdoc.7 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.196 and 1.243

version 1.196, 2011/08/03 21:25:23 version 1.243, 2014/11/28 18:09:01
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>  .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>  .\" Copyright (c) 2010, 2011, 2013 Ingo Schwarze <schwarze@openbsd.org>
 .\"  .\"
 .\" Permission to use, copy, modify, and distribute this software for any  .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above  .\" purpose with or without fee is hereby granted, provided that the above
Line 20 
Line 20 
 .Os  .Os
 .Sh NAME  .Sh NAME
 .Nm mdoc  .Nm mdoc
 .Nd mdoc language reference  .Nd semantic markup language for formatting manual pages
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm mdoc  .Nm mdoc
 language is used to format  language supports authoring of manual pages for the
 .Bx  .Xr man 1
 .Ux  utility by allowing semantic annotations of words, phrases,
 manuals.  page sections and complete manual pages.
 This reference document describes its syntax, structure, and  Such annotations are used by formatting tools to achieve a uniform
 usage.  presentation across all manuals written in
 The reference implementation is  .Nm ,
   and to support hyperlinking if supported by the output medium.
   .Pp
   This reference document describes the structure of manual pages
   and the syntax and usage of the
   .Nm
   language.
   The reference implementation of a parsing and formatting tool is
 .Xr mandoc 1 ;  .Xr mandoc 1 ;
 the  the
 .Sx COMPATIBILITY  .Sx COMPATIBILITY
 section describes compatibility with other troff \-mdoc implementations.  section describes compatibility with other implementations.
 .Pp  .Pp
 An  In an
 .Nm  .Nm
 document follows simple rules: lines beginning with the control  document, lines beginning with the control character
 character  
 .Sq \&.  .Sq \&.
 are parsed for macros.  are called
 Text lines, those not beginning with the control character, are  .Dq macro lines .
 interpreted within the scope of prior macros:  The first word is the macro name.
   It consists of two or three letters.
   Most macro names begin with a capital letter.
   For a list of available macros, see
   .Sx MACRO OVERVIEW .
   The words following the macro name are arguments to the macro, optionally
   including the names of other, callable macros; see
   .Sx MACRO SYNTAX
   for details.
   .Pp
   Lines not beginning with the control character are called
   .Dq text lines .
   They provide free-form text to be printed; the formatting of the text
   depends on the respective processing context:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Sh Macro lines change control state.  \&.Sh Macro lines change control state.
 Text lines are interpreted within the current state.  Text lines are interpreted within the current state.
 .Ed  .Ed
 .Sh LANGUAGE SYNTAX  
 .Nm  
 documents may contain only graphable 7-bit ASCII characters, the space  
 character, and, in certain circumstances, the tab character.  
 .Pp  .Pp
 If the first character of a text line is a space, that line is printed  Many aspects of the basic syntax of the
 with a leading newline.  .Nm
 .Ss Comments  language are based on the
 Text following a  .Xr roff 7
 .Sq \e\*q ,  language; see the
 whether in a macro or text line, is ignored to the end of  .Em LANGUAGE SYNTAX
 line.  
 A macro line with only a control character and comment escape,  
 .Sq \&.\e\*q ,  
 is also ignored.  
 Macro lines with only a control character and optional whitespace are  
 stripped from input.  
 .Ss Special Characters  
 Special characters may occur in both macro and text lines.  
 Sequences begin with the escape character  
 .Sq \e  
 followed by either an open-parenthesis  
 .Sq \&(  
 for two-character sequences; an open-bracket  
 .Sq \&[  
 for n-character sequences (terminated at a close-bracket  
 .Sq \&] ) ;  
 or a single one character sequence.  
 See  
 .Xr mandoc_char 7  
 for a complete list.  
 Examples include  
 .Sq \e(em  
 .Pq em-dash  
 and  and
 .Sq \ee  .Em MACRO SYNTAX
 .Pq back-slash .  sections in the
 .Ss Text Decoration  .Xr roff 7
 Terms may be text-decorated using the  manual for details, in particular regarding
 .Sq \ef  comments, escape sequences, whitespace, and quoting.
 escape followed by an indicator: B (bold), I (italic), R (Roman), or P  However, using
 (revert to previous mode):  .Xr roff 7
 .Pp  requests in
 .Dl \efBbold\efR \efIitalic\efP  .Nm
 .Pp  documents is discouraged;
 A numerical representation 3, 2, or 1 (bold, italic, and Roman,  .Xr mandoc 1
 respectively) may be used instead.  supports some of them merely for backward compatibility.
 If a macro opens a font scope after calling  
 .Sq \ef ,  
 such as with  
 .Sx \&Bf ,  
 the  
 .Sq \ef  
 mode will be restored upon exiting the  
 .Sx \&Bf  
 scope.  
 .Pp  
 Note this form is  
 .Em not  
 recommended for  
 .Nm ,  
 which encourages semantic annotation.  
 .Ss Predefined Strings  
 Historically,  
 troff  
 also defined a set of package-specific  
 .Dq predefined strings ,  
 which, like  
 .Sx Special Characters ,  
 mark special output characters and strings by way of input codes.  
 Predefined strings are escaped with the slash-asterisk,  
 .Sq \e* :  
 single-character  
 .Sq \e*X ,  
 two-character  
 .Sq \e*(XX ,  
 and N-character  
 .Sq \e*[N] .  
 See  
 .Xr mandoc_char 7  
 for a complete list.  
 Examples include  
 .Sq \e*(Am  
 .Pq ampersand  
 and  
 .Sq \e*(Ba  
 .Pq vertical bar .  
 .Ss Whitespace  
 Whitespace consists of the space character.  
 In text lines, whitespace is preserved within a line; unescaped  
 trailing spaces are stripped from input (unless in a literal context).  
 Blank text lines, which may include whitespace, are only permitted  
 within literal contexts.  
 .Pp  
 In general, trailing whitespace on input lines is discouraged  
 for reasons of clarity and portability.  
 In the rare case that a blank character is needed at the end of an  
 input line, it may be forced by  
 .Sq \e\ \e& .  
 .Pp  
 In macro lines, whitespace delimits arguments and is discarded.  
 .Ss Quotation  
 Macro arguments may be quoted with double-quotes; in this case,  
 whitespace within the quotes is retained as part of the argument.  
 For example,  
 .Pp  
 .D1 Pf \. \&Fn strlen "\(dqconst char *s\(dq"  
 .Pp  
 renders as  
 .Sq Fn strlen "const char *s" ,  
 while  
 .Pp  
 .D1 Pf \. \&Fn strlen "const char *s"  
 .Pp  
 would produce  
 .Sq Fn strlen const char *s .  
 .Pp  
 A quoted argument begins with a double-quote preceded by whitespace.  
 The next double-quote not pairwise adjacent to another double-quote  
 terminates the literal, regardless of surrounding whitespace.  
 .Pp  
 In unquoted arguments, space characters can alternatively be included  
 by preceding them with a backslash  
 .Pq Sq \e\~ ,  
 but quoting is usually better for clarity.  
 .Pp  
 Note that any quoted text, even if it would cause a macro invocation  
 when unquoted, is considered literal text.  
 Thus, the following produces  
 .Sq Op "Fl a" :  
 .Bd -literal -offset indent  
 \&.Op "Fl a"  
 .Ed  
 .Pp  
 In text lines, quotes are regarded as opaque text.  
 .Ss Scaling Widths  
 Many macros support scaled widths for their arguments, such as  
 stipulating a two-inch list indentation with the following:  
 .Bd -literal -offset indent  
 \&.Bl -tag -width 2i  
 .Ed  
 .Pp  
 The syntax for scaled widths is  
 .Sq Li [+-]?[0-9]*.[0-9]*[:unit:] ,  
 where a decimal must be preceded or proceeded by at least one digit.  
 Negative numbers, while accepted, are truncated to zero.  
 The following scaling units are accepted:  
 .Pp  
 .Bl -tag -width Ds -offset indent -compact  
 .It c  
 centimetre  
 .It i  
 inch  
 .It P  
 pica (~1/6 inch)  
 .It p  
 point (~1/72 inch)  
 .It f  
 synonym for  
 .Sq u  
 .It v  
 default vertical span  
 .It m  
 width of rendered  
 .Sq m  
 .Pq em  
 character  
 .It n  
 width of rendered  
 .Sq n  
 .Pq en  
 character  
 .It u  
 default horizontal span  
 .It M  
 mini-em (~1/100 em)  
 .El  
 .Pp  
 Using anything other than  
 .Sq m ,  
 .Sq n ,  
 .Sq u ,  
 or  
 .Sq v  
 is necessarily non-portable across output media.  
 See  
 .Sx COMPATIBILITY .  
 .Ss Sentence Spacing  
 When composing a manual, make sure that sentences end at the end of  
 a line.  
 By doing so, front-ends will be able to apply the proper amount of  
 spacing after the end of sentence (unescaped) period, exclamation mark,  
 or question mark followed by zero or more non-sentence closing  
 delimiters  
 .Po  
 .Sq \&) ,  
 .Sq \&] ,  
 .Sq \&' ,  
 .Sq \&"  
 .Pc .  
 .Pp  
 The proper spacing is also intelligently preserved if a sentence ends at  
 the boundary of a macro line.  
 For example:  
 .Pp  
 .Dl \&.Xr mandoc 1 \&.  
 .Dl \&.Fl T \&Ns \&Cm ascii \&.  
 .Sh MANUAL STRUCTURE  .Sh MANUAL STRUCTURE
 A well-formed  A well-formed
 .Nm  .Nm
Line 292  file for a utility
Line 124  file for a utility
 \&.Sh NAME  \&.Sh NAME
 \&.Nm progname  \&.Nm progname
 \&.Nd one line about what it does  \&.Nd one line about what it does
 \&.\e\*q .Sh LIBRARY  \&.\e\(dq .Sh LIBRARY
 \&.\e\*q For sections 2, 3, & 9 only.  \&.\e\(dq For sections 2, 3, and 9 only.
 \&.\e\*q Not used in OpenBSD.  \&.\e\(dq Not used in OpenBSD.
 \&.Sh SYNOPSIS  \&.Sh SYNOPSIS
 \&.Nm progname  \&.Nm progname
 \&.Op Fl options  \&.Op Fl options
Line 303  file for a utility
Line 135  file for a utility
 The  The
 \&.Nm  \&.Nm
 utility processes files ...  utility processes files ...
 \&.\e\*q .Sh IMPLEMENTATION NOTES  \&.\e\(dq .Sh CONTEXT
 \&.\e\*q Not used in OpenBSD.  \&.\e\(dq For section 9 functions only.
 \&.\e\*q .Sh RETURN VALUES  \&.\e\(dq .Sh IMPLEMENTATION NOTES
 \&.\e\*q For sections 2, 3, & 9 only.  \&.\e\(dq Not used in OpenBSD.
 \&.\e\*q .Sh ENVIRONMENT  \&.\e\(dq .Sh RETURN VALUES
 \&.\e\*q For sections 1, 6, 7, & 8 only.  \&.\e\(dq For sections 2, 3, and 9 function return values only.
 \&.\e\*q .Sh FILES  \&.\e\(dq .Sh ENVIRONMENT
 \&.\e\*q .Sh EXIT STATUS  \&.\e\(dq For sections 1, 6, 7, and 8 only.
 \&.\e\*q For sections 1, 6, & 8 only.  \&.\e\(dq .Sh FILES
 \&.\e\*q .Sh EXAMPLES  \&.\e\(dq .Sh EXIT STATUS
 \&.\e\*q .Sh DIAGNOSTICS  \&.\e\(dq For sections 1, 6, and 8 only.
 \&.\e\*q For sections 1, 4, 6, 7, & 8 only.  \&.\e\(dq .Sh EXAMPLES
 \&.\e\*q .Sh ERRORS  \&.\e\(dq .Sh DIAGNOSTICS
 \&.\e\*q For sections 2, 3, & 9 only.  \&.\e\(dq For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.
 \&.\e\*q .Sh SEE ALSO  \&.\e\(dq .Sh ERRORS
 \&.\e\*q .Xr foobar 1  \&.\e\(dq For sections 2, 3, 4, and 9 errno settings only.
 \&.\e\*q .Sh STANDARDS  \&.\e\(dq .Sh SEE ALSO
 \&.\e\*q .Sh HISTORY  \&.\e\(dq .Xr foobar 1
 \&.\e\*q .Sh AUTHORS  \&.\e\(dq .Sh STANDARDS
 \&.\e\*q .Sh CAVEATS  \&.\e\(dq .Sh HISTORY
 \&.\e\*q .Sh BUGS  \&.\e\(dq .Sh AUTHORS
 \&.\e\*q .Sh SECURITY CONSIDERATIONS  \&.\e\(dq .Sh CAVEATS
 \&.\e\*q Not used in OpenBSD.  \&.\e\(dq .Sh BUGS
   \&.\e\(dq .Sh SECURITY CONSIDERATIONS
   \&.\e\(dq Not used in OpenBSD.
 .Ed  .Ed
 .Pp  .Pp
 The sections in an  The sections in an
Line 406  macros should follow C header-file conventions.
Line 240  macros should follow C header-file conventions.
 .Pp  .Pp
 And for the third, configurations (section 4):  And for the third, configurations (section 4):
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Cd \*qit* at isa? port 0x2e\*q  \&.Cd \(dqit* at isa? port 0x2e\(dq
 \&.Cd \*qit* at isa? port 0x4e\*q  \&.Cd \(dqit* at isa? port 0x4e\(dq
 .Ed  .Ed
 .Pp  .Pp
 Manuals not in these sections generally don't need a  Manuals not in these sections generally don't need a
Line 471  Print verbose information.
Line 305  Print verbose information.
 .Ed  .Ed
 .Pp  .Pp
 Manuals not documenting a command won't include the above fragment.  Manuals not documenting a command won't include the above fragment.
   .Pp
   Since the
   .Em DESCRIPTION
   section usually contains most of the text of a manual, longer manuals
   often use the
   .Sx \&Ss
   macro to form subsections.
   In very long manuals, the
   .Em DESCRIPTION
   may be split into multiple sections, each started by an
   .Sx \&Sh
   macro followed by a non-standard section name, and each having
   several subsections, like in the present
   .Nm
   manual.
   .It Em CONTEXT
   This section lists the contexts in which functions can be called in section 9.
   The contexts are autoconf, process, or interrupt.
 .It Em IMPLEMENTATION NOTES  .It Em IMPLEMENTATION NOTES
 Implementation-specific notes should be kept here.  Implementation-specific notes should be kept here.
 This is useful when implementing standard functions that may have side  This is useful when implementing standard functions that may have side
Line 511  Example usages.
Line 363  Example usages.
 This often contains snippets of well-formed, well-tested invocations.  This often contains snippets of well-formed, well-tested invocations.
 Make sure that examples work properly!  Make sure that examples work properly!
 .It Em DIAGNOSTICS  .It Em DIAGNOSTICS
 Documents error conditions.  Documents error messages.
 This is most useful in section 4 manuals.  In section 4 and 9 manuals, these are usually messages printed by the
   kernel to the console and to the kernel log.
   In section 1, 6, 7, and 8, these are usually messages printed by
   userland programs to the standard error output.
   .Pp
 Historically, this section was used in place of  Historically, this section was used in place of
 .Em EXIT STATUS  .Em EXIT STATUS
 for manuals in sections 1, 6, and 8; however, this practise is  for manuals in sections 1, 6, and 8; however, this practise is
Line 522  See
Line 378  See
 .Sx \&Bl  .Sx \&Bl
 .Fl diag .  .Fl diag .
 .It Em ERRORS  .It Em ERRORS
 Documents error handling in sections 2, 3, and 9.  Documents
   .Xr errno 2
   settings in sections 2, 3, 4, and 9.
 .Pp  .Pp
 See  See
 .Sx \&Er .  .Sx \&Er .
Line 530  See
Line 388  See
 References other manuals with related topics.  References other manuals with related topics.
 This section should exist for most manuals.  This section should exist for most manuals.
 Cross-references should conventionally be ordered first by section, then  Cross-references should conventionally be ordered first by section, then
 alphabetically.  alphabetically (ignoring case).
 .Pp  .Pp
   References to other documentation concerning the topic of the manual page,
   for example authoritative books or journal articles, may also be
   provided in this section.
   .Pp
 See  See
   .Sx \&Rs
   and
 .Sx \&Xr .  .Sx \&Xr .
 .It Em STANDARDS  .It Em STANDARDS
 References any standards implemented or used.  References any standards implemented or used.
Line 543  section should be used instead.
Line 407  section should be used instead.
 See  See
 .Sx \&St .  .Sx \&St .
 .It Em HISTORY  .It Em HISTORY
 A brief history of the subject, including where support first appeared.  A brief history of the subject, including where it was first implemented,
   and when it was ported to or reimplemented for the operating system at hand.
 .It Em AUTHORS  .It Em AUTHORS
 Credits to the person or persons who wrote the code and/or documentation.  Credits to the person or persons who wrote the code and/or documentation.
 Authors should generally be noted by both name and email address.  Authors should generally be noted by both name and email address.
Line 559  in this section.
Line 424  in this section.
 .It Em SECURITY CONSIDERATIONS  .It Em SECURITY CONSIDERATIONS
 Documents any security precautions that operators should consider.  Documents any security precautions that operators should consider.
 .El  .El
 .Sh MACRO SYNTAX  .Sh MACRO OVERVIEW
 Macros are one to three three characters in length and begin with a  This overview is sorted such that macros of similar purpose are listed
 control character,  together, to help find the best macro for any given purpose.
 .Sq \&. ,  Deprecated macros are not included in the overview, but can be found below
 at the beginning of the line.  in the alphabetical
 An arbitrary amount of whitespace may sit between the control character  .Sx MACRO REFERENCE .
 and the macro name.  .Ss Document preamble and NAME section macros
 Thus, the following are equivalent:  .Bl -column "Brq, Bro, Brc" description
 .Bd -literal -offset indent  .It Sx \&Dd Ta document date: Cm $\&Mdocdate$ | Ar month day , year
 \&.Pp  .It Sx \&Dt Ta document title: Ar TITLE section Op Ar volume | arch
 \&.\ \ \ \&Pp  .It Sx \&Os Ta operating system version: Op Ar system Op Ar version
 .Ed  .It Sx \&Nm Ta document name (one argument)
 .Pp  .It Sx \&Nd Ta document description (one line)
 The syntax of a macro depends on its classification.  
 In this section,  
 .Sq \-arg  
 refers to macro arguments, which may be followed by zero or more  
 .Sq parm  
 parameters;  
 .Sq \&Yo  
 opens the scope of a macro; and if specified,  
 .Sq \&Yc  
 closes it out.  
 .Pp  
 The  
 .Em Callable  
 column indicates that the macro may also be called by passing its name  
 as an argument to another macro.  
 For example,  
 .Sq \&.Op \&Fl O \&Ar file  
 produces  
 .Sq Op Fl O Ar file .  
 To prevent a macro call and render the macro name literally,  
 escape it by prepending a zero-width space,  
 .Sq \e& .  
 For example,  
 .Sq \&Op \e&Fl O  
 produces  
 .Sq Op \&Fl O .  
 If a macro is not callable but its name appears as an argument  
 to another macro, it is interpreted as opaque text.  
 For example,  
 .Sq \&.Fl \&Sh  
 produces  
 .Sq Fl \&Sh .  
 .Pp  
 The  
 .Em Parsed  
 column indicates whether the macro may call other macros by receiving  
 their names as arguments.  
 If a macro is not parsed but the name of another macro appears  
 as an argument, it is interpreted as opaque text.  
 .Pp  
 The  
 .Em Scope  
 column, if applicable, describes closure rules.  
 .Ss Block full-explicit  
 Multi-line scope closed by an explicit closing macro.  
 All macros contains bodies; only  
 .Sx \&Bf  
 and  
 .Pq optionally  
 .Sx \&Bl  
 contain a head.  
 .Bd -literal -offset indent  
 \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB  
 \(lBbody...\(rB  
 \&.Yc  
 .Ed  
 .Pp  
 .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsedX" "closed by XXX"  
 .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope  
 .It Sx \&Bd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ed  
 .It Sx \&Bf  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ef  
 .It Sx \&Bk  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ek  
 .It Sx \&Bl  Ta    \&No     Ta    \&No     Ta    closed by Sx \&El  
 .It Sx \&Ed  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bd  
 .It Sx \&Ef  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bf  
 .It Sx \&Ek  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bk  
 .It Sx \&El  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bl  
 .El  .El
 .Ss Block full-implicit  .Ss Sections and cross references
 Multi-line scope closed by end-of-file or implicitly by another macro.  .Bl -column "Brq, Bro, Brc" description
 All macros have bodies; some  .It Sx \&Sh Ta section header (one line)
 .Po  .It Sx \&Ss Ta subsection header (one line)
 .Sx \&It Fl bullet ,  .It Sx \&Sx Ta internal cross reference to a section or subsection
 .Fl hyphen ,  .It Sx \&Xr Ta cross reference to another manual page: Ar name section
 .Fl dash ,  .It Sx \&Pp , \&Lp Ta start a text paragraph (no arguments)
 .Fl enum ,  
 .Fl item  
 .Pc  
 don't have heads; only one  
 .Po  
 .Sx \&It  
 in  
 .Sx \&Bl Fl column  
 .Pc  
 has multiple heads.  
 .Bd -literal -offset indent  
 \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB  
 \(lBbody...\(rB  
 .Ed  
 .Pp  
 .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsedX" "closed by XXXXXXXXXXX"  
 .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope  
 .It Sx \&It  Ta    \&No     Ta    Yes      Ta    closed by Sx \&It , Sx \&El  
 .It Sx \&Nd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh  
 .It Sx \&Nm  Ta    \&No     Ta  Yes Ta closed by Sx \&Nm , Sx \&Sh , Sx \&Ss  
 .It Sx \&Sh  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh  
 .It Sx \&Ss  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh , Sx \&Ss  
 .El  .El
 .Pp  .Ss Displays and lists
 Note that the  .Bl -column "Brq, Bro, Brc" description
 .Sx \&Nm  .It Sx \&Bd , \&Ed Ta display block:
 macro is a  .Fl Ar type
 .Sx Block full-implicit  .Op Fl offset Ar width
 macro only when invoked as the first macro  .Op Fl compact
 in a  .It Sx \&D1 Ta indented display (one line)
 .Em SYNOPSIS  .It Sx \&Dl Ta indented literal display (one line)
 section line, else it is  .It Sx \&Bl , \&El Ta list block:
 .Sx In-line .  .Fl Ar type
 .Ss Block partial-explicit  .Op Fl width Ar val
 Like block full-explicit, but also with single-line scope.  .Op Fl offset Ar val
 Each has at least a body and, in limited circumstances, a head  .Op Fl compact
 .Po  .It Sx \&It Ta list item (syntax depends on Fl Ar type )
 .Sx \&Fo ,  .It Sx \&Ta Ta table cell separator in Sx \&Bl Fl column No lists
 .Sx \&Eo  .It Sx \&Rs , \&%* , \&Re Ta bibliographic block (references)
 .Pc  
 and/or tail  
 .Pq Sx \&Ec .  
 .Bd -literal -offset indent  
 \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB  
 \(lBbody...\(rB  
 \&.Yc \(lBtail...\(rB  
   
 \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \  
 \(lBbody...\(rB \&Yc \(lBtail...\(rB  
 .Ed  
 .Pp  
 .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -compact -offset indent  
 .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope  
 .It Sx \&Ac  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Ao  
 .It Sx \&Ao  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ac  
 .It Sx \&Bc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Bo  
 .It Sx \&Bo  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Bc  
 .It Sx \&Brc Ta    Yes      Ta    Yes      Ta    opened by Sx \&Bro  
 .It Sx \&Bro Ta    Yes      Ta    Yes      Ta    closed by Sx \&Brc  
 .It Sx \&Dc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Do  
 .It Sx \&Do  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Dc  
 .It Sx \&Ec  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Eo  
 .It Sx \&Eo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ec  
 .It Sx \&Fc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Fo  
 .It Sx \&Fo  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Fc  
 .It Sx \&Oc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Oo  
 .It Sx \&Oo  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Oc  
 .It Sx \&Pc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Po  
 .It Sx \&Po  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Pc  
 .It Sx \&Qc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Oo  
 .It Sx \&Qo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Oc  
 .It Sx \&Re  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Rs  
 .It Sx \&Rs  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Re  
 .It Sx \&Sc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&So  
 .It Sx \&So  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Sc  
 .It Sx \&Xc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Xo  
 .It Sx \&Xo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Xc  
 .El  .El
 .Ss Block partial-implicit  .Ss Spacing control
 Like block full-implicit, but with single-line scope closed by the  .Bl -column "Brq, Bro, Brc" description
 end of the line.  .It Sx \&Pf Ta prefix, no following horizontal space (one argument)
 .Bd -literal -offset indent  .It Sx \&Ns Ta roman font, no preceding horizontal space (no arguments)
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB  .It Sx \&Ap Ta apostrophe without surrounding whitespace (no arguments)
 .Ed  .It Sx \&Sm Ta switch horizontal spacing mode: Op Cm on | off
 .Pp  .It Sx \&Bk , \&Ek Ta keep block: Fl words
 .Bl -column "MacroX" "CallableX" "ParsedX" -compact -offset indent  .It Sx \&br Ta force output line break in text mode (no arguments)
 .It Em Macro Ta Em Callable Ta Em Parsed  .It Sx \&sp Ta force vertical space: Op Ar height
 .It Sx \&Aq  Ta    Yes      Ta    Yes  
 .It Sx \&Bq  Ta    Yes      Ta    Yes  
 .It Sx \&Brq Ta    Yes      Ta    Yes  
 .It Sx \&D1  Ta    \&No     Ta    \&Yes  
 .It Sx \&Dl  Ta    \&No     Ta    Yes  
 .It Sx \&Dq  Ta    Yes      Ta    Yes  
 .It Sx \&Op  Ta    Yes      Ta    Yes  
 .It Sx \&Pq  Ta    Yes      Ta    Yes  
 .It Sx \&Ql  Ta    Yes      Ta    Yes  
 .It Sx \&Qq  Ta    Yes      Ta    Yes  
 .It Sx \&Sq  Ta    Yes      Ta    Yes  
 .It Sx \&Vt  Ta    Yes      Ta    Yes  
 .El  .El
 .Pp  .Ss Semantic markup for command line utilities:
 Note that the  .Bl -column "Brq, Bro, Brc" description
 .Sx \&Vt  .It Sx \&Nm Ta start a SYNOPSIS block with the name of a utility
 macro is a  .It Sx \&Fl Ta command line options (flags) (>=0 arguments)
 .Sx Block partial-implicit  .It Sx \&Cm Ta command modifier (>0 arguments)
 only when invoked as the first macro  .It Sx \&Ar Ta command arguments (>=0 arguments)
 in a  .It Sx \&Op , \&Oo , \&Oc Ta optional syntax elements (enclosure)
 .Em SYNOPSIS  .It Sx \&Ic Ta internal or interactive command (>0 arguments)
 section line, else it is  .It Sx \&Ev Ta environmental variable (>0 arguments)
 .Sx In-line .  .It Sx \&Pa Ta file system path (>=0 arguments)
 .Ss Special block macro  
 The  
 .Sx \&Ta  
 macro can only be used below  
 .Sx \&It  
 in  
 .Sx \&Bl Fl column  
 lists.  
 It delimits blocks representing table cells;  
 these blocks have bodies, but no heads.  
 .Pp  
 .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -compact -offset indent  
 .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope  
 .It Sx \&Ta  Ta    Yes      Ta    Yes    Ta closed by Sx \&Ta , Sx \&It  
 .El  .El
 .Ss In-line  .Ss Semantic markup for function libraries:
 Closed by the end of the line, fixed argument lengths,  .Bl -column "Brq, Bro, Brc" description
 and/or subsequent macros.  .It Sx \&Lb Ta function library (one argument)
 In-line macros have only text children.  .It Sx \&In Ta include file (one argument)
 If a number (or inequality) of arguments is  .It Sx \&Fd Ta other preprocessor directive (>0 arguments)
 .Pq n ,  .It Sx \&Ft Ta function type (>0 arguments)
 then the macro accepts an arbitrary number of arguments.  .It Sx \&Fo , \&Fc Ta function block: Ar funcname
 .Bd -literal -offset indent  .It Sx \&Fn Ta function name:
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lBres...\(rB  .Op Ar functype
   .Ar funcname
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc...  .Oo
   .Op Ar argtype
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN  .Ar argname
 .Ed  .Oc
 .Pp  .It Sx \&Fa Ta function argument (>0 arguments)
 .Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -compact -offset indent  .It Sx \&Vt Ta variable type (>0 arguments)
 .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Arguments  .It Sx \&Va Ta variable name (>0 arguments)
 .It Sx \&%A  Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&Dv Ta defined variable or preprocessor constant (>0 arguments)
 .It Sx \&%B  Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&Er Ta error constant (>0 arguments)
 .It Sx \&%C  Ta    \&No     Ta    \&No     Ta    >0  .It Sx \&Ev Ta environmental variable (>0 arguments)
 .It Sx \&%D  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%I  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%J  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%N  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%O  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%P  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%Q  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%R  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%T  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%U  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&%V  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&Ad  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&An  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Ap  Ta    Yes      Ta    Yes      Ta    0  
 .It Sx \&Ar  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&At  Ta    Yes      Ta    Yes      Ta    1  
 .It Sx \&Bsx Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Bt  Ta    \&No     Ta    \&No     Ta    0  
 .It Sx \&Bx  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Cd  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Cm  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Db  Ta    \&No     Ta    \&No     Ta    1  
 .It Sx \&Dd  Ta    \&No     Ta    \&No     Ta    n  
 .It Sx \&Dt  Ta    \&No     Ta    \&No     Ta    n  
 .It Sx \&Dv  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Dx  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Em  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&En  Ta    \&No     Ta    \&No     Ta    0  
 .It Sx \&Er  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Es  Ta    \&No     Ta    \&No     Ta    0  
 .It Sx \&Ev  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Ex  Ta    \&No     Ta    \&No     Ta    n  
 .It Sx \&Fa  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Fd  Ta    \&No     Ta    \&No     Ta    >0  
 .It Sx \&Fl  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Fn  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Fr  Ta    \&No     Ta    \&No     Ta    n  
 .It Sx \&Ft  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Fx  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Hf  Ta    \&No     Ta    \&No     Ta    n  
 .It Sx \&Ic  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&In  Ta    \&No     Ta    \&No     Ta    1  
 .It Sx \&Lb  Ta    \&No     Ta    \&No     Ta    1  
 .It Sx \&Li  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Lk  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Lp  Ta    \&No     Ta    \&No     Ta    0  
 .It Sx \&Ms  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Mt  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Nm  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&No  Ta    Yes      Ta    Yes      Ta    0  
 .It Sx \&Ns  Ta    Yes      Ta    Yes      Ta    0  
 .It Sx \&Nx  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Os  Ta    \&No     Ta    \&No     Ta    n  
 .It Sx \&Ot  Ta    \&No     Ta    \&No     Ta    n  
 .It Sx \&Ox  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Pa  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Pf  Ta    Yes      Ta    Yes      Ta    1  
 .It Sx \&Pp  Ta    \&No     Ta    \&No     Ta    0  
 .It Sx \&Rv  Ta    \&No     Ta    \&No     Ta    n  
 .It Sx \&Sm  Ta    \&No     Ta    \&No     Ta    1  
 .It Sx \&St  Ta    \&No     Ta    Yes      Ta    1  
 .It Sx \&Sx  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Sy  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Tn  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Ud  Ta    \&No     Ta    \&No     Ta    0  
 .It Sx \&Ux  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Va  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Vt  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&Xr  Ta    Yes      Ta    Yes      Ta    >0  
 .It Sx \&br  Ta    \&No     Ta    \&No     Ta    0  
 .It Sx \&sp  Ta    \&No     Ta    \&No     Ta    1  
 .El  .El
 .Ss Delimiters  .Ss Various semantic markup:
 When a macro argument consists of one single input character  .Bl -column "Brq, Bro, Brc" description
 considered as a delimiter, the argument gets special handling.  .It Sx \&An Ta author name (>0 arguments)
 This does not apply when delimiters appear in arguments containing  .It Sx \&Lk Ta hyperlink: Ar uri Op Ar name
 more than one character.  .It Sx \&Mt Ta Do mailto Dc hyperlink: Ar address
 Consequently, to prevent special handling and just handle it  .It Sx \&Cd Ta kernel configuration declaration (>0 arguments)
 like any other argument, a delimiter can be escaped by prepending  .It Sx \&Ad Ta memory address (>0 arguments)
 a zero-width space  .It Sx \&Ms Ta mathematical symbol (>0 arguments)
 .Pq Sq \e& .  
 In text lines, delimiters never need escaping, but may be used  
 as normal punctuation.  
 .Pp  
 For many macros, when the leading arguments are opening delimiters,  
 these delimiters are put before the macro scope,  
 and when the trailing arguments are closing delimiters,  
 these delimiters are put after the macro scope.  
 For example,  
 .Pp  
 .D1 Pf \. \&Aq "( [ word ] ) ."  
 .Pp  
 renders as:  
 .Pp  
 .D1 Aq ( [ word ] ) .  
 .Pp  
 Opening delimiters are:  
 .Pp  
 .Bl -tag -width Ds -offset indent -compact  
 .It \&(  
 left parenthesis  
 .It \&[  
 left bracket  
 .El  .El
 .Pp  .Ss Physical markup
 Closing delimiters are:  .Bl -column "Brq, Bro, Brc" description
 .Pp  .It Sx \&Em Ta italic font or underline (emphasis) (>0 arguments)
 .Bl -tag -width Ds -offset indent -compact  .It Sx \&Sy Ta boldface font (symbolic) (>0 arguments)
 .It \&.  .It Sx \&Li Ta typewriter font (literal) (>0 arguments)
 period  .It Sx \&No Ta return to roman font (normal) (no arguments)
 .It \&,  .It Sx \&Bf , \&Ef Ta font block:
 comma  .Op Fl Ar type | Cm \&Em | \&Li | \&Sy
 .It \&:  
 colon  
 .It \&;  
 semicolon  
 .It \&)  
 right parenthesis  
 .It \&]  
 right bracket  
 .It \&?  
 question mark  
 .It \&!  
 exclamation mark  
 .El  .El
 .Pp  .Ss Physical enclosures
 Note that even a period preceded by a backslash  .Bl -column "Brq, Bro, Brc" description
 .Pq Sq \e.\&  .It Sx \&Dq , \&Do , \&Dc Ta enclose in typographic double quotes: Dq text
 gets this special handling; use  .It Sx \&Qq , \&Qo , \&Qc Ta enclose in typewriter double quotes: Qq text
 .Sq \e&.  .It Sx \&Sq , \&So , \&Sc Ta enclose in single quotes: Sq text
 to prevent that.  .It Sx \&Ql Ta single-quoted literal text: Ql text
 .Pp  .It Sx \&Pq , \&Po , \&Pc Ta enclose in parentheses: Pq text
 Many in-line macros interrupt their scope when they encounter  .It Sx \&Bq , \&Bo , \&Bc Ta enclose in square brackets: Bq text
 delimiters, and resume their scope when more arguments follow that  .It Sx \&Brq , \&Bro , \&Brc Ta enclose in curly braces: Brq text
 are not delimiters.  .It Sx \&Aq , \&Ao , \&Ac Ta enclose in angle brackets: Aq text
 For example,  .It Sx \&Eo , \&Ec Ta generic enclosure
 .Pp  
 .D1 Pf \. \&Fl "a ( b | c \e*(Ba d ) e"  
 .Pp  
 renders as:  
 .Pp  
 .D1 Fl a ( b | c \*(Ba d ) e  
 .Pp  
 This applies to both opening and closing delimiters,  
 and also to the middle delimiter:  
 .Pp  
 .Bl -tag -width Ds -offset indent -compact  
 .It \&|  
 vertical bar  
 .El  .El
 .Pp  .Ss Text production
 As a special case, the predefined string \e*(Ba is handled and rendered  .Bl -column "Brq, Bro, Brc" description
 in the same way as a plain  .It Sx \&Ex Fl std Ta standard command exit values: Op Ar utility ...
 .Sq \&|  .It Sx \&Rv Fl std Ta standard function return values: Op Ar function ...
 character.  .It Sx \&St Ta reference to a standards document (one argument)
 Using this predefined string is not recommended in new manuals.  .It Sx \&At Ta At
 .Sh REFERENCE  .It Sx \&Bx Ta Bx
   .It Sx \&Bsx Ta Bsx
   .It Sx \&Nx Ta Nx
   .It Sx \&Fx Ta Fx
   .It Sx \&Ox Ta Ox
   .It Sx \&Dx Ta Dx
   .El
   .Sh MACRO REFERENCE
 This section is a canonical reference of all macros, arranged  This section is a canonical reference of all macros, arranged
 alphabetically.  alphabetically.
 For the scoping of individual macros, see  For the scoping of individual macros, see
Line 1067  for all other author listings.
Line 667  for all other author listings.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.An -nosplit  .Dl \&.An -nosplit
 .Dl \&.An Kristaps Dzonsons \&Aq kristaps@bsd.lv  .Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv
 .Ss \&Ao  .Ss \&Ao
 Begin a block enclosed by angle brackets.  Begin a block enclosed by angle brackets.
 Does not have any head arguments.  Does not have any head arguments.
Line 1121  for fixed strings to be passed verbatim as arguments, 
Line 721  for fixed strings to be passed verbatim as arguments, 
 or  or
 .Sx \&Cm .  .Sx \&Cm .
 .Ss \&At  .Ss \&At
 Formats an AT&T version.  Formats an
   .At
   version.
 Accepts one optional argument:  Accepts one optional argument:
 .Pp  .Pp
 .Bl -tag -width "v[1-7] | 32vX" -offset indent -compact  .Bl -tag -width "v[1-7] | 32vX" -offset indent -compact
Line 1148  See also
Line 750  See also
 .Sx \&Dx ,  .Sx \&Dx ,
 .Sx \&Fx ,  .Sx \&Fx ,
 .Sx \&Nx ,  .Sx \&Nx ,
 .Sx \&Ox ,  
 and  and
 .Sx \&Ux .  .Sx \&Ox .
 .Ss \&Bc  .Ss \&Bc
 Close a  Close a
 .Sx \&Bo  .Sx \&Bo
Line 1176  The
Line 777  The
 must be one of the following:  must be one of the following:
 .Bl -tag -width 13n -offset indent  .Bl -tag -width 13n -offset indent
 .It Fl centered  .It Fl centered
 Centre-justify each line.  Produce one output line from each input line, and centre-justify each line.
 Using this display type is not recommended; many  Using this display type is not recommended; many
 .Nm  .Nm
 implementations render it poorly.  implementations render it poorly.
 .It Fl filled  .It Fl filled
 Left- and right-justify the block.  Change the positions of line breaks to fill each line, and left- and
   right-justify the resulting block.
 .It Fl literal  .It Fl literal
 Do not justify the block at all.  Produce one output line from each input line,
   and do not justify the block at all.
 Preserve white space as it appears in the input.  Preserve white space as it appears in the input.
   Always use a constant-width font.
   Use this for displaying source code.
 .It Fl ragged  .It Fl ragged
 Only left-justify the block.  Change the positions of line breaks to fill each line, and left-justify
   the resulting block.
 .It Fl unfilled  .It Fl unfilled
 An alias for  The same as
 .Fl literal .  .Fl literal ,
   but using the same font as for normal text, which is a variable width font
   if supported by the output device.
 .El  .El
 .Pp  .Pp
 The  The
Line 1205  which may be one of the following:
Line 813  which may be one of the following:
 .It  .It
 One of the pre-defined strings  One of the pre-defined strings
 .Cm indent ,  .Cm indent ,
 the width of standard indentation;  the width of a standard indentation (six constant width characters);
 .Cm indent-two ,  .Cm indent-two ,
 twice  twice
 .Cm indent ;  .Cm indent ;
Line 1223  The most popular is the imaginary macro
Line 831  The most popular is the imaginary macro
 which resolves to  which resolves to
 .Sy 6n .  .Sy 6n .
 .It  .It
 A width using the syntax described in  A scaling width as described in
 .Sx Scaling Widths .  .Xr roff 7 .
 .It  .It
 An arbitrary string, which indents by the length of this string.  An arbitrary string, which indents by the length of this string.
 .El  .El
Line 1329  The
Line 937  The
 .Fl width  .Fl width
 and  and
 .Fl offset  .Fl offset
 arguments accept  arguments accept macro names as described for
 .Sx Scaling Widths  .Sx \&Bd
   .Fl offset ,
   scaling widths as described in
   .Xr roff 7 ,
 or use the length of the given string.  or use the length of the given string.
 The  The
 .Fl offset  .Fl offset
Line 1359  A columnated list.
Line 970  A columnated list.
 The  The
 .Fl width  .Fl width
 argument has no effect; instead, each argument specifies the width  argument has no effect; instead, each argument specifies the width
 of one column, using either the  of one column, using either the scaling width syntax described in
 .Sx Scaling Widths  .Xr roff 7
 syntax or the string length of the argument.  or the string length of the argument.
 If the first line of the body of a  If the first line of the body of a
 .Fl column  .Fl column
 list is not an  list is not an
Line 1382  except that dashes are used in place of bullets.
Line 993  except that dashes are used in place of bullets.
 Like  Like
 .Fl inset ,  .Fl inset ,
 except that item heads are not parsed for macro invocations.  except that item heads are not parsed for macro invocations.
 .\" but with additional formatting to the head.  Most often used in the
   .Em DIAGNOSTICS
   section with error constants in the item heads.
 .It Fl enum  .It Fl enum
 A numbered list.  A numbered list.
   No item heads can be specified.
 Formatted like  Formatted like
 .Fl bullet ,  .Fl bullet ,
 except that cardinal numbers are used in place of bullets,  except that cardinal numbers are used in place of bullets,
Line 1424  this head on the same output line.
Line 1038  this head on the same output line.
 Otherwise, the body starts on the output line following the head.  Otherwise, the body starts on the output line following the head.
 .El  .El
 .Pp  .Pp
   Lists may be nested within lists and displays.
   Nesting of
   .Fl column
   and
   .Fl enum
   lists may not be portable.
   .Pp
 See also  See also
 .Sx \&El  .Sx \&El
 and  and
Line 1482  Examples:
Line 1103  Examples:
 See also  See also
 .Sx \&Bro .  .Sx \&Bro .
 .Ss \&Bsx  .Ss \&Bsx
 Format the BSD/OS version provided as an argument, or a default value if  Format the
   .Bsx
   version provided as an argument, or a default value if
 no argument is provided.  no argument is provided.
 .Pp  .Pp
 Examples:  Examples:
Line 1495  See also
Line 1118  See also
 .Sx \&Dx ,  .Sx \&Dx ,
 .Sx \&Fx ,  .Sx \&Fx ,
 .Sx \&Nx ,  .Sx \&Nx ,
 .Sx \&Ox ,  
 and  and
 .Sx \&Ux .  .Sx \&Ox .
 .Ss \&Bt  .Ss \&Bt
   Supported only for compatibility, do not use this in new manuals.
 Prints  Prints
 .Dq is currently in beta test .  .Dq is currently in beta test.
 .Ss \&Bx  .Ss \&Bx
 Format the BSD version provided as an argument, or a default value if no  Format the
   .Bx
   version provided as an argument, or a default value if no
 argument is provided.  argument is provided.
 .Pp  .Pp
 Examples:  Examples:
   .Dl \&.Bx 4.3 Tahoe
 .Dl \&.Bx 4.4  .Dl \&.Bx 4.4
 .Dl \&.Bx  .Dl \&.Bx
 .Pp  .Pp
Line 1515  See also
Line 1141  See also
 .Sx \&Dx ,  .Sx \&Dx ,
 .Sx \&Fx ,  .Sx \&Fx ,
 .Sx \&Nx ,  .Sx \&Nx ,
 .Sx \&Ox ,  
 and  and
 .Sx \&Ux .  .Sx \&Ox .
 .Ss \&Cd  .Ss \&Cd
 Kernel configuration declaration.  Kernel configuration declaration.
 This denotes strings accepted by  This denotes strings accepted by
Line 1560  See also
Line 1185  See also
 and  and
 .Sx \&Dl .  .Sx \&Dl .
 .Ss \&Db  .Ss \&Db
 Switch debugging mode.  This macro is obsolete.
 Its syntax is as follows:  No replacement is needed.
 .Pp  It is ignored by
 .D1 Pf \. Sx \&Db Cm on | off  .Xr mandoc 1
 .Pp  and groff including its arguments.
 This macro is ignored by  It was formerly used to toggle a debugging mode.
 .Xr mandoc 1 .  
 .Ss \&Dc  .Ss \&Dc
 Close a  Close a
 .Sx \&Do  .Sx \&Do
 block.  block.
 Does not have any tail arguments.  Does not have any tail arguments.
 .Ss \&Dd  .Ss \&Dd
 Document date.  Document date for display in the page footer.
 This is the mandatory first macro of any  This is the mandatory first macro of any
 .Nm  .Nm
 manual.  manual.
Line 1602  the special string
Line 1226  the special string
 .Dq $\&Mdocdate$  .Dq $\&Mdocdate$
 can be given as an argument.  can be given as an argument.
 .It  .It
 A few alternative date formats are accepted as well  The traditional, purely numeric
 and converted to the standard form.  .Xr man 7
   format
   .Ar year Ns \(en Ns Ar month Ns \(en Ns Ar day
   is accepted, too.
 .It  .It
 If a date string cannot be parsed, it is used verbatim.  If a date string cannot be parsed, it is used verbatim.
 .It  .It
Line 1620  See also
Line 1247  See also
 and  and
 .Sx \&Os .  .Sx \&Os .
 .Ss \&Dl  .Ss \&Dl
 One-line intended display.  One-line indented display.
 This is formatted as literal text and is useful for commands and  This is formatted as literal text and is useful for commands and
 invocations.  invocations.
 It is followed by a newline.  It is followed by a newline.
Line 1663  See also
Line 1290  See also
 and  and
 .Sx \&Do .  .Sx \&Do .
 .Ss \&Dt  .Ss \&Dt
 Document title.  Document title for display in the page header.
 This is the mandatory second macro of any  This is the mandatory second macro of any
 .Nm  .Nm
 file.  file.
 Its syntax is as follows:  Its syntax is as follows:
 .Bd -ragged -offset indent  .Bd -ragged -offset indent
 .Pf \. Sx \&Dt  .Pf \. Sx \&Dt
 .Oo  .Ar TITLE
 .Ar title  
 .Oo  
 .Ar section  .Ar section
 .Op Ar volume | arch  .Op Ar volume | arch
 .Oc  
 .Oc  
 .Ed  .Ed
 .Pp  .Pp
 Its arguments are as follows:  Its arguments are as follows:
 .Bl -tag -width Ds -offset Ds  .Bl -tag -width section -offset 2n
 .It Ar title  .It Ar TITLE
 The document's title (name), defaulting to  The document's title (name), defaulting to
 .Dq UNKNOWN  .Dq UNTITLED
 if unspecified.  if unspecified.
 It should be capitalised.  To achieve a uniform appearance of page header lines,
   it should by convention be all caps.
 .It Ar section  .It Ar section
 The manual section.  The manual section.
 This may be one of  This may be one of
 .Ar 1  .Cm 1
 .Pq utilities ,  .Pq utilities ,
 .Ar 2  .Cm 2
 .Pq system calls ,  .Pq system calls ,
 .Ar 3  .Cm 3
 .Pq libraries ,  .Pq libraries ,
 .Ar 3p  .Cm 3p
 .Pq Perl libraries ,  .Pq Perl libraries ,
 .Ar 4  .Cm 4
 .Pq devices ,  .Pq devices ,
 .Ar 5  .Cm 5
 .Pq file formats ,  .Pq file formats ,
 .Ar 6  .Cm 6
 .Pq games ,  .Pq games ,
 .Ar 7  .Cm 7
 .Pq miscellaneous ,  .Pq miscellaneous ,
 .Ar 8  .Cm 8
 .Pq system utilities ,  .Pq system utilities ,
 .Ar 9  .Cm 9
 .Pq kernel functions ,  .Pq kernel functions ,
 .Ar X11  .Cm X11
 .Pq X Window System ,  .Pq X Window System ,
 .Ar X11R6  .Cm X11R6
 .Pq X Window System ,  .Pq X Window System ,
 .Ar unass  .Cm unass
 .Pq unassociated ,  .Pq unassociated ,
 .Ar local  .Cm local
 .Pq local system ,  .Pq local system ,
 .Ar draft  .Cm draft
 .Pq draft manual ,  .Pq draft manual ,
 or  or
 .Ar paper  .Cm paper
 .Pq paper .  .Pq paper .
 It should correspond to the manual's filename suffix and defaults to  It should correspond to the manual's filename suffix and defaults to
 .Dq 1  the empty string if unspecified.
 if unspecified.  
 .It Ar volume  .It Ar volume
 This overrides the volume inferred from  This overrides the volume inferred from
 .Ar section .  .Ar section .
 This field is optional, and if specified, must be one of  This field is optional, and if specified, must be one of
 .Ar USD  .Cm USD
 .Pq users' supplementary documents ,  .Pq users' supplementary documents ,
 .Ar PS1  .Cm PS1
 .Pq programmers' supplementary documents ,  .Pq programmers' supplementary documents ,
 .Ar AMD  .Cm AMD
 .Pq administrators' supplementary documents ,  .Pq administrators' supplementary documents ,
 .Ar SMM  .Cm SMM
 .Pq system managers' manuals ,  .Pq system managers' manuals ,
 .Ar URM  .Cm URM
 .Pq users' reference manuals ,  .Pq users' reference manuals ,
 .Ar PRM  .Cm PRM
 .Pq programmers' reference manuals ,  .Pq programmers' reference manuals ,
 .Ar KM  .Cm KM
 .Pq kernel manuals ,  .Pq kernel manuals ,
 .Ar IND  .Cm IND
 .Pq master index ,  .Pq master index ,
 .Ar MMI  .Cm MMI
 .Pq master index ,  .Pq master index ,
 .Ar LOCAL  .Cm LOCAL
 .Pq local manuals ,  .Pq local manuals ,
 .Ar LOC  .Cm LOC
 .Pq local manuals ,  .Pq local manuals ,
 or  or
 .Ar CON  .Cm CON
 .Pq contributed manuals .  .Pq contributed manuals .
 .It Ar arch  .It Ar arch
 This specifies a specific relevant architecture.  This specifies the machine architecture a manual page applies to,
 If  where relevant, for example
 .Ar volume  .Cm alpha ,
 is not provided, it may be used in its place, else it may be used  .Cm amd64 ,
 subsequent that.  .Cm i386 ,
 It, too, is optional.  
 It must be one of  
 .Ar alpha ,  
 .Ar amd64 ,  
 .Ar amiga ,  
 .Ar arc ,  
 .Ar arm ,  
 .Ar armish ,  
 .Ar aviion ,  
 .Ar hp300 ,  
 .Ar hppa ,  
 .Ar hppa64 ,  
 .Ar i386 ,  
 .Ar landisk ,  
 .Ar loongson ,  
 .Ar luna88k ,  
 .Ar mac68k ,  
 .Ar macppc ,  
 .Ar mips64 ,  
 .Ar mvme68k ,  
 .Ar mvme88k ,  
 .Ar mvmeppc ,  
 .Ar pmax ,  
 .Ar sgi ,  
 .Ar socppc ,  
 .Ar sparc ,  
 .Ar sparc64 ,  
 .Ar sun3 ,  
 .Ar vax ,  
 or  or
 .Ar zaurus .  .Cm sparc64 .
   The list of valid architectures varies by operating system.
 .El  .El
 .Pp  .Pp
 Examples:  Examples:
Line 1815  See also
Line 1410  See also
 .Sx \&Er  .Sx \&Er
 and  and
 .Sx \&Ev  .Sx \&Ev
 for special-purpose constants and  for special-purpose constants,
 .Sx \&Va  .Sx \&Va
 for variable symbols.  for variable symbols, and
   .Sx \&Fd
   for listing preprocessor variable definitions in the
   .Em SYNOPSIS .
 .Ss \&Dx  .Ss \&Dx
 Format the DragonFly BSD version provided as an argument, or a default  Format the
   .Dx
   version provided as an argument, or a default
 value if no argument is provided.  value if no argument is provided.
 .Pp  .Pp
 Examples:  Examples:
Line 1832  See also
Line 1432  See also
 .Sx \&Bx ,  .Sx \&Bx ,
 .Sx \&Fx ,  .Sx \&Fx ,
 .Sx \&Nx ,  .Sx \&Nx ,
 .Sx \&Ox ,  
 and  and
 .Sx \&Ux .  .Sx \&Ox .
 .Ss \&Ec  .Ss \&Ec
 Close a scope started by  Close a scope started by
 .Sx \&Eo .  .Sx \&Eo .
Line 1865  See also
Line 1464  See also
 and  and
 .Sx \&It .  .Sx \&It .
 .Ss \&Em  .Ss \&Em
 Denotes text that should be emphasised.  Request an italic font.
 Note that this is a presentation term and should not be used for  If the output device does not provide that, underline.
 stylistically decorating technical terms.  
 .Pp  .Pp
   This is most often used for stress emphasis (not to be confused with
   importance, see
   .Sx \&Sy ) .
   In the rare cases where none of the semantic markup macros fit,
   it can also be used for technical terms and placeholders, except
   that for syntax elements,
   .Sx \&Sy
   and
   .Sx \&Ar
   are preferred, respectively.
   .Pp
 Examples:  Examples:
 .Dl \&.Em Warnings!  .Bd -literal -compact -offset indent
 .Dl \&.Em Remarks :  Selected lines are those
   \&.Em not
   matching any of the specified patterns.
   Some of the functions use a
   \&.Em hold space
   to save the pattern space for subsequent retrieval.
   .Ed
 .Pp  .Pp
 See also  See also
 .Sx \&Bf ,  .Sx \&Bf ,
 .Sx \&Sy ,  .Sx \&Li ,
   .Sx \&No ,
 and  and
 .Sx \&Li .  .Sx \&Sy .
 .Ss \&En  .Ss \&En
 This macro is obsolete and not implemented in  This macro is obsolete.
 .Xr mandoc 1 .  Use
   .Sx \&Eo
   or any of the other enclosure macros.
   .Pp
   It encloses its argument in the delimiters specified by the last
   .Sx \&Es
   macro.
 .Ss \&Eo  .Ss \&Eo
 An arbitrary enclosure.  An arbitrary enclosure.
 Its syntax is as follows:  Its syntax is as follows:
Line 1906  See also
Line 1528  See also
 .Sx \&Dv  .Sx \&Dv
 for general constants.  for general constants.
 .Ss \&Es  .Ss \&Es
 This macro is obsolete and not implemented.  This macro is obsolete.
   Use
   .Sx \&Eo
   or any of the other enclosure macros.
   .Pp
   It takes two arguments, defining the delimiters to be used by subsequent
   .Sx \&En
   macros.
 .Ss \&Ev  .Ss \&Ev
 Environmental variables such as those specified in  Environmental variables such as those specified in
 .Xr environ 7 .  .Xr environ 7 .
Line 1938  arguments are treated as separate utilities.
Line 1567  arguments are treated as separate utilities.
 See also  See also
 .Sx \&Rv .  .Sx \&Rv .
 .Ss \&Fa  .Ss \&Fa
 Function argument.  Function argument or parameter.
 Its syntax is as follows:  Its syntax is as follows:
 .Bd -ragged -offset indent  .Bd -ragged -offset indent
 .Pf \. Sx \&Fa  .Pf \. Sx \&Fa
 .Op Cm argtype  .Qo
 .Cm argname  .Op Ar argtype
   .Op Ar argname
   .Qc Ar \&...
 .Ed  .Ed
 .Pp  .Pp
 This may be invoked for names with or without the corresponding type.  Each argument may be a name and a type (recommended for the
 It is also used to specify the field name of a structure.  .Em SYNOPSIS
   section), a name alone (for function invocations),
   or a type alone (for function prototypes).
   If both a type and a name are given or if the type consists of multiple
   words, all words belonging to the same function argument have to be
   given in a single argument to the
   .Sx \&Fa
   macro.
   .Pp
   This macro is also used to specify the field name of a structure.
   .Pp
 Most often, the  Most often, the
 .Sx \&Fa  .Sx \&Fa
 macro is used in the  macro is used in the
 .Em SYNOPSIS  .Em SYNOPSIS
 within  within
 .Sx \&Fo  .Sx \&Fo
 section when documenting multi-line function prototypes.  blocks when documenting multi-line function prototypes.
 If invoked with multiple arguments, the arguments are separated by a  If invoked with multiple arguments, the arguments are separated by a
 comma.  comma.
 Furthermore, if the following macro is another  Furthermore, if the following macro is another
Line 1964  the last argument will also have a trailing comma.
Line 1605  the last argument will also have a trailing comma.
 Examples:  Examples:
 .Dl \&.Fa \(dqconst char *p\(dq  .Dl \&.Fa \(dqconst char *p\(dq
 .Dl \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq  .Dl \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq
 .Dl \&.Fa foo  .Dl \&.Fa \(dqchar *\(dq size_t
 .Pp  .Pp
 See also  See also
 .Sx \&Fo .  .Sx \&Fo .
Line 1972  See also
Line 1613  See also
 End a function context started by  End a function context started by
 .Sx \&Fo .  .Sx \&Fo .
 .Ss \&Fd  .Ss \&Fd
 Historically used to document include files.  Preprocessor directive, in particular for listing it in the
 This usage has been deprecated in favour of  .Em SYNOPSIS .
   Historically, it was also used to document include files.
   The latter usage has been deprecated in favour of
 .Sx \&In .  .Sx \&In .
 Do not use this macro.  
 .Pp  .Pp
   Its syntax is as follows:
   .Bd -ragged -offset indent
   .Pf \. Sx \&Fd
   .Li # Ns Ar directive
   .Op Ar argument ...
   .Ed
   .Pp
   Examples:
   .Dl \&.Fd #define sa_handler __sigaction_u.__sa_handler
   .Dl \&.Fd #define SIO_MAXNFDS
   .Dl \&.Fd #ifdef FS_DEBUG
   .Dl \&.Ft void
   .Dl \&.Fn dbg_open \(dqconst char *\(dq
   .Dl \&.Fd #endif
   .Pp
 See also  See also
 .Sx MANUAL STRUCTURE  .Sx MANUAL STRUCTURE ,
   .Sx \&In ,
 and  and
 .Sx \&In .  .Sx \&Dv .
 .Ss \&Fl  .Ss \&Fl
 Command-line flag or option.  Command-line flag or option.
 Used when listing arguments to command-line utilities.  Used when listing arguments to command-line utilities.
Line 1992  If the argument is a macro, a hyphen is prefixed to th
Line 1650  If the argument is a macro, a hyphen is prefixed to th
 output.  output.
 .Pp  .Pp
 Examples:  Examples:
 .Dl ".Nm cat Fl v No considered harmful"  .Dl ".Fl R Op Fl H | L | P"
 .Dl ".Nm cp Fl pR Ar source ... directory"  .Dl ".Op Fl 1AaCcdFfgHhikLlmnopqRrSsTtux"
 .Dl ".Nm find Ar dir Fl type Cm d Fl name Pa CVS  .Dl ".Fl type Cm d Fl name Pa CVS"
 .Dl ".Nm kill Fl Ar signal_number pid"  .Dl ".Fl Ar signal_number"
 .Dl ".Nm su Fl"  .Dl ".Fl o Fl"
 .Pp  .Pp
 See also  See also
 .Sx \&Cm .  .Sx \&Cm .
Line 2019  section, this macro starts a new output line,
Line 1677  section, this macro starts a new output line,
 and a blank line is automatically inserted between function definitions.  and a blank line is automatically inserted between function definitions.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Fn \*qint funcname\*q \*qint arg0\*q \*qint arg1\*q  .Dl \&.Fn \(dqint funcname\(dq \(dqint arg0\(dq \(dqint arg1\(dq
 .Dl \&.Fn funcname \*qint arg0\*q  .Dl \&.Fn funcname \(dqint arg0\(dq
 .Dl \&.Fn funcname arg0  .Dl \&.Fn funcname arg0
 .Pp  .Pp
 .Bd -literal -offset indent -compact  .Bd -literal -offset indent -compact
Line 2050  Invocations usually occur in the following context:
Line 1708  Invocations usually occur in the following context:
 .br  .br
 .Pf \. Sx \&Fo Ar funcname  .Pf \. Sx \&Fo Ar funcname
 .br  .br
 .Pf \. Sx \&Fa Oo Ar argtype Oc Ar argname  .Pf \. Sx \&Fa Qq Ar argtype Ar argname
 .br  .br
 \&.\.\.  \&.\.\.
 .br  .br
Line 2069  See also
Line 1727  See also
 and  and
 .Sx \&Ft .  .Sx \&Ft .
 .Ss \&Fr  .Ss \&Fr
 This macro is obsolete and not implemented.  This macro is obsolete.
   No replacement markup is needed.
   .Pp
   It was used to show numerical function return values in an italic font.
 .Ss \&Ft  .Ss \&Ft
 A function type.  A function type.
 Its syntax is as follows:  Its syntax is as follows:
Line 2108  See also
Line 1769  See also
 .Sx \&Bx ,  .Sx \&Bx ,
 .Sx \&Dx ,  .Sx \&Dx ,
 .Sx \&Nx ,  .Sx \&Nx ,
 .Sx \&Ox ,  
 and  and
 .Sx \&Ux .  .Sx \&Ox .
 .Ss \&Hf  .Ss \&Hf
 This macro is obsolete and not implemented.  This macro is not implemented in
   .Xr mandoc 1 .
   .Pp
   It was used to include the contents of a (header) file literally.
   The syntax was:
   .Pp
   .Dl Pf . Sx \&Hf Ar filename
 .Ss \&Ic  .Ss \&Ic
 Designate an internal or interactive command.  Designate an internal or interactive command.
 This is similar to  This is similar to
Line 2213  line itself; on following lines, only the
Line 1879  line itself; on following lines, only the
 .Sx \&Ta  .Sx \&Ta
 macro can be used to delimit cells, and  macro can be used to delimit cells, and
 .Sx \&Ta  .Sx \&Ta
 is only recognized as a macro when called by other macros,  is only recognised as a macro when called by other macros,
 not as the first macro on a line.  not as the first macro on a line.
 .Pp  .Pp
 Note that quoted strings may span tab-delimited cells on an  Note that quoted strings may span tab-delimited cells on an
Line 2249  section as described in
Line 1915  section as described in
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Lb libz  .Dl \&.Lb libz
 .Dl \&.Lb mdoc  .Dl \&.Lb libmandoc
 .Ss \&Li  .Ss \&Li
 Denotes text that should be in a literal font mode.  Denotes text that should be in a
   .Li literal
   font mode.
 Note that this is a presentation term and should not be used for  Note that this is a presentation term and should not be used for
 stylistically decorating technical terms.  stylistically decorating technical terms.
 .Pp  .Pp
   On terminal output devices, this is often indistinguishable from
   normal text.
   .Pp
 See also  See also
 .Sx \&Bf ,  .Sx \&Bf ,
 .Sx \&Sy ,  .Sx \&Em ,
   .Sx \&No ,
 and  and
 .Sx \&Em .  .Sx \&Sy .
 .Ss \&Lk  .Ss \&Lk
 Format a hyperlink.  Format a hyperlink.
 Its syntax is as follows:  Its syntax is as follows:
Line 2267  Its syntax is as follows:
Line 1939  Its syntax is as follows:
 .D1 Pf \. Sx \&Lk Ar uri Op Ar name  .D1 Pf \. Sx \&Lk Ar uri Op Ar name
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Lk http://bsd.lv \*qThe BSD.lv Project\*q  .Dl \&.Lk http://bsd.lv \(dqThe BSD.lv Project\(dq
 .Dl \&.Lk http://bsd.lv  .Dl \&.Lk http://bsd.lv
 .Pp  .Pp
 See also  See also
Line 2294  Its syntax is as follows:
Line 1966  Its syntax is as follows:
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Mt discuss@manpages.bsd.lv  .Dl \&.Mt discuss@manpages.bsd.lv
   .Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv
 .Ss \&Nd  .Ss \&Nd
 A one line description of the manual's content.  A one line description of the manual's content.
 This may only be invoked in the  This may only be invoked in the
Line 2303  section subsequent the
Line 1976  section subsequent the
 macro.  macro.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Sx \&Nd mdoc language reference  .Dl Pf . Sx \&Nd mdoc language reference
 .Dl \&.Sx \&Nd format and display UNIX manuals  .Dl Pf . Sx \&Nd format and display UNIX manuals
 .Pp  .Pp
 The  The
 .Sx \&Nd  .Sx \&Nd
Line 2356  macro rather than
Line 2029  macro rather than
 .Sx \&Nm  .Sx \&Nm
 to mark up the name of the manual page.  to mark up the name of the manual page.
 .Ss \&No  .Ss \&No
 A  Normal text.
 .Dq noop  Closes the scope of any preceding in-line macro.
 macro used to terminate prior macro contexts.  When used after physical formatting macros like
   .Sx \&Em
   or
   .Sx \&Sy ,
   switches back to the standard font face and weight.
   Can also be used to embed plain text strings in macro lines
   using semantic annotation macros.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Sx \&Fl ab \&No cd \&Fl ef  .Dl ".Em italic , Sy bold , No and roman"
   .Pp
   .Bd -literal -offset indent -compact
   \&.Sm off
   \&.Cm :C No / Ar pattern No / Ar replacement No /
   \&.Sm on
   .Ed
   .Pp
   See also
   .Sx \&Em ,
   .Sx \&Li ,
   and
   .Sx \&Sy .
 .Ss \&Ns  .Ss \&Ns
 Suppress a space.  Suppress a space between the output of the preceding macro
 Following invocation, text is interpreted as free-form text until a  and the following text or macro.
 macro is encountered.  Following invocation, input is interpreted as normal text
   just like after an
   .Sx \&No
   macro.
 .Pp  .Pp
 This has no effect when invoked at the start of a macro line.  This has no effect when invoked at the start of a macro line.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Fl o \&Ns \&Ar output  .Dl ".Ar name Ns = Ns Ar value"
   .Dl ".Cm :M Ns Ar pattern"
   .Dl ".Fl o Ns Ar output"
 .Pp  .Pp
 See also  See also
 .Sx \&No  .Sx \&No
Line 2392  See also
Line 2088  See also
 .Sx \&Bx ,  .Sx \&Bx ,
 .Sx \&Dx ,  .Sx \&Dx ,
 .Sx \&Fx ,  .Sx \&Fx ,
 .Sx \&Ox ,  
 and  and
 .Sx \&Ux .  .Sx \&Ox .
 .Ss \&Oc  .Ss \&Oc
 Close multi-line  Close multi-line
 .Sx \&Oo  .Sx \&Oo
Line 2423  Examples:
Line 2118  Examples:
 See also  See also
 .Sx \&Oo .  .Sx \&Oo .
 .Ss \&Os  .Ss \&Os
 Document operating system version.  Operating system version for display in the page footer.
 This is the mandatory third macro of  This is the mandatory third macro of
 any  any
 .Nm  .Nm
Line 2448  See also
Line 2143  See also
 and  and
 .Sx \&Dt .  .Sx \&Dt .
 .Ss \&Ot  .Ss \&Ot
 Unknown usage.  This macro is obsolete.
   Use
   .Sx \&Ft
   instead; with
   .Xr mandoc 1 ,
   both have the same effect.
 .Pp  .Pp
 .Em Remarks :  Historical
 this macro has been deprecated.  .Nm
   packages described it as
   .Dq "old function type (FORTRAN)" .
 .Ss \&Ox  .Ss \&Ox
 Format the  Format the
 .Ox  .Ox
Line 2468  See also
Line 2170  See also
 .Sx \&Bx ,  .Sx \&Bx ,
 .Sx \&Dx ,  .Sx \&Dx ,
 .Sx \&Fx ,  .Sx \&Fx ,
 .Sx \&Nx ,  
 and  and
 .Sx \&Ux .  .Sx \&Nx .
 .Ss \&Pa  .Ss \&Pa
 An absolute or relative file system path, or a file or directory name.  An absolute or relative file system path, or a file or directory name.
 If an argument is not provided, the character  If an argument is not provided, the character
Line 2487  See also
Line 2188  See also
 Close parenthesised context opened by  Close parenthesised context opened by
 .Sx \&Po .  .Sx \&Po .
 .Ss \&Pf  .Ss \&Pf
 Removes the space  Removes the space between its argument
 .Pq Dq prefix  .Pq Dq prefix
 between its arguments.  and the following macro.
 Its syntax is as follows:  Its syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. \&Pf Ar prefix suffix  .D1 .Pf Ar prefix macro arguments ...
 .Pp  .Pp
 The  This is equivalent to:
 .Ar suffix  
 argument may be a macro.  
 .Pp  .Pp
   .D1 .No Ar prefix No \&Ns Ar macro arguments ...
   .Pp
 Examples:  Examples:
 .Dl \&.Pf \e. \&Sx \&Pf \&Ar prefix suffix  .Dl ".Pf $ Ar variable_name"
   .Dl ".Pf 0x Ar hex_digits"
   .Pp
   See also
   .Sx \&Ns
   and
   .Sx \&Sm .
 .Ss \&Po  .Ss \&Po
 Multi-line version of  Multi-line version of
 .Sx \&Pq .  .Sx \&Pq .
Line 2507  Multi-line version of
Line 2214  Multi-line version of
 Break a paragraph.  Break a paragraph.
 This will assert vertical space between prior and subsequent macros  This will assert vertical space between prior and subsequent macros
 and/or text.  and/or text.
   .Pp
   Paragraph breaks are not needed before or after
   .Sx \&Sh
   or
   .Sx \&Ss
   macros or before displays
   .Pq Sx \&Bd
   or lists
   .Pq Sx \&Bl
   unless the
   .Fl compact
   flag is given.
 .Ss \&Pq  .Ss \&Pq
 Parenthesised enclosure.  Parenthesised enclosure.
 .Pp  .Pp
Line 2526  Multi-line version of
Line 2245  Multi-line version of
 .Sx \&Qq .  .Sx \&Qq .
 .Ss \&Qq  .Ss \&Qq
 Encloses its arguments in  Encloses its arguments in
 .Dq typewriter  .Qq typewriter
 double-quotes.  double-quotes.
 Consider using  Consider using
 .Sx \&Dq .  .Sx \&Dq .
Line 2613  custom sections be used.
Line 2332  custom sections be used.
 .Pp  .Pp
 Section names should be unique so that they may be keyed by  Section names should be unique so that they may be keyed by
 .Sx \&Sx .  .Sx \&Sx .
   Although this macro is parsed, it should not consist of child node or it
   may not be linked with
   .Sx \&Sx .
 .Pp  .Pp
 See also  See also
 .Sx \&Pp ,  .Sx \&Pp ,
Line 2623  and
Line 2345  and
 Switches the spacing mode for output generated from macros.  Switches the spacing mode for output generated from macros.
 Its syntax is as follows:  Its syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. Sx \&Sm Cm on | off  .D1 Pf \. Sx \&Sm Op Cm on | off
 .Pp  .Pp
 By default, spacing is  By default, spacing is
 .Cm on .  .Cm on .
Line 2632  When switched
Line 2354  When switched
 no white space is inserted between macro arguments and between the  no white space is inserted between macro arguments and between the
 output generated from adjacent macros, but text lines  output generated from adjacent macros, but text lines
 still get normal spacing between words and sentences.  still get normal spacing between words and sentences.
   .Pp
   When called without an argument, the
   .Sx \&Sm
   macro toggles the spacing mode.
   Using this is not recommended because it makes the code harder to read.
 .Ss \&So  .Ss \&So
 Multi-line version of  Multi-line version of
 .Sx \&Sq .  .Sx \&Sq .
 .Ss \&Sq  .Ss \&Sq
 Encloses its arguments in  Encloses its arguments in
 .Dq typewriter  .Sq typewriter
 single-quotes.  single-quotes.
 .Pp  .Pp
 See also  See also
Line 2646  See also
Line 2373  See also
 and  and
 .Sx \&So .  .Sx \&So .
 .Ss \&Ss  .Ss \&Ss
 Begin a new sub-section.  Begin a new subsection.
 Unlike with  Unlike with
 .Sx \&Sh ,  .Sx \&Sh ,
 there's no convention for sub-sections.  there is no convention for the naming of subsections.
 Conventional sections, as described in  Except
 .Sx MANUAL STRUCTURE ,  .Em DESCRIPTION ,
 rarely have sub-sections.  the conventional sections described in
   .Sx MANUAL STRUCTURE
   rarely have subsections.
 .Pp  .Pp
 Sub-section names should be unique so that they may be keyed by  Sub-section names should be unique so that they may be keyed by
 .Sx \&Sx .  .Sx \&Sx .
   Although this macro is parsed, it should not consist of child node or it
   may not be linked with
   .Sx \&Sx .
 .Pp  .Pp
 See also  See also
 .Sx \&Pp ,  .Sx \&Pp ,
Line 2664  and
Line 2396  and
 .Sx \&Sx .  .Sx \&Sx .
 .Ss \&St  .Ss \&St
 Replace an abbreviation for a standard with the full form.  Replace an abbreviation for a standard with the full form.
 The following standards are recognised:  The following standards are recognised.
   Where multiple lines are given without a blank line in between,
   they all refer to the same standard, and using the first form
   is recommended.
   .Bl -tag -width 1n
   .It C language standards
 .Pp  .Pp
 .Bl -tag -width "-p1003.1g-2000X" -compact  .Bl -tag -width "-p1003.1g-2000" -compact
 .It \-p1003.1-88  .It \-ansiC
 .St -p1003.1-88  .St -ansiC
 .It \-p1003.1-90  .It \-ansiC-89
 .St -p1003.1-90  .St -ansiC-89
 .It \-p1003.1-96  
 .St -p1003.1-96  
 .It \-p1003.1-2001  
 .St -p1003.1-2001  
 .It \-p1003.1-2004  
 .St -p1003.1-2004  
 .It \-p1003.1-2008  
 .St -p1003.1-2008  
 .It \-p1003.1  
 .St -p1003.1  
 .It \-p1003.1b  
 .St -p1003.1b  
 .It \-p1003.1b-93  
 .St -p1003.1b-93  
 .It \-p1003.1c-95  
 .St -p1003.1c-95  
 .It \-p1003.1g-2000  
 .St -p1003.1g-2000  
 .It \-p1003.1i-95  
 .St -p1003.1i-95  
 .It \-p1003.2-92  
 .St -p1003.2-92  
 .It \-p1003.2a-92  
 .St -p1003.2a-92  
 .It \-p1387.2-95  
 .St -p1387.2-95  
 .It \-p1003.2  
 .St -p1003.2  
 .It \-p1387.2  
 .St -p1387.2  
 .It \-isoC  .It \-isoC
 .St -isoC  .St -isoC
 .It \-isoC-90  .It \-isoC-90
 .St -isoC-90  .St -isoC-90
   .br
   The original C standard.
   .Pp
 .It \-isoC-amd1  .It \-isoC-amd1
 .St -isoC-amd1  .St -isoC-amd1
   .Pp
 .It \-isoC-tcor1  .It \-isoC-tcor1
 .St -isoC-tcor1  .St -isoC-tcor1
   .Pp
 .It \-isoC-tcor2  .It \-isoC-tcor2
 .St -isoC-tcor2  .St -isoC-tcor2
   .Pp
 .It \-isoC-99  .It \-isoC-99
 .St -isoC-99  .St -isoC-99
   .It \-ansiC-99
   .St -ansiC-99
   .br
   The second major version of the C language standard.
   .Pp
   .It \-isoC-2011
   .St -isoC-2011
   .br
   The third major version of the C language standard.
   .El
   .It POSIX.1 before the Single UNIX Specification
   .Pp
   .Bl -tag -width "-p1003.1g-2000" -compact
   .It \-p1003.1-88
   .St -p1003.1-88
   .It \-p1003.1
   .St -p1003.1
   .br
   The original POSIX standard, based on ANSI C.
   .Pp
   .It \-p1003.1-90
   .St -p1003.1-90
 .It \-iso9945-1-90  .It \-iso9945-1-90
 .St -iso9945-1-90  .St -iso9945-1-90
   .br
   The first update of POSIX.1.
   .Pp
   .It \-p1003.1b-93
   .St -p1003.1b-93
   .It \-p1003.1b
   .St -p1003.1b
   .br
   Real-time extensions.
   .Pp
   .It \-p1003.1c-95
   .St -p1003.1c-95
   .br
   POSIX thread interfaces.
   .Pp
   .It \-p1003.1i-95
   .St -p1003.1i-95
   .br
   Technical Corrigendum.
   .Pp
   .It \-p1003.1-96
   .St -p1003.1-96
 .It \-iso9945-1-96  .It \-iso9945-1-96
 .St -iso9945-1-96  .St -iso9945-1-96
 .It \-iso9945-2-93  .br
 .St -iso9945-2-93  Includes POSIX.1-1990, 1b, 1c, and 1i.
 .It \-ansiC  .El
 .St -ansiC  .It X/Open Portability Guide version 4 and related standards
 .It \-ansiC-89  .Pp
 .St -ansiC-89  .Bl -tag -width "-p1003.1g-2000" -compact
 .It \-ansiC-99  
 .St -ansiC-99  
 .It \-ieee754  
 .St -ieee754  
 .It \-iso8802-3  
 .St -iso8802-3  
 .It \-ieee1275-94  
 .St -ieee1275-94  
 .It \-xpg3  .It \-xpg3
 .St -xpg3  .St -xpg3
   .br
   An XPG4 precursor, published in 1989.
   .Pp
   .It \-p1003.2
   .St -p1003.2
   .It \-p1003.2-92
   .St -p1003.2-92
   .It \-iso9945-2-93
   .St -iso9945-2-93
   .br
   An XCU4 precursor.
   .Pp
   .It \-p1003.2a-92
   .St -p1003.2a-92
   .br
   Updates to POSIX.2.
   .Pp
 .It \-xpg4  .It \-xpg4
 .St -xpg4  .St -xpg4
   .br
   Based on POSIX.1 and POSIX.2, published in 1992.
   .El
   .It Single UNIX Specification version 1 and related standards
   .Pp
   .Bl -tag -width "-p1003.1g-2000" -compact
   .It \-susv1
   .St -susv1
 .It \-xpg4.2  .It \-xpg4.2
 .St -xpg4.2  .St -xpg4.2
   .br
   This standard was published in 1994.
   It was used as the basis for UNIX 95 certification.
   The following three refer to parts of it.
   .Pp
   .It \-xsh4.2
   .St -xsh4.2
   .Pp
   .It \-xcurses4.2
   .St -xcurses4.2
   .Pp
   .It \-p1003.1g-2000
   .St -p1003.1g-2000
   .br
   Networking APIs, including sockets.
   .Pp
 .It \-xpg4.3  .It \-xpg4.3
 .St -xpg4.3  .St -xpg4.3
   .Pp
   .It \-svid4
   .St -svid4 ,
   .br
   Published in 1995.
   .El
   .It Single UNIX Specification version 2 and related standards
   .Pp
   .Bl -tag -width "-p1003.1g-2000" -compact
   .It \-susv2
   .St -susv2
   This Standard was published in 1997
   and is also called X/Open Portability Guide version 5.
   It was used as the basis for UNIX 98 certification.
   The following refer to parts of it.
   .Pp
 .It \-xbd5  .It \-xbd5
 .St -xbd5  .St -xbd5
 .It \-xcu5  .Pp
 .St -xcu5  
 .It \-xsh5  .It \-xsh5
 .St -xsh5  .St -xsh5
   .Pp
   .It \-xcu5
   .St -xcu5
   .Pp
 .It \-xns5  .It \-xns5
 .St -xns5  .St -xns5
 .It \-xns5.2  .It \-xns5.2
 .St -xns5.2  .St -xns5.2
 .It \-xns5.2d2.0  .El
 .St -xns5.2d2.0  .It Single UNIX Specification version 3 and related standards
 .It \-xcurses4.2  .Pp
 .St -xcurses4.2  .Bl -tag -width "-p1003.1g-2000X" -compact
 .It \-susv2  .It \-p1003.1d-99
 .St -susv2  .St -p1003.1d-99
   .br
   Additional real-time extensions.
   .Pp
   .It \-p1003.1-2001
   .St -p1003.1-2001
 .It \-susv3  .It \-susv3
 .St -susv3  .St -susv3
 .It \-svid4  .br
 .St -svid4  This standard is based on C99, SUSv2, POSIX.1-1996, 1d, and 1j.
   It is also called X/Open Portability Guide version 6.
   It is used as the basis for UNIX 03 certification.
   .Pp
   .It \-p1003.1-2004
   .St -p1003.1-2004
   .br
   The second and last Technical Corrigendum.
 .El  .El
   .It Single UNIX Specification version 4
   .Pp
   .Bl -tag -width "-p1003.1g-2000" -compact
   .It \-p1003.1-2008
   .St -p1003.1-2008
   .It \-susv4
   .St -susv4
   .br
   This standard is also called
   X/Open Portability Guide version 7.
   .Pp
   .It \-p1003.1-2013
   .St -p1003.1-2013
   .br
   This is the first Technical Corrigendum.
   .El
   .It Other standards
   .Pp
   .Bl -tag -width "-p1003.1g-2000" -compact
   .It \-ieee754
   .St -ieee754
   .br
   Floating-point arithmetic.
   .Pp
   .It \-iso8601
   .St -iso8601
   .br
   Representation of dates and times, published in 1988.
   .Pp
   .It \-iso8802-3
   .St -iso8802-3
   .br
   Ethernet local area networks.
   .Pp
   .It \-ieee1275-94
   .St -ieee1275-94
   .El
   .El
 .Ss \&Sx  .Ss \&Sx
 Reference a section or sub-section.  Reference a section or subsection in the same manual page.
 The referenced section or sub-section name must be identical to the  The referenced section or subsection name must be identical to the
 enclosed argument, including whitespace.  enclosed argument, including whitespace.
 .Pp  .Pp
 Examples:  Examples:
Line 2773  See also
Line 2632  See also
 and  and
 .Sx \&Ss .  .Sx \&Ss .
 .Ss \&Sy  .Ss \&Sy
 Format enclosed arguments in symbolic  Request a boldface font.
 .Pq Dq boldface .  
 Note that this is a presentation term and should not be used for  
 stylistically decorating technical terms.  
 .Pp  .Pp
   This is most often used to indicate importance or seriousness (not to be
   confused with stress emphasis, see
   .Sx \&Em ) .
   When none of the semantic macros fit, it is also adequate for syntax
   elements that have to be given or that appear verbatim.
   .Pp
   Examples:
   .Bd -literal -compact -offset indent
   \&.Sy Warning :
   If
   \&.Sy s
   appears in the owner permissions, set-user-ID mode is set.
   This utility replaces the former
   \&.Sy dumpdir
   program.
   .Ed
   .Pp
 See also  See also
 .Sx \&Bf ,  .Sx \&Bf ,
   .Sx \&Em ,
 .Sx \&Li ,  .Sx \&Li ,
 and  and
 .Sx \&Em .  .Sx \&No .
 .Ss \&Ta  .Ss \&Ta
 Table cell separator in  Table cell separator in
 .Sx \&Bl Fl column  .Sx \&Bl Fl column
 lists; can only be used below  lists; can only be used below
 .Sx \&It .  .Sx \&It .
 .Ss \&Tn  .Ss \&Tn
 Format a tradename.  Supported only for compatibility, do not use this in new manuals.
 .Pp  Even though the macro name
 Examples:  .Pq Dq tradename
 .Dl \&.Tn IBM  suggests a semantic function, historic usage is inconsistent, mostly
   using it as a presentation-level macro to request a small caps font.
 .Ss \&Ud  .Ss \&Ud
   Supported only for compatibility, do not use this in new manuals.
 Prints out  Prints out
 .Dq currently under development .  .Dq currently under development.
 .Ss \&Ux  .Ss \&Ux
 Format the UNIX name.  Supported only for compatibility, do not use this in new manuals.
 Accepts no argument.  Prints out
 .Pp  .Dq Ux .
 Examples:  
 .Dl \&.Ux  
 .Pp  
 See also  
 .Sx \&At ,  
 .Sx \&Bsx ,  
 .Sx \&Bx ,  
 .Sx \&Dx ,  
 .Sx \&Fx ,  
 .Sx \&Nx ,  
 and  
 .Sx \&Ox .  
 .Ss \&Va  .Ss \&Va
 A variable name.  A variable name.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Va foo  .Dl \&.Va foo
 .Dl \&.Va const char *bar ;  .Dl \&.Va const char *bar ;
   .Pp
   For function arguments and parameters, use
   .Sx \&Fa
   instead.
   For declarations of global variables in the
   .Em SYNOPSIS
   section, use
   .Sx \&Vt .
 .Ss \&Vt  .Ss \&Vt
 A variable type.  A variable type.
   .Pp
 This is also used for indicating global variables in the  This is also used for indicating global variables in the
 .Em SYNOPSIS  .Em SYNOPSIS
 section, in which case a variable name is also specified.  section, in which case a variable name is also specified.
Line 2834  In the former case, this macro starts a new output lin
Line 2707  In the former case, this macro starts a new output lin
 and a blank line is inserted in front if there is a preceding  and a blank line is inserted in front if there is a preceding
 function definition or include directive.  function definition or include directive.
 .Pp  .Pp
 Note that this should not be confused with  
 .Sx \&Ft ,  
 which is used for function return types.  
 .Pp  
 Examples:  Examples:
 .Dl \&.Vt unsigned char  .Dl \&.Vt unsigned char
 .Dl \&.Vt extern const char * const sys_signame[] \&;  .Dl \&.Vt extern const char * const sys_signame[] \&;
 .Pp  .Pp
   For parameters in function prototypes, use
   .Sx \&Fa
   instead, for function return types
   .Sx \&Ft ,
   and for variable names outside the
   .Em SYNOPSIS
   section
   .Sx \&Va ,
   even when including a type with the name.
 See also  See also
 .Sx MANUAL STRUCTURE  .Sx MANUAL STRUCTURE .
 and  
 .Sx \&Va .  
 .Ss \&Xc  .Ss \&Xc
 Close a scope opened by  Close a scope opened by
 .Sx \&Xo .  .Sx \&Xo .
Line 2862  Link to another manual
Line 2738  Link to another manual
 .Pq Qq cross-reference .  .Pq Qq cross-reference .
 Its syntax is as follows:  Its syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. Sx \&Xr Ar name section  .D1 Pf \. Sx \&Xr Ar name Op section
 .Pp  .Pp
 The  Cross reference the
 .Ar name  .Ar name
 and  and
 .Ar section  .Ar section
 are the name and section of the linked manual.  number of another man page;
 If  omitting the section number is rarely useful.
 .Ar section  
 is followed by non-punctuation, an  
 .Sx \&Ns  
 is inserted into the token stream.  
 This behaviour is for compatibility with  
 GNU troff.  
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Xr mandoc 1  .Dl \&.Xr mandoc 1
Line 2899  Its syntax is as follows:
Line 2769  Its syntax is as follows:
 .Pp  .Pp
 The  The
 .Ar height  .Ar height
 argument must be formatted as described in  argument is a scaling width as described in
 .Sx Scaling Widths .  .Xr roff 7 .
 If unspecified,  If unspecified,
 .Sx \&sp  .Sx \&sp
 asserts a single vertical space.  asserts a single vertical space.
   .Sh MACRO SYNTAX
   The syntax of a macro depends on its classification.
   In this section,
   .Sq \-arg
   refers to macro arguments, which may be followed by zero or more
   .Sq parm
   parameters;
   .Sq \&Yo
   opens the scope of a macro; and if specified,
   .Sq \&Yc
   closes it out.
   .Pp
   The
   .Em Callable
   column indicates that the macro may also be called by passing its name
   as an argument to another macro.
   For example,
   .Sq \&.Op \&Fl O \&Ar file
   produces
   .Sq Op Fl O Ar file .
   To prevent a macro call and render the macro name literally,
   escape it by prepending a zero-width space,
   .Sq \e& .
   For example,
   .Sq \&Op \e&Fl O
   produces
   .Sq Op \&Fl O .
   If a macro is not callable but its name appears as an argument
   to another macro, it is interpreted as opaque text.
   For example,
   .Sq \&.Fl \&Sh
   produces
   .Sq Fl \&Sh .
   .Pp
   The
   .Em Parsed
   column indicates whether the macro may call other macros by receiving
   their names as arguments.
   If a macro is not parsed but the name of another macro appears
   as an argument, it is interpreted as opaque text.
   .Pp
   The
   .Em Scope
   column, if applicable, describes closure rules.
   .Ss Block full-explicit
   Multi-line scope closed by an explicit closing macro.
   All macros contains bodies; only
   .Sx \&Bf
   and
   .Pq optionally
   .Sx \&Bl
   contain a head.
   .Bd -literal -offset indent
   \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
   \(lBbody...\(rB
   \&.Yc
   .Ed
   .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXX" -offset indent
   .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
   .It Sx \&Bd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ed
   .It Sx \&Bf  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ef
   .It Sx \&Bk  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Ek
   .It Sx \&Bl  Ta    \&No     Ta    \&No     Ta    closed by Sx \&El
   .It Sx \&Ed  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bd
   .It Sx \&Ef  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bf
   .It Sx \&Ek  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bk
   .It Sx \&El  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Bl
   .El
   .Ss Block full-implicit
   Multi-line scope closed by end-of-file or implicitly by another macro.
   All macros have bodies; some
   .Po
   .Sx \&It Fl bullet ,
   .Fl hyphen ,
   .Fl dash ,
   .Fl enum ,
   .Fl item
   .Pc
   don't have heads; only one
   .Po
   .Sx \&It
   in
   .Sx \&Bl Fl column
   .Pc
   has multiple heads.
   .Bd -literal -offset indent
   \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB
   \(lBbody...\(rB
   .Ed
   .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXXXXXXXXX" -offset indent
   .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
   .It Sx \&It Ta \&No Ta Yes  Ta closed by Sx \&It , Sx \&El
   .It Sx \&Nd Ta \&No Ta \&No Ta closed by Sx \&Sh
   .It Sx \&Nm Ta \&No Ta Yes  Ta closed by Sx \&Nm , Sx \&Sh , Sx \&Ss
   .It Sx \&Sh Ta \&No Ta Yes  Ta closed by Sx \&Sh
   .It Sx \&Ss Ta \&No Ta Yes  Ta closed by Sx \&Sh , Sx \&Ss
   .El
   .Pp
   Note that the
   .Sx \&Nm
   macro is a
   .Sx Block full-implicit
   macro only when invoked as the first macro
   in a
   .Em SYNOPSIS
   section line, else it is
   .Sx In-line .
   .Ss Block partial-explicit
   Like block full-explicit, but also with single-line scope.
   Each has at least a body and, in limited circumstances, a head
   .Po
   .Sx \&Fo ,
   .Sx \&Eo
   .Pc
   and/or tail
   .Pq Sx \&Ec .
   .Bd -literal -offset indent
   \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB
   \(lBbody...\(rB
   \&.Yc \(lBtail...\(rB
   
   \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \
   \(lBbody...\(rB \&Yc \(lBtail...\(rB
   .Ed
   .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -offset indent
   .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
   .It Sx \&Ac  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Ao
   .It Sx \&Ao  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ac
   .It Sx \&Bc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Bo
   .It Sx \&Bo  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Bc
   .It Sx \&Brc Ta    Yes      Ta    Yes      Ta    opened by Sx \&Bro
   .It Sx \&Bro Ta    Yes      Ta    Yes      Ta    closed by Sx \&Brc
   .It Sx \&Dc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Do
   .It Sx \&Do  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Dc
   .It Sx \&Ec  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Eo
   .It Sx \&Eo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Ec
   .It Sx \&Fc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Fo
   .It Sx \&Fo  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Fc
   .It Sx \&Oc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Oo
   .It Sx \&Oo  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Oc
   .It Sx \&Pc  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Po
   .It Sx \&Po  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Pc
   .It Sx \&Qc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Oo
   .It Sx \&Qo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Oc
   .It Sx \&Re  Ta    \&No     Ta    \&No     Ta    opened by Sx \&Rs
   .It Sx \&Rs  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Re
   .It Sx \&Sc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&So
   .It Sx \&So  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Sc
   .It Sx \&Xc  Ta    Yes      Ta    Yes      Ta    opened by Sx \&Xo
   .It Sx \&Xo  Ta    Yes      Ta    Yes      Ta    closed by Sx \&Xc
   .El
   .Ss Block partial-implicit
   Like block full-implicit, but with single-line scope closed by the
   end of the line.
   .Bd -literal -offset indent
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB
   .Ed
   .Bl -column "MacroX" "CallableX" "ParsedX" -offset indent
   .It Em Macro Ta Em Callable Ta Em Parsed
   .It Sx \&Aq  Ta    Yes      Ta    Yes
   .It Sx \&Bq  Ta    Yes      Ta    Yes
   .It Sx \&Brq Ta    Yes      Ta    Yes
   .It Sx \&D1  Ta    \&No     Ta    \&Yes
   .It Sx \&Dl  Ta    \&No     Ta    Yes
   .It Sx \&Dq  Ta    Yes      Ta    Yes
   .It Sx \&En  Ta    Yes      Ta    Yes
   .It Sx \&Op  Ta    Yes      Ta    Yes
   .It Sx \&Pq  Ta    Yes      Ta    Yes
   .It Sx \&Ql  Ta    Yes      Ta    Yes
   .It Sx \&Qq  Ta    Yes      Ta    Yes
   .It Sx \&Sq  Ta    Yes      Ta    Yes
   .It Sx \&Vt  Ta    Yes      Ta    Yes
   .El
   .Pp
   Note that the
   .Sx \&Vt
   macro is a
   .Sx Block partial-implicit
   only when invoked as the first macro
   in a
   .Em SYNOPSIS
   section line, else it is
   .Sx In-line .
   .Ss Special block macro
   The
   .Sx \&Ta
   macro can only be used below
   .Sx \&It
   in
   .Sx \&Bl Fl column
   lists.
   It delimits blocks representing table cells;
   these blocks have bodies, but no heads.
   .Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -offset indent
   .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
   .It Sx \&Ta  Ta    Yes      Ta    Yes    Ta closed by Sx \&Ta , Sx \&It
   .El
   .Ss In-line
   Closed by the end of the line, fixed argument lengths,
   and/or subsequent macros.
   In-line macros have only text children.
   If a number (or inequality) of arguments is
   .Pq n ,
   then the macro accepts an arbitrary number of arguments.
   .Bd -literal -offset indent
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lBres...\(rB
   
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc...
   
   \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN
   .Ed
   .Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -offset indent
   .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Arguments
   .It Sx \&%A  Ta    \&No     Ta    \&No     Ta    >0
   .It Sx \&%B  Ta    \&No     Ta    \&No     Ta    >0
   .It Sx \&%C  Ta    \&No     Ta    \&No     Ta    >0
   .It Sx \&%D  Ta    \&No     Ta    \&No     Ta    >0
   .It Sx \&%I  Ta    \&No     Ta    \&No     Ta    >0
   .It Sx \&%J  Ta    \&No     Ta    \&No     Ta    >0
   .It Sx \&%N  Ta    \&No     Ta    \&No     Ta    >0
   .It Sx \&%O  Ta    \&No     Ta    \&No     Ta    >0
   .It Sx \&%P  Ta    \&No     Ta    \&No     Ta    >0
   .It Sx \&%Q  Ta    \&No     Ta    \&No     Ta    >0
   .It Sx \&%R  Ta    \&No     Ta    \&No     Ta    >0
   .It Sx \&%T  Ta    \&No     Ta    \&No     Ta    >0
   .It Sx \&%U  Ta    \&No     Ta    \&No     Ta    >0
   .It Sx \&%V  Ta    \&No     Ta    \&No     Ta    >0
   .It Sx \&Ad  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&An  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&Ap  Ta    Yes      Ta    Yes      Ta    0
   .It Sx \&Ar  Ta    Yes      Ta    Yes      Ta    n
   .It Sx \&At  Ta    Yes      Ta    Yes      Ta    1
   .It Sx \&Bsx Ta    Yes      Ta    Yes      Ta    n
   .It Sx \&Bt  Ta    \&No     Ta    \&No     Ta    0
   .It Sx \&Bx  Ta    Yes      Ta    Yes      Ta    n
   .It Sx \&Cd  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&Cm  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&Db  Ta    \&No     Ta    \&No     Ta    1
   .It Sx \&Dd  Ta    \&No     Ta    \&No     Ta    n
   .It Sx \&Dt  Ta    \&No     Ta    \&No     Ta    n
   .It Sx \&Dv  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&Dx  Ta    Yes      Ta    Yes      Ta    n
   .It Sx \&Em  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&Er  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&Es  Ta    Yes      Ta    Yes      Ta    2
   .It Sx \&Ev  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&Ex  Ta    \&No     Ta    \&No     Ta    n
   .It Sx \&Fa  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&Fd  Ta    \&No     Ta    \&No     Ta    >0
   .It Sx \&Fl  Ta    Yes      Ta    Yes      Ta    n
   .It Sx \&Fn  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&Fr  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&Ft  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&Fx  Ta    Yes      Ta    Yes      Ta    n
   .It Sx \&Hf  Ta    \&No     Ta    \&No     Ta    n
   .It Sx \&Ic  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&In  Ta    \&No     Ta    \&No     Ta    1
   .It Sx \&Lb  Ta    \&No     Ta    \&No     Ta    1
   .It Sx \&Li  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&Lk  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&Lp  Ta    \&No     Ta    \&No     Ta    0
   .It Sx \&Ms  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&Mt  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&Nm  Ta    Yes      Ta    Yes      Ta    n
   .It Sx \&No  Ta    Yes      Ta    Yes      Ta    0
   .It Sx \&Ns  Ta    Yes      Ta    Yes      Ta    0
   .It Sx \&Nx  Ta    Yes      Ta    Yes      Ta    n
   .It Sx \&Os  Ta    \&No     Ta    \&No     Ta    n
   .It Sx \&Ot  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&Ox  Ta    Yes      Ta    Yes      Ta    n
   .It Sx \&Pa  Ta    Yes      Ta    Yes      Ta    n
   .It Sx \&Pf  Ta    Yes      Ta    Yes      Ta    1
   .It Sx \&Pp  Ta    \&No     Ta    \&No     Ta    0
   .It Sx \&Rv  Ta    \&No     Ta    \&No     Ta    n
   .It Sx \&Sm  Ta    \&No     Ta    \&No     Ta    <2
   .It Sx \&St  Ta    \&No     Ta    Yes      Ta    1
   .It Sx \&Sx  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&Sy  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&Tn  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&Ud  Ta    \&No     Ta    \&No     Ta    0
   .It Sx \&Ux  Ta    Yes      Ta    Yes      Ta    n
   .It Sx \&Va  Ta    Yes      Ta    Yes      Ta    n
   .It Sx \&Vt  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&Xr  Ta    Yes      Ta    Yes      Ta    >0
   .It Sx \&br  Ta    \&No     Ta    \&No     Ta    0
   .It Sx \&sp  Ta    \&No     Ta    \&No     Ta    1
   .El
   .Ss Delimiters
   When a macro argument consists of one single input character
   considered as a delimiter, the argument gets special handling.
   This does not apply when delimiters appear in arguments containing
   more than one character.
   Consequently, to prevent special handling and just handle it
   like any other argument, a delimiter can be escaped by prepending
   a zero-width space
   .Pq Sq \e& .
   In text lines, delimiters never need escaping, but may be used
   as normal punctuation.
   .Pp
   For many macros, when the leading arguments are opening delimiters,
   these delimiters are put before the macro scope,
   and when the trailing arguments are closing delimiters,
   these delimiters are put after the macro scope.
   For example,
   .Pp
   .D1 Pf \. \&Aq "( [ word ] ) ."
   .Pp
   renders as:
   .Pp
   .D1 Aq ( [ word ] ) .
   .Pp
   Opening delimiters are:
   .Pp
   .Bl -tag -width Ds -offset indent -compact
   .It \&(
   left parenthesis
   .It \&[
   left bracket
   .El
   .Pp
   Closing delimiters are:
   .Pp
   .Bl -tag -width Ds -offset indent -compact
   .It \&.
   period
   .It \&,
   comma
   .It \&:
   colon
   .It \&;
   semicolon
   .It \&)
   right parenthesis
   .It \&]
   right bracket
   .It \&?
   question mark
   .It \&!
   exclamation mark
   .El
   .Pp
   Note that even a period preceded by a backslash
   .Pq Sq \e.\&
   gets this special handling; use
   .Sq \e&.
   to prevent that.
   .Pp
   Many in-line macros interrupt their scope when they encounter
   delimiters, and resume their scope when more arguments follow that
   are not delimiters.
   For example,
   .Pp
   .D1 Pf \. \&Fl "a ( b | c \e*(Ba d ) e"
   .Pp
   renders as:
   .Pp
   .D1 Fl a ( b | c \*(Ba d ) e
   .Pp
   This applies to both opening and closing delimiters,
   and also to the middle delimiter:
   .Pp
   .Bl -tag -width Ds -offset indent -compact
   .It \&|
   vertical bar
   .El
   .Pp
   As a special case, the predefined string \e*(Ba is handled and rendered
   in the same way as a plain
   .Sq \&|
   character.
   Using this predefined string is not recommended in new manuals.
   .Ss Font handling
   In
   .Nm
   documents, usage of semantic markup is recommended in order to have
   proper fonts automatically selected; only when no fitting semantic markup
   is available, consider falling back to
   .Sx Physical markup
   macros.
   Whenever any
   .Nm
   macro switches the
   .Xr roff 7
   font mode, it will automatically restore the previous font when exiting
   its scope.
   Manually switching the font using the
   .Xr roff 7
   .Ql \ef
   font escape sequences is never required.
 .Sh COMPATIBILITY  .Sh COMPATIBILITY
 This section documents compatibility between mandoc and other other  This section provides an incomplete list of compatibility issues
 troff implementations, at this time limited to GNU troff  between mandoc and other troff implementations, at this time limited
   to GNU troff
 .Pq Qq groff .  .Pq Qq groff .
 The term  The term
 .Qq historic groff  .Qq historic groff
Line 2941  Newer groff and mandoc print
Line 3201  Newer groff and mandoc print
 and the arguments.  and the arguments.
 .It  .It
 .Sx \&Bl Fl column  .Sx \&Bl Fl column
 does not recognize trailing punctuation characters when they immediately  does not recognise trailing punctuation characters when they immediately
 precede tabulator characters, but treats them as normal text and  precede tabulator characters, but treats them as normal text and
 outputs a space before them.  outputs a space before them.
 .It  .It
Line 3015  certain list types.
Line 3275  certain list types.
 can only be called by other macros, but not at the beginning of a line.  can only be called by other macros, but not at the beginning of a line.
 .It  .It
 .Sx \&%C  .Sx \&%C
 is not implemented.  is not implemented (up to and including groff-1.22.2).
 .It  .It
 Historic groff only allows up to eight or nine arguments per macro input  Historic groff only allows up to eight or nine arguments per macro input
 line, depending on the exact situation.  line, depending on the exact situation.
Line 3033  in new groff and mandoc.
Line 3293  in new groff and mandoc.
 .Sq \ef  .Sq \ef
 .Pq font face  .Pq font face
 and  and
 .Sq \ef  .Sq \eF
 .Pq font family face  .Pq font family face
 .Sx Text Decoration  .Sx Text Decoration
 escapes behave irregularly when specified within line-macro scopes.  escapes behave irregularly when specified within line-macro scopes.
Line 3050  The following features are unimplemented in mandoc:
Line 3310  The following features are unimplemented in mandoc:
 .Fl file Ar file .  .Fl file Ar file .
 .It  .It
 .Sx \&Bd  .Sx \&Bd
 .Fl offset Ar center  .Fl offset Cm center
 and  and
 .Fl offset Ar right .  .Fl offset Cm right .
 Groff does not implement centered and flush-right rendering either,  Groff does not implement centred and flush-right rendering either,
 but produces large indentations.  but produces large indentations.
 .It  
 The  
 .Sq \eh  
 .Pq horizontal position ,  
 .Sq \ev  
 .Pq vertical position ,  
 .Sq \em  
 .Pq text colour ,  
 .Sq \eM  
 .Pq text filling colour ,  
 .Sq \ez  
 .Pq zero-length character ,  
 .Sq \ew  
 .Pq string length ,  
 .Sq \ek  
 .Pq horizontal position marker ,  
 .Sq \eo  
 .Pq text overstrike ,  
 and  
 .Sq \es  
 .Pq text size  
 escape sequences are all discarded in mandoc.  
 .It  
 The  
 .Sq \ef  
 scaling unit is accepted by mandoc, but rendered as the default unit.  
 .It  
 In quoted literals, groff allows pairwise double-quotes to produce a  
 standalone double-quote in formatted output.  
 This is not supported by mandoc.  
 .El  .El
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr man 1 ,  .Xr man 1 ,
 .Xr mandoc 1 ,  .Xr mandoc 1 ,
 .Xr eqn 7 ,  .Xr eqn 7 ,
 .Xr man 7 ,  .Xr man 7 ,
 .Xr mandoc_char 7  .Xr mandoc_char 7 ,
 .Xr roff 7 ,  .Xr roff 7 ,
 .Xr tbl 7  .Xr tbl 7
 .Sh HISTORY  .Sh HISTORY
Line 3109  utility written by Kristaps Dzonsons appeared in
Line 3339  utility written by Kristaps Dzonsons appeared in
 The  The
 .Nm  .Nm
 reference was written by  reference was written by
 .An Kristaps Dzonsons Aq kristaps@bsd.lv .  .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
Legend:
Removed from v.1.196  
changed lines
  Added in v.1.243
CVSweb