/[winpt]/trunk/README
ViewVC logotype

Annotation of /trunk/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 345 - (hide annotations)
Sun Nov 27 15:14:26 2011 UTC (13 years, 3 months ago) by twoaday
File size: 9522 byte(s)


1 twoaday 187 WinPT - The Windows Privacy Tray
2 twoaday 326 =================================
3 twoaday 50
4 twoaday 180
5 twoaday 246 Bugs and Improvements
6     ---------------------
7 twoaday 50
8 twoaday 345 Because of the long phase of inactivity, it is very likely that the
9     current code has problems with a recent GnuPG and Windows version. You
10     can find an (outdated) tracker at <http://wald.intevation.org>.
11 twoaday 50
12     Please include as much detail as possible including OS version, WinPT
13 twoaday 345 version, and GPG version in use. Please also summarize your gpg configuration
14 twoaday 50 and describe any special programs or configurations on your machine.
15    
16 twoaday 345 Update and new releases will be available at:
17     <http://wald.intevation.org/projects/winpt>
18 twoaday 50
19    
20 twoaday 246 Legacy Windows versions
21 twoaday 282 -----------------------
22 twoaday 218
23 twoaday 345 WinPT requires at least Windows XP or higher. Currently, the support
24     for Windows 7 is limited and we do not give any support for Vista.
25 twoaday 218
26    
27 twoaday 246 What is WinPT?
28     --------------
29 twoaday 50
30 twoaday 180 WinPT is a front-end for the GNU Privacy Guard. It just provides
31     a convinient interface to GPG while GPG does the actual (cryptographic) work.
32 twoaday 50
33 twoaday 180 GnuPG was written by Werner Koch and is Free Software. GnuPG contains all
34 twoaday 184 of the functions WinPT uses for data encrypting, e-signatures and
35 twoaday 50 key management.
36 twoaday 184
37 twoaday 50 WinPT is a Windows utility that sits on the taskbar. In the Windows
38     Clipboard, you can encrypt, sign, decrypt and verify data. You can also
39     import and export keys to the Clipboard.
40    
41     Practically, WinPT is a taskbar front-end for GnuPG. Without GnuPG, WinPT
42 twoaday 184 wouldn't work! Currently not all GnuPG functions are supported. With
43     all its key edit functions and file operations, WinPT is more than just
44     an universal e-mail plugin. Together with the filemanager and the keymanager,
45     it's like a real graphical GPG user interface.
46 twoaday 50
47    
48 twoaday 246 Install
49     -------
50 twoaday 50
51 twoaday 345 First you should install the GPG binary, version 1.4.11 or later.
52 twoaday 180 (If you want to use a directory other than the default you must modify
53 twoaday 184 the preferences in the WinPT program at Preferences->GPG Preferences).
54 twoaday 50
55     Next, download the WinPT binary package from the Internet. You can find the
56 twoaday 271 latest WinPT version at http://wald.intevation.org/projects/winpt.
57     Create a directory and extract all WinPT files from the archive.
58 twoaday 50
59    
60 twoaday 246 Keyserver Config File
61     ---------------------
62 twoaday 50
63     Now the keyserver config is read dynamically. That means there is a file
64     which WinPT reads the keyserver from. The name of this file MUST be
65     "keyserver.conf". I added a sample config file with the most common
66     keyservers. Of course it's possible to add own entries. Take a look
67     at the hints inside the file how to format the entries. If there no file,
68     the format can be described like this: 'DNS-Name=IP-Address'. Each line
69     of the file contains such an entry.
70 twoaday 184 But it is recommend that you modify the file directly with the keyserver
71     dialog in WinPT to keep this file consistent.
72 twoaday 50
73    
74 twoaday 246 Verify the Packet Signature
75     ---------------------------
76 twoaday 50
77     To verify that the source (or the binary) wasn't changed, you should
78     verify the package signature with GnuPG. For the process you will need
79     my OpenPGP public key. If you don't have it, please take a look at
80 twoaday 282 http://www.stud.uni-hannover.de/~twoaday/twoaday.asc or fetch it
81     via a keyserver (I suggest subkeys.pgp.net).
82 twoaday 50
83 twoaday 180 # gpg --verify winpt-x.x.x-exe.zip.asc
84     # gpg --verify winpt-x.x.x-src.zip.asc
85 twoaday 50
86     gpg should output that the signature was correct and that the signature
87     was created by me.
88    
89 twoaday 180 My key ID is 0xBF3DF9B4: 'Timo Schulz <[email protected]>' or
90     0x27F36D14: 'Timo Schulz (Laptop Key) <[email protected]>
91 twoaday 50
92    
93 twoaday 246 Native Language Support (NLS)
94     -----------------------------
95 twoaday 50
96     As a new feature WinPT now can handle multiple languages. To activate this
97     do the following:
98    
99     - Create a directory where you want to store the locale files
100     (the .mo files)
101    
102     - Rename your favourite .mo file to winpt.mo
103    
104     - Put all .mo files into this directory
105     (For example the gnupg.mo and the winpt.mo)
106    
107     - Start WinPT and choose the menu entry 'Preferences->GPG Prefs'.
108     Set your locale directory to the directory containing winpt.mo.
109    
110     - Now WinPT runs in the language you have selected.
111    
112 twoaday 282 For an overview what languages are supported take a look at
113     Po/LINGUAS. It contains all actively maintained languages.
114 twoaday 50
115     If you are interested in translating WinPT in your native language, please
116     let me know :-). It's not much work and you do NOT need to be a developer!
117    
118    
119 twoaday 246 Other Documentation
120     -------------------
121 twoaday 50
122     For those who are inexperienced with GnuPG it makes sense to download the
123     GnuPG guide or a HOWTO. There are many sites for this, but you can start
124     with the GnuPG site. This site is available in many languages. I prefer
125     the GNU Privacy Handbook. It contains background information that makes
126     working with GnuPG more effective.
127    
128     http://www.gnupg.org
129    
130     General questions (look first at the topic point), can be sent to one of the
131 twoaday 282 mailing lists.
132 twoaday 50
133 twoaday 184 GPG user list [email protected]
134     GPG developer list [email protected]
135 twoaday 50
136     At the moment the only available documentation for WinPT is this file. In
137     future releases I will include HTML documentation.
138    
139    
140 twoaday 246 Mailing Lists
141     -------------
142 twoaday 50
143     If you want to get the latest information, reports, or discussions about
144     WinPT you can subscribe to one of the WinPT mailing lists. There is a list
145 twoaday 180 for users and one for developers. All lists are in English! To subscribe
146     visit http://wald.intevation.org and go to the WinPT project site.
147 twoaday 50
148 twoaday 184 Please, before you send a message to the list take a look at the FAQ,
149     the README files and the list archives. It's possible that your question
150     is already answered there!
151 twoaday 50
152    
153 twoaday 246 Hotkey for Common Commands
154     --------------------------
155 twoaday 50
156     WinPT supports shortcuts, or 'Hotkeys', for the main gpg commands. These
157     keys are registered system wide, so you can use them from any window. If you
158     have some problems with this keys, you can change the hotkeys in the
159     preferences dialog.
160    
161     Encrypt Clipboard CTRL+ALT+e
162     Sign & Encrypt CTRL+ALT+b
163     Decrypt/verify Clipboard CTRL+ALT+d
164     Sign Clipboard CTRL+ALT+s
165     Export Clipboard CTRL+ALT+x
166     Import Clipboard CTRL+ALT+i
167    
168 twoaday 180 In case of an error, it's possible that another program already uses
169 twoaday 50 some of the hotkeys. WinPT will tell you which hotkey wasn't installed properly
170     so it's easier to figure out which hotkey caused the problem.
171    
172    
173 twoaday 246 Current Window Support
174     ----------------------
175 twoaday 50
176     WinPT allows you to use the main operations (sign and encrypt)
177     within the current window. This only works if the current window contains
178     text. For example, a mailer window with the message, a text editor or a
179 twoaday 184 simple edit field. There are some kind of windows that are NOT
180     supported.
181 twoaday 50
182     The easiest way to access this feature is using the hotkeys. Note: if
183     you use this feature the text will automatically be cut, encrypted
184     and pasted again in the window. You don't need to do anything manually.
185    
186     Encrypt current window ALT+SHIFT+e
187     Decrypt/verify current window ALT+SHIFT+d
188     Sign current window ALT+SHIFT+s
189    
190     Alternately you can use the WinPT menu for the current window support.
191     Please note, that the mode doesn't work very well if you use the menu
192     entry. I recommend to use it with the hotkeys until I fix this problem.
193    
194    
195 twoaday 246 Word Wrapping
196     -------------
197 twoaday 50
198     As a new feature, WinPT can wrap lines at a specific column. You can set
199     the value for this feature in the preferences dialog. If you don't want
200     to use this feature, you only need to set the value to "0".
201    
202    
203 twoaday 246 Default keyid for Signing
204     -------------------------
205 twoaday 50
206     There are two ways to set the default keyid. The best solution is to
207 twoaday 180 set the "default-key" entry in the GPG options file.
208 twoaday 184 The second solution is that you use the Key Manager to set a default
209     key. If no default key was found, WinPT uses the first useable key in
210     the secret key cache.
211 twoaday 50
212    
213 twoaday 246 File Manager
214 twoaday 50 ------------
215    
216     The filemanager is used to perform GPG operations on files. In further releases
217     I'll add more commands. Currently, encrypt, decrypt, sign and verify
218     is available. To add a file to the list element, you can use drag & drop
219     or use the 'Open' menu entry, like Windows Explorer.
220    
221     Please note that this code is under heavy development, but is should be
222     fairly stable. It possible that some parts don't work as expected, but
223     feel free to mail me about any bugs!
224    
225    
226 twoaday 246 Proxy Support
227 twoaday 50 --------------
228    
229     If you are not able to connect directly to the internet, you can
230 twoaday 184 use the proxy settings. To enable proxy support, you need to start
231     the keyserver dialog and use the "change" button to set a proxy.
232     Now the keyserver code uses the proxy instead of the direct connection.
233 twoaday 50
234     If your proxy needs some kind of authentification, you can use
235     "proxy_user" and "proxy_pass". Then for each request the data
236     is used. The code was tested with some HTTP/WWW proxies but it's
237     also possible that it does *not* work with some proxies! Please tell
238     me if you've problems with your proxy server.
239    
240    
241 twoaday 246 Debug Mode
242     ----------
243 twoaday 50
244     To make the detection of bugs and programming mistakes easier, WinPT
245     contains a built-in debug mode.
246    
247     It can be activated with the '--enable-debug'
248     switch on the command line. Then the WinPT output is more verbose and all
249     steps are logged a in a file with the name "gpgme.dbg". This file is stored
250     in the current directory and ONLY contains GPG related information. If you
251     think it is a WinPT problem, you can find a debug file in c:\windows\temp.
252     The name of this file is "winpt.log". It's possible that this file is very
253     large, so do NOT forget to compress it.
254    
255     After an error has occured, it would be very useful to send this file to me.
256     Which file you'll send depends on the occured error. Don't use the debug
257     mode for your usual work; it slows down both GPG and WinPT.

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26