maint: use more readable operator: "||" rather than "|"
[coreutils.git] / README-prereq
blob54cdb9cd4379d1b74393363dc5061b38e27d2775
1 This gives some notes on obtaining the tools required for development.
2 I.E. the tools checked for by the bootstrap script and include:
4 - Autoconf  <http://www.gnu.org/software/autoconf/>
5 - Automake  <http://www.gnu.org/software/automake/>
6 - Bison     <http://www.gnu.org/software/bison/>
7 - Gettext   <http://www.gnu.org/software/gettext/>
8 - Git       <http://git.or.cz/>
9 - Gperf     <http://www.gnu.org/software/gperf/>
10 - Gzip      <http://www.gnu.org/software/gzip/>
11 - Perl      <http://www.cpan.org/>
12 - Rsync     <http://samba.anu.edu.au/rsync/>
13 - Tar       <http://www.gnu.org/software/tar/>
14 - Texinfo   <http://www.gnu.org/software/texinfo/>
16 Note please try to install/build official packages for your system.
17 If these are not available then one can make them available only to
18 the coreutils build using the following instructions.  Even if the
19 official packages for your system are too old, please install them
20 as they may be required to build the newer versions.  The examples
21 below build into $HOME/coreutils/deps/, so first ensure that your
22 $PATH is set correctly, which can be done for the current shell like:
24   export PATH=$HOME/coreutils/deps/bin:$PATH
26 * autoconf *
28   # Note Autoconf 2.62 or newer is needed to build automake-1.11
29   git clone --depth=1 git://git.sv.gnu.org/autoconf.git
30   git checkout v2.62
31   autoreconf -vi
32   ./configure --prefix=$HOME/coreutils/deps
33   make install
35 * automake *
37   # Note help2man is required to build automake fully
38   git clone git://git.sv.gnu.org/automake.git
39   cd automake
40   git checkout -b branch-1.11 --track origin/branch-1.11
41   ./bootstrap
42   ./configure --prefix=$HOME/coreutils/deps
43   make install
45 coreutils uses XZ utils (successor to LZMA) to create
46 a compressed distribution tarball.  Using this feature of Automake
47 requires version 1.10a or newer, as well as the xz program itself.
49 * xz *
51   git clone git://ctrl.tukaani.org/xz.git
52   cd xz
53   ./autogen.sh
54   ./configure --prefix=$HOME/coreutils/deps
55   make install
57 Now one can build coreutils as described in README-hacking.