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.19 and 1.22

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

version 1.22, 2009/03/15 10:34:11

Line 21

.Os

.\" SECTION

.Sh NAME

.Nm mdocmterm

.Nm mdocterm

.Nd mdoc macro compiler

.\" SECTION

.Sh SYNOPSIS

.Nm mdocmterm

.Nm mdocterm

.Op Fl vV

.Op Fl f Ns Ar option...

.Op Fl O Ns Ar option...

.Op Fl W Ns Ar err...

.Op Ar infile

.Nm mdocterm

.Op Fl hi

.Op Fl m Ns Ar name

.Op Fl n Ns Ar num

.Op Fl o Ns Ar list

.Op Fl r Ns Ar cn

.Op Fl T Ns Ar name

.Op Ar infile

.\" SECTION

.Sh DESCRIPTION

The

Line 50 Override default compiler behaviour. See

Line 59 Override default compiler behaviour. See

.Sx Compiler Options

for details.

.\" ITEM

.It Fl O Ns Ar option...

Front-end options. See

.Sx Front-end Options

for details.

.\" ITEM

.It Fl W Ns Ar err...

Print warning messages. May be set to

.Fl W Ns Ar all

Line 74 for stdin.

Line 88 for stdin.

.El

.\" PARAGRAPH

.Pp

.Xr nroff 1

arguments are supplied on the command line

.Pq Fl himnorT ,

these are ignored unless

.Xr nroff 1

is invoked on parse failure.

.\" PARAGRAPH

.Pp

The

.Nm

utility is a formatting front-end for

Line 85 input, documented at

Line 108 input, documented at

and

.Xr mdoc.samples 7 ,

into an abstract syntax tree.

.\" PARAGRAPH

.Pp

By default,

.Nm

reads from stdin and prints ANSI

reads from stdin and prints nroff

.Qq raw

.Qq backspace

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

of 78 characters.

of 78 characters. If

.Ar infile

can't be parsed (isn't valid mdoc, doesn't contain valid syntax, etc.),

.Xr nroff 1

is invoked. If no

.Xr nroff 1

command-line argumnets aren't provided,

.Fl m Ar Ns andoc

is implied.

.\" PARAGRAPH

.Pp

.Ex -std mdocmterm

.Ex -std mdocterm

.\" SUB-SECTION

.Ss Front-end Options

The default behaviour may be overriden with the

.Fl O

flag. The available options are as follows:

.Bl -tag -width XXXXXXXXXXXX -offset XXXX

.It Fl O Ns Ar nopunt

Don't punt to

.Xr nroff 1

.Ar infile

may not be parsed.

.El

.\" SUB-SECTION

.Ss Compiler Options

Default compiler behaviour may be overriden with the

.Fl f

Line 115 As with the

Line 160 As with the

.Fl W

flag, multiple

.Fl f

and

.Fl O

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

This section documents the character-escapes accepted by

The following table shows all

.Xr mdocterm 1 .

.Xr mdoc 7

Note that the \\x, \\(xx and \\[n] forms are described here; the \\*(xx,

character escapes rendered by

\\*[n] and \\*x forms described in

.Nm .

.Xr mdoc.samples 7

are deprecated, but still rendered. All one- and two-character

sequences may be used in the n-character sequence \\[n].

.Pp

Note that the

.Em Output

column will render differently whether executed with

Line 269 the more general syntax.

Line 297 the more general syntax.

To display this manual page:

.\" PARAGRAPH

.Pp

.D1 % mdocmterm \-Wall,error mdocmterm.1

.D1 % mdocterm \-Wall,error mdocterm.1

.\" PARAGRAPH

.Pp

To pipe a manual page to the pager:

.Pp

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

.D1 % mdocterm mdocterm.1 | less

.\" SECTION

.Sh SEE ALSO

.Xr mdoctree 1 ,

.Xr mdoclint 1 ,

.Xr mdoc.samples 7 ,

.Xr mdoc 7 ,

.Xr mdoc 3

.\"

CVSweb