-
Notifications
You must be signed in to change notification settings - Fork 23
/
faq.html
298 lines (291 loc) · 15.3 KB
/
faq.html
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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
<!DOCTYPE html>
<html>
<head>
<title>Profanity, a console based XMPP client - FAQ</title>
<meta charset="utf-8">
<meta http-equiv="Expires" content="-1">
<meta http-equiv="Pragma" content="no-cache">
<meta http-equiv="Cache-Control" content="no-cache">
<link href="css/profanity.css" type="text/css" rel="stylesheet">
</head>
<body id="article">
<img class="overlay" src="images/profanity_mouth-only.png" alt="Profanity Illustration">
<header>
<h1>
<a href="index.html">
Profani<span class="kern-ty">ty</span>
</a>
</h1>
<h2>Frequently Asked Questions</h2>
</header>
<article id="manual">
<section>
<h3>Contents</h3>
<ul>
<li>
<ul>
<li><a href="#multiacc">How do I connect with multiple accounts?</a></li>
<li><a href="#omemo">OMEMO doesn't work for me</a></li>
<li><a href="#persistent">Why are my settings not persistent?</a></li>
<li><a href="#profrc">Where is the profrc file format described?</a></li>
<li><a href="#platform">Will Profanity run on <some platform>?</a></li>
<li><a href="#gtalk">Will Profanity work with Google Talk?</a></li>
<li><a href="#facebook">Will Profanity work with Facebook Chat?</a></li>
<li><a href="#slack">Will Profanity work with Slack?</a></li>
<li><a href="#msn">Will Profanity work with MSN/Yahoo/AIM/IRC etc?</a></li>
<li><a href="#keychain">Can Profanity use my keychain/keyring to retrieve my password?</a>
<li><a href="#multiaccount">Can I connect to more than one account at a time?</a></li>
<li><a href="#termf1">Why does the F1 key open terminal help rather than going back to the main
console window?</a></li>
<li><a href="#utf8encoding">Why can I not type anything in the input bar?</a></li>
<li><a href="#mucpresence">How can I hide join/leave messages in MUCs?</a></li>
<li><a href="#bugs">I've found a bug/have a feature request, who do I tell?</a></li>
<li><a href="#contrib">I'd like to contribute, what should I do?</a></li>
<li><a href="#donate">I'd like to donate to Profanity</a></li>
<li><a href="#clients">Are there more clients like this?</a></li>
<li><a href="#tor">How to connect to XMPP server using Tor</a></li>
<li><a href="#onion">How to connect to an onion XMPP server</a></li>
<li><a href="#distrobox">How to run the latest version on old distributions?</a></li>
<li><a href="#autoopen">How do I automatically open chat windows with contacts?</a></li>
</ul>
</li>
</ul>
</section>
<section>
<a name="multiacc"></a>
<h4>How do I connect with multiple accounts?</h4>
<p>Profanity only supports one account per instance. But you certainly can run several instances of Profanity! Run Profanity in multiple terminals or use a terminal multiplexer like screen or tmux. An example setup can be seen in this <a href="https://profanity-im.github.io/blog/post/how-to-run-profanity-instances-within-tmux/">blogpost</a>.
</p>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="omemo"></a>
<h4>OMEMO doesn't work for me</h4>
<p>OMEMO support was added in 0.7.0. Version 0.11.1 fixed a lot of common bugs. But please make sure to run the <strong>latest</strong> version of Profanity.</p>
<p>A common error is that the PEP nodes are wrongly configured. It could be that your server isn't configured the right way or that some client configured
this the wrong way in the past. Profanity tries to correct this but might fail. See <a href="https://github.com/profanity-im/profanity/issues/1538">issue 1538</a> for details.</p>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="platform"></a>
<h4>Will Profanity run on <some platform>?</h4>
<p>Profanity should run on any POSIX system, see the <a href="install.html">install guide</a> for specifics.
</p>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="gtalk"></a>
<h4>Will Profanity work with Google Talk?</h4>
<p>Profanity was able to work with Google Talk. But in 2013 after Google merged it's messenger products
Google Talk, Google+ Messenger and Hangouts together XMPP support was <a
href="https://www.theverge.com/2013/5/15/4318830/inside-hangouts-googles-big-fix-for-its-messaging-mess">dropped</a>.
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="facebook"></a>
<h4>Will Profanity work with Facebook Chat?</h4>
<p>Facebook have recently announced that they will no longer support the open XMPP chat protocol, so
Profanity will no longer work with Facebook Chat.</p>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="slack"></a>
<h4>Will Profanity work with Slack?</h4>
<p>Provided the XMPP gateway has been enabled for your team, Profanity will work. See <a target="_blank"
href="https://slack.zendesk.com/hc/en-us/articles/201727913-Connecting-to-Slack-over-IRC-and-XMPP">the
Slack page on gateways.</a></p>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="msn"></a>
<h4>Will Profanity work with MSN/Yahoo/AIM/IRC etc?</h4>
<p>No, Profanity is purely an XMPP chat client.</p>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="keychain"></a>
<h4>Can Profanity use my keychain/keyring to retrieve my password?</h4>
<p>Yes, the <a href="reference.html#account"><code>/account</code></a> command includes an
<code>eval_password</code> property which can be used to execute a script to retrieve your password.</p>
<p>For example on Ubuntu using gnome-keyring and <a
href="https://apps.ubuntu.com/cat/applications/libsecret-tools/"
target="_blank"><code>secret-tool</code></a>:</p>
<p>To add the password:</p>
<pre><code>secret-tool store --label="Bobs account" xmpp [email protected]</code></pre>
<p>You will be prompted to enter the password.</p>
<p>Command to use for the account <code>eval_password</code> property:</p>
<pre><code>secret-tool lookup xmpp [email protected]</code></pre>
<p>On OS X, use the following command for the <code>eval_password</code> property:</p>
<pre><code>security find-generic-password -s [email protected] -w</code></pre>
<p>You can also use Profanity together with <code>pass</code>, see this <a
href="https://hispagatos.org/post/xmpp_profanity_and_pass">guide</a>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="multiaccount"></a>
<h4>Can I connect to more than one account at a time?</h4>
<p>No, the recommended way is to use multiple terminal windows, or a terminal multiplexer like GNU Screen or
tmux.</p>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="persistent"></a>
<h4>Why are my settings not persistent?</h4>
<p>Because you did not use <code>/save</code>.</p>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="profrc"></a>
<h4>Where is the profrc file format described?</h4>
<p>Nowhere. Well, actually you cold read the source code.
But you should not edit the profrc file yourself anyways. Just use the commands to manipulate the settings.
And don't forget to <code>/save</code> before exiting.</p>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="termf1"></a>
<h4>Why does the F1 key open terminal help rather than going back to the main console window?</h4>
<p>Some terminals have a key binding for F1 to open help. You can use the alt-num keys to change windows, or
if you prefer to use the F keys, you'll need to change the terminal setting to open help with another
key.</p>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="utf8encoding"></a>
<h4>Why can I not type anything in the input bar?</h4>
<p>Profanity uses the ncursesw library to support wide characters, which requires a UTF-8 encoding. Try
running the following (or the equivalent for your language's UTF-8 encoding) in the terminal before
running profanity.</p>
<pre><code>export LANG=en_US.UTF-8</code></pre>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="mucpresence"></a>
<h4>How can I hide join/leave messages in MUCs?</h4>
<p>You can deactivate those messages with the following command:
<pre><code>/presence chat none</code></pre></p>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="bugs"></a>
<h4>I've found a bug/have a feature request who do I tell?</h4>
<p>If you have a github account, you can log an issue on the <a
href="https://github.com/profanity-im/profanity/issues?state=open" target="_blank">issue
tracker</a>.</p>
<p>Alternatively you are welcome to post on the <a
href="https://lists.posteo.de/listinfo/profanity" target="_blank">mailing
list</a>.</p>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="contrib"></a>
<h4>I'd like to contribute, what should I do?</h4>
<p>A page has been written with some ideas for how to <a id="link-helpout" href="helpout.html">help out</a>.
Any contributions/ideas are very welcome. Also see the <a
href="https://github.com/profanity-im/profanity/blob/master/CONTRIBUTING.md">CONTRIBUTING.md</a>
file on GitHub.</p>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="donate"></a>
<h4>I'd like to donate to Profanity</h4>
<p>If you want to pay the developers and maintainers of Profanity a coffee there are various ways to do so.
</p>
<p>On <a href="https://github.com/profanity-im/profanity">GitHub</a> there is a <b>Sponsor</b> button
linking to relevant pages. If you want to send the money directly you can ask for an IBAN via <a
href="mailto:[email protected]">email</a>.</p>
<p>We also got selected for GitHub Sponsors. You can find the link also on the <b>Sponsor</b> button on
GitHub.</p>
<p>There is also the possibility to set a bounty for certain issues via <a
href="https://www.bountysource.com/teams/profanity">Bountysource</a>. So in case you want to see a
certain feature implemented or bug fixed you can set a bounty there and the person doing the work gets
the reward.</p>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="clients"></a>
<h4>Are there more clients like this?</h4>
<p>Yes, there are several commandline clients: <a
href="https://www.gnu.org/software/freetalk/">freetalk</a>, <a
href="https://mcabber.com/">mcabber</a>, <a href="https://poez.io">poezio</a> and <a
href="https://xmpp.org/software/clients.html">more clients</a>.</p>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="tor"></a>
<h4>How to connect to XMPP server using Tor</h4>
<p>To connect to the XMPP server by the Tor network, you must launch Profanity with a tool called "proxychains-ng".
</p>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="onion"></a>
<h4>How to connect to an onion XMPP server</h4>
<p>An onion XMPP server is a server which is providing an onion address to reach it inside the Tor network.
You can specify the onion address with the <a href="reference.html#account"><code>/account</code></a> command in Profanity.</p>
<pre><code>/account set account_name server address.onion</pre></code>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="distrobox"></a>
<h4>How to run the latest version on old distributions?</h4>
<p>Some distributions, like Debian, have backports repositories. You can also run Profanity in a container via distrobox. See our <a href="https://profanity-im.github.io/blog/post/distrobox/">blogpost</a> </p>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
<section>
<a name="autoopen"></a>
<h4>How do I automatically open chat windows with contacts?</h4>
To the right side you can see your roster. It contains all your contacts and rooms (MUCs). MUCs can be automatically joined via bookmarks. If you want to open a chat window to a user automatically upon the start of profanity you can write a script to do that. Put <code>/msg theusersnickname</code> into <code>~/.local/share/profanity/scripts/myautoscript</code>. And configure your account to automatically launch that script <code>/account set <account> startscript myautoscript</code>.
<p></p>
<a href="#top">
<h5>back to top</h5>
</a>
</section>
</article>
<footer>
<p class="matty">site designed by <a href="http://www.matthewbalaam.co.uk">Matthew Balaam</a></p>
</footer>
</body>
</html>