fix some xxxs.
[tor.git] / doc / tor-rpm-creation.txt
blob9af2556b79f0c2bb7972b60873460531723e0a20
1 These are instructions for building Tor binaries in the rpm format on 
2 various cpu architectures and operating systems.  Each rpm will require
3 glibc on the target system.  It is believed that any rpm-based linux 
4 distribution should have semi-current glibc installed by default.  
5 If you run into a distribution that does not work with glibc, or does 
6 not contain it, please let us know the details.  
8 These are the exact same steps used to build the official rpms of Tor.
10 If you wish to further tune Tor binaries in rpm format beyond this list, 
11 see the GCC doc page for further options:
12 http://gcc.gnu.org/onlinedocs/gcc-4.0.2/gcc/
14 The tor.spec.in file contains the basic info needed to tune the binaries
15 produced in rpm format. The key parameters to tune are located in the
16 third section of the tor.spec.in file.  Locate the section similar to
17 this:
19 ## Target a specific arch and OS
21 # default is i386 linux
22 %define target gnu
23 %define target_cpu i386
24 %define target_os linux
27 The three parameters: target, target_cpu, and target_os are used
28 throughout the "make dist-rpm" process.  They control the parameters
29 passed to "configure" and the final tuning of the binaries produced.  
30 The default settings, as shown above, create binaries for the widest
31 range of Intel x86 or compatible architectures.
33 The paramters can be set as follows:
35 The "target" parameter:
36 This should be "gnu", "redhat", or the short name of your linux distribution.
37 Other possibilities are "mandrake" or "suse".  This is passed to
38 "configure" through the --host, --build, and --target parameters.
39 Therefore, this "target" parameter must be a valid OS for "configure" as
40 well.
43 The "target_cpu" parameter:
44 This parameter controls the optimization and tuning of your binaries via
45 gcc and "configure".  This parameter is passed to gcc via the -mtune= or
46 -mcpu= options.  The "configure" script will also receive this parameter
47 through the --host, --build, and --target parameters.  Therefore, this
48 "target_cpu" parameter must be valid for both gcc and "configure".  A
49 few common options for this parameter may be "athlon64, i686, pentium4" or
50 others.
53 The "target_os" parameter:
54 This parameter controls the target operating system.  Normally, this is
55 only "linux".  If you wish to build rpms for a non-linux operating
56 system, you can replace "linux" with your operating system.