Updating gnupg to version 2.2.0
[gpg4win.git] / doc / README.en.txt
index de6db66..467d1cf 100644 (file)
 ;; README.en.txt                               -*- coding: latin-1; -*-
-;; This is the README installed with gpg4win.  with a ; in the first
+;; This is the README installed with Gpg4win. Lines with a ; in the first
 ;; column are considered a comment and not included in the actually
 ;; installed version.  Certain keywords are replaced by the Makefile;
 ;; those words are enclosed by exclamation marks.
 
-                   English README file for Gpg4Win
+                   English README file for Gpg4win
                    ===============================
-
-This is GnuPG for Windows, vesion !VERSION!.
+!BETA-WARNING!
+This is Gpg4win, version !VERSION! (!BUILD_ISODATE!).
 
 Content:
 
-     1. Important notes
+     1. Important Notes
      2. Changes
-     3. Version numbers 
-     4. Installer options
-     5. Legal notices 
-
-
+     3. Known Bugs (and Workarounds)
+     4. Installation
+     5. Version History
+     6. Version Numbers of Included Software
+     7. Legal Notices
 
 
 1. Important Notes
 ==================
 
-Manuals describing the installation of Gpg4Win are currently only
-available in German.  Check out http://www/gpg4win.org for latest
-news.
+The Gpg4win Compendium describes the installation and use of Gpg4win.
+After installation it is available in the Gpg4win start menu or online:
+http://www.gpg4win.org/doc/en/gpg4win-compendium.html
 
+Please read the section "3. Known Bugs (and Workarounds)" of this
+README before you start working with Gpg4win.
 
+Gpg4win supports these platforms:
 
+  * Operating System: Windows XP and later Versions (for all: 32/64 bit)
 
-2. Record of Changes (NEWS file)
-================================
+  * MS Outlook: 2003, 2007, 2010, 2013, 2016 (2010 and later also in 64bit)
 
-An up-to-date list of changes is also available at
-http://www.gpg4win.de/change-history.html .  Below you find the raw
-NEWS file:
 
-!NEWSFILE!
+2. Changes
+==========
 
+Included Gpg4win components in Version !VERSION! are:
 
+!COMPONENTS!
 
 
-3. Version Numbers of Included Software
-=======================================
+New in Gpg4win Version !VERSION! (!BUILD_ISODATE!)
+-----------------------------------------
 
-!VERSIONINFO!
+- GnuPG is now of the modern 2.1 variant. See:
+  https://www.gnupg.org/faq/whats-new-in-2.1.html
+  for more information about this.
+
+- GpgOL is now also supported for 64bit Outlook.
+
+- GpgOL for Outlook 2010 and later now uses toggle buttons
+  to let you select Encypt and Sign. The operations are done
+  when the mail is sent, including all attachments,
+  using a standard format (MIME).
+
+- GpgOL for Outlook 2010 and later now automatically decrypts mails
+  again.
+
+- All 68 KDE translations for Kleopatra are now included in Gpg4win.
+
+- Kleopatra uses an updated icon theme.
+
+- Kleopatra now shows the used curve in for ECC keys under technical
+  details.
+
+- Kleopatra has been updated to a new set of base libraries.
+
+- Binaries are now all installed in a bin subdirectory. DBus
+  and kbuildsycoa are no longer required. This fixes the startup issues
+  of Kleopatra some users were facing.
+
+- After importing a secret key in Kleopatra you will be asked to directly
+  mark it as your own key. (Ownertrust)
+
+- Kleopatra now allows you to create ECC keys in the Advanced Settings
+  during Key generation.
+
+- Kleopatras file menu now also offers to encrypt Folders.
+
+- Kleopatra has a new option to print a secret key through the paperkey tool.
+
+- GPA and Kleopatra are now registred for OpenPGP and S/MIME related file extensions.
+
+- The file encryption dialog in Kleopatra has been redesigned to reduce steps and
+  improve user experience.
+
+- Kleopatra automatically detects the type of an input file and automatically starts
+  the corresponding action (e.g. decrypt).
+
+- Symmetric (password only) encryption is now accessible through Kleopatra and can
+  be combined with public-key encryption.
+
+- Pinentry now enables you to inspect the typed passphrase.
+
+- Kleopatra now supports OpenPGP Smartcards management.
+
+- GpgOL for Outlook 2010 and later has a new interface to show
+  the signature / encryption state inside of Outlook.
+
+- GnuPG now supports https and uses the https sks-keyserver pool
+  by default.
+
+- GpgOL now supports sending and receiving HTML Mails
+
+- Kleopatra now supports to directly import missing certificates
+  when verifying a file.
+
+- Kleopatra has improved file verification messages.
 
+- Many bugfixes and minor improvements.
 
 
+3. Additional Notes
+===================
+- General
 
-4. Installer Options
-====================
+  * For 3.0 we plan to offer a quick switch to a more automatic mode that
+    will set the gnupg options:
 
-The default installation path can be speficied with the /D=PATH
-option, which must be last on the command line.  The installer
-supports the options /S for unattended installation, and the option
-/C=INIFILE to specify an .ini file which should contain exactly one
-section "[gpg4win]" which may specify absolute file paths to
-configuration files that should be preinstalled.  Here is an example
-file which shows all possible keys:
+        auto-key-locate wkd
+        auto-key-retrieve
+        trust-model tofu+pgp
 
-[gpg4win]
-  gpg.conf = D:\config\gpg-site.conf
-  gpg-agent.conf = D:\config\gpg-agent-site.conf
-  trustlist.txt = D:\config\trustlist-site.txt
-  dirmngr.conf = D:\config\dirmngr-site.conf
-  dirmngr_ldapserver.conf = D:\config\dirmngr_ldapserver-site.conf
-  scdaemon.conf = D:\config\scdaemon-site.txt
-  gpa.conf = D:\config\gpa-site.conf
+    As this is not properly handled everywhere (especially Kleopatra's
+    file verification dialog) this is not yet default or easily accessible.
 
+    You can add it manually to your gpg.conf. The trust-model is fully
+    supported by GpgOL.
 
+- Kleopatra
 
+  * Netkey cards are not yet supported by the new Manage Smartcard view.
 
-5. Legal notices pertaining to the individual packets
+- GpgOL
+
+  * It is not possible to modify mails (e.g. moving / flagging the mail)
+    while they are shown decrypted.
+    To workaround this unselect the crypto mail and then make changes
+    through the right click context menu or move it with drag and drop.
+
+  * Crypto mails forwarded as attachment are not properly handled.
+
+  * The certificate selection dialog sometimes opens in the background and
+    needs an overhaul.
+
+  * Localization is incomplete
+
+
+- GpgOL for Outlook 2003 and 2007 (deprecated):
+
+  Outlook 2003 and 2007 support is deprecated and may be removed in a
+  future version.
+
+  * You defintely should create copies of your old encrypted/signed
+    emails before installing GpgOL, e.g. in the form of PST files.
+
+  * For Outlook 2003/2007 only:
+    Sending signed or encrypted messages via an Exchange based account
+    does not yet work.
+    [see https://bugs.g10code.com/gnupg/issue1102]
+    (Please note, using SMTP with GpgOL and Exchange seems to be work.
+    Or use GpgOL with Outlook 2010 or later.)
+
+  * For Outlook 2003/2007 only:
+    Encrypted E-Mails occuring un-encrypted on the email server: It
+    can happen that parts of encrypted emails are copied to your email
+    server (IMAP or MAPI) in un-encrypted/decrypted form when creating
+    or viewing them.  Affected is the content of the email view
+    window, thus usually the so-called email body.  Attachments are
+    not affected.  Switching off the Outlook preview will lower the
+    probability of this to happen, but not eliminate the issue.
+    Or use GpgOL with Outlook 2010/2013.
+
+
+4. Installation
+===============
+
+For installation instructions please read the new Gpg4win Compendium:
+http://www.gpg4win.org/doc/en/gpg4win-compendium_11.html
+
+Hints for automated installations (without user dialogs):
+http://www.gpg4win.org/doc/en/gpg4win-compendium_35.html
+
+
+5. Version History
+==================
+
+Listed below are the changes as recorded in the source distribution's
+NEWS file. An up-to-date list of changes is also available at:
+http://www.gpg4win.org/change-history.html
+
+!NEWSFILE!
+
+
+6. Version Numbers of Included Software
+=======================================
+
+!VERSIONINFO!
+
+
+7. Legal notices pertaining to the individual packets
 =====================================================
 
 Gpg4win consist of several independent developed packages, available
@@ -94,6 +225,7 @@ What follows is a list of copyright statements.
 
 Happy GiPiGing,
 
-  Your Gpg4Win Team
+  Your Gpg4win Team
+
 
 ***end of file ***