mandoc/man.7 - diff

Return to man.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/man.7 between version 1.63 and 1.105

version 1.63, 2010/05/07 15:49:36

version 1.105, 2011/08/18 08:58:43

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 25 The

.Nm man

language was historically used to format

.Ux

manuals. This reference document describes its syntax, structure, and

manuals.

usage.

This reference document describes its syntax, structure, and usage.

.Pp

.Bf -emphasis

Do not use

Line 37 Use the

.Xr mdoc 7

language, instead.

.Pp

.Nm

document follows simple rules: lines beginning with the control

character

.Sq \&.

are parsed for macros. Other lines are interpreted within the scope of

are parsed for macros.

Other lines are interpreted within the scope of

prior macros:

.Bd -literal -offset indent

\&.SH Macro lines change control state.

Other lines are interpreted within the current state.

.Ed

.Sh INPUT ENCODING

.Sh LANGUAGE SYNTAX

.Nm

documents may contain only graphable 7-bit ASCII characters, the

space character, and the tabs character. All manuals must have

space character, and the tab character.

.Ux

The back-space character

line termination.

.Sq \e

.Pp

indicates the start of an escape sequence for

Blank lines are acceptable; where found, the output will assert a

.Sx Comments ,

vertical space.

.Sx Predefined Strings ,

and

.Sx Special Characters .

.Ss Comments

Text following a

Text following an escaped double-quote

.Sq \e\*" ,

.Sq \e\*q ,

whether in a macro or free-form text line, is ignored to the end of

whether in a macro or text line, is ignored to the end of

line. A macro line with only a control character and comment escape,

line.

.Sq \&.\e" ,

A macro line beginning with a control character and comment escape

is also ignored. Macro lines with only a control character and

.Sq \&.\e\*q

optionally whitespace are stripped from input.

is also ignored.

Furthermore,

macro lines with only a control character and optional trailing

whitespace are

stripped from input.

.Pp

Examples:

.Bd -literal -offset indent -compact

\&.\e\*q This is a comment line.

\&.\e\*q The next line is ignored:

\&.

\&.Em Emphasis \e\*q This is also a comment.

.Ed

.Ss Special Characters

Special characters may occur in both macro and free-form lines.

Special characters are used to encode special glyphs and are rendered

differently across output media.

They may occur in both macro and text lines.

Sequences begin with the escape character

.Sq \e

followed by either an open-parenthesis

Line 75 for two-character sequences; an open-bracket

Line 92 for two-character sequences; an open-bracket

.Sq \&[

for n-character sequences (terminated at a close-bracket

.Sq \&] ) ;

or a single one-character sequence. See

or a single one character sequence.

.Pp

Examples:

.Bl -tag -width Ds -offset indent -compact

.It \e(em

em dash

.It \ee

backslash

.El

.Pp

See

.Xr mandoc_char 7

for a complete list. Examples include

for a complete list.

.Sq \e(em

.Pq em-dash

and

.Sq \ee

.Pq back-slash .

.Ss Text Decoration

Terms may be text-decorated using the

.Sq \ef

escape followed by an indicator: B (bold), I, (italic), R (Roman), or P

escape followed by an indicator: B (bold), I (italic), R (regular), or P

(revert to previous mode):

.Pp

A numerical representation 3, 2, or 1 (bold, italic, and regular,

.D1 \efBbold\efR \efIitalic\efP

respectively) may be used instead.

.Pp

A text decoration is only valid, if specified in free-form text, until

A numerical representation 3, 2, or 1 (bold, italic, and Roman,

the next macro invocation; if specified within a macro, it's only valid

respectively) may be used instead. A text decoration is only valid, if

until the macro closes scope.

specified in free-form text, until the next macro invocation; if

specified within a macro, it's only valid until the macro closes scope.

Note that macros like

.Sx \&BR

open and close a font scope with each argument.

.Pp

Text may also be sized with the

The

.Sq \es

.Sq \ef

escape, whose syntax is one of

attribute is forgotten when entering or exiting a macro block.

.Sq \es+-n

for one-digit numerals;

.Sq \es(+-nn

.Sq \es+-(nn

for two-digit numerals; and

.Sq \es[+-N] ,

.Sq \es+-[N] ,

.Sq \es'+-N' ,

.Sq \es+-'N'

for arbitrary-digit numerals:

.Pp

.D1 \es+1bigger\es-1

Examples:

.D1 \es[+10]much bigger\es[-10]

.Bl -tag -width Ds -offset indent -compact

.D1 \es+(10much bigger\es-(10

.It \efBbold\efR

.D1 \es+'100'much much bigger\es-'100'

write in bold, then switch to regular

.It \efIitalic\efP

write in italic, then return to previous

.El

.Ss Predefined Strings

Predefined strings, like

.Sx Special Characters ,

mark special output glyphs.

Predefined strings are escaped with the slash-asterisk,

.Sq \e* :

single-character

.Sq \e*X ,

two-character

.Sq \e*(XX ,

and N-character

.Sq \e*[N] .

.Pp

Both

Examples:

.Sq \es

.Bl -tag -width Ds -offset indent -compact

and

.It \e*(Am

.Sq \ef

ampersand

attributes are forgotten when entering or exiting a macro block.

.It \e*(Ba

.Ss Whitespace

vertical bar

Unless specifically escaped, consecutive blocks of whitespace are pruned

.El

from input. These are later re-added, if applicable, by a front-end

.Pp

utility such as

These strings are set using

.Xr mandoc 1 .

.Xr roff 7 ,

.Ss Dates

although

The

.Sx \&TH

macro is the only

.Nm

macro that requires a date. The form for this date is the ISO-8601

consists of several pre-set escapes listed in

standard

.Xr mandoc_char 7 .

.Cm YYYY-MM-DD .

.Ss Whitespace

.Ss Scaling Widths

Whitespace consists of the space character.

Many macros support scaled widths for their arguments, such as

In text lines, whitespace is preserved within a line.

stipulating a two-inch paragraph indentation with the following:

In macro lines, whitespace delimits arguments and is discarded.

.Bd -literal -offset indent

\&.HP 2i

.Ed

.Pp

The syntax for scaled widths is

Unescaped trailing spaces are stripped from text line input unless in a

.Sq Li [+-]?[0-9]*.[0-9]*[:unit:]? ,

literal context.

In general, trailing whitespace on any input line is discouraged for

reasons of portability.

In the rare case that a blank character is needed at the end of an

input line, it may be forced by

.Sq \e\ \e& .

.Pp

If the first character of a text line is a space, that line is printed

with a leading newline.

.Ss Quotation

Macro arguments may be quoted with double-quotes; in this case,

whitespace within the quotes is retained as part of the argument.

.Pp

A quoted argument begins with a double-quote preceded by whitespace.

The next double-quote not pairwise adjacent to another double-quote

terminates the literal, regardless of surrounding whitespace.

.Pp

In unquoted arguments, space characters can alternatively be included

by preceding them with a backslash

.Pq Sq \e\~ ,

but quoting is usually better for clarity.

.Pp

Note that any quoted text, even if it would cause a macro invocation

when unquoted, is considered literal text.

.Pp

In text lines, quotes are regarded as opaque text.

.Ss Scaling Widths

Many macros support scaled widths for their arguments.

The syntax for a scaled width is

.Sq Li [+-]?[0-9]*.[0-9]*[:unit:] ,

where a decimal must be preceded or proceeded by at least one digit.

Negative numbers, while accepted, are truncated to zero. The following

Negative numbers, while accepted, are truncated to zero.

scaling units are accepted:

.Pp

The following scaling units are accepted:

.Pp

.Bl -tag -width Ds -offset indent -compact

.It c

centimetre

Line 188 Using anything other than

Line 235 Using anything other than

.Sq v

is necessarily non-portable across output media.

See

.Sx COMPATIBILITY .

.Pp

If a scaling unit is not provided, the numerical value is interpreted

under the default rules of

Line 195 under the default rules of

Line 244 under the default rules of

for vertical spaces and

.Sq u

for horizontal ones.

.Em Note :

.Pp

this differs from

Examples:

.Xr mdoc 7 ,

.Bl -tag -width Ds -offset indent -compact

which, if a unit is not provided, will instead interpret the string as

.It \&.HP 2i

literal text.

two-inch tagged list indentation

.Pq see Sx \&HP

.It \&.sp 2v

two vertical spaces

.Pq see Sx \&sp

.El

.Ss Sentence Spacing

Sentences should terminate at the end of an input line.

By doing this, a formatter will be able to apply the proper amount of

spacing after the end of sentence (unescaped) period, exclamation mark,

or question mark followed by zero or more non-sentence closing

delimiters

.Po

.Sq \&) ,

.Sq \&] ,

.Sq \&' ,

.Sq \&"

.Pc .

.Pp

Examples:

.Bd -literal -offset indent -compact

Do not end sentences mid-line like this. Instead,

end a sentence like this.

A new sentence gets a new line.

.Ed

.Sh MANUAL STRUCTURE

Each

.Nm

document must contain contains at least the

document must contain the

.Sx \&TH

macro describing the document's section and title. It may occur

macro describing the document's section and title.

anywhere in the document, although conventionally, it appears as the

It may occur anywhere in the document, although conventionally it

first macro.

appears as the first macro.

.Pp

Beyond

.Sx \&TH ,

at least one macro or text node must appear in the document. Documents

at least one macro or text node must appear in the document.

are generally structured as follows:

.Pp

The following is a well-formed skeleton

.Nm

file for a utility

.Qq progname :

.Bd -literal -offset indent

\&.TH FOO 1 2009-10-10

\&.TH PROGNAME 1 2009-10-10

\&.

\&.SH NAME

\efBfoo\efR \e(en a description goes here

\efBprogname\efR \e(en a description goes here

\&.\e\*q The next is for sections 2 & 3 only.

\&.\e\*q .SH LIBRARY

\&.

\&.\e\*q For sections 2 & 3 only.

\&.\e\*q Not used in OpenBSD.

\&.SH SYNOPSIS

\efBfoo\efR [\efB\e-options\efR] arguments...

\efBprogname\efR [\efB\e-options\efR] arguments...

\&.

\&.SH DESCRIPTION

The \efBfoo\efR utility processes files...

\&.

\&.\e\*q .SH IMPLEMENTATION NOTES

\&.\e\*q The next is for sections 1 & 8 only.

\&.\e\*q Not used in OpenBSD.

\&.\e\*q .SH EXIT STATUS

\&.\e\*q The next is for sections 2, 3, & 9 only.

\&.\e\*q .SH RETURN VALUES

\&.\e\*q The next is for sections 1, 6, 7, & 8 only.

\&.\e\*q For sections 2, 3, & 9 only.

\&.\e\*q .SH ENVIRONMENT

\&.\e\*q For sections 1, 6, 7, & 8 only.

\&.\e\*q .SH FILES

\&.\e\*q .SH EXIT STATUS

\&.\e\*q For sections 1, 6, & 8 only.

\&.\e\*q .SH EXAMPLES

\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.

\&.\e\*q .SH DIAGNOSTICS

\&.\e\*q The next is for sections 2, 3, & 9 only.

\&.\e\*q For sections 1, 4, 6, 7, & 8 only.

\&.\e\*q .SH ERRORS

\&.\e\*q For sections 2, 3, & 9 only.

\&.\e\*q .SH SEE ALSO

\&.\e\*q .BR foo ( 1 )

\&.\e\*q .SH STANDARDS

Line 248 The \efBfoo\efR utility processes files...

Line 323 The \efBfoo\efR utility processes files...

\&.\e\*q .SH CAVEATS

\&.\e\*q .SH BUGS

\&.\e\*q .SH SECURITY CONSIDERATIONS

\&.\e\*q Not used in OpenBSD.

.Ed

.Pp

The sections in a

.Nm

document are conventionally ordered as they appear above. Sections

document are conventionally ordered as they appear above.

should be composed as follows:

Sections should be composed as follows:

.Bl -ohang -offset indent

.It Em NAME

The name(s) and a short description of the documented material. The

The name(s) and a short description of the documented material.

syntax for this is generally as follows:

The syntax for this is generally as follows:

.Pp

.D1 \efBname\efR \e(en description

.It Em LIBRARY

The name of the library containing the documented material, which is

assumed to be a function in a section 2 or 3 manual. For functions in

assumed to be a function in a section 2 or 3 manual.

the C library, this may be as follows:

For functions in the C library, this may be as follows:

.Pp

.D1 Standard C Library (libc, -lc)

.It Em SYNOPSIS

Line 291 This expands upon the brief, one-line description in

Line 367 This expands upon the brief, one-line description in

It usually contains a break-down of the options (if documenting a

command).

.It Em IMPLEMENTATION NOTES

Implementation-specific notes should be kept here. This is useful when

Implementation-specific notes should be kept here.

implementing standard functions that may have side effects or notable

This is useful when implementing standard functions that may have side

algorithmic implications.

effects or notable algorithmic implications.

.It Em EXIT STATUS

Command exit status for section 1, 6, and 8 manuals. This section is

the dual of

.Em RETURN VALUES ,

which is used for functions. Historically, this information was

described in

.Em DIAGNOSTICS ,

a practise that is now discouraged.

.It Em RETURN VALUES

This section is the dual of

This section documents the return values of functions in sections 2, 3, and 9.

.Em EXIT STATUS ,

which is used for commands. It documents the return values of functions

in sections 2, 3, and 9.

.It Em ENVIRONMENT

Documents any usages of environment variables, e.g.,

.Xr environ 7 .

.It Em FILES

Documents files used. It's helpful to document both the file and a

Documents files used.

short description of how the file is used (created, modified, etc.).

It's helpful to document both the file name and a short description of how

the file is used (created, modified, etc.).

.It Em EXIT STATUS

This section documents the command exit status for

section 1, 6, and 8 utilities.

Historically, this information was described in

.Em DIAGNOSTICS ,

a practise that is now discouraged.

.It Em EXAMPLES

Example usages. This often contains snippets of well-formed,

Example usages.

well-tested invocations. Make doubly sure that your examples work

This often contains snippets of well-formed,

properly!

well-tested invocations.

Make sure that examples work properly!

.It Em DIAGNOSTICS

Documents error conditions. This is most useful in section 4 manuals.

Documents error conditions.

This is most useful in section 4 manuals.

Historically, this section was used in place of

.Em EXIT STATUS

for manuals in sections 1, 6, and 8; however, this practise is

Line 326 discouraged.

Line 400 discouraged.

.It Em ERRORS

Documents error handling in sections 2, 3, and 9.

.It Em SEE ALSO

References other manuals with related topics. This section should exist

References other manuals with related topics.

for most manuals.

This section should exist for most manuals.

.Pp

.D1 \&.BR bar \&( 1 \&),

.Pp

Line 342 If not adhering to any standards, the

Line 416 If not adhering to any standards, the

.Em HISTORY

section should be used.

.It Em HISTORY

The history of any manual without a

A brief history of the subject, including where support first appeared.

.Em STANDARDS

section should be described in this section.

.It Em AUTHORS

Credits to authors, if applicable, should appear in this section.

Credits to the person or persons who wrote the code and/or documentation.

Authors should generally be noted by both name and an e-mail address.

Authors should generally be noted by both name and email address.

.It Em CAVEATS

Explanations of common misuses and misunderstandings should be explained

Common misuses and misunderstandings should be explained

in this section.

.It Em BUGS

Extant bugs should be described in this section.

Known bugs, limitations, and work-arounds should be described

in this section.

.It Em SECURITY CONSIDERATIONS

Documents any security precautions that operators should consider.

.El

.Sh MACRO SYNTAX

Macros are one to three three characters in length and begin with a

Macros are one to three characters in length and begin with a

control character ,

control character,

.Sq \&. ,

at the beginning of the line. The

at the beginning of the line.

The

.Sq \(aq

macro control character is also accepted. An arbitrary amount of

macro control character is also accepted.

whitespace (spaces or tabs) may sit between the control character and

An arbitrary amount of whitespace (spaces or tabs) may sit between the

the macro name. Thus, the following are equivalent:

control character and the macro name.

Thus, the following are equivalent:

.Bd -literal -offset indent

\&.PP

\&.\ \ \ PP

.Ed

.Pp

To include space characters in macro arguments, arguments may be quoted;

see the

.Sq MACRO SYNTAX

section in the

.Xr roff 7

manual for details.

.Pp

The

.Nm

macros are classified by scope: line scope or block scope. Line

macros are classified by scope: line scope or block scope.

macros are only scoped to the current line (and, in some situations,

Line macros are only scoped to the current line (and, in some

the subsequent line). Block macros are scoped to the current line and

situations, the subsequent line).

subsequent lines until closed by another block macro.

Block macros are scoped to the current line and subsequent lines until

closed by another block macro.

.Ss Line Macros

Line macros are generally scoped to the current line, with the body

consisting of zero or more arguments. If a macro is scoped to the next

consisting of zero or more arguments.

line and the line arguments are empty, the next line, which must be

If a macro is scoped to the next line and the line arguments are empty,

text, is used instead. Thus:

the next line, which must be text, is used instead.

Thus:

.Bd -literal -offset indent

\&.I

foo

Line 390 is equivalent to

Line 474 is equivalent to

.Sq \&.I foo .

If next-line macros are invoked consecutively, only the last is used.

If a next-line macro is followed by a non-next-line macro, an error is

raised (unless in the case of

raised, except for

.Sx \&br ,

.Sx \&sp ,

and

.Sx \&na ) .

.Sx \&na .

.Pp

The syntax is as follows:

.Bd -literal -offset indent

Line 404 The syntax is as follows:

Line 488 The syntax is as follows:

.Pp

.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX"

.It Em Macro Ta Em Arguments Ta Em Scope Ta Em Notes

.It Sx \&AT Ta <=1 Ta current Ta \&

.It Sx \&B Ta n Ta next-line Ta \&

.It Sx \&BI Ta n Ta current Ta \&

.It Sx \&BR Ta n Ta current Ta \&

Line 411 The syntax is as follows:

Line 496 The syntax is as follows:

.It Sx \&I Ta n Ta next-line Ta \&

.It Sx \&IB Ta n Ta current Ta \&

.It Sx \&IR Ta n Ta current Ta \&

.\" .It Sx \&PD Ta n Ta current Ta compat

.It Sx \&R Ta n Ta next-line Ta \&

.It Sx \&RB Ta n Ta current Ta \&

.It Sx \&RI Ta n Ta current Ta \&

.It Sx \&SB Ta n Ta next-line Ta \&

.It Sx \&SM Ta n Ta next-line Ta \&

.It Sx \&TH Ta >1, <6 Ta current Ta \&

.\" .It Sx \&UC Ta n Ta current Ta compat

.It Sx \&UC Ta <=1 Ta current Ta \&

.It Sx \&br Ta 0 Ta current Ta compat

.It Sx \&fi Ta 0 Ta current Ta compat

.It Sx \&i Ta n Ta current Ta compat

.It Sx \&ft Ta 1 Ta current Ta compat

.It Sx \&in Ta 1 Ta current Ta compat

.It Sx \&na Ta 0 Ta current Ta compat

.It Sx \&nf Ta 0 Ta current Ta compat

.It Sx \&r Ta 0 Ta current Ta compat

.It Sx \&sp Ta 1 Ta current Ta compat

.\" .It Sx \&Sp Ta 0 Ta current Ta compat

.\" .It Sx \&Vb Ta <1 Ta current Ta compat

.\" .It Sx \&Ve Ta 0 Ta current Ta compat

.El

.Pp

Macros marked as

.Qq compat

are included for compatibility with the significant corpus of existing

manuals that mix dialects of roff. These macros should not be used for

manuals that mix dialects of roff.

portable

These macros should not be used for portable

.Nm

manuals.

.Ss Block Macros

Block macros are comprised of a head and body. Like for in-line macros,

Block macros comprise a head and body.

the head is scoped to the current line and, in one circumstance, the

As with in-line macros, the head is scoped to the current line and, in

next line (the next-line stipulations as in

one circumstance, the next line (the next-line stipulations as in

.Sx Line Macros

apply here as well).

.Pp

Line 496 If a block macro is next-line scoped, it may only be f

Line 577 If a block macro is next-line scoped, it may only be f

macros for decorating text.

.Sh REFERENCE

This section is a canonical reference to all macros, arranged

alphabetically. For the scoping of individual macros, see

alphabetically.

For the scoping of individual macros, see

.Sx MACRO SYNTAX .

.Ss \&AT

Sets the volume for the footer for compatibility with man pages from

.Tn AT&T UNIX

releases.

The optional arguments specify which release it is from.

.Ss \&B

Text is rendered in bold face.

.Pp

See also

.Sx \&I ,

.Sx \&I

.Sx \&R ,

.Sx \&b ,

.Sx \&i ,

and

.Sx \&r .

.Sx \&R .

.Ss \&BI

Text is rendered alternately in bold face and italic. Thus,

Text is rendered alternately in bold face and italic.

Thus,

.Sq .BI this word and that

causes

.Sq this

Line 519 to render in bold face, while

Line 604 to render in bold face, while

.Sq word

and

.Sq that

render in italics. Whitespace between arguments is omitted in output.

render in italics.

Whitespace between arguments is omitted in output.

.Pp

Examples:

.Pp

.D1 \&.BI bold italic bold italic

.Dl \&.BI bold italic bold italic

.Pp

The output of this example will be emboldened

.Dq bold

Line 554 See also

Line 640 See also

and

.Sx \&IR .

.Ss \&DT

Has no effect. Included for compatibility.

Has no effect.

Included for compatibility.

.Ss \&HP

Begin a paragraph whose initial output line is left-justified, but

subsequent output lines are indented, with the following syntax:

Line 581 and

Line 668 and

Text is rendered in italics.

.Pp

See also

.Sx \&B ,

.Sx \&B

.Sx \&R ,

.Sx \&b ,

.Sx \&i ,

and

.Sx \&r .

.Sx \&R .

.Ss \&IB

Text is rendered alternately in italics and bold face. Whitespace

Text is rendered alternately in italics and bold face.

between arguments is omitted in output.

Whitespace between arguments is omitted in output.

.Pp

See

.Sx \&BI

Line 612 Begin an indented paragraph with the following syntax:

Line 696 Begin an indented paragraph with the following syntax:

The

.Cm width

argument defines the width of the left margin and is defined by

.Sx Scaling Widths ,

.Sx Scaling Widths .

It's saved for later paragraph left-margins; if unspecified, the saved or

default width is used.

.Pp

The

.Cm head

argument is used as a leading term, flushed to the left margin. This is

argument is used as a leading term, flushed to the left margin.

useful for bulleted paragraphs and so on.

This is useful for bulleted paragraphs and so on.

.Pp

See also

.Sx \&HP ,

Line 644 See also

Line 728 See also

and

.Sx \&RI .

.Ss \&LP

Begin an undecorated paragraph. The scope of a paragraph is closed by a

Begin an undecorated paragraph.

subsequent paragraph, sub-section, section, or end of file. The saved

The scope of a paragraph is closed by a subsequent paragraph,

paragraph left-margin width is re-set to the default.

sub-section, section, or end of file.

The saved paragraph left-margin width is reset to the default.

.Pp

See also

.Sx \&HP ,

Line 681 and

Line 766 and

Text is rendered in roman (the default font).

.Pp

See also

.Sx \&I ,

.Sx \&I

.Sx \&B ,

.Sx \&b ,

.Sx \&i ,

and

.Sx \&r .

.Sx \&B .

.Ss \&RB

Text is rendered alternately in roman (the default font) and bold face.

Whitespace between arguments is omitted in output.

Line 705 and

Line 787 and

.Ss \&RE

Explicitly close out the scope of a prior

.Sx \&RS .

The default left margin is restored to the state of the original

.Sx \&RS

invocation.

.Ss \&RI

Text is rendered alternately in roman (the default font) and italics.

Whitespace between arguments is omitted in output.

Line 721 See also

Line 806 See also

and

.Sx \&IR .

.Ss \&RS

Begin a part setting the left margin. The left margin controls the

Temporarily reset the default left margin.

offset, following an initial indentation, to un-indented text such as

that of

.Sx \&PP .

This has the following syntax:

.Bd -filled -offset indent

.Pf \. Sx \&Rs

.Pf \. Sx \&RS

.Op Cm width

.Ed

.Pp

Line 736 The

Line 818 The

argument must conform to

.Sx Scaling Widths .

If not specified, the saved or default width is used.

.Pp

See also

.Sx \&RE .

.Ss \&SB

Text is rendered in small size (one point smaller than the default font)

bold face.

.Ss \&SH

Begin a section. The scope of a section is only closed by another

Begin a section.

section or the end of file. The paragraph left-margin width is re-set

The scope of a section is only closed by another section or the end of

to the default.

file.

The paragraph left-margin width is reset to the default.

.Ss \&SM

Text is rendered in small size (one point smaller than the default

font).

.Ss \&SS

Begin a sub-section. The scope of a sub-section is closed by a

Begin a sub-section.

subsequent sub-section, section, or end of file. The paragraph

The scope of a sub-section is closed by a subsequent sub-section,

left-margin width is re-set to the default.

section, or end of file.

The paragraph left-margin width is reset to the default.

.Ss \&TH

Sets the title of the manual page with the following syntax:

.Bd -filled -offset indent

.Pf \. Sx \&TH

.Cm title section

.Ar title section date

.Op Cm date Op Cm source Op Cm volume

.Op Ar source Op Ar volume

.Ed

.Pp

At least the upper-case document title

Conventionally, the document

.Cm title

.Ar title

and numeric manual section

is given in all caps.

.Cm section

The recommended

arguments must be provided. The

.Ar date

.Cm date

format is

argument should be formatted as described in

.Sy YYYY-MM-DD

.Sx Dates :

as specified in the ISO-8601 standard;

if it does not conform, the current date is used instead. The

if the argument does not conform, it is printed verbatim.

.Cm source

If the

string specifies the organisation providing the utility. The

.Ar date

.Cm volume

is empty or not specified, the current date is used.

The optional

.Ar source

string specifies the organisation providing the utility.

The

.Ar volume

string replaces the default rendered volume, which is dictated by the

manual section.

.Pp

Examples:

.Pp

.D1 \&.TH CVS 5 "1992-02-12" GNU

.Dl \&.TH CVS 5 "1992-02-12" GNU

.Ss \&TP

Begin a paragraph where the head, if exceeding the indentation width, is

followed by a newline; if not, the body follows on the same line after a

buffer to the indentation width. Subsequent output lines are indented.

buffer to the indentation width.

Subsequent output lines are indented.

The syntax is as follows:

.Bd -filled -offset indent

.Pf \. Sx \&TP

Line 800 See also

Line 893 See also

.Sx \&P ,

and

.Sx \&PP .

.\" .

.Ss \&UC

.\" .

Sets the volume for the footer for compatibility with man pages from

.\" .Ss \&PD

BSD releases.

.\" Has no effect. Included for compatibility.

The optional first argument specifies which release it is from.

.\" .

.\" .Ss \&UC

.\" Has no effect. Included for compatibility.

.Ss \&br

Breaks the current line. Consecutive invocations have no further effect.

Breaks the current line.

Consecutive invocations have no further effect.

.Pp

See also

.Sx \&sp .

.Ss \&fi

End literal mode begun by

.Sx \&nf .

.Ss \&i

.Ss \&ft

Italicise arguments. Synonym for

Change the current font mode.

.Sx \&I .

See

.Sx Text Decoration

for a listing of available font modes.

.Ss \&in

Indent relative to the current indentation:

.Pp

See also

.D1 Pf \. Sx \&in Op Cm width

.Sx \&B ,

.Pp

.Sx \&I ,

.Sx \&R .

.Cm width

.Sx \&b ,

is signed, the new offset is relative.

and

Otherwise, it is absolute.

.Sx \&r .

This value is reset upon the next paragraph, section, or sub-section.

.Ss \&na

Don't align to the right margin.

.Ss \&nf

Begin literal mode: all subsequent free-form lines have their end of

line boundaries preserved. May be ended by

line boundaries preserved.

May be ended by

.Sx \&fi .

.Ss \&r

Literal mode is implicitly ended by

Fonts and styles (bold face, italics) reset to roman (default font).

.Sx \&SH

.Pp

See also

.Sx \&SS .

.Sx \&B ,

.Sx \&I ,

.Sx \&R ,

.Sx \&b ,

and

.Sx \&i .

.Ss \&sp

Insert vertical spaces into output with the following syntax:

.Bd -filled -offset indent

Line 856 spaces, which must conform to

Line 945 spaces, which must conform to

.Sx Scaling Widths .

If 0, this is equivalent to the

.Sx \&br

macro. Defaults to 1, if unspecified.

macro.

Defaults to 1, if unspecified.

.Pp

See also

.Sx \&br .

.\" .Ss \&Sp

.\" A synonym for

.\" .Sx \&sp

.\" .Cm 0.5v .

.\" .

.\" .Ss \&Vb

.\" A synonym for

.\" .Sx \&nf .

.\" Accepts an argument (the height of the formatted space) which is

.\" disregarded.

.\" .

.\" .Ss \&Ve

.\" A synonym for

.\" .Sx \&fi .

.\" .

.Sh COMPATIBILITY

This section documents areas of questionable portability between

implementations of the

Line 884 language.

Line 959 language.

.Bl -dash -compact

.It

In quoted literals, GNU troff allowed pair-wise double-quotes to produce

a standalone double-quote in formatted output. It is not known whether

a standalone double-quote in formatted output.

this behaviour is exhibited by other formatters.

It is not known whether this behaviour is exhibited by other formatters.

.It

The

troff suppresses a newline before

.Sx \&sp

macro does not accept negative values in mandoc. In GNU troff, this

would result in strange behaviour.

.It

The

.Sq \(aq

macro control character, in GNU troff (and prior troffs) suppresses a

macro output; in mandoc, it is an alias for the standard

newline before macro output; in mandoc, it is an alias for the standard

.Sq \&.

control character.

.It

The

.Sq \eh

.Pq horizontal position ,

.Sq \ev

.Pq vertical position ,

.Sq \em

.Pq text colour ,

.Sq \eM

.Pq text filling colour ,

.Sq \ez

.Pq zero-length character ,

.Sq \ew

.Pq string length ,

.Sq \ek

.Pq horizontal position marker ,

.Sq \eo

.Pq text overstrike ,

and

.Sq \es

.Pq text size

escape sequences are all discarded in mandoc.

.It

The

.Sq \ef

scaling unit is accepted by mandoc, but rendered as the default unit.

.It

The

.Sx \&sp

macro does not accept negative values in mandoc.

In GNU troff, this would result in strange behaviour.

.El

.Sh SEE ALSO

.Xr man 1 ,

.Xr mandoc 1 ,

.Xr mandoc_char 7

.Xr eqn 7 ,

.Sh AUTHORS

.Xr mandoc_char 7 ,

.Xr mdoc 7 ,

.Xr roff 7 ,

.Xr tbl 7

.Sh HISTORY

The

.Nm

language first appeared as a macro package for the roff typesetting

system in

.At v7 .

It was later rewritten by James Clark as a macro package for groff.

The stand-alone implementation that is part of the

.Xr mandoc 1

utility written by Kristaps Dzonsons appeared in

.Ox 4.6 .

.Sh AUTHORS

This

.Nm

reference was written by

.An Kristaps Dzonsons Aq kristaps@bsd.lv .

.An Kristaps Dzonsons ,

.Mt kristaps@bsd.lv .

.Sh CAVEATS

Do not use this language. Use

Do not use this language.

Use

.Xr mdoc 7 ,

instead.

CVSweb