about summary refs log tree commit diff stats
path: root/docs/profanity-notify.1
blob: 85d2d4a8f1b934b1a2919d3dc89156f8226f45bb (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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
.TH man 1 "2022-10-12" "0.13.0" "Profanity XMPP client"

.SH NAME
/notify

.SH DESCRIPTION
Configure desktop notifications. To configure presence update messages in the console, chat and chat room windows, see '/help presence'.

.SH SYNOPSIS
/notify chat on|off

.LP
/notify chat current on|off

.LP
/notify chat text on|off

.LP
/notify room on|off

.LP
/notify room mention on|off

.LP
/notify room mention case_sensitive|case_insensitive

.LP
/notify room mention word_whole|word_part

.LP
/notify room offline on|off

.LP
/notify room current on|off

.LP
/notify room text on|off

.LP
/notify room trigger add <text>

.LP
/notify room trigger remove <text>

.LP
/notify room trigger list

.LP
/notify room trigger on|off

.LP
/notify on|off

.LP
/notify mention on|off

.LP
/notify trigger on|off

.LP
/notify reset

.LP
/notify remind <seconds>

.LP
/notify typing on|off

.LP
/notify typing current on|off

.LP
/notify invite on|off

.LP
/notify sub on|off

.LP

.SH ARGUMENTS
.PP
\fBchat on|off\fR
.RS 4
Notifications for regular chat messages.
.RE
.PP
\fBchat current on|off\fR
.RS 4
Whether to show regular chat message notifications when the window is focused.
.RE
.PP
\fBchat text on|off\fR
.RS 4
Show message text in regular message notifications.
.RE
.PP
\fBroom on|off\fR
.RS 4
Notifications for all chat room messages.
.RE
.PP
\fBroom mention on|off\fR
.RS 4
Notifications for chat room messages when your nick is mentioned.
.RE
.PP
\fBroom mention case_sensitive\fR
.RS 4
Set room mention notifications as case sensitive.
.RE
.PP
\fBroom mention case_insensitive\fR
.RS 4
Set room mention notifications as case insensitive.
.RE
.PP
\fBroom mention word_whole\fR
.RS 4
Set room mention notifications only on whole word match, i.e. when nickname is not part of a larger word.
.RE
.PP
\fBroom mention word_part\fR
.RS 4
Set room mention notifications on partial word match, i.e. nickname may be part of a larger word.
.RE
.PP
\fBroom offline on|off\fR
.RS 4
Notifications for chat room messages that were sent while you were offline.
.RE
.PP
\fBroom current on|off\fR
.RS 4
Whether to show all chat room messages notifications when the window is focused.
.RE
.PP
\fBroom text on|off\fR
.RS 4
Show message text in chat room message notifications.
.RE
.PP
\fBroom trigger add <text>\fR
.RS 4
Notify when specified text included in all chat room messages.
.RE
.PP
\fBroom trigger remove <text>\fR
.RS 4
Remove chat room notification trigger.
.RE
.PP
\fBroom trigger list\fR
.RS 4
List all chat room highlight triggers.
.RE
.PP
\fBroom trigger on|off\fR
.RS 4
Enable or disable all chat room notification triggers.
.RE
.PP
\fBon|off\fR
.RS 4
Override the global message setting for the current chat room.
.RE
.PP
\fBmention on|off\fR
.RS 4
Override the global 'mention' setting for the current chat room.
.RE
.PP
\fBtrigger on|off\fR
.RS 4
Override the global 'trigger' setting for the current chat room.
.RE
.PP
\fBreset\fR
.RS 4
Reset to global notification settings for the current chat room.
.RE
.PP
\fBremind <seconds>\fR
.RS 4
Notification reminder period for unread messages, use 0 to disable.
.RE
.PP
\fBtyping on|off\fR
.RS 4
Notifications when contacts are typing.
.RE
.PP
\fBtyping current on|off\fR
.RS 4
Whether typing notifications are triggered for the current window.
.RE
.PP
\fBinvite on|off\fR
.RS 4
Notifications for chat room invites.
.RE
.PP
\fBsub on|off\fR
.RS 4
Notifications for subscription requests.
.RE

.SH EXAMPLES
/notify chat on

.LP
/notify chat text on

.LP
/notify room mention on

.LP
/notify room offline on

.LP
/notify room trigger add beer

.LP
/notify room trigger on

.LP
/notify room current off

.LP
/notify room text off

.LP
/notify remind 60

.LP
/notify typing on

.LP
/notify invite on

.LP