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

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

version 1.110, 2010/05/26 10:39:35 version 1.113, 2010/06/02 12:01:00
Line 343  file:
Line 343  file:
 \&.Dd $\&Mdocdate$  \&.Dd $\&Mdocdate$
 \&.Dt mdoc 7  \&.Dt mdoc 7
 \&.Os  \&.Os
 \&.  
 \&.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, & 9 only.  \&.\e\*q The next is for sections 2, 3, & 9 only.
 \&.\e\*q .Sh LIBRARY  \&.\e\*q .Sh LIBRARY
 \&.  
 \&.Sh SYNOPSIS  \&.Sh SYNOPSIS
 \&.Nm foo  \&.Nm foo
 \&.Op Fl options  \&.Op Fl options
 \&.Ar  \&.Ar
 \&.  
 \&.Sh DESCRIPTION  \&.Sh DESCRIPTION
 The  The
 \&.Nm  \&.Nm
Line 1143  List entry bodies must be left empty.
Line 1140  List entry bodies must be left empty.
 Column bodies have the following syntax:  Column bodies have the following syntax:
 .Pp  .Pp
 .D1 .It col1 <TAB> ... coln  .D1 .It col1 <TAB> ... coln
 .D1 .It col1 Ta ... coln  .D1 .It col1 \&Ta ... coln
 .D1 .It col1 <TAB> col2 Ta coln  .D1 .It col1 <TAB> col2 \&Ta coln
 .Pp  .Pp
 where columns may be separated by tabs, the literal string  where columns may be separated by tabs, the literal string
 .Qq Ta ,  .Qq \&Ta ,
 or a mixture of both.  or a mixture of both.
 These are equivalent except that quoted sections propogate over tabs,  These are equivalent except that quoted sections propogate over tabs,
 for example,  for example,
Line 1408  This is the mandatory second macro of any
Line 1405  This is the mandatory second macro of any
 file.  file.
 Its calling syntax is as follows:  Its calling syntax is as follows:
 .Pp  .Pp
 .D1 \. Ns Sx \&Dt Cm title section Op Cm volume | arch  .D1 \. Ns Sx \&Dt Op Cm title Op Cm section Op Cm volume | arch
 .Pp  .Pp
 Its arguments are as follows:  Its arguments are as follows:
 .Bl -tag -width Ds -offset Ds  .Bl -tag -width Ds -offset Ds
 .It Cm title  .It Cm title
 The document's title (name).  The document's title (name), defaulting to
 This should be capitalised and is required.  .Qq UNKNOWN
   if unspecified.
   It should be capitalised.
 .It Cm section  .It Cm section
 The manual section.  The manual section.
 This may be one of  This may be one of
Line 1451  This may be one of
Line 1450  This may be one of
 or  or
 .Ar paper  .Ar paper
 .Pq paper .  .Pq paper .
 It is also required and should correspond to the manual's filename  It should correspond to the manual's filename suffix and defaults to
 suffix.  .Qq 1
   if unspecified.
 .It Cm volume  .It Cm volume
 This overrides the volume inferred from  This overrides the volume inferred from
 .Ar section .  .Ar section .
Line 1524  Examples:
Line 1524  Examples:
 .D1 \&.Dt FOO 1  .D1 \&.Dt FOO 1
 .D1 \&.Dt FOO 4 KM  .D1 \&.Dt FOO 4 KM
 .D1 \&.Dt FOO 9 i386  .D1 \&.Dt FOO 9 i386
 .D1 \&.Dt FOO 9 KM i386  
 .Pp  .Pp
 See also  See also
 .Sx \&Dd  .Sx \&Dd
Legend:
Removed from v.1.110  
changed lines
  Added in v.1.113
CVSweb