[BACK]Return to mdoc.7 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.101 and 1.110

version 1.101, 2010/05/12 17:08:03 version 1.110, 2010/05/26 10:39:35
Line 301  When composing a manual, make sure that your sentences
Line 301  When composing a manual, make sure that your sentences
 a line.  a line.
 By doing so, front-ends will be able to apply the proper amount of  By doing so, front-ends will be able to apply the proper amount of
 spacing after the end of sentence (unescaped) period, exclamation mark,  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, e.g.,
   .Pp
   .D1 \&Xr mandoc 1 \.
   .D1 \&Fl T \&Ns \&Cm ascii \.
 .Sh MANUAL STRUCTURE  .Sh MANUAL STRUCTURE
 A well-formed  A well-formed
 .Nm  .Nm
Line 336  file:
Line 347  file:
 \&.Sh NAME  \&.Sh NAME
 \&.Nm foo  \&.Nm foo
 \&.Nd a description goes here  \&.Nd a description goes here
 \&.\e\*q The next is for sections 2 & 3 only.  \&.\e\*q The next is for sections 2, 3, & 9 only.
 \&.\e\*q .Sh LIBRARY  \&.\e\*q .Sh LIBRARY
 \&.  \&.
 \&.Sh SYNOPSIS  \&.Sh SYNOPSIS
Line 398  and
Line 409  and
 .Sx \&Nd .  .Sx \&Nd .
 .It Em LIBRARY  .It Em LIBRARY
 The name of the library containing the documented material, which is  The name of the library containing the documented material, which is
 assumed to be a function in a section 2 or 3 manual.  assumed to be a function in a section 2, 3, or 9 manual.
 The syntax for this is as follows:  The syntax for this is as follows:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Lb libarm  \&.Lb libarm
Line 720  Note that the
Line 731  Note that the
 macro is a  macro is a
 .Sx Block partial-implicit  .Sx Block partial-implicit
 only when invoked as the first macro  only when invoked as the first macro
 in a SYNOPSIS section line, else it is  in a
   .Em SYNOPSIS
   section line, else it is
 .Sx In-line .  .Sx In-line .
 .Ss In-line  .Ss In-line
 Closed by  Closed by
Line 1089  and
Line 1102  and
 .Ss \&Bf  .Ss \&Bf
 .Ss \&Bk  .Ss \&Bk
 .Ss \&Bl  .Ss \&Bl
 .\" Begins a list composed of one or more list entries.  A list entry is  Begins a list composed of one or more list entries.
 .\" specified by the  A list is associated with a type, which is a required argument.
 .\" .Sx \&It  Other arguments are
 .\" macro, which consists of a head and optional body.  By default, a list  .Fl width ,
 .\" is preceded by a blank line.  A list must specify one of the following  defined per-type as accepting a literal or
 .\" list types:  .Sx Scaling Widths
 .\" .Bl -tag -width 12n  value;
 .\" .It Fl bullet  .Fl offset ,
 .\" A list offset by a bullet.  The head of list entries must be empty.  also accepting a literal or
 .\" List entry bodies are justified after the bullet.  .Sx Scaling Widths
 .\" .It Fl column  value setting the list's global offset; and
 .\" A columnated list.  The number of columns is specified as arguments to  .Fl compact ,
 .\" the  suppressing the default vertical space printed before each list entry.
 .\" .Sx \&Bl  A list entry is specified by the
 .\" macro (the deprecated form of following the invocation of  .Sx \&It
 .\" .Fl column  macro, which consists of a head and optional body (depending on the list
 .\" is also accepted).  Arguments dictate the width of columns specified in  type).
 .\" list entries.  List entry bodies must be left empty.  Columns specified  A list must specify one of the following list types:
 .\" in the list entry head are justified to their position in the sequence  .Bl -tag -width 12n -offset indent
 .\" of columns.  .It Fl bullet
 .\" .It Fl dash  A list offset by a bullet.
 .\" A list offset by a dash (hyphen).  The head of list entries must be  The head of list entries must be empty.
 .\" empty.  List entry bodies are justified past the dash.  List entry bodies are positioned after the bullet.
 .\" .It Fl diag  The
 .\" Like  .Fl width
 .\" .Fl inset  argument varies the width of list bodies' left-margins.
 .\" lists, but with additional formatting to the head.  .It Fl column
 .\" .It Fl enum  A columnated list.
 .\" A list offset by a number indicating list entry position.  The head of  The
 .\" list entries must be empty.  List entry bodies are justified past the  .Fl width
 .\" enumeration.  argument has no effect.
 .\" .It Fl hang  The number of columns is specified as parameters to the
 .\" Like  .Sx \&Bl
 .\" .Fl tag ,  macro.
 .\" but instead of list bodies justifying to the head on the first line,  These dictate the width of columns either as
 .\" they trail the head text.  .Sx Scaling Widths
 .\" .It Fl hyphen  or literal text.
 .\" Synonym for  List entry bodies must be left empty.
 .\" .Fl dash .  Column bodies have the following syntax:
 .\" .It Fl inset  .Pp
 .\" Like  .D1 .It col1 <TAB> ... coln
 .\" .Fl tag ,  .D1 .It col1 Ta ... coln
 .\" but list entry bodies aren't justified.  .D1 .It col1 <TAB> col2 Ta coln
 .\" .It Fl item  .Pp
 .\" An un-justified list.  This produces blocks of text.  where columns may be separated by tabs, the literal string
 .\" .It Fl ohang  .Qq Ta ,
 .\" List bodies are placed on the line following the head.  or a mixture of both.
 .\" .It Fl tag  These are equivalent except that quoted sections propogate over tabs,
 .\" A list offset by list entry heads.  List entry bodies are justified  for example,
 .\" after the head.  .Pp
 .\" .El  .D1 .It \(dqcol1 ; <TAB> col2 ;\(dq ;
 .\" .Pp  .Pp
 .\" More...  will preserve the semicolon whitespace except for the last.
 .\" .  .It Fl dash
   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
   .Fl width
   argument.
   .El
 .Ss \&Bo  .Ss \&Bo
 Begins a block enclosed by square brackets.  Begins a block enclosed by square brackets.
 Does not have any head arguments.  Does not have any head arguments.
Line 1580  and
Line 1646  and
 .Ss \&In  .Ss \&In
 .Ss \&It  .Ss \&It
 .Ss \&Lb  .Ss \&Lb
   Specify a library.
   The calling syntax is as follows:
   .Pp
   .D1 \. Ns Sx \&Lb Cm library
   .Pp
   The
   .Cm library
   parameter may be a system library, such as
   .Cm libz
   or
   .Cm libpam ,
   in which case a small library description is printed next to the linker
   invocation; or a custom library, in which case the library name is
   printed in quotes.
   This is most commonly used in the
   .Em SYNOPSIS
   section as described in
   .Sx MANUAL STRUCTURE .
   .Pp
   Examples:
   .D1 \&.Lb libz
   .D1 \&.Lb mdoc
 .Ss \&Li  .Ss \&Li
 .Ss \&Lk  .Ss \&Lk
 Format a hyperlink.  Format a hyperlink.
Line 1732  line.
Line 1820  line.
 .Ss \&Sy  .Ss \&Sy
 .Ss \&Tn  .Ss \&Tn
 .Ss \&Ud  .Ss \&Ud
   Prints out
   .Dq currently under development.
 .Ss \&Ux  .Ss \&Ux
 Format the UNIX name.  Format the UNIX name.
 Accepts no argument.  Accepts no argument.
Line 1900  This is not the case in mandoc.
Line 1990  This is not the case in mandoc.
 In groff, the  In groff, the
 .Sx \&Cd ,  .Sx \&Cd ,
 .Sx \&Er ,  .Sx \&Er ,
   .Sx \&Ex ,
 and  and
 .Sx \&Ex  .Sx \&Rv
 macros were stipulated only to occur in certain manual sections.  macros were stipulated only to occur in certain manual sections.
 mandoc does not have these restrictions.  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  .El
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mandoc 1 ,  .Xr mandoc 1 ,
Legend:
Removed from v.1.101  
changed lines
  Added in v.1.110
CVSweb