README.md
changeset 15 a38e6916504c
parent 14 cba9fb39bcdb
child 16 e135ccae6783
equal deleted inserted replaced
14:cba9fb39bcdb 15:a38e6916504c
     6 
     6 
     7 ## Authors
     7 ## Authors
     8 
     8 
     9 * Mahlon E. Smith <mahlon@martini.nu>
     9 * Mahlon E. Smith <mahlon@martini.nu>
    10 * Michael Granger <ged@faeriemud.org>
    10 * Michael Granger <ged@faeriemud.org>
    11 * Jeremiah Jordan <jjordan@laika.com>
    11 * Jeremiah Jordan <jeremiah.m.jordan@gmail.com>
    12 
    12 
    13 
    13 
    14 ## Description
    14 ## Description
    15 
    15 
    16 This is a ruby interface for interacting with ezmlm-idx, an email list
    16 This is a ruby interface for interacting with ezmlm-idx, an email list
    20 
    20 
    21 http://untroubled.org/ezmlm/
    21 http://untroubled.org/ezmlm/
    22 
    22 
    23 This was tested against ezmlm-idx 7.2.2.
    23 This was tested against ezmlm-idx 7.2.2.
    24 
    24 
       
    25 *Strong recommendation*: Create your lists with archiving (-a) and
       
    26 indexing (-i)!   This library is suitable for modifying behavior of
       
    27 existing lists as a default, but with these flags enabled, can also
       
    28 be an interface to parsing and browsing the content of lists.
       
    29 
    25 
    30 
    26 ## Prerequisites
    31 ## Prerequisites
    27 
    32 
    28 * Ruby 2.1 or better
    33 * Ruby 2.1 or better
    29 
    34 
    30 
    35 
    31 ## Installation
    36 ## Installation
    32 
    37 
    33     $ gem install ezmlm
    38     $ gem install ezmlm
       
    39 
       
    40 ## Usage
       
    41 
       
    42 	....
    34 
    43 
    35 
    44 
    36 ## TODO
    45 ## TODO
    37 
    46 
    38   - Text file editing (trailers, etc.)
    47   - Text file editing (trailers, etc.)
    50 If things aren't adding up, make sure this library is running on a
    59 If things aren't adding up, make sure this library is running on a
    51 machine with a matching address space as the list itself.  (Running this
    60 machine with a matching address space as the list itself.  (Running this
    52 on a 64bit machine to talk to 32bit listserv isn't going to play well.)
    61 on a 64bit machine to talk to 32bit listserv isn't going to play well.)
    53 
    62 
    54 A lot of the fine tuning niceties of ezmlm come as flag options to
    63 A lot of the fine tuning niceties of ezmlm come as flag options to
    55 the various ezmlm-* binaries.  This library largely just deals with
    64 the various ezmlm binaries.  This library largely just deals with
    56 ezmlm-make flags for global list behaviors.  (For example, see the man
    65 ezmlm-make flags for global list behaviors.  (For example, see the man
    57 page for ezmlm-reject.)  Patches are welcome if you'd like these sorts
    66 page for ezmlm-reject.)  Patches are welcome if you'd like these sorts
    58 of miscellanous things included.
    67 of miscellaneous things included.
    59 
    68 
    60 
    69 
    61 ## License
    70 ## License
    62 
    71 
    63 Copyright (c) 2017, Mahlon E. Smith <mahlon@martini.nu>
    72 Copyright (c) 2017, Mahlon E. Smith <mahlon@martini.nu>