PANCTL(1)

πŸ“¦ version 0.10.4, in ubuntu jammy

πŸ’– PANCTL(1) πŸ’–

okay bestie, welcome to panctl β€” the manual page, but make it cute. it's a General Commands Manual situation, and she's here to help you run the show. πŸŽ€


✨ NAME ✨

panctl β€” control the Matrix reverse proxy daemon pantalaimon. yes that's the whole name section. short, sweet, iconic. πŸ’…


🌸 DESCRIPTION 🌸

panctl is a small utility β€” a lil baby tool, but she's powerful β€” that lets you control and introspect the state of pantalaimon. like, you poke pantalaimon and ask her how she's doing, and she tells you. no cap. πŸ¦‹

🫢 Commands

here's the full menu of what panctl will accept, no skips, no cuts, all of it:

  • list-servers β€” lists all the configured homeservers, plus the pan users hanging out on each homeserver. the whole guest list, basically. πŸ’Œ
  • list-devices pan-user user-id β€” lists the devices of a user that are known to the pan-user. who's on the roster, and which of them the pan-user already knows about. ✨
  • start-verification pan-user user-id β€” kicks off an interactive key verification between the given pan-user and user. the two of them start the little handshake, you're just the matchmaker. πŸ’ž
  • accept-verification pan-user user-id β€” accepts an interactive key verification that the given user has already started with your given pan-user. they slid into the DMs first, now you accept. 🫢
  • cancel-verification pan-user user-id β€” cancels an interactive key verification between the given pan-user and user. not feeling the vibe? ghost it. πŸ’€
  • confirm-verification pan-user user-id β€” confirms that the short authentication string of the interactive key verification with the given pan-user and user actually matches. yes, the numbers line up, we're so back. βœ…
  • verify-device pan-user user-id device-id β€” manually marks the given device as verified. important caveat bestie: the device gets marked verified only for the given pan-user. not global. local. exclusive. πŸ‘‘
  • unverify-device pan-user user-id device-id β€” marks a previously verified device of the given user as unverified again. the glow-up got reverted. πŸ™ˆ
  • blacklist-device pan-user user-id device-id β€” manually marks the given device of the given user as blacklisted. blocked, unfollowed, it's over. 🚫
  • unblacklist-device pan-user user-id device-id β€” marks a previously blacklisted device of the given user as unblacklisted. unblocked, we're being the bigger person. 🌈
  • send-anyways pan-user room-id β€” so here's the tea: if an encrypted room contains unverified devices and a connected Matrix client tries to send a message to such a room, pantalaimon will send a notification that the room contains unverified users. with this command, the user can choose to mark all unverified devices as ignored. ignored devices will still receive encryption keys, but they'll be left marked as unverified. the message will be sent away after all devices are marked as ignored. so yeah, you can force it through, but everyone stays unverified in the receipts. πŸ’…
  • cancel-sending pan-user room-id β€” the opposite energy of send-anyways: this one cancels the sending of a message to an encrypted room with unverified devices, and gives the user the oportunity to verify or blacklist devices as they see fit. you get to pause, breathe, and sort out your device drama first. πŸ›‘
  • import-keys pan-user file passphrase β€” imports end-to-end encryption keys from the given file for the given pan-user. ✨
  • export-keys pan-user file passphrase β€” exports end-to-end encryption keys to the given file for the given pan-user. the provided passphrase is used to encrypt the file that holds the keys, so don't lose it, fr fr. πŸ”

⭐ EXIT STATUS ⭐

panctl exits 0 on success, and >0 if an error occurs. zero means we ate, anything above zero means something went wrong and we're crying. 😭


🌟 SEE ALSO 🌟

go read those too, they're the main character's lore. πŸ“š


πŸ‘‘ AUTHORS πŸ‘‘

panctl was written by Damir JeliΔ‡ <poljar@termina.org.uk>. absolute legend, we stan. 🫢


okay that's the whole page bestie, you're officially panctl-literate πŸ’–βœ¨

this lil number came from the Debian side of the world, dated May 23, 2019, and the manual name is PANCTL(1) in case you forgot already. mwah. πŸ’‹πŸŽ€

πŸ“¦ where this page comes from