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

Diff for /mandoc/mdoc.7 between version 1.126 and 1.129

version 1.126, 2010/06/12 11:41:50 version 1.129, 2010/07/02 13:07:46
Line 478  they are separated by a vertical space, unless in the 
Line 478  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 685  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 1115  See also
Line 1139  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 1588  and
Line 1667  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 1937  Examples:
Line 2020  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
Legend:
Removed from v.1.126  
changed lines
  Added in v.1.129
CVSweb