summaryrefslogtreecommitdiffstats
path: root/mdoc.7
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2010-06-27 13:30:51 +0000
committerIngo Schwarze <schwarze@openbsd.org>2010-06-27 13:30:51 +0000
commit805bacfa2b5e3dcd0164d1295ff66e5d44e91853 (patch)
tree239ad11edaea1904998a87e70937340a22d3b5a2 /mdoc.7
parent186075c603215a3baa6ee2dd6ff0060ae58deb63 (diff)
downloadmandoc-805bacfa2b5e3dcd0164d1295ff66e5d44e91853.tar.gz
Document .Bk and .Ek; reminded by kristaps@.
Diffstat (limited to 'mdoc.7')
-rw-r--r--mdoc.721
1 files changed, 21 insertions, 0 deletions
diff --git a/mdoc.7 b/mdoc.7
index 1a25d73f..38282d1f 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -1116,6 +1116,25 @@ and
.Sx \&Dl .
.Ss \&Bf
.Ss \&Bk
+Begins a keep block, containing a collection of macros or text
+to be kept together in the output.
+One argument is required; additional arguments are ignored.
+Currently, the only argument implemented is
+.Fl words ,
+requesting to keep together all words of the contained text
+on the same output line.
+A
+.Fl lines
+argument to keep together all lines of the contained text
+on the same page has been desired for a long time,
+but has never been implemented.
+.Pp
+Examples:
+.Bd -literal -offset indent
+\&.Bk \-words
+\&.Op o Ar output_file
+\&.Ek
+.Ed
.Ss \&Bl
Begins a list composed of one or more list entries.
A list is associated with a type, which is a required argument.
@@ -1589,6 +1608,8 @@ and
.Ss \&Ed
.Ss \&Ef
.Ss \&Ek
+Ends a keep context started by
+.Sx \&Bk .
.Ss \&El
Ends a list context started by
.Sx \&Bl .