* mdocml: Document .Bk and .Ek; reminded by kristaps@.
@ 2010-06-27 13:30 schwarze
0 siblings, 0 replies; only message in thread
From: schwarze @ 2010-06-27 13:30 UTC (permalink / raw)
To: source
Log Message:
-----------
Document .Bk and .Ek; reminded by kristaps@.
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.126
retrieving revision 1.127
diff -Lmdoc.7 -Lmdoc.7 -u -p -r1.126 -r1.127
--- mdoc.7
+++ 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 .
--
To unsubscribe send an email to source+unsubscribe@mdocml.bsd.lv
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2010-06-27 13:30 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2010-06-27 13:30 mdocml: Document .Bk and .Ek; reminded by kristaps@ schwarze
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).