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

Diff for /mandoc/mandoc.1 between version 1.157 and 1.167

version 1.157, 2015/03/27 21:40:04 version 1.167, 2017/01/06 01:34:57
Line 75  This overrides any earlier
Line 75  This overrides any earlier
 and  and
 .Fl l  .Fl l
 options.  options.
   .It Fl h
   Display only the SYNOPSIS lines.
   Implies
   .Fl c .
 .It Fl I Cm os Ns = Ns Ar name  .It Fl I Cm os Ns = Ns Ar name
 Override the default operating system  Override the default operating system
 .Ar name  .Ar name
Line 85  and for the
Line 89  and for the
 .Xr man 7  .Xr man 7
 .Sq \&TH  .Sq \&TH
 macro.  macro.
 .It Fl h  
 Display only the SYNOPSIS lines.  
 Implies  
 .Fl c .  
 .It Fl K Ar encoding  .It Fl K Ar encoding
 Specify the input encoding.  Specify the input encoding.
 The supported  The supported
Line 284  See
Line 284  See
 .Sx PostScript Output .  .Sx PostScript Output .
 .It Fl T Cm tree  .It Fl T Cm tree
 Produce an indented parse tree.  Produce an indented parse tree.
   See
   .Sx Syntax tree output .
 .It Fl T Cm utf8  .It Fl T Cm utf8
 Encode output in the UTF\-8 multi-byte format.  Encode output in the UTF\-8 multi-byte format.
 See  See
Line 347  Equations rendered from
Line 349  Equations rendered from
 blocks use MathML.  blocks use MathML.
 .Pp  .Pp
 The  The
 .Pa example.style.css  .Pa mandoc.css
 file documents style-sheet classes available for customising output.  file documents style-sheet classes available for customising output.
 If a style-sheet is not specified with  If a style-sheet is not specified with
 .Fl O Cm style ,  .Fl O Cm style ,
Line 490  to force a UTF\-8 locale.
Line 492  to force a UTF\-8 locale.
 See  See
 .Sx Locale Output  .Sx Locale Output
 for details and options.  for details and options.
   .Ss Syntax tree output
   Use
   .Fl T Cm tree
   to show a human readable representation of the syntax tree.
   It is useful for debugging the source code of manual pages.
   The exact format is subject to change, so don't write parsers for it.
   Each output line shows one syntax tree node.
   Child nodes are indented with respect to their parent node.
   The columns are:
   .Pp
   .Bl -enum -compact
   .It
   For macro nodes, the macro name; for text and
   .Xr tbl 7
   nodes, the content.
   There is a special format for
   .Xr eqn 7
   nodes.
   .It
   Node type (text, elem, block, head, body, body-end, tail, tbl, eqn).
   .It
   Flags:
   .Bl -dash -compact
   .It
   An opening parenthesis if the node is an opening delimiter.
   .It
   An asterisk if the node starts a new input line.
   .It
   The input line number (starting at one).
   .It
   A colon.
   .It
   The input column number (starting at one).
   .It
   A closing parenthesis if the node is a closing delimiter.
   .It
   A full stop if the node ends a sentence.
   .El
   .El
 .Sh ENVIRONMENT  .Sh ENVIRONMENT
 .Bl -tag -width MANPAGER  .Bl -tag -width MANPAGER
 .It Ev MANPAGER  .It Ev MANPAGER
Line 502  Specifies the pagination program to use when
Line 543  Specifies the pagination program to use when
 .Ev MANPAGER  .Ev MANPAGER
 is not defined.  is not defined.
 If neither PAGER nor MANPAGER is defined,  If neither PAGER nor MANPAGER is defined,
 .Pa /usr/bin/more Fl s  .Xr more 1
   .Fl s
 will be used.  will be used.
 .El  .El
 .Sh EXIT STATUS  .Sh EXIT STATUS
Line 559  To page manuals to the terminal:
Line 601  To page manuals to the terminal:
 .Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less  .Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less
 .Pp  .Pp
 To produce HTML manuals with  To produce HTML manuals with
 .Ar style.css  .Pa mandoc.css
 as the style-sheet:  as the style-sheet:
 .Pp  .Pp
 .Dl $ mandoc \-T html -O style=style.css mdoc.7 \*(Gt mdoc.7.html  .Dl $ mandoc \-T html -O style=mandoc.css mdoc.7 \*(Gt mdoc.7.html
 .Pp  .Pp
 To check over a large set of manuals:  To check over a large set of manuals:
 .Pp  .Pp
 .Dl $ mandoc \-T lint `find /usr/src -name \e*\e.[1-9]`  .Dl $ mandoc \-T lint \(gafind /usr/src -name \e*\e.[1-9]\(ga
 .Pp  .Pp
 To produce a series of PostScript manuals for A4 paper:  To produce a series of PostScript manuals for A4 paper:
 .Pp  .Pp
Line 933  list block contains text or macros before the first
Line 975  list block contains text or macros before the first
 .Ic \&It  .Ic \&It
 macro.  macro.
 The offending children are moved before the beginning of the list.  The offending children are moved before the beginning of the list.
 .It Sy ".Vt block has child macro"  
 .Pq mdoc  
 The  
 .Ic \&Vt  
 macro supports plain text arguments only.  
 Formatting may be ugly and semantic searching  
 for the affected content might not work.  
 .It Sy "fill mode already enabled, skipping"  .It Sy "fill mode already enabled, skipping"
 .Pq man  .Pq man
 A  A
Line 1112  macro is immediately followed by an
Line 1147  macro is immediately followed by an
 .Ic \&Re  .Ic \&Re
 macro on the next input line.  macro on the next input line.
 Such an empty block does not produce any output.  Such an empty block does not produce any output.
   .It Sy "missing section argument"
   .Pq mdoc
   An
   .Ic \&Xr
   macro lacks its second, section number argument.
   The first argument, i.e. the name, is printed, but without subsequent
   parentheses.
 .It Sy "missing -std argument, adding it"  .It Sy "missing -std argument, adding it"
 .Pq mdoc  .Pq mdoc
 An  An
Line 1565  By requesting the inclusion of a sensitive file, a mal
Line 1607  By requesting the inclusion of a sensitive file, a mal
 might otherwise trick a privileged user into inadvertently displaying  might otherwise trick a privileged user into inadvertently displaying
 the file on the screen, revealing the file content to bystanders.  the file on the screen, revealing the file content to bystanders.
 The argument is ignored including the file name following it.  The argument is ignored including the file name following it.
   .It Sy "skipping display without arguments"
   .Pq mdoc
   A
   .Ic \&Bd
   block macro does not have any arguments.
   The block is discarded, and the block content is displayed in
   whatever mode was active before the block.
 .It Sy "missing list type, using -item"  .It Sy "missing list type, using -item"
 .Pq mdoc  .Pq mdoc
 A  A
Legend:
Removed from v.1.157  
changed lines
  Added in v.1.167
CVSweb