=================================================================== RCS file: /cvs/mandoc/man.7,v retrieving revision 1.13 retrieving revision 1.19 diff -u -p -r1.13 -r1.19 --- mandoc/man.7 2009/06/16 19:13:28 1.13 +++ mandoc/man.7 2009/07/14 15:56:44 1.19 @@ -1,4 +1,4 @@ -.\" $Id: man.7,v 1.13 2009/06/16 19:13:28 kristaps Exp $ +.\" $Id: man.7,v 1.19 2009/07/14 15:56:44 kristaps Exp $ .\" .\" Copyright (c) 2009 Kristaps Dzonsons .\" @@ -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: June 16 2009 $ +.Dd $Mdocdate: July 14 2009 $ .Dt MAN 7 .Os .\" SECTION @@ -27,13 +27,15 @@ The .Nm man language was historically used to format .Ux -manuals. This reference document describes the syntax and structure of -this language. +manuals. This reference document describes its syntax, structure, and +usage. .Pp -.Em \&Do not -use +.Bf Em +Do not use .Nm -to write your manuals. Use the +to write your manuals. +.Ef +Use the .Xr mdoc 7 language, instead. .\" PARAGRAPH @@ -52,12 +54,9 @@ Other lines are interpreted within the current state. .\" SECTION .Sh INPUT ENCODING .Nm -documents may contain only graphable 7-bit ASCII characters and the -space character -.Sq \ . -All manuals must have +documents may contain only graphable 7-bit ASCII characters, the +space character, and the tabs character. All manuals must have .Ux -.Sq \en line termination. .Pp Blank lines are acceptable; where found, the output will assert a @@ -93,9 +92,33 @@ or a single one-character sequence. .Pp Characters may alternatively be escaped by a slash-asterisk, .Sq \e* , -with the same combinations as described above. This form is deprecated. +with the same combinations as described above. +.Pp +Terms may also be text-decorated using the +.Sq \ef +escape followed by a text-decoration letter: B (bold), I, (italic), or P +and R (Roman, or reset). +.\" SUB-SECTION +.Ss Whitespace +Unless specifically escaped, consecutive blocks of whitespace are pruned +from input. These are later re-added, if applicable, by a front-end +utility such as +.Xr mandoc 1 . .\" 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 \&. , @@ -153,7 +176,7 @@ The .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 @@ -196,6 +219,11 @@ system, the following macros are also supported: These follow the same calling conventions as the above .Nm macros. +.\" SECTION +.Sh COMPATIBILITY +See +.Xr mdoc 7 +for groff compatibility notes. .\" SECTION .Sh SEE ALSO .Xr mandoc 1 ,