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

Diff for /mandoc/mandoc.1 between version 1.180 and 1.193

version 1.180, 2017/03/20 14:32:24 version 1.193, 2017/06/03 12:17:25
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 ac
 .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 mdoc | man  .Op Fl mdoc | man
 .Op Fl O Ar option  .Op Fl O Ar options
 .Op Fl T Ar output  .Op Fl T Ar output
 .Op Fl W Ar level  .Op Fl W Ar level
 .Op Ar  .Op Ar
Line 65  to paginate them.
Line 65  to paginate them.
 This is the default.  This is the default.
 It can be specified to override  It can be specified to override
 .Fl a .  .Fl a .
 .It Fl f  
 A synonym for  
 .Xr whatis 1 .  
 This overrides any earlier  
 .Fl k  
 and  
 .Fl l  
 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 120  sequence, input is interpreted as
Line 108  sequence, input is interpreted as
 Otherwise, input is interpreted as  Otherwise, input is interpreted as
 .Cm iso-8859-1 .  .Cm iso-8859-1 .
 .El  .El
 .It Fl k  
 A synonym for  
 .Xr apropos 1 .  
 This overrides any earlier  
 .Fl f  
 and  
 .Fl l  
 options.  
 .It Fl l  
 A synonym for  
 .Fl a .  
 Also reverts any earlier  
 .Fl f  
 and  
 .Fl k  
 options.  
 .It Fl mdoc | man  .It Fl mdoc | man
 With  With
 .Fl mdoc ,  .Fl mdoc ,
Line 158  parser is used.
Line 130  parser is used.
 With other arguments,  With other arguments,
 .Fl m  .Fl m
 is silently ignored.  is silently ignored.
 .It Fl O Ar option  .It Fl O Ar options
 Comma-separated output options.  Comma-separated output options.
 .It Fl T Ar output  .It Fl T Ar output
 Output format.  Output format.
Line 174  to be reported on the standard error output and to aff
Line 146  to be reported on the standard error output and to aff
 The  The
 .Ar level  .Ar level
 can be  can be
   .Cm style ,
 .Cm warning ,  .Cm warning ,
 .Cm error ,  .Cm error ,
 or  or
 .Cm unsupp ;  .Cm unsupp ;
 .Cm all  .Cm all
 is an alias for  is an alias for
 .Cm warning .  .Cm style .
 By default,  By default,
 .Nm  .Nm
 is silent.  is silent.
Line 211  If multiple files are specified,
Line 184  If multiple files are specified,
 will halt with the first failed parse.  will halt with the first failed parse.
 .El  .El
 .Pp  .Pp
   The options
   .Fl fhklw
   are also supported and are documented in man(1).
 In  In
 .Fl f  .Fl f
 and  and
Line 218  and
Line 194  and
 mode,  mode,
 .Nm  .Nm
 also supports the options  also supports the options
 .Fl CMmOSsw  .Fl CMmOSs
 described in the  described in the
 .Xr apropos 1  .Xr apropos 1
 manual.  manual.
   The options
   .Fl fkl
   are mutually exclusive and override each other.
 .Ss Output Formats  .Ss Output Formats
 The  The
 .Nm  .Nm
Line 240  See
Line 219  See
 .It Fl T Cm lint  .It Fl T Cm lint
 Parse only: produce no output.  Parse only: produce no output.
 Implies  Implies
 .Fl W Cm warning .  .Fl W Cm style .
 .It Fl T Cm locale  .It Fl T Cm locale
 Encode output using the current locale.  Encode output using the current locale.
 This is the default.  This is the default.
Line 274  See
Line 253  See
 Encode output in the UTF\-8 multi-byte format.  Encode output in the UTF\-8 multi-byte format.
 See  See
 .Sx UTF\-8 Output .  .Sx UTF\-8 Output .
 .It Fl T Cm xhtml  
 This is a synonym for  
 .Fl T Cm html .  
 .El  .El
 .Pp  .Pp
 If multiple input files are specified, these will be processed by the  If multiple input files are specified, these will be processed by the
Line 616  option:
Line 592  option:
 .Pp  .Pp
 .Bl -tag -width Ds -compact  .Bl -tag -width Ds -compact
 .It 0  .It 0
 No warnings or errors occurred, or those that did were ignored because  No style suggestions, warnings or errors occurred, or those that
 they were lower than the requested  did were ignored because they were lower than the requested
 .Ar level .  .Ar level .
   .It 1
   At least one style suggestion occurred, but no warning or error, and
   .Fl W Cm style
   was specified.
 .It 2  .It 2
 At least one warning occurred, but no error, and  At least one warning occurred, but no error, and
 .Fl W Cm warning  .Fl W Cm warning
   or
   .Fl W Cm style
 was specified.  was specified.
 .It 3  .It 3
 At least one parsing error occurred,  At least one parsing error occurred,
 but no unsupported feature was encountered, and  but no unsupported feature was encountered, and
 .Fl W Cm error  .Fl W Cm error
 or  or a lower
 .Fl W Cm warning  .Ar level
 was specified.  was requested.
 .It 4  .It 4
 At least one unsupported feature was encountered, and  At least one unsupported feature was encountered, and
 .Fl W Cm unsupp ,  .Fl W Cm unsupp
 .Fl W Cm error  or a lower
 or  .Ar level
 .Fl W Cm warning  was requested.
 was specified.  
 .It 5  .It 5
 Invalid command line arguments were specified.  Invalid command line arguments were specified.
 No input files have been read.  No input files have been read.
Line 651  to exit at once, possibly in the middle of parsing or 
Line 632  to exit at once, possibly in the middle of parsing or 
 Note that selecting  Note that selecting
 .Fl T Cm lint  .Fl T Cm lint
 output mode implies  output mode implies
 .Fl W Cm warning .  .Fl W Cm style .
 .Sh EXAMPLES  .Sh EXAMPLES
 To page manuals to the terminal:  To page manuals to the terminal:
 .Pp  .Pp
 .Dl $ mandoc \-W all,stop mandoc.1 2\*(Gt&1 | less  .Dl $ mandoc -l mandoc.1 man.1 apropos.1 makewhatis.8
 .Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less  
 .Pp  .Pp
 To produce HTML manuals with  To produce HTML manuals with
 .Pa mandoc.css  .Pa mandoc.css
Line 736  rendering can be produced.
Line 716  rendering can be produced.
 Documents causing warnings may render poorly when using other  Documents causing warnings may render poorly when using other
 formatting tools instead of  formatting tools instead of
 .Nm .  .Nm .
   .It Cm style
   An input file uses dubious or discouraged style.
   This is not a complaint about the syntax, and probably neither
   formatting nor portability are in danger.
   While great care is taken to avoid false positives on the higher
   message levels, the
   .Cm style
   level tries to reduce the probability that issues go unnoticed,
   so it may occasionally issue bogus suggestions.
   Please use your good judgement to decide whether any particular
   .Cm style
   suggestion really justifies a change to the input file.
 .El  .El
 .Pp  .Pp
 Messages of the  Messages of the
   .Cm style ,
 .Cm warning ,  .Cm warning ,
 .Cm error ,  .Cm error ,
 and  and
Line 749  are hidden unless their level, or a lower level, is re
Line 742  are hidden unless their level, or a lower level, is re
 option or  option or
 .Fl T Cm lint  .Fl T Cm lint
 output mode.  output mode.
   .Ss Style messages
   .Bl -ohang
   .It Sy "useless macro"
   .Pq mdoc
   A
   .Ic \&Bt ,
   .Ic \&Tn ,
   or
   .Ic \&Ud
   macro was found.
   Simply delete it: it serves no useful purpose.
   .It Sy "consider using OS macro"
   .Pq mdoc
   A string was found in plain text or in a
   .Ic \&Bx
   macro that could be represented using
   .Ic \&Ox ,
   .Ic \&Nx ,
   .Ic \&Fx ,
   or
   .Ic \&Dx .
   .It Sy "description line ends with a full stop"
   .Pq mdoc
   Do not use punctuation at the end of an
   .Ic \&Nd
   block.
   .El
 .Ss Warnings related to the document prologue  .Ss Warnings related to the document prologue
 .Bl -ohang  .Bl -ohang
 .It Sy "missing manual title, using UNTITLED"  .It Sy "missing manual title, using UNTITLED"
Line 1127  or
Line 1147  or
 .Ic \&Bl  .Ic \&Bl
 .Fl offset  .Fl offset
 or  or
 .Fl width.  .Fl width .
 .It Sy "missing display type, using -ragged"  .It Sy "missing display type, using -ragged"
 .Pq mdoc  .Pq mdoc
 The  The
Legend:
Removed from v.1.180  
changed lines
  Added in v.1.193
CVSweb