lib/Promulger.pm

   1 package Promulger;
   2 use strict;
   3 use warnings;
   4
   5 our $VERSION = '0.000001'; # 0.0.1
   6
   7 =pod
   8
   9 =head1 NAME
  10
  11 Promulger -- Simple, Unixy mailing list manager
  12
  13 =head1 SYNOPSIS
  14
  15   # In a config file somewhere:
  16   aliases = /path/to/etc/aliases
  17   list_home = /path/your/mta/can/write/to/lists
  18   bin_root = /path/to/pmg/bin # like /usr/local/bin
  19
  20   # then
  21   /path/to/pmg/bin/pmg -c /path/to/config/pmg.conf newlist mylist
  22
  23   # then
  24   mail -s subscribe mylist-request@yourhost < /dev/null
  25   mail -s post mylist@yourhost < first_post
  26
  27   # cleanup
  28   /path/to/pmg/bin/pmg -c /path/to/config/pmg.conf rmlist mylist
  29
  30 =head1 DESCRIPTION
  31
  32 Promulger is a simple, lightweight mailinglist manager (mlm) that subscribes to
  33 the Unix philosophy and aims to be sysadmin-friendly. Plaintext configuration
  34 and data files are favored over opaque binary files. The simplest possible thing
  35 that can work is the preferred approach. Simple algorithms, simple tools that do
  36 one thing well. An administrator should be able to read the config files and the
  37 data files without reading these docs and understand what's going on.
  38
  39 =head1 LIMITATIONS
  40
  41 Consider this section a TODO list.
  42
  43 Presently, Promulger doesn't support VERP, and as a result doesn't support
  44 bounce parsing. It's being released to be tested on small, closed networks with
  45 clueful admins. If fishing messages out of your MTA's queue isn't something you
  46 feel comfortable doing, Promulger isn't for you right now.
  47
  48 Another thing Promulger lacks is an archive. This is coming, but in the
  49 meantime, you're on your own.
  50
  51 There's no support for the standard mailing list headers. This means that
  52 filtering will need to work on the mailing list sender address for now.
  53
  54 It's not very customizable--in fact, it has no flexibility at all.
  55
  56 =head1 ENVIRONMENT
  57
  58 Promulger doesn't read any environment variables.
  59
  60 =head1 AUTHOR
  61
  62 Chris Nehren
  63
  64 =head1 CONTRIBUTORS
  65
  66 No one, yet. Patches welcome!
  67
  68 =head1 COPYRIGHT
  69
  70 Copyright (c) 2010 Chris Nehren and the CONTRIBUTORS above.
  71
  72 =head1 LICENSE
  73
  74 This library is free software and may be distributed under the same terms
  75 as perl itself.
  76
  77 =cut
  78
  79 1;