Improvements for release process; a gensend hook.
[rsync.git] / INSTALL.md
blobb53965e9a196deaebe158542206a59459075b49f
1 To build and install rsync:
3     $ ./configure
4     $ make
5     # make install
7 You may set the installation directory and other parameters by options
8 to ./configure.  To see them, use:
10     $ ./configure --help
12 Configure tries to figure out if the local system uses group "nobody" or
13 "nogroup" by looking in the /etc/group file.  (This is only used for the
14 default group of an rsync daemon, which attempts to run with "nobody"
15 user and group permissions.)  You can change the default user and group
16 for the daemon by editing the NOBODY_USER and NOBODY_GROUP defines in
17 config.h, or just override them in your /etc/rsyncd.conf file.
19 As of 2.4.7, rsync uses Eric Troan's popt option-parsing library.  A
20 cut-down copy of a recent release is included in the rsync distribution,
21 and will be used if there is no popt library on your build host, or if
22 the --with-included-popt option is passed to ./configure.
24 If you configure using --enable-maintainer-mode, then rsync will try
25 to pop up an xterm on DISPLAY=:0 if it crashes.  You might find this
26 useful, but it should be turned off for production builds.
28 MAKE COMPATIBILITY
29 ------------------
31 Note that Makefile.in has a rule that uses a wildcard in a prerequisite.  If
32 your make has a problem with this rule, you will see an error like this:
34     Don't know how to make ./*.c
36 You can change the "proto.h-tstamp" target in Makefile.in to list all the *.c
37 filenames explicitly in order to avoid this issue.
39 RPM NOTES
40 ---------
42 Under packaging you will find .spec files for several distributions.
43 The .spec file in packaging/lsb can be used for Linux systems that
44 adhere to the Linux Standards Base (e.g., RedHat and others).
46 HP-UX NOTES
47 -----------
49 The HP-UX 10.10 "bundled" C compiler seems not to be able to cope with
50 ANSI C.  You may see this error message in config.log if ./configure
51 fails:
53   (Bundled) cc: "configure", line 2162: error 1705: Function prototypes are an ANSI feature.
55 Install gcc or HP's "ANSI/C Compiler".
57 MAC OSX NOTES
58 -------------
60 Some versions of Mac OS X (Darwin) seem to have an IPv6 stack, but do
61 not completely implement the "New Sockets" API.  
63 <http://www.ipv6.org/impl/mac.html> says that Apple started to support
64 IPv6 in 10.2 (Jaguar).  If your build fails, try again after running
65 configure with --disable-ipv6.
67 IBM AIX NOTES
68 -------------
70 IBM AIX has a largefile problem with mkstemp.  See IBM PR-51921.
71 The workaround is to append the below to config.h
72         #ifdef _LARGE_FILES
73         #undef HAVE_SECURE_MKSTEMP
74         #endif