[BACK]Return to man.7 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/man.7 between version 1.1 and 1.80

version 1.1, 2009/03/23 16:02:56 version 1.80, 2010/07/26 10:00:03
Line 1 
Line 1 
 .\" $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>  .\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"  .\"
 .\" Permission to use, copy, modify, and distribute this software for any  .\" 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$  .Dd $Mdocdate$
 .Dt man 7  .Dt MAN 7
 .Os  .Os
 .\" SECTION  
 .Sh NAME  .Sh NAME
 .Nm man  .Nm man
 .Nd man language reference  .Nd man language reference
 .\" SECTION  
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm man  .Nm man
 language was historically used to format  language was historically used to format
 .Ux  .Ux
 manuals.  In this reference document, we describe the syntax and  manuals.
 structure of the  This reference document describes its syntax, structure, and usage.
 .Nm  
 language.  
 .Pp  .Pp
 .Em \&Do not  .Bf -emphasis
 use  Do not use
 .Nm  .Nm
 to write your manuals.  Use the  to write your manuals.
   .Ef
   Use the
 .Xr mdoc 7  .Xr mdoc 7
 language, instead.  language, instead.
 .\" PARAGRAPH  
 .Pp  .Pp
 An  A
 .Nm  .Nm
 document follows simple rules:  lines beginning with the control  document follows simple rules:  lines beginning with the control
 character  character
 .Sq \.  .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:  prior macros:
 .Bd -literal -offset XXX  .Bd -literal -offset indent
 \&.SH Macro lines change control state.  \&.SH Macro lines change control state.
 Other lines are interpreted within the current state.  Other lines are interpreted within the current state.
 .Ed  .Ed
 .\" PARAGRAPH  
 .Pp  
 Macros are character sequences whose structural rules are described  
 later in this document.  
 .\" SECTION  
 .Sh INPUT ENCODING  .Sh INPUT ENCODING
 .Nm  .Nm
 documents may contain only graphable 7-bit ASCII characters and the  documents may contain only graphable 7-bit ASCII characters, the
 space character  space character, and the tab character.
 .Sq \  .  
 All manuals must have  All manuals must have
 .Sq \en  .Ux
 line termination.  line termination.
 .Pp  .Pp
 Blank lines are acceptable; where found, the output will also assert a  Blank lines are acceptable; where found, the output will assert a
 vertical space.  vertical space.
 .\" SUB-SECTION  .Ss Comments
   Text following a
   .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\*q ,
   is also ignored.
   Macro lines with only a control character and optionally whitespace are
   stripped from input.
 .Ss Special Characters  .Ss Special Characters
 Special character sequences begin with the escape character  Special characters may occur in both macro and free-form lines.
 .Sq \\  Sequences begin with the escape character
 followed by either an open-parenthesis  .Sq \e
   followed by either an open-parenthesis
 .Sq \&(  .Sq \&(
 for two-character sequences; an open-bracket  for two-character sequences; an open-bracket
 .Sq \&[  .Sq \&[
 for n-character sequences (terminated at a close-bracket  for n-character sequences (terminated at a close-bracket
 .Sq \&] ) ;  .Sq \&] ) ;
 or a single one-character sequence.  or a single one-character sequence.
   See
   .Xr mandoc_char 7
   for a complete list.
   Examples include
   .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
   (revert to previous mode):
 .Pp  .Pp
 Characters may alternatively be escaped by a slash-asterisk,  .D1 \efBbold\efR \efIitalic\efP
 .Sq \\* ,  
 with the same combinations as described above.  This form is deprecated.  
 .Pp  .Pp
 The following is a table of all available escapes.  A numerical representation 3, 2, or 1 (bold, italic, and Roman,
   respectively) may be used instead.
   A text decoration is only valid, if 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  .Pp
 Grammatic:  The
 .Bl -tag -width 12n -offset "XXXX" -compact  .Sq \ef
 .It \\(em  attribute is forgotten when entering or exiting a macro block.
 .Pq em-dash  .Ss Whitespace
 .It \\(en  Whitespace consists of the space character.
 .Pq en-dash  In free-form lines, whitespace is preserved within a line; unescaped
 .It \e-  trailing spaces are stripped from input (unless in a literal context).
 .Pq hyphen  Blank free-form lines, which may include spaces, are permitted and
 .It \\\\  rendered as an empty line.
 .Pq back-slash  
 .It \e'  
 .Pq apostrophe  
 .It \e`  
 .Pq back-tick  
 .It \\  
 .Pq space  
 .It \\.  
 .Pq period  
 .It \\(r!  
 .Pq upside-down exclamation  
 .It \\(r?  
 .Pq upside-down question  
 .El  
 .\" PARAGRAPH  
 .Pp  .Pp
 Enclosures:  In macro lines, whitespace delimits arguments and is discarded.
 .Bl -tag -width 12n -offset "XXXX" -compact  If arguments are quoted, whitespace within the quotes is retained.
 .It \\(lh  .Ss Dates
 .Pq left hand  The
 .It \\(rh  .Sx \&TH
 .Pq right hand  macro is the only
 .It \\(Fo  .Nm
 .Pq left guillemet  macro that requires a date.
 .It \\(Fc  The form for this date is the ISO-8601
 .Pq right guillemet  standard
 .It \\(fo  .Cm YYYY-MM-DD .
 .Pq left guilsing  .Ss Scaling Widths
 .It \\(fc  Many macros support scaled widths for their arguments, such as
 .Pq right guilsing  stipulating a two-inch paragraph indentation with the following:
 .It \\(rC  .Bd -literal -offset indent
 .Pq right brace  \&.HP 2i
 .It \\(lC  .Ed
 .Pq left brace  
 .It \\(ra  
 .Pq right angle  
 .It \\(la  
 .Pq left angle  
 .It \\(rB  
 .Pq right bracket  
 .It \\(lB  
 .Pq left bracket  
 .It \\q  
 .Pq double-quote  
 .It \\(lq  
 .Pq left double-quote  
 .It \\(Lq  
 .Pq left double-quote, deprecated  
 .It \\(rq  
 .Pq right double-quote  
 .It \\(Rq  
 .Pq right double-quote, deprecated  
 .It \\(oq  
 .Pq left single-quote  
 .It \\(aq  
 .Pq right single-quote  
 .It \\(Bq  
 .Pq right low double-quote  
 .It \\(bq  
 .Pq right low single-quote  
 .El  
 .\" PARAGRAPH  
 .Pp  .Pp
 Indicatives:  The syntax for scaled widths is
 .Bl -tag -width 12n -offset "XXXX" -compact  .Sq Li [+-]?[0-9]*.[0-9]*[:unit:]? ,
 .It \\(<-  where a decimal must be preceded or proceeded by at least one digit.
 .Pq left arrow  Negative numbers, while accepted, are truncated to zero.
 .It \\(->  The following scaling units are accepted:
 .Pq right arrow  
 .It \\(ua  
 .Pq up arrow  
 .It \\(da  
 .Pq down arrow  
 .It \\(<>  
 .Pq left-right arrow  
 .It \\(lA  
 .Pq left double-arrow  
 .It \\(rA  
 .Pq right double-arrow  
 .It \\(uA  
 .Pq up double-arrow  
 .It \\(dA  
 .Pq down double-arrow  
 .It \\(hA  
 .Pq left-right double-arrow  
 .El  
 .\" PARAGRAPH  
 .Pp  .Pp
 Mathematical:  .Bl -tag -width Ds -offset indent -compact
 .Bl -tag -width 12n -offset "XXXX" -compact  .It c
 .It \\(es  centimetre
 .Pq empty set  .It i
 .It \\(ca  inch
 .Pq intersection  .It P
 .It \\(cu  pica (~1/6 inch)
 .Pq union  .It p
 .It \\(gr  point (~1/72 inch)
 .Pq gradient  .It f
 .It \\(pd  synonym for
 .Pq partial differential  .Sq u
 .It \\(ap  .It v
 .Pq similarity  default vertical span
 .It \\(=)  .It m
 .Pq proper superset  width of rendered
 .It \\((=  .Sq m
 .Pq proper subset  .Pq em
 .It \\(eq  character
 .Pq equals  .It n
 .It \\(di  width of rendered
 .Pq division  .Sq n
 .It \\(mu  .Pq en
 .Pq multiplication  character
 .It \\(pl  .It u
 .Pq addition  default horizontal span
 .It \\(nm  .It M
 .Pq not element  mini-em (~1/100 em)
 .It \\(mo  
 .Pq element  
 .It \\(Im  
 .Pq imaginary  
 .It \\(Re  
 .Pq real  
 .It \\(Ah  
 .Pq aleph  
 .It \\(te  
 .Pq existential quantifier  
 .It \\(fa  
 .Pq universal quantifier  
 .It \\(AN  
 .Pq logical AND  
 .It \\(OR  
 .Pq logical OR  
 .It \\(no  
 .Pq logical NOT  
 .It \\(st  
 .Pq such that  
 .It \\(tf  
 .Pq therefore  
 .It \\(~~  
 .Pq approximate  
 .It \\(~=  
 .Pq approximately equals  
 .It \\(=~  
 .Pq congruent  
 .It \\(Gt  
 .Pq greater-than, deprecated  
 .It \\(Lt  
 .Pq less-than, deprecated  
 .It \\(<=  
 .Pq less-than-equal  
 .It \\(Le  
 .Pq less-than-equal, deprecated  
 .It \\(>=  
 .Pq greater-than-equal  
 .It \\(Ge  
 .Pq greater-than-equal  
 .It \\(==  
 .Pq equal  
 .It \\(!=  
 .Pq not equal  
 .It \\(Ne  
 .Pq not equal, deprecated  
 .It \\(if  
 .Pq infinity  
 .It \\(If  
 .Pq infinity, deprecated  
 .It \\(na  
 .Pq NaN , an extension  
 .It \\(Na  
 .Pq NaN, deprecated  
 .It \\(+-  
 .Pq plus-minus  
 .It \\(Pm  
 .Pq plus-minus, deprecated  
 .It \\(**  
 .Pq asterisk  
 .El  .El
 .\" PARAGRAPH  
 .Pp  .Pp
 Ligatures:  Using anything other than
 .Bl -tag -width 12n -offset "XXXX" -compact  .Sq m ,
 .It \\(ss  .Sq n ,
 .Pq German eszett  .Sq u ,
 .It \\(AE  or
 .Pq upper-case AE  .Sq v
 .It \\(ae  is necessarily non-portable across output media.
 .Pq lower-case AE  .Pp
 .It \\(OE  If a scaling unit is not provided, the numerical value is interpreted
 .Pq upper-case OE  under the default rules of
 .It \\(oe  .Sq v
 .Pq lower-case OE  for vertical spaces and
 .It \\(ff  .Sq u
 .Pq ff ligature  for horizontal ones.
 .It \\(fi  .Em Note :
 .Pq fi ligature  this differs from
 .It \\(fl  .Xr mdoc 7 ,
 .Pq fl ligature  which, if a unit is not provided, will instead interpret the string as
 .It \\(Fi  literal text.
 .Pq ffi ligature  .Ss Sentence Spacing
 .It \\(Fl  When composing a manual, make sure that sentences end at the end of
 .Pq ffl ligature  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 mark,
   or question mark followed by zero or more non-sentence closing
   delimiters
   .Po
   .Sq \&) ,
   .Sq \&] ,
   .Sq \&' ,
   .Sq \&"
   .Pc .
   .Sh MANUAL STRUCTURE
   Each
   .Nm
   document must contain the
   .Sx \&TH
   macro describing the document's section and title.
   It may occur anywhere in the document, although conventionally it
   appears as the first macro.
   .Pp
   Beyond
   .Sx \&TH ,
   at least one macro or text node must appear in the document.
   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
   \&.\e\*q The next is for sections 1, 6, 7, & 8 only.
   \&.\e\*q .SH ENVIRONMENT
   \&.\e\*q .SH FILES
   \&.\e\*q The next is for sections 1 & 8 only.
   \&.\e\*q .SH EXIT STATUS
   \&.\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 .SH ERRORS
   \&.\e\*q .SH SEE ALSO
   \&.\e\*q .BR foo ( 1 )
   \&.\e\*q .SH STANDARDS
   \&.\e\*q .SH HISTORY
   \&.\e\*q .SH AUTHORS
   \&.\e\*q .SH CAVEATS
   \&.\e\*q .SH BUGS
   \&.\e\*q .SH SECURITY CONSIDERATIONS
   .Ed
   .Pp
   The sections in a
   .Nm
   document are conventionally ordered as they appear above.
   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 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 the C library, this may be as follows:
   .Pp
   .D1 Standard C Library (libc, -lc)
   .It Em SYNOPSIS
   Documents the utility invocation syntax, function call syntax, or device
   configuration.
   .Pp
   For the first, utilities (sections 1, 6, and 8), this is
   generally structured as follows:
   .Pp
   .D1 \efBname\efR [-\efBab\efR] [-\efBc\efR\efIarg\efR] \efBpath\efR...
   .Pp
   For the second, function calls (sections 2, 3, 9):
   .Pp
   .D1 \&.B char *name(char *\efIarg\efR);
   .Pp
   And for the third, configurations (section 4):
   .Pp
   .D1 \&.B name* at cardbus ? function ?
   .Pp
   Manuals not in these sections generally don't need a
   .Em SYNOPSIS .
   .It Em DESCRIPTION
   This expands upon the brief, one-line description in
   .Em NAME .
   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 implementing standard functions that may have side
   effects or notable algorithmic implications.
   .It Em RETURN VALUES
   This section 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 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,
   well-tested invocations.
   Make sure that examples work properly!
   .It Em DIAGNOSTICS
   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
   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 for most manuals.
   .Pp
   .D1 \&.BR bar \&( 1 \&),
   .Pp
   Cross-references should conventionally be ordered
   first by section, then alphabetically.
   .It Em STANDARDS
   References any standards implemented or used, such as
   .Pp
   .D1 IEEE Std 1003.2 (\e(lqPOSIX.2\e(rq)
   .Pp
   If not adhering to any standards, the
   .Em HISTORY
   section should be used.
   .It Em HISTORY
   The history of any manual without a
   .Em STANDARDS
   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 email address.
   .It Em CAVEATS
   Common misuses and misunderstandings should be explained
   in this section.
   .It Em BUGS
   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  .El
 .\" PARAGRAPH  .Sh MACRO SYNTAX
   Macros are one to three characters in length and begin with a
   control character,
   .Sq \&. ,
   at the beginning of the line.
   The
   .Sq \(aq
   macro control character is also accepted.
   An arbitrary amount of whitespace (spaces or tabs) may sit between the
   control character and the macro name.
   Thus, the following are equivalent:
   .Bd -literal -offset indent
   \&.PP
   \&.\ \ \ PP
   .Ed
 .Pp  .Pp
 Diacritics and letters:  The
 .Bl -tag -width 12n -offset "XXXX" -compact  .Nm
 .It \\(ga  macros are classified by scope: line scope or block scope.
 .Pq grave accent  Line macros are only scoped to the current line (and, in some
 .It \\(aa  situations, the subsequent line).
 .Pq accute accent  Block macros are scoped to the current line and subsequent lines until
 .It \\(a"  closed by another block macro.
 .Pq umlaut accent  .Ss Line Macros
 .It \\(ad  Line macros are generally scoped to the current line, with the body
 .Pq dieresis accent  consisting of zero or more arguments.
 .It \\(a~  If a macro is scoped to the next line and the line arguments are empty,
 .Pq tilde accent  the next line, which must be text, is used instead.
 .It \\(a^  Thus:
 .Pq circumflex accent  .Bd -literal -offset indent
 .It \\(ac  \&.I
 .Pq cedilla accent  foo
 .It \\(ad  .Ed
 .Pq dieresis accent  .Pp
 .It \\(ah  is equivalent to
 .Pq caron accent  .Sq \&.I foo .
 .It \\(ao  If next-line macros are invoked consecutively, only the last is used.
 .Pq ring accent  If a next-line macro is followed by a non-next-line macro, an error is
 .It \\(ho  raised, except for
 .Pq hook accent  .Sx \&br ,
 .It \\(ab  .Sx \&sp ,
 .Pq breve accent  and
 .It \\(a-  .Sx \&na .
 .Pq macron accent  .Pp
 .It \\(-D  The syntax is as follows:
 .Pq upper-case eth  .Bd -literal -offset indent
 .It \\(Sd  \&.YO \(lBbody...\(rB
 .Pq lower-case eth  \(lBbody...\(rB
 .It \\(TP  .Ed
 .Pq upper-case thorn  .Pp
 .It \\(Tp  .Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX"
 .Pq lower-case thorn  .It Em Macro Ta Em Arguments Ta Em Scope     Ta Em Notes
 .It \\('A  .It Sx \&AT  Ta    <=1       Ta    current   Ta    \&
 .Pq upper-case acute A  .It Sx \&B   Ta    n         Ta    next-line Ta    \&
 .It \\('E  .It Sx \&BI  Ta    n         Ta    current   Ta    \&
 .Pq upper-case acute E  .It Sx \&BR  Ta    n         Ta    current   Ta    \&
 .It \\('I  .It Sx \&DT  Ta    0         Ta    current   Ta    \&
 .Pq upper-case acute I  .It Sx \&I   Ta    n         Ta    next-line Ta    \&
 .It \\('O  .It Sx \&IB  Ta    n         Ta    current   Ta    \&
 .Pq upper-case acute O  .It Sx \&IR  Ta    n         Ta    current   Ta    \&
 .It \\('U  .\" .It Sx \&PD  Ta    n         Ta    current   Ta    compat
 .Pq upper-case acute U  .It Sx \&R   Ta    n         Ta    next-line Ta    \&
 .It \\('a  .It Sx \&RB  Ta    n         Ta    current   Ta    \&
 .Pq lower-case acute a  .It Sx \&RI  Ta    n         Ta    current   Ta    \&
 .It \\('e  .It Sx \&SB  Ta    n         Ta    next-line Ta    \&
 .Pq lower-case acute e  .It Sx \&SM  Ta    n         Ta    next-line Ta    \&
 .It \\('i  .It Sx \&TH  Ta    >1, <6    Ta    current   Ta    \&
 .Pq lower-case acute i  .It Sx \&UC  Ta    <=1       Ta    current   Ta    \&
 .It \\('o  .It Sx \&br  Ta    0         Ta    current   Ta    compat
 .Pq lower-case acute o  .It Sx \&fi  Ta    0         Ta    current   Ta    compat
 .It \\('u  .It Sx \&i   Ta    n         Ta    current   Ta    compat
 .Pq lower-case acute u  .It Sx \&in  Ta    1         Ta    current   Ta    compat
 .It \\(`A  .It Sx \&na  Ta    0         Ta    current   Ta    compat
 .Pq upper-case grave A  .It Sx \&nf  Ta    0         Ta    current   Ta    compat
 .It \\(`E  .It Sx \&r   Ta    0         Ta    current   Ta    compat
 .Pq upper-case grave E  .It Sx \&sp  Ta    1         Ta    current   Ta    compat
 .It \\(`I  .\" .It Sx \&Sp  Ta    <1        Ta    current   Ta    compat
 .Pq upper-case grave I  .\" .It Sx \&Vb  Ta    <1        Ta    current   Ta    compat
 .It \\(`O  .\" .It Sx \&Ve  Ta    0         Ta    current   Ta    compat
 .Pq upper-case grave O  
 .It \\(`U  
 .Pq upper-case grave U  
 .It \\(`a  
 .Pq lower-case grave a  
 .It \\(`e  
 .Pq lower-case grave e  
 .It \\(`i  
 .Pq lower-case grave i  
 .It \\(`o  
 .Pq lower-case grave o  
 .It \\(`u  
 .Pq lower-case grave u  
 .It \\(~A  
 .Pq upper-case tilde A  
 .It \\(~N  
 .Pq upper-case tilde N  
 .It \\(~O  
 .Pq upper-case tilde O  
 .It \\(~a  
 .Pq lower-case tilde a  
 .It \\(~n  
 .Pq lower-case tilde n  
 .It \\(~o  
 .Pq lower-case tilde o  
 .It \\(:A  
 .Pq upper-case dieresis A  
 .It \\(:E  
 .Pq upper-case dieresis E  
 .It \\(:I  
 .Pq upper-case dieresis I  
 .It \\(:O  
 .Pq upper-case dieresis O  
 .It \\(:U  
 .Pq upper-case dieresis U  
 .It \\(:a  
 .Pq lower-case dieresis a  
 .It \\(:e  
 .Pq lower-case dieresis e  
 .It \\(:i  
 .Pq lower-case dieresis i  
 .It \\(:o  
 .Pq lower-case dieresis o  
 .It \\(:u  
 .Pq lower-case dieresis u  
 .It \\(:y  
 .Pq lower-case dieresis y  
 .It \\(^A  
 .Pq upper-case circumflex A  
 .It \\(^E  
 .Pq upper-case circumflex E  
 .It \\(^I  
 .Pq upper-case circumflex I  
 .It \\(^O  
 .Pq upper-case circumflex O  
 .It \\(^U  
 .Pq upper-case circumflex U  
 .It \\(^a  
 .Pq lower-case circumflex a  
 .It \\(^e  
 .Pq lower-case circumflex e  
 .It \\(^i  
 .Pq lower-case circumflex i  
 .It \\(^o  
 .Pq lower-case circumflex o  
 .It \\(^u  
 .Pq lower-case circumflex u  
 .It \\(,C  
 .Pq upper-case cedilla C  
 .It \\(,c  
 .Pq lower-case cedilla c  
 .It \\(/L  
 .Pq upper-case stroke L  
 .It \\(/l  
 .Pq lower-case stroke l  
 .It \\(/O  
 .Pq upper-case stroke O  
 .It \\(/o  
 .Pq lower-case stroke o  
 .It \\(oA  
 .Pq upper-case ring A  
 .It \\(oa  
 .Pq lower-case ring a  
 .El  .El
 .\" PARAGRAPH  
 .Pp  .Pp
 Monetary:  Macros marked as
 .Bl -tag -width 12n -offset "XXXX" -compact  .Qq compat
 .It \\(Cs  are included for compatibility with the significant corpus of existing
 .Pq Scandinavian  manuals that mix dialects of roff.
 .It \\(Do  These macros should not be used for portable
 .Pq dollar  .Nm
 .It \\(Po  manuals.
 .Pq pound  .Ss Block Macros
 .It \\(Ye  Block macros comprise a head and body.
 .Pq yen  As with in-line macros, the head is scoped to the current line and, in
 .It \\(Fn  one circumstance, the next line (the next-line stipulations as in
 .Pq florin  .Sx Line Macros
 .It \\(ct  apply here as well).
 .Pq cent  .Pp
   The syntax is as follows:
   .Bd -literal -offset indent
   \&.YO \(lBhead...\(rB
   \(lBhead...\(rB
   \(lBbody...\(rB
   .Ed
   .Pp
   The closure of body scope may be to the section, where a macro is closed
   by
   .Sx \&SH ;
   sub-section, closed by a section or
   .Sx \&SS ;
   part, closed by a section, sub-section, or
   .Sx \&RE ;
   or paragraph, closed by a section, sub-section, part,
   .Sx \&HP ,
   .Sx \&IP ,
   .Sx \&LP ,
   .Sx \&P ,
   .Sx \&PP ,
   or
   .Sx \&TP .
   No closure refers to an explicit block closing macro.
   .Pp
   As a rule, block macros may not be nested; thus, calling a block macro
   while another block macro scope is open, and the open scope is not
   implicitly closed, is syntactically incorrect.
   .Pp
   .Bl -column -compact -offset indent "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX"
   .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope  Ta Em Notes
   .It Sx \&HP  Ta    <2        Ta    current    Ta    paragraph   Ta    \&
   .It Sx \&IP  Ta    <3        Ta    current    Ta    paragraph   Ta    \&
   .It Sx \&LP  Ta    0         Ta    current    Ta    paragraph   Ta    \&
   .It Sx \&P   Ta    0         Ta    current    Ta    paragraph   Ta    \&
   .It Sx \&PP  Ta    0         Ta    current    Ta    paragraph   Ta    \&
   .It Sx \&RE  Ta    0         Ta    current    Ta    none        Ta    compat
   .It Sx \&RS  Ta    1         Ta    current    Ta    part        Ta    compat
   .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    \&
 .El  .El
 .\" PARAGRAPH  
 .Pp  .Pp
 Special symbols:  Macros marked
 .Bl -tag -width 12n -offset "XXXX" -compact  .Qq compat
 .It \\(de  are as mentioned in
 .Pq degree  .Sx Line Macros .
 .It \\(ps  .Pp
 .Pq paragraph  If a block macro is next-line scoped, it may only be followed by in-line
 .It \\(sc  macros for decorating text.
 .Pq section  .Sh REFERENCE
 .It \\(dg  This section is a canonical reference to all macros, arranged
 .Pq dagger  alphabetically.
 .It \\(dd  For the scoping of individual macros, see
 .Pq double dagger  .Sx MACRO SYNTAX .
 .It \\(ci  .Ss \&AT
 .Pq circle  Sets the volume for the footer for compatibility with man pages from
 .It \\(ba  .Tn AT&T UNIX
 .Pq bar  releases.
 .It \\(bb  The optional arguments specify which release it is from.
 .Pq broken bar  .Ss \&B
 .It \\(Ba  Text is rendered in bold face.
 .Pq bar, deprecated  .Pp
 .It \\(co  See also
 .Pq copyright  .Sx \&I ,
 .It \\(rg  .Sx \&R ,
 .Pq registered  .Sx \&b ,
 .It \\(tm  .Sx \&i ,
 .Pq trademarked  and
 .It \\&  .Sx \&r .
 .Pq non-breaking space  .Ss \&BI
 .It \\e  Text is rendered alternately in bold face and italic.
 .Pq escape  Thus,
 .It \\(Am  .Sq .BI this word and that
 .Pq ampersand, deprecated  causes
 .El  .Sq this
 .\" SECTION  and
 .Sh STRUCTURE  .Sq and
 Macros are case in-sensitive and one to three three characters in  to render in bold face, while
 length.  All follow the same structural rules:  .Sq word
 .Bd -literal -offset XXXX  and
 \&.Yo \(lBbody...\(rB  .Sq that
   render in italics.
   Whitespace between arguments is omitted in output.
   .Pp
   Examples:
   .Pp
   .D1 \&.BI bold italic bold italic
   .Pp
   The output of this example will be emboldened
   .Dq bold
   and italicised
   .Dq italic ,
   with spaces stripped between arguments.
   .Pp
   See also
   .Sx \&IB ,
   .Sx \&BR ,
   .Sx \&RB ,
   .Sx \&RI ,
   and
   .Sx \&IR .
   .Ss \&BR
   Text is rendered alternately in bold face and roman (the default font).
   Whitespace between arguments is omitted in output.
   .Pp
   See
   .Sx \&BI
   for an equivalent example.
   .Pp
   See also
   .Sx \&BI ,
   .Sx \&IB ,
   .Sx \&RB ,
   .Sx \&RI ,
   and
   .Sx \&IR .
   .Ss \&DT
   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:
   .Bd -filled -offset indent
   .Pf \. Sx \&HP
   .Op Cm width
 .Ed  .Ed
 .Pp  .Pp
 The  The
 .Dq body  .Cm width
 consists of zero or more arguments to the macro.  argument must conform to
 .\" PARAGRAPH  .Sx Scaling Widths .
 .Sh MACROS  If specified, it's saved for later paragraph left-margins; if unspecified, the
 This section contains a complete list of all  saved or default width is used.
   .Pp
   See also
   .Sx \&IP ,
   .Sx \&LP ,
   .Sx \&P ,
   .Sx \&PP ,
   and
   .Sx \&TP .
   .Ss \&I
   Text is rendered in italics.
   .Pp
   See also
   .Sx \&B ,
   .Sx \&R ,
   .Sx \&b ,
   .Sx \&i ,
   and
   .Sx \&r .
   .Ss \&IB
   Text is rendered alternately in italics and bold face.
   Whitespace between arguments is omitted in output.
   .Pp
   See
   .Sx \&BI
   for an equivalent example.
   .Pp
   See also
   .Sx \&BI ,
   .Sx \&BR ,
   .Sx \&RB ,
   .Sx \&RI ,
   and
   .Sx \&IR .
   .Ss \&IP
   Begin an indented paragraph with the following syntax:
   .Bd -filled -offset indent
   .Pf \. Sx \&IP
   .Op Cm head Op Cm width
   .Ed
   .Pp
   The
   .Cm width
   argument defines the width of the left margin and is defined by
   .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 useful for bulleted paragraphs and so on.
   .Pp
   See also
   .Sx \&HP ,
   .Sx \&LP ,
   .Sx \&P ,
   .Sx \&PP ,
   and
   .Sx \&TP .
   .Ss \&IR
   Text is rendered alternately in italics and roman (the default font).
   Whitespace between arguments is omitted in output.
   .Pp
   See
   .Sx \&BI
   for an equivalent example.
   .Pp
   See also
   .Sx \&BI ,
   .Sx \&IB ,
   .Sx \&BR ,
   .Sx \&RB ,
   and
   .Sx \&RI .
   .Ss \&LP
   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 reset to the default.
   .Pp
   See also
   .Sx \&HP ,
   .Sx \&IP ,
   .Sx \&P ,
   .Sx \&PP ,
   and
   .Sx \&TP .
   .Ss \&P
   Synonym for
   .Sx \&LP .
   .Pp
   See also
   .Sx \&HP ,
   .Sx \&IP ,
   .Sx \&LP ,
   .Sx \&PP ,
   and
   .Sx \&TP .
   .Ss \&PP
   Synonym for
   .Sx \&LP .
   .Pp
   See also
   .Sx \&HP ,
   .Sx \&IP ,
   .Sx \&LP ,
   .Sx \&P ,
   and
   .Sx \&TP .
   .Ss \&R
   Text is rendered in roman (the default font).
   .Pp
   See also
   .Sx \&I ,
   .Sx \&B ,
   .Sx \&b ,
   .Sx \&i ,
   and
   .Sx \&r .
   .Ss \&RB
   Text is rendered alternately in roman (the default font) and bold face.
   Whitespace between arguments is omitted in output.
   .Pp
   See
   .Sx \&BI
   for an equivalent example.
   .Pp
   See also
   .Sx \&BI ,
   .Sx \&IB ,
   .Sx \&BR ,
   .Sx \&RI ,
   and
   .Sx \&IR .
   .Ss \&RE
   Explicitly close out the scope of a prior
   .Sx \&RS .
   .Ss \&RI
   Text is rendered alternately in roman (the default font) and italics.
   Whitespace between arguments is omitted in output.
   .Pp
   See
   .Sx \&BI
   for an equivalent example.
   .Pp
   See also
   .Sx \&BI ,
   .Sx \&IB ,
   .Sx \&BR ,
   .Sx \&RB ,
   and
   .Sx \&IR .
   .Ss \&RS
   Begin a part setting the left margin.
   The left margin controls the 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
   .Op Cm width
   .Ed
   .Pp
   The
   .Cm width
   argument must conform to
   .Sx Scaling Widths .
   If not specified, the saved or default width is used.
   .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 section or the end of
   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 subsequent sub-section,
   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
   .Op Cm date Op Cm source Op Cm volume
   .Ed
   .Pp
   At least the upper-case document
   .Cm title
   and the manual
   .Cm section
   arguments must be provided.
   The
   .Cm date
   argument should be formatted as described in
   .Sx Dates ,
   but will be printed verbatim if it is not.
   If the date is not specified, the current date is used.
   The
   .Cm source
   string specifies the organisation providing the utility.
   The
   .Cm 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
   .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.
   The syntax is as follows:
   .Bd -filled -offset indent
   .Pf \. Sx \&TP
   .Op Cm width
   .Ed
   .Pp
   The
   .Cm width
   argument must conform to
   .Sx Scaling Widths .
   If specified, it's saved for later paragraph left-margins; if
   unspecified, the saved or default width is used.
   .Pp
   See also
   .Sx \&HP ,
   .Sx \&IP ,
   .Sx \&LP ,
   .Sx \&P ,
   and
   .Sx \&PP .
   .\" .
   .\" .
   .\" .Ss \&PD
   .\" Has no effect.  Included for compatibility.
   .\" .
   .\" .
   .Ss \&UC
   Sets the volume for the footer for compatibility with man pages from
   BSD releases.
   The optional first argument specifies which release it is from.
   .Ss \&br
   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
   Italicise arguments.
   Synonym for
   .Sx \&I .
   .Pp
   See also
   .Sx \&B ,
   .Sx \&I ,
   .Sx \&R .
   .Sx \&b ,
   and
   .Sx \&r .
   .Ss \&in
   Indent relative to the current indentation:
   .Pp
   .D1 Pf \. Sx \&in Op Cm width
   .Pp
   If
   .Cm width
   is signed, the new offset is relative.
   Otherwise, it is absolute.
   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
   .Sx \&fi .
   .Ss \&r
   Fonts and styles (bold face, italics) reset to roman (default font).
   .Pp
   See also
   .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
   .Pf \. Sx \&sp
   .Op Cm height
   .Ed
   .Pp
   Insert
   .Cm height
   spaces, which must conform to
   .Sx Scaling Widths .
   If 0, this is equivalent to the
   .Sx \&br
   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
 .Nm  .Nm
 macros, arranged alphabetically, with the number of arguments.  language.
 .Pp  .Pp
 .Bl -column "MacroX" "Arguments" -compact -offset XXXX  .Bl -dash -compact
 .It Em Macro Ta Em Arguments  .It
 .It \&.TH    Ta    >0  The \es (font size), \em (font colour), and \eM (font filling colour)
 .It \&.SH    Ta    n  font decoration escapes are all discarded in mandoc.
 .It \&.SS    Ta    n  .It
 .It \&.TP    Ta    n  In quoted literals, GNU troff allowed pair-wise double-quotes to produce
 .It \&.LP    Ta    n  a standalone double-quote in formatted output.
 .It \&.PP    Ta    n  It is not known whether this behaviour is exhibited by other formatters.
 .It \&.P     Ta    n  .It
 .It \&.IP    Ta    n  The
 .It \&.HP    Ta    n  .Sx \&sp
 .It \&.SM    Ta    n  macro does not accept negative values in mandoc.
 .It \&.SB    Ta    n  In GNU troff, this would result in strange behaviour.
 .It \&.BI    Ta    n  .It
 .It \&.IB    Ta    n  The
 .It \&.BR    Ta    n  .Sq \(aq
 .It \&.RB    Ta    n  macro control character, in GNU troff (and prior troffs) suppresses a
 .It \&.R     Ta    n  newline before macro output; in mandoc, it is an alias for the standard
 .It \&.B     Ta    n  .Sq \&.
 .It \&.I     Ta    n  control character.
 .It \&.IR    Ta    n  
 .El  .El
 .\" SECTION  
 .Sh SEE ALSO  .Sh SEE ALSO
   .Xr mandoc 1 ,
   .Xr mandoc_char 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  .Xr mandoc 1
 .\" SECTION  utility written by Kristaps Dzonsons appeared in
   .Ox 4.6 .
 .Sh AUTHORS  .Sh AUTHORS
 The  This
 .Nm  .Nm
 utility was written by  reference was written by
 .An Kristaps Dzonsons Aq kristaps@openbsd.org .  .An Kristaps Dzonsons Aq kristaps@bsd.lv .
 .\" SECTION  
 .Sh CAVEATS  .Sh CAVEATS
 Do not use this language.  Use  Do not use this language.
   Use
 .Xr mdoc 7 ,  .Xr mdoc 7 ,
 instead.  instead.

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.80

CVSweb