diff options
Diffstat (limited to 'INSTALL')
| -rw-r--r-- | INSTALL | 123 |
1 files changed, 82 insertions, 41 deletions
@@ -1,72 +1,113 @@ - UNIX-LIKE SYSTEMS - ----------------- +This file contains instructions for the installation of HDF5 on +Unix-like systems. First, one must obtain a tarball of the HDF5 +release from ---FIXME---->http://hdf5.ncsa.uiuc.edu<----FIXME--- +repository. The files are available in uncompressed tar, gzip, bzip2, +and compress formats. -To build/install HDF5 on Unix systems from the root of the -distribution directory: +For those that like to live dangerously and don't like to read ;-) you +can do the following: - * Build the ./src/H5config.h file and Makefiles by saying: + $ tar xf hdf-5.0.0a.tar + $ cd hdf-5.0.0a + $ make test + $ make install # Optional - ./configure - You can say `./configure --help' to see a list of options. +Step 1. Unpack the source tree. - One common option is to specify the prefix directory under which - public files are stored. The default prefix is `/usr/local' - resulting in the directory structure: + * The tarball will unpack into an hdf-5.0.0a directory with one of + the following commands: - /usr/local/include -- C header files. - /usr/local/lib -- The HDF5 library. - /usr/local/bin -- HDF5 support programs. + $ tar xf hdf-5.0.0a.tar OR + $ gunzip <hdf-5.0.0a.tar.gz |tar xf - OR + $ bunzip2 <hdf-5.0.0a.tar.bz2 |tar xf - OR + $ uncompress -c <hdf-5.0.0a.tar.Z | tar xf - - To install the public files in `/usr/include', `/usr/lib', and - `/usr/bin' instead say: - ./configure --prefix=/usr +Step 2. Configure makefiles. - Configure will create directories `include', `lib', and `bin' - under the prefix directory if they don't already exist, but the - prefix directory must already exist and be writable. + * HDF5 uses the GNU autoconf program for configuration. Most + installations can be configured by typing just (from the + hdf-5.0.0a directory) - You can also override detection of certain things with - environment variables: + $ ./configure + + * By default libraries, programs, and documentation are installed + under /usr/local/lib, /usr/local/bin, and /usr/local/man. + However, if you want them in some other location you can specify + a prefix to use instead of /usr/local. For instance, to install + in /usr/lib, /usr/bin, and /usr/man one would say + + $ ./configure --prefix=/usr + + Note: HDF5 can be used without installing it. + + * You can also override detection of certain things with + environment variables: CC Name of the C compiler to use. CFLAGS Alternate C compiler flags. CPPFLAGS Alternate C preprocessor flags. MAKE Name of the make(1) program. - For instance it is common to say (add `env' to the beginning of - this command if you're running a csh-like shell) + For instance it is common to specify the name of the C compiler, + C proprocessor flags, and compiler flags (add `env' to the + beginning of this command if you're running a csh-like shell) + + $ CC=gcc CPPFLAGS=-DNDEBUG CFLAGS="-Wall -O3" ./configure + + + * You can see a list of other configuration options by saying + + $ ./configure --help + + +Step 3. Compile library, tests, and programs. + + * Build library targets by saying + + $ make + + Note: If you supplied some other make command through the MAKE + environment variable in the previous step then use that command + instead. + + Note: If you're re-building the library after changing some + files and you're not using GNU make and gcc, then you should say + `make clean' from the top directory between each build attempt + since the development Makefiles don't have complete dependency + information yet. + + Note: When using GNU make you can add `-j -l6' to the make + command to compile in parallel on SMP machines. + + +Step 4. Run confidence tests. + + * All confidence tests should be run by saying + + $ make test - CPPFLAGS=-DNDEBUG CC=gcc CFLAGS=-O3 ./configure + The command will fail if any test fails. - * Build library targets by saying (if you supplied some other - make command through the MAKE variable in the previous step then - use that command instead): + Note: some versions of make will report that `test is up to + date'. If this happens then run `make test' from within the test + directory. - make - If you're re-building the library after changing some files and - you're not using GNU make and gcc, then you should say `make - clean' from the top directory between each build attempt since - the development Makefiles don't have complete dependency - information yet. +Step 5. Install public files. - * Install the library, header files, and programs by saying: + * Install the library, header files, and programs by saying: - make install + $ make install This step will fail unless you have permission to write to the installation directories. Of course, you can use the header files, library, and programs directly out of the source tree if you like, skipping this step. +Step 6. Subscribe to mailing lists. - NON-UNIX SYSTEMS - ---------------- + * Subscribe to the mailing lists described in the README file. -To build/install HDF5 on non-Unix systems from the root of the -distribution directory: - * To be written later. Basically, there will be a separate - makefile (or equivalent) for each platform. |