Table of Contents

1. Introducing GNATS

1.1 The database paradigm
1.2 Flowchart of GNATS activities
1.3 States of Problem Reports
1.4 Problem Report format

1.4.1 Field datatypes reference
1.4.2 Mail header fields
1.4.3 Problem Report fields

2. The GNATS User Tools

2.1 Environment variables and GNATS tools
2.2 Submitting Problem Reports

2.2.1 Creating new Problem Reports
2.2.2 Using send-pr from within Emacs
2.2.3 Invoking send-pr from the shell
2.2.4 Submitting a Problem Report via direct e-mail
2.2.5 Helpful hints

2.3 Editing existing Problem Reports

2.3.1 Invoking edit-pr from the shell

2.4 Querying the database

2.4.1 Invoking query-pr
2.4.2 Formatting query-pr output
2.4.3 Query expressions
2.4.4 Example queries

2.5 The Emacs interface to GNATS

2.5.1 Viewing Problem Reports
2.5.2 Querying Problem Reports
2.5.3 Submitting new Problem Reports
2.5.4 Editing Problem Reports
2.5.5 The Problem Report editing buffer
2.5.6 Changing the database
2.5.7 dbconfig mode
2.5.8 Other commands
2.5.9 Customization

3. Installing GNATS

3.1 Configuring and compiling the software
3.2 Installing the utilities
3.3 Installing the default database
3.4 Setting up periodic jobs
3.5 Setting up mail aliases
3.6 Installing the daemon
3.7 Installing the user tools
3.8 Upgrading from older versions

3.8.1 Overview
3.8.2 Upgrading

4. GNATS Administration

4.1 Overview of GNATS configuration
4.2 The databases file
4.3 The dbconfig file

4.3.1 Overall database configuration
4.3.2 Individual field configuration
4.3.3 Field datatypes
4.3.4 Edit controls
4.3.5 Named query definitions
4.3.6 Audit-trail formats
4.3.7 Outgoing email formats
4.3.8 Index file description
4.3.9 Initial PR input fields

4.4 Other database-specific config files

4.4.1 The categories file
4.4.2 The responsible file
4.4.3 The submitters file
4.4.4 The states file
4.4.5 The addresses file
4.4.6 The classes file

4.5 Administrative data files

4.5.1 The index file
4.5.2 The current file

4.6 Administrative utilities

4.6.1 Adding another database
4.6.2 Adding a problem category
4.6.3 Removing a problem category
4.6.4 Regenerating the index
4.6.5 Checking database health
4.6.6 Managing user passwords

4.7 Internal utilities

4.7.1 Handling incoming traffic
4.7.2 Processing incoming traffic
4.7.3 Timely reminders
4.7.4 The edit-pr driver
4.7.5 The diff-prs tool
4.7.6 The pr-age tool

A. Where GNATS lives

A.1 prefix
A.2 exec-prefix
A.3 The `gnats-adm' directory
A.4 Default installation locations

B. The GNATS network server -- gnatsd

B.1 Description of gnatsd
B.2 gnatsd options
B.3 gnatsd command protocol
B.4 gnatsd commands
B.5 gnatsd environment variables

C. Controlling access to databases

C.1 Overview
C.2 Overall gnatsd access level
C.3 Overall access levels per host
C.4 Access levels per user
C.5 Privileged gnatsd commands

D. Querying using regular expressions
E. GNATS support
Index