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

Diff for /mandoc/mandoc.1 between version 1.246 and 1.255

version 1.246, 2020/08/27 14:28:11 version 1.255, 2022/02/08 18:30:22
Line 1 
Line 1 
 .\" $OpenBSD$  .\" $OpenBSD$
 .\"  .\"
 .\" Copyright (c) 2012, 2014-2020 Ingo Schwarze <schwarze@openbsd.org>  .\" Copyright (c) 2012, 2014-2021 Ingo Schwarze <schwarze@openbsd.org>
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>  .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"  .\"
 .\" Permission to use, copy, modify, and distribute this software for any  .\" Permission to use, copy, modify, and distribute this software for any
Line 301  Format
Line 301  Format
 input files in  input files in
 .Xr mdoc 7  .Xr mdoc 7
 output style.  output style.
 Specifically, this suppresses the two additional blank lines near the  This prints the operating system name rather than the page title
 top and the bottom of each page, and it implies  on the right side of the footer line, and it implies
 .Fl O Cm indent Ns =5 .  .Fl O Cm indent Ns =5 .
 One useful application is for checking that  One useful application is for checking that
 .Fl T Cm man  .Fl T Cm man
Line 475  code is not supported.
Line 475  code is not supported.
 .Pp  .Pp
 If the input format of a file is  If the input format of a file is
 .Xr man 7 ,  .Xr man 7 ,
 the input is copied to the output, expanding any  the input is copied to the output.
 .Xr roff 7  
 .Ic so  
 requests.  
 The parser is also run, and as usual, the  The parser is also run, and as usual, the
 .Fl W  .Fl W
 level controls which  level controls which
Line 738  output mode implies
Line 735  output mode implies
 .Sh EXAMPLES  .Sh EXAMPLES
 To page manuals to the terminal:  To page manuals to the terminal:
 .Pp  .Pp
 .Dl $ mandoc -l mandoc.1 man.1 apropos.1 makewhatis.8  .Dl $ mandoc -a mandoc.1 man.1 apropos.1 makewhatis.8
 .Pp  .Pp
 To produce HTML manuals with  To produce HTML manuals with
 .Pa /usr/share/misc/mandoc.css  .Pa /usr/share/misc/mandoc.css
Line 838  message levels, the
Line 835  message levels, the
 .Cm style  .Cm style
 level tries to reduce the probability that issues go unnoticed,  level tries to reduce the probability that issues go unnoticed,
 so it may occasionally issue bogus suggestions.  so it may occasionally issue bogus suggestions.
 Please use your good judgement to decide whether any particular  Use your judgement to decide whether any particular
 .Cm style  .Cm style
 suggestion really justifies a change to the input file.  suggestion really justifies a change to the input file.
 .It Cm base  .It Cm base
Line 925  generated by CVS
Line 922  generated by CVS
 or  or
 .Ic NetBSD  .Ic NetBSD
 keyword substitution as conventionally used in these operating systems.  keyword substitution as conventionally used in these operating systems.
 .It Sy "referenced manual not found"  
 .Pq mdoc  
 An  
 .Ic \&Xr  
 macro references a manual page that is not found in the base system.  
 The path to look for base system manuals is configurable at compile  
 time and defaults to  
 .Pa /usr/share/man : /usr/X11R6/man .  
 .El  .El
 .Ss Style suggestions  .Ss Style suggestions
 .Bl -ohang  .Bl -ohang
Line 1019  list contains two consecutive
Line 1008  list contains two consecutive
 entries describing the same  entries describing the same
 .Ic \&Er  .Ic \&Er
 number.  number.
   .It Sy "referenced manual not found"
   .Pq mdoc
   An
   .Ic \&Xr
   macro references a manual page that was not found.
   When running with
   .Fl W Cm base ,
   the search is restricted to the base system, by default to
   .Pa /usr/share/man : Ns Pa /usr/X11R6/man .
   This path can be configured at compile time using the
   .Dv MANPATH_BASE
   preprocessor macro.
   When running with
   .Fl W Cm style ,
   the search is done along the full search path as described in the
   .Xr man 1
   manual page, respecting the
   .Fl m
   and
   .Fl M
   command line options, the
   .Ev MANPATH
   environment variable, the
   .Xr man.conf 5
   file and falling back to the default of
   .Pa /usr/share/man : Ns Pa /usr/X11R6/man : Ns Pa /usr/local/man ,
   also configurable at compile time using the
   .Dv MANPATH_DEFAULT
   preprocessor macro.
 .It Sy "trailing delimiter"  .It Sy "trailing delimiter"
 .Pq mdoc  .Pq mdoc
 The last argument of an  The last argument of an
Line 1048  An
Line 1066  An
 request occurs even though the document already switched to no-fill mode  request occurs even though the document already switched to no-fill mode
 and did not switch back to fill mode yet.  and did not switch back to fill mode yet.
 It has no effect.  It has no effect.
   .It Sy "input text line longer than 80 bytes"
   Consider breaking the input text line
   at one of the blank characters before column 80.
 .It Sy "verbatim \(dq--\(dq, maybe consider using \e(em"  .It Sy "verbatim \(dq--\(dq, maybe consider using \e(em"
 .Pq mdoc  .Pq mdoc
 Even though the ASCII output device renders an em-dash as  Even though the ASCII output device renders an em-dash as
Line 1853  The invalid character is discarded.
Line 1874  The invalid character is discarded.
 A table layout specification contains an opening parenthesis,  A table layout specification contains an opening parenthesis,
 but no matching closing parenthesis.  but no matching closing parenthesis.
 The rest of the input line, starting from the parenthesis, has no effect.  The rest of the input line, starting from the parenthesis, has no effect.
   .It Sy "ignoring excessive spacing in tbl layout"
   .Pq tbl
   A spacing modifier in a table layout is unreasonably large.
   The default spacing of 3n is used instead.
 .It Sy "tbl without any data cells"  .It Sy "tbl without any data cells"
 .Pq tbl  .Pq tbl
 A table does not contain any data cells.  A table does not contain any data cells.
Line 2289  or
Line 2314  or
 macro or of an undefined macro.  macro or of an undefined macro.
 The macro is ignored, and its arguments are handled  The macro is ignored, and its arguments are handled
 as if they were a text line.  as if they were a text line.
   .It Sy "skipping tbl in -Tman mode"
   .Pq mdoc , tbl
   An input file contains the
   .Ic \&TS
   macro.
   This message is only generated in
   .Fl T Cm man
   output mode, where
   .Xr tbl 7
   input is not supported.
   .It Sy "skipping eqn in -Tman mode"
   .Pq mdoc , eqn
   An input file contains the
   .Ic \&EQ
   macro.
   This message is only generated in
   .Fl T Cm man
   output mode, where
   .Xr eqn 7
   input is not supported.
 .El  .El
 .Ss Bad command line arguments  .Ss Bad command line arguments
 .Bl -ohang  .Bl -ohang
Line 2326  The
Line 2371  The
 .Fl O Cm tag  .Fl O Cm tag
 option was specified but the tag was not found in any of the displayed  option was specified but the tag was not found in any of the displayed
 manual pages.  manual pages.
   .It Sy "\-Tmarkdown unsupported for man(7) input"
   .Pq man
   The
   .Fl T Cm markdown
   option was specified but an input file uses the
   .Xr man 7
   language.
   No output is produced for that input file.
 .El  .El
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr apropos 1 ,  .Xr apropos 1 ,
Legend:
Removed from v.1.246  
changed lines
  Added in v.1.255
CVSweb