Changes to gnats/doc/man/edit-pr.man

[Yngve Svendsen]

Index: gnats/doc/man/edit-pr.man
diff -c gnats/doc/man/edit-pr.man:1.1 gnats/doc/man/edit-pr.man:1.2
*** gnats/doc/man/edit-pr.man:1.1       Thu Jun 21 17:18:15 2001
--- gnats/doc/man/edit-pr.man   Sun Nov  3 18:43:54 2002
***************
*** 1,7 ****
  .\" Copyright (c) 1993, 1999 Free Software Foundation, Inc.
  .\" See section COPYING for conditions for redistribution
  .\" edit-pr, editing function for GNATS - Jeffrey Osier
! .TH edit-pr 1 "December 1999" "GNATS @VERSION@" "GNATS User Utilities"
  .de BP
  .sp
  .ti -.2i
--- 1,7 ----
  .\" Copyright (c) 1993, 1999 Free Software Foundation, Inc.
  .\" See section COPYING for conditions for redistribution
  .\" edit-pr, editing function for GNATS - Jeffrey Osier
! .TH edit-pr 1 "November 2002" "GNATS @VERSION@" "GNATS User Utilities"
  .de BP
  .sp
  .ti -.2i
***************
*** 13,18 ****
--- 13,19 ----
  .hy 0
  .na
  .B edit-pr 
+ .RS
  [
  .B -h 
  | 
***************
*** 23,28 ****
--- 24,36 ----
  | 
  .B --version
  ]
+ .br
+ [
+ .BI -d \ databasename
+ |
+ .BI --database= databasename
+ ]
+ .br
  [
  .BI -H \ host
  |
***************
*** 33,38 ****
--- 41,47 ----
  |
  .BI --port= port
  ]
+ .br
  [
  .BI -v \ user
  |
***************
*** 43,66 ****
  |
  .BI --passwd= password
  ]
! [
! .BI -d \ databasename
! |
! .BI --database= databasename
! ]
! .I gnats-id
  .ad b
  .hy 1
  .SH DESCRIPTION
! Calls 
! .B $EDITOR
! on 
! .IR gnats-id ; 
! when finished editing, refiles 
! .I gnats-id
! in the 
! .B GNATS
! database, updating the index and sending mail to relevant parties.
  .SH OPTIONS
  .TP 1i
  .B -h\fR,\fB --help
--- 52,84 ----
  |
  .BI --passwd= password
  ]
! .br
! .I PR
  .ad b
  .hy 1
  .SH DESCRIPTION
! \fBedit-pr\fR is used to make changes to existing PRs in a GNATS
! database.
! .P
! \fBedit-pr\fR first examines the \fIPR\fR and locks it if it is not
! already locked.  This is to prevent a PR from being edited by two
! users simultaneously.  If the PR is already in the process of being
! edited, \fBedit-pr\fR displays the name of the person who owns the
! lock.
! .P
! \fBedit-pr\fR then calls \fB$EDITOR\fR on \fIPR\fR.  After the PR has
! been edited, it is resubmitted to the database, and the index is
! updated.
! .P
! If you change a field that requires a reason for the change,
! \fBedit-pr\fR prompts you to supply a reason for the change.  A
! message is then appended to the Audit-Trail field of \fIPR\fR with the
! changed values and the change reason.
! .P
! Depending on how the database is configured, editing various fields in
! the PR may also cause mail to be sent concerning these changes.  In
! the default configuration, any fields that generate Audit-Trail
! entries will cause a copy of the new Audit-Trail message to be sent.
  .SH OPTIONS
  .TP 1i
  .B -h\fR,\fB --help
***************
*** 91,96 ****
--- 109,118 ----
  Password used to log into the GNATS server.
  .B
  .SH ENVIRONMENT VARIABLES
+ The environment variable
+ .B EDITOR
+ specifies the editor to invoke on the PR.  Default is \fIvi\fR(1).
+ .TP
  The \fBGNATSDB\fR environment variable is used to determine which database to
  use.  For a local database, it contains the name of the database to access.
  .P
***************
*** 111,117 ****
  .TP
  .B /tmp/ed_pr_ch$$
  Holds 
! .B >Audit-Trail:
  change message, if needed.
  .TP
  .B /tmp/u$$
--- 133,139 ----
  .TP
  .B /tmp/ed_pr_ch$$
  Holds 
! .B Audit-Trail
  change message, if needed.
  .TP
  .B /tmp/u$$
***************
*** 120,142 ****
  .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 query-pr (1),
  .BR delete-pr (8),
  .BR file-pr (8),
- .BR queue-pr (8),
- .BR mkcat (8),
- .BR rmcat (8),
  .BR gen-index (8),
! .BR mkdb (8).
  .SH COPYING
! Copyright (c) 1993 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
--- 142,164 ----
  .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, 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