maint: teach "make syntax-check" the space-only indentation rule
[coreutils.git] / README-prereq
blob686160ae5f7c85d2658a41052c2257943cbad761
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.
22 * autoconf *
24   # Note Autoconf 2.62 or newer is needed to build automake-1.11
25   git clone --depth=1 git://git.sv.gnu.org/autoconf.git
26   git checkout v2.62
27   autoreconf -vi
28   ./configure --prefix=$HOME/coreutils/deps
29   make install
31 * automake *
33   # Note help2man is required to build automake fully
34   git clone git://git.sv.gnu.org/automake.git
35   cd automake
36   git checkout -b branch-1.11 --track origin/branch-1.11
37   ./bootstrap
38   ./configure --prefix=$HOME/coreutils/deps
39   make install
41 coreutils uses XZ utils (successor to LZMA) to create
42 a compressed distribution tarball.  Using this feature of Automake
43 requires version 1.10a or newer, as well as the xz program itself.
45 * xz *
47   git clone git://ctrl.tukaani.org/xz.git
48   cd xz
49   ./autogen.sh
50   ./configure --prefix=$HOME/coreutils/deps
51   make install
53 Now we can build coreutils as described in README-hacking
54 as long as $PATH starts with $HOME/coreutils/deps/bin, which
55 one can set for the current shell like:
56   $ export PATH=$HOME/coreutils/deps/bin:$PATH