commands.rst 15.8 KB
Newer Older
mathieui's avatar
mathieui committed
1
2
3
Commands
========

mathieui's avatar
mathieui committed
4
Commands start with the ``/`` character and can take a list of any number
mathieui's avatar
mathieui committed
5
of arguments, separated by spaces. If an argument should contain a space,
mathieui's avatar
mathieui committed
6
you can use the ``"`` character to surround this argument.
mathieui's avatar
mathieui committed
7
8
9

The commands described in this page are shown like this:

mathieui's avatar
mathieui committed
10
``/command <mandatory argument> [optional argument]``
mathieui's avatar
mathieui committed
11

mathieui's avatar
mathieui committed
12
You can get the same help as below from inside poezio with the :term:`/help` command.
mathieui's avatar
mathieui committed
13
14
15
16
17
18
19

.. 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 agrguments, 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

mathieui's avatar
mathieui committed
20
21
.. _global-commands:

mathieui's avatar
mathieui committed
22
23
24
25
26
Global commands
~~~~~~~~~~~~~~~

These commands work in *any* tab.

27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
.. glossary::
    :sorted:

    /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.

    /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``

    /exit
    /quit
        Just disconnect from the server and exit poezio.

mathieui's avatar
mathieui committed
62
    /load
63
        **Usage:** ``/load <plugin name> [<other plugin> …]``
mathieui's avatar
mathieui committed
64

65
        Load or reload one or several plugins.
mathieui's avatar
mathieui committed
66
67

    /unload
68
        **Usage:** ``/unload <plugin name> [<other plugin> …]``
mathieui's avatar
mathieui committed
69

70
        Unload one or several plugins.
mathieui's avatar
mathieui committed
71
72
73
74

    /plugins
        List the loaded plugins.

75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
    /next
        Go to the next room.

    /prev
        Go to the previous room.

    /win
    /w
        **Usage:** ``/win <number>``

        Go to the specified room.

    /status
        **Usage:** ``/status <availability> [status message]``

        Set your availability and
        (optionaly) 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.'

    /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 commands 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.

    /remove_bookmark
        **Usage:** ``/remove_bookmark [room_jid]``

        Remove the bookmark on *room_jid* or the one on the current tab, if any.

    /bookmarks
        Show the current bookmarks.

    /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 resource with "/set resource
        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 set the option to true if it’s currently false, and to false if it’s
        currently true.

    /move_tab
        **Usage:** ``/move_tab <source> <destination>``

144
145
146
147
        Move tab <source> to <destination>. If the :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
148
149
        their number will change if you close a tab on the left of the list).

150
151
        A value of ``.`` for a parameter means the current tab.

152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
    /theme
        **Usage:** ``/theme [theme_name]``

        Reload the theme defined in the config file. If
        *theme_name* is given, this command will act like :samp:`/set theme {theme_name}` then
        /theme.

    /presence
        **Usage:** ``/presence <jid> [type] [status]``

        Send a directed presence to *jid* using
        *type* and *status* if provided.

    /rawxml
        **Usage:** ``/rawxml <stanza>``

        Send a custom XML stanza.

mathieui's avatar
mathieui committed
170
171
172
    /xml_tab
        Open an XML tab.

173
174
175
    /list
        **Usage:** ``/list [server.tld]``

mathieui's avatar
mathieui committed
176
        Get the list of public chatrooms in the specified server (open a :ref:`listtab`)
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199

    /message
        **Usage:** ``/message <jid> [optional message]``

        Open a conversation with the specified JID (event if it is not in our roster),
        and send a message to him/her, if specified.

    /version
        **Usage:** ``/version <jid>``

        Get the software version of the given JID (usually its XMPP
        client and Operating System).

    /invite
        **Usage:** ``/invite <jid> <room> [reason]``

        Invite *jid* to *room* with *reason* (if
        provided).

    /invitations
        Show the pending invitations.

    /activity
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
        **Usage:** ``/activity [<general> [specific] [comment]]``

        Send your current activity to your contacts (use the completion to cycle
        through all the general and specific possible activities).

        Nothing means "stop broadcasting an activity".

    /mood
        **Usage:** ``/mood [<mood> [comment]]``
        Send your current mood to your contacts (use the completion to cycle
        through all the possible moods).

        Nothing means "stop broadcasting a mood".

    /gaming
        **Usage:** ``/gaming [<game name> [server address]]``

        Send your current gaming activity to your contacts.

        Nothing means "stop broadcasting a gaming activity".

    /last_activity
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
        **Usage:** ``/activity <jid>``

        Show the last activity of a contact or a server (its
        uptime, in that case).

    /server_cycle
        **Usage:** ``/server_cycle [server.tld] [message]``

        Disconnect and reconnect in all the
        rooms of server.tld.

    /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.

    /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.


    /close
        Close the tab.

        .. note:: The /close command will work everywhere, except in the Roster tab,
                    which can’t be closed.

mathieui's avatar
mathieui committed
256

mathieui's avatar
mathieui committed
257
258
.. _chattab-commands:

mathieui's avatar
mathieui committed
259
260
261
262
263
264
Chat tab commands
~~~~~~~~~~~~~~~~~

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

265
266
267
.. glossary::
    :sorted:

mathieui's avatar
mathieui committed
268
269
270
271
272
    /correct
        **Usage:** ``/correct <corrected message>``

        Replace the content of the last sent message with *corrected message*.

273
274
275
276
277
278
279
280
281
    /say
        **Usage:** ``/say <message>``

        Just send the message (only useful it you want your message
        to begin with a **/**). Note that you can also send message starting with a **/**
        by starting it with **//**.

    /xhtml
        **Usage:** ``/xhtml <custom xhtml>``
mathieui's avatar
mathieui committed
282

283
        Send a custom xhtml message to the current tab.
mathieui's avatar
mathieui committed
284

285
286
    /clear
        Clear the current buffer.
mathieui's avatar
mathieui committed
287

mathieui's avatar
mathieui committed
288
289
.. _muctab-commands:

mathieui's avatar
mathieui committed
290
291
292
MultiUserChat tab commands
~~~~~~~~~~~~~~~~~~~~~~~~~~

293
294
295
.. glossary::
    :sorted:

296
297
298
299
300
    /clear [RosterTab version]
        **Usage:** ``/clear``

        Clear the information buffer. (was /clear_infos)

301
302
303
304
305
    /ignore
        **Usage:** ``/ignore <nickname>``

        Ignore a specified nickname.

306
307
308
309
310
311
312
    /invite [MUCTab version]
        **Usage:** ``/invite <jid> [reason]``

        Invite *jid* to this room with *reason* (if
        provided).


313
314
315
316
317
318
319
    /unignore
        **Usage:** ``/unignore <nickname>``

        Remove the specified nickname from the ignore list.

    /kick
        **Usage:** ``/kick <nick> [reason]``
mathieui's avatar
mathieui committed
320

321
322
        Kick the user with the specified nickname. You can
        also give an optional reason.
mathieui's avatar
mathieui committed
323

324
325
    /topic
        **Usage:** ``/topic <subject>``
mathieui's avatar
mathieui committed
326

327
328
        Change the subject of the room. You might want to knwow
        that entering ``/topic [tab]`` will autocomplete the topic.
mathieui's avatar
mathieui committed
329

330
331
    /query
        **Usage:** ``/query <nick> [message]``
mathieui's avatar
mathieui committed
332

mathieui's avatar
mathieui committed
333
        Open a :ref:`privatetab` with <nick>. This nick
334
335
        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.
mathieui's avatar
mathieui committed
336

337
338
    /part
        **Usage:** ``/part [message]``
mathieui's avatar
mathieui committed
339

340
341
        Disconnect you from a room. You can specify an optional
        message.
mathieui's avatar
mathieui committed
342

343
344
    /nick
        **Usage:** ``/nick <nickname>``
mathieui's avatar
mathieui committed
345

346
347
348
        Change your nickname in the current room.
        **Except for gmail users** because gmail.com sucks and will do weird things
        if you change your nickname in a MUC.
mathieui's avatar
mathieui committed
349

350
351
    /recolor
        **Usage:** ``/recolor [random]``
mathieui's avatar
mathieui committed
352

353
354
355
356
        Re-assign a color to all the participants in the current
        room, based on the last time they talked. Use this if the participants
        currently talking have too many identical colors. If a random argument is
        given, the participants will be shuffled before they are assigned a color.
mathieui's avatar
mathieui committed
357

358
359
    /cycle
        **Usage:** ``/cycle [message]``
mathieui's avatar
mathieui committed
360

361
362
363
364
365
366
367
368
369
        Leave the current room an rejoint it immediatly. You can
        specify an optional quit message.

    /info
        **Usage:** ``/info <nickname>``

        Display some information about the user in the room:
        his/her role, affiliation, status, and status message.

mathieui's avatar
mathieui committed
370
    /version
371
372
373
374
375
376
        **Usage:** ``/version <nickname or jid>``

        Get the software version of the given nick in
        room or the given jid (usually its XMPP client and Operating System).

    /configure
mathieui's avatar
mathieui committed
377
        Configure the current room through a form (Open a :ref:`dataformtab`).
378
379
380
381

    /names
        Get the list of the users in the room, their number, and the list
        of the people assuming different roles.
mathieui's avatar
mathieui committed
382

mathieui's avatar
mathieui committed
383
384
.. _privatetab-commands:

mathieui's avatar
mathieui committed
385
386
387
Private tab commands
~~~~~~~~~~~~~~~~~~~~

388
389
390
.. glossary::
    :sorted:

mathieui's avatar
mathieui committed
391
    /info
392
        Display some info about this user in the MultiUserChat.
mathieui's avatar
mathieui committed
393

mathieui's avatar
mathieui committed
394
    /unquery
395
        Close the tab.
mathieui's avatar
mathieui committed
396

mathieui's avatar
mathieui committed
397
    /version
398
399
        Get the software version of the current interlocutor (usually its
        XMPP client and Operating System).
mathieui's avatar
mathieui committed
400

mathieui's avatar
mathieui committed
401
402
.. _conversationtab-commands:

mathieui's avatar
mathieui committed
403
404
405
Normal Conversation tab commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

406
407
408
.. glossary::
    :sorted:

mathieui's avatar
mathieui committed
409
    /info
410
        Display the status of this contact.
mathieui's avatar
mathieui committed
411

mathieui's avatar
mathieui committed
412
    /unquery
413
        Close the tab.
mathieui's avatar
mathieui committed
414

mathieui's avatar
mathieui committed
415
    /version
416
417
        Get the software version of the current interlocutor (usually its
        XMPP client and Operating System).
mathieui's avatar
mathieui committed
418

mathieui's avatar
mathieui committed
419
420
.. _rostertab-commands:

mathieui's avatar
mathieui committed
421
422
Roster tab commands
~~~~~~~~~~~~~~~~~~~
423
424
425
426
427
428
429
430
.. glossary::
    :sorted:

    /accept
        **Usage:** ``/accept [jid]``

        Authorize the provided JID (or the selected contact in the
        roster) to see your presence.
mathieui's avatar
mathieui committed
431

432
433
    /deny
        **Usage:** ``/deny [jid]``
mathieui's avatar
mathieui committed
434

435
436
        Prevent the provided JID (or the selected contact in the
        roster) from seeing your presence.
mathieui's avatar
mathieui committed
437

438
439
    /add
        **Usage:** ``/add <jid>``
mathieui's avatar
mathieui committed
440

441
442
443
        Add the specified JID to your roster and authorize him to see
        your presence. If he accepts you, the subscription will be mutual (and if he
        doesn’t, you can still /remove him).
mathieui's avatar
mathieui committed
444

445
446
    /name
        **Usage:** ``/name <jid> <name>``
mathieui's avatar
mathieui committed
447

448
        Set the given JID’s name in your roster.
mathieui's avatar
mathieui committed
449

450
451
452
453
454
    /password
        **Usage:** ``/password <password>``

        Change your password.

455
456
    /groupadd
        **Usage:** ``/groupadd <jid> <group>``
mathieui's avatar
mathieui committed
457

458
459
        Add the given JID to the given group (if the group
        does not exist, it will be created).
mathieui's avatar
mathieui committed
460

461
462
    /groupmove
        **Usage:** ``/groupmove <jid> <old_group> <new_group>``
mathieui's avatar
mathieui committed
463

464
465
466
        Move the given JID from one group
        to another (the JID has to be in the first group, and the new group  may not
        exist).
mathieui's avatar
mathieui committed
467

468
469
    /groupremove
        **Usage:** ``/groupremove <jid> <group>``
mathieui's avatar
mathieui committed
470

471
472
        Remove the given JID from the given group (if
        the group is empty after that, it will get deleted).
mathieui's avatar
mathieui committed
473

474
475
    /remove
        **Usage:** ``/remove [jid]``
mathieui's avatar
mathieui committed
476

477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
        Remove the specified JID from your roster. This will
        unsubscribe you from its presence, cancel its subscription to yours, and
        remove the item from your roster.

    /reconnect

        Disconnect from the remote server (if connected) and then
        connect to it again.

.. note:: The following commands only exist if your server supports them. If it
            does not, you will be notified when you start poezio.

.. glossary::
    :sorted:

    /block
        **Usage:** ``/block [jid]``

        Block 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.

    /unblock
        **Usage:** ``/unblock [jid]``

        Unblock a previously blocked JID using simple blocking. You
        will be able to send and receive messages from him again.

    /list_blocks
        List the blocked JIDs.

.. note:: The following commands do not comply with any XEP or whatever, but they
mathieui's avatar
mathieui committed
508
509
 can still prove useful when you are migrating to an other JID.

510
511
512
513
514
.. glossary::
    :sorted:

    /export
        **Usage:** ``/export [/path/to/file]``
mathieui's avatar
mathieui committed
515

mathieui's avatar
mathieui committed
516
517
        Export your contacts into :file:`/path/to/file` if
        specified, or :file:`$HOME/poezio_contacts` if not.
518
519
520
521

    /import
        **Usage:** ``/import [/path/to/file]``

mathieui's avatar
mathieui committed
522
523
524
525
        Import your contacts from :file:`/path/to/file` if
        specified, or :file:`$HOME/poezio_contacts` if not.

.. _xmltab-commands:
mathieui's avatar
mathieui committed
526
527
528
529

XML tab commands
~~~~~~~~~~~~~~~~

530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
.. glossary::

    /clear [XML tab version]
        Clear the current buffer.

    /reset
        Reset the stanza filter.

    /filter_id
        **Usage:** ``/filter_id <id>``

        Filter by stanza id attribute.

    /filter_xpath
        **Usage:** ``/filter_xpath <xpath>``

        Filter with an XPath selector.

    /filter_xmlmask
        **Usage:** ``/filter_xmlmask <xml mask>``

        Filter using an XML mask