source: server/other/rsync.xml@ b5b51a2

10.0 10.1 11.0 11.1 6.3 6.3-rc1 6.3-rc2 6.3-rc3 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 krejzi/svn lazarus nosym perl-modules qt5new systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since b5b51a2 was b5b51a2, checked in by Randy McMurchy <randy@…>, 14 years ago

Updated to rsync-3.0.2

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@7425 af4574ff-66df-0310-9fd7-8a98e5e911e0

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