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

Diff for /mandoc/mdoc.7 between version 1.130 and 1.131

version 1.130, 2010/07/04 22:04:04 version 1.131, 2010/07/05 13:12:32
Line 1064  Closes a
Line 1064  Closes a
 block.  Does not have any tail arguments.  block.  Does not have any tail arguments.
 .Ss \&Bd  .Ss \&Bd
 Begins a display block.  Begins a display block.
   Its syntax is as follows:
   .Bd -ragged -offset indent
   .Pf \. Sx \&Bd
   .Fl type
   .Op Fl offset Ar width
   .Op Fl compact
   .Ed
   .Pp
 A display is collection of macros or text which may be collectively  A display is collection of macros or text which may be collectively
 offset or justified in a manner different from that  offset or justified in a manner different from that
 of the enclosing context.  of the enclosing context.
Line 1088  Centre-justify each line.
Line 1096  Centre-justify each line.
 The type must be provided first.  The type must be provided first.
 Secondary arguments are as follows:  Secondary arguments are as follows:
 .Bl -tag -width 12n -offset indent  .Bl -tag -width 12n -offset indent
 .It Fl offset Ar width  .It Fl offset Ar val
 Offset by the value of  Offset by the value of
 .Ar width ,  .Ar val ,
 which is interpreted as one of the following, specified in order:  which is interpreted as one of the following, specified in order:
 .Bl -item  .Bl -item
 .It  .It
Line 1101  the width of standard indentation;
Line 1109  the width of standard indentation;
 twice  twice
 .Ar indent ;  .Ar indent ;
 .Ar left ,  .Ar left ,
 which has no effect ;  which has no effect;
 .Ar right ,  .Ar right ,
 which justifies to the right margin; and  which justifies to the right margin; and
 .Ar center ,  .Ar center ,
Line 1122  As the calculated string length of the opaque string.
Line 1130  As the calculated string length of the opaque string.
 If not provided an argument, it will be ignored.  If not provided an argument, it will be ignored.
 .It Fl compact  .It Fl compact
 Do not assert a vertical space before the block.  Do not assert a vertical space before the block.
 .It Fl file Ar file  
 Prepend the file  
 .Ar file  
 before any text or macros within the block.  
 .El  .El
 .Pp  .Pp
 Examples:  Examples:
Line 1176  and
Line 1180  and
 .Ss \&Bk  .Ss \&Bk
 Begins a keep block, containing a collection of macros or text  Begins a keep block, containing a collection of macros or text
 to be kept together in the output.  to be kept together in the output.
 One argument is required; additional arguments are ignored.  Its syntax is as follows:
   .Pp
   .D1 Pf \. Sx \&Bk Fl words
   .Pp
 Currently, the only argument implemented is  Currently, the only argument implemented is
 .Fl words ,  .Fl words ,
 requesting to keep together all words of the contained text  requesting to keep together all words of the contained text
 on the same output line.  on the same output line.
 A  Subsequent arguments are ignored.
 .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  .Pp
 Examples:  Examples:
 .Bd -literal -offset indent  .Bd -literal -offset indent
Line 1198  See also
Line 1201  See also
 .Sx \&Ek .  .Sx \&Ek .
 .Ss \&Bl  .Ss \&Bl
 Begins a list composed of one or more list entries.  Begins a list composed of one or more list entries.
   Its syntax is as follows:
   .Bd -ragged -offset indent
   .Pf \. Sx \&Bl
   .Fl type
   .Op Fl width Ar val
   .Op Fl offset Ar val
   .Op Fl compact
   .Op HEAD ...
   .Ed
   .Pp
 A list is associated with a type, which is a required argument.  A list is associated with a type, which is a required argument.
 Other arguments are  Other arguments are
 .Fl width ,  .Fl width ,
Line 1666  See also
Line 1679  See also
 and  and
 .Sx \&Ux .  .Sx \&Ux .
 .Ss \&Ec  .Ss \&Ec
   Close a scope started by
   .Sx \&Eo .
   Its syntax is as follows:
   .Pp
   .D1 Pf \. Sx \&Ec Op Cm TERM
   .Pp
   The
   .Cm TERM
   argument is used as the enclosure tail, for example, specifying \e(rq
   will emulate
   .Sx \&Dc .
 .Ss \&Ed  .Ss \&Ed
   End a display context started by
   .Sx \&Bd .
 .Ss \&Ef  .Ss \&Ef
 Ends a font mode context started by  Ends a font mode context started by
 .Sx \&Bf .  .Sx \&Bf .
Line 1691  Examples:
Line 1717  Examples:
 .D1 \&.Em Remarks :  .D1 \&.Em Remarks :
 .Ss \&En  .Ss \&En
 .Ss \&Eo  .Ss \&Eo
   An arbitrary enclosure.
   Its syntax is as follows:
   .Pp
   .D1 Pf \. Sx \&Eo Op Cm TERM
   .Pp
   The
   .Cm TERM
   argument is used as the enclosure head, for example, specifying \e(lq
   will emulate
   .Sx \&Do .
 .Ss \&Er  .Ss \&Er
 Display error constants.  Display error constants.
 .Pp  .Pp
Line 1751  Examples:
Line 1787  Examples:
 See also  See also
 .Sx \&Fo .  .Sx \&Fo .
 .Ss \&Fc  .Ss \&Fc
   Ends a function context started by
   .Sx \&Fo .
 .Ss \&Fd  .Ss \&Fd
 Historically used to document include files.  Historically used to document include files.
 This usage has been deprecated in favour of  This usage has been deprecated in favour of
Line 1995  Examples:
Line 2033  Examples:
 .D1 \&.Lb libz  .D1 \&.Lb libz
 .D1 \&.Lb mdoc  .D1 \&.Lb mdoc
 .Ss \&Li  .Ss \&Li
   Denotes text that should be in a literal font mode.
   Note that this is a presentation term and should not be used for
   stylistically decorating technical terms.
 .Ss \&Lk  .Ss \&Lk
 Format a hyperlink.  Format a hyperlink.
 Its syntax is as follows:  Its syntax is as follows:
Line 2369  Display offsets
Line 2410  Display offsets
 and  and
 .Fl offset Ar right  .Fl offset Ar right
 are disregarded in mandoc.  are disregarded in mandoc.
 Furthermore, the  Furthermore, troff specifies a
 .Fl file Ar file  .Fl file Ar file
 argument is not supported in mandoc.  argument that is not supported in mandoc.
 Lastly, since text is not right-justified in mandoc (or even groff),  Lastly, since text is not right-justified in mandoc (or even groff),
 .Fl ragged  .Fl ragged
 and  and
Legend:
Removed from v.1.130  
changed lines
  Added in v.1.131
CVSweb