104 |
* databases file:: The databases file |
* databases file:: The databases file |
105 |
* dbconfig file:: The dbconfig file |
* dbconfig file:: The dbconfig file |
106 |
* Other config files:: Configuration files |
* Other config files:: Configuration files |
107 |
|
* send-pr.conf file:: The send-pr.conf file |
108 |
* Admin files:: Administrative data files |
* Admin files:: Administrative data files |
109 |
* Admin utils:: Administrative utilities |
* Admin utils:: Administrative utilities |
110 |
* Internal utils:: Internal utilities |
* Internal utils:: Internal utilities |
117 |
|
|
118 |
@xref{Locations,,Where @sc{gnats} lives}. |
@xref{Locations,,Where @sc{gnats} lives}. |
119 |
|
|
120 |
@sc{gnats} has two different kinds of configuration file. The |
@sc{gnats} has two, well, actually three, different kinds of |
121 |
@dfn{site-wide} configuration files determine overall behaviour across |
configuration file. The @dfn{site-wide} configuration files determine |
122 |
all the databases on your machine, while the @dfn{database-specific} |
overall behaviour across all the databases on your machine, while the |
123 |
configuration files determine how @sc{gnats} behaves when dealing with a |
@dfn{database-specific} configuration files determine how @sc{gnats} |
124 |
specific database. These files can be edited at any time --- the next |
behaves when dealing with a specific database. In addition, there is |
125 |
time a @sc{gnats} tool is invoked, the new parameters will take effect. |
a single file that needs to to be set up for the send-pr tool to work |
126 |
|
properly. These files can be edited at any time --- the next time a |
127 |
|
@sc{gnats} tool is invoked, the new parameters will take effect. |
128 |
|
|
129 |
These are the site-wide configuration files used by @sc{gnats}: |
These are the site-wide configuration files used by @sc{gnats}: |
130 |
|
|
207 |
|
|
208 |
@end table |
@end table |
209 |
|
|
210 |
|
The last file in this menagerie is the @code{send-pr} configuration |
211 |
|
file @file{send-pr.conf}. This file contains some defaults that need |
212 |
|
to be known in order for @code{send-pr} to work. The file needs to |
213 |
|
be present on all hosts where @code{send-pr} is to be used. |
214 |
|
@xref{send-pr.conf file,,the @file{send-pr.conf} file}. |
215 |
|
|
216 |
@node databases file |
@node databases file |
217 |
@section The @code{databases} file |
@section The @code{databases} file |
218 |
@cindex @code{databases} file |
@cindex @code{databases} file |
1430 |
Lines beginning with @samp{#} will be ignored, and the first listed |
Lines beginning with @samp{#} will be ignored, and the first listed |
1431 |
class is the default class for an incoming Problem Report. |
class is the default class for an incoming Problem Report. |
1432 |
|
|
1433 |
|
@node send-pr.conf file |
1434 |
|
@section The @file{send-pr.conf} file |
1435 |
|
@cindex @code{send-pr.conf} file |
1436 |
|
This file contains some default values that need to be known in order |
1437 |
|
for @code{send-pr} to work properly. This file needs to be copied to |
1438 |
|
all hosts where @code{send-pr} will be used. |
1439 |
|
|
1440 |
|
If @sc{gnats} was built with default options, the @file{send-pr.conf} |
1441 |
|
file should be placed in the @w{@file{/usr/local/etc/gnats}} directory. |
1442 |
|
However, if the option @code{--sysconfdir} was used during building of |
1443 |
|
@sc{gnats}, the @file{send-pr.conf} file resides at the location |
1444 |
|
given to this option. |
1445 |
|
|
1446 |
|
Entries in this file are on the format |
1447 |
|
|
1448 |
|
@smallexample |
1449 |
|
variable=@var{value} |
1450 |
|
@end smallexample |
1451 |
|
|
1452 |
|
The valid variables are: |
1453 |
|
|
1454 |
|
@table @code |
1455 |
|
@item SUBMITTER |
1456 |
|
The default value to be used for the Submitter-Id field when |
1457 |
|
@code{send-pr} is invoked. |
1458 |
|
|
1459 |
|
@item DEFAULT_RELEASE |
1460 |
|
The default value to be used for the Release field (only applicable if |
1461 |
|
the Release field is defined in the @file{dbconfig} file. |
1462 |
|
|
1463 |
|
@item DEFAULT_ORGANIZATION |
1464 |
|
The default value to be used for the Organization field. (only |
1465 |
|
applicable if the Organization field is defined in the @file{dbconfig} |
1466 |
|
file. |
1467 |
|
|
1468 |
|
@item MAILPROG |
1469 |
|
If the @sc{gnats} server can't be reached directly over the network, |
1470 |
|
i.e. it is behind a firewall or suchlike, @code{send-pr} can be set up |
1471 |
|
to submit Problem Reports by e-mail. This is done by setting the |
1472 |
|
@code{MAILPROG} variable to point to a mailer such as Sendmail. If |
1473 |
|
@code{MAILPROG} needs to have the address that the mail is being sent |
1474 |
|
to specified on the command line, it should be specified here as well |
1475 |
|
(for example, @samp{MAILPROG=''mail bugs@@foo.bar.com''} should work). |
1476 |
|
If Sendmail is used, use @samp{MAILPROG=''/usr/lib/sendmail -oi |
1477 |
|
-t''}. See also @code{MAILADDR} and @code{TEMPLATE} below. |
1478 |
|
|
1479 |
|
@item MAILADDR |
1480 |
|
If using e-mail to submit PRs, this is the address that PRs should be |
1481 |
|
sent to. |
1482 |
|
|
1483 |
|
@item TEMPLATE |
1484 |
|
When invoked, @code{send-pr} communicates directly over the network |
1485 |
|
with the @sc{gnats} server to determine what fields to include in a |
1486 |
|
correctly formatted Problem Report so that it can present the user |
1487 |
|
with a template. If the @sc{gnats} server can't be reached directly |
1488 |
|
over the network, a template must be provided. Set the |
1489 |
|
@code{TEMPLATE} variable to point to a template file created on the |
1490 |
|
@sc{gnats} server by using the command @command{send-pr -p}. |
1491 |
|
@xref{Installing tools,,Installing the user tools}. |
1492 |
|
@end table |
1493 |
|
|
1494 |
@node Admin files |
@node Admin files |
1495 |
@section Administrative data files |
@section Administrative data files |
1496 |
@cindex admin files |
@cindex admin files |