version 1.278, 2019/04/24 13:15:00 |
version 1.290, 2024/05/20 18:15:57 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2010, 2011, 2013-2018 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2010, 2011, 2013-2020 Ingo Schwarze <schwarze@openbsd.org> |
.\" |
.\" |
.\" 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 above |
.\" purpose with or without fee is hereby granted, provided that the above |
Line 297 utility does this, that, and the other. |
|
Line 297 utility does this, that, and the other. |
|
It usually follows with a breakdown of the options (if documenting a |
It usually follows with a breakdown of the options (if documenting a |
command), such as: |
command), such as: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
The arguments are as follows: |
The options are as follows: |
\&.Bl \-tag \-width Ds |
\&.Bl \-tag \-width Ds |
\&.It Fl v |
\&.It Fl v |
Print verbose information. |
Print verbose information. |
Line 439 in the alphabetical |
|
Line 439 in the alphabetical |
|
.Bl -column "Brq, Bro, Brc" description |
.Bl -column "Brq, Bro, Brc" description |
.It Ic \&Dd Ta document date: Cm $\&Mdocdate$ | Ar month day , year |
.It Ic \&Dd Ta document date: Cm $\&Mdocdate$ | Ar month day , year |
.It Ic \&Dt Ta document title: Ar TITLE section Op Ar arch |
.It Ic \&Dt Ta document title: Ar TITLE section Op Ar arch |
.It Ic \&Os Ta operating system version: Op Ar system Op Ar version |
.It Ic \&Os Ta operating system footer: Op Ar footer text |
.It Ic \&Nm Ta document name (one argument) |
.It Ic \&Nm Ta document name (one argument) |
.It Ic \&Nd Ta document description (one line) |
.It Ic \&Nd Ta document description (one line) |
.El |
.El |
Line 449 in the alphabetical |
|
Line 449 in the alphabetical |
|
.It Ic \&Ss Ta subsection header (one line) |
.It Ic \&Ss Ta subsection header (one line) |
.It Ic \&Sx Ta internal cross reference to a section or subsection |
.It Ic \&Sx Ta internal cross reference to a section or subsection |
.It Ic \&Xr Ta cross reference to another manual page: Ar name section |
.It Ic \&Xr Ta cross reference to another manual page: Ar name section |
|
.It Ic \&Tg Ta tag the definition of a Ar term Pq <= 1 arguments |
.It Ic \&Pp Ta start a text paragraph (no arguments) |
.It Ic \&Pp Ta start a text paragraph (no arguments) |
.El |
.El |
.Ss Displays and lists |
.Ss Displays and lists |
|
|
.Ic \&Ao |
.Ic \&Ao |
block. |
block. |
Does not have any tail arguments. |
Does not have any tail arguments. |
|
.Tg Ad |
.It Ic \&Ad Ar address |
.It Ic \&Ad Ar address |
Memory address. |
Memory address. |
Do not use this for postal addresses. |
Do not use this for postal addresses. |
Line 638 Do not use this for postal addresses. |
|
Line 640 Do not use this for postal addresses. |
|
Examples: |
Examples: |
.Dl \&.Ad [0,$] |
.Dl \&.Ad [0,$] |
.Dl \&.Ad 0x00000000 |
.Dl \&.Ad 0x00000000 |
|
.Tg An |
.It Ic \&An Fl split | nosplit | Ar first_name ... last_name |
.It Ic \&An Fl split | nosplit | Ar first_name ... last_name |
Author name. |
Author name. |
Can be used both for the authors of the program, function, or driver |
Can be used both for the authors of the program, function, or driver |
Line 678 This macro is almost never useful. |
|
Line 681 This macro is almost never useful. |
|
See |
See |
.Ic \&Aq |
.Ic \&Aq |
for more details. |
for more details. |
|
.Tg Ap |
.It Ic \&Ap |
.It Ic \&Ap |
Inserts an apostrophe without any surrounding whitespace. |
Inserts an apostrophe without any surrounding whitespace. |
This is generally used as a grammatical device when referring to the verb |
This is generally used as a grammatical device when referring to the verb |
Line 685 form of a function. |
|
Line 689 form of a function. |
|
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Fn execve \&Ap d |
.Dl \&.Fn execve \&Ap d |
|
.Tg Aq |
.It Ic \&Aq Ar line |
.It Ic \&Aq Ar line |
Enclose the rest of the input line in angle brackets. |
Enclose the rest of the input line in angle brackets. |
The only important use case is for email addresses. |
The only important use case is for email addresses. |
|
|
.Pp |
.Pp |
See also |
See also |
.Ic \&Ao . |
.Ic \&Ao . |
|
.Tg Ar |
.It Ic \&Ar Op Ar placeholder ... |
.It Ic \&Ar Op Ar placeholder ... |
Command arguments. |
Command arguments. |
If an argument is not provided, the string |
If an argument is not provided, the string |
Line 747 for fixed strings to be passed verbatim as arguments, |
|
Line 753 for fixed strings to be passed verbatim as arguments, |
|
.Ic \&Fl |
.Ic \&Fl |
or |
or |
.Ic \&Cm . |
.Ic \&Cm . |
|
.Tg At |
.It Ic \&At Op Ar version |
.It Ic \&At Op Ar version |
Formats an |
Formats an |
.At |
.At |
|
|
.Ic \&Bo |
.Ic \&Bo |
block. |
block. |
Does not have any tail arguments. |
Does not have any tail arguments. |
|
.Tg Bd |
.It Ic \&Bd Fl Ns Ar type Oo Fl offset Ar width Oc Op Fl compact |
.It Ic \&Bd Fl Ns Ar type Oo Fl offset Ar width Oc Op Fl compact |
Begin a display block. |
Begin a display block. |
Display blocks are used to select a different indentation and |
Display blocks are used to select a different indentation and |
|
|
.Ic \&D1 |
.Ic \&D1 |
and |
and |
.Ic \&Dl . |
.Ic \&Dl . |
|
.Tg Bf |
.It Ic \&Bf Fl emphasis | literal | symbolic | Cm \&Em | \&Li | \&Sy |
.It Ic \&Bf Fl emphasis | literal | symbolic | Cm \&Em | \&Li | \&Sy |
Change the font mode for a scoped block of text. |
Change the font mode for a scoped block of text. |
The |
The |
|
|
.Ic \&Em , |
.Ic \&Em , |
and |
and |
.Ic \&Sy . |
.Ic \&Sy . |
|
.Tg Bk |
.It Ic \&Bk Fl words |
.It Ic \&Bk Fl words |
For each macro, keep its output together on the same output line, |
For each macro, keep its output together on the same output line, |
until the end of the macro or the end of the input line is reached, |
until the end of the macro or the end of the input line is reached, |
|
|
.Pp |
.Pp |
Be careful in using over-long lines within a keep block! |
Be careful in using over-long lines within a keep block! |
Doing so will clobber the right margin. |
Doing so will clobber the right margin. |
|
.Tg Bl |
.It Xo |
.It Xo |
.Ic \&Bl |
.Ic \&Bl |
.Fl Ns Ar type |
.Fl Ns Ar type |
|
|
.Pp |
.Pp |
See also |
See also |
.Ic \&Bq . |
.Ic \&Bq . |
|
.Tg Bq |
.It Ic \&Bq Ar line |
.It Ic \&Bq Ar line |
Encloses its arguments in square brackets. |
Encloses its arguments in square brackets. |
.Pp |
.Pp |
|
|
.Pp |
.Pp |
See also |
See also |
.Ic \&Brq . |
.Ic \&Brq . |
|
.Tg Brq |
.It Ic \&Brq Ar line |
.It Ic \&Brq Ar line |
Encloses its arguments in curly braces. |
Encloses its arguments in curly braces. |
.Pp |
.Pp |
|
|
.Pp |
.Pp |
See also |
See also |
.Ic \&Bro . |
.Ic \&Bro . |
|
.Tg Bsx |
.It Ic \&Bsx Op Ar version |
.It Ic \&Bsx Op Ar version |
Format the |
Format the |
.Bsx |
.Bsx |
|
|
Supported only for compatibility, do not use this in new manuals. |
Supported only for compatibility, do not use this in new manuals. |
Prints |
Prints |
.Dq is currently in beta test. |
.Dq is currently in beta test. |
|
.Tg Bx |
.It Ic \&Bx Op Ar version Op Ar variant |
.It Ic \&Bx Op Ar version Op Ar variant |
Format the |
Format the |
.Bx |
.Bx |
|
|
.Ic \&Nx , |
.Ic \&Nx , |
and |
and |
.Ic \&Ox . |
.Ic \&Ox . |
|
.Tg Cd |
.It Ic \&Cd Ar line |
.It Ic \&Cd Ar line |
Kernel configuration declaration. |
Kernel configuration declaration. |
This denotes strings accepted by |
This denotes strings accepted by |
Line 1161 whitespace and align consecutive |
|
Line 1177 whitespace and align consecutive |
|
.Ic \&Cd |
.Ic \&Cd |
declarations. |
declarations. |
This practise is discouraged. |
This practise is discouraged. |
|
.Tg Cm |
.It Ic \&Cm Ar keyword ... |
.It Ic \&Cm Ar keyword ... |
Command modifiers. |
Command modifiers. |
Typically used for fixed strings passed as arguments to interactive |
Typically used for fixed strings passed as arguments to interactive |
|
|
.Dl ".Ic set Fl o Cm vi" |
.Dl ".Ic set Fl o Cm vi" |
.Dl ".Ic lookup Cm file bind" |
.Dl ".Ic lookup Cm file bind" |
.Dl ".Ic permit Ar identity Op Cm as Ar target" |
.Dl ".Ic permit Ar identity Op Cm as Ar target" |
|
.Tg D1 |
.It Ic \&D1 Ar line |
.It Ic \&D1 Ar line |
One-line indented display. |
One-line indented display. |
This is formatted by the default rules and is useful for simple indented |
This is formatted by the default rules and is useful for simple indented |
|
|
.Ic \&Do |
.Ic \&Do |
block. |
block. |
Does not have any tail arguments. |
Does not have any tail arguments. |
|
.Tg Dd |
.It Ic \&Dd Cm $\&Mdocdate$ | Ar month day , year |
.It Ic \&Dd Cm $\&Mdocdate$ | Ar month day , year |
Document date for display in the page footer. |
Document date for display in the page footer, |
|
by convention the date of the last change. |
This is the mandatory first macro of any |
This is the mandatory first macro of any |
.Nm |
.Nm |
manual. |
manual. |
|
|
.Ic \&Dt |
.Ic \&Dt |
and |
and |
.Ic \&Os . |
.Ic \&Os . |
|
.Tg Dl |
.It Ic \&Dl Ar line |
.It Ic \&Dl Ar line |
One-line indented display. |
One-line indented display. |
This is formatted as literal text and is useful for commands and |
This is formatted as literal text and is useful for commands and |
Line 1276 April is the cruellest month |
|
Line 1297 April is the cruellest month |
|
.Pp |
.Pp |
See also |
See also |
.Ic \&Dq . |
.Ic \&Dq . |
|
.Tg Dq |
.It Ic \&Dq Ar line |
.It Ic \&Dq Ar line |
Encloses its arguments in |
Encloses its arguments in |
.Dq typographic |
.Dq typographic |
|
|
.Ic \&Sq , |
.Ic \&Sq , |
and |
and |
.Ic \&Do . |
.Ic \&Do . |
|
.Tg Dt |
.It Ic \&Dt Ar TITLE section Op Ar arch |
.It Ic \&Dt Ar TITLE section Op Ar arch |
Document title for display in the page header. |
Document title for display in the page header. |
This is the mandatory second macro of any |
This is the mandatory second macro of any |
|
|
.Ic \&Dd |
.Ic \&Dd |
and |
and |
.Ic \&Os . |
.Ic \&Os . |
|
.Tg Dv |
.It Ic \&Dv Ar identifier ... |
.It Ic \&Dv Ar identifier ... |
Defined variables such as preprocessor constants, constant symbols, |
Defined variables such as preprocessor constants, constant symbols, |
enumeration values, and so on. |
enumeration values, and so on. |
Line 1370 for variable symbols, and |
|
Line 1394 for variable symbols, and |
|
.Ic \&Fd |
.Ic \&Fd |
for listing preprocessor variable definitions in the |
for listing preprocessor variable definitions in the |
.Em SYNOPSIS . |
.Em SYNOPSIS . |
|
.Tg Dx |
.It Ic \&Dx Op Ar version |
.It Ic \&Dx Op Ar version |
Format the |
Format the |
.Dx |
.Dx |
Line 1411 End a list context started by |
|
Line 1436 End a list context started by |
|
.Ic \&Bl . |
.Ic \&Bl . |
See also |
See also |
.Ic \&It . |
.Ic \&It . |
|
.Tg Em |
.It Ic \&Em Ar word ... |
.It Ic \&Em Ar word ... |
Request an italic font. |
Request an italic font. |
If the output device does not provide that, underline. |
If the output device does not provide that, underline. |
Line 1450 or any of the other enclosure macros. |
|
Line 1476 or any of the other enclosure macros. |
|
It encloses its argument in the delimiters specified by the last |
It encloses its argument in the delimiters specified by the last |
.Ic \&Es |
.Ic \&Es |
macro. |
macro. |
|
.Tg Eo |
.It Ic \&Eo Op Ar opening_delimiter |
.It Ic \&Eo Op Ar opening_delimiter |
An arbitrary enclosure. |
An arbitrary enclosure. |
The |
The |
|
|
argument is used as the enclosure head, for example, specifying \e(lq |
argument is used as the enclosure head, for example, specifying \e(lq |
will emulate |
will emulate |
.Ic \&Do . |
.Ic \&Do . |
|
.Tg Er |
.It Ic \&Er Ar identifier ... |
.It Ic \&Er Ar identifier ... |
Error constants for definitions of the |
Error constants for definitions of the |
.Va errno |
.Va errno |
Line 1479 or any of the other enclosure macros. |
|
Line 1507 or any of the other enclosure macros. |
|
It takes two arguments, defining the delimiters to be used by subsequent |
It takes two arguments, defining the delimiters to be used by subsequent |
.Ic \&En |
.Ic \&En |
macros. |
macros. |
|
.Tg Ev |
.It Ic \&Ev Ar identifier ... |
.It Ic \&Ev Ar identifier ... |
Environmental variables such as those specified in |
Environmental variables such as those specified in |
.Xr environ 7 . |
.Xr environ 7 . |
|
|
See also |
See also |
.Ic \&Dv |
.Ic \&Dv |
for general constants. |
for general constants. |
|
.Tg Ex |
.It Ic \&Ex Fl std Op Ar utility ... |
.It Ic \&Ex Fl std Op Ar utility ... |
Insert a standard sentence regarding command exit values of 0 on success |
Insert a standard sentence regarding command exit values of 0 on success |
and >0 on failure. |
and >0 on failure. |
Line 1506 arguments are treated as separate utilities. |
|
Line 1536 arguments are treated as separate utilities. |
|
.Pp |
.Pp |
See also |
See also |
.Ic \&Rv . |
.Ic \&Rv . |
|
.Tg Fa |
.It Ic \&Fa Ar argument ... |
.It Ic \&Fa Ar argument ... |
Function argument or parameter. |
Function argument or parameter. |
Each argument may be a name and a type (recommended for the |
Each argument may be a name and a type (recommended for the |
|
|
.It Ic \&Fc |
.It Ic \&Fc |
End a function context started by |
End a function context started by |
.Ic \&Fo . |
.Ic \&Fo . |
|
.Tg Fd |
.It Ic \&Fd Pf # Ar directive Op Ar argument ... |
.It Ic \&Fd Pf # Ar directive Op Ar argument ... |
Preprocessor directive, in particular for listing it in the |
Preprocessor directive, in particular for listing it in the |
.Em SYNOPSIS . |
.Em SYNOPSIS . |
|
|
.Ic \&In , |
.Ic \&In , |
and |
and |
.Ic \&Dv . |
.Ic \&Dv . |
|
.Tg Fl |
.It Ic \&Fl Op Ar word ... |
.It Ic \&Fl Op Ar word ... |
Command-line flag or option. |
Command-line flag or option. |
Used when listing arguments to command-line utilities. |
Used when listing arguments to command-line utilities. |
Prints a fixed-width hyphen |
For each argument, prints an ASCII hyphen-minus character |
.Sq \- |
.Sq \- , |
directly followed by each argument. |
immediately followed by the argument. |
If no arguments are provided, a hyphen is printed followed by a space. |
If no arguments are provided, a hyphen-minus is printed followed by a space. |
If the argument is a macro, a hyphen is prefixed to the subsequent macro |
If the argument is a macro, a hyphen-minus is prefixed |
output. |
to the subsequent macro output. |
.Pp |
.Pp |
Examples: |
Examples: |
.Dl ".Fl R Op Fl H | L | P" |
.Dl ".Nm du Op Fl H | L | P" |
.Dl ".Op Fl 1AaCcdFfgHhikLlmnopqRrSsTtux" |
.Dl ".Nm ls Op Fl 1AaCcdFfgHhikLlmnopqRrSsTtux" |
.Dl ".Fl type Cm d Fl name Pa CVS" |
.Dl ".Nm route Cm add Fl inet Ar destination gateway" |
.Dl ".Fl Ar signal_number" |
.Dl ".Nm locate.updatedb Op Fl \e-fcodes Ns = Ns Ar dbfile" |
.Dl ".Fl o Fl" |
.Dl ".Nm aucat Fl o Fl" |
|
.Dl ".Nm kill Fl Ar signal_number" |
.Pp |
.Pp |
|
For GNU-style long options, escaping the additional hyphen-minus is not |
|
strictly required, but may be safer with future versions of GNU troff; see |
|
.Xr mandoc_char 7 |
|
for details. |
|
.Pp |
See also |
See also |
.Ic \&Cm . |
.Ic \&Cm . |
|
.Tg Fn |
.It Ic \&Fn Ar funcname Op Ar argument ... |
.It Ic \&Fn Ar funcname Op Ar argument ... |
A function name. |
A function name. |
.Pp |
.Pp |
|
|
.Ic \&Fo , |
.Ic \&Fo , |
and |
and |
.Ic \&Ft . |
.Ic \&Ft . |
|
.Tg Fo |
.It Ic \&Fo Ar funcname |
.It Ic \&Fo Ar funcname |
Begin a function block. |
Begin a function block. |
This is a multi-line version of |
This is a multi-line version of |
Line 1644 This macro is obsolete. |
|
Line 1685 This macro is obsolete. |
|
No replacement markup is needed. |
No replacement markup is needed. |
.Pp |
.Pp |
It was used to show numerical function return values in an italic font. |
It was used to show numerical function return values in an italic font. |
|
.Tg Ft |
.It Ic \&Ft Ar functype |
.It Ic \&Ft Ar functype |
A function type. |
A function type. |
.Pp |
.Pp |
|
|
.Ic \&Fn , |
.Ic \&Fn , |
and |
and |
.Ic \&Fo . |
.Ic \&Fo . |
|
.Tg Fx |
.It Ic \&Fx Op Ar version |
.It Ic \&Fx Op Ar version |
Format the |
Format the |
.Fx |
.Fx |
|
|
This macro is not implemented in |
This macro is not implemented in |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
It was used to include the contents of a (header) file literally. |
It was used to include the contents of a (header) file literally. |
|
.Tg Ic |
.It Ic \&Ic Ar keyword ... |
.It Ic \&Ic Ar keyword ... |
Internal or interactive command, or configuration instruction |
Internal or interactive command, or configuration instruction |
in a configuration file. |
in a configuration file. |
|
|
is preferred for displaying code samples; the |
is preferred for displaying code samples; the |
.Ic \&Ic |
.Ic \&Ic |
macro is used when referring to an individual command name. |
macro is used when referring to an individual command name. |
|
.Tg In |
.It Ic \&In Ar filename |
.It Ic \&In Ar filename |
The name of an include file. |
The name of an include file. |
This macro is most often used in section 2, 3, and 9 manual pages. |
This macro is most often used in section 2, 3, and 9 manual pages. |
|
|
.Pp |
.Pp |
See also |
See also |
.Sx MANUAL STRUCTURE . |
.Sx MANUAL STRUCTURE . |
|
.Tg It |
.It Ic \&It Op Ar head |
.It Ic \&It Op Ar head |
A list item. |
A list item. |
The syntax of this macro depends on the list type. |
The syntax of this macro depends on the list type. |
Line 1813 but not the whitespace before the semicolon. |
|
Line 1859 but not the whitespace before the semicolon. |
|
.Pp |
.Pp |
See also |
See also |
.Ic \&Bl . |
.Ic \&Bl . |
|
.Tg Lb |
.It Ic \&Lb Cm lib Ns Ar name |
.It Ic \&Lb Cm lib Ns Ar name |
Specify a library. |
Specify a library. |
.Pp |
.Pp |
Line 1833 section as described in |
|
Line 1880 section as described in |
|
Examples: |
Examples: |
.Dl \&.Lb libz |
.Dl \&.Lb libz |
.Dl \&.Lb libmandoc |
.Dl \&.Lb libmandoc |
|
.Tg Li |
.It Ic \&Li Ar word ... |
.It Ic \&Li Ar word ... |
Request a typewriter (literal) font. |
Request a typewriter (literal) font. |
Deprecated because on terminal output devices, this is usually |
Deprecated because on terminal output devices, this is usually |
Line 1843 For literal displays, use |
|
Line 1891 For literal displays, use |
|
or |
or |
.Ic \&Bd Fl literal Pq multi-line |
.Ic \&Bd Fl literal Pq multi-line |
instead. |
instead. |
|
.Tg Lk |
.It Ic \&Lk Ar uri Op Ar display_name |
.It Ic \&Lk Ar uri Op Ar display_name |
Format a hyperlink. |
Format a hyperlink. |
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Lk http://bsd.lv \(dqThe BSD.lv Project\(dq |
.Dl \&.Lk https://bsd.lv \(dqThe BSD.lv Project\(dq |
.Dl \&.Lk http://bsd.lv |
.Dl \&.Lk https://bsd.lv |
.Pp |
.Pp |
See also |
See also |
.Ic \&Mt . |
.Ic \&Mt . |
.It Ic \&Lp |
.It Ic \&Lp |
Deprecated synonym for |
Deprecated synonym for |
.Ic \&Pp . |
.Ic \&Pp . |
|
.Tg Ms |
.It Ic \&Ms Ar name |
.It Ic \&Ms Ar name |
Display a mathematical symbol. |
Display a mathematical symbol. |
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Ms sigma |
.Dl \&.Ms sigma |
.Dl \&.Ms aleph |
.Dl \&.Ms aleph |
|
.Tg Mt |
.It Ic \&Mt Ar localpart Ns @ Ns Ar domain |
.It Ic \&Mt Ar localpart Ns @ Ns Ar domain |
Format a |
Format a |
.Dq mailto: |
.Dq mailto: |
|
|
Examples: |
Examples: |
.Dl \&.Mt discuss@manpages.bsd.lv |
.Dl \&.Mt discuss@manpages.bsd.lv |
.Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv |
.Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv |
|
.Tg Nd |
.It Ic \&Nd Ar line |
.It Ic \&Nd Ar line |
A one line description of the manual's content. |
A one line description of the manual's content. |
This is the mandatory last macro of the |
This is the mandatory last macro of the |
Line 1891 arguments and will display macros verbatim. |
|
Line 1943 arguments and will display macros verbatim. |
|
.Pp |
.Pp |
See also |
See also |
.Ic \&Nm . |
.Ic \&Nm . |
|
.Tg Nm |
.It Ic \&Nm Op Ar name |
.It Ic \&Nm Op Ar name |
The name of the manual page, or \(em in particular in section 1, 6, |
The name of the manual page, or \(em in particular in section 1, 6, |
and 8 pages \(em of an additional command or feature documented in |
and 8 pages \(em of an additional command or feature documented in |
Line 1928 of section 2, 3 and 9 manual pages, use the |
|
Line 1981 of section 2, 3 and 9 manual pages, use the |
|
macro rather than |
macro rather than |
.Ic \&Nm |
.Ic \&Nm |
to mark up the name of the manual page. |
to mark up the name of the manual page. |
|
.Tg No |
.It Ic \&No Ar word ... |
.It Ic \&No Ar word ... |
Normal text. |
Normal text. |
Closes the scope of any preceding in-line macro. |
Closes the scope of any preceding in-line macro. |
|
|
.Ic \&Ql , |
.Ic \&Ql , |
and |
and |
.Ic \&Sy . |
.Ic \&Sy . |
|
.Tg Ns |
.It Ic \&Ns |
.It Ic \&Ns |
Suppress a space between the output of the preceding macro |
Suppress a space between the output of the preceding macro |
and the following text or macro. |
and the following text or macro. |
|
|
.Ic \&No |
.Ic \&No |
and |
and |
.Ic \&Sm . |
.Ic \&Sm . |
|
.Tg Nx |
.It Ic \&Nx Op Ar version |
.It Ic \&Nx Op Ar version |
Format the |
Format the |
.Nx |
.Nx |
|
|
\&.Op Fl flag Ns Ar value |
\&.Op Fl flag Ns Ar value |
\&.Oc |
\&.Oc |
.Ed |
.Ed |
|
.Tg Op |
.It Ic \&Op Ar line |
.It Ic \&Op Ar line |
Optional part of a command line. |
Optional part of a command line. |
Prints the argument(s) in brackets. |
Prints the argument(s) in brackets. |
|
|
.Pp |
.Pp |
See also |
See also |
.Ic \&Oo . |
.Ic \&Oo . |
.It Ic \&Os Op Ar system Op Ar version |
.Tg Os |
Operating system version for display in the page footer. |
.It Ic \&Os Op Ar footer text |
This is the mandatory third macro of |
The mandatory third macro of every |
any |
|
.Nm |
.Nm |
file. |
file. |
|
Usually, do not specify any arguments, |
|
in particular not the operating system name and/or version. |
.Pp |
.Pp |
The optional |
If no argument is given, |
.Ar system |
|
parameter specifies the relevant operating system or environment. |
|
It is suggested to leave it unspecified, in which case |
|
.Xr mandoc 1 |
.Xr mandoc 1 |
uses its |
prints its |
.Fl Ios |
.Fl Ios |
argument or, if that isn't specified either, |
argument in the page footer, or |
.Fa sysname |
.Fa sysname |
and |
and |
.Fa release |
.Fa release |
as returned by |
as returned by |
.Xr uname 3 . |
.Xr uname 3 |
|
by default. |
.Pp |
.Pp |
Examples: |
Manual pages that are part of a portable software project can override |
.Dl \&.Os |
the default by giving the project name and version number as arguments, |
.Dl \&.Os KTH/CSC/TCS |
but leaving it blank is never a bad choice. |
.Dl \&.Os BSD 4.3 |
|
.Pp |
.Pp |
See also |
See also |
.Ic \&Dd |
.Ic \&Dd |
|
|
.Nm |
.Nm |
packages described it as |
packages described it as |
.Dq "old function type (FORTRAN)" . |
.Dq "old function type (FORTRAN)" . |
|
.Tg Ox |
.It Ic \&Ox Op Ar version |
.It Ic \&Ox Op Ar version |
Format the |
Format the |
.Ox |
.Ox |
|
|
.Ic \&Fx , |
.Ic \&Fx , |
and |
and |
.Ic \&Nx . |
.Ic \&Nx . |
|
.Tg Pa |
.It Ic \&Pa Ar name ... |
.It Ic \&Pa Ar name ... |
An absolute or relative file system path, or a file or directory name. |
An absolute or relative file system path, or a file or directory name. |
If an argument is not provided, the character |
If an argument is not provided, the character |
|
|
.It Ic \&Pc |
.It Ic \&Pc |
Close parenthesised context opened by |
Close parenthesised context opened by |
.Ic \&Po . |
.Ic \&Po . |
|
.Tg Pf |
.It Ic \&Pf Ar prefix macro Op Ar argument ... |
.It Ic \&Pf Ar prefix macro Op Ar argument ... |
Removes the space between its argument and the following macro. |
Removes the space between its argument and the following macro. |
It is equivalent to: |
It is equivalent to: |
|
|
.It Ic \&Po Ar block |
.It Ic \&Po Ar block |
Multi-line version of |
Multi-line version of |
.Ic \&Pq . |
.Ic \&Pq . |
|
.Tg Pp |
.It Ic \&Pp |
.It Ic \&Pp |
Break a paragraph. |
Break a paragraph. |
This will assert vertical space between prior and subsequent macros |
This will assert vertical space between prior and subsequent macros |
|
|
unless the |
unless the |
.Fl compact |
.Fl compact |
flag is given. |
flag is given. |
|
.Tg Pq |
.It Ic \&Pq Ar line |
.It Ic \&Pq Ar line |
Parenthesised enclosure. |
Parenthesised enclosure. |
.Pp |
.Pp |
|
|
.It Ic \&Qc |
.It Ic \&Qc |
Close quoted context opened by |
Close quoted context opened by |
.Ic \&Qo . |
.Ic \&Qo . |
|
.Tg Ql |
.It Ic \&Ql Ar line |
.It Ic \&Ql Ar line |
In-line literal display. |
In-line literal display. |
This can be used for complete command invocations and for multi-word |
This can be used for complete command invocations and for multi-word |
|
|
.It Ic \&Qo Ar block |
.It Ic \&Qo Ar block |
Multi-line version of |
Multi-line version of |
.Ic \&Qq . |
.Ic \&Qq . |
|
.Tg Qq |
.It Ic \&Qq Ar line |
.It Ic \&Qq Ar line |
Encloses its arguments in |
Encloses its arguments in |
.Qq typewriter |
.Qq typewriter |
|
|
.Ic \&Rs |
.Ic \&Rs |
block. |
block. |
Does not have any tail arguments. |
Does not have any tail arguments. |
|
.Tg Rs |
.It Ic \&Rs |
.It Ic \&Rs |
Begin a bibliographic |
Begin a bibliographic |
.Pq Dq reference |
.Pq Dq reference |
|
|
block is used within a SEE ALSO section, a vertical space is asserted |
block is used within a SEE ALSO section, a vertical space is asserted |
before the rendered output, else the block continues on the current |
before the rendered output, else the block continues on the current |
line. |
line. |
|
.Tg Rv |
.It Ic \&Rv Fl std Op Ar function ... |
.It Ic \&Rv Fl std Op Ar function ... |
Insert a standard sentence regarding a function call's return value of 0 |
Insert a standard sentence regarding a function call's return value of 0 |
on success and \-1 on error, with the |
on success and \-1 on error, with the |
|
|
.It Ic \&Sc |
.It Ic \&Sc |
Close single-quoted context opened by |
Close single-quoted context opened by |
.Ic \&So . |
.Ic \&So . |
|
.Tg Sh |
.It Ic \&Sh Ar TITLE LINE |
.It Ic \&Sh Ar TITLE LINE |
Begin a new section. |
Begin a new section. |
For a list of conventional manual sections, see |
For a list of conventional manual sections, see |
|
|
.Ic \&Ss , |
.Ic \&Ss , |
and |
and |
.Ic \&Sx . |
.Ic \&Sx . |
|
.Tg Sm |
.It Ic \&Sm Op Cm on | off |
.It Ic \&Sm Op Cm on | off |
Switches the spacing mode for output generated from macros. |
Switches the spacing mode for output generated from macros. |
.Pp |
.Pp |
Line 2264 Using this is not recommended because it makes the cod |
|
Line 2330 Using this is not recommended because it makes the cod |
|
.It Ic \&So Ar block |
.It Ic \&So Ar block |
Multi-line version of |
Multi-line version of |
.Ic \&Sq . |
.Ic \&Sq . |
|
.Tg Sq |
.It Ic \&Sq Ar line |
.It Ic \&Sq Ar line |
Encloses its arguments in |
Encloses its arguments in |
.Sq typewriter |
.Sq typewriter |
|
|
.Ic \&Qq , |
.Ic \&Qq , |
and |
and |
.Ic \&So . |
.Ic \&So . |
|
.Tg Ss |
.It Ic \&Ss Ar Title line |
.It Ic \&Ss Ar Title line |
Begin a new subsection. |
Begin a new subsection. |
Unlike with |
Unlike with |
|
|
.Ic \&Sh , |
.Ic \&Sh , |
and |
and |
.Ic \&Sx . |
.Ic \&Sx . |
|
.Tg St |
.It Ic \&St Fl Ns Ar abbreviation |
.It Ic \&St Fl Ns Ar abbreviation |
Replace an abbreviation for a standard with the full form. |
Replace an abbreviation for a standard with the full form. |
The following standards are recognised. |
The following standards are recognised. |
Line 2414 Based on POSIX.1 and POSIX.2, published in 1992. |
|
Line 2483 Based on POSIX.1 and POSIX.2, published in 1992. |
|
.br |
.br |
This standard was published in 1994. |
This standard was published in 1994. |
It was used as the basis for UNIX 95 certification. |
It was used as the basis for UNIX 95 certification. |
The following three refer to parts of it. |
The following two refer to parts of it. |
.Pp |
.Pp |
.It \-xsh4.2 |
|
.St -xsh4.2 |
|
.Pp |
|
.It \-xcurses4.2 |
.It \-xcurses4.2 |
.St -xcurses4.2 |
.St -xcurses4.2 |
.Pp |
.Pp |
Line 2506 Ethernet local area networks. |
|
Line 2572 Ethernet local area networks. |
|
.St -ieee1275-94 |
.St -ieee1275-94 |
.El |
.El |
.El |
.El |
|
.Tg Sx |
.It Ic \&Sx Ar Title line |
.It Ic \&Sx Ar Title line |
Reference a section or subsection in the same manual page. |
Reference a section or subsection in the same manual page. |
The referenced section or subsection name must be identical to the |
The referenced section or subsection name must be identical to the |
|
|
.Ic \&Sh |
.Ic \&Sh |
and |
and |
.Ic \&Ss . |
.Ic \&Ss . |
|
.Tg Sy |
.It Ic \&Sy Ar word ... |
.It Ic \&Sy Ar word ... |
Request a boldface font. |
Request a boldface font. |
.Pp |
.Pp |
|
|
.Ic \&No , |
.Ic \&No , |
and |
and |
.Ic \&Ql . |
.Ic \&Ql . |
|
.Tg Ta |
.It Ic \&Ta |
.It Ic \&Ta |
Table cell separator in |
Table cell separator in |
.Ic \&Bl Fl column |
.Ic \&Bl Fl column |
lists; can only be used below |
lists; can only be used below |
.Ic \&It . |
.Ic \&It . |
|
.Tg Tg |
|
.It Ic \&Tg Op Ar term |
|
Announce that the next input line starts a definition of the |
|
.Ar term . |
|
This macro must appear alone on its own input line. |
|
The argument defaults to the first argument of the first macro |
|
on the next line. |
|
The argument may not contain whitespace characters, not even when it is quoted. |
|
This macro is a |
|
.Xr mandoc 1 |
|
extension and is typically ignored by other formatters. |
|
.Pp |
|
When viewing terminal output with |
|
.Xr less 1 , |
|
the interactive |
|
.Ic :t |
|
command can be used to go to the definition of the |
|
.Ar term |
|
as described for the |
|
.Ev MANPAGER |
|
variable in |
|
.Xr man 1 ; |
|
when producing HTML output, a fragment identifier |
|
.Pq Ic id No attribute |
|
is generated, to be used for deep linking to this place of the document. |
|
.Pp |
|
In most cases, adding a |
|
.Ic \&Tg |
|
macro would be redundant because |
|
.Xr mandoc 1 |
|
is able to automatically tag most definitions. |
|
This macro is intended for cases where automatic tagging of a |
|
.Ar term |
|
is unsatisfactory, for example if a definition is not tagged |
|
automatically (false negative) or if places are tagged that do |
|
not define the |
|
.Ar term |
|
(false positives). |
|
When there is at least one |
|
.Ic \&Tg |
|
macro for a |
|
.Ar term , |
|
no other places are automatically marked as definitions of that |
|
.Ar term . |
.It Ic \&Tn Ar word ... |
.It Ic \&Tn Ar word ... |
Supported only for compatibility, do not use this in new manuals. |
Supported only for compatibility, do not use this in new manuals. |
Even though the macro name |
Even though the macro name |
|
|
Supported only for compatibility, do not use this in new manuals. |
Supported only for compatibility, do not use this in new manuals. |
Prints out |
Prints out |
.Dq Ux . |
.Dq Ux . |
|
.Tg Va |
.It Ic \&Va Oo Ar type Oc Ar identifier ... |
.It Ic \&Va Oo Ar type Oc Ar identifier ... |
A variable name. |
A variable name. |
.Pp |
.Pp |
Line 2576 For declarations of global variables in the |
|
Line 2690 For declarations of global variables in the |
|
.Em SYNOPSIS |
.Em SYNOPSIS |
section, use |
section, use |
.Ic \&Vt . |
.Ic \&Vt . |
|
.Tg Vt |
.It Ic \&Vt Ar type Op Ar identifier |
.It Ic \&Vt Ar type Op Ar identifier |
A variable type. |
A variable type. |
.Pp |
.Pp |
Line 2619 beyond the end of the input line. |
|
Line 2734 beyond the end of the input line. |
|
This macro originally existed to work around the 9-argument limit |
This macro originally existed to work around the 9-argument limit |
of historic |
of historic |
.Xr roff 7 . |
.Xr roff 7 . |
|
.Tg Xr |
.It Ic \&Xr Ar name section |
.It Ic \&Xr Ar name section |
Link to another manual |
Link to another manual |
.Pq Qq cross-reference . |
.Pq Qq cross-reference . |
Line 2681 column, if applicable, describes closure rules. |
|
Line 2797 column, if applicable, describes closure rules. |
|
.Ss Block full-explicit |
.Ss Block full-explicit |
Multi-line scope closed by an explicit closing macro. |
Multi-line scope closed by an explicit closing macro. |
All macros contains bodies; only |
All macros contains bodies; only |
.Ic \s&Bf |
.Ic \&Bf |
and |
and |
.Pq optionally |
.Pq optionally |
.Ic \&Bl |
.Ic \&Bl |
Line 2912 then the macro accepts an arbitrary number of argument |
|
Line 3028 then the macro accepts an arbitrary number of argument |
|
.It Ic \&St Ta \&No Ta Yes Ta 1 |
.It Ic \&St Ta \&No Ta Yes Ta 1 |
.It Ic \&Sx Ta Yes Ta Yes Ta >0 |
.It Ic \&Sx Ta Yes Ta Yes Ta >0 |
.It Ic \&Sy Ta Yes Ta Yes Ta >0 |
.It Ic \&Sy Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Tg Ta \&No Ta \&No Ta <2 |
.It Ic \&Tn Ta Yes Ta Yes Ta >0 |
.It Ic \&Tn Ta Yes Ta Yes Ta >0 |
.It Ic \&Ud Ta \&No Ta \&No Ta 0 |
.It Ic \&Ud Ta \&No Ta \&No Ta 0 |
.It Ic \&Ux Ta Yes Ta Yes Ta n |
.It Ic \&Ux Ta Yes Ta Yes Ta n |
Line 3005 in the same way as a plain |
|
Line 3122 in the same way as a plain |
|
.Sq \&| |
.Sq \&| |
character. |
character. |
Using this predefined string is not recommended in new manuals. |
Using this predefined string is not recommended in new manuals. |
|
.Pp |
|
Appending a zero-width space |
|
.Pq Sq \e& |
|
to the end of an input line is also useful to prevent the interpretation |
|
of a trailing period, exclamation or question mark as the end of a |
|
sentence, for example when an abbreviation happens to occur |
|
at the end of a text or macro input line. |
.Ss Font handling |
.Ss Font handling |
In |
In |
.Nm |
.Nm |
Line 3032 The following problematic behaviour is found in groff: |
|
Line 3156 The following problematic behaviour is found in groff: |
|
.Pp |
.Pp |
.Bl -dash -compact |
.Bl -dash -compact |
.It |
.It |
.Ic \&Dd |
|
with non-standard arguments behaves very strangely. |
|
When there are three arguments, they are printed verbatim. |
|
Any other number of arguments is replaced by the current date, |
|
but without any arguments the string |
|
.Dq Epoch |
|
is printed. |
|
.It |
|
.Ic \&Lk |
|
only accepts a single link-name argument; the remainder is misformatted. |
|
.It |
|
.Ic \&Pa |
.Ic \&Pa |
does not format its arguments when used in the FILES section under |
does not format its arguments when used in the FILES section under |
certain list types. |
certain list types. |
Line 3050 certain list types. |
|
Line 3163 certain list types. |
|
.Ic \&Ta |
.Ic \&Ta |
can only be called by other macros, but not at the beginning of a line. |
can only be called by other macros, but not at the beginning of a line. |
.It |
.It |
.Ic \&%C |
|
is not implemented (up to and including groff-1.22.2). |
|
.It |
|
.Sq \ef |
.Sq \ef |
.Pq font face |
.Pq font face |
and |
and |
Line 3102 but produces large indentations. |
|
Line 3212 but produces large indentations. |
|
.Xr tbl 7 |
.Xr tbl 7 |
.Pp |
.Pp |
The web page |
The web page |
.Lk http://mandoc.bsd.lv/mdoc/ "extended documentation for the mdoc language" |
.Lk https://mandoc.bsd.lv/mdoc/ "extended documentation for the mdoc language" |
provides a few tutorial-style pages for beginners, an extensive style |
provides a few tutorial-style pages for beginners, an extensive style |
guide for advanced authors, and an alphabetic index helping to choose |
guide for advanced authors, and an alphabetic index helping to choose |
the best macros for various kinds of content. |
the best macros for various kinds of content. |
|
.Pp |
|
The manual page |
|
.Lk https://man.voidlinux.org/groff_mdoc "groff_mdoc(7)" |
|
contained in the |
|
.Dq groff |
|
package documents exactly the same language in a somewhat different style. |
.Sh HISTORY |
.Sh HISTORY |
The |
The |
.Nm |
.Nm |