about summary refs log tree commit diff stats
path: root/docs/profanity-otr.1
blob: 64ca45768b4c1113e55731c7110c79071a414c89 (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
.TH man 1 "2022-10-12" "0.13.0" "Profanity XMPP client"

.SH NAME
/otr

.SH DESCRIPTION
Off The Record (OTR) commands to manage keys, and perform OTR encryption during chat sessions.

.SH SYNOPSIS
/otr libver

.LP
/otr gen

.LP
/otr myfp|theirfp

.LP
/otr start [<contact>]

.LP
/otr end

.LP
/otr trust|untrust

.LP
/otr secret <secret>

.LP
/otr question <question> <answer>

.LP
/otr answer <answer>

.LP
/otr policy manual|opportunistic|always [<contact>]

.LP
/otr log on|off|redact

.LP
/otr char <char>

.LP
/otr sendfile on|off

.LP

.SH ARGUMENTS
.PP
\fBlibver\fR
.RS 4
Show which version of the libotr library is being used.
.RE
.PP
\fBgen\fR
.RS 4
Generate your private key.
.RE
.PP
\fBmyfp\fR
.RS 4
Show your fingerprint.
.RE
.PP
\fBtheirfp\fR
.RS 4
Show contacts fingerprint.
.RE
.PP
\fBstart [<contact>]\fR
.RS 4
Start an OTR session with contact, or current recipient if omitted.
.RE
.PP
\fBend\fR
.RS 4
End the current OTR session.
.RE
.PP
\fBtrust|untrust\fR
.RS 4
Indicate whether or not you trust the contact's fingerprint.
.RE
.PP
\fBsecret <secret>\fR
.RS 4
Verify a contact's identity using a shared secret.
.RE
.PP
\fBquestion <question> <answer>\fR
.RS 4
Verify a contact's identity using a question and expected answer.
.RE
.PP
\fBanswer <answer>\fR
.RS 4
Respond to a question answer verification request with your answer.
.RE
.PP
\fBpolicy manual\fR
.RS 4
Set the global OTR policy to manual, OTR sessions must be started manually.
.RE
.PP
\fBpolicy manual <contact>\fR
.RS 4
Set the OTR policy to manual for a specific contact.
.RE
.PP
\fBpolicy opportunistic\fR
.RS 4
Set the global OTR policy to opportunistic, an OTR session will be attempted upon starting a conversation.
.RE
.PP
\fBpolicy opportunistic <contact>\fR
.RS 4
Set the OTR policy to opportunistic for a specific contact.
.RE
.PP
\fBpolicy always\fR
.RS 4
Set the global OTR policy to always, an error will be displayed if an OTR session cannot be initiated upon starting a conversation.
.RE
.PP
\fBpolicy always <contact>\fR
.RS 4
Set the OTR policy to always for a specific contact.
.RE
.PP
\fBlog on|off\fR
.RS 4
Enable or disable plaintext logging of OTR encrypted messages.
.RE
.PP
\fBlog redact\fR
.RS 4
Log OTR encrypted messages, but replace the contents with [redacted].
.RE
.PP
\fBchar <char>\fR
.RS 4
Set the character to be displayed next to OTR encrypted messages.
.RE
.PP
\fBsendfile on|off\fR
.RS 4
Allow /sendfile to send unencrypted files while in an OTR session.
.RE

.SH EXAMPLES
/otr log off

.LP
/otr policy manual

.LP
/otr policy opportunistic odin@valhalla.edda

.LP
/otr gen

.LP
/otr start odin@valhalla.edda

.LP
/otr myfp

.LP
/otr theirfp

.LP
/otr question "What is the name of my rabbit?" fiffi

.LP
/otr end

.LP
/otr char *

.LP