Section: File Formats (5)
Updated: Dec 2007
This manual page describes the layout of the reportbug and querybts configuration file and the available configuration options. The default location of the file is /etc/reportbug.conf and the options may be overriding in $HOME/.reportbugrc (which follows the same format as reportbug.conf).
Please note that any configuration file has to be a valid UTF-8 document, and not in a different locale; this is particularly important in situations where localized characters have to be used (like for realname).
Configuration options can be specified in the form
True/False (boolean) options can be specified as
(if it's present, it's a True).
Usually, no-option will disable option if option is boolean.
The summary of possible options (in alphabetical order) is as follows:
- The bug tracking system to use, see reportbug --help searching for --bts option for a list of currently supported BTSes.:
- cc (boolean)
- Whether the reporter should be Cc:ed on the bug report.:
- check-available (boolean)
- Whether packages.debian.org should be queried for newer releases of the package. In advanced and expert mode, incoming.debian.org and http://ftp-master.debian.org/new.html are also checked.:
- compress (boolean)
- Whether modified configuration files included in the bug report should be stripped down.:
- config-files (boolean)
- Whether modified configuration files should be included with the bug report.:
- The editor to use to edit the bug report. Example:
editor "emacs -nw"
- Default From address of the bug email (override with environment variables, see reportbug?(1)). Example:
- Specify the Envelope From mail header (also known as Return-path); by default it's the From address but it can be selected a different one in case the MTA doesn't canonicalize local users to public addresses.:
- Specify a command to open the bug reports mbox file. You can use %s to substitute the mbox file to be used, and to insert a literal percent sign. If no %s is specified, the mbox file name is supplied at the end of the argument list. Example:
mbox_reader_cmd "mutt -f %s"
- Additional headers to add to the bug email. Like:
header "X-Debbugs-CC: email@example.com"
header "X-Silly-Header: I haven't edited my /etc/reportbug.conf"
header "X-Debbugs-No-Ack: please" # to suppress acknowledgments
- Default HTTP proxy used to query the BTS (override with environment variables, see reportbug?(1)). Example:
- The justification in case of a Release Critical bug (severity either 'critical', 'serious' or 'grave'). Example:
justification "text here"
- The GPG key to use, if different from the default one on the system. Example:
- See the --maintonly entry in reportbug?(1).:
- The max size any attachment can have. Example:
- Use the mh mailer.:
- The address of a BTS mirror. Example:
- mode [novice|standard|advanced|expert]
- The default operating mode for reportbug?(1).:
- The path to the MTA used. Any SMTP server on Debian should be OK with the default:
- The mail user agent to use (the default is empty, to use an internal mailer). Example:
mua mutt -H
- Use the mutt mailer.:
- Use the nmh mailer.:
- no-check-uid (boolean)
- Disables checking whether the UIDs are outside admin range (root is still checked).:
- no-debconf (boolean)
- Disables adding the debconf-show output to the bug report.:
- no-query-source (boolean)
- Disables querying the source packages for bugs.:
- Disables all external queries.:
- Paranoid mode: print the whole email envelope before sending it.:
- Print the report on screen, don't sent it.:
- query-bts (boolean)
- Whether the BTS should be queried for existing bug reports.:
- See the --report-quiet entry in reportbug?(1).:
- The default real-name in the From address of the bug email (override with environment variables, see reportbug?(1)). Example:
realname "Humberto Flores III"
- The default Reply-To in the bug email (override with environment variables, see reportbug?(1). Example:
replyto "Humberto Flores <firstname.lastname@example.org>"
- severity [critical|grave|serious|important|normal|minor|wishlist]
- The default severity level of the bug reported. Setting this in the configuration file will disable prompting while running reportbug.:
- sign [gpg|pgp|gnupg|none]
- Program used to digitally sign bug reports automatically ('none' to disable it).:
- Use an MTA different from /usr/sbin/sendmail. A port number other than 25 can also be specified. Example:
Use "smtphost localhost" to enable the internal MTA.
- The password to use for SMTP. Example:
- The username to use for SMTP. Example:
- Enables TLS encryption for the SMTP connection.:
- Use submit as the bug submission address.:
- Use the template mode, bypasses all prompts and the output it sent to stdout.:
- ui [text|urwid|gtk2]
- The user interface that querybts?(1) and reportbug?(1) should use.:
- Enables automatic verification of package installation before reporting using debsums, if available.:
This manual page was written by Y Giridhar Appaji Nag <email@example.com> for the Debian project, but may be used by others.