1
<?xml version="1.0" encoding="ISO-8859-1"?>
2
<!DOCTYPE refentry PUBLIC
3
"-//OASIS//DTD DocBook XML V4.1.2//EN"
4
"docbook/docbookx.dtd">
5
<refentry id='bugzilla-submit.1'>
7
<refentrytitle>bugzilla-submit</refentrytitle>
8
<manvolnum>1</manvolnum>
9
<refmiscinfo class='date'>Oct 30, 2003</refmiscinfo>
11
<refnamediv id='name'>
12
<refname>bugzilla-submit</refname>
13
<refpurpose>post bugs to a Bugzilla instance</refpurpose>
15
<refsynopsisdiv id='synopsis'>
18
<command>bugzilla-submit</command>
19
<arg choice='opt'>--status <replaceable>bug_status</replaceable></arg>
20
<arg choice='opt'>--url <replaceable>bug_file_loc</replaceable></arg>
21
<arg choice='opt'>--product <replaceable>product</replaceable></arg>
22
<arg choice='opt'>--version <replaceable>version</replaceable></arg>
23
<arg choice='opt'>--component <replaceable>component</replaceable></arg>
24
<arg choice='opt'>--summary <replaceable>short_desc</replaceable></arg>
25
<arg choice='opt'>--hardware <replaceable>rep_platform</replaceable></arg>
26
<arg choice='opt'>--os <replaceable>op_sys</replaceable></arg>
27
<arg choice='opt'>--priority <replaceable>priority</replaceable></arg>
28
<arg choice='opt'>--severity <replaceable>bug_severity</replaceable></arg>
29
<arg choice='opt'>--assigned-to <replaceable>assigned-to</replaceable></arg>
30
<arg choice='opt'>--cc <replaceable>cc</replaceable></arg>
31
<arg choice='opt'>--keywords <replaceable>keywords</replaceable></arg>
32
<arg choice='opt'>--depends-on <replaceable>dependson</replaceable></arg>
33
<arg choice='opt'>--blocked <replaceable>blocked</replaceable></arg>
34
<arg choice='opt'>--description <replaceable>comment</replaceable></arg>
35
<arg choice='opt'>--no-stdin </arg>
36
<arg choice='plain'><replaceable>bugzilla-url</replaceable></arg>
41
<refsect1 id='description'><title>DESCRIPTION</title>
43
<para><application>bugzilla-submit</application> is a command-line tool
44
for posting bug reports to any instance of Bugzilla. It accepts on
45
standard input text resembling an RFC-822 message. The headers of
46
that message, and its body, are used to set error-report field values.
47
More field values are merged in from command-line options. If required
48
fields have not been set, <application>bugzilla-submit</application>
49
tries to compute them. Finally, the resulting error report is
50
validated. If all required fields are present, and there are no
51
illegal fields or values, the report is shipped off to the Mozilla
52
instance specified by the single positional argument. Login/password
53
credentials are read from the calling user's <filename>~/.netrc</filename>
56
<para>bugzilla-submit accepts a single argument:
57
<replaceable>bugzilla-url</replaceable>. Its value must match the
58
relevant Bugzilla instance's base URL (technically, its
59
<replaceable>urlbase</replaceable> param). The program also accepts the
60
following options to set or override fields:</para>
63
<term>-b, --status</term>
65
<para>Set the bug_status field, overriding the Status header from
66
standard input if present. (The stock Bugzilla web presentation
67
identifies this field as <quote>Status</quote>.)</para>
71
<term>-u, --url</term>
73
<para>Set the bug_file_loc field, overriding the URL header from
74
standard input if present. (The stock Bugzilla web presentation
75
identifies this field as <quote>URL</quote>.)</para>
79
<term>-p, --product</term>
81
<para>Set the product field, overriding the Product header from
82
standard input if necessary.</para>
86
<term>-v, --version</term>
87
<listitem><para>Set the version field, overriding the Version header
88
from standard input if necessary.</para></listitem>
91
<term>-c, --component</term>
92
<listitem><para>Set the component field, overriding the Component header
93
from standard input if necessary.</para></listitem>
96
<term>-s, --summary</term>
97
<listitem><para>Set the short_desc field, overriding the Summary header
98
from standard input if necessary. (The stock Bugzilla web presentation
99
identifies this field as <quote>Summary</quote>.)</para></listitem>
102
<term>-H, --hardware</term>
103
<listitem><para>Set the rep_platform field, overriding the Hardware header
104
from standard input if necessary. (The stock Bugzilla web presentation
105
identifies this field as <quote>Hardware</quote>.)</para></listitem>
108
<term>-o, --os</term>
109
<listitem><para>Set the op_sys field, overriding the OS (Operating
110
System) header from standard input if necessary. (The stock Bugzilla web
111
presentation also identifies this field as
112
<quote>OS</quote>.)</para></listitem>
115
<term>-r, --priority</term>
116
<listitem><para>Set the priority field, overriding the Priority header
117
from standard input if necessary.</para></listitem>
120
<term>-x, --severity</term>
121
<listitem><para>Set the severity field, overriding the Severity header
122
from standard input if necessary.</para></listitem>
125
<term>-d, --description</term>
126
<listitem><para>Set the comment field, overriding the Description header
127
from standard input if necessary. (The stock Bugzilla web presentation
128
identifies this field as <quote>Description</quote>.) If there is a
129
message body and no Description field and this option is not
130
specified, the message body is used as a description.
134
<term>-a, --assigned-to</term>
136
<para>Set the optional assigned_to field, overriding the Assigned-To
137
header from standard input if necessary.</para>
141
<term>-C, --cc</term>
143
<para>Set the optional cc field, overriding the Cc
144
header from standard input if necessary.</para>
148
<term>-k, --keywords</term>
150
<para>Set the optional keywords field, overriding the Keywords
151
header from standard input if necessary.</para>
155
<term>-D, --depends-on</term>
157
<para>Set the optional dependson field, overriding the Depends-On
158
header from standard input if necessary.</para>
162
<term>-B, --assigned-to</term>
164
<para>Set the optional blocked field, overriding the Blocked
165
header from standard input if necessary.</para>
169
<term>-n, --no-stdin</term>
170
<listitem><para>Suppress reading fields from standard input.</para></listitem>
173
<term>-h, --help</term>
174
<listitem><para>Print usage help and exit.</para></listitem>
178
<para>This program will try to deduce OS and Hardware if those are not
179
specified. If it fails, validation will fail before shipping the
182
<para>There is expected to be a single positional argument following
183
any options. It should be the URL of the Bugzilla instance to which
184
the bug is to be submitted.</para>
187
<refsect1 id='files'><title>FILES</title>
190
<term><filename>~/.netrc</filename></term>
191
<listitem><para>Must contain an entry in which the machine field is
192
the Bugzilla instance URL, the login field is your ID on that host, and the
193
password field is the right password. The URL in the machine field
194
must be enclosed in double quotes.</para>
196
<para>For example, if your Bugzilla instance is at
197
"http://landfill.bugzilla.org/bztest/", and your login and password
198
there are "john@doe.com" and "foo", respectively, your
199
<filename>.netrc</filename> entry should look something like:</para>
202
machine "http://landfill.bugzilla.org/bztest/"
208
<para>Note that the machine entry should match exactly the instance URL
209
specified to <application>bugzilla-submit</application>.</para>
216
<refsect1 id='author'><title>AUTHORS</title>
217
<para>Christian Reis <kiko@async.com.br>, Eric S. Raymond
218
<esr@thyrsus.com>.</para>
added
removed
contrib/bugzilla-submit/bugzilla-submit.xml
