version 1.280, 2020/01/19 18:02:00 |
version 1.286, 2021/07/29 16:25:20 |
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. |
|
|
block. |
block. |
Does not have any tail arguments. |
Does not have any tail arguments. |
.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. |
|
|
.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-sytle 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 . |
.It Ic \&Fn Ar funcname Op Ar argument ... |
.It Ic \&Fn Ar funcname Op Ar argument ... |
|
|
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 . |
Line 2725 column, if applicable, describes closure rules. |
|
Line 2732 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 3084 The following problematic behaviour is found in groff: |
|
Line 3091 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 3102 certain list types. |
|
Line 3098 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 3154 but produces large indentations. |
|
Line 3147 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 |