mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.93 and 1.102

version 1.93, 2011/09/26 20:47:23

version 1.102, 2013/03/06 08:08:24

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 above

Line 23

Line 24

.Sh SYNOPSIS

.Nm mandoc

.Op Fl V

.Sm off

.Op Fl I Cm os Li = Ar name

.Sm on

.Op Fl m Ns Ar format

.Op Fl O Ns Ar option

.Op Fl T Ns Ar output

Line 34 The

Line 38 The

utility formats

.Ux

manual pages for display.

.Pp

By default,

.Nm

reads

.Xr mdoc 7

.Xr man 7

text from stdin, implying

.Fl m Ns Cm andoc ,

and produces

.Fl T Ns Cm ascii

output.

.Pp

The arguments are as follows:

.Bl -tag -width Ds

.Sm off

.It Fl I Cm os Li = Ar name

.Sm on

Override the default operating system

.Ar name

for the

.Xr mdoc 7

.Sq \&Os

macro.

.It Fl m Ns Ar format

Input format.

See

Line 96 If multiple files are specified,

Line 122 If multiple files are specified,

.Nm

will halt with the first failed parse.

.El

.Pp

By default,

.Nm

reads

.Xr mdoc 7

.Xr man 7

text from stdin, implying

.Fl m Ns Cm andoc ,

and produces

.Fl T Ns Cm ascii

output.

.Ss Input Formats

The

.Nm

Line 176 Encode output using the current locale.

Line 190 Encode output using the current locale.

See

.Sx Locale Output .

.It Fl T Ns Cm man

Produce output in

Produce

.Xr man 7

format; only useful when applied to

format output.

.Fl m Ns Cm doc

See

input.

.Sx Man Output .

.It Fl T Ns Cm pdf

Produce PDF output.

See

Line 234 The following

Line 248 The following

.Fl O

arguments are accepted:

.Bl -tag -width Ds

.It Cm indent Ns = Ns Ar indent

The left margin for normal text is set to

.Ar indent

blank characters instead of the default of five for

.Xr mdoc 7

and seven for

.Xr man 7 .

Increasing this is not recommended; it may result in degraded formatting,

for example overfull lines or ugly line breaks.

.It Cm width Ns = Ns Ar width

The output width is set to

.Ar width ,

Line 259 The following

Line 282 The following

.Fl O

arguments are accepted:

.Bl -tag -width Ds

.It Cm fragment

Omit the

.Aq !DOCTYPE

declaration and the

.Aq html ,

.Aq head ,

and

.Aq body

elements and only emit the subtree below the

.Aq body

element.

The

.Cm style

argument will be ignored.

This is useful when embedding manual content within existing documents.

.It Cm includes Ns = Ns Ar fmt

The string

.Ar fmt ,

Line 305 will fall back to

Line 343 will fall back to

See

.Sx ASCII Output

for font style specification and available command-line arguments.

.Ss Man Output

Translate input format into

.Xr man 7

output format.

This is useful for distributing manual sources to legacy systems

lacking

.Xr mdoc 7

formatters.

.Pp

.Xr mdoc 7

is passed as input, it is translated into

.Xr man 7 .

If the input format is

.Xr man 7 ,

the input is copied to the output, expanding any

.Xr roff 7

.Sq so

requests.

The parser is also run, and as usual, the

.Fl W

level controls which

.Sx DIAGNOSTICS

are displayed before copying the input to the output.

.Ss PDF Output

PDF-1.1 output may be generated by

.Fl T Ns Cm pdf .

CVSweb