=================================================================== RCS file: /cvs/mandoc/man.7,v retrieving revision 1.126 retrieving revision 1.130 diff -u -p -r1.126 -r1.130 --- mandoc/man.7 2014/03/31 01:05:32 1.126 +++ mandoc/man.7 2015/01/24 02:14:46 1.130 @@ -1,7 +1,7 @@ -.\" $Id: man.7,v 1.126 2014/03/31 01:05:32 schwarze Exp $ +.\" $Id: man.7,v 1.130 2015/01/24 02:14:46 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons -.\" Copyright (c) 2011, 2012, 2013 Ingo Schwarze +.\" Copyright (c) 2011-2015 Ingo Schwarze .\" Copyright (c) 2010 Joerg Sonnenberger .\" .\" Permission to use, copy, modify, and distribute this software for any @@ -16,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: March 31 2014 $ +.Dd $Mdocdate: January 24 2015 $ .Dt MAN 7 .Os .Sh NAME @@ -369,11 +369,11 @@ Begin a paragraph whose initial output line is left-ju subsequent output lines are indented, with the following syntax: .Bd -filled -offset indent .Pf \. Sx \&HP -.Op Cm width +.Op Ar width .Ed .Pp The -.Cm width +.Ar width argument is a .Xr roff 7 scaling width. @@ -413,11 +413,11 @@ and Begin an indented paragraph with the following syntax: .Bd -filled -offset indent .Pf \. Sx \&IP -.Op Cm head Op Cm width +.Op Ar head Op Ar width .Ed .Pp The -.Cm width +.Ar width argument is a .Xr roff 7 scaling width defining the left margin. @@ -425,7 +425,7 @@ It's saved for later paragraph left-margins; if unspec default width is used. .Pp The -.Cm head +.Ar head argument is used as a leading term, flushed to the left margin. This is useful for bulleted paragraphs and so on. .Pp @@ -470,13 +470,13 @@ This is a non-standard GNU extension, included only fo It has the following syntax: .Bd -filled -offset indent .Pf \. Sx \&OP -.Cm key Op Cm value +.Ar key Op Ar value .Ed .Pp The -.Cm key +.Ar key is usually a command-line flag and -.Cm value +.Ar value its argument. .Ss \&P Synonym for @@ -495,11 +495,11 @@ Specify the vertical space to be inserted before each The syntax is as follows: .Bd -filled -offset indent .Pf \. Sx \&PD -.Op Cm height +.Op Ar height .Ed .Pp The -.Cm height +.Ar height argument is a .Xr roff 7 scaling width. @@ -555,9 +555,29 @@ and .Ss \&RE Explicitly close out the scope of a prior .Sx \&RS . -The default left margin is restored to the state of the original +The default left margin is restored to the state before that .Sx \&RS invocation. +.Pp +The syntax is as follows: +.Bd -filled -offset indent +.Pf \. Sx \&RE +.Op Ar level +.Ed +.Pp +Without an argument, the most recent +.Sx \&RS +block is closed out. +If +.Ar level +is 1, all open +.Sx \&RS +blocks are closed out. +Otherwise, +.Ar level No \(mi 1 +nested +.Sx \&RS +blocks remain open. .Ss \&RI Text is rendered alternately in roman (the default font) and italics. Whitespace between arguments is omitted in output. @@ -578,11 +598,11 @@ Temporarily reset the default left margin. This has the following syntax: .Bd -filled -offset indent .Pf \. Sx \&RS -.Op Cm width +.Op Ar width .Ed .Pp The -.Cm width +.Ar width argument is a .Xr roff 7 scaling width. @@ -607,7 +627,8 @@ The scope of a sub-section is closed by a subsequent s section, or end of file. The paragraph left-margin width is reset to the default. .Ss \&TH -Sets the title of the manual page with the following syntax: +Sets the title of the manual page for use in the page header +and footer with the following syntax: .Bd -filled -offset indent .Pf \. Sx \&TH .Ar title section date @@ -629,6 +650,11 @@ is empty or not specified, the current date is used. The optional .Ar source string specifies the organisation providing the utility. +When unspecified, +.Xr mandoc 1 +uses its +.Fl Ios +argument. The .Ar volume string replaces the default rendered volume, which is dictated by the @@ -645,11 +671,11 @@ Subsequent output lines are indented. The syntax is as follows: .Bd -filled -offset indent .Pf \. Sx \&TP -.Op Cm width +.Op Ar width .Ed .Pp The -.Cm width +.Ar width argument is a .Xr roff 7 scaling width. @@ -694,10 +720,10 @@ End literal mode begun by .Ss \&in Indent relative to the current indentation: .Pp -.D1 Pf \. Sx \&in Op Cm width +.D1 Pf \. Sx \&in Op Ar width .Pp If -.Cm width +.Ar width is signed, the new offset is relative. Otherwise, it is absolute. This value is reset upon the next paragraph, section, or sub-section. @@ -716,11 +742,11 @@ or Insert vertical spaces into output with the following syntax: .Bd -filled -offset indent .Pf \. Sx \&sp -.Op Cm height +.Op Ar height .Ed .Pp The -.Cm height +.Ar height argument is a scaling width as described in .Xr roff 7 . If 0, this is equivalent to the @@ -873,10 +899,11 @@ Note that macros like .Sx \&BR open and close a font scope for each argument. .Sh COMPATIBILITY -This section documents areas of questionable portability between +This section mentions some areas of questionable portability between implementations of the .Nm language. +More incompatibilities exist. .Pp .Bl -dash -compact .It @@ -888,47 +915,12 @@ to close out a literal context opened with .Sx \&nf . This behaviour may not be portable. .It -In quoted literals, GNU troff allowed pair-wise double-quotes to produce -a standalone double-quote in formatted output. -It is not known whether this behaviour is exhibited by other formatters. -.It troff suppresses a newline before .Sq \(aq macro output; in mandoc, it is an alias for the standard .Sq \&. control character. .It -The -.Sq \eh -.Pq horizontal position , -.Sq \ev -.Pq vertical position , -.Sq \em -.Pq text colour , -.Sq \eM -.Pq text filling colour , -.Sq \ez -.Pq zero-length character , -.Sq \ew -.Pq string length , -.Sq \ek -.Pq horizontal position marker , -.Sq \eo -.Pq text overstrike , -and -.Sq \es -.Pq text size -escape sequences are all discarded in mandoc. -.It -The -.Sq \ef -scaling unit is accepted by mandoc, but rendered as the default unit. -.It -The -.Sx \&sp -macro does not accept negative values in mandoc. -In GNU troff, this would result in strange behaviour. -.It In page header lines, GNU troff versions up to and including 1.21 only print .Ar volume @@ -944,8 +936,13 @@ is given, like in .El .Pp The -.Sx OP -macro is part of the extended +.Sx EE , +.Sx EX , +.Sx OP , +.Sx UE , +and +.Sx UR +macros are part of the GNU extended .Nm macro set, and may not be portable to non-GNU troff implementations. .Sh SEE ALSO