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

Diff for /mandoc/man.7 between version 1.77 and 1.78

version 1.77, 2010/07/19 10:48:36 version 1.78, 2010/07/19 23:21:39
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@bsd.lv>  .\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"  .\"
 .\" Permission to use, copy, modify, and distribute this software for any  .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above  .\" purpose with or without fee is hereby granted, provided that the above
Line 37  Use the
Line 37  Use the
 .Xr mdoc 7  .Xr mdoc 7
 language, instead.  language, instead.
 .Pp  .Pp
 An  A
 .Nm  .Nm
 document follows simple rules:  lines beginning with the control  document follows simple rules:  lines beginning with the control
 character  character
Line 52  Other lines are interpreted within the current state.
Line 52  Other lines are interpreted within the current state.
 .Sh INPUT ENCODING  .Sh INPUT ENCODING
 .Nm  .Nm
 documents may contain only graphable 7-bit ASCII characters, the  documents may contain only graphable 7-bit ASCII characters, the
 space character, and the tabs character.  space character, and the tab character.
 All manuals must have  All manuals must have
 .Ux  .Ux
 line termination.  line termination.
Line 92  and
Line 92  and
 .Ss Text Decoration  .Ss Text Decoration
 Terms may be text-decorated using the  Terms may be text-decorated using the
 .Sq \ef  .Sq \ef
 escape followed by an indicator: B (bold), I, (italic), R (Roman), or P  escape followed by an indicator: B (bold), I (italic), R (Roman), or P
 (revert to previous mode):  (revert to previous mode):
 .Pp  .Pp
 .D1 \efBbold\efR \efIitalic\efP  .D1 \efBbold\efR \efIitalic\efP
Line 300  Documents any usages of environment variables, e.g.,
Line 300  Documents any usages of environment variables, e.g.,
 .Xr environ 7 .  .Xr environ 7 .
 .It Em FILES  .It Em FILES
 Documents files used.  Documents files used.
 It's helpful to document both the file and a short description of how  It's helpful to document both the file name and a short description of how
 the file is used (created, modified, etc.).  the file is used (created, modified, etc.).
 .It Em EXIT STATUS  .It Em EXIT STATUS
 Command exit status for section 1, 6, and 8 manuals.  Command exit status for section 1, 6, and 8 manuals.
Line 346  The history of any manual without a
Line 346  The history of any manual without a
 section should be described in this section.  section should be described in this section.
 .It Em AUTHORS  .It Em AUTHORS
 Credits to authors, if applicable, should appear in this section.  Credits to authors, if applicable, should appear in this section.
 Authors should generally be noted by both name and an e-mail address.  Authors should generally be noted by both name and email address.
 .It Em CAVEATS  .It Em CAVEATS
 Explanations of common misuses and misunderstandings should be explained  Common misuses and misunderstandings should be explained
 in this section.  in this section.
 .It Em BUGS  .It Em BUGS
 Extant bugs should be described in this section.  Known bugs, limitations and work-arounds should be described
   in this section.
 .It Em SECURITY CONSIDERATIONS  .It Em SECURITY CONSIDERATIONS
 Documents any security precautions that operators should consider.  Documents any security precautions that operators should consider.
 .El  .El
 .Sh MACRO SYNTAX  .Sh MACRO SYNTAX
 Macros are one to three three characters in length and begin with a  Macros are one to three three characters in length and begin with a
 control character ,  control character,
 .Sq \&. ,  .Sq \&. ,
 at the beginning of the line.  at the beginning of the line.
 The  The
Line 393  is equivalent to
Line 394  is equivalent to
 .Sq \&.I foo .  .Sq \&.I foo .
 If next-line macros are invoked consecutively, only the last is used.  If next-line macros are invoked consecutively, only the last is used.
 If a next-line macro is followed by a non-next-line macro, an error is  If a next-line macro is followed by a non-next-line macro, an error is
 raised (unless in the case of  raised, except for
 .Sx \&br ,  .Sx \&br ,
 .Sx \&sp ,  .Sx \&sp ,
 or  and
 .Sx \&na ) .  .Sx \&na .
 .Pp  .Pp
 The syntax is as follows:  The syntax is as follows:
 .Bd -literal -offset indent  .Bd -literal -offset indent
Line 660  and
Line 661  and
 Begin an undecorated paragraph.  Begin an undecorated paragraph.
 The scope of a paragraph is closed by a subsequent paragraph,  The scope of a paragraph is closed by a subsequent paragraph,
 sub-section, section, or end of file.  sub-section, section, or end of file.
 The saved paragraph left-margin width is re-set to the default.  The saved paragraph left-margin width is reset to the default.
 .Pp  .Pp
 See also  See also
 .Sx \&HP ,  .Sx \&HP ,
Line 757  bold face.
Line 758  bold face.
 Begin a section.  Begin a section.
 The scope of a section is only closed by another section or the end of  The scope of a section is only closed by another section or the end of
 file.  file.
 The paragraph left-margin width is re-set to the default.  The paragraph left-margin width is reset to the default.
 .Ss \&SM  .Ss \&SM
 Text is rendered in small size (one point smaller than the default  Text is rendered in small size (one point smaller than the default
 font).  font).
Line 765  font).
Line 766  font).
 Begin a sub-section.  Begin a sub-section.
 The scope of a sub-section is closed by a subsequent sub-section,  The scope of a sub-section is closed by a subsequent sub-section,
 section, or end of file.  section, or end of file.
 The paragraph left-margin width is re-set to the default.  The paragraph left-margin width is reset to the default.
 .Ss \&TH  .Ss \&TH
 Sets the title of the manual page with the following syntax:  Sets the title of the manual page with the following syntax:
 .Bd -filled -offset indent  .Bd -filled -offset indent
Line 774  Sets the title of the manual page with the following s
Line 775  Sets the title of the manual page with the following s
 .Op Cm date Op Cm source Op Cm volume  .Op Cm date Op Cm source Op Cm volume
 .Ed  .Ed
 .Pp  .Pp
 At least the upper-case document title  At least the upper-case document
 .Cm title  .Cm title
 and numeric manual section  and the manual
 .Cm section  .Cm section
 arguments must be provided.  arguments must be provided.
 The  The
Line 932  control character.
Line 933  control character.
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mandoc 1 ,  .Xr mandoc 1 ,
 .Xr mandoc_char 7  .Xr mandoc_char 7
 .Sh AUTHORS  .Sh HISTORY
 The  The
   .Nm
   language first appeared as a macro package for the roff typesetting
   system in
   .At v7 .
   It was later rewritten by James Clark as a macro package for groff.
   The stand-alone implementation that is part of the
   .Xr mandoc 1
   utility written by Kristaps Dzonsons appeared in
   .Ox 4.6.
   .Sh AUTHORS
   This
 .Nm  .Nm
 reference was written by  reference was written by
 .An Kristaps Dzonsons Aq kristaps@bsd.lv .  .An Kristaps Dzonsons Aq kristaps@bsd.lv .
Legend:
Removed from v.1.77  
changed lines
  Added in v.1.78
CVSweb