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