[0931098] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[0931098] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[10ea80a9] | 7 | <!ENTITY rsync-download-http "http://samba.org/ftp/rsync/src/rsync-&rsync-version;.tar.gz">
|
---|
| 8 | <!ENTITY rsync-download-ftp "ftp://ftp.samba.org/pub/rsync/src/rsync-&rsync-version;.tar.gz">
|
---|
| 9 | <!ENTITY rsync-md5sum "b53525900817cf1ba7ad3a516ab5bfe9">
|
---|
[b5b51a2] | 10 | <!ENTITY rsync-size "765 KB">
|
---|
| 11 | <!ENTITY rsync-buildsize "35 MB (includes installing all documentation)">
|
---|
[1e642794] | 12 | <!ENTITY rsync-time "0.2 SBU">
|
---|
[0931098] | 13 | ]>
|
---|
| 14 |
|
---|
[46cef72] | 15 | <sect1 id="rsync" xreflabel="rsync-&rsync-version;">
|
---|
[5ab6e72] | 16 | <?dbhtml filename="rsync.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>rsync-&rsync-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="rsync">
|
---|
| 26 | <primary sortas="a-rsync">rsync</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to rsync</title>
|
---|
| 31 |
|
---|
| 32 | <para>The <application>rsync</application> package contains the
|
---|
| 33 | <command>rsync</command> utility. This is useful for synchronizing large
|
---|
| 34 | file archives over a network.</para>
|
---|
| 35 |
|
---|
| 36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 37 | <itemizedlist spacing="compact">
|
---|
| 38 | <listitem>
|
---|
| 39 | <para>Download (HTTP): <ulink url="&rsync-download-http;"/></para>
|
---|
| 40 | </listitem>
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>Download (FTP): <ulink url="&rsync-download-ftp;"/></para>
|
---|
| 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>Download MD5 sum: &rsync-md5sum;</para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>Download size: &rsync-size;</para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>Estimated disk space required: &rsync-buildsize;</para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>Estimated build time: &rsync-time;</para>
|
---|
| 55 | </listitem>
|
---|
| 56 | </itemizedlist>
|
---|
| 57 |
|
---|
| 58 | <bridgehead renderas="sect3">rsync Dependencies</bridgehead>
|
---|
| 59 |
|
---|
| 60 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[aca42dac] | 61 | <para role="optional"><xref linkend="popt"/>,
|
---|
[31784c8] | 62 | <xref linkend="attr"/>,
|
---|
| 63 | <xref linkend="acl"/></para>
|
---|
[5ab6e72] | 64 |
|
---|
[3cb0c57] | 65 | <para condition="html" role="usernotes">User Notes:
|
---|
| 66 | <ulink url="&blfs-wiki;/rsync"/></para>
|
---|
| 67 |
|
---|
[5ab6e72] | 68 | </sect2>
|
---|
| 69 |
|
---|
| 70 | <sect2 role="installation">
|
---|
| 71 | <title>Installation of rsync</title>
|
---|
| 72 |
|
---|
| 73 | <para>For security reasons, running the <application>rsync</application>
|
---|
| 74 | server as an unprivileged user and group is encouraged. If you intend to
|
---|
| 75 | run <command>rsync</command> as a daemon, create the
|
---|
| 76 | <systemitem class="username">rsyncd</systemitem> user and group
|
---|
[bccbdaea] | 77 | with the following commands issued by the
|
---|
[fdf798a6] | 78 | <systemitem class="username">root</systemitem> user:</para>
|
---|
[5ab6e72] | 79 |
|
---|
[fdf798a6] | 80 | <screen role="root"><userinput>groupadd -g 48 rsyncd &&
|
---|
| 81 | useradd -c "rsyncd Daemon" -d /home/rsync -g rsyncd \
|
---|
| 82 | -s /bin/false -u 48 rsyncd</userinput></screen>
|
---|
[5ab6e72] | 83 |
|
---|
| 84 | <para>Install <application>rsync</application> by running the following
|
---|
| 85 | commands:</para>
|
---|
| 86 |
|
---|
| 87 | <screen><userinput>./configure --prefix=/usr &&
|
---|
[fdf798a6] | 88 | make</userinput></screen>
|
---|
| 89 |
|
---|
[9b7fb82] | 90 | <para>If you have <xref linkend="doxygen"/> installed and wish to
|
---|
[aca42dac] | 91 | build HTML API documentation, issue <command>doxygen</command>.</para>
|
---|
[9b7fb82] | 92 |
|
---|
| 93 | <para>If you have <xref linkend="docbook-utils"/> installed and wish to
|
---|
| 94 | build the user documentation, issue any or all of the following
|
---|
| 95 | commands:</para>
|
---|
[fdf798a6] | 96 |
|
---|
[aca42dac] | 97 | <screen><userinput>pushd doc &&
|
---|
[9b7fb82] | 98 | docbook2pdf rsync.sgml &&
|
---|
| 99 | docbook2ps rsync.sgml &&
|
---|
| 100 | docbook2dvi rsync.sgml &&
|
---|
| 101 | docbook2txt rsync.sgml &&
|
---|
| 102 | docbook2html --nochunks rsync.sgml &&
|
---|
[aca42dac] | 103 | popd</userinput></screen>
|
---|
[fdf798a6] | 104 |
|
---|
| 105 | <para>To test the results, issue: <command>make check</command>.</para>
|
---|
| 106 |
|
---|
| 107 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 108 |
|
---|
| 109 | <screen role='root'><userinput>make install</userinput></screen>
|
---|
| 110 |
|
---|
[9b7fb82] | 111 | <para>If you built the documentation, install it using the following
|
---|
[fdf798a6] | 112 | commands as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 113 |
|
---|
[9b7fb82] | 114 | <screen role='root'><userinput>install -v -m755 -d /usr/share/doc/rsync-&rsync-version;/api &&
|
---|
| 115 | install -v -m644 dox/html/* /usr/share/doc/rsync-&rsync-version;/api &&
|
---|
| 116 | install -v -m644 doc/rsync.* /usr/share/doc/rsync-&rsync-version;</userinput></screen>
|
---|
[0931098] | 117 |
|
---|
[5ab6e72] | 118 | </sect2>
|
---|
[0931098] | 119 |
|
---|
[5ab6e72] | 120 | <sect2 role="configuration">
|
---|
| 121 | <title>Configuring rsync</title>
|
---|
[0931098] | 122 |
|
---|
[5ab6e72] | 123 | <sect3 id="rsync-config">
|
---|
| 124 | <title>Config Files</title>
|
---|
[0931098] | 125 |
|
---|
[5ab6e72] | 126 | <para><filename>/etc/rsyncd.conf</filename></para>
|
---|
[0931098] | 127 |
|
---|
[5ab6e72] | 128 | <indexterm zone="rsync rsync-config">
|
---|
| 129 | <primary sortas="e-etc-rsyncd.conf">/etc/rsyncd.conf</primary>
|
---|
| 130 | </indexterm>
|
---|
| 131 |
|
---|
| 132 | </sect3>
|
---|
| 133 |
|
---|
| 134 | <sect3>
|
---|
| 135 | <title>Configuration Information</title>
|
---|
| 136 |
|
---|
[bccbdaea] | 137 | <para>For client access to remote files, you may need to install the
|
---|
[fdf798a6] | 138 | <xref linkend="openssh"/> package to connect to the remote server.</para>
|
---|
| 139 |
|
---|
[bccbdaea] | 140 | <para>This is a simple download-only configuration to set up running
|
---|
[fdf798a6] | 141 | <command>rsync</command> as a server. See the rsyncd.conf(5)
|
---|
[5ab6e72] | 142 | man-page for additional options (i.e., user authentication).</para>
|
---|
| 143 |
|
---|
| 144 | <screen role="root"><userinput>cat > /etc/rsyncd.conf << "EOF"
|
---|
| 145 | <literal># This is a basic rsync configuration file
|
---|
[0931098] | 146 | # It exports a single module without user authentication.
|
---|
| 147 |
|
---|
| 148 | motd file = /home/rsync/welcome.msg
|
---|
| 149 | use chroot = yes
|
---|
| 150 |
|
---|
| 151 | [localhost]
|
---|
| 152 | path = /home/rsync
|
---|
| 153 | comment = Default rsync module
|
---|
| 154 | read only = yes
|
---|
| 155 | list = yes
|
---|
| 156 | uid = rsyncd
|
---|
| 157 | gid = rsyncd
|
---|
[5ab6e72] | 158 | </literal>
|
---|
| 159 | EOF</userinput></screen>
|
---|
[0931098] | 160 |
|
---|
[fdf798a6] | 161 | <para>You can find additional configuration information and general
|
---|
| 162 | documentation about <command>rsync</command> at
|
---|
| 163 | <ulink url="http://rsync.samba.org/documentation.html"/>.</para>
|
---|
[bccbdaea] | 164 |
|
---|
[5ab6e72] | 165 | </sect3>
|
---|
[0931098] | 166 |
|
---|
[fdf798a6] | 167 | <sect3 id="rsync-init">
|
---|
[5ab6e72] | 168 | <title>Boot Script</title>
|
---|
[0931098] | 169 |
|
---|
[5ab6e72] | 170 | <para>Note that you only want to start the
|
---|
[fdf798a6] | 171 | <application>rsync</application> server if you want to provide an
|
---|
[5ab6e72] | 172 | <application>rsync</application> archive on your local machine.
|
---|
| 173 | You don't need this script to run the
|
---|
| 174 | <application>rsync</application> client.</para>
|
---|
[fce1d8e] | 175 |
|
---|
[5ab6e72] | 176 | <para>Install the <filename>/etc/rc.d/init.d/rsyncd</filename> init
|
---|
| 177 | script included in the
|
---|
[5254d12] | 178 | <xref linkend="bootscripts"/> package.</para>
|
---|
[0931098] | 179 |
|
---|
[5ab6e72] | 180 | <screen role="root"><userinput>make install-rsyncd</userinput></screen>
|
---|
[0931098] | 181 |
|
---|
[5ab6e72] | 182 | </sect3>
|
---|
[0931098] | 183 |
|
---|
[5ab6e72] | 184 | </sect2>
|
---|
[0931098] | 185 |
|
---|
[5ab6e72] | 186 | <sect2 role="content">
|
---|
| 187 | <title>Contents</title>
|
---|
[0931098] | 188 |
|
---|
[5ab6e72] | 189 | <segmentedlist>
|
---|
| 190 | <segtitle>Installed Program</segtitle>
|
---|
| 191 | <segtitle>Installed Libraries</segtitle>
|
---|
| 192 | <segtitle>Installed Directories</segtitle>
|
---|
[0931098] | 193 |
|
---|
[5ab6e72] | 194 | <seglistitem>
|
---|
| 195 | <seg>rsync</seg>
|
---|
| 196 | <seg>None</seg>
|
---|
[fdf798a6] | 197 | <seg>Optionally, /usr/share/doc/rsync-&rsync-version;</seg>
|
---|
[5ab6e72] | 198 | </seglistitem>
|
---|
| 199 | </segmentedlist>
|
---|
[0931098] | 200 |
|
---|
[5ab6e72] | 201 | <variablelist>
|
---|
| 202 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 203 | <?dbfo list-presentation="list"?>
|
---|
| 204 | <?dbhtml list-presentation="table"?>
|
---|
[0931098] | 205 |
|
---|
[5ab6e72] | 206 | <varlistentry id="rsync-prog">
|
---|
| 207 | <term><command>rsync</command></term>
|
---|
| 208 | <listitem>
|
---|
| 209 | <para>is a replacement for <command>rcp</command> (and
|
---|
| 210 | <command>scp</command>) that has many more features. It uses the
|
---|
[fdf798a6] | 211 | <quote>rsync algorithm</quote> which provides a very fast method of
|
---|
| 212 | syncing remote files. It does this by sending just the differences
|
---|
| 213 | in the files across the link, without requiring that both sets of
|
---|
| 214 | files are present at one end of the link beforehand.</para>
|
---|
[5ab6e72] | 215 | <indexterm zone="rsync rsync-prog">
|
---|
| 216 | <primary sortas="b-rsync">rsync</primary>
|
---|
| 217 | </indexterm>
|
---|
| 218 | </listitem>
|
---|
| 219 | </varlistentry>
|
---|
[0931098] | 220 |
|
---|
[5ab6e72] | 221 | </variablelist>
|
---|
[46cef72] | 222 |
|
---|
[5ab6e72] | 223 | </sect2>
|
---|
[46cef72] | 224 |
|
---|
[5ab6e72] | 225 | </sect1>
|
---|