summaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2010-07-06 11:07:21 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2010-07-06 11:07:21 +0000
commitc4fa950f5e6ed5b4e4e34092fb956af4832ae594 (patch)
tree29de761f1cc023296af4fab32536a3b634a3fcaf
parent3cb602bc8c8d9b3dd4eeef3496eb73e22670fec0 (diff)
downloadmandoc-c4fa950f5e6ed5b4e4e34092fb956af4832ae594.tar.gz
mandoc-c4fa950f5e6ed5b4e4e34092fb956af4832ae594.tar.zst
mandoc-c4fa950f5e6ed5b4e4e34092fb956af4832ae594.zip
Clarified `Bk' operation in mdoc.7.
-rw-r--r--mdoc.724
1 files changed, 13 insertions, 11 deletions
diff --git a/mdoc.7 b/mdoc.7
index f3e25289..7cf011bf 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -1,4 +1,4 @@
-.\" $Id: mdoc.7,v 1.132 2010/07/06 10:55:50 kristaps Exp $
+.\" $Id: mdoc.7,v 1.133 2010/07/06 11:07:21 kristaps Exp $
.\"
.\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
.\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
@@ -1178,27 +1178,29 @@ See also
and
.Sx \&Sy .
.Ss \&Bk
-Begins a keep block, containing a collection of macros or text
-to be kept together in the output.
+Begins a collection of macros or text not breaking the line.
Its syntax is as follows:
.Pp
.D1 Pf \. Sx \&Bk Fl words
.Pp
-Currently, the only argument implemented is
-.Fl words ,
-requesting to keep together all words of the contained text
-on the same output line.
Subsequent arguments are ignored.
+The
+.Fl words
+argument is required.
.Pp
-Examples:
+Each line within a keep block is kept intact, so the following example
+will not break within each
+.Sx \&Op
+macro line:
.Bd -literal -offset indent
\&.Bk \-words
-\&.Op o Ar output_file
+\&.Op Fl f Ar flags
+\&.Op Fl o Ar output
\&.Ek
.Ed
.Pp
-See also
-.Sx \&Ek .
+Be careful in using over-long lines within a keep block!
+Doing so will clobber the right margin.
.Ss \&Bl
Begins a list composed of one or more list entries.
Its syntax is as follows: