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