summaryrefslogtreecommitdiffstats
path: root/sq/sq-inspect.1
diff options
context:
space:
mode:
Diffstat (limited to 'sq/sq-inspect.1')
-rw-r--r--sq/sq-inspect.156
1 files changed, 56 insertions, 0 deletions
diff --git a/sq/sq-inspect.1 b/sq/sq-inspect.1
new file mode 100644
index 00000000..35beaefb
--- /dev/null
+++ b/sq/sq-inspect.1
@@ -0,0 +1,56 @@
+.TH SQ-INSPECT "1" "JANUARY 2021" " " "USER COMMANDS" 5
+.SH NAME
+sq inspect \- Inspects data, like file(1)
+
+It is often difficult to tell from cursory inspection using cat(1) or
+file(1) what kind of OpenPGP one is looking at. This subcommand
+inspects the data and provides a meaningful human\-readable description
+of it.
+
+.SH SYNOPSIS
+\fBsq inspect\fR [FLAGS] [\-\-] [FILE]
+.SH FLAGS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Prints help information
+
+.TP
+\fB\-\-certifications\fR
+Prints third\-party certifications
+.SH ARGS
+.TP
+FILE
+Reads from FILE or stdin if omitted
+.SH EXAMPLES
+.TP
+Inspects a certificate
+\fB$ sq inspect juliet.pgp\fR
+.TP
+Inspects a certificate ring
+\fB$ sq inspect certs.pgp\fR
+.TP
+Inspects a message
+\fB$ sq inspect message.pgp\fR
+.TP
+Inspects a detached signature
+\fB$ sq inspect message.sig\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>