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.1beta2 or later.
  24
  25 If you want to do remote connections to a pwmd server:
  26
  27     libssh2      - http://libssh2.org/
  28                    Version 1.2.9 or later is required for SSH connections.
  29                    Optional.
  30
  31     gnutls       - http://www.gnu.org/software/gnutls/
  32                    For remote connections over TLS. Version 3.3.0 or later.
  33                    Optional.
  34
  35
  36 For functions that use a local pinentry and when --disable-pinentry is not
  37 passed to configure, then you'll need:
  38
  39     pinentry     - ftp://ftp.gnupg.org/gcrypt/pinentry/
  40                    There are various interfaces for passphrase entry:
  41                    console/curses, X11/GTK2, X11/QT. The X11 versions also
  42                    support console/curses. Version 0.7.6 or later is required.
  43
  44
  45 GIT Repository
  46 --------------
  47 There is a public GIT repository available at Gitlab. Anonymous checkouts can
  48 be done by:
  49
  50     git clone https://gitlab.com/bjk/libpwmd.git
  51     or from the mirror:
  52     git clone git://repo.or.cz/libpwmd.git
  53
  54 The gitweb interface can be viewed at:
  55
  56     https://gitlab.com/bjk/libpwmd
  57     or
  58     http://repo.or.cz/w/libpwmd.git
  59
  60
  61 Mailing lists
  62 -------------
  63 For libpwmd:
  64 https://lists.sourceforge.net/lists/listinfo/libpwmd-devel
  65
  66 And for pwmd:
  67 https://lists.sourceforge.net/lists/listinfo/pwmd-devel
  68
  69
  70 Issue tracker:
  71 --------------
  72 Please send any bug reports, feature requests or patches to the issue tracker
  73 at Gitlab: https://gitlab.com/bjk/libpwmd/issues.
  74
  75 Ben Kibbey <bjk@luxsci.net>
  76 https://gitlab.com/bjk/libpwmd