* Finish initial documentation of the Bl lists.
@ 2010-05-14 15:17 kristaps
0 siblings, 0 replies; only message in thread
From: kristaps @ 2010-05-14 15:17 UTC (permalink / raw)
To: source
Log Message:
-----------
Finish initial documentation of the Bl lists.
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.103
retrieving revision 1.104
diff -Lmdoc.7 -Lmdoc.7 -u -p -r1.103 -r1.104
--- mdoc.7
+++ mdoc.7
@@ -1093,6 +1093,18 @@ and
.Ss \&Bk
.Ss \&Bl
Begins a list composed of one or more list entries.
+A list is associated with a type, which is a required argument.
+Other arguments are
+.Fl width ,
+defined per-type as accepting a literal or
+.Sx Scaling Widths
+value;
+.Fl offset ,
+also accepting a literal or
+.Sx Scaling Widths
+value setting the list's global offset; and
+.Fl compact ,
+suppressing the default vertical space printed before each list entry.
A list entry is specified by the
.Sx \&It
macro, which consists of a head and optional body (depending on the list
@@ -1103,8 +1115,14 @@ A list must specify one of the following
A list offset by a bullet.
The head of list entries must be empty.
List entry bodies are positioned after the bullet.
+The
+.Fl width
+argument varies the width of list bodies' left-margins.
.It Fl column
A columnated list.
+The
+.Fl width
+argument has no effect.
The number of columns is specified as parameters to the
.Sx \&Bl
macro.
@@ -1131,29 +1149,50 @@ will preserve the semicolon whitespace e
A list offset by a dash (hyphen).
The head of list entries must be empty.
List entry bodies are positioned past the dash.
+The
+.Fl width
+argument varies the width of list bodies' left-margins.
.It Fl diag
Like
.Fl inset ,
but with additional formatting to the head.
+The
+.Fl width
+argument varies the width of list bodies' left-margins.
.It Fl enum
An enumerated list offset by the enumeration from 1.
The head of list entries must be empty.
List entry bodies are positioned after the enumeration.
+The
+.Fl width
+argument varies the width of list bodies' left-margins.
.It Fl hang
Like
.Fl tag ,
but instead of list bodies positioned after the head, they trail the
head text.
+The
+.Fl width
+argument varies the width of list bodies' left-margins.
.It Fl hyphen
Synonym for
.Fl dash .
.It Fl inset
List bodies follow the list head.
+The
+.Fl width
+argument is ignored.
.It Fl item
This produces blocks of text.
The head of list entries must be empty.
+The
+.Fl width
+argument is ignored.
.It Fl ohang
List bodies are positioned on the line following the head.
+The
+.Fl width
+argument is ignored.
.It Fl tag
A list offset by list entry heads. List entry bodies are positioned
after the head as specified by the
--
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-05-14 15:17 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2010-05-14 15:17 Finish initial documentation of the Bl lists 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).