README.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 Promulger -- Simple, Unixy mailing list manager
   6
   7 =head1 SYNOPSIS
   8
   9   # In a config file somewhere:
  10   aliases = /path/to/etc/aliases
  11   list_home = /path/your/mta/can/write/to/lists
  12
  13   # then
  14   /path/to/pmg/bin/pmg -c /path/to/config/pmg.conf newlist mylist
  15
  16   # then
  17   mail -s subscribe mylist-request@yourhost < /dev/null
  18   mail -s post mylist@yourhost < first_post
  19
  20   # cleanup
  21   /path/to/pmg/bin/pmg -c /path/to/config/pmg.conf rmlist mylist
  22
  23 =head1 DESCRIPTION
  24
  25 Promulger is a simple, lightweight mailinglist manager (mlm) that subscribes to
  26 the Unix philosophy and aims to be sysadmin-friendly. Plaintext configuration
  27 and data files are favored over opaque binary files. The simplest possible thing
  28 that can work is the preferred approach. Simple algorithms, simple tools that do
  29 one thing well. An administrator should be able to read the config files and the
  30 data files without reading these docs and understand what's going on.
  31
  32 Promulger strives to be easy to install while not reinventing the wheel. To this
  33 end it uses modern tools on the CPAN where it makes sense, but nonetheless tries
  34 to be minimal. It doesn't need the enterprise-grade flexibility of L<Catalyst>,
  35 but at the same time writing raw CGI was bad ten years ago and still is.
  36
  37 Another design goal (one further in the future) is standards-compliance. There
  38 are a number of documents and RFCs related to email and mailing lists. Promulger
  39 seeks to adhere to these where it makes sense to do so, with the belief that
  40 consistent software is easier to use and manage. As Promulger supports relevant
  41 standards, the documentation will be updated to describe which standards are
  42 respected and any deviations (along with the rationale therefor).
  43
  44 =head1 LIMITATIONS
  45
  46 Consider this section a TODO list.
  47
  48 Presently, Promulger doesn't support VERP, and as a result doesn't support
  49 bounce parsing. It's being released to be tested on small, closed networks with
  50 clueful admins. If fishing messages out of your MTA's queue isn't something you
  51 feel comfortable doing, Promulger isn't for you right now.
  52
  53 Another thing Promulger lacks is an archive. This is coming, but in the
  54 meantime, you're on your own.
  55
  56 There's no support for the standard mailing list headers. This means that
  57 filtering will need to work on the mailing list sender address for now.
  58
  59 It's not very customizable--in fact, it has no flexibility at all.
  60
  61 =head1 ENVIRONMENT
  62
  63 Promulger doesn't read any environment variables.
  64
  65 =head1 AUTHOR
  66
  67 Chris Nehren
  68
  69 =head1 CONTRIBUTORS
  70
  71 No one, yet. Patches welcome!
  72
  73 =head1 COPYRIGHT
  74
  75 Copyright (c) 2010, 2011 Chris Nehren and the CONTRIBUTORS above.
  76
  77 =head1 LICENSE
  78
  79 This library is free software and may be distributed under the same terms
  80 as perl itself.
  81
  82 =cut