README

   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).
   6
   7
   8 Requirements:
   9     C99 compiler - http://www.gnu.org/software/gcc/
  10                    Is a good choice. Required.
  11
  12     libassuan    - http://www.gnupg.org/
  13                    Protocol. Version 2.0.3 or later is required. Version 2.1.0
  14                    or later is recommended.
  15
  16     libgpg-error - http://www.gnupg.org/
  17                    libassuan (and pwmd) return gpg error codes. Required.
  18
  19     libreadline  - http://www.gnu.org/software/readline/
  20                    For an interactive shell-like interface to pwmc. Optional.
  21
  22     pwmd         - http://pwmd.sourceforge.net/
  23                    Version 3.1 or later. Version 7.3.0 and later of libpwmd
  24                    are backward compatible with pwmd version 3.0.x but the
  25                    pwmc client included in libpwmd 7.3.0 is not and requires
  26                    pwmd 3.1 or later.
  27
  28 If you want to do remote connections to a pwmd server:
  29
  30     libssh2      - http://libssh2.org/
  31                    Version 1.2.9 or later is required for SSH connections.
  32                    Optional.
  33
  34     gnutls       - http://www.gnu.org/software/gnutls/
  35                    For remote connections over TLS. Version 3.3.0 or later.
  36                    Optional.
  37
  38
  39 For functions that use a local pinentry and when --disable-pinentry is not
  40 passed to configure, then you'll need:
  41
  42     pinentry     - ftp://ftp.gnupg.org/gcrypt/pinentry/
  43                    There are various interfaces for passphrase entry:
  44                    console/curses, X11/GTK2, X11/QT. The X11 versions also
  45                    support console/curses. Version 0.7.6 or later is required.
  46
  47     cracklib2    - http://sourceforge.net/projects/cracklib
  48                    If --enable-quality is passed to ./configure then a
  49                    passphrase quality meter is used with the local pinentry.
  50                    Optional.
  51
  52
  53 GIT Repository
  54 --------------
  55 There is a public GIT repository available at repo.or.cz. Anonymous checkouts
  56 can be done by:
  57
  58     git clone git://repo.or.cz/libpwmd.git
  59
  60 The gitweb interface can be viewed at http://repo.or.cz/w/libpwmd.git.
  61
  62
  63 Mailing lists
  64 -------------
  65 For libpwmd:
  66 https://lists.sourceforge.net/lists/listinfo/libpwmd-users
  67 https://lists.sourceforge.net/lists/listinfo/libpwmd-devel
  68
  69 And for pwmd:
  70 https://lists.sourceforge.net/lists/listinfo/pwmd-users
  71 https://lists.sourceforge.net/lists/listinfo/pwmd-devel
  72
  73
  74 Ben Kibbey <bjk@luxsci.net>
  75 http://libpwmd.sourceforge.net/