1PINEntry
2---------
3
4This is a collection of PIN or passphrase entry dialogs which
5utilize the Assuan protocol as specified in the Libassuan manual.
6
7There are programs for different toolkits available.  For all GUIs it
8is automatically detected which modules can be built, but it can also
9be requested explicitly.
10
11GUI		OPTION			 DEPENDENCIES
12--------------------------------------------------------------------------
13GTK+ V2.0	--enable-pinentry-gtk2	 Gimp Toolkit Library, Version 2.0
14					 eg. libgtk-x11-2.0 and libglib-2.0
15GNOME           --enable-pinentry-gnome  GNOME
16Qt		--enable-pinentry-qt	 Qt (> 4.4.0)
17TQt		--enable-pinentry-tqt	 Trinity Qt
18Enlightenment	--enable-pinentry-efl	 EFL (>= 1.18)
19FLTK		--enable-pinentry-fltk	 Fast Light Toolkit (>= 1.3)
20Curses		--enable-pinentry-curses Curses library, for example ncurses
21TTY		--enable-pinentry-tty	 Simple TTY version, no dependencies
22
23The GTK+, GNOME, and Qt pinentries can fall back to curses mode.  The
24option to enable this is --enable-fallback-curses, but this is also
25detected automatically in the same way --enable-pinentry-curses is.
26The fallback to curses also works if --disable-pinentry-curses is
27specified.  So to disable linking to curses completely you have to
28pass --disable-fallback-curses to the configure script as well.
29
30Examples:
31* To only build the GTK+ pinentry with curses support:
32./configure --enable-pinentry-gtk2 --enable-fallback-curses \
33	--disable-pinentry-curses --disable-pinentry-qt
34
35* To build the Qt pinentry, and the other pinentries if they are
36  supported:
37./configure --enable-pinentry-qt
38
39* To build everything that is supported (complete auto-detection):
40./configure
41
42Some of the code is taken from Robert Bihlmeyer's Quintuple-Agent.
43For security reasons, all internationalization has been removed.  The
44client is expected to tell the PIN entry the text strings to be
45displayed.
46
47
48Curses Pinentry
49---------------
50
51The curses pinentry supports colors if the terminal does.  The colors
52can be specified by the --colors=FG,BG,SO option, which sets the
53foreground, background and standout colors respectively.  The standout
54color is used for error messages.  Colors can be named by any of
55"black", "red", "green", "yellow", "blue", "magenta", "cyan" and
56"white".  The foreground and standout color can be prefixed by
57"bright-", "bright", "bold-" and "bold", and any of these prefixes has
58the same effect of making the color bolder or brighter.  Two special
59color names are defined as well: "default" chooses the default color,
60and "none" disables use of colors.  The name "none" is only meaningful
61for the standout color and in this case a reversed effect is used for
62error messages.  For the other colors, disabling colors means the same
63as using the defaults.  The default colors are as follows:
64
65	Foreground:	Terminal default
66	Background:	Terminal default
67	Standout:	Bright red
68
69Note that color support is limited by the capabilities of the display
70terminal.  Some color combinations can be very difficult to read, and
71please know that colors are perceived differently by different people.
72