maint: fix a comment typo
[coreutils.git] / README-prereq
blob66688dcf7c90d92d8854c86cc0c250e4005625ac
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 programs are not available use the following instructions
18 to build them and install the results into a directory that you will
19 then use when building this package.
21 Even if the official version of a package for your system is too old,
22 please install it, as it may be required to build the newer versions.
23 The examples below install into $HOME/coreutils/deps/, so if you are
24 going to follow these instructions, first ensure that your $PATH is
25 set correctly by running this command:
27   prefix=$HOME/coreutils/deps
28   export PATH=$prefix/bin:$PATH
30 * autoconf *
32   # Note Autoconf 2.62 or newer is needed to build automake-1.11.1
33   git clone --depth=1 git://git.sv.gnu.org/autoconf.git
34   git checkout v2.62
35   autoreconf -vi
36   ./configure --prefix=$prefix
37   make install
39 * automake *
41   # Note help2man is required to build automake fully
42   git clone git://git.sv.gnu.org/automake.git
43   cd automake
44   git checkout v1.11.1
45   ./bootstrap
46   ./configure --prefix=$prefix
47   make install
49 This package uses XZ utils (successor to LZMA) to create
50 a compressed distribution tarball.  Using this feature of Automake
51 requires version 1.10a or newer, as well as the xz program itself.
53 * xz *
55   git clone git://ctrl.tukaani.org/xz.git
56   cd xz
57   ./autogen.sh
58   ./configure --prefix=$prefix
59   make install
61 Now you can build this package as described in README-hacking.