version 1.6, 2009/03/27 14:56:15 |
version 1.12, 2009/06/11 07:26:35 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org> |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se> |
.\" |
.\" |
.\" 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 |
.\" SECTION |
.Sh NAME |
.Sh NAME |
|
|
.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. This reference document describes the syntax and structure of |
structure of the |
this language. |
.Nm |
|
language. |
|
.Pp |
.Pp |
.Em \&Do not ever |
.Em \&Do not |
use |
use |
.Nm |
.Nm |
to write your manuals. Use the |
to write your manuals. Use the |
|
|
.Ed |
.Ed |
.Pp |
.Pp |
is equivalent to |
is equivalent to |
.Sq \&.RI foo . |
.Sq \&.RI foo . |
If two consecutive lines exhibit the latter behaviour, |
If two consecutive lines exhibit the latter behaviour, |
an error is raised. Thus, the following is not acceptable: |
an error is raised. Thus, the following is not acceptable: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
Line 176 macros and corresponding number of arguments. |
|
Line 172 macros and corresponding number of arguments. |
|
.It \&.IR Ta n |
.It \&.IR Ta n |
.It \&.RI Ta n |
.It \&.RI Ta n |
.El |
.El |
|
.Pp |
|
Although not historically part of the |
|
.Nm |
|
system, the following macros are also supported: |
|
.Pp |
|
.Bl -column "MacroX" "Arguments" -compact -offset indent |
|
.It Em Macro Ta Em Arguments |
|
.It \&.br Ta 0 |
|
.It \&.i Ta n |
|
.El |
|
.Pp |
|
These follow the same calling conventions as the above |
|
.Nm |
|
macros. |
.\" SECTION |
.\" SECTION |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
Line 185 macros and corresponding number of arguments. |
|
Line 195 macros and corresponding number of arguments. |
|
The |
The |
.Nm |
.Nm |
utility was written by |
utility was written by |
.An Kristaps Dzonsons Aq kristaps@openbsd.org . |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.\" SECTION |
.\" SECTION |
.Sh CAVEATS |
.Sh CAVEATS |
Do not use this language. Use |
Do not use this language. Use |