Remove the ENDBODY_NOSPACE flag, simplifying the code.

[mandoc.git] / mdoc.7

diff --git a/mdoc.7 b/mdoc.7
index 566501c9a830bf5463e3b28b49324e93b131cb32..ce4bd92f0ef00a72aa59bcfd66eac9cb9fcbae9b 100644 (file)
--- a/mdoc.7
+++ b/mdoc.7
@@ -1,7 +1,7 @@
-.\"    $Id: mdoc.7,v 1.254 2015/09/14 20:10:19 schwarze Exp $
+.\"    $Id: mdoc.7,v 1.261 2017/02/05 22:30:29 schwarze Exp $

 .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>

-.\" Copyright (c) 2010, 2011, 2013 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2010, 2011, 2013-2017 Ingo Schwarze <schwarze@openbsd.org>

 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above
 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above


@@ -15,7 +15,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: September 14 2015 $
+.Dd $Mdocdate: February 5 2017 $

 .Dt MDOC 7
 .Os
 .Sh NAME
 .Dt MDOC 7
 .Os
 .Sh NAME


@@ -304,6 +304,11 @@ Print verbose information.
 \&.El
 .Ed
 .Pp
 \&.El
 .Ed
 .Pp

+List the options in alphabetical order,
+uppercase before lowercase for each letter and
+with no regard to whether an option takes an argument.
+Put digits in ascending order before all letter options.
+.Pp

 Manuals not documenting a command won't include the above fragment.
 .Pp
 Since the
 Manuals not documenting a command won't include the above fragment.
 .Pp
 Since the


@@ -1826,14 +1831,25 @@ The
 list is the most complicated.
 Its syntax is as follows:
 .Pp
 list is the most complicated.
 Its syntax is as follows:
 .Pp

-.D1 Pf \. Sx \&It Ar cell Op <TAB> Ar cell ...

 .D1 Pf \. Sx \&It Ar cell Op Sx \&Ta Ar cell ...
 .D1 Pf \. Sx \&It Ar cell Op Sx \&Ta Ar cell ...

+.D1 Pf \. Sx \&It Ar cell Op <TAB> Ar cell ...

 .Pp
 The arguments consist of one or more lines of text and macros
 representing a complete table line.
 .Pp
 The arguments consist of one or more lines of text and macros
 representing a complete table line.

-Cells within the line are delimited by tabs or by the special
+Cells within the line are delimited by the special

 .Sx \&Ta
 .Sx \&Ta

-block macro.
+block macro or by literal tab characters.
+.Pp
+Using literal tabs is strongly discouraged because they are very
+hard to use correctly and
+.Nm
+code using them is very hard to read.
+In particular, a blank character is syntactically significant
+before and after the literal tab character.
+If a word precedes or follows the tab without an intervening blank,
+that word is never interpreted as a macro call, but always output
+literally.
+.Pp

 The tab cell delimiter may only be used within the
 .Sx \&It
 line itself; on following lines, only the
 The tab cell delimiter may only be used within the
 .Sx \&It
 line itself; on following lines, only the


@@ -1848,9 +1864,10 @@ Note that quoted strings may span tab-delimited cells on an
 line.
 For example,
 .Pp
 line.
 For example,
 .Pp

-.Dl .It \(dqcol1 ; <TAB> col2 ;\(dq \&;
+.Dl .It \(dqcol1 ,\& <TAB> col2 ,\(dq \&;

 .Pp
 .Pp

-will preserve the semicolon whitespace except for the last.
+will preserve the whitespace before both commas,
+but not the whitespace before the semicolon.

 .Pp
 See also
 .Sx \&Bl .
 .Pp
 See also
 .Sx \&Bl .


@@ -2155,19 +2172,23 @@ See also
 Close parenthesised context opened by
 .Sx \&Po .
 .Ss \&Pf
 Close parenthesised context opened by
 .Sx \&Po .
 .Ss \&Pf

-Removes the space between its argument
-.Pq Dq prefix
-and the following macro.
+Removes the space between its argument and the following macro.

 Its syntax is as follows:
 .Pp
 .D1 .Pf Ar prefix macro arguments ...
 .Pp
 This is equivalent to:
 .Pp
 Its syntax is as follows:
 .Pp
 .D1 .Pf Ar prefix macro arguments ...
 .Pp
 This is equivalent to:
 .Pp

-.D1 .No Ar prefix No \&Ns Ar macro arguments ...
+.D1 .No \e& Ns Ar prefix No \&Ns Ar macro arguments ...
+.Pp
+The
+.Ar prefix
+argument is not parsed for macro names or delimiters,
+but used verbatim as if it were escaped.

 .Pp
 Examples:
 .Dl ".Pf $ Ar variable_name"
 .Pp
 Examples:
 .Dl ".Pf $ Ar variable_name"

+.Dl ".Pf . Ar macro_name"

 .Dl ".Pf 0x Ar hex_digits"
 .Pp
 See also
 .Dl ".Pf 0x Ar hex_digits"
 .Pp
 See also


@@ -2267,7 +2288,7 @@ Examples:
 \&.%A J. D. Ullman
 \&.%B Introduction to Automata Theory, Languages, and Computation
 \&.%I Addison-Wesley
 \&.%A J. D. Ullman
 \&.%B Introduction to Automata Theory, Languages, and Computation
 \&.%I Addison-Wesley

-\&.%C Reading, Massachusettes
+\&.%C Reading, Massachusetts

 \&.%D 1979
 \&.Re
 .Ed
 \&.%D 1979
 \&.Re
 .Ed


@@ -2705,14 +2726,13 @@ Link to another manual
 .Pq Qq cross-reference .
 Its syntax is as follows:
 .Pp
 .Pq Qq cross-reference .
 Its syntax is as follows:
 .Pp

-.D1 Pf \. Sx \&Xr Ar name Op section
+.D1 Pf \. Sx \&Xr Ar name section

 .Pp
 Cross reference the
 .Ar name
 and
 .Ar section
 .Pp
 Cross reference the
 .Ar name
 and
 .Ar section

-number of another man page;
-omitting the section number is rarely useful.
+number of another man page.

 .Pp
 Examples:
 .Dl \&.Xr mandoc 1
 .Pp
 Examples:
 .Dl \&.Xr mandoc 1


@@ -3024,7 +3044,7 @@ then the macro accepts an arbitrary number of arguments.
 .It Sx \&Ux  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Va  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Vt  Ta    Yes      Ta    Yes      Ta    >0
 .It Sx \&Ux  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Va  Ta    Yes      Ta    Yes      Ta    n
 .It Sx \&Vt  Ta    Yes      Ta    Yes      Ta    >0

-.It Sx \&Xr  Ta    Yes      Ta    Yes      Ta    >0
+.It Sx \&Xr  Ta    Yes      Ta    Yes      Ta    2

 .It Sx \&br  Ta    \&No     Ta    \&No     Ta    0
 .It Sx \&sp  Ta    \&No     Ta    \&No     Ta    1
 .El
 .It Sx \&br  Ta    \&No     Ta    \&No     Ta    0
 .It Sx \&sp  Ta    \&No     Ta    \&No     Ta    1
 .El


@@ -3044,6 +3064,8 @@ For many macros, when the leading arguments are opening delimiters,
 these delimiters are put before the macro scope,
 and when the trailing arguments are closing delimiters,
 these delimiters are put after the macro scope.
 these delimiters are put before the macro scope,
 and when the trailing arguments are closing delimiters,
 these delimiters are put after the macro scope.

+Spacing is suppressed after opening delimiters
+and before closing delimiters.

 For example,
 .Pp
 .D1 Pf \. \&Aq "( [ word ] ) ."
 For example,
 .Pp
 .D1 Pf \. \&Aq "( [ word ] ) ."


@@ -3100,7 +3122,7 @@ renders as:
 .D1 Fl a ( b | c \*(Ba d ) e
 .Pp
 This applies to both opening and closing delimiters,
 .D1 Fl a ( b | c \*(Ba d ) e
 .Pp
 This applies to both opening and closing delimiters,

-and also to the middle delimiter:
+and also to the middle delimiter, which does not suppress spacing:

 .Pp
 .Bl -tag -width Ds -offset indent -compact
 .It \&|
 .Pp
 .Bl -tag -width Ds -offset indent -compact
 .It \&|


@@ -3208,6 +3230,12 @@ but produces large indentations.
 .Xr mandoc_char 7 ,
 .Xr roff 7 ,
 .Xr tbl 7
 .Xr mandoc_char 7 ,
 .Xr roff 7 ,
 .Xr tbl 7

+.Pp
+The web page
+.Lk http://mdocml.bsd.lv/mdoc/ "extended documentation for the mdoc language"
+provides a few tutorial-style pages for beginners, an extensive style
+guide for advanced authors, and an alphabetic index helping to choose
+the best macros for various kinds of content.

 .Sh HISTORY
 The
 .Nm
 .Sh HISTORY
 The
 .Nm