summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@cvs.openbsd.org>2009-06-23 23:41:00 +0000
committerIngo Schwarze <schwarze@cvs.openbsd.org>2009-06-23 23:41:00 +0000
commit85e711da98bd9600c6866831a0731af30d3ce162 (patch)
tree43ad2552b3fd3249ff90747110c49a35b37dcf22
parent815f2ceecc27c119c17c688e7b2352976ba1ba22 (diff)
sync to 1.7.20: Document whitespace handling.
Currently, mandoc(1) produces French spacing, which is a bug and needs to be fixed, but document it anyway for the time being. While here, fix a few typos, also reported upstream.
-rw-r--r--usr.bin/mandoc/mandoc.125
1 files changed, 18 insertions, 7 deletions
diff --git a/usr.bin/mandoc/mandoc.1 b/usr.bin/mandoc/mandoc.1
index d16edbd3501..d134e82bcea 100644
--- a/usr.bin/mandoc/mandoc.1
+++ b/usr.bin/mandoc/mandoc.1
@@ -1,4 +1,4 @@
-.\" $Id: mandoc.1,v 1.6 2009/06/21 20:03:11 schwarze Exp $
+.\" $Id: mandoc.1,v 1.7 2009/06/23 23:40:59 schwarze 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: June 21 2009 $
+.Dd $Mdocdate: June 23 2009 $
.Dt MANDOC 1
.Os
.\" SECTION
@@ -98,19 +98,19 @@ were provided.
.Pp
.Ex -std mandoc
.\" SUB-SECTION
-.Ss Punctuation
+.Ss Punctuation and Spacing
If punctuation is set apart from words, such as in the phrase
.Dq to be \&, or not to be ,
it's processed by
.Nm
-according to the following rules. Opening punctuation
+according to the following rules: opening punctuation
.Po
.Sq \&( ,
.Sq \&[ ,
and
.Sq \&{
.Pc
-is not followed by a space. Closing punctuation
+is not followed by a space; closing punctuation
.Po
.Sq \&. ,
.Sq \&, ,
@@ -128,6 +128,15 @@ is not preceded by whitespace.
If the input is
.Xr mdoc 7 ,
these rules are also applied to macro arguments when appropriate.
+.Pp
+White-space, in non-literal (normal) mode, is stripped from input and
+replaced on output by a single space. Thus, if you wish to preserve
+multiple spaces, they must be space-escaped
+.Sq \e\
+or used in a literal display mode, e.g.,
+.Sq \&.Bd \-literal
+in
+.Xr mdoc 7 .
.\" SUB-SECTION
.Ss Input Formats
The
@@ -253,14 +262,16 @@ A list or display following
.Sq \&.Ss
does not assert a prior vertical break, just as it doesn't with
.Sq \&.Sh .
-.\" LIST-ITEM
.It
The \-literal and \-unfilled
.Sq \&.Bd
displays types are synonyms, as are \-filled and \-ragged.
-.\" LIST-ITEM
.It
Words aren't hyphenated.
+.It
+In normal mode (not a literal block), blocks of spaces aren't preserved,
+so double spaces following sentence closure are reduced to a single space
+.Pq Dq French spacing .
.El
.\" SECTION
.Sh SEE ALSO