From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from krisdoz.my.domain (kristaps@localhost [127.0.0.1])
	by krisdoz.my.domain (8.14.3/8.14.3) with ESMTP id o66B7MuN025648
	for <source@mdocml.bsd.lv>; Tue, 6 Jul 2010 07:07:22 -0400 (EDT)
Received: (from kristaps@localhost)
	by krisdoz.my.domain (8.14.3/8.14.3/Submit) id o66B7MVM008238;
	Tue, 6 Jul 2010 07:07:22 -0400 (EDT)
Date: Tue, 6 Jul 2010 07:07:22 -0400 (EDT)
Message-Id: <201007061107.o66B7MVM008238@krisdoz.my.domain>
X-Mailinglist: mdocml-source
Reply-To: source@mdocml.bsd.lv
MIME-Version: 1.0
From: kristaps@mdocml.bsd.lv
To: source@mdocml.bsd.lv
Subject: mdocml: Clarified `Bk' operation in mdoc.7.
X-Mailer: activitymail 1.26, http://search.cpan.org/dist/activitymail/
Content-Type: text/plain; charset=utf-8

Log Message:
-----------
Clarified `Bk' operation in mdoc.7.

Modified Files:
--------------
    mdocml:
        mdoc.7

Revision Data
-------------
Index: mdoc.7
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/mdoc.7,v
retrieving revision 1.132
retrieving revision 1.133
diff -Lmdoc.7 -Lmdoc.7 -u -p -r1.132 -r1.133
--- mdoc.7
+++ mdoc.7
@@ -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:
--
 To unsubscribe send an email to source+unsubscribe@mdocml.bsd.lv