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

Diff for /mandoc/mandoc.1 between version 1.184 and 1.203

version 1.184, 2017/03/27 18:51:36 version 1.203, 2017/06/24 15:59:50
Line 146  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 base ,
   .Cm style ,
 .Cm warning ,  .Cm warning ,
 .Cm error ,  .Cm error ,
 or  or
 .Cm unsupp ;  .Cm unsupp .
   The
   .Cm base
   level automatically derives the operating system from the contents of the
   .Ic \&Os
   macro, from the
   .Fl Ios
   command line option, or from the
   .Xr uname 3
   return value.
   The levels
   .Cm openbsd
   and
   .Cm netbsd
   are variants of
   .Cm base
   that bypass autodetection and request validation of base system
   conventions for a particular operating system.
   The level
 .Cm all  .Cm all
 is an alias for  is an alias for
 .Cm warning .  .Cm base .
 By default,  By default,
 .Nm  .Nm
 is silent.  is silent.
Line 218  See
Line 238  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 all .
 .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 252  See
Line 272  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 298  Increasing this is not recommended; it may result in d
Line 315  Increasing this is not recommended; it may result in d
 for example overfull lines or ugly line breaks.  for example overfull lines or ugly line breaks.
 .It Cm width Ns = Ns Ar width  .It Cm width Ns = Ns Ar width
 The output width is set to  The output width is set to
 .Ar width ,  .Ar width .
 which will normalise to \(>=58.  
 .El  .El
 .Ss HTML Output  .Ss HTML Output
 Output produced by  Output produced by
Line 594  option:
Line 610  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 base system convention violations, style suggestions, warnings,
 they were lower than the requested  or errors occurred, or those that did were ignored because they
   were lower than the requested
 .Ar level .  .Ar level .
   .It 1
   At least one base system convention violation or style suggestion
   occurred, but no warning or error, and
   .Fl W Cm base
   or
   .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
 was specified.  or a lower
   .Ar level
   was requested.
 .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 629  to exit at once, possibly in the middle of parsing or 
Line 654  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 all .
 .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 663  parser:
Line 687  parser:
 Messages displayed by  Messages displayed by
 .Nm  .Nm
 follow this format:  follow this format:
   .Bd -ragged -offset indent
   .Nm Ns :
   .Ar file : Ns Ar line : Ns Ar column : level : message : macro args
   .Pq Ar os
   .Ed
 .Pp  .Pp
 .D1 Nm Ns : Ar file : Ns Ar line : Ns Ar column : level : message : macro args  
 .Pp  
 Line and column numbers start at 1.  Line and column numbers start at 1.
 Both are omitted for messages referring to an input file as a whole.  Both are omitted for messages referring to an input file as a whole.
 Macro names and arguments are omitted where meaningless.  Macro names and arguments are omitted where meaningless.
   The
   .Ar os
   operating system specifier is omitted for messages that are relevant
   for all operating systems.
 Fatal messages about invalid command line arguments  Fatal messages about invalid command line arguments
 or operating system errors, for example when memory is exhausted,  or operating system errors, for example when memory is exhausted,
 may also omit the  may also omit the
Line 714  rendering can be produced.
Line 745  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.
   .It Cm base
   A convertion used in the base system of a specific operating system
   is not adhered to.
   These are not markup mistakes, and neither the quality of formatting
   nor portability are in danger.
 .El  .El
 .Pp  .Pp
 Messages of the  Messages of the
   .Cm base ,
   .Cm style ,
 .Cm warning ,  .Cm warning ,
 .Cm error ,  .Cm error ,
 and  and
Line 727  are hidden unless their level, or a lower level, is re
Line 777  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.
   .Pp
   As indicated below, all
   .Cm base
   and some
   .Cm style
   checks are only performed if a specific operating system name occurs
   in the arguments of the
   .Fl W
   command line option, of the
   .Ic \&Os
   macro, of the
   .Fl Ios
   command line option, or, if neither are present, in the return value
   of the
   .Xr uname 3
   function.
   .Ss Conventions for base system manuals
   .Bl -ohang
   .It Sy "Mdocdate found"
   .Pq mdoc , Nx
   The
   .Ic \&Dd
   macro uses CVS
   .Ic Mdocdate
   keyword substitution, which is not supported by the
   .Nx
   base system.
   Consider using the conventional
   .Dq "Month dd, yyyy"
   format instead.
   .It Sy "Mdocdate missing"
   .Pq mdoc , Ox
   The
   .Ic \&Dd
   macro does not use CVS
   .Ic Mdocdate
   keyword substitution, but using it is conventionally expected in the
   .Ox
   base system.
   .It Sy "operating system explicitly specified"
   .Pq mdoc , Ox , Nx
   The
   .Ic \&Os
   macro has an argument.
   In the base system, it is conventionally left blank.
   .It Sy "RCS id missing"
   .Pq Ox , Nx
   The manual page lacks the comment line with the RCS identifier
   generated by CVS
   .Ic OpenBSD
   or
   .Ic NetBSD
   keyword substitution as conventionally used in these operating systems.
   .El
   .Ss Style suggestions
   .Bl -ohang
   .It Sy "legacy man(7) date format"
   .Pq mdoc
   The
   .Ic \&Dd
   macro uses the legacy
   .Xr man 7
   date format
   .Dq yyyy-dd-mm .
   Consider using the conventional
   .Xr mdoc 7
   date format
   .Dq "Month dd, yyyy"
   instead.
   .It Sy "duplicate RCS id"
   A single manual page contains two copies of the RCS identifier for
   the same operating system.
   Consider deleting the later instance and moving the first one up
   to the top of the page.
   .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 "errnos out of order"
   .Pq mdoc, Nx
   The
   .Ic \&Er
   items in a
   .Ic \&Bl
   list are not in alphabetical order.
   .It Sy "duplicate errno"
   .Pq mdoc, Nx
   A
   .Ic \&Bl
   list contains two consecutive
   .Ic \&It
   entries describing the same
   .Ic \&Er
   number.
   .It Sy "description line ends with a full stop"
   .Pq mdoc
   Do not use punctuation at the end of an
   .Ic \&Nd
   block.
   .It Sy "no blank before trailing delimiter"
   .Pq mdoc
   The last argument of a macro that supports trailing delimiter
   arguments is longer than one byte and ends with a trailing delimiter.
   Consider inserting a blank such that the delimiter becomes a separate
   argument, thus moving it out of the scope of the macro.
   .It Sy "function name without markup"
   .Pq mdoc
   A word followed by an empty pair of parentheses occurs on a text line.
   Consider using an
   .Ic \&Fn
   or
   .Ic \&Xr
   macro.
   .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 1105  or
Line 1284  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
Line 1327  or
Line 1506  or
 .Ic \&Fn  .Ic \&Fn
 macro contains an opening or closing parenthesis; that's probably wrong,  macro contains an opening or closing parenthesis; that's probably wrong,
 parentheses are added automatically.  parentheses are added automatically.
   .It Sy "unknown library name"
   .Pq mdoc, not on Ox
   An
   .Ic \&Lb
   macro has an unknown name argument and will be rendered as
   .Qq library Dq Ar name .
 .It Sy "invalid content in Rs block"  .It Sy "invalid content in Rs block"
 .Pq mdoc  .Pq mdoc
 An  An
Line 1674  whatever mode was active before the block.
Line 1859  whatever mode was active before the block.
 A  A
 .Ic \&Bl  .Ic \&Bl
 macro fails to specify the list type.  macro fails to specify the list type.
   .It Sy "argument is not numeric, using 1"
   .Pq roff
   The argument of a
   .Ic \&ce
   request is not a number.
 .It Sy "missing manual name, using \(dq\(dq"  .It Sy "missing manual name, using \(dq\(dq"
 .Pq mdoc  .Pq mdoc
 The first call to  The first call to
Legend:
Removed from v.1.184  
changed lines
  Added in v.1.203
CVSweb