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

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

version 1.243, 2014/11/28 18:09:01 version 1.248, 2015/01/03 00:59:13
Line 433  in the alphabetical
Line 433  in the alphabetical
 .Ss Document preamble and NAME section macros  .Ss Document preamble and NAME section macros
 .Bl -column "Brq, Bro, Brc" description  .Bl -column "Brq, Bro, Brc" description
 .It Sx \&Dd Ta document date: Cm $\&Mdocdate$ | Ar month day , year  .It Sx \&Dd Ta document date: Cm $\&Mdocdate$ | Ar month day , year
 .It Sx \&Dt Ta document title: Ar TITLE section Op Ar volume | arch  .It Sx \&Dt Ta document title: Ar TITLE section Op Ar arch
 .It Sx \&Os Ta operating system version: Op Ar system Op Ar version  .It Sx \&Os Ta operating system version: Op Ar system Op Ar version
 .It Sx \&Nm Ta document name (one argument)  .It Sx \&Nm Ta document name (one argument)
 .It Sx \&Nd Ta document description (one line)  .It Sx \&Nd Ta document description (one line)
Line 454  in the alphabetical
Line 454  in the alphabetical
 .Op Fl compact  .Op Fl compact
 .It Sx \&D1 Ta indented display (one line)  .It Sx \&D1 Ta indented display (one line)
 .It Sx \&Dl Ta indented literal display (one line)  .It Sx \&Dl Ta indented literal display (one line)
   .It Sx \&Ql Ta in-line literal display: Ql text
 .It Sx \&Bl , \&El Ta list block:  .It Sx \&Bl , \&El Ta list block:
 .Fl Ar type  .Fl Ar type
 .Op Fl width Ar val  .Op Fl width Ar val
Line 528  in the alphabetical
Line 529  in the alphabetical
 .It Sx \&Dq , \&Do , \&Dc Ta enclose in typographic double quotes: Dq text  .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 \&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 \&Sq , \&So , \&Sc Ta enclose in single quotes: Sq text
 .It Sx \&Ql Ta single-quoted literal text: Ql text  
 .It Sx \&Pq , \&Po , \&Pc Ta enclose in parentheses: Pq 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 \&Bq , \&Bo , \&Bc Ta enclose in square brackets: Bq text
 .It Sx \&Brq , \&Bro , \&Brc Ta enclose in curly braces: Brq text  .It Sx \&Brq , \&Bro , \&Brc Ta enclose in curly braces: Brq text
Line 1256  Examples:
Line 1256  Examples:
 .Dl \&.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 1299  Its syntax is as follows:
Line 1301  Its syntax is as follows:
 .Pf \. Sx \&Dt  .Pf \. Sx \&Dt
 .Ar TITLE  .Ar TITLE
 .Ar section  .Ar section
 .Op Ar volume | arch  .Op Ar arch
 .Ed  .Ed
 .Pp  .Pp
 Its arguments are as follows:  Its arguments are as follows:
Line 1314  it should by convention be all caps.
Line 1316  it should by convention be all caps.
 The manual section.  The manual section.
 This may be one of  This may be one of
 .Cm 1  .Cm 1
 .Pq utilities ,  .Pq General Commands ,
 .Cm 2  .Cm 2
 .Pq system calls ,  .Pq System Calls ,
 .Cm 3  .Cm 3
 .Pq libraries ,  .Pq Library Functions ,
 .Cm 3p  .Cm 3p
 .Pq Perl libraries ,  .Pq Perl Library ,
 .Cm 4  .Cm 4
 .Pq devices ,  .Pq Device Drivers ,
 .Cm 5  .Cm 5
 .Pq file formats ,  .Pq File Formats ,
 .Cm 6  .Cm 6
 .Pq games ,  .Pq Games ,
 .Cm 7  .Cm 7
 .Pq miscellaneous ,  .Pq Miscellaneous Information ,
 .Cm 8  .Cm 8
 .Pq system utilities ,  .Pq System Manager's Manual ,
 .Cm 9  
 .Pq kernel functions ,  
 .Cm X11  
 .Pq X Window System ,  
 .Cm X11R6  
 .Pq X Window System ,  
 .Cm unass  
 .Pq unassociated ,  
 .Cm local  
 .Pq local system ,  
 .Cm draft  
 .Pq draft manual ,  
 or  or
 .Cm 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
 the empty string if unspecified.  the empty string if unspecified.
 .It Ar volume  
 This overrides the volume inferred from  
 .Ar section .  
 This field is optional, and if specified, must be one of  
 .Cm USD  
 .Pq users' supplementary documents ,  
 .Cm PS1  
 .Pq programmers' supplementary documents ,  
 .Cm AMD  
 .Pq administrators' supplementary documents ,  
 .Cm SMM  
 .Pq system managers' manuals ,  
 .Cm URM  
 .Pq users' reference manuals ,  
 .Cm PRM  
 .Pq programmers' reference manuals ,  
 .Cm KM  
 .Pq kernel manuals ,  
 .Cm IND  
 .Pq master index ,  
 .Cm MMI  
 .Pq master index ,  
 .Cm LOCAL  
 .Pq local manuals ,  
 .Cm LOC  
 .Pq local manuals ,  
 or  
 .Cm CON  
 .Pq contributed manuals .  
 .It Ar arch  .It Ar arch
 This specifies the machine architecture a manual page applies to,  This specifies the machine architecture a manual page applies to,
 where relevant, for example  where relevant, for example
Line 1390  The list of valid architectures varies by operating sy
Line 1351  The list of valid architectures varies by operating sy
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Dt FOO 1  .Dl \&.Dt FOO 1
 .Dl \&.Dt FOO 4 KM  
 .Dl \&.Dt FOO 9 i386  .Dl \&.Dt FOO 9 i386
 .Pp  .Pp
 See also  See also
Line 2130  Its syntax is as follows:
Line 2090  Its syntax is as follows:
 The optional  The optional
 .Ar 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:
 .Dl \&.Os  .Dl \&.Os
Line 2235  See also
Line 2203  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 .
Line 2426  The original C standard.
Line 2404  The original C standard.
 .Pp  .Pp
 .It \-isoC-99  .It \-isoC-99
 .St -isoC-99  .St -isoC-99
 .It \-ansiC-99  
 .St -ansiC-99  
 .br  .br
 The second major version of the C language standard.  The second major version of the C language standard.
 .Pp  .Pp
Line 2527  The following three refer to parts of it.
Line 2503  The following three refer to parts of it.
 .br  .br
 Networking APIs, including sockets.  Networking APIs, including sockets.
 .Pp  .Pp
 .It \-xpg4.3  
 .St -xpg4.3  
 .Pp  
 .It \-svid4  .It \-svid4
 .St -svid4 ,  .St -svid4 ,
 .br  .br
Line 2559  The following refer to parts of it.
Line 2532  The following refer to parts of it.
 .It \-xns5.2  .It \-xns5.2
 .St -xns5.2  .St -xns5.2
 .El  .El
 .It Single UNIX Specification version 3 and related standards  .It Single UNIX Specification version 3
 .Pp  .Pp
 .Bl -tag -width "-p1003.1g-2000X" -compact  .Bl -tag -width "-p1003.1-2001" -compact
 .It \-p1003.1d-99  
 .St -p1003.1d-99  
 .br  
 Additional real-time extensions.  
 .Pp  
 .It \-p1003.1-2001  .It \-p1003.1-2001
 .St -p1003.1-2001  .St -p1003.1-2001
 .It \-susv3  .It \-susv3
Legend:
Removed from v.1.243  
changed lines
  Added in v.1.248
CVSweb