mandoc/man.7 - diff

Return to man.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/man.7 between version 1.117 and 1.124

version 1.117, 2012/06/20 22:06:30

version 1.124, 2014/02/16 14:26: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 above

Line 97 file for a utility

Line 98 file for a utility

.Bd -literal -offset indent

\&.TH PROGNAME 1 2009-10-10

\&.SH NAME

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

\efBprogname\efR \e(en one line about what it does

\&.\e\(dq .SH LIBRARY

\&.\e\(dq For sections 2 & 3 only.

\&.\e\(dq For sections 2, 3, and 9 only.

\&.\e\(dq Not used in OpenBSD.

\&.SH SYNOPSIS

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

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

\&.SH DESCRIPTION

The \efBfoo\efR utility processes files...

The \efBfoo\efR utility processes files ...

\&.\e\(dq .SH IMPLEMENTATION NOTES

\&.\e\(dq Not used in OpenBSD.

\&.\e\(dq .SH RETURN VALUES

\&.\e\(dq For sections 2, 3, & 9 only.

\&.\e\(dq For sections 2, 3, and 9 function return values only.

\&.\e\(dq .SH ENVIRONMENT

\&.\e\(dq For sections 1, 6, 7, & 8 only.

\&.\e\(dq For sections 1, 6, 7, and 8 only.

\&.\e\(dq .SH FILES

\&.\e\(dq .SH EXIT STATUS

\&.\e\(dq For sections 1, 6, & 8 only.

\&.\e\(dq For sections 1, 6, and 8 only.

\&.\e\(dq .SH EXAMPLES

\&.\e\(dq .SH DIAGNOSTICS

\&.\e\(dq For sections 1, 4, 6, 7, & 8 only.

\&.\e\(dq For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.

\&.\e\(dq .SH ERRORS

\&.\e\(dq For sections 2, 3, & 9 only.

\&.\e\(dq For sections 2, 3, 4, and 9 errno settings only.

\&.\e\(dq .SH SEE ALSO

\&.\e\(dq .BR foo ( 1 )

\&.\e\(dq .BR foobar ( 1 )

\&.\e\(dq .SH STANDARDS

\&.\e\(dq .SH HISTORY

\&.\e\(dq .SH AUTHORS

Line 196 well-tested invocations.

Line 197 well-tested invocations.

Make sure that examples work properly!

.It Em DIAGNOSTICS

Documents error conditions.

This is most useful in section 4 manuals.

In section 4 and 9 manuals, these are usually messages

printed by the kernel to the console and to the kernel log.

In section 1, 6, 7, and 8, these are usually messages

printed by userland programs to the standard error output.

.Pp

Historically, this section was used in place of

.Em EXIT STATUS

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

discouraged.

.It Em ERRORS

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

Documents

.Xr errno 2

settings in sections 2, 3, 4, and 9.

.It Em SEE ALSO

References other manuals with related topics.

This section should exist for most manuals.

Line 253 in the alphabetical reference below.

Line 260 in the alphabetical reference below.

.It Sx IP Ta indented paragraph: Op Ar head Op Ar width

.It Sx TP Ta tagged paragraph: Op Ar width

.It Sx HP Ta hanged paragraph: Op Ar width

.It Sx PD Ta set vertical paragraph distance: Op Ar height

.It Sx \&br Ta force output line break in text mode (no arguments)

.It Sx \&sp Ta force vertical space: Op Ar height

.It Sx fi , nf Ta fill mode and no-fill mode (no arguments)

Line 279 For the scoping of individual macros, see

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

.At

releases.

The optional arguments specify which release it is from.

.Ss \&B

Line 476 See also

Line 484 See also

.Sx \&PP ,

and

.Sx \&TP .

.Ss \&PD

Specify the vertical space to be inserted before each new paragraph.

.br

The syntax is as follows:

.Bd -filled -offset indent

.Pf \. Sx \&PD

.Op Cm height

.Ed

.Pp

The

.Cm height

argument is a

.Xr roff 7

scaling width.

It defaults to

.Cm 1v .

If the unit is omitted,

.Cm v

is assumed.

.Pp

This macro affects the spacing before any subsequent instances of

.Sx \&HP ,

.Sx \&IP ,

.Sx \&LP ,

.Sx \&P ,

.Sx \&PP ,

.Sx \&SH ,

.Sx \&SS ,

and

.Sx \&TP .

.Ss \&PP

Synonym for

.Sx \&LP .

Line 622 and

Line 660 and

.Sx \&PP .

.Ss \&UC

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

BSD releases.

.Bx

releases.

The optional first argument specifies which release it is from.

.Ss \&UE

End a uniform resource identifier block.

This is a non-standard GNU extension, included only for compatibility.

See

.Sx \&UE .

.Ss \&UR

Begin a uniform resource identifier block.

This is a non-standard GNU extension, included only for compatibility.

It has the following syntax:

.Bd -literal -offset indent

.Pf \. Sx \&UR Ar uri

link description to be shown

.Pf \. Sx UE

.Ed

.Ss \&br

Breaks the current line.

Consecutive invocations have no further effect.

Line 718 The syntax is as follows:

Line 771 The syntax is as follows:

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

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

.It Sx \&DT Ta 0 Ta current Ta \&

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

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

.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 \&OP Ta 0, 1 Ta current Ta compat

.It Sx \&PD Ta 1 Ta current Ta \&

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

Line 791 implicitly closed, is syntactically incorrect.

Line 847 implicitly closed, is syntactically incorrect.

.It Sx \&SH Ta >0 Ta next-line Ta section Ta \&

.It Sx \&SS Ta >0 Ta next-line Ta sub-section Ta \&

.It Sx \&TP Ta n Ta next-line Ta paragraph Ta \&

.It Sx \&UE Ta 0 Ta current Ta none Ta compat

.It Sx \&UR Ta 1 Ta current Ta part Ta compat

.El

.Pp

Macros marked

Line 917 utility written by Kristaps Dzonsons appeared in

Line 975 utility written by Kristaps Dzonsons appeared in

This

.Nm

reference was written by

.An Kristaps Dzonsons ,

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

.Mt kristaps@bsd.lv .

.Sh CAVEATS

Do not use this language.

Use

CVSweb