Fixed STRUCTURE/SYNTAX section data.

[mandoc.git] / man.7

diff --git a/man.7 b/man.7
index 2899c8c99bcaeb310a0441afe946fc3c19f7863f..fb471551adbf153fd3ef4445437ef058f04ec586 100644 (file)
--- a/man.7
+++ b/man.7
@@ -1,4 +1,4 @@
-.\"    $Id: man.7,v 1.11 2009/06/10 20:18:43 kristaps Exp $
+.\"    $Id: man.7,v 1.16 2009/06/25 10:48:21 kristaps Exp $

 .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"
 .\"
 .\" 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.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: June 10 2009 $
+.Dd $Mdocdate: June 25 2009 $

 .Dt MAN 7
 .Os
 .\" SECTION
 .Dt MAN 7
 .Os
 .\" SECTION


@@ -52,9 +52,11 @@ Other lines are interpreted within the current state.
 .\" SECTION
 .Sh INPUT ENCODING
 .Nm
 .\" SECTION
 .Sh INPUT ENCODING
 .Nm

-documents may contain only graphable 7-bit ASCII characters and the
+documents may contain only graphable 7-bit ASCII characters, the

 space character
 space character

-.Sq \  .
+.Sq \  ,
+and tabs
+.Sq \et . 

 All manuals must have
 .Ux
 .Sq \en
 All manuals must have
 .Ux
 .Sq \en


@@ -70,6 +72,16 @@ escape is common in historical
 documents; if encountered at the end of a word, it ensures that the
 subsequent word isn't off-set by whitespace.
 .\" SUB-SECTION
 documents; if encountered at the end of a word, it ensures that the
 subsequent word isn't off-set by whitespace.
 .\" SUB-SECTION

+.Ss Comments
+Anything following a
+.Sq \e" 
+delimiter is considered a comment (unless the 
+.Sq \e
+itself has been escaped) and is ignored to the end of line.
+Furthermore, a macro line with only a control character
+.Sq \. ,
+optionally followed by whitespace, is ignored.
+.\" SUB-SECTION

 .Ss Special Characters
 Special character sequences begin with the escape character
 .Sq \e
 .Ss Special Characters
 Special character sequences begin with the escape character
 .Sq \e


@@ -86,6 +98,19 @@ Characters may alternatively be escaped by a slash-asterisk,
 with the same combinations as described above.  This form is deprecated.  
 .\" SECTION
 .Sh STRUCTURE
 with the same combinations as described above.  This form is deprecated.  
 .\" SECTION
 .Sh STRUCTURE

+Each
+.Nm
+document must contain contains at least the
+.Sq \&.TH
+macro describing the document's section and title.  It may occur
+anywhere in the document, although conventionally, it appears as the
+first macro.
+.Pp
+Beyond the 
+.Sq \&.TH ,
+at least one macro or text node must appear in the document.
+.\" SECTION
+.Sh SYNTAX

 Macros are one to three three characters in length and begin with a
 control character ,
 .Sq \&. ,
 Macros are one to three three characters in length and begin with a
 control character ,
 .Sq \&. ,


@@ -143,7 +168,7 @@ The
 .Sq \&.TP
 macro is similar, but does not need an empty argument line to trigger
 the behaviour.
 .Sq \&.TP
 macro is similar, but does not need an empty argument line to trigger
 the behaviour.

-.\" PARAGRAPH
+.\" SECTION

 .Sh MACROS
 This section contains a complete list of all 
 .Nm
 .Sh MACROS
 This section contains a complete list of all 
 .Nm


@@ -195,7 +220,7 @@ macros.
 The
 .Nm
 utility was written by 
 The
 .Nm
 utility was written by 

-.An Kristaps Dzonsons Aq kristaps@openbsd.org .
+.An Kristaps Dzonsons Aq kristaps@kth.se .

 .\" SECTION
 .Sh CAVEATS
 Do not use this language.  Use
 .\" SECTION
 .Sh CAVEATS
 Do not use this language.  Use