Annotation of mandoc/mandoc.1, Revision 1.1
1.1 ! kristaps 1: .\" $Id: mdocterm.1,v 1.26 2009/03/19 11:49:00 kristaps Exp $
! 2: .\"
! 3: .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>
! 4: .\"
! 5: .\" Permission to use, copy, modify, and distribute this software for any
! 6: .\" purpose with or without fee is hereby granted, provided that the
! 7: .\" above copyright notice and this permission notice appear in all
! 8: .\" copies.
! 9: .\"
! 10: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
! 11: .\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
! 12: .\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
! 13: .\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
! 14: .\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
! 15: .\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
! 16: .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
! 17: .\" PERFORMANCE OF THIS SOFTWARE.
! 18: .\"
! 19: .Dd $Mdocdate$
! 20: .Dt mandoc 1
! 21: .Os
! 22: .\" SECTION
! 23: .Sh NAME
! 24: .Nm mandoc
! 25: .Nd format and display BSD manuals
! 26: .\" SECTION
! 27: .Sh SYNOPSIS
! 28: .Nm mandoc
! 29: .Op Fl V
! 30: .Op Fl f Ns Ar option...
! 31: .Op Fl W Ns Ar err...
! 32: .Op Fl T Ns Ar output
! 33: .Op Ar infile...
! 34: .\" SECTION
! 35: .Sh DESCRIPTION
! 36: The
! 37: .Nm
! 38: utility formats a BSD
! 39: .Dq mdoc
! 40: manual page for display. The arguments are as follows:
! 41: .Bl -tag -width XXXXXXXXXXXX
! 42: .\" ITEM
! 43: .It Fl f Ns Ar option...
! 44: Override default compiler behaviour. See
! 45: .Sx Compiler Options
! 46: for details.
! 47: .\" ITEM
! 48: .It Fl T
! 49: Output format. See
! 50: .Sx Output Formats
! 51: for available formats. Defaults to
! 52: .Fl T Ns Ar ascii .
! 53: .\" ITEM
! 54: .It Fl V
! 55: Print version and exit.
! 56: .\" ITEM
! 57: .It Fl W Ns Ar err...
! 58: Print warning messages. May be set to
! 59: .Fl W Ns Ar all
! 60: for all warnings,
! 61: .Ar compat
! 62: for groff/troff-compatibility warnings, or
! 63: .Ar syntax
! 64: for syntax warnings. If
! 65: .Fl W Ns Ar error
! 66: is specified, warnings are considered errors and cause utility
! 67: termination. Multiple
! 68: .Fl W
! 69: arguments may be comma-separated, such as
! 70: .Fl W Ns Ar error,all .
! 71: .\" ITEM
! 72: .It Ar infile...
! 73: Read input from zero or more
! 74: .Ar infile .
! 75: If unspecified, reads from stdin.
! 76: .El
! 77: .\" PARAGRAPH
! 78: .Pp
! 79: By default,
! 80: .Nm
! 81: reads from stdin and prints 78-column backspace-encoded output to stdout
! 82: as if
! 83: .Fl T Ns Ar ascii
! 84: were provided.
! 85: .\" PARAGRAPH
! 86: .Pp
! 87: .Ex -std mandoc
! 88: .\" SUB-SECTION
! 89: .Ss Output Formats
! 90: The
! 91: .Nm
! 92: utility accepts the following
! 93: .Fl T
! 94: arguments:
! 95: .Bl -tag -width XXXXXXXXXXXX -offset XXXX
! 96: .It Ar ascii
! 97: Produce 7-bit ASCII output, backspace-encoded for bold and underline
! 98: styles. This is the default.
! 99: .It Ar tree
! 100: Produce an indented parse tree.
! 101: .It Ar lint
! 102: Parse only: produce no output.
! 103: .El
! 104: .\" SUB-SECTION
! 105: .Ss Compiler Options
! 106: Default compiler behaviour may be overriden with the
! 107: .Fl f
! 108: flag.
! 109: .Bl -tag -width XXXXXXXXXXXX -offset XXXX
! 110: .It Fl f Ns Ar ign-scope
! 111: When rewinding the scope of a block macro, forces the compiler to ignore
! 112: scope violations. This can seriously mangle the resulting tree.
! 113: .It Fl f Ns Ar ign-escape
! 114: Ignore invalid escape sequences.
! 115: .It Fl f Ns Ar ign-macro
! 116: Ignore unknown macros at the start of input lines.
! 117: .El
! 118: .\" PARAGRAPH
! 119: .Pp
! 120: As with the
! 121: .Fl W
! 122: flag, multiple
! 123: .Fl f
! 124: options may be grouped and delimited with a comma. Using
! 125: .Fl f Ns Ar ign-scope,ign-escape ,
! 126: for example, will try to ignore scope and character-escape errors.
! 127: .\" SECTION
! 128: .Sh EXAMPLES
! 129: To page this manual page on the terminal:
! 130: .\" PARAGRAPH
! 131: .Pp
! 132: .D1 % mandoc \-Wall,error mandoc.1 2>&1 | less
! 133: .\" SECTION
! 134: .Sh SEE ALSO
! 135: .Xr mdoc 7
! 136: .\"
! 137: .Sh AUTHORS
! 138: The
! 139: .Nm
! 140: utility was written by
! 141: .An Kristaps Dzonsons Aq kristaps@openbsd.org .
! 142: .\" SECTION
! 143: .Sh CAVEATS
! 144: The
! 145: .Nm
! 146: utility doesn't yet know how to display the following:
! 147: .Pp
! 148: .Bl -bullet -compact
! 149: .It
! 150: The \-hang
! 151: .Sq \&Bl
! 152: list is not yet supported.
! 153: .It
! 154: The \-literal and \-unfilled
! 155: .Sq \&Bd
! 156: displays only accept text contents.
! 157: .It
! 158: The
! 159: .Sq \&Xo/Xc
! 160: pair isn't supported.
! 161: .It
! 162: The
! 163: .Sq \&Sm
! 164: macro has no effect, yet.
! 165: .El
! 166: .Pp
! 167: Other macros still aren't supported by virtue of nobody complaining
! 168: about their absence. Please report any omissions: this is a work in
! 169: progress.
CVSweb