doc/
[gpgme.git] / doc / ChangeLog
1 2004-02-24  Marcus Brinkmann  <marcus@g10code.de>
2
3         * gpgme.texi (cancellation): New section.
4
5 2004-02-17  Werner Koch  <wk@gnupg.org>
6
7         * gpgme.texi (Key Listing Mode): Doc KEYLIST_MODE_VALIDATE.
8
9 2004-02-06  Moritz Schulte  <mo@g10code.com>
10
11         * gpgme.texi: A couple of small fixes regarding the Largfile
12         Support section.
13
14 2004-02-01  Marcus Brinkmann  <marcus@g10code.de>
15
16         * gpgme.texi (Largefile Support): New section.
17
18 2004-01-13  Marcus Brinkmann  <marcus@g10code.de>
19
20         * gpgme.texi (Key Management): Fix exportable field.
21
22 2003-12-25  Marcus Brinkmann  <marcus@g10code.de>
23
24         * gpgme.texi (Key Management): Rename member class in
25         gpgme_key_sig_t to sig_class.
26         (Creating a Signature): Likewise for gpgme_signature_t.
27
28 2003-12-23  Moritz Schulte  <mo@g10code.com>
29
30         * gpgme.texi (Listing Keys): Minor clarification for
31         gpgme_get_key.
32
33 2003-10-06  Marcus Brinkmann  <marcus@g10code.de>
34
35         * gpgme.texi (Signal Handling): New section.
36
37 2003-09-14  Marcus Brinkmann  <marcus@g10code.de>
38
39         * gpgme.texi (Multi Threading): Correct documentation on memory
40         synchronization requirement.
41
42         * gpgme.texi (Locale): New section.
43         (Multi Threading): Set locale in example.
44
45 2003-09-13  Marcus Brinkmann  <marcus@g10code.de>
46
47         * gpgme.texi (Error Strings): Add gpgme_strerror_r.
48
49 2003-09-13  Marcus Brinkmann  <marcus@g10code.de>
50
51         * gpgme.texi (Multi Threading): Update documentation.
52
53 2003-09-03  Marcus Brinkmann  <marcus@g10code.de>
54
55         * gpgme.texi (Header): We don't use the assuan namespace anymore.
56         Document new thread options.
57
58 2003-08-14  Marcus Brinkmann  <marcus@g10code.de>
59
60         * gpgme.texi (Creating a Signature): Change type of member class
61         to unsigned int.
62
63 2003-08-04  Marcus Brinkmann  <marcus@g10code.de>
64
65         * gpgme.texi (Verify): Get error code from SIG->status in the code
66         for gpgme_get_sig_status.
67
68 2003-07-31  Marcus Brinkmann  <marcus@g10code.de>
69
70         * gpgme.texi (Key Management): Add can_authenticate flag.
71
72         * gpgme.texi (Listing Keys): Document GPG_ERR_AMBIGUOUS_NAME for
73         gpgme_get_key.
74
75 2003-07-29  Marcus Brinkmann  <marcus@g10code.de>
76
77         * Makefile.am (EXTRA_DIST): Remove variable.
78
79         * gpgme.texi (Encrypting a Plaintext): Bad passphrase is only
80         possible with symmetric encryption, change the wording to reflect
81         that.
82
83         * gpgme.texi (Creating a Signature): Document
84         GPG_ERR_UNUSABLE_SECKEY.
85
86         * gpgme.texi (Encrypting a Plaintext): Mention encrypt and sign
87         operations in result function.
88         (Creating a Signature): Likewise.
89
90 2003-07-23  Marcus Brinkmann  <marcus@g10code.de>
91
92         * gpgme.texi (Key Listing Mode): Remove word duplication.
93         (Listing Keys): Remove mentioning of force argument.
94         (Verify): Don't mention r_stat.  Fix some typos.
95         (Decrypt and Verify): Correct info how to get the result.  Don't
96         mention r_stat.
97         (Manipulating Data Buffers): Fix documentation of return value.
98         (Listing Keys): Update examples.
99         (Decrypt): Result might also be available when operation failed.
100         (Verify): Result might also be available when operation failed.
101         All spotted by Stéphane Corthésy.
102
103 2003-07-22  Marcus Brinkmann  <marcus@g10code.de>
104
105         * gpgme.texi (Error Sources): Fix cut and paste error.
106
107 2003-07-09  Marcus Brinkmann  <marcus@g10code.de>
108
109         * gpgme.texi (Key Management): Clarify difference between can_sign
110         and can_certify.
111         (Information About Keys): Likewise for GPGME_ATTR_CAN_SIGN and
112         GPGME_ATTR_CAN_CERTIFY.
113
114 2003-07-08  Marcus Brinkmann  <marcus@g10code.de>
115
116         * gpgme.texi (Progress Meter Callback): Change return type of
117         gpgme_progress_cb_t to void.
118
119 2003-06-22  Marcus Brinkmann  <marcus@g10code.de>
120
121         * gpgme.texi: Add 2003 to copyright notice.
122
123         * gpgme.texi (Header): Fix name space documentation on
124         libgpg-error.
125
126 2003-06-22  Marcus Brinkmann  <marcus@g10code.de>
127
128         * gpgme.texi (Multi Threading): Remove reference to
129         gpgme_recipients_t.
130
131 2003-06-06  Marcus Brinkmann  <marcus@g10code.de>
132
133         * gpgme.texi (Crypto Operations): Rename gpgme_invalid_user_id_t
134         to gpgme_invalid_key_t.
135
136 2003-06-06  Marcus Brinkmann  <marcus@g10code.de>
137
138         * gpgme.texi: Change error codes to GPG_ERR_* variants.
139         (Error Handling): Rewritten.
140
141 2003-05-29  Marcus Brinkmann  <marcus@g10code.de>
142
143         * gpgme.texi (Exporting Keys): Change and document prototypes.
144         Add new gpgme_op_export_ext and gpgme_op_export_ext_start
145         variants.
146         (Selecting Recipients): Section removed.
147         (Encrypting a Plaintext): Change prototypes and document the
148         changes.
149
150 2003-05-28  Marcus Brinkmann  <marcus@g10code.de>
151
152         * gpgme.texi (Exporting Keys): Change argument type from
153         gpgme_recipient_t to gpgme_user_id_t.
154         (Encrypting a Plaintext): Likewise.
155         (Selecting Recipients): Rewritten.
156
157 2003-05-27  Marcus Brinkmann  <marcus@g10code.de>
158
159         * gpgme.texi (Protocol Selection): Do not use @acronym in @node
160         because that breaks texi2dvi.
161
162         * gpgme.texi (Passphrase Callback): Document new prototype.
163
164 2003-05-18  Marcus Brinkmann  <marcus@g10code.de>
165
166         * gpgme.texi (Header): Remove Gpgme as namespace prefix.  Add
167         _GPGME to namespace prefix.
168         * gpgme.texi (Multi Threading): Add note about link order.
169
170 2003-05-04  Marcus Brinkmann  <marcus@g10code.de>
171
172         * gpgme.texi (Listing Keys): Document what happens if key is not
173         found.
174
175         * gpgme.texi (Importing Keys): Fix cut and paste error.
176
177 2003-04-30  Marcus Brinkmann  <marcus@g10code.de>
178
179         * gpgme.texi (Encrypting a Plaintext): Remove reference to
180         gpgme_get_op_info.
181         (Detailed Results): Subsection removed.
182
183         * gpgme.texi (Key Listing Mode): Add GPGME_KEYLIST_MODE_SIGS.
184         (Manipulating Keys): Add obsoleteness note.
185         (Key Signatures): Likewise.
186         (Information About Keys): Likewise.
187         (Key Management): Add new data types GpgmeSubkey, GpgmeKeySig,
188         GpgmeUserID, and all the information about GpgmeKey.
189
190 2003-04-29  Marcus Brinkmann  <marcus@g10code.de>
191
192         * gpgme.texi (Listing Keys): Remove force_update argument from
193         gpgme_get_key.
194
195         * gpgme.texi (Trust Item Management): Add data members of
196         GpgmeTrustItem type.
197         (Information About Trust Items): Add note about obsoleteness.
198         (Manipulating Trust Items): Add gpgme_trust_item_ref and
199         gpgme_trust_item_unref.
200
201 2003-04-28  Marcus Brinkmann  <marcus@g10code.de>
202
203         * gpgme.texi (Verify): Rewritten to take into account new and
204         deprecated functions and data types.
205
206         * gpgme.texi (Decrypt): Descript gpgme_op_decrypt_result and
207         GpgmeDecryptResult.
208
209 2003-04-27  Marcus Brinkmann  <marcus@g10code.de>
210
211         * gpgme.texi (Encrypting a Plaintext): Add info about
212         GpgmeEncryptResult and gpgme_op_encrypt_result.
213
214         * gpgme.texi (Creating a Signature): Add info about
215         GpgmeNewSignature, GpgmeSignResult and gpgme_op_sign_result.
216         (Crypto Operations): Add GpgmeInvalidUserID.
217         (Algorithms): New chapter.
218
219         * gpgme.texi (Deleting Keys): Document
220         GPGME_Ambiguous_Specification.
221         (Error Values): Remove GPGME_Invalid_Type and GPGME_Invalid_Mode.
222         Add GPGME_Unknown_Reason, GPGME_Not_Found,
223         GPGME_Ambiguous_Specification, GPGME_Wrong_Key_Usage,
224         GPGME_Key_Revoked, GPGME_Key_Expired, GPGME_No_CRL_Known,
225         GPGME_CRL_Too_Old, GPGME_Policy_Mismatch, GPGME_No_Secret_Key,
226         GPGME_Key_Not_Trusted, GPGME_Issuer_Missing, GPGME_Chain_Too_Long,
227         GPGME_Unsupported_Algorithm, GPGME_Sig_Expired,
228         GPGME_Bad_Signature, GPGME_No_Public_Key.
229
230 2003-04-25  Marcus Brinkmann  <marcus@g10code.de>
231
232         * gpgme.texi (Importing Keys): Change GPGME_IMPORT_PRIVATE to
233         GPGME_IMPORT_SECRET.
234
235         * gpgme.texi (Importing Keys): Remove note about gpgme_get_op_info.
236         (Detailed Results): Remove note about import.
237
238         * gpgme.texi (Importing Keys): Add documentation for
239         GpgmeImportStatus, GpgmeImportResult and gpgme_op_import_result.
240
241         * gpgme.texi (Generating Keys): Fix documentation of public and
242         secret arguments.
243
244 2003-04-24  Marcus Brinkmann  <marcus@g10code.de>
245
246         * gpgme.texi (Generating Keys): Document changed gpgme_op_genkey
247         and new gpgme_op_genkey_result function.  Document
248         GpgmeGenKeyResult data type.
249
250         * gpgme.texi (Error Values): Rename GPGME_No_Passphrase to
251         GPGME_Bad_Passphrase.
252         * gpgme.texi (Decrypt): Likewise.
253         (Decrypt and Verify): Likewise.
254         (Creating a Signature): Likewise.
255         (Encrypting a Plaintext): Likewise.
256
257         * gpgme.texi (Error Values): Rename GPGME_No_Recipients to
258         GPGME_No_UserID and GPGME_Invalid_Recipient to
259         GPGME_Invalid_UserID.
260         (Encrypting a Plaintext): Likewise.
261
262         * gpgme.texi (Error Values): Remove GPGME_Busy and GPGME_No_Request.
263         (Listing Keys): Likewise.
264         (Listing Trust Items): Likewise.
265
266 2003-02-06  Marcus Brinkmann  <marcus@g10code.de>
267
268         * gpgme.texi (Cancelling an Operation): Removed.
269         (Passphrase Callback): Document new type for GpgmePassphraseCb.
270
271 2003-01-30  Marcus Brinkmann  <marcus@g10code.de>
272
273         * gpgme.texi (Engine Information): Rename member part to
274         file_name.
275
276         * gpgme.texi (Protocols and Engines): Document
277         gpgme_get_protocol_name.
278
279         * gpgme.texi (Engine Information): Rewritten.
280
281 2003-01-29  Marcus Brinkmann  <marcus@g10code.de>
282
283         * gpgme.texi (I/O Callback Interface): Document new even
284         GPGME_EVENT_START.
285         (Waiting For Completion): Document new possible return values.
286         (I/O Callback Interface): Document return type of GpgmeIOCb.
287
288 2003-01-29  Marcus Brinkmann  <marcus@g10code.de>
289
290         * gpgme.texi (Hooking Up Into Idle Time): Section removed.
291
292 2002-12-24  Marcus Brinkmann  <marcus@g10code.de>
293
294         * gpgme.texi (Verify): Drop R_STAT argument in gpgme_op_verify.
295         * gpgme.texi (Decrypt and Verify): Likewise for
296         gpgme_op_decrypt_verify.
297
298 2002-12-23  Marcus Brinkmann  <marcus@g10code.de>
299
300         * gpgme.texi (Information About Keys): Document that
301         GPGME_ATTR_IS_SECRET is not representable as a string anymore.
302
303 2002-12-22  Marcus Brinkmann  <marcus@g10code.de>
304
305         * gpgme.texi (Key Signatures): New section.
306         (Listing Keys): Add gpgme_get_key.
307
308 2002-12-06  Marcus Brinkmann  <marcus@g10code.de>
309
310         * gpgme.texi (Memory Based Data Buffers): New subsection.
311         (File Based Data Buffers): Likewise.
312         (Callback Based Data Buffers): Likewise.
313         (Manipulating Data Buffers): Update interfaces.  Add
314         gpgme_data_seek.
315         * gpgme.texi (Engine Version Check): Remove gpgme_check_engine.
316         
317 2002-11-21  Marcus Brinkmann  <marcus@g10code.de>
318
319         * gpgme.texi (Verify): Document the new interface.
320
321 2002-11-19  Marcus Brinkmann  <marcus@g10code.de>
322
323         * gpgme.texi (Generating Keys): Document new argument to
324         gpgme_op_genkey.
325
326 2002-11-05  Marcus Brinkmann  <marcus@g10code.de>
327
328         * gpgme.texi (Verify): Fix prototype of gpgme_get_sig_key.
329         Reported by Miguel Coca <e970095@zipi.fi.upm.es>.
330
331 2002-08-30  Marcus Brinkmann  <marcus@g10code.de>
332
333         * gpgme.texi (Selecting Signers): Fix reference count.
334
335 2002-08-21  Marcus Brinkmann  <marcus@g10code.de>
336
337         * gpgme.texi (Header): Document name space.
338
339 2002-08-20  Marcus Brinkmann  <marcus@g10code.de>
340
341         * gpgme.texi (Importing Keys): Document gpgme_op_import_ext.
342
343         * gpgme.texi (Importing Keys): Undocument EOF.
344
345 2002-08-14  Werner Koch  <wk@gnupg.org>
346
347         * gpgme.texi (Information About Keys): Changed GPGME_ATTR_TYPE.
348
349 2002-07-25  Marcus Brinkmann  <marcus@g10code.de>
350
351         * gpgme.texi (Deleting Keys): Say that secret keys might not be
352         deleted.
353
354 2002-07-25  Marcus Brinkmann  <marcus@g10code.de>
355
356         * gpgme.texi (Information About Keys): Document (badly) the new
357         key attributes.
358
359         * gpgme.texi (Manipulating Data Buffers): Mention that backend
360         tries to detect encoding automatically.
361
362 2002-07-03  Marcus Brinkmann  <marcus@g10code.de>
363
364         * gpgme.texi (Run Control): Update this section.
365         (Waiting For Completion): Likewise for this subsection.
366         (Cancelling an Operation): Likewise for this subsection.
367         (Using External Event Loops): New subsection with several
368         subsubsections.
369
370 2002-06-28  Marcus Brinkmann  <marcus@g10code.de>
371
372         * gpgme.texi (Multi Threading): Remove item about the need to
373         synchronize anything against gpgme_wait (except gpgme_wait
374         itself).
375
376 2002-06-27  Marcus Brinkmann  <marcus@g10code.de>
377
378         * gpgme.texi (Information About Keys): Fix documentation for IDX.
379         (Information About Trust Items): Likewise.
380
381 2002-06-26  Werner Koch  <wk@gnupg.org>
382
383         * gpgme.texi (Importing Keys): Document the return value -1 of
384         gpgme_op_import.
385
386 2002-06-20  Werner Koch  <wk@gnupg.org>
387
388         * gpgme.texi (Verify): Explain the new whatidx variable.
389
390 2002-06-10  Werner Koch  <wk@gnupg.org>
391
392         * gpgme.texi (Verify): Document attribute GPGME_ATTR_ERRTOK.
393
394 2002-06-04  Marcus Brinkmann  <marcus@g10code.de>
395
396         * gpgme.texi (Multi Threading): Document new autodetection.
397
398 2002-06-04  Marcus Brinkmann  <marcus@g10code.de>
399
400         * Makefile.am (DISTCLEANFILES): New variable.
401
402 2002-05-26  Marcus Brinkmann  <marcus@g10code.de>
403
404         * gpgme.texi: Some typographical correctons throughout.
405
406 2002-05-09  Marcus Brinkmann  <marcus@g10code.de>
407
408         * gpgme.texi (Using Automake): New section.
409
410 2002-05-09  Marcus Brinkmann  <marcus@g10code.de>
411
412         * gpgme.texi (Multi Threading): Escape { and }.
413
414 2002-05-09  Marcus Brinkmann  <marcus@g10code.de>
415
416         * gpgme.texi (Overview): Replace note about thread-safeness.
417         (Multi Threading): New section.
418
419 2002-05-03  Werner Koch  <wk@gnupg.org>
420
421         * gpgme.texi (Manipulating Data Buffers): Changed some data types
422         to void*.
423         (Protocol Selection): Added gpgme_get_protocol.
424         (Verify): Updated to include the new attribute fucntions and
425         status codes.
426
427 2002-04-27  Werner Koch  <wk@gnupg.org>
428
429         * gpgme.texi (Manipulating Data Buffers): New type GpgmeDataEncoding.
430
431 2002-04-23  Marcus Brinkmann  <marcus@g10code.de>
432
433         * gpgme.texi (Passphrase Callback): Document that either return
434         argument can be NULL.
435         (Progress Meter Callback): Likewise.
436
437 2002-04-22  Marcus Brinkmann  <marcus@g10code.de>
438
439         * gpgme.texi (Passphrase Callback): Fix small typo.  Document the
440         new function gpgme_get_passphrase_cb.
441         (Progress Meter Callback): Document the new function
442         gpgme_get_progress_cb.
443
444 2002-04-16  Marcus Brinkmann  <marcus@g10code.de>
445
446         * gpgme.texi (Creating a Signature): Fix function name.  Reported
447         by Wichert Ackerman <wichert@debian.org>.
448
449 2002-03-29  Marcus Brinkmann  <marcus@g10code.de>
450
451         * gpgme.texi (direntry): End index entry with a full stop.
452         Patch submitted by Jose Carlos Garcia Sogo <jsogo@debian.org>.
453         
454 2002-03-17  Marcus Brinkmann  <marcus@g10code.de>
455
456         * gpgme.texi (Detailed Results): Fix syntax error in last change.
457
458 2002-03-08  Werner Koch  <wk@gnupg.org>
459
460         * gpgme.texi (Detailed Results): Import does also return info.
461
462 2002-03-06  Marcus Brinkmann  <marcus@g10code.de>
463
464         * gpgme.texi (Encrypting a Plaintext): Document symmetric
465         encryption.
466
467 2002-03-06  Marcus Brinkmann  <marcus@g10code.de>
468
469         * gpgme.texi (Error Strings): Add example.
470         * gpgme.texi (Listing Keys): Likewise.
471
472 2002-03-03  Marcus Brinkmann  <marcus@g10code.de>
473
474         * gpgme.texi (Information About Keys): Document GPGME_ATTR_EXPIRE.
475
476 2002-03-03  Marcus Brinkmann  <marcus@g10code.de>
477
478         * gpgme.texi (Verify): Document verification of normal and
479         cleartext signatures.
480
481 2002-02-27  Marcus Brinkmann  <marcus@g10code.de>
482
483         * gpgme.texi (Listing Keys): Document gpgme_op_keylist_ext_start.
484
485 2002-02-27  Marcus Brinkmann  <marcus@g10code.de>
486
487         * gpgme.texi (Encrypting a Plaintext): Document
488         GPGME_Invalid_Recipients.
489         (Error Values): Likewise.
490
491 2002-02-26  Marcus Brinkmann  <marcus@g10code.de>
492
493         * gpgme.texi (Encrypting a Plaintext): Document
494         gpgme_op_encrypt_sign and gpgme_op_encrypt_sign_start.
495
496 2002-02-25  Marcus Brinkmann  <marcus@g10code.de>
497
498         * gpgme.texi (Creating a Signature): Add a note about
499         certificates to include.
500         (Included Certificates): New section.
501
502 2002-02-09  Marcus Brinkmann  <marcus@g10code.de>
503
504         * gpgme.texi (Detailed Results): Remove literal tags.
505         (Generating Keys): Update documentation.
506
507         * gpgme.texi (Generating Keys): Fix syntax error.
508
509 2002-02-06  Marcus Brinkmann  <marcus@g10code.de>
510
511         * gpgme.texi (Waiting For Completion): Adjust doc to changes in
512         the code.
513
514 2002-02-06  Marcus Brinkmann  <marcus@g10code.de>
515
516         * gpgme.texi (Key Listing Mode): Update documentation.
517
518 2002-01-31  Marcus Brinkmann  <marcus@g10code.de>
519
520         * gpgme.texi (Generating Keys): Document error at creation
521         failure.
522
523 2002-01-30  Marcus Brinkmann  <marcus@g10code.de>
524
525         * gpgme.texi (Deleting Keys): Document new error values.
526
527 2002-01-30  Marcus Brinkmann  <marcus@g10code.de>
528
529         * gpgme.texi (Importing Keys): Add reference to gpgme_get_op_info.
530
531 2002-01-30  Marcus Brinkmann  <marcus@g10code.de>
532
533         * gpgme.texi: Some spell checking.
534
535 2002-01-30  Marcus Brinkmann  <marcus@g10code.de>
536
537         * gpgme.texi: Add all the gpgme_op_*_start functions.
538         Fill the concept index with many, many entries.
539
540 2002-01-29  Marcus Brinkmann  <marcus@g10code.de>
541
542         * gpgme.texi (Run Control): New section.
543         (Verify): Docuent gpgme_get_notation.
544         (More Information): New section describing gpgme_get_op_info.
545
546 2002-01-22  Marcus Brinkmann  <marcus@g10code.de>
547
548         * gpgme.texi (Passphrase callback): Change GpgmePassphraseCb's
549         R_HD type from void* to void**.
550
551 2002-01-22  Marcus Brinkmann  <marcus@g10code.de>
552
553         * gpgme.texi (Creating data buffers): Change
554         gpgme_data_new_from_filepart's LENGTH type from off_t to size_t.
555
556 2002-01-22  Marcus Brinkmann  <marcus@g10code.de>
557
558         * gpgme.texi (Generating keys): New subsection.
559         (Exporting keys): Likewise.
560         (Importing keys): Likewise.
561         (Deleting keys): Likewise.
562
563 2002-01-16  Marcus Brinkmann  <marcus@g10code.de>
564
565         * gpgme.texi: g10Code -> g10 Code
566
567         * gpgme.texi (Top): Complete detailmenu.
568         
569         * gpgme.texi: Convert embarassing cruft to the real thing.
570
571 2002-01-16  Marcus Brinkmann  <marcus@g10code.de>
572
573         * ChangeLog: New file.
574         * gpgme.texi: Likewise.
575         * gpl.texi: Likewise.
576         * fdl.texi: Likewise.
577         * Makefile.am (info_TEXINFOS): New variable.
578         (gpgme_TEXINFOS): Likewise.
579
580  Copyright 2002, 2003, 2004 g10 Code GmbH
581
582  This file is free software; as a special exception the author gives
583  unlimited permission to copy and/or distribute it, with or without
584  modifications, as long as this notice is preserved.
585
586  This file is distributed in the hope that it will be useful, but
587  WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
588  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.