[hdf5] 07/08: Add manpages for h5pcc, h5pfc and h5debug

Mon May 5 12:39:15 UTC 2014

This is an automated email from the git hooks/post-receive script.

pini pushed a commit to branch master
in repository hdf5.

commit 261a989762247198a98afb3d59fd44e235813c7d
Author: Gilles Filippini <pini at debian.org>
Date:   Mon May 5 11:51:47 2014 +0200

    Add manpages for h5pcc, h5pfc and h5debug
---
 debian/README.source                |  6 +++
 debian/hdf5-tools.manpages          |  1 +
 debian/libhdf5-mpich-dev.manpages   |  2 +
 debian/libhdf5-openmpi-dev.manpages |  2 +
 debian/man/h5debug.1                |  9 ++++
 debian/man/h5pcc.1                  | 93 +++++++++++++++++++++++++++++++++++++
 debian/man/h5pfc.1                  | 74 +++++++++++++++++++++++++++++
 7 files changed, 187 insertions(+)

diff --git a/debian/README.source b/debian/README.source
index ed35209..74c788b 100644
--- a/debian/README.source
+++ b/debian/README.source
@@ -55,6 +55,12 @@ Considering applying this piece of advice from Julien Cristau:
 > libtool plutôt que -version-info.  Ça prend directement comme argument
 > major:minor:micro, donc on se perd pas dans des calculs à la con.
 
+Manpages
+--------
+$ help2man -n "helper script to compile HDF5 Fortran applications" --version-string="h5pfc (hdf5 1.8.12)" -h -help -N h5pfc >debian/man/h5pfc.1
+$ help2man -n "helper script to compile HDF5 C applications" --version-string="h5pcc (hdf5 1.8.12)" -h -help -N h5pcc >debian/man/h5pcc.1
+$ help2man -n "debugs an existing HDF5 file at a low level" --version-string="h5debug (hdf5 1.8.12)" -N 'bash -c "h5debug 2>&1"' >debian/man/h5debug.1
+
 TO-DO
 -----
 * common manpage for h5*{c,f}c
diff --git a/debian/hdf5-tools.manpages b/debian/hdf5-tools.manpages
index 5e7d0a2..cf052ca 100644
--- a/debian/hdf5-tools.manpages
+++ b/debian/hdf5-tools.manpages
@@ -13,3 +13,4 @@ debian/man/h5ls.1
 debian/man/h5dump.1
 debian/man/h5jam.1
 debian/man/h5repart.1
+debian/man/h5debug.1
diff --git a/debian/libhdf5-mpich-dev.manpages b/debian/libhdf5-mpich-dev.manpages
new file mode 100644
index 0000000..5837d0b
--- /dev/null
+++ b/debian/libhdf5-mpich-dev.manpages
@@ -0,0 +1,2 @@
+debian/man/h5pcc.1
+debian/man/h5pfc.1
diff --git a/debian/libhdf5-openmpi-dev.manpages b/debian/libhdf5-openmpi-dev.manpages
new file mode 100644
index 0000000..5837d0b
--- /dev/null
+++ b/debian/libhdf5-openmpi-dev.manpages
@@ -0,0 +1,2 @@
+debian/man/h5pcc.1
+debian/man/h5pfc.1
diff --git a/debian/man/h5debug.1 b/debian/man/h5debug.1
new file mode 100644
index 0000000..1e52db5
--- /dev/null
+++ b/debian/man/h5debug.1
@@ -0,0 +1,9 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.45.1.
+.TH H5DEBUG "1" "May 2014" "h5debug (hdf5 1.8.12)" "User Commands"
+.SH NAME
+h5debug \- debugs an existing HDF5 file at a low level
+.SH SYNOPSIS
+.B h5debug
+\fI\,filename \/\fR[\fI\,signature-addr \/\fR[\fI\,extra\/\fR]]
+.SH DESCRIPTION
+
diff --git a/debian/man/h5pcc.1 b/debian/man/h5pcc.1
new file mode 100644
index 0000000..28314ec
--- /dev/null
+++ b/debian/man/h5pcc.1
@@ -0,0 +1,93 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.45.1.
+.TH H5PCC "1" "May 2014" "h5pcc (hdf5 1.8.12)" "User Commands"
+.SH NAME
+h5pcc \- helper script to compile HDF5 C applications
+.SH DESCRIPTION
+usage: h5pcc [OPTIONS] <compile line>
+.IP
+OPTIONS:
+.TP
+\fB\-help\fR
+This help message.
+.TP
+\fB\-echo\fR
+Show all the shell commands executed
+.TP
+\fB\-prefix\fR=\fI\,DIR\/\fR
+Prefix directory to find HDF5 lib/ and include/
+.IP
+subdirectories [default: /usr]
+.PP
+usage: h5pcc [OPTIONS] <compile line>
+.IP
+OPTIONS:
+.TP
+\fB\-help\fR
+This help message.
+.TP
+\fB\-echo\fR
+Show all the shell commands executed
+.TP
+\fB\-prefix\fR=\fI\,DIR\/\fR
+Prefix directory to find HDF5 lib/ and include/
+.IP
+subdirectories [default: /usr]
+.TP
+\fB\-show\fR
+Show the commands without executing them
+.TP
+\fB\-showconfig\fR
+Show the HDF5 library configuration summary
+.TP
+\fB\-shlib\fR
+Compile with shared HDF5 libraries [default for hdf5 built
+without static libraries]
+.TP
+\fB\-noshlib\fR
+Compile with static HDF5 libraries [default for hdf5 built
+with static libraries]
+.TP
+<compile line>
+\- the normal compile line options for your compiler.
+.TP
+h5pcc uses the same compiler you used to compile
+HDF5. Check with your compiler's man pages for more
+information on which options are needed.
+.IP
+You can override the compiler, linker, and whether or not to use static
+or shared libraries to compile your program by setting the following
+environment variables accordingly:
+.TP
+HDF5_CC
+\-  use a different C compiler
+.TP
+HDF5_CLINKER
+\-  use a different linker
+.TP
+HDF5_USE_SHLIB=[yes|no]
+\-  use shared or static version of the HDF5 library
+.TP
+[default: no except when built with only
+shared libraries]
+.IP
+You can also add or change paths and flags to the compile line using
+the following environment varibles or by assigning them to their counterparts
+in the 'Things You Can Modify to Override...' section of h5pcc
+.TP
+Variable
+Current value to be replaced
+.TP
+HDF5_CPPFLAGS
+""
+.TP
+HDF5_CFLAGS
+""
+.TP
+HDF5_LDFLAGS
+""
+.TP
+HDF5_LIBS
+""
+.IP
+Note that adding library paths to HDF5_LDFLAGS where another hdf5 version
+is located may link your program with that other hdf5 library version.
diff --git a/debian/man/h5pfc.1 b/debian/man/h5pfc.1
new file mode 100644
index 0000000..54f387a
--- /dev/null
+++ b/debian/man/h5pfc.1
@@ -0,0 +1,74 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.45.1.
+.TH H5PFC "1" "May 2014" "h5pfc (hdf5 1.8.12)" "User Commands"
+.SH NAME
+h5pfc \- helper script to compile HDF5 Fortran applications
+.SH DESCRIPTION
+usage: h5pfc [OPTIONS] <compile line>
+.IP
+OPTIONS:
+.TP
+\fB\-help\fR
+This help message.
+.TP
+\fB\-echo\fR
+Show all the shell commands executed
+.TP
+\fB\-prefix\fR=\fI\,DIR\/\fR
+Prefix directory to find HDF5 lib/ and include/
+.IP
+subdirectories [default: /usr]
+.TP
+\fB\-show\fR
+Show the commands without executing them
+.TP
+\fB\-showconfig\fR
+Show the HDF5 library configuration summary
+.TP
+\fB\-shlib\fR
+Compile with shared HDF5 libraries [default for hdf5 built
+without static libraries]
+.TP
+\fB\-noshlib\fR
+Compile with static HDF5 libraries [default for hdf5 built
+with static libraries]
+.TP
+<compile line>
+\- the normal compile line options for your compiler.
+.TP
+h5pfc uses the same compiler you used to compile
+HDF5. Check with your compiler's man pages for more
+information on which options are needed.
+.IP
+You can override the compiler and linker to compile your program by
+setting the following environment variables accordingly:
+.TP
+HDF5_FC
+\-  use a different Fortran 90 or 95 compiler
+.TP
+HDF5_FLINKER
+\-  use a different linker
+.TP
+HDF5_USE_SHLIB=[yes|no]
+\-  use shared or static version of the HDF5 library
+.TP
+[default: no except when built with only
+shared libraries]
+.IP
+You can also add or change paths and flags to the compile line using
+the following environment varibles or by assigning them to their counterparts
+in the 'Things You Can Modify to Override...' section of h5pfc
+.TP
+Variable
+Current value to be replaced
+.TP
+HDF5_FCFLAGS
+""
+.TP
+HDF5_LDFLAGS
+""
+.TP
+HDF5_LIBS
+""
+.IP
+Note that adding library paths to HDF5_LDFLAGS where another hdf5 version
+is located may link your program with that other hdf5 library version.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-grass/hdf5.git

