Return to mdoc.7 CVS log | Up to [cvsweb.bsd.lv] / mandoc |
version 1.251, 2015/02/15 17:57:45 | version 1.257, 2015/11/05 12:06:45 | ||
---|---|---|---|
|
|
||
\&.El | \&.El | ||
.Ed | .Ed | ||
.Pp | .Pp | ||
List the options in alphabetical order, | |||
uppercase before lowercase for each letter and | |||
with no regard to whether an option takes an argument. | |||
Put digits in ascending order before all letter options. | |||
.Pp | |||
Manuals not documenting a command won't include the above fragment. | Manuals not documenting a command won't include the above fragment. | ||
.Pp | .Pp | ||
Since the | Since the | ||
|
|
||
A function name. | A function name. | ||
Its syntax is as follows: | Its syntax is as follows: | ||
.Bd -ragged -offset indent | .Bd -ragged -offset indent | ||
.Pf \. Ns Sx \&Fn | .Pf . Sx \&Fn | ||
.Op Ar functype | .Op Ar functype | ||
.Ar funcname | .Ar funcname | ||
.Op Oo Ar argtype Oc Ar argname | .Op Oo Ar argtype Oc Ar argname | ||
|
|
||
.Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv | .Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv | ||
.Ss \&Nd | .Ss \&Nd | ||
A one line description of the manual's content. | A one line description of the manual's content. | ||
This may only be invoked in the | This is the mandatory last macro of the | ||
.Em SYNOPSIS | .Em NAME | ||
section subsequent the | section and not appropriate for other sections. | ||
.Sx \&Nm | |||
macro. | |||
.Pp | .Pp | ||
Examples: | Examples: | ||
.Dl Pf . Sx \&Nd mdoc language reference | .Dl Pf . Sx \&Nd mdoc language reference | ||
|
|
||
.Xr mandoc 1 | .Xr mandoc 1 | ||
uses its | uses its | ||
.Fl Ios | .Fl Ios | ||
argument, or, if that isn't specified either, | argument or, if that isn't specified either, | ||
.Fa sysname | .Fa sysname | ||
and | and | ||
.Fa release | .Fa release | ||
|
|
||
Close parenthesised context opened by | Close parenthesised context opened by | ||
.Sx \&Po . | .Sx \&Po . | ||
.Ss \&Pf | .Ss \&Pf | ||
Removes the space between its argument | Removes the space between its argument and the following macro. | ||
.Pq Dq prefix | |||
and the following macro. | |||
Its syntax is as follows: | Its syntax is as follows: | ||
.Pp | .Pp | ||
.D1 .Pf Ar prefix macro arguments ... | .D1 .Pf Ar prefix macro arguments ... | ||
.Pp | .Pp | ||
This is equivalent to: | This is equivalent to: | ||
.Pp | .Pp | ||
.D1 .No Ar prefix No \&Ns Ar macro arguments ... | .D1 .No \e& Ns Ar prefix No \&Ns Ar macro arguments ... | ||
.Pp | .Pp | ||
The | |||
.Ar prefix | |||
argument is not parsed for macro names or delimiters, | |||
but used verbatim as if it were escaped. | |||
.Pp | |||
Examples: | Examples: | ||
.Dl ".Pf $ Ar variable_name" | .Dl ".Pf $ Ar variable_name" | ||
.Dl ".Pf . Ar macro_name" | |||
.Dl ".Pf 0x Ar hex_digits" | .Dl ".Pf 0x Ar hex_digits" | ||
.Pp | .Pp | ||
See also | See also | ||
|
|
||
\&.%A J. D. Ullman | \&.%A J. D. Ullman | ||
\&.%B Introduction to Automata Theory, Languages, and Computation | \&.%B Introduction to Automata Theory, Languages, and Computation | ||
\&.%I Addison-Wesley | \&.%I Addison-Wesley | ||
\&.%C Reading, Massachusettes | \&.%C Reading, Massachusetts | ||
\&.%D 1979 | \&.%D 1979 | ||
\&.Re | \&.Re | ||
.Ed | .Ed |