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

Diff for /mandoc/mandoc.1 between version 1.3 and 1.8

version 1.3, 2009/03/20 15:14:01 version 1.8, 2009/03/23 15:41:09
Line 22 
Line 22 
 .\" SECTION  .\" SECTION
 .Sh NAME  .Sh NAME
 .Nm mandoc  .Nm mandoc
 .Nd format and display BSD manuals  .Nd format and display UNIX manuals
 .\" SECTION  .\" SECTION
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm mandoc  .Nm mandoc
 .Op Fl V  .Op Fl V
 .Op Fl f Ns Ar option...  .Op Fl f Ns Ar option...
   .Op Fl m Ns Ar format
 .Op Fl W Ns Ar err...  .Op Fl W Ns Ar err...
 .Op Fl T Ns Ar output  .Op Fl T Ns Ar output
 .Op Ar infile...  .Op Ar infile...
Line 35 
Line 36 
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm  .Nm
 utility formats a BSD  utility formats
 .Dq mdoc  .Ux
 manual page for display.  The arguments are as follows:  manual pages for display.  The arguments are as follows:
 .Bl -tag -width XXXXXXXXXXXX  .Bl -tag -width XXXXXXXXXXXX
 .\" ITEM  .\" ITEM
 .It Fl f Ns Ar option...  .It Fl f Ns Ar option...
Line 45  Override default compiler behaviour.  See 
Line 46  Override default compiler behaviour.  See 
 .Sx Compiler Options  .Sx Compiler Options
 for details.  for details.
 .\" ITEM  .\" ITEM
   .It Fl m
   Input format.  See
   .Sx Input Formats
   for available formats.  Defaults to
   .Fl m Ns Ar mdoc .
   .\" ITEM
 .It Fl T  .It Fl T
 Output format.  See  Output format.  See
 .Sx Output Formats  .Sx Output Formats
Line 80  will halt with the first failed parse.
Line 87  will halt with the first failed parse.
 .Pp  .Pp
 By default,  By default,
 .Nm  .Nm
 reads from stdin and prints 78-column backspace-encoded output to stdout  reads
 as if  .Xr mdoc 7
   text from stdin, implying
   .Fl m Ns Ar mdoc ,
   and prints 78-column backspace-encoded output to stdout as if
 .Fl T Ns Ar ascii  .Fl T Ns Ar ascii
 were provided.  were provided.
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 .Ex -std mandoc  .Ex -std mandoc
 .\" SUB-SECTION  .\" SUB-SECTION
   .Ss Reserved Words (mdoc only)
   The reserved words described in
   .Xr mdoc 7
   are handled according to the following rules:
   .Bl -enum -offset XXX
   .It
   Opening delimiters
   .Po
   .Sq \&( ,
   .Sq \&[ ,
   and
   .Sq \&{
   .Pc are not followed by whitespace.
   .It
   Closing delimiters
   .Po
   .Sq \&. ,
   .Sq \&, ,
   .Sq \&; ,
   .Sq \&: ,
   .Sq \&? ,
   .Sq \&! ,
   .Sq \&) ,
   .Sq \&]
   and
   .Sq \&}
   .Pc are not preceeded by whitespace.
   .El
   .\" PARAGRAPH
   .Pp
   Note that reserved words only register as such as if they appear as
   standalone tokens, either in parsed lines or streams of text.  Thus, the
   following fragment:
   .Bd -literal -offset XXXX
   this self is not that of the waking , empirically real man
   .Ed
   .\" PARAGRAPH
   .Pp
   \&...correctly adjusts the comma spacing to
   .Dq this self is not that of the waking , empirically real man .
   However, if the comma were part of
   .Dq ,empirically ,
   it would not.
   .\" SUB-SECTION
   .Ss Input Formats
   The
   .Nm
   utility accepts
   .Xr mdoc 7
   and
   .Xr man 7
   input with
   .Fl m Ns Ar mdoc
   and
   .Fl m Ns Ar man ,
   respectively.  The
   .Xr mdoc 7
   format is
   .Em strongly
   recommended;
   .Xr man 7
   should only be used for legacy manuals.
   .Pp
   Note that the
   .Fl m Ns Ar man
   option is experimental and only works with
   .Fl T Ns Ar tree .
   .\" SUB-SECTION
 .Ss Output Formats  .Ss Output Formats
 The  The
 .Nm  .Nm
Line 112  flag.
Line 190  flag.
 .It Fl f Ns Ar ign-scope  .It Fl f Ns Ar ign-scope
 When rewinding the scope of a block macro, forces the compiler to ignore  When rewinding the scope of a block macro, forces the compiler to ignore
 scope violations.  This can seriously mangle the resulting tree.  scope violations.  This can seriously mangle the resulting tree.
   .Pq mdoc only
 .It Fl f Ns Ar ign-escape  .It Fl f Ns Ar ign-escape
 Ignore invalid escape sequences.  Ignore invalid escape sequences.
 .It Fl f Ns Ar ign-macro  .It Fl f Ns Ar ign-macro
Line 145  utility was written by 
Line 224  utility was written by 
 .Sh CAVEATS  .Sh CAVEATS
 The  The
 .Nm  .Nm
 utility doesn't yet know how to display the following:  utility in
   .Fl T Ns Ar ascii
   mode doesn't yet know how to display the following:
 .Pp  .Pp
 .Bl -bullet -compact  .Bl -bullet -compact
 .It  .It
 The \-hang  The \-hang
 .Sq \&Bl  .Sq \&Bl
 list is not yet supported.  list is not yet supported.
 .It  
 The \-literal and \-unfilled  
 .Sq \&Bd  
 displays types are synonyms, as are \-filled and \-ragged.  
 .It  
 The  
 .Sq \&Xo/Xc  
 pair isn't supported.  
 .It  
 The  
 .Sq \&Sm  
 macro has no effect, yet.  
 .El  .El
 .Pp  .Pp
 Other macros still aren't supported by virtue of nobody complaining  Other macros still aren't supported by virtue of nobody complaining
 about their absence.  Please report any omissions: this is a work in  about their absence.  Please report any omissions: this is a work in
 progress.  progress.
   .Pp
   The following list documents differences between traditional
   .Xr nroff 1
   output and
   .Nm :
   .Pp
   .Bl -bullet -compact
   .It
   A list of display following
   .Sq \&Ss
   does not assert a prior vertical break, just as it doesn't with
   .Sq \&Sh .
   .It
   Special characters don't follow the current font style.
   .\" LIST-ITEM
   .It
   The \-literal and \-unfilled
   .Sq \&Bd
   displays types are synonyms, as are \-filled and \-ragged.
   .El
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.8
CVSweb