* mdocml: Clarified `Bk' operation in mdoc.7.
@ 2010-07-06 11:07 kristaps
0 siblings, 0 replies; only message in thread
From: kristaps @ 2010-07-06 11:07 UTC (permalink / raw)
To: source
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
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2010-07-06 11:07 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2010-07-06 11:07 mdocml: Clarified `Bk' operation in mdoc.7 kristaps
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).