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

Diff for /mandoc/mdoc.7 between version 1.195 and 1.196

version 1.195, 2011/08/02 01:07:26 version 1.196, 2011/08/03 21:25:23
Line 1037  Examples:
Line 1037  Examples:
 .Dl \&.Ad 0x00000000  .Dl \&.Ad 0x00000000
 .Ss \&An  .Ss \&An
 Author name.  Author name.
   Can be used both for the authors of the program, function, or driver
   documented in the manual, or for the authors of the manual itself.
 Requires either the name of an author or one of the following arguments:  Requires either the name of an author or one of the following arguments:
 .Pp  .Pp
 .Bl -tag -width "-nosplitX" -offset indent -compact  .Bl -tag -width "-nosplitX" -offset indent -compact
Line 1107  If an argument is not provided, the string
Line 1109  If an argument is not provided, the string
 is used as a default.  is used as a default.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Fl o \&Ns \&Ar file1  .Dl ".Fl o Ar file"
 .Dl \&.Ar  .Dl ".Ar"
 .Dl \&.Ar arg1 , arg2 .  .Dl ".Ar arg1 , arg2 ."
   .Pp
   The arguments to the
   .Sx \&Ar
   macro are names and placeholders for command arguments;
   for fixed strings to be passed verbatim as arguments, use
   .Sx \&Fl
   or
   .Sx \&Cm .
 .Ss \&At  .Ss \&At
 Formats an AT&T version.  Formats an AT&T version.
 Accepts one optional argument:  Accepts one optional argument:
Line 1512  and
Line 1522  and
 Kernel configuration declaration.  Kernel configuration declaration.
 This denotes strings accepted by  This denotes strings accepted by
 .Xr config 8 .  .Xr config 8 .
   It is most often used in section 4 manual pages.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Cd device le0 at scode?  .Dl \&.Cd device le0 at scode?
Line 1524  declarations.
Line 1535  declarations.
 This practise is discouraged.  This practise is discouraged.
 .Ss \&Cm  .Ss \&Cm
 Command modifiers.  Command modifiers.
 Useful when specifying configuration options or keys.  Typically used for fixed strings passed as arguments, unless
   .Sx \&Fl
   is more appropriate.
   Also useful when specifying configuration options or keys.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Cm ControlPath  .Dl ".Nm mt Fl f Ar device Cm rewind"
 .Dl \&.Cm ControlMaster  .Dl ".Nm ps Fl o Cm pid , Ns Cm command"
 .Pp  .Dl ".Nm dd Cm if= Ns Ar file1 Cm of= Ns Ar file2"
 See also  .Dl ".Cm IdentityFile Pa ~/.ssh/id_rsa"
 .Sx \&Fl .  .Dl ".Cm LogLevel Dv DEBUG"
 .Ss \&D1  .Ss \&D1
 One-line indented display.  One-line indented display.
 This is formatted by the default rules and is useful for simple indented  This is formatted by the default rules and is useful for simple indented
Line 1882  will emulate
Line 1896  will emulate
 Error constants for definitions of the  Error constants for definitions of the
 .Va errno  .Va errno
 libc global variable.  libc global variable.
   This is most often used in section 2 and 3 manual pages.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Er EPERM  .Dl \&.Er EPERM
Line 1906  for general constants.
Line 1921  for general constants.
 .Ss \&Ex  .Ss \&Ex
 Insert a standard sentence regarding command exit values of 0 on success  Insert a standard sentence regarding command exit values of 0 on success
 and >0 on failure.  and >0 on failure.
   This is most often used in section 1, 6, and 8 manual pages.
 Its syntax is as follows:  Its syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. Sx \&Ex Fl std Op Ar utility ...  .D1 Pf \. Sx \&Ex Fl std Op Ar utility ...
Line 1966  See also
Line 1982  See also
 and  and
 .Sx \&In .  .Sx \&In .
 .Ss \&Fl  .Ss \&Fl
 Command-line flag.  Command-line flag or option.
 Used when listing arguments to command-line utilities.  Used when listing arguments to command-line utilities.
 Prints a fixed-width hyphen  Prints a fixed-width hyphen
 .Sq \-  .Sq \-
Line 1976  If the argument is a macro, a hyphen is prefixed to th
Line 1992  If the argument is a macro, a hyphen is prefixed to th
 output.  output.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Fl a b c  .Dl ".Nm cat Fl v No considered harmful"
 .Dl \&.Fl \&Pf a b  .Dl ".Nm cp Fl pR Ar source ... directory"
 .Dl \&.Fl  .Dl ".Nm find Ar dir Fl type Cm d Fl name Pa CVS
 .Dl \&.Op \&Fl o \&Ns \&Ar file  .Dl ".Nm kill Fl Ar signal_number pid"
   .Dl ".Nm su Fl"
 .Pp  .Pp
 See also  See also
 .Sx \&Cm .  .Sx \&Cm .
Line 1996  Its syntax is as follows:
Line 2013  Its syntax is as follows:
 Function arguments are surrounded in parenthesis and  Function arguments are surrounded in parenthesis and
 are delimited by commas.  are delimited by commas.
 If no arguments are specified, blank parenthesis are output.  If no arguments are specified, blank parenthesis are output.
   In the
   .Em SYNOPSIS
   section, this macro starts a new output line,
   and a blank line is automatically inserted between function definitions.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Fn \*qint funcname\*q \*qint arg0\*q \*qint arg1\*q  .Dl \&.Fn \*qint funcname\*q \*qint arg0\*q \*qint arg1\*q
 .Dl \&.Fn funcname \*qint arg0\*q  .Dl \&.Fn funcname \*qint arg0\*q
 .Dl \&.Fn funcname arg0  .Dl \&.Fn funcname arg0
   .Pp
 .Bd -literal -offset indent -compact  .Bd -literal -offset indent -compact
 \&.Ft functype  \&.Ft functype
 \&.Fn funcname  \&.Fn funcname
Line 2010  When referring to a function documented in another man
Line 2032  When referring to a function documented in another man
 .Sx \&Xr  .Sx \&Xr
 instead.  instead.
 See also  See also
 .Sx MANUAL STRUCTURE  .Sx MANUAL STRUCTURE ,
   .Sx \&Fo ,
 and  and
 .Sx \&Ft .  .Sx \&Ft .
 .Ss \&Fo  .Ss \&Fo
Line 2037  Invocations usually occur in the following context:
Line 2060  Invocations usually occur in the following context:
 A  A
 .Sx \&Fo  .Sx \&Fo
 scope is closed by  scope is closed by
   .Sx \&Fc .
 .Pp  .Pp
 See also  See also
 .Sx MANUAL STRUCTURE ,  .Sx MANUAL STRUCTURE ,
Line 2052  Its syntax is as follows:
Line 2076  Its syntax is as follows:
 .Pp  .Pp
 .D1 Pf \. Sx \&Ft Ar functype  .D1 Pf \. Sx \&Ft Ar functype
 .Pp  .Pp
   In the
   .Em SYNOPSIS
   section, a new output line is started after this macro.
   .Pp
 Examples:  Examples:
 .Dl \&.Ft int  .Dl \&.Ft int
 .Bd -literal -offset indent -compact  .Bd -literal -offset indent -compact
Line 2092  This is similar to
Line 2120  This is similar to
 but used for instructions rather than values.  but used for instructions rather than values.
 .Pp  .Pp
 Examples:  Examples:
   .Dl \&.Ic :wq
 .Dl \&.Ic hash  .Dl \&.Ic hash
 .Dl \&.Ic alias  .Dl \&.Ic alias
 .Pp  .Pp
Line 2106  macro is used when referring to specific instructions.
Line 2135  macro is used when referring to specific instructions.
 An  An
 .Dq include  .Dq include
 file.  file.
 In the  When invoked as the first macro on an input line in the
 .Em SYNOPSIS  .Em SYNOPSIS
 section (only if invoked as the line macro), the first argument is  section, the argument is displayed in angle brackets
 preceded by  and preceded by
 .Dq #include ,  .Dq #include ,
 the arguments is enclosed in angle brackets.  and a blank line is inserted in front if there is a preceding
   function declaration.
   This is most often used in section 2, 3, and 9 manual pages.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.In sys/types  .Dl \&.In sys/types.h
 .Pp  .Pp
 See also  See also
 .Sx MANUAL STRUCTURE .  .Sx MANUAL STRUCTURE .
Line 2379  Examples:
Line 2410  Examples:
 \&.Oc  \&.Oc
 .Ed  .Ed
 .Ss \&Op  .Ss \&Op
 Command-line option.  Optional part of a command line.
 Used when listing options to command-line utilities.  
 Prints the argument(s) in brackets.  Prints the argument(s) in brackets.
   This is most often used in the
   .Em SYNOPSIS
   section of section 1 and 8 manual pages.
 .Pp  .Pp
 Examples:  Examples:
 .Dl \&.Op \&Fl a \&Ar b  .Dl \&.Op \&Fl a \&Ar b
Line 2439  See also
Line 2472  See also
 and  and
 .Sx \&Ux .  .Sx \&Ux .
 .Ss \&Pa  .Ss \&Pa
 A file-system path.  An absolute or relative file system path, or a file or directory name.
 If an argument is not provided, the string  If an argument is not provided, the character
 .Dq \(ti  .Sq \(ti
 is used as a default.  is used as a default.
 .Pp  .Pp
 Examples:  Examples:
Line 2704  The following standards are recognised:
Line 2737  The following standards are recognised:
 .St -xpg4  .St -xpg4
 .It \-xpg4.2  .It \-xpg4.2
 .St -xpg4.2  .St -xpg4.2
   .It \-xpg4.3
 .St -xpg4.3  .St -xpg4.3
 .It \-xbd5  .It \-xbd5
 .St -xbd5  .St -xbd5
Line 2791  This is also used for indicating global variables in t
Line 2825  This is also used for indicating global variables in t
 section, in which case a variable name is also specified.  section, in which case a variable name is also specified.
 Note that it accepts  Note that it accepts
 .Sx Block partial-implicit  .Sx Block partial-implicit
 syntax when invoked as the first macro in the  syntax when invoked as the first macro on an input line in the
 .Em SYNOPSIS  .Em SYNOPSIS
 section, else it accepts ordinary  section, else it accepts ordinary
 .Sx In-line  .Sx In-line
 syntax.  syntax.
   In the former case, this macro starts a new output line,
   and a blank line is inserted in front if there is a preceding
   function definition or include directive.
 .Pp  .Pp
 Note that this should not be confused with  Note that this should not be confused with
 .Sx \&Ft ,  .Sx \&Ft ,

Legend:
Removed from v.1.195  
changed lines
  Added in v.1.196

CVSweb