|
| 1 | +.TH man 1 "2022-03-30" "0.12.0" "Profanity XMPP client" |
| 2 | + |
| 3 | +.SH NAME |
| 4 | +/account |
| 5 | + |
| 6 | +.SH DESCRIPTION |
| 7 | +Commands for creating and managing accounts. Calling with no arguments will display information for the current account. |
| 8 | + |
| 9 | +.SH SYNOPSIS |
| 10 | +/account |
| 11 | + |
| 12 | +.LP |
| 13 | +/account list |
| 14 | + |
| 15 | +.LP |
| 16 | +/account show <account> |
| 17 | + |
| 18 | +.LP |
| 19 | +/account enable|disable <account> |
| 20 | + |
| 21 | +.LP |
| 22 | +/account default set <account> |
| 23 | + |
| 24 | +.LP |
| 25 | +/account default off |
| 26 | + |
| 27 | +.LP |
| 28 | +/account add <account> |
| 29 | + |
| 30 | +.LP |
| 31 | +/account remove <account> |
| 32 | + |
| 33 | +.LP |
| 34 | +/account rename <account> <newaccount> |
| 35 | + |
| 36 | +.LP |
| 37 | +/account set <account> jid <jid> |
| 38 | + |
| 39 | +.LP |
| 40 | +/account set <account> server <server> |
| 41 | + |
| 42 | +.LP |
| 43 | +/account set <account> port <port> |
| 44 | + |
| 45 | +.LP |
| 46 | +/account set <account> status <presence> |
| 47 | + |
| 48 | +.LP |
| 49 | +/account set <account> status last |
| 50 | + |
| 51 | +.LP |
| 52 | +/account set <account> <presence> <priority> |
| 53 | + |
| 54 | +.LP |
| 55 | +/account set <account> resource <resource> |
| 56 | + |
| 57 | +.LP |
| 58 | +/account set <account> password <password> |
| 59 | + |
| 60 | +.LP |
| 61 | +/account set <account> eval_password <command> |
| 62 | + |
| 63 | +.LP |
| 64 | +/account set <account> muc <service> |
| 65 | + |
| 66 | +.LP |
| 67 | +/account set <account> nick <nick> |
| 68 | + |
| 69 | +.LP |
| 70 | +/account set <account> otr <policy> |
| 71 | + |
| 72 | +.LP |
| 73 | +/account set <account> pgpkeyid <pgpkeyid> |
| 74 | + |
| 75 | +.LP |
| 76 | +/account set <account> startscript <script> |
| 77 | + |
| 78 | +.LP |
| 79 | +/account set <account> tls force|allow|trust|legacy|disable |
| 80 | + |
| 81 | +.LP |
| 82 | +/account set <account> auth default|legacy |
| 83 | + |
| 84 | +.LP |
| 85 | +/account set <account> theme <theme> |
| 86 | + |
| 87 | +.LP |
| 88 | +/account clear <account> password |
| 89 | + |
| 90 | +.LP |
| 91 | +/account clear <account> eval_password |
| 92 | + |
| 93 | +.LP |
| 94 | +/account clear <account> server |
| 95 | + |
| 96 | +.LP |
| 97 | +/account clear <account> port |
| 98 | + |
| 99 | +.LP |
| 100 | +/account clear <account> otr |
| 101 | + |
| 102 | +.LP |
| 103 | +/account clear <account> pgpkeyid |
| 104 | + |
| 105 | +.LP |
| 106 | +/account clear <account> startscript |
| 107 | + |
| 108 | +.LP |
| 109 | +/account clear <account> muc |
| 110 | + |
| 111 | +.LP |
| 112 | +/account clear <account> resource |
| 113 | + |
| 114 | +.LP |
| 115 | + |
| 116 | +.SH ARGUMENTS |
| 117 | +.PP |
| 118 | +\fBlist\fR |
| 119 | +.RS 4 |
| 120 | +List all accounts. |
| 121 | +.RE |
| 122 | +.PP |
| 123 | +\fBenable <account>\fR |
| 124 | +.RS 4 |
| 125 | +Enable the account, it will be used for autocompletion. |
| 126 | +.RE |
| 127 | +.PP |
| 128 | +\fBshow <account>\fR |
| 129 | +.RS 4 |
| 130 | +Show details for the specified account. |
| 131 | +.RE |
| 132 | +.PP |
| 133 | +\fBdisable <account>\fR |
| 134 | +.RS 4 |
| 135 | +Disable the account. |
| 136 | +.RE |
| 137 | +.PP |
| 138 | +\fBdefault set <account>\fR |
| 139 | +.RS 4 |
| 140 | +Set the default account, used when no argument passed to the /connect command. |
| 141 | +.RE |
| 142 | +.PP |
| 143 | +\fBdefault off\fR |
| 144 | +.RS 4 |
| 145 | +Clear the default account setting. |
| 146 | +.RE |
| 147 | +.PP |
| 148 | +\fBadd <account>\fR |
| 149 | +.RS 4 |
| 150 | +Create a new account. |
| 151 | +.RE |
| 152 | +.PP |
| 153 | +\fBremove <account>\fR |
| 154 | +.RS 4 |
| 155 | +Remove an account. |
| 156 | +.RE |
| 157 | +.PP |
| 158 | +\fBrename <account> <newaccount>\fR |
| 159 | +.RS 4 |
| 160 | +Rename 'account' to 'newaccount'. |
| 161 | +.RE |
| 162 | +.PP |
| 163 | +\fBset <account> jid <jid>\fR |
| 164 | +.RS 4 |
| 165 | +Set the Jabber ID for the account, account name will be used if not set. |
| 166 | +.RE |
| 167 | +.PP |
| 168 | +\fBset <account> server <server>\fR |
| 169 | +.RS 4 |
| 170 | +The chat server, if different to the domainpart of the JID. |
| 171 | +.RE |
| 172 | +.PP |
| 173 | +\fBset <account> port <port>\fR |
| 174 | +.RS 4 |
| 175 | +The port used for connecting if not the default (5222, or 5223 for SSL). |
| 176 | +.RE |
| 177 | +.PP |
| 178 | +\fBset <account> status <presence>\fR |
| 179 | +.RS 4 |
| 180 | +The presence status to use on login. |
| 181 | +.RE |
| 182 | +.PP |
| 183 | +\fBset <account> status last\fR |
| 184 | +.RS 4 |
| 185 | +Use your last status before logging out, when logging in. |
| 186 | +.RE |
| 187 | +.PP |
| 188 | +\fBset <account> <presence> <priority>\fR |
| 189 | +.RS 4 |
| 190 | +Set the priority (-128..127) to use for the specified presence. |
| 191 | +.RE |
| 192 | +.PP |
| 193 | +\fBset <account> resource <resource>\fR |
| 194 | +.RS 4 |
| 195 | +The resource to be used for this account, defaults to 'profanity'. |
| 196 | +.RE |
| 197 | +.PP |
| 198 | +\fBset <account> password <password>\fR |
| 199 | +.RS 4 |
| 200 | +Password for the account, note this is currently stored in plaintext if set. |
| 201 | +.RE |
| 202 | +.PP |
| 203 | +\fBset <account> eval_password <command>\fR |
| 204 | +.RS 4 |
| 205 | +Shell command evaluated to retrieve password for the account. Can be used to retrieve password from keyring. |
| 206 | +.RE |
| 207 | +.PP |
| 208 | +\fBset <account> muc <service>\fR |
| 209 | +.RS 4 |
| 210 | +The default MUC chat service to use, defaults to the servers disco info response. |
| 211 | +.RE |
| 212 | +.PP |
| 213 | +\fBset <account> nick <nick>\fR |
| 214 | +.RS 4 |
| 215 | +The default nickname to use when joining chat rooms. |
| 216 | +.RE |
| 217 | +.PP |
| 218 | +\fBset <account> otr <policy>\fR |
| 219 | +.RS 4 |
| 220 | +Override global OTR policy for this account, see /otr. |
| 221 | +.RE |
| 222 | +.PP |
| 223 | +\fBset <account> pgpkeyid <pgpkeyid>\fR |
| 224 | +.RS 4 |
| 225 | +Set the ID of the PGP key for this account, see /pgp. |
| 226 | +.RE |
| 227 | +.PP |
| 228 | +\fBset <account> startscript <script>\fR |
| 229 | +.RS 4 |
| 230 | +Set the script to execute after connecting. |
| 231 | +.RE |
| 232 | +.PP |
| 233 | +\fBset <account> tls force\fR |
| 234 | +.RS 4 |
| 235 | +Force TLS connection, and fail if one cannot be established, this is default behaviour. |
| 236 | +.RE |
| 237 | +.PP |
| 238 | +\fBset <account> tls allow\fR |
| 239 | +.RS 4 |
| 240 | +Use TLS for the connection if it is available. |
| 241 | +.RE |
| 242 | +.PP |
| 243 | +\fBset <account> tls trust\fR |
| 244 | +.RS 4 |
| 245 | +Force TLS connection and trust server's certificate. |
| 246 | +.RE |
| 247 | +.PP |
| 248 | +\fBset <account> tls legacy\fR |
| 249 | +.RS 4 |
| 250 | +Use legacy TLS for the connection. It means server doesn't support STARTTLS and TLS is forced just after TCP connection is established. |
| 251 | +.RE |
| 252 | +.PP |
| 253 | +\fBset <account> tls disable\fR |
| 254 | +.RS 4 |
| 255 | +Disable TLS for the connection. |
| 256 | +.RE |
| 257 | +.PP |
| 258 | +\fBset <account> auth default\fR |
| 259 | +.RS 4 |
| 260 | +Use default authentication process. |
| 261 | +.RE |
| 262 | +.PP |
| 263 | +\fBset <account> auth legacy\fR |
| 264 | +.RS 4 |
| 265 | +Allow legacy authentication. |
| 266 | +.RE |
| 267 | +.PP |
| 268 | +\fBset <account> <theme>\fR |
| 269 | +.RS 4 |
| 270 | +Set the UI theme for the account. |
| 271 | +.RE |
| 272 | +.PP |
| 273 | +\fBclear <account> server\fR |
| 274 | +.RS 4 |
| 275 | +Remove the server setting for this account. |
| 276 | +.RE |
| 277 | +.PP |
| 278 | +\fBclear <account> port\fR |
| 279 | +.RS 4 |
| 280 | +Remove the port setting for this account. |
| 281 | +.RE |
| 282 | +.PP |
| 283 | +\fBclear <account> password\fR |
| 284 | +.RS 4 |
| 285 | +Remove the password setting for this account. |
| 286 | +.RE |
| 287 | +.PP |
| 288 | +\fBclear <account> eval_password\fR |
| 289 | +.RS 4 |
| 290 | +Remove the eval_password setting for this account. |
| 291 | +.RE |
| 292 | +.PP |
| 293 | +\fBclear <account> otr\fR |
| 294 | +.RS 4 |
| 295 | +Remove the OTR policy setting for this account. |
| 296 | +.RE |
| 297 | +.PP |
| 298 | +\fBclear <account> pgpkeyid\fR |
| 299 | +.RS 4 |
| 300 | +Remove pgpkeyid associated with this account. |
| 301 | +.RE |
| 302 | +.PP |
| 303 | +\fBclear <account> startscript\fR |
| 304 | +.RS 4 |
| 305 | +Remove startscript associated with this account. |
| 306 | +.RE |
| 307 | +.PP |
| 308 | +\fBclear <account> theme\fR |
| 309 | +.RS 4 |
| 310 | +Clear the theme setting for the account, the global theme will be used. |
| 311 | +.RE |
| 312 | +.PP |
| 313 | +\fBclear <account> resource\fR |
| 314 | +.RS 4 |
| 315 | +Remove the resource setting for this account. |
| 316 | +.RE |
| 317 | +.PP |
| 318 | +\fBclear <account> muc\fR |
| 319 | +.RS 4 |
| 320 | +Remove the default MUC service setting. |
| 321 | +.RE |
| 322 | + |
| 323 | +.SH EXAMPLES |
| 324 | +/account add me |
| 325 | + |
| 326 | +.LP |
| 327 | +/account set me jid [email protected] |
| 328 | + |
| 329 | +.LP |
| 330 | +/account set me server talk.chat.com |
| 331 | + |
| 332 | +.LP |
| 333 | +/account set me port 5111 |
| 334 | + |
| 335 | +.LP |
| 336 | +/account set me muc chatservice.mycompany.com |
| 337 | + |
| 338 | +.LP |
| 339 | +/account set me nick dennis |
| 340 | + |
| 341 | +.LP |
| 342 | +/account set me status dnd |
| 343 | + |
| 344 | +.LP |
| 345 | +/account set me dnd -1 |
| 346 | + |
| 347 | +.LP |
| 348 | +/account rename me chattyme |
| 349 | + |
| 350 | +.LP |
| 351 | +/account clear me pgpkeyid |
| 352 | + |
| 353 | +.LP |
0 commit comments