about summary refs log tree commit diff stats
path: root/docs/profanity-rooms.1
blob: 67506c08b2f0f996bd4e421f289c30d1bd7319e3 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
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
.TH man 1 "2022-04-04" "0.12.0" "Profanity XMPP client"

.SH NAME
/rooms

.SH DESCRIPTION
List the chat rooms available at the specified conference service. If no argument is supplied, the account preference 'muc.service' is used, 'conference.<domain-part>' by default. The filter argument only shows rooms that contain the provided text, case insensitive.

.SH SYNOPSIS
/rooms

.LP
/rooms filter <text>

.LP
/rooms service <service>

.LP
/rooms service <service> filter <text>

.LP
/rooms cache on|off|clear

.LP

.SH ARGUMENTS
.PP
\fBservice <service>\fR
.RS 4
The conference service to query.
.RE
.PP
\fBfilter <text>\fR
.RS 4
The text to filter results by.
.RE
.PP
\fBcache on|off\fR
.RS 4
Enable or disable caching of rooms list response, enabled by default.
.RE
.PP
\fBcache clear\fR
.RS 4
Clear the rooms response cache if enabled.
.RE

.SH EXAMPLES
/rooms

.LP
/rooms filter development

.LP
/rooms service conference.jabber.org

.LP
/rooms service conference.jabber.org filter "News Room"

.LP