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