Changes to gnats/doc/p-inst.texi

[Yngve Svendsen]

Index: gnats/doc/p-inst.texi
diff -c gnats/doc/p-inst.texi:1.14 gnats/doc/p-inst.texi:1.15
*** gnats/doc/p-inst.texi:1.14  Sun Mar 31 19:18:08 2002
--- gnats/doc/p-inst.texi       Mon Apr  1 11:55:46 2002
***************
*** 654,671 ****
  @cindex configuring @sc{gnats} on a network
  
  When you install the @sc{gnats} utilities, the user tools are
! installed by default on the host machine.  If your machine is part of
! a network, however, you may wish to install the user tools on each
  machine in the network so that responsible parties on those machines
  can submit new Problem Reports, query the database, and edit existing
! PRs.  
  
! In the following discussion, machines with the @sc{gnats} user
! tools installed are referred to as @dfn{client} machines.
! 
! As discussed below, there are two main ways to make the user tools
! available on client hosts, depending on where the client machines are
! located.
  
  @subsection User tools on a local network
  @cindex using @sc{gnats} over a local network
--- 654,681 ----
  @cindex configuring @sc{gnats} on a network
  
  When you install the @sc{gnats} utilities, the user tools are
! installed by default on the server machine.  If your machine is part
! of a network, however, you may wish to install the user tools on each
  machine in the network so that responsible parties on those machines
  can submit new Problem Reports, query the database, and edit existing
! PRs.  In the following discussion, machines with the @sc{gnats} user
! tools installed are referred to as @dfn{client} machines.  In general,
! there are three distinct types of client that a @sc{gnats} server may
! have to cater for:
! 
! @itemize
! @item Machines that are on the same local network as the
! @sc{gnats} server, i.e. machines that are under the same
! administratice control.
! 
! @item Machines on the general, open Internet.
! 
! @item Machines behind firewalls etc. which deny direct access
! over the network to the @sc{gnats} server.
! @end itemize
  
! Each type of client requires a different approach when it comes to
! providing access.
  
  @subsection User tools on a local network
  @cindex using @sc{gnats} over a local network
***************
*** 697,707 ****
  
  Then, @code{send-pr} can simply be invoked without any options.
  
  @subsection User tools for remote users
  @cindex using @sc{gnats} remotely
  @cindex configuring @sc{gnats} for remote users
  
! Outline for each host:
  
  @enumerate
  @item Download
--- 707,726 ----
  
  Then, @code{send-pr} can simply be invoked without any options.
  
+ The other tools, @code{query-pr} and @code{edit-pr}, work in similar
+ ways, honoring the @code{-d} option as well as the @code{GNATSDB}
+ environment variable.  @xref{GNATS user tools}.
+ 
  @subsection User tools for remote users
  @cindex using @sc{gnats} remotely
  @cindex configuring @sc{gnats} for remote users
  
! When client machines reside on the general Internet, both security and
! practical considerations may make it impossible to provide a shared
! installation of the @sc{gnats} tools.  In this case, you may choose to
! only provide access through a web interface such as Gnatsweb.  For
! clients that need the @sc{gnats} tools, the following needs to be
! carried out on the remote machines:
  
  @enumerate
  @item Download
***************
*** 714,720 ****
  need to submit by e-mail, create a template by running ``send-pr -p''
  and install this file on the clients.
  
! @c ---------------------------------------------------------------
  @node Upgrading
  @section Upgrading from older versions
  @cindex upgrading from older versions
--- 733,777 ----
  need to submit by e-mail, create a template by running ``send-pr -p''
  and install this file on the clients.
  
! For clients that have no direct network access to your @sc{gnats}
! server, such as those that are located behind strict firewalls, you
! either need to set up a web interface such as Gnatsweb (provided that
! the firewall lets web traffic through) or use a variation on the
! procedure above which sets up @code{send-pr} to submit Problem Reports
! by e-mail.  In order to query PRs, users on the remote machines will
! then have to use the the e-mail functionality of @code{query-pr}
! (@pxref{Invoking query-pr}.  Editing PRs by e-mail is not possible, so
! clients in this group who need edit access have to get access through
! a web interface if possible.
! 
! For clients without direct network access, you need to go through the
! procedure described above to install the @sc{gnats} user tools.  Then
! you should run the command
! 
! @smallexample
! send-pr -p
! @end smallexample
! 
! @emph{on the @sc{gnats} server} to print out a template for new PRs.
! Save this template and have it installed on the remote client. Then
! add the following lines to the file @file{send-pr.conf} on the client:
! 
! @smallexample
! address@hidden to template file}
! address@hidden program}
! address@hidden address for new PRs}
! @end smallexample
! 
! Substitute as appropriate for the client machine. @xref{send-pr.conf
! file}.
! 
! Note that when @code{send-pr} is set up to work over e-mail, the
! @code{GNATSDB} environment variable and the @code{-d} command line
! option have no effect since @code{send-pr} is tied to a specific
! database by way of the value of @code{MAILAADR} in the
! file{send-pr.conf} file.
! 
! @C---------------------------------------------------------------
  @node Upgrading
  @section Upgrading from older versions
  @cindex upgrading from older versions