Update to automake 1.14.
[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+ V2.0       --enable-pinentry-gtk2   Gimp Toolkit Library, Version 2.0
15                                          eg. libgtk-x11-2.0 and libglib-2.0
16 Qt4             --enable-pinentry-qt4    Qt4
17 TTY             --enable-pinentry-tty    Simple TTY version, no dependencies
18
19 The GTK+ and Qt pinentries can fall back to the curses mode.  The
20 option to enable this is --enable-fallback-curses, but this is also
21 detected automatically in the same way --enable-pinentry-curses is.
22 The fallback to curses also works if --disable-pinentry-curses is
23 specified.  So to disable linking to curses completely you have to
24 pass --disable-fallback-curses to the configure script as well.
25
26 Examples:
27 * To only build the GTK+ pinentry with curses support:
28 ./configure --enable-pinentry-gtk2 --enable-fallback-curses \
29         --disable-pinentry-curses --disable-pinentry-qt4
30
31 * To build the Qt pinentry, and the other pinentries if they are
32   supported:
33 ./configure --enable-pinentry-qt4
34
35 * To build everything that is supported (complete auto-detection):
36 ./configure
37
38 Some of the code is taken from Robert Bihlmeyer's Quintuple-Agent.
39 For security reasons, all internationalization has been removed.  The
40 client is expected to tell the PIN entry the text strings to be
41 displayed.
42
43
44 Curses Pinentry
45 ---------------
46
47 The curses pinentry supports colors if the terminal does.  The colors
48 can be specified by the --colors=FG,BG,SO option, which sets the
49 foreground, background and standout colors respectively.  The standout
50 color is used for error messages.  Colors can be named by any of
51 "black", "red", "green", "yellow", "blue", "magenta", "cyan" and
52 "white".  The foreground and standout color can be prefixed by
53 "bright-", "bright", "bold-" and "bold", and any of these prefixes has
54 the same effect of making the color bolder or brighter.  Two special
55 color names are defined as well: "default" chooses the default color,
56 and "none" disables use of colors.  The name "none" is only meaningful
57 for the standout color and in this case a reversed effect is used for
58 error messages.  For the other colors, disabling colors means the same
59 as using the defaults.  The default colors are as follows:
60
61         Foreground:     Terminal default
62         Background:     Terminal default
63         Standout:       Bright red
64
65 Note that color support is limited by the capabilities of the display
66 terminal.  Some color combinations can be very difficult to read, and
67 please know that colors are perceived differently by different people.