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

Diff for /mandoc/mdoc.7 between version 1.123 and 1.130

version 1.123, 2010/06/07 11:14:13 version 1.130, 2010/07/04 22:04:04
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@bsd.lv>  .\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
   .\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
 .\"  .\"
 .\" Permission to use, copy, modify, and distribute this software for any  .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above  .\" purpose with or without fee is hereby granted, provided that the above
Line 55  Text following a
Line 56  Text following a
 whether in a macro or free-form text line, is ignored to the end of  whether in a macro or free-form text line, is ignored to the end of
 line.  A macro line with only a control character and comment escape,  line.  A macro line with only a control character and comment escape,
 .Sq \&.\e" ,  .Sq \&.\e" ,
 is also ignored.  Macro lines with only a control charater and optionally  is also ignored.  Macro lines with only a control character and optionally
 whitespace are stripped from input.  whitespace are stripped from input.
 .Ss Reserved Characters  .Ss Reserved Characters
 Within a macro line, the following characters are reserved:  Within a macro line, the following characters are reserved:
Line 167  also defined a set of package-specific
Line 168  also defined a set of package-specific
 .Dq predefined strings ,  .Dq predefined strings ,
 which, like  which, like
 .Sx Special Characters ,  .Sx Special Characters ,
 demark special output characters and strings by way of input codes.  mark special output characters and strings by way of input codes.
 Predefined strings are escaped with the slash-asterisk,  Predefined strings are escaped with the slash-asterisk,
 .Sq \e* :  .Sq \e* :
 single-character  single-character
Line 478  they are separated by a vertical space, unless in the 
Line 479  they are separated by a vertical space, unless in the 
 and  and
 .Sx \&Ft ,  .Sx \&Ft ,
 which are always separated by vertical space.  which are always separated by vertical space.
   .Pp
   When text and macros following an
   .Sx \&Nm
   macro starting an input line span multiple output lines,
   all output lines but the first will be indented to align
   with the text immediately following the
   .Sx \&Nm
   macro, up to the next
   .Sx \&Nm ,
   .Sx \&Sx ,
   or
   .Sx \&Ss
   macro or the end of an enclosing block, whichever comes first.
 .It Em DESCRIPTION  .It Em DESCRIPTION
 This expands upon the brief, one-line description in  This expands upon the brief, one-line description in
 .Em NAME .  .Em NAME .
Line 672  has multiple heads.
Line 686  has multiple heads.
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope  .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
 .It Sx \&It  Ta    \&No     Ta    Yes      Ta    closed by Sx \&It , Sx \&El  .It Sx \&It  Ta    \&No     Ta    Yes      Ta    closed by Sx \&It , Sx \&El
 .It Sx \&Nd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh  .It Sx \&Nd  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh
   .It Sx \&Nm  Ta    \&No     Ta  Yes Ta closed by Sx \&Nm , Sx \&Sh , Sx \&Ss
 .It Sx \&Sh  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh  .It Sx \&Sh  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh
 .It Sx \&Ss  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh , Sx \&Ss  .It Sx \&Ss  Ta    \&No     Ta    \&No     Ta    closed by Sx \&Sh , Sx \&Ss
 .El  .El
   .Pp
   Note that the
   .Sx \&Nm
   macro is a
   .Sx Block full-implicit
   macro only when invoked as the first macro
   in a
   .Em SYNOPSIS
   section line, else it is
   .Sx In-line .
 .Ss Block partial-explicit  .Ss Block partial-explicit
 Like block full-explicit, but also with single-line scope.  Like block full-explicit, but also with single-line scope.
 Each has at least a body and, in limited circumstances, a head  Each has at least a body and, in limited circumstances, a head
Line 973  See also
Line 998  See also
 .Sx \&Aq .  .Sx \&Aq .
 .Ss \&Ap  .Ss \&Ap
 Inserts an apostrophe without any surrounding white-space.  Inserts an apostrophe without any surrounding white-space.
 This is generally used as a grammatic device when referring to the verb  This is generally used as a grammatical device when referring to the verb
 form of a function:  form of a function:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Fn execve Ap d  \&.Fn execve Ap d
Line 1094  As a scaling unit following the syntax described in
Line 1119  As a scaling unit following the syntax described in
 As the calculated string length of the opaque string.  As the calculated string length of the opaque string.
 .El  .El
 .Pp  .Pp
 If unset, it will revert to the value of  If not provided an argument, it will be ignored.
 .Ar 8n  
 as described in  
 .Sx Scaling Widths .  
 .It Fl compact  .It Fl compact
 Do not assert a vertical space before the block.  Do not assert a vertical space before the block.
 .It Fl file Ar file  .It Fl file Ar file
Line 1118  See also
Line 1140  See also
 and  and
 .Sx \&Dl .  .Sx \&Dl .
 .Ss \&Bf  .Ss \&Bf
   Change the font mode for a scoped block of text.
   Its syntax is as follows:
   .Bd -ragged -offset indent
   .Pf \. Sx \&Bf
   .Oo
   .Fl emphasis | literal | symbolic |
   .Cm \&Em | \&Li | \&Sy
   .Oc
   .Ed
   .Pp
   The
   .Fl emphasis
   and
   .Cm \&Em
   argument are equivalent, as are
   .Fl symbolic
   and
   .Cm \&Sy,
   and
   .Fl literal
   and
   .Cm \&Li .
   Without an argument, this macro does nothing.
   The font mode continues until broken by a new font mode in a nested
   scope or
   .Sx \&Ef
   is encountered.
   .Pp
   See also
   .Sx \&Li ,
   .Sx \&Ef ,
   and
   .Sx \&Sy .
 .Ss \&Bk  .Ss \&Bk
   Begins a keep block, containing a collection of macros or text
   to be kept together in the output.
   One argument is required; additional arguments are ignored.
   Currently, the only argument implemented is
   .Fl words ,
   requesting to keep together all words of the contained text
   on the same output line.
   A
   .Fl lines
   argument to keep together all lines of the contained text
   on the same page has been desired for a long time,
   but has never been implemented.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Bk \-words
   \&.Op o Ar output_file
   \&.Ek
   .Ed
   .Pp
   See also
   .Sx \&Ek .
 .Ss \&Bl  .Ss \&Bl
 Begins a list composed of one or more list entries.  Begins a list composed of one or more list entries.
 A list is associated with a type, which is a required argument.  A list is associated with a type, which is a required argument.
Line 1591  and
Line 1668  and
 .Ss \&Ec  .Ss \&Ec
 .Ss \&Ed  .Ss \&Ed
 .Ss \&Ef  .Ss \&Ef
   Ends a font mode context started by
   .Sx \&Bf .
 .Ss \&Ek  .Ss \&Ek
   Ends a keep context started by
   .Sx \&Bk .
 .Ss \&El  .Ss \&El
 Ends a list context started by  Ends a list context started by
 .Sx \&Bl .  .Sx \&Bl .
Line 1879  line itself.
Line 1960  line itself.
 Subsequent this, only the  Subsequent this, only the
 .Sq \&Ta  .Sq \&Ta
 pseudo-macro may be used to delimit phrases.  pseudo-macro may be used to delimit phrases.
 Furthermore, note that quoted sections propogate over tab-delimited  Furthermore, note that quoted sections propagate over tab-delimited
 phrases on an  phrases on an
 .Sx \&It ,  .Sx \&It ,
 for example,  for example,
Line 1940  Examples:
Line 2021  Examples:
 .D1 \&.Mt discuss@manpages.bsd.lv  .D1 \&.Mt discuss@manpages.bsd.lv
 .Ss \&Nd  .Ss \&Nd
 .Ss \&Nm  .Ss \&Nm
   The name of the manual page, or \(em in particular in section 1, 6,
   and 8 pages \(em of an additional command or feature documented in
   the manual page.
   When first invoked, the
   .Sx \&Nm
   macro expects a single argument, the name of the manual page.
   Usually, the first invocation happens in the
   .Em NAME
   section of the page.
   The specified name will be remembered and used whenever the macro is
   called again without arguments later in the page.
   The
   .Sx \&Nm
   macro uses
   .Sx Block full-implicit
   semantics when invoked as the first macro on an input line in the
   .Em SYNOPSIS
   section; otherwise, it uses ordinary
   .Sx In-line
   semantics.
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Sh SYNOPSIS
   \&.Nm cat
   \&.Op Fl benstuv
   \&.Op Ar
   .Ed
   .Pp
   In the
   .Em SYNOPSIS
   of section 2, 3 and 9 manual pages, use the
   .Sx \&Fn
   macro rather than
   .Sx \&Nm
   to mark up the name of the manual page.
 .Ss \&No  .Ss \&No
 .Ss \&Ns  .Ss \&Ns
 .Ss \&Nx  .Ss \&Nx
Line 2169  Heirloom troff, the other significant troff implementa
Line 2286  Heirloom troff, the other significant troff implementa
 .Pp  .Pp
 .Bl -dash -compact  .Bl -dash -compact
 .It  .It
   Old groff fails to assert a newline before
   .Sx \&Bd Fl ragged compact .
   .It
 groff behaves inconsistently when encountering  groff behaves inconsistently when encountering
 .Pf non- Sx \&Fa  .Pf non- Sx \&Fa
 children of  children of
Line 2185  and
Line 2305  and
 .Sx \&Fn  .Sx \&Fn
 in the  in the
 .Em SYNOPSIS :  .Em SYNOPSIS :
 at times newline(s) are suppressed dependong on whether a prior  at times newline(s) are suppressed depending on whether a prior
 .Sx \&Fn  .Sx \&Fn
 has been invoked.  has been invoked.
 In mandoc, this is not the case.  In mandoc, this is not the case.
Line 2243  In quoted literals, groff allowed pair-wise double-quo
Line 2363  In quoted literals, groff allowed pair-wise double-quo
 standalone double-quote in formatted output.  standalone double-quote in formatted output.
 This idiosyncratic behaviour is not applicable in mandoc.  This idiosyncratic behaviour is not applicable in mandoc.
 .It  .It
 Display types  Display offsets
 .Sx \&Bd  .Sx \&Bd
 .Fl center  .Fl offset Ar center
 and  and
 .Fl right  .Fl offset Ar right
 are aliases for  are disregarded in mandoc.
 .Fl left  Furthermore, the
 in manodc.  Furthermore, the  
 .Fl file Ar file  .Fl file Ar file
 argument is ignored.  argument is not supported in mandoc.
 Lastly, since text is not right-justified in mandoc (or even groff),  Lastly, since text is not right-justified in mandoc (or even groff),
 .Fl ragged  .Fl ragged
 and  and
Legend:
Removed from v.1.123  
changed lines
  Added in v.1.130
CVSweb