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