mandoc/mdocterm.1 - diff

Return to mdocterm.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/mdocterm.1 between version 1.13 and 1.19

version 1.13, 2009/03/04 14:13:05

version 1.19, 2009/03/13 07:46:10

Line 17

.\" PERFORMANCE OF THIS SOFTWARE.

.\"

.Dd $Mdocdate$

.Dt mdocmterm 1

.Dt mdocterm 1

.Os

.\" SECTION

.Sh NAME

Line 26

.\" SECTION

.Sh SYNOPSIS

.Nm mdocmterm

.Op Fl v

.Op Fl vV

.Op Fl f Ns Ar option...

.Op Fl W Ns Ar err...

.Op Ar infile

.\" SECTION

Line 36 The

Line 37 The

utility formats a BSD

.Dq mdoc

manual page for display on the terminal. The arguments are as follows:

.Bl -tag -width "\-Werr... "

.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

Line 75 input, documented at

Line 84 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 terminal-encoded output to stdout.

reads from stdin and prints ANSI

.Qq raw

terminal-encoded output to stdout, at this time to a fixed column with

of 78 characters.

.\" PARAGRAPH

.Pp

.Ex -std mdocmterm

.\" 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

.Ud

.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

This section documents the character-escapes accepted by

Line 127 Enclosures:

Line 171 Enclosures:

.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact

.It Em Output

.Em Input (Name)

.It \(rC

\\(rC (right brace)

.It \(lC

\\(lC (left brace)

.It \(ra

\\(ra (right angle)

.It \(la

Line 135 Enclosures:

Line 183 Enclosures:

\\(rB (right bracket)

.It \(lB

\\(lB (left bracket)

.It \q

\\q (double-quote)

.It \(lq

\\(lq (left double-quote)

.It \(rq

Line 224 To display this manual page:

Line 274 To display this manual page:

.Pp

To pipe a manual page to the pager:

.Pp

.D1 % mdocterm mdocterm.1 | less \-R

.D1 % mdocterm mdocterm.1 2>&1 | less \-R

.\" SECTION

.Sh SEE ALSO

.Xr mdoctree 1 ,

Line 251 utility doesn't yet know how to display the following:

Line 301 utility doesn't yet know how to display the following:

.Pp

.Bl -bullet -compact

.It

The \-hang and \-column

The \-hang

.Sq \&Bl

lists are not yet supported.

list is not yet supported.

.It

The \-literal and \-unfilled

.Sq \&Bd

CVSweb