.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "SVN::Notify::Alternative 3pm"
.TH SVN::Notify::Alternative 3pm "2018-07-03" "perl v5.26.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "Name"
.IX Header "Name"
SVN::Notify::Alternative \- \s-1MIME\s0 multipart/alternative notification
.SH "Synopsis"
.IX Header "Synopsis"
Use \fIsvnnotify\fR in \fIpost-commit\fR:
.PP
.Vb 2
\&  svnnotify \-\-repos\-path "$1" \-\-revision "$2" \e
\&    \-\-to developers@example.com \-\-handler Alternative [options]
.Ve
.PP
For example:
.PP
.Vb 3
\&  svnnotify \-\-repos\-path "$1" \-\-revision "$2" \e
\&    \-\-to developers@example.com \-\-handler Alternative \e
\&    \-\-alternative HTML::ColorDiff
.Ve
.PP
Use the class in a custom script:
.PP
.Vb 1
\&  use SVN::Notify::Alternative;
\&
\&  my $notifier = SVN::Notify::Alternative\->new(%params);
\&  $notifier\->prepare;
\&  $notifier\->execute;
.Ve
.SH "Description"
.IX Header "Description"
This subclass of SVN::Notify sends \s-1MIME\s0 multipart/alternative
email messages for Subversion activity. The messages contain both the standard
SVN::Notify plain text change notification and one or more alternative formats
of the message. The default alternative format is \s-1HTML\s0.
.PP
Note that this means that many or all of the processing of a subversion commit
will be executed multiple times, once for the plain text version and then
again for each alternative version. This will therefore increase resource
usage on your Subversion server (mainly processor time, but also possibly
memory).
.PP
It also means that the size of the outgoing message will increase for each
alternative. If you're using \f(CW\*(C`\-\-with\-diff\*(C'\fR, then those messages could be very
large indeed for large commits. If, however, you use \f(CW\*(C`\-\-attach\-diff\*(C'\fR, the
diff will only be attached to the last alternative.
.SH "Usage"
.IX Header "Usage"
To use SVN::Notify::Alternative, simply follow the
instructions in SVN::Notify, but when using \fIsvnnotify\fR,
use the \f(CW\*(C`\-\-alternative\*(C'\fR option to add one or more alternative formats.
.SH "Class Interface"
.IX Header "Class Interface"
.SS "Constructor"
.IX Subsection "Constructor"
\fInew\fR
.IX Subsection "new"
.PP
.Vb 1
\&  my $notifier = SVN::Notify::Alternative\->new(%params);
.Ve
.PP
Constructs and returns a new SVN::Notify object. All parameters supported by
SVN::Notity are supported here, as are the options of all specified
alternative formats, but SVN::Notify::Alternative supports an additional
parameter:
.IP "alternatives" 4
.IX Item "alternatives"
.Vb 2
\&  svnnotify \-\-alternative HTML
\&  svnnotify \-\-alt HTML \-\-alt HTML::ColorDiff
.Ve
.Sp
An array reference that specifies the SVN::Notify handlers (subclasses) to be
used for formatting the alternative parts of the notification message. The
command-line option may be called as either \f(CW\*(C`\-\-alternative\*(C'\fR or \f(CW\*(C`\-\-alt\*(C'\fR, and
the value is the same as that of the SVN::Notify \f(CW\*(C`\-\-handler\*(C'\fR parameter, i.e.
the module name without the \*(L"SVN::Notify::\*(R" prefix. Specify the option
multiple times to specify multiple alternative handlers. Defaults to
\&\f(CW\*(C`[\*(AqHTML\*(Aq]\*(C'\fR if not specified.
.SH "Instance Interface"
.IX Header "Instance Interface"
.SS "Instance Methods"
.IX Subsection "Instance Methods"
\fIoutput\fR
.IX Subsection "output"
.PP
.Vb 1
\&  $notifier\->output($file_handle);
.Ve
.PP
Overrides the \f(CW\*(C`output()\*(C'\fR method of SVN::Notify to replace the standard
message output with a \s-1MIME\s0 \f(CW\*(C`multipart/alternative\*(C'\fR skeleton. It then creates
new instances of the standard SVN::Notify plain text formatter and each of the
configured alternative formatters, and uses those instances to fill in the
alternative parts of the message. If \f(CW\*(C`attach_diff\*(C'\fR is true, it will be used
only in the last alternative to be output, which should also be the richest
format.
.SS "Accessors"
.IX Subsection "Accessors"
In addition to those supported by SVN::Notify,
SVN::Notify::Alternative supports the following accessors:
.PP
\fIalternatives\fR
.IX Subsection "alternatives"
.PP
.Vb 2
\&  my $alts = $notify\->alternatives;
\&  $notify\->alternatives($alts);
.Ve
.PP
Gets or sets the value of the \f(CW\*(C`alternatives\*(C'\fR attribute, which must always be
set to an array reference.
.SH "See Also"
.IX Header "See Also"
.IP "SVN::Notify" 4
.IX Item "SVN::Notify"
.SH "Authors"
.IX Header "Authors"
Jukka Zitting <jz@yukatan.fi>
.PP
David E. Wheeler <david@justatheory.com>
.SH "Copyright and License"
.IX Header "Copyright and License"
Copyright (c) 2005 Jukka Zitting and 2005\-2016 David E. Wheeler. Some Rights
Reserved.
.PP
This module is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.