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

Diff for /mandoc/mdoc.7 between version 1.213 and 1.222

version 1.213, 2011/11/01 14:59:27 version 1.222, 2013/11/02 20:39:49
Line 477  in the alphabetical
Line 477  in the alphabetical
 .Bl -column "Brq, Bro, Brc" description  .Bl -column "Brq, Bro, Brc" description
 .It Sx \&Lb Ta function library (one argument)  .It Sx \&Lb Ta function library (one argument)
 .It Sx \&In Ta include file (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 \&Ft Ta function type (>0 arguments)
 .It Sx \&Fo , \&Fc Ta function block: Ar funcname  .It Sx \&Fo , \&Fc Ta function block: Ar funcname
 .It Sx \&Fn Ta function name:  .It Sx \&Fn Ta function name:
Line 657  for all other author listings.
Line 658  for all other author listings.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.An -nosplit  .Dl \&.An -nosplit
 .Dl \&.An Kristaps Dzonsons \&Aq kristaps@bsd.lv  .Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv
 .Ss \&Ao  .Ss \&Ao
 Begin a block enclosed by angle brackets.  Begin a block enclosed by angle brackets.
 Does not have any head arguments.  Does not have any head arguments.
Line 711  for fixed strings to be passed verbatim as arguments, 
Line 712  for fixed strings to be passed verbatim as arguments, 
 or  or
 .Sx \&Cm .  .Sx \&Cm .
 .Ss \&At  .Ss \&At
 Formats an AT&T version.  Formats an
   .At
   version.
 Accepts one optional argument:  Accepts one optional argument:
 .Pp  .Pp
 .Bl -tag -width "v[1-7] | 32vX" -offset indent -compact  .Bl -tag -width "v[1-7] | 32vX" -offset indent -compact
Line 820  The most popular is the imaginary macro
Line 823  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 926  The
Line 929  The
 .Fl width  .Fl width
 and  and
 .Fl offset  .Fl offset
 arguments accept  arguments accept scaling widths as described in
 .Sx Scaling Widths  .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 956  A columnated list.
Line 959  A columnated list.
 The  The
 .Fl width  .Fl width
 argument has no effect; instead, each argument specifies the width  argument has no effect; instead, each argument specifies the width
 of one column, using either the  of one column, using either the scaling width syntax described in
 .Sx Scaling Widths  .Xr roff 7
 syntax or the string length of the argument.  or the string length of the argument.
 If the first line of the body of a  If the first line of the body of a
 .Fl column  .Fl column
 list is not an  list is not an
Line 1089  Examples:
Line 1092  Examples:
 See also  See also
 .Sx \&Bro .  .Sx \&Bro .
 .Ss \&Bsx  .Ss \&Bsx
 Format the BSD/OS version provided as an argument, or a default value if  Format the
   .Bsx
   version provided as an argument, or a default value if
 no argument is provided.  no argument is provided.
 .Pp  .Pp
 Examples:  Examples:
Line 1109  and
Line 1114  and
 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:
Line 1401  See also
Line 1408  See also
 .Sx \&Er  .Sx \&Er
 and  and
 .Sx \&Ev  .Sx \&Ev
 for special-purpose constants and  for special-purpose constants,
 .Sx \&Va  .Sx \&Va
 for variable symbols.  for variable symbols, and
   .Sx \&Fd
   for listing preprocessor variable definitions in the
   .Em SYNOPSIS .
 .Ss \&Dx  .Ss \&Dx
 Format the DragonFly BSD version provided as an argument, or a default  Format the
   .Dx
   version provided as an argument, or a default
 value if no argument is provided.  value if no argument is provided.
 .Pp  .Pp
 Examples:  Examples:
Line 1562  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 or option.  Command-line flag or option.
 Used when listing arguments to command-line utilities.  Used when listing arguments to command-line utilities.
Line 1851  section as described in
Line 1880  section as described in
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Lb libz  .Dl \&.Lb libz
 .Dl \&.Lb mdoc  .Dl \&.Lb libmandoc
 .Ss \&Li  .Ss \&Li
 Denotes text that should be in a  Denotes text that should be in a
 .Li literal  .Li literal
Line 1902  Its syntax is as follows:
Line 1931  Its syntax is as follows:
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Mt discuss@manpages.bsd.lv  .Dl \&.Mt discuss@manpages.bsd.lv
   .Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv
 .Ss \&Nd  .Ss \&Nd
 A one line description of the manual's content.  A one line description of the manual's content.
 This may only be invoked in the  This may only be invoked in the
Line 2083  This macro is obsolete and not implemented in
Line 2113  This macro is obsolete and not implemented in
 .Xr mandoc 1 .  .Xr mandoc 1 .
 .Pp  .Pp
 Historical  Historical
 .Xr mdoc 7  .Nm
 packages described it as  packages described it as
 .Dq "old function type (FORTRAN)" .  .Dq "old function type (FORTRAN)" .
 .Ss \&Ox  .Ss \&Ox
Line 2347  The following standards are recognised:
Line 2377  The following standards are recognised:
 .St -p1003.1b-93  .St -p1003.1b-93
 .It \-p1003.1c-95  .It \-p1003.1c-95
 .St -p1003.1c-95  .St -p1003.1c-95
   .It \-p1003.1d-99
   .St -p1003.1d-99
 .It \-p1003.1g-2000  .It \-p1003.1g-2000
 .St -p1003.1g-2000  .St -p1003.1g-2000
 .It \-p1003.1i-95  .It \-p1003.1i-95
 .St -p1003.1i-95  .St -p1003.1i-95
   .It \-p1003.1j-2000
   .St -p1003.1j-2000
   .It \-p1003.1q-2000
   .St -p1003.1q-2000
   .It \-p1003.2
   .St -p1003.2
 .It \-p1003.2-92  .It \-p1003.2-92
 .St -p1003.2-92  .St -p1003.2-92
 .It \-p1003.2a-92  .It \-p1003.2a-92
 .St -p1003.2a-92  .St -p1003.2a-92
 .It \-p1387.2-95  
 .St -p1387.2-95  
 .It \-p1003.2  
 .St -p1003.2  
 .It \-p1387.2  .It \-p1387.2
 .St -p1387.2  .St -p1387.2
   .It \-p1387.2-95
   .St -p1387.2-95
 .It \-isoC  .It \-isoC
 .St -isoC  .St -isoC
 .It \-isoC-90  .It \-isoC-90
Line 2373  The following standards are recognised:
Line 2409  The following standards are recognised:
 .St -isoC-tcor2  .St -isoC-tcor2
 .It \-isoC-99  .It \-isoC-99
 .St -isoC-99  .St -isoC-99
   .It \-isoC-2011
   .St -isoC-2011
 .It \-iso9945-1-90  .It \-iso9945-1-90
 .St -iso9945-1-90  .St -iso9945-1-90
 .It \-iso9945-1-96  .It \-iso9945-1-96
Line 2465  Examples:
Line 2503  Examples:
 Prints out  Prints out
 .Dq currently under development.  .Dq currently under development.
 .Ss \&Ux  .Ss \&Ux
 Format the UNIX name.  Format the
   .Ux
   name.
 Accepts no argument.  Accepts no argument.
 .Pp  .Pp
 Examples:  Examples:
Line 2530  Link to another manual
Line 2570  Link to another manual
 .Pq Qq cross-reference .  .Pq Qq cross-reference .
 Its syntax is as follows:  Its syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. Sx \&Xr Ar name section  .D1 Pf \. Sx \&Xr Ar name Op section
 .Pp  .Pp
 The  Cross reference the
 .Ar name  .Ar name
 and  and
 .Ar section  .Ar section
 are the name and section of the linked manual.  number of another man page;
 If  omitting the section number is rarely useful.
 .Ar section  
 is followed by non-punctuation, an  
 .Sx \&Ns  
 is inserted into the token stream.  
 This behaviour is for compatibility with  
 GNU troff.  
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Xr mandoc 1  .Dl \&.Xr mandoc 1
Line 2567  Its syntax is as follows:
Line 2601  Its syntax is as follows:
 .Pp  .Pp
 The  The
 .Ar height  .Ar height
 argument must be formatted as described in  argument is a scaling width as described in
 .Sx Scaling Widths .  .Xr roff 7 .
 If unspecified,  If unspecified,
 .Sx \&sp  .Sx \&sp
 asserts a single vertical space.  asserts a single vertical space.
Line 2962  Manually switching the font using the
Line 2996  Manually switching the font using the
 .Ql \ef  .Ql \ef
 font escape sequences is never required.  font escape sequences is never required.
 .Sh COMPATIBILITY  .Sh COMPATIBILITY
 This section documents compatibility between mandoc and other other  This section documents compatibility between mandoc and other
 troff implementations, at this time limited to GNU troff  troff implementations, at this time limited to GNU troff
 .Pq Qq groff .  .Pq Qq groff .
 The term  The term
Line 3166  utility written by Kristaps Dzonsons appeared in
Line 3200  utility written by Kristaps Dzonsons appeared in
 The  The
 .Nm  .Nm
 reference was written by  reference was written by
 .An Kristaps Dzonsons ,  .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
 .Mt kristaps@bsd.lv .  
Legend:
Removed from v.1.213  
changed lines
  Added in v.1.222
CVSweb