1
0
mirror of git://git.gnupg.org/gnupg.git synced 2024-06-27 02:02:45 +02:00

* gpg.sgml: List proper documentation URL. Note that addrevoker takes an

optional "sensitive" argument.  Remind that $GNUPGHOME can be used instead
of --homedir.  Clarify --no-default-keyring, and note why it may not take
effect if there are no other keyrings present.  Remove --pgp2 from the
list of --pgpXes that are just for bad preference lists.  Explain more why
locking memory pages is good.
This commit is contained in:
David Shaw 2004-01-07 05:02:57 +00:00
parent 9e8788618f
commit 27b650553e
2 changed files with 69 additions and 54 deletions

View File

@ -1,3 +1,13 @@
2004-01-06 David Shaw <dshaw@jabberwocky.com>
* gpg.sgml: List proper documentation URL. Note that addrevoker
takes an optional "sensitive" argument. Remind that $GNUPGHOME
can be used instead of --homedir. Clarify --no-default-keyring,
and note why it may not take effect if there are no other keyrings
present. Remove --pgp2 from the list of --pgpXes that are just
for bad preference lists. Explain more why locking memory pages
is good.
2003-12-21 David Shaw <dshaw@jabberwocky.com> 2003-12-21 David Shaw <dshaw@jabberwocky.com>
* gpg.sgml: Add an example of what an exclamation mark is, as * gpg.sgml: Add an example of what an exclamation mark is, as

View File

@ -1,5 +1,5 @@
<!-- gpg.sgml - the man page for GnuPG <!-- gpg.sgml - the man page for GnuPG
Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc. Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
This file is part of GnuPG. This file is part of GnuPG.
@ -73,9 +73,9 @@
<command/gpg/ is the main program for the GnuPG system. <command/gpg/ is the main program for the GnuPG system.
</para> </para>
<para> <para>
This man page only lists the commands and options available. This man page only lists the commands and options available. For more
For more verbose documentation get the GNU Privacy Handbook (GPH) or verbose documentation get the GNU Privacy Handbook (GPH) or one of the
one of the other documents at http://www.gnupg.org/docs.html . other documents at http://www.gnupg.org/documentation/ .
</para> </para>
<para> <para>
Please remember that option parsing stops as soon as a non option is Please remember that option parsing stops as soon as a non option is
@ -373,7 +373,7 @@ Add a subkey to this key.</para></listitem></varlistentry>
<listitem><para> <listitem><para>
Remove a subkey.</para></listitem></varlistentry> Remove a subkey.</para></listitem></varlistentry>
<varlistentry> <varlistentry>
<term>addrevoker</term> <term>addrevoker <optional>sensitive</optional></term>
<listitem><para> <listitem><para>
Add a designated revoker. This takes one optional argument: Add a designated revoker. This takes one optional argument:
"sensitive". If a designated revoker is marked as sensitive, it will "sensitive". If a designated revoker is marked as sensitive, it will
@ -1227,13 +1227,15 @@ effect when listing all keys.
<varlistentry> <varlistentry>
<term>--keyring &ParmFile;</term> <term>--keyring &ParmFile;</term>
<listitem><para> <listitem><para>
Add &ParmFile; to the list of keyrings. If &ParmFile; begins with a Add &ParmFile; to the current list of keyrings. If &ParmFile; begins
tilde and a slash, these are replaced by the HOME directory. If the with a tilde and a slash, these are replaced by the $HOME
filename does not contain a slash, it is assumed to be in the GnuPG directory. If the filename does not contain a slash, it is assumed to
home directory ("~/.gnupg" if --homedir is not used). The filename be in the GnuPG home directory ("~/.gnupg" if --homedir or $GNUPGHOME
may be prefixed with a scheme:</para> is not used).
<para>"gnupg-ring:" is the default one.</para> </para><para>
<para>It might make sense to use it together with --no-default-keyring. Note that this adds a keyring to the current list. If the intent is
to use the specified keyring alone, use --keyring along with
--no-default-keyring.
</para></listitem></varlistentry> </para></listitem></varlistentry>
@ -1247,32 +1249,32 @@ Same as --keyring but for the secret keyrings.
<varlistentry> <varlistentry>
<term>--trustdb-name &ParmFile;</term> <term>--trustdb-name &ParmFile;</term>
<listitem><para> <listitem><para>
Use &ParmFile; instead of the default trustdb. If &ParmFile; begins Use &ParmFile; instead of the default trustdb. If &ParmFile; begins
with a tilde and a slash, these are replaced by the HOME directory. If with a tilde and a slash, these are replaced by the $HOME
the filename does not contain a slash, it is assumed to be in the directory. If the filename does not contain a slash, it is assumed to
GnuPG home directory ("~/.gnupg" if --homedir is not used). be in the GnuPG home directory ("~/.gnupg" if --homedir or $GNUPGHOME
is not used).
</para></listitem></varlistentry> </para></listitem></varlistentry>
<varlistentry> <varlistentry>
<term>--homedir &ParmDir;</term> <term>--homedir &ParmDir;</term>
<listitem><para> <listitem><para>
Set the name of the home directory to &ParmDir; If this Set the name of the home directory to &ParmDir; If this option is not
option is not used it defaults to "~/.gnupg". It does used it defaults to "~/.gnupg". It does not make sense to use this in
not make sense to use this in a options file. This a options file. This also overrides the environment variable
also overrides the environment variable "GNUPGHOME". $GNUPGHOME.
</para></listitem></varlistentry> </para></listitem></varlistentry>
<varlistentry> <varlistentry>
<term>--charset &ParmName;</term> <term>--charset &ParmName;</term>
<listitem><para> <listitem><para>
Set the name of the native character set. This is used Set the name of the native character set. This is used to convert
to convert some strings to proper UTF-8 encoding. If this option is not used, the default character set is determined some strings to proper UTF-8 encoding. If this option is not used, the
from the current locale. A verbosity level of 3 shows the used one. default character set is determined from the current locale. A
Valid values for &ParmName; are:</para> verbosity level of 3 shows the used one. Valid values for &ParmName;
are:</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>iso-8859-1</term><listitem><para>This is the Latin 1 set.</para></listitem> <term>iso-8859-1</term><listitem><para>This is the Latin 1 set.</para></listitem>
@ -1473,17 +1475,16 @@ as well as when verifying a signature with a notation in it.
--no-show-notation disables this option. --no-show-notation disables this option.
</para></listitem></varlistentry> </para></listitem></varlistentry>
<varlistentry> <varlistentry>
<term>--sig-policy-url &ParmString;</term> <term>--sig-policy-url &ParmString;</term>
<term>--cert-policy-url &ParmString;</term> <term>--cert-policy-url &ParmString;</term>
<term>--set-policy-url &ParmString;</term> <term>--set-policy-url &ParmString;</term>
<listitem><para> <listitem><para>
Use &ParmString; as Policy URL for signatures (rfc2440:5.2.3.19). If Use &ParmString; as a Policy URL for signatures (rfc2440:5.2.3.19).
you prefix it with an exclamation mark (!), the policy URL packet will If you prefix it with an exclamation mark (!), the policy URL packet
be flagged as critical. --sig-policy-url sets a a policy url for data will be flagged as critical. --sig-policy-url sets a a policy url for
signatures. --cert-policy-url sets a policy url for key signatures data signatures. --cert-policy-url sets a policy url for key
(certifications). --set-policy-url sets both. signatures (certifications). --set-policy-url sets both.
</para><para> </para><para>
The same %-expandos used for notation data are available here as well. The same %-expandos used for notation data are available here as well.
</para></listitem></varlistentry> </para></listitem></varlistentry>
@ -2000,7 +2001,6 @@ Suppress the warning about "using insecure memory".
<varlistentry> <varlistentry>
<term>--no-permission-warning</term> <term>--no-permission-warning</term>
<listitem><para> <listitem><para>
Suppress the warning about unsafe file and home directory (--homedir) Suppress the warning about unsafe file and home directory (--homedir)
permissions. Note that the permission checks that GnuPG performs are permissions. Note that the permission checks that GnuPG performs are
not intended to be authoritative, but rather they simply warn about not intended to be authoritative, but rather they simply warn about
@ -2031,8 +2031,11 @@ Assume the input data is not in ASCII armored format.
<varlistentry> <varlistentry>
<term>--no-default-keyring</term> <term>--no-default-keyring</term>
<listitem><para> <listitem><para>
Do not add the default keyrings to the list of Do not add the default keyrings to the list of keyrings. Note that
keyrings. GnuPG will not operate 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 public or
secret keyrings.
</para></listitem></varlistentry> </para></listitem></varlistentry>
@ -2111,10 +2114,10 @@ This is not for normal use. Use the source to see for what it might be useful.
<varlistentry> <varlistentry>
<term>--emulate-md-encode-bug</term> <term>--emulate-md-encode-bug</term>
<listitem><para> <listitem><para>
GnuPG versions prior to 1.0.2 had a bug in the way a signature was encoded. GnuPG versions prior to 1.0.2 had a bug in the way a signature was
This options enables a workaround by checking faulty signatures again with encoded. This options enables a workaround by checking faulty
the encoding used in old versions. This may only happen for ElGamal signatures signatures again with the encoding used in old versions. This may
which are not widely used. only happen for Elgamal signatures which are not widely used.
</para></listitem></varlistentry> </para></listitem></varlistentry>
<varlistentry> <varlistentry>
@ -2361,10 +2364,10 @@ in front.
</variablelist> </variablelist>
<para> <para>
Note that you can append an exclamation mark (!) to key IDs or Note that you can append an exclamation point (!) to key IDs or
fingerprints. This flag tells GnuPG to use exactly the given primary fingerprints. This flag tells GnuPG to use the specified primary or
or secondary key and not to try to figure out which secondary or secondary key and not to try and calculate which primary or secondary
primary key to use. key to use.
</para> </para>
</refsect1> </refsect1>
@ -2555,22 +2558,23 @@ cannot be read by the intended recipient.
</para> </para>
<para> <para>
For example, as of this writing, no version of official PGP supports For example, as of this writing, no (unhacked) version of PGP supports
the BLOWFISH cipher algorithm. If you use it, no PGP user will be the BLOWFISH cipher algorithm. If you use it, no PGP user will be
able to decrypt your message. The same thing applies to the ZLIB able to decrypt your message. The same thing applies to the ZLIB
compression algorithm. By default, GnuPG uses the OpenPGP preferences compression algorithm. By default, GnuPG uses the standard OpenPGP
system that will always do the right thing and create messages that preferences system that will always do the right thing and create
are usable by all recipients, regardless of which OpenPGP program they messages that are usable by all recipients, regardless of which
use. Only override this safe default if you know what you are doing. OpenPGP program they use. Only override this safe default if you know
what you are doing.
</para> </para>
<para> <para>
If you absolutely must override the safe default, or if the If you absolutely must override the safe default, or if the
preferences on a given key are invalid for some reason, you are far preferences on a given key are invalid for some reason, you are far
better off using the --pgp2, --pgp6, --pgp7, or --pgp8 options. These better off using the --pgp6, --pgp7, or --pgp8 options. These options
options are safe as they do not force any particular algorithms in are safe as they do not force any particular algorithms in violation
violation of OpenPGP, but rather reduce the available algorithms to a of OpenPGP, but rather reduce the available algorithms to a "PGP-safe"
"PGP-safe" list. list.
</para> </para>
</refsect1> </refsect1>
@ -2580,10 +2584,11 @@ violation of OpenPGP, but rather reduce the available algorithms to a
<title>BUGS</title> <title>BUGS</title>
<para> <para>
On many systems this program should be installed as setuid(root). This On many systems this program should be installed as setuid(root). This
is necessary to lock memory pages. Locking memory pages prevents the is necessary to lock memory pages. Locking memory pages prevents the
operating system from writing memory pages to disk. If you get no operating system from writing memory pages (which may contain
passphrases or other sensitive material) to disk. If you get no
warning message about insecure memory your operating system supports warning message about insecure memory your operating system supports
locking without being root. The program drops root privileges as soon locking without being root. The program drops root privileges as soon
as locked memory is allocated. as locked memory is allocated.
</para> </para>
</refsect1> </refsect1>