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

Diff for /mandoc/mdoc.7 between version 1.131 and 1.135

version 1.131, 2010/07/05 13:12:32 version 1.135, 2010/07/16 21:09:39
Line 52  manuals must have
Line 52  manuals must have
 line terminators.  line terminators.
 .Ss Comments  .Ss Comments
 Text following a  Text following a
 .Sq \e" ,  .Sq \e\*q ,
 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\*q ,
 is also ignored.  Macro lines with only a control character 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
Line 1178  See also
Line 1178  See also
 and  and
 .Sx \&Sy .  .Sx \&Sy .
 .Ss \&Bk  .Ss \&Bk
 Begins a keep block, containing a collection of macros or text  Begins a collection of macros or text not breaking the line.
 to be kept together in the output.  
 Its syntax is as follows:  Its syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. Sx \&Bk Fl words  .D1 Pf \. Sx \&Bk Fl words
 .Pp  .Pp
 Currently, the only argument implemented is  
 .Fl words ,  
 requesting to keep together all words of the contained text  
 on the same output line.  
 Subsequent arguments are ignored.  Subsequent arguments are ignored.
   The
   .Fl words
   argument is required.
 .Pp  .Pp
 Examples:  Each line within a keep block is kept intact, so the following example
   will not break within each
   .Sx \&Op
   macro line:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Bk \-words  \&.Bk \-words
 \&.Op o Ar output_file  \&.Op Fl f Ar flags
   \&.Op Fl o Ar output
 \&.Ek  \&.Ek
 .Ed  .Ed
 .Pp  .Pp
 See also  Be careful in using over-long lines within a keep block!
 .Sx \&Ek .  Doing so will clobber the right margin.
 .Ss \&Bl  .Ss \&Bl
 Begins a list composed of one or more list entries.  Begins a list composed of one or more list entries.
 Its syntax is as follows:  Its syntax is as follows:
Line 1716  Examples:
Line 1718  Examples:
 .D1 \&.Em Warnings!  .D1 \&.Em Warnings!
 .D1 \&.Em Remarks :  .D1 \&.Em Remarks :
 .Ss \&En  .Ss \&En
   This macro is obsolete and not implemented.
 .Ss \&Eo  .Ss \&Eo
 An arbitrary enclosure.  An arbitrary enclosure.
 Its syntax is as follows:  Its syntax is as follows:
Line 1737  Examples:
Line 1740  Examples:
 See also  See also
 .Sx \&Dv .  .Sx \&Dv .
 .Ss \&Es  .Ss \&Es
   This macro is obsolete and not implemented.
 .Ss \&Ev  .Ss \&Ev
 Environmental variables such as those specified in  Environmental variables such as those specified in
 .Xr environ 7 .  .Xr environ 7 .
Line 1910  See also
Line 1914  See also
 and  and
 .Sx \&Ux .  .Sx \&Ux .
 .Ss \&Hf  .Ss \&Hf
   This macro is obsolete and not implemented.
 .Ss \&Ic  .Ss \&Ic
   Designate an internal or interactive command.
   This is similar to
   .Sx \&Cm
   but used for instructions rather than values.
   .Pp
   Examples:
   .D1 \&.Ic hash
   .D1 \&.Ic alias
   .Pp
   Note that using
   .Sx \&Bd No Fl literal
   or
   .Sx \&D1
   is preferred for displaying code; the
   .Sx \&Ic
   macro is used when referring to specific instructions.
 .Ss \&In  .Ss \&In
 An  An
 .Qq include  .Qq include
Line 2049  Examples:
Line 2070  Examples:
 See also  See also
 .Sx \&Mt .  .Sx \&Mt .
 .Ss \&Lp  .Ss \&Lp
   Synonym for
   .Sx \&Pp .
 .Ss \&Ms  .Ss \&Ms
 .Ss \&Mt  .Ss \&Mt
 Format a  Format a
Line 2061  Its syntax is as follows:
Line 2084  Its syntax is as follows:
 Examples:  Examples:
 .D1 \&.Mt discuss@manpages.bsd.lv  .D1 \&.Mt discuss@manpages.bsd.lv
 .Ss \&Nd  .Ss \&Nd
   A one-line description of the manual's content.
   This may only be invoked in the
   .Em SYNOPSIS
   section subsequent the
   .Sx \&Nm
   macro.
   .Pp
   Examples:
   .D1 \&.Sx \&Nd mdoc language reference
   .D1 \&.Sx \&Nd format and display UNIX manuals
   .Pp
   The
   .Sx \&Nd
   macro technically accepts child macros and terminates with a subsequent
   .Sx \&Sh
   invocation.
   Do not assume this behaviour: some
   .Xr whatis 1
   database generators are not smart enough to parse more than the line
   arguments and will display macros verbatim.
   .Pp
   See also
   .Sx \&Nm .
 .Ss \&Nm  .Ss \&Nm
 The name of the manual page, or \(em in particular in section 1, 6,  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  and 8 pages \(em of an additional command or feature documented in
Line 2099  macro rather than
Line 2145  macro rather than
 .Sx \&Nm  .Sx \&Nm
 to mark up the name of the manual page.  to mark up the name of the manual page.
 .Ss \&No  .Ss \&No
   A
   .Qq noop
   macro used to terminate prior macro contexts.
   .Pp
   Examples:
   .D1 \&.Sx \&Fl ab \&No cd \&Fl ef
 .Ss \&Ns  .Ss \&Ns
 .Ss \&Nx  .Ss \&Nx
 Format the NetBSD version provided as an argument, or a default value if  Format the NetBSD version provided as an argument, or a default value if
Line 2118  See also
Line 2170  See also
 and  and
 .Sx \&Ux .  .Sx \&Ux .
 .Ss \&Oc  .Ss \&Oc
   Closes multi-line
   .Sx \&Oo
   context.
 .Ss \&Oo  .Ss \&Oo
   Multi-line version of
   .Sx \&Op .
   .Pp
   Examples:
   .Bd -literal -offset indent
   \&.Oo
   \&.Op Fl flag Ns Ar value
   \&.Oc
   .Ed
 .Ss \&Op  .Ss \&Op
   Command-line option.
   Used when listing options to command-line utilities.
   Prints the argument(s) in brackets.
   .Pp
   Examples:
   .D1 \&.Op \&Fl a \&Ar b
   .D1 \&.Op \&Ar a | b
   .Pp
   See also
   .Sx \&Oo .
 .Ss \&Os  .Ss \&Os
 Document operating system version.  Document operating system version.
 This is the mandatory third macro of  This is the mandatory third macro of
Line 2168  See also
Line 2242  See also
 and  and
 .Sx \&Ux .  .Sx \&Ux .
 .Ss \&Pa  .Ss \&Pa
   A file-system path.
   .Pp
   Examples:
   .D1 \&.Pa /usr/bin/mandoc
   .D1 \&.Pa /usr/share/man/man7/mdoc.7
   .Pp
   See also
   .Sx \&Lk .
 .Ss \&Pc  .Ss \&Pc
   Close parenthesised context opened by
   .Sx \&Po .
 .Ss \&Pf  .Ss \&Pf
   Removes the space
   .Pq Qq prefix
   between its arguments.
   Its syntax is as follows:
   .Pp
   .D1 Pf \. \&Pf Cm prefix suffix
   .Pp
   The
   .Cm suffix
   argument may be a macro.
   .Pp
   Examples:
   .D1 \&.Pf \e. \&Sx \&Pf \&Cm prefix suffix
 .Ss \&Po  .Ss \&Po
   Multi-line version of
   .Sx \&Pq .
 .Ss \&Pp  .Ss \&Pp
   Break a paragraph.
   This will assert vertical space between prior and subsequent macros
   and/or text.
 .Ss \&Pq  .Ss \&Pq
   Parenthesised enclosure.
   .Pp
   See also
   .Sx \&Po .
 .Ss \&Qc  .Ss \&Qc
 .Ss \&Ql  .Ss \&Ql
 .Ss \&Qo  .Ss \&Qo
Line 2226  line.
Line 2332  line.
 .Ss \&Sc  .Ss \&Sc
 .Ss \&Sh  .Ss \&Sh
 .Ss \&Sm  .Ss \&Sm
   Switches the spacing mode for output generated from macros.
   Its syntax is as follows:
   .Pp
   .D1 Pf \. Sx \&Sm Cm on | off
   .Pp
   By default, spacing is
   .Cm on .
   When switched
   .Cm off ,
   no white space is inserted between macro arguments and between the
   output generated from adjacent macros, but free-form text lines
   still get normal spacing between words and sentences.
 .Ss \&So  .Ss \&So
 .Ss \&Sq  .Ss \&Sq
 .Ss \&Ss  .Ss \&Ss
Line 2253  See also
Line 2371  See also
 and  and
 .Sx \&Ox .  .Sx \&Ox .
 .Ss \&Va  .Ss \&Va
   A variable name.
   .Pp
   Examples:
   .D1 \&.Va foo
   .D1 \&.Va const char *bar ;
 .Ss \&Vt  .Ss \&Vt
 A variable type.  A variable type.
 This is also used for indicating global variables in the  This is also used for indicating global variables in the
Legend:
Removed from v.1.131  
changed lines
  Added in v.1.135
CVSweb