Make sure secrets file is not other-accessible, and owned by root if the
[rsync/rsync.git] / README
diff --git a/README b/README
index 1eca449..e037f51 100644 (file)
--- a/README
+++ b/README
@@ -47,19 +47,26 @@ Options:
     --rsync-path PATH    specify path to rsync on the remote machine
 -C, --cvs-exclude        auto ignore files in the same way CVS does
     --delete             delete files that don't exist on the sending side
+    --force              force deletion of directories even if not empty
+    --numeric-ids        don't map uid/gid values by user/group name
+    --timeout TIME       set IO timeout in seconds
 -I, --ignore-times       don't exclude files that match length and time
+-T  --temp-dir DIR       create temporary files in directory DIR
 -z, --compress           compress file data
     --exclude FILE       exclude file FILE
     --exclude-from FILE  exclude files listed in FILE
     --suffix SUFFIX      override backup suffix
     --version            print version number
+    --daemon             run as a rsync daemon
+    --config FILE        specify alternate rsyncd.conf file
+    --port PORT          specify alternate rsyncd port number
 
 
 SETUP
 -----
 
 Rsync uses rsh or ssh for communication. It does not need to be setuid
-and requires no special privilages for installation. It does not
+and requires no special privileges for installation. It does not
 require a inetd entry or a daemon. You must, however, have a working
 rsh or ssh system. Using ssh is recommended for its security
 features. 
@@ -68,9 +75,23 @@ To install rsync, first run the "configure" script. This will create a
 Makefile and config.h appropriate for your system. Then type
 "make". 
 
+Note that on some systems you will have to force configure not to use
+gcc because gcc may not support some features (such as 64 bit file
+offsets) that your system may support. Set the environment variable CC
+to the name of your native compiler before running configure in this
+case. 
+
 Once built put a copy of rsync in your search path on the local and
 remote systems (or use "make install"). That's it!
 
+RSYNC SERVERS
+-------------
+
+rsync can also talk to "rsync servers" which can provide anonymous or
+authenticated rsync. See the rsyncd.conf(5) man page for details on how
+to setup a rsync server. See the rsync(1) man page for info on how to
+connect to a rsync server.
+
 
 MAILING LIST
 ------------
@@ -79,25 +100,25 @@ There is a mailing list for the discussion of rsync and its
 applications. It is open to anyone to join. I will announce new
 versions on this list. 
 
-To join the mailing list send mail to listproc@samba.anu.edu.au with
+To join the mailing list send mail to listproc@samba.org with
 no subject and a body of "subscribe rsync Your Name".
 
-To send mail to everyone on the list send it to rsync@samba.anu.edu.au
+To send mail to everyone on the list send it to rsync@samba.org
 
 
 BUG REPORTS
 -----------
 
 If you have web access then please look at
-http://samba.anu.edu.au/cgi-bin/rsync 
+http://rsync.samba.org/rsync/ 
 
 This will give you access to the bug tracking system used by the
 developers of rsync and will allow you to look at other bug reports or
 submit a new bug report.
 
 If you don't have web access then mail bug reports to
-rsync-bugs@samba.anu.edu.au or (if you think it will be of interest to
-lots of people) send it to rsync@samba.anu.edu.au
+rsync-bugs@samba.org or (if you think it will be of interest to lots
+of people) send it to rsync@samba.org
 
 
 CVS TREE
@@ -107,10 +128,10 @@ If you want to get the very latest version of rsync direct from the
 source code repository then you can use anonymous cvs. You will need a
 recent version of cvs then use the following commands:
 
-       cvs -d :pserver:cvs@samba.anu.edu.au:/cvsroot login
+       cvs -d :pserver:cvs@cvs.samba.org:/cvsroot login
        Password: cvs
 
-       cvs -d :pserver:cvs@samba.anu.edu.au:/cvsroot co rsync
+       cvs -d :pserver:cvs@cvs.samba.org:/cvsroot co rsync
 
 Look at the cvs documentation for more details.
 
@@ -119,19 +140,15 @@ COPYRIGHT
 ---------
 
 Rsync was written by Andrew Tridgell and Paul Mackerras, and is
-available under the GPL.
+available under the Gnu Public License.
 
-Andrew.Tridgell@anu.edu.au
+tridge@samba.org
 paulus@cs.anu.edu.au
 
 
 AVAILABILITY
 ------------
 
-The main ftp site for rsync is ftp://samba.anu.edu.au/pub/rsync
-
-Mirrors are available at:
-
-ftp://sunsite.auc.dk/pub/unix/rsync
-ftp://ftp.sunet.se/pub/unix/admin/rsync
-ftp://ftp.fu-berlin.de/pub/unix/network/rsync/
+The main web site for rsync is http://rsync.samba.org/
+The main ftp site is ftp://rsync.samba.org/pub/rsync/
+This is also available as rsync://rsync.samba.org/rsyncftp/