gpg: Print the keygrip with --card-status
[gnupg.git] / README
diff --git a/README b/README
index aaf347c..d46efd9 100644 (file)
--- a/README
+++ b/README
@@ -1,9 +1,9 @@
                        The GNU Privacy Guard 2
                       =========================
-                             Version 2.1
+                             Version 2.2
 
-          Copyright 1997-2017 Werner Koch
-          Copyright 1998-2017 Free Software Foundation, Inc.
+          Copyright 1997-2018 Werner Koch
+          Copyright 1998-2018 Free Software Foundation, Inc.
 
 
 * INTRODUCTION
   GNU General Public License.
 
   Note that the 2.0 series of GnuPG will reach end-of-life on
-  2017-12-31.  It is not possible to install a 2.1.x version along
-  with any 2.0.x version.  However, it is possible to install GnuPG
-  1.4 along with a 2.x version.
+  2017-12-31.  It is not possible to install a 2.2.x version along
+  with any 2.0.x version.
 
 
 * BUILD INSTRUCTIONS
 
-  GnuPG 2.1 depends on the following GnuPG related packages:
+  GnuPG 2.2 depends on the following GnuPG related packages:
 
-    npth         (ftp://ftp.gnupg.org/gcrypt/npth/)
-    libgpg-error (ftp://ftp.gnupg.org/gcrypt/libgpg-error/)
-    libgcrypt    (ftp://ftp.gnupg.org/gcrypt/libgcrypt/)
-    libksba      (ftp://ftp.gnupg.org/gcrypt/libksba/)
-    libassuan    (ftp://ftp.gnupg.org/gcrypt/libassuan/)
+    npth         (https://gnupg.org/ftp/gcrypt/npth/)
+    libgpg-error (https://gnupg.org/ftp/gcrypt/libgpg-error/)
+    libgcrypt    (https://gnupg.org/ftp/gcrypt/libgcrypt/)
+    libksba      (https://gnupg.org/ftp/gcrypt/libksba/)
+    libassuan    (https://gnupg.org/ftp/gcrypt/libassuan/)
 
   You should get the latest versions of course, the GnuPG configure
   script complains if a version is not sufficient.
@@ -49,7 +48,7 @@
 
   You also need the Pinentry package for most functions of GnuPG;
   however it is not a build requirement.  Pinentry is available at
-  ftp://ftp.gnupg.org/gcrypt/pinentry/ .
+  https://gnupg.org/ftp/gcrypt/pinentry/ .
 
   After building and installing the above packages in the order as
   given above, you may continue with GnuPG installation (you may also
 
     ./configure
     make
+    make check
     make install
 
-  (Before doing install you might need to become root.)
+  The "make check" is optional but highly recommended.  To run even
+  more tests you may add "--enable-all-tests" to the configure run.
+  Before running the "make install" you might need to become root.
 
   If everything succeeds, you have a working GnuPG with support for
   OpenPGP, S/MIME, ssh-agent, and smartcards.  Note that there is no
   Add other options as needed.
 
 
-* MIGRATION from 1.4 or 2.0 to 2.1
+* MIGRATION from 1.4 or 2.0 to 2.2
 
-  The major change in 2.1 is gpg-agent taking care of the OpenPGP
+  The major change in 2.2 is gpg-agent taking care of the OpenPGP
   secret keys (those managed by GPG).  The former file "secring.gpg"
   will not be used anymore.  Newly generated keys are stored in the
   agent's key store directory "~/.gnupg/private-keys-v1.d/".  The
 
   Note that gpg-agent now uses a fixed socket.  All tools will start
   the gpg-agent as needed.  The formerly used environment variable
-  GPG_AGENT_INFO is ignored by 2.1.  The SSH_AUTH_SOCK environment
+  GPG_AGENT_INFO is ignored by 2.2.  The SSH_AUTH_SOCK environment
   variable should be set to a fixed value.
 
   The Dirmngr is now part of GnuPG proper and also used to access
   use of the GnuPG directories.  Dirmngr is started by gpg or gpgsm as
   needed. There is no more need to install a separate Dirmngr package.
 
+  All changes introduced with GnuPG 2.2 have been developed in the 2.1
+  series of releases.  See the respective entries in the file NEWS.
+
 * RECOMMENDATIONS
 
 ** Socket directory
   is at [[https://gnupg.org/documentation/manuals/gnupg-devel/]] .
 
 
-* GnuPG 1.4 and GnuPG 2.0
+* Installing GnuPG 2.2. and GnuPG 1.4
 
-  GnuPG 2.0 is a newer version of GnuPG with additional support for
-  S/MIME.  It has a different design philosophy that splits
-  functionality up into several modules.  Both versions may be
-  installed simultaneously without any conflict (gpg is called gpg2 in
-  GnuPG 2).  In fact, the gpg version from GnuPG 1.4 is able to make
-  use of the gpg-agent as included in GnuPG 2 and allows for seamless
-  passphrase caching.  The advantage of GnuPG 1.4 is its smaller size
-  and no dependency on other modules at run and build time.
+  GnuPG 2.2 is a current version of GnuPG with state of the art
+  security design and many more features.  To install both versions
+  alongside, it is suggested to rename the 1.4 version of "gpg" to
+  "gpg1" as well as the corresponding man page.  Newer releases of the
+  1.4 branch will likely do this by default.  In case this is not
+  possible, the 2.2 version can be installed under the name "gpg2"
+  using the configure option --enable-gpg-is-gpg2.
 
 
 * HOW TO GET MORE INFORMATION
 
-  A description of new features and changes in version 2.1 can be
+  A description of new features and changes since version 2.1 can be
   found in the file "doc/whats-new-in-2.1.txt" and online at
   "https://gnupg.org/faq/whats-new-in-2.1.html" .
 
-  The primary WWW page is "https://www.gnupg.org"
+  The primary WWW page is "https://gnupg.org"
              or using Tor "http://ic6au7wa3f6naxjq.onion"
-  The primary FTP site is "ftp://ftp.gnupg.org/gcrypt/"
+  The primary FTP site is "https://gnupg.org/ftp/gcrypt/"
 
   See [[https://gnupg.org/download/mirrors.html]] for a list of
   mirrors and use them if possible.  You may also find GnuPG mirrored
   You subscribe to one of the list by sending mail with a subject of
   "subscribe" to x-request@gnupg.org, where x is the name of the
   mailing list (gnupg-announce, gnupg-users, etc.). See
-  https://www.gnupg.org/documentation/mailing-lists.html for archives
+  https://gnupg.org/documentation/mailing-lists.html for archives
   of the mailing lists.
 
-  Please direct bug reports to [[http://bugs.gnupg.org]] or post them
+  Please direct bug reports to [[https://bugs.gnupg.org]] or post them
   direct to the mailing list <gnupg-devel@gnupg.org>.
 
   Please direct questions about GnuPG to the users mailing list or one
   authors and we try to answer questions when time allows us.
 
   Commercial grade support for GnuPG is available; for a listing of
-  offers see https://www.gnupg.org/service.html .  Maintaining and
+  offers see https://gnupg.org/service.html .  Maintaining and
   improving GnuPG requires a lot of time.  Since 2001, g10 Code GmbH,
   a German company owned and headed by GnuPG's principal author Werner
   Koch, is bearing the majority of these costs.  To keep GnuPG in a