Package: reportbug
Version: 3.38
Severity: wishlist
Tags: patch

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi,

I was going through the reportbug TODO and noticed that reportbug.conf
doesn't have man page.  Please find it attached with this mail.  I based
it on the reportbug.conf file in the reportbug CVS repository on alioth.

The reportbug-3.38.diff.txt file (attached) is for the following
changes (from the CVS version) in the named files:

TODO: Change the CVS repository path from
- -http://cvs.alioth.debian.org/cgi-bin/cvsweb.cgi/reportbug/ to
http://alioth.debian.org/plugins/scmcvs/cvsweb.php/?cvsroot=reportbug
and remove "Document reportbug.conf properly in a man page."

querybts.1: Add reportbug.conf(5) to "SEE ALSO"

reportbug.1: Remove reference to the default /etc/reportbug.conf.
Instead, add reportbug.conf(5) to "SEE ALSO"

debian/rules: installman reportbug.conf.5

Giridhar

- -- Package-specific info:
** Environment settings:
DEBEMAIL="[EMAIL PROTECTED]"
DEBFULLNAME="Y Giridhar Appaji Nag"

** /home/appaji/.reportbugrc:
bts debian
submit
header "X-Debbugs-Cc: Y Giridhar Appaji Nag <[EMAIL PROTECTED]>"
header "X-Debbugs-No-Ack: true"
header "X-Website: http://www.appaji.net/";
no-query-bts
cc
config-files
compress
sign gpg
email "[EMAIL PROTECTED]"
realname "Y Giridhar Appaji Nag"
replyto "Y Giridhar Appaji Nag <[EMAIL PROTECTED]>"
verify
mode advanced

- -- System Information:
Debian Release: lenny/sid
  APT prefers unstable
  APT policy: (800, 'unstable'), (700, 'experimental')
Architecture: i386 (i686)

Kernel: Linux 2.6.21-1-686 (SMP w/1 CPU core)
Locale: LANG=C, LC_CTYPE=C (charmap=ANSI_X3.4-1968)
Shell: /bin/sh linked to /bin/bash

Versions of packages reportbug depends on:
ii  apt                         0.6.46.4-0.1 Advanced front-end for dpkg
ii  python                      2.4.4-6      An interactive high-level object-o
ii  python-central              0.5.13-0.1   register and build utility for Pyt

reportbug recommends no packages.

- -- no debconf information

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (GNU/Linux)

iD8DBQFGv2B54eu+pR04mIcRAt2sAKDqN9vJ1ZK9UHmAkGdX6SRKXvQpSQCg5HZK
EuavyLjH7on0cnfYiwj0H9E=
=ilKF
-----END PGP SIGNATURE-----
Index: TODO
===================================================================
RCS file: /cvsroot/reportbug/reportbug/TODO,v
retrieving revision 1.9
diff -u -d -p -r1.9 TODO
--- TODO        17 Aug 2006 02:23:57 -0000      1.9
+++ TODO        12 Aug 2007 19:23:48 -0000
@@ -1,13 +1,9 @@
 reportbug now has public CVS read access at:
 
-http://cvs.alioth.debian.org/cgi-bin/cvsweb.cgi/reportbug/
+http://alioth.debian.org/plugins/scmcvs/cvsweb.php/?cvsroot=reportbug
 
 --
 
-Silly TODO list for 3.0 (possibly etch, depending on RM's mood):
-
-1. Document reportbug.conf properly in a man page.
-
 Silly TODO list for 4.0 (etch+1), in no particular order:
 
 1. Convert the modules to a proper package and stick it in the Python
Index: querybts.1
===================================================================
RCS file: /cvsroot/reportbug/reportbug/querybts.1,v
retrieving revision 1.2
diff -u -d -p -r1.2 querybts.1
--- querybts.1  30 Apr 2005 06:19:49 -0000      1.2
+++ querybts.1  12 Aug 2007 19:23:48 -0000
@@ -92,6 +92,6 @@ package name.
 
 You must have the python-newt package installed to run this program.
 .SH "SEE ALSO"
-reportbug(1)
+reportbug(1), reportbug.conf(5)
 .SH AUTHOR
 Chris Lawrence <[EMAIL PROTECTED]>.
Index: reportbug.1
===================================================================
RCS file: /cvsroot/reportbug/reportbug/reportbug.1,v
retrieving revision 1.17
diff -u -d -p -r1.17 reportbug.1
--- reportbug.1 19 Mar 2007 21:07:30 -0000      1.17
+++ reportbug.1 12 Aug 2007 19:23:49 -0000
@@ -430,8 +430,8 @@ with # is taken to be a comment and will
 
 Generally, options corresponding to the GNU long options for
 .B reportbug
-are supported, without leading \-\- sequences.  See the default
-.B /etc/reportbug.conf
+are supported, without leading \-\- sequences.  See 
+.B reportbug.conf(5)
 for all acceptable options.
 .SH ENVIRONMENT
 .TP
@@ -480,7 +480,9 @@ should probably be compatible with other
 .B jitterbug
 (used by Samba, AbiSource and FreeCiv) but it isn't.
 .SH "SEE ALSO"
-http://www.debian.org/Bugs/Developer#tags for available tags, querybts(1)
+reportbug.conf(5),
+.I http://www.debian.org/Bugs/Developer#tags
+for available tags, querybts(1)
 .SH AUTHOR
 Chris Lawrence <[EMAIL PROTECTED]>.
 
Index: debian/rules
===================================================================
RCS file: /cvsroot/reportbug/reportbug/debian/rules,v
retrieving revision 1.7
diff -u -d -p -r1.7 rules
--- debian/rules        10 Aug 2006 02:36:14 -0000      1.7
+++ debian/rules        12 Aug 2007 19:23:49 -0000
@@ -68,7 +68,7 @@ binary-arch: build install
 #      dh_installemacsen
 #      dh_installinit
        dh_installcron
-       dh_installman querybts.1 reportbug.1 reportbug.fr.1 reportbug.ja.1
+       dh_installman querybts.1 reportbug.1 reportbug.fr.1 reportbug.ja.1 
reportbug.conf.5
 #      dh_undocumented
        dh_installchangelogs 
        dh_link
.\" 
.\" reportbug.conf manual page Written by Y Giridhar Appaji Nag 
.\" Copyright (c) 2007 Y Giridhar Appaji Nag <[EMAIL PROTECTED]>
.\" 
.\" This manual page is distributable under the following license:
.\" 
.\" Permission to use, copy, modify, and distribute this software and its
.\" documentation for any purpose and without fee is hereby granted,
.\" provided that the above copyright notice appears in all copies and that
.\" both that copyright notice and this permission notice appear in
.\" supporting documentation.
.\" 
.\" I DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL I
.\" BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
.\" DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
.\" WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
.\" ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
.\" SOFTWARE.
.\" 
.\" $Id: $
.\" 
.TH REPORTBUG.CONF 5 "Aug 2007" "reportbug 3.38"
.SH NAME
.B reportbug.conf
- The configuration file for reportbug
.SH SYNOPSIS
.B /etc/reportbug.conf
- The configuration file for reportbug, a program designed to report bugs in the
Debian distribution
.hw config
.SH DESCRIPTION
This manual page describes the layout of the
.B reportbug(1)
configuration file and the available configuration options.  The default
location of the file is
.B /etc/reportbug.conf
and the options may be overriding in
.B $HOME/.reportbugrc
-- which follows the same format as
.B reportbug.conf
.SH "FILE FORMAT"
Configuration options can be specified in the form

\fIoption-name\fP \fIoption-value\fP

True/false (boolean) options can be specified as

\fIboolean-option\fP

Usually, \fIno-option\fP will disable
\fIoption\fP if \fIoption\fP is boolean.

Options can be specified in any order.
.SH OPTIONS
The summary of possible options (in alphabetical order) is as follows:
.TP
.B af
Use the
.B af
mailer
.TP
.B bts
The bug tracking system to use, see
.B reportbug --bts help
for a list of currently supported BTSes
.TP
.B cc (\fIboolean\fP)
Whether the reporter should be Cc:ed on the bug report
.TP
.B compress (\fIboolean\fP)
Whether modified configuration files included in the bug report should
be stripped down
.TP
.B config-files (\fIboolean\fP)
Whether modified configuration files should be included with the bug
report
.TP
.B editor
The editor to use to edit the bug report

\fIeditor "emacs -nw"\fP

.TP
.B email
Default "From:" address of the bug email (override with environment
variables, see
.B reportbug(1))

\fIemail "[EMAIL PROTECTED]"\fP

.TP
.B header
Additional headers to add to the bug email.  Like:

\fIheader "X-Debbugs-CC: [EMAIL PROTECTED]"\fP
.br
\fIheader "X-Silly-Header: I haven't edited my /etc/reportbug.conf"\fP
.br
\fIheader "X-Debbugs-No-Ack: please" # to suppress acknowledgments\fP

.TP
.B http_proxy
Default HTTP proxy used to query the BTS (override with environment
variables, see
.B reportbug(1))

\fIhttp_proxy http://proxy.example.com:3128/\fP

.TP
.B maintonly
See the
.B --maintonly
entry in
.B reportbug(1)
.TP
.B mh
Use the
.B mh
mailer
.TP
.B mode [\fInovice\fP|\fIstandard\fP|\fIadvanced\fP|\fIexpert\fP]
The default operating mode for
.B reportbug(1)
.TP
.B mta
The path to the MTA used.  Any any SMTP server on Debian should be OK
with the default

\fImta /usr/sbin/sendmail\fP

.TP
.B mua
The mailer to use (the default is empty, to use an internal mailer).
Takes an argument like that to
.B --mua
in
.B reportbug(1)

\fImua 'mutt -H'\fP

.TP
.B mutt
Use the
.B mutt
mailer
.TP
.B nmh
Use the
.B nmh
mailer
.TP
.B no-check-uid (\fIboolean\fP)
Disables checking whether the UIDs are outside admin range (\fIroot\fP
is still checked)
.TP
.B no-debconf (\fIboolean\fP)
Disables adding the
.B debconf-show
output to the bug report
.TP
.B no-query-source (\fIboolean\fP)
Disables querying the source packages for bugs
.TP
.B offline
Disables all external queries
.TP
.B query-bts (\fIboolean\fP)
Whether the BTS should be queried for existing bug reports
.TP
.B quiet
See the
.B --report-quiet
entry in
.B reportbug(1)
.TP
.B realname
The default real-name in the "From:" address of the bug email
(override with environment variables.  See
.B reportbug(1))

\fIrealname "Humberto Flores III"\fP

.TP
.B replyto
The default "Reply-To:" in the bug email (override with environment
variables.  See
.B reportbug(1))

\fIreplyto "Humberto Flores <[EMAIL PROTECTED]>"\fP

.TP
.B severity 
[\fIcritical\fP|\fIgrave\fP|\fIserious\fP|\fIimportant\fP|\fIdoes-not-build\fP|\fInormal\fP|\fIminor\fP|\fIwishlist\fP]
The default severity level of the bug reported.  Setting this in the
configuration file will disable prompting while running
.B reportbug
.TP
.B sign [\fIgpg\fP|\fIpgp\fP]
Program used to digitally sign bug reports automatically
.TP
.B smtphost
Use an MTA different from /usr/sbin/sendmail.  A port number other than
25 can also be specified

\fIsmtphost mail.example.com:2525\fP

Use \fIsmtphost localhost\fP to enable the internal MTA

.TP
.B smtppasswd
The password to use for SMTP

\fIsmtppasswd f10r35\fP

.TP
.B smtpuser
The username to use for SMTP

\fIsmtpuser hflores\fP

.TP
.B smtptls
Enables TLS encryption
.TP
.B submit
Use \fIsubmit\fP as the bug submission address
.TP
.B template
Use the template mode, bypasses all prompts and the output it sent to
stdout
.TP
.B ui [\fItext\fP|\fInewt\fP]
The user interface that
.B querybts(1)
and
.B reportbug(1)
should use
.TP
.B verify
Enables automatic verification of package installation before reporting
using debsums, if available
.SH "SEE ALSO"
reportbug(1), querybts(1)
.SH AUTHOR
reportbug was written by Chris Lawrence <[EMAIL PROTECTED]>
.PP
This manual page was written by Y Giridhar Appaji Nag
<[EMAIL PROTECTED]> for the Debian project, but may be used by others.
.PP
Last modified: 2007-08-13 by Y Giridhar Appaji Nag

Reply via email to