1pybugz.d(5) File Formats Manual pybugz.d(5)
2
6 pybugz.d - configuration files for pybugz
7
9 /usr/share/pybugz.d/*.conf
10 /etc/pybugz.d/*.conf
12 ~/.bugzrc
14
16 When started, bugz reads configuration files from all of the locations
17 listed above, in the order listed. In the directories, it reads the
18 files in lexical order.
19 Files located in /usr/share/pybugz.d/*.conf are provided by pybugz and
21 should not be modified.
22 Files located in /etc/pybugz.d/*.conf, if it exists, are provided by
24 the system administrator.
25 The final file that is read, if it exists, is ~/.bugzrc by default.
27 This is the user-specific configuration file. This file name can be
28 overridden on the command line by using the --config-file option.
29
31 A configuration file consists of sections which define parameters for
32 the Bugzillas you intend to use. Each section starts with a case-
33 sensitive section name in square brackets and is followed by the
34 settings, in the form "key = value" or "key : value", which define the
35 parameters for this bugzilla instance.
36 The section name is also the name that should be used with the
38 --connection option of the bugz command or the "connection" setting in
39 the default section of the configuration file.
40 The section named [default] is special. Any settings defined in this
42 section will have the value they are given here in all other sections
43 unless they are overridden. So, for example, if you want to use the
44 same username for most of your bugzillas, define user in the default
45 section.
46 Comments are also allowed. A comment must begin with "#" or ";" and be
48 on a line of its own.
49
51 This is a list of the current settings supported by pybugz.
52 connection = sectionname
54 This is used in the default section to define the bugzilla you connect
56 with most of the time. It is not an error to put it in another section,
57 but it does not make much sense to do so.
58 base = http://my.project.com/bugzilla/xmlrpc.cgi
60 base =
62 http://myhttpname:myhttppasswd@my.project.com/bugzilla/xmlrpc.cgi
63 This is the base URL of the bugzilla. It must point to the xmlrpc.cgi
65 script on the bugzilla installation. The second form is used if you
66 need to encode a username and password into the URL for basic http
67 authentication.
68 user = myname@my.project.com
70 password = secret2
72 These set your username and password for this bugzilla. If you do not
74 provide one or both of these and you do not use the key setting below,
75 you will be prompted for the setting you do not provide.
76 passwordcmd = gpg --decrypt ~/.my-encrypted-password.gpg
78 As another alternative for storing your password, you can provide a
80 password command. This command will be run, and pybugz expects it to
81 output the password to stdout. The example above uses gpg to decrypt an
82 encrypted password stored in a file. The default setting is undefined,
83 so it will not be used unless you define it.
84 key = string
86 This is your API key, which is an alternative way to authenticate for
88 Bugzilla 5.0 and newer. To use this, you must generate an API key in
89 the preferences section of Bugzilla and set it to that value. This
90 overrides the username and password settings. The default is undefined.
91 columns = 80
93 This is the number of columns your terminal can display. Most of the
95 time, pybugz should be able to determine this value. If it cannot, the
96 default value is 80, so more than likely you will never have to change
97 this setting.
98 debug = 0
100 This sets the level of debug logging. This is mostly used for
102 development purposes. It causes PyBugz to print out debugging
103 information as it runs.
104 quiet = False
106 If set to true, this requests that pybugz run in quiet mode. This means
108 only output returned from the Bugzilla will be displayed; several more
109 verbose log messages will not be displayed.
110 product = string
112 This is the default setting for the product field in bugs in this
114 Bugzilla instance. It is possible to define this in the default
115 section. However, it does not make sense to do so most of the time. If
116 this is set, you will not be prompted for a product when you run bugz
117 post, and this value will also be the default for bugz search.
118 component = string
120 This is the default setting for the component field in bugs in this
122 Bugzilla instance. It is possible to define this in the default
123 section. However, it does not make sense to do so most of the time. If
124 this is set, you will not be prompted for a component when you run bugz
125 post, and this will also be the default value for bugz search.
126 search_statuses = confirmed, in_progress, unconfirmed
128 This sets the default statuses to be used in a search command. It is a
130 space separated list of Bugzilla statuses.
131 insecure = true | false
133 If this is set to true, pybugz will not validate the ssl certificate
135 used during an https connection to this site. Do not use this setting
136 unless you know exactly what you are doing.
137 interactive = true | false
139 If this is set to true, pybugz will prompt for a username and password
141 for the bugzilla you are attempting to connect to if no credentials are
142 specified in the configuration file. The default setting is false.
143
145 The home page of this project is http://www.github.com/williamh/pybugz.
146 Bugs should be reported to the bug tracker there.
147
149 bugz(1)
150
152 William Hubbs <w.d.hubbs@gmail.com>
1530.12 20 Jan 2013 pybugz.d(5)