| 1 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> |
| 2 | <book id="rsync"> |
| 3 | <bookinfo> |
| 4 | <title>rsync</title> |
| 5 | <copyright> |
| 6 | <year>1996 -- 2002</year> |
| 7 | <holder>Martin Pool</holder> |
| 8 | <holder>Andrew Tridgell</holder> |
| 9 | </copyright> |
| 10 | <author> |
| 11 | <firstname>Martin</firstname> |
| 12 | <surname>Pool</surname> |
| 13 | </author> |
| 14 | </bookinfo> |
| 15 | |
| 16 | <chapter> |
| 17 | <title>Introduction</title> |
| 18 | |
| 19 | <para>rsync is a flexible program for efficiently copying files or |
| 20 | directory trees. |
| 21 | |
| 22 | <para>rsync has many options to select which files will be copied |
| 23 | and how they are to be transferred. It may be used as an |
| 24 | alternative to ftp, http, scp or rcp. |
| 25 | |
| 26 | <para>The rsync remote-update protocol allows rsync to transfer just |
| 27 | the differences between two sets of files across the network link, |
| 28 | using an efficient checksum-search algorithm described in the |
| 29 | technical report that accompanies this package.</para> |
| 30 | |
| 31 | <para>Some of the additional features of rsync are:</para> |
| 32 | |
| 33 | <itemizedlist> |
| 34 | |
| 35 | <listitem> |
| 36 | <para>support for copying links, devices, owners, groups and |
| 37 | permissions |
| 38 | </para> |
| 39 | </listitem> |
| 40 | |
| 41 | <listitem> |
| 42 | <para> |
| 43 | exclude and exclude-from options similar to GNU tar |
| 44 | </para> |
| 45 | </listitem> |
| 46 | |
| 47 | <listitem> |
| 48 | <para> |
| 49 | a CVS exclude mode for ignoring the same files that CVS would ignore |
| 50 | </listitem> |
| 51 | |
| 52 | <listitem> |
| 53 | <para> |
| 54 | can use any transparent remote shell, including rsh or ssh |
| 55 | </listitem> |
| 56 | |
| 57 | <listitem> |
| 58 | <para> |
| 59 | does not require root privileges |
| 60 | </listitem> |
| 61 | |
| 62 | <listitem> |
| 63 | <para> |
| 64 | pipelining of file transfers to minimize latency costs |
| 65 | </listitem> |
| 66 | |
| 67 | <listitem> |
| 68 | <para> |
| 69 | support for anonymous or authenticated rsync servers (ideal for |
| 70 | mirroring) |
| 71 | </para> |
| 72 | </listitem> |
| 73 | </itemizedlist> |
| 74 | </chapter> |
| 75 | |
| 76 | |
| 77 | |
| 78 | <chapter> |
| 79 | <title>Using rsync</title> |
| 80 | <section> |
| 81 | <title> |
| 82 | Introductory example |
| 83 | </title> |
| 84 | |
| 85 | <para> |
| 86 | Probably the most common case of rsync usage is to copy files |
| 87 | to or from a remote machine using |
| 88 | <application>ssh</application> as a network transport. In |
| 89 | this situation rsync is a good alternative to |
| 90 | <application>scp</application>. |
| 91 | </para> |
| 92 | |
| 93 | <para> |
| 94 | The most commonly used arguments for rsync are |
| 95 | </para> |
| 96 | |
| 97 | <!-- |
| 98 | @item -a |
| 99 | Reproduce the structure and attributes of the origin files as exactly |
| 100 | as possible: this includes copying subdirectories, symlinks, special |
| 101 | files, ownership and permissions. (@xref{Attributes to copy}.) |
| 102 | |
| 103 | @item -v |
| 104 | Be verbose. Primarily, display the name of each file as it is copied. |
| 105 | |
| 106 | @item -z |
| 107 | Compress network traffic, using a modified version of the |
| 108 | @command{zlib} library. |
| 109 | |
| 110 | @item -P |
| 111 | Display a progress indicator while files are transferred. This should |
| 112 | normally be ommitted if rsync is not run on a terminal. |
| 113 | --> |
| 114 | </section> |
| 115 | </chapter> |
| 116 | </book> |