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

Diff for /mandoc/mandoc.1 between version 1.178 and 1.182

version 1.178, 2017/03/08 19:40:59 version 1.182, 2017/03/27 14:40:39
Line 20 
Line 20 
 .Os  .Os
 .Sh NAME  .Sh NAME
 .Nm mandoc  .Nm mandoc
 .Nd format and display UNIX manuals  .Nd format manual pages
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm mandoc  .Nm mandoc
 .Op Fl acfhkl  .Op Fl acfhkl
 .Op Fl I Cm os Ns = Ns Ar name  .Op Fl I Cm os Ns = Ns Ar name
 .Op Fl K Ar encoding  .Op Fl K Ar encoding
 .Op Fl m Ns Ar format  .Op Fl mdoc | man
 .Op Fl O Ar option  .Op Fl O Ar option
 .Op Fl T Ar output  .Op Fl T Ar output
 .Op Fl W Ar level  .Op Fl W Ar level
Line 44  reads
Line 44  reads
 .Xr mdoc 7  .Xr mdoc 7
 or  or
 .Xr man 7  .Xr man 7
 text from stdin, implying  text from stdin and produces
 .Fl m Ns Cm andoc ,  
 and produces  
 .Fl T Cm locale  .Fl T Cm locale
 output.  output.
 .Pp  .Pp
Line 70  It can be specified to override
Line 68  It can be specified to override
 .It Fl f  .It Fl f
 A synonym for  A synonym for
 .Xr whatis 1 .  .Xr whatis 1 .
 This overrides any earlier  
 .Fl k  
 and  
 .Fl l  
 options.  
 .It Fl h  .It Fl h
 Display only the SYNOPSIS lines.  Display only the SYNOPSIS lines.
 Implies  Implies
Line 84  Override the default operating system
Line 77  Override the default operating system
 .Ar name  .Ar name
 for the  for the
 .Xr mdoc 7  .Xr mdoc 7
 .Sq \&Os  .Ic \&Os
 and for the  and for the
 .Xr man 7  .Xr man 7
 .Sq \&TH  .Ic \&TH
 macro.  macro.
 .It Fl K Ar encoding  .It Fl K Ar encoding
 Specify the input encoding.  Specify the input encoding.
Line 125  Otherwise, input is interpreted as
Line 118  Otherwise, input is interpreted as
 .It Fl k  .It Fl k
 A synonym for  A synonym for
 .Xr apropos 1 .  .Xr apropos 1 .
 This overrides any earlier  
 .Fl f  
 and  
 .Fl l  
 options.  
 .It Fl l  .It Fl l
 A synonym for  A synonym for
 .Fl a .  .Fl a .
 Also reverts any earlier  .It Fl mdoc | man
 .Fl f  With
 and  .Fl mdoc ,
 .Fl k  all input files are interpreted as
 options.  .Xr mdoc 7 .
 .It Fl m Ns Ar format  With
 Input format.  .Fl man ,
 See  all input files are interpreted as
 .Sx Input Formats  .Xr man 7 .
 for available formats.  By default, the input language is automatically detected for each file:
 Defaults to  if the the first macro is
 .Fl m Ns Cm andoc .  .Ic \&Dd
   or
   .Ic \&Dt ,
   the
   .Xr mdoc 7
   parser is used; otherwise, the
   .Xr man 7
   parser is used.
   With other arguments,
   .Fl m
   is silently ignored.
 .It Fl O Ar option  .It Fl O Ar option
 Comma-separated output options.  Comma-separated output options.
 .It Fl T Ar output  .It Fl T Ar output
Line 209  also supports the options
Line 207  also supports the options
 described in the  described in the
 .Xr apropos 1  .Xr apropos 1
 manual.  manual.
 .Ss Input Formats  The options
 The  .Fl fkl
 .Nm  are mutually exclusive and override each other.
 utility accepts  
 .Xr mdoc 7  
 and  
 .Xr man 7  
 input with  
 .Fl m Ns Cm doc  
 and  
 .Fl m Ns Cm an ,  
 respectively.  
 The  
 .Xr mdoc 7  
 format is  
 .Em strongly  
 recommended;  
 .Xr man 7  
 should only be used for legacy manuals.  
 .Pp  
 A third option,  
 .Fl m Ns Cm andoc ,  
 which is also the default, determines encoding on-the-fly: if the first  
 non-comment macro is  
 .Sq \&Dd  
 or  
 .Sq \&Dt ,  
 the  
 .Xr mdoc 7  
 parser is used; otherwise, the  
 .Xr man 7  
 parser is used.  
 .Pp  
 If multiple  
 files are specified with  
 .Fl m Ns Cm andoc ,  
 each has its file-type determined this way.  
 If multiple files are  
 specified and  
 .Fl m Ns Cm doc  
 or  
 .Fl m Ns Cm an  
 is specified, then this format is used exclusively.  
 .Ss Output Formats  .Ss Output Formats
 The  The
 .Nm  .Nm
Line 391  The string
Line 349  The string
 for example,  for example,
 .Ar ../src/%I.html ,  .Ar ../src/%I.html ,
 is used as a template for linked header files (usually via the  is used as a template for linked header files (usually via the
 .Sq \&In  .Ic \&In
 macro).  macro).
 Instances of  Instances of
 .Sq \&%I  .Sq \&%I
Line 404  The string
Line 362  The string
 for example,  for example,
 .Ar ../html%S/%N.%S.html ,  .Ar ../html%S/%N.%S.html ,
 is used as a template for linked manuals (usually via the  is used as a template for linked manuals (usually via the
 .Sq \&Xr  .Ic \&Xr
 macro).  macro).
 Instances of  Instances of
 .Sq \&%N  .Sq \&%N
Line 450  If the input format is
Line 408  If the input format is
 .Xr man 7 ,  .Xr man 7 ,
 the input is copied to the output, expanding any  the input is copied to the output, expanding any
 .Xr roff 7  .Xr roff 7
 .Sq so  .Ic so
 requests.  requests.
 The parser is also run, and as usual, the  The parser is also run, and as usual, the
 .Fl W  .Fl W
Line 611  Meta data is not available in this case.
Line 569  Meta data is not available in this case.
 .It Ev MANPAGER  .It Ev MANPAGER
 Any non-empty value of the environment variable  Any non-empty value of the environment variable
 .Ev MANPAGER  .Ev MANPAGER
 will be used instead of the standard pagination program,  is used instead of the standard pagination program,
 .Xr more 1 .  .Xr more 1 ;
   see
   .Xr man 1
   for details.
   Only used if
   .Fl a
   or
   .Fl l
   is specified.
 .It Ev PAGER  .It Ev PAGER
 Specifies the pagination program to use when  Specifies the pagination program to use when
 .Ev MANPAGER  .Ev MANPAGER
Line 620  is not defined.
Line 586  is not defined.
 If neither PAGER nor MANPAGER is defined,  If neither PAGER nor MANPAGER is defined,
 .Xr more 1  .Xr more 1
 .Fl s  .Fl s
 will be used.  is used.
   Only used if
   .Fl a
   or
   .Fl l
   is specified.
 .El  .El
 .Sh EXIT STATUS  .Sh EXIT STATUS
 The  The
Legend:
Removed from v.1.178  
changed lines
  Added in v.1.182
CVSweb