summaryrefslogtreecommitdiffstats
path: root/sq/man-sq-autocrypt/sq-encrypt.1
diff options
context:
space:
mode:
Diffstat (limited to 'sq/man-sq-autocrypt/sq-encrypt.1')
-rw-r--r--sq/man-sq-autocrypt/sq-encrypt.185
1 files changed, 85 insertions, 0 deletions
diff --git a/sq/man-sq-autocrypt/sq-encrypt.1 b/sq/man-sq-autocrypt/sq-encrypt.1
new file mode 100644
index 00000000..93b194eb
--- /dev/null
+++ b/sq/man-sq-autocrypt/sq-encrypt.1
@@ -0,0 +1,85 @@
+.TH SQ-ENCRYPT "1" "JANUARY 2021" "0.24.0 (SEQUOIA-OPENPGP 1.0.0)" "USER COMMANDS" 5
+.SH NAME
+sq\-encrypt \- Encrypts a message
+
+Encrypts a message for any number of recipients and with any number of
+passwords, optionally signing the message in the process.
+
+The converse operation is "sq decrypt".
+
+.SH SYNOPSIS
+\fBsq encrypt\fR [FLAGS] [OPTIONS] [\-\-] [FILE]
+.SH FLAGS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Prints help information
+
+.TP
+\fB\-B\fR, \fB\-\-binary\fR
+Emits binary data
+
+.TP
+\fB\-s\fR, \fB\-\-symmetric\fR
+Adds a password to encrypt with. The message can be decrypted with either one of the recipient's keys, or any password.
+
+.TP
+\fB\-\-use\-expired\-subkey\fR
+If a certificate has only expired encryption\-capable subkeys, falls back to using the one that expired last
+.SH OPTIONS
+.TP
+\fB\-o\fR, \fB\-\-output\fR FILE
+Writes to FILE or stdout if omitted
+
+.TP
+\fB\-\-recipient\-cert\fR CERT\-RING
+Encrypts for all recipients in CERT\-RING
+
+.TP
+\fB\-\-signer\-key\fR KEY
+Signs the message with KEY
+
+.TP
+\fB\-\-mode\fR MODE
+Selects what kind of keys are considered for encryption. Transport select subkeys marked as suitable for transport encryption, rest selects those for encrypting data at rest, and all selects all encryption\-capable subkeys. [default: all] [possible values: transport, rest, all]
+
+.TP
+\fB\-\-compression\fR KIND
+Selects compression scheme to use [default: pad] [possible values: none, pad, zip, zlib, bzip2]
+
+.TP
+\fB\-t\fR, \fB\-\-time\fR TIME
+Chooses keys valid at the specified time and sets the signature's creation time
+.SH ARGS
+.TP
+FILE
+Reads from FILE or stdin if omitted
+.SH EXAMPLES
+.TP
+# Encrypt a file using a certificate
+\fB $ sq encrypt \-\-recipient\-cert romeo.pgp message.txt\fR
+.TP
+# Encrypt a file creating a signature in the process
+\fB $ sq encrypt \-\-recipient\-cert romeo.pgp \-\-signer\-key juliet.pgp message.txt\fR
+.TP
+# Encrypt a file using a password
+\fB $ sq encrypt \-\-symmetric message.txt\fR
+
+.SH SEE ALSO
+For the full documentation see <https://docs.sequoia\-pgp.org/sq/>.
+
+.ad l
+.nh
+sq(1), sq\-armor(1), sq\-autocrypt(1), sq\-certify(1), sq\-dearmor(1), sq\-decrypt(1), sq\-encrypt(1), sq\-inspect(1), sq\-key(1), sq\-keyring(1), sq\-packet(1), sq\-sign(1), sq\-verify(1)
+
+
+.SH AUTHORS
+.P
+.RS 2
+.nf
+Azul <azul@sequoia\-pgp.org>
+Igor Matuszewski <igor@sequoia\-pgp.org>
+Justus Winter <justus@sequoia\-pgp.org>
+Kai Michaelis <kai@sequoia\-pgp.org>
+Neal H. Walfield <neal@sequoia\-pgp.org>
+Nora Widdecke <nora@sequoia\-pgp.org>
+Wiktor Kwapisiewicz <wiktor@sequoia\-pgp.org>