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

Diff for /mandoc/mandoc.1 between version 1.25 and 1.26

version 1.25, 2009/07/14 15:57:43 version 1.26, 2009/07/20 13:45:11
Line 34 
Line 34 
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm  .Nm
 utility formats  utility formats
 .Ux  .Ux
 manual pages for display.  The arguments are as follows:  manual pages for display.  The arguments are as follows:
 .Bl -tag -width Ds  .Bl -tag -width Ds
 .\" ITEM  .\" ITEM
 .It Fl f Ns Ar option...  .It Fl f Ns Ar option...
 Override default compiler behaviour.  See  Override default compiler behaviour.  See
 .Sx Compiler Options  .Sx Compiler Options
 for details.  for details.
 .\" ITEM  .\" ITEM
Line 63  Print version and exit.
Line 63  Print version and exit.
 Configure warning messages.  Use  Configure warning messages.  Use
 .Fl W Ns Ar all  .Fl W Ns Ar all
 to print warnings,  to print warnings,
 .Fl W Ns Ar error  .Fl W Ns Ar error
 for warnings to be considered errors and cause utility  for warnings to be considered errors and cause utility
 termination.  Multiple  termination.  Multiple
 .Fl W  .Fl W
 arguments may be comma-separated, such as  arguments may be comma-separated, such as
 .Fl W Ns Ar error,all .  .Fl W Ns Ar error,all .
Line 79  will halt with the first failed parse.
Line 79  will halt with the first failed parse.
 .El  .El
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 By default,  By default,
 .Nm  .Nm
 reads  reads
 .Xr mdoc 7  .Xr mdoc 7
 or  or
 .Xr man 7  .Xr man 7
Line 101  it's processed by
Line 101  it's processed by
 .Nm  .Nm
 according to the following rules:  opening punctuation  according to the following rules:  opening punctuation
 .Po  .Po
 .Sq \&( ,  .Sq \&( ,
 .Sq \&[ ,  .Sq \&[ ,
 and  and
 .Sq \&{  .Sq \&{
 .Pc  .Pc
 is not followed by a space; closing punctuation  is not followed by a space; closing punctuation
 .Po  .Po
 .Sq \&. ,  .Sq \&. ,
 .Sq \&, ,  .Sq \&, ,
 .Sq \&; ,  .Sq \&; ,
 .Sq \&: ,  .Sq \&: ,
 .Sq \&? ,  .Sq \&? ,
 .Sq \&! ,  .Sq \&! ,
 .Sq \&) ,  .Sq \&) ,
 .Sq \&]  .Sq \&]
 and  and
 .Sq \&}  .Sq \&}
 .Pc  .Pc
 is not preceded by whitespace.  is not preceded by whitespace.
 .Pp  .Pp
 If the input is  If the input is
Line 128  these rules are also applied to macro arguments when a
Line 128  these rules are also applied to macro arguments when a
 White-space, in non-literal (normal) mode, is stripped from input and  White-space, in non-literal (normal) mode, is stripped from input and
 replaced on output by a single space.  Thus, if you wish to preserve  replaced on output by a single space.  Thus, if you wish to preserve
 multiple spaces, they must be space-escaped  multiple spaces, they must be space-escaped
 .Sq \e\  .Sq \e\
 or used in a literal display mode, e.g.,  or used in a literal display mode, e.g.,
 .Sq \&.Bd \-literal  .Sq \&.Bd \-literal
 in  in
 .Xr mdoc 7 .  .Xr mdoc 7 .
 .\" SUB-SECTION  .\" SUB-SECTION
 .Ss Input Formats  .Ss Input Formats
Line 149  respectively.  The
Line 149  respectively.  The
 .Xr mdoc 7  .Xr mdoc 7
 format is  format is
 .Em strongly  .Em strongly
 recommended;  recommended;
 .Xr man 7  .Xr man 7
 should only be used for legacy manuals.  should only be used for legacy manuals.
 .Pp  .Pp
 A third option,  A third option,
 .Fl m Ns Ar andoc ,  .Fl m Ns Ar andoc ,
 which is also the default, determines encoding on-the-fly: if the first  which is also the default, determines encoding on-the-fly: if the first
 non-comment macro is  non-comment macro is
 .Sq \&.Dd  .Sq \&.Dd
 or  or
 .Sq \&.Dt ,  .Sq \&.Dt ,
 the  the
 .Xr mdoc 7  .Xr mdoc 7
 parser is used; otherwise, the  parser is used; otherwise, the
 .Xr man 7  .Xr man 7
 parser is used.  parser is used.
 .Pp  .Pp
 If multiple  If multiple
 files are specified with  files are specified with
 .Fl m Ns Ar andoc ,  .Fl m Ns Ar andoc ,
 each has its file-type determined this way.  If multiple files are  each has its file-type determined this way.  If multiple files are
 specified and  specified and
 .Fl m Ns Ar doc  .Fl m Ns Ar doc
Line 222  Do not ignore unknown macros at the start of input lin
Line 222  Do not ignore unknown macros at the start of input lin
 .It Fl f Ns Ar no-ign-chars  .It Fl f Ns Ar no-ign-chars
 Do not ignore disallowed characters.  Do not ignore disallowed characters.
 .It Fl f Ns Ar strict  .It Fl f Ns Ar strict
 Implies  Implies
 .Fl f Ns Ar no-ign-escape ,  .Fl f Ns Ar no-ign-escape ,
 .Fl f Ns Ar no-ign-macro  .Fl f Ns Ar no-ign-macro
 and  and
 .Fl f Ns Ar no-ign-chars .  .Fl f Ns Ar no-ign-chars .
 .El  .El
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
Line 247  To page manuals to the terminal:
Line 247  To page manuals to the terminal:
 .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less  .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less
 .\" SECTION  .\" SECTION
 .Sh COMPATIBILITY  .Sh COMPATIBILITY
 This section summarises  This section summarises
 .Nm  .Nm
 compatibility with  compatibility with
 .Xr groff 1 .  .Xr groff 1 .
 .Pp  .Pp
 .Bl -bullet -compact  .Bl -bullet -compact
 .It  .It
 A list or display following  A list or display following
 .Sq \&.Ss  .Sq \&.Ss
 does not assert a prior vertical break, just as it doesn't with  does not assert a prior vertical break, just as it doesn't with
 .Sq \&.Sh .  .Sq \&.Sh .
 .It  .It
 The \-literal and \-unfilled  The \-literal and \-unfilled
 .Sq \&.Bd  .Sq \&.Bd
 displays types are synonyms, as are \-filled and \-ragged.  displays types are synonyms, as are \-filled and \-ragged.
 .It  .It
Line 278  so double spaces following sentence closure are reduce
Line 278  so double spaces following sentence closure are reduce
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
 utility was written by  utility was written by
 .An Kristaps Dzonsons Aq kristaps@kth.se .  .An Kristaps Dzonsons Aq kristaps@kth.se .

Legend:
Removed from v.1.25  
changed lines
  Added in v.1.26

CVSweb