ruby-ezmlm: README.md@a03c08c289e9 (annotated)

12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	1	# Ruby-Ezmlm
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	2
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	3	code
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	4	: https://bitbucket.org/mahlon/Ruby-Ezmlm
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	5
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	6
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	7	## Authors
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	8
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	9	* Michael Granger <ged@faeriemud.org>
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	10	* Jeremiah Jordan <jjordan@laika.com>
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	11	* Mahlon E. Smith <mahlon@martini.nu>
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	12
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	13
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	14	## Description
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	15
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	16	This is a ruby interface for interacting with ezmlm-idx, an email list
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	17	manager for use with the Qmail MTA. (The -idx provides an extended
13 a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	18	feature set over the initial ezmlm environment), and messages therein.
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	19
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	20	http://untroubled.org/ezmlm/
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	21
1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	22
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	23	## Prerequisites
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	24
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	25	* Ruby 2.2 or better
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	26
1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	27
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	28	## Installation
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	29
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	30	$ gem install ezmlm
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	31
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	32
13 a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	33	## Limitations
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	34
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	35	This library is designed to only work with lists stored on disk (the
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	36	default), not the SQL backends.
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	37
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	38	Address space (32 bit vs 64 bit) matters when ezmlm calculates hashes.
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	39	If things aren't adding up, make sure this library is running on a
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	40	machine with a matching address space as the list itself. (Running this
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	41	on a 64bit machine to talk to 32bit listserv isn't going to play well.)
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	42
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	43	The option set offered with ezmlm-make is not fully ported, just the
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	44	most common switches. Patches welcome.
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	45
a03c08c289e9 Multiple changes. Mahlon E. Smith <mahlon@martini.nu> parents: 12 diff changeset	46
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	47	## License
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	48
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	49	Copyright (c) 2017, Mahlon E. Smith <mahlon@martini.nu>
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	50	All rights reserved.
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	51
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	52	Redistribution and use in source and binary forms, with or without
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	53	modification, are permitted provided that the following conditions are met:
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	54
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	55	* Redistributions of source code must retain the above copyright notice,
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	56	this list of conditions and the following disclaimer.
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	57
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	58	* Redistributions in binary form must reproduce the above copyright notice,
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	59	this list of conditions and the following disclaimer in the documentation
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	60	and/or other materials provided with the distribution.
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	61
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	62	* Neither the name of the author/s, nor the names of the project's
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	63	contributors may be used to endorse or promote products derived from this
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	64	software without specific prior written permission.
1 1d3cfd4837a8 Filled out the project, added Ezmlm module + spec. Michael Granger <mgranger@laika.com> parents: diff changeset	65
12 3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	66	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	67	AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	68	IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	69	DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	70	FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	71	DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	72	SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	73	CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	74	OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
3cc813140c80 First round of modernizing after a long absence. Mahlon E. Smith <mahlon@martini.nu> parents: 1 diff changeset	75	OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

author	Mahlon E. Smith <mahlon@martini.nu>
	Fri, 03 Feb 2017 10:52:46 -0800
changeset 13	a03c08c289e9
parent 12	3cc813140c80
child 14	cba9fb39bcdb
permissions	-rw-r--r--