introspection: build ui vs the uninstalled gcr-base libtool archive.
[platform/upstream/gcr.git] / README
1 GCR is a library for displaying certificates, and crypto UI, accessing
2 key stores. It also provides the viewer for crypto files on the GNOME
3 desktop.
4
5 GCK is a library for accessing PKCS#11 modules like smart cards, in a
6 (G)object oriented way.
7
8
9 DEBUG TRACING
10 ==============
11
12 The Gcr and Gck libraries contain statements which help debug flow
13 and logic. In many cases these help you track down problems.
14
15 Use the environment variable GCR_DEBUG='all' or GCR_HELP='xxx' to
16 display either all messages or a specific category of debug messages.
17 To figure out what you can use in place of the 'xxx' category above,
18 use GCR_DEBUG='help' and you'll see a list of all the messages.
19
20 Example to display all debug messages:
21
22  $ GCR_DEBUG=all gcr-viewer /path/to/certificate.crt
23  (gcr-viewer:9418): Gcr-DEBUG: gcr_pkcs11_initialize_async: starting initialize of registered modules
24  ...
25
26 Example to display the various debug categories:
27
28  $ GCR_DEBUG=help gcr-viewer /path/to/certificate.crt
29  Supported debug values: library certificate-chain parse gnupg trust import key prompt all help
30
31 Example to display debug messages for a specific category:
32
33  $ GCR_DEBUG=library gcr-viewer /path/to/certificate.crt
34  (gcr-viewer:9503): Gcr-DEBUG: gcr_pkcs11_initialize_async: starting initialize of registered modules
35  ...
36
37 If you wish to permanently enable certain debug messages, include compiler
38 directives like this when configuring this library:
39
40  $ CFLAGS='-DGCR_DEBUG=library' ./configure ...
41
42 For the Gck debug messages simply replace 'GCR_DEBUG' with 'GCK_DEBUG'
43 in the above examples.