pybugz.d(5)

📦
version 0.14 · 2 versions
, in debian trixie, epel 9, fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 pybugz.d — the config files for pybugz 💖

okay bestie, this is the manual page for pybugz.d, section 5 of the File Formats Manual, and it's literally just the lore drop on how you configure pybugz. it's giving "small file, big power". let's get into it 🫶

✨ SYNOPSIS ✨

/usr/share/pybugz.d/*.conf

/etc/pybugz.d/*.conf

~/.bugzrc

🌸 DESCRIPTION 🌸

so when bugz starts up, it reads config files from all of the locations above, in the order they're listed. and inside those directories? it reads the files in lexical order. yes bestie, alphabetical, no cap.

  • files in /usr/share/pybugz.d/*.conf are shipped by pybugz itself and you should not be editing them. hands off, they're not yours 💅
  • files in /etc/pybugz.d/*.conf, if that directory even exists, are the system administrator's doing.
  • the final file it reads, if it exists, is ~/.bugzrc by default — that's your user-specific config, your personal little corner of the world 🎀. and fun fact, you can override that filename on the command line with the --config-file option. iconic.

🦋 CONFIGURATION FILE FORMAT 🦋

a config file is made up of sections, and each section defines parameters for a Bugzilla you intend to use. every section kicks off with a case-sensitive section name wrapped in square brackets, then the settings follow in the form key = value or key : value. those settings are what define the parameters for that bugzilla instance.

careful bestie — case-sensitive. [Default] and [default] are NOT the same thing, and one of them is going to do absolutely nothing for you 😭

the section name is also the name you should use with the --connection option of the bugz command, or as the connection setting in the default section of the config file. two ways, same name, iykyk.

the section named [default] is special ✨. anything you define in there gets inherited by every other section, unless that other section overrides it. so like, if you want the same username for most of your bugzillas? just define user in the default section once and vibe. obsessed with the efficiency honestly.

comments are allowed too! a comment has to start with # or ; and it has to be on a line of its own. no sneaking comments onto the end of a setting line, that's not the vibe.

👑 CONFIGURATION SETTINGS 👑

here's the full list of settings pybugz currently supports. no skipping, we're doing all of them 💅

  • connection = sectionname — this goes in the default section and defines the bugzilla you connect to most of the time. it's not technically an error to put it in another section, but like... it doesn't make much sense there, bestie. it's giving "wrong room, wrong party".
  • base = http://my.project.com/bugzilla/xmlrpc.cgi
  • base = http://myhttpname:myhttppasswd@my.project.com/bugzilla/xmlrpc.cgi — this is the base URL of your bugzilla, and it must point at the xmlrpc.cgi script on that installation. the second form is what you reach for when you need to encode a username and password into the URL for basic http authentication. fancy, but valid.
  • user = myname@my.project.com
  • password = secret2 — these set your username and password for this bugzilla. if you don't provide one or both of them, and you're also not using the key setting below, pybugz will prompt you for whatever you didn't provide. it's not gonna just guess, bestie.
  • passwordcmd = gpg --decrypt ~/.my-encrypted-password.gpg — another option for storing your password! you give it a command, pybugz runs it, and it expects the password to come out on stdout. the example above uses gpg to decrypt a password that's sitting encrypted in a file. the default is undefined, so this does nothing at all unless you define it. no cap.
  • key = string — this is your API key, which is an alternate way to authenticate on Bugzilla 5.0 and newer. to use it you have to generate an API key in the preferences section of Bugzilla and set this to that value. heads up: this overrides the username and password settings. the default is undefined.
  • columns = 80 — how many columns your terminal can display. most of the time pybugz can figure this out on its own. if it can't, the default is 80, so realistically you will probably never touch this one. leaving it alone is the self-care.
  • debug = 0 — sets the level of debug logging. this is mostly a development thing, and it makes PyBugz print out debugging info as it runs. nerdy, we love her.
  • quiet = False — if you set this to true, you're asking pybugz to run in quiet mode. that means only output returned from the Bugzilla gets displayed, and several chattier log messages stay silent. peace and quiet, periodt.
  • product = string — the default for the product field in bugs on this Bugzilla instance. you can define this in the default section, but most of the time that doesn't make sense, so maybe don't. if it's set, you won't get prompted for a product when you run bugz post, and it also becomes the default for bugz search.
  • component = string — same energy as product, but for the component field. you can put it in the default section, though again, usually that's not the move. if it's set, no component prompt when you run bugz post, and it's the default value for bugz search too.
  • search_statuses = confirmed, in_progress, unconfirmed — sets the default statuses used by a search command. it's a space separated list of Bugzilla statuses.
  • insecure = true | false — if this is true, pybugz will not validate the ssl certificate used during an https connection to this site.
🚨 bestie NO. do not use this setting unless you know exactly what you are doing. i'm so serious. this is the "trust me bro" of config options and it is not your friend.
  • interactive = true | false — if this is true, pybugz will prompt for a username and password for the bugzilla you're trying to connect to, but only if no credentials were specified in the config file. the default setting is false.

💀 BUGS 💀

the home page of this project is http://www.github.com/williamh/pybugz. bugs should be reported to the bug tracker there. go tell them, they want to know 🙈

🌈 SEE ALSO 🌈

bugz(1)

💜 AUTHOR 💜

William Hubbs <w.d.hubbs@gmail.com>

and that's the whole page, bestie 🎀 this was pybugz.d, version 0.12, dated 20 Jan 2013 — shoutout to the File Formats Manual for housing her. now go write a config file and slay ✨💅🦋

📦 where this page comes from