Updating gnupg to version 2.2.0
[gpg4win.git] / doc / README.en.txt
index 62d9903..467d1cf 100644 (file)
 
                    English README file for Gpg4win
                    ===============================
-
-This is GnuPG for Windows, version !VERSION!.
+!BETA-WARNING!
+This is Gpg4win, version !VERSION! (!BUILD_ISODATE!).
 
 Content:
 
-     1. Important notes
+     1. Important Notes
      2. Changes
-     3. Known bugs
-     4. Version numbers
-     5. Installer options
-     6. 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:
 
-If you used an older version of Gpg4win in the past, please check
-out the migration hints in the Gpg4win Compendium's appendix.
+  * Operating System: Windows XP and later Versions (for all: 32/64 bit)
+
+  * MS Outlook: 2003, 2007, 2010, 2013, 2016 (2010 and later also in 64bit)
 
 
 2. Changes
 ==========
 
-Gpg4win/2 has major changes compared to Gpg4win 1.x. Below is a list
-of the most important ones:
+Included Gpg4win components in Version !VERSION! are:
 
-- Kleopatra is the new certificate manager.  Kleopatra is the S/MIME
-  certificate manager of KDE (a desktop environment used on many
-  GNU/Linux systems). For use in Gpg4win it has been extended to
-  support OpenPGP and to act as a graphical user interface for all
-  cryptographic operations. It is automatically started if another
-  component requests its services and then runs permanently in your
-  system tray. WinPT has been dropped.
+!COMPONENTS!
 
-- GpgEX is the new plugin for the Explorer and replaces GpgEE.
 
-- The mail program Claws Mail has been updated to a modern version.
-  It now supports SSL, NNTP and IMAP.
+New in Gpg4win Version !VERSION! (!BUILD_ISODATE!)
+-----------------------------------------
 
-- GpgOL, the plugin for Outlook 2003 and 2007 has been comprehensively
-  updated. It now supports PGP/MIME and thus makes the use of
-  encrypted or signed attachments much easier and standard conform.
-  Support for S/MIME has been added. Most dialogs are now provided by
-  Kleopatra for graphical user dialogs.
+- 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.
 
-- The German "Gpg4win-Kompendium" is the new documentation for Gpg4win.
-  This combines the previous "Einsteiger" and "Durchblicker" manuals.
-  All chapters were reworked and extended to describe the new Gpg4win
-  Version 2.0. Among other things, this means adaption to Kleopatra,
-  GpgEX and PGP/MIME and new texts for S/MIME and X.509.
+- 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).
 
-2.1 Version history
--------------------
+- GpgOL for Outlook 2010 and later now automatically decrypts mails
+  again.
 
-Find below 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.de/change-history.html .
+- All 68 KDE translations for Kleopatra are now included in Gpg4win.
 
-!NEWSFILE!
+- 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.
 
-3. Known Bugs
-=============
+- Many bugfixes and minor improvements.
 
-  * Kleopatra is still under development: Some functionalities for
-    OpenPGP are still missing. You can use GPA for the missing
-    functionality.
 
-- Using smart card with Kleopatra...
+3. Additional Notes
+===================
+- General
 
-   * ... and OpenPGP card:
-     Use the gpg command line tool to create a new OpenPGP certificate
-     on your card.
-     Run "gpg --card-edit".
-     Switch to admin modus by enter: "admin".
-     Run "generate" to create a new certificate.
-     After finishing the process your new certificate is shown in
-     Kleopatra with a smart card icon.
+  * For 3.0 we plan to offer a quick switch to a more automatic mode that
+    will set the gnupg options:
 
-   * ... and Telesec Netkey 3 card:
-     Use the gpgsm command line tool to initializing your card.
-     Insert your card.
-     Run "gpgsm --learn-card".
-     After this the certificates from your card are shown in
-     Kleopatra with a smart card icon.
+        auto-key-locate wkd
+        auto-key-retrieve
+        trust-model tofu+pgp
 
-   A good (graphical) alternative for setting up your smart
-   card and changing PIN is GPA.
+    As this is not properly handled everywhere (especially Kleopatra's
+    file verification dialog) this is not yet default or easily accessible.
 
-- Using the Outlook Plugin "GpgOL":
+    You can add it manually to your gpg.conf. The trust-model is fully
+    supported by GpgOL.
 
-  * You defintely should create copies of your old
-    encrypted/signed emails, e.g. in the form of PST files.
+- Kleopatra
 
-  * Encrypted E-Mails occuring un-encrypted on the email server:
-    It can happens 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 windows, 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.
-    A solution is being worked on.
+  * Netkey cards are not yet supported by the new Manage Smartcard view.
 
-  * Sending signed or encrypted maessages via an Exchange based
-    account doesn't work.
+- 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.
 
-4. Version Numbers of Included Software
+  * 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!
 
 
-
-5. Installer 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]".  This section contains various installer settings
-and absolute file paths to configuration files that should be
-preinstalled.  Most options just set a different default value.
-Excetions are documented below.  Here is an example file which shows
-all possible keys:
-
-[gpg4win]
-  ; Installer settings.  Do not define or leave empty for defaults.
-  inst_gpgol = true
-  inst_gpgex = true
-  inst_kleopatra = true
-  inst_gpa = true
-  inst_scute = true
-  inst_claws_mail = false
-  inst_compendium_de = true
-  inst_novice_manual_en = true
-  inst_novice_manual_de = true
-  inst_advanced_manual_de = true
-  inst_advanced_manual_en = true
-
-  ; Where to install short-cuts.
-  inst_start_menu = true
-  inst_desktop = false
-  inst_quick_launch_bar = false
-
-  ; Contrary to other settings in this file, the start menu folder
-  ; setting here will override the user selection at installation
-  ; time.
-  inst_start_menu_folder = GnuPG for Windows
-
-  ; Additional configuration files to install.
-  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
-
-An example command for unattended installation could look like this:
-
-gpg4win.exe /S /C=C:\TEMP\gpg4win.ini /D=D:\Programme\Gpg4win
-
-For the MSI installer, the above also holds, with the following
-changes: Unattended installation is achieved as usual with the /qb-
-option to msiexec.  The control file must be called gpg4win.ini and
-reside in the system directory (C:\WINDOWS).  It is found
-automatically by the installer.  The installation directory can be
-specified with an entry for "instdir".  Also, each entry can be given
-in uppercase at the command line through INSTDIR=... and
-INST_GPA=FALSE etc. (the control file takes precedence, though).  The
-default config files as well as start menu directory and optional
-installation of short cuts are currently not supported through the MSI
-installer.
-
-
-6. Legal notices pertaining to the individual packets
+7. Legal notices pertaining to the individual packets
 =====================================================
 
 Gpg4win consist of several independent developed packages, available
@@ -213,4 +227,5 @@ Happy GiPiGing,
 
   Your Gpg4win Team
 
+
 ***end of file ***