Skip to content

Commit dc9cad0

Browse files
crobinsocrobinso
committed
Prep for release 0.8.0
1 parent dcf2c39 commit dc9cad0

1 file changed

Lines changed: 45 additions & 24 deletions

File tree

‎bugzilla.1‎

Lines changed: 45 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH bugzilla 1 "June 06, 2012" "version 0.7.0" "User Commands"
1+
.TH bugzilla 1 "February 15, 2013" "version 0.7.0" "User Commands"
22
.SH NAME
33
bugzilla \- command-line interface to Bugzilla over XML-RPC
44
.SH SYNOPSIS
@@ -24,12 +24,14 @@ by Bugzilla.
2424
.br
2525
.I \fR * info - get info about the given bugzilla instance
2626
.SH GLOBAL OPTIONS
27+
.IP "--version"
28+
show program's version number and exit
2729
.IP "--help, -h"
2830
show this help message and exit
2931
.IP "--bugzilla=BUGZILLA"
3032
bugzilla XMLRPC URI. default: https://bugzilla.redhat.com/xmlrpc.cgi
3133
.IP "--bztype=BZTYPE"
32-
Bugzilla type. Autodetected if not set. Available types: Bugzilla3 Bugzilla32 Bugzilla34 Bugzilla36 Bugzilla4 RHBugzilla3 RHBugzilla4 NovellBugzilla
34+
Bugzilla type. Autodetected if not set. Available types: Bugzilla3 Bugzilla32 Bugzilla34 Bugzilla36 Bugzilla4 Bugzilla42 Bugzilla44 RHBugzilla3 RHBugzilla4 RHBugzilla NovellBugzilla
3335
.IP "--user=USER"
3436
username
3537
.IP "--password=PASSWORD"
@@ -47,26 +49,28 @@ REQUIRED: product name (list with 'bugzilla info -p')
4749
REQUIRED: product version
4850
.IP "--component=COMPONENT, -c COMPONENT"
4951
REQUIRED: component name (list with 'bugzilla info -c PRODUCT')
50-
.IP "--comment=COMMENT, -l COMMENT"
52+
.IP "--comment=DESCRIPTION, -l DESCRIPTION"
5153
REQUIRED: initial bug comment
52-
.IP "--short_desc=SHORT_DESC, --summary=SHORT_DESC, -s SHORT_DESC"
54+
.IP "--short_desc=SUMMARY, --summary=SUMMARY, -s SUMMARY"
5355
REQUIRED: bug summary
5456
.IP "--os=OP_SYS, -o OP_SYS"
5557
OPTIONAL: operating system (default: Linux)
56-
.IP "--arch=REP_PLATFORM, -a REP_PLATFORM"
58+
.IP "--arch=PLATFORM, -a PLATFORM"
5759
OPTIONAL: arch this bug occurs on (default: All)
58-
.IP "--severity=BUG_SEVERITY"
60+
.IP "--severity=SEVERITY"
5961
OPTIONAL: bug severity (default: medium)
6062
.IP "--priority=PRIORITY"
6163
OPTIONAL: bug priority (default: medium)
6264
.IP "--url=BUG_FILE_LOC, -u BUG_FILE_LOC"
6365
OPTIONAL: URL for further bug info
64-
.IP "--cc=CC[,CC,...]"
66+
.IP "--cc=CC[, CC, ...]"
6567
OPTIONAL: add emails to initial CC list
66-
.IP "--blocked=BUGID[,BUGID,...]"
68+
.IP "--blocked=BUGID[, BUGID, ...]"
6769
OPTIONAL: add bug_ids blocked by this bug
68-
.IP "--dependson=BUGID[,BUGID,...]"
70+
.IP "--dependson=BUGID[, BUGID, ...]"
6971
OPTIONAL: add bug_ids that this bug depends on
72+
73+
.SH OUTPUT FORMAT \[oq]NEW\[cq] OPTIONS
7074
.IP "--full, -f"
7175
output detailed bug info
7276
.IP "--ids, -i"
@@ -85,7 +89,7 @@ specify individual bugs by IDs, separated with commas
8589
.IP "--product=PRODUCT, -p PRODUCT"
8690
product name, comma-separated (list with 'bugzilla info -p')
8791
.IP "--version=VERSION, -v VERSION"
88-
product version
92+
product version, comma-separated
8993
.IP "--component=COMPONENT, -c COMPONENT"
9094
component name(s), comma-separated (list with 'bugzilla info -c PRODUCT')
9195
.IP "--components_file=COMPONENTS_FILE"
@@ -97,13 +101,17 @@ search for a target milestone
97101
.IP "--short_desc=SHORT_DESC, -s SHORT_DESC"
98102
search bug summaries
99103
.IP "--bug_status=BUG_STATUS, -t BUG_STATUS"
100-
comma-separated list of bug statuses to accept [Default:all] [Available:NEW,ASSIGNED,NEEDINFO,ON_DEV,MODIFIED,POST,ON_QA,FAILS_QA,PASSES_QA,REOPENED,VERIFIED,RELEASE_PENDING,CLOSED]
104+
comma-separated list of bug statuses to accept [Default:all]
101105
.IP "--bug_severity=BUG_SEVERITY, --severity=BUG_SEVERITY, -x BUG_SEVERITY"
102106
search severities, comma-separated
103107
.IP "--priority=PRIORITY, -z PRIORITY"
104108
search priorities, comma-separated
109+
.IP "--from-url=FROM_URL"
110+
Use the query given by a query.cgi URL. (Use quotes!)
111+
112+
.SH EMAIL \[oq]QUERY\[cq] OPTIONS
105113
.IP "--emailtype=EMAILTYPE, -E EMAILTYPE"
106-
Email: specify searching option for emails, ie. substring,notsubstring,exact,... [Default: substring]
114+
Email: specify searching option for emails, ie. substring, notsubstring, exact, ... [Default: substring]
107115
.IP "--cc=CC, -o CC"
108116
Email: search cc lists for given address
109117
.IP "--reporter=REPORTER, -r REPORTER"
@@ -112,20 +120,24 @@ Email: search reporter email for given address
112120
Email: search for bugs assigned to this address
113121
.IP "--qa_contact=QA_CONTACT, -q QA_CONTACT"
114122
Email: search for bugs which have QA Contact assigned to this address
123+
124+
.SH STRING SEARCH \[oq]QUERY\[cq] OPTIONS
115125
.IP "--url=URL, -u URL"
116126
search keywords field for given url
117127
.IP "--url_type=URL_TYPE, -U URL_TYPE"
118-
specify searching option for urls, ie. anywords,allwords,nowords
128+
specify searching option for urls, ie. anywords, allwords, nowords
119129
.IP "--keywords=KEYWORDS, -k KEYWORDS"
120130
search keywords field for specified words
121131
.IP "--keywords_type=KEYWORDS_TYPE, -K KEYWORDS_TYPE"
122-
specify searching option for keywords, ie. anywords,allwords,nowords
132+
specify searching option for keywords, ie. anywords, allwords, nowords
123133
.IP "--status_whiteboard=STATUS_WHITEBOARD, -w STATUS_WHITEBOARD"
124134
search Status Whiteboard field for specified words
125135
.IP "--status_whiteboard_type=STATUS_WHITEBOARD_TYPE, -W STATUS_WHITEBOARD_TYPE"
126-
specify searching option for Status Whiteboard, ie. anywords,allwords,nowords
136+
specify searching option for Status Whiteboard, ie. anywords, allwords, nowords
137+
138+
.SH BOOLEAN \[oq]QUERY\[cq] OPTIONS
127139
.IP "--booleantype=BOOLEANTYPE, -B BOOLEANTYPE"
128-
specify searching option for booleans, ie. substring,notsubstring,exact,... [Default: substring]
140+
specify searching option for booleans, ie. substring, notsubstring, exact, ... [Default: substring]
129141
.IP "--boolean_query=BOOLEAN_QUERY"
130142
Boolean:Create your own query. Format: BooleanName-Condition-Parameter &/| ... . ie, keywords-substring-Partner & keywords-notsubstring-OtherQA
131143
.IP "--blocked=BLOCKED"
@@ -142,8 +154,8 @@ Boolean:search for bugs that have certain Devel Whiteboard text present
142154
Boolean:search for bugs that have the provided alias
143155
.IP "--fixed_in=FIXED_IN"
144156
search Status Whiteboard field for specified words
145-
.IP "--from-url=FROM_URL"
146-
Use the query given by a query.cgi URL. (Use quotes!)
157+
158+
.SH OUTPUT FORMAT \[oq]QUERY\[cq] OPTIONS
147159
.IP "--full, -f"
148160
output detailed bug info
149161
.IP "--ids, -i"
@@ -161,6 +173,8 @@ Print output in the form given. You can use RPM-style tags that match bug fields
161173
Add a comment
162174
.IP "--close=RESOLUTION, -k RESOLUTION"
163175
Close with the given resolution
176+
.IP "--dupeid=ORIGINAL, -d ORIGINAL"
177+
ID of original bug (implies -k DUPLICATE)
164178
.IP "--private, -p"
165179
Mark as private
166180
.IP "--status=STATUS, -s STATUS"
@@ -170,11 +184,13 @@ Assign bugzilla to assignee
170184
.IP "--qa_contact=QA_CONTACT"
171185
Change QA contact
172186
.IP "--flag=FLAG, -f FLAG"
173-
Update bugzilla flags with requested type, ie fedora-cvs? (Use a new option for each flag)
187+
Update bugzilla flags with requested type, ie fedora-cvs?, or needinfoX to clear (Use a new option for each flag)
174188
.IP "--cc=CC"
175189
Add an email to the cc list
176190
.IP "--fixed_in=VERSION, -F VERSION"
177191
"Fixed in version" field
192+
.IP "--whiteboard=TEXT"
193+
Alter status whiteboard text. TEXT appends, -TEXT removes, =TEXT overwrites
178194
.SH \[oq]ATTACH\[cq] OPTIONS
179195
.IP "--file=FILENAME, -f FILENAME"
180196
File to attach, or filename for data provided on stdin
@@ -202,6 +218,10 @@ bugzilla query --bug_id 62037
202218

203219
bugzilla query --version 15 --component python-bugzilla
204220

221+
# All boolean options can be formatted like this
222+
.br
223+
bugzilla query --blocked "123456 | 224466"
224+
205225
bugzilla login
206226

207227
bugzilla create -p Fedora -v rawhide -c python-bugzilla \\
@@ -214,6 +234,7 @@ bugzilla attach --getall $BUGID
214234

215235
bugzilla modify --close NOTABUG --comment "Actually, you're hungover." $BUGID
216236

237+
217238
.SH EXIT STATUS
218239
.BR bugzilla
219240
normally returns 0 if the requested command was successful.
@@ -222,11 +243,11 @@ Otherwise, exit status is 1 if
222243
is interrupted by the user (or a login attempt fails), 2 if a
223244
socket error occurs (e.g. TCP connection timeout), and 3 if the server returns
224245
an XML-RPC fault.
225-
.SH NOTES
226-
Not everything that's exposed in the Web UI is exposed by XML-RPC, and not
227-
everything that's exposed by XML-RPC is used by
228-
.BR bugzilla .
229246
.SH BUGS
230-
Bugs? In a sub-1.0 release? Preposterous.
247+
Please report any bugs to bugzilla.redhat.com
248+
.br
249+
Product=Fedora component=python-bugzilla or to the mailing list at
250+
.br
251+
https://fedorahosted.org/mailman/listinfo/python-bugzilla
231252
.SH AUTHOR
232253
Will Woods <[email protected]>

0 commit comments

Comments
 (0)