summaryrefslogtreecommitdiffstats
path: root/sq/man-sq-net/sq-decrypt.1
diff options
context:
space:
mode:
Diffstat (limited to 'sq/man-sq-net/sq-decrypt.1')
-rw-r--r--sq/man-sq-net/sq-decrypt.177
1 files changed, 77 insertions, 0 deletions
diff --git a/sq/man-sq-net/sq-decrypt.1 b/sq/man-sq-net/sq-decrypt.1
new file mode 100644
index 00000000..7caa10ae
--- /dev/null
+++ b/sq/man-sq-net/sq-decrypt.1
@@ -0,0 +1,77 @@
+.TH SQ-DECRYPT "1" "JANUARY 2021" "0.24.0 (SEQUOIA-OPENPGP 1.0.0)" "USER COMMANDS" 5
+.SH NAME
+sq\-decrypt \- Decrypts a message
+
+Decrypts a message using either supplied keys, or by prompting for a
+password. Any signatures are checked using the supplied certificates.
+
+The converse operation is "sq encrypt".
+
+.SH SYNOPSIS
+\fBsq decrypt\fR [FLAGS] [OPTIONS] [\-\-] [FILE]
+.SH FLAGS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Prints help information
+
+.TP
+\fB\-\-dump\-session\-key\fR
+Prints the session key to stderr
+
+.TP
+\fB\-\-dump\fR
+Prints a packet dump to stderr
+
+.TP
+\fB\-x\fR, \fB\-\-hex\fR
+Prints a hexdump (implies \-\-dump)
+.SH OPTIONS
+.TP
+\fB\-o\fR, \fB\-\-output\fR FILE
+Writes to FILE or stdout if omitted
+
+.TP
+\fB\-n\fR, \fB\-\-signatures\fR N
+Sets the threshold of valid signatures to N. If this threshold is not reached, the message will not be considered verified. [default: 0]
+
+.TP
+\fB\-\-signer\-cert\fR CERT
+Verifies signatures with CERT
+
+.TP
+\fB\-\-recipient\-key\fR KEY
+Decrypts with KEY
+.SH ARGS
+.TP
+FILE
+Reads from FILE or stdin if omitted
+.SH EXAMPLES
+.TP
+# Decrypt a file using a secret key
+\fB $ sq decrypt \-\-recipient\-key juliet.pgp ciphertext.pgp\fR
+.TP
+# Decrypt a file verifying signatures
+\fB $ sq decrypt \-\-recipient\-key juliet.pgp \-\-signer\-cert romeo.pgp ciphertext.pgp\fR
+.TP
+# Decrypt a file using a password
+\fB $ sq decrypt ciphertext.pgp\fR
+
+.SH SEE ALSO
+For the full documentation see <https://docs.sequoia\-pgp.org/sq/>.
+
+.ad l
+.nh
+sq(1), sq\-armor(1), sq\-certify(1), sq\-dearmor(1), sq\-decrypt(1), sq\-encrypt(1), sq\-inspect(1), sq\-key(1), sq\-keyring(1), sq\-keyserver(1), sq\-packet(1), sq\-sign(1), sq\-verify(1), sq\-wkd(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>