Update TODO.
[libpwmd.git] / README
blobdd31f2fb53cf1959ae873808ba6d7559d0e1d698
1 This is a library making it easy to patch applications to send commands to
2 PWMD.  There is an included command line client 'pwmc' that reads protocol
3 commands from stdin or in an interactive shell-like mode and sends them to the
4 pwmd server. Read libpwmd(3) or pwmc(1) for all the details. Read
5 doc/tutorial.html for an introduction to pwmd and pwmc usage (recommended).
8 Requirements:
9     C99 compiler - http://www.gnu.org/software/gcc/
10                    Is a good choice. Required.
12     libassuan    - http://www.gnupg.org/
13                    Protocol. Version 2.0.3 or later is required.
15     libgpg-error - http://www.gnupg.org/
16                    libassuan (and pwmd) return gpg error codes. Required.
18     libreadline  - http://www.gnu.org/software/readline/
19                    For an interactive shell-like interface to pwmc. Optional.
20     
21     pwmd         - http://pwmd.sourceforge.net/
22                    Version 3.0 or later.
24 If you want to do remote connections to a pwmd server:
26     libssh2      - http://libssh2.org/
27                    Version 1.2.9 or later is required for SSH connections.
29     gnutls       - http://www.gnu.org/software/gnutls/
30                    For remote connections over TLS.
33 For functions that use a local pinentry and when --disable-pinentry is not
34 passed to configure, then you'll need:
36     pinentry     - ftp://ftp.gnupg.org/gcrypt/pinentry/
37                    There are various interfaces for passphrase entry:
38                    console/curses, X11/GTK2, X11/QT. The X11 versions also
39                    support console/curses. Version 0.7.6 or later is required.
41     cracklib2    - http://sourceforge.net/projects/cracklib
42                    If --enable-quality is passed to ./configure then a
43                    passphrase quality meter is used with the local pinentry.
44                    Optional.
47 GIT Repository
48 --------------
49 There is a public GIT repository available at repo.or.cz. Anonymous checkouts
50 can be done by:
52     git clone git://repo.or.cz/libpwmd.git
54 The gitweb interface can be viewed at http://repo.or.cz/w/libpwmd.git.
57 Mailing lists
58 -------------
59 For libpwmd:
60 https://lists.sourceforge.net/lists/listinfo/libpwmd-users
61 https://lists.sourceforge.net/lists/listinfo/libpwmd-devel
63 And for pwmd:
64 https://lists.sourceforge.net/lists/listinfo/pwmd-users
65 https://lists.sourceforge.net/lists/listinfo/pwmd-devel
68 Ben Kibbey <bjk@luxsci.net>
69 http://libpwmd.sourceforge.net/