=================================================================== RCS file: /cvs/mandoc/man.7,v retrieving revision 1.112 retrieving revision 1.123 diff -u -p -r1.112 -r1.123 --- mandoc/man.7 2011/12/02 01:37:14 1.112 +++ mandoc/man.7 2014/02/14 17:35:05 1.123 @@ -1,7 +1,8 @@ -.\" $Id: man.7,v 1.112 2011/12/02 01:37:14 schwarze Exp $ +.\" $Id: man.7,v 1.123 2014/02/14 17:35:05 schwarze Exp $ .\" -.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons -.\" Copyright (c) 2011 Ingo Schwarze +.\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons +.\" Copyright (c) 2011, 2012, 2013 Ingo Schwarze +.\" Copyright (c) 2010 Joerg Sonnenberger .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -15,7 +16,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: December 2 2011 $ +.Dd $Mdocdate: February 14 2014 $ .Dt MAN 7 .Os .Sh NAME @@ -253,6 +254,7 @@ in the alphabetical reference below. .It Sx IP Ta indented paragraph: Op Ar head Op Ar width .It Sx TP Ta tagged paragraph: Op Ar width .It Sx HP Ta hanged paragraph: Op Ar width +.It Sx PD Ta set vertical paragraph distance: Op Ar height .It Sx \&br Ta force output line break in text mode (no arguments) .It Sx \&sp Ta force vertical space: Op Ar height .It Sx fi , nf Ta fill mode and no-fill mode (no arguments) @@ -279,7 +281,7 @@ For the scoping of individual macros, see .Sx MACRO SYNTAX . .Ss \&AT Sets the volume for the footer for compatibility with man pages from -.Tn AT&T UNIX +.At releases. The optional arguments specify which release it is from. .Ss \&B @@ -339,6 +341,18 @@ and .Ss \&DT Has no effect. 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 Begin a paragraph whose initial output line is left-justified, but subsequent output lines are indented, with the following syntax: @@ -349,8 +363,9 @@ subsequent output lines are indented, with the followi .Pp The .Cm width -argument must conform to -.Sx Scaling Widths . +argument is a +.Xr roff 7 +scaling width. If specified, it's saved for later paragraph left-margins; if unspecified, the saved or default width is used. .Pp @@ -392,8 +407,9 @@ Begin an indented paragraph with the following syntax: .Pp The .Cm width -argument defines the width of the left margin and is defined by -.Sx Scaling Widths . +argument is a +.Xr roff 7 +scaling width defining the left margin. It's saved for later paragraph left-margins; if unspecified, the saved or default width is used. .Pp @@ -437,6 +453,20 @@ See also .Sx \&PP , and .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 Synonym for .Sx \&LP . @@ -448,6 +478,36 @@ See also .Sx \&PP , and .Sx \&TP . +.Ss \&PD +Specify the vertical space to be inserted before each new paragraph. +.br +The syntax is as follows: +.Bd -filled -offset indent +.Pf \. Sx \&PD +.Op Cm height +.Ed +.Pp +The +.Cm height +argument is a +.Xr roff 7 +scaling width. +It defaults to +.Cm 1v . +If the unit is omitted, +.Cm v +is assumed. +.Pp +This macro affects the spacing before any subsequent instances of +.Sx \&HP , +.Sx \&IP , +.Sx \&LP , +.Sx \&P , +.Sx \&PP , +.Sx \&SH , +.Sx \&SS , +and +.Sx \&TP . .Ss \&PP Synonym for .Sx \&LP . @@ -512,8 +572,9 @@ This has the following syntax: .Pp The .Cm width -argument must conform to -.Sx Scaling Widths . +argument is a +.Xr roff 7 +scaling width. If not specified, the saved or default width is used. .Pp See also @@ -578,8 +639,9 @@ The syntax is as follows: .Pp The .Cm width -argument must conform to -.Sx Scaling Widths . +argument is a +.Xr roff 7 +scaling width. If specified, it's saved for later paragraph left-margins; if unspecified, the saved or default width is used. .Pp @@ -592,8 +654,23 @@ and .Sx \&PP . .Ss \&UC Sets the volume for the footer for compatibility with man pages from -BSD releases. +.Bx +releases. The optional first argument specifies which release it is from. +.Ss \&UE +End a uniform resource identifier block. +This is a non-standard GNU extension, included only for compatibility. +See +.Sx \&UE . +.Ss \&UR +Begin a uniform resource identifier block. +This is a non-standard GNU extension, included only for compatibility. +It has the following syntax: +.Bd -literal -offset indent +.Pf \. Sx \&UR Ar uri +link description to be shown +.Pf \. Sx UE +.Ed .Ss \&br Breaks the current line. Consecutive invocations have no further effect. @@ -636,10 +713,10 @@ Insert vertical spaces into output with the following .Op Cm height .Ed .Pp -Insert +The .Cm height -spaces, which must conform to -.Sx Scaling Widths . +argument is a scaling width as described in +.Xr roff 7 . If 0, this is equivalent to the .Sx \&br macro. @@ -688,9 +765,13 @@ The syntax is as follows: .It Sx \&BI Ta n Ta current Ta \& .It Sx \&BR Ta n Ta current Ta \& .It Sx \&DT Ta 0 Ta current Ta \& +.It Sx \&EE Ta 0 Ta current Ta compat +.It Sx \&EX Ta 0 Ta current Ta compat .It Sx \&I Ta n Ta next-line Ta \& .It Sx \&IB 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 \&PD Ta 1 Ta current Ta \& .It Sx \&R Ta n Ta next-line Ta \& .It Sx \&RB Ta n Ta current Ta \& .It Sx \&RI Ta n Ta current Ta \& @@ -760,6 +841,8 @@ implicitly closed, is syntactically incorrect. .It Sx \&SH Ta >0 Ta next-line Ta section Ta \& .It Sx \&SS Ta >0 Ta next-line Ta sub-section Ta \& .It Sx \&TP Ta n Ta next-line Ta paragraph Ta \& +.It Sx \&UE Ta 0 Ta current Ta none Ta compat +.It Sx \&UR Ta 1 Ta current Ta part Ta compat .El .Pp Macros marked @@ -854,6 +937,12 @@ number when no is given, like in .Xr mdoc 7 . .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 .Xr man 1 , .Xr mandoc 1 , @@ -869,6 +958,9 @@ language first appeared as a macro package for the rof system in .At v7 . 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 .Xr mandoc 1 utility written by Kristaps Dzonsons appeared in @@ -877,8 +969,7 @@ utility written by Kristaps Dzonsons appeared in This .Nm reference was written by -.An Kristaps Dzonsons , -.Mt kristaps@bsd.lv . +.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . .Sh CAVEATS Do not use this language. Use