Add item about result structures.
[gpgme.git] / complus / README
1           How to install and use the Gpgcom Windows Component
2           ===================================================
3                               2001-07-31
4
5
6 Installation should be pretty easy:
7 -----------------------------------
8
9   * Get and install the latest GnuPG binary for windows
10     (ftp://ftp.gnupg.org/gcrypt/binary/gnupg-w32-1.0.6.zip)
11   
12   * Check that you have an untampered version of this package by
13     comparing an MD5SUM against the one on the webpage or by checking
14     the signature of the package using "gpg --verify".  See the
15     webpacge for details.
16
17   * Because you are reading this file, you probably have already
18     unpacked it distribution using a unzip utility :-). You should
19     find these files:
20
21        README      - This file
22        gpgcom.exe  - The Gpgcom server
23        vbtest.html - A Test webpage 
24        vbtest.vbs  - A VB script to be used with the cscript utility
25
26    * If you are updating Gpgcom, run the old Gpgcom like this:
27
28        c:\gnupg\gpgcom -UnregServer
29
30      (Replace c:\gnupg with the actually used path)
31
32    * Copy the file gpgcom.exe to a some location. C:\gnupg seems to be
33      a good choice. 
34
35    * Register the component using this command:
36
37       c:\gnupg\gpgcom -RegServer
38
39    * Ready
40
41 Testing the installation:
42 -------------------------
43
44   * Make sure that you have a working GnuPG (gpg.exe) and that at least
45     one key is installed.
46
47   * Edit the vbtest.vbs script and replace "alice" in the line
48
49       gpg.AddRecipient "alice"
50
51    with a keyID or user name you have in your key ring.
52
53   * Run the test script:
54
55       cscript vbtest.vbs
56
57     and you should see a valid MIME message with the encrypted text.
58
59     
60 Using Gpgcom
61 ------------ 
62
63 Gpgcom currently support only encryption but will be extended to the
64 full range of operations GnuPG provides. The 2 examples should goive
65 yopu a hint on how to use it.  We suggest that you always set armor to
66 true, so that the returned text is a string.  If you don't use armor,
67 the "ciphertext" property will return an array with the binary
68 message.
69
70
71
72