NAME

sq - A command-line frontend for Sequoia, an implementation of OpenPGP

SYNOPSIS

sq [-f|--force] [--no-cert-store] [--cert-store] [--pep-cert-store] [--keyring] [--output-format] [--output-version] [--known-notation] [--time] [--trust-root] [-h|--help] [-V|--version] <subcommands>

DESCRIPTION

A command-line frontend for Sequoia, an implementation of OpenPGP

Functionality is grouped and available using subcommands. This interface is not completely stateless. In particular, the user's default certificate store is used. This can be disabled using "--no-cert-store".

OpenPGP data can be provided in binary or ASCII armored form. This will be handled automatically. Emitted OpenPGP data is ASCII armored by default.

We use the term "certificate", or cert for short, to refer to OpenPGP keys that do not contain secrets. Conversely, we use the term "key" to refer to OpenPGP keys that do contain secrets.

OPTIONS

-f, --force=FORCE

Overwrites existing files

--no-cert-store=NO_CERT_STORE

Disables the use of a certificate store. Normally sq uses the user's standard cert-d, which is located in $HOME/.local/share/pgp.cert.d.

--cert-store=PATH

Specifies the location of the certificate store. By default, sq uses the OpenPGP certificate directory at `$HOME/.local/share/pgp.cert.d`, and creates it if it does not exist.

--pep-cert-store=PATH

Specifies the location of a pEp certificate store. sq does not use a pEp certificate store by default; it must be explicitly enabled using this argument or the corresponding environment variable, PEP_CERT_STORE. The pEp Engine's default certificate store is at "$HOME/.pEp/keys.db".

--keyring=PATH

Specifies the location of a keyring to use. Keyrings are used in addition to any certificate store. The content of the keyring is not imported into the certificate store. When a certificate is looked up, it is looked up in all keyrings and any certificate store, and the results are merged together.

--output-format=FORMAT [default: human-readable]

Produces output in FORMAT, if possible

[possible values: human-readable, json, dot]

--output-version=VERSION

Produces output variant VERSION, such as 0.0.0. The default is the newest version. The output version is separate from the version of the sq program. To see the current supported versions, use output-versions subcommand.

--known-notation=NOTATION

Adds NOTATION to the list of known notations. This is used when validating signatures. Signatures that have unknown notations with the critical bit set are considered invalid.

--time=TIME

Sets the reference time as an ISO 8601 formatted timestamp. Normally, commands use the current time as the reference time. This argument allows the user to use a difference reference time. For instance, when creating a key using "sq key generate", the creation time is normally set to the current time, but can be overridden using this option. Similarly, when verifying a message, the message is verified with respect to the current time. This option allows the user to use a different time.

TIME is interpreted as an ISO 8601 timestamp. To set the certification time to June 9, 2011 at midnight UTC, you can do:

$ sq --time 20130721 verify msg.pgp

To include a time, add a T, the time and optionally the timezone (the default timezone is UTC):

$ sq --time 20130721T0550+0200 verify msg.pgp

--trust-root=FINGERPRINT|KEYID

Considers the specified certificate to be a trust root. Trust roots are used by trust models, e.g., the web of trust, to authenticate certificates and User IDs.

-h, --help

Print help information (use `-h` for a summary)

-V, --version

Print version information

SUBCOMMANDS

sq-encrypt(1)

Encrypts a message

sq-decrypt(1)

Decrypts a message

sq-sign(1)

Signs messages or data files

sq-verify(1)

Verifies signed messages or detached signatures

sq-key(1)

Manages keys

sq-keyring(1)

Manages collections of keys or certs

sq-import(1)

Imports certificates into the local certificate store

sq-export(1)

Exports certificates from the local certificate store

sq-certify(1)

Certifies a User ID for a Certificate

sq-link(1)

Manages authenticated certificate and User ID links

sq-wot(1)

Command-line frontends for Sequoia

sq-autocrypt(1)

Communicates certificates using Autocrypt

sq-keyserver(1)

Interacts with keyservers

sq-wkd(1)

Interacts with Web Key Directories

sq-dane(1)

Interacts with DANE

sq-armor(1)

Converts binary to ASCII

sq-dearmor(1)

Converts ASCII to binary

sq-inspect(1)

Inspects data, like file(1)

sq-packet(1)

Low-level packet manipulation

sq-revoke(1)

Generates revocation certificates

sq-output-versions(1)

List supported output versions

sq-help(1)

Print this message or the help of the given subcommand(s)

VERSION

v0.30.1 (sequoia-openpgp 1.16.0, using Nettle 3.9 (Cv448: true))