version 1.112, 2011/12/02 01:37:14 |
version 1.117, 2012/06/20 22:06:30 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2011 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2011 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 |
|
|
.Ss \&DT |
.Ss \&DT |
Has no effect. |
Has no effect. |
Included for compatibility. |
Included for compatibility. |
|
.Ss \&EE |
|
This is a non-standard GNU extension, included only for compatibility. |
|
In |
|
.Xr mandoc 1 , |
|
it does the same as |
|
.Sx \&fi . |
|
.Ss \&EX |
|
This is a non-standard GNU extension, included only for compatibility. |
|
In |
|
.Xr mandoc 1 , |
|
it does the same as |
|
.Sx \&nf . |
.Ss \&HP |
.Ss \&HP |
Begin a paragraph whose initial output line is left-justified, but |
Begin a paragraph whose initial output line is left-justified, but |
subsequent output lines are indented, with the following syntax: |
subsequent output lines are indented, with the following syntax: |
Line 349 subsequent output lines are indented, with the followi |
|
Line 361 subsequent output lines are indented, with the followi |
|
.Pp |
.Pp |
The |
The |
.Cm width |
.Cm width |
argument must conform to |
argument is a |
.Sx Scaling Widths . |
.Xr roff 7 |
|
scaling width. |
If specified, it's saved for later paragraph left-margins; if unspecified, the |
If specified, it's saved for later paragraph left-margins; if unspecified, the |
saved or default width is used. |
saved or default width is used. |
.Pp |
.Pp |
Line 392 Begin an indented paragraph with the following syntax: |
|
Line 405 Begin an indented paragraph with the following syntax: |
|
.Pp |
.Pp |
The |
The |
.Cm width |
.Cm width |
argument defines the width of the left margin and is defined by |
argument is a |
.Sx Scaling Widths . |
.Xr roff 7 |
|
scaling width defining the left margin. |
It's saved for later paragraph left-margins; if unspecified, the saved or |
It's saved for later paragraph left-margins; if unspecified, the saved or |
default width is used. |
default width is used. |
.Pp |
.Pp |
|
|
.Sx \&PP , |
.Sx \&PP , |
and |
and |
.Sx \&TP . |
.Sx \&TP . |
|
.Ss \&OP |
|
Optional command-line argument. |
|
This is a non-standard GNU extension, included only for compatibility. |
|
It has the following syntax: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&OP |
|
.Cm key Op Cm value |
|
.Ed |
|
.Pp |
|
The |
|
.Cm key |
|
is usually a command-line flag and |
|
.Cm value |
|
its argument. |
.Ss \&P |
.Ss \&P |
Synonym for |
Synonym for |
.Sx \&LP . |
.Sx \&LP . |
Line 512 This has the following syntax: |
|
Line 540 This has the following syntax: |
|
.Pp |
.Pp |
The |
The |
.Cm width |
.Cm width |
argument must conform to |
argument is a |
.Sx Scaling Widths . |
.Xr roff 7 |
|
scaling width. |
If not specified, the saved or default width is used. |
If not specified, the saved or default width is used. |
.Pp |
.Pp |
See also |
See also |
Line 578 The syntax is as follows: |
|
Line 607 The syntax is as follows: |
|
.Pp |
.Pp |
The |
The |
.Cm width |
.Cm width |
argument must conform to |
argument is a |
.Sx Scaling Widths . |
.Xr roff 7 |
|
scaling width. |
If specified, it's saved for later paragraph left-margins; if |
If specified, it's saved for later paragraph left-margins; if |
unspecified, the saved or default width is used. |
unspecified, the saved or default width is used. |
.Pp |
.Pp |
Line 636 Insert vertical spaces into output with the following |
|
Line 666 Insert vertical spaces into output with the following |
|
.Op Cm height |
.Op Cm height |
.Ed |
.Ed |
.Pp |
.Pp |
Insert |
The |
.Cm height |
.Cm height |
spaces, which must conform to |
argument is a scaling width as described in |
.Sx Scaling Widths . |
.Xr roff 7 . |
If 0, this is equivalent to the |
If 0, this is equivalent to the |
.Sx \&br |
.Sx \&br |
macro. |
macro. |
Line 691 The syntax is as follows: |
|
Line 721 The syntax is as follows: |
|
.It Sx \&I Ta n Ta next-line Ta \& |
.It Sx \&I Ta n Ta next-line Ta \& |
.It Sx \&IB Ta n Ta current Ta \& |
.It Sx \&IB Ta n Ta current Ta \& |
.It Sx \&IR Ta n Ta current Ta \& |
.It Sx \&IR Ta n Ta current Ta \& |
|
.It Sx \&OP Ta 0, 1 Ta current Ta compat |
.It Sx \&R Ta n Ta next-line Ta \& |
.It Sx \&R Ta n Ta next-line Ta \& |
.It Sx \&RB Ta n Ta current Ta \& |
.It Sx \&RB Ta n Ta current Ta \& |
.It Sx \&RI Ta n Ta current Ta \& |
.It Sx \&RI Ta n Ta current Ta \& |
|
|
is given, like in |
is given, like in |
.Xr mdoc 7 . |
.Xr mdoc 7 . |
.El |
.El |
|
.Pp |
|
The |
|
.Sx OP |
|
macro is part of the extended |
|
.Nm |
|
macro set, and may not be portable to non-GNU troff implementations. |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr man 1 , |
.Xr man 1 , |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
Line 869 language first appeared as a macro package for the rof |
|
Line 906 language first appeared as a macro package for the rof |
|
system in |
system in |
.At v7 . |
.At v7 . |
It was later rewritten by James Clark as a macro package for groff. |
It was later rewritten by James Clark as a macro package for groff. |
|
Eric S. Raymond wrote the extended |
|
.Nm |
|
macros for groff in 2007. |
The stand-alone implementation that is part of the |
The stand-alone implementation that is part of the |
.Xr mandoc 1 |
.Xr mandoc 1 |
utility written by Kristaps Dzonsons appeared in |
utility written by Kristaps Dzonsons appeared in |