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

Diff for /mandoc/mdoc.7 between version 1.237 and 1.245

version 1.237, 2014/09/17 00:43:15 version 1.245, 2014/11/30 21:56:18
Line 388  See
Line 388  See
 References other manuals with related topics.  References other manuals with related topics.
 This section should exist for most manuals.  This section should exist for most manuals.
 Cross-references should conventionally be ordered first by section, then  Cross-references should conventionally be ordered first by section, then
 alphabetically.  alphabetically (ignoring case).
 .Pp  .Pp
 References to other documentation concerning the topic of the manual page,  References to other documentation concerning the topic of the manual page,
 for example authoritative books or journal articles, may also be  for example authoritative books or journal articles, may also be
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 937  The
Line 937  The
 .Fl width  .Fl width
 and  and
 .Fl offset  .Fl offset
 arguments accept scaling widths as described in  arguments accept macro names as described for
 .Xr roff 7  .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 1182  See also
Line 1185  See also
 and  and
 .Sx \&Dl .  .Sx \&Dl .
 .Ss \&Db  .Ss \&Db
 Switch debugging mode.  This macro is obsolete.
 Its syntax is as follows:  No replacement is needed.
 .Pp  It is ignored by
 .D1 Pf \. Sx \&Db Cm on | off  .Xr mandoc 1
 .Pp  and groff including its arguments.
 This macro is ignored by  It was formerly used to toggle a debugging mode.
 .Xr mandoc 1 .  
 .Ss \&Dc  .Ss \&Dc
 Close a  Close a
 .Sx \&Do  .Sx \&Do
Line 1297  Its syntax is as follows:
Line 1299  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 1346  or
Line 1348  or
 .Pq paper .  .Pq paper .
 It should correspond to the manual's filename suffix and defaults to  It should correspond to the manual's filename suffix and defaults to
 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 1383  where relevant, for example
Line 1356  where relevant, for example
 .Cm i386 ,  .Cm i386 ,
 or  or
 .Cm sparc64 .  .Cm sparc64 .
 The list of supported architectures varies by operating system.  The list of valid architectures varies by operating system.
 For the full list of all architectures recognized by  
 .Xr mandoc 1 ,  
 see the file  
 .Pa arch.in  
 in the source distribution.  
 .El  .El
 .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 1570  arguments are treated as separate utilities.
Line 1537  arguments are treated as separate utilities.
 See also  See also
 .Sx \&Rv .  .Sx \&Rv .
 .Ss \&Fa  .Ss \&Fa
 Function argument.  Function argument or parameter.
 Its syntax is as follows:  Its syntax is as follows:
 .Bd -ragged -offset indent  .Bd -ragged -offset indent
 .Pf \. Sx \&Fa  .Pf \. Sx \&Fa
Line 2429  The original C standard.
Line 2396  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 2530  The following three refer to parts of it.
Line 2495  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 2521  The following refer to parts of it.
 .Pp  .Pp
 .It \-xns5  .It \-xns5
 .St -xns5  .St -xns5
 .It \-xns5.2d2.0  
 .St -xns5.2d2.0  
 .It \-xns5.2  .It \-xns5.2
 .St -xns5.2  .St -xns5.2
 .Pp  
 .It \-p1387.2  
 .St -p1387.2  
 .It \-p1387.2-95  
 .St -p1387.2-95  
 .br  
 POSIX software administration.  
 .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.1j-2000  
 .St -p1003.1j-2000  
 .br  
 Advanced real-time extensions.  
 .Pp  
 .It \-p1003.1q-2000  
 .St -p1003.1q-2000  
 .br  
 Amendment 7: Tracing [C Language].  
 .Pp  
 .It \-p1003.1-2001  .It \-p1003.1-2001
 .St -p1003.1-2001  .St -p1003.1-2001
 .It \-susv3  .It \-susv3
Line 2704  A variable name.
Line 2642  A variable name.
 Examples:  Examples:
 .Dl \&.Va foo  .Dl \&.Va foo
 .Dl \&.Va const char *bar ;  .Dl \&.Va const char *bar ;
   .Pp
   For function arguments and parameters, use
   .Sx \&Fa
   instead.
   For declarations of global variables in the
   .Em SYNOPSIS
   section, use
   .Sx \&Vt .
 .Ss \&Vt  .Ss \&Vt
 A variable type.  A variable type.
   .Pp
 This is also used for indicating global variables in the  This is also used for indicating global variables in the
 .Em SYNOPSIS  .Em SYNOPSIS
 section, in which case a variable name is also specified.  section, in which case a variable name is also specified.
Line 2720  In the former case, this macro starts a new output lin
Line 2667  In the former case, this macro starts a new output lin
 and a blank line is inserted in front if there is a preceding  and a blank line is inserted in front if there is a preceding
 function definition or include directive.  function definition or include directive.
 .Pp  .Pp
 Note that this should not be confused with  
 .Sx \&Ft ,  
 which is used for function return types.  
 .Pp  
 Examples:  Examples:
 .Dl \&.Vt unsigned char  .Dl \&.Vt unsigned char
 .Dl \&.Vt extern const char * const sys_signame[] \&;  .Dl \&.Vt extern const char * const sys_signame[] \&;
 .Pp  .Pp
   For parameters in function prototypes, use
   .Sx \&Fa
   instead, for function return types
   .Sx \&Ft ,
   and for variable names outside the
   .Em SYNOPSIS
   section
   .Sx \&Va ,
   even when including a type with the name.
 See also  See also
 .Sx MANUAL STRUCTURE  .Sx MANUAL STRUCTURE .
 and  
 .Sx \&Va .  
 .Ss \&Xc  .Ss \&Xc
 Close a scope opened by  Close a scope opened by
 .Sx \&Xo .  .Sx \&Xo .
Legend:
Removed from v.1.237  
changed lines
  Added in v.1.245
CVSweb