From e81807680a9a78e4658f5e00ffc42de9da9eb19d Mon Sep 17 00:00:00 2001 From: Kristaps Dzonsons Date: Thu, 19 Mar 2009 16:17:27 +0000 Subject: Split mdocterm.c -> main.c terminal.c. Abstracted output with -T selector (default ascii). Name change: mdocterm -> mandoc. Re-imported tree with -Ttree. --- mdocterm.1 | 182 ------------------------------------------------------------- 1 file changed, 182 deletions(-) delete mode 100644 mdocterm.1 (limited to 'mdocterm.1') diff --git a/mdocterm.1 b/mdocterm.1 deleted file mode 100644 index 6922c618..00000000 --- a/mdocterm.1 +++ /dev/null @@ -1,182 +0,0 @@ -.\" $Id: mdocterm.1,v 1.26 2009/03/19 11:49:00 kristaps Exp $ -.\" -.\" Copyright (c) 2009 Kristaps Dzonsons -.\" -.\" 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 19 2009 $ -.Dt mdocterm 1 -.Os -.\" SECTION -.Sh NAME -.Nm mdocterm -.Nd mdoc macro compiler -.\" SECTION -.Sh SYNOPSIS -.Nm mdocterm -.Op Fl V -.Op Fl f Ns Ar option... -.Op Fl W Ns Ar err... -.Op Ar infile... -.\" SECTION -.Sh DESCRIPTION -The -.Nm -utility formats a BSD -.Dq mdoc -manual page for display on the terminal. The arguments are as follows: -.Bl -tag -width XXXXXXXXXXXX -.\" 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 zero or more -.Ar infile . -If unspecified, reads from 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. -.\" PARAGRAPH -.Pp -By default, -.Nm -reads from stdin and prints nroff -.Qq backspace -terminal-encoded output to stdout, at this time to a fixed column with -of 78 characters. -.\" PARAGRAPH -.Pp -.Ex -std mdocterm -.\" 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 Character Escapes -The -.Nm -utility correctly renders all -.Sx Special Characters -in -.Xr mdoc 7 -in 7-bit ASCII. -.Pp -In the general sense, -.Nm -will make a -.Pq best-effort -to render complex characters; however, if a manual is using considerable -special characters, some meaning may be lost in translation. -.\" SECTION -.Sh EXAMPLES -To display this manual page: -.\" PARAGRAPH -.Pp -.D1 % mdocterm \-Wall,error mdocterm.1 -.\" PARAGRAPH -.Pp -To pipe a manual page to the pager: -.Pp -.D1 % mdocterm mdocterm.1 | less -.\" SECTION -.Sh SEE ALSO -.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 regarding the -document parse. -.Pp -The -.Nm -utility doesn't yet know how to display the following: -.Pp -.Bl -bullet -compact -.It -The \-hang -.Sq \&Bl -list is not yet supported. -.It -The \-literal and \-unfilled -.Sq \&Bd -displays only accept text contents. -.It -The -.Sq \&Xo/Xc -pair isn't supported (and never will be). -.It -The -.Sq \&Sm -macro has no effect, yet. -.El -- cgit v1.2.3-56-ge451