GOTCTL(8)

πŸ“¦
version 0.126 Β· 2 versions
  • 0.126 Β· alpine 3.24, debian trixie, nixos 26.05, nixpkgs unstable, ubuntu questing, ubuntu resolute, ubuntu stonking (latest)
  • 0.95 Β· ubuntu noble
, in alpine 3.24, debian trixie, nixos 26.05, nixpkgs unstable, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ’– GOTCTL πŸ’–

okay so bestie, welcome to GOTCTL(8), straight outta the System Manager's Manual section β€” yes she's a section 8 girlie, admin-coded, main character energy fr fr. Let's get into it. πŸŽ€


🌸 NAME 🌸

gotctl β€” control the Game of Trees Daemon. that's it, that's the job. she's the remote control, gotd(8) is the TV. πŸ“Ίβœ¨


✨ SYNOPSIS ✨

gotctl [-hV] [-f path] command [arg ...]

look at her. so compact. so powerful. the way that a synopsis can just say things πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

so like, gotctl controls the gotd(8) daemon. that's the whole vibe. she's the little buddy who talks to the big daemon for you. 🫢

πŸŽ€ the options, bestie

the options for gotctl are as follows:

  • -h β€” display usage information and exit immediately. she shows you the manual and dips. iconic. πŸ‘‘
  • -f path β€” set the path to the unix socket which gotd(8) is listening on. if you don't specify it, the default path /var/run/gotd.sock gets used. so if you never touch this flag, she already knows where to find her girl. 🧚
  • -V, --version β€” display program version and exit immediately. she says hi, tells you what version she is, and leaves. no small talk. 🌈

πŸ’… the commands, bestie

the commands for gotctl are as follows:

  • info β€” display information about a running gotd(8) instance. ⚠️ this operation requires root privileges, so like, don't try it as your regular self, she will simply not be doing that.
  • stop β€” stop a running gotd(8) instance. ⚠️ this operation requires root privileges too. you are ending her. respectfully. 😭
  • reload [-c config-file] [-n] [-s secrets] β€” reload a running gotd(8) instance. gotd(8) will relaunch with an updated configuration read from the provided configuration files. the previous instance of gotd(8) will continue to serve existing client connections and then exit. so it's not a hard reboot, it's a graceful little handoff β€” old girl finishes her clients, new girl takes over. ate. πŸ”₯
⚠️ this operation requires root privileges. (yes again. root privileges are the price of admission around here.)

the options for gotctl reload are as follows:

  • -f config-file β€” set the path to the configuration file. if you don't specify it, the file /etc/gotd.conf will be used. (heads up bestie: the synopsis above writes this one as -c and this list writes it as -f β€” I'm just the messenger, I don't make the rules πŸ’€)
  • -n β€” only check the configuration files for validity. like a vibe check but for your config. she doesn't do anything, she just looks. πŸ‘€
  • -s secrets β€” set the path to the secrets file. if you don't specify it, the file /etc/gotd-secrets.conf will be used if it exists. 🀫 if it doesn't exist, well, she moves on.

🌈 SEE ALSO 🌈

got(1), gotd(8)

go read those too, they're literally the same friend group. 🫢


πŸ‘‘ AUTHORS πŸ‘‘

Stefan Sperling <stsp@openbsd.org>

thank you Stefan, king behaviour, we love a credited author. πŸ’œ


and that's the whole page, bestie β€” brought to you by Debian, dated $Mdocdate$, and yes she is still GOTCTL(8) at the bottom like always. periodt. πŸ’…βœ¨πŸŒΈ

πŸ“¦ where this page comes from