                        The Windows Privacy Tray
                             Version 0.5.5

Index
     1. Notice
     2. Bugs and improvements
     3. What is WinPT?
     4. Install
      4.1 Keyserver config file
     5. Verify the packet signature
     6. Native language support
     7. Other documentation
     8. Mailing lists
     9. Hotkeys for common commands
    10. Current window support
    11. Word wrapping
    12. Default key for signing
    13. Commands
     13.1 File manager
     13.2 Key manager
      13.2.1 Edit
      13.2.2 UserID
      13.2.3 Delete
      13.2.4 Sign
      13.2.5 Revoke cert
      13.2.6 Check sigs
      13.2.7 List trust path
    13.3 Keyserver
     13.3.1 Keyserver searching
     13.3.2 Proxy support
    14. Debug mode
    15. Agent support
    16. Features of the dialogs
    16. Features of the dialogs


1. Notice
---------

This is only a quick guide for WinPT. For the moment the program is its own
documentation. This is subject to change. Please note, this text needs many
improvements, because English isn't my native lanuage ;-(. Please feel free
to send me spelling corrections.


2. Bugs and improvements
------------------------

I have tried to thoroughly debug this program, but if you've found a bug,
please send me a message with a full error description!

Please include as much detail as possible including OS version, WinPT
version, and GPG version in use. Please summarize your gpg configuration
and describe any special programs or configurations on your machine. 

I try to fix bugs as quickly as possible and will upload all updates to
http://www.winpt.org


3. What is WinPT?
-----------------

WinPT is a tool to protect your privacy! Because I'm NOT a crypto expert,
I use another program, the GNU Privacy Guard for the cryptographic
functionality.

GnuPG was written by Werner Koch and is GNU Open Source. GnuPG contains all
of the functions WinPT uses for data encrypting and e-signatures and
key management.
 
WinPT is a Windows utility that sits on the taskbar. In the Windows
Clipboard, you can encrypt, sign, decrypt and verify data. You can also
import and export keys to the Clipboard.

Practically, WinPT is a taskbar front-end for GnuPG. Without GnuPG, WinPT
doesn't work! Currently not all GnuPG functions are supported. Because of
all the new features, WinPT is more then just an universal e-mail plugin.
Together with the filemanager and the keymanager, it's like a real GUI.


4. Install
----------

First you should install the GPG binary into C:\GNUPG (Version 1.0.5 or
later.) (If you want to use a directory other than C:\GNUPG you must modify
the preferences in the WinPT program at Preferences->GPG Prefs.


** GPG 1.0.5 is needed for WinPT but because of the security problem
   with this version, it's recommend to use 1.0.6! **

Next, download the WinPT binary package from the Internet. You can find the
latest WinPT version at http://www.winpt.org/download.html. Create a
directory and extract all WinPT releated files.


With the 0.5.0 version of WinPT, all modules are now integrated in
the main package. So you don't need the wipe-ext.dll or the ldap-ext.dll!


4.1 Keyserver config file
-------------------------

Now the keyserver config is read dynamically. That means there is a file
which WinPT reads the keyserver from. The name of this file MUST be
"keyserver.conf". I added a sample config file with the most common
keyservers. Of course it's possible to add own entries. Take a look
at the hints inside the file how to format the entries. If there no file,
the format can be described like this: 'DNS-Name=IP-Address'. Each line
of the file contains such an entry.


5. Verify the packet signature
------------------------------

To verify that the source (or the binary) wasn't changed, you should
verify the package signature with GnuPG. For the process you will need
my OpenPGP public key. If you don't have it, please take a look at
http://www.winpt.org/twoaday.asc

# gpg --verify WinPT-x.x.x-exe.zip.asc
# gpg --verify WinPT-x.x.x-src.zip.asc

gpg should output that the signature was correct and that the signature
was created by me.

My key ID is 0xBF3DF9B4: 'Timo Schulz <ts@winpt.org>'.


6. Native language support
--------------------------

As a new feature WinPT now can handle multiple languages. To activate this
do the following:

- Create a directory where you want to store the locale files
  (the .mo files)

- Rename your favourite .mo file to winpt.mo

- Put all .mo files into this directory
  (For example the gnupg.mo and the winpt.mo)

- Start WinPT and choose the menu entry 'Preferences->GPG Prefs'.
  Set your locale directory to the directory containing winpt.mo.

- Now WinPT runs in the language you have selected.

For the moment, WinPT supports these languages:

    * Italian winpt-it.mo
    * French winpt-fr.mo
    * German winpt-de.mo
    * Spanish winpt-es.mo
    * Russian winpt-ru.mo
    * Portuguese (Brazilian) winpt-pt_BR.mo
    * Portuguese winpt-pt_PT.mo
    * Hungarian winpt-hu.mo
    * Chinese winpt-zh_CN.mo
    * Czech winpt-ch.mo

If you are interested in translating WinPT in your native language, please
let me know :-). It's not much work and you do NOT need to be a developer!


7. Other documentation
----------------------

For those who are inexperienced with GnuPG it makes sense to download the
GnuPG guide or a HOWTO. There are many sites for this, but you can start
with the GnuPG site. This site is available in many languages. I prefer
the GNU Privacy Handbook. It contains background information that makes
working with GnuPG more effective.

http://www.gnupg.org

General questions (look first at the topic point), can be sent to one of the
mailing lists. All GnuPG lists are in English.

PGP User list (German) pgp-friends-de@egroups.com
GPG User list (English) gnupg-users@gnupg.org
GPG Developer list (English) gnupg-devel@gnupg.org

At the moment the only available documentation for WinPT is this file. In
future releases I will include HTML documentation.


8. Mailing lists
----------------

If you want to get the latest information, reports, or discussions about
WinPT you can subscribe to one of the WinPT mailing lists. There is a list
for users and one for developers. Both lists are in English! To subscribe
send a message to 'majordomo@lcsweb.net' with "subscribe listname" in the
body.

Example: subscribe winpt-name_of_thelist

winpt-dev@lcsweb.net    - The developer list
winpt-users@lcsweb.net  - The users list

Please, before you send a message to the list take a look at the FAQ
or the README files. It's possible that your question is already answered
there!


9. Hotkey for common commands
-----------------------------

WinPT supports shortcuts, or 'Hotkeys', for the main gpg commands.  These
keys are registered system wide, so you can use them from any window. If you
have some problems with this keys, you can change the hotkeys in the
preferences dialog.

Encrypt Clipboard        CTRL+ALT+e
Sign & Encrypt		 CTRL+ALT+b
Decrypt/verify Clipboard CTRL+ALT+d
Sign Clipboard           CTRL+ALT+s
Export Clipboard         CTRL+ALT+x
Import Clipboard         CTRL+ALT+i

In the event of an error, it's possible that another program already uses
some of the hotkeys. WinPT will tell you which hotkey wasn't installed properly
so it's easier to figure out which hotkey caused the problem.


10. Current window support
--------------------------

WinPT allows you to use the main operations (sign and encrypt)
within the current window. This only works if the current window contains
text. For example, a mailer window with the message, a text editor or a
simple edit field. There are some kind of windows that are NOT supported
yet!

The easiest way to access this feature is using the hotkeys. Note: if
you use this feature the text will automatically be cut, encrypted
and pasted again in the window. You don't need to do anything manually.

Encrypt current window         ALT+SHIFT+e
Decrypt/verify current window  ALT+SHIFT+d
Sign current window            ALT+SHIFT+s

Alternately you can use the WinPT menu for the current window support.
Please note, that the mode doesn't work very well if you use the menu
entry. I recommend to use it with the hotkeys until I fix this problem.


11. Word wrapping
-----------------

As a new feature, WinPT can wrap lines at a specific column. You can set
the value for this feature in the preferences dialog. If you don't want
to use this feature, you only need to set the value to "0".


12.Default keyid for signing
----------------------------

There are two ways to set the default keyid. The best solution is to
set the "default-key" entry in the GPG options file. Alternative you can
also use "encrypt-to" for the default keyid.
The second solution is to let WinPT figure out it from the secret key cache,
the first key in this cache is the default keyid. Warning, with this method
it's possible that another keyid is chosen (because of the order in which the keyring
was read!).


13. Commands
------------


13.1 Filemanager
----------------

The filemanager is used to perform GPG operations on files. In further releases
I'll add more commands. Currently, encrypt, decrypt, sign and verify
is available. To add a file to the list element, you can use drag & drop
or use the 'Open' menu entry, like Windows Explorer.

Please note that this code is under heavy development, but is should be
fairly stable. It possible that some parts don't work as expected, but
feel free to mail me about any bugs!


13.2 Keymanager
---------------

13.2.1 Edit
-----------

Here you access some of the "edit-key" command from the GPG command
line.


13.2.2 UserID
-------------

Gives you an overview about all user id's from a public key. The validity
of each is also listed.


13.2.3 Delete
-------------

With it you can delete public keys and/or key pairs.


13.2.4 Sign
-----------

This is an interface to sign a public key.


13.2.5 Revoke cert
------------------

Generate a revocation certificate for the chosen key.


13.2.6 List trust path
----------------------

TODO.


13.2.7 Check sigs
-----------------

With this command you can check the signatures from a special public key.


13.2.7 Key properties
---------------------

This dialog is an easy way to get an overview about the given key.
To activate this dialog, you've to double click on a key item in the
key management dialog. Then a dialog with all related information about
the selected key will open.


13.3 Keyserver
--------------

13.3.1 Keyserver searching
--------------------------

This new feature works exactly like the normal keyserver support.
You have to enter the pattern, then chose a keyserver. The command
is started with the "Search" button. The next dialog contains all
found keys from the keyserver. If you want, you can import a key
from this list by select the key and press the "Receive" button.

13.3.2 Proxy support
--------------------

If you are not able to connect directly to the internet, you can
use the proxy settings. To enable proxy support, you need to add
"use_proxy=xx.xx.xx.xx:port" to your keyserver.conf. Then restart
WinPT. Now the keyserver code uses the proxy instead of the direct
connection.

If your proxy needs some kind of authentification, you can use
"proxy_user" and "proxy_pass". Then for each request the data
is used. The code was tested with some HTTP/WWW proxies but it's
also possible that it does *not* work with some proxies! Please tell
me if you've problems with your proxy server.


14. Debug mode
--------------

To make the detection of bugs and programming mistakes easier, WinPT
contains a built-in debug mode.

It can be activated with the '--enable-debug'
switch on the command line. Then the WinPT output is more verbose and all
steps are logged a in a file with the name "gpgme.dbg". This file is stored
in the current directory and ONLY contains GPG related information. If you
think it is a WinPT problem, you can find a debug file in c:\windows\temp.
The name of this file is "winpt.log". It's possible that this file is very
large, so do NOT forget to compress it.

After an error has occured, it would be very useful to send this file to me.
Which file you'll send depends on the occured error. Don't use the debug
mode for your usual work; it slows down both GPG and WinPT.


15. Agent support
-----------------

To use the Windows GPG Agent, you must start the process BEFORE running
WinPT. When there was no error, WinPT runs in a passphrase-less mode. All
passphrase requests are send to the client. As a result the sign and
sign & encrypt dialogs contain NO passphrase items! To force WinPT to use
the internal passphrase routines, you can use the "--no-agent" option on
the command line.


16. Features of the dialogs
----------------------------

This sections contains hints about the special features of some dialogs.
Currently this is only valid for dialog with listview controls.

o Selection of an entry for the GPG main commands

If you only want to select one recipient, you can also double click
the line which the recipient you want to choose. Then the command
is automatically invoked and you don't need to click the "OK" button.

o Context menu for the key manager

Now the keymanager supports a context menu. To activate it, you should
click with the right mouse button on a selected item.

o Generic keys known from the Explorer

For example the key manager supports generic keys like:
DELETE = secure the selected key.

o Context menu for the file manager

This popup menu is similar to the key manager menu.

