This is an automated email from the git hooks/post-receive script. sebastic pushed a commit to branch master in repository hdf4.
commit 89bc581980e1ef46d8c969ddc2412c6bb5664faa Author: Bas Couwenberg <[email protected]> Date: Sat May 28 04:30:27 2016 +0200 Add manpages for: h4{cc,fc,redeploy}, hdfimport, hdiff & hrepack. --- debian/changelog | 1 + debian/hdf4-tools.manpages | 3 +- debian/man/h4cc.1 | 68 ++++++++ debian/man/h4cc.1.xml | 146 ++++++++++++++++ debian/man/h4fc.1 | 56 ++++++ debian/man/h4fc.1.xml | 116 ++++++++++++ debian/man/h4redeploy.1 | 50 ++++++ debian/man/h4redeploy.1.xml | 99 +++++++++++ debian/man/hdfimport.1 | 250 ++++++++++++++++++++++++++ debian/man/hdfimport.1.xml | 417 ++++++++++++++++++++++++++++++++++++++++++++ debian/man/hdiff.1 | 80 +++++++++ debian/man/hdiff.1.xml | 194 +++++++++++++++++++++ debian/man/hrepack.1 | 166 ++++++++++++++++++ debian/man/hrepack.1.xml | 325 ++++++++++++++++++++++++++++++++++ 14 files changed, 1970 insertions(+), 1 deletion(-) diff --git a/debian/changelog b/debian/changelog index 7da2437..9b8ece8 100644 --- a/debian/changelog +++ b/debian/changelog @@ -3,6 +3,7 @@ libhdf4 (4.2.11-2) UNRELEASED; urgency=medium * Team upload. * Add patch to make the libhdf4.settings reproducible. (closes: #825540) + * Add manpages for: h4{cc,fc,redeploy}, hdfimport, hdiff & hrepack. -- Bas Couwenberg <[email protected]> Fri, 27 May 2016 19:18:12 +0200 diff --git a/debian/hdf4-tools.manpages b/debian/hdf4-tools.manpages index 19f429f..630f1ec 100644 --- a/debian/hdf4-tools.manpages +++ b/debian/hdf4-tools.manpages @@ -1 +1,2 @@ -debian/man/* +debian/man/*.1 +man/*.1 diff --git a/debian/man/h4cc.1 b/debian/man/h4cc.1 new file mode 100644 index 0000000..8e0a301 --- /dev/null +++ b/debian/man/h4cc.1 @@ -0,0 +1,68 @@ +'\" -*- coding: us-ascii -*- +.if \n(.g .ds T< \\FC +.if \n(.g .ds T> \\F[\n[.fam]] +.de URL +\\$2 \(la\\$1\(ra\\$3 +.. +.if \n(.g .mso www.tmac +.TH h4cc 1 "28 May 2016" "" "" +.SH NAME +h4cc \- compiles an HDF4 C program +.SH SYNOPSIS +'nh +.fi +.ad l +\fBh4cc\fR \kx +.if (\nx>(\n(.l/2)) .nr x (\n(.l/5) +'in \n(.iu+\nxu +[\fIOPTIONS\fR] <\fIcompile line\fR> +'in \n(.iu-\nxu +.ad b +'hy +.SH DESCRIPTION +\fBh4cc\fR compiles an HDF4 C program. +.SH OPTIONS +.TP +\*(T<\fB\-help\fR\*(T> +Display usage information +.TP +\*(T<\fB\-echo\fR\*(T> +Show all the shell commands executed +.TP +\*(T<\fB\-prefix\fR\*(T>=\fIDIR\fR +Prefix directory to find HDF4 +\*(T<\fIlib/\fR\*(T> and +\*(T<\fIinclude/\fR\*(T> subdirectories +[default: /usr] +.TP +\*(T<\fB\-show\fR\*(T> +Show the commands without executing them +.TP +\*(T<\fB\-shlib\fR\*(T> +Compile with shared HDF4 libraries +[default for hdf4 built without static libraries] +.TP +\*(T<\fB\-noshlib\fR\*(T> +Compile with static HDF4 libraries +[default for hdf4 built with static libraries] +.TP +<\fIcompile line\fR> +the normal compile line options for your compiler. +\fBh4cc\fR uses the same compiler you used to compile +HDF4. +Check with your compiler's man pages for more information on +which options are needed. +.PP +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 +HDF4_CC +use a different C compiler +.TP +HDF4_CLINKER +use a different linker +.TP +HDF4_USE_SHLIB=[yes|no] +use shared or static version of the HDF4 library +[default: no] diff --git a/debian/man/h4cc.1.xml b/debian/man/h4cc.1.xml new file mode 100644 index 0000000..9af0990 --- /dev/null +++ b/debian/man/h4cc.1.xml @@ -0,0 +1,146 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd";> +<refentry id='h4cc'> + + <refmeta> + <refentrytitle>h4cc</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>h4cc</refname> + <refpurpose>compiles an HDF4 C program</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>h4cc</command> + <arg choice='opt'><replaceable>OPTIONS</replaceable></arg> + <arg choice='plain'><<replaceable>compile line</replaceable>></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>h4cc</command> compiles an HDF4 C program. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist> + + <varlistentry> + <term><option>-help</option></term> + <listitem> + <para> + Display usage information + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-echo</option></term> + <listitem> + <para> + Show all the shell commands executed + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-prefix</option>=<replaceable>DIR</replaceable></term> + <listitem> + <para> + Prefix directory to find HDF4 + <filename class='directory'>lib/</filename> and + <filename class='directory'>include/</filename> subdirectories + [default: /usr] + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-show</option></term> + <listitem> + <para> + Show the commands without executing them + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-shlib</option></term> + <listitem> + <para> + Compile with shared HDF4 libraries + [default for hdf4 built without static libraries] + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-noshlib</option></term> + <listitem> + <para> + Compile with static HDF4 libraries + [default for hdf4 built with static libraries] + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><<replaceable>compile line</replaceable>></term> + <listitem> + <para> + the normal compile line options for your compiler. + <command>h4cc</command> uses the same compiler you used to compile + HDF4. + Check with your compiler's man pages for more information on + which options are needed. + </para> + </listitem> + </varlistentry> + + </variablelist> + <para> + 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: + <variablelist> + + <varlistentry> + <term>HDF4_CC</term> + <listitem> + <para> + use a different C compiler + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>HDF4_CLINKER</term> + <listitem> + <para> + use a different linker + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>HDF4_USE_SHLIB=[yes|no]</term> + <listitem> + <para> + use shared or static version of the HDF4 library + [default: no] + </para> + </listitem> + </varlistentry> + + </variablelist> + </para> + + </refsect1> + +</refentry> diff --git a/debian/man/h4fc.1 b/debian/man/h4fc.1 new file mode 100644 index 0000000..61f0d9a --- /dev/null +++ b/debian/man/h4fc.1 @@ -0,0 +1,56 @@ +'\" -*- coding: us-ascii -*- +.if \n(.g .ds T< \\FC +.if \n(.g .ds T> \\F[\n[.fam]] +.de URL +\\$2 \(la\\$1\(ra\\$3 +.. +.if \n(.g .mso www.tmac +.TH h4fc 1 "28 May 2016" "" "" +.SH NAME +h4fc \- compiles an HDF4 F90 program +.SH SYNOPSIS +'nh +.fi +.ad l +\fBh4fc\fR \kx +.if (\nx>(\n(.l/2)) .nr x (\n(.l/5) +'in \n(.iu+\nxu +[\fIOPTIONS\fR] <\fIcompile line\fR> +'in \n(.iu-\nxu +.ad b +'hy +.SH DESCRIPTION +\fBh4fc\fR compiles an HDF4 F90 program. +.SH OPTIONS +.TP +\*(T<\fB\-help\fR\*(T> +Display usage information +.TP +\*(T<\fB\-echo\fR\*(T> +Show all the shell commands executed +.TP +\*(T<\fB\-prefix\fR\*(T>=\fIDIR\fR +Prefix directory to find HDF4 +\*(T<\fIlib/\fR\*(T> and +\*(T<\fIinclude/\fR\*(T> subdirectories +[default: /usr] +.TP +\*(T<\fB\-show\fR\*(T> +Show the commands without executing them +.TP +<\fIcompile line\fR> +the normal compile line options for your compiler. +\fBh4fc\fR uses the same compiler you used to compile +HDF4. +Check with your compiler's man pages for more information on +which options are needed. +.PP +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 +HDF4_F77 +use a different Fortran 77 compiler +.TP +HDF4_F77LINKER +use a different linker diff --git a/debian/man/h4fc.1.xml b/debian/man/h4fc.1.xml new file mode 100644 index 0000000..6f683e3 --- /dev/null +++ b/debian/man/h4fc.1.xml @@ -0,0 +1,116 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd";> +<refentry id='h4fc'> + + <refmeta> + <refentrytitle>h4fc</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>h4fc</refname> + <refpurpose>compiles an HDF4 F90 program</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>h4fc</command> + <arg choice='opt'><replaceable>OPTIONS</replaceable></arg> + <arg choice='plain'><<replaceable>compile line</replaceable>></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>h4fc</command> compiles an HDF4 F90 program. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist> + + <varlistentry> + <term><option>-help</option></term> + <listitem> + <para> + Display usage information + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-echo</option></term> + <listitem> + <para> + Show all the shell commands executed + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-prefix</option>=<replaceable>DIR</replaceable></term> + <listitem> + <para> + Prefix directory to find HDF4 + <filename class='directory'>lib/</filename> and + <filename class='directory'>include/</filename> subdirectories + [default: /usr] + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-show</option></term> + <listitem> + <para> + Show the commands without executing them + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><<replaceable>compile line</replaceable>></term> + <listitem> + <para> + the normal compile line options for your compiler. + <command>h4fc</command> uses the same compiler you used to compile + HDF4. + Check with your compiler's man pages for more information on + which options are needed. + </para> + </listitem> + </varlistentry> + + </variablelist> + <para> + 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: + <variablelist> + + <varlistentry> + <term>HDF4_F77</term> + <listitem> + <para> + use a different Fortran 77 compiler + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>HDF4_F77LINKER</term> + <listitem> + <para> + use a different linker + </para> + </listitem> + </varlistentry> + + </variablelist> + </para> + + </refsect1> + +</refentry> diff --git a/debian/man/h4redeploy.1 b/debian/man/h4redeploy.1 new file mode 100644 index 0000000..27ac52d --- /dev/null +++ b/debian/man/h4redeploy.1 @@ -0,0 +1,50 @@ +'\" -*- coding: us-ascii -*- +.if \n(.g .ds T< \\FC +.if \n(.g .ds T> \\F[\n[.fam]] +.de URL +\\$2 \(la\\$1\(ra\\$3 +.. +.if \n(.g .mso www.tmac +.TH h4redeploy 1 "28 May 2016" "" "" +.SH NAME +h4redeploy \- updates paths in h4cc/h4fc +.SH SYNOPSIS +'nh +.fi +.ad l +\fBh4redeploy\fR \kx +.if (\nx>(\n(.l/2)) .nr x (\n(.l/5) +'in \n(.iu+\nxu +[\fIOPTIONS\fR] +'in \n(.iu-\nxu +.ad b +'hy +.SH DESCRIPTION +\fBh4redeploy\fR updates paths in +\fBh4cc\fR/\fBh4fc\fR after the HDF4 +pre-compiled binaries have been installed in a new location. +.SH OPTIONS +.TP +\*(T<\fB\-help\fR\*(T> +Display usage information +.TP +\*(T<\fB\-echo\fR\*(T> +Show all the shell commands executed +.TP +\*(T<\fB\-force\fR\*(T> +No prompt, just do it +.TP +\*(T<\fB\-prefix\fR\*(T>=\fIDIR\fR +Prefix directory to find HDF4 +\*(T<\fIlib/\fR\*(T> and +\*(T<\fIinclude/\fR\*(T> subdirectories +[default: current directory] +.TP +\*(T<\fB\-tool\fR\*(T>=\fITOOL\fR +Tool to update. +\fITOOL\fR must be in the current directory +and writable. +[default: h4cc h4fc] +.TP +\*(T<\fB\-show\fR\*(T> +Show the commands without executing them diff --git a/debian/man/h4redeploy.1.xml b/debian/man/h4redeploy.1.xml new file mode 100644 index 0000000..eda15a2 --- /dev/null +++ b/debian/man/h4redeploy.1.xml @@ -0,0 +1,99 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd";> +<refentry id='h4redeploy'> + + <refmeta> + <refentrytitle>h4redeploy</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>h4redeploy</refname> + <refpurpose>updates paths in h4cc/h4fc</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>h4redeploy</command> + <arg choice='opt'><replaceable>OPTIONS</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>h4redeploy</command> updates paths in + <command>h4cc</command>/<command>h4fc</command> after the HDF4 + pre-compiled binaries have been installed in a new location. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist> + + <varlistentry> + <term><option>-help</option></term> + <listitem> + <para> + Display usage information + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-echo</option></term> + <listitem> + <para> + Show all the shell commands executed + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-force</option></term> + <listitem> + <para> + No prompt, just do it + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-prefix</option>=<replaceable>DIR</replaceable></term> + <listitem> + <para> + Prefix directory to find HDF4 + <filename class='directory'>lib/</filename> and + <filename class='directory'>include/</filename> subdirectories + [default: current directory] + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-tool</option>=<replaceable>TOOL</replaceable></term> + <listitem> + <para> + Tool to update. + <replaceable>TOOL</replaceable> must be in the current directory + and writable. + [default: h4cc h4fc] + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-show</option></term> + <listitem> + <para> + Show the commands without executing them + </para> + </listitem> + </varlistentry> + + </variablelist> + + </refsect1> + +</refentry> diff --git a/debian/man/hdfimport.1 b/debian/man/hdfimport.1 new file mode 100644 index 0000000..7bb884d --- /dev/null +++ b/debian/man/hdfimport.1 @@ -0,0 +1,250 @@ +'\" -*- coding: us-ascii -*- +.if \n(.g .ds T< \\FC +.if \n(.g .ds T> \\F[\n[.fam]] +.de URL +\\$2 \(la\\$1\(ra\\$3 +.. +.if \n(.g .mso www.tmac +.TH hdfimport 1 "28 May 2016" "" "" +.SH NAME +hdfimport \- imports ASCII or binary data into HDF +.SH SYNOPSIS +'nh +.fi +.ad l +\fBhdfimport\fR \kx +.if (\nx>(\n(.l/2)) .nr x (\n(.l/5) +'in \n(.iu+\nxu +<infile> [ +[\fB-t[ype]\fR \fIoutput-type\fR | \fB-n\fR] +[ +<infile> +[\fB-t[ype]\fR \fIoutput-type\fR | \fB-n\fR] +\&... +] +] \fB-o[utfile]\fR \fIoutfile\fR [\fB-r[aster]\fR [ras_opts ...]] [\fB-f[loat]\fR] +'in \n(.iu-\nxu +.ad b +'hy +.SH DESCRIPTION +\fBhdfimport\fR converts floating point data to HDF +Scientific Data Set (SDS) and/or 8-bit Raster Image Set (RIS8) format, +storing the results in an HDF file. +The image data can be scaled about a mean value. +.SH OPTIONS +.TP +\fIinfile(s)\fR +Name of the input file(s), containing a single two-dimensional or +three-dimensional floating point array in either ASCII text, +native floating point, native integer or HDF SDS format. +If an HDF file is used for input, it must contain an SDS. +The SDS need only contain a dimension record and the data, but if +it also contains maximum and minimum values and/or scales for each +axis, these will be used. +If the input format is ASCII text or native floating point or +native integer, see "Notes" below on how it must be organized. +.TP +\*(T<\fB\-t[ype]\fR\*(T> \fIoutput-type\fR +Optionally used for every input ASCII file to specify the data type +of the data-set to be written. If not specified default data type +is 32-bit floating point. +\fIoutput-type\fR can be any of the following: +FP32 (default), FP64, INT32, INT16, INT8. +It can be used only with ASCII files. +.TP +.TP +\*(T<\fB\-n\fR\*(T> +This option is to be used only if the binary input file contains +64-bit floating point data and the default behaviour (default +behaviour is to write it to a 32-bit floating point data-set) +should be overridden to write it to a 64-bit floating point +data-set. +.TP +\*(T<\fB\-t[ype]\fR\*(T> \fIoutput-type\fR +Data from one or more input files are stored as one or more data +sets and/or images in one HDF output file, +"\fIoutfile\fR". +.TP +\*(T<\fB\-r[aster]\fR\*(T> +Store output as a raster image set in the output file. +.TP +\*(T<\fB\-f[loat]\fR\*(T> +Store output as a scientific data set in the output file. +This is the default if the "\*(T<\fB\-r\fR\*(T>" option is not +specified. +.TP +[ras_opts ...] +.RS +.TP +\*(T<\fB\-e[xpand]\fR\*(T> \fIhoriz\fR \fIvert\fR [\fIdepth\fR] +Expand float data via pixel replication to produce the +image(s). +"\fIhoriz\fR" and +"\fIvert\fR" give the horizontal and +vertical resolution of the image(s) to be produced; and +optionally, "\fIdepth\fR" gives the +number of images or depth planes (for 3D input data). +.TP +\*(T<\fB\-i[nterp]\fR\*(T> \fIhoriz\fR \fIvert\fR [\fIdepth\fR] +Apply bilinear, or trilinear, interpolation to the float +data to produce the image(s). +"\fIhoriz\fR", +"\fIvert\fR", and +"\fIdepth\fR" must be greater than or +equal to the dimensions of the original dataset. +If max and min are supplied in input file, this option clips +values that are greater than max or less then min, setting +them to the max and min, respectively. +.TP +\*(T<\fB\-p[alfile]\fR\*(T> \fIpalfile\fR +Store the palette with the image. +Get the palette from "\fIpalfile\fR"; +which may be an HDF file containing a palette, or a file +containing a raw palette. +.TP +\*(T<\fB\-m[ean]\fR\*(T> \fImean\fR +If a floating point mean value is given, the image will be +scaled about the mean. +The new extremes (newmax and newmin), as given by: + +.nf +\*(T< + newmax = mean + max(abs(max\-mean), abs(mean\-min)) + newmin = mean \- max(abs(max\-mean), abs(mean\-min)) + \*(T> +.fi + +will be equidistant from the mean value. +If no mean value is given, then the mean will be: + +.nf +\*(T< + 0.5 * (max + min) + \*(T> +.fi +.RE +.TP +Notes: +If the input file format is ASCII text or native floating +point or native integer(32-bit, 16-bit, 8-bit), it must +have the following input fields: + +.nf +\*(T< +format +nplanes +nrows +cols +max_value +min_value +[plane1 plane2 plane3 ...] +row1 row2 row3 ... +col1 col2 col3 ... +data1 data2 data3 ... + \*(T> +.fi + +Where: +.RS +.TP +format: +Format designator +("TEXT", "FP32", "FP64", "IN32", "IN16", "IN08"). +.TP +nplanes, nrows, ncols: +Dimensions are specified in the order slowest changing +dimension first. +ncols is dimension of the fastest changing dimension. +(horizontal axis or X-axis in a 3D scale) +nrows corresponds to dimension of the vertical axis or +Y-axis in a 3D scale. +nplanes corresponds to the slowest changing dimension i.e. +dimension of the depth axis or the Z-axis in a 3D scale +("1" for 2D input). +.TP +max_value: +Maximum data value. +.TP +min_value: +Minimum data value. +.TP +plane1, plane2, plane3, ...: +Scales for depth axis. +.TP +row1, row2, row3, ...: +Scales for the vertical axis. +.TP +col1, col2, col3, ...: +Scales for the horizontal axis. +.TP +data1, data2, data3, ...: +The data ordered by rows, left to right and top to bottom; +then optionally, ordered by planes, front to back. +.RE + +For FP32 and FP64 input format, "format", "nplanes", "nrows", +"ncols", and "nplanes" are native integers; where "format" is the +integer representation of the appropriate 4-character string +(0x46503332 for "FP32" and 0x46503634 for "FP64"). +The remaining input fields are composed of native 32-bit floating +point values for FP32 input format, or native 64-bit floating +point values for FP64 input format. + +For IN32, IN16 and IN08 input format, "format", "nplanes", "nrows", +"ncols", and "nplanes" are native integers; where "format" is the +integer representation of the appropriate 4-character string. +The remaining input fields are composed of native 32-bit integer +values for IN32 input format, or native 16-bit integer values for +IN16 input format or native 8-bit integer values for IN08 input +format. +.SH EXAMPLES +Convert floating point data in "\*(T<\fIf1.txt\fR\*(T>" to SDS +format, and store it as an SDS in HDF file "\*(T<\fIo1\fR\*(T>": +.PP +.nf +\*(T< +\fBhdfimport\fR \fIf1.txt\fR \fB\-o\fR \fIo1\fR + \*(T> +.fi +.PP +Convert floating point data in "\*(T<\fIf2.hdf\fR\*(T>" to 8-bit +raster format, and store it as an RIS8 in HDF file +"\*(T<\fIo2\fR\*(T>": +.PP +.nf +\*(T< +\fBhdfimport\fR \fIf2.hdf\fR \fB\-o\fR \fIo2\fR \fB\-r\fR + \*(T> +.fi +.PP +Convert floating point data in "\*(T<\fIf3.bin\fR\*(T>" to 8-bit +raster format and SDS format, and store both the RIS8 and the SDS in +HDF file "\*(T<\fIo3\fR\*(T>": +.PP +.nf +\*(T< +\fBhdfimport\fR \fIf3.bin\fR \fB\-o\fR \fIo3\fR \fB\-r\fR \fB\-f\fR + \*(T> +.fi +.PP +Convert floating point data in "\*(T<\fIf4\fR\*(T>" to a 500x600 +raster image, and store the RIS8 in HDF file "\*(T<\fIo4\fR\*(T>". +Also store a palette from "\*(T<\fIpalfile\fR\*(T>" with the image: +.PP +.nf +\*(T< +\fBhdfimport\fR \fIf4\fR \fB\-o\fR \fIo4\fR \fB\-r\fR \fB\-e\fR \fI500 600\fR \fB\-p\fR \fIpalfile\fR + \*(T> +.fi +.PP +Convert floating point data in "\*(T<\fIf5\fR\*(T>" to 200 planes +of 500x600 raster images, and store the RIS8 in HDF file +"\*(T<\fIo5\fR\*(T>". +Also scale the image data so that it is centered about a mean value of +10.0: +.PP +.nf +\*(T< +\fBhdfimport\fR \fIf5\fR \fB\-o\fR \fIo5\fR \fB\-r\fR \fB\-i\fR \fI500 600 200\fR \fB\-m\fR \fI10.0\fR + \*(T> +.fi diff --git a/debian/man/hdfimport.1.xml b/debian/man/hdfimport.1.xml new file mode 100644 index 0000000..9bcd8e6 --- /dev/null +++ b/debian/man/hdfimport.1.xml @@ -0,0 +1,417 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd";> +<refentry id='hdfimport'> + + <refmeta> + <refentrytitle>hdfimport</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>hdfimport</refname> + <refpurpose>imports ASCII or binary data into HDF</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>hdfimport</command> + <arg choice='plain'><infile></arg> + <arg choice='opt'> + <group> + <arg choice='opt'><option>-t[ype]</option> <replaceable>output-type</replaceable></arg> + <arg choice='opt'><option>-n</option></arg> + </group> + <arg choice='opt'> + <infile> + <group> + <arg choice='opt'><option>-t[ype]</option> <replaceable>output-type</replaceable></arg> + <arg choice='opt'><option>-n</option></arg> + </group> + ... + </arg> + </arg> + <option>-o[utfile]</option> <replaceable>outfile</replaceable> + <arg choice='opt'><option>-r[aster]</option> [ras_opts ...]</arg> + <arg choice='opt'><option>-f[loat]</option></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>hdfimport</command> converts floating point data to HDF + Scientific Data Set (SDS) and/or 8-bit Raster Image Set (RIS8) format, + storing the results in an HDF file. + The image data can be scaled about a mean value. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist> + + <varlistentry> + <term><replaceable>infile(s)</replaceable></term> + <listitem> + <para> + Name of the input file(s), containing a single two-dimensional or + three-dimensional floating point array in either ASCII text, + native floating point, native integer or HDF SDS format. + If an HDF file is used for input, it must contain an SDS. + The SDS need only contain a dimension record and the data, but if + it also contains maximum and minimum values and/or scales for each + axis, these will be used. + If the input format is ASCII text or native floating point or + native integer, see "Notes" below on how it must be organized. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-t[ype]</option> <replaceable>output-type</replaceable></term> + <listitem> + <para> + Optionally used for every input ASCII file to specify the data type + of the data-set to be written. If not specified default data type + is 32-bit floating point. + <replaceable>output-type</replaceable> can be any of the following: + FP32 (default), FP64, INT32, INT16, INT8. + It can be used only with ASCII files. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option></option></term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-n</option></term> + <listitem> + <para> + This option is to be used only if the binary input file contains + 64-bit floating point data and the default behaviour (default + behaviour is to write it to a 32-bit floating point data-set) + should be overridden to write it to a 64-bit floating point + data-set. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-t[ype]</option> <replaceable>output-type</replaceable></term> + <listitem> + <para> + Data from one or more input files are stored as one or more data + sets and/or images in one HDF output file, + "<replaceable>outfile</replaceable>". + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-r[aster]</option></term> + <listitem> + <para> + Store output as a raster image set in the output file. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-f[loat]</option></term> + <listitem> + <para> + Store output as a scientific data set in the output file. + This is the default if the "<option>-r</option>" option is not + specified. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>[ras_opts ...]</term> + <listitem> + <para> + <variablelist> + + <varlistentry> + <term><option>-e[xpand]</option> <replaceable>horiz</replaceable> <replaceable>vert</replaceable> [<replaceable>depth</replaceable>]</term> + <listitem> + <para> + Expand float data via pixel replication to produce the + image(s). + "<replaceable>horiz</replaceable>" and + "<replaceable>vert</replaceable>" give the horizontal and + vertical resolution of the image(s) to be produced; and + optionally, "<replaceable>depth</replaceable>" gives the + number of images or depth planes (for 3D input data). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-i[nterp]</option> <replaceable>horiz</replaceable> <replaceable>vert</replaceable> [<replaceable>depth</replaceable>]</term> + <listitem> + <para> + Apply bilinear, or trilinear, interpolation to the float + data to produce the image(s). + "<replaceable>horiz</replaceable>", + "<replaceable>vert</replaceable>", and + "<replaceable>depth</replaceable>" must be greater than or + equal to the dimensions of the original dataset. + If max and min are supplied in input file, this option clips + values that are greater than max or less then min, setting + them to the max and min, respectively. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-p[alfile]</option> <replaceable>palfile</replaceable></term> + <listitem> + <para> + Store the palette with the image. + Get the palette from "<replaceable>palfile</replaceable>"; + which may be an HDF file containing a palette, or a file + containing a raw palette. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-m[ean]</option> <replaceable>mean</replaceable></term> + <listitem> + <para> + If a floating point mean value is given, the image will be + scaled about the mean. + The new extremes (newmax and newmin), as given by: + <screen> + <informalequation> + <alt>newmax = mean + max(abs(max-mean), abs(mean-min))</alt> + </informalequation> + <informalequation> + <alt>newmin = mean - max(abs(max-mean), abs(mean-min))</alt> + </informalequation> + </screen> + will be equidistant from the mean value. + If no mean value is given, then the mean will be: + <screen> + <informalequation> + <alt>0.5 * (max + min)</alt> + </informalequation> + </screen> + </para> + </listitem> + </varlistentry> + + </variablelist> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Notes:</term> + <listitem> + <para> + If the input file format is ASCII text or native floating + point or native integer(32-bit, 16-bit, 8-bit), it must + have the following input fields: + <screen> +format +nplanes +nrows +cols +max_value +min_value +[plane1 plane2 plane3 ...] +row1 row2 row3 ... +col1 col2 col3 ... +data1 data2 data3 ... + </screen> + </para> + <para> + Where: + <variablelist> + + <varlistentry> + <term>format:</term> + <listitem> + <para> + Format designator + ("TEXT", "FP32", "FP64", "IN32", "IN16", "IN08"). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>nplanes, nrows, ncols:</term> + <listitem> + <para> + Dimensions are specified in the order slowest changing + dimension first. + ncols is dimension of the fastest changing dimension. + (horizontal axis or X-axis in a 3D scale) + nrows corresponds to dimension of the vertical axis or + Y-axis in a 3D scale. + nplanes corresponds to the slowest changing dimension i.e. + dimension of the depth axis or the Z-axis in a 3D scale + ("1" for 2D input). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>max_value:</term> + <listitem> + <para> + Maximum data value. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>min_value:</term> + <listitem> + <para> + Minimum data value. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>plane1, plane2, plane3, ...:</term> + <listitem> + <para> + Scales for depth axis. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>row1, row2, row3, ...:</term> + <listitem> + <para> + Scales for the vertical axis. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>col1, col2, col3, ...:</term> + <listitem> + <para> + Scales for the horizontal axis. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>data1, data2, data3, ...:</term> + <listitem> + <para> + The data ordered by rows, left to right and top to bottom; + then optionally, ordered by planes, front to back. + </para> + </listitem> + </varlistentry> + + </variablelist> + </para> + <para> + For FP32 and FP64 input format, "format", "nplanes", "nrows", + "ncols", and "nplanes" are native integers; where "format" is the + integer representation of the appropriate 4-character string + (0x46503332 for "FP32" and 0x46503634 for "FP64"). + The remaining input fields are composed of native 32-bit floating + point values for FP32 input format, or native 64-bit floating + point values for FP64 input format. + </para> + <para> + For IN32, IN16 and IN08 input format, "format", "nplanes", "nrows", + "ncols", and "nplanes" are native integers; where "format" is the + integer representation of the appropriate 4-character string. + The remaining input fields are composed of native 32-bit integer + values for IN32 input format, or native 16-bit integer values for + IN16 input format or native 8-bit integer values for IN08 input + format. + </para> + </listitem> + </varlistentry> + + </variablelist> + + </refsect1> + + <refsect1 id='examples'> + <title>EXAMPLES</title> + + <example> + <para> + Convert floating point data in "<filename>f1.txt</filename>" to SDS + format, and store it as an SDS in HDF file "<filename>o1</filename>": + </para> + + <screen> +<command>hdfimport</command> <filename>f1.txt</filename> <option>-o</option> <filename>o1</filename> + </screen> + </example> + + <example> + <para> + Convert floating point data in "<filename>f2.hdf</filename>" to 8-bit + raster format, and store it as an RIS8 in HDF file + "<filename>o2</filename>": + </para> + + <screen> +<command>hdfimport</command> <filename>f2.hdf</filename> <option>-o</option> <filename>o2</filename> <option>-r</option> + </screen> + </example> + + <example> + <para> + Convert floating point data in "<filename>f3.bin</filename>" to 8-bit + raster format and SDS format, and store both the RIS8 and the SDS in + HDF file "<filename>o3</filename>": + </para> + + <screen> +<command>hdfimport</command> <filename>f3.bin</filename> <option>-o</option> <filename>o3</filename> <option>-r</option> <option>-f</option> + </screen> + </example> + + <example> + <para> + Convert floating point data in "<filename>f4</filename>" to a 500x600 + raster image, and store the RIS8 in HDF file "<filename>o4</filename>". + Also store a palette from "<filename>palfile</filename>" with the image: + </para> + + <screen> +<command>hdfimport</command> <filename>f4</filename> <option>-o</option> <filename>o4</filename> <option>-r</option> <option>-e</option> <replaceable>500 600</replaceable> <option>-p</option> <filename>palfile</filename> + </screen> + </example> + + <example> + <para> + Convert floating point data in "<filename>f5</filename>" to 200 planes + of 500x600 raster images, and store the RIS8 in HDF file + "<filename>o5</filename>". + Also scale the image data so that it is centered about a mean value of + 10.0: + </para> + + <screen> +<command>hdfimport</command> <filename>f5</filename> <option>-o</option> <filename>o5</filename> <option>-r</option> <option>-i</option> <replaceable>500 600 200</replaceable> <option>-m</option> <replaceable>10.0</replaceable> + </screen> + </example> + + </refsect1> + +</refentry> diff --git a/debian/man/hdiff.1 b/debian/man/hdiff.1 new file mode 100644 index 0000000..fb25ac6 --- /dev/null +++ b/debian/man/hdiff.1 @@ -0,0 +1,80 @@ +'\" -*- coding: us-ascii -*- +.if \n(.g .ds T< \\FC +.if \n(.g .ds T> \\F[\n[.fam]] +.de URL +\\$2 \(la\\$1\(ra\\$3 +.. +.if \n(.g .mso www.tmac +.TH hdiff 1 "28 May 2016" "" "" +.SH NAME +hdiff \- compares two HDF files and reports the differences +.SH SYNOPSIS +'nh +.fi +.ad l +\fBhdiff\fR \kx +.if (\nx>(\n(.l/2)) .nr x (\n(.l/5) +'in \n(.iu+\nxu +[\fB-V\fR] [\fB-b\fR] [\fB-g\fR] [\fB-s\fR] [\fB-d\fR] [\fB-D\fR] [\fB-S\fR] [\fB-v\fR \fIvar1[,...]\fR] [\fB-u\fR \fIvar1[,...]\fR] [\fB-e\fR \fIcount\fR] [\fB-t\fR \fIlimit\fR] [\fB-p\fR \fIrelative\fR] file1 file2 +'in \n(.iu-\nxu +.ad b +'hy +.SH DESCRIPTION +\fBhdiff\fR compares two HDF files and reports the +differences. +.SH OPTIONS +.TP +\*(T<\fB\-V\fR\*(T> +Display version of the HDF4 library and exit +.TP +\*(T<\fB\-b\fR\*(T> +Verbose mode +.TP +\*(T<\fB\-g\fR\*(T> +Compare global attributes only +.TP +\*(T<\fB\-s\fR\*(T> +Compare SD local attributes only +.TP +\*(T<\fB\-d\fR\*(T> +Compare SD data only +.TP +\*(T<\fB\-D\fR\*(T> +Compare Vdata data only +.TP +\*(T<\fB\-S\fR\*(T> +Print statistics +.TP +\*(T<\fB\-v\fR\*(T> \fIvar1[,...]\fR +Compare SD data on variable(s) \fIvar1\fR,... +only +.TP +\*(T<\fB\-u\fR\*(T> \fIvar1[,...]\fR +Compare vdata on variable(s) \fIvar1\fR,... only +.TP +\*(T<\fB\-e\fR\*(T> \fIcount\fR +Print difference up to count number for each variable +.TP +\*(T<\fB\-t\fR\*(T> \fIlimit\fR +Print difference when it is greater than limit +.TP +\*(T<\fB\-p\fR\*(T> \fIrelative\fR +Print difference when it is greater than a relative limit +.TP +\*(T<\fIfile1\fR\*(T> +File name of the first HDF file +.TP +\*(T<\fIfile2\fR\*(T> +File name of the second HDF file +.PP +The '\fIcount\fR' value must be a positive integer +.PP +The '\fIlimit\fR' +and '\fIrelative\fR' +values must be positive numbers +.PP +The \*(T<\fB\-t\fR\*(T> compare criteria is |a - b| > limit +.PP +The \*(T<\fB\-p\fR\*(T> compare criteria is |(b-a)/a| > relative +.PP +Return codes: 0 (no differences found), 1 (differences found) diff --git a/debian/man/hdiff.1.xml b/debian/man/hdiff.1.xml new file mode 100644 index 0000000..8d58913 --- /dev/null +++ b/debian/man/hdiff.1.xml @@ -0,0 +1,194 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd";> +<refentry id='hdiff'> + + <refmeta> + <refentrytitle>hdiff</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>hdiff</refname> + <refpurpose>compares two HDF files and reports the differences</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>hdiff</command> + <arg choice='opt'><option>-V</option></arg> + <arg choice='opt'><option>-b</option></arg> + <arg choice='opt'><option>-g</option></arg> + <arg choice='opt'><option>-s</option></arg> + <arg choice='opt'><option>-d</option></arg> + <arg choice='opt'><option>-D</option></arg> + <arg choice='opt'><option>-S</option></arg> + <arg choice='opt'><option>-v</option> <replaceable>var1[,...]</replaceable></arg> + <arg choice='opt'><option>-u</option> <replaceable>var1[,...]</replaceable></arg> + <arg choice='opt'><option>-e</option> <replaceable>count</replaceable></arg> + <arg choice='opt'><option>-t</option> <replaceable>limit</replaceable></arg> + <arg choice='opt'><option>-p</option> <replaceable>relative</replaceable></arg> + <arg choice='plain'><filename>file1</filename></arg> + <arg choice='plain'><filename>file2</filename></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>hdiff</command> compares two HDF files and reports the + differences. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist> + + <varlistentry> + <term><option>-V</option></term> + <listitem> + <para> + Display version of the HDF4 library and exit + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-b</option></term> + <listitem> + <para> + Verbose mode + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-g</option></term> + <listitem> + <para> + Compare global attributes only + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-s</option></term> + <listitem> + <para> + Compare SD local attributes only + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-d</option></term> + <listitem> + <para> + Compare SD data only + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-D</option></term> + <listitem> + <para> + Compare Vdata data only + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-S</option></term> + <listitem> + <para> + Print statistics + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-v</option> <replaceable>var1[,...]</replaceable></term> + <listitem> + <para> + Compare SD data on variable(s) <replaceable>var1</replaceable>,... + only + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-u</option> <replaceable>var1[,...]</replaceable></term> + <listitem> + <para> + Compare vdata on variable(s) <replaceable>var1</replaceable>,... only + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-e</option> <replaceable>count</replaceable></term> + <listitem> + <para> + Print difference up to count number for each variable + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-t</option> <replaceable>limit</replaceable></term> + <listitem> + <para> + Print difference when it is greater than limit + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-p</option> <replaceable>relative</replaceable></term> + <listitem> + <para> + Print difference when it is greater than a relative limit + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><filename>file1</filename></term> + <listitem> + <para> + File name of the first HDF file + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><filename>file2</filename></term> + <listitem> + <para> + File name of the second HDF file + </para> + </listitem> + </varlistentry> + + </variablelist> + <para> + The '<replaceable>count</replaceable>' value must be a positive integer + </para> + <para> + The '<replaceable>limit</replaceable>' + and '<replaceable>relative</replaceable>' + values must be positive numbers + </para> + <para> + The <option>-t</option> compare criteria is |a - b| > limit + </para> + <para> + The <option>-p</option> compare criteria is |(b-a)/a| > relative + </para> + <para> + Return codes: 0 (no differences found), 1 (differences found) + </para> + </refsect1> + +</refentry> diff --git a/debian/man/hrepack.1 b/debian/man/hrepack.1 new file mode 100644 index 0000000..3eb19d4 --- /dev/null +++ b/debian/man/hrepack.1 @@ -0,0 +1,166 @@ +'\" -*- coding: us-ascii -*- +.if \n(.g .ds T< \\FC +.if \n(.g .ds T> \\F[\n[.fam]] +.de URL +\\$2 \(la\\$1\(ra\\$3 +.. +.if \n(.g .mso www.tmac +.TH hrepack 1 "28 May 2016" "" "" +.SH NAME +hrepack \- copies an HDF file to a new file +.SH SYNOPSIS +'nh +.fi +.ad l +\fBhrepack\fR \kx +.if (\nx>(\n(.l/2)) .nr x (\n(.l/5) +'in \n(.iu+\nxu +\fB-i\fR \fIinput\fR \fB-o\fR \fIoutput\fR [\fB-V\fR] [\fB-h\fR] [\fB-v\fR] [\fB-t\fR \fIcomp_info\fR] [\fB-c\fR \fIchunk_info\fR] [\fB-f\fR \fIcfile\fR] [\fB-m\fR \fIsize\fR] +'in \n(.iu-\nxu +.ad b +'hy +.SH DESCRIPTION +\fBhrepack\fR copies an HDF file to a new file with/without +compression and/or chunking. +.SH OPTIONS +.TP +\*(T<\fB\-i\fR\*(T> \fIinput\fR +input HDF File +.TP +\*(T<\fB\-o\fR\*(T> \fIoutput\fR +output HDF File +.TP +\*(T<\fB\-V\fR\*(T> +prints version of the HDF4 library and exits +.TP +\*(T<\fB\-h\fR\*(T> +prints usage information +.TP +\*(T<\fB\-v\fR\*(T> +verbose mode +.TP +\*(T<\fB\-t\fR\*(T> \fIcomp_info\fR +compression type: '\fIcomp_info\fR' is a +string with the format +<object list>:<type of compression><parameters> + +<object list> is a comma separated list of object names +meaning apply compression only to those objects. +\&'*' means all objects. + +<type of compression> can be: +.RS +RLE + +for RLE compression + +HUFF + +for Huffman + +GZIP + +for gzip + +JPEG + +for JPEG (for images only) + +SZIP + +for szip + +NONE + +to uncompress +.RE + +<parameters> is optional compression info +.RS +RLE + +no parameter + +HUFF + +the skip-size + +GZIP + +the deflation level + +JPEG + +the quality factor + +SZIP + +pixels per block, compression mode (NN or EC) +.RE + +.TP +\*(T<\fB\-c\fR\*(T> \fIchunk_info\fR +apply chunking. +\fIchunk_info\fR is a string with the format +<object list>:<chunk information> + +<object list> is a comma separated list of object names +meaning apply chunking only to those objects. +\&'*' means all objects + +<chunk information> is the chunk size of each dimension: +\fIdim_1 x dim_2 x ... dim_n\fR or +NONE, to unchunk a previous chunked object +.TP +\*(T<\fB\-f\fR\*(T> \fIcfile\fR +file with compression information \*(T<\fB\-t\fR\*(T> and +\*(T<\fB\-c\fR\*(T> +.TP +\*(T<\fB\-m\fR\*(T> \fIsize\fR +do not compress objects smaller than size (bytes) +.SH EXAMPLES +compresses all objects in the file \*(T<\fIfile1.hdf\fR\*(T>, +using RLE compression +.PP +.nf +\*(T< +\fBhrepack\fR \fB\-v\fR \fB\-i\fR \fIfile1.hdf\fR \fB\-o\fR \fIfile2.hdf\fR \fB\-t\fR '*:RLE' + \*(T> +.fi +.PP +applies Skipping Huffman compression with skip factor of 1, +for objects /group1/A, /group2/B and C +.PP +.nf +\*(T< +\fBhrepack\fR \fB\-v\fR \fB\-i\fR \fIfile1.hdf\fR \fB\-o\fR \fIfile2.hdf\fR \fB\-t\fR '/group1/A,/group2/B,C:HUFF 1' + \*(T> +.fi +.PP +applies RLE compression for object /group1/D. +.PP +applies chunking to objects D and E using a chunk size of 10 for the 2 dimensions +.PP +.nf +\*(T< +\fBhrepack\fR \fB\-v\fR \fB\-i\fR \fIfile1.hdf\fR \fB\-o\fR \fIfile2.hdf\fR \fB\-t\fR '/group1/D:RLE' \fB\-c\fR 'D,E:10x10' + \*(T> +.fi +.PP +uncompresses object A +.PP +.nf +\*(T< +\fBhrepack\fR \fB\-v\fR \fB\-i\fR \fIfile1.hdf\fR \fB\-o\fR \fIfile2.hdf\fR \fB\-t\fR 'A:NONE' + \*(T> +.fi +.PP +applies SZIP compression to object A, with parameters 8 and NN +.PP +.nf +\*(T< +\fBhrepack\fR \fB\-v\fR \fB\-i\fR \fIfile1.hdf\fR \fB\-o\fR \fIfile2.hdf\fR \fB\-t\fR 'A:SZIP 8,NN' + \*(T> +.fi +.PP +Note: the use of the verbose option -v is recommended diff --git a/debian/man/hrepack.1.xml b/debian/man/hrepack.1.xml new file mode 100644 index 0000000..2e0ea36 --- /dev/null +++ b/debian/man/hrepack.1.xml @@ -0,0 +1,325 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd";> +<refentry id='hrepack'> + + <refmeta> + <refentrytitle>hrepack</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>hrepack</refname> + <refpurpose>copies an HDF file to a new file</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>hrepack</command> + <arg choice='plain'><option>-i</option> <replaceable>input</replaceable></arg> + <arg choice='plain'><option>-o</option> <replaceable>output</replaceable></arg> + <arg choice='opt'><option>-V</option></arg> + <arg choice='opt'><option>-h</option></arg> + <arg choice='opt'><option>-v</option></arg> + <arg choice='opt'><option>-t</option> <replaceable>comp_info</replaceable></arg> + <arg choice='opt'><option>-c</option> <replaceable>chunk_info</replaceable></arg> + <arg choice='opt'><option>-f</option> <replaceable>cfile</replaceable></arg> + <arg choice='opt'><option>-m</option> <replaceable>size</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>hrepack</command> copies an HDF file to a new file with/without + compression and/or chunking. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist> + + <varlistentry> + <term><option>-i</option> <replaceable>input</replaceable></term> + <listitem> + <para> + input HDF File + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-o</option> <replaceable>output</replaceable></term> + <listitem> + <para> + output HDF File + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-V</option></term> + <listitem> + <para> + prints version of the HDF4 library and exits + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-h</option></term> + <listitem> + <para> + prints usage information + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-v</option></term> + <listitem> + <para> + verbose mode + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-t</option> <replaceable>comp_info</replaceable></term> + <listitem> + <para> + compression type: '<replaceable>comp_info</replaceable>' is a + string with the format + <object list>:<type of compression><parameters> + </para> + <para> + <object list> is a comma separated list of object names + meaning apply compression only to those objects. + '*' means all objects. + </para> + <para> + <type of compression> can be: + <variablelist> + + <varlistitem> + <term>RLE</term> + <listitem> + <para> + for RLE compression + </para> + </listitem> + </varlistitem> + + <varlistitem> + <term>HUFF</term> + <listitem> + <para> + for Huffman + </para> + </listitem> + </varlistitem> + + <varlistitem> + <term>GZIP</term> + <listitem> + <para> + for gzip + </para> + </listitem> + </varlistitem> + + <varlistitem> + <term>JPEG</term> + <listitem> + <para> + for JPEG (for images only) + </para> + </listitem> + </varlistitem> + + <varlistitem> + <term>SZIP</term> + <listitem> + <para> + for szip + </para> + </listitem> + </varlistitem> + + <varlistitem> + <term>NONE</term> + <listitem> + <para> + to uncompress + </para> + </listitem> + </varlistitem> + + </variablelist> + </para> + <para> + <parameters> is optional compression info + <variablelist> + + <varlistitem> + <term>RLE</term> + <listitem> + <para> + no parameter + </para> + </listitem> + </varlistitem> + + <varlistitem> + <term>HUFF</term> + <listitem> + <para> + the skip-size + </para> + </listitem> + </varlistitem> + + <varlistitem> + <term>GZIP</term> + <listitem> + <para> + the deflation level + </para> + </listitem> + </varlistitem> + + <varlistitem> + <term>JPEG</term> + <listitem> + <para> + the quality factor + </para> + </listitem> + </varlistitem> + + <varlistitem> + <term>SZIP</term> + <listitem> + <para> + pixels per block, compression mode (NN or EC) + </para> + </listitem> + </varlistitem> + + </variablelist> + </para> + <para> + + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-c</option> <replaceable>chunk_info</replaceable></term> + <listitem> + <para> + apply chunking. + <replaceable>chunk_info</replaceable> is a string with the format + <object list>:<chunk information> + </para> + <para> + <object list> is a comma separated list of object names + meaning apply chunking only to those objects. + '*' means all objects + </para> + <para> + <chunk information> is the chunk size of each dimension: + <replaceable>dim_1 x dim_2 x ... dim_n</replaceable> or + NONE, to unchunk a previous chunked object + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-f</option> <replaceable>cfile</replaceable></term> + <listitem> + <para> + file with compression information <option>-t</option> and + <option>-c</option> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-m</option> <replaceable>size</replaceable></term> + <listitem> + <para> + do not compress objects smaller than size (bytes) + </para> + </listitem> + </varlistentry> + + </variablelist> + + </refsect1> + + <refsect1 id='examples'> + <title>EXAMPLES</title> + + <example> + <para> + compresses all objects in the file <filename>file1.hdf</filename>, + using RLE compression + </para> + + <screen> +<command>hrepack</command> <option>-v</option> <option>-i</option> <filename>file1.hdf</filename> <option>-o</option> <filename>file2.hdf</filename> <option>-t</option> <literal>'*:RLE'</literal> + </screen> + </example> + + <example> + <para> + applies Skipping Huffman compression with skip factor of 1, + for objects /group1/A, /group2/B and C + </para> + + <screen> +<command>hrepack</command> <option>-v</option> <option>-i</option> <filename>file1.hdf</filename> <option>-o</option> <filename>file2.hdf</filename> <option>-t</option> <literal>'/group1/A,/group2/B,C:HUFF 1'</literal> + </screen> + </example> + + <example> + <para> + applies RLE compression for object /group1/D. + </para> + <para> + applies chunking to objects D and E using a chunk size of 10 for the 2 dimensions + </para> + + <screen> +<command>hrepack</command> <option>-v</option> <option>-i</option> <filename>file1.hdf</filename> <option>-o</option> <filename>file2.hdf</filename> <option>-t</option> <literal>'/group1/D:RLE'</literal> <option>-c</option> <literal>'D,E:10x10'</literal> + </screen> + </example> + + <example> + <para> + uncompresses object A + </para> + + <screen> +<command>hrepack</command> <option>-v</option> <option>-i</option> <filename>file1.hdf</filename> <option>-o</option> <filename>file2.hdf</filename> <option>-t</option> <literal>'A:NONE'</literal> + </screen> + </example> + + <example> + <para> + applies SZIP compression to object A, with parameters 8 and NN + </para> + + <screen> +<command>hrepack</command> <option>-v</option> <option>-i</option> <filename>file1.hdf</filename> <option>-o</option> <filename>file2.hdf</filename> <option>-t</option> <literal>'A:SZIP 8,NN'</literal> + </screen> + + <para> + Note: the use of the verbose option -v is recommended + </para> + </example> + + </refsect1> + +</refentry> -- Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-grass/hdf4.git _______________________________________________ Pkg-grass-devel mailing list [email protected] http://lists.alioth.debian.org/cgi-bin/mailman/listinfo/pkg-grass-devel
