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

version 1.1, 2009/03/23 16:02:56 version 1.107, 2011/08/30 12:16:36
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.
 prior macros:  Lines not beginning with the control character are
 .Bd -literal -offset XXX  interpreted within the scope of prior macros:
   .Bd -literal -offset indent
 \&.SH Macro lines change control state.  \&.SH Macro lines change control state.
 Other lines are interpreted within the current state.  Text lines are interpreted within the current state.
 .Ed  .Ed
 .\" PARAGRAPH  .Sh LANGUAGE SYNTAX
 .Pp  
 Macros are character sequences whose structural rules are described  
 later in this document.  
 .\" SECTION  
 .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 \  .  The back-space character
 All manuals must have  .Sq \e
 .Sq \en  indicates the start of an escape sequence for
 line termination.  .Sx Comments ,
   .Sx Predefined Strings ,
   and
   .Sx Special Characters .
   .Ss Comments
   Text following an escaped double-quote
   .Sq \e\(dq ,
   whether in a macro or text line, is ignored to the end of
   line.
   A macro line beginning with a control character and comment escape
   .Sq \&.\e\(dq
   is also ignored.
   Furthermore,
   macro lines with only a control character and optional trailing
   whitespace are
   stripped from input.
 .Pp  .Pp
 Blank lines are acceptable; where found, the output will also assert a  Examples:
 vertical space.  .Bd -literal -offset indent -compact
 .\" SUB-SECTION  \&.\e\(dq This is a comment line.
   \&.\e\(dq The next line is ignored:
   \&.
   \&.Em Emphasis \e\(dq This is also a comment.
   .Ed
 .Ss Special Characters  .Ss Special Characters
 Special character sequences begin with the escape character  Special characters are used to encode special glyphs and are rendered
 .Sq \\  differently across output media.
 followed by either an open-parenthesis  They may occur in both macro and text lines.
   Sequences begin with the escape character
   .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.
 .Pp  .Pp
 Characters may alternatively be escaped by a slash-asterisk,  Examples:
 .Sq \\* ,  .Bl -tag -width Ds -offset indent -compact
 with the same combinations as described above.  This form is deprecated.  .It Li \e(em
   Two-letter em dash escape.
   .It Li \ee
   One-letter backslash escape.
   .El
 .Pp  .Pp
 The following is a table of all available escapes.  See
   .Xr mandoc_char 7
   for a complete list.
   .Ss Text Decoration
   Terms may be text-decorated using the
   .Sq \ef
   escape followed by an indicator: B (bold), I (italic), R (regular), or P
   (revert to previous mode).
   A numerical representation 3, 2, or 1 (bold, italic, and regular,
   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  .Pp
 .It \\(en  Examples:
 .Pq en-dash  .Bl -tag -width Ds -offset indent -compact
 .It \e-  .It Li \efBbold\efR
 .Pq hyphen  Write in bold, then switch to regular font mode.
 .It \\\\  .It Li \efIitalic\efP
 .Pq back-slash  Write in italic, then return to previous font mode.
 .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  .El
 .\" PARAGRAPH  .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  .Pp
 Enclosures:  Examples:
 .Bl -tag -width 12n -offset "XXXX" -compact  .Bl -tag -width Ds -offset indent -compact
 .It \\(lh  .It Li \e*(Am
 .Pq left hand  Two-letter ampersand predefined string.
 .It \\(rh  .It Li \e*q
 .Pq right hand  One-letter double-quote predefined string.
 .It \\(Fo  
 .Pq left guillemet  
 .It \\(Fc  
 .Pq right guillemet  
 .It \\(fo  
 .Pq left guilsing  
 .It \\(fc  
 .Pq right guilsing  
 .It \\(rC  
 .Pq right brace  
 .It \\(lC  
 .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  .El
 .\" PARAGRAPH  
 .Pp  .Pp
 Indicatives:  These strings are set using
 .Bl -tag -width 12n -offset "XXXX" -compact  .Xr roff 7 ,
 .It \\(<-  although
 .Pq left arrow  .Nm
 .It \\(->  consists of several pre-set escapes listed in
 .Pq right arrow  .Xr mandoc_char 7 .
 .It \\(ua  .Ss Whitespace
 .Pq up arrow  Whitespace consists of the space character.
 .It \\(da  In text lines, whitespace is preserved within a line.
 .Pq down arrow  In macro lines, whitespace delimits arguments and is discarded.
 .It \\(<>  .Pp
 .Pq left-right arrow  Unescaped trailing spaces are stripped from text line input unless in a
 .It \\(lA  literal context.
 .Pq left double-arrow  In general, trailing whitespace on any input line is discouraged for
 .It \\(rA  reasons of portability.
 .Pq right double-arrow  In the rare case that a blank character is needed at the end of an
 .It \\(uA  input line, it may be forced by
 .Pq up double-arrow  .Sq \e\ \e& .
 .It \\(dA  .Pp
 .Pq down double-arrow  In general, space characters can be rendered as literal
 .It \\(hA  characters by using non-breaking space escapes or
 .Pq left-right double-arrow  .Sx Quotation .
   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 to so that the
   enclosed text is one literal term.
   Quoted text, even if whitespace or if it would cause a macro invocation
   when unquoted, is considered literal text.
   .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
   Examples:
   .Bl -tag -width Ds -offset indent -compact
   .It Li .BR a \(dqb c\(dq d
   Group arguments
   .Qq b c
   into one un-bolded argument.
   If unspecified,
   .Qq a
   and
   .Qq c
   will be in bold,
   .Qq b
   and
   .Qq d
   in regular font mode.
   Furthermore, will be preserved between
   .Qq b
   and
   .Qq c .
 .El  .El
 .\" PARAGRAPH  .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.
 .Pp  .Pp
 Mathematical:  The following scaling units are accepted:
 .Bl -tag -width 12n -offset "XXXX" -compact  .Pp
 .It \\(es  .Bl -tag -width Ds -offset indent -compact
 .Pq empty set  .It c
 .It \\(ca  centimetre
 .Pq intersection  .It i
 .It \\(cu  inch
 .Pq union  .It P
 .It \\(gr  pica (~1/6 inch)
 .Pq gradient  .It p
 .It \\(pd  point (~1/72 inch)
 .Pq partial differential  .It f
 .It \\(ap  synonym for
 .Pq similarity  .Sq u
 .It \\(=)  .It v
 .Pq proper superset  default vertical span
 .It \\((=  .It m
 .Pq proper subset  width of rendered
 .It \\(eq  .Sq m
 .Pq equals  .Pq em
 .It \\(di  character
 .Pq division  .It n
 .It \\(mu  width of rendered
 .Pq multiplication  .Sq n
 .It \\(pl  .Pq en
 .Pq addition  character
 .It \\(nm  .It u
 .Pq not element  default horizontal span
 .It \\(mo  .It M
 .Pq element  mini-em (~1/100 em)
 .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  See
 .It \\(OE  .Sx COMPATIBILITY .
 .Pq upper-case OE  .Pp
 .It \\(oe  If a scaling unit is not provided, the numerical value is interpreted
 .Pq lower-case OE  under the default rules of
 .It \\(ff  .Sq v
 .Pq ff ligature  for vertical spaces and
 .It \\(fi  .Sq u
 .Pq fi ligature  for horizontal ones.
 .It \\(fl  .Pp
 .Pq fl ligature  Examples:
 .It \\(Fi  .Bl -tag -width Ds -offset indent -compact
 .Pq ffi ligature  .It \&.HP 2i
 .It \\(Fl  two-inch tagged list indentation
 .Pq ffl ligature  .Pq see Sx \&HP
   .It \&.sp 2v
   two vertical spaces
   .Pq see Sx \&sp
 .El  .El
 .\" PARAGRAPH  .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  .Pp
 Diacritics and letters:  Examples:
 .Bl -tag -width 12n -offset "XXXX" -compact  .Bd -literal -offset indent -compact
 .It \\(ga  Do not end sentences mid-line like this.  Instead,
 .Pq grave accent  end a sentence like this.
 .It \\(aa  A new sentence gets a new line.
 .Pq accute accent  .Ed
 .It \\(a"  .Sh MANUAL STRUCTURE
 .Pq umlaut accent  Each
 .It \\(ad  .Nm
 .Pq dieresis accent  document must contain the
 .It \\(a~  .Sx \&TH
 .Pq tilde accent  macro describing the document's section and title.
 .It \\(a^  It may occur anywhere in the document, although conventionally it
 .Pq circumflex accent  appears as the first macro.
 .It \\(ac  .Pp
 .Pq cedilla accent  Beyond
 .It \\(ad  .Sx \&TH ,
 .Pq dieresis accent  at least one macro or text node must appear in the document.
 .It \\(ah  .Pp
 .Pq caron accent  The following is a well-formed skeleton
 .It \\(ao  .Nm
 .Pq ring accent  file for a utility
 .It \\(ho  .Qq progname :
 .Pq hook accent  .Bd -literal -offset indent
 .It \\(ab  \&.TH PROGNAME 1 2009-10-10
 .Pq breve accent  \&.SH NAME
 .It \\(a-  \efBprogname\efR \e(en a description goes here
 .Pq macron accent  \&.\e\(dq .SH LIBRARY
 .It \\(-D  \&.\e\(dq For sections 2 & 3 only.
 .Pq upper-case eth  \&.\e\(dq Not used in OpenBSD.
 .It \\(Sd  \&.SH SYNOPSIS
 .Pq lower-case eth  \efBprogname\efR [\efB\e-options\efR] arguments...
 .It \\(TP  \&.SH DESCRIPTION
 .Pq upper-case thorn  The \efBfoo\efR utility processes files...
 .It \\(Tp  \&.\e\(dq .SH IMPLEMENTATION NOTES
 .Pq lower-case thorn  \&.\e\(dq Not used in OpenBSD.
 .It \\('A  \&.\e\(dq .SH RETURN VALUES
 .Pq upper-case acute A  \&.\e\(dq For sections 2, 3, & 9 only.
 .It \\('E  \&.\e\(dq .SH ENVIRONMENT
 .Pq upper-case acute E  \&.\e\(dq For sections 1, 6, 7, & 8 only.
 .It \\('I  \&.\e\(dq .SH FILES
 .Pq upper-case acute I  \&.\e\(dq .SH EXIT STATUS
 .It \\('O  \&.\e\(dq For sections 1, 6, & 8 only.
 .Pq upper-case acute O  \&.\e\(dq .SH EXAMPLES
 .It \\('U  \&.\e\(dq .SH DIAGNOSTICS
 .Pq upper-case acute U  \&.\e\(dq For sections 1, 4, 6, 7, & 8 only.
 .It \\('a  \&.\e\(dq .SH ERRORS
 .Pq lower-case acute a  \&.\e\(dq For sections 2, 3, & 9 only.
 .It \\('e  \&.\e\(dq .SH SEE ALSO
 .Pq lower-case acute e  \&.\e\(dq .BR foo ( 1 )
 .It \\('i  \&.\e\(dq .SH STANDARDS
 .Pq lower-case acute i  \&.\e\(dq .SH HISTORY
 .It \\('o  \&.\e\(dq .SH AUTHORS
 .Pq lower-case acute o  \&.\e\(dq .SH CAVEATS
 .It \\('u  \&.\e\(dq .SH BUGS
 .Pq lower-case acute u  \&.\e\(dq .SH SECURITY CONSIDERATIONS
 .It \\(`A  \&.\e\(dq Not used in OpenBSD.
 .Pq upper-case grave A  .Ed
 .It \\(`E  .Pp
 .Pq upper-case grave E  The sections in a
 .It \\(`I  .Nm
 .Pq upper-case grave I  document are conventionally ordered as they appear above.
 .It \\(`O  Sections should be composed as follows:
 .Pq upper-case grave O  .Bl -ohang -offset indent
 .It \\(`U  .It Em NAME
 .Pq upper-case grave U  The name(s) and a short description of the documented material.
 .It \\(`a  The syntax for this is generally as follows:
 .Pq lower-case grave a  .Pp
 .It \\(`e  .D1 \efBname\efR \e(en description
 .Pq lower-case grave e  .It Em LIBRARY
 .It \\(`i  The name of the library containing the documented material, which is
 .Pq lower-case grave i  assumed to be a function in a section 2 or 3 manual.
 .It \\(`o  For functions in the C library, this may be as follows:
 .Pq lower-case grave o  .Pp
 .It \\(`u  .D1 Standard C Library (libc, -lc)
 .Pq lower-case grave u  .It Em SYNOPSIS
 .It \\(~A  Documents the utility invocation syntax, function call syntax, or device
 .Pq upper-case tilde A  configuration.
 .It \\(~N  .Pp
 .Pq upper-case tilde N  For the first, utilities (sections 1, 6, and 8), this is
 .It \\(~O  generally structured as follows:
 .Pq upper-case tilde O  .Pp
 .It \\(~a  .D1 \efBname\efR [-\efBab\efR] [-\efBc\efR\efIarg\efR] \efBpath\efR...
 .Pq lower-case tilde a  .Pp
 .It \\(~n  For the second, function calls (sections 2, 3, 9):
 .Pq lower-case tilde n  .Pp
 .It \\(~o  .D1 \&.B char *name(char *\efIarg\efR);
 .Pq lower-case tilde o  .Pp
 .It \\(:A  And for the third, configurations (section 4):
 .Pq upper-case dieresis A  .Pp
 .It \\(:E  .D1 \&.B name* at cardbus ? function ?
 .Pq upper-case dieresis E  .Pp
 .It \\(:I  Manuals not in these sections generally don't need a
 .Pq upper-case dieresis I  .Em SYNOPSIS .
 .It \\(:O  .It Em DESCRIPTION
 .Pq upper-case dieresis O  This expands upon the brief, one-line description in
 .It \\(:U  .Em NAME .
 .Pq upper-case dieresis U  It usually contains a break-down of the options (if documenting a
 .It \\(:a  command).
 .Pq lower-case dieresis a  .It Em IMPLEMENTATION NOTES
 .It \\(:e  Implementation-specific notes should be kept here.
 .Pq lower-case dieresis e  This is useful when implementing standard functions that may have side
 .It \\(:i  effects or notable algorithmic implications.
 .Pq lower-case dieresis i  .It Em RETURN VALUES
 .It \\(:o  This section documents the return values of functions in sections 2, 3, and 9.
 .Pq lower-case dieresis o  .It Em ENVIRONMENT
 .It \\(:u  Documents any usages of environment variables, e.g.,
 .Pq lower-case dieresis u  .Xr environ 7 .
 .It \\(:y  .It Em FILES
 .Pq lower-case dieresis y  Documents files used.
 .It \\(^A  It's helpful to document both the file name and a short description of how
 .Pq upper-case circumflex A  the file is used (created, modified, etc.).
 .It \\(^E  .It Em EXIT STATUS
 .Pq upper-case circumflex E  This section documents the command exit status for
 .It \\(^I  section 1, 6, and 8 utilities.
 .Pq upper-case circumflex I  Historically, this information was described in
 .It \\(^O  .Em DIAGNOSTICS ,
 .Pq upper-case circumflex O  a practise that is now discouraged.
 .It \\(^U  .It Em EXAMPLES
 .Pq upper-case circumflex U  Example usages.
 .It \\(^a  This often contains snippets of well-formed,
 .Pq lower-case circumflex a  well-tested invocations.
 .It \\(^e  Make sure that examples work properly!
 .Pq lower-case circumflex e  .It Em DIAGNOSTICS
 .It \\(^i  Documents error conditions.
 .Pq lower-case circumflex i  This is most useful in section 4 manuals.
 .It \\(^o  Historically, this section was used in place of
 .Pq lower-case circumflex o  .Em EXIT STATUS
 .It \\(^u  for manuals in sections 1, 6, and 8; however, this practise is
 .Pq lower-case circumflex u  discouraged.
 .It \\(,C  .It Em ERRORS
 .Pq upper-case cedilla C  Documents error handling in sections 2, 3, and 9.
 .It \\(,c  .It Em SEE ALSO
 .Pq lower-case cedilla c  References other manuals with related topics.
 .It \\(/L  This section should exist for most manuals.
 .Pq upper-case stroke L  .Pp
 .It \\(/l  .D1 \&.BR bar \&( 1 \&),
 .Pq lower-case stroke l  .Pp
 .It \\(/O  Cross-references should conventionally be ordered
 .Pq upper-case stroke O  first by section, then alphabetically.
 .It \\(/o  .It Em STANDARDS
 .Pq lower-case stroke o  References any standards implemented or used, such as
 .It \\(oA  .Pp
 .Pq upper-case ring A  .D1 IEEE Std 1003.2 (\e(lqPOSIX.2\e(rq)
 .It \\(oa  .Pp
 .Pq lower-case ring a  If not adhering to any standards, the
   .Em HISTORY
   section should be used.
   .It Em HISTORY
   A brief history of the subject, including where support first appeared.
   .It Em AUTHORS
   Credits to the person or persons who wrote the code and/or documentation.
   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
 Monetary:  To include space characters in macro arguments, arguments may be quoted;
 .Bl -tag -width 12n -offset "XXXX" -compact  see the
 .It \\(Cs  .Sq MACRO SYNTAX
 .Pq Scandinavian  section in the
 .It \\(Do  .Xr roff 7
 .Pq dollar  manual for details.
 .It \\(Po  .Pp
 .Pq pound  The
 .It \\(Ye  .Nm
 .Pq yen  macros are classified by scope: line scope or block scope.
 .It \\(Fn  Line macros are only scoped to the current line (and, in some
 .Pq florin  situations, the subsequent line).
 .It \\(ct  Block macros are scoped to the current line and subsequent lines until
 .Pq cent  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 line and the line arguments are empty,
   the next line, which must be text, is used instead.
   Thus:
   .Bd -literal -offset indent
   \&.I
   foo
   .Ed
   .Pp
   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, except for
   .Sx \&br ,
   .Sx \&sp ,
   and
   .Sx \&na .
   .Pp
   The syntax is as follows:
   .Bd -literal -offset indent
   \&.YO \(lBbody...\(rB
   \(lBbody...\(rB
   .Ed
   .Bl -column -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    \&
   .It Sx \&DT  Ta    0         Ta    current   Ta    \&
   .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 \&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    <=1       Ta    current   Ta    \&
   .It Sx \&br  Ta    0         Ta    current   Ta    compat
   .It Sx \&fi  Ta    0         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 \&sp  Ta    1         Ta    current   Ta    compat
 .El  .El
 .\" PARAGRAPH  
 .Pp  .Pp
 Special symbols:  Macros marked as
 .Bl -tag -width 12n -offset "XXXX" -compact  .Qq compat
 .It \\(de  are included for compatibility with the significant corpus of existing
 .Pq degree  manuals that mix dialects of roff.
 .It \\(ps  These macros should not be used for portable
 .Pq paragraph  .Nm
 .It \\(sc  manuals.
 .Pq section  .Ss Block Macros
 .It \\(dg  Block macros comprise a head and body.
 .Pq dagger  As with in-line macros, the head is scoped to the current line and, in
 .It \\(dd  one circumstance, the next line (the next-line stipulations as in
 .Pq double dagger  .Sx Line Macros
 .It \\(ci  apply here as well).
 .Pq circle  .Pp
 .It \\(ba  The syntax is as follows:
 .Pq bar  .Bd -literal -offset indent
 .It \\(bb  \&.YO \(lBhead...\(rB
 .Pq broken bar  \(lBhead...\(rB
 .It \\(Ba  \(lBbody...\(rB
 .Pq bar, deprecated  
 .It \\(co  
 .Pq copyright  
 .It \\(rg  
 .Pq registered  
 .It \\(tm  
 .Pq trademarked  
 .It \\&  
 .Pq non-breaking space  
 .It \\e  
 .Pq escape  
 .It \\(Am  
 .Pq ampersand, deprecated  
 .El  
 .\" SECTION  
 .Sh STRUCTURE  
 Macros are case in-sensitive and one to three three characters in  
 length.  All follow the same structural rules:  
 .Bd -literal -offset XXXX  
 \&.Yo \(lBbody...\(rB  
 .Ed  .Ed
 .Pp  .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.
   .Bl -column -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
   .Pp
   Macros marked
   .Qq compat
   are as mentioned in
   .Sx Line Macros .
   .Pp
   If a block macro is next-line scoped, it may only be followed by in-line
   macros for decorating text.
   .Sh REFERENCE
   This section is a canonical reference to all macros, arranged
   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
   and
   .Sx \&R .
   .Ss \&BI
   Text is rendered alternately in bold face and italic.
   Thus,
   .Sq .BI this word and that
   causes
   .Sq this
   and
   .Sq and
   to render in bold face, while
   .Sq word
   and
   .Sq that
   render in italics.
   Whitespace between arguments is omitted in output.
   .Pp
   Examples:
   .Pp
   .Dl \&.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
   .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
   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
   and
   .Sx \&B .
   .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 .
   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.
   .Pp
   See
   .Sx \&BI
   for an equivalent example.
   .Pp
   See also
   .Sx \&BI ,
   .Sx \&IB ,
   .Sx \&BR ,
   .Sx \&RB ,
   and
   .Sx \&IR .
   .Ss \&RS
   Temporarily reset the default left margin.
   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.
   .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 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
   .Ar title section date
   .Op Ar source Op Ar volume
   .Ed
   .Pp
   Conventionally, the document
   .Ar title
   is given in all caps.
   The recommended
   .Ar date
   format is
   .Sy YYYY-MM-DD
   as specified in the ISO-8601 standard;
   if the argument does not conform, it is printed verbatim.
   If the
   .Ar date
   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
   .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.
   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 \&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 \&ft
   Change the current font mode.
   See
   .Sx Text Decoration
   for a listing of available font modes.
   .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 .
   Literal mode is implicitly ended by
   .Sx \&SH
   or
   .Sx \&SS .
   .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 .
   .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  In quoted literals, GNU troff allowed pair-wise double-quotes to produce
 .It \&.SH    Ta    n  a standalone double-quote in formatted output.
 .It \&.SS    Ta    n  It is not known whether this behaviour is exhibited by other formatters.
 .It \&.TP    Ta    n  .It
 .It \&.LP    Ta    n  troff suppresses a newline before
 .It \&.PP    Ta    n  .Sq \(aq
 .It \&.P     Ta    n  macro output; in mandoc, it is an alias for the standard
 .It \&.IP    Ta    n  .Sq \&.
 .It \&.HP    Ta    n  control character.
 .It \&.SM    Ta    n  .It
 .It \&.SB    Ta    n  The
 .It \&.BI    Ta    n  .Sq \eh
 .It \&.IB    Ta    n  .Pq horizontal position ,
 .It \&.BR    Ta    n  .Sq \ev
 .It \&.RB    Ta    n  .Pq vertical position ,
 .It \&.R     Ta    n  .Sq \em
 .It \&.B     Ta    n  .Pq text colour ,
 .It \&.I     Ta    n  .Sq \eM
 .It \&.IR    Ta    n  .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  .El
 .\" SECTION  
 .Sh SEE ALSO  .Sh SEE ALSO
   .Xr man 1 ,
   .Xr mandoc 1 ,
   .Xr eqn 7 ,
   .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  .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 ,
 .\" SECTION  .Mt kristaps@bsd.lv .
 .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.107
CVSweb