1man(1) Profanity XMPP client man(1)
2
6 Profanity - a simple console based XMPP chat client.
7
9 profanity [-vh] [-l level] [-a account]
10
12 Profanity is a simple lightweight console based XMPP chat client. Its
13 emphasis is on having a simple and configurable command driven UI, see
14 the homepage at:
15 <https://profanity-im.github.io>
17
19 -v, --version
20 Show version and build information.
21 -h, --help
23 Show help on command line arguments.
24 -a, --account ACCOUNT
26 Auto connect to an account on startup, ACCOUNT must be an exist‐
27 ing account.
28 -c, --config
30 Use an alternative config file.
31 -l, --log LEVEL
33 Set the logging level, LEVEL may be set to DEBUG, INFO (the de‐
34 fault), WARN or ERROR.
35 -f, --logfile
37 Specify a different logfile
38 -t, --theme THEME
40 Specify which theme to use. THEME must be one of the themes in‐
41 stalled in $XDG_CONFIG_HOME/profanity/themes
42
44 Tab, Shift+Tab
45 Tab completion next, previous. Works for commands, nicks and
46 quotes (when input line starts with >).
47 ALT+1..Alt-0 or F1..F10
49 Choose window 1..10.
50 ALT+q..Alt-p (in QWERTY layout)
52 Choose window 11..20.
53 ALT+LEFT
55 Choose previous chat window.
56 ALT+RIGHT
58 Choose next chat window.
59 PAGEUP Page the active window up.
61 PAGEDOWN
63 Page the active window down.
64 ALT+PAGEUP
66 Page the occupants or roster panel up.
67 ALT+PAGEDOWN
69 Page the occupants or roster panel down.
70 ALT+a Jump to the next unread window.
72 ALT+v Mark current window for later reading with an attention flag.
74 ALT+m Switch between windows marked with the attention flag.
76 ALT+c Run external editor (see profanity-editor(1)) for current input
78 line.
79 CTRL+DOWN
81 Store current input line in history but do not execute it.
82 Note: Profanity is using GNU Readline library to handle input so de‐
84 fault configuration file ~/.inputrc affects operation. In addition to
85 that $XDG_CONFIG_HOME/profanity/inputrc is read after all default key‐
86 bindigs are set so one can override or add settings there. For refer‐
87 ence, see Readline documentation: info readline "Command Line Editing"
88 "Readline Init File" "Readline Init File Syntax" and the list of avail‐
89 able Profanity commands in inputwin.c. Standard Readline keybindings
90 are supported, including C-r for interactive history search and C-x C-r
91 for reloading inputrc without restart.
92
94 The user guide can be found at <https://profanity-im.github.io/user‐
95 guide.html>.
96
98 Profanity supports various kinds of encryption: OMEMO, OTR, PGP, OX.
99 You can only enable one of them per correspondent at a time.
100 OMEMO OMEMO (/omemo) is defined in XEP-0384. It uses an implementation
102 of the Signal protocol for key management and to synchronize
103 messages among different clients. It works even when other
104 clients are offline. And offers Perfect Forward Secrecy and
105 Plausible deniability. Servers need to support PEP (XEP-0163).
106 We implement the "siacs" version of OMEMO. Version 0.3.0, which
107 is currently the widest adopted option. OMEMO is the only en‐
108 cryption option in Profanity that also supports encryption for
109 MUCs (XEP-0045) and file transfer via HTTP upload (XEP-0363).
110 OTR OTR (/otr) is defined in XEP-0364. It uses a combination of the
112 AES symmetric-key algorithm, the Diffie–Hellman key exchange,
113 and the SHA-1 hash function. It offers deniable authentication
114 and Perfect Forward Secrecy. To initialize a session both
115 clients need to be online at the same time. A session is between
116 two clients, so multiclient chats are not working. Which is a
117 feature not a bug. OTR does by design not work for MUCs.
118 OpenPGP
120 OpenPGP (/pgp) is defined in XEP-0027. Is uses a public and se‐
121 cret key. It is also known as Legacy OpenPGP and has been depre‐
122 cated. It doesn't provide protection against replay attacks.
123 MUCs and file transfer via HTTP upload are not specified and
124 thus not supported.
125 OX OX (/ox) is defined in XEP-0373 and XEP-0374. It's a more modern
127 way to use OpenPGP on XMPP and tries to fix the shortcomings of
128 legacy XEP-0027. Servers need to support PEP (XEP-0163). MUCs
129 and file transfer via HTTP upload are not specified and thus not
130 supported.
131 DETAILS
133 For more details read the relevant XEPs and look at the overview
134 at <https://wiki.xmpp.org/web/XMPP_E2E_Security>
135
137 There is some XMPP specific terminology that might be unknown for fresh
138 users. We will try to describe them here since they are often refer‐
139 ences in the help and man pages.
140 JID Stands for Jabber ID. It refers to an XMPP address. Historically
142 XMPP was also known as Jabber. MAM Stands for Message Archive
143 Management (XEP-0313) and describes the ability to store mes‐
144 sages on the server and retrieve them later. MUC Stands for
145 Mutli-User Chats (XEP-0045) and are also called, groups, group
146 chats, chatrooms or conferences. Roster The roster is your con‐
147 tact list. By default displayed at the right side on the console
148 window. See RFC6121. XEP XMPP is aa extendable protocol. There
149 are core features and optional features described in XMPP Exten‐
150 sion Protocols, short XEPs.
151
153 Profanity itself has a lot of built-in help. Check the /help command
154 for more information. Type "/help help" for information on how to use
155 help itself. Profanity ships with one man page for each built-in com‐
156 mand, e.g. there is profanity-account(1) for /account.
157
159 Configuration for Profanity is stored in $XDG_CONFIG_HOME/profan‐
160 ity/profrc , details on commands for configuring Profanity can be found
161 at <https://profanity-im.github.io/reference.html> or the respective
162 built-in help or man pages.
163
165 Bugs can either be reported by raising an issue at the Github issue
166 tracker:
167 <https://github.com/profanity-im/profanity/issues>
169 or to the mailing list at:
171 <https://lists.posteo.de/listinfo/profanity>
173
175 Copyright (C) 2012 - 2019 James Booth <boothj5web@gmail.com>. Copy‐
176 right (C) 2019 - 2023 Michael Vetter <jubalh@iodoru.com>. License
177 GPLv3+: GNU GPL version 3 or later <https://www.gnu.org/li‐
178 censes/gpl.html> This is free software; you are free to change and re‐
179 distribute it. There is NO WARRANTY, to the extent permitted by law.
180
182 Profanity was created by James Booth <boothj5web@gmail.com> with many
183 contributions from others, see the full list at:
184 <https://github.com/profanity-im/profanity/graphs/contributors>
1850.14.0 2023-08-03 man(1)