summaryrefslogtreecommitdiffstats
path: root/sq/sq-decrypt.1
blob: 922c68cd51acc0722e5c69d3175c552fdb1092f1 (plain)
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
.TH SQ-DECRYPT "1" "JANUARY 2021" " " "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\-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>