/[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 246 by twoaday, Tue Jul 11 08:55:57 2006 UTC
# Line 1  Line 1 
1                          WinPT - The Windows Privacy Tray                          WinPT - The Windows Privacy Tray
2    
3    
4  Index  Note
5       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  
 ---------  
6    
7  This is only a quick guide for WinPT. For the moment the program is its own  This is only a quick guide for WinPT. For the moment the program is its own
8  documentation. This is subject to change.  documentation. This is subject to change.
9    
10    
11  2. Bugs and improvements  Bugs and Improvements
12  ------------------------  ---------------------
13    
14  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,
15  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 55  I try to fix bugs as quickly as possible Line 23  I try to fix bugs as quickly as possible
23  http://www.winpt.org  http://www.winpt.org
24    
25    
26  2.1 Legacy Windows versions  Legacy Windows versions
27    
28  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
29  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
# Line 65  a serious problem, I doubt I can fix it Line 33  a serious problem, I doubt I can fix it
33  this is the major problem!  this is the major problem!
34    
35    
36  3. What is WinPT?  What is WinPT?
37  -----------------  --------------
38    
39  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
40  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 54  an universal e-mail plugin. Together wit
54  it's like a real graphical GPG user interface.  it's like a real graphical GPG user interface.
55    
56    
57  4. Install  Install
58  ----------  -------
59    
60  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.
61  (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
# Line 98  latest WinPT version at http://www.winpt Line 66  latest WinPT version at http://www.winpt
66  extract all WinPT files from the archive.  extract all WinPT files from the archive.
67    
68    
69  4.1 Keyserver config file  Keyserver Config File
70  -------------------------  ---------------------
71    
72  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
73  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 80  But it is recommend that you modify the
80  dialog in WinPT to keep this file consistent.  dialog in WinPT to keep this file consistent.
81    
82    
83  5. Verify the packet signature  Verify the Packet Signature
84  ------------------------------  ---------------------------
85    
86  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
87  verify the package signature with GnuPG. For the process you will need  verify the package signature with GnuPG. For the process you will need
# Line 130  My key ID is 0xBF3DF9B4: 'Timo Schulz <t Line 98  My key ID is 0xBF3DF9B4: 'Timo Schulz <t
98               0x27F36D14: 'Timo Schulz (Laptop Key) <[email protected]>               0x27F36D14: 'Timo Schulz (Laptop Key) <[email protected]>
99    
100    
101  6. Native language support  Native Language Support (NLS)
102  --------------------------  -----------------------------
103    
104  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
105  do the following:  do the following:
# Line 158  If you are interested in translating Win Line 126  If you are interested in translating Win
126  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!
127    
128    
129  7. Other documentation  Other Documentation
130  ----------------------  -------------------
131    
132  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
133  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 179  At the moment the only available documen Line 147  At the moment the only available documen
147  future releases I will include HTML documentation.  future releases I will include HTML documentation.
148    
149    
150  8. Mailing lists  Mailing Lists
151  ----------------  -------------
152    
153  If you want to get the latest information, reports, or discussions about  If you want to get the latest information, reports, or discussions about
154  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 160  the README files and the list archives.
160  is already answered there!  is already answered there!
161    
162    
163  9. Hotkey for common commands  Hotkey for Common Commands
164  -----------------------------  --------------------------
165    
166  WinPT supports shortcuts, or 'Hotkeys', for the main gpg commands.  These  WinPT supports shortcuts, or 'Hotkeys', for the main gpg commands.  These
167  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 180  some of the hotkeys. WinPT will tell you
180  so it's easier to figure out which hotkey caused the problem.  so it's easier to figure out which hotkey caused the problem.
181    
182    
183  10. Current window support  Current Window Support
184  --------------------------  ----------------------
185    
186  WinPT allows you to use the main operations (sign and encrypt)  WinPT allows you to use the main operations (sign and encrypt)
187  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 202  Please note, that the mode doesn't work
202  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.
203    
204    
205  11. Word wrapping  Word Wrapping
206  -----------------  -------------
207    
208  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
209  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
210  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".
211    
212    
213  12. Default keyid for signing  Default keyid for Signing
214  ----------------------------  -------------------------
215    
216  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
217  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 220  key. If no default key was found, WinPT
220  the secret key cache.  the secret key cache.
221    
222    
223  13. Commands  File Manager
224  ------------  ------------
225    
   
 13.1 Filemanager  
 ----------------  
   
226  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
227  I'll add more commands. Currently, encrypt, decrypt, sign and verify  I'll add more commands. Currently, encrypt, decrypt, sign and verify
228  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 233  fairly stable. It possible that some par
233  feel free to mail me about any bugs!  feel free to mail me about any bugs!
234    
235    
236  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  
237  --------------  --------------
238    
 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  
 --------------------  
   
239  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
240  use the proxy settings. To enable proxy support, you need to start  use the proxy settings. To enable proxy support, you need to start
241  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 248  also possible that it does *not* work wi
248  me if you've problems with your proxy server.  me if you've problems with your proxy server.
249    
250    
251  14. Debug mode  Debug Mode
252  --------------  ----------
253    
254  To make the detection of bugs and programming mistakes easier, WinPT  To make the detection of bugs and programming mistakes easier, WinPT
255  contains a built-in debug mode.  contains a built-in debug mode.
# Line 356  large, so do NOT forget to compress it. Line 265  large, so do NOT forget to compress it.
265  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.
266  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
267  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.246
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26