README

   1 Mutt-LDAP provides an `external address query script`_ for Mutt_ which
   2 connects to LDAP_ databases using python-ldap_.  It can cache queries
   3 locally in case your LDAP server is slow or not always available,
   4 expiring cached queries after a configurable amount of time.
   5
   6 Installation
   7 ============
   8
   9 Packages
  10 --------
  11
  12 Gentoo
  13 ~~~~~~
  14
  15 I've packaged Mutt-LDAP for Gentoo_.  You need layman_ and my `wtk
  16 overlay`_.  Install with::
  17
  18   # emerge -av app-portage/layman
  19   # layman --add wtk
  20   # emerge -av mail-client/mutt-ldap
  21
  22 Dependencies
  23 ------------
  24
  25 If you're installing by hand or packaging Mutt-LDAP for another
  26 distribution, you'll need the following dependencies:
  27
  28 ============  ================  ===========  ======================
  29 Package       Purpose           Debian_      Gentoo_
  30 ============  ================  ===========  ======================
  31 python-ldap_  LDAP connections  python-ldap  dev-python/python-ldap
  32 ============  ================  ===========  ======================
  33
  34 Installing by hand
  35 ------------------
  36
  37 Mutt-LDAP is available as a Git_ repository::
  38
  39   $ git clone git://tremily.us/mutt-ldap.git
  40
  41 It is also mirrored on GitHub_.  To install the checkout, run the
  42 standard::
  43
  44   $ python setup.py install
  45
  46 or you can just copy ``mutt-ldap.py`` into to your ``PATH``.
  47
  48 Usage
  49 =====
  50
  51 Add the following line to your ``~/.muttrc``::
  52
  53   set query_command = "mutt-ldap.py '%s'"
  54
  55 Search for addresses (from Mutt_) with ``^t``, optionally after typing
  56 part of the name.  Configure your connection by creating
  57 ``~/.mutt-ldap.rc`` contaning something like::
  58
  59   [connection]
  60   server = myserver.example.net
  61   basedn = ou=people,dc=example,dc=net
  62
  63 See the ``CONFIG`` options in ``mutt-ldap.py`` for other available
  64 settings.
  65
  66 Licence
  67 =======
  68
  69 This project is distributed under the `GNU General Public License
  70 Version 3`_ or greater.
  71
  72 Bugs
  73 ====
  74
  75 Use the `GitHub issue tracker`_ to submit bugs.
  76
  77 Related work
  78 ============
  79
  80 `mutt_ldap_query`_ is a Perl script with a similar purpose.
  81
  82 .. _external address query script:
  83    http://www.mutt.org/doc/manual/manual-4.html#ss4.5
  84 .. _Mutt: http://www.mutt.org/
  85 .. _LDAP: http://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol
  86 .. _python-ldap: http://www.python-ldap.org/
  87 .. _Gentoo: http://www.gentoo.org/
  88 .. _layman: http://layman.sourceforge.net/
  89 .. _wtk overlay: http://blog.tremily.us/posts/Gentoo_overlay/
  90 .. _Debian: http://www.debian.org/
  91 .. _Git: http://git-scm.com/
  92 .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.html
  93 .. _GitHub: https://github.com/wking/mutt-ldap
  94 .. _GitHub issue tracker: https://github.com/wking/mutt-ldap/issues
  95 .. _mutt_ldap_query: ftp://ftp.mutt.org/pub/mutt/contrib/mutt_ldap_query.README