/[winpt]/trunk/README
ViewVC logotype

Diff of /trunk/README

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

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