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

Annotation of mandoc/mandoc.1, Revision 1.52

1.52    ! kristaps    1: .\"    $Id: mandoc.1,v 1.51 2010/03/22 14:03:03 kristaps Exp $
1.1       kristaps    2: .\"
1.17      kristaps    3: .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1       kristaps    4: .\"
                      5: .\" Permission to use, copy, modify, and distribute this software for any
1.16      kristaps    6: .\" purpose with or without fee is hereby granted, provided that the above
                      7: .\" copyright notice and this permission notice appear in all copies.
1.1       kristaps    8: .\"
1.16      kristaps    9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1       kristaps   16: .\"
1.52    ! kristaps   17: .Dd $Mdocdate: March 22 2010 $
1.14      kristaps   18: .Dt MANDOC 1
1.1       kristaps   19: .Os
1.32      kristaps   20: .
                     21: .
1.1       kristaps   22: .Sh NAME
                     23: .Nm mandoc
1.8       kristaps   24: .Nd format and display UNIX manuals
1.32      kristaps   25: .
                     26: .
1.1       kristaps   27: .Sh SYNOPSIS
                     28: .Nm mandoc
                     29: .Op Fl f Ns Ar option...
1.8       kristaps   30: .Op Fl m Ns Ar format
1.44      kristaps   31: .Op Fl O Ns Ar option...
1.37      kristaps   32: .Op Fl T Ns Ar output
                     33: .Op Fl V
1.1       kristaps   34: .Op Fl W Ns Ar err...
                     35: .Op Ar infile...
1.32      kristaps   36: .
                     37: .
1.1       kristaps   38: .Sh DESCRIPTION
                     39: The
                     40: .Nm
1.26      kristaps   41: utility formats
1.8       kristaps   42: .Ux
                     43: manual pages for display.  The arguments are as follows:
1.32      kristaps   44: .
1.19      kristaps   45: .Bl -tag -width Ds
1.1       kristaps   46: .It Fl f Ns Ar option...
1.37      kristaps   47: Comma-separated compiler options.  See
1.1       kristaps   48: .Sx Compiler Options
                     49: for details.
1.32      kristaps   50: .
1.19      kristaps   51: .It Fl m Ns Ar format
1.8       kristaps   52: Input format.  See
                     53: .Sx Input Formats
                     54: for available formats.  Defaults to
1.12      kristaps   55: .Fl m Ns Ar andoc .
1.32      kristaps   56: .
1.44      kristaps   57: .It Fl O Ns Ar option...
1.37      kristaps   58: Comma-separated output options.  See
                     59: .Sx Output Options
                     60: for details.
                     61: .
1.19      kristaps   62: .It Fl T Ns Ar output
1.1       kristaps   63: Output format.  See
                     64: .Sx Output Formats
                     65: for available formats.  Defaults to
                     66: .Fl T Ns Ar ascii .
1.32      kristaps   67: .
1.1       kristaps   68: .It Fl V
                     69: Print version and exit.
1.32      kristaps   70: .
1.1       kristaps   71: .It Fl W Ns Ar err...
1.37      kristaps   72: Comma-separated warning options.  Use
1.1       kristaps   73: .Fl W Ns Ar all
1.24      kristaps   74: to print warnings,
1.26      kristaps   75: .Fl W Ns Ar error
1.24      kristaps   76: for warnings to be considered errors and cause utility
1.26      kristaps   77: termination.  Multiple
1.1       kristaps   78: .Fl W
                     79: arguments may be comma-separated, such as
                     80: .Fl W Ns Ar error,all .
1.32      kristaps   81: .
1.1       kristaps   82: .It Ar infile...
                     83: Read input from zero or more
                     84: .Ar infile .
1.2       kristaps   85: If unspecified, reads from stdin.  If multiple files are specified,
                     86: .Nm
                     87: will halt with the first failed parse.
1.1       kristaps   88: .El
1.32      kristaps   89: .
1.1       kristaps   90: .Pp
1.26      kristaps   91: By default,
                     92: .Nm
                     93: reads
1.8       kristaps   94: .Xr mdoc 7
1.12      kristaps   95: or
                     96: .Xr man 7
1.8       kristaps   97: text from stdin, implying
1.12      kristaps   98: .Fl m Ns Ar andoc ,
1.48      kristaps   99: and produces
1.1       kristaps  100: .Fl T Ns Ar ascii
1.48      kristaps  101: output.
1.32      kristaps  102: .
1.1       kristaps  103: .Pp
                    104: .Ex -std mandoc
1.32      kristaps  105: .
                    106: .
1.8       kristaps  107: .Ss Input Formats
                    108: The
                    109: .Nm
                    110: utility accepts
                    111: .Xr mdoc 7
                    112: and
                    113: .Xr man 7
                    114: input with
1.10      kristaps  115: .Fl m Ns Ar doc
1.8       kristaps  116: and
1.10      kristaps  117: .Fl m Ns Ar an ,
1.8       kristaps  118: respectively.  The
                    119: .Xr mdoc 7
                    120: format is
                    121: .Em strongly
1.26      kristaps  122: recommended;
1.8       kristaps  123: .Xr man 7
                    124: should only be used for legacy manuals.
1.32      kristaps  125: .
1.11      kristaps  126: .Pp
1.12      kristaps  127: A third option,
                    128: .Fl m Ns Ar andoc ,
1.13      kristaps  129: which is also the default, determines encoding on-the-fly: if the first
1.26      kristaps  130: non-comment macro is
1.27      kristaps  131: .Sq \&Dd
1.13      kristaps  132: or
1.27      kristaps  133: .Sq \&Dt ,
1.26      kristaps  134: the
1.13      kristaps  135: .Xr mdoc 7
                    136: parser is used; otherwise, the
                    137: .Xr man 7
                    138: parser is used.
1.32      kristaps  139: .
1.13      kristaps  140: .Pp
                    141: If multiple
1.26      kristaps  142: files are specified with
                    143: .Fl m Ns Ar andoc ,
1.13      kristaps  144: each has its file-type determined this way.  If multiple files are
                    145: specified and
1.12      kristaps  146: .Fl m Ns Ar doc
                    147: or
                    148: .Fl m Ns Ar an
                    149: is specified, then this format is used exclusively.
1.32      kristaps  150: .
                    151: .
1.1       kristaps  152: .Ss Output Formats
                    153: The
                    154: .Nm
                    155: utility accepts the following
                    156: .Fl T
1.48      kristaps  157: arguments (see
                    158: .Sx OUTPUT ) :
1.32      kristaps  159: .
1.19      kristaps  160: .Bl -tag -width Ds
1.13      kristaps  161: .It Fl T Ns Ar ascii
1.1       kristaps  162: Produce 7-bit ASCII output, backspace-encoded for bold and underline
1.48      kristaps  163: styles.  This is the default.  See
                    164: .Sx ASCII Output .
1.32      kristaps  165: .
1.37      kristaps  166: .It Fl T Ns Ar html
1.48      kristaps  167: Produce strict HTML-4.01 output, with a sane default style.  See
                    168: .Sx HTML Output .
1.37      kristaps  169: .
1.50      kristaps  170: .It Fl T Ns Ar xhtml
                    171: Produce strict XHTML-1.0 output, with a sane default style.  See
                    172: .Sx XHTML Output .
                    173: .
1.13      kristaps  174: .It Fl T Ns Ar tree
1.1       kristaps  175: Produce an indented parse tree.
1.32      kristaps  176: .
1.13      kristaps  177: .It Fl T Ns Ar lint
1.1       kristaps  178: Parse only: produce no output.
1.52    ! kristaps  179: Implies
        !           180: .Fl W Ns Ar all
        !           181: and
        !           182: .Fl f Ns Ar strict .
1.1       kristaps  183: .El
1.32      kristaps  184: .
1.13      kristaps  185: .Pp
                    186: If multiple input files are specified, these will be processed by the
                    187: corresponding filter in-order.
1.32      kristaps  188: .
                    189: .
1.1       kristaps  190: .Ss Compiler Options
1.35      kristaps  191: Default compiler behaviour may be overridden with the
1.1       kristaps  192: .Fl f
                    193: flag.
1.32      kristaps  194: .
1.19      kristaps  195: .Bl -tag -width Ds
1.1       kristaps  196: .It Fl f Ns Ar ign-scope
                    197: When rewinding the scope of a block macro, forces the compiler to ignore
                    198: scope violations.  This can seriously mangle the resulting tree.
1.8       kristaps  199: .Pq mdoc only
1.32      kristaps  200: .
1.45      kristaps  201: .It Fl f Ns Ar ign-escape
                    202: Ignore invalid escape sequences.
                    203: This is the default, but the option can be used to override an earlier
                    204: .Fl f Ns Ar strict .
                    205: .
1.21      kristaps  206: .It Fl f Ns Ar no-ign-escape
                    207: Don't ignore invalid escape sequences.
1.32      kristaps  208: .
1.12      kristaps  209: .It Fl f Ns Ar no-ign-macro
1.21      kristaps  210: Do not ignore unknown macros at the start of input lines.
1.32      kristaps  211: .
1.21      kristaps  212: .It Fl f Ns Ar no-ign-chars
                    213: Do not ignore disallowed characters.
1.32      kristaps  214: .
1.21      kristaps  215: .It Fl f Ns Ar strict
1.26      kristaps  216: Implies
1.21      kristaps  217: .Fl f Ns Ar no-ign-escape ,
1.26      kristaps  218: .Fl f Ns Ar no-ign-macro
1.21      kristaps  219: and
1.26      kristaps  220: .Fl f Ns Ar no-ign-chars .
1.32      kristaps  221: .
1.28      kristaps  222: .It Fl f Ns Ar ign-errors
                    223: Don't halt when encountering parse errors.  Useful with
                    224: .Fl T Ns Ar lint
                    225: over a large set of manuals passed on the command line.
1.1       kristaps  226: .El
1.32      kristaps  227: .
1.48      kristaps  228: .
1.37      kristaps  229: .Ss Output Options
                    230: For the time being, only
                    231: .Fl T Ns Ar html
1.52    ! kristaps  232: and
        !           233: .Fl T Ns Ar xhtml
1.48      kristaps  234: accepts output options:
1.37      kristaps  235: .Bl -tag -width Ds
1.44      kristaps  236: .It Fl O Ns Ar style=style.css
1.37      kristaps  237: The file
                    238: .Ar style.css
                    239: is used for an external style-sheet.  This must be a valid absolute or
                    240: relative URI.
1.44      kristaps  241: .It Fl O Ns Ar includes=fmt
1.40      kristaps  242: The string
                    243: .Ar fmt ,
1.49      kristaps  244: for example,
1.40      kristaps  245: .Ar ../src/%I.html ,
                    246: is used as a template for linked header files (usually via the
                    247: .Sq \&In
                    248: macro).  Instances of
1.43      kristaps  249: .Sq \&%I
1.40      kristaps  250: are replaced with the include filename.  The default is not to present a
                    251: hyperlink.
1.44      kristaps  252: .It Fl O Ns Ar man=fmt
1.39      kristaps  253: The string
                    254: .Ar fmt ,
1.49      kristaps  255: for example,
1.39      kristaps  256: .Ar ../html%S/%N.%S.html ,
                    257: is used as a template for linked manuals (usually via the
1.37      kristaps  258: .Sq \&Xr
1.40      kristaps  259: macro).  Instances of
1.43      kristaps  260: .Sq \&%N
1.40      kristaps  261: and
                    262: .Sq %S
                    263: are replaced with the linked manual's name and section, respectively.
                    264: If no section is included, section 1 is assumed.  The default is not to
                    265: present a hyperlink.
1.37      kristaps  266: .El
1.32      kristaps  267: .
1.48      kristaps  268: .
                    269: .Sh OUTPUT
                    270: This section documents output details of
                    271: .Nm .
                    272: In general, output conforms to the traditional manual style of a header,
1.49      kristaps  273: a body composed of sections and sub-sections, and a footer.
1.48      kristaps  274: .Pp
                    275: The text style of output characters (non-macro characters, punctuation,
                    276: and white-space) is dictated by context.
                    277: .Pp
                    278: White-space is generally stripped from input.  This can be changed with
                    279: character escapes (specified in
                    280: .Xr mandoc_char 7 )
                    281: or literal modes (specified in
                    282: .Xr mdoc 7
                    283: and
                    284: .Xr man 7 ) .
                    285: .Pp
                    286: If non-macro punctuation is set apart from words, such as in the phrase
                    287: .Dq to be \&, or not to be ,
                    288: it's processed by
                    289: .Nm ,
                    290: regardless of output format, according to the following rules:  opening
                    291: punctuation
                    292: .Po
                    293: .Sq \&( ,
                    294: .Sq \&[ ,
                    295: and
                    296: .Sq \&{
                    297: .Pc
                    298: is not followed by a space; closing punctuation
                    299: .Po
                    300: .Sq \&. ,
                    301: .Sq \&, ,
                    302: .Sq \&; ,
                    303: .Sq \&: ,
                    304: .Sq \&? ,
                    305: .Sq \&! ,
                    306: .Sq \&) ,
                    307: .Sq \&]
                    308: and
                    309: .Sq \&}
                    310: .Pc
                    311: is not preceded by white-space.
                    312: .
                    313: .Pp
                    314: If the input is
                    315: .Xr mdoc 7 ,
                    316: however, these rules are also applied to macro arguments when appropriate.
                    317: .
                    318: .
                    319: .Ss ASCII Output
1.49      kristaps  320: Output produced by
1.48      kristaps  321: .Fl T Ns Ar ascii ,
                    322: which is the default, is rendered in standard 7-bit ASCII documented in
                    323: .Xr ascii 7 .
                    324: .Pp
                    325: Font styles are applied by using back-spaced encoding such that an
                    326: underlined character
                    327: .Sq c
                    328: is rendered as
                    329: .Sq _ Ns \e[bs] Ns c ,
                    330: where
                    331: .Sq \e[bs]
                    332: is the back-space character number 8.  Emboldened characters are rendered as
                    333: .Sq c Ns \e[bs] Ns c .
                    334: .Pp
                    335: The special characters documented in
                    336: .Xr mandoc_char 7
                    337: are rendered best-effort in an ASCII equivalent.
                    338: .Pp
                    339: Output width is limited to 78 visible columns unless literal input lines
                    340: exceed this limit.
                    341: .
                    342: .
                    343: .Ss HTML Output
                    344: Output produced by
                    345: .Fl T Ns Ar html
1.50      kristaps  346: conforms to HTML-4.01 strict.
1.48      kristaps  347: .Pp
                    348: Font styles and page structure are applied using CSS2.  By default, no
                    349: font style is applied to any text, although CSS2 is hard-coded to format
                    350: the basic structure of output.
                    351: .Pp
                    352: The
                    353: .Pa example.style.css
                    354: file documents the range of styles applied to output and, if used, will
                    355: cause rendered documents to appear as they do in
                    356: .Fl T Ns Ar ascii .
                    357: .Pp
                    358: Special characters are rendered in decimal-encoded UTF-8.
                    359: .
                    360: .
1.50      kristaps  361: .Ss XHTML Output
                    362: Output produced by
                    363: .Fl T Ns Ar xhtml
                    364: conforms to XHTML-1.0 strict.
                    365: .Pp
                    366: See
                    367: .Sx HTML Output
                    368: for details; beyond generating XHTML tags instead of HTML tags, these
                    369: output modes are identical.
                    370: .
                    371: .
1.1       kristaps  372: .Sh EXAMPLES
1.13      kristaps  373: To page manuals to the terminal:
1.32      kristaps  374: .
1.1       kristaps  375: .Pp
1.21      kristaps  376: .D1 % mandoc \-Wall,error \-fstrict mandoc.1 2>&1 | less
1.13      kristaps  377: .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less
1.32      kristaps  378: .
1.28      kristaps  379: .Pp
1.41      kristaps  380: To produce HTML manuals with
                    381: .Ar style.css
                    382: as the style-sheet:
1.38      kristaps  383: .Pp
1.48      kristaps  384: .D1 % mandoc \-Thtml -Ostyle=style.css mdoc.7 > mdoc.7.html
1.38      kristaps  385: .Pp
1.28      kristaps  386: To check over a large set of manuals:
1.32      kristaps  387: .
1.28      kristaps  388: .Pp
                    389: .Dl % mandoc \-Tlint \-fign-errors `find /usr/src -name \e*\e.[1-9]`
1.32      kristaps  390: .
                    391: .
1.20      kristaps  392: .Sh COMPATIBILITY
1.26      kristaps  393: This section summarises
1.20      kristaps  394: .Nm
1.26      kristaps  395: compatibility with
1.20      kristaps  396: .Xr groff 1 .
1.32      kristaps  397: Each input and output format is separately noted.
                    398: .
                    399: .
1.48      kristaps  400: .Ss ASCII Compatibility
1.37      kristaps  401: .Bl -bullet -compact
1.29      kristaps  402: .It
1.49      kristaps  403: The
1.29      kristaps  404: .Sq \e~
1.49      kristaps  405: special character doesn't produce expected behaviour in
1.32      kristaps  406: .Fl T Ns Ar ascii .
                    407: .
                    408: .It
1.49      kristaps  409: The
1.33      kristaps  410: .Sq \&Bd \-literal
1.49      kristaps  411: and
1.32      kristaps  412: .Sq \&Bd \-unfilled
                    413: macros of
                    414: .Xr mdoc 7
                    415: in
                    416: .Fl T Ns Ar ascii
                    417: are synonyms, as are \-filled and \-ragged.
                    418: .
1.26      kristaps  419: .It
1.49      kristaps  420: In
1.27      kristaps  421: .Xr groff 1 ,
                    422: the
                    423: .Sq \&Pa
1.32      kristaps  424: .Xr mdoc 7
                    425: macro does not underline when scoped under an
1.30      kristaps  426: .Sq \&It
                    427: in the FILES section.  This behaves correctly in
1.27      kristaps  428: .Nm .
1.32      kristaps  429: .
1.27      kristaps  430: .It
1.20      kristaps  431: A list or display following
1.27      kristaps  432: .Sq \&Ss
1.32      kristaps  433: .Xr mdoc 7
                    434: macro in
                    435: .Fl T Ns Ar ascii
1.20      kristaps  436: does not assert a prior vertical break, just as it doesn't with
1.27      kristaps  437: .Sq \&Sh .
1.32      kristaps  438: .
1.20      kristaps  439: .It
1.32      kristaps  440: The
                    441: .Sq \&na
                    442: .Xr man 7
1.34      kristaps  443: macro in
1.32      kristaps  444: .Fl T Ns Ar ascii
1.34      kristaps  445: has no effect.
1.32      kristaps  446: .
1.20      kristaps  447: .It
                    448: Words aren't hyphenated.
1.32      kristaps  449: .
1.22      kristaps  450: .It
                    451: In normal mode (not a literal block), blocks of spaces aren't preserved,
1.32      kristaps  452: so double spaces following sentence closure are reduced to a single space;
                    453: .Xr groff 1
                    454: retains spaces.
                    455: .
                    456: .It
                    457: Sentences are unilaterally monospaced.
1.20      kristaps  458: .El
1.42      kristaps  459: .
1.48      kristaps  460: .
1.50      kristaps  461: .Ss HTML/XHTML Compatibility
1.42      kristaps  462: .Bl -bullet -compact
                    463: .It
                    464: The
1.47      kristaps  465: .Sq \efP
                    466: escape will revert the font to the previous
                    467: .Sq \ef
                    468: escape, not to the last rendered decoration, which is now dictated by
                    469: CSS instead of hard-coded.  It also will not span past the current
1.49      kristaps  470: scope, for the same reason.  Note that in
1.47      kristaps  471: .Sx ASCII Output
                    472: mode, this will work fine.
                    473: .It
                    474: The
1.42      kristaps  475: .Xr mdoc 7
                    476: .Sq \&Bl \-hang
                    477: and
                    478: .Sq \&Bl \-tag
                    479: list types render similarly (no break following overreached left-hand
                    480: side) due to the expressive constraints of HTML.
                    481: .
                    482: .It
                    483: The
                    484: .Xr man 7
                    485: .Sq IP
                    486: and
                    487: .Sq TP
                    488: lists render similarly.
                    489: .El
1.48      kristaps  490: .
                    491: .
1.1       kristaps  492: .Sh SEE ALSO
1.13      kristaps  493: .Xr mandoc_char 7 ,
1.9       kristaps  494: .Xr mdoc 7 ,
                    495: .Xr man 7
1.39      kristaps  496: .
1.1       kristaps  497: .Sh AUTHORS
                    498: The
                    499: .Nm
1.26      kristaps  500: utility was written by
1.18      kristaps  501: .An Kristaps Dzonsons Aq kristaps@kth.se .
1.39      kristaps  502: .
1.48      kristaps  503: .
1.39      kristaps  504: .Sh CAVEATS
1.48      kristaps  505: The
                    506: .Fl T Ns Ar html
1.50      kristaps  507: and
                    508: .Fl T Ns Ar xhtml
1.48      kristaps  509: CSS2 styling used for
                    510: .Fl m Ns Ar doc
1.51      kristaps  511: input lists does not render properly in older browsers, such as Internet
                    512: Explorer 6 and earlier.
1.48      kristaps  513: .Pp
1.39      kristaps  514: In
1.50      kristaps  515: .Fl T Ns Ar html
                    516: and
                    517: .Fl T Ns Ar xhtml ,
1.39      kristaps  518: the maximum size of an element attribute is determined by
                    519: .Dv BUFSIZ ,
                    520: which is usually 1024 bytes.  Be aware of this when setting long link
1.48      kristaps  521: formats, e.g.,
                    522: .Fl O Ns Ar style=really/long/link .
1.46      kristaps  523: .Pp
                    524: The
                    525: .Fl T Ns Ar html
1.50      kristaps  526: and
                    527: .Fl T Ns Ar xhtml
                    528: output modes don't render the
1.46      kristaps  529: .Sq \es
1.47      kristaps  530: font size escape documented in
1.46      kristaps  531: .Xr mdoc 7
                    532: and
                    533: .Xr man 7 .
1.51      kristaps  534: .Pp
                    535: Nesting elements within next-line element scopes of
1.52    ! kristaps  536: .Fl m Ns Ar an ,
1.51      kristaps  537: such as
                    538: .Sq br
                    539: within an empty
                    540: .Sq B ,
                    541: will confuse
                    542: .Fl T Ns Ar html
                    543: and
                    544: .Fl T Ns Ar xhtml
1.52    ! kristaps  545: and cause them to forget the formatting of the prior next-line scope.

CVSweb