view release on metacpan or  search on metacpan

README  view on Meta::CPAN

Darcs::Notify
-------------

Darcs::Notify compares the list of patches in a darcs repository
against a saved backup copy and sends emails about the changes.

For full documentation, run:
  perldoc darcs-notify

Installation
------------

To build, test and install:

 perl Build.PL

darcs-notify  view on Meta::CPAN

darcs-notify [options] <email> [<email> ...]

  Options:
    --smtp-server=<server>    Use a server other than "localhost".
    -r | --repo=<repo-dir>    Use a repo other than the current directory.
    -h | --help               Show some help.

=head1 DESCRIPTION

B<darcs-notify> compares the list of patches in a darcs repository
against a saved backup copy and sends emails about the changes. The
backup copy is stored in the file
F<_darcs/third-party/darcs-notify/old-inventory>.

=head1 USAGE

One way to use darcs notify is to just run it periodically. Since it
just compares the current list of patches against it's stored set it
can run any time. If there is nothing to report, nothing will happen.

However, typical usage is to install it into your darcs repo's post
hooks so that it runs automatically when someone pushes, pulls, or

lib/Darcs/Notify.pm  view on Meta::CPAN

                                      "user2@example.com"],
                               smtp_server => "smtp.example.com" },
                    IRC => { # Autoloads Darcs::Notify::IRC (if you have it)
                             server => irc.example.com,
                             channel => "#darcs_notify" })
     ->notify;

=head1 DESCRIPTION

B<Darcs::Notify> compares the list of patches in a darcs repository
against a saved backup copy (stored in the file
F<_darcs/third-party/darcs-notify/old-inventory>) and does "something
cool and useful" when it detects added or removed patches. I'm being
cagey about exactly what is done because Darcs::Notify lets you pass
in arbitrary notification methods so that you can customize it to you
liking. L<Darcs::Notify::Email> is the quintessential notifier that
sends email notifications to a list of email addresses.

Normal users will probably just want to use the command line script
L<darcs-notify>, which is a front end to L<Darcs::Notify> and
L<Darcs::Notify::Email>.