Updating gnupg to version 2.2.0
[gpg4win.git] / doc / README.en.txt
index e4918d2..467d1cf 100644 (file)
                    English README file for Gpg4win
                    ===============================
 !BETA-WARNING!
-This is Gpg4win, version !VERSION!.
+This is Gpg4win, version !VERSION! (!BUILD_ISODATE!).
 
 Content:
 
      1. Important Notes
      2. Changes
      3. Known Bugs (and Workarounds)
-     4. Version History
-     5. Version Numbers of Included Software
-     6. Installer Options
+     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
 
-If you used an older version of Gpg4win in the past, please check
-out the migration hints in the Gpg4win Compendium's appendix.
+Please read the section "3. Known Bugs (and Workarounds)" of this
+README before you start working with Gpg4win.
 
-Please read the "Known bugs" section before you start working with
-Gpg4win.
+Gpg4win supports these platforms:
+
+  * 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
 ==========
 
-Gpg4win2 has major changes compared to Gpg4win 1.x.  Below is a list
-of the most important ones:
-
-- 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.
-
-- GpgEX is the new plugin for the Microsoft Explorer and replaces GpgEE.
-
-- The mail program Claws Mail has been updated to a modern version.
-  It now supports SSL, NNTP and IMAP.
-
-- 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.
-
-- 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.
-
-- Support of these platforms:
-  Operating System: Windows 2000, XP (32/64), Vista (32/64)
-  Outlook: 2003, 2007
-
-
-Short overview on changes compared to version 2.0.4:
-----------------------------------------------------
-[The following issue numbers reference to https://issues.kolab.org/.]
-
-- Kleopatra:
-  * Conflict dialog 
-    - Certificate selection dialog now works context-sensitive
-      (dependent on selecting sign, encrypt or sign/encrypt)
-      [kolab/issue4492]
-    - Conflicts redefined and implemented, fixed errors
-      [kolab/issue4197,4234]
-    - New configuration option for "quick mode" (Power-User-Mode) to
-      sign and encrypt
-      [kolab/issue4136])
-    - No protocol (OpenPGP or S/MIME) pre-selection dialog required -
-      replaced by new certificate selection dialog.
-      [kolab/issue4213,4235]
-  * (recursive) sign/encrypt of files and folders possible (see
-    GnuPG-Backend)
-  * Create/verify checksum by sha1sum, sha256sum, md5sum possible
-    (see GnuPG-Backend)
-  * Certificate lookup on certificate server
-    - Search for fingerprint or key-id shows new information dialog 
-      (some server requires 0x-Präfix in search string)
-      [kolab/issue4453]
-  * Certify OpenPGP certificates
-    - Fingerprint and key-id in step 1 added
-      [kolab/issue4468,4458]
-    - Key-id in step 2 added
-      [kolab/issue4460]
-  * Several minor and medium (GUI) improvements:
-    - Export of secret X.509 certificats use new default (utf8) for
-      passphrase charset
-      [kolab/issue4454]
-    - Import certificate without file type improved (content checker)
-      [kolab/issue4457]
-    - Fix certificate list in delete confirm dialog
-      [kolab/issue4459] 
-    - New context menu entry for deleting certificate added
-      [kolab/issue4450]
-    - OwnerTrust added to tooltips and certificate details
-      [kolab/issue4198]
-    - Unit (Bits) to the key strength fields in NewCertificateWizard's
-      overview page added
-      [kolab/issue4183]
-    - E-Mail-Validator allows to delete '@' Zeichen
-      [kolab/issue4189]
-    - Trust/distrust root certificates via context menu
-      (write directly $GNUPGHOME\trustlist.txt)
-      [kolab/issue4190]
-    - For developer: KDebugDialog available (installed with Kleopatra,
-      run $INSTDIR\kdebugdialog.exe)
-      [kolab/issue4318]
-    - Hierarchical certificate list: toggling (regression)
-      [kolab/issue4327]
-    - Fixed exception for decrypt/verify special S/MIME e-mail
-      [kolab/issue4179]
-  * SmartCard 
-    - Detecting smartcard: Kleopatra's systemtray icon blinks after
-      inserting X.509 card. Click starts learn card command or opens
-      nullpin dialog.
-      [kolab/issue4191]
-    - Learn card commands suppress gpgsm error dialogs.
-      [kolab/issue4126]
-  * Miscellaneous
-    - Gpg4win credits added (see 'About Gpg4win' dialog)
-    - German translations fixed
-    - Several minor and medium issues and errors were fixed
-
-- GpgOL:
-  * Portuguese translation added
-  * updated to new libassuan2 interface and libgpg-error 1.9
-
-- GpgEX
-  * (recursive) sign/encrypt of files and folders possible (see
-    GnuPG-Backend)
-  * Create/verify checksum by sha1sum, sha256sum, md5sum possible
-    (see GnuPG-Backend)
-  * Portuguese translation added
-  * Updated to libgpg-error 1.9
-
-- Pinentry:
-  * Change default: switch to QT4
-    (GTK still enabled for gpg4win-light installer)
-    [kolab/issue4378]
-  * Fixed German translation for 'Cancel' cancel
-    [kolab/issue4132]
-
-- GnuPG-Backend:
-  * NEW: (recursive) sign/encrypt of files and folders possible
-    [kolab/issue4298,4299,4300] 
-  * NEW: Create/verify checksum by sha1sum, sha256sum, md5sum
-    possible via GpgEX
-    [kolab/issue41634,294,4295,4296,4297,4321]
-  * Updated to new libassuan v2 interface
-  * Several minor and medium improvements of stability
-    [u.a.: kolab/issue4212] 
-
-- Installer:
-  * NEW: English language version of the Gpg4win Compendium
-    (v3.0.0-beta1) added. Old novices manual removed.
-  * Installer was signed with a CodeSigning certificate of GlobalSign
-    (Publisher: "Intevation GmbH")
-  * Portuguese translation added
-
-- Included Gpg4win components are:
-    GnuPG:          2.0.16
-    Kleopatra:      2.1.0-svn1167864 (2010-08-11)
-    GPA:            0.9.0
-    GpgOL:          1.1.2
-    GpgEX:          0.9.7
-    Claws-Mail:     3.7.6
-    Kompendium DE:  3.0.0
-    Kompendium EN:  3.0.0-beta1
-
-
-3. Known Bugs (and Workarounds)
-===============================
-
-- Using smart card with Kleopatra
-
-   The initial setting of smart cards with Kleopatra is currently not
-   yet possible. Please run the following steps one-time to use your
-   smart card with Kleopatra.
-
-   * OpenPGP card
-     Use the gpg command line tool to create a new OpenPGP certificate
-     on your card (a) or to activate your existing certificate of
-     your card (b):
-
-     (a) Create new certificate
-       - Insert card.
-       - Run "gpg --card-edit".
-       - Switch to admin modus by enter: "admin".
-       - Enter "generate" to create a new certificate.
-
-     (b) Activate existing certificate of your card
-       - Import associated (public) certificate of your card (e.g.
-         from certificate server or from a exported certificate file).
-       - Insert card.
-       - Run "gpg --card-status".
-
-   * X.509 Telesec Netkey 3 card
-     Use Kleopatra to initializing your card:
-     - Insert card.
-     - Click at the Kleopatra systemtray icon (or use the context menu of
-       the systemtray icon and run the learn card command).
-
-   After finishing these steps your OpenPGP / X.509 certificate
-   from your smart card is shown in Kleopatra under the tab
-   "My certificates" (marked with a smart card icon).
-
-   A better smart card support for Kleopatra is in process.
-
-- Using the Outlook Plugin "GpgOL":
+Included Gpg4win components in Version !VERSION! are:
+
+!COMPONENTS!
+
+
+New in Gpg4win Version !VERSION! (!BUILD_ISODATE!)
+-----------------------------------------
+
+- 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
+
+  * For 3.0 we plan to offer a quick switch to a more automatic mode that
+    will set the gnupg options:
+
+        auto-key-locate wkd
+        auto-key-retrieve
+        trust-model tofu+pgp
+
+    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.
+
+- 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, e.g. in the form of PST files.
+    emails before installing GpgOL, e.g. in the form of PST files.
 
-  * Sending signed or encrypted messages via an Exchange based account
+  * 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.)
 
-  * Outlook2007 crashes after opening attachments of an encrypted message
-    [see https://bugs.g10code.com/gnupg/issue1110]
-
-  * Encrypted E-Mails occuring un-encrypted on the email server: It
+  * 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.
-    A solution is being worked on.
+    Or use GpgOL with Outlook 2010/2013.
 
-- Using GpgEX with Windows x64:
 
-   * In some cases sign/encrypt or decrypt/verify via GpgEX doesn't work 
-     correctly (Kleopatra freezed). Then you should kill Kleopatra via 
-     task manager and run the file crypto operation directly in Kleopatra
-     (see file menu).
+4. Installation
+===============
 
-   * Problems with Windows x64:
-     GpgEX is a (32bit) plugin for the (32bit) Windows
-     Explorer and it does _not_ run in a 64bit Explorer
-     (= default for a Windows 64bit system).
+For installation instructions please read the new Gpg4win Compendium:
+http://www.gpg4win.org/doc/en/gpg4win-compendium_11.html
 
-     Workaround: Run the 32bit Explorer to use GpgEX.
-     Click "Start" -> "Run", type the following in the box, and then
-     click OK:
-         C:\windows\syswow64\explorer.exe /separate
-     Note: Adjust the path to your x64-based version of Windows if
-     necessary. 
-     This separate command seems to be currently broken in Win7/64bit.
+Hints for automated installations (without user dialogs):
+http://www.gpg4win.org/doc/en/gpg4win-compendium_35.html
 
 
-4. Version History
+5. Version History
 ==================
 
-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 .
+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!
 
 
-5. Version Numbers of Included Software
+6. Version Numbers of Included Software
 =======================================
 
 !VERSIONINFO!
 
 
-
-6. 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_claws_mail = false
-  inst_compendium_de = true
-  inst_man_novice_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 = Gpg4win
-
-  ; 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.
-
-
 7. Legal notices pertaining to the individual packets
 =====================================================
 
@@ -365,4 +227,5 @@ Happy GiPiGing,
 
   Your Gpg4win Team
 
+
 ***end of file ***