Slightly tweak www section/subsections.

[mandoc.git] / mdoc.7

diff --git a/mdoc.7 b/mdoc.7
index d00c2105963c068498dfe8bb54a6eb314f0067ab..b42c6fcca9e381910238ea1718e30e1f8014ea3d 100644 (file)
--- a/mdoc.7
+++ b/mdoc.7
@@ -1,4 +1,4 @@
-.\"    $Id: mdoc.7,v 1.195 2011/08/02 01:07:26 schwarze Exp $
+.\"    $Id: mdoc.7,v 1.202 2011/08/18 08:58:44 kristaps Exp $

 .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
 .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>


@@ -15,7 +15,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: August 2 2011 $
+.Dd $Mdocdate: August 18 2011 $

 .Dt MDOC 7
 .Os
 .Sh NAME
 .Dt MDOC 7
 .Os
 .Sh NAME


@@ -30,11 +30,13 @@ language is used to format
 manuals.
 This reference document describes its syntax, structure, and
 usage.
 manuals.
 This reference document describes its syntax, structure, and
 usage.

-The reference implementation is
+The reference implementation for
+.Nm
+formatting is

 .Xr mandoc 1 ;
 the
 .Sx COMPATIBILITY
 .Xr mandoc 1 ;
 the
 .Sx COMPATIBILITY

-section describes compatibility with other troff \-mdoc implementations.
+section describes compatibility with other implementations.

 .Pp
 An
 .Nm
 .Pp
 An
 .Nm


@@ -42,7 +44,7 @@ document follows simple rules: lines beginning with the control
 character
 .Sq \&.
 are parsed for macros.
 character
 .Sq \&.
 are parsed for macros.

-Text lines, those not beginning with the control character, are
+Lines not beginning with the control character are

 interpreted within the scope of prior macros:
 .Bd -literal -offset indent
 \&.Sh Macro lines change control state.
 interpreted within the scope of prior macros:
 .Bd -literal -offset indent
 \&.Sh Macro lines change control state.


@@ -52,21 +54,37 @@ Text lines are interpreted within the current state.
 .Nm
 documents may contain only graphable 7-bit ASCII characters, the space
 character, and, in certain circumstances, the tab character.
 .Nm
 documents may contain only graphable 7-bit ASCII characters, the space
 character, and, in certain circumstances, the tab character.

-.Pp
-If the first character of a text line is a space, that line is printed
-with a leading newline.
+The back-space character
+.Sq \e
+indicates the start of an escape sequence for
+.Sx Comments ,
+.Sx Predefined Strings ,
+and
+.Sx Special Characters .

 .Ss Comments
 .Ss Comments

-Text following a
+Text following an escaped double-quote

 .Sq \e\*q ,
 whether in a macro or text line, is ignored to the end of
 line.
 .Sq \e\*q ,
 whether in a macro or text line, is ignored to the end of
 line.

-A macro line with only a control character and comment escape,
-.Sq \&.\e\*q ,
+A macro line beginning with a control character and comment escape
+.Sq \&.\e\*q

 is also ignored.
 is also ignored.

-Macro lines with only a control character and optional whitespace are
+Furthermore,
+macro lines with only a control character and optional trailing
+whitespace are

 stripped from input.
 stripped from input.

+.Pp
+Examples:
+.Bd -literal -offset indent -compact
+\&.\e\*q This is a comment line.
+\&.\e\*q The next line is ignored:
+\&.
+\&.Em Emphasis \e\*q This is also a comment.
+.Ed

 .Ss Special Characters
 .Ss Special Characters

-Special characters may occur in both macro and text lines.
+Special characters are used to encode special glyphs and are rendered
+differently across output media.
+They may occur in both macro and text lines.

 Sequences begin with the escape character
 .Sq \e
 followed by either an open-parenthesis
 Sequences begin with the escape character
 .Sq \e
 followed by either an open-parenthesis


@@ -76,24 +94,24 @@ for two-character sequences; an open-bracket
 for n-character sequences (terminated at a close-bracket
 .Sq \&] ) ;
 or a single one character sequence.
 for n-character sequences (terminated at a close-bracket
 .Sq \&] ) ;
 or a single one character sequence.

+.Pp
+Examples:
+.Bl -tag -width Ds -offset indent -compact
+.It \e(em
+em dash
+.It \ee
+backslash
+.El
+.Pp

 See
 .Xr mandoc_char 7
 for a complete list.
 See
 .Xr mandoc_char 7
 for a complete list.

-Examples include
-.Sq \e(em
-.Pq em-dash
-and
-.Sq \ee
-.Pq back-slash .

 .Ss Text Decoration
 Terms may be text-decorated using the
 .Sq \ef
 .Ss Text Decoration
 Terms may be text-decorated using the
 .Sq \ef

-escape followed by an indicator: B (bold), I (italic), R (Roman), or P
-(revert to previous mode):
-.Pp
-.Dl \efBbold\efR \efIitalic\efP
-.Pp
-A numerical representation 3, 2, or 1 (bold, italic, and Roman,
+escape followed by an indicator: B (bold), I (italic), R (regular), or P
+(revert to previous mode).
+A numerical representation 3, 2, or 1 (bold, italic, and regular,

 respectively) may be used instead.
 If a macro opens a font scope after calling
 .Sq \ef ,
 respectively) may be used instead.
 If a macro opens a font scope after calling
 .Sq \ef ,


@@ -105,19 +123,23 @@ mode will be restored upon exiting the
 .Sx \&Bf
 scope.
 .Pp
 .Sx \&Bf
 scope.
 .Pp

-Note this form is
+Examples:
+.Bl -tag -width Ds -offset indent -compact
+.It \efBbold\efR
+write in bold, then switch to regular
+.It \efIitalic\efP
+write in italic, then return to previous
+.El
+.Pp
+Text decoration is

 .Em not
 recommended for
 .Nm ,
 which encourages semantic annotation.
 .Ss Predefined Strings
 .Em not
 recommended for
 .Nm ,
 which encourages semantic annotation.
 .Ss Predefined Strings

-Historically,
-troff
-also defined a set of package-specific
-.Dq predefined strings ,
-which, like
+Predefined strings, like

 .Sx Special Characters ,
 .Sx Special Characters ,

-mark special output characters and strings by way of input codes.
+mark special output glyphs.

 Predefined strings are escaped with the slash-asterisk,
 .Sq \e* :
 single-character
 Predefined strings are escaped with the slash-asterisk,
 .Sq \e* :
 single-character


@@ -126,29 +148,38 @@ two-character
 .Sq \e*(XX ,
 and N-character
 .Sq \e*[N] .
 .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 .
+.Pp
+Examples:
+.Bl -tag -width Ds -offset indent -compact
+.It \e*(Am
+ampersand
+.It \e*(Ba
+vertical bar
+.El
+.Pp
+These strings are set using
+.Xr roff 7 ,
+although
+.Nm
+consists of several pre-set escapes listed in
+.Xr mandoc_char 7 .

 .Ss Whitespace
 Whitespace consists of the space character.
 .Ss Whitespace
 Whitespace consists of the space character.

-In text lines, whitespace is preserved within a line; unescaped
-trailing spaces are stripped from input (unless in a literal context).
-Blank text lines, which may include whitespace, are only permitted
-within literal contexts.
+In text lines, whitespace is preserved within a line.
+In macro lines, whitespace delimits arguments and is discarded.

 .Pp
 .Pp

-In general, trailing whitespace on input lines is discouraged
-for reasons of clarity and portability.
+Unescaped trailing spaces are stripped from text line input unless in a
+literal context.
+In general, trailing whitespace on any input line is discouraged for
+reasons of portability.

 In the rare case that a blank character is needed at the end of an
 input line, it may be forced by
 .Sq \e\ \e& .
 .Pp
 In the rare case that a blank character is needed at the end of an
 input line, it may be forced by
 .Sq \e\ \e& .
 .Pp

-In macro lines, whitespace delimits arguments and is discarded.
+Blank text lines, which may include whitespace, are only permitted
+within literal contexts.
+If the first character of a text line is a space, that line is printed
+with a leading newline.

 .Ss Quotation
 Macro arguments may be quoted with double-quotes; in this case,
 whitespace within the quotes is retained as part of the argument.
 .Ss Quotation
 Macro arguments may be quoted with double-quotes; in this case,
 whitespace within the quotes is retained as part of the argument.


@@ -184,16 +215,12 @@ Thus, the following produces
 .Pp
 In text lines, quotes are regarded as opaque text.
 .Ss Scaling Widths
 .Pp
 In text lines, quotes are regarded as opaque text.
 .Ss Scaling Widths

-Many macros support scaled widths for their arguments, such as
-stipulating a two-inch list indentation with the following:
-.Bd -literal -offset indent
-\&.Bl -tag -width 2i
-.Ed
-.Pp
-The syntax for scaled widths is
+Many macros support scaled widths for their arguments.
+The syntax for a scaled width 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.
 .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.

+.Pp

 The following scaling units are accepted:
 .Pp
 .Bl -tag -width Ds -offset indent -compact
 The following scaling units are accepted:
 .Pp
 .Bl -tag -width Ds -offset indent -compact


@@ -235,10 +262,19 @@ or
 is necessarily non-portable across output media.
 See
 .Sx COMPATIBILITY .
 is necessarily non-portable across output media.
 See
 .Sx COMPATIBILITY .

+.Pp
+Examples:
+.Bl -tag -width Ds -offset indent -compact
+.It \&.Bl -tag -width 2i
+two-inch tagged list indentation
+.Pq see Sx \&Bl
+.It \&.sp 2v
+two vertical spaces
+.Pq see Sx \&sp
+.El

 .Ss Sentence Spacing
 .Ss Sentence Spacing

-When composing a manual, make sure that sentences end at the end of
-a line.
-By doing so, front-ends will be able to apply the proper amount of
+Sentences should terminate at the end of an input line.
+By doing this, a formatter 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
 spacing after the end of sentence (unescaped) period, exclamation mark,
 or question mark followed by zero or more non-sentence closing
 delimiters


@@ -251,10 +287,14 @@ delimiters
 .Pp
 The proper spacing is also intelligently preserved if a sentence ends at
 the boundary of a macro line.
 .Pp
 The proper spacing is also intelligently preserved if a sentence ends at
 the boundary of a macro line.

-For example:

 .Pp
 .Pp

-.Dl \&.Xr mandoc 1 \&.
-.Dl \&.Fl T \&Ns \&Cm ascii \&.
+Examples:
+.Bd -literal -offset indent -compact
+Do not end sentences mid-line like this.  Instead,
+end a sentence like this.
+A macro would end like this:
+\&.Xr mandoc 1 \&.
+.Ed

 .Sh MANUAL STRUCTURE
 A well-formed
 .Nm
 .Sh MANUAL STRUCTURE
 A well-formed
 .Nm


@@ -471,6 +511,21 @@ Print verbose information.
 .Ed
 .Pp
 Manuals not documenting a command won't include the above fragment.
 .Ed
 .Pp
 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 IMPLEMENTATION NOTES
 Implementation-specific notes should be kept here.
 This is useful when implementing standard functions that may have side
 .It Em IMPLEMENTATION NOTES
 Implementation-specific notes should be kept here.
 This is useful when implementing standard functions that may have side


@@ -532,7 +587,13 @@ This section should exist for most manuals.
 Cross-references should conventionally be ordered first by section, then
 alphabetically.
 .Pp
 Cross-references should conventionally be ordered first by section, then
 alphabetically.
 .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 .
 .It Em STANDARDS
 References any standards implemented or used.
 .Sx \&Xr .
 .It Em STANDARDS
 References any standards implemented or used.


@@ -543,7 +604,8 @@ section should be used instead.
 See
 .Sx \&St .
 .It Em HISTORY
 See
 .Sx \&St .
 .It Em HISTORY

-A brief history of the subject, including where support first appeared.
+A brief history of the subject, including where it was first implemented,
+and when it was ported to or reimplemented for the operating system at hand.

 .It Em AUTHORS
 Credits to the person or persons who wrote the code and/or documentation.
 Authors should generally be noted by both name and email address.
 .It Em AUTHORS
 Credits to the person or persons who wrote the code and/or documentation.
 Authors should generally be noted by both name and email address.


@@ -664,11 +726,11 @@ has multiple heads.
 .Pp
 .Bl -column -compact -offset indent "MacroX" "CallableX" "ParsedX" "closed by XXXXXXXXXXX"
 .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope
 .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
+.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
 .El
 .Pp
 Note that the


@@ -1037,6 +1099,8 @@ Examples:
 .Dl \&.Ad 0x00000000
 .Ss \&An
 Author name.
 .Dl \&.Ad 0x00000000
 .Ss \&An
 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:
 .Pp
 .Bl -tag -width "-nosplitX" -offset indent -compact
 Requires either the name of an author or one of the following arguments:
 .Pp
 .Bl -tag -width "-nosplitX" -offset indent -compact


@@ -1107,9 +1171,17 @@ If an argument is not provided, the string
 is used as a default.
 .Pp
 Examples:
 is used as a default.
 .Pp
 Examples:

-.Dl \&.Fl o \&Ns \&Ar file1
-.Dl \&.Ar
-.Dl \&.Ar arg1 , arg2 .
+.Dl ".Fl o Ar file"
+.Dl ".Ar"
+.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
 Formats an AT&T version.
 Accepts one optional argument:
 .Ss \&At
 Formats an AT&T version.
 Accepts one optional argument:


@@ -1166,20 +1238,27 @@ The
 must be one of the following:
 .Bl -tag -width 13n -offset indent
 .It Fl centered
 must be one of the following:
 .Bl -tag -width 13n -offset indent
 .It Fl centered

-Centre-justify each line.
+Produce one output line from each input line, and centre-justify each line.

 Using this display type is not recommended; many
 .Nm
 implementations render it poorly.
 .It Fl filled
 Using this display type is not recommended; many
 .Nm
 implementations render it poorly.
 .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
-.Fl literal .
+The same as
+.Fl literal ,
+but using the same font as for normal text, which is a variable width font
+if supported by the output device.

 .El
 .Pp
 The
 .El
 .Pp
 The


@@ -1195,7 +1274,7 @@ which may be one of the following:
 .It
 One of the pre-defined strings
 .Cm indent ,
 .It
 One of the pre-defined strings
 .Cm indent ,

-the width of standard indentation;
+the width of a standard indentation (six constant width characters);

 .Cm indent-two ,
 twice
 .Cm indent ;
 .Cm indent-two ,
 twice
 .Cm indent ;


@@ -1372,9 +1451,12 @@ except that dashes are used in place of bullets.
 Like
 .Fl inset ,
 except that item heads are not parsed for macro invocations.
 Like
 .Fl inset ,
 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
 A numbered list.
 .It Fl enum
 A numbered list.

+No item heads can be specified.

 Formatted like
 .Fl bullet ,
 except that cardinal numbers are used in place of bullets,
 Formatted like
 .Fl bullet ,
 except that cardinal numbers are used in place of bullets,


@@ -1414,6 +1496,13 @@ this head on the same output line.
 Otherwise, the body starts on the output line following the head.
 .El
 .Pp
 Otherwise, the body starts on the output line following the head.
 .El
 .Pp

+Lists may be nested within lists and displays.
+Nesting of
+.Fl column
+and
+.Fl enum
+lists may not be portable.
+.Pp

 See also
 .Sx \&El
 and
 See also
 .Sx \&El
 and


@@ -1490,12 +1579,13 @@ and
 .Sx \&Ux .
 .Ss \&Bt
 Prints
 .Sx \&Ux .
 .Ss \&Bt
 Prints

-.Dq is currently in beta test .
+.Dq is currently in beta test.

 .Ss \&Bx
 Format the BSD version provided as an argument, or a default value if no
 argument is provided.
 .Pp
 Examples:
 .Ss \&Bx
 Format the BSD version provided as an argument, or a default value if no
 argument is provided.
 .Pp
 Examples:

+.Dl \&.Bx 4.3 Tahoe

 .Dl \&.Bx 4.4
 .Dl \&.Bx
 .Pp
 .Dl \&.Bx 4.4
 .Dl \&.Bx
 .Pp


@@ -1512,6 +1602,7 @@ and
 Kernel configuration declaration.
 This denotes strings accepted by
 .Xr config 8 .
 Kernel configuration declaration.
 This denotes strings accepted by
 .Xr config 8 .

+It is most often used in section 4 manual pages.

 .Pp
 Examples:
 .Dl \&.Cd device le0 at scode?
 .Pp
 Examples:
 .Dl \&.Cd device le0 at scode?


@@ -1524,14 +1615,17 @@ declarations.
 This practise is discouraged.
 .Ss \&Cm
 Command modifiers.
 This practise is discouraged.
 .Ss \&Cm
 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
 Examples:
 .Pp
 Examples:

-.Dl \&.Cm ControlPath
-.Dl \&.Cm ControlMaster
-.Pp
-See also
-.Sx \&Fl .
+.Dl ".Nm mt Fl f Ar device Cm rewind"
+.Dl ".Nm ps Fl o Cm pid , Ns Cm command"
+.Dl ".Nm dd Cm if= Ns Ar file1 Cm of= Ns Ar file2"
+.Dl ".Cm IdentityFile Pa ~/.ssh/id_rsa"
+.Dl ".Cm LogLevel Dv DEBUG"

 .Ss \&D1
 One-line indented display.
 This is formatted by the default rules and is useful for simple indented
 .Ss \&D1
 One-line indented display.
 This is formatted by the default rules and is useful for simple indented


@@ -1851,9 +1945,12 @@ See also
 and
 .Sx \&It .
 .Ss \&Em
 and
 .Sx \&It .
 .Ss \&Em

-Denotes text that should be emphasised.
+Denotes text that should be
+.Em emphasised .

 Note that this is a presentation term and should not be used for
 stylistically decorating technical terms.
 Note that this is a presentation term and should not be used for
 stylistically decorating technical terms.

+Depending on the output device, this is usually represented
+using an italic font or underlined characters.

 .Pp
 Examples:
 .Dl \&.Em Warnings!
 .Pp
 Examples:
 .Dl \&.Em Warnings!


@@ -1861,9 +1958,10 @@ Examples:
 .Pp
 See also
 .Sx \&Bf ,
 .Pp
 See also
 .Sx \&Bf ,

-.Sx \&Sy ,
+.Sx \&Li ,
+.Sx \&No ,

 and
 and

-.Sx \&Li .
+.Sx \&Sy .

 .Ss \&En
 This macro is obsolete and not implemented in
 .Xr mandoc 1 .
 .Ss \&En
 This macro is obsolete and not implemented in
 .Xr mandoc 1 .


@@ -1882,6 +1980,7 @@ will emulate
 Error constants for definitions of the
 .Va errno
 libc global variable.
 Error constants for definitions of the
 .Va errno
 libc global variable.

+This is most often used in section 2 and 3 manual pages.

 .Pp
 Examples:
 .Dl \&.Er EPERM
 .Pp
 Examples:
 .Dl \&.Er EPERM


@@ -1906,6 +2005,7 @@ for general constants.
 .Ss \&Ex
 Insert a standard sentence regarding command exit values of 0 on success
 and >0 on failure.
 .Ss \&Ex
 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:
 .Pp
 .D1 Pf \. Sx \&Ex Fl std Op Ar utility ...
 Its syntax is as follows:
 .Pp
 .D1 Pf \. Sx \&Ex Fl std Op Ar utility ...


@@ -1966,7 +2066,7 @@ See also
 and
 .Sx \&In .
 .Ss \&Fl
 and
 .Sx \&In .
 .Ss \&Fl

-Command-line flag.
+Command-line flag or option.

 Used when listing arguments to command-line utilities.
 Prints a fixed-width hyphen
 .Sq \-
 Used when listing arguments to command-line utilities.
 Prints a fixed-width hyphen
 .Sq \-


@@ -1976,10 +2076,11 @@ If the argument is a macro, a hyphen is prefixed to the subsequent macro
 output.
 .Pp
 Examples:
 output.
 .Pp
 Examples:

-.Dl \&.Fl a b c
-.Dl \&.Fl \&Pf a b
-.Dl \&.Fl
-.Dl \&.Op \&Fl o \&Ns \&Ar file
+.Dl ".Fl R Op Fl H | L | P"
+.Dl ".Op Fl 1AaCcdFfgHhikLlmnopqRrSsTtux"
+.Dl ".Fl type Cm d Fl name Pa CVS"
+.Dl ".Fl Ar signal_number"
+.Dl ".Fl o Fl"

 .Pp
 See also
 .Sx \&Cm .
 .Pp
 See also
 .Sx \&Cm .


@@ -1996,11 +2097,16 @@ Its syntax is as follows:
 Function arguments are surrounded in parenthesis and
 are delimited by commas.
 If no arguments are specified, blank parenthesis are output.
 Function arguments are surrounded in parenthesis and
 are delimited by commas.
 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
 Examples:
 .Dl \&.Fn \*qint funcname\*q \*qint arg0\*q \*qint arg1\*q
 .Dl \&.Fn funcname \*qint arg0\*q
 .Dl \&.Fn funcname arg0
 .Pp
 Examples:
 .Dl \&.Fn \*qint funcname\*q \*qint arg0\*q \*qint arg1\*q
 .Dl \&.Fn funcname \*qint arg0\*q
 .Dl \&.Fn funcname arg0

+.Pp

 .Bd -literal -offset indent -compact
 \&.Ft functype
 \&.Fn funcname
 .Bd -literal -offset indent -compact
 \&.Ft functype
 \&.Fn funcname


@@ -2010,7 +2116,8 @@ When referring to a function documented in another manual page, use
 .Sx \&Xr
 instead.
 See also
 .Sx \&Xr
 instead.
 See also

-.Sx MANUAL STRUCTURE
+.Sx MANUAL STRUCTURE ,
+.Sx \&Fo ,

 and
 .Sx \&Ft .
 .Ss \&Fo
 and
 .Sx \&Ft .
 .Ss \&Fo


@@ -2037,6 +2144,7 @@ Invocations usually occur in the following context:
 A
 .Sx \&Fo
 scope is closed by
 A
 .Sx \&Fo
 scope is closed by

+.Sx \&Fc .

 .Pp
 See also
 .Sx MANUAL STRUCTURE ,
 .Pp
 See also
 .Sx MANUAL STRUCTURE ,


@@ -2045,13 +2153,23 @@ See also
 and
 .Sx \&Ft .
 .Ss \&Fr
 and
 .Sx \&Ft .
 .Ss \&Fr

-This macro is obsolete and not implemented.
+This macro is obsolete and not implemented in
+.Xr mandoc 1 .
+.Pp
+It was used to show function return values.
+The syntax was:
+.Pp
+.Dl Pf . Sx \&Fr Ar value

 .Ss \&Ft
 A function type.
 Its syntax is as follows:
 .Pp
 .D1 Pf \. Sx \&Ft Ar functype
 .Pp
 .Ss \&Ft
 A function type.
 Its syntax is as follows:
 .Pp
 .D1 Pf \. Sx \&Ft Ar functype
 .Pp

+In the
+.Em SYNOPSIS
+section, a new output line is started after this macro.
+.Pp

 Examples:
 .Dl \&.Ft int
 .Bd -literal -offset indent -compact
 Examples:
 .Dl \&.Ft int
 .Bd -literal -offset indent -compact


@@ -2084,7 +2202,13 @@ See also
 and
 .Sx \&Ux .
 .Ss \&Hf
 and
 .Sx \&Ux .
 .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
 Designate an internal or interactive command.
 This is similar to
 .Ss \&Ic
 Designate an internal or interactive command.
 This is similar to


@@ -2092,6 +2216,7 @@ This is similar to
 but used for instructions rather than values.
 .Pp
 Examples:
 but used for instructions rather than values.
 .Pp
 Examples:

+.Dl \&.Ic :wq

 .Dl \&.Ic hash
 .Dl \&.Ic alias
 .Pp
 .Dl \&.Ic hash
 .Dl \&.Ic alias
 .Pp


@@ -2106,15 +2231,17 @@ macro is used when referring to specific instructions.
 An
 .Dq include
 file.
 An
 .Dq include
 file.

-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
-preceded by
+section, the argument is displayed in angle brackets
+and preceded by

 .Dq #include ,
 .Dq #include ,

-the arguments is enclosed in angle brackets.
+and a blank line is inserted in front if there is a preceding
+function declaration.
+This is most often used in section 2, 3, and 9 manual pages.

 .Pp
 Examples:
 .Pp
 Examples:

-.Dl \&.In sys/types
+.Dl \&.In sys/types.h

 .Pp
 See also
 .Sx MANUAL STRUCTURE .
 .Pp
 See also
 .Sx MANUAL STRUCTURE .


@@ -2220,15 +2347,21 @@ Examples:
 .Dl \&.Lb libz
 .Dl \&.Lb mdoc
 .Ss \&Li
 .Dl \&.Lb libz
 .Dl \&.Lb mdoc
 .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
 stylistically decorating technical terms.
 .Pp
 Note that this is a presentation term and should not be used for
 stylistically decorating technical terms.
 .Pp

+On terminal output devices, this is often indistinguishable from
+normal text.
+.Pp

 See also
 .Sx \&Bf ,
 See also
 .Sx \&Bf ,

-.Sx \&Sy ,
+.Sx \&Em ,
+.Sx \&No ,

 and
 and

-.Sx \&Em .
+.Sx \&Sy .

 .Ss \&Lk
 Format a hyperlink.
 Its syntax is as follows:
 .Ss \&Lk
 Format a hyperlink.
 Its syntax is as follows:


@@ -2272,8 +2405,8 @@ section subsequent the
 macro.
 .Pp
 Examples:
 macro.
 .Pp
 Examples:

-.Dl \&.Sx \&Nd mdoc language reference
-.Dl \&.Sx \&Nd format and display UNIX manuals
+.Dl Pf . Sx \&Nd mdoc language reference
+.Dl Pf . Sx \&Nd format and display UNIX manuals

 .Pp
 The
 .Sx \&Nd
 .Pp
 The
 .Sx \&Nd


@@ -2325,21 +2458,44 @@ macro rather than
 .Sx \&Nm
 to mark up the name of the manual page.
 .Ss \&No
 .Sx \&Nm
 to mark up the name of the manual page.
 .Ss \&No

-A
-.Dq noop
-macro used to terminate prior macro contexts.
+Normal text.
+Closes the scope of any preceding in-line macro.
+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
 Examples:
 .Pp
 Examples:

-.Dl \&.Sx \&Fl ab \&No cd \&Fl ef
+.Dl ".Em italic , Sy bold , No and roman"
+.Pp
+.Bd -literal -offset indent -compact
+\&.Sm off
+\&.Cm :C No / Ar pattern No / Ar replacement No /
+\&.Sm on
+.Ed
+.Pp
+See also
+.Sx \&Em ,
+.Sx \&Li ,
+and
+.Sx \&Sy .

 .Ss \&Ns
 .Ss \&Ns

-Suppress a space.
-Following invocation, text is interpreted as free-form text until a
-macro is encountered.
+Suppress a space between the output of the preceding macro
+and the following text or macro.
+Following invocation, input is interpreted as normal text
+just like after an
+.Sx \&No
+macro.

 .Pp
 This has no effect when invoked at the start of a macro line.
 .Pp
 Examples:
 .Pp
 This has no effect when invoked at the start of a macro line.
 .Pp
 Examples:

-.Dl \&.Fl o \&Ns \&Ar output
+.Dl ".Ar name Ns = Ns Ar value"
+.Dl ".Cm :M Ns Ar pattern"
+.Dl ".Fl o Ns Ar output"

 .Pp
 See also
 .Sx \&No
 .Pp
 See also
 .Sx \&No


@@ -2379,9 +2535,11 @@ Examples:
 \&.Oc
 .Ed
 .Ss \&Op
 \&.Oc
 .Ed
 .Ss \&Op

-Command-line option.
-Used when listing options to command-line utilities.
+Optional part of a command line.

 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
 Examples:
 .Dl \&.Op \&Fl a \&Ar b
 .Pp
 Examples:
 .Dl \&.Op \&Fl a \&Ar b


@@ -2415,10 +2573,13 @@ See also
 and
 .Sx \&Dt .
 .Ss \&Ot
 and
 .Sx \&Dt .
 .Ss \&Ot

-Unknown usage.
+This macro is obsolete and not implemented in
+.Xr mandoc 1 .

 .Pp
 .Pp

-.Em Remarks :
-this macro has been deprecated.
+Historical
+.Xr mdoc 7
+packages described it as
+.Dq "old function type (FORTRAN)" .

 .Ss \&Ox
 Format the
 .Ox
 .Ss \&Ox
 Format the
 .Ox


@@ -2439,9 +2600,9 @@ See also
 and
 .Sx \&Ux .
 .Ss \&Pa
 and
 .Sx \&Ux .
 .Ss \&Pa

-A file-system path.
-If an argument is not provided, the string
-.Dq \(ti
+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
 Examples:
 is used as a default.
 .Pp
 Examples:


@@ -2454,19 +2615,25 @@ See also
 Close parenthesised context opened by
 .Sx \&Po .
 .Ss \&Pf
 Close parenthesised context opened by
 .Sx \&Po .
 .Ss \&Pf

-Removes the space
+Removes the space between its argument

 .Pq Dq prefix
 .Pq Dq prefix

-between its arguments.
+and the following macro.

 Its syntax is as follows:
 .Pp
 Its syntax is as follows:
 .Pp

-.D1 Pf \. \&Pf Ar prefix suffix
+.D1 .Pf Ar prefix macro arguments ...

 .Pp
 .Pp

-The
-.Ar suffix
-argument may be a macro.
+This is equivalent to:
+.Pp
+.D1 .No Ar prefix No \&Ns Ar macro arguments ...

 .Pp
 Examples:
 .Pp
 Examples:

-.Dl \&.Pf \e. \&Sx \&Pf \&Ar prefix suffix
+.Dl ".Pf $ Ar variable_name"
+.Dl ".Pf 0x Ar hex_digits"
+.Pp
+See also
+.Sx \&Ns
+and
+.Sx \&Sm .

 .Ss \&Po
 Multi-line version of
 .Sx \&Pq .
 .Ss \&Po
 Multi-line version of
 .Sx \&Pq .


@@ -2474,6 +2641,18 @@ Multi-line version of
 Break a paragraph.
 This will assert vertical space between prior and subsequent macros
 and/or text.
 Break a paragraph.
 This will assert vertical space between prior and subsequent macros
 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
 Parenthesised enclosure.
 .Pp
 .Ss \&Pq
 Parenthesised enclosure.
 .Pp


@@ -2493,7 +2672,7 @@ Multi-line version of
 .Sx \&Qq .
 .Ss \&Qq
 Encloses its arguments in
 .Sx \&Qq .
 .Ss \&Qq
 Encloses its arguments in

-.Dq typewriter
+.Qq typewriter

 double-quotes.
 Consider using
 .Sx \&Dq .
 double-quotes.
 Consider using
 .Sx \&Dq .


@@ -2580,6 +2759,9 @@ custom sections be used.
 .Pp
 Section names should be unique so that they may be keyed by
 .Sx \&Sx .
 .Pp
 Section names should be unique so that they may be keyed by
 .Sx \&Sx .

+Although this macro is parsed, it should not consist of child node or it
+may not be linked with
+.Sx \&Sx .

 .Pp
 See also
 .Sx \&Pp ,
 .Pp
 See also
 .Sx \&Pp ,


@@ -2604,7 +2786,7 @@ Multi-line version of
 .Sx \&Sq .
 .Ss \&Sq
 Encloses its arguments in
 .Sx \&Sq .
 .Ss \&Sq
 Encloses its arguments in

-.Dq typewriter
+.Sq typewriter

 single-quotes.
 .Pp
 See also
 single-quotes.
 .Pp
 See also


@@ -2613,16 +2795,21 @@ See also
 and
 .Sx \&So .
 .Ss \&Ss
 and
 .Sx \&So .
 .Ss \&Ss

-Begin a new sub-section.
+Begin a new subsection.

 Unlike with
 .Sx \&Sh ,
 Unlike with
 .Sx \&Sh ,

-there's no convention for sub-sections.
-Conventional sections, as described in
-.Sx MANUAL STRUCTURE ,
-rarely have sub-sections.
+there is no convention for the naming of subsections.
+Except
+.Em DESCRIPTION ,
+the conventional sections described in
+.Sx MANUAL STRUCTURE
+rarely have subsections.

 .Pp
 Sub-section names should be unique so that they may be keyed by
 .Sx \&Sx .
 .Pp
 Sub-section names should be unique so that they may be keyed by
 .Sx \&Sx .

+Although this macro is parsed, it should not consist of child node or it
+may not be linked with
+.Sx \&Sx .

 .Pp
 See also
 .Sx \&Pp ,
 .Pp
 See also
 .Sx \&Pp ,


@@ -2704,6 +2891,7 @@ The following standards are recognised:
 .St -xpg4
 .It \-xpg4.2
 .St -xpg4.2
 .St -xpg4
 .It \-xpg4.2
 .St -xpg4.2

+.It \-xpg4.3

 .St -xpg4.3
 .It \-xbd5
 .St -xbd5
 .St -xpg4.3
 .It \-xbd5
 .St -xbd5


@@ -2727,8 +2915,8 @@ The following standards are recognised:
 .St -svid4
 .El
 .Ss \&Sx
 .St -svid4
 .El
 .Ss \&Sx

-Reference a section or sub-section.
-The referenced section or sub-section name must be identical to the
+Reference a section or subsection in the same manual page.
+The referenced section or subsection name must be identical to the

 enclosed argument, including whitespace.
 .Pp
 Examples:
 enclosed argument, including whitespace.
 .Pp
 Examples:


@@ -2746,9 +2934,10 @@ stylistically decorating technical terms.
 .Pp
 See also
 .Sx \&Bf ,
 .Pp
 See also
 .Sx \&Bf ,

+.Sx \&Em ,

 .Sx \&Li ,
 and
 .Sx \&Li ,
 and

-.Sx \&Em .
+.Sx \&No .

 .Ss \&Ta
 Table cell separator in
 .Sx \&Bl Fl column
 .Ss \&Ta
 Table cell separator in
 .Sx \&Bl Fl column


@@ -2757,11 +2946,16 @@ lists; can only be used below
 .Ss \&Tn
 Format a tradename.
 .Pp
 .Ss \&Tn
 Format a tradename.
 .Pp

+Since this macro is often implemented to use a small caps font,
+it has historically been used for acronyms (like ASCII) as well.
+Such usage is not recommended because it would use the same macro
+sometimes for semantical annotation, sometimes for physical formatting.
+.Pp

 Examples:
 .Dl \&.Tn IBM
 .Ss \&Ud
 Prints out
 Examples:
 .Dl \&.Tn IBM
 .Ss \&Ud
 Prints out

-.Dq currently under development .
+.Dq currently under development.

 .Ss \&Ux
 Format the UNIX name.
 Accepts no argument.
 .Ss \&Ux
 Format the UNIX name.
 Accepts no argument.


@@ -2791,11 +2985,14 @@ This is also used for indicating global variables in the
 section, in which case a variable name is also specified.
 Note that it accepts
 .Sx Block partial-implicit
 section, in which case a variable name is also specified.
 Note that it accepts
 .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
 section, else it accepts ordinary
 .Sx In-line
 syntax.
 .Em SYNOPSIS
 section, else it accepts ordinary
 .Sx In-line
 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
 Note that this should not be confused with
 .Sx \&Ft ,
 .Pp
 Note that this should not be confused with
 .Sx \&Ft ,


@@ -3054,7 +3251,7 @@ This is not supported by mandoc.
 .Xr mandoc 1 ,
 .Xr eqn 7 ,
 .Xr man 7 ,
 .Xr mandoc 1 ,
 .Xr eqn 7 ,
 .Xr man 7 ,

-.Xr mandoc_char 7
+.Xr mandoc_char 7 ,

 .Xr roff 7 ,
 .Xr tbl 7
 .Sh HISTORY
 .Xr roff 7 ,
 .Xr tbl 7
 .Sh HISTORY


@@ -3072,4 +3269,5 @@ utility written by Kristaps Dzonsons appeared in
 The
 .Nm
 reference was written by
 The
 .Nm
 reference was written by

-.An Kristaps Dzonsons Aq kristaps@bsd.lv .
+.An Kristaps Dzonsons ,
+.Mt kristaps@bsd.lv .