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

Diff for /mandoc/mdoc.7 between version 1.233 and 1.239

version 1.233, 2014/08/08 01:52:40 version 1.239, 2014/10/20 17:59:20
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 468  in the alphabetical
Line 468  in the alphabetical
 .It Sx \&Pf Ta prefix, no following horizontal space (one argument)  .It Sx \&Pf Ta prefix, no following horizontal space (one argument)
 .It Sx \&Ns Ta roman font, no preceding horizontal space (no arguments)  .It Sx \&Ns Ta roman font, no preceding horizontal space (no arguments)
 .It Sx \&Ap Ta apostrophe without surrounding whitespace (no arguments)  .It Sx \&Ap Ta apostrophe without surrounding whitespace (no arguments)
 .It Sx \&Sm Ta switch horizontal spacing mode: Cm on | off  .It Sx \&Sm Ta switch horizontal spacing mode: Op Cm on | off
 .It Sx \&Bk , \&Ek Ta keep block: Fl words  .It Sx \&Bk , \&Ek Ta keep block: Fl words
 .It Sx \&br Ta force output line break in text mode (no arguments)  .It Sx \&br Ta force output line break in text mode (no arguments)
 .It Sx \&sp Ta force vertical space: Op Ar height  .It Sx \&sp Ta force vertical space: Op Ar height
Line 1245  See also
Line 1245  See also
 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.
Line 1467  See also
Line 1467  See also
 and  and
 .Sx \&It .  .Sx \&It .
 .Ss \&Em  .Ss \&Em
 Denotes text that should be  Request an italic font.
 .Em emphasised .  If the output device does not provide that, underline.
 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  .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:
 .Dl \&.Em Warnings!  .Bd -literal -compact -offset indent
 .Dl \&.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 ,
Line 1557  arguments are treated as separate utilities.
Line 1570  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 2335  and
Line 2348  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 .
Line 2344  When switched
Line 2357  When switched
 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 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 .
Line 2492  Based on POSIX.1 and POSIX.2, published in 1992.
Line 2510  Based on POSIX.1 and POSIX.2, published in 1992.
 .It Single UNIX Specification version 1 and related standards  .It Single UNIX Specification version 1 and related standards
 .Pp  .Pp
 .Bl -tag -width "-p1003.1g-2000" -compact  .Bl -tag -width "-p1003.1g-2000" -compact
   .It \-susv1
   .St -susv1
 .It \-xpg4.2  .It \-xpg4.2
 .St -xpg4.2  .St -xpg4.2
 .br  .br
 This standard was published in 1994 and is also called SUSv1.  This standard was published in 1994.
 It was used as the basis for UNIX 95 certification.  It was used as the basis for UNIX 95 certification.
 The following three refer to parts of it.  The following three refer to parts of it.
 .Pp  .Pp
Line 2588  The second and last Technical Corrigendum.
Line 2608  The second and last Technical Corrigendum.
 .Bl -tag -width "-p1003.1g-2000" -compact  .Bl -tag -width "-p1003.1g-2000" -compact
 .It \-p1003.1-2008  .It \-p1003.1-2008
 .St -p1003.1-2008  .St -p1003.1-2008
   .It \-susv4
   .St -susv4
 .br  .br
 This standard is also called SUSv4 and  This standard is also called
 X/Open Portability Guide version 7.  X/Open Portability Guide version 7.
 .Pp  .Pp
 .It \-p1003.1-2013  .It \-p1003.1-2013
Line 2632  See also
Line 2654  See also
 and  and
 .Sx \&Ss .  .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 \&Em ,
Line 2668  A variable name.
Line 2704  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 2684  In the former case, this macro starts a new output lin
Line 2729  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 .
Line 3022  then the macro accepts an arbitrary number of argument
Line 3070  then the macro accepts an arbitrary number of argument
 .It Sx \&Pf  Ta    Yes      Ta    Yes      Ta    1  .It Sx \&Pf  Ta    Yes      Ta    Yes      Ta    1
 .It Sx \&Pp  Ta    \&No     Ta    \&No     Ta    0  .It Sx \&Pp  Ta    \&No     Ta    \&No     Ta    0
 .It Sx \&Rv  Ta    \&No     Ta    \&No     Ta    n  .It Sx \&Rv  Ta    \&No     Ta    \&No     Ta    n
 .It Sx \&Sm  Ta    \&No     Ta    \&No     Ta    1  .It Sx \&Sm  Ta    \&No     Ta    \&No     Ta    <2
 .It Sx \&St  Ta    \&No     Ta    Yes      Ta    1  .It Sx \&St  Ta    \&No     Ta    Yes      Ta    1
 .It Sx \&Sx  Ta    Yes      Ta    Yes      Ta    >0  .It Sx \&Sx  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Sy  Ta    Yes      Ta    Yes      Ta    >0  .It Sx \&Sy  Ta    Yes      Ta    Yes      Ta    >0
Legend:
Removed from v.1.233  
changed lines
  Added in v.1.239
CVSweb