.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 "SVN::Notify::Mirror::Rsync 3pm"
.TH SVN::Notify::Mirror::Rsync 3pm "2022-06-17" "perl v5.34.0" "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"
SVN::Notify::Mirror::Rsync \- Mirror a repository path via Rsync
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Use \fIsvnnotify\fR in \fIpost-commit\fR:
.PP
.Vb 9
\&  svnnotify \-\-repos\-path "$1" \-\-revision "$2" \e
\&   \-\-handler Mirror::Rsync \-\-to "/path/to/local/htdocs" \e
\&   [\-\-svn\-binary /full/path/to/svn] \e
\&   \-\-rsync\-host remote_server \e
\&   [\-\-rsync\-delete=[yes|no]] \e
\&   [\-\-rsync\-dest "/path/on/remote/server"] \e
\&   [\-\-rsync\-args arg1 [\-\-rsync\-args arg2...]]
\&   [[\-\-rsync\-ssh] [\-\-ssh\-user remote_user] \e
\&   [\-\-ssh\-identity /home/user/.ssh/id_rsa]]
.Ve
.PP
or better yet, use SVN::Notify::Config for a more
sophisticated setup:
.PP
.Vb 10
\&  #!/usr/bin/perl \-MSVN::Notify::Config=$0
\&  \-\-\- #YAML:1.0
\&  \*(Aq\*(Aq:
\&    PATH: "/usr/bin:/usr/local/bin"
\&  \*(Aqpath/in/repository\*(Aq:
\&    handler: Mirror
\&    to: "/path/to/www/htdocs"
\&  \*(Aqsome/other/path/in/repository\*(Aq:
\&    handler: Mirror
\&    to: "/path/to/local/www/htdocs"
\&    rsync\-host: "remote_host"
\&    rsync\-dest: "/path/on/remote/www/htdocs"
\&    ssh\-user: "remote_user"
\&    ssh\-identity: "/home/user/.ssh/id_rsa"
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Keep a directory in sync with a portion of a Subversion repository.
Typically used to keep a development web server in sync with the changes
made to the repository.  This directory can either be on the same box as
the repository itself, or it can be remote (via \s-1SSH\s0 connection).
.SH "USAGE"
.IX Header "USAGE"
Depending on whether the target is a \*(L"Local Mirror\*(R" or a Remote
Mirror, there are different options available.  All options are
available either as a commandline option to svnnotify or as a hash
key in SVN::Notify::Config (see their respective documentation for
more details).
.SS "Working Copy on Local host"
.IX Subsection "Working Copy on Local host"
Because 'svn export' is not able to be consistently updated, the
local rsync'd directory must be a full working copy.  The remote server
will only contain the ordinary files (no Subversion admin files).
.PP
The files in the working copy must be writeable (preferrably owned)
by the user identity executing the hook script (this is the user 
identity that is running Apache or svnserve respectively).
.SH "Local Mirror"
.IX Header "Local Mirror"
Please see SVN::Notify::Mirror for details.
.SS "Remote Mirror"
.IX Subsection "Remote Mirror"
Used for directories not located on the same machine as the
repository itself.  Typically, this might be a production web
server located in a \s-1DMZ,\s0 so special consideration must be paid
to security concerns.  In particular, the remote mirror server
may not be able to directly access the repository box.
.IP "\(bu" 4
rsync-host
.Sp
This value is required and must be the hostname or \s-1IP\s0 address
of the remote host (where the mirror directories reside).
.IP "\(bu" 4
rsync-delete
.Sp
The default mode of operation is to delete remote files which are
not present in the local working copy.  \s-1NOTE:\s0 this will \fBdelete\fR
any unversioned files in the remote directory tree.  Unless you
have all of your files under version control, you should pass the 
\&\f(CW\*(C`\-\-no\-rsync\-delete\*(C'\fR or \f(CW\*(C`\-\-rsync\-delete no\*(C'\fR option.
.IP "\(bu" 4
rsync-dest
.Sp
This optional value specifies the path to update on the remote
host.  If you do not specify this value, the same path as passed
in as the \f(CW\*(C`\-\-to\*(C'\fR parameter will be used (this may not be what you
meant to do).
.IP "\(bu" 4
rsync-args
.Sp
This optional parameter can be used to pass additional commandline
options to the rsync command.  You can use this multiple times in
order to pass multiple options.  The default args are \f(CW\*(C`\-\-archive 
\&\-\-compress\*(C'\fR.  See the \f(CW\*(C`rsync\-ssh\*(C'\fR options for using \s-1SSH\s0 instead of
\&\s-1RSH\s0 (rather than pass those commands via \f(CW\*(C`\-\-rsync\-args\*(C'\fR
.IP "\(bu" 4
rsync-ssh
.Sp
This optional parameter signals that you wish to use \s-1SSH\s0 instead of
whatever the default remote shell program is configured in your
copy of rsync.  You may need to set one or more of the \f(CW\*(C`ssh\-*\*(C'\fR
parameters as well.
.IP "\(bu" 4
ssh-user
.Sp
If the remote user is different than the local user executing the
postcommit script, you can specify it with this parameter.  You would
often use this in conjunction with the next parameter.
.IP "\(bu" 4
ssh-identity
.Sp
This value may be optional and should be the full path to the
local identity file being used to authenticate with the remote
host. If you are setting the ssh-user to be something other than
the local user name, you will typically also have to set the
ssh-identity.
.SH "AUTHOR"
.IX Header "AUTHOR"
John Peacock <jpeacock@cpan.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2005\-2008 John Peacock
.PP
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
\&\s-1LICENSE\s0 file included with this module.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
SVN::Notify, SVN::Notify::Config, SVN::Notify::Mirror