mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.98 and 1.105

version 1.98, 2011/11/13 13:15:14

version 1.105, 2014/06/23 22:03:30

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 242 blank characters instead of the default of five for

Line 256 blank characters instead of the default of five for

and seven for

.Xr man 7 .

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

for example overful lines or ugly line breaks.

for example overfull lines or ugly line breaks.

.It Cm width Ns = Ns Ar width

The output width is set to

.Ar width ,

Line 333 for font style specification and available command-lin

Line 347 for font style specification and available command-lin

Translate input format into

.Xr man 7

output format.

This is useful for distributing manual sources to legancy systems

This is useful for distributing manual sources to legacy systems

lacking

.Xr mdoc 7

formatters.

Line 484 parser:

Line 498 parser:

.Sh DIAGNOSTICS

Standard error messages reporting parsing errors are prefixed by

.Pp

.Sm off

.D1 Nm Ns : Ar file : Ns Ar line : Ns Ar column : level :

.D1 Ar file : line : column : \ level :

.Sm on

.Pp

where the fields have the following meanings:

.Bl -tag -width "column"

Line 504 points to the first character of the word.

Line 516 points to the first character of the word.

The message level, printed in capital letters.

.El

.Pp

The

.Ar line

and

.Ar column

fields are omitted when meaningless.

.Pp

Message levels have the following meanings:

.Bl -tag -width "warning"

.It Cm syserr

Opening or reading an input file failed, so the parser cannot

even be started and no output is produced from that input file.

.It Cm fatal

The parser is unable to parse a given input file at all.

No formatted output is produced from that input file.

Line 541 output mode.

Line 562 output mode.

The

.Nm

utility may also print messages related to invalid command line arguments

or operating system errors, for example when memory is exhausted or

or operating system errors, for example when memory is exhausted.

input files cannot be read.

Such messages may not carry the prefix described above.

Such messages do not carry the prefix described above.

.Sh COMPATIBILITY

This section summarises

.Nm

Line 636 lists render similarly.

Line 656 lists render similarly.

The

.Nm

utility was written by

.An Kristaps Dzonsons ,

.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .

.Mt kristaps@bsd.lv .

.Sh CAVEATS

.Fl T Ns Cm html

CVSweb