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

Diff for /mandoc/man.7 between version 1.127 and 1.135

version 1.127, 2014/06/22 16:39:45 version 1.135, 2017/05/07 21:44:49
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>  .\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2011, 2012, 2013 Ingo Schwarze <schwarze@openbsd.org>  .\" Copyright (c) 2011-2015 Ingo Schwarze <schwarze@openbsd.org>
 .\" Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>  .\" Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
 .\"  .\"
 .\" Permission to use, copy, modify, and distribute this software for any  .\" Permission to use, copy, modify, and distribute this software for any
Line 266  in the alphabetical reference below.
Line 266  in the alphabetical reference below.
 .It Sx TP Ta tagged paragraph: Op Ar width  .It Sx TP Ta tagged paragraph: Op Ar width
 .It Sx HP Ta hanged paragraph: Op Ar width  .It Sx HP Ta hanged paragraph: Op Ar width
 .It Sx PD Ta set vertical paragraph distance: Op Ar height  .It Sx PD Ta set vertical paragraph distance: Op Ar height
 .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 fi , nf Ta fill mode and no-fill mode (no arguments)  .It Sx fi , nf Ta fill mode and no-fill mode (no arguments)
 .It Sx in Ta additional indent: Op Ar width  .It Sx in Ta additional indent: Op Ar width
 .El  .El
Line 350  See also
Line 348  See also
 and  and
 .Sx \&IR .  .Sx \&IR .
 .Ss \&DT  .Ss \&DT
 Has no effect.  Restore the default tabulator positions.
 Included for compatibility.  They are at intervals of 0.5 inches.
   This has no effect unless the tabulator positions were changed with the
   .Xr roff 7
   .Ic \&ta
   request.
 .Ss \&EE  .Ss \&EE
 This is a non-standard GNU extension, included only for compatibility.  This is a non-standard GNU extension, included only for compatibility.
 In  In
Line 369  Begin a paragraph whose initial output line is left-ju
Line 371  Begin a paragraph whose initial output line is left-ju
 subsequent output lines are indented, with the following syntax:  subsequent output lines are indented, with the following syntax:
 .Bd -filled -offset indent  .Bd -filled -offset indent
 .Pf \. Sx \&HP  .Pf \. Sx \&HP
 .Op Cm width  .Op Ar width
 .Ed  .Ed
 .Pp  .Pp
 The  The
 .Cm width  .Ar width
 argument is a  argument is a
 .Xr roff 7  .Xr roff 7
 scaling width.  scaling width.
Line 413  and
Line 415  and
 Begin an indented paragraph with the following syntax:  Begin an indented paragraph with the following syntax:
 .Bd -filled -offset indent  .Bd -filled -offset indent
 .Pf \. Sx \&IP  .Pf \. Sx \&IP
 .Op Cm head Op Cm width  .Op Ar head Op Ar width
 .Ed  .Ed
 .Pp  .Pp
 The  The
 .Cm width  .Ar width
 argument is a  argument is a
 .Xr roff 7  .Xr roff 7
 scaling width defining the left margin.  scaling width defining the left margin.
Line 425  It's saved for later paragraph left-margins; if unspec
Line 427  It's saved for later paragraph left-margins; if unspec
 default width is used.  default width is used.
 .Pp  .Pp
 The  The
 .Cm head  .Ar head
 argument is used as a leading term, flushed to the left margin.  argument is used as a leading term, flushed to the left margin.
 This is useful for bulleted paragraphs and so on.  This is useful for bulleted paragraphs and so on.
 .Pp  .Pp
Line 470  This is a non-standard GNU extension, included only fo
Line 472  This is a non-standard GNU extension, included only fo
 It has the following syntax:  It has the following syntax:
 .Bd -filled -offset indent  .Bd -filled -offset indent
 .Pf \. Sx \&OP  .Pf \. Sx \&OP
 .Cm key Op Cm value  .Ar key Op Ar value
 .Ed  .Ed
 .Pp  .Pp
 The  The
 .Cm key  .Ar key
 is usually a command-line flag and  is usually a command-line flag and
 .Cm value  .Ar value
 its argument.  its argument.
 .Ss \&P  .Ss \&P
 Synonym for  Synonym for
Line 495  Specify the vertical space to be inserted before each 
Line 497  Specify the vertical space to be inserted before each 
 The syntax is as follows:  The syntax is as follows:
 .Bd -filled -offset indent  .Bd -filled -offset indent
 .Pf \. Sx \&PD  .Pf \. Sx \&PD
 .Op Cm height  .Op Ar height
 .Ed  .Ed
 .Pp  .Pp
 The  The
 .Cm height  .Ar height
 argument is a  argument is a
 .Xr roff 7  .Xr roff 7
 scaling width.  scaling width.
Line 555  and
Line 557  and
 .Ss \&RE  .Ss \&RE
 Explicitly close out the scope of a prior  Explicitly close out the scope of a prior
 .Sx \&RS .  .Sx \&RS .
 The default left margin is restored to the state of the original  The default left margin is restored to the state before that
 .Sx \&RS  .Sx \&RS
 invocation.  invocation.
   .Pp
   The syntax is as follows:
   .Bd -filled -offset indent
   .Pf \. Sx \&RE
   .Op Ar level
   .Ed
   .Pp
   Without an argument, the most recent
   .Sx \&RS
   block is closed out.
   If
   .Ar level
   is 1, all open
   .Sx \&RS
   blocks are closed out.
   Otherwise,
   .Ar level No \(mi 1
   nested
   .Sx \&RS
   blocks remain open.
 .Ss \&RI  .Ss \&RI
 Text is rendered alternately in roman (the default font) and italics.  Text is rendered alternately in roman (the default font) and italics.
 Whitespace between arguments is omitted in output.  Whitespace between arguments is omitted in output.
Line 578  Temporarily reset the default left margin.
Line 600  Temporarily reset the default left margin.
 This has the following syntax:  This has the following syntax:
 .Bd -filled -offset indent  .Bd -filled -offset indent
 .Pf \. Sx \&RS  .Pf \. Sx \&RS
 .Op Cm width  .Op Ar width
 .Ed  .Ed
 .Pp  .Pp
 The  The
 .Cm width  .Ar width
 argument is a  argument is a
 .Xr roff 7  .Xr roff 7
 scaling width.  scaling width.
Line 607  The scope of a sub-section is closed by a subsequent s
Line 629  The scope of a sub-section is closed by a subsequent s
 section, or end of file.  section, or end of file.
 The paragraph left-margin width is reset to the default.  The paragraph left-margin width is reset to the default.
 .Ss \&TH  .Ss \&TH
 Sets the title of the manual page with the following syntax:  Sets the title of the manual page for use in the page header
   and footer with the following syntax:
 .Bd -filled -offset indent  .Bd -filled -offset indent
 .Pf \. Sx \&TH  .Pf \. Sx \&TH
 .Ar title section date  .Ar title section date
Line 629  is empty or not specified, the current date is used.
Line 652  is empty or not specified, the current date is used.
 The optional  The optional
 .Ar source  .Ar source
 string specifies the organisation providing the utility.  string specifies the organisation providing the utility.
   When unspecified,
   .Xr mandoc 1
   uses its
   .Fl Ios
   argument.
 The  The
 .Ar volume  .Ar volume
 string replaces the default rendered volume, which is dictated by the  string replaces the default rendered volume, which is dictated by the
Line 645  Subsequent output lines are indented.
Line 673  Subsequent output lines are indented.
 The syntax is as follows:  The syntax is as follows:
 .Bd -filled -offset indent  .Bd -filled -offset indent
 .Pf \. Sx \&TP  .Pf \. Sx \&TP
 .Op Cm width  .Op Ar width
 .Ed  .Ed
 .Pp  .Pp
 The  The
 .Cm width  .Ar width
 argument is a  argument is a
 .Xr roff 7  .Xr roff 7
 scaling width.  scaling width.
Line 682  It has the following syntax:
Line 710  It has the following syntax:
 link description to be shown  link description to be shown
 .Pf \. Sx UE  .Pf \. Sx UE
 .Ed  .Ed
 .Ss \&br  
 Breaks the current line.  
 Consecutive invocations have no further effect.  
 .Pp  
 See also  
 .Sx \&sp .  
 .Ss \&fi  .Ss \&fi
 End literal mode begun by  End literal mode begun by
 .Sx \&nf .  .Sx \&nf .
 .Ss \&in  .Ss \&in
 Indent relative to the current indentation:  Indent relative to the current indentation:
 .Pp  .Pp
 .D1 Pf \. Sx \&in Op Cm width  .D1 Pf \. Sx \&in Op Ar width
 .Pp  .Pp
 If  If
 .Cm width  .Ar width
 is signed, the new offset is relative.  is signed, the new offset is relative.
 Otherwise, it is absolute.  Otherwise, it is absolute.
 This value is reset upon the next paragraph, section, or sub-section.  This value is reset upon the next paragraph, section, or sub-section.
 .Ss \&na  
 Don't align to the right margin.  
 .Ss \&nf  .Ss \&nf
 Begin literal mode: all subsequent free-form lines have their end of  Begin literal mode: all subsequent free-form lines have their end of
 line boundaries preserved.  line boundaries preserved.
Line 712  Literal mode is implicitly ended by
Line 732  Literal mode is implicitly ended by
 .Sx \&SH  .Sx \&SH
 or  or
 .Sx \&SS .  .Sx \&SS .
 .Ss \&sp  
 Insert vertical spaces into output with the following syntax:  
 .Bd -filled -offset indent  
 .Pf \. Sx \&sp  
 .Op Cm height  
 .Ed  
 .Pp  
 The  
 .Cm height  
 argument is a scaling width as described in  
 .Xr roff 7 .  
 If 0, this is equivalent to the  
 .Sx \&br  
 macro.  
 Defaults to 1, if unspecified.  
 .Pp  
 See also  
 .Sx \&br .  
 .Sh MACRO SYNTAX  .Sh MACRO SYNTAX
 The  The
 .Nm  .Nm
Line 753  is equivalent to
Line 755  is equivalent to
 .Sq \&.I foo .  .Sq \&.I foo .
 If next-line macros are invoked consecutively, only the last is used.  If next-line macros are invoked consecutively, only the last is used.
 If a next-line macro is followed by a non-next-line macro, an error is  If a next-line macro is followed by a non-next-line macro, an error is
 raised, except for  raised.
 .Sx \&br ,  
 .Sx \&sp ,  
 and  
 .Sx \&na .  
 .Pp  .Pp
 The syntax is as follows:  The syntax is as follows:
 .Bd -literal -offset indent  .Bd -literal -offset indent
Line 785  The syntax is as follows:
Line 783  The syntax is as follows:
 .It Sx \&SM  Ta    n         Ta    next-line Ta    \&  .It Sx \&SM  Ta    n         Ta    next-line Ta    \&
 .It Sx \&TH  Ta    >1, <6    Ta    current   Ta    \&  .It Sx \&TH  Ta    >1, <6    Ta    current   Ta    \&
 .It Sx \&UC  Ta    <=1       Ta    current   Ta    \&  .It Sx \&UC  Ta    <=1       Ta    current   Ta    \&
 .It Sx \&br  Ta    0         Ta    current   Ta    compat  
 .It Sx \&fi  Ta    0         Ta    current   Ta    compat  .It Sx \&fi  Ta    0         Ta    current   Ta    compat
 .It Sx \&in  Ta    1         Ta    current   Ta    compat  .It Sx \&in  Ta    1         Ta    current   Ta    compat
 .It Sx \&na  Ta    0         Ta    current   Ta    compat  
 .It Sx \&nf  Ta    0         Ta    current   Ta    compat  .It Sx \&nf  Ta    0         Ta    current   Ta    compat
 .It Sx \&sp  Ta    1         Ta    current   Ta    compat  
 .El  .El
 .Pp  .Pp
 Macros marked as  Macros marked as
Line 872  until the end of the macro scope.
Line 867  until the end of the macro scope.
 Note that macros like  Note that macros like
 .Sx \&BR  .Sx \&BR
 open and close a font scope for each argument.  open and close a font scope for each argument.
 .Sh COMPATIBILITY  
 This section mentions some areas of questionable portability between  
 implementations of the  
 .Nm  
 language.  
 More incompatibilities exist.  
 .Pp  
 .Bl -dash -compact  
 .It  
 Do not depend on  
 .Sx \&SH  
 or  
 .Sx \&SS  
 to close out a literal context opened with  
 .Sx \&nf .  
 This behaviour may not be portable.  
 .It  
 troff suppresses a newline before  
 .Sq \(aq  
 macro output; in mandoc, it is an alias for the standard  
 .Sq \&.  
 control character.  
 .It  
 In page header lines, GNU troff versions up to and including 1.21  
 only print  
 .Ar volume  
 names explicitly specified in the  
 .Sx \&TH  
 macro; mandoc and newer groff print the default volume name  
 corresponding to the  
 .Ar section  
 number when no  
 .Ar volume  
 is given, like in  
 .Xr mdoc 7 .  
 .El  
 .Pp  
 The  
 .Sx EE ,  
 .Sx EX ,  
 .Sx OP ,  
 .Sx UE ,  
 and  
 .Sx UR  
 macros are part of the GNU extended  
 .Nm  
 macro set, and may not be portable to non-GNU troff implementations.  
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr man 1 ,  .Xr man 1 ,
 .Xr mandoc 1 ,  .Xr mandoc 1 ,
Legend:
Removed from v.1.127  
changed lines
  Added in v.1.135
CVSweb