Changes to gnats/doc/p-inst.texi

[Yngve Svendsen]

Index: gnats/doc/p-inst.texi
diff -c gnats/doc/p-inst.texi:1.19 gnats/doc/p-inst.texi:1.20
*** gnats/doc/p-inst.texi:1.19  Tue Oct 15 08:13:40 2002
--- gnats/doc/p-inst.texi       Tue Oct 15 10:01:39 2002
***************
*** 652,671 ****
  @cindex using @sc{gnats} over a network
  @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.
  
--- 652,671 ----
  @cindex using @sc{gnats} over a network
  @cindex configuring @sc{gnats} on a network
  
! When you install the @sc{gnats} utilities, the user tools
! @code{send-pr}, @code{query-pr} and @code{edit-pr} are installed 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 @minus
  @item Machines that are on the same local network as the
  @sc{gnats} server, i.e. machines that are under the same
! administrative control.
  
  @item Machines on the general, open Internet.
  
***************
*** 680,694 ****
  @cindex using @sc{gnats} over a local network
  @cindex configuring @sc{gnats} on a local network
  
! If all the machines involved reside on the same local network
! as the @sc{gnats} server, you can simply share out the directories on
! the server that contain the user tools, by default
! @file{/usr/local/bin} and the directory which contains the
! @file{send-pr.conf} configuration file, by default
! @file{/usr/local/etc/gnats}.  If you have a heterogeneous environment,
! i.e. hosts running different operating systems, you need to create
! several shared @sc{gnats} installations.  The @file{send-pr.conf} file
! is platform-independent, though.
  
  In order to submit a new PR, @code{send-pr} would then be invoked as
  follows on the client machines:
--- 680,694 ----
  @cindex using @sc{gnats} over a local network
  @cindex configuring @sc{gnats} on a local network
  
! If all the machines involved reside on the same local network as the
! @sc{gnats} server, you can simply share out the directories on the
! server that contain the user tools, by default @file{/usr/local/bin} and
! the directory which contains the @file{send-pr.conf} configuration file
! (@pxref{send-pr.conf file,,The send-pr.conf configuration file}), by
! default @file{/usr/local/etc/gnats}.  If you have a heterogeneous
! environment, i.e. hosts running different operating systems, you need to
! create several shared @sc{gnats} installations, one for each platform.
! The @file{send-pr.conf} file is platform-independent, though.
  
  In order to submit a new PR, @code{send-pr} would then be invoked as
  follows on the client machines:
***************
*** 721,773 ****
  clients that need the @sc{gnats} tools, the following needs to be
  carried out on the remote machines:
  
! @enumerate
! @item Download
! @item Configure
! @item make
! @item Install send-pr.conf
! @end enumerate
  
! Use same send-pr syntax as above or use GNATSDB, OR for sites that
! 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 ---------------------------------------------------------------
--- 721,789 ----
  clients that need the @sc{gnats} tools, the following needs to be
  carried out on the remote machines:
  
! @enumerate 
! @item Configure and build @sc{gnats} on the client machine
  
! @item Configure @code{send-pr} on the client machine
! @end enumerate
  
! You should unpack the distribution and run @code{configure} on the
! client machine in the same way as described in @ref{Configure and
! make,,Configuring and compiling the software}.  Note, however, that you
! do not need to create a @code{gnats} user on the client and you should
! not use the @code{make all info} command to build.  Instead, issue the
! following commands from the top level directory of the source
! distribution:
  
  @smallexample
! cd gnats
! make install-tools
! cd ../send-pr
! make all install
  @end smallexample
  
! This builds and installs the @code{send-pr}, @code{query-pr} and
! @code{edit-pr} tools on the client machine.  You should now configure
! @code{send-pr} by editing the @file{send-pr.conf} file
! (@pxref{send-pr.conf file,,The send-pr.conf configuration file}.)
! 
! Users on the client machine can now either use the send-pr syntax or the
! @code{GNATSDB}environment variable described in the previous section.
! 
! For sites that need to submit Problem Reports by having send-pr send
! e-mail instead of speaking directly over the network to the @sc{gnats}
! server, you need to create a problem report template on the @sc{gnats}
! server and have that template copied to a suitable location on the
! client machine (any filename and any location will do, as long as
! @code{send-pr} on the client machine can read the file).  On the
! @sc{gnats} server, use the command
  
  @smallexample
! send-pr -p > @file{filename}
  @end smallexample
  
! The file @file{filename} now contains a PR template for your database.
! Copy this file to the client.  Then edit the @file{send-pr.conf} file
! that you created on the client, set the @code{TEMPLATE} variable to
! point to the template file (@pxref{send-pr.conf file,,The send-pr.conf
! configuration file}) and make sure that the @code{MAILPROG} and
! @code{MAILADDR} varables in @file{send-pr.conf} are correctly set.  You
! should now have a working remote tool installation.
! 
! 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 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.
  
  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{MAILADDR} in the
  @file{send-pr.conf} file.
  
  @c ---------------------------------------------------------------