mcabber/doc/help/en/hlp_room.txt
author Mikael Berthe <mikael@lilotux.net>
Sat, 17 Sep 2016 10:02:56 +0200
changeset 2270 5d05e8128ef4
parent 2139 5afdfac67964
permissions -rw-r--r--
Use nick to set the role This should fix issue #152, reported by Stefan Haller.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
904
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     1
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     2
 /ROOM join|leave|names|nick|remove|topic|unlock|destroy
1532
eebeb4171232 Update documentation (help files)
Mikael Berthe <mikael@lilotux.net>
parents: 1377
diff changeset
     3
 /ROOM privmsg|invite|whois|kick|ban|unban|role|affil
1979
6febc7d1f760 Add /room setopt flag_joins (Hermitifier)
Mikael Berthe <mikael@lilotux.net>
parents: 1603
diff changeset
     4
 /ROOM setopt print_status|auto_whois|flag_joins [value]
2139
5afdfac67964 Update room bookmark help files
Mikael Berthe <mikael@lilotux.net>
parents: 2130
diff changeset
     5
 /ROOM bookmark [add|del] [-autojoin|+autojoin] [-|nick] [password]
904
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     6
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     7
The 'room' command handles Multi-User Chat room actions.
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     8
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     9
/room join [room [nick [pass]]]
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    10
 Join "room", using "nick" as nickname.  If no nickname is provided (or if it is an empty string), the "nickname" option value is used (see sample configuration file).  If the currently selected entry is correctly recognized as a room by mcabber, the shortcut "." can be used instead of the full room id.  A password can be provided to enter protected rooms.  If your nickname contains space characters, use quotes.
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    11
/room leave [message]
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    12
 Leave the current room
1587
0a1f59dc503d /room names --compact
sh!zeeg <shizeeg@yandex.ru>
parents: 1534
diff changeset
    13
/room names [--detail|--short|--quiet|--compact]
904
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    14
 Display members of the current room
915
59b53fed6de1 Update help files
Mikael Berthe <mikael@lilotux.net>
parents: 904
diff changeset
    15
/room nick newnick
904
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    16
 Change your nickname in the current room
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    17
/room privmsg nick msg
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    18
 Send private message "msg" to "nick"
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    19
/room remove
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    20
 Remove the current room from the roster (you must have left this room before)
2130
da426904eeda Add a mention about the room topic -u switch to the help files
Mikael Berthe <mikael@lilotux.net>
parents: 1979
diff changeset
    21
/room topic [-u] -|newtopic
904
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    22
 Set topic for current room
2130
da426904eeda Add a mention about the room topic -u switch to the help files
Mikael Berthe <mikael@lilotux.net>
parents: 1979
diff changeset
    23
 When the option -u (unescape) is used, a string '\n' is expanded and sent as an actual newline character, and '\t' is expanded to a real tabulation.
1534
0650ffc8cbbd Update FR help files (and a few EN files)
Mikael Berthe <mikael@lilotux.net>
parents: 1532
diff changeset
    24
 (The topic is cleared if newtopic is "-")
904
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    25
/room unlock
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    26
 Unlock current room (if you are the owner)
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    27
/room destroy [reason]
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    28
 Destroy the current room (use with care!)
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    29
/room whois nick
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    30
 Display MUC information about "nick"
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    31
/room ban jid [reason]
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    32
 Ban jid from the current room
1260
b4ccc5b2a6de Add command /room unban
Mikael Berthe <mikael@lilotux.net>
parents: 1163
diff changeset
    33
/room unban jid
b4ccc5b2a6de Add command /room unban
Mikael Berthe <mikael@lilotux.net>
parents: 1163
diff changeset
    34
 Unban jid from the current room
904
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    35
/room invite jid [reason]
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    36
 Invite jid to the current room
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    37
/room kick nick [reason]
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    38
 Kick "nick" from the current room
2270
5d05e8128ef4 Use nick to set the role
Mikael Berthe <mikael@lilotux.net>
parents: 2139
diff changeset
    39
/room role nick role [reason]
5d05e8128ef4 Use nick to set the role
Mikael Berthe <mikael@lilotux.net>
parents: 2139
diff changeset
    40
 Change nick's role (role can be "none", "visitor", "participant", "moderator")
904
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    41
/room affil jid affil [reason]
9d11c1b1af7a English help files
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    42
 Change jid's affiliation (affil can be "none", "member", "admin", "owner")
1979
6febc7d1f760 Add /room setopt flag_joins (Hermitifier)
Mikael Berthe <mikael@lilotux.net>
parents: 1603
diff changeset
    43
/room setopt print_status|auto_whois|flag_joins [value]
1377
cd9182f0b5c7 Add /room setopt {print_status,auto_whois}
Mikael Berthe <mikael@lilotux.net>
parents: 1341
diff changeset
    44
 Change settings for the current room
cd9182f0b5c7 Add /room setopt {print_status,auto_whois}
Mikael Berthe <mikael@lilotux.net>
parents: 1341
diff changeset
    45
 For print_status, the possible values are "default", "none", "in_and_out", "all".
cd9182f0b5c7 Add /room setopt {print_status,auto_whois}
Mikael Berthe <mikael@lilotux.net>
parents: 1341
diff changeset
    46
 For auto_whois, the possible values are "default", "off", "on".
1979
6febc7d1f760 Add /room setopt flag_joins (Hermitifier)
Mikael Berthe <mikael@lilotux.net>
parents: 1603
diff changeset
    47
 For flag_joins, the possible values are "default", "none", "joins", "all".
6febc7d1f760 Add /room setopt flag_joins (Hermitifier)
Mikael Berthe <mikael@lilotux.net>
parents: 1603
diff changeset
    48
 When the value is "default", the options muc_print_status / muc_auto_whois / muc_flag_joins is used.
2139
5afdfac67964 Update room bookmark help files
Mikael Berthe <mikael@lilotux.net>
parents: 2130
diff changeset
    49
/room bookmark [add|del] [-autojoin|+autojoin] [-|nick] [password]
5afdfac67964 Update room bookmark help files
Mikael Berthe <mikael@lilotux.net>
parents: 2130
diff changeset
    50
 Add, remove or update a bookmark (default is add) and optionally store a password for entering the MUC.
1603
54029aba9452 Allow specifying nickname for bookmark
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1587
diff changeset
    51
/room bookmark [add|del] [-autojoin|+autojoin] [-|nick]
1062
9207f2efb921 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 915
diff changeset
    52
 If autojoin is set, mcabber will automatically join the MUC room when it connects to the server.
1163
2913310a7be6 Make /roster bookmark in the status buffer show all bookmarks
Mikael Berthe <mikael@lilotux.net>
parents: 1162
diff changeset
    53
 To see the list of bookmarks, use /room bookmark in the status buffer.