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

Diff for /mandoc/mdoc.7 between version 1.212 and 1.220

version 1.212, 2011/09/27 21:49:23 version 1.220, 2013/08/14 15:08:31
Line 657  for all other author listings.
Line 657  for all other author listings.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.An -nosplit  .Dl \&.An -nosplit
 .Dl \&.An Kristaps Dzonsons \&Aq kristaps@bsd.lv  .Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv
 .Ss \&Ao  .Ss \&Ao
 Begin a block enclosed by angle brackets.  Begin a block enclosed by angle brackets.
 Does not have any head arguments.  Does not have any head arguments.
Line 711  for fixed strings to be passed verbatim as arguments, 
Line 711  for fixed strings to be passed verbatim as arguments, 
 or  or
 .Sx \&Cm .  .Sx \&Cm .
 .Ss \&At  .Ss \&At
 Formats an AT&T version.  Formats an
   .At
   version.
 Accepts one optional argument:  Accepts one optional argument:
 .Pp  .Pp
 .Bl -tag -width "v[1-7] | 32vX" -offset indent -compact  .Bl -tag -width "v[1-7] | 32vX" -offset indent -compact
Line 820  The most popular is the imaginary macro
Line 822  The most popular is the imaginary macro
 which resolves to  which resolves to
 .Sy 6n .  .Sy 6n .
 .It  .It
 A width using the syntax described in  A scaling width as described in
 .Sx Scaling Widths .  .Xr roff 7 .
 .It  .It
 An arbitrary string, which indents by the length of this string.  An arbitrary string, which indents by the length of this string.
 .El  .El
Line 926  The
Line 928  The
 .Fl width  .Fl width
 and  and
 .Fl offset  .Fl offset
 arguments accept  arguments accept scaling widths as described in
 .Sx Scaling Widths  .Xr roff 7
 or use the length of the given string.  or use the length of the given string.
 The  The
 .Fl offset  .Fl offset
Line 956  A columnated list.
Line 958  A columnated list.
 The  The
 .Fl width  .Fl width
 argument has no effect; instead, each argument specifies the width  argument has no effect; instead, each argument specifies the width
 of one column, using either the  of one column, using either the scaling width syntax described in
 .Sx Scaling Widths  .Xr roff 7
 syntax or the string length of the argument.  or the string length of the argument.
 If the first line of the body of a  If the first line of the body of a
 .Fl column  .Fl column
 list is not an  list is not an
Line 1089  Examples:
Line 1091  Examples:
 See also  See also
 .Sx \&Bro .  .Sx \&Bro .
 .Ss \&Bsx  .Ss \&Bsx
 Format the BSD/OS version provided as an argument, or a default value if  Format the
   .Bsx
   version provided as an argument, or a default value if
 no argument is provided.  no argument is provided.
 .Pp  .Pp
 Examples:  Examples:
Line 1109  and
Line 1113  and
 Prints  Prints
 .Dq is currently in beta test.  .Dq is currently in beta test.
 .Ss \&Bx  .Ss \&Bx
 Format the BSD version provided as an argument, or a default value if no  Format the
   .Bx
   version provided as an argument, or a default value if no
 argument is provided.  argument is provided.
 .Pp  .Pp
 Examples:  Examples:
Line 1282  Its syntax is as follows:
Line 1288  Its syntax is as follows:
 .Ar title  .Ar title
 .Oo  .Oo
 .Ar section  .Ar section
 .Op Ar volume | arch  .Op Ar volume
   .Op Ar arch
 .Oc  .Oc
 .Oc  .Oc
 .Ed  .Ed
Line 1363  or
Line 1370  or
 .Ar CON  .Ar CON
 .Pq contributed manuals .  .Pq contributed manuals .
 .It Ar arch  .It Ar arch
 This specifies a specific relevant architecture.  This specifies the machine architecture a manual page applies to,
 If  where relevant, for example
 .Ar volume  .Cm alpha ,
 is not provided, it may be used in its place, else it may be used  .Cm amd64 ,
 subsequent that.  .Cm i386 ,
 It, too, is optional.  
 It must be one of  
 .Ar alpha ,  
 .Ar amd64 ,  
 .Ar amiga ,  
 .Ar arc ,  
 .Ar arm ,  
 .Ar armish ,  
 .Ar aviion ,  
 .Ar hp300 ,  
 .Ar hppa ,  
 .Ar hppa64 ,  
 .Ar i386 ,  
 .Ar landisk ,  
 .Ar loongson ,  
 .Ar luna88k ,  
 .Ar mac68k ,  
 .Ar macppc ,  
 .Ar mips64 ,  
 .Ar mvme68k ,  
 .Ar mvme88k ,  
 .Ar mvmeppc ,  
 .Ar pmax ,  
 .Ar sgi ,  
 .Ar socppc ,  
 .Ar sparc ,  
 .Ar sparc64 ,  
 .Ar sun3 ,  
 .Ar vax ,  
 or  or
 .Ar zaurus .  .Cm sparc64 .
   The list of supported architectures varies by operating system.
   For the full list of all architectures recognized by
   .Xr mandoc 1 ,
   see the file
   .Pa arch.in
   in the source distribution.
 .El  .El
 .Pp  .Pp
 Examples:  Examples:
Line 1427  for special-purpose constants and
Line 1411  for special-purpose constants and
 .Sx \&Va  .Sx \&Va
 for variable symbols.  for variable symbols.
 .Ss \&Dx  .Ss \&Dx
 Format the DragonFly BSD version provided as an argument, or a default  Format the
   .Dx
   version provided as an argument, or a default
 value if no argument is provided.  value if no argument is provided.
 .Pp  .Pp
 Examples:  Examples:
Line 1924  Its syntax is as follows:
Line 1910  Its syntax is as follows:
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Mt discuss@manpages.bsd.lv  .Dl \&.Mt discuss@manpages.bsd.lv
   .Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv
 .Ss \&Nd  .Ss \&Nd
 A one line description of the manual's content.  A one line description of the manual's content.
 This may only be invoked in the  This may only be invoked in the
Line 2105  This macro is obsolete and not implemented in
Line 2092  This macro is obsolete and not implemented in
 .Xr mandoc 1 .  .Xr mandoc 1 .
 .Pp  .Pp
 Historical  Historical
 .Xr mdoc 7  .Nm
 packages described it as  packages described it as
 .Dq "old function type (FORTRAN)" .  .Dq "old function type (FORTRAN)" .
 .Ss \&Ox  .Ss \&Ox
Line 2369  The following standards are recognised:
Line 2356  The following standards are recognised:
 .St -p1003.1b-93  .St -p1003.1b-93
 .It \-p1003.1c-95  .It \-p1003.1c-95
 .St -p1003.1c-95  .St -p1003.1c-95
   .It \-p1003.1d-99
   .St -p1003.1d-99
 .It \-p1003.1g-2000  .It \-p1003.1g-2000
 .St -p1003.1g-2000  .St -p1003.1g-2000
 .It \-p1003.1i-95  .It \-p1003.1i-95
 .St -p1003.1i-95  .St -p1003.1i-95
   .It \-p1003.1j-2000
   .St -p1003.1j-2000
   .It \-p1003.1q-2000
   .St -p1003.1q-2000
   .It \-p1003.2
   .St -p1003.2
 .It \-p1003.2-92  .It \-p1003.2-92
 .St -p1003.2-92  .St -p1003.2-92
 .It \-p1003.2a-92  .It \-p1003.2a-92
 .St -p1003.2a-92  .St -p1003.2a-92
 .It \-p1387.2-95  
 .St -p1387.2-95  
 .It \-p1003.2  
 .St -p1003.2  
 .It \-p1387.2  .It \-p1387.2
 .St -p1387.2  .St -p1387.2
   .It \-p1387.2-95
   .St -p1387.2-95
 .It \-isoC  .It \-isoC
 .St -isoC  .St -isoC
 .It \-isoC-90  .It \-isoC-90
Line 2395  The following standards are recognised:
Line 2388  The following standards are recognised:
 .St -isoC-tcor2  .St -isoC-tcor2
 .It \-isoC-99  .It \-isoC-99
 .St -isoC-99  .St -isoC-99
   .It \-isoC-2011
   .St -isoC-2011
 .It \-iso9945-1-90  .It \-iso9945-1-90
 .St -iso9945-1-90  .St -iso9945-1-90
 .It \-iso9945-1-96  .It \-iso9945-1-96
Line 2487  Examples:
Line 2482  Examples:
 Prints out  Prints out
 .Dq currently under development.  .Dq currently under development.
 .Ss \&Ux  .Ss \&Ux
 Format the UNIX name.  Format the
   .Ux
   name.
 Accepts no argument.  Accepts no argument.
 .Pp  .Pp
 Examples:  Examples:
Line 2552  Link to another manual
Line 2549  Link to another manual
 .Pq Qq cross-reference .  .Pq Qq cross-reference .
 Its syntax is as follows:  Its syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. Sx \&Xr Ar name section  .D1 Pf \. Sx \&Xr Ar name Op section
 .Pp  .Pp
 The  Cross reference the
 .Ar name  .Ar name
 and  and
 .Ar section  .Ar section
 are the name and section of the linked manual.  number of another man page;
 If  omitting the section number is rarely useful.
 .Ar section  
 is followed by non-punctuation, an  
 .Sx \&Ns  
 is inserted into the token stream.  
 This behaviour is for compatibility with  
 GNU troff.  
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Xr mandoc 1  .Dl \&.Xr mandoc 1
Line 2589  Its syntax is as follows:
Line 2580  Its syntax is as follows:
 .Pp  .Pp
 The  The
 .Ar height  .Ar height
 argument must be formatted as described in  argument is a scaling width as described in
 .Sx Scaling Widths .  .Xr roff 7 .
 If unspecified,  If unspecified,
 .Sx \&sp  .Sx \&sp
 asserts a single vertical space.  asserts a single vertical space.
Line 2984  Manually switching the font using the
Line 2975  Manually switching the font using the
 .Ql \ef  .Ql \ef
 font escape sequences is never required.  font escape sequences is never required.
 .Sh COMPATIBILITY  .Sh COMPATIBILITY
 This section documents compatibility between mandoc and other other  This section documents compatibility between mandoc and other
 troff implementations, at this time limited to GNU troff  troff implementations, at this time limited to GNU troff
 .Pq Qq groff .  .Pq Qq groff .
 The term  The term
Line 3188  utility written by Kristaps Dzonsons appeared in
Line 3179  utility written by Kristaps Dzonsons appeared in
 The  The
 .Nm  .Nm
 reference was written by  reference was written by
 .An Kristaps Dzonsons ,  .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
 .Mt kristaps@bsd.lv .  
Legend:
Removed from v.1.212  
changed lines
  Added in v.1.220
CVSweb