Changes to gnats/doc/p-admin.texi

[Yngve Svendsen]

Index: gnats/doc/p-admin.texi
diff -c gnats/doc/p-admin.texi:1.23 gnats/doc/p-admin.texi:1.24
*** gnats/doc/p-admin.texi:1.23 Sun Mar 31 11:13:12 2002
--- gnats/doc/p-admin.texi      Sun Mar 31 17:19:38 2002
***************
*** 104,109 ****
--- 104,110 ----
  * databases file::        The databases file
  * dbconfig file::         The dbconfig file
  * Other config files::    Configuration files
+ * send-pr.conf file::     The send-pr.conf file
  * Admin files::           Administrative data files
  * Admin utils::           Administrative utilities
  * Internal utils::        Internal utilities
***************
*** 116,127 ****
  
  @xref{Locations,,Where @sc{gnats} lives}.
  
! @sc{gnats} has two different kinds of configuration file.  The
! @dfn{site-wide} configuration files determine overall behaviour across
! all the databases on your machine, while the @dfn{database-specific}
! configuration files determine how @sc{gnats} behaves when dealing with a
! specific database.  These files can be edited at any time --- the next
! time a @sc{gnats} tool is invoked, the new parameters will take effect.
  
  These are the site-wide configuration files used by @sc{gnats}:
  
--- 117,130 ----
  
  @xref{Locations,,Where @sc{gnats} lives}.
  
! @sc{gnats} has two, well, actually three, different kinds of
! configuration file.  The @dfn{site-wide} configuration files determine
! overall behaviour across all the databases on your machine, while the
! @dfn{database-specific} configuration files determine how @sc{gnats}
! behaves when dealing with a specific database.  In addition, there is
! a single file that needs to to be set up for the send-pr tool to work
! properly.  These files can be edited at any time --- the next time a
! @sc{gnats} tool is invoked, the new parameters will take effect.
  
  These are the site-wide configuration files used by @sc{gnats}:
  
***************
*** 204,209 ****
--- 207,218 ----
  
  @end table
  
+ The last file in this menagerie is the @code{send-pr} configuration
+ file @file{send-pr.conf}.  This file contains some defaults that need
+ to be known in order for @code{send-pr} to work.  The file needs to
+ be present on all hosts where @code{send-pr} is to be used.
+ @xref{send-pr.conf file,,the @file{send-pr.conf} file}.
+ 
  @node databases file
  @section The @code{databases} file
  @cindex @code{databases} file
***************
*** 1420,1425 ****
--- 1429,1495 ----
  
  Lines beginning with @samp{#} will be ignored, and the first listed
  class is the default class for an incoming Problem Report.
+ 
+ @node send-pr.conf file
+ @section The @file{send-pr.conf} file
+ @cindex @code{send-pr.conf} file
+ This file contains some default values that need to be known in order
+ for @code{send-pr} to work properly.  This file needs to be copied to
+ all hosts where @code{send-pr} will be used.
+ 
+ If @sc{gnats} was built with default options, the @file{send-pr.conf}
+ file should be placed in the @address@hidden/usr/local/etc/gnats}} directory.
+ However, if the option @code{--sysconfdir} was used during building of
+ @sc{gnats}, the @file{send-pr.conf} file resides at the location
+ given to this option.
+ 
+ Entries in this file are on the format
+ 
+ @smallexample
+ address@hidden
+ @end smallexample
+ 
+ The valid variables are:
+ 
+ @table @code
+ @item SUBMITTER
+ The default value to be used for the Submitter-Id field when
+ @code{send-pr} is invoked.
+ 
+ @item DEFAULT_RELEASE
+ The default value to be used for the Release field (only applicable if
+ the Release field is defined in the @file{dbconfig} file.
+ 
+ @item DEFAULT_ORGANIZATION
+ The default value to be used for the Organization field.  (only
+ applicable if the Organization field is defined in the @file{dbconfig}
+ file.
+ 
+ @item MAILPROG
+ If the @sc{gnats} server can't be reached directly over the network,
+ i.e. it is behind a firewall or suchlike, @code{send-pr} can be set up
+ to submit Problem Reports by e-mail.  This is done by setting the
+ @code{MAILPROG} variable to point to a mailer such as Sendmail.  If
+ @code{MAILPROG} needs to have the address that the mail is being sent
+ to specified on the command line, it should be specified here as well
+ (for example, @samp{MAILPROG=''mail bugs@@foo.bar.com''} should work).
+ If Sendmail is used, use @samp{MAILPROG=''/usr/lib/sendmail -oi
+ -t''}.  See also @code{MAILADDR} and @code{TEMPLATE} below.
+ 
+ @item MAILADDR
+ If using e-mail to submit PRs, this is the address that PRs should be
+ sent to.
+ 
+ @item TEMPLATE
+ When invoked, @code{send-pr} communicates directly over the network
+ with the @sc{gnats} server to determine what fields to include in a
+ correctly formatted Problem Report so that it can present the user
+ with a template.  If the @sc{gnats} server can't be reached directly
+ over the network, a template must be provided.  Set the
+ @code{TEMPLATE} variable to point to a template file created on the
+ @sc{gnats} server by using the command @command{send-pr -p}.
+ @xref{Installing tools,,Installing the user tools}.
+ @end table
  
  @node Admin files
  @section Administrative data files