File: profanity-bookmark.1

package info (click to toggle)
profanity 0.16.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,044 kB
  • sloc: ansic: 78,684; makefile: 552; python: 212; sh: 179
file content (124 lines) | stat: -rw-r--r-- 2,262 bytes parent folder | download
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
.TH man 1 "2026-02-23" "0.16.0" "Profanity XMPP client"

.SH NAME
/bookmark

.SH DESCRIPTION
Manage bookmarks and join bookmarked rooms. If you are in a chat room and no arguments are supplied to `/bookmark add`, autojoin is set to "on". There is also an autojoin ignore list in case you want to autojoin in many clients but not on Profanity. 

.SH SYNOPSIS
/bookmark

.LP
/bookmark list [<jid>]

.LP
/bookmark add [<room>] [nick <nick>] [password <password>] [name <roomname>] [autojoin on|off]

.LP
/bookmark update <room> [nick <nick>] [password <password>] [name <roomname>] [autojoin on|off]

.LP
/bookmark remove [<room>]

.LP
/bookmark join <room>

.LP
/bookmark invites on|off

.LP
/bookmark ignore

.LP
/bookmark ignore add <jid>

.LP
/bookmark ignore remove <jid>

.LP

.SH ARGUMENTS
.PP
\fBlist [<jid>]\fR
.RS 4
List all bookmarks. Or the details of one.
.RE
.PP
\fBadd [<room>]\fR
.RS 4
Add a bookmark, passing no room will bookmark the current room, setting autojoin to "on".
.RE
.PP
\fBremove [<room>]\fR
.RS 4
Remove a bookmark, passing no room will remove the bookmark for the current room, if one exists.
.RE
.PP
\fBupdate <room>\fR
.RS 4
Update the properties associated with a bookmark.
.RE
.PP
\fBnick <nick>\fR
.RS 4
Nickname used when joining the chat room.
.RE
.PP
\fBpassword <password>\fR
.RS 4
Password if required, may be stored in plaintext on your server.
.RE
.PP
\fBname <roomname>\fR
.RS 4
Optional name for the bookmark. By default localpart of the JID will be used.
.RE
.PP
\fBautojoin on|off\fR
.RS 4
Whether to join the room automatically on login.
.RE
.PP
\fBjoin <room>\fR
.RS 4
Join room using the properties associated with the bookmark.
.RE
.PP
\fBinvites on|off\fR
.RS 4
Whether or not to bookmark accepted room invites, defaults to 'on'.
.RE
.PP
\fBignore add <barejid>\fR
.RS 4
Add a bookmark to the autojoin ignore list.
.RE
.PP
\fBignore remove <barejid>\fR
.RS 4
Remove a bookmark from the autojoin ignore list.
.RE

.SH EXAMPLES
/bookmark add room@example.com nick YOURNICK

.LP
/bookmark join room@example.com

.LP
/bookmark update room@example.com nick NEWNICK autojoin on

.LP
/bookmark ignore room@example.com

.LP
/bookmark list

.LP
/bookmark list room@example.com

.LP
/bookmark remove room@example.com

.LP