/[winpt]/trunk/README

Diff of /trunk/README

Parent Directory | Revision Log | View Patch Patch

-revision 180 by twoaday,
Mon Mar  6 14:41:58 2006 UTC
+revision 282 by twoaday,
Mon Jan 15 22:11:52 2007 UTC
 Line 1
-                         The Windows Privacy Tray
+                         WinPT - The Windows Privacy Tray
+                         ================================
- Index
+ Bugs and Improvements
-. Notice
+ ---------------------
-. Bugs and improvements
-. What is WinPT?
-. Install
-.1 Keyserver config file
-. Verify the packet signature
-. Native language support
-. Other documentation
-. Mailing lists
-. Hotkeys for common commands
-. Current window support
-. Word wrapping
-. Default key for signing
-. Commands
-.1 File manager
-.2 Key manager
-.2.1 Edit
-.2.2 UserID
-.2.3 Delete
-.2.4 Sign
-.2.5 Revoke cert
-.2.6 Check sigs
-.3 Keyserver
-.3.1 Keyserver searching
-.3.2 Proxy support
-. Debug mode
-. Features of the dialogs
-. Features of the dialogs
-. Notice
- ---------
- This is only a quick guide for WinPT. For the moment the program is its own
- documentation. This is subject to change.
-. Bugs and improvements
- ------------------------
- I have tried to thoroughly debug this program, but if you've found a bug,
+ I have tried to thoroughly test this program, but if you've found a bug,
  please send me a message with a full error description or go directly
  to http://wald.intevation.org and use the WinPT bug tracking system.
-Line 51 
 version, and GPG version in use. Please
+Line 14 
 version, and GPG version in use. Please
  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
+ http://wald.intevation.org/projects/winpt
+ Legacy Windows versions
+ -----------------------
-. What is WinPT?
+ I know a lot of people still user old versions of WinPT but it is very
- -----------------
+ hard to test the code on all these platforms and thus I decided to
+ obsolete the support for these OS versions: Win95, WinME/98. The code
+ works on 98/ME without known limitations but if you will encounter
+ a serious problem, I doubt I can fix it without having this OS and
+ this is the major problem! It is likewise with older NT based systems
+ like NT4 and, with each new year, Win2K.
+ What is WinPT?
+ --------------
  WinPT is a front-end for the GNU Privacy Guard. It just provides
  a convinient interface to GPG while GPG does the actual (cryptographic) work.
  GnuPG was written by Werner Koch and is Free Software. GnuPG contains all
- of the functions WinPT uses for data encrypting and e-signatures and
+ of the functions WinPT uses for data encrypting, 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
+ wouldn't work! Currently not all GnuPG functions are supported. With
- all the new features, WinPT is more then just an universal e-mail plugin.
+ all its key edit functions and file operations, WinPT is more than just
- Together with the filemanager and the keymanager, it's like a real GUI.
+ an universal e-mail plugin. Together with the filemanager and the keymanager,
+ it's like a real graphical GPG user interface.
-. Install
+ Install
- ----------
+ -------
- First you should install the GPG binary (Version 1.4.x or later.)
+ First you should install the GPG binary, version 1.4.x or later.
  (If you want to use a directory other than the default you must modify
- the preferences in the WinPT program at Preferences->GPG Prefs.
+ the preferences in the WinPT program at Preferences->GPG Preferences).
  Next, download the WinPT binary package from the Internet. You can find the
- latest WinPT version at http://www.winpt.org. Create a directory and
+ latest WinPT version at http://wald.intevation.org/projects/winpt.
- extract all WinPT releated files.
+ Create a directory and extract all WinPT files from the archive.
-.1 Keyserver config file
+ 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
-Line 96 
 keyservers. Of course it's possible to a
+Line 72 
 keyservers. Of course it's possible to a
  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.
+ But it is recommend that you modify the file directly with the keyserver
+ dialog in WinPT to keep this file consistent.
-. Verify the packet signature
+ 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
+ http://www.stud.uni-hannover.de/~twoaday/twoaday.asc or fetch it
+ via a keyserver (I suggest subkeys.pgp.net).
  # gpg --verify winpt-x.x.x-exe.zip.asc
  # gpg --verify winpt-x.x.x-src.zip.asc
-Line 116 
 My key ID is 0xBF3DF9B4: 'Timo Schulz <t
+Line 95 
 My key ID is 0xBF3DF9B4: 'Timo Schulz <t
 x27F36D14: 'Timo Schulz (Laptop Key) <[email protected]>
-. Native language support
+ Native Language Support (NLS)
- --------------------------
+ -----------------------------
  As a new feature WinPT now can handle multiple languages. To activate this
  do the following:
-Line 135 
 do the following:
+Line 114 
 do the following:
  - Now WinPT runs in the language you have selected.
- For the moment, WinPT supports these languages:
+ For an overview what languages are supported take a look at
+ Po/LINGUAS. It contains all actively maintained languages.
-     * German winpt-de.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!
-. Other documentation
+ 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
-Line 155 
 working with GnuPG more effective.
+Line 133 
 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.
+ mailing lists.
- GPG User list (English) [email protected]
+ GPG user list [email protected]
- GPG Developer list (English) [email protected]
+ GPG developer list [email protected]
  At the moment the only available documentation for WinPT is this file. In
  future releases I will include HTML documentation.
-. Mailing lists
+ 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. All lists are in English! To subscribe
  visit http://wald.intevation.org and go to the WinPT project site.
- Please, before you send a message to the list take a look at the FAQ
+ 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
+ the README files and the list archives. It's possible that your question
- there!
+ is already answered there!
-. Hotkey for common commands
+ 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
-Line 197 
 some of the hotkeys. WinPT will tell you
+Line 175 
 some of the hotkeys. WinPT will tell you
  so it's easier to figure out which hotkey caused the problem.
-. Current window support
+ 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
+ simple edit field. There are some kind of windows that are NOT
- yet!
+ supported.
  The easiest way to access this feature is using the hotkeys. Note: if
  you use this feature the text will automatically be cut, encrypted
-Line 219 
 Please note, that the mode doesn't work
+Line 197 
 Please note, that the mode doesn't work
  entry. I recommend to use it with the hotkeys until I fix this problem.
-. Word wrapping
+ 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".
-. Default keyid for signing
+ 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.
- The second solution is to let WinPT figure out it from the secret key cache,
+ The second solution is that you use the Key Manager to set a default
- the first key in this cache is the default keyid. Warning, with this method
+ key. If no default key was found, WinPT uses the first useable key in
- it's possible that another keyid is chosen (because of the order in
+ the secret key cache.
- which the keyring was read!).
-. Commands
+ File Manager
  ------------
-.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
-Line 255 
 fairly stable. It possible that some par
+Line 228 
 fairly stable. It possible that some par
  feel free to mail me about any bugs!
-.2 Keymanager
+ Proxy Support
- ---------------
-.2.1 Edit
- -----------
- Here you access some of the "edit-key" command from the GPG command
- line.
-.2.2 UserID
- -------------
- Gives you an overview about all user id's from a public key. The validity
- of each is also listed.
-.2.3 Delete
- -------------
- With it you can delete public keys and/or key pairs.
-.2.4 Sign
- -----------
- This is an interface to sign a public key.
-.2.5 Revoke cert
- ------------------
- Generate a revocation certificate for the chosen key.
-.2.7 Check sigs
- -----------------
- With this command you can check the signatures from a special public key.
-.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.
-.3 Keyserver
  --------------
-.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.
-.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 the proxy settings. To enable proxy support, you need to start
- "use_proxy=xx.xx.xx.xx:port" to your keyserver.conf. Then restart
+ the keyserver dialog and use the "change" button to set a proxy.
- WinPT. Now the keyserver code uses the proxy instead of the direct
+ Now the keyserver code uses the proxy instead of the direct connection.
- connection.
  If your proxy needs some kind of authentification, you can use
  "proxy_user" and "proxy_pass". Then for each request the data
-Line 333 
 also possible that it does *not* work wi
+Line 243 
 also possible that it does *not* work wi
  me if you've problems with your proxy server.
-. Debug mode
+ Debug Mode
- --------------
+ ----------
  To make the detection of bugs and programming mistakes easier, WinPT
  contains a built-in debug mode.
-Line 350 
 large, so do NOT forget to compress it.
+Line 260 
 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.
-. 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.

 Legend:



Removed from v.180
 


changed lines


 
Added in v.282
 Legend:



Removed from v.180
 


changed lines


 
Added in v.282
-Removed from v.180
+Added in v.282

[email protected]	ViewVC Help
Powered by ViewVC 1.1.26