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.23 and 1.26

version 1.23, 2009/03/16 22:19:19

version 1.26, 2009/03/19 11:49:00

Line 1

.\" $Id$

.\"

.\" Permission to use, copy, modify, and distribute this software for any

.\" purpose with or without fee is hereby granted, provided that the

Line 26

.\" SECTION

.Sh SYNOPSIS

.Nm mdocterm

.Op Fl vV

.Op Fl V

.Op Fl f Ns Ar option...

.Op Fl O Ns Ar option...

.Op Fl W Ns Ar err...

.Op Ar infile

.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 48 utility formats a BSD

Line 39 utility formats a BSD

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

.Bl -tag -width XXXXXXXXXXXX

.\" ITEM

.It Fl v

.It Fl V

Print verbose parsing output.

.\" ITEM

.It Fl v

Print version and exit.

.\" ITEM

.It Fl f Ns Ar option...

Line 59 Override default compiler behaviour. See

Line 47 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 79 termination. Multiple

Line 62 termination. Multiple

arguments may be comma-separated, such as

.Fl W Ns Ar error,all .

.\" ITEM

.It Ar infile

.It Ar infile...

Read input from

Read input from zero or more

.Ar infile ,

.Ar infile .

which may be

If unspecified, reads from stdin.

.Dq \-

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 115 By default,

Line 87 By default,

reads from stdin and prints nroff

.Qq backspace

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

of 78 characters. If

of 78 characters.

.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 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 160 As with the

Line 111 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.

Line 194 To pipe a manual page to the pager:

Line 143 To pipe a manual page to the pager:

.D1 % mdocterm mdocterm.1 | less

.\" SECTION

.Sh SEE ALSO

.Xr mdoctree 1 ,

.Xr mdoclint 1 ,

.Xr mdoc 7 ,

.Xr mdoc 3

.\"

Line 203 To pipe a manual page to the pager:

Line 150 To pipe a manual page to the pager:

The

.Nm

utility was written by

.An Kristaps Dzonsons Aq kristaps@kth.se .

.An Kristaps Dzonsons Aq kristaps@openbsd.org .

.\" SECTION

.Sh CAVEATS

See

CVSweb