README.md
1SVN/Notify version 2.87
2=======================
3
4This class may be used for sending email messages for
5[Subversion](http://subversion.tigris.org/) repository activity. There are a
6number of different modes supported, and SVN::Notify is fully subclassable, to
7easily add new functionality. By default, a list of all the files affected by
8the commit will be assembled and listed in a single message. An additional
9option allows diffs to be calculated for the changes and either appended to
10the message or added as an attachment. The included subclass,
11SVN::Notify::HTML, allows the messages to be sent in HTML format.
12
13Installation
14------------
15
16To install this module, type the following:
17
18 perl Build.PL
19 ./Build
20 ./Build test
21 ./Build install
22
23Or, if you don't have Module::Build installed, type the following:
24
25 perl Makefile.PL
26 make
27 make test
28 make install
29
30Dependencies
31------------
32
33SVN::Notify has the following dependencies:
34
35* Getopt::Long
36 This module is included with Perl.
37
38* Pod::Usage
39 For calling 'svnnotify' with the --help or --man options, or when it fails
40 to process the command-line options, usage output will be triggered by
41 Pod::Usage, has been included with Perl since 5.6.0.
42
43* HTML::Entities
44 This module is required for sending HTML-formatted notifications with
45 SVN::Notify::HTML.
46
47* Net::SMTP
48 This module is required for sending notification messages via SMTP rather
49 than by sendmail (e.g., under Windows). That is, it is required when using
50 the --smtp option.
51
52* Net::SMTP_auth
53 This module is required for sending notifications messages via an
54 authenticating SMTP server, i.e., when using the --smtp-authtype option.
55
56Copyright and License
57---------------------
58
59Copyright (c) 2004-2018 David E. Wheeler. Some Rights Reserved.
60
61This module is free software; you can redistribute it and/or modify it under
62the same terms as Perl itself.
63