reduce indentation for better readability

[mandoc.git] / man.7

diff --git a/man.7 b/man.7
index 8c61748e69365c0d18bb7572c3adad5cb4051ca8..bfeec51650e4e98f7fb449a23893741346ad02d9 100644 (file)
--- a/man.7
+++ b/man.7
@@ -1,4 +1,4 @@
-.\"    $Id: man.7,v 1.129 2015/01/24 01:58:33 schwarze Exp $
+.\"    $Id: man.7,v 1.132 2015/01/29 00:33:57 schwarze Exp $

 .\"
 .\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2011-2015 Ingo Schwarze <schwarze@openbsd.org>
 .\"
 .\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2011-2015 Ingo Schwarze <schwarze@openbsd.org>


@@ -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.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: January 24 2015 $
+.Dd $Mdocdate: January 29 2015 $

 .Dt MAN 7
 .Os
 .Sh NAME
 .Dt MAN 7
 .Os
 .Sh NAME


@@ -369,11 +369,11 @@ Begin a paragraph whose initial output line is left-justified, but
 subsequent output lines are indented, with the following syntax:
 .Bd -filled -offset indent
 .Pf \. Sx \&HP
 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
 .Ed
 .Pp
 The

-.Cm width
+.Ar width

 argument is a
 .Xr roff 7
 scaling 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
 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
 .Ed
 .Pp
 The

-.Cm width
+.Ar width

 argument is a
 .Xr roff 7
 scaling width defining the left margin.
 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 unspecified, the saved or
 default width is used.
 .Pp
 The
 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
 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 for compatibility.
 It has the following syntax:
 .Bd -filled -offset indent
 .Pf \. Sx \&OP
 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
 .Ed
 .Pp
 The

-.Cm key
+.Ar key

 is usually a command-line flag and
 is usually a command-line flag and

-.Cm value
+.Ar value

 its argument.
 .Ss \&P
 Synonym for
 its argument.
 .Ss \&P
 Synonym for


@@ -495,11 +495,11 @@ Specify the vertical space to be inserted before each new paragraph.
 The syntax is as follows:
 .Bd -filled -offset indent
 .Pf \. Sx \&PD
 The syntax is as follows:
 .Bd -filled -offset indent
 .Pf \. Sx \&PD

-.Op Cm height
+.Op Ar height

 .Ed
 .Pp
 The
 .Ed
 .Pp
 The

-.Cm height
+.Ar height

 argument is a
 .Xr roff 7
 scaling width.
 argument is a
 .Xr roff 7
 scaling width.


@@ -598,11 +598,11 @@ Temporarily reset the default left margin.
 This has the following syntax:
 .Bd -filled -offset indent
 .Pf \. Sx \&RS
 This has the following syntax:
 .Bd -filled -offset indent
 .Pf \. Sx \&RS

-.Op Cm width
+.Op Ar width

 .Ed
 .Pp
 The
 .Ed
 .Pp
 The

-.Cm width
+.Ar width

 argument is a
 .Xr roff 7
 scaling width.
 argument is a
 .Xr roff 7
 scaling width.


@@ -671,11 +671,11 @@ Subsequent output lines are indented.
 The syntax is as follows:
 .Bd -filled -offset indent
 .Pf \. Sx \&TP
 The syntax is as follows:
 .Bd -filled -offset indent
 .Pf \. Sx \&TP

-.Op Cm width
+.Op Ar width

 .Ed
 .Pp
 The
 .Ed
 .Pp
 The

-.Cm width
+.Ar width

 argument is a
 .Xr roff 7
 scaling width.
 argument is a
 .Xr roff 7
 scaling width.


@@ -720,15 +720,13 @@ End literal mode begun by
 .Ss \&in
 Indent relative to the current indentation:
 .Pp
 .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
 .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.
 is signed, the new offset is relative.
 Otherwise, it is absolute.
 This value is reset upon the next paragraph, section, or sub-section.

-.Ss \&na
-Don't align to the right margin.

 .Ss \&nf
 Begin literal mode: all subsequent free-form lines have their end of
 line boundaries preserved.
 .Ss \&nf
 Begin literal mode: all subsequent free-form lines have their end of
 line boundaries preserved.


@@ -742,11 +740,11 @@ or
 Insert vertical spaces into output with the following syntax:
 .Bd -filled -offset indent
 .Pf \. Sx \&sp
 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
 .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
 argument is a scaling width as described in
 .Xr roff 7 .
 If 0, this is equivalent to the


@@ -780,10 +778,9 @@ is equivalent to
 If next-line macros are invoked consecutively, only the last is used.
 If a next-line macro is followed by a non-next-line macro, an error is
 raised, except for
 If next-line macros are invoked consecutively, only the last is used.
 If a next-line macro is followed by a non-next-line macro, an error is
 raised, except for

-.Sx \&br ,
-.Sx \&sp ,
+.Sx \&br

 and
 and

-.Sx \&na .
+.Sx \&sp .

 .Pp
 The syntax is as follows:
 .Bd -literal -offset indent
 .Pp
 The syntax is as follows:
 .Bd -literal -offset indent


@@ -814,7 +811,6 @@ The syntax is as follows:
 .It Sx \&br  Ta    0         Ta    current   Ta    compat
 .It Sx \&fi  Ta    0         Ta    current   Ta    compat
 .It Sx \&in  Ta    1         Ta    current   Ta    compat
 .It Sx \&br  Ta    0         Ta    current   Ta    compat
 .It Sx \&fi  Ta    0         Ta    current   Ta    compat
 .It Sx \&in  Ta    1         Ta    current   Ta    compat

-.It Sx \&na  Ta    0         Ta    current   Ta    compat

 .It Sx \&nf  Ta    0         Ta    current   Ta    compat
 .It Sx \&sp  Ta    1         Ta    current   Ta    compat
 .El
 .It Sx \&nf  Ta    0         Ta    current   Ta    compat
 .It Sx \&sp  Ta    1         Ta    current   Ta    compat
 .El


@@ -898,53 +894,6 @@ until the end of the macro scope.
 Note that macros like
 .Sx \&BR
 open and close a font scope for each argument.
 Note that macros like
 .Sx \&BR
 open and close a font scope for each argument.

-.Sh COMPATIBILITY
-This section mentions some areas of questionable portability between
-implementations of the
-.Nm
-language.
-More incompatibilities exist.
-.Pp
-.Bl -dash -compact
-.It
-Do not depend on
-.Sx \&SH
-or
-.Sx \&SS
-to close out a literal context opened with
-.Sx \&nf .
-This behaviour may not be portable.
-.It
-troff suppresses a newline before
-.Sq \(aq
-macro output; in mandoc, it is an alias for the standard
-.Sq \&.
-control character.
-.It
-In page header lines, GNU troff versions up to and including 1.21
-only print
-.Ar volume
-names explicitly specified in the
-.Sx \&TH
-macro; mandoc and newer groff print the default volume name
-corresponding to the
-.Ar section
-number when no
-.Ar volume
-is given, like in
-.Xr mdoc 7 .
-.El
-.Pp
-The
-.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
 .Xr man 1 ,
 .Xr mandoc 1 ,
 .Sh SEE ALSO
 .Xr man 1 ,
 .Xr mandoc 1 ,