Changes to gnats/doc/gnats.texi

[Milan Zamazal]

Index: gnats/doc/gnats.texi
diff -c gnats/doc/gnats.texi:1.21 gnats/doc/gnats.texi:1.22
*** gnats/doc/gnats.texi:1.21   Sat Dec 15 10:21:54 2001
--- gnats/doc/gnats.texi        Sun Dec 23 15:20:43 2001
***************
*** 1330,1335 ****
--- 1330,1348 ----
  the replacement PR text or errors encountered while updating the PR file
  or index.
  
+ @item EDITADDR @var{address}
+ Sets the e-mail address of the person communicating with
+ @code{gnatsd}.  The command requires at least the @code{edit} access
+ level.
+ 
+ The possible responses are:
+ 
+ @code{200 (CODE_OK)}
+ @*The address was successfully set.
+ 
+ @code{440 (CODE_CMD_ERROR)}
+ @*Invalid number of arguments were supplied.
+ 
  @item APPN @var{PR} @var{field}
  @itemx REPL @var{PR} @var{field}
  Appends to or replaces the contents of @var{field} in @var{PR} with the
***************
*** 1615,1624 ****
  @section Overall access levels per host
  @cindex @file{gnatsd.host_access}
  
! The file @file{/usr/local/etc/gnats/gnatsd.host_access} controls
! overall access levels on a per-host basis, meaning that settings in this
! file apply across all databases on the server.  Entries in this file are
! on the following format:
  
  @var{host:access-level:whatever}
  
--- 1628,1638 ----
  @section Overall access levels per host
  @cindex @file{gnatsd.host_access}
  
! The file @address@hidden/gnats/gnatsd.host_access} (usually
! @file{/etc/gnats/gnatsd.host_access}) controls overall access levels
! on a per-host basis, meaning that settings in this file apply across
! all databases on the server.  Entries in this file are on the
! following format:
  
  @var{host:access-level:whatever}
  
***************
*** 1653,1669 ****
  for that database.  If it doesn't exist, or doesn't contain the user
  name given to @code{gnatsd}, then the file
  @address@hidden@var{SYSCONFDIR}/gnats/gnatsd.access}}, usually
! @address@hidden/usr/local/etc/gnats/gnatsd.access}}, specifying the per-user
  access levels across all the databases on the server is checked.
  
  If the access level is @code{none} after processing the userid and
  password, the connection is closed.
  
! The @file{gnatsd.access} files are clear text, but should be owned by
! the @sc{gnats} user with file permission 600.
! 
! Wildcard characters are supported for the userid and password. A null
! string or @samp{*} matches anything; @samp{?} matches any one character.
  
  Entries in the database-specific @file{gnatsd.access} user access file
  in the @file{gnats-adm} directory of the database have the following
--- 1667,1689 ----
  for that database.  If it doesn't exist, or doesn't contain the user
  name given to @code{gnatsd}, then the file
  @address@hidden@var{SYSCONFDIR}/gnats/gnatsd.access}}, usually
! @address@hidden/etc/gnats/gnatsd.access}}, specifying the per-user
  access levels across all the databases on the server is checked.
  
+ The user access files can only @emph{increase} the access level
+ defined in the host access files for the given host, they can never
+ lower it.
+ 
  If the access level is @code{none} after processing the userid and
  password, the connection is closed.
  
! The @file{gnatsd.access} files can contain plain text passwords, in
! such a case they should be owned by the @sc{gnats} user with file
! permission 600.
! 
! Wildcard characters are supported for the userid and password with
! plain text passwords.  A null string or @samp{*} matches anything;
! @samp{?} matches any one character.
  
  Entries in the database-specific @file{gnatsd.access} user access file
  in the @file{gnats-adm} directory of the database have the following
***************
*** 1671,1684 ****
  
  @var{userid:password:access-level}
  
! @noindent @var{password} should either be in plaintext, DES
  @code{crypt()address@hidden crypt is the standard password encryption
  format used by most UNIX systems} or MD5 hash address@hidden is
  only supported on platforms that have a @code{crypt()} function that
  supports MD5. Among others, this currently includes @sc{gnu} Linux and
  OpenBSD.}.
  
! If the password is in plaintext format, it must be prefixed by
  @samp{$0$} and if it is in MD5 format, it needs to be prefixed by the
  string @samp{$1$}.  Passwords encrypted by @code{crypt()} should have no
  prefix.
--- 1691,1704 ----
  
  @var{userid:password:access-level}
  
! @noindent @var{password} should either be in plain text, DES
  @code{crypt()address@hidden crypt is the standard password encryption
  format used by most UNIX systems} or MD5 hash address@hidden is
  only supported on platforms that have a @code{crypt()} function that
  supports MD5. Among others, this currently includes @sc{gnu} Linux and
  OpenBSD.}.
  
! If the password is in plain text format, it must be prefixed by
  @samp{$0$} and if it is in MD5 format, it needs to be prefixed by the
  string @samp{$1$}.  Passwords encrypted by @code{crypt()} should have no
  prefix.
***************
*** 1710,1716 ****
  lowers) the access level given as the default for the user's host in the
  global gnatsd.host_access file.
  
! The following shows an example gnatsd.access file with plaintext passwords:
  
  @example
  rickm:$0$ruckm:edit
--- 1730,1736 ----
  lowers) the access level given as the default for the user's host in the
  global gnatsd.host_access file.
  
! The following shows an example gnatsd.access file with plain text passwords:
  
  @example
  rickm:$0$ruckm:edit
***************
*** 1732,1738 ****
  
  The overall user access file
  @address@hidden@var{SYSCONFDIR}/gnats/gnatsd.access}}, usually
! @address@hidden/usr/local/etc/gnats/gnatsd.access}}, adds a fourth
  @var{database} field.  This file contains a comma-separated list of
  database names, as defined in the @file{databases} file
  (@pxref{databases file,,The @code{databases} file}.  Wildcard characters
--- 1752,1758 ----
  
  The overall user access file
  @address@hidden@var{SYSCONFDIR}/gnats/gnatsd.access}}, usually
! @address@hidden/etc/gnats/gnatsd.access}}, adds a fourth
  @var{database} field.  This file contains a comma-separated list of
  database names, as defined in the @file{databases} file
  (@pxref{databases file,,The @code{databases} file}.  Wildcard characters