Willie(1)

📦 version 6.6.9, in ubuntu jammy

👑 willie — the manual, but make it a group chat

okay so bestie, welcome to Willie(1), aka the Willie IRC Bot manual page. yes it's a real manpage, yes it's from Linux, and yes i'm about to make it make sense. grab a snack. 🍓

✨ NAME ✨

willie — a highly customizable Internet Relay Chat bot 💅

🌸 SYNOPSIS 🌸

like, here's how you actually call her:

willie [-q|--quit] [-k|--kill] [-d|--fork] [--quiet] [-c filename |--config= filename]
willie [-h|--help]
willie [-m|--migrate]
willie [-w|--configure-all] [--configure-modules] [--configure-database]

🦋 DESCRIPTION 🦋

so willie runs a bot that drops some genuinely useful (and, ngl, some deeply useless) commands into one or more Internet Relay Chat channels. main character energy fr fr. 👑

she reads her config options — stuff like which network to connect to, which channels to join, and more — from a config file that you hand her with the -c option. no -c? no problem, she defaults to ~/.willie/default.cfg. 🎀

and here's the cute part: if the config file she's pointed at doesn't exist, she'll run a lil brief configuration wizard for you, setting up the basic options, and optionally setting up a database for user data plus any modules that might need configuring. she's thoughtful like that. ✨

in most cases tho, literally just running willie is enough. the bot starts after initial configuration and keeps vibing until someone tells her to quit through IRC. periodt.

💖 OPTIONS 💖

  • -h, --help — shows you a brief summary of these options. the "wait what do i do" button. 🙈
  • -c filename, --config= filename — run Willie with the configuration options from the file you specify. you can give her an absolute pathname, or just the name of a file inside the configuration directory. ~/.willie is the preferred location, but — legacy reasons, iykyk — this option and -c will also look in ~/.jenni and ~/.phenny. also, if the file's suffix is .cfg, you can just... omit it. slay.
  • -d, --fork — run Willie in the background. she'll safely run back there in the background, and you can kill her later with -q or -d. 🧚
  • -q, --quit — gracefully quit a daemonized instance of Willie. she figures out which instance to quit by the name of the config file given to the -c option, if you used it — so you gotta pass the same argument with -c when you use -q. same energy, same name. 🫶
  • -k, --kill — terminates a daemonized instance of Willie. same deal as above: she determines which instance to kill by the name of the config file given to the -c option, if used, so the same argument must be given with -c when you use -k. this one is not the gentle version. 💀
  • -l, --list — list all config files found in the usual configuration file directories: ~/.willie ~/.jenni and ~/.phenny. window shopping bestie. 🌈
  • -m, --migrate — attempts to migrate a configuration file from an older version of the bot to the new format. versions prior to 3.1 used a configuration file written in Python, and this tool can convert that. glow-up arc. 🔥
  • --quiet — suppress all output from the bot to the terminal. she goes silent mode. 🤫
  • -w, --configure-all — run the initial configuration wizard. you can run it with -c to configure a specified file, or without -c to work on the default file. ⭐
  • --configure-modules — check for modules that have configuration options, and let the user modify those options. changes get added to the default file, or to the file given to -c if you used it. 🎀
  • --configure-database — run a wizard for configuring the user information database options. changes get added to the default file, or to the file given to -c if you used it. 💜
⚠️ real talk bestie: -q and -k both identify their target by the config file name from -c, so if you don't pass the same -c argument, she's not finding that instance. no cap.

and that's the whole page!! 🦋 this was Willie(1) from the Willie IRC Bot manual, dated 2013-15-01, served up on Linux. tysm for reading, go run your bot, ily, bye!! 💅✨👑

📦 where this page comes from