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

[Yngve Svendsen]

Index: gnats/doc/man/pr-edit.man
diff -c gnats/doc/man/pr-edit.man:1.1 gnats/doc/man/pr-edit.man:1.2
*** gnats/doc/man/pr-edit.man:1.1       Thu Jun 21 17:18:15 2001
--- gnats/doc/man/pr-edit.man   Sun Nov  3 18:43:54 2002
***************
*** 1,6 ****
  .\" Copyright (c) 2000 Free Software Foundation, Inc.
  .\" See section COPYING for conditions for redistribution
! .TH pr-edit 8 "January 2000" "GNATS @VERSION@" "GNATS Admininstration 
Utilities"
  .de BP
  .sp
  .ti -.2i
--- 1,6 ----
  .\" Copyright (c) 2000 Free Software Foundation, Inc.
  .\" See section COPYING for conditions for redistribution
! .TH pr-edit 8 "November 2002" "GNATS @VERSION@" "GNATS Admininstration 
Utilities"
  .de BP
  .sp
  .ti -.2i
***************
*** 13,43 ****
  .na
  .TP
  .B pr\-edit
! [\fB\-\-lock\fR\ \fIusername\fR\ |\ \fB\-l\fR\ \fIusername\fR]
! [\fB\-\-unlock\fR\ |\ \fB\-u\fR]
! [\fB\-\-lockdb\fR\ |\ \fB\-L\fR]
! [\fB\-\-unlockdb\fR\ |\ \fB\-U\fR]
! [\fB\-\-check\fR\ |\ \fB\-c\fR]
! [\fB\-\-check\-initial\fR\ |\ \fB\-C\fR]
! [\fB\-\-submit\fR\ |\ \fB\-s\fR]
! [\fB\-\-append\fR\ \fIfield\fR\ |\ \fB\-a\fR\ \fIfield\fR]
! [\fB\-\-replace\fR\ \fIfield\fR\ |\ \fB\-r\fR\ \fIfield\fR]
! [\fB\-\-delete\-pr\fR]
! [\fB\-\-process\fR\ \fIprocess\-id\fR\ |\ \fB\-p\fR\ \fIprocess\-id\fR]
! [\fB\-\-database\fR\ \fIdatabase\fR\ |\ \fB\-d\fR\ \fIdatabase\fR]
! [\fB\-\-filename\fR\ \fIfilename\fR\ |\ \fB\-f\fR\ \fIfilename\fR]
! [\fB\-\-version\fR\ |\ \fB\-V\fR]
! [\fB\-\-help\fR\ |\ \fB\-h\fR]
! [\fB\-\-user\fR\ \fInetid\fR\ |\ \fB\-v\fR\ \fInetid\fR]
! [\fB\-\-passwd\fR\ \fIpassword\fR\ |\ \fB\-w\fR\ \fIpassword\fR]
! [\fB\-\-host\fR\ \fIhost\fR\ |\ \fB\-H\fR\ \fIhost\fR]
! [\fB\-\-port\fR\ \fIport\fR\ |\ \fB\-P\fR\ \fIport\fR]
! [\fB\-\-debug\fR\ |\ \fB\-D\fR]
! [\fBPR number\fR]
  .ad b
  .hy 1
  .SH DESCRIPTION
! \fBpr\-edit\fR can be used to exit an existing \fIPR\fR by either
  replacing or appending to particular fields within the \fIPR\fR, or
  providing a new \fIPR\fR to replace the existing one. \fBpr\-edit\fR
  can also be used to create new \fIPR\fRs from scratch, or delete
--- 13,59 ----
  .na
  .TP
  .B pr\-edit
! [\ \fB\-\-lock\fR\=\fIusername\fR\ |\ \fB\-l\fR\ \fIusername\fR\ ]
! [\ \fB\-\-unlock\fR\ |\ \fB\-u\fR\ ]
! .br
! [\ \fB\-\-lockdb\fR\ |\ \fB\-L\fR\ ]\ [\ \fB\-\-unlockdb\fR\ |\ \fB\-U\fR\ ]
! .br
! [\ \fB\-\-check\fR\ |\ \fB\-c\fR\ ]
! [\ \fB\-\-check\-initial\fR\ |\ \fB\-C\fR\ ]
! .br
! [\ \fB\-\-submit\fR\ |\ \fB\-s\fR\ ]
! .br
! [\ \fB\-\-append\fR\=\fIfield\fR\ |\ \fB\-a\fR\ \fIfield\fR\ ]
! [\ \fB\-\-replace\fR\=\fIfield\fR\ |\ \fB\-r\fR\ \fIfield\fR\ ]
! .br
! [\ \fB\-\-reason\fR\=\fIreason\fR\ |\ \fB\-R\fR\ \fIreason\fR\ ]
! .br
! [\ \fB\-\-delete\-pr\fR\ ]
! .br
! [\ \fB\-\-process\fR\=\fIprocess\-id\fR\ |\ \fB\-p\fR\ \fIprocess\-id\fR\ ]
! .br
! [\ \fB\-\-database\fR\=\fIdatabase\fR\ |\ \fB\-d\fR\ \fIdatabase\fR\ ]
! .br
! [\ \fB\-\-filename\fR\=\fIfilename\fR\ |\ \fB\-f\fR\ \fIfilename\fR\ ]
! .br
! [\ \fB\-\-version\fR\ |\ \fB\-V\fR\ ]
! [\ \fB\-\-help\fR\ |\ \fB\-h\fR\ ]
! .br
! [\ \fB\-\-user\fR\=\fIusername\fR\ |\ \fB\-v\fR\ \fIusername\fR\ ]
! .br
! [\ \fB\-\-passwd\fR\=\fIpassword\fR\ |\ \fB\-w\fR\ \fIpassword\fR\ ]
! .br
! [\ \fB\-\-host\fR\=\fIhost\fR\ |\ \fB\-H\fR\ \fIhost\fR\ ]
! .br
! [\ \fB\-\-port\fR\=\fIport\fR\ |\ \fB\-P\fR\ \fIport\fR\ ]
! .br
! [\ \fB\-\-debug\fR\ |\ \fB\-D\fR\ ]
! .br
! [\ \fIPR\fR\ ]
  .ad b
  .hy 1
  .SH DESCRIPTION
! \fBpr\-edit\fR can be used to edit an existing \fIPR\fR by either
  replacing or appending to particular fields within the \fIPR\fR, or
  providing a new \fIPR\fR to replace the existing one. \fBpr\-edit\fR
  can also be used to create new \fIPR\fRs from scratch, or delete
***************
*** 96,105 ****
  in a closed state, and not locked.
  .LP
  .RS 0.5i
! Only the user address@hidden@\fR is permitted to delete \fIPR\fRs.
  .RE
  .TP 0.5i
! \fB\-\-lock\fR\ \fIusername\fR,\ \fB\-l\fR\ \fIusername\fR
  Locks the \fIPR\fR.  \fIusername\fR is associated with the lock, so
  the system administrator can determine who actually placed the lock on
  the \fIPR\fR.  However, anyone is permitted to remove locks on a
--- 112,121 ----
  in a closed state, and not locked.
  .LP
  .RS 0.5i
! Only the GNATS user (by default \fBgnats\fR) is permitted to delete \fIPR\fRs.
  .RE
  .TP 0.5i
! \fB\-\-lock\fR\=\fIusername\fR,\ \fB\-l\fR\ \fIusername\fR
  Locks the \fIPR\fR.  \fIusername\fR is associated with the lock, so
  the system administrator can determine who actually placed the lock on
  the \fIPR\fR.  However, anyone is permitted to remove locks on a
***************
*** 113,121 ****
  \fB\-\-unlock\fR,\ \fB\-u\fR
  Unlocks the \fIPR\fR.
  .TP
! \fB\-\-append\fR\ \fIfield\fR,\ \fB\-a\fR\ \fIfield\fR
  .TP
! \fB\-\-replace\fR\ \fIfield\fR,\ \fB\-r\fR\ \fIfield\fR
  \fB\-\-append\fR and \fB\-\-replace\fR are used to append or replace
  content of a specific field within a \fIPR\fR.  The new field content
  is read in from stdin (or from the file specified with the
--- 129,137 ----
  \fB\-\-unlock\fR,\ \fB\-u\fR
  Unlocks the \fIPR\fR.
  .TP
! \fB\-\-append\fR\=\fIfield\fR,\ \fB\-a\fR\ \fIfield\fR
  .TP
! \fB\-\-replace\fR\=\fIfield\fR,\ \fB\-r\fR\ \fIfield\fR
  \fB\-\-append\fR and \fB\-\-replace\fR are used to append or replace
  content of a specific field within a \fIPR\fR.  The new field content
  is read in from stdin (or from the file specified with the
***************
*** 129,136 ****
  are printed to stdout.
  .RE
  .TP 0.5i
! \fB[PR number]\fR
! If only a \fIPR number\fR is specified with no other options, a
  replacement \fIPR\fR is read in (either from stdin or the file
  specified with \fB\-\-filename\fR).  If the \fIPR\fR contents are
  valid and correct, the existing \fIPR\fR is replaced with the new
--- 145,161 ----
  are printed to stdout.
  .RE
  .TP 0.5i
! \fB\fB\-\-reason\fR\=\fIreason\fR,\ \fB\-R\fR\ \fIreason\fR
! Certain PR fields are configured in the database configuration to
! require a short text describing the reason for every change that is
! made to them.  If you edit a PR and change any such fields, you must
! provide a short text, the \fIreason\fR for the change, through this
! option.  If the option is used and no change-reason requiring field is
! actually changed, the option has no effect.
! .RE
! .TP 0.5i
! \fI[PR]\fR
! If only a \fIPR\fR number is specified with no other options, a
  replacement \fIPR\fR is read in (either from stdin or the file
  specified with \fB\-\-filename\fR).  If the \fIPR\fR contents are
  valid and correct, the existing \fIPR\fR is replaced with the new
***************
*** 142,154 ****
  are printed to stdout.
  .RE
  .TP 0.5i
! \fB\-\-database\fR\ \fIdatabase\fR,\ \fB\-d\fR\ \fIdatabase\fR
  Specifies the database which is to be manipulated.  If no database is
  specified, the database named \fIdefault\fR is assumed.  This option
  overrides the database specified in the \fBGNATSDB\fR environment
  variable.
  .TP 0.5i
! \fB\-\-filename\fR\ \fIfilename\fR,\ \fB\-f\fR\ \fIfilename\fR
  For actions that require reading in a \fIPR\fR or field content, this
  specifies the name of a file to read.  If \fB\-\-filename\fR is not
  specified, the \fIPR\fR or field content is read in from stdin.
--- 167,179 ----
  are printed to stdout.
  .RE
  .TP 0.5i
! \fB\-\-database\fR\=\fIdatabase\fR,\ \fB\-d\fR\ \fIdatabase\fR
  Specifies the database which is to be manipulated.  If no database is
  specified, the database named \fIdefault\fR is assumed.  This option
  overrides the database specified in the \fBGNATSDB\fR environment
  variable.
  .TP 0.5i
! \fB\-\-filename\fR\=\fIfilename\fR,\ \fB\-f\fR\ \fIfilename\fR
  For actions that require reading in a \fIPR\fR or field content, this
  specifies the name of a file to read.  If \fB\-\-filename\fR is not
  specified, the \fIPR\fR or field content is read in from stdin.
***************
*** 159,174 ****
  \fB\-\-help\fR,\ \fB\-h\fR
  Prints a brief usage message.
  .TP 0.5i
! \fB\-\-host\fR\ \fIhost\fR,\ \fB\-H\fR\ \fIhost\fR
  Hostname of the GNATS server.
  .TP 0.5i
! \fB\-\-port\fR\ \fIport\fR,\ \fB\-P\fR\ \fIport\fR
  The port that the GNATS server runs on.
  .TP 0.5i
! \fB\-\-user\fR\ \fInetid\fR,\ \fB\-v\fR\ \fInetid\fR
  Username used when logging into the GNATS server.
  .TP 0.5i
! \fB\-\-passwd\fR\ \fIpassword\fR,\ \fB\-w\fR\ \fIpassword\fR
  Password used when logging into the GNATS server.
  .TP 0.5i
  \fB\-\-debug\fR,\ \fB\-D\fR
--- 184,199 ----
  \fB\-\-help\fR,\ \fB\-h\fR
  Prints a brief usage message.
  .TP 0.5i
! \fB\-\-host\fR\=\fIhost\fR,\ \fB\-H\fR\ \fIhost\fR
  Hostname of the GNATS server.
  .TP 0.5i
! \fB\-\-port\fR\=\fIport\fR,\ \fB\-P\fR\ \fIport\fR
  The port that the GNATS server runs on.
  .TP 0.5i
! \fB\-\-user\fR\=\fIusername\fR,\ \fB\-v\fR\ \fIusername\fR
  Username used when logging into the GNATS server.
  .TP 0.5i
! \fB\-\-passwd\fR\=\fIpassword\fR,\ \fB\-w\fR\ \fIpassword\fR
  Password used when logging into the GNATS server.
  .TP 0.5i
  \fB\-\-debug\fR,\ \fB\-D\fR
***************
*** 192,213 ****
  .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 query-pr (1),
- .BR file-pr (8),
  .BR queue-pr (8),
! .BR rmcat (8),
! .BR gen-index (8),
! .BR mkcat (8).
  .SH COPYING
! Copyright (c) 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
--- 217,239 ----
  .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) 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