Created a doc/Makefile "doxygen" target to generate the documentation.
[libpwmd.git] / README
blobf6f0eeb1c0f8d110429fe5375ed2db0b1d894ca8
1 This is a library making it easy to patch applications to send commands to
2 PWMD. Read libpwmd.h or libpwmd(3) for all the details. There is an included
3 command line client 'pwmc' that reads protocol commands from stdin and sends
4 them to the pwmd server.
6 Requirements:
8     libassuan    - http://www.gnupg.org
9                    Communication protocol. Version 1.0.5 or later is required.
11     libgpg-error - http://www.gnupg.org
12                    libassuan returns gpg error codes.
14     libpth2      - http://www.gnu.org/software/pth/pth.html
15                    Portable multi-threading library. Optional.
16     
17     pwmd         - http://bjk.sourceforge.net/pwmd/
18                    Version 1.11 or later is required.
20 If you want remote SSH support:
22     libssh2      - http://libssh2.org
23                    Version 1.0 has been tested to work.
25     libc-ares    - http://c-ares.haxx.se
26                    For asynchronous DNS lookups. Version 1.5.2 has been tested
27                    to work.
29 For functions that require a local pinentry (and not pwmd's pinentry) can be
30 used to retreive the passphrase. If --disable-pinentry is not passed to
31 configure, then you'll need:
33     pinentry     - http://www.gnupg.org/aegypten
34                    There are various interfaces for password entry:
35                    console/curses, X11/GTK2, X11/QT. The X11 versions also
36                    support console/curses. If you plan on using
37                    pwmd_open_asyn2() then pinentry v0.7.5 or later is
38                    required.
40 GIT Repository
41 --------------
42 There is a public GIT repository available at repo.or.cz. Anonymous checkouts
43 can be done by:
45     git clone git://repo.or.cz/libpwmd.git
47 The gitweb interface can be viewed at http://repo.or.cz/w/libpwmd.git.
49 Ben Kibbey <bjk@luxsci.net>
50 http://bjk.sourceforge.net/pwmd/.