Changes to gnats/doc/man/databases.man

Yngve Svendsen <[email protected]> Sun, 03 Nov 2002 18:43:54 -0500
Newsgroups gmane.comp.bug-tracking.gnats.patches
Message-ID <[email protected]>
Index: gnats/doc/man/databases.man
diff -c gnats/doc/man/databases.man:1.1 gnats/doc/man/databases.man:1.2
*** gnats/doc/man/databases.man:1.1	Thu Jun 21 17:18:15 2001
--- gnats/doc/man/databases.man	Sun Nov  3 18:43:54 2002
***************
*** 1,6 ****
! .\" Copyright (c) 1993, 2000 Free Software Foundation, Inc.
  .\" See section COPYING for conditions for redistribution
! .TH databases 5 "January 2000" "GNATS @VERSION@" "GNATS configuration files"
  .de BP
  .sp
  .ti -.2i
--- 1,6 ----
! .\" Copyright (c) 1993, 2000, 2002 Free Software Foundation, Inc.
  .\" See section COPYING for conditions for redistribution
! .TH databases 5 "November 2002" "GNATS @VERSION@" "GNATS configuration files"
  .de BP
  .sp
  .ti -.2i
***************
*** 9,73 ****
  .SH NAME
  databases \- the known set of GNATS databases
  .SH DESCRIPTION
! \fBdatabases\fR contains a list of database names and their associated
! parameters.  It it used by the GNATS clients to determine the location
! of a database referred to by name.  It is located by default in
! @PREFIX@/share/gnats/databases.
! .P
! \fBdatabases\fR consists of one or more lines containing at least
! three colon-separated fields:
  .P
  .RS
! default\:The default database\:/the/directory
  .RE
  .P
! Lines beginning with a # are ignored.
! .P
! The first field is the database name, which is the string passed to
! the --database option or specified via the GNATSDB environment
! variable.  The second field is a short human-readable description of
! the database contents.  The final field is the directory where the
! database contents are kept.
! .P
! It may also contain one or two additional fields describing the
! network location of the database:
  .P
  .RS
! network\:Network db\:\:gnats.foo.com\:1234
  .RE
  .P
! The last two options describe the hostname and port of the server where
! \fBgnatsd\fR is running.
  .P
! Both a directory and a server/port may be present.  In this case
! \fBgnatsd\fR uses the directory field to determine where the database
! contents are located, while the clients use the server/port
! information to connect to \fBgnatsd\fR.
  .P
  The database name \fBdefault\fR is special; this is the entry used if
! no database name is specified via a --database option or the
  \fBGNATSDB\fR environment variable.
  .SH "SEE ALSO"
  .I Keeping Track: Managing Messages With GNATS
  (also installed as the GNU Info file
  .BR gnats.info )
- and
- .I Reporting Problems Using send-pr
- (also installed as the GNU Info file
- .BR send-pr.info ).
  .LP
! .BR gnats (7),
! .BR send-pr (1),
! .BR edit-pr (1),
  .BR delete-pr (8),
! .BR query-pr (1),
  .BR file-pr (8),
- .BR queue-pr (8),
  .BR gen-index (8),
  .BR mkcat (8),
! .BR mkdb (8).
  .SH COPYING
! Copyright (c) 1993, 2000 Free Software Foundation, Inc.
  .PP
  Permission is granted to make and distribute verbatim copies of
  this manual provided the copyright notice and this permission notice
--- 9,81 ----
  .SH NAME
  databases \- the known set of GNATS databases
  .SH DESCRIPTION
! The \fBdatabases\fR configuration file is a site-wide configuration
! file containing the list of GNATS databases that are available either
! on the host itself or remotely over the network, together with some
! parameters associated with each database.  It is located in the
! directory @PREFIX@/share/gnats.
! .P
! The file contains one line for each database. For databases located on
! the host itself, each line consists of three fields separated by
! colons:
  .P
  .RS
! database name:short description:/path/to/database
  .RE
  .P
! The first field is the database name.  This is the name used to
! identify the database when invoking programs such as \fBquery-pr\fR or
! \fBsend-pr\fR, either by using the \fB--database\fR option of the
! program or by setting the \fBGNATSDB\fR environment variable to the
! name of the database.  The second field is a short human-readable
! description of the database contents, and the final field is the
! directory where the database contents are kept.
! .P
! For a database that is located across a network, but which should be
! accessible from this host, the entry for the database should look
! like this:
  .P
  .RS
! database name:short description of database::hostname:port
  .RE
  .P
! The first two fields are the same as for local databases, the third
! field is empty (notice the two adjacent `:' symbols, indicating an
! empty field), the fourth field is the hostname of the remote GNATS
! server, and the fifth field is the port number that the remote
! GNATS server is running on.
! .P
! Note that if you add a new local database, you must create its data
! directory, including appropriate subdirectories and administrative
! files after adding an entry to \fBdatabases\fR.  This is best done
! using the \fBmkdb\fR tool.
  .P
! Lines beginning with a # are ignored.
  .P
  The database name \fBdefault\fR is special; this is the entry used if
! no database name is specified via a \fB--database\fR option or the
  \fBGNATSDB\fR environment variable.
  .SH "SEE ALSO"
  .I Keeping Track: Managing Messages With GNATS
  (also installed as the GNU Info file
  .BR gnats.info )
  .LP
! .BR databases (5),
! .BR dbconfig (5),
  .BR delete-pr (8),
! .BR edit-pr (1)
  .BR file-pr (8),
  .BR gen-index (8),
+ .BR gnats (7),
+ .BR gnatsd (8),
  .BR mkcat (8),
! .BR mkdb (8),
! .BR pr-edit (8),
! .BR query-pr (1),
! .BR queue-pr (8),
! .BR send-pr (1).
  .SH COPYING
! Copyright (c) 1993, 2000, 2002, Free Software Foundation, Inc.
  .PP
  Permission is granted to make and distribute verbatim copies of
  this manual provided the copyright notice and this permission notice