You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 

272 lines
7.8 KiB

  1. .\"
  2. .\" reportbug.conf manual page Written by Y Giridhar Appaji Nag
  3. .\" Copyright (c) 2007 Y Giridhar Appaji Nag <giridhar@appaji.net>
  4. .\"
  5. .\" This manual page is distributable under the following license:
  6. .\"
  7. .\" Permission to use, copy, modify, and distribute this software and its
  8. .\" documentation for any purpose and without fee is hereby granted,
  9. .\" provided that the above copyright notice appears in all copies and that
  10. .\" both that copyright notice and this permission notice appear in
  11. .\" supporting documentation.
  12. .\"
  13. .\" I DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
  14. .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL I
  15. .\" BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
  16. .\" DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  17. .\" WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  18. .\" ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  19. .\" SOFTWARE.
  20. .\"
  21. .TH REPORTBUG.CONF 5 "Dec 2007" "reportbug 3.39"
  22. .SH NAME
  23. .B reportbug.conf
  24. - The configuration file for reportbug
  25. .SH SYNOPSIS
  26. .B /etc/reportbug.conf
  27. - The configuration file for reportbug, a program designed to report bugs in the
  28. Debian distribution
  29. .hw config
  30. .SH DESCRIPTION
  31. This manual page describes the layout of the \fBreportbug\fP and
  32. \fBquerybts\fP configuration file and the available configuration
  33. options. The default location of the file is
  34. \fB/etc/reportbug.conf\fP and the options may be overriding in
  35. \fB$HOME/.reportbugrc\fP (which follows the same format as
  36. \fBreportbug.conf\fP).
  37. Please note that any configuration file has to be a valid UTF-8
  38. document, and not in a different locale; this is particularly
  39. important in situations where localized characters have to be used
  40. (like for realname).
  41. .SH "FILE FORMAT"
  42. Configuration options can be specified in the form
  43. \fBoption-name\fP \fIoption-value\fP
  44. True/False (boolean) options can be specified as
  45. \fBboolean-option\fP
  46. (if it's present, it's a \fBTrue\fP).
  47. Usually, \fBno-option\fP will disable \fBoption\fP if \fBoption\fP is
  48. boolean.
  49. Options can be specified in any order.
  50. .SH OPTIONS
  51. The summary of possible options (in alphabetical order) is as follows:
  52. .TP
  53. .B bts
  54. The bug tracking system to use, see \fBreportbug \-\-help\fP searching
  55. for \fB\-\-bts\fP option for a list of currently supported BTSes.
  56. .TP
  57. .B cc (\fIboolean\fP)
  58. Whether the reporter should be Cc:ed on the bug report.
  59. .TP
  60. .B check-available (\fIboolean\fP)
  61. Whether \fBpackages.debian.org\fP should be queried for newer releases
  62. of the package. In \fBadvanced\fP and \fBexpert\fP mode,
  63. \fBincoming.debian.org\fP and
  64. \fBhttp://ftp-master.debian.org/new.html\fP are also checked.
  65. .TP
  66. .B compress (\fIboolean\fP)
  67. Whether modified configuration files included in the bug report should
  68. be stripped down.
  69. .TP
  70. .B config-files (\fIboolean\fP)
  71. Whether modified configuration files should be included with the bug
  72. report.
  73. .TP
  74. .B editor
  75. The editor to use to edit the bug report. Example:
  76. \fBeditor\fP \fI"emacs \-nw"\fP
  77. .TP
  78. .B email
  79. Default \fBFrom\fP address of the bug email (override with environment
  80. variables, see \fBreportbug(1)\fP). Example:
  81. \fBemail\fP \fI"humberto@example.com"\fP
  82. .TP
  83. .B envelopefrom
  84. Specify the Envelope From mail header (also known as Return-path); by default
  85. it's the From address but it can be selected a different one in case the MTA
  86. doesn't canonicalize local users to public addresses.
  87. .TP
  88. .B mbox_reader_cmd
  89. Specify a command to open the bug reports mbox file. You can use
  90. \fB%s\fP to substitute the mbox file to be used, and \fB%%\fP to insert
  91. a literal percent sign. If no \fB%s\fP is specified, the mbox file name
  92. is supplied at the end of the argument list. Example:
  93. \fBmbox_reader_cmd\fP \fI"mutt \-f %s"\fP
  94. .TP
  95. .B header
  96. Additional headers to add to the bug email. Like:
  97. \fBheader\fP \fI"X-Debbugs-CC: debian-qa@lists.debian.org"\fP
  98. .br
  99. \fBheader\fP \fI"X-Silly-Header: I haven't edited my /etc/reportbug.conf"\fP
  100. .br
  101. \fBheader\fP \fI"X-Debbugs-No-Ack: please" # to suppress acknowledgments\fP
  102. .TP
  103. .B http_proxy
  104. Default HTTP proxy used to query the BTS (override with environment
  105. variables, see \fBreportbug(1)\fP). Example:
  106. \fBhttp_proxy\fP \fIhttp://proxy.example.com:3128/\fP
  107. .TP
  108. .B justification
  109. The justification in case of a Release Critical bug (severity either 'critical', 'serious' or 'grave'). Example:
  110. \fBjustification\fP \fI"text here"\fP
  111. .TP
  112. .B keyid
  113. The GPG key to use, if different from the default one on the system.
  114. Example:
  115. \fBkeyid\fP \fI12345678\fP
  116. .TP
  117. .B maintonly
  118. See the \fB\-\-maintonly\fP entry in \fBreportbug(1)\fP.
  119. .TP
  120. .B max_attachment_size
  121. The max size any attachment can have. Example:
  122. \fBmax_attachment_size\fP \fI5000000\fP
  123. .TP
  124. .B mh
  125. Use the \fBmh\fP mailer.
  126. .TP
  127. .B mirror
  128. The address of a BTS mirror. Example:
  129. \fBmirror\fP \fIhttp://mirror.address/\fP
  130. .TP
  131. .B mode [\fInovice\fP|\fIstandard\fP|\fIadvanced\fP|\fIexpert\fP]
  132. The default operating mode for \fBreportbug(1)\fP.
  133. .TP
  134. .B mta
  135. The path to the MTA used. Any SMTP server on Debian should be OK
  136. with the default:
  137. \fBmta\fP \fI/usr/sbin/sendmail\fP
  138. .TP
  139. .B mua
  140. The mail user agent to use (the default is empty, to use an internal
  141. mailer). Example:
  142. \fBmua\fP \fI'mutt \-H'\fP
  143. .TP
  144. .B mutt
  145. Use the \fBmutt\fP mailer.
  146. .TP
  147. .B nmh
  148. Use the \fBnmh\fP mailer.
  149. .TP
  150. .B no-check-uid (\fIboolean\fP)
  151. Disables checking whether the UIDs are outside admin range (\fIroot\fP
  152. is still checked).
  153. .TP
  154. .B no-debconf (\fIboolean\fP)
  155. Disables adding the \fBdebconf-show\fP output to the bug report.
  156. .TP
  157. .B no-query-source (\fIboolean\fP)
  158. Disables querying the source packages for bugs.
  159. .TP
  160. .B offline
  161. Disables all external queries.
  162. .TP
  163. .B paranoid
  164. Paranoid mode: print the whole email envelope before sending it.
  165. .TP
  166. .B printonly
  167. Print the report on screen, don't sent it.
  168. .TP
  169. .B query-bts (\fIboolean\fP)
  170. Whether the BTS should be queried for existing bug reports.
  171. .TP
  172. .B quiet
  173. See the \fB\-\-report-quiet\fP entry in \fBreportbug(1)\fP.
  174. .TP
  175. .B realname
  176. The default real-name in the \fBFrom\fP address of the bug email
  177. (override with environment variables, see \fBreportbug(1)\fP). Example:
  178. \fBrealname\fP \fI"Humberto Flores III"\fP
  179. .TP
  180. .B replyto
  181. The default \fBReply-To\fP in the bug email (override with environment
  182. variables, see \fBreportbug(1)\fP. Example:
  183. \fBreplyto\fP \fI"Humberto Flores <humflores@example.org>"\fP
  184. .TP
  185. .B severity [\fIcritical\fP|\fIgrave\fP|\fIserious\fP|\fIimportant\fP|\fInormal\fP|\fIminor\fP|\fIwishlist\fP]
  186. The default severity level of the bug reported. Setting this in the
  187. configuration file will disable prompting while running
  188. \fBreportbug\fP.
  189. .TP
  190. .B sign [\fIgpg\fP|\fIpgp\fP|\fIgnupg\fP|\fInone\fP]
  191. Program used to digitally sign bug reports automatically ('none' to disable it).
  192. .TP
  193. .B smtphost
  194. Use an MTA different from \fB/usr/sbin/sendmail\fP. A port number
  195. other than 25 can also be specified. Example:
  196. \fBsmtphost\fP \fImail.example.com:2525\fP
  197. Use "\fBsmtphost\fP \fIlocalhost\fP" to enable the internal MTA.
  198. .TP
  199. .B smtppasswd
  200. The password to use for SMTP. Example:
  201. \fBsmtppasswd\fP \fIf10r35\fP
  202. .TP
  203. .B smtpuser
  204. The username to use for SMTP. Example:
  205. \fBsmtpuser\fP \fIhflores\fP
  206. .TP
  207. .B smtptls
  208. Enables TLS encryption for the SMTP connection.
  209. .TP
  210. .B submit
  211. Use \fIsubmit\fP as the bug submission address.
  212. .TP
  213. .B template
  214. Use the template mode, bypasses all prompts and the output it sent to
  215. stdout.
  216. .TP
  217. .B ui [\fItext\fP|\fIurwid\fP|\fIgtk2\fP]
  218. The user interface that \fBquerybts(1)\fP and \fBreportbug(1)\fP
  219. should use.
  220. .TP
  221. .B verify
  222. Enables automatic verification of package installation before reporting
  223. using \fBdebsums\fP, if available.
  224. .SH "SEE ALSO"
  225. reportbug(1), querybts(1)
  226. .SH AUTHOR
  227. reportbug was written by Chris Lawrence <lawrencc@debian.org> and it's now maintained by Sandro Tosi <morph@debian.org>.
  228. .PP
  229. This manual page was written by Y Giridhar Appaji Nag
  230. <giridhar@appaji.net> for the Debian project, but may be used by others.