mandoc/man.7 - diff

Return to man.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/man.7 between version 1.70 and 1.78

version 1.70, 2010/05/14 16:19:26

version 1.78, 2010/07/19 23:21:39

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 37 Use the

.Xr mdoc 7

language, instead.

.Pp

.Nm

document follows simple rules: lines beginning with the control

character

Line 52 Other lines are interpreted within the current state.

.Sh INPUT ENCODING

.Nm

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

space character, and the tabs character.

space character, and the tab character.

All manuals must have

.Ux

line termination.

Line 61 Blank lines are acceptable; where found, the output wi

vertical space.

.Ss Comments

Text following a

.Sq \e\*" ,

.Sq \e\*q ,

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

line.

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

.Sq \&.\e" ,

.Sq \&.\e\*q ,

is also ignored.

Macro lines with only a control character and optionally whitespace are

stripped from input.

Line 92 and

.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 (Roman), or P

(revert to previous mode):

.Pp

.D1 \efBbold\efR \efIitalic\efP

Line 106 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

escape, whose syntax is one of

.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

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

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

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

.Pp

Both

.Sq \es

and

.Sq \ef

attributes are forgotten when entering or exiting a macro block.

attribute is forgotten when entering or exiting a macro block.

.Ss Whitespace

Whitespace consists of the space character.

In free-form lines, whitespace is preserved within a line; un-escaped

Line 216 literal text.

Line 193 literal text.

When composing a manual, make sure that your sentences end at the end of

a line.

By doing so, front-ends will be able to apply the proper amount of

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

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

mark.

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

delimiters (

.Ns Sq \&) ,

.Sq \&] ,

.Sq \&' ,

.Sq \&" ) .

.Sh MANUAL STRUCTURE

Each

.Nm

Line 233 at least one macro or text node must appear in the doc

Line 215 at least one macro or text node must appear in the doc

Documents are generally structured as follows:

.Bd -literal -offset indent

\&.TH FOO 1 2009-10-10

\&.

\&.SH NAME

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

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

\&.\e\*q .SH LIBRARY

\&.

\&.SH SYNOPSIS

\efBfoo\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 2, 3, & 9 only.

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

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

Line 300 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 short description of how

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

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

Line 368 The history of any manual without a

Line 346 The history of any manual without a

section should be described in this section.

.It Em AUTHORS

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

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

control character ,

control character,

.Sq \&. ,

at the beginning of the line.

The

Line 415 is equivalent to

Line 394 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 429 The syntax is as follows:

Line 408 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 443 The syntax is as follows:

Line 423 The syntax is as follows:

.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

Line 524 This section is a canonical reference to all macros, a

Line 504 This section is a canonical reference to all macros, a

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

Line 676 and

Line 661 and

Begin an undecorated paragraph.

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

sub-section, section, or end of file.

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

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

.Pp