diff options
Diffstat (limited to 'mdoctree.1')
| -rw-r--r-- | mdoctree.1 | 162 |
1 files changed, 0 insertions, 162 deletions
diff --git a/mdoctree.1 b/mdoctree.1 deleted file mode 100644 index e9dbaf62..00000000 --- a/mdoctree.1 +++ /dev/null @@ -1,162 +0,0 @@ -.\" $Id: mdoctree.1,v 1.7 2009/03/16 23:37:28 kristaps Exp $ -.\" -.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org> -.\" -.\" Permission to use, copy, modify, and distribute this software for any -.\" purpose with or without fee is hereby granted, provided that the -.\" above copyright notice and this permission notice appear in all -.\" copies. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL -.\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED -.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE -.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL -.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR -.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER -.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR -.\" PERFORMANCE OF THIS SOFTWARE. -.\" -.Dd $Mdocdate: March 16 2009 $ -.Dt mdoctree 1 -.Os -.\" SECTION -.Sh NAME -.Nm mdoctree -.Nd mdoc macro compiler -.\" SECTION -.Sh SYNOPSIS -.Nm mdoctree -.Op Fl vV -.Op Fl f Ns Ar options... -.Op Fl W Ns Ar err... -.Op Ar infile -.\" SECTION -.Sh DESCRIPTION -The -.Nm -utility parses a BSD -.Dq mdoc -manual pages and prints its syntax tree. It's commonly used to see the -syntax tree of a document when building new -.Xr mdoc 3 -utilities. The arguments are as follows: -.Bl -tag -width XXXXXXXXXXXX -.\" ITEM -.It Fl v -Print verbose parsing output. -.\" ITEM -.It Fl V -Print version and exit. -.\" ITEM -.It Fl f Ns Ar option... -Override default compiler behaviour. See -.Sx Compiler Options -for details. -.\" ITEM -.It Fl W Ns Ar err... -Print warning messages. May be set to -.Fl W Ns Ar all -for all warnings, -.Ar compat -for groff/troff-compatibility warnings, or -.Ar syntax -for syntax warnings. If -.Fl W Ns Ar error -is specified, warnings are considered errors and cause utility -termination. Multiple -.Fl W -arguments may be comma-separated, such as -.Fl W Ns Ar error,all . -.\" ITEM -.It Ar infile -Read input from -.Ar infile , -which may be -.Dq \- -for stdin. -.El -.\" PARAGRAPH -.Pp -The -.Nm -utility is a formatting front-end for -.Xr mdoc 3 , -which parses the -.Dq mdoc -input, documented at -.Xr mdoc 7 -and -.Xr mdoc.samples 7 , -into an abstract syntax tree. By default, it reads from stdin and -prints the syntax tree to stdout. -.\" PARAGRAPH -.Pp -.Ex -std mdoctree -.\" SUB-SECTION -.Ss Compiler Options -Default compiler behaviour may be overriden with the -.Fl f -flag. The available options are as follows: -.Bl -tag -width XXXXXXXXXXXX -offset XXXX -.It Fl f Ns Ar ign-scope -When rewinding the scope of a block macro, forces the compiler to ignore -scope violations. This can seriously mangle the resulting tree. -.It Fl f Ns Ar ign-escape -Ignore invalid escape sequences. -.It Fl f Ns Ar ign-macro -Ignore unknown macros at the start of input lines. -.El -.\" PARAGRAPH -.Pp -As with the -.Fl W -flag, multiple -.Fl f -options may be grouped and delimited with a comma. Using -.Fl f Ns Ar ign-scope,ign-escape , -for example, will try to ignore scope and character-escape errors. -.\" SUB-SECTION -.Ss Input Encoding -The -.Nm -utility expects its input to be 7-bit ASCII as defined in -.Xr ascii 7 . -The only non-graphing characters accepted are spaces, -.Sq \ , -and tabs, -.Sq \et . -Tabs are only accepted in literal block-displays and as column -delimiters. -.Pp -Only Unix-style newlines (\en) are accepted; if the newline is escaped, -the line is concatenated with the next. -.\" SUB-SECTION -.Ss Character Escapes -Since -.Nm -doesn't format its output, character escapes are displayed as passed -into the compiler. -.\" SECTION -.Sh EXAMPLES -To validate this manual page: -.\" PARAGRAPH -.Pp -.D1 % mdoctree \-Wall,error mdoctree.1 -.\" SECTION -.Sh SEE ALSO -.Xr mdocterm 1 , -.Xr mdoclint 1 , -.Xr mdoc.samples 7 , -.Xr mdoc 7 , -.Xr mdoc 3 -.\" -.Sh AUTHORS -The -.Nm -utility was written by -.An Kristaps Dzonsons Aq kristaps@openbsd.org . -.\" SECTION -.Sh CAVEATS -See -.Xr mdoc 3 -for a list of bugs, caveats, and incomplete macros. |