diff options
author | Michael Vetter <jubalh@iodoru.org> | 2021-01-09 08:08:10 +0100 |
---|---|---|
committer | Michael Vetter <jubalh@iodoru.org> | 2021-01-09 08:08:10 +0100 |
commit | d3820239613d0dcf6bc8e4cdd81ff7d14113c609 (patch) | |
tree | 589e6ff2dfc56400d34079dbaf86515cb56afd14 /docs/profanity-ox.1 | |
parent | 8c08e64f377c9faee1abe9c663e9b2d73e7a7a45 (diff) | |
download | profani-tty-d3820239613d0dcf6bc8e4cdd81ff7d14113c609.tar.gz |
Release 0.10.0
Diffstat (limited to 'docs/profanity-ox.1')
-rw-r--r-- | docs/profanity-ox.1 | 110 |
1 files changed, 110 insertions, 0 deletions
diff --git a/docs/profanity-ox.1 b/docs/profanity-ox.1 new file mode 100644 index 00000000..ad92dee6 --- /dev/null +++ b/docs/profanity-ox.1 @@ -0,0 +1,110 @@ +.TH man 1 "2021-01-09" "0.10.0" "Profanity XMPP client" + +.SH NAME +/ox + +.SH DESCRIPTION +OpenPGP (OX) commands to manage keys, and perform PGP encryption during chat sessions. + +.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 sendfile on|off + +.LP +/ox announce <file> + +.LP +/ox discover + +.LP +/ox request <jid> + +.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]. This is the default. +.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 +.RE +.PP +\fBrequest <jid>\fR +.RS 4 +Request public keys +.RE +.PP +\fBsendfile on|off\fR +.RS 4 +Allow /sendfile to send unencrypted files while otherwise using PGP. +.RE + +.SH EXAMPLES +/ox log off + +.LP +/ox start odin@valhalla.edda + +.LP +/ox end + +.LP +/ox char X + +.LP |