1
0
mirror of https://github.com/profanity-im/profanity.git synced 2024-06-16 21:35:24 +00:00
profanity/docs/profanity-ox.1
2023-08-03 08:01:43 +02:00

103 lines
1.6 KiB
Groff

.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/ox
.SH DESCRIPTION
OpenPGP (OX) commands to manage keys, and perform OpenPGP encryption during chat sessions. Your OpenPGP key needs a user-id with your JID URI (xmpp:local@domain.tld). A key can be generated with "gpg --quick-gen-key xmpp:local@domain.tld future-default default 3y". See man profanity-ox-setup for details on how to set up OX the first time.
.SH SYNOPSIS
/ox keys
.LP
/ox contacts
.LP
/ox start [<contact>]
.LP
/ox end
.LP
/ox log on|off|redact
.LP
/ox char <char>
.LP
/ox announce <file>
.LP
/ox discover <jid>
.LP
/ox request <jid> <keyid>
.LP
.SH ARGUMENTS
.PP
\fBkeys\fR
.RS 4
List all keys known to the system.
.RE
.PP
\fBcontacts\fR
.RS 4
Show contacts with assigned public keys.
.RE
.PP
\fBstart [<contact>]\fR
.RS 4
Start PGP encrypted chat, current contact will be used if not specified.
.RE
.PP
\fBend\fR
.RS 4
End PGP encrypted chat with the current recipient.
.RE
.PP
\fBlog on|off\fR
.RS 4
Enable or disable plaintext logging of PGP encrypted messages.
.RE
.PP
\fBlog redact\fR
.RS 4
Log PGP encrypted messages, but replace the contents with [redacted].
.RE
.PP
\fBchar <char>\fR
.RS 4
Set the character to be displayed next to PGP encrypted messages.
.RE
.PP
\fBannounce <file>\fR
.RS 4
Announce a public key by pushing it on the XMPP Server
.RE
.PP
\fBdiscover <jid>\fR
.RS 4
Discover public keys of a jid. The OpenPGP Key IDs will be displayed
.RE
.PP
\fBrequest <jid> <keyid>\fR
.RS 4
Request public key. See /ox discover to to get available key IDs.
.RE
.SH EXAMPLES
/ox log off
.LP
/ox start odin@valhalla.edda
.LP
/ox end
.LP
/ox char X
.LP