/[winpt]/trunk/README
ViewVC logotype

Diff of /trunk/README

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 218 by twoaday, Wed May 24 07:53:24 2006 UTC revision 282 by twoaday, Mon Jan 15 22:11:52 2007 UTC
# Line 1  Line 1 
1                          WinPT - The Windows Privacy Tray                          WinPT - The Windows Privacy Tray
2                            ================================
3    
4    
5  Index  Bugs and Improvements
6       1. Note  ---------------------
      2. Bugs and improvements  
      2.1 Legacy Windows versions  
      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.3 Keyserver  
      13.3.1 Keyserver searching  
      13.3.2 Proxy support  
     14. Debug mode  
     16. Features of the dialogs  
     16. Features of the dialogs  
   
   
 1. Note  
 ---------  
   
 This is only a quick guide for WinPT. For the moment the program is its own  
 documentation. This is subject to change.  
   
   
 2. Bugs and improvements  
 ------------------------  
7    
8  I have tried to thoroughly test this program, but if you've found a bug,  I have tried to thoroughly test this program, but if you've found a bug,
9  please send me a message with a full error description or go directly  please send me a message with a full error description or go directly
# Line 52  version, and GPG version in use. Please Line 14  version, and GPG version in use. Please
14  and describe any special programs or configurations on your machine.  and describe any special programs or configurations on your machine.
15    
16  I try to fix bugs as quickly as possible and will upload all updates to  I try to fix bugs as quickly as possible and will upload all updates to
17  http://www.winpt.org  http://wald.intevation.org/projects/winpt
18    
19    
20  2.1 Legacy Windows versions  Legacy Windows versions
21    -----------------------
22    
23  I know a lot of people still user old versions of WinPT but it is very  I know a lot of people still user old versions of WinPT but it is very
24  hard to test the code on all these platforms and thus I decided to  hard to test the code on all these platforms and thus I decided to
25  obsolete the support for these OS versions: Win95, WinME/98. The code  obsolete the support for these OS versions: Win95, WinME/98. The code
26  works on 98/ME without known limitations but if you will encounter  works on 98/ME without known limitations but if you will encounter
27  a serious problem, I doubt I can fix it without having this OS and  a serious problem, I doubt I can fix it without having this OS and
28  this is the major problem!  this is the major problem! It is likewise with older NT based systems
29    like NT4 and, with each new year, Win2K.
30    
31    
32  3. What is WinPT?  What is WinPT?
33  -----------------  --------------
34    
35  WinPT is a front-end for the GNU Privacy Guard. It just provides  WinPT is a front-end for the GNU Privacy Guard. It just provides
36  a convinient interface to GPG while GPG does the actual (cryptographic) work.  a convinient interface to GPG while GPG does the actual (cryptographic) work.
# Line 86  an universal e-mail plugin. Together wit Line 50  an universal e-mail plugin. Together wit
50  it's like a real graphical GPG user interface.  it's like a real graphical GPG user interface.
51    
52    
53  4. Install  Install
54  ----------  -------
55    
56  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.
57  (If you want to use a directory other than the default you must modify  (If you want to use a directory other than the default you must modify
58  the preferences in the WinPT program at Preferences->GPG Preferences).  the preferences in the WinPT program at Preferences->GPG Preferences).
59    
60  Next, download the WinPT binary package from the Internet. You can find the  Next, download the WinPT binary package from the Internet. You can find the
61  latest WinPT version at http://www.winpt.org. Create a directory and  latest WinPT version at http://wald.intevation.org/projects/winpt.
62  extract all WinPT files from the archive.  Create a directory and extract all WinPT files from the archive.
63    
64    
65  4.1 Keyserver config file  Keyserver Config File
66  -------------------------  ---------------------
67    
68  Now the keyserver config is read dynamically. That means there is a file  Now the keyserver config is read dynamically. That means there is a file
69  which WinPT reads the keyserver from. The name of this file MUST be  which WinPT reads the keyserver from. The name of this file MUST be
# Line 112  But it is recommend that you modify the Line 76  But it is recommend that you modify the
76  dialog in WinPT to keep this file consistent.  dialog in WinPT to keep this file consistent.
77    
78    
79  5. Verify the packet signature  Verify the Packet Signature
80  ------------------------------  ---------------------------
81    
82  To verify that the source (or the binary) wasn't changed, you should  To verify that the source (or the binary) wasn't changed, you should
83  verify the package signature with GnuPG. For the process you will need  verify the package signature with GnuPG. For the process you will need
84  my OpenPGP public key. If you don't have it, please take a look at  my OpenPGP public key. If you don't have it, please take a look at
85  http://www.winpt.org/twoaday.asc  http://www.stud.uni-hannover.de/~twoaday/twoaday.asc or fetch it
86    via a keyserver (I suggest subkeys.pgp.net).
87    
88  # gpg --verify winpt-x.x.x-exe.zip.asc  # gpg --verify winpt-x.x.x-exe.zip.asc
89  # gpg --verify winpt-x.x.x-src.zip.asc  # gpg --verify winpt-x.x.x-src.zip.asc
# Line 130  My key ID is 0xBF3DF9B4: 'Timo Schulz <t Line 95  My key ID is 0xBF3DF9B4: 'Timo Schulz <t
95               0x27F36D14: 'Timo Schulz (Laptop Key) <[email protected]>               0x27F36D14: 'Timo Schulz (Laptop Key) <[email protected]>
96    
97    
98  6. Native language support  Native Language Support (NLS)
99  --------------------------  -----------------------------
100    
101  As a new feature WinPT now can handle multiple languages. To activate this  As a new feature WinPT now can handle multiple languages. To activate this
102  do the following:  do the following:
# Line 149  do the following: Line 114  do the following:
114    
115  - Now WinPT runs in the language you have selected.  - Now WinPT runs in the language you have selected.
116    
117  For the moment, WinPT supports these languages:  For an overview what languages are supported take a look at
118    Po/LINGUAS. It contains all actively maintained languages.
     * German winpt-de.mo  
     * Japanese winpt-jp.mo  
119    
120  If you are interested in translating WinPT in your native language, please  If you are interested in translating WinPT in your native language, please
121  let me know :-). It's not much work and you do NOT need to be a developer!  let me know :-). It's not much work and you do NOT need to be a developer!
122    
123    
124  7. Other documentation  Other Documentation
125  ----------------------  -------------------
126    
127  For those who are inexperienced with GnuPG it makes sense to download the  For those who are inexperienced with GnuPG it makes sense to download the
128  GnuPG guide or a HOWTO. There are many sites for this, but you can start  GnuPG guide or a HOWTO. There are many sites for this, but you can start
# Line 170  working with GnuPG more effective. Line 133  working with GnuPG more effective.
133  http://www.gnupg.org  http://www.gnupg.org
134    
135  General questions (look first at the topic point), can be sent to one of the  General questions (look first at the topic point), can be sent to one of the
136  mailing lists. All GnuPG lists are in English.  mailing lists.
137    
138  GPG user list [email protected]  GPG user list [email protected]
139  GPG developer list [email protected]  GPG developer list [email protected]
# Line 179  At the moment the only available documen Line 142  At the moment the only available documen
142  future releases I will include HTML documentation.  future releases I will include HTML documentation.
143    
144    
145  8. Mailing lists  Mailing Lists
146  ----------------  -------------
147    
148  If you want to get the latest information, reports, or discussions about  If you want to get the latest information, reports, or discussions about
149  WinPT you can subscribe to one of the WinPT mailing lists. There is a list  WinPT you can subscribe to one of the WinPT mailing lists. There is a list
# Line 192  the README files and the list archives. Line 155  the README files and the list archives.
155  is already answered there!  is already answered there!
156    
157    
158  9. Hotkey for common commands  Hotkey for Common Commands
159  -----------------------------  --------------------------
160    
161  WinPT supports shortcuts, or 'Hotkeys', for the main gpg commands.  These  WinPT supports shortcuts, or 'Hotkeys', for the main gpg commands.  These
162  keys are registered system wide, so you can use them from any window. If you  keys are registered system wide, so you can use them from any window. If you
# Line 212  some of the hotkeys. WinPT will tell you Line 175  some of the hotkeys. WinPT will tell you
175  so it's easier to figure out which hotkey caused the problem.  so it's easier to figure out which hotkey caused the problem.
176    
177    
178  10. Current window support  Current Window Support
179  --------------------------  ----------------------
180    
181  WinPT allows you to use the main operations (sign and encrypt)  WinPT allows you to use the main operations (sign and encrypt)
182  within the current window. This only works if the current window contains  within the current window. This only works if the current window contains
# Line 234  Please note, that the mode doesn't work Line 197  Please note, that the mode doesn't work
197  entry. I recommend to use it with the hotkeys until I fix this problem.  entry. I recommend to use it with the hotkeys until I fix this problem.
198    
199    
200  11. Word wrapping  Word Wrapping
201  -----------------  -------------
202    
203  As a new feature, WinPT can wrap lines at a specific column. You can set  As a new feature, WinPT can wrap lines at a specific column. You can set
204  the value for this feature in the preferences dialog. If you don't want  the value for this feature in the preferences dialog. If you don't want
205  to use this feature, you only need to set the value to "0".  to use this feature, you only need to set the value to "0".
206    
207    
208  12. Default keyid for signing  Default keyid for Signing
209  ----------------------------  -------------------------
210    
211  There are two ways to set the default keyid. The best solution is to  There are two ways to set the default keyid. The best solution is to
212  set the "default-key" entry in the GPG options file.  set the "default-key" entry in the GPG options file.
# Line 252  key. If no default key was found, WinPT Line 215  key. If no default key was found, WinPT
215  the secret key cache.  the secret key cache.
216    
217    
218  13. Commands  File Manager
219  ------------  ------------
220    
   
 13.1 Filemanager  
 ----------------  
   
221  The filemanager is used to perform GPG operations on files. In further releases  The filemanager is used to perform GPG operations on files. In further releases
222  I'll add more commands. Currently, encrypt, decrypt, sign and verify  I'll add more commands. Currently, encrypt, decrypt, sign and verify
223  is available. To add a file to the list element, you can use drag & drop  is available. To add a file to the list element, you can use drag & drop
# Line 269  fairly stable. It possible that some par Line 228  fairly stable. It possible that some par
228  feel free to mail me about any bugs!  feel free to mail me about any bugs!
229    
230    
231  13.2 Keymanager  Proxy Support
 ---------------  
   
 13.2.1 Edit  
 -----------  
   
 Here you access some of the "edit-key" command from the GPG command  
 line.  
   
   
 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.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  
232  --------------  --------------
233    
 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  
 --------------------  
   
234  If you are not able to connect directly to the internet, you can  If you are not able to connect directly to the internet, you can
235  use the proxy settings. To enable proxy support, you need to start  use the proxy settings. To enable proxy support, you need to start
236  the keyserver dialog and use the "change" button to set a proxy.  the keyserver dialog and use the "change" button to set a proxy.
# Line 339  also possible that it does *not* work wi Line 243  also possible that it does *not* work wi
243  me if you've problems with your proxy server.  me if you've problems with your proxy server.
244    
245    
246  14. Debug mode  Debug Mode
247  --------------  ----------
248    
249  To make the detection of bugs and programming mistakes easier, WinPT  To make the detection of bugs and programming mistakes easier, WinPT
250  contains a built-in debug mode.  contains a built-in debug mode.
# Line 356  large, so do NOT forget to compress it. Line 260  large, so do NOT forget to compress it.
260  After an error has occured, it would be very useful to send this file to me.  After an error has occured, it would be very useful to send this file to me.
261  Which file you'll send depends on the occured error. Don't use the debug  Which file you'll send depends on the occured error. Don't use the debug
262  mode for your usual work; it slows down both GPG and WinPT.  mode for your usual work; it slows down both GPG and WinPT.
   
   
 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.  
   

Legend:
Removed from v.218  
changed lines
  Added in v.282

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26