From 2bd7a9c8194cad47e34ce249971099e523d6f26b Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Tue, 6 May 2003 16:54:54 -0500 Subject: [svn-r6812] Purpose: New feature -- h5fc Description: Added h5fc entry. Took the opportunity to make some relatively minor copy edits and grammatical corrections in h5cc entry. Platforms tested: Safari, IE 5 --- doc/html/Tools.html | 123 +++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 97 insertions(+), 26 deletions(-) diff --git a/doc/html/Tools.html b/doc/html/Tools.html index 9f86a9a..9583b37 100644 --- a/doc/html/Tools.html +++ b/doc/html/Tools.html @@ -72,6 +72,8 @@ to convert files from HDF4 format to HDF5 format and vice versa. A tool for converting an HDF4 file to an HDF5 file
  • h5cc -- A tool for compiling HDF5 programs +
  • h5fc -- + A tool for compiling HDF5 programs written in Fortran90
  • Java-based tools for HDF5 -- (at http://hdf.ncsa.uiuc.edu/java-hdf5-html/)
    @@ -296,7 +298,6 @@ to convert files from HDF4 format to HDF5 format and vice versa.

    -

    Examples:
    1. Dumping the group /GroupFoo/GroupBar in the file @@ -410,6 +411,7 @@ to convert files from HDF4 format to HDF5 format and vice versa. +
      Tool Name: h5ls @@ -486,6 +488,7 @@ to convert files from HDF4 format to HDF5 format and vice versa. -->
      +
      Tool Name: h5repart @@ -835,6 +838,7 @@ to convert files from HDF4 format to HDF5 format and vice versa. -->
      +
      Tool Name: h5cc @@ -844,21 +848,16 @@ to convert files from HDF4 format to HDF5 format and vice versa.
      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 +

      h5cc can be used in much the same way MPIch is used + to compile an 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 + h5cc also uses those scripts. For example, 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 @@ -866,30 +865,28 @@ to convert files from HDF4 format to HDF5 format and vice versa. 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 + hdf_prog, which consists of modules prog1.c and prog2.c and uses the HDF5 - shared library: - + shared library, would be as follows: 

               # 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]. +
      Use the directory DIR to find the HDF5 + lib/ and include/ subdirectories. +
      + Default: prefix specified when configuring HDF5.
      -show
      Show the commands without executing them.
      -shlib @@ -897,16 +894,14 @@ to convert files from HDF4 format to HDF5 format and vice versa.
      -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 +
      The normal compile line options for your compiler. + h5cc uses the same compiler you used to compile HDF5. + Check 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. +
      When set, these environment variables override some of the built-in + defaults of h5cc.
      HDF5_CC @@ -924,6 +919,82 @@ to convert files from HDF4 format to HDF5 format and vice versa. -->
      + +
      +
      +
      Tool Name: h5fc +
      Syntax: +
      h5fc + [OPTIONS] <compile line> +
      Purpose: +
      Helper script to compile HDF5 Fortran90 applications. +
      Description: +

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

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

      + Some programs use HDF5 in only a few modules. It isn't necessary + to use h5fc to compile those modules which don't use + HDF5. In fact, since h5fc is only a convenience + script, you are still able to compile HDF5 Fortran 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.f90 and prog2.f90 + and uses the HDF5 Fortran library, would be as follows: + 

      +        # h5fc -c prog1.f90
+        # h5fc -c prog2.f90
+        # h5fc -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. +
      <compile line> +
      The normal compile line options for your compiler. + h5fc uses the same compiler you used + to compile HDF5. Check 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_FC +
      Use a different Fortran90 compiler. +
      HDF5_FLINKER +
      Use a different linker. +
      + +
      + + -Last modified: 13. September 2001 +Last modified: 6 May 2003 -- cgit v0.12