From 16d12b1471b6b053d96ccbf8260003b36af8209b Mon Sep 17 00:00:00 2001 From: Bill Wendling Date: Thu, 13 Sep 2001 12:11:31 -0500 Subject: [svn-r4438] Purpose: Feature Add Description: Added description of the H5CC script. Platforms tested: Mozilla --- doc/html/Tools.html | 100 +++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 95 insertions(+), 5 deletions(-) diff --git a/doc/html/Tools.html b/doc/html/Tools.html index b13c498..6c948fc 100644 --- a/doc/html/Tools.html +++ b/doc/html/Tools.html @@ -70,14 +70,16 @@ to convert files from HDF4 format to HDF5 format and vice versa. A tool for converting an HDF5 file to an HDF4 file
  • h4toh5 -- A tool for converting an HDF4 file to an HDF5 file +
  • h5cc -- + A tool for compiling HDF5 programs
  • Java-based tools for HDF5 -- (at http://hdf.ncsa.uiuc.edu/java-hdf5-html/)
    - Java-based tools for viewing, manipulating, and generating HDF5 files - (distributed separately) + Java-based tools for viewing, manipulating, and generating HDF5 + files (distributed separately)
    - Includes H5view, H5gen, - Java HDF5 Interface (JHI5), and HDF5 VisAD Data Adapter + Includes H5view, H5gen, Java HDF5 + Interface (JHI5), and HDF5 VisAD Data Adapter @@ -817,6 +819,94 @@ to convert files from HDF4 format to HDF5 format and vice versa. --> +
    +
    +
    Tool Name: h5cc +
    Syntax: +
    h5cc + [OPTIONS] <compile line> +
    Purpose: +
    Helper script to compile HDF5 applications. +
    Description: +

    + h5cc can be used in much the same way MPIch is used + to compile HDF5 program. It takes care of specifying where the + HDF5 header files and libraries are on the commandline. +

    + +

    + h5cc supercedes all other compiler scripts in that + if you've used them to compile the HDF5 library, then + h5cc also uses those scripts. For examples, when + compiling an MPIch program, you use the mpicc + script. If you've built HDF5 using MPIch, then h5cc + uses the MPIch program for compilation. +

    + +

    + Some programs use HDF5 in only a few modules. It isn't necessary + to use h5cc to compile those modules which don't use + HDF5. In fact, since h5cc is only a convenience + script, you are still able to compile HDF5 modules in the normal + way. In that case, you will have to specify the HDF5 libraries + and include paths yourself. +

    + +

    + An example of how to use HDF5 to compile the program + hdf_prog which consists of modules + prog1.c and prog2.c and uses the HDF5 + shared library: + + 

    +        # h5cc -c prog1.c
+        # h5cc -c prog2.c
+        # h5cc -shlib -o hdf_prog prog1.o prog2.o
+
    +

    +

    Options and Parameters: +
    +
    -help +
    Prints a help message. +
    -echo +
    Show all the shell commands executed. +
    -prefix=DIR +
    Use the directory DIR to find HDF5 lib/ and include/ + subdirectories [default: prefix specified when + configuring HDF5]. +
    -show +
    Show the commands without executing them. +
    -shlib +
    Compile using shared HDF5 libraries. +
    -noshlib +
    Compile using static HDF5 libraries [default]. +
    <compile line> +
    The normal compile line options for your compiler. h5cc + uses the same compiler you used to compile HDF5. Check + with your compiler's manual for more information on which + options are needed. +
    +

    +

    Environment Variables: +
    + When set, these environment variables override some of the built-in + defaults of h5cc. + +
    +
    HDF5_CC +
    Use a different C compiler. +
    HDF5_CLINKER +
    Use a different linker. +
    HDF5_USE_SHLIB=[yes|no] +
    Use shared version of the HDF5 library [default: no]. +
    + +
    @@ -904,7 +994,7 @@ Tools   HDF Help Desk
    -Last modified: 2 August 2001 +Last modified: 13. September 2001
    Describes HDF5 Release 1.5, Unreleased Development Branch -- cgit v0.12