mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.14 and 1.23

version 1.14, 2009/04/12 19:19:57

version 1.23, 2009/06/25 10:51:55

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

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

.\" above copyright notice and this permission notice appear in all

.\" copyright notice and this permission notice appear in all copies.

.\" copies.

.\"

.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL

.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES

.\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED

.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF

.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE

.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR

.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL

.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES

.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR

.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN

.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER

.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF

.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR

.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

.\" PERFORMANCE OF THIS SOFTWARE.

.\"

.Dd $Mdocdate$

.Dt MANDOC 1

Line 39 The

Line 37 The

utility formats

.Ux

manual pages for display. The arguments are as follows:

.Bl -tag -width XXXXXXXXXXXX

.Bl -tag -width Ds

.\" ITEM

.It Fl f Ns Ar option...

Override default compiler behaviour. See

.Sx Compiler Options

for details.

.\" ITEM

.It Fl m

.It Fl m Ns Ar format

Input format. See

.Sx Input Formats

for available formats. Defaults to

.Fl m Ns Ar andoc .

.\" ITEM

.It Fl T

.It Fl T Ns Ar output

Output format. See

.Sx Output Formats

for available formats. Defaults to

Line 100 were provided.

Line 98 were provided.

.Pp

.Ex -std mandoc

.\" SUB-SECTION

.Ss Punctuation

.Ss Punctuation and Spacing

If punctuation is set apart from words, such as in the phrase

.Dq to be \&, or not to be ,

it's processed by

.Nm

according to the following rules. Opening punctuation

according to the following rules: opening punctuation

.Po

.Sq \&( ,

.Sq \&[ ,

and

.Sq \&{

.Pc

is not followed by a space. Closing punctuation

is not followed by a space; closing punctuation

.Po

.Sq \&. ,

.Sq \&, ,

Line 125 is not followed by a space. Closing punctuation

Line 123 is not followed by a space. Closing punctuation

and

.Sq \&}

.Pc

is not preceeded by whitespace.

is not preceded by whitespace.

.Pp

If the input is

.Xr mdoc 7 ,

these rules are also applied to macro arguments when appropriate.

.Pp

White-space, in non-literal (normal) mode, is stripped from input and

replaced on output by a single space. Thus, if you wish to preserve

multiple spaces, they must be space-escaped

.Sq \e\

or used in a literal display mode, e.g.,

.Sq \&.Bd \-literal

.Xr mdoc 7 .

.\" SUB-SECTION

.Ss Input Formats

The

Line 190 The

Line 197 The

utility accepts the following

.Fl T

arguments:

.Bl -tag -width XXXXXXXXXXXX

.Bl -tag -width Ds

.It Fl T Ns Ar ascii

Produce 7-bit ASCII output, backspace-encoded for bold and underline

styles. This is the default.

Line 207 corresponding filter in-order.

Line 214 corresponding filter in-order.

Default compiler behaviour may be overriden with the

.Fl f

flag.

.Bl -tag -width XXXXXXXXXXXXXX

.Bl -tag -width Ds

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

.Pq mdoc only

.It Fl f Ns Ar ign-escape

.It Fl f Ns Ar no-ign-escape

Ignore invalid escape sequences.

Don't ignore invalid escape sequences.

.It Fl f Ns Ar ign-macro

Ignore unknown macros at the start of input lines (default for

.Xr man 7

parsing).

.It Fl f Ns Ar no-ign-macro

Do not ignore unknown macros at the start of input lines (default for

Do not ignore unknown macros at the start of input lines.

.Xr mdoc 7

.It Fl f Ns Ar no-ign-chars

parsing).

Do not ignore disallowed characters.

.It Fl f Ns Ar strict

Implies

.Fl f Ns Ar no-ign-escape ,

.Fl f Ns Ar no-ign-macro

and

.Fl f Ns Ar no-ign-chars .

.El

.\" PARAGRAPH

.Pp

Line 230 As with the

Line 239 As with the

flag, multiple

.Fl f

options may be grouped and delimited with a comma. Using

.Fl f Ns Ar ign-scope,ign-escape ,

.Fl f Ns Ar ign-scope,no-ign-escape ,

for example, will try to ignore scope and character-escape errors.

for example, will try to ignore scope and not ignore character-escape

errors.

.\" SECTION

.Sh EXAMPLES

To page manuals to the terminal:

.\" PARAGRAPH

.Pp

.D1 % mandoc \-Wall,error mandoc.1 2>&1 | less

.D1 % mandoc \-Wall,error \-fstrict mandoc.1 2>&1 | less

.Pp

.D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less

.\" SECTION

.Sh COMPATIBILITY

This section summarises

.Nm

compatibility with

.Xr groff 1 .

.Pp

.Bl -bullet -compact

.It

A list or display following

.Sq \&.Ss

does not assert a prior vertical break, just as it doesn't with

.Sq \&.Sh .

.It

The \-literal and \-unfilled

.Sq \&.Bd

displays types are synonyms, as are \-filled and \-ragged.

.It

Words aren't hyphenated.

.It

In normal mode (not a literal block), blocks of spaces aren't preserved,

so double spaces following sentence closure are reduced to a single space

.Pq Dq French spacing .

.El

.\" SECTION

.Sh SEE ALSO

.Xr mandoc_char 7 ,

.Xr mdoc 7 ,

.Xr man 7

.\"

.\" SECTION

.Sh AUTHORS

The

.Nm

utility was written by

.An Kristaps Dzonsons Aq kristaps@openbsd.org .

.An Kristaps Dzonsons Aq kristaps@kth.se .

.\" SECTION

.Sh CAVEATS

The

.Nm

utility in

utility doesn't yet know how to display \-hang lists.

.Fl T Ns Ar ascii

mode doesn't yet know how to display the following:

.Pp

.Bl -bullet -compact

.It

The \-hang

.Sq \&.Bl

list is not yet supported.

.El

.Pp

Other macros still aren't supported by virtue of nobody complaining

about their absence. Please report any omissions: this is a work in

about their absence.

progress.

.Pp

The following list documents differences between traditional

.Xr nroff 1

output and

.Nm :

.Pp

.Bl -bullet -compact

.It

A list of display following

.Sq \&.Ss

does not assert a prior vertical break, just as it doesn't with

.Sq \&.Sh .

.It

Special characters don't follow the current font style.

.\" LIST-ITEM

.It

The \-literal and \-unfilled

.Sq \&.Bd

displays types are synonyms, as are \-filled and \-ragged.

.El

CVSweb