~ubuntu-branches/ubuntu/wily/irssi-plugin-xmpp/wily

« back to all changes in this revision

Viewing changes to .pc/strip_resource_08082009.patch/docs/GENERAL

  • Committer: Package Import Robot
  • Author(s): Florian Schlichting
  • Date: 2015-03-27 21:44:52 UTC
  • Revision ID: package-import@ubuntu.com-20150327214452-fia86qdiv03fwee7
Tags: 0.52+git20140102-3
* Update XMPP-PGP support (closes: #779156)
* Add strip_resource_08082009.patch to optionally ignore random resource
  strings
* Bump Standards-Version to 3.9.6 (no changes necessary)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
General commands:
 
2
=================
 
3
 
 
4
These commands are the general commands for a basic usage of irssi-xmpp.
 
5
 
 
6
You may notice that some commands accept as parameter a JID, a full JID
 
7
(a JID with a resource) or a name. If you specify a name, it will be
 
8
resolved through the roster. But if the name cannot be found in your
 
9
roster, irssi-xmpp will assume that the name is a JID.
 
10
 
 
11
Some commands require a full JID, but if you type only a JID or a name,
 
12
these commands will automatically use the highest resource for this
 
13
contact in your roster.
 
14
 
 
15
/QUERY <jid>[/<resource>]
 
16
/QUERY <name>
 
17
    Starts a private conversation with the JID. If the user is online and 
 
18
    the resource isn't specified, the conversation window will be on the
 
19
    resource with the highest priority.
 
20
 
 
21
/MSG <jid>[/<resource>] <message>
 
22
    Sends a message to a jid. There is no name resolution through the roster so
 
23
    the jid must be valid. (Prefer /QUERY if you want a normal discussion in
 
24
    a query window.)
 
25
 
 
26
/ME <message>
 
27
    Sends an "ACTION", useable in a query or in a room.
 
28
 
 
29
/AWAY [away|chat|dnd|xa] <reason>
 
30
    This command marks you as being "away". If the away mode isn't specified,
 
31
    the "xmpp_default_away_mode" setting will be used. You can remove your away
 
32
    status by using AWAY with no arguments.
 
33
 
 
34
/ROSTER
 
35
    Shows your contacts in a list.
 
36
 
 
37
/ROSTER FULL
 
38
    Shows all your contacts in a list, even those who are offline.
 
39
 
 
40
/ROSTER ADD [-nosub] <jid>
 
41
    Adds a JID to your contact list. (Use the parameter "-nosub" if you
 
42
    don't want to send a subscribe request.)
 
43
 
 
44
/ROSTER REMOVE <jid>
 
45
    Removes a JID from your contact list. The subscriptions will be removed too.
 
46
 
 
47
/ROSTER NAME <jid> <name>
 
48
    Changes the name (or nickname) of a JID.
 
49
 
 
50
/ROSTER GROUP <jid> <group>
 
51
    Changes the group of a JID.
 
52
 
 
53
/WHOIS <jid>
 
54
/WHOIS <name>
 
55
    Requests the vcard related to the JID.
 
56
 
 
57
/VER <jid>/<resource>
 
58
/VER <name>
 
59
    Requests the software version of the resource.
 
60
 
 
61
/QUOTE <data>
 
62
    Sends server raw data without parsing. You need to make sure the value is
 
63
    XML valid.
 
64
 
 
65
/XMPPCONNECT [-ssl] [-host <host>] [-port <port>]
 
66
             <jid>[/<resource>] <password>
 
67
/XMPPSERVER [-ssl] [-host <host>] [-port <port>]
 
68
            <jid>[/<resource>] <password>
 
69
    See the "Connection" section of the STARTUP file.
 
70
 
 
71
Subscription commands:
 
72
======================
 
73
 
 
74
These commands are useful if you want to manage the subscription of your
 
75
contacts.
 
76
 
 
77
/PRESENCE ACCEPT <jid>
 
78
    Accepts a subscription request, so the contact will be able to see your
 
79
    presence.
 
80
 
 
81
/PRESENCE DENY <jid>
 
82
    Denies a subscription, so the contact won't see your presence anymore.
 
83
 
 
84
/PRESENCE SUBSCRIBE <jid> <reason>
 
85
    Sends a subscription request to a JID. If the contact accepts your request,
 
86
    you'll be able to see his/her presence.
 
87
 
 
88
/PRESENCE UNSUBSCRIBE <jid>
 
89
    Unsubscribes to the contact's presence, so you won't see his/her presence
 
90
    anymore.
 
91
 
 
92
Subscription status:
 
93
====================
 
94
 
 
95
These are the subscription status displayed in the roster list with their
 
96
description:
 
97
 
 
98
both: The contact and you can see each other's presence. (not displayed)
 
99
from: The contact can see your presence.  
 
100
to: You can see the contact's presence.
 
101
none: The contact and you cannot see each other's presence.
 
102
 
 
103
Settings:
 
104
=========
 
105
 
 
106
In "xmpp" section:
 
107
 
 
108
/SET xmpp_priority <number>
 
109
    Sets the priority of your connection. It's a number between -128 and 127.
 
110
    Priority changes will take effect immediatly for all your connected
 
111
    accounts. (default: 0)
 
112
 
 
113
/SET xmpp_priority_away <number>
 
114
    Sets the priority of your connection when your are away. (default: -1)
 
115
 
 
116
/SET xmpp_send_version ON/OFF
 
117
    Sends information about your client: name (irssi-xmpp), version and operating
 
118
    system. (default: ON)
 
119
 
 
120
/SET xmpp_default_away_mode {away|chat|dnd|xa}
 
121
    Sets the default away mode when you just type "/AWAY <message>".
 
122
    (default: away)
 
123
 
 
124
/SET xmpp_send_composing ON/OFF
 
125
    Enables or disables the sending of your chat state notifications.
 
126
    (default: ON)
 
127
 
 
128
In "xmpp_lookandfeel" section:
 
129
 
 
130
/SET xmpp_set_nick_as_username ON/OFF
 
131
    Sets whether your JID's username should be used as nick in query
 
132
    windows. If this setting is OFF, your nick will be your JID. If it's
 
133
    ON, your nick will be the username of your JID. (default: OFF)
 
134
 
 
135
/SET xmpp_status_window ON/OFF
 
136
    Creates a new window that displays every status change of your contacts.
 
137
    (default: OFF)
 
138
 
 
139
/SET xmpp_timestamp_format <format>
 
140
    Sets the timestamp format that should be used to display the delayed
 
141
    messages. (default: %Y-%m-%d %H:%M)
 
142
 
 
143
/SET xmpp_history_maxstanzas <number>
 
144
    Sets the maximum number of messages that should be retrieved from the
 
145
    archives when joining a room.
 
146
    (default: 30)
 
147
 
 
148
/SET xmpp_xml_console ON/OFF
 
149
    Creates a new window where the raw XML messages are displayed. Useful for
 
150
    debugging. (default: OFF)
 
151
 
 
152
In "xmpp_proxy" section:
 
153
 
 
154
    See the "Proxy usage" section of this file.
 
155
 
 
156
In "xmpp_roster" section:
 
157
 
 
158
/SET xmpp_roster_show_offline ON/OFF
 
159
    Shows offline contacts in the roster. (default: ON)
 
160
 
 
161
/SET xmpp_roster_show_unsubscribed ON/OFF
 
162
    Shows unsubscribed contacts in the roster when they are offline.
 
163
    (default: ON)
 
164
 
 
165
/SET xmpp_roster_default_group <group>
 
166
    Sets the default group where the contacts will be displayed if the group name
 
167
    is unspecified. (default: General)
 
168
 
 
169
/SET xmpp_roster_service_name <group>
 
170
    Sets the default group where the services and the transports will be
 
171
    displayed. (default: Agents/Transports)
 
172
    (Not used yet!)
 
173
 
 
174
Away status:
 
175
===========
 
176
 
 
177
In this section you can find the descriptions of each away status available
 
178
in jabber:
 
179
 
 
180
away: Away
 
181
chat: Free for chat
 
182
dnd: Do not disturb
 
183
xa: Not available
 
184
 
 
185
Proxy usage:
 
186
============
 
187
 
 
188
To connect to an account through a proxy, you must set these settings
 
189
according to your proxy configuration. Please note that these settings
 
190
are general so they affect all the jabber accounts you configured in
 
191
irssi.
 
192
 
 
193
/SET xmpp_use_proxy ON/OFF
 
194
    Enables or disables the proxy. (default: OFF)
 
195
 
 
196
/SET xmpp_proxy_address <host>
 
197
/SET xmpp_proxy_port <port>
 
198
/SET xmpp_proxy_user <user>
 
199
/SET xmpp_proxy_password <password>
 
200
    Sets the connection parameters to connect to the proxy.
 
201
 
 
202
/SET xmpp_proxy_type <type>
 
203
    Sets the type of the proxy. Currently, irssi-xmpp only supports the HTTP
 
204
    method. (default: http)
 
205
 
 
206
Composing in the statusbar:
 
207
===========================
 
208
 
 
209
irssi-xmpp supports the XEP-0085: Chat State Notifications, so you can see when
 
210
your contacts are typing a messages with "composing" appearing in the statusbar.
 
211
To add this statusbar element, you can use this command :
 
212
 
 
213
/STATUSBAR WINDOW ADD xmpp_composing
 
214
 
 
215
Or for example:
 
216
 
 
217
/STATUSBAR WINDOW ADD -before barend -alignment right xmpp_composing