=================================================================== RCS file: /cvs/mandoc/mdoc.7,v retrieving revision 1.103 retrieving revision 1.107 diff -u -p -r1.103 -r1.107 --- mandoc/mdoc.7 2010/05/14 15:02:03 1.103 +++ mandoc/mdoc.7 2010/05/15 07:01:51 1.107 @@ -1,4 +1,4 @@ -.\" $Id: mdoc.7,v 1.103 2010/05/14 15:02:03 kristaps Exp $ +.\" $Id: mdoc.7,v 1.107 2010/05/15 07:01:51 kristaps Exp $ .\" .\" Copyright (c) 2009 Kristaps Dzonsons .\" @@ -14,7 +14,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: May 14 2010 $ +.Dd $Mdocdate: May 15 2010 $ .Dt MDOC 7 .Os .Sh NAME @@ -301,10 +301,18 @@ When composing a manual, make sure that your sentences a line. By doing so, front-ends will be able to apply the proper amount of spacing after the end of sentence (unescaped) period, exclamation mark, -or question mark. +or question mark followed by zero or more non-sentence closing +delimiters ( +.Ns Sq \&) , +.Sq \&] , +.Sq \&' , +.Sq \&" ) . .Pp The proper spacing is also intelligently preserved if a sentence ends at -the boundary of a macro line. +the boundary of a macro line, e.g., +.Pp +.D1 \&Xr mandoc 1 \. +.D1 \&Fl T \&Ns \&Cm ascii \. .Sh MANUAL STRUCTURE A well-formed .Nm @@ -1093,6 +1101,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 +1123,14 @@ A list must specify one of the following list types: 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 +1157,50 @@ will preserve the semicolon whitespace except for the 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 @@ -1917,10 +1964,17 @@ This is not the case in mandoc. In groff, the .Sx \&Cd , .Sx \&Er , +.Sx \&Ex , and -.Sx \&Ex +.Sx \&Rv macros were stipulated only to occur in certain manual sections. mandoc does not have these restrictions. +.It +Newer groff and mandoc print +.Qq AT&T UNIX +prior to unknown arguments of +.Sx \&At ; +older groff did nothing. .El .Sh SEE ALSO .Xr mandoc 1 ,