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

Diff for /mandoc/man.7 between version 1.19 and 1.20

version 1.19, 2009/07/14 15:56:44 version 1.20, 2009/07/20 13:45:11
Line 25 
Line 25 
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm man  .Nm man
 language was historically used to format  language was historically used to format
 .Ux  .Ux
 manuals.  This reference document describes its syntax, structure, and  manuals.  This reference document describes its syntax, structure, and
 usage.  usage.
 .Pp  .Pp
 .Bf Em  .Bf -emphasis
 Do not use  Do not use
 .Nm  .Nm
 to write your manuals.  to write your manuals.
 .Ef  .Ef
 Use the  Use the
 .Xr mdoc 7  .Xr mdoc 7
Line 43  language, instead.
Line 43  language, instead.
 An  An
 .Nm  .Nm
 document follows simple rules:  lines beginning with the control  document follows simple rules:  lines beginning with the control
 character  character
 .Sq \&.  .Sq \&.
 are parsed for macros.  Other lines are interpreted within the scope of  are parsed for macros.  Other lines are interpreted within the scope of
 prior macros:  prior macros:
Line 57  Other lines are interpreted within the current state.
Line 57  Other lines are interpreted within the current state.
 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.  All manuals must have  space character, and the tabs character.  All manuals must have
 .Ux  .Ux
 line termination.  line termination.
 .Pp  .Pp
 Blank lines are acceptable; where found, the output will assert a  Blank lines are acceptable; where found, the output will assert a
 vertical space.  vertical space.
Line 71  subsequent word isn't off-set by whitespace.
Line 71  subsequent word isn't off-set by whitespace.
 .\" SUB-SECTION  .\" SUB-SECTION
 .Ss Comments  .Ss Comments
 Anything following a  Anything following a
 .Sq \e"  .Sq \e"
 delimiter is considered a comment (unless the  delimiter is considered a comment (unless the
 .Sq \e  .Sq \e
 itself has been escaped) and is ignored to the end of line.  itself has been escaped) and is ignored to the end of line.
 Furthermore, a macro line with only a control character  Furthermore, a macro line with only a control character
Line 82  optionally followed by whitespace, is ignored.
Line 82  optionally followed by whitespace, is ignored.
 .Ss Special Characters  .Ss Special Characters
 Special character sequences begin with the escape character  Special character sequences begin with the escape character
 .Sq \e  .Sq \e
 followed by either an open-parenthesis  followed by either an open-parenthesis
 .Sq \&(  .Sq \&(
 for two-character sequences; an open-bracket  for two-character sequences; an open-bracket
 .Sq \&[  .Sq \&[
Line 114  macro describing the document's section and title.  It
Line 114  macro describing the document's section and title.  It
 anywhere in the document, although conventionally, it appears as the  anywhere in the document, although conventionally, it appears as the
 first macro.  first macro.
 .Pp  .Pp
 Beyond the  Beyond the
 .Sq \&.TH ,  .Sq \&.TH ,
 at least one macro or text node must appear in the document.  at least one macro or text node must appear in the document.
 .\" SECTION  .\" SECTION
Line 129  and
Line 129  and
 .Sq \&.\ \ \ \&PP  .Sq \&.\ \ \ \&PP
 are equivalent.  are equivalent.
 .Pp  .Pp
 All  All
 .Nm  .Nm
 macros follow the same structural rules:  macros follow the same structural rules:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.YO \(lBbody...\(rB  \&.YO \(lBbody...\(rB
 .Ed  .Ed
 .Pp  .Pp
 The  The
Line 141  The
Line 141  The
 consists of zero or more arguments to the macro.  consists of zero or more arguments to the macro.
 .Pp  .Pp
 .Nm  .Nm
 has a primitive notion of multi-line scope for the following macros:  has a primitive notion of multi-line scope for the following macros:
 .Sq \&.TM ,  .Sq \&.TM ,
 .Sq \&.SM ,  .Sq \&.SM ,
 .Sq \&.SB ,  .Sq \&.SB ,
Line 152  has a primitive notion of multi-line scope for the fol
Line 152  has a primitive notion of multi-line scope for the fol
 .Sq \&.R ,  .Sq \&.R ,
 .Sq \&.B ,  .Sq \&.B ,
 .Sq \&.I ,  .Sq \&.I ,
 .Sq \&.IR  .Sq \&.IR
 and  and
 .Sq \&.RI .  .Sq \&.RI .
 When these macros are invoked without arguments, the subsequent line is  When these macros are invoked without arguments, the subsequent line is
 considered a continuation of the macro.  Thus:  considered a continuation of the macro.  Thus:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.RI  \&.RI
 foo  foo
 .Ed  .Ed
 .Pp  .Pp
 is equivalent to  is equivalent to
 .Sq \&.RI foo .  .Sq \&.RI foo .
 If two consecutive lines exhibit the latter behaviour,  If two consecutive lines exhibit the latter behaviour,
 an error is raised.  Thus, the following is not acceptable:  an error is raised.  Thus, the following is not acceptable:
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.RI  \&.RI
 \&.I  \&.I
 Hello, world.  Hello, world.
 .Ed  .Ed
 .Pp  .Pp
Line 178  macro is similar, but does not need an empty argument 
Line 178  macro is similar, but does not need an empty argument 
 the behaviour.  the behaviour.
 .\" SECTION  .\" SECTION
 .Sh MACROS  .Sh MACROS
 This section contains a complete list of all  This section contains a complete list of all
 .Nm  .Nm
 macros and corresponding number of arguments.  macros and corresponding number of arguments.
 .Pp  .Pp
Line 232  for groff compatibility notes.
Line 232  for groff compatibility notes.
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
 utility was written by  utility was written by
 .An Kristaps Dzonsons Aq kristaps@kth.se .  .An Kristaps Dzonsons Aq kristaps@kth.se .
 .\" SECTION  .\" SECTION
 .Sh CAVEATS  .Sh CAVEATS
Legend:
Removed from v.1.19  
changed lines
  Added in v.1.20
CVSweb