[BACK]Return to man.7 CVS log [TXT][DIR] Up to [local] / src / usr.bin / mandoc

Diff for /src/usr.bin/mandoc/Attic/man.7 between version 1.12 and 1.13

version 1.12, 2009/10/21 19:13:50 version 1.13, 2009/10/27 21:40:07
Line 237 
Line 237 
 \&.\e\*q .SH BUGS  \&.\e\*q .SH BUGS
 \&.\e\*q .SH SECURITY CONSIDERATIONS  \&.\e\*q .SH SECURITY CONSIDERATIONS
 .Ed  .Ed
   .Pp
   The sections in a
   .Nm
   document are conventionally ordered as they appear above.  Sections
   should be composed as follows:
   .Bl -tag -width Ds -offset Ds
   .It NAME
   The name(s) and a short description of the documented material.  The
   syntax for this is generally as follows:
   .Pp
   .D1 \efBname\efR \e(en description
   .It LIBRARY
   The name of the library containing the documented material, which is
   assumed to be a function in a section 2 or 3 manual.  For functions in
   the C library, this may be as follows:
   .Pp
   .D1 Standard C Library (libc, -lc)
   .It SYNOPSIS
   Documents the utility invocation syntax, function call syntax, or device
   configuration.
   .Pp
   For the first, utilities (sections 1, 6, and 8), this is
   generally structured as follows:
   .Pp
   .D1 \efBname\efR [-\efBab\efR] [-\efBc\efR\efIarg\efR] \efBpath\efR...
   .Pp
   For the second, function calls (sections 2, 3, 9):
   .Pp
   .D1 \. Ns Sx \&B No char *name(char *\efIarg\efR);
   .Pp
   And for the third, configurations (section 4):
   .Pp
   .D1 \. Ns Sx \&B No name* at cardbus ? function ?
   .Pp
   Manuals not in these sections generally don't need a SYNOPSIS.
   .It DESCRIPTION
   This expands upon the brief, one-line description in NAME.  It usually
   contains a break-down of the options (if documenting a command).
   .It IMPLEMENTATION NOTES
   Implementation-specific notes should be kept here.  This is useful when
   implementing standard functions that may have side effects or notable
   algorithmic implications.
   .It EXIT STATUS
   .It RETURN VALUES
   .It ENVIRONMENT
   .It FILES
   .It EXAMPLES
   .It DIAGNOSTICS
   .It ERRORS
   .It SEE ALSO
   .It STANDARDS
   .It HISTORY
   .It AUTHORS
   .It CAVEATS
   .It BUGS
   .It SECURITY CONSIDERATIONS
   .El
 .  .
 .  .
 .Sh MACRO SYNTAX  .Sh MACRO SYNTAX
Line 290 
Line 347 
 .It Sx \&I   Ta    n         Ta    next-line  .It Sx \&I   Ta    n         Ta    next-line
 .It Sx \&IB  Ta    n         Ta    current  .It Sx \&IB  Ta    n         Ta    current
 .It Sx \&IR  Ta    n         Ta    current  .It Sx \&IR  Ta    n         Ta    current
   .It Sx \&PD  Ta    n         Ta    current
 .It Sx \&R   Ta    n         Ta    next-line  .It Sx \&R   Ta    n         Ta    next-line
 .It Sx \&RB  Ta    n         Ta    current  .It Sx \&RB  Ta    n         Ta    current
 .It Sx \&RI  Ta    n         Ta    current  .It Sx \&RI  Ta    n         Ta    current
Line 308 
Line 366 
 .  .
 .Pp  .Pp
 The  The
   .Sx \&PD ,
 .Sx \&RS ,  .Sx \&RS ,
 .Sx \&RE ,  .Sx \&RE ,
 .Sx \&UC ,  .Sx \&UC ,
Line 370 
Line 429 
 If a block macro is next-line scoped, it may only be followed by in-line  If a block macro is next-line scoped, it may only be followed by in-line
 macros (excluding  macros (excluding
 .Sx \&DT ,  .Sx \&DT ,
   .Sx \&PD ,
 .Sx \&TH ,  .Sx \&TH ,
 .Sx \&UC ,  .Sx \&UC ,
 .Sx \&br ,  .Sx \&br ,
Line 525 
Line 585 
 .Va width  .Va width
 is specified, it's saved for later paragraph left-margins; if  is specified, it's saved for later paragraph left-margins; if
 unspecified, the saved or default width is used.  unspecified, the saved or default width is used.
   .Ss \&PD
   Has no effect.  Included for compatibility.
 .Ss \&UC  .Ss \&UC
 Has no effect.  Included for compatibility.  Has no effect.  Included for compatibility.
 .Ss \&br  .Ss \&br
Legend:
Removed from v.1.12  
changed lines
  Added in v.1.13