REPORTBUG.CONF(5)

๐Ÿ“ฆ
version 13.2.0ubuntu1 ยท 3 versions
, in debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

๐Ÿ’– reportbug.conf(5) ๐Ÿ’–

okay so bestie, welcome to the reportbug.conf manual page โ€” yes it's a File Formats Manual, yes it's section 5, and yes we're gonna make it cute. this is the configuration file for reportbug. ๐ŸŽ€


โœจ NAME โœจ

reportbug.conf โ€” the configuration file for reportbug ๐ŸŒธ


โœจ SYNOPSIS โœจ

/etc/reportbug.conf - The configuration file for reportbug, a program
designed to report bugs in the Debian distribution

โœจ DESCRIPTION โœจ

so basically this page tells you how the reportbug and querybts config file is laid out, plus every single option you can put in it. ๐Ÿ’… the default home for it is /etc/reportbug.conf, and you can override stuff in $HOME/.reportbugrc (same format as reportbug.conf, no cap). โœจ

โš ๏ธ lowkey important: any config file has to be a valid UTF-8 document, and not in some other locale. this hits different when you need localized characters (like for realname). ๐Ÿ˜ญ

๐ŸŒˆ FILE FORMAT ๐ŸŒˆ

config options go in like this:

option-name option-value

True/False (boolean) options go in like this:

boolean-option

(if it's there, it's a True. periodt. ๐Ÿ‘‘)

usually, no-option will disable option if option is boolean. โœจ

and you can put options in any order you want. no rules, we're free. ๐Ÿฆ‹


๐Ÿ’… OPTIONS ๐Ÿ’…

here's the summary of possible options (alphabetical, because we're organized like that bestie):

  • bts โ€” the bug tracking system to use. run reportbug --bts=help to see the list of currently supported BTSes. ๐Ÿ”ฅ
  • cc (boolean) โ€” whether the reporter should be Cc:ed on the bug report. ๐Ÿ‘€
  • check-available (boolean) โ€” whether Debian package lists should be queried for newer releases of the package. and in advanced and expert mode, https://ftp-master.debian.org/new.html also gets 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. ๐ŸŽ€
  • draftpath โ€” the directory where unsubmitted reports should be saved. default is /tmp.
  • editor โ€” the editor to use to edit the bug report. example:
editor "emacs -nw"
  • email โ€” default From address of the bug email (override with environment variables, see reportbug(1)). example:
email "humberto@example.com"
  • envelopefrom โ€” specify the Envelope From mail header (also known as Return-path). by default it's the From address, but you can pick a different one in case the MTA doesn't canonicalize local users to public addresses. you can set this to the empty string if the MTA doesn't allow setting the Envelope From. ๐Ÿ’Œ
  • list-cc-me (boolean) โ€” send a carbon copy of the report to your automatically detected email address after a report number is assigned, like the --list-cc-me option. ๐Ÿซถ
  • mbox_reader_cmd โ€” 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"
  • header โ€” additional headers to add to the bug email. like:
header "X-Silly-Header: I haven't edited my /etc/reportbug.conf"
header "X-Debbugs-No-Ack: please" # to suppress acknowledgments
note that setting additional headers may not work reliably if the bug email is passed to an external MUA for submission. ๐Ÿ’€
  • http_proxy โ€” default HTTP proxy used to query the BTS (override with environment variables, see reportbug(1)). example:
http_proxy http://proxy.example.com:3128/
  • justification โ€” the justification in case of a Release Critical bug (severity either 'critical', 'serious' or 'grave'). example:
justification "text here"
  • keyid โ€” the GPG key to use, if different from the default one on the system. example:
keyid 12345678
  • maintonly โ€” see the --maintonly entry in reportbug(1). ๐Ÿ‘‘
  • max_attachment_size โ€” the max size any attachment can have. example:
max_attachment_size 5000000
  • mh โ€” use the mh mailer. ๐Ÿ“ฌ
  • mirror โ€” the address of a BTS mirror. example:
mirror http://mirror.address/
  • mode [novice|standard|advanced|expert] โ€” the default operating mode for reportbug(1). โœจ
  • mta โ€” the path to the MTA used. any SMTP server on Debian should be OK with the default:
mta /usr/sbin/sendmail
  • mua โ€” the mail user agent to use (the default is empty, to use an internal mailer). example:
mua 'mutt -H'
  • mutt โ€” use the mutt mailer. ๐Ÿ•
  • nmh โ€” 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.
  • offline โ€” disables all external queries. ๐Ÿ›‘โœจ
  • paranoid โ€” paranoid mode: print the whole email envelope before sending it. ๐Ÿ‘€
  • printonly โ€” print the report on screen, don't sent it. ๐Ÿ–จ๏ธ
  • query-bts (boolean) โ€” whether the BTS should be queried for existing bug reports.
  • quiet โ€” see the --report-quiet entry in reportbug(1).
  • realname โ€” the default real-name in the From address of the bug email (override with environment variables, see reportbug(1)). example:
realname "Humberto Flores III"
  • replyto โ€” the default Reply-To in the bug email (override with environment variables, see reportbug(1). example:
replyto "Humberto Flores <humflores@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). โœ๏ธ
  • smtphost โ€” use an MTA different from /usr/sbin/sendmail. a port number other than 25 can also be specified. example:
smtphost mail.example.com:2525

use "smtphost localhost" to enable the internal MTA. ๐Ÿ 

  • smtppasswd โ€” the password to use for SMTP. example:
smtppasswd f10r35
  • smtpuser โ€” the username to use for SMTP. example:
smtpuser hflores
  • smtptls โ€” enables TLS encryption for the SMTP connection, using STARTTLS. this setting is ignored if you connect to port 465, in which case SSL/TLS will always be used. ๐Ÿ”’
  • submit โ€” use submit as the bug submission address. ๐Ÿ“ฎ
  • template โ€” use the template mode, bypasses all prompts and the output it sent to stdout. โœจ
  • timeout โ€” the number of seconds to wait for a network resource to respond. the default is 60 seconds. example:
timeout 30
  • ui [text|urwid|gtk] โ€” the user interface that querybts(1) and reportbug(1) should use. ๐ŸŽ€
  • verify โ€” enables automatic verification of package installation before reporting using debsums, if available. โœ…

๐ŸŒธ SEE ALSO ๐ŸŒธ

reportbug(1), querybts(1)


๐Ÿ‘‘ AUTHOR ๐Ÿ‘‘

reportbug was written by Chris Lawrence <lawrencc@debian.org> and it's now maintained by Sandro Tosi <morph@debian.org>. ๐Ÿ’–

this manual page was written by Y Giridhar Appaji Nag <giridhar@appaji.net> for the Debian project, but may be used by others. ๐Ÿซถ


and that's the whole REPORTBUG.CONF(5) File Formats Manual bestie โ€” go forth and configure, you absolute icon ๐Ÿ’…โœจ๐ŸŒˆ

๐Ÿ“ฆ where this page comes from