1man(1)                       Profanity XMPP client                      man(1)
2
3
4

NAME

6       /roster
7
8

DESCRIPTION

10       Manage  your  roster, and roster display settings. Passing no arguments
11       lists all contacts in your roster.
12
13

SYNOPSIS

15       /roster
16
17
18       /roster online
19
20
21       /roster   show    [offline|resource|presence|status|empty|priority|con‐
22       tacts|rooms]
23
24
25       /roster    hide   [offline|resource|presence|status|empty|priority|con‐
26       tacts|rooms]
27
28
29       /roster by group|presence|none
30
31
32       /roster count unread|items|off
33
34
35       /roster count zero on|off
36
37
38       /roster color on|off
39
40
41       /roster order name|presence
42
43
44       /roster unread before|after|off
45
46
47       /roster room char <char>|none
48
49
50       /roster room private char <char>|none
51
52
53       /roster room position first|last
54
55
56       /roster room by service|none
57
58
59       /roster room order name|unread
60
61
62       /roster room unread before|after|off
63
64
65       /roster room show server
66
67
68       /roster room hide server
69
70
71       /roster room use name|jid
72
73
74       /roster private room|group|off
75
76
77       /roster private char <char>|none
78
79
80       /roster header char <char>|none
81
82
83       /roster presence indent <indent>
84
85
86       /roster contact char <char>|none
87
88
89       /roster contact indent <indent>
90
91
92       /roster resource char <char>|none
93
94
95       /roster resource indent <indent>
96
97
98       /roster resource join on|off
99
100
101       /roster size <percent>
102
103
104       /roster wrap on|off
105
106
107       /roster add <jid> [<nick>]
108
109
110       /roster remove <contact>
111
112
113       /roster remove_all contacts
114
115
116       /roster nick <jid> <nick>
117
118
119       /roster clearnick <jid>
120
121
122       /roster group
123
124
125       /roster group show <group>
126
127
128       /roster group add <group> <contat>
129
130
131       /roster group remove <group> <contact>
132
133

ARGUMENTS

135       online
136           Show all online contacts in console.
137
138       show
139           Show the roster panel.
140
141       show offline
142           Show offline contacts in roster panel.
143
144       show resource
145           Show contact's connected resources in roster panel.
146
147       show presence
148           Show contact's presence in roster panel.
149
150       show status
151           Show contact's status message in roster panel.
152
153       show empty
154           Show empty groups in roster panel.
155
156       show priority
157           Show resource priority in roster panel.
158
159       show contacts
160           Show contacts in roster panel.
161
162       show rooms
163           Show chat rooms in roster panel.
164
165       hide
166           Hide the roster panel.
167
168       hide offline
169           Hide offline contacts in roster panel.
170
171       hide resource
172           Hide contact's connected resources in roster panel.
173
174       hide presence
175           Hide contact's presence in roster panel.
176
177       hide status
178           Hide contact's status message in roster panel.
179
180       hide empty
181           Hide empty groups in roster panel.
182
183       hide priority
184           Hide resource priority in roster panel.
185
186       hide contacts
187           Hide contacts in roster panel.
188
189       hide rooms
190           Hide chat rooms in roster panel.
191
192       by group
193           Group contacts in roster panel by roster group.
194
195       by presence
196           Group contacts in roster panel by presence.
197
198       by none
199           No grouping in roster panel.
200
201       count unread
202           Show unread message count with roster headers.
203
204       count items
205           Show item count with roster headers.
206
207       count off
208           Do not show any count with roster headers.
209
210       count zero on
211           Show roster header count when 0.
212
213       count zero off
214           Hide roster header count when 0.
215
216       color on
217           Enable generated color names (XEP-0392)
218
219       color off
220           Disable generated color names (XEP-0392)
221
222       order name
223           Order roster contacts by name only.
224
225       order presence
226           Order roster contacts by presence, and then by name.
227
228       unread before
229           Show unread message count before contact.
230
231       unread after
232           Show unread message count after contact.
233
234       unread off
235           Do not show unread message count for contacts.
236
237       room char <char>
238           Prefix rooms with specified character.
239
240       room char none
241           Remove room character prefix.
242
243       room private char <char>
244           Prefix private room chat with specified  character  when  displayed
245           with room.
246
247       room private char none
248           Remove private room chat character prefix when displayed with room.
249
250       room position first
251           Show rooms first in roster.
252
253       room position last
254           Show rooms last in roster.
255
256       room by service
257           Group rooms by chat service.
258
259       room by none
260           Do not group rooms.
261
262       room order name
263           Order rooms by name.
264
265       room order unread
266           Order rooms by unread messages, and then by name.
267
268       room unread before
269           Show unread message count before room.
270
271       room unread after
272           Show unread message count after room.
273
274       room unread off
275           Do not show unread message count for rooms.
276
277       room show server
278           Show the conference server with room JIDs.
279
280       room hide server
281           Do not show the conference server with room JIDs.
282
283       room use name
284           Use the MUC name as room name.
285
286       room use jid
287           Use the JID as room name.
288
289       private room
290           Show room private chats with the room.
291
292       private group
293           Show room private chats as a separate roster group.
294
295       private off
296           Do not show room private chats.
297
298       private char <char>
299           Prefix  private  room chats with specified character when displayed
300           in separate group.
301
302       private char none
303           Remove private room chat character prefix.
304
305       header char <char>
306           Prefix roster headers with specified character.
307
308       header char none
309           Remove roster header character prefix.
310
311       contact char <char>
312           Prefix roster contacts with specified character.
313
314       contact char none
315           Remove roster contact character prefix.
316
317       contact indent <indent>
318           Indent contact line by <indent> spaces (0 to 10).
319
320       resource char <char>
321           Prefix roster resources with specified character.
322
323       resource char none
324           Remove roster resource character prefix.
325
326       resource indent <indent>
327           Indent resource line by <indent> spaces (0 to 10).
328
329       resource join on|off
330           Join resource with previous line when only one available resource.
331
332       presence indent <indent>
333           Indent presence line by <indent> spaces (-1 to 10), a value  of  -1
334           will show presence on the previous line.
335
336       size <percent>
337           Percentage of the screen taken up by the roster (1-99).
338
339       wrap on|off
340           Enable or disable line wrapping in roster panel.
341
342       add <jid> [<nick>]
343           Add a new item to the roster.
344
345       remove <jid>
346           Removes an item from the roster.
347
348       remove_all contacts
349           Remove all items from roster.
350
351       nick <jid> <nick>
352           Change a contacts nickname.
353
354       clearnick <jid>
355           Removes the current nickname.
356
357       group show <group>
358           List all roster items in a group.
359
360       group add <group> <contact>
361           Add a contact to a group.
362
363       group remove <group> <contact>
364           Remove a contact from a group.
365
366

EXAMPLES

368       /roster
369
370
371       /roster add odin@valhalla.edda
372
373
374       /roster add odin@valhalla.edda Allfather
375
376
377       /roster remove loki@ownserver.org
378
379
380       /roster nick odin@valhalla.edda "All Father"
381
382
383       /roster clearnick thor@valhalla.edda
384
385
386       /roster size 15
387
388
389       /roster group
390
391
392       /roster group show friends
393
394
395       /roster group add friends fenris@ownserver.org
396
397
398       /roster group add family Brother
399
400
401       /roster group remove colleagues boss@work.com
402
403
4040.13.1                            2023-08-03                            man(1)
Impressum