{ "content": [ { "type": "text", "text": "# gpg (man)\n\n## NAME\n\ngpg - OpenPGP encryption and signing tool\n\n## SYNOPSIS\n\ngpg [--homedir dir] [--options file] [options] command [args]\n\n## DESCRIPTION\n\ngpg is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a tool to provide digital en‐\ncryption and signing services using the OpenPGP standard. gpg features complete key manage‐\nment and all the bells and whistles you would expect from a full OpenPGP implementation.\n\n## TLDR\n\n> GNU Privacy Guard, an OpenPGP encryption and signing tool.\n\n- Create a GPG public and private key interactively:\n `gpg {{--full-gen-key|--full-generate-key}}`\n- List all keys from the public keyring:\n `gpg {{-k|--list-keys}}`\n- Sign `doc.txt` without encryption (writes output to `doc.txt.asc`):\n `gpg --clearsign {{doc.txt}}`\n- Encrypt and sign `doc.txt` for `alice@example.com` and `bob@example.com` (output to `doc.txt.gpg`):\n `gpg {{-es|--encrypt --sign}} {{-r|--recipient}} {{alice@example.com}} {{-r|--recipient}} {{bob@example.com}} {{doc.txt}}`\n- Encrypt `doc.txt` with only a passphrase (output to `doc.txt.gpg`):\n `gpg {{-c|--symmetric}} {{doc.txt}}`\n- Decrypt `doc.txt.gpg` (output to `stdout`):\n `gpg {{-d|--decrypt}} {{doc.txt.gpg}}`\n- Import a public key from WKD (Web Key Directory) if the key isn't already in the keyring:\n `gpg --locate-keys {{alice@example.com}}`\n- Export the public/private key for `alice@example.com` (output to `stdout`):\n `gpg {{-export|--export-secret-keys}} {{-a|--armor}} {{alice@example.com}}`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **RETURN VALUE**\n- **WARNINGS**\n- **INTEROPERABILITY**\n- **COMMANDS** (63 subsections)\n- **OPTIONS** (163 subsections)\n- **EXAMPLES** (5 subsections)\n- **HOW TO SPECIFY A USER ID** (11 subsections)\n- **FILTER EXPRESSIONS** (9 subsections)\n- **TRUST VALUES** (6 subsections)\n- **FILES** (12 subsections)\n- **BUGS**\n- **SEE ALSO**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "gpg", "section": "", "mode": "man", "summary": "gpg - OpenPGP encryption and signing tool", "synopsis": "gpg [--homedir dir] [--options file] [options] command [args]", "tldr_summary": "GNU Privacy Guard, an OpenPGP encryption and signing tool.", "tldr_examples": [ { "description": "Create a GPG public and private key interactively", "command": "gpg {{--full-gen-key|--full-generate-key}}" }, { "description": "List all keys from the public keyring", "command": "gpg {{-k|--list-keys}}" }, { "description": "Sign `doc.txt` without encryption (writes output to `doc.txt.asc`)", "command": "gpg --clearsign {{doc.txt}}" }, { "description": "Encrypt and sign `doc.txt` for `alice@example.com` and `bob@example.com` (output to `doc.txt.gpg`)", "command": "gpg {{-es|--encrypt --sign}} {{-r|--recipient}} {{alice@example.com}} {{-r|--recipient}} {{bob@example.com}} {{doc.txt}}" }, { "description": "Encrypt `doc.txt` with only a passphrase (output to `doc.txt.gpg`)", "command": "gpg {{-c|--symmetric}} {{doc.txt}}" }, { "description": "Decrypt `doc.txt.gpg` (output to `stdout`)", "command": "gpg {{-d|--decrypt}} {{doc.txt.gpg}}" }, { "description": "Import a public key from WKD (Web Key Directory) if the key isn't already in the keyring", "command": "gpg --locate-keys {{alice@example.com}}" }, { "description": "Export the public/private key for `alice@example.com` (output to `stdout`)", "command": "gpg {{-export|--export-secret-keys}} {{-a|--armor}} {{alice@example.com}}" } ], "tldr_source": "official", "flags": [ { "flag": "", "long": "--default-recipient-self", "arg": null, "description": "Use the default key as default recipient if option --recipient is not used and don't ask if this is a valid one. The default key is the first one from the secret keyring or the one set with --default-key." }, { "flag": "", "long": "--no-default-recipient", "arg": null, "description": "Reset --default-recipient and --default-recipient-self." }, { "flag": "-v", "long": "--verbose", "arg": null, "description": "Give more information during processing. If used twice, the input data is listed in detail." }, { "flag": "", "long": "--no-verbose", "arg": null, "description": "Reset verbose level to 0." }, { "flag": "-q", "long": "--quiet", "arg": null, "description": "Try to be as quiet as possible." }, { "flag": "", "long": "--batch", "arg": null, "description": "" }, { "flag": "", "long": "--no-batch", "arg": null, "description": "Use batch mode. Never ask, do not allow interactive commands. --no-batch disables this option. Note that even with a filename given on the command line, gpg might still need to read from STDIN (in particular if gpg figures that the input is a de‐ tached signature and no data file has been specified). Thus if you do not want to feed data via STDIN, you should connect STDIN to g‘/dev/null’. It is highly recommended to use this option along with the options --status-fd and --with-colons for any unattended use of gpg." }, { "flag": "", "long": "--no-tty", "arg": null, "description": "Make sure that the TTY (terminal) is never used for any output. This option is needed in some cases because GnuPG sometimes prints warnings to the TTY even if --batch is used. --yes Assume \"yes\" on most questions. --no Assume \"no\" on most questions. --list-options parameters This is a space or comma delimited string that gives options used when listing keys and signatures (that is, --list-keys, --check-signatures, --list-public-keys, --list- secret-keys, and the --edit-key functions). Options can be prepended with a no- (af‐ ter the two dashes) to give the opposite meaning. The options are: show-photos Causes --list-keys, --check-signatures, --list-public-keys, and --list-secret- keys to display any photo IDs attached to the key. Defaults to no. See also --photo-viewer. Does not work with --with-colons: see --attribute-fd for the appropriate way to get photo data for scripts and other frontends. show-usage Show usage information for keys and subkeys in the standard key listing. This is a list of letters indicating the allowed usage for a key (E=encryption, S=signing, C=certification, A=authentication). Defaults to yes. show-policy-urls Show policy URLs in the --check-signatures listings. Defaults to no. show-notations show-std-notations show-user-notations Show all, IETF standard, or user-defined signature notations in the --check- signatures listings. Defaults to no. show-keyserver-urls Show any preferred keyserver URL in the --check-signatures listings. Defaults to no. show-uid-validity Display the calculated validity of user IDs during key listings. Defaults to yes. show-unusable-uids Show revoked and expired user IDs in key listings. Defaults to no. show-unusable-subkeys Show revoked and expired subkeys in key listings. Defaults to no. show-keyring Display the keyring name at the head of key listings to show which keyring a given key resides on. Defaults to no. show-sig-expire Show signature expiration dates (if any) during --check-signatures listings. Defaults to no. show-sig-subpackets Include signature subpackets in the key listing. This option can take an op‐ tional argument list of the subpackets to list. If no argument is passed, list all subpackets. Defaults to no. This option is only meaningful when using --with-colons along with --check-signatures. show-only-fpr-mbox For each user-id which has a valid mail address print only the fingerprint fol‐ lowed by the mail address. --verify-options parameters This is a space or comma delimited string that gives options used when verifying sig‐ natures. Options can be prepended with a `no-' to give the opposite meaning. The op‐ tions are: show-photos Display any photo IDs present on the key that issued the signature. Defaults to no. See also --photo-viewer. show-policy-urls Show policy URLs in the signature being verified. Defaults to yes. show-notations show-std-notations show-user-notations Show all, IETF standard, or user-defined signature notations in the signature being verified. Defaults to IETF standard. show-keyserver-urls Show any preferred keyserver URL in the signature being verified. Defaults to yes. show-uid-validity Display the calculated validity of the user IDs on the key that issued the sig‐ nature. Defaults to yes. show-unusable-uids Show revoked and expired user IDs during signature verification. Defaults to no. show-primary-uid-only Show only the primary user ID during signature verification. That is all the AKA lines as well as photo Ids are not shown with the signature verification status. pka-lookups Enable PKA lookups to verify sender addresses. Note that PKA is based on DNS, and so enabling this option may disclose information on when and what signa‐ tures are verified or to whom data is encrypted. This is similar to the \"web bug\" described for the --auto-key-retrieve option. pka-trust-increase Raise the trust in a signature to full if the signature passes PKA validation. This option is only meaningful if pka-lookups is set." }, { "flag": "", "long": "--enable-large-rsa", "arg": null, "description": "" }, { "flag": "", "long": "--disable-large-rsa", "arg": null, "description": "With --generate-key and --batch, enable the creation of RSA secret keys as large as 8192 bit. Note: 8192 bit is more than is generally recommended. These large keys don't significantly improve security, but they are more expensive to use, and their signatures and certifications are larger. This option is only available if the binary was build with large-secmem support." }, { "flag": "", "long": "--enable-dsa2", "arg": null, "description": "" }, { "flag": "", "long": "--disable-dsa2", "arg": null, "description": "Enable hash truncation for all DSA keys even for old DSA Keys up to 1024 bit. This is also the default with --openpgp. Note that older versions of GnuPG also required this flag to allow the generation of DSA larger than 1024 bit. --photo-viewer string This is the command line that should be run to view a photo ID. \"%i\" will be expanded to a filename containing the photo. \"%I\" does the same, except the file will not be deleted once the viewer exits. Other flags are \"%k\" for the key ID, \"%K\" for the long key ID, \"%f\" for the key fingerprint, \"%t\" for the extension of the image type (e.g. \"jpg\"), \"%T\" for the MIME type of the image (e.g. \"image/jpeg\"), \"%v\" for the single- character calculated validity of the image being viewed (e.g. \"f\"), \"%V\" for the cal‐ culated validity as a string (e.g. \"full\"), \"%U\" for a base32 encoded hash of the user ID, and \"%%\" for an actual percent sign. If neither %i or %I are present, then the photo will be supplied to the viewer on standard input. On Unix the default viewer is xloadimage -fork -quiet -title 'KeyID 0x%k' STDIN with a fallback to display -title 'KeyID 0x%k' %i and finally to xdg-open %i. On Windows !ShellExecute 400 %i is used; here the command is a meta command to use that API call followed by a wait time in milliseconds which is used to give the viewer time to read the temporary image file before gpg deletes it again. Note that if your image viewer program is not secure, then executing it from gpg does not make it secure. --exec-path string Sets a list of directories to search for photo viewers If not provided photo viewers use the PATH environment variable. --keyring file Add file to the current list of keyrings. If file begins with a tilde and a slash, these are replaced by the $HOME directory. If the filename does not contain a slash, it is assumed to be in the GnuPG home directory (\"~/.gnupg\" if --homedir or $GNUPGHOME is not used). Note that this adds a keyring to the current list. If the intent is to use the speci‐ fied keyring alone, use --keyring along with --no-default-keyring. If the option --no-keyring has been used no keyrings will be used at all. --secret-keyring file This is an obsolete option and ignored. All secret keys are stored in the ‘private- keys-v1.d’ directory below the GnuPG home directory. --primary-keyring file Designate file as the primary public keyring. This means that newly imported keys (via --import or keyserver --recv-from) will go to this keyring. --trustdb-name file Use file instead of the default trustdb. If file begins with a tilde and a slash, these are replaced by the $HOME directory. If the filename does not contain a slash, it is assumed to be in the GnuPG home directory (‘~/.gnupg’ if --homedir or $GNUPGHOME is not used). --homedir dir Set the name of the home directory to dir. If this option is not used, the home direc‐ tory defaults to ‘~/.gnupg’. It is only recognized when given on the command line. It also overrides any home directory stated through the environment variable ‘GNUPGHOME’ or (on Windows systems) by means of the Registry entry HKCU\\Soft‐ ware\\GNU\\GnuPG:HomeDir. On Windows systems it is possible to install GnuPG as a portable application. In this case only this command line option is considered, all other ways to set a home direc‐ tory are ignored. To install GnuPG as a portable application under Windows, create an empty file named ‘gpgconf.ctl’ in the same directory as the tool ‘gpgconf.exe’. The root of the in‐ stallation is then that directory; or, if ‘gpgconf.exe’ has been installed directly below a directory named ‘bin’, its parent directory. You also need to make sure that the following directories exist and are writable: ‘ROOT/home’ for the GnuPG home and ‘ROOT/var/cache/gnupg’ for internal cache files. --display-charset name Set the name of the native character set. This is used to convert some informational strings like user IDs to the proper UTF-8 encoding. Note that this has nothing to do with the character set of data to be encrypted or signed; GnuPG does not recode user- supplied data. If this option is not used, the default character set is determined from the current locale. A verbosity level of 3 shows the chosen set. Valid values for name are: iso-8859-1 This is the Latin 1 set. iso-8859-2 The Latin 2 set. iso-8859-15 This is currently an alias for the Latin 1 set. koi8-r The usual Russian set (RFC-1489). utf-8 Bypass all translations and assume that the OS uses native UTF-8 encoding." }, { "flag": "", "long": "--utf8-strings", "arg": null, "description": "" }, { "flag": "", "long": "--no-utf8-strings", "arg": null, "description": "Assume that command line arguments are given as UTF-8 strings. The default (--no- utf8-strings) is to assume that arguments are encoded in the character set as speci‐ fied by --display-charset. These options affect all following arguments. Both options may be used multiple times. --options file Read options from file and do not try to read them from the default options file in the homedir (see --homedir). This option is ignored if used in an options file." }, { "flag": "", "long": "--no-options", "arg": null, "description": "Shortcut for --options /dev/null. This option is detected before an attempt to open an option file. Using this option will also prevent the creation of a ‘~/.gnupg’ home‐ dir." }, { "flag": "-z", "long": null, "arg": null, "description": "--compress-level n --bzip2-compress-level n Set compression level to n for the ZIP and ZLIB compression algorithms. The default is to use the default compression level of zlib (normally 6). --bzip2-compress-level sets the compression level for the BZIP2 compression algorithm (defaulting to 6 as well). This is a different option from --compress-level since BZIP2 uses a significant amount of memory for each additional compression level. -z sets both. A value of 0 for n disables compression." }, { "flag": "", "long": "--bzip2-decompress-lowmem", "arg": null, "description": "Use a different decompression method for BZIP2 compressed files. This alternate method uses a bit more than half the memory, but also runs at half the speed. This is useful under extreme low memory circumstances when the file was originally compressed at a high --bzip2-compress-level." }, { "flag": "", "long": "--mangle-dos-filenames", "arg": null, "description": "" }, { "flag": "", "long": "--no-mangle-dos-filenames", "arg": null, "description": "Older version of Windows cannot handle filenames with more than one dot. --mangle-dos- filenames causes GnuPG to replace (rather than add to) the extension of an output filename to avoid this problem. This option is off by default and has no effect on non-Windows platforms." }, { "flag": "", "long": "--ask-cert-level", "arg": null, "description": "" }, { "flag": "", "long": "--no-ask-cert-level", "arg": null, "description": "When making a key signature, prompt for a certification level. If this option is not specified, the certification level used is set via --default-cert-level. See --de‐‐ fault-cert-level for information on the specific levels and how they are used. --no- ask-cert-level disables this option. This option defaults to no. --default-cert-level n The default to use for the check level when signing a key. 0 means you make no particular claim as to how carefully you verified the key. 1 means you believe the key is owned by the person who claims to own it but you could not, or did not verify the key at all. This is useful for a \"persona\" verification, where you sign the key of a pseudonymous user. 2 means you did casual verification of the key. For example, this could mean that you verified the key fingerprint and checked the user ID on the key against a photo ID. 3 means you did extensive verification of the key. For example, this could mean that you verified the key fingerprint with the owner of the key in person, and that you checked, by means of a hard to forge document with a photo ID (such as a passport) that the name of the key owner matches the name in the user ID on the key, and finally that you verified (by exchange of email) that the email address on the key belongs to the key owner. Note that the examples given above for levels 2 and 3 are just that: examples. In the end, it is up to you to decide just what \"casual\" and \"extensive\" mean to you. This option defaults to 0 (no particular claim)." }, { "flag": "", "long": "--min-cert-level", "arg": null, "description": "When building the trust database, treat any signatures with a certification level be‐ low this as invalid. Defaults to 2, which disregards level 1 signatures. Note that level 0 \"no particular claim\" signatures are always accepted. --trusted-key long key ID or fingerprint Assume that the specified key (which must be given as a full 8 byte key ID or 20 byte fingerprint) is as trustworthy as one of your own secret keys. This option is useful if you don't want to keep your secret keys (or one of them) online but still want to be able to check the validity of a given recipient's or signator's key." }, { "flag": "", "long": "--trust-model", "arg": null, "description": "Set what trust model GnuPG should follow. The models are: pgp This is the Web of Trust combined with trust signatures as used in PGP 5.x and later. This is the default trust model when creating a new trust database. classic This is the standard Web of Trust as introduced by PGP 2. tofu TOFU stands for Trust On First Use. In this trust model, the first time a key is seen, it is memorized. If later another key with a user id with the same email address is seen, both keys are marked as suspect. In that case, the next time either is used, a warning is displayed describing the conflict, why it might have occurred (either the user generated a new key and failed to cross sign the old and new keys, the key is forgery, or a man-in-the-middle attack is being attempted), and the user is prompted to manually confirm the validity of the key in question. Because a potential attacker is able to control the email address and thereby circumvent the conflict detection algorithm by using an email address that is similar in appearance to a trusted email address, whenever a message is veri‐ fied, statistics about the number of messages signed with the key are shown. In this way, a user can easily identify attacks using fake keys for regular correspondents. When compared with the Web of Trust, TOFU offers significantly weaker security guarantees. In particular, TOFU only helps ensure consistency (that is, that the binding between a key and email address doesn't change). A major advantage of TOFU is that it requires little maintenance to use correctly. To use the web of trust properly, you need to actively sign keys and mark users as trusted introducers. This is a time-consuming process and anecdotal evidence suggests that even security-conscious users rarely take the time to do this thoroughly and instead rely on an ad-hoc TOFU process. In the TOFU model, policies are associated with bindings between keys and email addresses (which are extracted from user ids and normalized). There are five policies, which can be set manually using the --tofu-policy option. The de‐ fault policy can be set using the --tofu-default-policy option. The TOFU policies are: auto, good, unknown, bad and ask. The auto policy is used by default (unless overridden by --tofu-default-policy) and marks a bind‐ ing as marginally trusted. The good, unknown and bad policies mark a binding as fully trusted, as having unknown trust or as having trust never, respec‐ tively. The unknown policy is useful for just using TOFU to detect conflicts, but to never assign positive trust to a binding. The final policy, ask prompts the user to indicate the binding's trust. If batch mode is enabled (or input is inappropriate in the context), then the user is not prompted and the unde‐‐ fined trust level is returned. tofu+pgp This trust model combines TOFU with the Web of Trust. This is done by comput‐ ing the trust level for each model and then taking the maximum trust level where the trust levels are ordered as follows: unknown < undefined < marginal < fully < ultimate < expired < never. By setting --tofu-default-policy=unknown, this model can be used to implement the web of trust with TOFU's conflict detection algorithm, but without its as‐ signment of positive trust values, which some security-conscious users don't like. direct Key validity is set directly by the user and not calculated via the Web of Trust. This model is solely based on the key and does not distinguish user IDs. Note that when changing to another trust model the trust values assigned to a key are transformed into ownertrust values, which also indicate how you trust the owner of the key to sign other keys. always Skip key validation and assume that used keys are always fully valid. You gen‐ erally won't use this unless you are using some external validation scheme. This option also suppresses the \"[uncertain]\" tag printed with signature checks when there is no evidence that the user ID is bound to the key. Note that this trust model still does not allow the use of expired, revoked, or disabled keys. auto Select the trust model depending on whatever the internal trust database says. This is the default model if such a database already exists. Note that a tofu trust model is not considered here and must be enabled explicitly. --auto-key-locate mechanisms" }, { "flag": "", "long": "--no-auto-key-locate", "arg": null, "description": "GnuPG can automatically locate and retrieve keys as needed using this option. This happens when encrypting to an email address (in the \"user@example.com\" form), and there are no \"user@example.com\" keys on the local keyring. This option takes any num‐ ber of the mechanisms listed below, in the order they are to be tried. Instead of listing the mechanisms as comma delimited arguments, the option may also be given sev‐ eral times to add more mechanism. The option --no-auto-key-locate or the mechanism \"clear\" resets the list. The default is \"local,wkd\". cert Locate a key using DNS CERT, as specified in RFC-4398. pka Locate a key using DNS PKA. dane Locate a key using DANE, as specified in draft-ietf-dane-openpgpkey-05.txt. wkd Locate a key using the Web Key Directory protocol. ldap Using DNS Service Discovery, check the domain in question for any LDAP key‐ servers to use. If this fails, attempt to locate the key using the PGP Univer‐ sal method of checking ‘ldap://keys.(thedomain)’. ntds Locate the key using the Active Directory (Windows only). keyserver Locate a key using a keyserver. keyserver-URL In addition, a keyserver URL as used in the dirmngr configuration may be used here to query that particular keyserver. local Locate the key using the local keyrings. This mechanism allows the user to se‐ lect the order a local key lookup is done. Thus using ‘--auto-key-locate lo‐ cal’ is identical to --no-auto-key-locate. nodefault This flag disables the standard local key lookup, done before any of the mecha‐ nisms defined by the --auto-key-locate are tried. The position of this mecha‐ nism in the list does not matter. It is not required if local is also used. clear Clear all defined mechanisms. This is useful to override mechanisms given in a config file. Note that a nodefault in mechanisms will also be cleared unless it is given after the clear." }, { "flag": "", "long": "--auto-key-import", "arg": null, "description": "" }, { "flag": "", "long": "--no-auto-key-import", "arg": null, "description": "This is an offline mechanism to get a missing key for signature verification and for later encryption to this key. If this option is enabled and a signature includes an embedded key, that key is used to verify the signature and on verification success that key is imported. The default is --no-auto-key-import. On the sender (signing) site the option --include-key-block needs to be used to put the public part of the signing key as “Key Block subpacket” into the signature." }, { "flag": "", "long": "--auto-key-retrieve", "arg": null, "description": "" }, { "flag": "", "long": "--no-auto-key-retrieve", "arg": null, "description": "These options enable or disable the automatic retrieving of keys from a keyserver when verifying signatures made by keys that are not on the local keyring. The default is --no-auto-key-retrieve. The order of methods tried to lookup the key is: 1. If the option --auto-key-import is set and the signatures includes an embedded key, that key is used to verify the signature and on verification success that key is im‐ ported. 2. If a preferred keyserver is specified in the signature and the option honor-key‐‐ server-url is active (which is not the default), that keyserver is tried. Note that the creator of the signature uses the option --sig-keyserver-url to specify the pre‐ ferred keyserver for data signatures. 3. If the signature has the Signer's UID set (e.g. using --sender while creating the signature) a Web Key Directory (WKD) lookup is done. This is the default configura‐ tion but can be disabled by removing WKD from the auto-key-locate list or by using the option --disable-signer-uid. 4. If the option honor-pka-record is active, the legacy PKA method is used. 5. If any keyserver is configured and the Issuer Fingerprint is part of the signature (since GnuPG 2.1.16), the configured keyservers are tried. Note that this option makes a \"web bug\" like behavior possible. Keyserver or Web Key Directory operators can see which keys you request, so by sending you a message signed by a brand new key (which you naturally will not have on your local keyring), the op‐ erator can tell both your IP address and the time when you verified the signature." }, { "flag": "", "long": "--keyid-format", "arg": null, "description": "Select how to display key IDs. \"none\" does not show the key ID at all but shows the fingerprint in a separate line. \"short\" is the traditional 8-character key ID. \"long\" is the more accurate (but less convenient) 16-character key ID. Add an \"0x\" to either to include an \"0x\" at the beginning of the key ID, as in 0x99242560. Note that this option is ignored if the option --with-colons is used. --keyserver name This option is deprecated - please use the --keyserver in ‘dirmngr.conf’ instead. Use name as your keyserver. This is the server that --receive-keys, --send-keys, and --search-keys will communicate with to receive keys from, send keys to, and search for keys on. The format of the name is a URI: `scheme:[//]keyservername[:port]' The scheme is the type of keyserver: \"hkp\" for the HTTP (or compatible) keyservers, \"ldap\" for the LDAP keyservers, or \"mailto\" for the Graff email keyserver. Note that your partic‐ ular installation of GnuPG may have other keyserver types available as well. Keyserver schemes are case-insensitive. After the keyserver name, optional keyserver configura‐ tion options may be provided. These are the same as the global --keyserver-options from below, but apply only to this particular keyserver. Most keyservers synchronize with each other, so there is generally no need to send keys to more than one server. The keyserver hkp://keys.gnupg.net uses round robin DNS to give a different keyserver each time you use it. --keyserver-options {name=value} This is a space or comma delimited string that gives options for the keyserver. Op‐ tions can be prefixed with a `no-' to give the opposite meaning. Valid import-options or export-options may be used here as well to apply to importing (--recv-key) or ex‐ porting (--send-key) a key from a keyserver. While not all options are available for all keyserver types, some common options are: include-revoked When searching for a key with --search-keys, include keys that are marked on the keyserver as revoked. Note that not all keyservers differentiate between revoked and unrevoked keys, and for such keyservers this option is meaningless. Note also that most keyservers do not have cryptographic verification of key revocations, and so turning this option off may result in skipping keys that are incorrectly marked as revoked. include-disabled When searching for a key with --search-keys, include keys that are marked on the keyserver as disabled. Note that this option is not used with HKP key‐ servers. auto-key-retrieve This is an obsolete alias for the option auto-key-retrieve. Please do not use it; it will be removed in future versions.. honor-keyserver-url When using --refresh-keys, if the key in question has a preferred keyserver URL, then use that preferred keyserver to refresh the key from. In addition, if auto-key-retrieve is set, and the signature being verified has a preferred key‐ server URL, then use that preferred keyserver to fetch the key from. Note that this option introduces a \"web bug\": The creator of the key can see when the keys is refreshed. Thus this option is not enabled by default. honor-pka-record If --auto-key-retrieve is used, and the signature being verified has a PKA record, then use the PKA information to fetch the key. Defaults to \"yes\". include-subkeys When receiving a key, include subkeys as potential targets. Note that this op‐ tion is not used with HKP keyservers, as they do not support retrieving keys by subkey id. timeout http-proxy=value verbose debug check-cert ca-cert-file These options have no more function since GnuPG 2.1. Use the dirmngr configu‐ ration options instead. The default list of options is: \"self-sigs-only, repair-keys, repair-pks-subkey-bug, export- attributes, honor-pka-record\". --completes-needed n Number of completely trusted users to introduce a new key signer (defaults to 1). --marginals-needed n Number of marginally trusted users to introduce a new key signer (defaults to 3)" }, { "flag": "", "long": "--tofu-default-policy", "arg": null, "description": "The default TOFU policy (defaults to auto). For more information about the meaning of this option, see: [trust-model-tofu]. --max-cert-depth n Maximum depth of a certification chain (default is 5)." }, { "flag": "", "long": "--no-sig-cache", "arg": null, "description": "Do not cache the verification status of key signatures. Caching gives a much better performance in key listings. However, if you suspect that your public keyring is not safe against write modifications, you can use this option to disable the caching. It probably does not make sense to disable it because all kind of damage can be done if someone else has write access to your public keyring." }, { "flag": "", "long": "--auto-check-trustdb", "arg": null, "description": "" }, { "flag": "", "long": "--no-auto-check-trustdb", "arg": null, "description": "If GnuPG feels that its information about the Web of Trust has to be updated, it auto‐ matically runs the --check-trustdb command internally. This may be a time consuming process. --no-auto-check-trustdb disables this option." }, { "flag": "", "long": "--use-agent", "arg": null, "description": "" }, { "flag": "", "long": "--no-use-agent", "arg": null, "description": "This is dummy option. gpg always requires the agent." }, { "flag": "", "long": "--gpg-agent-info", "arg": null, "description": "This is dummy option. It has no effect when used with gpg. --agent-program file Specify an agent program to be used for secret key operations. The default value is determined by running gpgconf with the option --list-dirs. Note that the pipe symbol (|) is used for a regression test suite hack and may thus not be used in the file name. --dirmngr-program file Specify a dirmngr program to be used for keyserver access. The default value is ‘/usr/bin/dirmngr’." }, { "flag": "", "long": "--disable-dirmngr", "arg": null, "description": "Entirely disable the use of the Dirmngr." }, { "flag": "", "long": "--no-autostart", "arg": null, "description": "Do not start the gpg-agent or the dirmngr if it has not yet been started and its ser‐ vice is required. This option is mostly useful on machines where the connection to gpg-agent has been redirected to another machines. If dirmngr is required on the re‐ mote machine, it may be started manually using gpgconf --launch dirmngr." }, { "flag": "", "long": "--lock-once", "arg": null, "description": "Lock the databases the first time a lock is requested and do not release the lock un‐ til the process terminates." }, { "flag": "", "long": "--lock-multiple", "arg": null, "description": "Release the locks every time a lock is no longer needed. Use this to override a previ‐ ous --lock-once from a config file." }, { "flag": "", "long": "--lock-never", "arg": null, "description": "Disable locking entirely. This option should be used only in very special environ‐ ments, where it can be assured that only one process is accessing those files. A bootable floppy with a stand-alone encryption system will probably use this. Improper usage of this option may lead to data and key corruption." }, { "flag": "", "long": "--exit-on-status-write-error", "arg": null, "description": "This option will cause write errors on the status FD to immediately terminate the process. That should in fact be the default but it never worked this way and thus we need an option to enable this, so that the change won't break applications which close their end of a status fd connected pipe too early. Using this option along with --en‐‐ able-progress-filter may be used to cleanly cancel long running gpg operations. --limit-card-insert-tries n With n greater than 0 the number of prompts asking to insert a smartcard gets limited to N-1. Thus with a value of 1 gpg won't at all ask to insert a card if none has been inserted at startup. This option is useful in the configuration file in case an appli‐ cation does not know about the smartcard support and waits ad infinitum for an in‐ serted card." }, { "flag": "", "long": "--no-random-seed-file", "arg": null, "description": "GnuPG uses a file to store its internal random pool over invocations. This makes ran‐ dom generation faster; however sometimes write operations are not desired. This option can be used to achieve that with the cost of slower random generation." }, { "flag": "", "long": "--no-greeting", "arg": null, "description": "Suppress the initial copyright message." }, { "flag": "", "long": "--no-secmem-warning", "arg": null, "description": "Suppress the warning about \"using insecure memory\"." }, { "flag": "", "long": "--no-permission-warning", "arg": null, "description": "Suppress the warning about unsafe file and home directory (--homedir) permissions. Note that the permission checks that GnuPG performs are not intended to be authorita‐ tive, but rather they simply warn about certain common permission problems. Do not as‐ sume that the lack of a warning means that your system is secure. Note that the warning for unsafe --homedir permissions cannot be suppressed in the gpg.conf file, as this would allow an attacker to place an unsafe gpg.conf file in place, and use this file to suppress warnings about itself. The --homedir permissions warning may only be suppressed on the command line." }, { "flag": "", "long": "--require-secmem", "arg": null, "description": "" }, { "flag": "", "long": "--no-require-secmem", "arg": null, "description": "Refuse to run if GnuPG cannot get secure memory. Defaults to no (i.e. run, but give a warning)." }, { "flag": "", "long": "--require-cross-certification", "arg": null, "description": "" }, { "flag": "", "long": "--no-require-cross-certification", "arg": null, "description": "When verifying a signature made from a subkey, ensure that the cross certification \"back signature\" on the subkey is present and valid. This protects against a subtle attack against subkeys that can sign. Defaults to --require-cross-certification for gpg." }, { "flag": "", "long": "--expert", "arg": null, "description": "" }, { "flag": "", "long": "--no-expert", "arg": null, "description": "Allow the user to do certain nonsensical or \"silly\" things like signing an expired or revoked key, or certain potentially incompatible things like generating unusual key types. This also disables certain warning messages about potentially incompatible ac‐ tions. As the name implies, this option is for experts only. If you don't fully under‐ stand the implications of what it allows you to do, leave this off. --no-expert dis‐ ables this option." }, { "flag": "-r", "long": "--hidden-recipient", "arg": null, "description": "asks for the user-id unless --default-recipient is given. --hidden-recipient name" }, { "flag": "-R", "long": null, "arg": null, "description": "hide the receiver of the message and is a limited countermeasure against traffic analysis. If this option or --recipient is not specified, GnuPG asks for the user ID unless --default-recipient is given. --recipient-file file" }, { "flag": "-f", "long": "--recipient", "arg": null, "description": "given file. file must be the name of a file containing exactly one key. gpg assumes that the key in this file is fully valid. --hidden-recipient-file file" }, { "flag": "-F", "long": "--hidden-recipient", "arg": null, "description": "in the given file. file must be the name of a file containing exactly one key. gpg assumes that the key in this file is fully valid. --encrypt-to name Same as --recipient but this one is intended for use in the options file and may be used with your own user-id as an \"encrypt-to-self\". These keys are only used when there are other recipients given either by use of --recipient or by the asked user id. No trust checking is performed for these user ids and even disabled keys can be used. --hidden-encrypt-to name Same as --hidden-recipient but this one is intended for use in the options file and may be used with your own user-id as a hidden \"encrypt-to-self\". These keys are only used when there are other recipients given either by use of --recipient or by the asked user id. No trust checking is performed for these user ids and even disabled keys can be used." }, { "flag": "", "long": "--no-encrypt-to", "arg": null, "description": "Disable the use of all --encrypt-to and --hidden-encrypt-to keys. --group {name=value} Sets up a named group, which is similar to aliases in email programs. Any time the group name is a recipient (-r or --recipient), it will be expanded to the values spec‐ ified. Multiple groups with the same name are automatically merged into a single group. The values are key IDs or fingerprints, but any key description is accepted. Note that a value with spaces in it will be treated as two different values. Note also there is only one level of expansion --- you cannot make an group that points to another group. When used from the command line, it may be necessary to quote the argument to this op‐ tion to prevent the shell from treating it as multiple arguments. --ungroup name Remove a given entry from the --group list." }, { "flag": "", "long": "--no-groups", "arg": null, "description": "Remove all entries from the --group list. --local-user name" }, { "flag": "-u", "long": "--default-key", "arg": null, "description": "--sender mbox This option has two purposes. mbox must either be a complete user id with a proper mail address or just a mail address. When creating a signature this option tells gpg the user id of a key used to make a signature if the key was not directly specified by a user id. When verifying a signature the mbox is used to restrict the information printed by the TOFU code to matching user ids. --try-secret-key name For hidden recipients GPG needs to know the keys to use for trial decryption. The key set with --default-key is always tried first, but this is often not sufficient. This option allows setting more keys to be used for trial decryption. Although any valid user-id specification may be used for name it makes sense to use at least the long keyid to avoid ambiguities. Note that gpg-agent might pop up a pinentry for a lot keys to do the trial decryption. If you want to stop all further trial decryption you may use close-window button instead of the cancel button." }, { "flag": "", "long": "--try-all-secrets", "arg": null, "description": "Don't look at the key ID as stored in the message but try all secret keys in turn to find the right decryption key. This option forces the behaviour as used by anonymous recipients (created by using --throw-keyids or --hidden-recipient) and might come handy in case where an encrypted message contains a bogus key ID." }, { "flag": "", "long": "--skip-hidden-recipients", "arg": null, "description": "" }, { "flag": "", "long": "--no-skip-hidden-recipients", "arg": null, "description": "During decryption skip all anonymous recipients. This option helps in the case that people use the hidden recipients feature to hide their own encrypt-to key from others. If one has many secret keys this may lead to a major annoyance because all keys are tried in turn to decrypt something which was not really intended for it. The drawback of this option is that it is currently not possible to decrypt a message which in‐ cludes real anonymous recipients." }, { "flag": "", "long": "--armor", "arg": null, "description": "" }, { "flag": "-a", "long": null, "arg": null, "description": "" }, { "flag": "", "long": "--no-armor", "arg": null, "description": "Assume the input data is not in ASCII armored format. --output file" }, { "flag": "-o", "long": null, "arg": null, "description": "Write output to file. To write to stdout use - as the filename. --max-output n This option sets a limit on the number of bytes that will be generated when processing a file. Since OpenPGP supports various levels of compression, it is possible that the plaintext of a given message may be significantly larger than the original OpenPGP message. While GnuPG works properly with such messages, there is often a desire to set a maximum file size that will be generated before processing is forced to stop by the OS limits. Defaults to 0, which means \"no limit\". --input-size-hint n This option can be used to tell GPG the size of the input data in bytes. n must be a positive base-10 number. This option is only useful if the input is not taken from a file. GPG may use this hint to optimize its buffer allocation strategy. It is also used by the --status-fd line ``PROGRESS'' to provide a value for ``total'' if that is not available by other means. --key-origin string[,url] gpg can track the origin of a key. Certain origins are implicitly known (e.g. key‐ server, web key directory) and set. For a standard import the origin of the keys im‐ ported can be set with this option. To list the possible values use \"help\" for string. Some origins can store an optional url argument. That URL can appended to string after a comma. --import-options parameters This is a space or comma delimited string that gives options for importing keys. Op‐ tions can be prepended with a `no-' to give the opposite meaning. The options are: import-local-sigs Allow importing key signatures marked as \"local\". This is not generally useful unless a shared keyring scheme is being used. Defaults to no. keep-ownertrust Normally possible still existing ownertrust values of a key are cleared if a key is imported. This is in general desirable so that a formerly deleted key does not automatically gain an ownertrust values merely due to import. On the other hand it is sometimes necessary to re-import a trusted set of keys again but keeping already assigned ownertrust values. This can be achieved by using this option. repair-pks-subkey-bug During import, attempt to repair the damage caused by the PKS keyserver bug (pre version 0.9.6) that mangles keys with multiple subkeys. Note that this cannot completely repair the damaged key as some crucial data is removed by the keyserver, but it does at least give you back one subkey. Defaults to no for regular --import and to yes for keyserver --receive-keys. import-show show-only Show a listing of the key as imported right before it is stored. This can be combined with the option --dry-run to only look at keys; the option show-only is a shortcut for this combination. The command --show-keys is another short‐ cut for this. Note that suffixes like '#' for \"sec\" and \"sbb\" lines may or may not be printed. import-export Run the entire import code but instead of storing the key to the local keyring write it to the output. The export options export-pka and export-dane affect the output. This option can be used to remove all invalid parts from a key without the need to store it. merge-only During import, allow key updates to existing keys, but do not allow any new keys to be imported. Defaults to no. import-clean After import, compact (remove all signatures except the self-signature) any user IDs from the new key that are not usable. Then, remove any signatures from the new key that are not usable. This includes signatures that were is‐ sued by keys that are not present on the keyring. This option is the same as running the --edit-key command \"clean\" after import. Defaults to no. self-sigs-only Accept only self-signatures while importing a key. All other key signatures are skipped at an early import stage. This option can be used with keyserver- options to mitigate attempts to flood a key with bogus signatures from a key‐ server. The drawback is that all other valid key signatures, as required by the Web of Trust are also not imported. Note that when using this option along with import-clean it suppresses the final clean step after merging the imported key into the existing key. repair-keys After import, fix various problems with the keys. For example, this reorders signatures, and strips duplicate signatures. Defaults to yes. import-minimal Import the smallest key possible. This removes all signatures except the most recent self-signature on each user ID. This option is the same as running the --edit-key command \"minimize\" after import. Defaults to no. restore import-restore Import in key restore mode. This imports all data which is usually skipped during import; including all GnuPG specific data. All other contradicting op‐ tions are overridden. --import-filter {name=expr} --export-filter {name=expr} These options define an import/export filter which are applied to the imported/ex‐ ported keyblock right before it will be stored/written. name defines the type of fil‐ ter to use, expr the expression to evaluate. The option can be used several times which then appends more expression to the same name. The available filter types are: keep-uid This filter will keep a user id packet and its dependent packets in the key‐ block if the expression evaluates to true. drop-subkey This filter drops the selected subkeys. Currently only implemented for --ex‐ port-filter. drop-sig This filter drops the selected key signatures on user ids. Self-signatures are not considered. Currently only implemented for --import-filter. For the syntax of the expression see the chapter \"FILTER EXPRESSIONS\". The property names for the expressions depend on the actual filter type and are indicated in the following ta‐ ble. The available properties are: uid A string with the user id. (keep-uid) mbox The addr-spec part of a user id with mailbox or the empty string. (keep-uid) keyalgo A number with the public key algorithm of a key or subkey packet. (drop-sub‐ key) keycreated keycreatedd The first is the timestamp a public key or subkey packet was created. The sec‐ ond is the same but given as an ISO string, e.g. \"2016-08-17\". (drop-subkey) fpr The hexified fingerprint of the current subkey or primary key. (drop-subkey) primary Boolean indicating whether the user id is the primary one. (keep-uid) expired Boolean indicating whether a user id (keep-uid), a key (drop-subkey), or a sig‐ nature (drop-sig) expired. revoked Boolean indicating whether a user id (keep-uid) or a key (drop-subkey) has been revoked. disabled Boolean indicating whether a primary key is disabled. (not used) secret Boolean indicating whether a key or subkey is a secret one. (drop-subkey) usage A string indicating the usage flags for the subkey, from the sequence ``ecsa?''. For example, a subkey capable of just signing and authentication would be an exact match for ``sa''. (drop-subkey) sigcreated sigcreatedd The first is the timestamp a signature packet was created. The second is the same but given as an ISO date string, e.g. \"2016-08-17\". (drop-sig) sigalgo A number with the public key algorithm of a signature packet. (drop-sig) sigdigestalgo A number with the digest algorithm of a signature packet. (drop-sig) --export-options parameters This is a space or comma delimited string that gives options for exporting keys. Op‐ tions can be prepended with a `no-' to give the opposite meaning. The options are: export-local-sigs Allow exporting key signatures marked as \"local\". This is not generally useful unless a shared keyring scheme is being used. Defaults to no. export-attributes Include attribute user IDs (photo IDs) while exporting. Not including attribute user IDs is useful to export keys that are going to be used by an OpenPGP pro‐ gram that does not accept attribute user IDs. Defaults to yes. export-sensitive-revkeys Include designated revoker information that was marked as \"sensitive\". Defaults to no. backup export-backup Export for use as a backup. The exported data includes all data which is needed to restore the key or keys later with GnuPG. The format is basically the OpenPGP format but enhanced with GnuPG specific data. All other contra‐ dicting options are overridden. export-clean Compact (remove all signatures from) user IDs on the key being exported if the user IDs are not usable. Also, do not export any signatures that are not us‐ able. This includes signatures that were issued by keys that are not present on the keyring. This option is the same as running the --edit-key command \"clean\" before export except that the local copy of the key is not modified. Defaults to no. export-minimal Export the smallest key possible. This removes all signatures except the most recent self-signature on each user ID. This option is the same as running the --edit-key command \"minimize\" before export except that the local copy of the key is not modified. Defaults to no. export-pka Instead of outputting the key material output PKA records suitable to put into DNS zone files. An ORIGIN line is printed before each record to allow divert‐ ing the records to the corresponding zone file. export-dane Instead of outputting the key material output OpenPGP DANE records suitable to put into DNS zone files. An ORIGIN line is printed before each record to allow diverting the records to the corresponding zone file." }, { "flag": "", "long": "--with-colons", "arg": null, "description": "Print key listings delimited by colons. Note that the output will be encoded in UTF-8 regardless of any --display-charset setting. This format is useful when GnuPG is called from scripts and other programs as it is easily machine parsed. The details of this format are documented in the file ‘doc/DETAILS’, which is included in the GnuPG source distribution." }, { "flag": "", "long": "--fixed-list-mode", "arg": null, "description": "Do not merge primary user ID and primary key in --with-colon listing mode and print all timestamps as seconds since 1970-01-01. Since GnuPG 2.0.10, this mode is always used and thus this option is obsolete; it does not harm to use it though." }, { "flag": "", "long": "--legacy-list-mode", "arg": null, "description": "Revert to the pre-2.1 public key list mode. This only affects the human readable out‐ put and not the machine interface (i.e. --with-colons). Note that the legacy format does not convey suitable information for elliptic curves." }, { "flag": "", "long": "--with-fingerprint", "arg": null, "description": "Same as the command --fingerprint but changes only the format of the output and may be used together with another command." }, { "flag": "", "long": "--with-subkey-fingerprint", "arg": null, "description": "If a fingerprint is printed for the primary key, this option forces printing of the fingerprint for all subkeys. This could also be achieved by using the --with-finger‐‐ print twice but by using this option along with keyid-format \"none\" a compact finger‐ print is printed." }, { "flag": "", "long": "--with-icao-spelling", "arg": null, "description": "Print the ICAO spelling of the fingerprint in addition to the hex digits." }, { "flag": "", "long": "--with-keygrip", "arg": null, "description": "Include the keygrip in the key listings. In --with-colons mode this is implicitly en‐ able for secret keys." }, { "flag": "", "long": "--with-key-origin", "arg": null, "description": "Include the locally held information on the origin and last update of a key in a key listing. In --with-colons mode this is always printed. This data is currently exper‐ imental and shall not be considered part of the stable API." }, { "flag": "", "long": "--with-wkd-hash", "arg": null, "description": "Print a Web Key Directory identifier along with each user ID in key listings. This is an experimental feature and semantics may change." }, { "flag": "", "long": "--with-secret", "arg": null, "description": "Include info about the presence of a secret key in public key listings done with --with-colons." }, { "flag": "-t", "long": "--textmode", "arg": null, "description": "" }, { "flag": "", "long": "--no-textmode", "arg": null, "description": "Treat input files as text and store them in the OpenPGP canonical text form with stan‐ dard \"CRLF\" line endings. This also sets the necessary flags to inform the recipient that the encrypted or signed data is text and may need its line endings converted back to whatever the local system uses. This option is useful when communicating between two platforms that have different line ending conventions (UNIX-like to Mac, Mac to Windows, etc). --no-textmode disables this option, and is the default." }, { "flag": "", "long": "--force-v3-sigs", "arg": null, "description": "" }, { "flag": "", "long": "--no-force-v3-sigs", "arg": null, "description": "" }, { "flag": "", "long": "--force-v4-certs", "arg": null, "description": "" }, { "flag": "", "long": "--no-force-v4-certs", "arg": null, "description": "These options are obsolete and have no effect since GnuPG 2.1." }, { "flag": "", "long": "--force-mdc", "arg": null, "description": "" }, { "flag": "", "long": "--disable-mdc", "arg": null, "description": "These options are obsolete and have no effect since GnuPG 2.2.8. The MDC is always used. But note: If the creation of a legacy non-MDC message is exceptionally re‐ quired, the option --rfc2440 allows for this." }, { "flag": "", "long": "--disable-signer-uid", "arg": null, "description": "By default the user ID of the signing key is embedded in the data signature. As of now this is only done if the signing key has been specified with local-user using a mail address, or with sender. This information can be helpful for verifier to locate the key; see option --auto-key-retrieve." }, { "flag": "", "long": "--include-key-block", "arg": null, "description": "This option is used to embed the actual signing key into a data signature. The embed‐ ded key is stripped down to a single user id and includes only the signing subkey used to create the signature as well as as valid encryption subkeys. All other info is re‐ moved from the key to keep it and thus the signature small. This option is the OpenPGP counterpart to the gpgsm option --include-certs. --personal-cipher-preferences string Set the list of personal cipher preferences to string. Use gpg --version to get a list of available algorithms, and use none to set no preference at all. This allows the user to safely override the algorithm chosen by the recipient key preferences, as GPG will only select an algorithm that is usable by all recipients. The most highly ranked cipher in this list is also used for the --symmetric encryption command. --personal-digest-preferences string Set the list of personal digest preferences to string. Use gpg --version to get a list of available algorithms, and use none to set no preference at all. This allows the user to safely override the algorithm chosen by the recipient key preferences, as GPG will only select an algorithm that is usable by all recipients. The most highly ranked digest algorithm in this list is also used when signing without encryption (e.g. --clear-sign or --sign). --personal-compress-preferences string Set the list of personal compression preferences to string. Use gpg --version to get a list of available algorithms, and use none to set no preference at all. This allows the user to safely override the algorithm chosen by the recipient key preferences, as GPG will only select an algorithm that is usable by all recipients. The most highly ranked compression algorithm in this list is also used when there are no recipient keys to consider (e.g. --symmetric). --s2k-cipher-algo name Use name as the cipher algorithm for symmetric encryption with a passphrase if --per‐‐ sonal-cipher-preferences and --cipher-algo are not given. The default is AES-128. --s2k-digest-algo name Use name as the digest algorithm used to mangle the passphrases for symmetric encryp‐ tion. The default is SHA-1. --s2k-mode n Selects how passphrases for symmetric encryption are mangled. If n is 0 a plain passphrase (which is in general not recommended) will be used, a 1 adds a salt (which should not be used) to the passphrase and a 3 (the default) iterates the whole process a number of times (see --s2k-count). --s2k-count n Specify how many times the passphrases mangling for symmetric encryption is repeated. This value may range between 1024 and 65011712 inclusive. The default is inquired from gpg-agent. Note that not all values in the 1024-65011712 range are legal and if an illegal value is selected, GnuPG will round up to the nearest legal value. This option is only meaningful if --s2k-mode is set to the default of 3." }, { "flag": "", "long": "--gnupg", "arg": null, "description": "Use standard GnuPG behavior. This is essentially OpenPGP behavior (see --openpgp), but with some additional workarounds for common compatibility problems in different ver‐ sions of PGP. This is the default option, so it is not generally needed, but it may be useful to override a different compliance option in the gpg.conf file." }, { "flag": "", "long": "--openpgp", "arg": null, "description": "Reset all packet, cipher and digest options to strict OpenPGP behavior. Use this op‐ tion to reset all previous options like --s2k-*, --cipher-algo, --digest-algo and --compress-algo to OpenPGP compliant values. All PGP workarounds are disabled." }, { "flag": "", "long": "--rfc4880", "arg": null, "description": "Reset all packet, cipher and digest options to strict RFC-4880 behavior. Note that this is currently the same thing as --openpgp." }, { "flag": "", "long": "--rfc4880bis", "arg": null, "description": "Enable experimental features from proposed updates to RFC-4880. This option can be used in addition to the other compliance options. Warning: The behavior may change with any GnuPG release and created keys or data may not be usable with future GnuPG versions." }, { "flag": "", "long": "--rfc2440", "arg": null, "description": "Reset all packet, cipher and digest options to strict RFC-2440 behavior. Note that by using this option encryption packets are created in a legacy mode without MDC protec‐ tion. This is dangerous and should thus only be used for experiments. See also op‐ tion --ignore-mdc-error. --pgp6 Set up all options to be as PGP 6 compliant as possible. This restricts you to the ci‐ phers IDEA (if the IDEA plugin is installed), 3DES, and CAST5, the hashes MD5, SHA1 and RIPEMD160, and the compression algorithms none and ZIP. This also disables --throw-keyids, and making signatures with signing subkeys as PGP 6 does not under‐ stand signatures made by signing subkeys. This option implies --escape-from-lines. --pgp7 Set up all options to be as PGP 7 compliant as possible. This is identical to --pgp6 except that MDCs are not disabled, and the list of allowable ciphers is expanded to add AES128, AES192, AES256, and TWOFISH. --pgp8 Set up all options to be as PGP 8 compliant as possible. PGP 8 is a lot closer to the OpenPGP standard than previous versions of PGP, so all this does is disable --throw- keyids and set --escape-from-lines. All algorithms are allowed except for the SHA224, SHA384, and SHA512 digests. --compliance string This option can be used instead of one of the options above. Valid values for string are the above option names (without the double dash) and possibly others as shown when using \"help\" for value." }, { "flag": "-n", "long": null, "arg": null, "description": "" }, { "flag": "", "long": "--dry-run", "arg": null, "description": "Don't make any changes (this is not completely implemented)." }, { "flag": "", "long": "--list-only", "arg": null, "description": "Changes the behaviour of some commands. This is like --dry-run but different in some cases. The semantic of this option may be extended in the future. Currently it only skips the actual decryption pass and therefore enables a fast listing of the encryp‐ tion keys." }, { "flag": "-i", "long": null, "arg": null, "description": "" }, { "flag": "", "long": "--interactive", "arg": null, "description": "Prompt before overwriting any files. --debug-level level Select the debug level for investigating problems. level may be a numeric value or by a keyword: none No debugging at all. A value of less than 1 may be used instead of the key‐ word. basic Some basic debug messages. A value between 1 and 2 may be used instead of the keyword. advanced More verbose debug messages. A value between 3 and 5 may be used instead of the keyword. expert Even more detailed messages. A value between 6 and 8 may be used instead of the keyword. guru All of the debug messages you can get. A value greater than 8 may be used in‐ stead of the keyword. The creation of hash tracing files is only enabled if the keyword is used. How these messages are mapped to the actual debugging flags is not specified and may change with newer releases of this program. They are however carefully selected to best aid in de‐ bugging. --debug flags Set debugging flags. All flags are or-ed and flags may be given in C syntax (e.g. 0x0042) or as a comma separated list of flag names. To get a list of all supported flags the single word \"help\" can be used." }, { "flag": "", "long": "--debug-all", "arg": null, "description": "Set all useful debugging flags." }, { "flag": "", "long": "--debug-iolbf", "arg": null, "description": "Set stdout into line buffered mode. This option is only honored when given on the command line. --faked-system-time epoch This option is only useful for testing; it sets the system time back or forth to epoch which is the number of seconds elapsed since the year 1970. Alternatively epoch may be given as a full ISO time string (e.g. \"20070924T154812\"). If you suffix epoch with an exclamation mark (!), the system time will appear to be frozen at the specified time." }, { "flag": "", "long": "--enable-progress-filter", "arg": null, "description": "Enable certain PROGRESS status outputs. This option allows frontends to display a progress indicator while gpg is processing larger files. There is a slight perfor‐ mance overhead using it. --status-fd n Write special status strings to the file descriptor n. See the file DETAILS in the documentation for a listing of them. --status-file file Same as --status-fd, except the status data is written to file file. --logger-fd n Write log output to file descriptor n and not to STDERR. --log-file file --logger-file file Same as --logger-fd, except the logger data is written to file file. Use ‘socket://’ to log to a socket. Note that in this version of gpg the option has only an effect if --batch is also used. --attribute-fd n Write attribute subpackets to the file descriptor n. This is most useful for use with --status-fd, since the status messages are needed to separate out the various subpack‐ ets from the stream delivered to the file descriptor. --attribute-file file Same as --attribute-fd, except the attribute data is written to file file. --comment string" }, { "flag": "", "long": "--no-comments", "arg": null, "description": "Use string as a comment string in cleartext signatures and ASCII armored messages or keys (see --armor). The default behavior is not to use a comment string. --comment may be repeated multiple times to get multiple comment strings. --no-comments removes all comments. It is a good idea to keep the length of a single comment below 60 charac‐ ters to avoid problems with mail programs wrapping such lines. Note that comment lines, like all other header lines, are not protected by the signature." }, { "flag": "", "long": "--emit-version", "arg": null, "description": "" }, { "flag": "", "long": "--no-emit-version", "arg": null, "description": "Force inclusion of the version string in ASCII armored output. If given once only the name of the program and the major number is emitted, given twice the minor is also emitted, given thrice the micro is added, and given four times an operating system identification is also emitted. --no-emit-version (default) disables the version line. --sig-notation {name=value} --cert-notation {name=value}" }, { "flag": "-N", "long": "--set-notation", "arg": null, "description": "Put the name value pair into the signature as notation data. name must consist only of printable characters or spaces, and must contain a '@' character in the form key‐ name@domain.example.com (substituting the appropriate keyname and domain name, of course). This is to help prevent pollution of the IETF reserved notation namespace. The --expert flag overrides the '@' check. value may be any printable string; it will be encoded in UTF-8, so you should check that your --display-charset is set correctly. If you prefix name with an exclamation mark (!), the notation data will be flagged as critical (rfc4880:5.2.3.16). --sig-notation sets a notation for data signatures. --cert-notation sets a notation for key signatures (certifications). --set-notation sets both. There are special codes that may be used in notation names. \"%k\" will be expanded into the key ID of the key being signed, \"%K\" into the long key ID of the key being signed, \"%f\" into the fingerprint of the key being signed, \"%s\" into the key ID of the key making the signature, \"%S\" into the long key ID of the key making the signature, \"%g\" into the fingerprint of the key making the signature (which might be a subkey), \"%p\" into the fingerprint of the primary key of the key making the signature, \"%c\" into the signature count from the OpenPGP smartcard, and \"%%\" results in a single \"%\". %k, %K, and %f are only meaningful when making a key signature (certification), and %c is only meaningful when using the OpenPGP smartcard. --known-notation name Adds name to a list of known critical signature notations. The effect of this is that gpg will not mark a signature with a critical signature notation of that name as bad. Note that gpg already knows by default about a few critical signatures notation names. --sig-policy-url string --cert-policy-url string --set-policy-url string Use string as a Policy URL for signatures (rfc4880:5.2.3.20). If you prefix it with an exclamation mark (!), the policy URL packet will be flagged as critical. --sig-pol‐‐ icy-url sets a policy url for data signatures. --cert-policy-url sets a policy url for key signatures (certifications). --set-policy-url sets both. The same %-expandos used for notation data are available here as well. --sig-keyserver-url string Use string as a preferred keyserver URL for data signatures. If you prefix it with an exclamation mark (!), the keyserver URL packet will be flagged as critical. The same %-expandos used for notation data are available here as well. --set-filename string Use string as the filename which is stored inside messages. This overrides the de‐ fault, which is to use the actual filename of the file being encrypted. Using the empty string for string effectively removes the filename from the output." }, { "flag": "", "long": "--for-your-eyes-only", "arg": null, "description": "" }, { "flag": "", "long": "--no-for-your-eyes-only", "arg": null, "description": "Set the `for your eyes only' flag in the message. This causes GnuPG to refuse to save the file unless the --output option is given, and PGP to use a \"secure viewer\" with a claimed Tempest-resistant font to display the message. This option overrides --set- filename. --no-for-your-eyes-only disables this option." }, { "flag": "", "long": "--use-embedded-filename", "arg": null, "description": "" }, { "flag": "", "long": "--no-use-embedded-filename", "arg": null, "description": "Try to create a file with a name as embedded in the data. This can be a dangerous op‐ tion as it enables overwriting files. Defaults to no. Note that the option --output overrides this option. --cipher-algo name Use name as cipher algorithm. Running the program with the command --version yields a list of supported algorithms. If this is not used the cipher algorithm is selected from the preferences stored with the key. In general, you do not want to use this op‐ tion as it allows you to violate the OpenPGP standard. --personal-cipher-preferences is the safe way to accomplish the same thing. --digest-algo name Use name as the message digest algorithm. Running the program with the command --ver‐‐ sion yields a list of supported algorithms. In general, you do not want to use this option as it allows you to violate the OpenPGP standard. --personal-digest-preferences is the safe way to accomplish the same thing. --compress-algo name Use compression algorithm name. \"zlib\" is RFC-1950 ZLIB compression. \"zip\" is RFC-1951 ZIP compression which is used by PGP. \"bzip2\" is a more modern compression scheme that can compress some things better than zip or zlib, but at the cost of more memory used during compression and decompression. \"uncompressed\" or \"none\" disables compres‐ sion. If this option is not used, the default behavior is to examine the recipient key preferences to see which algorithms the recipient supports. If all else fails, ZIP is used for maximum compatibility. ZLIB may give better compression results than ZIP, as the compression window size is not limited to 8k. BZIP2 may give even better compression results than that, but will use a significantly larger amount of memory while compressing and decompressing. This may be significant in low memory situations. Note, however, that PGP (all versions) only supports ZIP compression. Using any algorithm other than ZIP or \"none\" will make the message unreadable with PGP. In general, you do not want to use this option as it allows you to violate the OpenPGP standard. --personal-compress-preferences is the safe way to accomplish the same thing. --cert-digest-algo name Use name as the message digest algorithm used when signing a key. Running the program with the command --version yields a list of supported algorithms. Be aware that if you choose an algorithm that GnuPG supports but other OpenPGP implementations do not, then some users will not be able to use the key signatures you make, or quite possibly your entire key. --disable-cipher-algo name Never allow the use of name as cipher algorithm. The given name will not be checked so that a later loaded algorithm will still get disabled. --disable-pubkey-algo name Never allow the use of name as public key algorithm. The given name will not be checked so that a later loaded algorithm will still get disabled." }, { "flag": "", "long": "--throw-keyids", "arg": null, "description": "" }, { "flag": "", "long": "--no-throw-keyids", "arg": null, "description": "Do not put the recipient key IDs into encrypted messages. This helps to hide the re‐ ceivers of the message and is a limited countermeasure against traffic analysis. ([Us‐ ing a little social engineering anyone who is able to decrypt the message can check whether one of the other recipients is the one he suspects.]) On the receiving side, it may slow down the decryption process because all available secret keys must be tried. --no-throw-keyids disables this option. This option is essentially the same as using --hidden-recipient for all recipients." }, { "flag": "", "long": "--not-dash-escaped", "arg": null, "description": "This option changes the behavior of cleartext signatures so that they can be used for patch files. You should not send such an armored file via email because all spaces and line endings are hashed too. You can not use this option for data which has 5 dashes at the beginning of a line, patch files don't have this. A special armor header line tells GnuPG about this cleartext signature option." }, { "flag": "", "long": "--escape-from-lines", "arg": null, "description": "" }, { "flag": "", "long": "--no-escape-from-lines", "arg": null, "description": "Because some mailers change lines starting with \"From \" to \">From \" it is good to han‐ dle such lines in a special way when creating cleartext signatures to prevent the mail system from breaking the signature. Note that all other PGP versions do it this way too. Enabled by default. --no-escape-from-lines disables this option. --passphrase-repeat n Specify how many times gpg will request a new passphrase be repeated. This is useful for helping memorize a passphrase. Defaults to 1 repetition; can be set to 0 to dis‐ able any passphrase repetition. Note that a n greater than 1 will pop up the pinentry window n+1 times even if a modern pinentry with two entry fields is used. --passphrase-fd n Read the passphrase from file descriptor n. Only the first line will be read from file descriptor n. If you use 0 for n, the passphrase will be read from STDIN. This can only be used if only one passphrase is supplied. Note that since Version 2.0 this passphrase is only used if the option --batch has also been given. Since Version 2.1 the --pinentry-mode also needs to be set to loop‐‐ back. --passphrase-file file Read the passphrase from file file. Only the first line will be read from file file. This can only be used if only one passphrase is supplied. Obviously, a passphrase stored in a file is of questionable security if other users can read this file. Don't use this option if you can avoid it. Note that since Version 2.0 this passphrase is only used if the option --batch has also been given. Since Version 2.1 the --pinentry-mode also needs to be set to loop‐‐ back. --passphrase string Use string as the passphrase. This can only be used if only one passphrase is sup‐ plied. Obviously, this is of very questionable security on a multi-user system. Don't use this option if you can avoid it. Note that since Version 2.0 this passphrase is only used if the option --batch has also been given. Since Version 2.1 the --pinentry-mode also needs to be set to loop‐‐ back. --pinentry-mode mode Set the pinentry mode to mode. Allowed values for mode are: default Use the default of the agent, which is ask. ask Force the use of the Pinentry. cancel Emulate use of Pinentry's cancel button. error Return a Pinentry error (``No Pinentry''). loopback Redirect Pinentry queries to the caller. Note that in contrast to Pinentry the user is not prompted again if he enters a bad password." }, { "flag": "", "long": "--no-symkey-cache", "arg": null, "description": "Disable the passphrase cache used for symmetrical en- and decryption. This cache is based on the message specific salt value (cf. --s2k-mode). --request-origin origin Tell gpg to assume that the operation ultimately originated at origin. Depending on the origin certain restrictions are applied and the Pinentry may include an extra note on the origin. Supported values for origin are: local which is the default, remote to indicate a remote origin or browser for an operation requested by a web browser. --command-fd n This is a replacement for the deprecated shared-memory IPC mode. If this option is enabled, user input on questions is not expected from the TTY but from the given file descriptor. It should be used together with --status-fd. See the file doc/DETAILS in the source distribution for details on how to use it. --command-file file Same as --command-fd, except the commands are read out of file file" }, { "flag": "", "long": "--allow-non-selfsigned-uid", "arg": null, "description": "" }, { "flag": "", "long": "--no-allow-non-selfsigned-uid", "arg": null, "description": "Allow the import and use of keys with user IDs which are not self-signed. This is not recommended, as a non self-signed user ID is trivial to forge. --no-allow-non-self‐‐ signed-uid disables." }, { "flag": "", "long": "--allow-freeform-uid", "arg": null, "description": "Disable all checks on the form of the user ID while generating a new one. This option should only be used in very special environments as it does not ensure the de-facto standard format of user IDs." }, { "flag": "", "long": "--ignore-time-conflict", "arg": null, "description": "GnuPG normally checks that the timestamps associated with keys and signatures have plausible values. However, sometimes a signature seems to be older than the key due to clock problems. This option makes these checks just a warning. See also --ignore- valid-from for timestamp issues on subkeys." }, { "flag": "", "long": "--ignore-valid-from", "arg": null, "description": "GnuPG normally does not select and use subkeys created in the future. This option al‐ lows the use of such keys and thus exhibits the pre-1.0.7 behaviour. You should not use this option unless there is some clock problem. See also --ignore-time-conflict for timestamp issues with signatures." }, { "flag": "", "long": "--ignore-crc-error", "arg": null, "description": "The ASCII armor used by OpenPGP is protected by a CRC checksum against transmission errors. Occasionally the CRC gets mangled somewhere on the transmission channel but the actual content (which is protected by the OpenPGP protocol anyway) is still okay. This option allows GnuPG to ignore CRC errors." }, { "flag": "", "long": "--ignore-mdc-error", "arg": null, "description": "This option changes a MDC integrity protection failure into a warning. It is required to decrypt old messages which did not use an MDC. It may also be useful if a message is partially garbled, but it is necessary to get as much data as possible out of that garbled message. Be aware that a missing or failed MDC can be an indication of an at‐ tack. Use with great caution; see also option --rfc2440." }, { "flag": "", "long": "--allow-weak-digest-algos", "arg": null, "description": "Signatures made with known-weak digest algorithms are normally rejected with an ``in‐ valid digest algorithm'' message. This option allows the verification of signatures made with such weak algorithms. MD5 is the only digest algorithm considered weak by default. See also --weak-digest to reject other digest algorithms. --weak-digest name Treat the specified digest algorithm as weak. Signatures made over weak digests algo‐ rithms are normally rejected. This option can be supplied multiple times if multiple algorithms should be considered weak. See also --allow-weak-digest-algos to disable rejection of weak digests. MD5 is always considered weak, and does not need to be listed explicitly." }, { "flag": "", "long": "--allow-weak-key-signatures", "arg": null, "description": "To avoid a minor risk of collision attacks on third-party key signatures made using SHA-1, those key signatures are considered invalid. This options allows to override this restriction." }, { "flag": "", "long": "--no-default-keyring", "arg": null, "description": "Do not add the default keyrings to the list of keyrings. Note that GnuPG will not op‐ erate without any keyrings, so if you use this option and do not provide alternate keyrings via --keyring or --secret-keyring, then GnuPG will still use the default pub‐ lic or secret keyrings." }, { "flag": "", "long": "--no-keyring", "arg": null, "description": "Do not use any keyring at all. This overrides the default and all options which spec‐ ify keyrings." }, { "flag": "", "long": "--skip-verify", "arg": null, "description": "Skip the signature verification step. This may be used to make the decryption faster if the signature verification is not needed." }, { "flag": "", "long": "--with-key-data", "arg": null, "description": "Print key listings delimited by colons (like --with-colons) and print the public key data." }, { "flag": "", "long": "--list-signatures", "arg": null, "description": "" }, { "flag": "", "long": "--list-sigs", "arg": null, "description": "Same as --list-keys, but the signatures are listed too. This command has the same ef‐ fect as using --list-keys with --with-sig-list. Note that in contrast to --check-sig‐‐ natures the key signatures are not verified. This command can be used to create a list of signing keys missing in the local keyring; for example: gpg --list-sigs --with-colons USERID | \\ awk -F: '$1==\"sig\" && $2==\"?\" {if($13){print $13}else{print $5}}'" }, { "flag": "", "long": "--fast-list-mode", "arg": null, "description": "Changes the output of the list commands to work faster; this is achieved by leaving some parts empty. Some applications don't need the user ID and the trust information given in the listings. By using this options they can get a faster listing. The exact behaviour of this option may change in future versions. If you are missing some in‐ formation, don't use this option." }, { "flag": "", "long": "--no-literal", "arg": null, "description": "This is not for normal use. Use the source to see for what it might be useful." }, { "flag": "", "long": "--set-filesize", "arg": null, "description": "This is not for normal use. Use the source to see for what it might be useful." }, { "flag": "", "long": "--show-session-key", "arg": null, "description": "Display the session key used for one message. See --override-session-key for the coun‐ terpart of this option. We think that Key Escrow is a Bad Thing; however the user should have the freedom to decide whether to go to prison or to reveal the content of one specific message with‐ out compromising all messages ever encrypted for one secret key. You can also use this option if you receive an encrypted message which is abusive or offensive, to prove to the administrators of the messaging system that the ciphertext transmitted corresponds to an inappropriate plaintext so they can take action against the offending user. --override-session-key string --override-session-key-fd fd Don't use the public key but the session key string respective the session key taken from the first line read from file descriptor fd. The format of this string is the same as the one printed by --show-session-key. This option is normally not used but comes handy in case someone forces you to reveal the content of an encrypted message; using this option you can do this without handing out the secret key. Note that using --override-session-key may reveal the session key to all local users via the global process table. Often it is useful to combine this option with --no-keyring." }, { "flag": "", "long": "--ask-sig-expire", "arg": null, "description": "" }, { "flag": "", "long": "--no-ask-sig-expire", "arg": null, "description": "When making a data signature, prompt for an expiration time. If this option is not specified, the expiration time set via --default-sig-expire is used. --no-ask-sig-ex‐‐ pire disables this option." }, { "flag": "", "long": "--default-sig-expire", "arg": null, "description": "The default expiration time to use for signature expiration. Valid values are \"0\" for no expiration, a number followed by the letter d (for days), w (for weeks), m (for months), or y (for years) (for example \"2m\" for two months, or \"5y\" for five years), or an absolute date in the form YYYY-MM-DD. Defaults to \"0\"." }, { "flag": "", "long": "--ask-cert-expire", "arg": null, "description": "" }, { "flag": "", "long": "--no-ask-cert-expire", "arg": null, "description": "When making a key signature, prompt for an expiration time. If this option is not specified, the expiration time set via --default-cert-expire is used. --no-ask-cert- expire disables this option." }, { "flag": "", "long": "--default-cert-expire", "arg": null, "description": "The default expiration time to use for key signature expiration. Valid values are \"0\" for no expiration, a number followed by the letter d (for days), w (for weeks), m (for months), or y (for years) (for example \"2m\" for two months, or \"5y\" for five years), or an absolute date in the form YYYY-MM-DD. Defaults to \"0\". --default-new-key-algo string This option can be used to change the default algorithms for key generation. The string is similar to the arguments required for the command --quick-add-key but slightly different. For example the current default of \"rsa2048/cert,sign+rsa2048/encr\" (or \"rsa3072\") can be changed to the value of what we currently call future default, which is \"ed25519/cert,sign+cv25519/encr\". You need to consult the source code to learn the details. Note that the advanced key generation commands can always be used to specify a key algorithm directly." }, { "flag": "", "long": "--allow-secret-key-import", "arg": null, "description": "This is an obsolete option and is not used anywhere." }, { "flag": "", "long": "--allow-multiple-messages", "arg": null, "description": "" }, { "flag": "", "long": "--no-allow-multiple-messages", "arg": null, "description": "Allow processing of multiple OpenPGP messages contained in a single file or stream. Some programs that call GPG are not prepared to deal with multiple messages being pro‐ cessed together, so this option defaults to no. Note that versions of GPG prior to 1.4.7 always allowed multiple messages. Future versions of GnUPG will remove this op‐ tion. Warning: Do not use this option unless you need it as a temporary workaround!" }, { "flag": "", "long": "--enable-special-filenames", "arg": null, "description": "This option enables a mode in which filenames of the form ‘-&n’, where n is a non-neg‐ ative decimal number, refer to the file descriptor n and not to a file with that name." }, { "flag": "", "long": "--no-expensive-trust-checks", "arg": null, "description": "Experimental use only." }, { "flag": "", "long": "--preserve-permissions", "arg": null, "description": "Don't change the permissions of a secret keyring back to user read/write only. Use this option only if you really know what you are doing. --default-preference-list string Set the list of default preferences to string. This preference list is used for new keys and becomes the default for \"setpref\" in the edit menu. --default-keyserver-url name Set the default keyserver URL to name. This keyserver will be used as the keyserver URL when writing a new self-signature on a key, which includes key generation and changing preferences." }, { "flag": "", "long": "--list-config", "arg": null, "description": "Display various internal configuration parameters of GnuPG. This option is intended for external programs that call GnuPG to perform tasks, and is thus not generally use‐ ful. See the file ‘doc/DETAILS’ in the source distribution for the details of which configuration items may be listed. --list-config is only usable with --with-colons set." }, { "flag": "", "long": "--list-gcrypt-config", "arg": null, "description": "Display various internal configuration parameters of Libgcrypt." }, { "flag": "", "long": "--gpgconf-list", "arg": null, "description": "This command is similar to --list-config but in general only internally used by the gpgconf tool." }, { "flag": "", "long": "--gpgconf-test", "arg": null, "description": "This is more or less dummy action. However it parses the configuration file and re‐ turns with failure if the configuration file would prevent gpg from startup. Thus it may be used to run a syntax check on the configuration file." }, { "flag": "", "long": "--show-photos", "arg": null, "description": "" }, { "flag": "", "long": "--no-show-photos", "arg": null, "description": "Causes --list-keys, --list-signatures, --list-public-keys, --list-secret-keys, and verifying a signature to also display the photo ID attached to the key, if any. See also --photo-viewer. These options are deprecated. Use --list-options [no-]show-photos and/or --verify-options [no-]show-photos instead." }, { "flag": "", "long": "--show-keyring", "arg": null, "description": "Display the keyring name at the head of key listings to show which keyring a given key resides on. This option is deprecated: use --list-options [no-]show-keyring instead." }, { "flag": "", "long": "--always-trust", "arg": null, "description": "Identical to --trust-model always. This option is deprecated." }, { "flag": "", "long": "--show-notation", "arg": null, "description": "" }, { "flag": "", "long": "--no-show-notation", "arg": null, "description": "Show signature notations in the --list-signatures or --check-signatures listings as well as when verifying a signature with a notation in it. These options are depre‐ cated. Use --list-options [no-]show-notation and/or --verify-options [no-]show-nota‐‐ tion instead." }, { "flag": "", "long": "--show-policy-url", "arg": null, "description": "" }, { "flag": "", "long": "--no-show-policy-url", "arg": null, "description": "Show policy URLs in the --list-signatures or --check-signatures listings as well as when verifying a signature with a policy URL in it. These options are deprecated. Use --list-options [no-]show-policy-url and/or --verify-options [no-]show-policy-url in‐ stead." } ], "examples": [ "sign and encrypt for user Bob", "make a cleartext signature", "make a detached signature", "make a detached signature with the key 0x12345678", "gpg --list-keys userID", "show keys", "gpg --fingerprint userID", "show fingerprint", "gpg --verify sigfile [datafile]", "Verify the signature of the file but do not output the data unless requested. The", "second form is used for detached signatures, where sigfile is the detached signature", "(either ASCII armored or binary) and datafile are the signed data; if this is not", "given, the name of the file holding the signed data is constructed by cutting off the", "extension (\".asc\" or \".sig\") of sigfile or by asking the user for the filename. If", "the option --output is also used the signed data is written to the file specified by", "that option; use - to write the signed data to stdout." ], "see_also": [ { "name": "gpgv", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/gpgv/1/json" }, { "name": "gpgsm", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/gpgsm/1/json" }, { "name": "gpg-agent", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/gpg-agent/1/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 5, "subsections": [] }, { "name": "DESCRIPTION", "lines": 18, "subsections": [] }, { "name": "RETURN VALUE", "lines": 9, "subsections": [] }, { "name": "WARNINGS", "lines": 20, "subsections": [] }, { "name": "INTEROPERABILITY", "lines": 22, "subsections": [] }, { "name": "COMMANDS", "lines": 16, "subsections": [ { "name": "Commands not specific to the function", "lines": 1 }, { "name": "--version", "lines": 4, "long": "--version" }, { "name": "--help", "lines": 1, "long": "--help" }, { "name": "-h", "lines": 3, "flag": "-h" }, { "name": "--warranty", "lines": 3, "long": "--warranty" }, { "name": "--dump-options", "lines": 3, "long": "--dump-options" }, { "name": "Commands to select the type of operation", "lines": 1 }, { "name": "--sign", "lines": 1, "long": "--sign" }, { "name": "-s --encrypt", "lines": 6, "flag": "-s", "long": "--encrypt" }, { "name": "--clear-sign", "lines": 1, "long": "--clear-sign" }, { "name": "--clearsign", "lines": 8, "long": "--clearsign" }, { "name": "--detach-sign", "lines": 1, "long": "--detach-sign" }, { "name": "-b", "lines": 1, "flag": "-b" }, { "name": "--encrypt", "lines": 1, "long": "--encrypt" }, { "name": "-e --sign", "lines": 6, "flag": "-e", "long": "--sign" }, { "name": "--symmetric", "lines": 1, "long": "--symmetric" }, { "name": "-c", "lines": 9, "flag": "-c" }, { "name": "--store", "lines": 3, "long": "--store" }, { "name": "--decrypt", "lines": 1, "long": "--decrypt" }, { "name": "-d", "lines": 6, "flag": "-d" }, { "name": "--verify", "lines": 26, "long": "--verify" }, { "name": "--multifile", "lines": 7, "long": "--multifile" }, { "name": "--verify-files", "lines": 3, "long": "--verify-files" }, { "name": "--encrypt-files", "lines": 3, "long": "--encrypt-files" }, { "name": "--decrypt-files", "lines": 3, "long": "--decrypt-files" }, { "name": "--list-keys", "lines": 1, "long": "--list-keys" }, { "name": "-k", "lines": 1, "flag": "-k" }, { "name": "--list-public-keys", "lines": 9, "long": "--list-public-keys" }, { "name": "--list-secret-keys", "lines": 1, "long": "--list-secret-keys" }, { "name": "-K", "lines": 7, "flag": "-K" }, { "name": "--check-signatures", "lines": 1, "long": "--check-signatures" }, { "name": "--check-sigs", "lines": 23, "long": "--check-sigs" }, { "name": "--locate-keys", "lines": 1, "long": "--locate-keys" }, { "name": "--locate-external-keys", "lines": 8, "long": "--locate-external-keys" }, { "name": "--show-keys", "lines": 7, "long": "--show-keys" }, { "name": "--fingerprint", "lines": 7, "long": "--fingerprint" }, { "name": "--list-packets", "lines": 6, "long": "--list-packets" }, { "name": "--edit-card", "lines": 1, "long": "--edit-card" }, { "name": "--card-edit", "lines": 5, "long": "--card-edit" }, { "name": "--card-status", "lines": 3, "long": "--card-status" }, { "name": "--change-pin", "lines": 29, "long": "--change-pin" }, { "name": "--export", "lines": 16, "long": "--export" }, { "name": "--export-secret-keys", "lines": 1, "long": "--export-secret-keys" }, { "name": "--export-secret-subkeys", "lines": 18, "long": "--export-secret-subkeys" }, { "name": "--export-ssh-key", "lines": 10, "long": "--export-ssh-key" }, { "name": "--import", "lines": 1, "long": "--import" }, { "name": "--fast-import", "lines": 13, "long": "--fast-import" }, { "name": "--refresh-keys", "lines": 20, "long": "--refresh-keys" }, { "name": "--update-trustdb", "lines": 8, "long": "--update-trustdb" }, { "name": "--check-trustdb", "lines": 13, "long": "--check-trustdb" }, { "name": "--export-ownertrust", "lines": 6, "long": "--export-ownertrust" }, { "name": "--import-ownertrust", "lines": 10, "long": "--import-ownertrust" }, { "name": "--rebuild-keydb-caches", "lines": 5, "long": "--rebuild-keydb-caches" }, { "name": "--print-mds", "lines": 16, "long": "--print-mds" }, { "name": "--enarmor", "lines": 1, "long": "--enarmor" }, { "name": "--dearmor", "lines": 11, "long": "--dearmor" }, { "name": "How to manage your keys", "lines": 5 }, { "name": "--quick-gen-key", "lines": 80, "long": "--quick-gen-key" }, { "name": "--generate-key", "lines": 1, "long": "--generate-key" }, { "name": "--gen-key", "lines": 5, "long": "--gen-key" }, { "name": "--full-generate-key", "lines": 1, "long": "--full-generate-key" }, { "name": "--full-gen-key", "lines": 30, "long": "--full-gen-key" }, { "name": "--edit-key", "lines": 304, "long": "--edit-key" } ] }, { "name": "OPTIONS", "lines": 16, "subsections": [ { "name": "How to change the configuration", "lines": 18 }, { "name": "--default-recipient-self", "lines": 5, "long": "--default-recipient-self" }, { "name": "--no-default-recipient", "lines": 3, "long": "--no-default-recipient" }, { "name": "-v, --verbose", "lines": 4, "flag": "-v", "long": "--verbose" }, { "name": "--no-verbose", "lines": 3, "long": "--no-verbose" }, { "name": "-q, --quiet", "lines": 3, "flag": "-q", "long": "--quiet" }, { "name": "--batch", "lines": 1, "long": "--batch" }, { "name": "--no-batch", "lines": 10, "long": "--no-batch" }, { "name": "--no-tty", "lines": 140, "long": "--no-tty" }, { "name": "--enable-large-rsa", "lines": 1, "long": "--enable-large-rsa" }, { "name": "--disable-large-rsa", "lines": 7, "long": "--disable-large-rsa" }, { "name": "--enable-dsa2", "lines": 1, "long": "--enable-dsa2" }, { "name": "--disable-dsa2", "lines": 107, "long": "--disable-dsa2" }, { "name": "--utf8-strings", "lines": 1, "long": "--utf8-strings" }, { "name": "--no-utf8-strings", "lines": 12, "long": "--no-utf8-strings" }, { "name": "--no-options", "lines": 5, "long": "--no-options" }, { "name": "-z", "lines": 10, "flag": "-z" }, { "name": "--bzip2-decompress-lowmem", "lines": 7, "long": "--bzip2-decompress-lowmem" }, { "name": "--mangle-dos-filenames", "lines": 1, "long": "--mangle-dos-filenames" }, { "name": "--no-mangle-dos-filenames", "lines": 6, "long": "--no-mangle-dos-filenames" }, { "name": "--ask-cert-level", "lines": 1, "long": "--ask-cert-level" }, { "name": "--no-ask-cert-level", "lines": 31, "long": "--no-ask-cert-level" }, { "name": "--min-cert-level", "lines": 12, "long": "--min-cert-level" }, { "name": "--trust-model {pgp|classic|tofu|tofu+pgp|direct|always|auto}", "lines": 87, "long": "--trust-model" }, { "name": "--no-auto-key-locate", "lines": 57, "long": "--no-auto-key-locate" }, { "name": "--auto-key-import", "lines": 1, "long": "--auto-key-import" }, { "name": "--no-auto-key-import", "lines": 9, "long": "--no-auto-key-import" }, { "name": "--auto-key-retrieve", "lines": 1, "long": "--auto-key-retrieve" }, { "name": "--no-auto-key-retrieve", "lines": 31, "long": "--no-auto-key-retrieve" }, { "name": "--keyid-format {none|short|0xshort|long|0xlong}", "lines": 98, "long": "--keyid-format" }, { "name": "--tofu-default-policy {auto|good|unknown|bad|ask}", "lines": 8, "long": "--tofu-default-policy" }, { "name": "--no-sig-cache", "lines": 7, "long": "--no-sig-cache" }, { "name": "--auto-check-trustdb", "lines": 1, "long": "--auto-check-trustdb" }, { "name": "--no-auto-check-trustdb", "lines": 5, "long": "--no-auto-check-trustdb" }, { "name": "--use-agent", "lines": 1, "long": "--use-agent" }, { "name": "--no-use-agent", "lines": 3, "long": "--no-use-agent" }, { "name": "--gpg-agent-info", "lines": 16, "long": "--gpg-agent-info" }, { "name": "--disable-dirmngr", "lines": 3, "long": "--disable-dirmngr" }, { "name": "--no-autostart", "lines": 6, "long": "--no-autostart" }, { "name": "--lock-once", "lines": 4, "long": "--lock-once" }, { "name": "--lock-multiple", "lines": 4, "long": "--lock-multiple" }, { "name": "--lock-never", "lines": 6, "long": "--lock-never" }, { "name": "--exit-on-status-write-error", "lines": 15, "long": "--exit-on-status-write-error" }, { "name": "--no-random-seed-file", "lines": 5, "long": "--no-random-seed-file" }, { "name": "--no-greeting", "lines": 3, "long": "--no-greeting" }, { "name": "--no-secmem-warning", "lines": 3, "long": "--no-secmem-warning" }, { "name": "--no-permission-warning", "lines": 11, "long": "--no-permission-warning" }, { "name": "--require-secmem", "lines": 1, "long": "--require-secmem" }, { "name": "--no-require-secmem", "lines": 5, "long": "--no-require-secmem" }, { "name": "--require-cross-certification", "lines": 1, "long": "--require-cross-certification" }, { "name": "--no-require-cross-certification", "lines": 6, "long": "--no-require-cross-certification" }, { "name": "--expert", "lines": 1, "long": "--expert" }, { "name": "--no-expert", "lines": 8, "long": "--no-expert" }, { "name": "Key related options", "lines": 1 }, { "name": "-r --hidden-recipient", "lines": 4, "flag": "-r", "long": "--hidden-recipient" }, { "name": "-R", "lines": 6, "flag": "-R" }, { "name": "-f --recipient", "lines": 5, "flag": "-f", "long": "--recipient" }, { "name": "-F --hidden-recipient", "lines": 19, "flag": "-F", "long": "--hidden-recipient" }, { "name": "--no-encrypt-to", "lines": 20, "long": "--no-encrypt-to" }, { "name": "--no-groups", "lines": 4, "long": "--no-groups" }, { "name": "-u --default-key", "lines": 18, "flag": "-u", "long": "--default-key" }, { "name": "--try-all-secrets", "lines": 6, "long": "--try-all-secrets" }, { "name": "--skip-hidden-recipients", "lines": 1, "long": "--skip-hidden-recipients" }, { "name": "--no-skip-hidden-recipients", "lines": 9, "long": "--no-skip-hidden-recipients" }, { "name": "Input and Output", "lines": 1 }, { "name": "--armor", "lines": 1, "long": "--armor" }, { "name": "-a", "lines": 1, "flag": "-a" }, { "name": "--no-armor", "lines": 4, "long": "--no-armor" }, { "name": "-o", "lines": 269, "flag": "-o" }, { "name": "--with-colons", "lines": 7, "long": "--with-colons" }, { "name": "--fixed-list-mode", "lines": 5, "long": "--fixed-list-mode" }, { "name": "--legacy-list-mode", "lines": 5, "long": "--legacy-list-mode" }, { "name": "--with-fingerprint", "lines": 4, "long": "--with-fingerprint" }, { "name": "--with-subkey-fingerprint", "lines": 6, "long": "--with-subkey-fingerprint" }, { "name": "--with-icao-spelling", "lines": 3, "long": "--with-icao-spelling" }, { "name": "--with-keygrip", "lines": 4, "long": "--with-keygrip" }, { "name": "--with-key-origin", "lines": 5, "long": "--with-key-origin" }, { "name": "--with-wkd-hash", "lines": 4, "long": "--with-wkd-hash" }, { "name": "--with-secret", "lines": 4, "long": "--with-secret" }, { "name": "OpenPGP protocol specific options", "lines": 1 }, { "name": "-t, --textmode", "lines": 1, "flag": "-t", "long": "--textmode" }, { "name": "--no-textmode", "lines": 8, "long": "--no-textmode" }, { "name": "--force-v3-sigs", "lines": 1, "long": "--force-v3-sigs" }, { "name": "--no-force-v3-sigs", "lines": 1, "long": "--no-force-v3-sigs" }, { "name": "--force-v4-certs", "lines": 1, "long": "--force-v4-certs" }, { "name": "--no-force-v4-certs", "lines": 3, "long": "--no-force-v4-certs" }, { "name": "--force-mdc", "lines": 1, "long": "--force-mdc" }, { "name": "--disable-mdc", "lines": 5, "long": "--disable-mdc" }, { "name": "--disable-signer-uid", "lines": 6, "long": "--disable-signer-uid" }, { "name": "--include-key-block", "lines": 59, "long": "--include-key-block" }, { "name": "Compliance options", "lines": 6 }, { "name": "--gnupg", "lines": 6, "long": "--gnupg" }, { "name": "--openpgp", "lines": 5, "long": "--openpgp" }, { "name": "--rfc4880", "lines": 4, "long": "--rfc4880" }, { "name": "--rfc4880bis", "lines": 6, "long": "--rfc4880bis" }, { "name": "--rfc2440", "lines": 32, "long": "--rfc2440" }, { "name": "Doing things one usually doesn't want to do", "lines": 1 }, { "name": "-n", "lines": 1, "flag": "-n" }, { "name": "--dry-run", "lines": 3, "long": "--dry-run" }, { "name": "--list-only", "lines": 6, "long": "--list-only" }, { "name": "-i", "lines": 1, "flag": "-i" }, { "name": "--interactive", "lines": 36, "long": "--interactive" }, { "name": "--debug-all", "lines": 3, "long": "--debug-all" }, { "name": "--debug-iolbf", "lines": 13, "long": "--debug-iolbf" }, { "name": "--enable-progress-filter", "lines": 36, "long": "--enable-progress-filter" }, { "name": "--no-comments", "lines": 8, "long": "--no-comments" }, { "name": "--emit-version", "lines": 1, "long": "--emit-version" }, { "name": "--no-emit-version", "lines": 9, "long": "--no-emit-version" }, { "name": "-N, --set-notation", "lines": 52, "flag": "-N", "long": "--set-notation" }, { "name": "--for-your-eyes-only", "lines": 1, "long": "--for-your-eyes-only" }, { "name": "--no-for-your-eyes-only", "lines": 6, "long": "--no-for-your-eyes-only" }, { "name": "--use-embedded-filename", "lines": 1, "long": "--use-embedded-filename" }, { "name": "--no-use-embedded-filename", "lines": 57, "long": "--no-use-embedded-filename" }, { "name": "--throw-keyids", "lines": 1, "long": "--throw-keyids" }, { "name": "--no-throw-keyids", "lines": 9, "long": "--no-throw-keyids" }, { "name": "--not-dash-escaped", "lines": 7, "long": "--not-dash-escaped" }, { "name": "--escape-from-lines", "lines": 1, "long": "--escape-from-lines" }, { "name": "--no-escape-from-lines", "lines": 61, "long": "--no-escape-from-lines" }, { "name": "--no-symkey-cache", "lines": 22, "long": "--no-symkey-cache" }, { "name": "--allow-non-selfsigned-uid", "lines": 1, "long": "--allow-non-selfsigned-uid" }, { "name": "--no-allow-non-selfsigned-uid", "lines": 5, "long": "--no-allow-non-selfsigned-uid" }, { "name": "--allow-freeform-uid", "lines": 5, "long": "--allow-freeform-uid" }, { "name": "--ignore-time-conflict", "lines": 6, "long": "--ignore-time-conflict" }, { "name": "--ignore-valid-from", "lines": 6, "long": "--ignore-valid-from" }, { "name": "--ignore-crc-error", "lines": 6, "long": "--ignore-crc-error" }, { "name": "--ignore-mdc-error", "lines": 7, "long": "--ignore-mdc-error" }, { "name": "--allow-weak-digest-algos", "lines": 14, "long": "--allow-weak-digest-algos" }, { "name": "--allow-weak-key-signatures", "lines": 5, "long": "--allow-weak-key-signatures" }, { "name": "--no-default-keyring", "lines": 6, "long": "--no-default-keyring" }, { "name": "--no-keyring", "lines": 4, "long": "--no-keyring" }, { "name": "--skip-verify", "lines": 4, "long": "--skip-verify" }, { "name": "--with-key-data", "lines": 4, "long": "--with-key-data" }, { "name": "--list-signatures", "lines": 1, "long": "--list-signatures" }, { "name": "--list-sigs", "lines": 9, "long": "--list-sigs" }, { "name": "--fast-list-mode", "lines": 7, "long": "--fast-list-mode" }, { "name": "--no-literal", "lines": 3, "long": "--no-literal" }, { "name": "--set-filesize", "lines": 3, "long": "--set-filesize" }, { "name": "--show-session-key", "lines": 24, "long": "--show-session-key" }, { "name": "--ask-sig-expire", "lines": 1, "long": "--ask-sig-expire" }, { "name": "--no-ask-sig-expire", "lines": 5, "long": "--no-ask-sig-expire" }, { "name": "--default-sig-expire", "lines": 6, "long": "--default-sig-expire" }, { "name": "--ask-cert-expire", "lines": 1, "long": "--ask-cert-expire" }, { "name": "--no-ask-cert-expire", "lines": 5, "long": "--no-ask-cert-expire" }, { "name": "--default-cert-expire", "lines": 16, "long": "--default-cert-expire" }, { "name": "--allow-secret-key-import", "lines": 3, "long": "--allow-secret-key-import" }, { "name": "--allow-multiple-messages", "lines": 1, "long": "--allow-multiple-messages" }, { "name": "--no-allow-multiple-messages", "lines": 10, "long": "--no-allow-multiple-messages" }, { "name": "--enable-special-filenames", "lines": 4, "long": "--enable-special-filenames" }, { "name": "--no-expensive-trust-checks", "lines": 3, "long": "--no-expensive-trust-checks" }, { "name": "--preserve-permissions", "lines": 15, "long": "--preserve-permissions" }, { "name": "--list-config", "lines": 7, "long": "--list-config" }, { "name": "--list-gcrypt-config", "lines": 3, "long": "--list-gcrypt-config" }, { "name": "--gpgconf-list", "lines": 4, "long": "--gpgconf-list" }, { "name": "--gpgconf-test", "lines": 5, "long": "--gpgconf-test" }, { "name": "Deprecated options", "lines": 1 }, { "name": "--show-photos", "lines": 1, "long": "--show-photos" }, { "name": "--no-show-photos", "lines": 6, "long": "--no-show-photos" }, { "name": "--show-keyring", "lines": 4, "long": "--show-keyring" }, { "name": "--always-trust", "lines": 3, "long": "--always-trust" }, { "name": "--show-notation", "lines": 1, "long": "--show-notation" }, { "name": "--no-show-notation", "lines": 6, "long": "--no-show-notation" }, { "name": "--show-policy-url", "lines": 1, "long": "--show-policy-url" }, { "name": "--no-show-policy-url", "lines": 7, "long": "--no-show-policy-url" } ] }, { "name": "EXAMPLES", "lines": 1, "subsections": [ { "name": "gpg -se -r Bob file", "lines": 3 }, { "name": "gpg --clear-sign file", "lines": 3 }, { "name": "gpg -sb file", "lines": 3 }, { "name": "gpg -u 0x12345678 -sb file", "lines": 11 }, { "name": "gpg --verify pgpfile", "lines": 9 } ] }, { "name": "HOW TO SPECIFY A USER ID", "lines": 5, "subsections": [ { "name": "By key Id.", "lines": 26 }, { "name": "By fingerprint.", "lines": 22 }, { "name": "By exact match on OpenPGP user ID.", "lines": 6 }, { "name": "By exact match on an email address.", "lines": 7 }, { "name": "By partial match on an email address.", "lines": 6 }, { "name": "By exact match on the subject's DN.", "lines": 8 }, { "name": "By exact match on the issuer's DN.", "lines": 8 }, { "name": "By exact match on serial number and issuer's DN.", "lines": 7 }, { "name": "By keygrip.", "lines": 7 }, { "name": "By substring match.", "lines": 7 }, { "name": ". and + prefixes", "lines": 13 } ] }, { "name": "FILTER EXPRESSIONS", "lines": 54, "subsections": [ { "name": "-le", "lines": 1 }, { "name": "-lt", "lines": 1 }, { "name": "-gt", "lines": 1 }, { "name": "-ge", "lines": 1 }, { "name": "-n", "lines": 1, "flag": "-n" }, { "name": "-z", "lines": 1, "flag": "-z" }, { "name": "-t", "lines": 1, "flag": "-t" }, { "name": "-f", "lines": 5, "flag": "-f" }, { "name": "-c", "lines": 18, "flag": "-c" } ] }, { "name": "TRUST VALUES", "lines": 6, "subsections": [ { "name": "unknown", "lines": 4 }, { "name": "expired", "lines": 4 }, { "name": "undefined, undef", "lines": 8 }, { "name": "marginal", "lines": 8 }, { "name": "ultimate", "lines": 4 }, { "name": "revoked", "lines": 7 } ] }, { "name": "FILES", "lines": 5, "subsections": [ { "name": "gpg.conf", "lines": 15 }, { "name": "~/.gnupg", "lines": 4 }, { "name": "~/.gnupg/pubring.gpg", "lines": 13 }, { "name": "~/.gnupg/pubring.gpg.lock", "lines": 3 }, { "name": "~/.gnupg/pubring.kbx", "lines": 16 }, { "name": "~/.gnupg/pubring.kbx.lock", "lines": 3 }, { "name": "~/.gnupg/secring.gpg", "lines": 5 }, { "name": "~/.gnupg/secring.gpg.lock", "lines": 3 }, { "name": "~/.gnupg/.gpg-v21-migrated", "lines": 3 }, { "name": "~/.gnupg/trustdb.gpg", "lines": 4 }, { "name": "~/.gnupg/trustdb.gpg.lock", "lines": 7 }, { "name": "~/.gnupg/openpgp-revocs.d/", "lines": 51 } ] }, { "name": "BUGS", "lines": 18, "subsections": [] }, { "name": "SEE ALSO", "lines": 12, "subsections": [] } ], "sections": { "NAME": { "content": "gpg - OpenPGP encryption and signing tool\n", "subsections": [] }, "SYNOPSIS": { "content": "gpg [--homedir dir] [--options file] [options] command [args]\n\n\n\n", "subsections": [] }, "DESCRIPTION": { "content": "gpg is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a tool to provide digital en‐\ncryption and signing services using the OpenPGP standard. gpg features complete key manage‐\nment and all the bells and whistles you would expect from a full OpenPGP implementation.\n\nThere are two main versions of GnuPG: GnuPG 1.x and GnuPG 2.x. GnuPG 2.x supports modern en‐\ncryption algorithms and thus should be preferred over GnuPG 1.x. You only need to use GnuPG\n1.x if your platform doesn't support GnuPG 2.x, or you need support for some features that\nGnuPG 2.x has deprecated, e.g., decrypting data created with PGP-2 keys.\n\nIf you are looking for version 1 of GnuPG, you may find that version installed under the name\ngpg1.\n\n\n\n\n\n\n", "subsections": [] }, "RETURN VALUE": { "content": "The program returns 0 if there are no severe errors, 1 if at least a signature was bad, and\nother error codes for fatal errors.\n\nNote that signature verification requires exact knowledge of what has been signed and by whom\nit has beensigned. Using only the return code is thus not an appropriate way to verify a\nsignature by a script. Either make proper use or the status codes or use the gpgv tool which\nhas been designed to make signature verification easy for scripts.\n\n", "subsections": [] }, "WARNINGS": { "content": "Use a good password for your user account and make sure that all security issues are always\nfixed on your machine. Also employ diligent physical protection to your machine. Consider\nto use a good passphrase as a last resort protection to your secret key in the case your ma‐\nchine gets stolen. It is important that your secret key is never leaked. Using an easy to\ncarry around token or smartcard with the secret key is often a advisable.\n\nIf you are going to verify detached signatures, make sure that the program knows about it;\neither give both filenames on the command line or use ‘-’ to specify STDIN.\n\nFor scripted or other unattended use of gpg make sure to use the machine-parseable interface\nand not the default interface which is intended for direct use by humans. The machine-\nparseable interface provides a stable and well documented API independent of the locale or\nfuture changes of gpg. To enable this interface use the options --with-colons and --status-\nfd. For certain operations the option --command-fd may come handy too. See this man page\nand the file ‘DETAILS’ for the specification of the interface. Note that the GnuPG ``info''\npages as well as the PDF version of the GnuPG manual features a chapter on unattended use of\nGnuPG. As an alternative the library GPGME can be used as a high-level abstraction on top of\nthat interface.\n\n", "subsections": [] }, "INTEROPERABILITY": { "content": "GnuPG tries to be a very flexible implementation of the OpenPGP standard. In particular,\nGnuPG implements many of the optional parts of the standard, such as the SHA-512 hash, and\nthe ZLIB and BZIP2 compression algorithms. It is important to be aware that not all OpenPGP\nprograms implement these optional algorithms and that by forcing their use via the --cipher-\nalgo, --digest-algo, --cert-digest-algo, or --compress-algo options in GnuPG, it is possible\nto create a perfectly valid OpenPGP message, but one that cannot be read by the intended re‐\ncipient.\n\nThere are dozens of variations of OpenPGP programs available, and each supports a slightly\ndifferent subset of these optional algorithms. For example, until recently, no (unhacked)\nversion of PGP supported the BLOWFISH cipher algorithm. A message using BLOWFISH simply could\nnot be read by a PGP user. By default, GnuPG uses the standard OpenPGP preferences system\nthat will always do the right thing and create messages that are usable by all recipients,\nregardless of which OpenPGP program they use. Only override this safe default if you really\nknow what you are doing.\n\nIf you absolutely must override the safe default, or if the preferences on a given key are\ninvalid for some reason, you are far better off using the --pgp6, --pgp7, or --pgp8 options.\nThese options are safe as they do not force any particular algorithms in violation of\nOpenPGP, but rather reduce the available algorithms to a \"PGP-safe\" list.\n\n", "subsections": [] }, "COMMANDS": { "content": "Commands are not distinguished from options except for the fact that only one command is al‐\nlowed. Generally speaking, irrelevant options are silently ignored, and may not be checked\nfor correctness.\n\ngpg may be run with no commands. In this case it will print a warning perform a reasonable\naction depending on the type of file it is given as input (an encrypted message is decrypted,\na signature is verified, a file containing keys is listed, etc.).\n\nIf you run into any problems, please add the option --verbose to the invocation to see more\ndiagnostics.\n\n\n\n\n\n", "subsections": [ { "name": "Commands not specific to the function", "content": "" }, { "name": "--version", "content": "Print the program version and licensing information. Note that you cannot abbreviate\nthis command.\n\n", "long": "--version" }, { "name": "--help", "content": "", "long": "--help" }, { "name": "-h", "content": "cannot arbitrarily abbreviate this command (though you can use its short form -h).\n\n", "flag": "-h" }, { "name": "--warranty", "content": "Print warranty information.\n\n", "long": "--warranty" }, { "name": "--dump-options", "content": "Print a list of all available options and commands. Note that you cannot abbreviate\nthis command.\n", "long": "--dump-options" }, { "name": "Commands to select the type of operation", "content": "" }, { "name": "--sign", "content": "", "long": "--sign" }, { "name": "-s --encrypt", "content": "message), --symmetric (to sign and symmetrically encrypt a message), or both --encrypt\nand --symmetric (to sign and encrypt a message that can be decrypted using a secret\nkey or a passphrase). The signing key is chosen by default or can be set explicitly\nusing the --local-user and --default-key options.\n\n", "flag": "-s", "long": "--encrypt" }, { "name": "--clear-sign", "content": "", "long": "--clear-sign" }, { "name": "--clearsign", "content": "Make a cleartext signature. The content in a cleartext signature is readable without\nany special software. OpenPGP software is only needed to verify the signature. clear‐\ntext signatures may modify end-of-line whitespace for platform independence and are\nnot intended to be reversible. The signing key is chosen by default or can be set ex‐\nplicitly using the --local-user and --default-key options.\n\n\n", "long": "--clearsign" }, { "name": "--detach-sign", "content": "", "long": "--detach-sign" }, { "name": "-b", "content": "", "flag": "-b" }, { "name": "--encrypt", "content": "", "long": "--encrypt" }, { "name": "-e --sign", "content": "sign and encrypt a message), --symmetric (to encrypt a message that can be decrypted\nusing a secret key or a passphrase), or --sign and --symmetric together (for a signed\nmessage that can be decrypted using a secret key or a passphrase). --recipient and\nrelated options specify which public keys to use for encryption.\n\n", "flag": "-e", "long": "--sign" }, { "name": "--symmetric", "content": "", "long": "--symmetric" }, { "name": "-c", "content": "is AES-128, but may be chosen with the --cipher-algo option. This command may be com‐\nbined with --sign (for a signed and symmetrically encrypted message), --encrypt (for a\nmessage that may be decrypted via a secret key or a passphrase), or --sign and --en‐‐\ncrypt together (for a signed message that may be decrypted via a secret key or a\npassphrase). gpg caches the passphrase used for symmetric encryption so that a de‐\ncrypt operation may not require that the user needs to enter the passphrase. The op‐\ntion --no-symkey-cache can be used to disable this feature.\n\n", "flag": "-c" }, { "name": "--store", "content": "Store only (make a simple literal data packet).\n\n", "long": "--store" }, { "name": "--decrypt", "content": "", "long": "--decrypt" }, { "name": "-d", "content": "write it to STDOUT (or the file specified with --output). If the decrypted file is\nsigned, the signature is also verified. This command differs from the default opera‐\ntion, as it never writes to the filename which is included in the file and it rejects\nfiles that don't begin with an encrypted message.\n\n", "flag": "-d" }, { "name": "--verify", "content": "Assume that the first argument is a signed file and verify it without generating any\noutput. With no arguments, the signature packet is read from STDIN. If only one ar‐\ngument is given, the specified file is expected to include a complete signature.\n\nWith more than one argument, the first argument should specify a file with a detached\nsignature and the remaining files should contain the signed data. To read the signed\ndata from STDIN, use ‘-’ as the second filename. For security reasons, a detached\nsignature will not read the signed material from STDIN if not explicitly specified.\n\nNote: If the option --batch is not used, gpg may assume that a single argument is a\nfile with a detached signature, and it will try to find a matching data file by strip‐\nping certain suffixes. Using this historical feature to verify a detached signature\nis strongly discouraged; you should always specify the data file explicitly.\n\nNote: When verifying a cleartext signature, gpg verifies only what makes up the clear‐\ntext signed data and not any extra data outside of the cleartext signature or the\nheader lines directly following the dash marker line. The option --output may be used\nto write out the actual signed data, but there are other pitfalls with this format as\nwell. It is suggested to avoid cleartext signatures in favor of detached signatures.\n\nNote: Sometimes the use of the gpgv tool is easier than using the full-fledged gpg\nwith this option. gpgv is designed to compare signed data against a list of trusted\nkeys and returns with success only for a good signature. It has its own manual page.\n\n\n", "long": "--verify" }, { "name": "--multifile", "content": "This modifies certain other commands to accept multiple files for processing on the\ncommand line or read from STDIN with each filename on a separate line. This allows for\nmany files to be processed at once. --multifile may currently be used along with\n--verify, --encrypt, and --decrypt. Note that --multifile --verify may not be used\nwith detached signatures.\n\n", "long": "--multifile" }, { "name": "--verify-files", "content": "Identical to --multifile --verify.\n\n", "long": "--verify-files" }, { "name": "--encrypt-files", "content": "Identical to --multifile --encrypt.\n\n", "long": "--encrypt-files" }, { "name": "--decrypt-files", "content": "Identical to --multifile --decrypt.\n\n", "long": "--decrypt-files" }, { "name": "--list-keys", "content": "", "long": "--list-keys" }, { "name": "-k", "content": "", "flag": "-k" }, { "name": "--list-public-keys", "content": "List the specified keys. If no keys are specified, then all keys from the configured\npublic keyrings are listed.\n\nNever use the output of this command in scripts or other programs. The output is in‐\ntended only for humans and its format is likely to change. The --with-colons option\nemits the output in a stable, machine-parseable format, which is intended for use by\nscripts and other programs.\n\n", "long": "--list-public-keys" }, { "name": "--list-secret-keys", "content": "", "long": "--list-secret-keys" }, { "name": "-K", "content": "are listed. A # after the initial tags sec or ssb means that the secret key or subkey\nis currently not usable. We also say that this key has been taken offline (for exam‐\nple, a primary key can be taken offline by exporting the key using the command --ex‐‐\nport-secret-subkeys). A > after these tags indicate that the key is stored on a\nsmartcard. See also --list-keys.\n\n", "flag": "-K" }, { "name": "--check-signatures", "content": "", "long": "--check-signatures" }, { "name": "--check-sigs", "content": "Same as --list-keys, but the key signatures are verified and listed too. Note that\nfor performance reasons the revocation status of a signing key is not shown. This\ncommand has the same effect as using --list-keys with --with-sig-check.\n\nThe status of the verification is indicated by a flag directly following the \"sig\" tag\n(and thus before the flags described below. A \"!\" indicates that the signature has\nbeen successfully verified, a \"-\" denotes a bad signature and a \"%\" is used if an er‐\nror occurred while checking the signature (e.g. a non supported algorithm). Signa‐\ntures where the public key is not available are not listed; to see their keyids the\ncommand --list-sigs can be used.\n\nFor each signature listed, there are several flags in between the signature status\nflag and keyid. These flags give additional information about each key signature.\nFrom left to right, they are the numbers 1-3 for certificate check level (see --ask-\ncert-level), \"L\" for a local or non-exportable signature (see --lsign-key), \"R\" for a\nnonRevocable signature (see the --edit-key command \"nrsign\"), \"P\" for a signature that\ncontains a policy URL (see --cert-policy-url), \"N\" for a signature that contains a no‐\ntation (see --cert-notation), \"X\" for an eXpired signature (see --ask-cert-expire),\nand the numbers 1-9 or \"T\" for 10 and above to indicate trust signature levels (see\nthe --edit-key command \"tsign\").\n\n\n", "long": "--check-sigs" }, { "name": "--locate-keys", "content": "", "long": "--locate-keys" }, { "name": "--locate-external-keys", "content": "Locate the keys given as arguments. This command basically uses the same algorithm as\nused when locating keys for encryption or signing and may thus be used to see what\nkeys gpg might use. In particular external methods as defined by --auto-key-locate\nmay be used to locate a key. Only public keys are listed. The variant --locate-ex‐‐\nternal-keys does not consider a locally existing key and can thus be used to force the\nrefresh of a key via the defined external methods.\n\n", "long": "--locate-external-keys" }, { "name": "--show-keys", "content": "This commands takes OpenPGP keys as input and prints information about them in the\nsame way the command --list-keys does for locally stored key. In addition the list\noptions show-unusable-uids, show-unusable-subkeys, show-notations and show-policy-urls\nare also enabled. As usual for automated processing, this command should be combined\nwith the option --with-colons.\n\n", "long": "--show-keys" }, { "name": "--fingerprint", "content": "List all keys (or the specified ones) along with their fingerprints. This is the same\noutput as --list-keys but with the additional output of a line with the fingerprint.\nMay also be combined with --check-signatures. If this command is given twice, the\nfingerprints of all secondary keys are listed too. This command also forces pretty\nprinting of fingerprints if the keyid format has been set to \"none\".\n\n", "long": "--fingerprint" }, { "name": "--list-packets", "content": "List only the sequence of packets. This command is only useful for debugging. When\nused with option --verbose the actual MPI values are dumped and not only their\nlengths. Note that the output of this command may change with new releases.\n\n\n", "long": "--list-packets" }, { "name": "--edit-card", "content": "", "long": "--edit-card" }, { "name": "--card-edit", "content": "Present a menu to work with a smartcard. The subcommand \"help\" provides an overview on\navailable commands. For a detailed description, please see the Card HOWTO at\nhttps://gnupg.org/documentation/howtos.html#GnuPG-cardHOWTO .\n\n", "long": "--card-edit" }, { "name": "--card-status", "content": "Show the content of the smart card.\n\n", "long": "--card-status" }, { "name": "--change-pin", "content": "Present a menu to allow changing the PIN of a smartcard. This functionality is also\navailable as the subcommand \"passwd\" with the --edit-card command.\n\n\n--delete-keys name\nRemove key from the public keyring. In batch mode either --yes is required or the key\nmust be specified by fingerprint. This is a safeguard against accidental deletion of\nmultiple keys. If the exclamation mark syntax is used with the fingerprint of a sub‐\nkey only that subkey is deleted; if the exclamation mark is used with the fingerprint\nof the primary key the entire public key is deleted.\n\n\n--delete-secret-keys name\nRemove key from the secret keyring. In batch mode the key must be specified by finger‐\nprint. The option --yes can be used to advise gpg-agent not to request a confirma‐\ntion. This extra pre-caution is done because gpg can't be sure that the secret key\n(as controlled by gpg-agent) is only used for the given OpenPGP public key. If the\nexclamation mark syntax is used with the fingerprint of a subkey only the secret part\nof that subkey is deleted; if the exclamation mark is used with the fingerprint of the\nprimary key only the secret part of the primary key is deleted.\n\n\n\n--delete-secret-and-public-key name\nSame as --delete-key, but if a secret key exists, it will be removed first. In batch\nmode the key must be specified by fingerprint. The option --yes can be used to advise\ngpg-agent not to request a confirmation.\n\n", "long": "--change-pin" }, { "name": "--export", "content": "Either export all keys from all keyrings (default keyrings and those registered via\noption --keyring), or if at least one name is given, those of the given name. The ex‐\nported keys are written to STDOUT or to the file given with option --output. Use to‐\ngether with --armor to mail those keys.\n\n\n--send-keys keyIDs\nSimilar to --export but sends the keys to a keyserver. Fingerprints may be used in‐\nstead of key IDs. Don't send your complete keyring to a keyserver --- select only\nthose keys which are new or changed by you. If no keyIDs are given, gpg does nothing.\n\nTake care: Keyservers are by design write only systems and thus it is not possible to\never delete keys once they have been send to a keyserver.\n\n\n", "long": "--export" }, { "name": "--export-secret-keys", "content": "", "long": "--export-secret-keys" }, { "name": "--export-secret-subkeys", "content": "Same as --export, but exports the secret keys instead. The exported keys are written\nto STDOUT or to the file given with option --output. This command is often used along\nwith the option --armor to allow for easy printing of the key for paper backup; how‐\never the external tool paperkey does a better job of creating backups on paper. Note\nthat exporting a secret key can be a security risk if the exported keys are sent over\nan insecure channel.\n\nThe second form of the command has the special property to render the secret part of\nthe primary key useless; this is a GNU extension to OpenPGP and other implementations\ncan not be expected to successfully import such a key. Its intended use is in gener‐\nating a full key with an additional signing subkey on a dedicated machine. This com‐\nmand then exports the key without the primary key to the main machine.\n\nGnuPG may ask you to enter the passphrase for the key. This is required, because the\ninternal protection method of the secret key is different from the one specified by\nthe OpenPGP protocol.\n\n", "long": "--export-secret-subkeys" }, { "name": "--export-ssh-key", "content": "This command is used to export a key in the OpenSSH public key format. It requires\nthe specification of one key by the usual means and exports the latest valid subkey\nwhich has an authentication capability to STDOUT or to the file given with option\n--output. That output can directly be added to ssh's ‘authorizedkey’ file.\n\nBy specifying the key to export using a key ID or a fingerprint suffixed with an ex‐\nclamation mark (!), a specific subkey or the primary key can be exported. This does\nnot even require that the key has the authentication capability flag set.\n\n", "long": "--export-ssh-key" }, { "name": "--import", "content": "", "long": "--import" }, { "name": "--fast-import", "content": "Import/merge keys. This adds the given keys to the keyring. The fast version is cur‐\nrently just a synonym.\n\nThere are a few other options which control how this command works. Most notable here\nis the --import-options merge-only option which does not insert new keys but does only\nthe merging of new signatures, user-IDs and subkeys.\n\n\n--receive-keys keyIDs\n--recv-keys keyIDs\nImport the keys with the given keyIDs from a keyserver.\n\n", "long": "--fast-import" }, { "name": "--refresh-keys", "content": "Request updates from a keyserver for keys that already exist on the local keyring.\nThis is useful for updating a key with the latest signatures, user IDs, etc. Calling\nthis with no arguments will refresh the entire keyring.\n\n\n--search-keys names\nSearch the keyserver for the given names. Multiple names given here will be joined to‐\ngether to create the search string for the keyserver. Note that keyservers search for\nnames in a different and simpler way than gpg does. The best choice is to use a mail\naddress. Due to data privacy reasons keyservers may even not even allow searching by\nuser id or mail address and thus may only return results when being used with the\n--recv-key command to search by key fingerprint or keyid.\n\n\n--fetch-keys URIs\nRetrieve keys located at the specified URIs. Note that different installations of\nGnuPG may support different protocols (HTTP, FTP, LDAP, etc.). When using HTTPS the\nsystem provided root certificates are used by this command.\n\n", "long": "--refresh-keys" }, { "name": "--update-trustdb", "content": "Do trust database maintenance. This command iterates over all keys and builds the Web\nof Trust. This is an interactive command because it may have to ask for the \"own‐\nertrust\" values for keys. The user has to give an estimation of how far she trusts the\nowner of the displayed key to correctly certify (sign) other keys. GnuPG only asks for\nthe ownertrust value if it has not yet been assigned to a key. Using the --edit-key\nmenu, the assigned value can be changed at any time.\n\n", "long": "--update-trustdb" }, { "name": "--check-trustdb", "content": "Do trust database maintenance without user interaction. From time to time the trust\ndatabase must be updated so that expired keys or signatures and the resulting changes\nin the Web of Trust can be tracked. Normally, GnuPG will calculate when this is re‐\nquired and do it automatically unless --no-auto-check-trustdb is set. This command can\nbe used to force a trust database check at any time. The processing is identical to\nthat of --update-trustdb but it skips keys with a not yet defined \"ownertrust\".\n\nFor use with cron jobs, this command can be used together with --batch in which case\nthe trust database check is done only if a check is needed. To force a run even in\nbatch mode add the option --yes.\n\n\n", "long": "--check-trustdb" }, { "name": "--export-ownertrust", "content": "Send the ownertrust values to STDOUT. This is useful for backup purposes as these val‐\nues are the only ones which can't be re-created from a corrupted trustdb. Example:\ngpg --export-ownertrust > otrust.txt\n\n\n", "long": "--export-ownertrust" }, { "name": "--import-ownertrust", "content": "Update the trustdb with the ownertrust values stored in files (or STDIN if not given);\nexisting values will be overwritten. In case of a severely damaged trustdb and if you\nhave a recent backup of the ownertrust values (e.g. in the file ‘otrust.txt’), you may\nre-create the trustdb using these commands:\ncd ~/.gnupg\nrm trustdb.gpg\ngpg --import-ownertrust < otrust.txt\n\n\n", "long": "--import-ownertrust" }, { "name": "--rebuild-keydb-caches", "content": "When updating from version 1.0.6 to 1.0.7 this command should be used to create signa‐\nture caches in the keyring. It might be handy in other situations too.\n\n\n--print-md algo", "long": "--rebuild-keydb-caches" }, { "name": "--print-mds", "content": "Print message digest of algorithm algo for all given files or STDIN. With the second\nform (or a deprecated \"*\" for algo) digests for all available algorithms are printed.\n\n\n--gen-random 0|1|2 count\nEmit count random bytes of the given quality level 0, 1 or 2. If count is not given or\nzero, an endless sequence of random bytes will be emitted. If used with --armor the\noutput will be base64 encoded. PLEASE, don't use this command unless you know what\nyou are doing; it may remove precious entropy from the system!\n\n\n--gen-prime mode bits\nUse the source, Luke :-). The output format is subject to change with ant release.\n\n\n", "long": "--print-mds" }, { "name": "--enarmor", "content": "", "long": "--enarmor" }, { "name": "--dearmor", "content": "Pack or unpack an arbitrary input into/from an OpenPGP ASCII armor. This is a GnuPG\nextension to OpenPGP and in general not very useful.\n\n\n--tofu-policy {auto|good|unknown|bad|ask} keys\nSet the TOFU policy for all the bindings associated with the specified keys. For more\ninformation about the meaning of the policies, see: [trust-model-tofu]. The keys may\nbe specified either by their fingerprint (preferred) or their keyid.\n\n\n", "long": "--dearmor" }, { "name": "How to manage your keys", "content": "This section explains the main commands for key management.\n\n\n\n--quick-generate-key user-id [algo [usage [expire]]]" }, { "name": "--quick-gen-key", "content": "This is a simple command to generate a standard key with one user id. In contrast to\n--generate-key the key is generated directly without the need to answer a bunch of\nprompts. Unless the option --yes is given, the key creation will be canceled if the\ngiven user id already exists in the keyring.\n\nIf invoked directly on the console without any special options an answer to a ``Con‐\ntinue?'' style confirmation prompt is required. In case the user id already exists in\nthe keyring a second prompt to force the creation of the key will show up.\n\nIf algo or usage are given, only the primary key is created and no prompts are shown.\nTo specify an expiration date but still create a primary and subkey use ``default'' or\n``future-default'' for algo and ``default'' for usage. For a description of these op‐\ntional arguments see the command --quick-add-key. The usage accepts also the value\n``cert'' which can be used to create a certification only primary key; the default is\nto a create certification and signing key.\n\nThe expire argument can be used to specify an expiration date for the key. Several\nformats are supported; commonly the ISO formats ``YYYY-MM-DD'' or ``YYYYMMDDThhmmss''\nare used. To make the key expire in N seconds, N days, N weeks, N months, or N years\nuse ``seconds=N'', ``Nd'', ``Nw'', ``Nm'', or ``Ny'' respectively. Not specifying a\nvalue, or using ``-'' results in a key expiring in a reasonable default interval. The\nvalues ``never'', ``none'' can be used for no expiration date.\n\nIf this command is used with --batch, --pinentry-mode has been set to loopback, and\none of the passphrase options (--passphrase, --passphrase-fd, or passphrase-file) is\nused, the supplied passphrase is used for the new key and the agent does not ask for\nit. To create a key without any protection --passphrase '' may be used.\n\nTo create an OpenPGP key from the keys available on the currently inserted smartcard,\nthe special string ``card'' can be used for algo. If the card features an encryption\nand a signing key, gpg will figure them out and creates an OpenPGP key consisting of\nthe usual primary key and one subkey. This works only with certain smartcards. Note\nthat the interactive --full-gen-key command allows to do the same but with greater\nflexibility in the selection of the smartcard keys.\n\nNote that it is possible to create a primary key and a subkey using non-default algo‐\nrithms by using ``default'' and changing the default parameters using the option --de‐‐\nfault-new-key-algo.\n\n\n--quick-set-expire fpr expire [*|subfprs]\nWith two arguments given, directly set the expiration time of the primary key identi‐\nfied by fpr to expire. To remove the expiration time 0 can be used. With three argu‐\nments and the third given as an asterisk, the expiration time of all non-revoked and\nnot yet expired subkeys are set to expire. With more than two arguments and a list of\nfingerprints given for subfprs, all non-revoked subkeys matching these fingerprints\nare set to expire.\n\n\n\n--quick-add-key fpr [algo [usage [expire]]]\nDirectly add a subkey to the key identified by the fingerprint fpr. Without the op‐\ntional arguments an encryption subkey is added. If any of the arguments are given a\nmore specific subkey is added.\n\nalgo may be any of the supported algorithms or curve names given in the format as used\nby key listings. To use the default algorithm the string ``default'' or ``-'' can be\nused. Supported algorithms are ``rsa'', ``dsa'', ``elg'', ``ed25519'', ``cv25519'',\nand other ECC curves. For example the string ``rsa'' adds an RSA key with the default\nkey length; a string ``rsa4096'' requests that the key length is 4096 bits. The\nstring ``future-default'' is an alias for the algorithm which will likely be used as\ndefault algorithm in future versions of gpg. To list the supported ECC curves the\ncommand gpg --with-colons --list-config curve can be used.\n\nDepending on the given algo the subkey may either be an encryption subkey or a signing\nsubkey. If an algorithm is capable of signing and encryption and such a subkey is de‐\nsired, a usage string must be given. This string is either ``default'' or ``-'' to\nkeep the default or a comma delimited list (or space delimited list) of keywords:\n``sign'' for a signing subkey, ``auth'' for an authentication subkey, and ``encr'' for\nan encryption subkey (``encrypt'' can be used as alias for ``encr''). The valid com‐\nbinations depend on the algorithm.\n\nThe expire argument can be used to specify an expiration date for the key. Several\nformats are supported; commonly the ISO formats ``YYYY-MM-DD'' or ``YYYYMMDDThhmmss''\nare used. To make the key expire in N seconds, N days, N weeks, N months, or N years\nuse ``seconds=N'', ``Nd'', ``Nw'', ``Nm'', or ``Ny'' respectively. Not specifying a\nvalue, or using ``-'' results in a key expiring in a reasonable default interval. The\nvalues ``never'', ``none'' can be used for no expiration date.\n\n", "long": "--quick-gen-key" }, { "name": "--generate-key", "content": "", "long": "--generate-key" }, { "name": "--gen-key", "content": "Generate a new key pair using the current default parameters. This is the standard\ncommand to create a new key. In addition to the key a revocation certificate is cre‐\nated and stored in the ‘openpgp-revocs.d’ directory below the GnuPG home directory.\n\n", "long": "--gen-key" }, { "name": "--full-generate-key", "content": "", "long": "--full-generate-key" }, { "name": "--full-gen-key", "content": "Generate a new key pair with dialogs for all options. This is an extended version of\n--generate-key.\n\nThere is also a feature which allows you to create keys in batch mode. See the manual\nsection ``Unattended key generation'' on how to use this.\n\n\n\n--generate-revocation name\n--gen-revoke name\nGenerate a revocation certificate for the complete key. To only revoke a subkey or a\nkey signature, use the --edit command.\n\nThis command merely creates the revocation certificate so that it can be used to re‐\nvoke the key if that is ever needed. To actually revoke a key the created revocation\ncertificate needs to be merged with the key to revoke. This is done by importing the\nrevocation certificate using the --import command. Then the revoked key needs to be\npublished, which is best done by sending the key to a keyserver (command --send-key)\nand by exporting (--export) it to a file which is then send to frequent communication\npartners.\n\n\n\n--generate-designated-revocation name\n--desig-revoke name\nGenerate a designated revocation certificate for a key. This allows a user (with the\npermission of the keyholder) to revoke someone else's key.\n\n\n", "long": "--full-gen-key" }, { "name": "--edit-key", "content": "Present a menu which enables you to do most of the key management related tasks. It\nexpects the specification of a key on the command line.\n\n\n\nuid n Toggle selection of user ID or photographic user ID with index n. Use * to se‐\nlect all and 0 to deselect all.\n\n\nkey n Toggle selection of subkey with index n or key ID n. Use * to select all and 0\nto deselect all.\n\n\nsign Make a signature on key of user name. If the key is not yet signed by the de‐\nfault user (or the users given with -u), the program displays the information\nof the key again, together with its fingerprint and asks whether it should be\nsigned. This question is repeated for all users specified with -u.\n\n\nlsign Same as \"sign\" but the signature is marked as non-exportable and will therefore\nnever be used by others. This may be used to make keys valid only in the local\nenvironment.\n\n\nnrsign Same as \"sign\" but the signature is marked as non-revocable and can therefore\nnever be revoked.\n\n\ntsign Make a trust signature. This is a signature that combines the notions of certi‐\nfication (like a regular signature), and trust (like the \"trust\" command). It\nis generally only useful in distinct communities or groups. For more informa‐\ntion please read the sections ``Trust Signature'' and ``Regular Expression'' in\nRFC-4880.\n\nNote that \"l\" (for local / non-exportable), \"nr\" (for non-revocable, and \"t\" (for\ntrust) may be freely mixed and prefixed to \"sign\" to create a signature of any type\ndesired.\n\nIf the option --only-sign-text-ids is specified, then any non-text based user ids (e.g.,\nphoto IDs) will not be selected for signing.\n\n\n\ndelsig Delete a signature. Note that it is not possible to retract a signature, once\nit has been send to the public (i.e. to a keyserver). In that case you better\nuse revsig.\n\n\nrevsig Revoke a signature. For every signature which has been generated by one of the\nsecret keys, GnuPG asks whether a revocation certificate should be generated.\n\n\ncheck Check the signatures on all selected user IDs. With the extra option selfsig\nonly self-signatures are shown.\n\n\nadduid Create an additional user ID.\n\n\naddphoto\nCreate a photographic user ID. This will prompt for a JPEG file that will be\nembedded into the user ID. Note that a very large JPEG will make for a very\nlarge key. Also note that some programs will display your JPEG unchanged\n(GnuPG), and some programs will scale it to fit in a dialog box (PGP).\n\n\nshowphoto\nDisplay the selected photographic user ID.\n\n\ndeluid Delete a user ID or photographic user ID. Note that it is not possible to re‐\ntract a user id, once it has been send to the public (i.e. to a keyserver). In\nthat case you better use revuid.\n\n\nrevuid Revoke a user ID or photographic user ID.\n\n\nprimary\nFlag the current user id as the primary one, removes the primary user id flag\nfrom all other user ids and sets the timestamp of all affected self-signatures\none second ahead. Note that setting a photo user ID as primary makes it primary\nover other photo user IDs, and setting a regular user ID as primary makes it\nprimary over other regular user IDs.\n\n\nkeyserver\nSet a preferred keyserver for the specified user ID(s). This allows other users\nto know where you prefer they get your key from. See --keyserver-options honor-\nkeyserver-url for more on how this works. Setting a value of \"none\" removes an\nexisting preferred keyserver.\n\n\nnotation\nSet a name=value notation for the specified user ID(s). See --cert-notation for\nmore on how this works. Setting a value of \"none\" removes all notations, set‐\nting a notation prefixed with a minus sign (-) removes that notation, and set‐\nting a notation name (without the =value) prefixed with a minus sign removes\nall notations with that name.\n\n\npref List preferences from the selected user ID. This shows the actual preferences,\nwithout including any implied preferences.\n\n\nshowpref\nMore verbose preferences listing for the selected user ID. This shows the pref‐\nerences in effect by including the implied preferences of 3DES (cipher), SHA-1\n(digest), and Uncompressed (compression) if they are not already included in\nthe preference list. In addition, the preferred keyserver and signature nota‐\ntions (if any) are shown.\n\n\nsetpref string\nSet the list of user ID preferences to string for all (or just the selected)\nuser IDs. Calling setpref with no arguments sets the preference list to the de‐\nfault (either built-in or set via --default-preference-list), and calling set‐\npref with \"none\" as the argument sets an empty preference list. Use gpg --ver‐‐\nsion to get a list of available algorithms. Note that while you can change the\npreferences on an attribute user ID (aka \"photo ID\"), GnuPG does not select\nkeys via attribute user IDs so these preferences will not be used by GnuPG.\n\nWhen setting preferences, you should list the algorithms in the order which\nyou'd like to see them used by someone else when encrypting a message to your\nkey. If you don't include 3DES, it will be automatically added at the end.\nNote that there are many factors that go into choosing an algorithm (for exam‐\nple, your key may not be the only recipient), and so the remote OpenPGP appli‐\ncation being used to send to you may or may not follow your exact chosen order\nfor a given message. It will, however, only choose an algorithm that is\npresent on the preference list of every recipient key. See also the INTEROPER‐\nABILITY WITH OTHER OPENPGP PROGRAMS section below.\n\n\naddkey Add a subkey to this key.\n\n\naddcardkey\nGenerate a subkey on a card and add it to this key.\n\n\nkeytocard\nTransfer the selected secret subkey (or the primary key if no subkey has been\nselected) to a smartcard. The secret key in the keyring will be replaced by a\nstub if the key could be stored successfully on the card and you use the save\ncommand later. Only certain key types may be transferred to the card. A sub\nmenu allows you to select on what card to store the key. Note that it is not\npossible to get that key back from the card - if the card gets broken your se‐\ncret key will be lost unless you have a backup somewhere.\n\n\nbkuptocard file\nRestore the given file to a card. This command may be used to restore a backup\nkey (as generated during card initialization) to a new card. In almost all\ncases this will be the encryption key. You should use this command only with\nthe corresponding public key and make sure that the file given as argument is\nindeed the backup to restore. You should then select 2 to restore as encryption\nkey. You will first be asked to enter the passphrase of the backup key and\nthen for the Admin PIN of the card.\n\n\ndelkey Remove a subkey (secondary key). Note that it is not possible to retract a sub‐\nkey, once it has been send to the public (i.e. to a keyserver). In that case\nyou better use revkey. Also note that this only deletes the public part of a\nkey.\n\n\nrevkey Revoke a subkey.\n\n\nexpire Change the key or subkey expiration time. If a subkey is selected, the expira‐\ntion time of this subkey will be changed. With no selection, the key expiration\nof the primary key is changed.\n\n\ntrust Change the owner trust value for the key. This updates the trust-db immediately\nand no save is required.\n\n\ndisable\nenable Disable or enable an entire key. A disabled key can not normally be used for\nencryption.\n\n\naddrevoker\nAdd a designated revoker to the key. This takes one optional argument: \"sensi‐\ntive\". If a designated revoker is marked as sensitive, it will not be exported\nby default (see export-options).\n\n\npasswd Change the passphrase of the secret key.\n\n\ntoggle This is dummy command which exists only for backward compatibility.\n\n\nclean Compact (by removing all signatures except the selfsig) any user ID that is no\nlonger usable (e.g. revoked, or expired). Then, remove any signatures that are\nnot usable by the trust calculations. Specifically, this removes any signature\nthat does not validate, any signature that is superseded by a later signature,\nrevoked signatures, and signatures issued by keys that are not present on the\nkeyring.\n\n\nminimize\nMake the key as small as possible. This removes all signatures from each user\nID except for the most recent self-signature.\n\n\nchange-usage\nChange the usage flags (capabilities) of the primary key or of subkeys. These\nusage flags (e.g. Certify, Sign, Authenticate, Encrypt) are set during key cre‐\nation. Sometimes it is useful to have the opportunity to change them (for ex‐\nample to add Authenticate) after they have been created. Please take care when\ndoing this; the allowed usage flags depend on the key algorithm.\n\n\ncross-certify\nAdd cross-certification signatures to signing subkeys that may not currently\nhave them. Cross-certification signatures protect against a subtle attack\nagainst signing subkeys. See --require-cross-certification. All new keys gen‐\nerated have this signature by default, so this command is only useful to bring\nolder keys up to date.\n\n\nsave Save all changes to the keyrings and quit.\n\n\nquit Quit the program without updating the keyrings.\n\nThe listing shows you the key with its secondary keys and all user IDs. The primary\nuser ID is indicated by a dot, and selected keys or user IDs are indicated by an as‐\nterisk. The trust value is displayed with the primary key: \"trust\" is the assigned\nowner trust and \"validity\" is the calculated validity of the key. Validity values are\nalso displayed for all user IDs. For possible values of trust, see: [trust-values].\n\n\n--sign-key name\nSigns a public key with your secret key. This is a shortcut version of the subcommand\n\"sign\" from --edit.\n\n\n--lsign-key name\nSigns a public key with your secret key but marks it as non-exportable. This is a\nshortcut version of the subcommand \"lsign\" from --edit-key.\n\n\n--quick-sign-key fpr [names]\n--quick-lsign-key fpr [names]\nDirectly sign a key from the passphrase without any further user interaction. The fpr\nmust be the verified primary fingerprint of a key in the local keyring. If no names\nare given, all useful user ids are signed; with given [names] only useful user ids\nmatching one of theses names are signed. By default, or if a name is prefixed with a\n'*', a case insensitive substring match is used. If a name is prefixed with a '=' a\ncase sensitive exact match is done.\n\nThe command --quick-lsign-key marks the signatures as non-exportable. If such a non-\nexportable signature already exists the --quick-sign-key turns it into a exportable\nsignature.\n\nThis command uses reasonable defaults and thus does not provide the full flexibility\nof the \"sign\" subcommand from --edit-key. Its intended use is to help unattended key\nsigning by utilizing a list of verified fingerprints.\n\n\n--quick-add-uid user-id new-user-id\nThis command adds a new user id to an existing key. In contrast to the interactive\nsub-command adduid of --edit-key the new-user-id is added verbatim with only leading\nand trailing white space removed, it is expected to be UTF-8 encoded, and no checks on\nits form are applied.\n\n\n--quick-revoke-uid user-id user-id-to-revoke\nThis command revokes a user ID on an existing key. It cannot be used to revoke the\nlast user ID on key (some non-revoked user ID must remain), with revocation reason\n``User ID is no longer valid''. If you want to specify a different revocation reason,\nor to supply supplementary revocation text, you should use the interactive sub-command\nrevuid of --edit-key.\n\n\n--quick-revoke-sig fpr signing-fpr [names]\nThis command revokes the key signatures made by signing-fpr from the key specified by\nthe fingerprint fpr. With names given only the signatures on user ids of the key\nmatching any of the given names are affected (see --quick-sign-key). If a revocation\nalready exists a notice is printed instead of creating a new revocation; no error is\nreturned in this case. Note that key signature revocations may be superseded by a\nnewer key signature and in turn again revoked.\n\n\n--quick-set-primary-uid user-id primary-user-id\nThis command sets or updates the primary user ID flag on an existing key. user-id\nspecifies the key and primary-user-id the user ID which shall be flagged as the pri‐\nmary user ID. The primary user ID flag is removed from all other user ids and the\ntimestamp of all affected self-signatures is set one second ahead.\n\n\n\n--change-passphrase user-id\n--passwd user-id\nChange the passphrase of the secret key belonging to the certificate specified as\nuser-id. This is a shortcut for the sub-command passwd of the edit key menu. When\nusing together with the option --dry-run this will not actually change the passphrase\nbut check that the current passphrase is correct.\n\n", "long": "--edit-key" } ] }, "OPTIONS": { "content": "gpg features a bunch of options to control the exact behaviour and to change the default con‐\nfiguration.\n\n\nLong options can be put in an options file (default \"~/.gnupg/gpg.conf\"). Short option names\nwill not work - for example, \"armor\" is a valid option for the options file, while \"a\" is\nnot. Do not write the 2 dashes, but simply the name of the option and any required arguments.\nLines with a hash ('#') as the first non-white-space character are ignored. Commands may be\nput in this file too, but that is not generally useful as the command will execute automati‐\ncally with every execution of gpg.\n\nPlease remember that option parsing stops as soon as a non-option is encountered, you can ex‐\nplicitly stop parsing by using the special option --.\n\n\n", "subsections": [ { "name": "How to change the configuration", "content": "These options are used to change the configuration and are usually found in the option file.\n\n\n\n--default-key name\nUse name as the default key to sign with. If this option is not used, the default key\nis the first key found in the secret keyring. Note that -u or --local-user overrides\nthis option. This option may be given multiple times. In this case, the last key for\nwhich a secret key is available is used. If there is no secret key available for any\nof the specified values, GnuPG will not emit an error message but continue as if this\noption wasn't given.\n\n\n--default-recipient name\nUse name as default recipient if option --recipient is not used and don't ask if this\nis a valid one. name must be non-empty.\n\n" }, { "name": "--default-recipient-self", "content": "Use the default key as default recipient if option --recipient is not used and don't\nask if this is a valid one. The default key is the first one from the secret keyring\nor the one set with --default-key.\n\n", "long": "--default-recipient-self" }, { "name": "--no-default-recipient", "content": "Reset --default-recipient and --default-recipient-self.\n\n", "long": "--no-default-recipient" }, { "name": "-v, --verbose", "content": "Give more information during processing. If used twice, the input data is listed in\ndetail.\n\n", "flag": "-v", "long": "--verbose" }, { "name": "--no-verbose", "content": "Reset verbose level to 0.\n\n", "long": "--no-verbose" }, { "name": "-q, --quiet", "content": "Try to be as quiet as possible.\n\n", "flag": "-q", "long": "--quiet" }, { "name": "--batch", "content": "", "long": "--batch" }, { "name": "--no-batch", "content": "Use batch mode. Never ask, do not allow interactive commands. --no-batch disables\nthis option. Note that even with a filename given on the command line, gpg might\nstill need to read from STDIN (in particular if gpg figures that the input is a de‐\ntached signature and no data file has been specified). Thus if you do not want to\nfeed data via STDIN, you should connect STDIN to g‘/dev/null’.\n\nIt is highly recommended to use this option along with the options --status-fd and\n--with-colons for any unattended use of gpg.\n\n", "long": "--no-batch" }, { "name": "--no-tty", "content": "Make sure that the TTY (terminal) is never used for any output. This option is needed\nin some cases because GnuPG sometimes prints warnings to the TTY even if --batch is\nused.\n\n\n--yes Assume \"yes\" on most questions.\n\n\n--no Assume \"no\" on most questions.\n\n\n\n--list-options parameters\nThis is a space or comma delimited string that gives options used when listing keys\nand signatures (that is, --list-keys, --check-signatures, --list-public-keys, --list-\nsecret-keys, and the --edit-key functions). Options can be prepended with a no- (af‐\nter the two dashes) to give the opposite meaning. The options are:\n\n\n\nshow-photos\nCauses --list-keys, --check-signatures, --list-public-keys, and --list-secret-\nkeys to display any photo IDs attached to the key. Defaults to no. See also\n--photo-viewer. Does not work with --with-colons: see --attribute-fd for the\nappropriate way to get photo data for scripts and other frontends.\n\n\nshow-usage\nShow usage information for keys and subkeys in the standard key listing. This\nis a list of letters indicating the allowed usage for a key (E=encryption,\nS=signing, C=certification, A=authentication). Defaults to yes.\n\n\nshow-policy-urls\nShow policy URLs in the --check-signatures listings. Defaults to no.\n\n\nshow-notations\nshow-std-notations\nshow-user-notations\nShow all, IETF standard, or user-defined signature notations in the --check-\nsignatures listings. Defaults to no.\n\n\nshow-keyserver-urls\nShow any preferred keyserver URL in the --check-signatures listings. Defaults\nto no.\n\n\nshow-uid-validity\nDisplay the calculated validity of user IDs during key listings. Defaults to\nyes.\n\n\nshow-unusable-uids\nShow revoked and expired user IDs in key listings. Defaults to no.\n\n\nshow-unusable-subkeys\nShow revoked and expired subkeys in key listings. Defaults to no.\n\n\nshow-keyring\nDisplay the keyring name at the head of key listings to show which keyring a\ngiven key resides on. Defaults to no.\n\n\nshow-sig-expire\nShow signature expiration dates (if any) during --check-signatures listings.\nDefaults to no.\n\n\nshow-sig-subpackets\nInclude signature subpackets in the key listing. This option can take an op‐\ntional argument list of the subpackets to list. If no argument is passed, list\nall subpackets. Defaults to no. This option is only meaningful when using\n--with-colons along with --check-signatures.\n\n\nshow-only-fpr-mbox\nFor each user-id which has a valid mail address print only the fingerprint fol‐\nlowed by the mail address.\n\n\n--verify-options parameters\nThis is a space or comma delimited string that gives options used when verifying sig‐\nnatures. Options can be prepended with a `no-' to give the opposite meaning. The op‐\ntions are:\n\n\n\nshow-photos\nDisplay any photo IDs present on the key that issued the signature. Defaults\nto no. See also --photo-viewer.\n\n\nshow-policy-urls\nShow policy URLs in the signature being verified. Defaults to yes.\n\n\nshow-notations\nshow-std-notations\nshow-user-notations\nShow all, IETF standard, or user-defined signature notations in the signature\nbeing verified. Defaults to IETF standard.\n\n\nshow-keyserver-urls\nShow any preferred keyserver URL in the signature being verified. Defaults to\nyes.\n\n\nshow-uid-validity\nDisplay the calculated validity of the user IDs on the key that issued the sig‐\nnature. Defaults to yes.\n\n\nshow-unusable-uids\nShow revoked and expired user IDs during signature verification. Defaults to\nno.\n\n\nshow-primary-uid-only\nShow only the primary user ID during signature verification. That is all the\nAKA lines as well as photo Ids are not shown with the signature verification\nstatus.\n\n\npka-lookups\nEnable PKA lookups to verify sender addresses. Note that PKA is based on DNS,\nand so enabling this option may disclose information on when and what signa‐\ntures are verified or to whom data is encrypted. This is similar to the \"web\nbug\" described for the --auto-key-retrieve option.\n\n\npka-trust-increase\nRaise the trust in a signature to full if the signature passes PKA validation.\nThis option is only meaningful if pka-lookups is set.\n\n", "long": "--no-tty" }, { "name": "--enable-large-rsa", "content": "", "long": "--enable-large-rsa" }, { "name": "--disable-large-rsa", "content": "With --generate-key and --batch, enable the creation of RSA secret keys as large as\n8192 bit. Note: 8192 bit is more than is generally recommended. These large keys\ndon't significantly improve security, but they are more expensive to use, and their\nsignatures and certifications are larger. This option is only available if the binary\nwas build with large-secmem support.\n\n", "long": "--disable-large-rsa" }, { "name": "--enable-dsa2", "content": "", "long": "--enable-dsa2" }, { "name": "--disable-dsa2", "content": "Enable hash truncation for all DSA keys even for old DSA Keys up to 1024 bit. This is\nalso the default with --openpgp. Note that older versions of GnuPG also required this\nflag to allow the generation of DSA larger than 1024 bit.\n\n\n--photo-viewer string\nThis is the command line that should be run to view a photo ID. \"%i\" will be expanded\nto a filename containing the photo. \"%I\" does the same, except the file will not be\ndeleted once the viewer exits. Other flags are \"%k\" for the key ID, \"%K\" for the long\nkey ID, \"%f\" for the key fingerprint, \"%t\" for the extension of the image type (e.g.\n\"jpg\"), \"%T\" for the MIME type of the image (e.g. \"image/jpeg\"), \"%v\" for the single-\ncharacter calculated validity of the image being viewed (e.g. \"f\"), \"%V\" for the cal‐\nculated validity as a string (e.g. \"full\"), \"%U\" for a base32 encoded hash of the\nuser ID, and \"%%\" for an actual percent sign. If neither %i or %I are present, then\nthe photo will be supplied to the viewer on standard input.\n\nOn Unix the default viewer is xloadimage -fork -quiet -title 'KeyID 0x%k' STDIN with a\nfallback to display -title 'KeyID 0x%k' %i and finally to xdg-open %i. On Windows\n!ShellExecute 400 %i is used; here the command is a meta command to use that API call\nfollowed by a wait time in milliseconds which is used to give the viewer time to read\nthe temporary image file before gpg deletes it again. Note that if your image viewer\nprogram is not secure, then executing it from gpg does not make it secure.\n\n\n--exec-path string\nSets a list of directories to search for photo viewers If not provided photo viewers\nuse the PATH environment variable.\n\n\n--keyring file\nAdd file to the current list of keyrings. If file begins with a tilde and a slash,\nthese are replaced by the $HOME directory. If the filename does not contain a slash,\nit is assumed to be in the GnuPG home directory (\"~/.gnupg\" if --homedir or $GNUPGHOME\nis not used).\n\nNote that this adds a keyring to the current list. If the intent is to use the speci‐\nfied keyring alone, use --keyring along with --no-default-keyring.\n\nIf the option --no-keyring has been used no keyrings will be used at all.\n\n\n\n--secret-keyring file\nThis is an obsolete option and ignored. All secret keys are stored in the ‘private-\nkeys-v1.d’ directory below the GnuPG home directory.\n\n\n--primary-keyring file\nDesignate file as the primary public keyring. This means that newly imported keys (via\n--import or keyserver --recv-from) will go to this keyring.\n\n\n--trustdb-name file\nUse file instead of the default trustdb. If file begins with a tilde and a slash,\nthese are replaced by the $HOME directory. If the filename does not contain a slash,\nit is assumed to be in the GnuPG home directory (‘~/.gnupg’ if --homedir or $GNUPGHOME\nis not used).\n\n\n--homedir dir\nSet the name of the home directory to dir. If this option is not used, the home direc‐\ntory defaults to ‘~/.gnupg’. It is only recognized when given on the command line.\nIt also overrides any home directory stated through the environment variable\n‘GNUPGHOME’ or (on Windows systems) by means of the Registry entry HKCU\\Soft‐\nware\\GNU\\GnuPG:HomeDir.\n\nOn Windows systems it is possible to install GnuPG as a portable application. In this\ncase only this command line option is considered, all other ways to set a home direc‐\ntory are ignored.\n\nTo install GnuPG as a portable application under Windows, create an empty file named\n‘gpgconf.ctl’ in the same directory as the tool ‘gpgconf.exe’. The root of the in‐\nstallation is then that directory; or, if ‘gpgconf.exe’ has been installed directly\nbelow a directory named ‘bin’, its parent directory. You also need to make sure that\nthe following directories exist and are writable: ‘ROOT/home’ for the GnuPG home and\n‘ROOT/var/cache/gnupg’ for internal cache files.\n\n\n\n--display-charset name\nSet the name of the native character set. This is used to convert some informational\nstrings like user IDs to the proper UTF-8 encoding. Note that this has nothing to do\nwith the character set of data to be encrypted or signed; GnuPG does not recode user-\nsupplied data. If this option is not used, the default character set is determined\nfrom the current locale. A verbosity level of 3 shows the chosen set. Valid values\nfor name are:\n\n\n\niso-8859-1\nThis is the Latin 1 set.\n\n\niso-8859-2\nThe Latin 2 set.\n\n\niso-8859-15\nThis is currently an alias for the Latin 1 set.\n\n\nkoi8-r The usual Russian set (RFC-1489).\n\n\nutf-8 Bypass all translations and assume that the OS uses native UTF-8 encoding.\n\n", "long": "--disable-dsa2" }, { "name": "--utf8-strings", "content": "", "long": "--utf8-strings" }, { "name": "--no-utf8-strings", "content": "Assume that command line arguments are given as UTF-8 strings. The default (--no-\nutf8-strings) is to assume that arguments are encoded in the character set as speci‐\nfied by --display-charset. These options affect all following arguments. Both options\nmay be used multiple times.\n\n\n\n--options file\nRead options from file and do not try to read them from the default options file in\nthe homedir (see --homedir). This option is ignored if used in an options file.\n\n", "long": "--no-utf8-strings" }, { "name": "--no-options", "content": "Shortcut for --options /dev/null. This option is detected before an attempt to open an\noption file. Using this option will also prevent the creation of a ‘~/.gnupg’ home‐\ndir.\n\n", "long": "--no-options" }, { "name": "-z", "content": "--compress-level n\n--bzip2-compress-level n\nSet compression level to n for the ZIP and ZLIB compression algorithms. The default is\nto use the default compression level of zlib (normally 6). --bzip2-compress-level sets\nthe compression level for the BZIP2 compression algorithm (defaulting to 6 as well).\nThis is a different option from --compress-level since BZIP2 uses a significant amount\nof memory for each additional compression level. -z sets both. A value of 0 for n\ndisables compression.\n\n", "flag": "-z" }, { "name": "--bzip2-decompress-lowmem", "content": "Use a different decompression method for BZIP2 compressed files. This alternate method\nuses a bit more than half the memory, but also runs at half the speed. This is useful\nunder extreme low memory circumstances when the file was originally compressed at a\nhigh --bzip2-compress-level.\n\n\n", "long": "--bzip2-decompress-lowmem" }, { "name": "--mangle-dos-filenames", "content": "", "long": "--mangle-dos-filenames" }, { "name": "--no-mangle-dos-filenames", "content": "Older version of Windows cannot handle filenames with more than one dot. --mangle-dos-\nfilenames causes GnuPG to replace (rather than add to) the extension of an output\nfilename to avoid this problem. This option is off by default and has no effect on\nnon-Windows platforms.\n\n", "long": "--no-mangle-dos-filenames" }, { "name": "--ask-cert-level", "content": "", "long": "--ask-cert-level" }, { "name": "--no-ask-cert-level", "content": "When making a key signature, prompt for a certification level. If this option is not\nspecified, the certification level used is set via --default-cert-level. See --de‐‐\nfault-cert-level for information on the specific levels and how they are used. --no-\nask-cert-level disables this option. This option defaults to no.\n\n\n--default-cert-level n\nThe default to use for the check level when signing a key.\n\n0 means you make no particular claim as to how carefully you verified the key.\n\n1 means you believe the key is owned by the person who claims to own it but you could\nnot, or did not verify the key at all. This is useful for a \"persona\" verification,\nwhere you sign the key of a pseudonymous user.\n\n2 means you did casual verification of the key. For example, this could mean that you\nverified the key fingerprint and checked the user ID on the key against a photo ID.\n\n3 means you did extensive verification of the key. For example, this could mean that\nyou verified the key fingerprint with the owner of the key in person, and that you\nchecked, by means of a hard to forge document with a photo ID (such as a passport)\nthat the name of the key owner matches the name in the user ID on the key, and finally\nthat you verified (by exchange of email) that the email address on the key belongs to\nthe key owner.\n\nNote that the examples given above for levels 2 and 3 are just that: examples. In the\nend, it is up to you to decide just what \"casual\" and \"extensive\" mean to you.\n\nThis option defaults to 0 (no particular claim).\n\n", "long": "--no-ask-cert-level" }, { "name": "--min-cert-level", "content": "When building the trust database, treat any signatures with a certification level be‐\nlow this as invalid. Defaults to 2, which disregards level 1 signatures. Note that\nlevel 0 \"no particular claim\" signatures are always accepted.\n\n\n--trusted-key long key ID or fingerprint\nAssume that the specified key (which must be given as a full 8 byte key ID or 20 byte\nfingerprint) is as trustworthy as one of your own secret keys. This option is useful\nif you don't want to keep your secret keys (or one of them) online but still want to\nbe able to check the validity of a given recipient's or signator's key.\n\n", "long": "--min-cert-level" }, { "name": "--trust-model {pgp|classic|tofu|tofu+pgp|direct|always|auto}", "content": "Set what trust model GnuPG should follow. The models are:\n\n\n\npgp This is the Web of Trust combined with trust signatures as used in PGP 5.x and\nlater. This is the default trust model when creating a new trust database.\n\n\nclassic\nThis is the standard Web of Trust as introduced by PGP 2.\n\n\ntofu\n\nTOFU stands for Trust On First Use. In this trust model, the first time a key\nis seen, it is memorized. If later another key with a user id with the same\nemail address is seen, both keys are marked as suspect. In that case, the next\ntime either is used, a warning is displayed describing the conflict, why it\nmight have occurred (either the user generated a new key and failed to cross\nsign the old and new keys, the key is forgery, or a man-in-the-middle attack is\nbeing attempted), and the user is prompted to manually confirm the validity of\nthe key in question.\n\nBecause a potential attacker is able to control the email address and thereby\ncircumvent the conflict detection algorithm by using an email address that is\nsimilar in appearance to a trusted email address, whenever a message is veri‐\nfied, statistics about the number of messages signed with the key are shown.\nIn this way, a user can easily identify attacks using fake keys for regular\ncorrespondents.\n\nWhen compared with the Web of Trust, TOFU offers significantly weaker security\nguarantees. In particular, TOFU only helps ensure consistency (that is, that\nthe binding between a key and email address doesn't change). A major advantage\nof TOFU is that it requires little maintenance to use correctly. To use the\nweb of trust properly, you need to actively sign keys and mark users as trusted\nintroducers. This is a time-consuming process and anecdotal evidence suggests\nthat even security-conscious users rarely take the time to do this thoroughly\nand instead rely on an ad-hoc TOFU process.\n\nIn the TOFU model, policies are associated with bindings between keys and email\naddresses (which are extracted from user ids and normalized). There are five\npolicies, which can be set manually using the --tofu-policy option. The de‐\nfault policy can be set using the --tofu-default-policy option.\n\nThe TOFU policies are: auto, good, unknown, bad and ask. The auto policy is\nused by default (unless overridden by --tofu-default-policy) and marks a bind‐\ning as marginally trusted. The good, unknown and bad policies mark a binding\nas fully trusted, as having unknown trust or as having trust never, respec‐\ntively. The unknown policy is useful for just using TOFU to detect conflicts,\nbut to never assign positive trust to a binding. The final policy, ask prompts\nthe user to indicate the binding's trust. If batch mode is enabled (or input\nis inappropriate in the context), then the user is not prompted and the unde‐‐\nfined trust level is returned.\n\n\ntofu+pgp\nThis trust model combines TOFU with the Web of Trust. This is done by comput‐\ning the trust level for each model and then taking the maximum trust level\nwhere the trust levels are ordered as follows: unknown < undefined < marginal <\nfully < ultimate < expired < never.\n\nBy setting --tofu-default-policy=unknown, this model can be used to implement\nthe web of trust with TOFU's conflict detection algorithm, but without its as‐\nsignment of positive trust values, which some security-conscious users don't\nlike.\n\n\ndirect Key validity is set directly by the user and not calculated via the Web of\nTrust. This model is solely based on the key and does not distinguish user\nIDs. Note that when changing to another trust model the trust values assigned\nto a key are transformed into ownertrust values, which also indicate how you\ntrust the owner of the key to sign other keys.\n\n\nalways Skip key validation and assume that used keys are always fully valid. You gen‐\nerally won't use this unless you are using some external validation scheme.\nThis option also suppresses the \"[uncertain]\" tag printed with signature checks\nwhen there is no evidence that the user ID is bound to the key. Note that this\ntrust model still does not allow the use of expired, revoked, or disabled keys.\n\n\nauto Select the trust model depending on whatever the internal trust database says.\nThis is the default model if such a database already exists. Note that a tofu\ntrust model is not considered here and must be enabled explicitly.\n\n\n--auto-key-locate mechanisms", "long": "--trust-model" }, { "name": "--no-auto-key-locate", "content": "GnuPG can automatically locate and retrieve keys as needed using this option. This\nhappens when encrypting to an email address (in the \"user@example.com\" form), and\nthere are no \"user@example.com\" keys on the local keyring. This option takes any num‐\nber of the mechanisms listed below, in the order they are to be tried. Instead of\nlisting the mechanisms as comma delimited arguments, the option may also be given sev‐\neral times to add more mechanism. The option --no-auto-key-locate or the mechanism\n\"clear\" resets the list. The default is \"local,wkd\".\n\n\n\ncert Locate a key using DNS CERT, as specified in RFC-4398.\n\n\npka Locate a key using DNS PKA.\n\n\ndane Locate a key using DANE, as specified in draft-ietf-dane-openpgpkey-05.txt.\n\n\nwkd Locate a key using the Web Key Directory protocol.\n\n\nldap Using DNS Service Discovery, check the domain in question for any LDAP key‐\nservers to use. If this fails, attempt to locate the key using the PGP Univer‐\nsal method of checking ‘ldap://keys.(thedomain)’.\n\n\nntds Locate the key using the Active Directory (Windows only).\n\n\nkeyserver\nLocate a key using a keyserver.\n\n\nkeyserver-URL\nIn addition, a keyserver URL as used in the dirmngr configuration may be used\nhere to query that particular keyserver.\n\n\nlocal Locate the key using the local keyrings. This mechanism allows the user to se‐\nlect the order a local key lookup is done. Thus using ‘--auto-key-locate lo‐\ncal’ is identical to --no-auto-key-locate.\n\n\nnodefault\nThis flag disables the standard local key lookup, done before any of the mecha‐\nnisms defined by the --auto-key-locate are tried. The position of this mecha‐\nnism in the list does not matter. It is not required if local is also used.\n\n\nclear Clear all defined mechanisms. This is useful to override mechanisms given in a\nconfig file. Note that a nodefault in mechanisms will also be cleared unless\nit is given after the clear.\n\n\n\n", "long": "--no-auto-key-locate" }, { "name": "--auto-key-import", "content": "", "long": "--auto-key-import" }, { "name": "--no-auto-key-import", "content": "This is an offline mechanism to get a missing key for signature verification and for\nlater encryption to this key. If this option is enabled and a signature includes an\nembedded key, that key is used to verify the signature and on verification success\nthat key is imported. The default is --no-auto-key-import.\n\nOn the sender (signing) site the option --include-key-block needs to be used to put\nthe public part of the signing key as “Key Block subpacket” into the signature.\n\n", "long": "--no-auto-key-import" }, { "name": "--auto-key-retrieve", "content": "", "long": "--auto-key-retrieve" }, { "name": "--no-auto-key-retrieve", "content": "These options enable or disable the automatic retrieving of keys from a keyserver when\nverifying signatures made by keys that are not on the local keyring. The default is\n--no-auto-key-retrieve.\n\nThe order of methods tried to lookup the key is:\n\n1. If the option --auto-key-import is set and the signatures includes an embedded key,\nthat key is used to verify the signature and on verification success that key is im‐\nported.\n\n2. If a preferred keyserver is specified in the signature and the option honor-key‐‐\nserver-url is active (which is not the default), that keyserver is tried. Note that\nthe creator of the signature uses the option --sig-keyserver-url to specify the pre‐\nferred keyserver for data signatures.\n\n3. If the signature has the Signer's UID set (e.g. using --sender while creating the\nsignature) a Web Key Directory (WKD) lookup is done. This is the default configura‐\ntion but can be disabled by removing WKD from the auto-key-locate list or by using the\noption --disable-signer-uid.\n\n4. If the option honor-pka-record is active, the legacy PKA method is used.\n\n5. If any keyserver is configured and the Issuer Fingerprint is part of the signature\n(since GnuPG 2.1.16), the configured keyservers are tried.\n\nNote that this option makes a \"web bug\" like behavior possible. Keyserver or Web Key\nDirectory operators can see which keys you request, so by sending you a message signed\nby a brand new key (which you naturally will not have on your local keyring), the op‐\nerator can tell both your IP address and the time when you verified the signature.\n\n", "long": "--no-auto-key-retrieve" }, { "name": "--keyid-format {none|short|0xshort|long|0xlong}", "content": "Select how to display key IDs. \"none\" does not show the key ID at all but shows the\nfingerprint in a separate line. \"short\" is the traditional 8-character key ID.\n\"long\" is the more accurate (but less convenient) 16-character key ID. Add an \"0x\" to\neither to include an \"0x\" at the beginning of the key ID, as in 0x99242560. Note that\nthis option is ignored if the option --with-colons is used.\n\n\n--keyserver name\nThis option is deprecated - please use the --keyserver in ‘dirmngr.conf’ instead.\n\nUse name as your keyserver. This is the server that --receive-keys, --send-keys, and\n--search-keys will communicate with to receive keys from, send keys to, and search for\nkeys on. The format of the name is a URI: `scheme:[//]keyservername[:port]' The scheme\nis the type of keyserver: \"hkp\" for the HTTP (or compatible) keyservers, \"ldap\" for\nthe LDAP keyservers, or \"mailto\" for the Graff email keyserver. Note that your partic‐\nular installation of GnuPG may have other keyserver types available as well. Keyserver\nschemes are case-insensitive. After the keyserver name, optional keyserver configura‐\ntion options may be provided. These are the same as the global --keyserver-options\nfrom below, but apply only to this particular keyserver.\n\nMost keyservers synchronize with each other, so there is generally no need to send\nkeys to more than one server. The keyserver hkp://keys.gnupg.net uses round robin DNS\nto give a different keyserver each time you use it.\n\n\n--keyserver-options {name=value}\nThis is a space or comma delimited string that gives options for the keyserver. Op‐\ntions can be prefixed with a `no-' to give the opposite meaning. Valid import-options\nor export-options may be used here as well to apply to importing (--recv-key) or ex‐\nporting (--send-key) a key from a keyserver. While not all options are available for\nall keyserver types, some common options are:\n\n\n\ninclude-revoked\nWhen searching for a key with --search-keys, include keys that are marked on\nthe keyserver as revoked. Note that not all keyservers differentiate between\nrevoked and unrevoked keys, and for such keyservers this option is meaningless.\nNote also that most keyservers do not have cryptographic verification of key\nrevocations, and so turning this option off may result in skipping keys that\nare incorrectly marked as revoked.\n\n\ninclude-disabled\nWhen searching for a key with --search-keys, include keys that are marked on\nthe keyserver as disabled. Note that this option is not used with HKP key‐\nservers.\n\n\nauto-key-retrieve\nThis is an obsolete alias for the option auto-key-retrieve. Please do not use\nit; it will be removed in future versions..\n\n\nhonor-keyserver-url\nWhen using --refresh-keys, if the key in question has a preferred keyserver\nURL, then use that preferred keyserver to refresh the key from. In addition, if\nauto-key-retrieve is set, and the signature being verified has a preferred key‐\nserver URL, then use that preferred keyserver to fetch the key from. Note that\nthis option introduces a \"web bug\": The creator of the key can see when the\nkeys is refreshed. Thus this option is not enabled by default.\n\n\nhonor-pka-record\nIf --auto-key-retrieve is used, and the signature being verified has a PKA\nrecord, then use the PKA information to fetch the key. Defaults to \"yes\".\n\n\ninclude-subkeys\nWhen receiving a key, include subkeys as potential targets. Note that this op‐\ntion is not used with HKP keyservers, as they do not support retrieving keys by\nsubkey id.\n\n\ntimeout\nhttp-proxy=value\nverbose\ndebug\ncheck-cert\n\nca-cert-file\nThese options have no more function since GnuPG 2.1. Use the dirmngr configu‐\nration options instead.\n\n\nThe default list of options is: \"self-sigs-only, repair-keys, repair-pks-subkey-bug, export-\nattributes, honor-pka-record\".\n\n\n\n--completes-needed n\nNumber of completely trusted users to introduce a new key signer (defaults to 1).\n\n\n--marginals-needed n\nNumber of marginally trusted users to introduce a new key signer (defaults to 3)\n\n", "long": "--keyid-format" }, { "name": "--tofu-default-policy {auto|good|unknown|bad|ask}", "content": "The default TOFU policy (defaults to auto). For more information about the meaning of\nthis option, see: [trust-model-tofu].\n\n\n--max-cert-depth n\nMaximum depth of a certification chain (default is 5).\n\n", "long": "--tofu-default-policy" }, { "name": "--no-sig-cache", "content": "Do not cache the verification status of key signatures. Caching gives a much better\nperformance in key listings. However, if you suspect that your public keyring is not\nsafe against write modifications, you can use this option to disable the caching. It\nprobably does not make sense to disable it because all kind of damage can be done if\nsomeone else has write access to your public keyring.\n\n", "long": "--no-sig-cache" }, { "name": "--auto-check-trustdb", "content": "", "long": "--auto-check-trustdb" }, { "name": "--no-auto-check-trustdb", "content": "If GnuPG feels that its information about the Web of Trust has to be updated, it auto‐\nmatically runs the --check-trustdb command internally. This may be a time consuming\nprocess. --no-auto-check-trustdb disables this option.\n\n", "long": "--no-auto-check-trustdb" }, { "name": "--use-agent", "content": "", "long": "--use-agent" }, { "name": "--no-use-agent", "content": "This is dummy option. gpg always requires the agent.\n\n", "long": "--no-use-agent" }, { "name": "--gpg-agent-info", "content": "This is dummy option. It has no effect when used with gpg.\n\n\n\n--agent-program file\nSpecify an agent program to be used for secret key operations. The default value is\ndetermined by running gpgconf with the option --list-dirs. Note that the pipe symbol\n(|) is used for a regression test suite hack and may thus not be used in the file\nname.\n\n\n--dirmngr-program file\nSpecify a dirmngr program to be used for keyserver access. The default value is\n‘/usr/bin/dirmngr’.\n\n", "long": "--gpg-agent-info" }, { "name": "--disable-dirmngr", "content": "Entirely disable the use of the Dirmngr.\n\n", "long": "--disable-dirmngr" }, { "name": "--no-autostart", "content": "Do not start the gpg-agent or the dirmngr if it has not yet been started and its ser‐\nvice is required. This option is mostly useful on machines where the connection to\ngpg-agent has been redirected to another machines. If dirmngr is required on the re‐\nmote machine, it may be started manually using gpgconf --launch dirmngr.\n\n", "long": "--no-autostart" }, { "name": "--lock-once", "content": "Lock the databases the first time a lock is requested and do not release the lock un‐\ntil the process terminates.\n\n", "long": "--lock-once" }, { "name": "--lock-multiple", "content": "Release the locks every time a lock is no longer needed. Use this to override a previ‐\nous --lock-once from a config file.\n\n", "long": "--lock-multiple" }, { "name": "--lock-never", "content": "Disable locking entirely. This option should be used only in very special environ‐\nments, where it can be assured that only one process is accessing those files. A\nbootable floppy with a stand-alone encryption system will probably use this. Improper\nusage of this option may lead to data and key corruption.\n\n", "long": "--lock-never" }, { "name": "--exit-on-status-write-error", "content": "This option will cause write errors on the status FD to immediately terminate the\nprocess. That should in fact be the default but it never worked this way and thus we\nneed an option to enable this, so that the change won't break applications which close\ntheir end of a status fd connected pipe too early. Using this option along with --en‐‐\nable-progress-filter may be used to cleanly cancel long running gpg operations.\n\n\n--limit-card-insert-tries n\nWith n greater than 0 the number of prompts asking to insert a smartcard gets limited\nto N-1. Thus with a value of 1 gpg won't at all ask to insert a card if none has been\ninserted at startup. This option is useful in the configuration file in case an appli‐\ncation does not know about the smartcard support and waits ad infinitum for an in‐\nserted card.\n\n", "long": "--exit-on-status-write-error" }, { "name": "--no-random-seed-file", "content": "GnuPG uses a file to store its internal random pool over invocations. This makes ran‐\ndom generation faster; however sometimes write operations are not desired. This option\ncan be used to achieve that with the cost of slower random generation.\n\n", "long": "--no-random-seed-file" }, { "name": "--no-greeting", "content": "Suppress the initial copyright message.\n\n", "long": "--no-greeting" }, { "name": "--no-secmem-warning", "content": "Suppress the warning about \"using insecure memory\".\n\n", "long": "--no-secmem-warning" }, { "name": "--no-permission-warning", "content": "Suppress the warning about unsafe file and home directory (--homedir) permissions.\nNote that the permission checks that GnuPG performs are not intended to be authorita‐\ntive, but rather they simply warn about certain common permission problems. Do not as‐\nsume that the lack of a warning means that your system is secure.\n\nNote that the warning for unsafe --homedir permissions cannot be suppressed in the\ngpg.conf file, as this would allow an attacker to place an unsafe gpg.conf file in\nplace, and use this file to suppress warnings about itself. The --homedir permissions\nwarning may only be suppressed on the command line.\n\n", "long": "--no-permission-warning" }, { "name": "--require-secmem", "content": "", "long": "--require-secmem" }, { "name": "--no-require-secmem", "content": "Refuse to run if GnuPG cannot get secure memory. Defaults to no (i.e. run, but give a\nwarning).\n\n\n", "long": "--no-require-secmem" }, { "name": "--require-cross-certification", "content": "", "long": "--require-cross-certification" }, { "name": "--no-require-cross-certification", "content": "When verifying a signature made from a subkey, ensure that the cross certification\n\"back signature\" on the subkey is present and valid. This protects against a subtle\nattack against subkeys that can sign. Defaults to --require-cross-certification for\ngpg.\n\n", "long": "--no-require-cross-certification" }, { "name": "--expert", "content": "", "long": "--expert" }, { "name": "--no-expert", "content": "Allow the user to do certain nonsensical or \"silly\" things like signing an expired or\nrevoked key, or certain potentially incompatible things like generating unusual key\ntypes. This also disables certain warning messages about potentially incompatible ac‐\ntions. As the name implies, this option is for experts only. If you don't fully under‐\nstand the implications of what it allows you to do, leave this off. --no-expert dis‐\nables this option.\n\n", "long": "--no-expert" }, { "name": "Key related options", "content": "--recipient name" }, { "name": "-r --hidden-recipient", "content": "asks for the user-id unless --default-recipient is given.\n\n\n--hidden-recipient name", "flag": "-r", "long": "--hidden-recipient" }, { "name": "-R", "content": "hide the receiver of the message and is a limited countermeasure against traffic\nanalysis. If this option or --recipient is not specified, GnuPG asks for the user ID\nunless --default-recipient is given.\n\n\n--recipient-file file", "flag": "-R" }, { "name": "-f --recipient", "content": "given file. file must be the name of a file containing exactly one key. gpg assumes\nthat the key in this file is fully valid.\n\n\n--hidden-recipient-file file", "flag": "-f", "long": "--recipient" }, { "name": "-F --hidden-recipient", "content": "in the given file. file must be the name of a file containing exactly one key. gpg\nassumes that the key in this file is fully valid.\n\n\n--encrypt-to name\nSame as --recipient but this one is intended for use in the options file and may be\nused with your own user-id as an \"encrypt-to-self\". These keys are only used when\nthere are other recipients given either by use of --recipient or by the asked user id.\nNo trust checking is performed for these user ids and even disabled keys can be used.\n\n\n--hidden-encrypt-to name\nSame as --hidden-recipient but this one is intended for use in the options file and\nmay be used with your own user-id as a hidden \"encrypt-to-self\". These keys are only\nused when there are other recipients given either by use of --recipient or by the\nasked user id. No trust checking is performed for these user ids and even disabled\nkeys can be used.\n\n", "flag": "-F", "long": "--hidden-recipient" }, { "name": "--no-encrypt-to", "content": "Disable the use of all --encrypt-to and --hidden-encrypt-to keys.\n\n\n--group {name=value}\nSets up a named group, which is similar to aliases in email programs. Any time the\ngroup name is a recipient (-r or --recipient), it will be expanded to the values spec‐\nified. Multiple groups with the same name are automatically merged into a single\ngroup.\n\nThe values are key IDs or fingerprints, but any key description is accepted. Note that\na value with spaces in it will be treated as two different values. Note also there is\nonly one level of expansion --- you cannot make an group that points to another group.\nWhen used from the command line, it may be necessary to quote the argument to this op‐\ntion to prevent the shell from treating it as multiple arguments.\n\n\n--ungroup name\nRemove a given entry from the --group list.\n\n", "long": "--no-encrypt-to" }, { "name": "--no-groups", "content": "Remove all entries from the --group list.\n\n\n--local-user name", "long": "--no-groups" }, { "name": "-u --default-key", "content": "--sender mbox\nThis option has two purposes. mbox must either be a complete user id with a proper\nmail address or just a mail address. When creating a signature this option tells gpg\nthe user id of a key used to make a signature if the key was not directly specified by\na user id. When verifying a signature the mbox is used to restrict the information\nprinted by the TOFU code to matching user ids.\n\n\n--try-secret-key name\nFor hidden recipients GPG needs to know the keys to use for trial decryption. The key\nset with --default-key is always tried first, but this is often not sufficient. This\noption allows setting more keys to be used for trial decryption. Although any valid\nuser-id specification may be used for name it makes sense to use at least the long\nkeyid to avoid ambiguities. Note that gpg-agent might pop up a pinentry for a lot\nkeys to do the trial decryption. If you want to stop all further trial decryption you\nmay use close-window button instead of the cancel button.\n\n", "flag": "-u", "long": "--default-key" }, { "name": "--try-all-secrets", "content": "Don't look at the key ID as stored in the message but try all secret keys in turn to\nfind the right decryption key. This option forces the behaviour as used by anonymous\nrecipients (created by using --throw-keyids or --hidden-recipient) and might come\nhandy in case where an encrypted message contains a bogus key ID.\n\n", "long": "--try-all-secrets" }, { "name": "--skip-hidden-recipients", "content": "", "long": "--skip-hidden-recipients" }, { "name": "--no-skip-hidden-recipients", "content": "During decryption skip all anonymous recipients. This option helps in the case that\npeople use the hidden recipients feature to hide their own encrypt-to key from others.\nIf one has many secret keys this may lead to a major annoyance because all keys are\ntried in turn to decrypt something which was not really intended for it. The drawback\nof this option is that it is currently not possible to decrypt a message which in‐\ncludes real anonymous recipients.\n\n\n", "long": "--no-skip-hidden-recipients" }, { "name": "Input and Output", "content": "" }, { "name": "--armor", "content": "", "long": "--armor" }, { "name": "-a", "content": "", "flag": "-a" }, { "name": "--no-armor", "content": "Assume the input data is not in ASCII armored format.\n\n\n--output file", "long": "--no-armor" }, { "name": "-o", "content": "Write output to file. To write to stdout use - as the filename.\n\n\n--max-output n\nThis option sets a limit on the number of bytes that will be generated when processing\na file. Since OpenPGP supports various levels of compression, it is possible that the\nplaintext of a given message may be significantly larger than the original OpenPGP\nmessage. While GnuPG works properly with such messages, there is often a desire to set\na maximum file size that will be generated before processing is forced to stop by the\nOS limits. Defaults to 0, which means \"no limit\".\n\n\n--input-size-hint n\nThis option can be used to tell GPG the size of the input data in bytes. n must be a\npositive base-10 number. This option is only useful if the input is not taken from a\nfile. GPG may use this hint to optimize its buffer allocation strategy. It is also\nused by the --status-fd line ``PROGRESS'' to provide a value for ``total'' if that is\nnot available by other means.\n\n\n--key-origin string[,url]\ngpg can track the origin of a key. Certain origins are implicitly known (e.g. key‐\nserver, web key directory) and set. For a standard import the origin of the keys im‐\nported can be set with this option. To list the possible values use \"help\" for\nstring. Some origins can store an optional url argument. That URL can appended to\nstring after a comma.\n\n\n--import-options parameters\nThis is a space or comma delimited string that gives options for importing keys. Op‐\ntions can be prepended with a `no-' to give the opposite meaning. The options are:\n\n\n\nimport-local-sigs\nAllow importing key signatures marked as \"local\". This is not generally useful\nunless a shared keyring scheme is being used. Defaults to no.\n\n\nkeep-ownertrust\nNormally possible still existing ownertrust values of a key are cleared if a\nkey is imported. This is in general desirable so that a formerly deleted key\ndoes not automatically gain an ownertrust values merely due to import. On the\nother hand it is sometimes necessary to re-import a trusted set of keys again\nbut keeping already assigned ownertrust values. This can be achieved by using\nthis option.\n\n\nrepair-pks-subkey-bug\nDuring import, attempt to repair the damage caused by the PKS keyserver bug\n(pre version 0.9.6) that mangles keys with multiple subkeys. Note that this\ncannot completely repair the damaged key as some crucial data is removed by the\nkeyserver, but it does at least give you back one subkey. Defaults to no for\nregular --import and to yes for keyserver --receive-keys.\n\n\nimport-show\nshow-only\nShow a listing of the key as imported right before it is stored. This can be\ncombined with the option --dry-run to only look at keys; the option show-only\nis a shortcut for this combination. The command --show-keys is another short‐\ncut for this. Note that suffixes like '#' for \"sec\" and \"sbb\" lines may or may\nnot be printed.\n\n\nimport-export\nRun the entire import code but instead of storing the key to the local keyring\nwrite it to the output. The export options export-pka and export-dane affect\nthe output. This option can be used to remove all invalid parts from a key\nwithout the need to store it.\n\n\nmerge-only\nDuring import, allow key updates to existing keys, but do not allow any new\nkeys to be imported. Defaults to no.\n\n\nimport-clean\nAfter import, compact (remove all signatures except the self-signature) any\nuser IDs from the new key that are not usable. Then, remove any signatures\nfrom the new key that are not usable. This includes signatures that were is‐\nsued by keys that are not present on the keyring. This option is the same as\nrunning the --edit-key command \"clean\" after import. Defaults to no.\n\n\nself-sigs-only\nAccept only self-signatures while importing a key. All other key signatures\nare skipped at an early import stage. This option can be used with keyserver-\noptions to mitigate attempts to flood a key with bogus signatures from a key‐\nserver. The drawback is that all other valid key signatures, as required by\nthe Web of Trust are also not imported. Note that when using this option along\nwith import-clean it suppresses the final clean step after merging the imported\nkey into the existing key.\n\n\nrepair-keys\nAfter import, fix various problems with the keys. For example, this reorders\nsignatures, and strips duplicate signatures. Defaults to yes.\n\n\nimport-minimal\nImport the smallest key possible. This removes all signatures except the most\nrecent self-signature on each user ID. This option is the same as running the\n--edit-key command \"minimize\" after import. Defaults to no.\n\n\nrestore\nimport-restore\nImport in key restore mode. This imports all data which is usually skipped\nduring import; including all GnuPG specific data. All other contradicting op‐\ntions are overridden.\n\n\n--import-filter {name=expr}\n--export-filter {name=expr}\nThese options define an import/export filter which are applied to the imported/ex‐\nported keyblock right before it will be stored/written. name defines the type of fil‐\nter to use, expr the expression to evaluate. The option can be used several times\nwhich then appends more expression to the same name.\n\n\nThe available filter types are:\n\n\n\nkeep-uid\nThis filter will keep a user id packet and its dependent packets in the key‐\nblock if the expression evaluates to true.\n\n\ndrop-subkey\nThis filter drops the selected subkeys. Currently only implemented for --ex‐\nport-filter.\n\n\ndrop-sig\nThis filter drops the selected key signatures on user ids. Self-signatures are\nnot considered. Currently only implemented for --import-filter.\n\n\nFor the syntax of the expression see the chapter \"FILTER EXPRESSIONS\". The property names\nfor the expressions depend on the actual filter type and are indicated in the following ta‐\nble.\n\nThe available properties are:\n\n\n\nuid A string with the user id. (keep-uid)\n\n\nmbox The addr-spec part of a user id with mailbox or the empty string. (keep-uid)\n\n\nkeyalgo\nA number with the public key algorithm of a key or subkey packet. (drop-sub‐\nkey)\n\n\nkeycreated\nkeycreatedd\nThe first is the timestamp a public key or subkey packet was created. The sec‐\nond is the same but given as an ISO string, e.g. \"2016-08-17\". (drop-subkey)\n\n\nfpr The hexified fingerprint of the current subkey or primary key. (drop-subkey)\n\n\nprimary\nBoolean indicating whether the user id is the primary one. (keep-uid)\n\n\nexpired\nBoolean indicating whether a user id (keep-uid), a key (drop-subkey), or a sig‐\nnature (drop-sig) expired.\n\n\nrevoked\nBoolean indicating whether a user id (keep-uid) or a key (drop-subkey) has been\nrevoked.\n\n\ndisabled\nBoolean indicating whether a primary key is disabled. (not used)\n\n\nsecret Boolean indicating whether a key or subkey is a secret one. (drop-subkey)\n\n\nusage A string indicating the usage flags for the subkey, from the sequence\n``ecsa?''. For example, a subkey capable of just signing and authentication\nwould be an exact match for ``sa''. (drop-subkey)\n\n\nsigcreated\nsigcreatedd\nThe first is the timestamp a signature packet was created. The second is the\nsame but given as an ISO date string, e.g. \"2016-08-17\". (drop-sig)\n\n\nsigalgo\nA number with the public key algorithm of a signature packet. (drop-sig)\n\n\nsigdigestalgo\nA number with the digest algorithm of a signature packet. (drop-sig)\n\n\n\n--export-options parameters\nThis is a space or comma delimited string that gives options for exporting keys. Op‐\ntions can be prepended with a `no-' to give the opposite meaning. The options are:\n\n\n\nexport-local-sigs\nAllow exporting key signatures marked as \"local\". This is not generally useful\nunless a shared keyring scheme is being used. Defaults to no.\n\n\nexport-attributes\nInclude attribute user IDs (photo IDs) while exporting. Not including attribute\nuser IDs is useful to export keys that are going to be used by an OpenPGP pro‐\ngram that does not accept attribute user IDs. Defaults to yes.\n\n\nexport-sensitive-revkeys\nInclude designated revoker information that was marked as \"sensitive\". Defaults\nto no.\n\n\n\nbackup\nexport-backup\nExport for use as a backup. The exported data includes all data which is\nneeded to restore the key or keys later with GnuPG. The format is basically\nthe OpenPGP format but enhanced with GnuPG specific data. All other contra‐\ndicting options are overridden.\n\n\nexport-clean\nCompact (remove all signatures from) user IDs on the key being exported if the\nuser IDs are not usable. Also, do not export any signatures that are not us‐\nable. This includes signatures that were issued by keys that are not present on\nthe keyring. This option is the same as running the --edit-key command \"clean\"\nbefore export except that the local copy of the key is not modified. Defaults\nto no.\n\n\nexport-minimal\nExport the smallest key possible. This removes all signatures except the most\nrecent self-signature on each user ID. This option is the same as running the\n--edit-key command \"minimize\" before export except that the local copy of the\nkey is not modified. Defaults to no.\n\n\nexport-pka\nInstead of outputting the key material output PKA records suitable to put into\nDNS zone files. An ORIGIN line is printed before each record to allow divert‐\ning the records to the corresponding zone file.\n\n\nexport-dane\nInstead of outputting the key material output OpenPGP DANE records suitable to\nput into DNS zone files. An ORIGIN line is printed before each record to allow\ndiverting the records to the corresponding zone file.\n\n\n", "flag": "-o" }, { "name": "--with-colons", "content": "Print key listings delimited by colons. Note that the output will be encoded in UTF-8\nregardless of any --display-charset setting. This format is useful when GnuPG is\ncalled from scripts and other programs as it is easily machine parsed. The details of\nthis format are documented in the file ‘doc/DETAILS’, which is included in the GnuPG\nsource distribution.\n\n", "long": "--with-colons" }, { "name": "--fixed-list-mode", "content": "Do not merge primary user ID and primary key in --with-colon listing mode and print\nall timestamps as seconds since 1970-01-01. Since GnuPG 2.0.10, this mode is always\nused and thus this option is obsolete; it does not harm to use it though.\n\n", "long": "--fixed-list-mode" }, { "name": "--legacy-list-mode", "content": "Revert to the pre-2.1 public key list mode. This only affects the human readable out‐\nput and not the machine interface (i.e. --with-colons). Note that the legacy format\ndoes not convey suitable information for elliptic curves.\n\n", "long": "--legacy-list-mode" }, { "name": "--with-fingerprint", "content": "Same as the command --fingerprint but changes only the format of the output and may be\nused together with another command.\n\n", "long": "--with-fingerprint" }, { "name": "--with-subkey-fingerprint", "content": "If a fingerprint is printed for the primary key, this option forces printing of the\nfingerprint for all subkeys. This could also be achieved by using the --with-finger‐‐\nprint twice but by using this option along with keyid-format \"none\" a compact finger‐\nprint is printed.\n\n", "long": "--with-subkey-fingerprint" }, { "name": "--with-icao-spelling", "content": "Print the ICAO spelling of the fingerprint in addition to the hex digits.\n\n", "long": "--with-icao-spelling" }, { "name": "--with-keygrip", "content": "Include the keygrip in the key listings. In --with-colons mode this is implicitly en‐\nable for secret keys.\n\n", "long": "--with-keygrip" }, { "name": "--with-key-origin", "content": "Include the locally held information on the origin and last update of a key in a key\nlisting. In --with-colons mode this is always printed. This data is currently exper‐\nimental and shall not be considered part of the stable API.\n\n", "long": "--with-key-origin" }, { "name": "--with-wkd-hash", "content": "Print a Web Key Directory identifier along with each user ID in key listings. This is\nan experimental feature and semantics may change.\n\n", "long": "--with-wkd-hash" }, { "name": "--with-secret", "content": "Include info about the presence of a secret key in public key listings done with\n--with-colons.\n\n", "long": "--with-secret" }, { "name": "OpenPGP protocol specific options", "content": "" }, { "name": "-t, --textmode", "content": "", "flag": "-t", "long": "--textmode" }, { "name": "--no-textmode", "content": "Treat input files as text and store them in the OpenPGP canonical text form with stan‐\ndard \"CRLF\" line endings. This also sets the necessary flags to inform the recipient\nthat the encrypted or signed data is text and may need its line endings converted back\nto whatever the local system uses. This option is useful when communicating between\ntwo platforms that have different line ending conventions (UNIX-like to Mac, Mac to\nWindows, etc). --no-textmode disables this option, and is the default.\n\n", "long": "--no-textmode" }, { "name": "--force-v3-sigs", "content": "", "long": "--force-v3-sigs" }, { "name": "--no-force-v3-sigs", "content": "", "long": "--no-force-v3-sigs" }, { "name": "--force-v4-certs", "content": "", "long": "--force-v4-certs" }, { "name": "--no-force-v4-certs", "content": "These options are obsolete and have no effect since GnuPG 2.1.\n\n", "long": "--no-force-v4-certs" }, { "name": "--force-mdc", "content": "", "long": "--force-mdc" }, { "name": "--disable-mdc", "content": "These options are obsolete and have no effect since GnuPG 2.2.8. The MDC is always\nused. But note: If the creation of a legacy non-MDC message is exceptionally re‐\nquired, the option --rfc2440 allows for this.\n\n", "long": "--disable-mdc" }, { "name": "--disable-signer-uid", "content": "By default the user ID of the signing key is embedded in the data signature. As of\nnow this is only done if the signing key has been specified with local-user using a\nmail address, or with sender. This information can be helpful for verifier to locate\nthe key; see option --auto-key-retrieve.\n\n", "long": "--disable-signer-uid" }, { "name": "--include-key-block", "content": "This option is used to embed the actual signing key into a data signature. The embed‐\nded key is stripped down to a single user id and includes only the signing subkey used\nto create the signature as well as as valid encryption subkeys. All other info is re‐\nmoved from the key to keep it and thus the signature small. This option is the\nOpenPGP counterpart to the gpgsm option --include-certs.\n\n\n--personal-cipher-preferences string\nSet the list of personal cipher preferences to string. Use gpg --version to get a\nlist of available algorithms, and use none to set no preference at all. This allows\nthe user to safely override the algorithm chosen by the recipient key preferences, as\nGPG will only select an algorithm that is usable by all recipients. The most highly\nranked cipher in this list is also used for the --symmetric encryption command.\n\n\n--personal-digest-preferences string\nSet the list of personal digest preferences to string. Use gpg --version to get a\nlist of available algorithms, and use none to set no preference at all. This allows\nthe user to safely override the algorithm chosen by the recipient key preferences, as\nGPG will only select an algorithm that is usable by all recipients. The most highly\nranked digest algorithm in this list is also used when signing without encryption\n(e.g. --clear-sign or --sign).\n\n\n--personal-compress-preferences string\nSet the list of personal compression preferences to string. Use gpg --version to get\na list of available algorithms, and use none to set no preference at all. This allows\nthe user to safely override the algorithm chosen by the recipient key preferences, as\nGPG will only select an algorithm that is usable by all recipients. The most highly\nranked compression algorithm in this list is also used when there are no recipient\nkeys to consider (e.g. --symmetric).\n\n\n--s2k-cipher-algo name\nUse name as the cipher algorithm for symmetric encryption with a passphrase if --per‐‐\nsonal-cipher-preferences and --cipher-algo are not given. The default is AES-128.\n\n\n--s2k-digest-algo name\nUse name as the digest algorithm used to mangle the passphrases for symmetric encryp‐\ntion. The default is SHA-1.\n\n\n--s2k-mode n\nSelects how passphrases for symmetric encryption are mangled. If n is 0 a plain\npassphrase (which is in general not recommended) will be used, a 1 adds a salt (which\nshould not be used) to the passphrase and a 3 (the default) iterates the whole process\na number of times (see --s2k-count).\n\n\n--s2k-count n\nSpecify how many times the passphrases mangling for symmetric encryption is repeated.\nThis value may range between 1024 and 65011712 inclusive. The default is inquired\nfrom gpg-agent. Note that not all values in the 1024-65011712 range are legal and if\nan illegal value is selected, GnuPG will round up to the nearest legal value. This\noption is only meaningful if --s2k-mode is set to the default of 3.\n\n\n", "long": "--include-key-block" }, { "name": "Compliance options", "content": "These options control what GnuPG is compliant to. Only one of these options may be active at\na time. Note that the default setting of this is nearly always the correct one. See the IN‐\nTEROPERABILITY WITH OTHER OPENPGP PROGRAMS section below before using one of these options.\n\n\n" }, { "name": "--gnupg", "content": "Use standard GnuPG behavior. This is essentially OpenPGP behavior (see --openpgp), but\nwith some additional workarounds for common compatibility problems in different ver‐\nsions of PGP. This is the default option, so it is not generally needed, but it may be\nuseful to override a different compliance option in the gpg.conf file.\n\n", "long": "--gnupg" }, { "name": "--openpgp", "content": "Reset all packet, cipher and digest options to strict OpenPGP behavior. Use this op‐\ntion to reset all previous options like --s2k-*, --cipher-algo, --digest-algo and\n--compress-algo to OpenPGP compliant values. All PGP workarounds are disabled.\n\n", "long": "--openpgp" }, { "name": "--rfc4880", "content": "Reset all packet, cipher and digest options to strict RFC-4880 behavior. Note that\nthis is currently the same thing as --openpgp.\n\n", "long": "--rfc4880" }, { "name": "--rfc4880bis", "content": "Enable experimental features from proposed updates to RFC-4880. This option can be\nused in addition to the other compliance options. Warning: The behavior may change\nwith any GnuPG release and created keys or data may not be usable with future GnuPG\nversions.\n\n", "long": "--rfc4880bis" }, { "name": "--rfc2440", "content": "Reset all packet, cipher and digest options to strict RFC-2440 behavior. Note that by\nusing this option encryption packets are created in a legacy mode without MDC protec‐\ntion. This is dangerous and should thus only be used for experiments. See also op‐\ntion --ignore-mdc-error.\n\n\n--pgp6 Set up all options to be as PGP 6 compliant as possible. This restricts you to the ci‐\nphers IDEA (if the IDEA plugin is installed), 3DES, and CAST5, the hashes MD5, SHA1\nand RIPEMD160, and the compression algorithms none and ZIP. This also disables\n--throw-keyids, and making signatures with signing subkeys as PGP 6 does not under‐\nstand signatures made by signing subkeys.\n\nThis option implies --escape-from-lines.\n\n\n--pgp7 Set up all options to be as PGP 7 compliant as possible. This is identical to --pgp6\nexcept that MDCs are not disabled, and the list of allowable ciphers is expanded to\nadd AES128, AES192, AES256, and TWOFISH.\n\n\n--pgp8 Set up all options to be as PGP 8 compliant as possible. PGP 8 is a lot closer to the\nOpenPGP standard than previous versions of PGP, so all this does is disable --throw-\nkeyids and set --escape-from-lines. All algorithms are allowed except for the SHA224,\nSHA384, and SHA512 digests.\n\n\n--compliance string\nThis option can be used instead of one of the options above. Valid values for string\nare the above option names (without the double dash) and possibly others as shown when\nusing \"help\" for value.\n\n", "long": "--rfc2440" }, { "name": "Doing things one usually doesn't want to do", "content": "" }, { "name": "-n", "content": "", "flag": "-n" }, { "name": "--dry-run", "content": "Don't make any changes (this is not completely implemented).\n\n", "long": "--dry-run" }, { "name": "--list-only", "content": "Changes the behaviour of some commands. This is like --dry-run but different in some\ncases. The semantic of this option may be extended in the future. Currently it only\nskips the actual decryption pass and therefore enables a fast listing of the encryp‐\ntion keys.\n\n", "long": "--list-only" }, { "name": "-i", "content": "", "flag": "-i" }, { "name": "--interactive", "content": "Prompt before overwriting any files.\n\n\n--debug-level level\nSelect the debug level for investigating problems. level may be a numeric value or by\na keyword:\n\n\nnone No debugging at all. A value of less than 1 may be used instead of the key‐\nword.\n\nbasic Some basic debug messages. A value between 1 and 2 may be used instead of the\nkeyword.\n\nadvanced\nMore verbose debug messages. A value between 3 and 5 may be used instead of\nthe keyword.\n\nexpert Even more detailed messages. A value between 6 and 8 may be used instead of\nthe keyword.\n\nguru All of the debug messages you can get. A value greater than 8 may be used in‐\nstead of the keyword. The creation of hash tracing files is only enabled if\nthe keyword is used.\n\nHow these messages are mapped to the actual debugging flags is not specified and may change\nwith newer releases of this program. They are however carefully selected to best aid in de‐\nbugging.\n\n\n--debug flags\nSet debugging flags. All flags are or-ed and flags may be given in C syntax (e.g.\n0x0042) or as a comma separated list of flag names. To get a list of all supported\nflags the single word \"help\" can be used.\n\n", "long": "--interactive" }, { "name": "--debug-all", "content": "Set all useful debugging flags.\n\n", "long": "--debug-all" }, { "name": "--debug-iolbf", "content": "Set stdout into line buffered mode. This option is only honored when given on the\ncommand line.\n\n\n--faked-system-time epoch\nThis option is only useful for testing; it sets the system time back or forth to epoch\nwhich is the number of seconds elapsed since the year 1970. Alternatively epoch may\nbe given as a full ISO time string (e.g. \"20070924T154812\").\n\nIf you suffix epoch with an exclamation mark (!), the system time will appear to be\nfrozen at the specified time.\n\n", "long": "--debug-iolbf" }, { "name": "--enable-progress-filter", "content": "Enable certain PROGRESS status outputs. This option allows frontends to display a\nprogress indicator while gpg is processing larger files. There is a slight perfor‐\nmance overhead using it.\n\n\n--status-fd n\nWrite special status strings to the file descriptor n. See the file DETAILS in the\ndocumentation for a listing of them.\n\n\n--status-file file\nSame as --status-fd, except the status data is written to file file.\n\n\n--logger-fd n\nWrite log output to file descriptor n and not to STDERR.\n\n\n--log-file file\n--logger-file file\nSame as --logger-fd, except the logger data is written to file file. Use ‘socket://’\nto log to a socket. Note that in this version of gpg the option has only an effect if\n--batch is also used.\n\n\n--attribute-fd n\nWrite attribute subpackets to the file descriptor n. This is most useful for use with\n--status-fd, since the status messages are needed to separate out the various subpack‐\nets from the stream delivered to the file descriptor.\n\n\n--attribute-file file\nSame as --attribute-fd, except the attribute data is written to file file.\n\n\n--comment string", "long": "--enable-progress-filter" }, { "name": "--no-comments", "content": "Use string as a comment string in cleartext signatures and ASCII armored messages or\nkeys (see --armor). The default behavior is not to use a comment string. --comment may\nbe repeated multiple times to get multiple comment strings. --no-comments removes all\ncomments. It is a good idea to keep the length of a single comment below 60 charac‐\nters to avoid problems with mail programs wrapping such lines. Note that comment\nlines, like all other header lines, are not protected by the signature.\n\n", "long": "--no-comments" }, { "name": "--emit-version", "content": "", "long": "--emit-version" }, { "name": "--no-emit-version", "content": "Force inclusion of the version string in ASCII armored output. If given once only the\nname of the program and the major number is emitted, given twice the minor is also\nemitted, given thrice the micro is added, and given four times an operating system\nidentification is also emitted. --no-emit-version (default) disables the version\nline.\n\n\n--sig-notation {name=value}\n--cert-notation {name=value}", "long": "--no-emit-version" }, { "name": "-N, --set-notation", "content": "Put the name value pair into the signature as notation data. name must consist only\nof printable characters or spaces, and must contain a '@' character in the form key‐\nname@domain.example.com (substituting the appropriate keyname and domain name, of\ncourse). This is to help prevent pollution of the IETF reserved notation namespace.\nThe --expert flag overrides the '@' check. value may be any printable string; it will\nbe encoded in UTF-8, so you should check that your --display-charset is set correctly.\nIf you prefix name with an exclamation mark (!), the notation data will be flagged as\ncritical (rfc4880:5.2.3.16). --sig-notation sets a notation for data signatures.\n--cert-notation sets a notation for key signatures (certifications). --set-notation\nsets both.\n\nThere are special codes that may be used in notation names. \"%k\" will be expanded into\nthe key ID of the key being signed, \"%K\" into the long key ID of the key being signed,\n\"%f\" into the fingerprint of the key being signed, \"%s\" into the key ID of the key\nmaking the signature, \"%S\" into the long key ID of the key making the signature, \"%g\"\ninto the fingerprint of the key making the signature (which might be a subkey), \"%p\"\ninto the fingerprint of the primary key of the key making the signature, \"%c\" into the\nsignature count from the OpenPGP smartcard, and \"%%\" results in a single \"%\". %k, %K,\nand %f are only meaningful when making a key signature (certification), and %c is only\nmeaningful when using the OpenPGP smartcard.\n\n\n--known-notation name\nAdds name to a list of known critical signature notations. The effect of this is that\ngpg will not mark a signature with a critical signature notation of that name as bad.\nNote that gpg already knows by default about a few critical signatures notation names.\n\n\n--sig-policy-url string\n--cert-policy-url string\n--set-policy-url string\nUse string as a Policy URL for signatures (rfc4880:5.2.3.20). If you prefix it with\nan exclamation mark (!), the policy URL packet will be flagged as critical. --sig-pol‐‐\nicy-url sets a policy url for data signatures. --cert-policy-url sets a policy url for\nkey signatures (certifications). --set-policy-url sets both.\n\nThe same %-expandos used for notation data are available here as well.\n\n\n--sig-keyserver-url string\nUse string as a preferred keyserver URL for data signatures. If you prefix it with an\nexclamation mark (!), the keyserver URL packet will be flagged as critical.\n\nThe same %-expandos used for notation data are available here as well.\n\n\n--set-filename string\nUse string as the filename which is stored inside messages. This overrides the de‐\nfault, which is to use the actual filename of the file being encrypted. Using the\nempty string for string effectively removes the filename from the output.\n\n", "flag": "-N", "long": "--set-notation" }, { "name": "--for-your-eyes-only", "content": "", "long": "--for-your-eyes-only" }, { "name": "--no-for-your-eyes-only", "content": "Set the `for your eyes only' flag in the message. This causes GnuPG to refuse to save\nthe file unless the --output option is given, and PGP to use a \"secure viewer\" with a\nclaimed Tempest-resistant font to display the message. This option overrides --set-\nfilename. --no-for-your-eyes-only disables this option.\n\n", "long": "--no-for-your-eyes-only" }, { "name": "--use-embedded-filename", "content": "", "long": "--use-embedded-filename" }, { "name": "--no-use-embedded-filename", "content": "Try to create a file with a name as embedded in the data. This can be a dangerous op‐\ntion as it enables overwriting files. Defaults to no. Note that the option --output\noverrides this option.\n\n\n--cipher-algo name\nUse name as cipher algorithm. Running the program with the command --version yields a\nlist of supported algorithms. If this is not used the cipher algorithm is selected\nfrom the preferences stored with the key. In general, you do not want to use this op‐\ntion as it allows you to violate the OpenPGP standard. --personal-cipher-preferences\nis the safe way to accomplish the same thing.\n\n\n--digest-algo name\nUse name as the message digest algorithm. Running the program with the command --ver‐‐\nsion yields a list of supported algorithms. In general, you do not want to use this\noption as it allows you to violate the OpenPGP standard. --personal-digest-preferences\nis the safe way to accomplish the same thing.\n\n\n--compress-algo name\nUse compression algorithm name. \"zlib\" is RFC-1950 ZLIB compression. \"zip\" is RFC-1951\nZIP compression which is used by PGP. \"bzip2\" is a more modern compression scheme\nthat can compress some things better than zip or zlib, but at the cost of more memory\nused during compression and decompression. \"uncompressed\" or \"none\" disables compres‐\nsion. If this option is not used, the default behavior is to examine the recipient key\npreferences to see which algorithms the recipient supports. If all else fails, ZIP is\nused for maximum compatibility.\n\nZLIB may give better compression results than ZIP, as the compression window size is\nnot limited to 8k. BZIP2 may give even better compression results than that, but will\nuse a significantly larger amount of memory while compressing and decompressing. This\nmay be significant in low memory situations. Note, however, that PGP (all versions)\nonly supports ZIP compression. Using any algorithm other than ZIP or \"none\" will make\nthe message unreadable with PGP. In general, you do not want to use this option as it\nallows you to violate the OpenPGP standard. --personal-compress-preferences is the\nsafe way to accomplish the same thing.\n\n\n--cert-digest-algo name\nUse name as the message digest algorithm used when signing a key. Running the program\nwith the command --version yields a list of supported algorithms. Be aware that if you\nchoose an algorithm that GnuPG supports but other OpenPGP implementations do not, then\nsome users will not be able to use the key signatures you make, or quite possibly your\nentire key.\n\n\n--disable-cipher-algo name\nNever allow the use of name as cipher algorithm. The given name will not be checked\nso that a later loaded algorithm will still get disabled.\n\n\n--disable-pubkey-algo name\nNever allow the use of name as public key algorithm. The given name will not be\nchecked so that a later loaded algorithm will still get disabled.\n\n", "long": "--no-use-embedded-filename" }, { "name": "--throw-keyids", "content": "", "long": "--throw-keyids" }, { "name": "--no-throw-keyids", "content": "Do not put the recipient key IDs into encrypted messages. This helps to hide the re‐\nceivers of the message and is a limited countermeasure against traffic analysis. ([Us‐\ning a little social engineering anyone who is able to decrypt the message can check\nwhether one of the other recipients is the one he suspects.]) On the receiving side,\nit may slow down the decryption process because all available secret keys must be\ntried. --no-throw-keyids disables this option. This option is essentially the same as\nusing --hidden-recipient for all recipients.\n\n", "long": "--no-throw-keyids" }, { "name": "--not-dash-escaped", "content": "This option changes the behavior of cleartext signatures so that they can be used for\npatch files. You should not send such an armored file via email because all spaces and\nline endings are hashed too. You can not use this option for data which has 5 dashes\nat the beginning of a line, patch files don't have this. A special armor header line\ntells GnuPG about this cleartext signature option.\n\n", "long": "--not-dash-escaped" }, { "name": "--escape-from-lines", "content": "", "long": "--escape-from-lines" }, { "name": "--no-escape-from-lines", "content": "Because some mailers change lines starting with \"From \" to \">From \" it is good to han‐\ndle such lines in a special way when creating cleartext signatures to prevent the mail\nsystem from breaking the signature. Note that all other PGP versions do it this way\ntoo. Enabled by default. --no-escape-from-lines disables this option.\n\n\n--passphrase-repeat n\nSpecify how many times gpg will request a new passphrase be repeated. This is useful\nfor helping memorize a passphrase. Defaults to 1 repetition; can be set to 0 to dis‐\nable any passphrase repetition. Note that a n greater than 1 will pop up the pinentry\nwindow n+1 times even if a modern pinentry with two entry fields is used.\n\n\n--passphrase-fd n\nRead the passphrase from file descriptor n. Only the first line will be read from file\ndescriptor n. If you use 0 for n, the passphrase will be read from STDIN. This can\nonly be used if only one passphrase is supplied.\n\nNote that since Version 2.0 this passphrase is only used if the option --batch has\nalso been given. Since Version 2.1 the --pinentry-mode also needs to be set to loop‐‐\nback.\n\n\n--passphrase-file file\nRead the passphrase from file file. Only the first line will be read from file file.\nThis can only be used if only one passphrase is supplied. Obviously, a passphrase\nstored in a file is of questionable security if other users can read this file. Don't\nuse this option if you can avoid it.\n\nNote that since Version 2.0 this passphrase is only used if the option --batch has\nalso been given. Since Version 2.1 the --pinentry-mode also needs to be set to loop‐‐\nback.\n\n\n--passphrase string\nUse string as the passphrase. This can only be used if only one passphrase is sup‐\nplied. Obviously, this is of very questionable security on a multi-user system. Don't\nuse this option if you can avoid it.\n\nNote that since Version 2.0 this passphrase is only used if the option --batch has\nalso been given. Since Version 2.1 the --pinentry-mode also needs to be set to loop‐‐\nback.\n\n\n--pinentry-mode mode\nSet the pinentry mode to mode. Allowed values for mode are:\n\ndefault\nUse the default of the agent, which is ask.\n\nask Force the use of the Pinentry.\n\ncancel Emulate use of Pinentry's cancel button.\n\nerror Return a Pinentry error (``No Pinentry'').\n\nloopback\nRedirect Pinentry queries to the caller. Note that in contrast to Pinentry the\nuser is not prompted again if he enters a bad password.\n\n", "long": "--no-escape-from-lines" }, { "name": "--no-symkey-cache", "content": "Disable the passphrase cache used for symmetrical en- and decryption. This cache is\nbased on the message specific salt value (cf. --s2k-mode).\n\n\n--request-origin origin\nTell gpg to assume that the operation ultimately originated at origin. Depending on\nthe origin certain restrictions are applied and the Pinentry may include an extra note\non the origin. Supported values for origin are: local which is the default, remote to\nindicate a remote origin or browser for an operation requested by a web browser.\n\n\n--command-fd n\nThis is a replacement for the deprecated shared-memory IPC mode. If this option is\nenabled, user input on questions is not expected from the TTY but from the given file\ndescriptor. It should be used together with --status-fd. See the file doc/DETAILS in\nthe source distribution for details on how to use it.\n\n\n--command-file file\nSame as --command-fd, except the commands are read out of file file\n\n", "long": "--no-symkey-cache" }, { "name": "--allow-non-selfsigned-uid", "content": "", "long": "--allow-non-selfsigned-uid" }, { "name": "--no-allow-non-selfsigned-uid", "content": "Allow the import and use of keys with user IDs which are not self-signed. This is not\nrecommended, as a non self-signed user ID is trivial to forge. --no-allow-non-self‐‐\nsigned-uid disables.\n\n", "long": "--no-allow-non-selfsigned-uid" }, { "name": "--allow-freeform-uid", "content": "Disable all checks on the form of the user ID while generating a new one. This option\nshould only be used in very special environments as it does not ensure the de-facto\nstandard format of user IDs.\n\n", "long": "--allow-freeform-uid" }, { "name": "--ignore-time-conflict", "content": "GnuPG normally checks that the timestamps associated with keys and signatures have\nplausible values. However, sometimes a signature seems to be older than the key due to\nclock problems. This option makes these checks just a warning. See also --ignore-\nvalid-from for timestamp issues on subkeys.\n\n", "long": "--ignore-time-conflict" }, { "name": "--ignore-valid-from", "content": "GnuPG normally does not select and use subkeys created in the future. This option al‐\nlows the use of such keys and thus exhibits the pre-1.0.7 behaviour. You should not\nuse this option unless there is some clock problem. See also --ignore-time-conflict\nfor timestamp issues with signatures.\n\n", "long": "--ignore-valid-from" }, { "name": "--ignore-crc-error", "content": "The ASCII armor used by OpenPGP is protected by a CRC checksum against transmission\nerrors. Occasionally the CRC gets mangled somewhere on the transmission channel but\nthe actual content (which is protected by the OpenPGP protocol anyway) is still okay.\nThis option allows GnuPG to ignore CRC errors.\n\n", "long": "--ignore-crc-error" }, { "name": "--ignore-mdc-error", "content": "This option changes a MDC integrity protection failure into a warning. It is required\nto decrypt old messages which did not use an MDC. It may also be useful if a message\nis partially garbled, but it is necessary to get as much data as possible out of that\ngarbled message. Be aware that a missing or failed MDC can be an indication of an at‐\ntack. Use with great caution; see also option --rfc2440.\n\n", "long": "--ignore-mdc-error" }, { "name": "--allow-weak-digest-algos", "content": "Signatures made with known-weak digest algorithms are normally rejected with an ``in‐\nvalid digest algorithm'' message. This option allows the verification of signatures\nmade with such weak algorithms. MD5 is the only digest algorithm considered weak by\ndefault. See also --weak-digest to reject other digest algorithms.\n\n\n--weak-digest name\nTreat the specified digest algorithm as weak. Signatures made over weak digests algo‐\nrithms are normally rejected. This option can be supplied multiple times if multiple\nalgorithms should be considered weak. See also --allow-weak-digest-algos to disable\nrejection of weak digests. MD5 is always considered weak, and does not need to be\nlisted explicitly.\n\n", "long": "--allow-weak-digest-algos" }, { "name": "--allow-weak-key-signatures", "content": "To avoid a minor risk of collision attacks on third-party key signatures made using\nSHA-1, those key signatures are considered invalid. This options allows to override\nthis restriction.\n\n", "long": "--allow-weak-key-signatures" }, { "name": "--no-default-keyring", "content": "Do not add the default keyrings to the list of keyrings. Note that GnuPG will not op‐\nerate without any keyrings, so if you use this option and do not provide alternate\nkeyrings via --keyring or --secret-keyring, then GnuPG will still use the default pub‐\nlic or secret keyrings.\n\n", "long": "--no-default-keyring" }, { "name": "--no-keyring", "content": "Do not use any keyring at all. This overrides the default and all options which spec‐\nify keyrings.\n\n", "long": "--no-keyring" }, { "name": "--skip-verify", "content": "Skip the signature verification step. This may be used to make the decryption faster\nif the signature verification is not needed.\n\n", "long": "--skip-verify" }, { "name": "--with-key-data", "content": "Print key listings delimited by colons (like --with-colons) and print the public key\ndata.\n\n", "long": "--with-key-data" }, { "name": "--list-signatures", "content": "", "long": "--list-signatures" }, { "name": "--list-sigs", "content": "Same as --list-keys, but the signatures are listed too. This command has the same ef‐\nfect as using --list-keys with --with-sig-list. Note that in contrast to --check-sig‐‐\nnatures the key signatures are not verified. This command can be used to create a\nlist of signing keys missing in the local keyring; for example:\n\ngpg --list-sigs --with-colons USERID | \\\nawk -F: '$1==\"sig\" && $2==\"?\" {if($13){print $13}else{print $5}}'\n\n", "long": "--list-sigs" }, { "name": "--fast-list-mode", "content": "Changes the output of the list commands to work faster; this is achieved by leaving\nsome parts empty. Some applications don't need the user ID and the trust information\ngiven in the listings. By using this options they can get a faster listing. The exact\nbehaviour of this option may change in future versions. If you are missing some in‐\nformation, don't use this option.\n\n", "long": "--fast-list-mode" }, { "name": "--no-literal", "content": "This is not for normal use. Use the source to see for what it might be useful.\n\n", "long": "--no-literal" }, { "name": "--set-filesize", "content": "This is not for normal use. Use the source to see for what it might be useful.\n\n", "long": "--set-filesize" }, { "name": "--show-session-key", "content": "Display the session key used for one message. See --override-session-key for the coun‐\nterpart of this option.\n\nWe think that Key Escrow is a Bad Thing; however the user should have the freedom to\ndecide whether to go to prison or to reveal the content of one specific message with‐\nout compromising all messages ever encrypted for one secret key.\n\nYou can also use this option if you receive an encrypted message which is abusive or\noffensive, to prove to the administrators of the messaging system that the ciphertext\ntransmitted corresponds to an inappropriate plaintext so they can take action against\nthe offending user.\n\n\n--override-session-key string\n--override-session-key-fd fd\nDon't use the public key but the session key string respective the session key taken\nfrom the first line read from file descriptor fd. The format of this string is the\nsame as the one printed by --show-session-key. This option is normally not used but\ncomes handy in case someone forces you to reveal the content of an encrypted message;\nusing this option you can do this without handing out the secret key. Note that using\n--override-session-key may reveal the session key to all local users via the global\nprocess table. Often it is useful to combine this option with --no-keyring.\n\n", "long": "--show-session-key" }, { "name": "--ask-sig-expire", "content": "", "long": "--ask-sig-expire" }, { "name": "--no-ask-sig-expire", "content": "When making a data signature, prompt for an expiration time. If this option is not\nspecified, the expiration time set via --default-sig-expire is used. --no-ask-sig-ex‐‐\npire disables this option.\n\n", "long": "--no-ask-sig-expire" }, { "name": "--default-sig-expire", "content": "The default expiration time to use for signature expiration. Valid values are \"0\" for\nno expiration, a number followed by the letter d (for days), w (for weeks), m (for\nmonths), or y (for years) (for example \"2m\" for two months, or \"5y\" for five years),\nor an absolute date in the form YYYY-MM-DD. Defaults to \"0\".\n\n", "long": "--default-sig-expire" }, { "name": "--ask-cert-expire", "content": "", "long": "--ask-cert-expire" }, { "name": "--no-ask-cert-expire", "content": "When making a key signature, prompt for an expiration time. If this option is not\nspecified, the expiration time set via --default-cert-expire is used. --no-ask-cert-\nexpire disables this option.\n\n", "long": "--no-ask-cert-expire" }, { "name": "--default-cert-expire", "content": "The default expiration time to use for key signature expiration. Valid values are \"0\"\nfor no expiration, a number followed by the letter d (for days), w (for weeks), m (for\nmonths), or y (for years) (for example \"2m\" for two months, or \"5y\" for five years),\nor an absolute date in the form YYYY-MM-DD. Defaults to \"0\".\n\n\n--default-new-key-algo string\nThis option can be used to change the default algorithms for key generation. The\nstring is similar to the arguments required for the command --quick-add-key but\nslightly different. For example the current default of\n\"rsa2048/cert,sign+rsa2048/encr\" (or \"rsa3072\") can be changed to the value of what we\ncurrently call future default, which is \"ed25519/cert,sign+cv25519/encr\". You need to\nconsult the source code to learn the details. Note that the advanced key generation\ncommands can always be used to specify a key algorithm directly.\n\n", "long": "--default-cert-expire" }, { "name": "--allow-secret-key-import", "content": "This is an obsolete option and is not used anywhere.\n\n", "long": "--allow-secret-key-import" }, { "name": "--allow-multiple-messages", "content": "", "long": "--allow-multiple-messages" }, { "name": "--no-allow-multiple-messages", "content": "Allow processing of multiple OpenPGP messages contained in a single file or stream.\nSome programs that call GPG are not prepared to deal with multiple messages being pro‐\ncessed together, so this option defaults to no. Note that versions of GPG prior to\n1.4.7 always allowed multiple messages. Future versions of GnUPG will remove this op‐\ntion.\n\nWarning: Do not use this option unless you need it as a temporary workaround!\n\n\n", "long": "--no-allow-multiple-messages" }, { "name": "--enable-special-filenames", "content": "This option enables a mode in which filenames of the form ‘-&n’, where n is a non-neg‐\native decimal number, refer to the file descriptor n and not to a file with that name.\n\n", "long": "--enable-special-filenames" }, { "name": "--no-expensive-trust-checks", "content": "Experimental use only.\n\n", "long": "--no-expensive-trust-checks" }, { "name": "--preserve-permissions", "content": "Don't change the permissions of a secret keyring back to user read/write only. Use\nthis option only if you really know what you are doing.\n\n\n--default-preference-list string\nSet the list of default preferences to string. This preference list is used for new\nkeys and becomes the default for \"setpref\" in the edit menu.\n\n\n--default-keyserver-url name\nSet the default keyserver URL to name. This keyserver will be used as the keyserver\nURL when writing a new self-signature on a key, which includes key generation and\nchanging preferences.\n\n", "long": "--preserve-permissions" }, { "name": "--list-config", "content": "Display various internal configuration parameters of GnuPG. This option is intended\nfor external programs that call GnuPG to perform tasks, and is thus not generally use‐\nful. See the file ‘doc/DETAILS’ in the source distribution for the details of which\nconfiguration items may be listed. --list-config is only usable with --with-colons\nset.\n\n", "long": "--list-config" }, { "name": "--list-gcrypt-config", "content": "Display various internal configuration parameters of Libgcrypt.\n\n", "long": "--list-gcrypt-config" }, { "name": "--gpgconf-list", "content": "This command is similar to --list-config but in general only internally used by the\ngpgconf tool.\n\n", "long": "--gpgconf-list" }, { "name": "--gpgconf-test", "content": "This is more or less dummy action. However it parses the configuration file and re‐\nturns with failure if the configuration file would prevent gpg from startup. Thus it\nmay be used to run a syntax check on the configuration file.\n\n", "long": "--gpgconf-test" }, { "name": "Deprecated options", "content": "" }, { "name": "--show-photos", "content": "", "long": "--show-photos" }, { "name": "--no-show-photos", "content": "Causes --list-keys, --list-signatures, --list-public-keys, --list-secret-keys, and\nverifying a signature to also display the photo ID attached to the key, if any. See\nalso --photo-viewer. These options are deprecated. Use --list-options [no-]show-photos\nand/or --verify-options [no-]show-photos instead.\n\n", "long": "--no-show-photos" }, { "name": "--show-keyring", "content": "Display the keyring name at the head of key listings to show which keyring a given key\nresides on. This option is deprecated: use --list-options [no-]show-keyring instead.\n\n", "long": "--show-keyring" }, { "name": "--always-trust", "content": "Identical to --trust-model always. This option is deprecated.\n\n", "long": "--always-trust" }, { "name": "--show-notation", "content": "", "long": "--show-notation" }, { "name": "--no-show-notation", "content": "Show signature notations in the --list-signatures or --check-signatures listings as\nwell as when verifying a signature with a notation in it. These options are depre‐\ncated. Use --list-options [no-]show-notation and/or --verify-options [no-]show-nota‐‐\ntion instead.\n\n", "long": "--no-show-notation" }, { "name": "--show-policy-url", "content": "", "long": "--show-policy-url" }, { "name": "--no-show-policy-url", "content": "Show policy URLs in the --list-signatures or --check-signatures listings as well as\nwhen verifying a signature with a policy URL in it. These options are deprecated. Use\n--list-options [no-]show-policy-url and/or --verify-options [no-]show-policy-url in‐\nstead.\n\n\n", "long": "--no-show-policy-url" } ] }, "EXAMPLES": { "content": "", "subsections": [ { "name": "gpg -se -r Bob file", "content": "sign and encrypt for user Bob\n\n" }, { "name": "gpg --clear-sign file", "content": "make a cleartext signature\n\n" }, { "name": "gpg -sb file", "content": "make a detached signature\n\n" }, { "name": "gpg -u 0x12345678 -sb file", "content": "make a detached signature with the key 0x12345678\n\n\ngpg --list-keys userID\nshow keys\n\n\ngpg --fingerprint userID\nshow fingerprint\n\n" }, { "name": "gpg --verify pgpfile", "content": "gpg --verify sigfile [datafile]\nVerify the signature of the file but do not output the data unless requested. The\nsecond form is used for detached signatures, where sigfile is the detached signature\n(either ASCII armored or binary) and datafile are the signed data; if this is not\ngiven, the name of the file holding the signed data is constructed by cutting off the\nextension (\".asc\" or \".sig\") of sigfile or by asking the user for the filename. If\nthe option --output is also used the signed data is written to the file specified by\nthat option; use - to write the signed data to stdout.\n" } ] }, "HOW TO SPECIFY A USER ID": { "content": "There are different ways to specify a user ID to GnuPG. Some of them are only valid for gpg\nothers are only good for gpgsm. Here is the entire list of ways to specify a key:\n\n\n", "subsections": [ { "name": "By key Id.", "content": "This format is deduced from the length of the string and its content or 0x prefix. The\nkey Id of an X.509 certificate are the low 64 bits of its SHA-1 fingerprint. The use\nof key Ids is just a shortcut, for all automated processing the fingerprint should be\nused.\n\nWhen using gpg an exclamation mark (!) may be appended to force using the specified\nprimary or secondary key and not to try and calculate which primary or secondary key\nto use.\n\nThe last four lines of the example give the key ID in their long form as internally\nused by the OpenPGP protocol. You can see the long key ID using the option --with-\ncolons.\n\n234567C4\n0F34E556E\n01347A56A\n0xAB123456\n\n234AABBCC34567C4\n0F323456784E56EAB\n01AB3FED1347A5612\n0x234AABBCC34567C4\n\n\n\n" }, { "name": "By fingerprint.", "content": "This format is deduced from the length of the string and its content or the 0x prefix.\nNote, that only the 20 byte version fingerprint is available with gpgsm (i.e. the\nSHA-1 hash of the certificate).\n\nWhen using gpg an exclamation mark (!) may be appended to force using the specified\nprimary or secondary key and not to try and calculate which primary or secondary key\nto use.\n\nThe best way to specify a key Id is by using the fingerprint. This avoids any ambigu‐\nities in case that there are duplicated key IDs.\n\n1234343434343434C434343434343434\n123434343434343C3434343434343734349A3434\n0E12343434343434343434EAB3484343434343434\n0xE12343434343434343434EAB3484343434343434\n\n\ngpgsm also accepts colons between each pair of hexadecimal digits because this is the de-\nfacto standard on how to present X.509 fingerprints. gpg also allows the use of the space\nseparated SHA-1 fingerprint as printed by the key listing commands.\n\n" }, { "name": "By exact match on OpenPGP user ID.", "content": "This is denoted by a leading equal sign. It does not make sense for X.509 certifi‐\ncates.\n\n=Heinrich Heine \n\n" }, { "name": "By exact match on an email address.", "content": "This is indicated by enclosing the email address in the usual way with left and right\nangles.\n\n\n\n\n" }, { "name": "By partial match on an email address.", "content": "This is indicated by prefixing the search string with an @. This uses a substring\nsearch but considers only the mail address (i.e. inside the angle brackets).\n\n@heinrichh\n\n" }, { "name": "By exact match on the subject's DN.", "content": "This is indicated by a leading slash, directly followed by the RFC-2253 encoded DN of\nthe subject. Note that you can't use the string printed by gpgsm --list-keys because\nthat one has been reordered and modified for better readability; use --with-colons to\nprint the raw (but standard escaped) RFC-2253 string.\n\n/CN=Heinrich Heine,O=Poets,L=Paris,C=FR\n\n" }, { "name": "By exact match on the issuer's DN.", "content": "This is indicated by a leading hash mark, directly followed by a slash and then di‐\nrectly followed by the RFC-2253 encoded DN of the issuer. This should return the Root\ncert of the issuer. See note above.\n\n#/CN=Root Cert,O=Poets,L=Paris,C=FR\n\n\n" }, { "name": "By exact match on serial number and issuer's DN.", "content": "This is indicated by a hash mark, followed by the hexadecimal representation of the\nserial number, then followed by a slash and the RFC-2253 encoded DN of the issuer. See\nnote above.\n\n#4F03/CN=Root Cert,O=Poets,L=Paris,C=FR\n\n" }, { "name": "By keygrip.", "content": "This is indicated by an ampersand followed by the 40 hex digits of a keygrip. gpgsm\nprints the keygrip when using the command --dump-cert.\n\n&D75F22C3F86E355877348498CDC92BD21010A480\n\n\n" }, { "name": "By substring match.", "content": "This is the default mode but applications may want to explicitly indicate this by\nputting the asterisk in front. Match is not case sensitive.\n\nHeine\n*Heine\n\n" }, { "name": ". and + prefixes", "content": "These prefixes are reserved for looking up mails anchored at the end and for a word\nsearch mode. They are not yet implemented and using them is undefined.\n\n\nPlease note that we have reused the hash mark identifier which was used in old GnuPG\nversions to indicate the so called local-id. It is not anymore used and there should\nbe no conflict when used with X.509 stuff.\n\nUsing the RFC-2253 format of DNs has the drawback that it is not possible to map them\nback to the original encoding, however we don't have to do this because our key data‐\nbase stores this encoding as meta data.\n\n" } ] }, "FILTER EXPRESSIONS": { "content": "The options --import-filter and --export-filter use expressions with this syntax (square\nbrackets indicate an optional part and curly braces a repetition, white space between the el‐\nements are allowed):\n\n[lc] {[{flag}] PROPNAME op VALUE [lc]}\n\nThe name of a property (PROPNAME) may only consist of letters, digits and underscores. The\ndescription for the filter type describes which properties are defined. If an undefined\nproperty is used it evaluates to the empty string. Unless otherwise noted, the VALUE must\nalways be given and may not be the empty string. No quoting is defined for the value, thus\nthe value may not contain the strings && or ||, which are used as logical connection opera‐\ntors. The flag -- can be used to remove this restriction.\n\nNumerical values are computed as long int; standard C notation applies. lc is the logical\nconnection operator; either && for a conjunction or || for a disjunction. A conjunction is\nassumed at the begin of an expression. Conjunctions have higher precedence than disjunc‐\ntions. If VALUE starts with one of the characters used in any op a space after the op is re‐\nquired.\n\n\nThe supported operators (op) are:\n\n\n\n=~ Substring must match.\n\n\n!~ Substring must not match.\n\n\n= The full string must match.\n\n\n<> The full string must not match.\n\n\n== The numerical value must match.\n\n\n!= The numerical value must not match.\n\n\n<= The numerical value of the field must be LE than the value.\n\n\n< The numerical value of the field must be LT than the value.\n\n\n> The numerical value of the field must be GT than the value.\n\n\n>= The numerical value of the field must be GE than the value.\n\n", "subsections": [ { "name": "-le", "content": "" }, { "name": "-lt", "content": "" }, { "name": "-gt", "content": "" }, { "name": "-ge", "content": "" }, { "name": "-n", "content": "", "flag": "-n" }, { "name": "-z", "content": "", "flag": "-z" }, { "name": "-t", "content": "", "flag": "-t" }, { "name": "-f", "content": "Values for flag must be space separated. The supported flags are:\n\n\n-- VALUE spans to the end of the expression.\n", "flag": "-f" }, { "name": "-c", "content": "The filter options concatenate several specifications for a filter of the same type. For ex‐\nample the four options in this example:\n\n--import-filter keep-uid=\"uid =~ Alfa\"\n--import-filter keep-uid=\"&& uid !~ Test\"\n--import-filter keep-uid=\"|| uid =~ Alpha\"\n--import-filter keep-uid=\"uid !~ Test\"\n\n\nwhich is equivalent to\n\n--import-filter \\\nkeep-uid=\"uid =~ Alfa\" && uid !~ Test\" || uid =~ Alpha\" && \"uid !~ Test\"\n\nimports only the user ids of a key containing the strings \"Alfa\" or \"Alpha\" but not the\nstring \"test\".\n\n", "flag": "-c" } ] }, "TRUST VALUES": { "content": "Trust values are used to indicate ownertrust and validity of keys and user IDs. They are\ndisplayed with letters or strings:\n\n\n\n-", "subsections": [ { "name": "unknown", "content": "No ownertrust assigned / not yet calculated.\n\n\ne" }, { "name": "expired", "content": "Trust calculation has failed; probably due to an expired key.\n\n\nq" }, { "name": "undefined, undef", "content": "Not enough information for calculation.\n\n\nn\nnever Never trust this key.\n\n\nm" }, { "name": "marginal", "content": "Marginally trusted.\n\n\nf\nfull Fully trusted.\n\n\nu" }, { "name": "ultimate", "content": "Ultimately trusted.\n\n\nr" }, { "name": "revoked", "content": "For validity only: the key or the user ID has been revoked.\n\n\n?\nerr The program encountered an unknown trust value.\n\n" } ] }, "FILES": { "content": "There are a few configuration files to control certain aspects of gpg's operation. Unless\nnoted, they are expected in the current home directory (see: [option --homedir]).\n\n\n", "subsections": [ { "name": "gpg.conf", "content": "This is the standard configuration file read by gpg on startup. It may contain any\nvalid long option; the leading two dashes may not be entered and the option may not be\nabbreviated. This default name may be changed on the command line (see: [gpg-option\n--options]). You should backup this file.\n\n\nNote that on larger installations, it is useful to put predefined files into the directory\n‘/etc/skel/.gnupg’ so that newly created users start up with a working configuration. For\nexisting users a small helper script is provided to create these files (see: [addgnupghome]).\n\nFor internal purposes gpg creates and maintains a few other files; They all live in the cur‐\nrent home directory (see: [option --homedir]). Only the gpg program may modify these files.\n\n\n" }, { "name": "~/.gnupg", "content": "This is the default home directory which is used if neither the environment variable\nGNUPGHOME nor the option --homedir is given.\n\n" }, { "name": "~/.gnupg/pubring.gpg", "content": "The public keyring using a legacy format. You should backup this file.\n\nIf this file is not available, gpg defaults to the new keybox format and creates a\nfile ‘pubring.kbx’ unless that file already exists in which case that file will also\nbe used for OpenPGP keys.\n\nNote that in the case that both files, ‘pubring.gpg’ and ‘pubring.kbx’ exists but the\nlatter has no OpenPGP keys, the legacy file ‘pubring.gpg’ will be used. Take care:\nGnuPG versions before 2.1 will always use the file ‘pubring.gpg’ because they do not\nknow about the new keybox format. In the case that you have to use GnuPG 1.4 to de‐\ncrypt archived data you should keep this file.\n\n" }, { "name": "~/.gnupg/pubring.gpg.lock", "content": "The lock file for the public keyring.\n\n" }, { "name": "~/.gnupg/pubring.kbx", "content": "The public keyring using the new keybox format. This file is shared with gpgsm. You\nshould backup this file. See above for the relation between this file and it prede‐\ncessor.\n\nTo convert an existing ‘pubring.gpg’ file to the keybox format, you first backup the\nownertrust values, then rename ‘pubring.gpg’ to ‘publickeys.backup’, so it won’t be\nrecognized by any GnuPG version, run import, and finally restore the ownertrust val‐\nues:\n\n$ cd ~/.gnupg\n$ gpg --export-ownertrust >otrust.lst\n$ mv pubring.gpg publickeys.backup\n$ gpg --import-options restore --import publickeys.backups\n$ gpg --import-ownertrust otrust.lst\n\n" }, { "name": "~/.gnupg/pubring.kbx.lock", "content": "The lock file for ‘pubring.kbx’.\n\n" }, { "name": "~/.gnupg/secring.gpg", "content": "The legacy secret keyring as used by GnuPG versions before 2.1. It is not used by\nGnuPG 2.1 and later. You may want to keep it in case you have to use GnuPG 1.4 to de‐\ncrypt archived data.\n\n" }, { "name": "~/.gnupg/secring.gpg.lock", "content": "The lock file for the legacy secret keyring.\n\n" }, { "name": "~/.gnupg/.gpg-v21-migrated", "content": "File indicating that a migration to GnuPG 2.1 has been done.\n\n" }, { "name": "~/.gnupg/trustdb.gpg", "content": "The trust database. There is no need to backup this file; it is better to backup the\nownertrust values (see: [option --export-ownertrust]).\n\n" }, { "name": "~/.gnupg/trustdb.gpg.lock", "content": "The lock file for the trust database.\n\n\n~/.gnupg/randomseed\nA file used to preserve the state of the internal random pool.\n\n" }, { "name": "~/.gnupg/openpgp-revocs.d/", "content": "This is the directory where gpg stores pre-generated revocation certificates. The\nfile name corresponds to the OpenPGP fingerprint of the respective key. It is sug‐\ngested to backup those certificates and if the primary private key is not stored on\nthe disk to move them to an external storage device. Anyone who can access theses\nfiles is able to revoke the corresponding key. You may want to print them out. You\nshould backup all files in this directory and take care to keep this backup closed\naway.\n\n\nOperation is further controlled by a few environment variables:\n\n\n\nHOME Used to locate the default home directory.\n\n\nGNUPGHOME\nIf set directory used instead of \"~/.gnupg\".\n\n\nGPGAGENTINFO\nThis variable is obsolete; it was used by GnuPG versions before 2.1.\n\n\nPINENTRYUSERDATA\nThis value is passed via gpg-agent to pinentry. It is useful to convey extra informa‐\ntion to a custom pinentry.\n\n\nCOLUMNS\nLINES Used to size some displays to the full size of the screen.\n\n\nLANGUAGE\nApart from its use by GNU, it is used in the W32 version to override the language se‐\nlection done through the Registry. If used and set to a valid and available language\nname (langid), the file with the translation is loaded from\ngpgdir/gnupg.nls/langid.mo. Here gpgdir is the directory out of which the gpg binary\nhas been loaded. If it can't be loaded the Registry is tried and as last resort the\nnative Windows locale system is used.\n\n\nWhen calling the gpg-agent component gpg sends a set of environment variables to gpg-agent.\nThe names of these variables can be listed using the command:\n\ngpg-connect-agent 'getinfo stdenvnames' /bye | awk '$1==\"D\" {print $2}'\n\n\n\n\n" } ] }, "BUGS": { "content": "On older systems this program should be installed as setuid(root). This is necessary to lock\nmemory pages. Locking memory pages prevents the operating system from writing memory pages\n(which may contain passphrases or other sensitive material) to disk. If you get no warning\nmessage about insecure memory your operating system supports locking without being root. The\nprogram drops root privileges as soon as locked memory is allocated.\n\nNote also that some systems (especially laptops) have the ability to ``suspend to disk''\n(also known as ``safe sleep'' or ``hibernate''). This writes all memory to disk before going\ninto a low power or even powered off mode. Unless measures are taken in the operating system\nto protect the saved memory, passphrases or other sensitive material may be recoverable from\nit later.\n\nBefore you report a bug you should first search the mailing list archives for similar prob‐\nlems and second check whether such a bug has already been reported to our bug tracker at\nhttps://bugs.gnupg.org.\n\n\n", "subsections": [] }, "SEE ALSO": { "content": "gpgv(1), gpgsm(1), gpg-agent(1)\n\nThe full documentation for this tool is maintained as a Texinfo manual. If GnuPG and the\ninfo program are properly installed at your site, the command\n\ninfo gnupg\n\nshould give you access to the complete manual including a menu structure and an index.\n\n\n\nGnuPG 2.2.27 2020-12-21 GPG(1)", "subsections": [] } } } }