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

Diff for /mandoc/mandoc.1 between version 1.16 and 1.21

version 1.16, 2009/04/12 19:45:26 version 1.21, 2009/06/18 08:13:34
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>  .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"  .\"
 .\" 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 37  The
Line 37  The
 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 XXXXXXXXXXXX  .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
 .It Fl m  .It Fl m Ns Ar format
 Input format.  See  Input format.  See
 .Sx Input Formats  .Sx Input Formats
 for available formats.  Defaults to  for available formats.  Defaults to
 .Fl m Ns Ar andoc .  .Fl m Ns Ar andoc .
 .\" ITEM  .\" ITEM
 .It Fl T  .It Fl T Ns Ar output
 Output format.  See  Output format.  See
 .Sx Output Formats  .Sx Output Formats
 for available formats.  Defaults to  for available formats.  Defaults to
Line 188  The
Line 188  The
 utility accepts the following  utility accepts the following
 .Fl T  .Fl T
 arguments:  arguments:
 .Bl -tag -width XXXXXXXXXXXX  .Bl -tag -width Ds
 .It Fl T Ns Ar ascii  .It Fl T Ns Ar ascii
 Produce 7-bit ASCII output, backspace-encoded for bold and underline  Produce 7-bit ASCII output, backspace-encoded for bold and underline
 styles.  This is the default.  styles.  This is the default.
Line 205  corresponding filter in-order.
Line 205  corresponding filter in-order.
 Default compiler behaviour may be overriden with the  Default compiler behaviour may be overriden with the
 .Fl f  .Fl f
 flag.  flag.
 .Bl -tag -width XXXXXXXXXXXXXX  .Bl -tag -width Ds
 .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  .Pq mdoc only
 .It Fl f Ns Ar ign-escape  .It Fl f Ns Ar no-ign-escape
 Ignore invalid escape sequences.  Don't ignore invalid escape sequences.
 .It Fl f Ns Ar ign-macro  
 Ignore unknown macros at the start of input lines (default for  
 .Xr man 7  
 parsing).  
 .It Fl f Ns Ar no-ign-macro  .It Fl f Ns Ar no-ign-macro
 Do not ignore unknown macros at the start of input lines (default for  Do not ignore unknown macros at the start of input lines.
 .Xr mdoc 7  .It Fl f Ns Ar no-ign-chars
 parsing).  Do not ignore disallowed characters.
   .It Fl f Ns Ar strict
   Implies
   .Fl f Ns Ar no-ign-escape ,
   .Fl f Ns Ar no-ign-macro
   and
   .Fl f Ns Ar no-ign-chars .
 .El  .El
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
Line 228  As with the
Line 230  As with the
 flag, multiple  flag, multiple
 .Fl f  .Fl f
 options may be grouped and delimited with a comma.  Using  options may be grouped and delimited with a comma.  Using
 .Fl f Ns Ar ign-scope,ign-escape ,  .Fl f Ns Ar ign-scope,no-ign-escape ,
 for example, will try to ignore scope and character-escape errors.  for example, will try to ignore scope and not ignore character-escape
   errors.
 .\" SECTION  .\" SECTION
 .Sh EXAMPLES  .Sh EXAMPLES
 To page manuals to the terminal:  To page manuals to the terminal:
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 .D1 % mandoc \-Wall,error mandoc.1 2>&1 | less  .D1 % mandoc \-Wall,error \-fstrict mandoc.1 2>&1 | less
 .Pp  
 .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less  .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less
 .\" SECTION  .\" SECTION
   .Sh COMPATIBILITY
   This section summarises
   .Nm
   compatibility with
   .Xr groff 1 .
   .Pp
   .Bl -bullet -compact
   .It
   A list or display following
   .Sq \&.Ss
   does not assert a prior vertical break, just as it doesn't with
   .Sq \&.Sh .
   .\" LIST-ITEM
   .It
   The \-literal and \-unfilled
   .Sq \&.Bd
   displays types are synonyms, as are \-filled and \-ragged.
   .\" LIST-ITEM
   .It
   Words aren't hyphenated.
   .El
   .\" SECTION
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mandoc_char 7 ,  .Xr mandoc_char 7 ,
 .Xr mdoc 7 ,  .Xr mdoc 7 ,
 .Xr man 7  .Xr man 7
 .\"  .\" SECTION
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
 utility was written by  utility was written by
 .An Kristaps Dzonsons Aq kristaps@openbsd.org .  .An Kristaps Dzonsons Aq kristaps@kth.se .
 .\" SECTION  .\" SECTION
 .Sh CAVEATS  .Sh CAVEATS
 The  The
 .Nm  .Nm
 utility in  utility doesn't yet know how to display \-hang lists.
 .Fl T Ns Ar ascii  
 mode doesn't yet know how to display the following:  
 .Pp  .Pp
 .Bl -bullet -compact  
 .It  
 The \-hang  
 .Sq \&.Bl  
 list is not yet supported.  
 .El  
 .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.
 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.16  
changed lines
  Added in v.1.21
CVSweb