POEZIO.COMMANDS(7)

📦
version 0.18 · 2 versions
, in nixpkgs unstable

🌸 NAME 🌸

Okay so this is poezio.commands(7) — the Poezio Commands page, bestie. 💖

Commands start with the / character and can take a list of any number of arguments, separated by spaces. If an argument should contain a space, you can use the " character to surround this argument.

The commands described in this page are shown like this:

/command <mandatory argument> [optional argument]

You can get the same help as below from inside poezio with the /help command. 👑

Note: use command parameters like this:
  • Do not use quotes if they are unnecessary (words without special chars or spaces)
  • If the command takes several arguments, you need to put quotes around arguments containing special chars such as backslashes or quotes
  • If the command always takes only one argument, then do not use quotes even for words containing special chars

✨ GLOBAL COMMANDS ✨

These commands work in any tab. 💅

  • /ad-hoc — Usage: /ad-hoc <jid>. List available ad-hoc commands on the given jid.
  • /bind — Usage: /bind <key> <eq>. Bind a key to another key or to a "command". For example, /bind ^H KEY_UP makes Control + h behave the same way as the Up key. See the key bindings documentation page for more details.
  • /bookmark — Usage: /bookmark [roomname][/nick] [autojoin] [password]. Bookmark the specified room. This command uses almost the same syntax as /join. Type /help join for syntax examples. Note that when typing /bookmark on its own, the room will be bookmarked with the nickname you're currently using in this room (instead of default_nick). You can specify an optional autojoin and password if you call it with the full line (/bookmark alone will put the room in autojoin without password). The bookmarks stored with this command are stored on your xmpp server.
  • /bookmark_local — Usage: /bookmark_local [roomname][/nick]. Bookmark the specified room (you will then auto-join it on each poezio start). This command uses almost the same syntax as /join. Type /help join for syntax examples. Note that when typing /bookmark on its own, the room will be bookmarked with the nickname you're currently using in this room (instead of default_nick). The bookmarks stored with this command will be stored locally. They have priority over the ones stored online.
  • /bookmarks — Usage: /bookmarks. Open a Bookmarks tab <#bookmarks-tab> in order to edit the current boookmarks.
  • /close — Close the tab.
Note: the /close command will work everywhere, except in the Contact list tab, which can’t be closed.
  • /debug — Usage: /debug [filename]. Reset logging and enable debugging to [filename]. If the filename is empty, debug logging will be disabled.
  • /destroy_room — Usage: /destroy_room [room JID [reason [alternative venue]]]. Try to destroy the room given as a parameter, or the current room if no parameter is given and the current tab is a chatroom.

You need to be the owner of a room or a server admin to destroy it.

  • /exit, /quit — Just disconnect from the server and exit poezio.
  • /help — Usage: /help [command]. If called without an argument, this command will list the available commands. If it has a valid command as an argument, this command will show the usage and the help for the given command.
  • /impromptu — Usage: /impromptu <jid> [jid ..]. Invite specified JIDs into a newly created room.

Added in version 0.13.

  • /invitations — Show the pending invitations.
  • /invite (Global version) — Usage: /invite <jid> <room> [reason]. Invite jid to room with reason (if provided).
  • /join — Usage: /join [room_name][@server][/nick] [password]. Join the specified room. You can specify a nickname after a slash (/). If no nickname is specified, you will use the default_nick in the configuration file. You can omit the room name: you will then join the room you're looking at (useful if you were kicked). You can also provide a room_name without specifying a server, the server of the room you're currently in will be used. You can also provide a password to join the room.

Examples:

  • /join room@server.tld
  • /join room@server.tld/John
  • /join room2
  • /join /me_again
  • /join
  • /join room@server.tld/my_nick password
  • /join / password
  • /last_activity — Usage: /activity <jid>. Show the last activity of a contact or a server (its uptime, in that case).
  • /list — Usage: /list [server.tld]. Get the list of public chatrooms in the specified server (open a List tab <#listtab>).
  • /load — Usage: /load <plugin name> [<other plugin> …]. Load or reload one or several plugins.
  • /message — Usage: /message <jid> [optional message]. Open a conversation with the specified JID (even if it is not in our contact list), and send a message to them, if specified.
  • /move_tab — Usage: /move_tab <source> <destination>. Move tab <source> to <destination>. If the create_gaps <# term-create_gaps> option is true, then it will leave a gap at the <source> position, leading to usual behaviour. If create_gaps is not enabled, then the tabs will number from 0 to your actual tab number, without gaps (which means their number will change if you close a tab on the left of the list).

A value of . for a parameter means the current tab.

  • /next — Go to the next room.
  • /plugins — List the loaded plugins.
  • /presence — Usage: /presence <jid> [type] [status]. Send a directed presence to jid using type and status if provided.
  • /prev — Go to the previous room.
  • /rawxml — Usage: /rawxml <stanza>. Send a custom XML stanza.
  • /reload — Reload the config. You can achieve the same by sending SIGUSR1 to poezio.
  • /remove_bookmark — Usage: /remove_bookmark [room_jid]. Remove the bookmark on room_jid or the one on the current tab, if any.
  • /runkey — Usage: /runkey <key>. Execute the action defined for key. For example, /runkey KEY_PPAGE will scroll up, or /runkey ^N will go to the next tab.
  • /self — Reminds you of who you are and what your status is.
  • /server_cycle — Usage: /server_cycle [server.tld] [message]. Disconnect and reconnect in all the rooms of server.tld.
  • /set — Usage: /set [plugin|][section] <option> <value>. Set the value to the option in your configuration file. You can, for example, change your default nickname by doing /set default_nick toto or your password with /set password blabla. Doing so will write in the main config file, and in the main section ([Poezio]). But you can also write to another section, with /set bindings M-i ^i, to a plugin configuration with /set mpd_client| host main (notice the |, it is mandatory to write in a plugin), or even to another section in a plugin configuration /set plugin|other_section option value. toggle can be used as a special value for a boolean option. It just sets the option to true if it’s currently false, and to false if it’s currently true.
  • /set_default — Usage: /set_default [section] <option>. Set the value of an option back to the default. For example, /set_default password will reset the password option.
  • /status — Usage: /status <availability> [status message]. Set your availability and (optionally) your status message. The <availability> argument is one of "available, chat, away, afk, dnd, busy, xa" and the optional [status] argument will be your status message.
  • /theme — Usage: /theme [theme_name]. Reload the theme defined in the config file. If theme_name is given, this command will act like /set theme theme_name then /theme.
  • /toggle — Usage: /toggle <option>. Toggle an option, shortcut for /set <option> toggle.
  • /unload — Usage: /unload <plugin name> [<other plugin> …]. Unload one or several plugins.
  • /version — Usage: /version <jid>. Get the software version of the given JID (usually its XMPP client and Operating System).
  • /win, /w — Usage: /win <number or string>. Go to the matching tab. If the argument is a number, it goes to the tab with that number. Otherwise, it goes to the next tab whose name contains the given string.
  • /wup — Usage: /wup <prefix>. Go to the tab whose name starts with prefix. If multiple tabs start with that prefix, no action is taken.

(Mnemonic: Window by Unique Prefix)

  • /xml_tab — Open an XML tab.

💬 CHAT TAB COMMANDS 💬

These commands will work in any conversation tab (MultiUserChat, Private, or Conversation tabs). 🫶

  • /clear — Clear the current buffer.
  • /correct — Usage: /correct <corrected message>. Replace the content of the last sent message with corrected message.
  • /say — Usage: /say <message>. Just send the message (only useful if you want your message to begin with a /). Note that you can also send message starting with a / by starting it with //.
  • /scrollback, /sb — Usage: /scrollback end home clear status goto <+|-linecount>|<linenum>|<timestamp>. Allows to go to the given line or message in the window.
  • /xhtml — Usage: /xhtml <custom xhtml>. Send a custom xhtml message to the current tab.

💬 MULTIUSERCHAT TAB COMMANDS 💬

Room commands, bestie. This is where the group-chat magic lives ✨

  • /affiliation [room version] — sets somebody's affiliation in this room.
Usage: /affiliation [<nick or jid> <affiliation>]

You pick a participant by nick or jid and give them an affiliation — it can be one of owner, admin, member, outcast and none. If you pass no argument at all, it just lists the room's affiliations for you. 🫶

  • /clear [Chatroom version]
Usage: /clear

Clears the message buffer. Poof, scrollback gone 💨

  • /color — give a nick a permanent glow-up 🎀
Usage: /color <nick> <color>

Assigns a color to the given nick, and here's the iconic part: the nick and all its aliases get that color everywhere. Aliases are nicks that only differ by one or more _ characters at the beginning or the end — so _Foo and Foo___ are considered aliases of the nick Foo. The color sticks in all MultiUserChat tabs, no cap.

Use the completion to get a list of all the available color values. There's a special color unset that removes the attributed color on this nick, and you can also use random to attribute a random color 🌈

  • /configure — configure the current room through a form (it opens a Dataforms tab <#dataformtab>).
  • /cycle
Usage: /cycle [message]

Leaves the current room and rejoins it immediately. You can specify an optional quit message on the way out 👋

  • /ignore
Usage: /ignore <nickname>

Ignores a specified nickname. Not me muting the group chat 💀

  • /info [Chatroom version]
Usage: /info <nickname>

Displays some information about the user in the room: their role, affiliation, status, and status message. Little dossier moment 📋

  • /invite [Chatroom version]
Usage: /invite <jid> [reason]

Invites jid to this room, with reason if provided 💌

  • /kick
Usage: /kick <nick> [reason]

Kicks the user with the specified nickname. You can also give an optional reason — be nice about it 🥿

  • /leave
Usage: /leave [message]

Disconnects you from a room, on all of your clients. You can specify an optional message.

This is similar to /part, but it closes the tab and removes its bookmark, to make sure we don't come back to this room the next time we open poezio or another client.

This is similar to /close, but also removes the bookmark to make sure we don't come back to this room the next time we open poezio or another client. No zombie rooms, periodt ✌️

  • /names — gets the list of the users in the room, their number, and the list of the people assuming different roles. Roll call 👑
  • /nick
Usage: /nick <nickname>

Changes your nickname in the current room. New name, new era 💅

  • /part
Usage: /part [message]

Disconnects you from a room. You can specify an optional message.

This is similar to /leave, but it keeps the tab open and doesn't remove the bookmark, so restarting poezio or another client will reopen this room. It's giving "brb" not "goodbye" 🦋

  • /query
Usage: /query <nick> [message]

Opens a Private tab <#privatetab> with nick. This nick has to be present in the room you're currently in. If you specified a message after the nickname, it will be sent to this user. Slide into their DMs, respectfully 🙈

  • /recolor
Usage: /recolor

Re-assigns a color to all the participants in the current room, if the theme has changed. Glow-up for everyone, on the house ✨

  • /role
Usage: /affiliation <nick> <role>

(Yes, that's the usage line exactly as written — we don't make the rules, we just ship them 😭)

Sets the role of the participant designated by nick to the given role — it can be one of moderator, participant, visitor and none.

  • /topic
Usage: /topic [subject]

Changes the subject of the room.

Using the auto-completion of this command writes the current topic in the input, to help the user make a small change to the topic without having to rewrite it all by hand. Highkey the best quality-of-life feature in here 🫶

If no subject is specified as an argument, the current topic is displayed, unchanged.

  • /unignore
Usage: /unignore <nickname>

Removes the specified nickname from the ignore list. Forgiveness era 🌸

  • /version [Chatroom version]
Usage: /version <nickname or jid>

Gets the software version of the given nick in room, or of the given jid (usually its XMPP client and Operating System). Cyber-stalking, but consensual 🔍

💌 PRIVATE TAB COMMANDS 💌

One-on-one mode, iykyk.

  • /info [Private tab version] — displays some info about this user in the MultiUserChat.
  • /unquery [Private tab] — closes the tab. Leaving the DM, no drama 🚪
  • /version [Private tab version] — gets the software version of the current interlocutor (usually its XMPP client and Operating System).

🗨️ NORMAL CONVERSATION TAB COMMANDS 🗨️

Your classic 1:1 chats, bestie.

  • /info [Conversation version] — displays the status of this contact.
  • /invite [Conversation version]
Usage: /invite <jid> [jid ..]

Invites the specified JIDs, with this contact, into a newly created room. Group hangout speedrun 🏃‍♀️💨

Added in version 0.13.

  • /unquery [Conversation tab] — closes the tab.
  • /version [Conversation tab version] — gets the software version of the current interlocutor (usually its XMPP client and Operating System).

📇 CONTACT LIST TAB COMMANDS 📇

Roster management hour, let's go 👑

  • /accept
Usage: /accept [jid]

Authorizes the provided JID (or the selected contact in the contact list) to see your presence. Let them in 🫶

  • /add
Usage: /add <jid>

Adds the specified JID to your contact list and authorizes them to see your presence. If they accept you, the subscription will be mutual (and if they don't, you can still /remove them). Mutuals only 💖

  • /deny
Usage: /deny [jid]

Prevents the provided JID (or the selected contact in the contact list) from seeing your presence. Blocked, but politely.

  • /groupadd
Usage: /groupadd (<jid> <group>|<group>)

Adds the given JID to the given group (if the group does not exist, it will be created). If no jid is provided, the currently selected item on the contact list (resource or JID) will be used.

  • /groupmove
Usage: /groupmove <jid> <old_group> <new_group>

Moves the given JID from one group to another (the JID has to be in the first group, and the new group may not exist). Relocation arc 🚚

  • /groupremove
Usage: /groupremove <jid> <group>

Removes the given JID from the given group (if the group is empty after that, it will get deleted).

  • /name
Usage: /name <jid> <name>

Sets the given JID's name in your contact list. Save-contact energy 💾

  • /password
Usage: /password <password>

Changes your password. Pick a good one, bestie 🔐

  • /reconnect — disconnects from the remote server (if connected) and then connects to it again. Have you tried turning it off and on again 🔄
  • /remove
Usage: /remove [jid]

Removes the specified JID from your contact list. This will unsubscribe you from its presence, cancel its subscription to yours, and remove the item from your contact list. Full unfollow, no leftovers.

Note: the following commands only exist if your server announces it supports them. Server-dependent, so vibe check with your admin first 💅
  • /block
Usage: /block [jid]

Blocks the following JID using simple blocking. You will not receive any of his messages and won't be able to send some to him either. Two-way silence 🔇

  • /cert_add
Usage: /cert_add <name> <certificate file> [management]

Adds a client X.509 certificate to the list of the certificates which grand access to your account. It must have an unique name, the file must be in PEM format. [management] is true by default and specifies if the clients connecting with this particular certificate will be able to manage the list of authorized certificates 🎫

  • /cert_disable
Usage: /cert_disable <name>

Removes a certificate from the authorized list. Clients currently connected with the certificate identified by <name> will however not be disconnected. Soft revoke 🫧

  • /cert_fetch
Usage: /cert_fetch <name> <path>

Downloads the public key of the authorized certificate identified by name from the XMPP server, and stores it in <path>.

  • /cert_revoke
Usage: /cert_revoke <name>

Removes a certificate from the authorized list. Clients currently connected with the certificate identified by <name> will be disconnected. This one's the hard revoke 😤

  • /certs — lists the remotely stored X.509 certificated allowed to connect to your accounts.
  • /list_blocks — lists the blocked JIDs. Receipts 🧾
  • /unblock
Usage: /unblock [jid]

Unblocks a previously blocked JID using simple blocking. You will be able to send and receive messages from him again. Un-ghosting, technically.

Note: the following commands do not comply with any XEP or whatever, but they can still prove useful when you are migrating to an other JID. They're just little helpers, not spec royalty 🎀
  • /export
Usage: /export [/path/to/file]

Exports your contacts into /path/to/file if specified, or $HOME/poezio_contacts if not.

  • /import
Usage: /import [/path/to/file]

Imports your contacts from /path/to/file if specified, or $HOME/poezio_contacts if not.

🔬 XML TAB COMMANDS 🔬

For the nerds who like to see the raw stanzas. We respect it deeply 🧚

  • /clear [XML tab version] — clears the current buffer.
  • /dump
Usage: /dump <filename>

Writes the content of the XML buffer into a file.

  • /filter_from
Usage: /filter_from <jid>

Filters by JID for from attribute.

  • /filter_id
Usage: /filter_id <id>

Filters by stanza id attribute.

  • /filter_jid
Usage: /filter_jid <jid>

Filters by JID, both to and from.

  • /filter_reset — resets the stanza filters. Clean slate 🧼
  • /filter_to
Usage: /filter_to <jid>

Filters by JID for the to attribute.

  • /filter_xmlmask
Usage: /filter_xmlmask <xml mask>

Filters using an XML mask.

  • /filter_xpath
Usage: /filter_xpath <xpath>

Filters with an XPath selector.

👑 AUTHOR 👑

Mathieu Pasquet, Florent Le Coz, Emmanuel Gil Peyrot, Maxime Buquet

1980, Mathieu Pasquet - Florent Le Coz - Emmanuel Gil Peyrot - Maxime Buquet

And that's the whole page, bestie — you made it to the end 🫶✨ This little masterpiece is POEZIO.COMMANDS(7), version 0.17, dated Jan 02, 1980 (yes, the copyright year and the date match, it's giving time-travel, we don't ask questions 💀). Now go forth and command things, you absolute main character 🌈💖

📦 where this page comes from