version 1.274, 2018/12/23 22:03:32 |
version 1.280, 2020/01/19 18:02:00 |
|
|
.\" $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 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 |
Line 516 in the alphabetical |
|
Line 517 in the alphabetical |
|
.Bl -column "Brq, Bro, Brc" description |
.Bl -column "Brq, Bro, Brc" description |
.It Ic \&Em Ta italic font or underline (emphasis) (>0 arguments) |
.It Ic \&Em Ta italic font or underline (emphasis) (>0 arguments) |
.It Ic \&Sy Ta boldface font (symbolic) (>0 arguments) |
.It Ic \&Sy Ta boldface font (symbolic) (>0 arguments) |
.It Ic \&No Ta return to roman font (normal) (no arguments) |
.It Ic \&No Ta return to roman font (normal) (>0 arguments) |
.It Ic \&Bf , \&Ef Ta font block: Fl Ar type | Cm \&Em | \&Li | \&Sy |
.It Ic \&Bf , \&Ef Ta font block: Fl Ar type | Cm \&Em | \&Li | \&Sy |
.El |
.El |
.Ss Physical enclosures |
.Ss Physical enclosures |
|
|
Book or journal page number of an |
Book or journal page number of an |
.Ic \&Rs |
.Ic \&Rs |
block. |
block. |
|
Conventionally, the argument starts with |
|
.Ql p.\& |
|
for a single page or |
|
.Ql pp.\& |
|
for a range of pages, for example: |
|
.Pp |
|
.Dl .%P pp. 42\e(en47 |
.It Ic \&%Q Ar name |
.It Ic \&%Q Ar name |
Institutional author (school, government, etc.) of an |
Institutional author (school, government, etc.) of an |
.Ic \&Rs |
.Ic \&Rs |
|
|
This practise is discouraged. |
This practise is discouraged. |
.It Ic \&Cm Ar keyword ... |
.It Ic \&Cm Ar keyword ... |
Command modifiers. |
Command modifiers. |
Typically used for fixed strings passed as arguments, unless |
Typically used for fixed strings passed as arguments to interactive |
|
commands, to commands in interpreted scripts, or to configuration |
|
file directives, unless |
.Ic \&Fl |
.Ic \&Fl |
is more appropriate. |
is more appropriate. |
Also useful when specifying configuration options or keys. |
|
.Pp |
.Pp |
Examples: |
Examples: |
.Dl ".Nm mt Fl f Ar device Cm rewind" |
.Dl ".Nm mt Fl f Ar device Cm rewind" |
.Dl ".Nm ps Fl o Cm pid , Ns Cm command" |
.Dl ".Nm ps Fl o Cm pid , Ns Cm command" |
.Dl ".Nm dd Cm if= Ns Ar file1 Cm of= Ns Ar file2" |
.Dl ".Nm dd Cm if= Ns Ar file1 Cm of= Ns Ar file2" |
.Dl ".Cm IdentityFile Pa ~/.ssh/id_rsa" |
.Dl ".Ic set Fl o Cm vi" |
.Dl ".Cm LogLevel Dv DEBUG" |
.Dl ".Ic lookup Cm file bind" |
|
.Dl ".Ic permit Ar identity Op Cm as Ar target" |
.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 |
|
|
.Dl \&.Fn \(dqint funcname\(dq \(dqint arg0\(dq \(dqint arg1\(dq |
.Dl \&.Fn \(dqint funcname\(dq \(dqint arg0\(dq \(dqint arg1\(dq |
.Dl \&.Fn funcname \(dqint arg0\(dq |
.Dl \&.Fn funcname \(dqint arg0\(dq |
.Dl \&.Fn funcname arg0 |
.Dl \&.Fn funcname arg0 |
.Pp |
.Bd -literal -offset indent |
.Bd -literal -offset indent -compact |
|
\&.Ft functype |
\&.Ft functype |
\&.Fn funcname |
\&.Fn funcname |
.Ed |
.Ed |
Line 1678 This macro is not implemented in |
|
Line 1687 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. |
.It Ic \&Ic Ar keyword ... |
.It Ic \&Ic Ar keyword ... |
Designate an internal or interactive command. |
Internal or interactive command, or configuration instruction |
This is similar to |
in a configuration file. |
.Ic \&Cm |
See also |
but used for instructions rather than values. |
.Ic \&Cm . |
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Ic :wq |
.Dl \&.Ic :wq |
Line 1933 using semantic annotation macros. |
|
Line 1942 using semantic annotation macros. |
|
.Pp |
.Pp |
Examples: |
Examples: |
.Dl ".Em italic , Sy bold , No and roman" |
.Dl ".Em italic , Sy bold , No and roman" |
.Pp |
.Bd -literal -offset indent |
.Bd -literal -offset indent -compact |
|
\&.Sm off |
\&.Sm off |
\&.Cm :C No / Ar pattern No / Ar replacement No / |
\&.Cm :C No / Ar pattern No / Ar replacement No / |
\&.Sm on |
\&.Sm on |
Line 2541 Table cell separator in |
|
Line 2549 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 . |
|
.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 |
Line 2891 then the macro accepts an arbitrary number of argument |
|
Line 2942 then the macro accepts an arbitrary number of argument |
|
.It Ic \&Ms Ta Yes Ta Yes Ta >0 |
.It Ic \&Ms Ta Yes Ta Yes Ta >0 |
.It Ic \&Mt Ta Yes Ta Yes Ta >0 |
.It Ic \&Mt Ta Yes Ta Yes Ta >0 |
.It Ic \&Nm Ta Yes Ta Yes Ta n |
.It Ic \&Nm Ta Yes Ta Yes Ta n |
.It Ic \&No Ta Yes Ta Yes Ta 0 |
.It Ic \&No Ta Yes Ta Yes Ta >0 |
.It Ic \&Ns Ta Yes Ta Yes Ta 0 |
.It Ic \&Ns Ta Yes Ta Yes Ta 0 |
.It Ic \&Nx Ta Yes Ta Yes Ta n |
.It Ic \&Nx Ta Yes Ta Yes Ta n |
.It Ic \&Os Ta \&No Ta \&No Ta n |
.It Ic \&Os Ta \&No Ta \&No Ta n |
Line 2905 then the macro accepts an arbitrary number of argument |
|
Line 2956 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 2971 exclamation mark |
|
Line 3023 exclamation mark |
|
Note that even a period preceded by a backslash |
Note that even a period preceded by a backslash |
.Pq Sq \e.\& |
.Pq Sq \e.\& |
gets this special handling; use |
gets this special handling; use |
.Sq \e&. |
.Sq \e&.\& |
to prevent that. |
to prevent that. |
.Pp |
.Pp |
Many in-line macros interrupt their scope when they encounter |
Many in-line macros interrupt their scope when they encounter |
Line 2998 in the same way as a plain |
|
Line 3050 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 |