From 540840a67d85e798044523229513ccc4a13d9bc1 Mon Sep 17 00:00:00 2001 From: David Shaw Date: Mon, 7 Apr 2003 21:27:48 +0000 Subject: [PATCH] * Makefile.am: Allow CVS version to build without faqprog.pl. * gpg.sgml: Some cleanup of --no-xxx options, make sure that all SGML tags are closed, clarify --pgp8 allows SHA-256, and document --no-emit-version. --- doc/ChangeLog | 8 ++ doc/Makefile.am | 16 +++- doc/gpg.sgml | 195 ++++++++++++++---------------------------------- 3 files changed, 76 insertions(+), 143 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 73b16f8f6..733d150dd 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,11 @@ +2003-04-07 David Shaw + + * Makefile.am: Allow CVS version to build without faqprog.pl. + + * gpg.sgml: Some cleanup of --no-xxx options, make sure that all + SGML tags are closed, clarify --pgp8 allows SHA-256, and document + --no-emit-version. + 2003-02-24 David Shaw * gpg.sgml: Document "revuid". Clarify that --openpgp resets diff --git a/doc/Makefile.am b/doc/Makefile.am index 8f951191a..5972432a3 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -67,16 +67,24 @@ else echo "No man page due to missing docbook-to-man" >>$@ endif - FAQ : faq.raw +if WORKING_FAQPROG $(FAQPROG) -f $< $@ || $(FAQPROG) -f $< $@ +else + : Warning: missing faqprog.pl, cannot make $@ + echo "No $@ due to missing faqprog.pl" > $@ + echo "See ftp://ftp.gnupg.org/gcrypt/contrib/faqprog.pl" >> $@ +endif faq.html : faq.raw +if WORKING_FAQPROG $(FAQPROG) -h -f $< $@ 2>&1 || $(FAQPROG) -h -f $< $@ +else + : Warning: missing faqprog.pl, cannot make $@ + echo "No $@ due to missing faqprog.pl" > $@ + echo "See ftp://ftp.gnupg.org/gcrypt/contrib/faqprog.pl" >> $@ +endif dist-hook: @if test "`wc -c < gpg.1`" -lt 200; then \ echo 'ERROR: dummy man page'; false; fi - - - diff --git a/doc/gpg.sgml b/doc/gpg.sgml index 05551668d..8007d333e 100644 --- a/doc/gpg.sgml +++ b/doc/gpg.sgml @@ -335,7 +335,8 @@ Create an alternate user id. addphoto -Create a photographic user id. +Create a photographic user id. This will prompt for a JPEG file that +will be embedded into the user ID. deluid @@ -890,11 +891,13 @@ Prompt before overwriting any files. --batch +--no-batch -Use batch mode. Never ask, do not allow interactive -commands. +Use batch mode. Never ask, do not allow interactive commands. +--no-batch disables this option. + --no-tty @@ -904,14 +907,6 @@ warnings to the TTY if --batch is used. - ---no-batch - -Disable batch mode. This may be of use if --batch -is enabled from an options file. - - - --yes @@ -1169,17 +1164,12 @@ Include designated revoker information that was marked as --show-photos +--no-show-photos Causes --list-keys, --list-sigs, --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. - - - ---no-show-photos - -Resets the --show-photos flag. +photo ID attached to the key, if any. See also --photo-viewer. +--no-show-photos disables this option. @@ -1360,18 +1350,15 @@ delivered to the file descriptor. --sk-comments +--no-sk-comments Include secret key comment packets when exporting secret keys. This is a GnuPG extension to the OpenPGP standard, and is off by default. Please note that this has nothing to do with the comments in clear -text signatures or armor headers. +text signatures or armor headers. --no-sk-comments disables this +option. - ---no-sk-comments - -Resets the --sk-comments option. - --no-comment @@ -1398,19 +1385,12 @@ default comment string anymore. - ---no-version - -Omit the version string in clear text signatures. - - - --emit-version +--no-emit-version -Force to write the version string in clear text -signatures. Use this to overwrite a previous ---no-version from a config file. +Force inclusion of the version string in ASCII armored output. +--no-emit-version disables this option. @@ -1446,16 +1426,13 @@ making a key signature (certification). --show-notation +--no-show-notation Show signature notations in the --list-sigs or --check-sigs listings as well as when verifying a signature with a notation in it. +--no-show-notation disables this option. - ---no-show-notation - -Do not show signature notations. - --sig-policy-url &ParmString; @@ -1475,15 +1452,11 @@ The same %-expandos used for notation data are available here as well. --show-policy-url +--no-show-policy-url Show policy URLs in the --list-sigs or --check-sigs listings as well as when verifying a signature with a policy URL in it. - - - ---no-show-policy-url - -Do not show policy URLs. +--no-show-policy-url disables this option. @@ -1495,18 +1468,14 @@ messages. --for-your-eyes-only +--no-for-your-eyes-only 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 the "secure viewer" with a Tempest-resistant font to display the message. This option overrides --set-filename. - ---no-for-your-eyes-only - -Resets the --for-your-eyes-only flag. - --use-embedded-filename @@ -1667,16 +1636,12 @@ interaction, this performance penalty does not matter in most settings. --auto-check-trustdb - -If GnuPG feels that its information about the Web-of-Trust has to be -updated, it automatically runs the --check-trustdb command -internally. This may be a time consuming process. - - - --no-auto-check-trustdb -Resets the --auto-check-trustdb option. +If GnuPG feels that its information about the Web-of-Trust has to be +updated, it automatically runs the --check-trustdb command internally. +This may be a time consuming process. --no-auto-check-trustdb +disables this option. @@ -1757,6 +1722,7 @@ Try to be more RFC1991 (PGP 2.x) compliant. --pgp2 +--no-pgp2 Set up all options to be as PGP 2.x compliant as possible, and warn if an action is taken (e.g. encrypting to a non-RSA key) that will create @@ -1768,17 +1734,12 @@ This option implies `--rfc1991 --no-openpgp --disable-mdc --no-force-v4-certs --no-comment --escape-from-lines --force-v3-sigs --no-ask-sig-expire --no-ask-cert-expire --cipher-algo IDEA --digest-algo MD5 --compress-algo 1'. It also disables --textmode -when encrypting. - - - ---no-pgp2 - -Resets the --pgp2 option. +when encrypting. --no-pgp2 disables this option. --pgp6 +--no-pgp6 Set up all options to be as PGP 6 compliant as possible. This restricts you to the ciphers IDEA (if the IDEA plugin is installed), @@ -1788,43 +1749,30 @@ compression algorithms none and ZIP. This also disables does not understand signatures made by signing subkeys. This option implies `--disable-mdc --no-comment --escape-from-lines ---force-v3-sigs --no-ask-sig-expire --compress-algo 1' - - - ---no-pgp6 - -Resets the --pgp6 option. +--force-v3-sigs --no-ask-sig-expire --compress-algo 1' --no-pgp6 +disables this option. --pgp7 +--no-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. - - - ---no-pgp7 - -Resets the --pgp7 option. +TWOFISH. --no-pgp7 disables this option. --pgp8 +--no-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-keyid and set --escape-from-lines and ---compress-algo 1. The allowed algorithms list is the same as --pgp7. - - - ---no-pgp8 - -Resets the --pgp8 option. +--compress-algo 1. The allowed algorithms list is the same as --pgp7 +with the addition of the SHA-256 digest algorithm. --no-pgp8 disables +this option. @@ -1839,31 +1787,23 @@ this option to reset all previous options like --rfc1991, --force-v3-sigs +--no-force-v3-sigs OpenPGP states that an implementation should generate v4 signatures but PGP versions 5 and higher only recognize v4 signatures on key material. This option forces v3 signatures for signatures on data. Note that this option overrides --ask-sig-expire, as v3 signatures -cannot have expiration dates. - - - ---no-force-v3-sigs - -Reset the --force-v3-sigs option. +cannot have expiration dates. --no-force-v3-sigs disables this +option. --force-v4-certs +--no-force-v4-certs Always use v4 key signatures even on v3 keys. This option also changes the default hash algorithm for v3 RSA keys from MD5 to SHA-1. - - - ---no-force-v4-certs - -Reset the --force-v4-certs option. +--no-force-v4-certs disables this option. @@ -1871,8 +1811,8 @@ Reset the --force-v4-certs option. Force the use of encryption with a modification detection code. This is always used with the newer ciphers (those with a blocksize greater -than 64 bits), or if the recipient key has one of those ciphers as a -preference. +than 64 bits), or if all of the recipient keys indicate MDC support in +their feature flags. @@ -1885,16 +1825,11 @@ message modification attack. --allow-non-selfsigned-uid +--no-allow-non-selfsigned-uid 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-selfsigned-uid - -Reset the --allow-non-selfsigned-uid option. +trivial to forge. --no-allow-non-selfsigned-uid disables. @@ -1905,7 +1840,6 @@ one. This option should only be used in very special environments as it does not ensure the de-facto standard format of user IDs. - --ignore-time-conflict @@ -1952,7 +1886,6 @@ and do not release the lock until the process terminates. - --lock-multiple @@ -1980,19 +1913,16 @@ are not desired. This option can be used to achieve that with the cost of slower random generation. - --no-verbose Reset verbose level to 0. - --no-greeting -Suppress the initial copyright message but do not -enter batch mode. +Suppress the initial copyright message. @@ -2135,32 +2065,25 @@ handing out the secret key. --ask-sig-expire +--no-ask-sig-expire When making a data signature, prompt for an expiration time. If this option is not specified, the expiration time is "never". - ---no-ask-sig-expire - -Resets the --ask-sig-expire option. - --ask-cert-expire +--no-ask-cert-expire When making a key signature, prompt for an expiration time. If this option is not specified, the expiration time is "never". - ---no-ask-cert-expire - -Resets the --ask-cert-expire option. - --expert +--no-expert Allow the user to do certain nonsensical or "silly" things like signing an expired or revoked key, or certain potentially incompatible @@ -2168,14 +2091,8 @@ things like generating deprecated key types. This also disables certain warning messages about potentially incompatible actions. As the name implies, this option is for experts only. If you don't fully understand the implications of what it allows you to do, leave this -off. - ---no-expert - -Resets the --expert option. - --merge-only