CINXE.COM
Debian -- Debian BTS - reporting bugs
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Debian -- Debian BTS - reporting bugs </title> <link rel="author" href="mailto:webmaster@debian.org"> <meta name="Generator" content="WML 2.32.0"> <meta name="Modified" content="2024-11-09 19:25:56"> <meta name="viewport" content="width=device-width"> <meta name="mobileoptimized" content="300"> <meta name="HandheldFriendly" content="true"> <link href="../debian.css" rel="stylesheet" type="text/css"> <link href="../debian-en.css" rel="stylesheet" type="text/css" media="all"> <link rel="search" type="application/opensearchdescription+xml" title="Debian website search" href="../search.en.xml"> </head> <body> <div id="header"> <div id="upperheader"> <div id="logo"> <a href="../" title="Debian Home"><img src="../Pics/openlogo-50.png" alt="Debian" width="50" height="61"></a> </div> <!-- end logo --> <div id="searchbox"> <form name="p" method="get" action="https://search.debian.org/cgi-bin/omega"> <p> <input type="hidden" name="DB" value="en"> <input name="P" value="" size="14"> <input type="submit" value="Search"> </p> </form> </div> <!-- end sitetools --> </div> <!-- end upperheader --> <!--UdmComment--> <div id="navbar"> <p class="hidecss"><a href="#content">Skip Quicknav</a></p> <ul> <!-- Link to Debian's own Social Media resources --> <li><a href="https://bits.debian.org/" title="Bits from Debian">Blog</a></li> <li><a href="https://micronews.debian.org" title="Micronews from Debian">Micronews</a></li> <li><a href="https://planet.debian.org/" title="The Planet of Debian">Planet</a></li> </ul> </div> <!-- end navbar --> <p id="breadcrumbs"><a href="./">Debian bug tracking system</a> / Debian BTS - reporting bugs</p> </div> <!-- end header --> <!--/UdmComment--> <div id="content"> <h1>How to report a bug in Debian using reportbug</h1> <a name="reportbug"></a> <p>We strongly recommend that you report bugs in Debian using the <code><a href="https://packages.debian.org/stable/utils/reportbug">reportbug</a></code> program.</p> <p> reportbug is installed by default on most systems. If it is not available, it can be installed using the package management tool available on your system. </p> <p> reportbug can be started from the system section of the menu or by running <code>reportbug</code> via the command-line. </p> <p>It will guide you through the bug reporting process step by step.</p> <p>If you have questions that the interactive prompts of reportbug do not resolve, you can refer to the rest of the documentation below or ask the <a href="mailto:debian-user@lists.debian.org"> Debian user mailing list</a>.</p> <h1> How to report a bug in Debian using email (and advanced usage of reportbug)</h1> <h2>Important things to note <strong>before</strong> sending your bug report</h2> <a name="whatpackage"></a> <h3>What package does your bug report belong to?</h3> <p>You need to know what package your bug report should be filed against. See <a href="#findpkgver">this example</a> for information on how to find this information. (You will use this information to <a href="#filedalready">see if your bug report has been filed already.</a>) </p> <p>If you are unable to determine which package your bug report should be filed against, please send e-mail to the <a href="mailto:debian-user@lists.debian.org"> Debian user mailing list</a> asking for advice.</p> <p>If your problem doesn't relate just to one package but some general Debian service, there are several <a href="pseudo-packages">pseudo-packages</a> or even <a href="../MailingLists/">mailing lists</a> that you can use to relay your message to us instead.</p> <a name="filedalready"></a> <h3>Has your bug report been filed already?</h3> <p>You should check to see if your bug report has already been filed before submitting it. You can see which bugs have been filed in a specific package using the <a href="./#pkgreport">package option of the bug search form</a>. If there is an existing bug report #<var><number></var>, you should submit your comments by sending e-mail to <var><number></var>@bugs.debian.org instead of reporting a new bug.</p> <h3>Send multiple reports for multiple bugs</h3> <p>Please don't report multiple unrelated bugs — especially ones in different packages — in a single bug report.</p> <h3>Don't file bugs upstream</h3> <p>If you file a bug in Debian, don't send a copy to the upstream software maintainers yourself, as it is possible that the bug exists only in Debian. If necessary, the maintainer of the package will forward the bug upstream.</p> <h2>Sending the bug report via e-mail</h2> <p>You can report bugs in Debian by sending an e-mail to <a href="mailto:submit@bugs.debian.org"><code>submit@bugs.debian.org</code></a> with a special format described below. <code>reportbug</code> (<a href="#reportbug">see above</a>) will properly format the e-mails for you; please use it!</p> <h3>Headers</h3> <p>Like any e-mail you should include a clear, descriptive <code>Subject</code> line in your main mail header. The subject you give will be used as the initial bug title in the tracking system, so please try to make it informative!</p> <p>If you'd like to send a copy of your bug report to additional recipients (such as mailing lists), you shouldn't use the usual e-mail headers, but <a href="#xcc">a different method, described below</a>.</p> <h3><a name="pseudoheader">Pseudo-headers</a></h3> <p>The first part of the bug report are the pseudo-headers which contain information about what package and version your bug report applies to. The first line of the message body has to include a pseudo-header. It should say:</p> <pre> Package: <packagename> </pre> <p>Replace <code><packagename></code> with the <a href="#whatpackage">name of the package</a> which has the bug.</p> <p>The second line of the message should say:</p> <pre> Version: <packageversion> </pre> <p>Replace <code><packageversion></code> with the version of the package. Please don't include any text here other than the version itself, as the bug tracking system relies on this field to work out which releases are affected by the bug.</p> <p>You need to supply a correct <code>Package</code> line in the pseudo-header in order for the bug tracking system to deliver the message to the package's maintainer. See <a href="#findpkgver">this example</a> for information on how to find this information.</p> <p>For other valid pseudo-headers, see <a href="#additionalpseudoheaders">Additional pseudo-headers</a></p> <h3>The body of the report</h3> <p>Please include in your report:</p> <ul> <li>The <em>exact</em> and <em>complete</em> text of any error messages printed or logged. This is very important!</li> <li>Exactly what you typed or did to demonstrate the problem.</li> <li>A description of the incorrect behavior: exactly what behavior you were expecting, and what you observed. A transcript of an example session is a good way of showing this.</li> <li>A suggested fix, or even a patch, if you have one.</li> <li>Details of the configuration of the program with the problem. Include the complete text of its configuration files.</li> <li>The versions of any packages on which the buggy package depends.</li> <li>What kernel version you're using (type <code>uname -a</code>), your shared C library (type <code>ls -l /lib/*/libc.so.6</code> or <code>apt show libc6 | grep ^Version</code>), and any other details about your Debian system, if it seems appropriate. For example, if you had a problem with a Perl script, you would want to provide the version of the `perl' binary (type <code>perl -v</code> or <code>dpkg -s perl | grep ^Version:</code>).</li> <li>Appropriate details of the hardware in your system. If you're reporting a problem with a device driver please list <em>all</em> the hardware in your system, as problems are often caused by IRQ and I/O address conflicts.</li> <li>If you have <a href="https://packages.debian.org/stable/utils/reportbug">reportbug</a> installed the output of <code>reportbug --template -T none -s none -S normal -b --list-cc none -q <package></code> will also be useful, as it contains the output of maintainer specific scripts and version information.</li> </ul> <p>Include any detail that seems relevant — you are in very little danger of making your report too long by including too much information. If they are small, please include in your report any files you were using to reproduce the problem. (If they are large, consider making them available on a publicly available website if possible.)</p> <p>For more advice on how to help the developers solve your problem, please read <a href="https://www.chiark.greenend.org.uk/~sgtatham/bugs.html"> How to Report Bugs Effectively</a>.</p> <h2><a name="example">An Example Bug Report</a></h2> <p>A bug report with header and pseudo-header looks something like this:</p> <pre> To: submit@bugs.debian.org From: diligent@testing.linux.org Subject: Hello says `goodbye' Package: hello Version: 1.3-16 When I invoke `hello' without arguments from an ordinary shell prompt it prints `goodbye', rather than the expected `hello, world'. Here is a transcript: $ hello goodbye $ /usr/bin/hello goodbye $ I suggest that the output string, in hello.c, be corrected. I am using Debian GNU/Linux 2.2, kernel 2.2.17-pre-patch-13 and libc6 2.1.3-10. </pre> <h2><a name="xcc">Sending copies of bug reports to other addresses</a></h2> <p>Sometimes it is necessary to send a copy of a bug report to somewhere else besides <code>debian-bugs-dist</code> and the package maintainer, which is where they are normally sent.</p> <p>You could do this by CC'ing your bug report to the other address(es), but then the other copies would not have the bug report number put in the <code>Reply-To</code> field and the <code>Subject</code> line. When the recipients reply they will probably preserve the <code>submit@bugs.debian.org</code> entry in the header and have their message filed as a new bug report. This leads to many duplicated reports.</p> <p>The <em>right</em> way to do this is to use the <code>X-Debbugs-CC</code> pseudo-header. Add a line like this to your message's pseudo-headers: <pre> X-Debbugs-CC: other-list@cosmic.edu </pre> <p>This will cause the bug tracking system to send a copy of your report to the address(es) in the <code>X-Debbugs-CC</code> line as well as to <code>debian-bugs-dist</code>.</p> <p>If you want to send copies to more than one address, add them comma-separated in only one <code>X-Debbugs-CC</code> line.</p> <p>Avoid sending such copies to the addresses of other bug reports, as they will be caught by the checks that prevent mail loops. There is relatively little point in using <code>X-Debbugs-CC</code> for this anyway, as the bug number added by that mechanism will just be replaced by a new one; use an ordinary <code>CC</code> header instead.</p> <p>This feature can often be combined usefully with mailing <code>quiet</code> — see below.</p> <a name="additionalpseudoheaders"></a> <h1>Additional Pseudoheaders</h1> <h2><a name="severities">Severity levels</a></h2> <p>If a report is of a particularly serious bug, or is merely a feature request, you can set the severity level of the bug as you report it. This is not required however, and the package maintainer will assign an appropriate severity level to your report even if you do not (or pick the wrong severity).</p> <p>To assign a severity level, put a line like this one in the <a href="#pseudoheader">pseudo-header</a>:</p> <pre> Severity: <<var>severity</var>> </pre> <p>Replace <<var>severity</var>> with one of the available severity levels, as described in the <a href="Developer#severities">advanced documentation</a>.</p> <h2><a name="tags">Assigning tags</a></h2> <p>You can set tags on a bug as you are reporting it. For example, if you are including a patch with your bug report, you may wish to set the <code>patch</code> tag. This is not required, however, and the developers will set tags on your report as and when it is appropriate.</p> <p>To set tags, put a line like this one in the <a href="#pseudoheader">pseudo-header</a>:</p> <pre> Tags: <<var>tags</var>> </pre> <p>Replace <<var>tags</var>> with one or more of the available tags, as described in the <a href="Developer#tags">advanced documentation</a>. Separate multiple tags with commas, spaces, or both.</p> <pre> User: <<var>username</var>> Usertags: <<var>usertags</var>> </pre> <p>Replace <<var>usertags</var>> with one or more usertags. Separate multiple tags with commas, spaces, or both. If you specify a <<var>username</var>>, that user's tags will be set. Otherwise, the e-mail address of the sender will be used as the username.</p> <p>You can set usertags for multiple users at bug submission time by including multiple User pseudo-headers; each Usertags pseudo-header sets the usertags for the preceding User pseudo-header. This is especially useful for setting usertags for a team with multiple users, setting usertags for multiple teams, or setting the <a href="https://wiki.debian.org/Teams/Debbugs/ArchitectureTags">architecture usertags</a> for bugs affecting multiple architectures. </p> <pre> User: <<var>first-username</var>> Usertags: <<var>first-username usertags</var>> User: <<var>second-username</var>> Usertags: <<var>second-username usertags</var>> </pre> <h2>Setting Forwarded</h2> <pre> Forwarded: <var>foo@example.com</var> </pre> <p> will mark the newly submitted bug as forwarded to foo@example.com. See <a href="Developer#forward">Recording that you have passed on a bug report</a> in the developers' documentation for details. </p> <h2>Claiming ownership</h2> <pre> Owner: <var>foo@example.com</var> </pre> <p> will indicate that foo@example.com is now responsible for fixing this bug. See <a href="Developer#owner">Changing bug ownership</a> in the developers' documentation for details. </p> <h2>Source Package</h2> <pre> Source: <var>foopackage</var> </pre> <p> the equivalent of <code>Package:</code> for bugs present in the source package of foopackage; for most bugs in most packages you don't want to use this option. </p> <h2><a name="control">Control Commands</a></h2> <pre> Control: <var>control commands</var> </pre> <p> Allows for any of the commands which must be sent to <code>control@bugs.debian.org</code> to work when sent to <code>submit@bugs.debian.org</code> or <code>nnn@bugs.debian.org</code>. -1 initially refers to the current bug (that is, the bug created by a mail to submit@ or the bug messaged with nnn@). Please see <a href="server-control">the server control documentation</a> for more information on the control commands which are valid.</p> <p>For example, the following pseudoheader in a message sent to <code>12345@bugs.debian.org</code>:</p> <pre> Control: retitle -1 this is the title Control: severity -1 normal Control: summary -1 0 Control: forwarded -1 https://bugs.debian.org/nnn </pre> <p>would cause 12345 to be retitled, its severity changed, summary set, and marked as forwarded.</p> <h2>X-Debbugs- headers</h2> <p>Finally, if your <acronym title="Mail User Agent" lang="en">MUA</acronym> doesn't allow you to edit the headers, you can set the various <code>X-Debbugs-</code> headers in the <a href="#pseudoheader">pseudo-headers</a>.</p> <h1>Additional information</h1> <h2>Different submission addresses (minor or mass bug reports)</h2> <p>If a bug report is minor, for example, a documentation typo or a trivial build problem, please adjust the severity appropriately and send it to <code>maintonly@bugs.debian.org</code> instead of <code>submit@bugs.debian.org</code>. <code>maintonly</code> will forward the report to the package maintainer only, it won't forward it to the BTS mailing lists.</p> <p>If you're submitting many reports at once, you should definitely use <code>maintonly@bugs.debian.org</code> so that you don't cause too much redundant traffic on the BTS mailing lists. Before submitting many similar bugs you may also want to post a summary on <code>debian-bugs-dist</code>.</p> <p>If you wish to report a bug to the bug tracking system that's already been sent to the maintainer, you can use <code>quiet@bugs.debian.org</code>. Bugs sent to <code>quiet@bugs.debian.org</code> will not be forwarded anywhere, only filed.</p> <p>When you use different submission addresses, the bug tracking system will set the <code>Reply-To</code> of any forwarded message so that the replies will by default be processed in the same way as the original report. That means that, for example, replies to <code>maintonly</code> will go to <var>nnn</var><code>-maintonly@bugs.debian.org</code> instead of <var>nnn</var><code>@bugs.debian.org</code>, unless of course one overrides this manually.</p> <h2>Acknowledgements</h2> <p>Normally, the bug tracking system will return an acknowledgement to you by e-mail when you report a new bug or submit additional information to an existing bug. If you want to suppress this acknowledgement, include an <code>X-Debbugs-No-Ack</code> header or pseudoheader in your e-mail (the contents of this header do not matter). If you report a new bug with this header, you will need to check the web interface yourself to find the bug number.</p> <p>Note that this header will not suppress acknowledgements from the <code>control@bugs.debian.org</code> mailserver, since those acknowledgements may contain error messages which should be read and acted upon.</p> <h2>Spamfighting and missing mail</h2> <p>The bug tracking system implements a rather extensive set of rules designed to make sure that spam does not make it through the BTS. While we try to minimize the number of false positives, they do occur. If you suspect your mail has triggered a false positive, feel free to contact <code>owner@bugs.debian.org</code> for assistance. Another common cause of mail not making it through to the BTS is utilizing addresses which match procmail's FROM_DAEMON, which includes mail from addresses like <code>mail@foobar.com</code>. If you suspect your mail matches FROM_DAEMON, see <a href="https://manpages.debian.org/cgi-bin/man.cgi?query=procmailrc">procmailrc(5)</a> to verify, and then resend the mail using an address which does not match FROM_DAEMON.</p> <h2>Bug reports against unknown packages</h2> <p>If the bug tracking system doesn't know who the maintainer of the relevant package is it will forward the report to <code>debian-bugs-dist</code> even if <code>maintonly</code> was used.</p> <p>When sending to <code>maintonly@bugs.debian.org</code> or <var>nnn</var><code>-maintonly@bugs.debian.org</code> you should make sure that the bug report is assigned to the right package, by putting a correct <code>Package</code> at the top of an original submission of a report, or by using <A href="server-control">the <code>control@bugs.debian.org</code> service</A> to (re)assign the report appropriately.</p> <h2><a name="findpkgver">Using <code>dpkg</code> to find the package and version for the report</a></h2> <p>When using <code>reportbug</code> to report a bug in a command, say <code>grep</code>, the following will automatically select the right package and let you write the report right away: <code>reportbug --file $(which grep)</code></p> <p>You can also find out which package installed it by using <code>dpkg --search</code>. You can find out which version of a package you have installed by using <code>dpkg --list</code> or <code>dpkg --status</code>. </p> <p>For example:</p> <pre> $ which apt-get /usr/bin/apt-get $ type apt-get apt-get is /usr/bin/apt-get $ dpkg --search /usr/bin/apt-get apt: /usr/bin/apt-get $ dpkg --list apt Desired=Unknown/Install/Remove/Purge/Hold | Status=Not/Installed/Config-files/Unpacked/Failed-config/Half-installed |/ Err?=(none)/Hold/Reinst-required/X=both-problems (Status,Err: uppercase=bad) ||/ Name Version Description +++-==============-==============-============================================ ii apt 0.3.19 Advanced front-end for dpkg $ dpkg --status apt Package: apt Status: install ok installed Priority: standard Section: base Installed-Size: 1391 Maintainer: APT Development Team <deity@lists.debian.org> Version: 0.3.19 Replaces: deity, libapt-pkg-doc (<< 0.3.7), libapt-pkg-dev (<< 0.3.7) Provides: libapt-pkg2.7 Depends: libapt-pkg2.7, libc6 (>= 2.1.2), libstdc++2.10 Suggests: dpkg-dev Conflicts: deity Description: Advanced front-end for dpkg This is Debian's next generation front-end for the dpkg package manager. It provides the apt-get utility and APT dselect method that provides a simpler, safer way to install and upgrade packages. . APT features complete installation ordering, multiple source capability and several other unique features, see the Users Guide in /usr/doc/apt/guide.text.gz </pre> <a name="otherusefulcommands"></a> <h2>Other useful commands and packages</h2> <p> The <kbd>querybts</kbd> tool, available from the same package as <a href="https://packages.debian.org/stable/utils/reportbug">reportbug</a>, provides a convenient text-based interface to the bug tracking system.</p> <p>Emacs users can also use the debian-bug command provided by the <code><a href="https://packages.debian.org/stable/utils/debian-el">debian-el</a></code> package. When called with <kbd>M-x debian-bug</kbd>, it will ask for all necessary information in a similar way to <code>reportbug</code>.</p> <hr> <p>Other BTS pages:</p> <ul> <li><a href="./">Bug tracking system main contents page.</a></li> <li><a href="Reporting">Instructions for reporting bugs.</a></li> <li><a href="Access">Accessing the bug tracking system logs.</a></li> <li><a href="Developer">Information for developers on the bug tracking system.</a></li> <li><a href="server-control">Developers' information on manipulation of bugs using the e-mail control interface.</a></li> <li><a href="server-refcard">Mailservers' reference card.</a></li> <li><a href="server-request">Requesting bug reports by e-mail.</a></li> </ul> <hr> <address> Debian BTS administrators <<a href="mailto:owner@bugs.debian.org">owner@bugs.debian.org</a>> </address> <p>Debian bug tracking system<br> Copyright © 1999 Darren O. Benham, 1997, 2003 nCipher Corporation Ltd, 1994-1997 Ian Jackson.</p> <div class="clr"></div> </div> <!-- end content --> <div id="footer"> <hr class="hidecss"> <p>Back to the <a href="../">Debian Project homepage</a>.</p> <hr> <!--UdmComment--> <div id="pageLang"> <div id="langSelector"> This page is also available in the following languages: <div id="langContainer"> <select onchange="location = this.value;"> <option value="" disabled selected>Select your language</option> <option value="Reporting.da.html" title="Danish" lang="da">dansk</option> <option value="Reporting.de.html" title="German" lang="de">Deutsch</option> <option value="Reporting.es.html" title="Spanish" lang="es">español</option> <option value="Reporting.fr.html" title="French" lang="fr">français</option> <option value="Reporting.hr.html" title="Croatian" lang="hr">hrvatski</option> <option value="Reporting.it.html" title="Italian" lang="it">Italiano</option> <option value="Reporting.nl.html" title="Dutch" lang="nl">Nederlands</option> <option value="Reporting.pl.html" title="Polish" lang="pl">polski</option> <option value="Reporting.pt.html" title="Portuguese" lang="pt">Português</option> <option value="Reporting.fi.html" title="Finnish" lang="fi">suomi</option> <option value="Reporting.sv.html" title="Swedish" lang="sv">svenska</option> <option value="Reporting.bg.html" title="Bulgarian" lang="bg">Български (Bəlgarski)</option> <option value="Reporting.ru.html" title="Russian" lang="ru">Русский (Russkij)</option> <option value="Reporting.uk.html" title="Ukrainian" lang="uk">українська (ukrajins'ka)</option> <option value="Reporting.zh-cn.html" title="Chinese (China)" lang="zh-CN">中文(简)</option> <option value="Reporting.zh-hk.html" title="Chinese (Hong Kong)" lang="zh-HK">中文(HK)</option> <option value="Reporting.zh-tw.html" title="Chinese (Taiwan)" lang="zh-TW">中文(繁)</option> <option value="Reporting.ja.html" title="Japanese" lang="ja">日本語 (Nihongo)</option> <option value="Reporting.ko.html" title="Korean" lang="ko">한국어 (Korean)</option> </select> </div> How to set <a href="../intro/cn">the default document language</a> </div></div><!--/UdmComment--> <hr> <div id="footermap"> <!--UdmComment--> <p><strong><a href="/">Home</a></strong></p> <ul id="footermap-cola"> <li><a href="../intro/about">About</a> <ul> <li><a href="../social_contract">Social Contract</a></li> <li><a href="../code_of_conduct">Code of Conduct</a></li> <li><a href="../intro/free">Free Software</a></li> <li><a href="../legal">Legal Info</a></li> </ul> </li> <li><a href="../intro/help">Help Debian</a></li> </ul> <ul id="footermap-colb"> <li><a href="../distrib/">Getting Debian</a> <ul> <li><a href="../distrib/netinst">Network install</a></li> <li><a href="../CD/">CD/USB ISO images</a></li> <li><a href="../blends/">Pure Blends</a></li> <li><a href="../distrib/packages">Debian Packages</a></li> <li><a href="../devel/">Developers' Corner</a></li> </ul> </li> </ul> <ul id="footermap-colc"> <li><a href="../News/">News</a> <ul> <li><a href="../News/weekly/">Project News</a></li> <li><a href="../events/">Events</a></li> </ul> </li> <li><a href="../doc/">Documentation</a> <ul> <li><a href="../releases/">Release Info</a></li> <li><a href="https://wiki.debian.org/">Debian Wiki</a></li> </ul> </li> </ul> <ul id="footermap-cold"> <li><a href="../support">Support</a> <ul> <li><a href="../international/">Debian International</a></li> <li><a href="../security/">Security Information</a></li> <li><a href="../Bugs/">Bug reports</a></li> <li><a href="../MailingLists/">Mailing Lists</a></li> </ul> </li> </ul> <ul id="footermap-cole"> <li><a href="../sitemap">Site map</a></li> <li><a href="https://search.debian.org/">Search</a></li> <li><a href="https://bits.debian.org">The Debian Blog</a></li> <li><a href="https://micronews.debian.org">Debian Micronews</a></li> <li><a href="https://planet.debian.org">Debian Planet</a></li> </ul> <!--/UdmComment--> </div> <!-- end footermap --> <div id="fineprint"> <!--UdmComment--> <p>See our <a href="../contact">contact page</a> to get in touch. Web site source code is <a href="https://salsa.debian.org/webmaster-team/webwml">available</a>.</p> <p> Last Modified: Sun, Oct 15 11:59:12 UTC 2023   Last Built: Sat, Nov 9 19:25:56 UTC 2024 </p> <!--/UdmComment--> </div> </div> <!-- end footer --> </body> </html>