diff options
| author | dmcmahill <dmcmahill@NetBSD.org> | 1999-10-30 17:02:43 +0000 |
|---|---|---|
| committer | dmcmahill <dmcmahill@NetBSD.org> | 1999-10-30 17:02:43 +0000 |
| commit | cbb06aec9841b654a13416bf4b04bbca7547c3b3 (patch) | |
| tree | a1ab12253facadc823c94928887e70034f1e8657 /gnu/usr.bin | |
| parent | 98b5a519ce3cda7bf5a7ee3d9d466dc829c02a97 (diff) | |
- document the environment variables used by send-pr to fill in defaults
for problem reports. See the ENVIRONMENT section of the manpage.
- document the files used by send-pr to fill in defaults for problem
reports. See the FILES section of the manpage.
This addresses PR misc/1889.
Diffstat (limited to 'gnu/usr.bin')
| -rw-r--r-- | gnu/usr.bin/send-pr/send-pr.man | 79 |
1 files changed, 63 insertions, 16 deletions
diff --git a/gnu/usr.bin/send-pr/send-pr.man b/gnu/usr.bin/send-pr/send-pr.man index 9bbcadce2a5..41a947bffc6 100644 --- a/gnu/usr.bin/send-pr/send-pr.man +++ b/gnu/usr.bin/send-pr/send-pr.man @@ -166,19 +166,51 @@ both the template and itself will help ensure all necessary information will reach the support site. .SH ENVIRONMENT -The environment variable -.B EDITOR -specifies the editor to invoke on the template. -.br -default: -.B vi -.sp -If the environment variable -.B PR_FORM -is set, then its value is used as the file name of the template for +.TP +.SM GNATS_ROOT +If the file $GNATS_ROOT/gnats-adm/config exists then it is used +to provide newer configuration information. The default value +is the empty string. +.TP +.SM LOGNAME +Sets the default for the From and Reply-To fields of the problem report. +Defaults to $USER if not set. +.TP +.SM NAME +Sets the default for the Originator field of the problem report. +If not set, then the file $HOME/.fullname is used. If +$HOME/.fullname is not present, then an attempt is made to query +the password file for a full name. +.TP +.SM ORGANIZATION +The name of a file which contains the default for the Organization field +of the problem report. +.TP +.SM PR_FORM +If this is set, then its value is used as the file name of the template for your problem-report editing session. You can use this to start with a partially completed form (for example, a form with the identification fields already completed). +.TP +.SM REPLYTO +Sets the default for the Reply-To field of the problem report. If not +set, then it defaults to $LOGNAME. +.TP +.SM TMPDIR +Specifies the temporary directory used for creating the problem report. +This directory must exist with write permissions. Defaults to /tmp if +not specified. +.TP +.SM USER_GNATS_SITE +Used to set the default site you are reporting bugs to. Defaults to +netbsd if not specified. +.TP +.SM VISUAL +Specifies the editor to invoke on the template. If not set, then the +variable EDITOR is used. If neither VISUAL nor EDITOR are +set, then +.BR vi (1) +is used. .SH "HOW TO FILL OUT A PROBLEM REPORT" Problem reports have to be in a particular form so that a program can easily manage them. Please remember the following guidelines: @@ -268,12 +300,27 @@ Submit small code samples with the PR. Contact the support site for instructions on submitting larger test cases and problematic source code. .SH FILES -.ta \w'/tmp/pbad$$ 'u -/tmp/p$$ copy of PR used in editing session -.br -/tmp/pf$$ copy of empty PR form, for testing purposes -.br -/tmp/pbad$$ file for rejected PRs +.SM /tmp/p$$ +copy of PR used in editing session +.TP +.SM /tmp/pf$$ +copy of empty PR form, for testing purposes +.TP +.SM /tmp/pbad$$ +file for rejected PRs +.TP +.SM $HOME/.fullname +Contains the default for the Originator field of the problem +report if $NAME is not set +.TP +.SM $HOME/.organization +Contains the default for the Organization field of the problem +report if $ORGANIZATION is not set. +.TP +.SM $HOME/.signature +Contains the default for the Organization field of the problem +report if $ORGANIZATION is not set and $HOME/.organization does +not exist. .SH EMACS USER INTERFACE An Emacs user interface for .B send-pr |
