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

Diff for /mandoc/mdoc.7 between version 1.142 and 1.264

version 1.142, 2010/07/26 13:45:49 version 1.264, 2017/05/05 15:54:59
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009, 2010 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-2017 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.
 In this reference document, we describe its syntax, structure, and  Such annotations are used by formatting tools to achieve a uniform
 usage.  presentation across all manuals written in
 Our reference implementation is mandoc; the  .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 ;
   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 called
 are parsed for macros.  .Dq macro lines .
 Other lines are interpreted within the scope of  The first word is the macro name.
 prior macros:  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.
 Other 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.  
 All manuals must have  
 .Ux  
 line terminators.  
 .Ss Comments  
 Text following a  
 .Sq \e\*q ,  
 whether in a macro or free-form text line, is ignored to the end of  
 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 optionally whitespace are  
 stripped from input.  
 .Ss Reserved Characters  
 Within a macro line, the following characters are reserved:  
 .Pp  .Pp
 .Bl -tag -width Ds -offset indent -compact  Many aspects of the basic syntax of the
 .It \&.  .Nm
 .Pq period  language are based on the
 .It \&,  .Xr roff 7
 .Pq comma  language; see the
 .It \&:  .Em LANGUAGE SYNTAX
 .Pq colon  
 .It \&;  
 .Pq semicolon  
 .It \&(  
 .Pq left-parenthesis  
 .It \&)  
 .Pq right-parenthesis  
 .It \&[  
 .Pq left-bracket  
 .It \&]  
 .Pq right-bracket  
 .It \&?  
 .Pq question  
 .It \&!  
 .Pq exclamation  
 .It \&|  
 .Pq vertical bar  
 .El  
 .Pp  
 Use of reserved characters is described in  
 .Sx MACRO SYNTAX .  
 For general use in macro lines, these characters can either be escaped  
 with a non-breaking space  
 .Pq Sq \e&  
 or, if applicable, an appropriate escape sequence can be used.  
 .Ss Special Characters  
 Special characters may occur in both macro and free-form 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
 .D1 \efBbold\efR \efIitalic\efP  
 .Pp  
 A numerical representation 3, 2, or 1 (bold, italic, and Roman,  
 respectively) may be used instead.  
 A text decoration is valid within  
 the current font scope only: if a macro opens a font scope alongside  
 its own scope, such as  
 .Sx \&Bf  
 .Cm \&Sy ,  
 in-scope invocations of  
 .Sq \ef  
 are only valid within the font scope of the macro.  
 If  
 .Sq \ef  
 is specified outside of any font scope, such as in unenclosed, free-form  
 text, it will affect the remainder of the document.  
 .Pp  
 Note this form is  
 .Em not  
 recommended for  
 .Nm ,  
 which encourages semantic annotation.  
 .Ss Predefined Strings  
 Historically,  
 .Xr groff 1  
 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 free-form lines, whitespace is preserved within a line; un-escaped  
 trailing spaces are stripped from input (unless in a literal context).  
 Blank free-form lines, which may include whitespace, are only permitted  
 within literal contexts.  
 .Pp  
 In macro lines, whitespace delimits arguments and is discarded.  
 If arguments are quoted, whitespace within the quotes is retained.  
 .Ss Quotation  
 Macro arguments may be quoted with double-quotes to group  
 space-delimited terms or to retain blocks of whitespace.  
 A quoted argument begins with a double-quote preceded by whitespace.  
 The next double-quote not pair-wise adjacent to another double-quote  
 terminates the literal, regardless of surrounding whitespace.  
 .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 free-form mode, quotes are regarded as opaque text.  
 .Ss Dates  
 There are several macros in  
 .Nm  .Nm
 that require a date argument.  documents is discouraged;
 The canonical form for dates is the American format:  .Xr mandoc 1
 .Pp  supports some of them merely for backward compatibility.
 .D1 Cm Month Day , Year  
 .Pp  
 The  
 .Cm Day  
 value is an optionally zero-padded numeral.  
 The  
 .Cm Month  
 value is the full month name.  
 The  
 .Cm Year  
 value is the full four-digit year.  
 .Pp  
 Reduced form dates are broken-down canonical form dates:  
 .Pp  
 .D1 Cm Month , Year  
 .D1 Cm Year  
 .Pp  
 Some examples of valid dates follow:  
 .Pp  
 .D1 "May, 2009" Pq reduced form  
 .D1 "2009" Pq reduced form  
 .D1 "May 20, 2009" Pq canonical form  
 .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 your 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 (  
 .Ns Sq \&) ,  
 .Sq \&] ,  
 .Sq \&' ,  
 .Sq \&" ) .  
 .Pp  
 The proper spacing is also intelligently preserved if a sentence ends at  
 the boundary of a macro line, e.g.,  
 .Pp  
 .D1 \&Xr mandoc 1 \.  
 .D1 \&Fl T \&Ns \&Cm ascii \.  
 .Sh MANUAL STRUCTURE  .Sh MANUAL STRUCTURE
 A well-formed  A well-formed
 .Nm  .Nm
Line 320  sections, although this varies between manual sections
Line 115  sections, although this varies between manual sections
 .Pp  .Pp
 The following is a well-formed skeleton  The following is a well-formed skeleton
 .Nm  .Nm
 file:  file for a utility
   .Qq progname :
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Dd $\&Mdocdate$  \&.Dd $\&Mdocdate$
 \&.Dt mdoc 7  \&.Dt PROGNAME section
 \&.Os  \&.Os
 \&.Sh NAME  \&.Sh NAME
 \&.Nm foo  \&.Nm progname
 \&.Nd a description goes here  \&.Nd one line about what it does
 \&.\e\*q The next is for sections 2, 3, & 9 only.  \&.\e\(dq .Sh LIBRARY
 \&.\e\*q .Sh LIBRARY  \&.\e\(dq For sections 2, 3, and 9 only.
   \&.\e\(dq Not used in OpenBSD.
 \&.Sh SYNOPSIS  \&.Sh SYNOPSIS
 \&.Nm foo  \&.Nm progname
 \&.Op Fl options  \&.Op Fl options
 \&.Ar  \&.Ar
 \&.Sh DESCRIPTION  \&.Sh DESCRIPTION
 The  The
 \&.Nm  \&.Nm
 utility processes files ...  utility processes files ...
 \&.\e\*q .Sh IMPLEMENTATION NOTES  \&.\e\(dq .Sh CONTEXT
 \&.\e\*q The next is for sections 2, 3, & 9 only.  \&.\e\(dq For section 9 functions only.
 \&.\e\*q .Sh RETURN VALUES  \&.\e\(dq .Sh IMPLEMENTATION NOTES
 \&.\e\*q The next is for sections 1, 6, 7, & 8 only.  \&.\e\(dq Not used in OpenBSD.
 \&.\e\*q .Sh ENVIRONMENT  \&.\e\(dq .Sh RETURN VALUES
 \&.\e\*q .Sh FILES  \&.\e\(dq For sections 2, 3, and 9 function return values only.
 \&.\e\*q The next is for sections 1 & 8 only.  \&.\e\(dq .Sh ENVIRONMENT
 \&.\e\*q .Sh EXIT STATUS  \&.\e\(dq For sections 1, 6, 7, and 8 only.
 \&.\e\*q .Sh EXAMPLES  \&.\e\(dq .Sh FILES
 \&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.  \&.\e\(dq .Sh EXIT STATUS
 \&.\e\*q .Sh DIAGNOSTICS  \&.\e\(dq For sections 1, 6, and 8 only.
 \&.\e\*q The next is for sections 2, 3, & 9 only.  \&.\e\(dq .Sh EXAMPLES
 \&.\e\*q .Sh ERRORS  \&.\e\(dq .Sh DIAGNOSTICS
 \&.\e\*q .Sh SEE ALSO  \&.\e\(dq For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.
 \&.\e\*q .Xr foobar 1  \&.\e\(dq .Sh ERRORS
 \&.\e\*q .Sh STANDARDS  \&.\e\(dq For sections 2, 3, 4, and 9 errno settings only.
 \&.\e\*q .Sh HISTORY  \&.\e\(dq .Sh SEE ALSO
 \&.\e\*q .Sh AUTHORS  \&.\e\(dq .Xr foobar 1
 \&.\e\*q .Sh CAVEATS  \&.\e\(dq .Sh STANDARDS
 \&.\e\*q .Sh BUGS  \&.\e\(dq .Sh HISTORY
 \&.\e\*q .Sh SECURITY CONSIDERATIONS  \&.\e\(dq .Sh AUTHORS
   \&.\e\(dq .Sh CAVEATS
   \&.\e\(dq .Sh BUGS
   \&.\e\(dq .Sh SECURITY CONSIDERATIONS
   \&.\e\(dq Not used in OpenBSD.
 .Ed  .Ed
 .Pp  .Pp
 The sections in a  The sections in an
 .Nm  .Nm
 document are conventionally ordered as they appear above.  document are conventionally ordered as they appear above.
 Sections should be composed as follows:  Sections should be composed as follows:
 .Bl -ohang -offset Ds  .Bl -ohang -offset Ds
 .It Em NAME  .It Em NAME
 The name(s) and a one-line description of the documented material.  The name(s) and a one line description of the documented material.
 The syntax for this as follows:  The syntax for this as follows:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Nm name0  \&.Nm name0 ,
 \&.Nm name1  \&.Nm name1 ,
 \&.Nm name2  \&.Nm name2
 \&.Nd a one-line description  \&.Nd a one line description
 .Ed  .Ed
 .Pp  .Pp
   Multiple
   .Sq \&Nm
   names should be separated by commas.
   .Pp
 The  The
 .Sx \&Nm  .Sx \&Nm
 macro(s) must precede the  macro(s) must precede the
Line 403  configuration.
Line 208  configuration.
 For the first, utilities (sections 1, 6, and 8), this is  For the first, utilities (sections 1, 6, and 8), this is
 generally structured as follows:  generally structured as follows:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Nm foo  \&.Nm bar
 \&.Op Fl v  \&.Op Fl v
 \&.Op Fl o Ar file  \&.Op Fl o Ar file
 \&.Op Ar  \&.Op Ar
 \&.Nm bar  \&.Nm foo
 \&.Op Fl v  \&.Op Fl v
 \&.Op Fl o Ar file  \&.Op Fl o Ar file
 \&.Op Ar  \&.Op Ar
 .Ed  .Ed
 .Pp  .Pp
   Commands should be ordered alphabetically.
   .Pp
 For the second, function calls (sections 2, 3, 9):  For the second, function calls (sections 2, 3, 9):
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Vt extern const char *global;  
 \&.In header.h  \&.In header.h
   \&.Vt extern const char *global;
 \&.Ft "char *"  \&.Ft "char *"
 \&.Fn foo "const char *src"  \&.Fn foo "const char *src"
 \&.Ft "char *"  \&.Ft "char *"
 \&.Fn bar "const char *src"  \&.Fn bar "const char *src"
 .Ed  .Ed
 .Pp  .Pp
   Ordering of
   .Sx \&In ,
   .Sx \&Vt ,
   .Sx \&Fn ,
   and
   .Sx \&Fo
   macros should follow C header-file conventions.
   .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 445  section, particularly
Line 260  section, particularly
 and  and
 .Sx \&Ft .  .Sx \&Ft .
 All of these macros are output on their own line.  All of these macros are output on their own line.
 If two such dissimilar macros are pair-wise invoked (except for  If two such dissimilar macros are pairwise invoked (except for
 .Sx \&Ft  .Sx \&Ft
 before  before
 .Sx \&Fo  .Sx \&Fo
Line 471  or
Line 286  or
 .Sx \&Ss  .Sx \&Ss
 macro or the end of an enclosing block, whichever comes first.  macro or the end of an enclosing block, whichever comes first.
 .It Em DESCRIPTION  .It Em DESCRIPTION
 This expands upon the brief, one-line description in  This begins with an expansion of the brief, one line description in
 .Em NAME .  .Em NAME :
 It usually contains a break-down of the options (if documenting a  .Bd -literal -offset indent
   The
   \&.Nm
   utility does this, that, and the other.
   .Ed
   .Pp
   It usually follows with a breakdown of the options (if documenting a
 command), such as:  command), such as:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 The arguments are as follows:  The arguments are as follows:
Line 483  Print verbose information.
Line 304  Print verbose information.
 \&.El  \&.El
 .Ed  .Ed
 .Pp  .Pp
   List the options in alphabetical order,
   uppercase before lowercase for each letter and
   with no regard to whether an option takes an argument.
   Put digits in ascending order before all letter options.
   .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
 effects or notable algorithmic implications.  effects or notable algorithmic implications.
 .It Em RETURN VALUES  .It Em RETURN VALUES
 This section is the dual of  This section documents the
 .Em EXIT STATUS ,  return values of functions in sections 2, 3, and 9.
 which is used for commands.  
 It documents the return values of functions in sections 2, 3, and 9.  
 .Pp  .Pp
 See  See
 .Sx \&Rv .  .Sx \&Rv .
Line 513  the file is used (created, modified, etc.).
Line 355  the file is used (created, modified, etc.).
 See  See
 .Sx \&Pa .  .Sx \&Pa .
 .It Em EXIT STATUS  .It Em EXIT STATUS
 Command exit status for section 1, 6, and 8 manuals.  This section documents the
 This section is the dual of  command exit status for section 1, 6, and 8 utilities.
 .Em RETURN VALUES ,  
 which is used for functions.  
 Historically, this information was described in  Historically, this information was described in
 .Em DIAGNOSTICS ,  .Em DIAGNOSTICS ,
 a practise that is now discouraged.  a practise that is now discouraged.
Line 526  See
Line 366  See
 .It Em EXAMPLES  .It Em EXAMPLES
 Example usages.  Example usages.
 This often contains snippets of well-formed, well-tested invocations.  This often contains snippets of well-formed, well-tested invocations.
 Make doubly sure that your 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 539  See
Line 383  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 547  See
Line 393  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 560  section should be used instead.
Line 412  section should be used instead.
 See  See
 .Sx \&St .  .Sx \&St .
 .It Em HISTORY  .It Em HISTORY
 The history of any manual without a  A brief history of the subject, including where it was first implemented,
 .Em STANDARDS  and when it was ported to or reimplemented for the operating system at hand.
 section should be described in this section.  
 .It Em AUTHORS  .It Em AUTHORS
 Credits to authors, if applicable, should appear in this section.  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.
 .Pp  .Pp
 See  See
Line 573  See
Line 424  See
 Common misuses and misunderstandings should be explained  Common misuses and misunderstandings should be explained
 in this section.  in this section.
 .It Em BUGS  .It Em BUGS
 Known bugs, limitations and work-arounds should be described  Known bugs, limitations, and work-arounds should be described
 in this section.  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 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 be called subsequent to the initial  
 line-macro.  
 If a macro is not callable, then its invocation after the initial line  
 macro is interpreted as opaque text, such that  
 .Sq \&.Fl \&Sh  
 produces  
 .Sq Fl \&Sh .  
 .Pp  
 The  
 .Em Parsed  
 column indicates whether the macro may be followed by further  
 (ostensibly callable) macros.  
 If a macro is not parsed, subsequent macro invocations on the line  
 will be 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  
 contains 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 \&Ql Ta in-line literal display: Ql text
 .Sx In-line .  .It Sx \&Bl , \&El Ta list block:
 .Ss Block partial-explicit  .Fl Ar type
 Like block full-explicit, but also with single-line scope.  .Op Fl width Ar val
 Each has at least a body and, in limited circumstances, a head  .Op Fl offset Ar val
 .Po  .Op Fl compact
 .Sx \&Fo ,  .It Sx \&It Ta list item (syntax depends on Fl Ar type )
 .Sx \&Eo  .It Sx \&Ta Ta table cell separator in Sx \&Bl Fl column No lists
 .Pc  .It Sx \&Rs , \&%* , \&Re Ta bibliographic block (references)
 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  .Bl -column "Brq, Bro, Brc" description
 .Sx Reserved Characters  .It Sx \&Pf Ta prefix, no following horizontal space (one argument)
 or end of line.  .It Sx \&Ns Ta roman font, no preceding horizontal space (no arguments)
 .Bd -literal -offset indent  .It Sx \&Ap Ta apostrophe without surrounding whitespace (no arguments)
 \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB  .It Sx \&Sm Ta switch horizontal spacing mode: Op Cm on | off
 .Ed  .It Sx \&Bk , \&Ek Ta keep block: Fl words
 .Pp  
 .Bl -column "MacroX" "CallableX" "ParsedX" -compact -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 \&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 In-line  
 Closed by  
 .Sx Reserved Characters ,  
 end of 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  
 .Pp  
 .Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -compact -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    n  
 .It Sx \&An  Ta    Yes      Ta    Yes      Ta    n  
 .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    n  
 .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    n  
 .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    n  
 .It Sx \&Ex  Ta    \&No     Ta    \&No     Ta    n  
 .It Sx \&Fa  Ta    Yes      Ta    Yes      Ta    n  
 .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    n  
 .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    n  
 .It Sx \&Lb  Ta    \&No     Ta    \&No     Ta    1  
 .It Sx \&Li  Ta    Yes      Ta    Yes      Ta    n  
 .It Sx \&Lk  Ta    Yes      Ta    Yes      Ta    n  
 .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
 .Sh REFERENCE  .Ss Semantic markup for function libraries:
   .Bl -column "Brq, Bro, Brc" description
   .It Sx \&Lb Ta function library (one argument)
   .It Sx \&In Ta include file (one argument)
   .It Sx \&Fd Ta other preprocessor directive (>0 arguments)
   .It Sx \&Ft Ta function type (>0 arguments)
   .It Sx \&Fo , \&Fc Ta function block: Ar funcname
   .It Sx \&Fn Ta function name:
   .Op Ar functype
   .Ar funcname
   .Oo
   .Op Ar argtype
   .Ar argname
   .Oc
   .It Sx \&Fa Ta function argument (>0 arguments)
   .It Sx \&Vt Ta variable type (>0 arguments)
   .It Sx \&Va Ta variable name (>0 arguments)
   .It Sx \&Dv Ta defined variable or preprocessor constant (>0 arguments)
   .It Sx \&Er Ta error constant (>0 arguments)
   .It Sx \&Ev Ta environmental variable (>0 arguments)
   .El
   .Ss Various semantic markup:
   .Bl -column "Brq, Bro, Brc" description
   .It Sx \&An Ta author name (>0 arguments)
   .It Sx \&Lk Ta hyperlink: Ar uri Op Ar name
   .It Sx \&Mt Ta Do mailto Dc hyperlink: Ar address
   .It Sx \&Cd Ta kernel configuration declaration (>0 arguments)
   .It Sx \&Ad Ta memory address (>0 arguments)
   .It Sx \&Ms Ta mathematical symbol (>0 arguments)
   .El
   .Ss Physical markup
   .Bl -column "Brq, Bro, Brc" description
   .It Sx \&Em Ta italic font or underline (emphasis) (>0 arguments)
   .It Sx \&Sy Ta boldface font (symbolic) (>0 arguments)
   .It Sx \&Li Ta typewriter font (literal) (>0 arguments)
   .It Sx \&No Ta return to roman font (normal) (no arguments)
   .It Sx \&Bf , \&Ef Ta font block:
   .Op Fl Ar type | Cm \&Em | \&Li | \&Sy
   .El
   .Ss Physical enclosures
   .Bl -column "Brq, Bro, Brc" description
   .It Sx \&Dq , \&Do , \&Dc Ta enclose in typographic double quotes: Dq text
   .It Sx \&Qq , \&Qo , \&Qc Ta enclose in typewriter double quotes: Qq text
   .It Sx \&Sq , \&So , \&Sc Ta enclose in single quotes: Sq text
   .It Sx \&Pq , \&Po , \&Pc Ta enclose in parentheses: Pq text
   .It Sx \&Bq , \&Bo , \&Bc Ta enclose in square brackets: Bq text
   .It Sx \&Brq , \&Bro , \&Brc Ta enclose in curly braces: Brq text
   .It Sx \&Aq , \&Ao , \&Ac Ta enclose in angle brackets: Aq text
   .It Sx \&Eo , \&Ec Ta generic enclosure
   .El
   .Ss Text production
   .Bl -column "Brq, Bro, Brc" description
   .It Sx \&Ex Fl std Ta standard command exit values: Op Ar utility ...
   .It Sx \&Rv Fl std Ta standard function return values: Op Ar function ...
   .It Sx \&St Ta reference to a standards document (one argument)
   .It Sx \&At Ta At
   .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 879  referring to book titles.
Line 575  referring to book titles.
 Publication city or location of an  Publication city or location of an
 .Sx \&Rs  .Sx \&Rs
 block.  block.
 .Pp  
 .Em Remarks :  
 this macro is not implemented in  
 .Xr groff 1 .  
 .Ss \&%D  .Ss \&%D
 Publication date of an  Publication date of an
 .Sx \&Rs  .Sx \&Rs
 block.  block.
 This should follow the reduced or canonical form syntax described in  Recommended formats of arguments are
 .Sx Dates .  .Ar month day , year
   or just
   .Ar year .
 .Ss \&%I  .Ss \&%I
 Publisher or issuer name of an  Publisher or issuer name of an
 .Sx \&Rs  .Sx \&Rs
Line 942  Memory address.
Line 636  Memory address.
 Do not use this for postal addresses.  Do not use this for postal addresses.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Ad [0,$]  .Dl \&.Ad [0,$]
 .D1 \&.Ad 0x00000000  .Dl \&.Ad 0x00000000
 .Ss \&An  .Ss \&An
 Author name.  Author name.
   Can be used both for the authors of the program, function, or driver
   documented in the manual, or for the authors of the manual itself.
 Requires either the name of an author or one of the following arguments:  Requires either the name of an author or one of the following arguments:
 .Pp  .Pp
 .Bl -tag -width "-nosplitX" -offset indent -compact  .Bl -tag -width "-nosplitX" -offset indent -compact
Line 973  for the first author listing and
Line 669  for the first author listing and
 for all other author listings.  for all other author listings.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.An -nosplit  .Dl \&.An -nosplit
 .D1 \&.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.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac  .Dl \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac
 .Pp  .Pp
 See also  See also
 .Sx \&Aq .  .Sx \&Aq .
Line 990  This is generally used as a grammatical device when re
Line 686  This is generally used as a grammatical device when re
 form of a function.  form of a function.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Fn execve \&Ap d  .Dl \&.Fn execve \&Ap d
 .Ss \&Aq  .Ss \&Aq
 Encloses its arguments in angle brackets.  Encloses its arguments in angle brackets.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Fl -key= \&Ns \&Aq \&Ar val  .Dl \&.Fl -key= \&Ns \&Aq \&Ar val
 .Pp  .Pp
 .Em Remarks :  .Em Remarks :
 this macro is often abused for rendering URIs, which should instead use  this macro is often abused for rendering URIs, which should instead use
Line 1016  If an argument is not provided, the string
Line 712  If an argument is not provided, the string
 is used as a default.  is used as a default.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Fl o \&Ns \&Ar file1  .Dl ".Fl o Ar file"
 .D1 \&.Ar  .Dl ".Ar"
 .D1 \&.Ar arg1 , arg2 .  .Dl ".Ar arg1 , arg2 ."
   .Pp
   The arguments to the
   .Sx \&Ar
   macro are names and placeholders for command arguments;
   for fixed strings to be passed verbatim as arguments, use
   .Sx \&Fl
   or
   .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
 .It Cm v[1-7] | 32v  .It Cm v[1-7] | 32v
 A version of  A version of
 .At .  .At .
   .It Cm III
   .At III .
 .It Cm V[.[1-4]]?  .It Cm V[.[1-4]]?
 A version of  A version of
 .At V .  .At V .
Line 1035  A version of
Line 743  A version of
 Note that these arguments do not begin with a hyphen.  Note that these arguments do not begin with a hyphen.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.At  .Dl \&.At
 .D1 \&.At V.1  .Dl \&.At III
   .Dl \&.At V.1
 .Pp  .Pp
 See also  See also
 .Sx \&Bsx ,  .Sx \&Bsx ,
Line 1044  See also
Line 753  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 1064  Its syntax is as follows:
Line 772  Its syntax is as follows:
 .Pp  .Pp
 Display blocks are used to select a different indentation and  Display blocks are used to select a different indentation and
 justification than the one used by the surrounding text.  justification than the one used by the surrounding text.
 They may contain both macro lines and free-form text lines.  They may contain both macro lines and text lines.
 By default, a display block is preceded by a vertical space.  By default, a display block is preceded by a vertical space.
 .Pp  .Pp
 The  The
Line 1072  The
Line 780  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 center-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 1101  which may be one of the following:
Line 816  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 1110  which has no effect;
Line 825  which has no effect;
 .Cm right ,  .Cm right ,
 which justifies to the right margin; or  which justifies to the right margin; or
 .Cm center ,  .Cm center ,
 which aligns around an imagined centre axis.  which aligns around an imagined center axis.
 .It  .It
 A macro invocation, which selects a predefined width  A macro invocation, which selects a predefined width
 associated with that macro.  associated with that macro.
Line 1119  The most popular is the imaginary macro
Line 834  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 1161  and
Line 876  and
 argument are equivalent, as are  argument are equivalent, as are
 .Fl symbolic  .Fl symbolic
 and  and
 .Cm \&Sy,  .Cm \&Sy ,
 and  and
 .Fl literal  .Fl literal
 and  and
Line 1179  See also
Line 894  See also
 and  and
 .Sx \&Sy .  .Sx \&Sy .
 .Ss \&Bk  .Ss \&Bk
 Keep the output generated from each macro input line together  For each macro, keep its output together on the same output line,
 on one single output line.  until the end of the macro or the end of the input line is reached,
 Line breaks in free-form text lines are unaffected.  whichever comes first.
   Line breaks in text lines are unaffected.
 The syntax is as follows:  The syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. Sx \&Bk Fl words  .D1 Pf \. Sx \&Bk Fl words
Line 1204  Be careful in using over-long lines within a keep bloc
Line 920  Be careful in using over-long lines within a keep bloc
 Doing so will clobber the right margin.  Doing so will clobber the right margin.
 .Ss \&Bl  .Ss \&Bl
 Begin a list.  Begin a list.
 Lists consist of items started by the  Lists consist of items specified using the
 .Sx \&It  .Sx \&It
 macro, containing a head or a body or both.  macro, containing a head or a body or both.
 The list syntax is as follows:  The list syntax is as follows:
Line 1224  The
Line 940  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 1253  argument.
Line 972  argument.
 A columnated list.  A columnated list.
 The  The
 .Fl width  .Fl width
 argument has no effect; instead, each argument specifies the width  argument has no effect; instead, the string length of each argument
 of one column, using either the  specifies the width of one column.
 .Sx Scaling Widths  
 syntax 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 1277  except that dashes are used in place of bullets.
Line 994  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 1319  this head on the same output line.
Line 1039  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 1339  See also
Line 1066  See also
 Encloses its arguments in square brackets.  Encloses its arguments in square brackets.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Bq 1 , \&Dv BUFSIZ  .Dl \&.Bq 1 , \&Dv BUFSIZ
 .Pp  .Pp
 .Em Remarks :  .Em Remarks :
 this macro is sometimes abused to emulate optional arguments for  this macro is sometimes abused to emulate optional arguments for
Line 1372  See also
Line 1099  See also
 Encloses its arguments in curly braces.  Encloses its arguments in curly braces.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Brq 1 , ... , \&Va n  .Dl \&.Brq 1 , ... , \&Va n
 .Pp  .Pp
 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:
 .D1 \&.Bsx 1.0  .Dl \&.Bsx 1.0
 .D1 \&.Bsx  .Dl \&.Bsx
 .Pp  .Pp
 See also  See also
 .Sx \&At ,  .Sx \&At ,
Line 1390  See also
Line 1119  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:
 .D1 \&.Bx 4.4  .Dl \&.Bx 4.3 Tahoe
 .D1 \&.Bx  .Dl \&.Bx 4.4
   .Dl \&.Bx
 .Pp  .Pp
 See also  See also
 .Sx \&At ,  .Sx \&At ,
Line 1410  See also
Line 1142  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
 .Xr config 8 .  .Xr config 8 .
   It is most often used in section 4 manual pages.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Cd device le0 at scode?  .Dl \&.Cd device le0 at scode?
 .Pp  .Pp
 .Em Remarks :  .Em Remarks :
 this macro is commonly abused by using quoted literals to retain  this macro is commonly abused by using quoted literals to retain
Line 1429  declarations.
Line 1161  declarations.
 This practise is discouraged.  This practise is discouraged.
 .Ss \&Cm  .Ss \&Cm
 Command modifiers.  Command modifiers.
 Useful when specifying configuration options or keys.  Typically used for fixed strings passed as arguments, unless
   .Sx \&Fl
   is more appropriate.
   Also useful when specifying configuration options or keys.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Cm ControlPath  .Dl ".Nm mt Fl f Ar device Cm rewind"
 .D1 \&.Cm ControlMaster  .Dl ".Nm ps Fl o Cm pid , Ns Cm command"
 .Pp  .Dl ".Nm dd Cm if= Ns Ar file1 Cm of= Ns Ar file2"
 See also  .Dl ".Cm IdentityFile Pa ~/.ssh/id_rsa"
 .Sx \&Fl .  .Dl ".Cm LogLevel Dv DEBUG"
 .Ss \&D1  .Ss \&D1
 One-line indented display.  One-line indented display.
 This is formatted by the default rules and is useful for simple indented  This is formatted by the default rules and is useful for simple indented
Line 1444  statements.
Line 1179  statements.
 It is followed by a newline.  It is followed by a newline.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.D1 \&Fl abcdefgh  .Dl \&.D1 \&Fl abcdefgh
 .Pp  .Pp
 See also  See also
 .Sx \&Bd  .Sx \&Bd
 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.
 Its syntax is as follows:  Its syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. Sx \&Dd Op Ar date  .D1 Pf \. Sx \&Dd Ar month day , year
 .Pp  .Pp
 The  The
 .Ar date  .Ar month
 may be either  is the full English month name, the
 .Ar $\&Mdocdate$ ,  .Ar day
 which signifies the current manual revision date dictated by  is an optionally zero-padded numeral, and the
   .Ar year
   is the full four-digit year.
   .Pp
   Other arguments are not portable; the
   .Xr mandoc 1
   utility handles them as follows:
   .Bl -dash -offset 3n -compact
   .It
   To have the date automatically filled in by the
   .Ox
   version of
 .Xr cvs 1 ,  .Xr cvs 1 ,
 or instead a valid canonical date as specified by  the special string
 .Sx Dates .  .Dq $\&Mdocdate$
 If a date does not conform or is empty, the current date is used.  can be given as an argument.
   .It
   The traditional, purely numeric
   .Xr man 7
   format
   .Ar year Ns \(en Ns Ar month Ns \(en Ns Ar day
   is accepted, too.
   .It
   If a date string cannot be parsed, it is used verbatim.
   .It
   If no date string is given, the current date is used.
   .El
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Dd $\&Mdocdate$  .Dl \&.Dd $\&Mdocdate$
 .D1 \&.Dd $\&Mdocdate: July 21 2007$  .Dl \&.Dd $\&Mdocdate: July 21 2007$
 .D1 \&.Dd July 21, 2007  .Dl \&.Dd July 21, 2007
 .Pp  .Pp
 See also  See also
 .Sx \&Dt  .Sx \&Dt
 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.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Dl % mandoc mdoc.7 \e(ba less  .Dl \&.Dl % mandoc mdoc.7 \e(ba less
 .Pp  .Pp
 See also  See also
   .Sx \&Ql ,
 .Sx \&Bd  .Sx \&Bd
   .Fl literal ,
 and  and
 .Sx \&D1 .  .Sx \&D1 .
 .Ss \&Do  .Ss \&Do
Line 1535  See also
Line 1293  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 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 General Commands ,
 .Ar 2  .Cm 2
 .Pq system calls ,  .Pq System Calls ,
 .Ar 3  .Cm 3
 .Pq libraries ,  .Pq Library Functions ,
 .Ar 3p  .Cm 3p
 .Pq Perl libraries ,  .Pq Perl Library ,
 .Ar 4  .Cm 4
 .Pq devices ,  .Pq Device Drivers ,
 .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 Information ,
 .Ar 8  .Cm 8
 .Pq system utilities ,  .Pq System Manager's Manual ,
 .Ar 9  
 .Pq kernel functions ,  
 .Ar X11  
 .Pq X Window System ,  
 .Ar X11R6  
 .Pq X Window System ,  
 .Ar unass  
 .Pq unassociated ,  
 .Ar local  
 .Pq local system ,  
 .Ar draft  
 .Pq draft manual ,  
 or  or
 .Ar paper  .Cm 9
 .Pq paper .  .Pq Kernel Developer's Manual .
 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  
 This overrides the volume inferred from  
 .Ar section .  
 This field is optional, and if specified, must be one of  
 .Ar USD  
 .Pq users' supplementary documents ,  
 .Ar PS1  
 .Pq programmers' supplementary documents ,  
 .Ar AMD  
 .Pq administrators' supplementary documents ,  
 .Ar SMM  
 .Pq system managers' manuals ,  
 .Ar URM  
 .Pq users' reference manuals ,  
 .Ar PRM  
 .Pq programmers' reference manuals ,  
 .Ar KM  
 .Pq kernel manuals ,  
 .Ar IND  
 .Pq master index ,  
 .Ar MMI  
 .Pq master index ,  
 .Ar LOCAL  
 .Pq local manuals ,  
 .Ar LOC  
 .Pq local manuals ,  
 or  
 .Ar CON  
 .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 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:
 .D1 \&.Dt FOO 1  .Dl \&.Dt FOO 1
 .D1 \&.Dt FOO 4 KM  .Dl \&.Dt FOO 9 i386
 .D1 \&.Dt FOO 9 i386  
 .Pp  .Pp
 See also  See also
 .Sx \&Dd  .Sx \&Dd
 and  and
 .Sx \&Os .  .Sx \&Os .
 .Ss \&Dv  .Ss \&Dv
 Defined variables such as preprocessor constants.  Defined variables such as preprocessor constants, constant symbols,
   enumeration values, and so on.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Dv BUFSIZ  .Dl \&.Dv NULL
 .D1 \&.Dv STDOUT_FILENO  .Dl \&.Dv BUFSIZ
   .Dl \&.Dv STDOUT_FILENO
 .Pp  .Pp
 See also  See also
 .Sx \&Er .  .Sx \&Er
   and
   .Sx \&Ev
   for special-purpose constants,
   .Sx \&Va
   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:
 .D1 \&.Dx 2.4.1  .Dl \&.Dx 2.4.1
 .D1 \&.Dx  .Dl \&.Dx
 .Pp  .Pp
 See also  See also
 .Sx \&At ,  .Sx \&At ,
Line 1696  See also
Line 1393  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 1729  See also
Line 1425  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:
 .D1 \&.Em Warnings!  .Bd -literal -compact -offset indent
 .D1 \&.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 1757  argument is used as the enclosure head, for example, s
Line 1476  argument is used as the enclosure head, for example, s
 will emulate  will emulate
 .Sx \&Do .  .Sx \&Do .
 .Ss \&Er  .Ss \&Er
 Display error constants.  Error constants for definitions of the
   .Va errno
   libc global variable.
   This is most often used in section 2 and 3 manual pages.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Er EPERM  .Dl \&.Er EPERM
 .D1 \&.Er ENOENT  .Dl \&.Er ENOENT
 .Pp  .Pp
 See also  See also
 .Sx \&Dv .  .Sx \&Dv
   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 .
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Ev DISPLAY  .Dl \&.Ev DISPLAY
 .D1 \&.Ev PATH  .Dl \&.Ev PATH
   .Pp
   See also
   .Sx \&Dv
   for general constants.
 .Ss \&Ex  .Ss \&Ex
 Insert a standard sentence regarding exit values.  Insert a standard sentence regarding command exit values of 0 on success
   and >0 on failure.
   This is most often used in section 1, 6, and 8 manual pages.
 Its syntax is as follows:  Its syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. Sx \&Ex Fl std Op Ar utility  .D1 Pf \. Sx \&Ex Fl std Op Ar utility ...
 .Pp  .Pp
 When  If
 .Ar utility  .Ar utility
 is not specified, the document's name set by  is not specified, the document's name set by
 .Sx \&Nm  .Sx \&Nm
 is used.  is used.
   Multiple
   .Ar utility
   arguments are treated as separate utilities.
 .Pp  .Pp
 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 1813  Furthermore, if the following macro is another
Line 1564  Furthermore, if the following macro is another
 the last argument will also have a trailing comma.  the last argument will also have a trailing comma.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Fa \(dqconst char *p\(dq  .Dl \&.Fa \(dqconst char *p\(dq
 .D1 \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq  .Dl \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq
 .D1 \&.Fa foo  .Dl \&.Fa \(dqchar *\(dq size_t
 .Pp  .Pp
 See also  See also
 .Sx \&Fo .  .Sx \&Fo .
Line 1823  See also
Line 1574  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.  Command-line flag or option.
 Used when listing arguments to command-line utilities.  Used when listing arguments to command-line utilities.
 Prints a fixed-width hyphen  Prints a fixed-width hyphen
 .Sq \-  .Sq \-
Line 1843  If the argument is a macro, a hyphen is prefixed to th
Line 1611  If the argument is a macro, a hyphen is prefixed to th
 output.  output.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Fl a b c  .Dl ".Fl R Op Fl H | L | P"
 .D1 \&.Fl \&Pf a b  .Dl ".Op Fl 1AaCcdFfgHhikLlmnopqRrSsTtux"
 .D1 \&.Fl  .Dl ".Fl type Cm d Fl name Pa CVS"
 .D1 \&.Op \&Fl o \&Ns \&Ar file  .Dl ".Fl Ar signal_number"
   .Dl ".Fl o Fl"
 .Pp  .Pp
 See also  See also
 .Sx \&Cm .  .Sx \&Cm .
Line 1854  See also
Line 1623  See also
 A function name.  A function name.
 Its syntax is as follows:  Its syntax is as follows:
 .Bd -ragged -offset indent  .Bd -ragged -offset indent
 .Pf \. Ns Sx \&Fn  .Pf . Sx \&Fn
 .Op Cm functype  .Op Ar functype
 .Cm funcname  .Ar funcname
 .Op Oo Cm argtype Oc Cm argname  .Op Oo Ar argtype Oc Ar argname
 .Ed  .Ed
 .Pp  .Pp
 Function arguments are surrounded in parenthesis and  Function arguments are surrounded in parenthesis and
 are delimited by commas.  are delimited by commas.
 If no arguments are specified, blank parenthesis are output.  If no arguments are specified, blank parenthesis are output.
   In the
   .Em SYNOPSIS
   section, this macro starts a new output line,
   and a blank line is automatically inserted between function definitions.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Fn "int funcname" "int arg0" "int arg1"  .Dl \&.Fn \(dqint funcname\(dq \(dqint arg0\(dq \(dqint arg1\(dq
 .D1 \&.Fn funcname "int arg0"  .Dl \&.Fn funcname \(dqint arg0\(dq
 .D1 \&.Fn funcname arg0  .Dl \&.Fn funcname arg0
   .Pp
 .Bd -literal -offset indent -compact  .Bd -literal -offset indent -compact
 \&.Ft functype  \&.Ft functype
 \&.Fn funcname  \&.Fn funcname
 .Ed  .Ed
 .Pp  .Pp
   When referring to a function documented in another manual page, use
   .Sx \&Xr
   instead.
 See also  See also
 .Sx MANUAL STRUCTURE  .Sx MANUAL STRUCTURE ,
   .Sx \&Fo ,
 and  and
 .Sx \&Ft .  .Sx \&Ft .
 .Ss \&Fo  .Ss \&Fo
Line 1883  This is a multi-line version of
Line 1661  This is a multi-line version of
 .Sx \&Fn .  .Sx \&Fn .
 Its syntax is as follows:  Its syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. Sx \&Fo Cm funcname  .D1 Pf \. Sx \&Fo Ar funcname
 .Pp  .Pp
 Invocations usually occur in the following context:  Invocations usually occur in the following context:
 .Bd -ragged -offset indent  .Bd -ragged -offset indent
 .Pf \. Sx \&Ft Cm functype  .Pf \. Sx \&Ft Ar functype
 .br  .br
 .Pf \. Sx \&Fo Cm funcname  .Pf \. Sx \&Fo Ar funcname
 .br  .br
 .Pf \. Sx \&Fa Oo Cm argtype Oc Cm argname  .Pf \. Sx \&Fa Qq Ar argtype Ar argname
 .br  .br
 \.\.\.  \&.\.\.
 .br  .br
 .Pf \. Sx \&Fc  .Pf \. Sx \&Fc
 .Ed  .Ed
Line 1901  Invocations usually occur in the following context:
Line 1679  Invocations usually occur in the following context:
 A  A
 .Sx \&Fo  .Sx \&Fo
 scope is closed by  scope is closed by
   .Sx \&Fc .
 .Pp  .Pp
 See also  See also
 .Sx MANUAL STRUCTURE ,  .Sx MANUAL STRUCTURE ,
Line 1908  See also
Line 1687  See also
 .Sx \&Fc ,  .Sx \&Fc ,
 and  and
 .Sx \&Ft .  .Sx \&Ft .
   .Ss \&Fr
   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:
 .Pp  .Pp
 .D1 Pf \. Sx \&Ft Cm functype  .D1 Pf \. Sx \&Ft Ar functype
 .Pp  .Pp
   In the
   .Em SYNOPSIS
   section, a new output line is started after this macro.
   .Pp
 Examples:  Examples:
 .D1 \&.Ft int  .Dl \&.Ft int
 .Bd -literal -offset indent -compact  .Bd -literal -offset indent -compact
 \&.Ft functype  \&.Ft functype
 \&.Fn funcname  \&.Fn funcname
Line 1927  See also
Line 1715  See also
 and  and
 .Sx \&Fo .  .Sx \&Fo .
 .Ss \&Fx  .Ss \&Fx
 Format the FreeBSD version provided as an argument, or a default value  Format the
   .Fx
   version provided as an argument, or a default value
 if no argument is provided.  if no argument is provided.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Fx 7.1  .Dl \&.Fx 7.1
 .D1 \&.Fx  .Dl \&.Fx
 .Pp  .Pp
 See also  See also
 .Sx \&At ,  .Sx \&At ,
Line 1940  See also
Line 1730  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 1952  This is similar to
Line 1747  This is similar to
 but used for instructions rather than values.  but used for instructions rather than values.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Ic hash  .Dl \&.Ic :wq
 .D1 \&.Ic alias  .Dl \&.Ic hash
   .Dl \&.Ic alias
 .Pp  .Pp
 Note that using  Note that using
 .Sx \&Bd No Fl literal  .Sx \&Bd Fl literal
 or  or
 .Sx \&D1  .Sx \&D1
 is preferred for displaying code; the  is preferred for displaying code; the
 .Sx \&Ic  .Sx \&Ic
 macro is used when referring to specific instructions.  macro is used when referring to specific instructions.
 .Ss \&In  .Ss \&In
 An  The name of an include file.
 .Dq include  This macro is most often used in section 2, 3, and 9 manual pages.
 file.  .Pp
 In the  When invoked as the first macro on an input line in the
 .Em SYNOPSIS  .Em SYNOPSIS
 section (only if invoked as the line macro), the first argument is  section, the argument is displayed in angle brackets
 preceded by  and preceded by
 .Dq #include ,  .Qq #include ,
 the arguments is enclosed in angle brackets.  and a blank line is inserted in front if there is a preceding
   function declaration.
   In other sections, it only encloses its argument in angle brackets
   and causes no line break.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.In sys/types  .Dl \&.In sys/types.h
 .Pp  .Pp
 See also  See also
 .Sx MANUAL STRUCTURE .  .Sx MANUAL STRUCTURE .
Line 1991  and
Line 1790  and
 .Fl diag  .Fl diag
 have the following syntax:  have the following syntax:
 .Pp  .Pp
 .D1 Pf \. Sx \&It Cm args  .D1 Pf \. Sx \&It Ar args
 .Pp  .Pp
 Lists of type  Lists of type
 .Fl bullet ,  .Fl bullet ,
Line 2028  The
Line 1827  The
 list is the most complicated.  list is the most complicated.
 Its syntax is as follows:  Its syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. Sx \&It Op Cm args  .D1 Pf \. Sx \&It Ar cell Op Sx \&Ta Ar cell ...
   .D1 Pf \. Sx \&It Ar cell Op <TAB> Ar cell ...
 .Pp  .Pp
 The  The arguments consist of one or more lines of text and macros
 .Cm args  representing a complete table line.
 are phrases, a mix of macros and text corresponding to a line column,  Cells within the line are delimited by the special
 delimited by tabs or the special  .Sx \&Ta
 .Sq \&Ta  block macro or by literal tab characters.
 pseudo-macro.  .Pp
 Lines subsequent the  Using literal tabs is strongly discouraged because they are very
   hard to use correctly and
   .Nm
   code using them is very hard to read.
   In particular, a blank character is syntactically significant
   before and after the literal tab character.
   If a word precedes or follows the tab without an intervening blank,
   that word is never interpreted as a macro call, but always output
   literally.
   .Pp
   The tab cell delimiter may only be used within the
 .Sx \&It  .Sx \&It
 are interpreted within the scope of the last phrase.  line itself; on following lines, only the
 Calling the pseudo-macro  .Sx \&Ta
 .Sq \&Ta  macro can be used to delimit cells, and
 will open a new phrase scope (this must occur on a macro line to be  .Sx \&Ta
 interpreted as a macro).  is only recognised as a macro when called by other macros,
 Note that the tab phrase delimiter may only be used within the  not as the first macro on a line.
   .Pp
   Note that quoted strings may span tab-delimited cells on an
 .Sx \&It  .Sx \&It
 line itself.  line.
 Subsequent this, only the  For example,
 .Sq \&Ta  
 pseudo-macro may be used to delimit phrases.  
 Furthermore, note that quoted sections propagate over tab-delimited  
 phrases on an  
 .Sx \&It ,  
 for example,  
 .Pp  .Pp
 .D1 .It \(dqcol1 ; <TAB> col2 ;\(dq \&;  .Dl .It \(dqcol1 ,\& <TAB> col2 ,\(dq \&;
 .Pp  .Pp
 will preserve the semicolon whitespace except for the last.  will preserve the whitespace before both commas,
   but not the whitespace before the semicolon.
 .Pp  .Pp
 See also  See also
 .Sx \&Bl .  .Sx \&Bl .
Line 2064  See also
Line 1871  See also
 Specify a library.  Specify a library.
 The syntax is as follows:  The syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. Sx \&Lb Cm library  .D1 Pf \. Sx \&Lb Ar library
 .Pp  .Pp
 The  The
 .Cm library  .Ar library
 parameter may be a system library, such as  parameter may be a system library, such as
 .Cm libz  .Cm libz
 or  or
Line 2081  section as described in
Line 1888  section as described in
 .Sx MANUAL STRUCTURE .  .Sx MANUAL STRUCTURE .
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Lb libz  .Dl \&.Lb libz
 .D1 \&.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:
 .Pp  .Pp
 .D1 Pf \. Sx \&Lk Cm uri Op Cm name  .D1 Pf \. Sx \&Lk Ar uri Op Ar name
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Lk http://bsd.lv "The BSD.lv Project"  .Dl \&.Lk http://bsd.lv \(dqThe BSD.lv Project\(dq
 .D1 \&.Lk http://bsd.lv  .Dl \&.Lk http://bsd.lv
 .Pp  .Pp
 See also  See also
 .Sx \&Mt .  .Sx \&Mt .
Line 2112  Synonym for
Line 1925  Synonym for
 Display a mathematical symbol.  Display a mathematical symbol.
 Its syntax is as follows:  Its syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. Sx \&Ms Cm symbol  .D1 Pf \. Sx \&Ms Ar symbol
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Ms sigma  .Dl \&.Ms sigma
 .D1 \&.Ms aleph  .Dl \&.Ms aleph
 .Ss \&Mt  .Ss \&Mt
 Format a  Format a
 .Dq mailto:  .Dq mailto:
 hyperlink.  hyperlink.
 Its syntax is as follows:  Its syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. Sx \&Mt Cm address  .D1 Pf \. Sx \&Mt Ar address
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.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 is the mandatory last macro of the
 .Em SYNOPSIS  .Em NAME
 section subsequent the  section and not appropriate for other sections.
 .Sx \&Nm  
 macro.  
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Sx \&Nd mdoc language reference  .Dl Pf . Sx \&Nd mdoc language reference
 .D1 \&.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 2189  macro rather than
Line 2001  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:
 .D1 \&.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.
   .Pp
 Examples:  Examples:
 .D1 \&.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
 and  and
 .Sx \&Sm .  .Sx \&Sm .
 .Ss \&Nx  .Ss \&Nx
 Format the NetBSD version provided as an argument, or a default value if  Format the
   .Nx
   version provided as an argument, or a default value if
 no argument is provided.  no argument is provided.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Nx 5.01  .Dl \&.Nx 5.01
 .D1 \&.Nx  .Dl \&.Nx
 .Pp  .Pp
 See also  See also
 .Sx \&At ,  .Sx \&At ,
Line 2221  See also
Line 2060  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 2239  Examples:
Line 2077  Examples:
 \&.Oc  \&.Oc
 .Ed  .Ed
 .Ss \&Op  .Ss \&Op
 Command-line option.  Optional part of a command line.
 Used when listing options to command-line utilities.  
 Prints the argument(s) in brackets.  Prints the argument(s) in brackets.
   This is most often used in the
   .Em SYNOPSIS
   section of section 1 and 8 manual pages.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Op \&Fl a \&Ar b  .Dl \&.Op \&Fl a \&Ar b
 .D1 \&.Op \&Ar a | b  .Dl \&.Op \&Ar a | b
 .Pp  .Pp
 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
 file.  file.
 Its syntax is as follows:  Its syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. Sx \&Os Op Cm system  .D1 Pf \. Sx \&Os Op Ar system Op Ar version
 .Pp  .Pp
 The optional  The optional
 .Cm system  .Ar system
 parameter specifies the relevant operating system or environment.  parameter specifies the relevant operating system or environment.
 Left unspecified, it defaults to the local operating system version.  It is suggested to leave it unspecified, in which case
 This is the suggested form.  .Xr mandoc 1
   uses its
   .Fl Ios
   argument or, if that isn't specified either,
   .Fa sysname
   and
   .Fa release
   as returned by
   .Xr uname 3 .
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Os  .Dl \&.Os
 .D1 \&.Os KTH/CSC/TCS  .Dl \&.Os KTH/CSC/TCS
 .D1 \&.Os BSD 4.3  .Dl \&.Os BSD 4.3
 .Pp  .Pp
 See also  See also
 .Sx \&Dd  .Sx \&Dd
 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 OpenBSD version provided as an argument, or a default value  Format the
   .Ox
   version provided as an argument, or a default value
 if no argument is provided.  if no argument is provided.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Ox 4.5  .Dl \&.Ox 4.5
 .D1 \&.Ox  .Dl \&.Ox
 .Pp  .Pp
 See also  See also
 .Sx \&At ,  .Sx \&At ,
Line 2293  See also
Line 2150  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
 A file-system path.  An absolute or relative file system path, or a file or directory name.
   If an argument is not provided, the character
   .Sq \(ti
   is used as a default.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Pa /usr/bin/mandoc  .Dl \&.Pa /usr/bin/mandoc
 .D1 \&.Pa /usr/share/man/man7/mdoc.7  .Dl \&.Pa /usr/share/man/man7/mdoc.7
 .Pp  .Pp
 See also  See also
 .Sx \&Lk .  .Sx \&Lk .
Line 2309  See also
Line 2168  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 and the following macro.
 .Pq Dq prefix  
 between its arguments.  
 Its syntax is as follows:  Its syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. \&Pf Cm prefix suffix  .D1 .Pf Ar prefix macro arguments ...
 .Pp  .Pp
   This is equivalent to:
   .Pp
   .D1 .No \e& Ns Ar prefix No \&Ns Ar macro arguments ...
   .Pp
 The  The
 .Cm suffix  .Ar prefix
 argument may be a macro.  argument is not parsed for macro names or delimiters,
   but used verbatim as if it were escaped.
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Pf \e. \&Sx \&Pf \&Cm prefix suffix  .Dl ".Pf $ Ar variable_name"
   .Dl ".Pf . Ar macro_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 2329  Multi-line version of
Line 2198  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 2338  See also
Line 2219  See also
 Close quoted context opened by  Close quoted context opened by
 .Sx \&Qo .  .Sx \&Qo .
 .Ss \&Ql  .Ss \&Ql
 Format a single-quoted literal.  In-line literal display.
   This can for example be used for complete command invocations and
   for multi-word code fragments when more specific markup is not
   appropriate and an indented display is not desired.
   While
   .Xr mandoc 1
   always encloses the arguments in single quotes, other formatters
   usually omit the quotes on non-terminal output devices when the
   arguments have three or more characters.
   .Pp
 See also  See also
 .Sx \&Qq  .Sx \&Dl
 and  and
 .Sx \&Sq .  .Sx \&Bd
   .Fl literal .
 .Ss \&Qo  .Ss \&Qo
 Multi-line version of  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 2393  Examples:
Line 2284  Examples:
 \&.%A J. D. Ullman  \&.%A J. D. Ullman
 \&.%B Introduction to Automata Theory, Languages, and Computation  \&.%B Introduction to Automata Theory, Languages, and Computation
 \&.%I Addison-Wesley  \&.%I Addison-Wesley
 \&.%C Reading, Massachusettes  \&.%C Reading, Massachusetts
 \&.%D 1979  \&.%D 1979
 \&.Re  \&.Re
 .Ed  .Ed
Line 2404  block is used within a SEE ALSO section, a vertical sp
Line 2295  block is used within a SEE ALSO section, a vertical sp
 before the rendered output, else the block continues on the current  before the rendered output, else the block continues on the current
 line.  line.
 .Ss \&Rv  .Ss \&Rv
 Inserts text regarding a function call's return value.  Insert a standard sentence regarding a function call's return value of 0
 This macro must consist of the  on success and \-1 on error, with the
 .Fl std  .Va errno
 argument followed by an optional  libc global variable set on error.
 .Ar function .  Its syntax is as follows:
   .Pp
   .D1 Pf \. Sx \&Rv Fl std Op Ar function ...
   .Pp
 If  If
 .Ar function  .Ar function
 is not provided, the document's name as stipulated by the first  is not specified, the document's name set by
 .Sx \&Nm  .Sx \&Nm
 is provided.  is used.
   Multiple
   .Ar function
   arguments are treated as separate functions.
 .Pp  .Pp
 See also  See also
 .Sx \&Ex .  .Sx \&Ex .
Line 2429  custom sections be used.
Line 2326  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 2439  and
Line 2339  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 .
 When switched  When switched
 .Cm off ,  .Cm off ,
 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 free-form 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 2462  See also
Line 2367  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 2480  and
Line 2390  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
   .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
 .St -xpg4.3  .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 \-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
 .It \-xcurses4.2  .Pp
 .St -xcurses4.2  .Bl -tag -width "-p1003.1-2001" -compact
 .It \-susv2  .It \-p1003.1-2001
 .St -susv2  .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:
 .D1 \&.Sx MANUAL STRUCTURE  .Dl \&.Sx MANUAL STRUCTURE
   .Pp
   See also
   .Sx \&Sh
   and
   .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
   Table cell separator in
   .Sx \&Bl Fl column
   lists; can only be used below
   .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
 .D1 \&.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:  
 .D1 \&.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:
 .D1 \&.Va foo  .Dl \&.Va foo
 .D1 \&.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.
 Note that it accepts  Note that it accepts
 .Sx Block partial-implicit  .Sx Block partial-implicit
 syntax when invoked as the first macro in the  syntax when invoked as the first macro on an input line in the
 .Em SYNOPSIS  .Em SYNOPSIS
 section, else it accepts ordinary  section, else it accepts ordinary
 .Sx In-line  .Sx In-line
 syntax.  syntax.
   In the former case, this macro starts a new output line,
   and a blank line is inserted in front if there is a preceding
   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:
 .D1 \&.Vt unsigned char  .Dl \&.Vt unsigned char
 .D1 \&.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 .
 .Ss \&Xo  .Ss \&Xo
 Open an extension scope.  Extend the header of an
 This macro originally existed to extend the 9-argument limit of troff;  .Sx \&It
 since this limit has been lifted, the macro has been deprecated.  macro or the body of a partial-implicit block macro
   beyond the end of the input line.
   This macro originally existed to work around the 9-argument limit
   of historic
   .Xr roff 7 .
 .Ss \&Xr  .Ss \&Xr
 Link to another manual  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 Cm name section  .D1 Pf \. Sx \&Xr Ar name section
 .Pp  .Pp
 The  Cross reference the
 .Cm name  .Ar name
 and  and
 .Cm section  .Ar section
 are the name and section of the linked manual.  number of another man page.
 If  
 .Cm section  
 is followed by non-punctuation, an  
 .Sx \&Ns  
 is inserted into the token stream.  
 This behaviour is for compatibility with  
 .Xr groff 1 .  
 .Pp  .Pp
 Examples:  Examples:
 .D1 \&.Xr mandoc 1  .Dl \&.Xr mandoc 1
 .D1 \&.Xr mandoc 1 \&;  .Dl \&.Xr mandoc 1 \&;
 .D1 \&.Xr mandoc 1 \&Ns s behaviour  .Dl \&.Xr mandoc 1 \&Ns s behaviour
 .Ss \&br  .Sh MACRO SYNTAX
 Emits a line-break.  The syntax of a macro depends on its classification.
 This macro should not be used; it is implemented for compatibility with  In this section,
 historical manuals.  .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  .Pp
 Consider using  The
 .Sx \&Pp  .Em Callable
 in the event of natural paragraph breaks.  column indicates that the macro may also be called by passing its name
 .Ss \&sp  as an argument to another macro.
 Emits vertical space.  For example,
 This macro should not be used; it is implemented for compatibility with  .Sq \&.Op \&Fl O \&Ar file
 historical manuals.  produces
 Its syntax is as follows:  .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  .Pp
 .D1 Pf \. Sx \&sp Op Cm height  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  .Pp
 The  The
 .Cm height  .Em Scope
 argument must be formatted as described in  column, if applicable, describes closure rules.
 .Sx Scaling Widths .  .Ss Block full-explicit
 If unspecified,  Multi-line scope closed by an explicit closing macro.
 .Sx \&sp  All macros contains bodies; only
 asserts a single vertical space.  .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    2
   .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.
   Spacing is suppressed after opening delimiters
   and before closing delimiters.
   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, which does not suppress spacing:
   .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 GNU troff
 .Pq Qq groff .  .Pq Qq groff .
 The term  
 .Qq historic groff  
 refers to groff versions before the  
 .Pa doc.tmac  
 file re-write  
 .Pq somewhere between 1.15 and 1.19 .  
 .Pp  .Pp
 Heirloom troff, the other significant troff implementation accepting  The following problematic behaviour is found in groff:
 \-mdoc, is similar to historic groff.  
 .Pp  .Pp
 .Bl -dash -compact  .Bl -dash -compact
 .It  .It
 An empty  .Sx \&Dd
 .Sq \&Dd  with non-standard arguments behaves very strangely.
 macro in groff prints  When there are three arguments, they are printed verbatim.
 .Dq Epoch .  Any other number of arguments is replaced by the current date,
 In mandoc, it resolves to the current date.  but without any arguments the string
   .Dq Epoch
   is printed.
 .It  .It
 The \es (font size), \em (font colour), and \eM (font filling colour)  .Sx \&Lk
 font decoration escapes are all discarded in mandoc.  only accepts a single link-name argument; the remainder is misformatted.
 .It  .It
 Old groff fails to assert a newline before  
 .Sx \&Bd Fl ragged compact .  
 .It  
 groff behaves inconsistently when encountering  
 .Pf non- Sx \&Fa  
 children of  
 .Sx \&Fo  
 regarding spacing between arguments.  
 In mandoc, this is not the case: each argument is consistently followed  
 by a single space and the trailing  
 .Sq \&)  
 suppresses prior spacing.  
 .It  
 groff behaves inconsistently when encountering  
 .Sx \&Ft  
 and  
 .Sx \&Fn  
 in the  
 .Em SYNOPSIS :  
 at times newline(s) are suppressed depending on whether a prior  
 .Sx \&Fn  
 has been invoked.  
 In mandoc, this is not the case.  
 See  
 .Sx \&Ft  
 and  
 .Sx \&Fn  
 for the normalised behaviour.  
 .It  
 Historic groff does not break before an  
 .Sx \&Fn  
 when not invoked as the line macro in the  
 .Em SYNOPSIS  
 section.  
 .It  
 Historic groff formats the  
 .Sx \&In  
 badly: trailing arguments are trashed and  
 .Em SYNOPSIS  
 is not specially treated.  
 .It  
 groff does not accept the  
 .Sq \&Ta  
 pseudo-macro as a line macro.  
 mandoc does.  
 .It  
 The comment syntax  
 .Sq \e\."  
 is no longer accepted.  
 .It  
 In groff, the  
 .Sx \&Pa  .Sx \&Pa
 macro does not format its arguments when used in the FILES section under  does not format its arguments when used in the FILES section under
 certain list types.  certain list types.
 mandoc does.  
 .It  .It
 Historic groff does not print a dash for empty  .Sx \&Ta
 .Sx \&Fl  can only be called by other macros, but not at the beginning of a line.
 arguments.  
 mandoc and newer groff implementations do.  
 .It  .It
 groff behaves irregularly when specifying  .Sx \&%C
   is not implemented (up to and including groff-1.22.2).
   .It
 .Sq \ef  .Sq \ef
   .Pq font face
   and
   .Sq \eF
   .Pq font family face
 .Sx Text Decoration  .Sx Text Decoration
 within line-macro scopes.  escapes behave irregularly when specified within line-macro scopes.
 mandoc follows a consistent system.  
 .It  .It
 In mandoc, negative scaling units are truncated to zero; groff would  Negative scaling units return to prior lines.
 move to prior lines.  Instead, mandoc truncates them to zero.
 Furthermore, the  .El
 .Sq f  .Pp
 scaling unit, while accepted, is rendered as the default unit.  The following features are unimplemented in mandoc:
   .Pp
   .Bl -dash -compact
 .It  .It
 In quoted literals, groff allowed pair-wise double-quotes to produce a  
 standalone double-quote in formatted output.  
 This idiosyncratic behaviour is not applicable in mandoc.  
 .It  
 Display offsets  
 .Sx \&Bd  .Sx \&Bd
 .Fl offset Ar center  
 and  
 .Fl offset Ar right  
 are disregarded in mandoc.  
 Furthermore, troff specifies a  
 .Fl file Ar file  .Fl file Ar file
 argument that is not supported in mandoc.  is unsupported for security reasons.
 Lastly, since text is not right-justified in mandoc (or even groff),  .It
 .Fl ragged  .Sx \&Bd
 and  
 .Fl filled  .Fl filled
 are aliases, as are  does not adjust the right margin, but is an alias for
   .Sx \&Bd
   .Fl ragged .
   .It
   .Sx \&Bd
 .Fl literal  .Fl literal
 and  does not use a literal font, but is an alias for
   .Sx \&Bd
 .Fl unfilled .  .Fl unfilled .
 .It  .It
 Historic groff has many un-callable macros.  .Sx \&Bd
 Most of these (excluding some block-level macros) are now callable.  .Fl offset Cm center
 .It  
 The vertical bar  
 .Sq \(ba  
 made historic groff  
 .Qq go orbital  
 but has been a proper delimiter since then.  
 .It  
 .Sx \&It Fl nested  
 is assumed for all lists (it wasn't in historic groff): any list may be  
 nested and  
 .Fl enum  
 lists will restart the sequence only for the sub-list.  
 .It  
 Some manuals use  
 .Sx \&Li  
 incorrectly by following it with a reserved character and expecting the  
 delimiter to render.  
 This is not supported in mandoc.  
 .It  
 In groff, the  
 .Sx \&Cd ,  
 .Sx \&Er ,  
 .Sx \&Ex ,  
 and  and
 .Sx \&Rv  .Fl offset Cm right
 macros were stipulated only to occur in certain manual sections.  don't work.
 mandoc does not have these restrictions.  Groff does not implement centered and flush-right rendering either,
 .It  but produces large indentations.
 Newer groff and mandoc print  
 .Qq AT&T UNIX  
 prior to unknown arguments of  
 .Sx \&At ;  
 older groff did nothing.  
 .El  .El
 .Sh SEE ALSO  .Sh SEE ALSO
   .Xr man 1 ,
 .Xr mandoc 1 ,  .Xr mandoc 1 ,
 .Xr mandoc_char 7  .Xr eqn 7 ,
   .Xr man 7 ,
   .Xr mandoc_char 7 ,
   .Xr roff 7 ,
   .Xr tbl 7
   .Pp
   The web page
   .Lk http://mdocml.bsd.lv/mdoc/ "extended documentation for the mdoc language"
   provides a few tutorial-style pages for beginners, an extensive style
   guide for advanced authors, and an alphabetic index helping to choose
   the best macros for various kinds of content.
   .Sh HISTORY
   The
   .Nm
   language first appeared as a troff macro package in
   .Bx 4.4 .
   It was later significantly updated by Werner Lemberg and Ruslan Ermilov
   in groff-1.17.
   The standalone implementation that is part of the
   .Xr mandoc 1
   utility written by Kristaps Dzonsons appeared in
   .Ox 4.6 .
 .Sh AUTHORS  .Sh AUTHORS
 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.142  
changed lines
  Added in v.1.264
CVSweb