`Cd' in -Thtml -mdoc correctly breaks lines.

[mandoc.git] / man.7

diff --git a/man.7 b/man.7
index e491a1bf7a7207ca305ab5882710789e0045f202..c0f93cd5c6ffa0c1cf5e10a6b6ca30618a16160e 100644 (file)
--- a/man.7
+++ b/man.7
@@ -1,4 +1,4 @@
-.\"    $Id: man.7,v 1.32 2009/08/20 12:08:40 kristaps Exp $
+.\"    $Id: man.7,v 1.37 2009/09/05 10:37:09 kristaps Exp $
 .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"
@@ -14,7 +14,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: August 20 2009 $
+.Dd $Mdocdate: September 5 2009 $
 .Dt MAN 7
 .Os
 .
@@ -139,18 +139,27 @@ are generally structured as follows:
 \&.
 \&.SH NAME
 \efBfoo\efR \e(en a description goes here
+\&.\e\*q The next is for sections 2 & 3 only.
+\&.\e\*q .SH LIBRARY
 \&.
 \&.SH SYNOPSIS
 \efBfoo\efR [\efB\e-options\efR] arguments...
 \&.
 \&.SH DESCRIPTION
-The \efBfoo\efR utility does...
+The \efBfoo\efR utility processes files...
 \&.
+\&.\e\*q .SH IMPLEMENTATION NOTES
+\&.\e\*q The next is for sections 1 & 8 only.
+\&.\e\*q .SH EXIT STATUS
+\&.\e\*q The next is for sections 2, 3, & 9 only.
 \&.\e\*q .SH RETURN VALUES
+\&.\e\*q The next is for sections 1, 6, 7, & 8 only.
 \&.\e\*q .SH ENVIRONMENT
 \&.\e\*q .SH FILES
 \&.\e\*q .SH EXAMPLES
+\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.
 \&.\e\*q .SH DIAGNOSTICS
+\&.\e\*q The next is for sections 2, 3, & 9 only.
 \&.\e\*q .SH ERRORS
 \&.\e\*q .SH SEE ALSO
 \&.\e\*q \efBbar\efR(1)
@@ -159,6 +168,7 @@ The \efBfoo\efR utility does...
 \&.\e\*q .SH AUTHORS
 \&.\e\*q .SH CAVEATS
 \&.\e\*q .SH BUGS
+\&.\e\*q .SH SECURITY CONSIDERATIONS
 .Ed
 .
 .
@@ -195,18 +205,14 @@ foo
 .Pp
 is equivalent to
 .Sq \&.I foo .
-.\" PARAGRAPH
-Consecutive next-line scope invocations are disallowed.
+If next-line macros are invoked consecutively, only the last is used.
+If a next-line macro is proceded by a block macro, it is ignored.
 .Bd -literal -offset indent
 \&.YO \(lBbody...\(rB
 \(lBbody...\(rB
 .Ed
 .
 .Pp
-It is considered an error when next-line scope is open at the end of
-file.
-.
-.Pp
 .Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX"
 .It Em Macro Ta Em Arguments Ta Em Scope
 .It    B     Ta    n         Ta    next-line
@@ -222,6 +228,7 @@ file.
 .It    SB    Ta    n         Ta    next-line
 .It    SM    Ta    n         Ta    next-line
 .It    TH    Ta    >1, <6    Ta    current
+.It    UC    Ta    n         Ta    current
 .It    br    Ta    0         Ta    current
 .It    fi    Ta    0         Ta    current
 .It    i     Ta    n         Ta    current
@@ -235,6 +242,7 @@ file.
 The
 .Sq RS ,
 .Sq RE ,
+.Sq UC ,
 .Sq br ,
 .Sq fi ,
 .Sq i ,
@@ -243,9 +251,7 @@ The
 .Sq r ,
 and
 .Sq sp
-macros aren't historically part of
-.Nm
-and should not be used.  They're included for compatibility.
+macros should not be used.  They're included for compatibility.
 .
 .
 .Ss Block Macros
@@ -278,10 +284,6 @@ or
 No closure refers to an explicit block closing macro.
 .
 .Pp
-It is considered an error when part or next-line scope is open at the
-end of file.
-.
-.Pp
 .Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent
 .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope
 .It   HP     Ta    <2        Ta    current    Ta    paragraph
@@ -291,8 +293,8 @@ end of file.
 .It   PP     Ta    0         Ta    current    Ta    paragraph
 .It   RE     Ta    0         Ta    current    Ta    none
 .It   RS     Ta    1         Ta    current    Ta    part
-.It   SH     Ta    >0        Ta    current    Ta    section
-.It   SS     Ta    >0        Ta    current    Ta    sub-section
+.It   SH     Ta    >0        Ta    next-line  Ta    section
+.It   SS     Ta    >0        Ta    next-line  Ta    sub-section
 .It   TP     Ta    n         Ta    next-line  Ta    paragraph
 .El
 .
@@ -301,6 +303,7 @@ If a block macro is next-line scoped, it may only be followed by in-line
 macros (excluding
 .Sq DT ,
 .Sq TH ,
+.Sq UC ,
 .Sq br ,
 .Sq na ,
 .Sq sp ,
@@ -355,7 +358,7 @@ render in italics.  Whitespace between arguments is omitted in output.
 Text is rendered alternately in bold face and roman (the default font).
 Whitespace between arguments is omitted in output.
 .It DT
-Re-set the tab spacing to 0.5 inches.
+Has no effect.  Included for compatibility.
 .It HP
 Begin a paragraph whose initial output line is left-justified, but
 subsequent output lines are indented, with the following syntax:
@@ -473,6 +476,8 @@ must be a properly-formed numeric width.  If
 .Va width
 is specified, it's saved for later paragraph left-margins; if
 unspecified, the saved or default width is used.
+.It UC
+Has no effect.  Included for compatibility.
 .It br
 Breaks the current line.  Consecutive invocations have no further effect.
 .It fi
@@ -482,7 +487,7 @@ End literal mode begun by
 Italicise arguments.  If no arguments are specified, all subsequent text
 is italicised.
 .It na
-Don't alignment the right margin.
+Don't align to the right margin.
 .It nf
 Begin literal mode: all subsequent free-form lines have their end of
 line boundaries preserved.  May be ended by