Released 0.6.3.
[pinentry.git] / README
1 PIN Entry
2 ---------
3
4 This is a collection of simple PIN or passphrase entry dialogs which
5 utilize the Assuan protocol as described by the aegypten project; see
6 http://www.gnupg.org/aegypten/ for details.
7
8 There are programs for different toolkits available.  For all GUIs it
9 is automatically detected which modules can be built, but it can also
10 be requested explicitely.
11
12 GUI     OPTION                   DEPENDENCIES
13 Curses  --enable-pinentry-curses Curses library, for example ncurses
14 GTK+    --enable-pinentry-gtk    Gimp Toolkit Library, eg libgtk and libglib
15 Qt      --enable-pinentry-qt     Qt, eg libqt-mt
16
17 The GTK+ and Qt pinentry can fall back to the curses mode.  The option
18 to enable this is --enable-fallback-curses, but this is also detected
19 automatically in the same way --enable-pinentry-curses is.  The
20 fallback to curses also works if --disable-pinentry-curses is
21 specified.  So to disable linking to curses completely you have to
22 pass --disable-fallback-curses to the configure script as well.
23
24 Examples:
25 * To only build the GTK+ pinentry with curses support:
26 ./configure --enable-pinentry-gtk --enable-fallback-curses \
27         --disable-pinentry-curses --disable-pinentry-qt
28
29 * To build the Qt pinentry, and the other pinentries if they are
30   supported:
31 ./configure --enable-pinentry-qt
32
33 * To build everything that is supported (complete auto-detection):
34 ./configure
35
36 Some of the code is taken from Robert Bihlmeyer's Quintuple-Agent.
37 For security reasons, all internationalization has been removed.  The
38 client is expected to tell the PIN entry the text strings to be
39 displayed.