JezK
Edit File: svnnotify.1p
.\" Automatically generated by Pod::Man 4.10 (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 .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" 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 "SVNNOTIFY 1" .TH SVNNOTIFY 1 "2019-07-01" "perl v5.28.1" "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" svnnotify \- Subversion activity notification .SH "Usage" .IX Header "Usage" .Vb 1 \& svnnotify \-\-repos\-path "$1" \-\-revision "$2" [options] .Ve .SH "Options" .IX Header "Options" .Vb 10 \& \-p \-\-repos\-path PATH Path to the Subversion repository. Required. \& \-r \-\-revision REVISION Commit revision number. Required. \& \-t \-\-to ADDRESS The notification destination email address. \& Required unless \-\-to\-regex\-map. \& \-x \-\-to\-regex\-map TO=REGEX A mapping between a destination email address \& and a regular expression to match against the \& directories affected by the commit. Required \& unless \-\-to or \-\-to\-email\-map. \& \-\-to\-email\-map REGEX=TO The inverse of \-\-to\-regex\-map: Map a regular \& expression to an email address. Required unless \& \-\-to or \-\-to\-regex\-map. \& \-f \-\-from ADDRESS Email address to use in the From header. \& \-D \-\-user\-domain DOMAIN Domain name to append to the username to \& complete the email address in the From header. \& \-l \-\-svnlook SVNLOOK Location of the svnlook executable. \& \-s \-\-sendmail SENDMAIL Location of the sendmail executable. \& \-E \-\-set\-sender Set the envelope sender to the from address. \& \-\-smtp ADDRESS Address for an SMTP server. \& \-\-smtp\-user USERNAME Username for authenticating to a SMTP server. \& \-\-smtp\-pass PASSWORD Password for authenticating to a SMTP server. \& \-\-smtp\-port PORT Port to connect to on the SMTP server. \& \-\-smtp\-tls Enable TLS/SSL connection to the SMTP server. \& \-c \-\-encoding ENCODING The character encoding for reading and writing \& data. \& \-\-svn\-encoding ENCODING The character encoding of the log message and \& the repository files. \& \-\-diff\-encoding ENCODING The character encoding of the repository files. \& \-g \-\-language LANGUAGE Value for the Content\-Language header and $LANG \& environment variable. \& \-d \-\-with\-diff Include the diff in the message. \& \-a \-\-attach\-diff Attach the diff to the message. \& \-w \-\-diff\-switches SWITCHES Switches to pass to C<svnlook diff>. \& \-\-diff\-content\-type TYPE Sets the Content\-Type for diff attachments. \& \-R \-\-reply\-to ADDRESS Address for use in the Reply\-To header. \& \-\-add\-header NAME=VALUE Add an extra header to the email. \& \-P \-\-subject\-prefix PREFIX String to prepend to the subject. \& \-C \-\-subject\-cx Include the context of the commit in the \& subject. \& \-X \-\-strip\-cx\-regex Regex to remove part of the CX file name from \& the subject. \& \-O \-\-no\-first\-line Do not include the first line of the log \& message in the subject. \& \-i \-\-max\-sub\-length LENGTH Maximum size of the subject line. \& \-e \-\-max\-diff\-length LENGTH Maximum size of the diff output. \& \-H \-\-handler HANDLER The notification handler, such as "HTML". \& \-F \-\-filter FILTER An output filter, such as "Markdown". \& \-A \-\-author\-url URL Include link to specified author URL. \& \-U \-\-revision\-url URL Include links to specified Revision URL. \& \-T \-\-rt\-url URL Include links to specified Request Tracker URL. \& \-B \-\-bugzilla\-url URL Include links to specified Bugzilla URL. \& \-J \-\-jira\-url URL Include links to specified JIRA URL. \& \-G \-\-gnats\-url URL Include links to specified Gnats URL. \& \-\-ticket\-map REGEX=URL Regex and URL for custom ticket identifiers. \& \-\-header HEADER Text header to display before body. \& \-\-footer FOOTER Text footer to display at end of body. \& \-V \-\-verbose Incremental verbose mode. \& \-h \-\-help Print this usage statement and exit. \& \-m \-\-man Print the complete documentation and exit. \& \-v \-\-version Print the version number and exit. .Ve .PP More options may be supported by the subclass of SVN::Notify specified by the \&\f(CW\*(C`\-\-handler\*(C'\fR option or by filters specified by the \f(CW\*(C`\-\-filter\*(C'\fR option. Consult the documentation of the relevant modules for details. .SH "See Also" .IX Header "See Also" See SVN::Notify for the complete documentation. If you're having issues with character encodings, see especially the Character Encoding Support section. .SH "Author" .IX Header "Author" David E. Wheeler <david@justatheory.com> .SH "Copyright and License" .IX Header "Copyright and License" Copyright (c) 2004\-2018 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.