mirror of
https://github.com/HDFGroup/hdf5.git
synced 2026-09-25 04:09:44 +03:00
Fix display of '--' options in documentation (#6318)
* Fix display of '--' options in documentation * Fix more formatting
This commit is contained in:
jhendersonHDF
+11
-11
@@ -27,21 +27,21 @@
|
||||
* <h4>h5copy [OPTIONS] [OBJECTS...]</h4>
|
||||
*
|
||||
* \subsection subsec_cltools_h5copy_objs Objects
|
||||
* \li <strong>--input</strong> input file name
|
||||
* \li <strong>--output</strong> output file name
|
||||
* \li <strong>--source</strong> source object name
|
||||
* \li <strong>--destination</strong> destination object name
|
||||
* \li <strong>\--input</strong> input file name
|
||||
* \li <strong>\--output</strong> output file name
|
||||
* \li <strong>\--source</strong> source object name
|
||||
* \li <strong>\--destination</strong> destination object name
|
||||
*
|
||||
* \subsection subsec_cltools_h5copy_error Error Report Option
|
||||
* \li <strong>--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
|
||||
Optional value 2 also prints file open errors, --enable-error-stack=2.
|
||||
* \li <strong>\--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
|
||||
* Optional value 2 also prints file open errors, <code>\--enable-error-stack=2</code>.
|
||||
*
|
||||
* \subsection subsec_cltools_h5copy_options Options
|
||||
* \li <strong>--help</strong> Print a usage message and exit
|
||||
* \li <strong>--parents</strong> No error if existing, make parent groups as needed
|
||||
* \li <strong>--verbose</strong> Print information about OBJECTS and OPTIONS
|
||||
* \li <strong>--version</strong> Print the library version number and exit
|
||||
* \li <strong>--flag</strong> Flag type
|
||||
* \li <strong>\--help</strong> Print a usage message and exit
|
||||
* \li <strong>\--parents</strong> No error if existing, make parent groups as needed
|
||||
* \li <strong>\--verbose</strong> Print information about OBJECTS and OPTIONS
|
||||
* \li <strong>\--version</strong> Print the library version number and exit
|
||||
* \li <strong>\--flag</strong> Flag type
|
||||
*
|
||||
* \subsubsection subsubsec_cltools_h5copy_options_args Flag Type Options
|
||||
* Flag type is one of the following strings:
|
||||
|
||||
@@ -31,50 +31,50 @@
|
||||
* \li <strong>[obj2]</strong> Name of an HDF5 object, in absolute path
|
||||
*
|
||||
* \subsection subsec_cltools_h5diff_error Error Report
|
||||
* \li <strong>--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
|
||||
* Optional value 2 also prints file open errors, --enable-error-stack=2.
|
||||
* \li <strong>\--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
|
||||
* Optional value 2 also prints file open errors, <code>\--enable-error-stack=2</code>.
|
||||
*
|
||||
* \subsection subsec_cltools_h5diff_options Options
|
||||
* \li <strong>--help</strong> Print a usage message and exit.
|
||||
* \li <strong>--version</strong> Print the library version number and exit.
|
||||
* \li <strong>--report</strong> Report mode. Print differences.
|
||||
* \li <strong>--verbose</strong> Verbose mode. Print differences information and list of objects.
|
||||
* \li <strong>--verbose=N</strong> Verbose mode with level. Print differences and list of objects.
|
||||
* \li <strong>\--help</strong> Print a usage message and exit.
|
||||
* \li <strong>\--version</strong> Print the library version number and exit.
|
||||
* \li <strong>\--report</strong> Report mode. Print differences.
|
||||
* \li <strong>\--verbose</strong> Verbose mode. Print differences information and list of objects.
|
||||
* \li <strong>\--verbose=N</strong> Verbose mode with level. Print differences and list of objects.
|
||||
* Level of detail depends on value of N:
|
||||
* <ul><li> <strong>0</strong> Identical to '-v' or '--verbose'.</li>
|
||||
* <ul><li> <strong>0</strong> Identical to '-v' or '\--verbose'.</li>
|
||||
* <li> <strong>1</strong> All level 0 information plus one-line attribute status summary.</li>
|
||||
* <li> <strong>2</strong> All level 1 information plus extended attribute status report.</li>
|
||||
* <li> <strong>3</strong> All level 2 information plus file names.</li></ul>
|
||||
* \li <strong>--quiet</strong> Quiet mode. Do not produce output.
|
||||
* \li <strong>--page-buffer-size=N</strong> Set the page buffer cache size, N=non-negative integers
|
||||
* \li <strong>--vol-value-1</strong> Value (ID) of the VOL connector to use for opening the
|
||||
* \li <strong>\--quiet</strong> Quiet mode. Do not produce output.
|
||||
* \li <strong>\--page-buffer-size=N</strong> Set the page buffer cache size, N=non-negative integers
|
||||
* \li <strong>\--vol-value-1</strong> Value (ID) of the VOL connector to use for opening the
|
||||
* first HDF5 file specified
|
||||
* \li <strong>--vol-name-1</strong> Name of the VOL connector to use for opening the first
|
||||
* \li <strong>\--vol-name-1</strong> Name of the VOL connector to use for opening the first
|
||||
* HDF5 file specified
|
||||
* \li <strong>--vol-info-1</strong> VOL-specific info to pass to the VOL connector used for
|
||||
* \li <strong>\--vol-info-1</strong> VOL-specific info to pass to the VOL connector used for
|
||||
* opening the first HDF5 file specified
|
||||
* \li <strong>--vol-value-2</strong> Value (ID) of the VOL connector to use for opening the
|
||||
* \li <strong>\--vol-value-2</strong> Value (ID) of the VOL connector to use for opening the
|
||||
* second HDF5 file specified
|
||||
* \li <strong>--vol-name-2</strong> Name of the VOL connector to use for opening the second
|
||||
* \li <strong>\--vol-name-2</strong> Name of the VOL connector to use for opening the second
|
||||
* HDF5 file specified
|
||||
* \li <strong>--vol-info-2</strong> VOL-specific info to pass to the VOL connector used for
|
||||
* \li <strong>\--vol-info-2</strong> VOL-specific info to pass to the VOL connector used for
|
||||
* opening the second HDF5 file specified.<br />
|
||||
* If none of the above options are used to specify a VOL for a file, then
|
||||
* the VOL named by HDF5_VOL_CONNECTOR (or the native VOL connector,
|
||||
* if that environment variable is unset) will be used
|
||||
* \li <strong>--vfd-value-1</strong> Value (ID) of the VFL driver to use for opening the
|
||||
* \li <strong>\--vfd-value-1</strong> Value (ID) of the VFL driver to use for opening the
|
||||
* first HDF5 file specified
|
||||
* \li <strong>--vfd-name-1</strong> Name of the VFL driver to use for opening the first
|
||||
* \li <strong>\--vfd-name-1</strong> Name of the VFL driver to use for opening the first
|
||||
* HDF5 file specified
|
||||
* \li <strong>--vfd-info-1 </strong> VFD-specific info to pass to the VFL driver used for
|
||||
* \li <strong>\--vfd-info-1 </strong> VFD-specific info to pass to the VFL driver used for
|
||||
* opening the first HDF5 file specified
|
||||
* \li <strong>--vfd-value-2 </strong> Value (ID) of the VFL driver to use for opening the
|
||||
* \li <strong>\--vfd-value-2 </strong> Value (ID) of the VFL driver to use for opening the
|
||||
* second HDF5 file specified
|
||||
* \li <strong>--vfd-name-2</strong> Name of the VFL driver to use for opening the second
|
||||
* \li <strong>\--vfd-name-2</strong> Name of the VFL driver to use for opening the second
|
||||
* HDF5 file specified
|
||||
* \li <strong>--vfd-info-2</strong> VFD-specific info to pass to the VFL driver used for
|
||||
* \li <strong>\--vfd-info-2</strong> VFD-specific info to pass to the VFL driver used for
|
||||
* opening the second HDF5 file specified
|
||||
* \li <strong>--follow-symlinks</strong>
|
||||
* \li <strong>\--follow-symlinks</strong>
|
||||
* Follow symbolic links (soft links and external links) and compare the
|
||||
* links' target objects.<br />
|
||||
* If symbolic link(s) with the same name exist in the files being
|
||||
@@ -82,63 +82,67 @@
|
||||
* object (dataset, group, or named datatype) or the link is a dangling
|
||||
* link (a soft or external link pointing to a target object that does
|
||||
* not yet exist).
|
||||
* <ul><li> If both symbolic links are dangling links, they are treated as being
|
||||
* the same; by default, h5diff returns an exit code of 0.
|
||||
* If, however, --no-dangling-links is used with --follow-symlinks,
|
||||
* this situation is treated as an error and h5diff returns an
|
||||
* exit code of 2.</li>
|
||||
* <li> If only one of the two links is a dangling link,they are treated as
|
||||
* being different and h5diff returns an exit code of 1.
|
||||
* If, however, --no-dangling-links is used with --follow-symlinks,
|
||||
* this situation is treated as an error and h5diff returns an
|
||||
* exit code of 2.</li>
|
||||
* <li> If both symbolic links point to existing objects, h5diff compares the
|
||||
* two objects.</li></ul>
|
||||
* If any symbolic link specified in the call to h5diff does not exist,
|
||||
* h5diff treats it as an error and returns an exit code of 2.
|
||||
* \li <strong>--no-dangling-links</strong>
|
||||
* Must be used with <strong>--follow-symlinks</strong> option; otherwise, h5diff shows
|
||||
* error message and returns an exit code of 2.<br />
|
||||
* Check for any symbolic links (soft links or external links) that do not
|
||||
* resolve to an existing object (dataset, group, or named datatype).
|
||||
* If any dangling link is found, this situation is treated as an error
|
||||
* and h5diff returns an exit code of 2.
|
||||
* \li <strong>--compare</strong> List objects that are not comparable
|
||||
* \li <strong>--nan</strong> Avoid NaNs detection
|
||||
* \li <strong>--count=C</strong> Print differences up to \b C. \b C must be a positive integer.
|
||||
* \li <strong>--delta=D</strong>
|
||||
* <ul>
|
||||
* <li> If both symbolic links are dangling links, they are treated as being
|
||||
* the same; by default, h5diff returns an exit code of 0.
|
||||
* If, however, <strong>\--no-dangling-links</strong> is used with
|
||||
* <strong>\--follow-symlinks</strong>, this situation is treated as an error
|
||||
* and h5diff returns an exit code of 2.
|
||||
* </li>
|
||||
* <li> If only one of the two links is a dangling link, they are treated as being
|
||||
* different and h5diff returns an exit code of 1. If, however,
|
||||
* <strong>\--no-dangling-links</strong> is used with
|
||||
* <strong>\--follow-symlinks</strong>, this situation is treated as an error
|
||||
* and h5diff returns an exit code of 2.
|
||||
* </li>
|
||||
* <li> If both symbolic links point to existing objects, h5diff compares the two
|
||||
* objects.
|
||||
* </li>
|
||||
* </ul>
|
||||
* If any symbolic link specified in the call to h5diff does not exist, h5diff treats
|
||||
* it as an error and returns an exit code of 2.
|
||||
* \li <strong>\--no-dangling-links</strong>
|
||||
* Must be used with <strong>\--follow-symlinks</strong> option; otherwise, h5diff
|
||||
* shows error message and returns an exit code of 2.<br />
|
||||
* Check for any symbolic links (soft links or external links) that do not resolve to
|
||||
* an existing object (dataset, group, or named datatype). If any dangling link is found,
|
||||
* this situation is treated as an error and h5diff returns an exit code of 2.
|
||||
* \li <strong>\--compare</strong> List objects that are not comparable
|
||||
* \li <strong>\--nan</strong> Avoid NaNs detection
|
||||
* \li <strong>\--count=C</strong> Print differences up to \b C. \b C must be a positive integer.
|
||||
* \li <strong>\--delta=D</strong>
|
||||
* Print difference if (<strong>|a-b| > D</strong>). \b D must be a positive number, where \b a
|
||||
* is the data point value in file1 and b is the data point value in file2.
|
||||
* Can not use with '--relative' or '--use-system-epsilon'.
|
||||
* \li <strong>--relative=R</strong>
|
||||
* Can not use with '\--relative' or '\--use-system-epsilon'.
|
||||
* \li <strong>\--relative=R</strong>
|
||||
* Print difference if (<strong>|(a-b)/b| > R</strong>). \b R must be a positive number, where \b a
|
||||
* is the data point value in file1 and \b b is the data point value in file2.
|
||||
* Can not use with '--delta' or '--use-system-epsilon'.
|
||||
* \li <strong>--use-system-epsilon</strong>
|
||||
* Can not use with '\--delta' or '\--use-system-epsilon'.
|
||||
* \li <strong>\--use-system-epsilon</strong>
|
||||
* Print difference if (<strong>|a-b| > EPSILON</strong>), \b EPSILON is system defined value, where
|
||||
* \b a is the data point value in file1 and \b b is the data point value in file2. If the system epsilon is
|
||||
* not defined,one of the following predefined values will be used: <ul><li><code
|
||||
* style="background-color:whitesmoke;">FLT_EPSILON = 1.19209E-07</code> for floating-point type</li>
|
||||
* <li><code style="background-color:whitesmoke;">DBL_EPSILON = 2.22045E-16</code>
|
||||
* for double precision</li></ul>
|
||||
* type Can not use with '--relative' or '--delta'.
|
||||
* \li <strong>--exclude-path "path"</strong> Exclude the specified path to an object when
|
||||
* type Can not use with '\--relative' or '\--delta'.
|
||||
* \li <strong>\--exclude-path "path"</strong> Exclude the specified path to an object when
|
||||
* comparing files or groups. If a group is excluded, all member objects will also be excluded.
|
||||
* The specified path is excluded wherever it occurs. This flexibility enables the same option
|
||||
* to exclude either objects that exist only in one file or common objects that are known to differ.<br />
|
||||
* When comparing files, "path" is the absolute path to the excluded object;
|
||||
* when comparing groups, "path" is similar to the relative path from the group to the excluded object. This
|
||||
* "path" can be taken from the first section of the output of the <strong>--verbose</strong> option.<br />
|
||||
* "path" can be taken from the first section of the output of the <strong>\--verbose</strong> option.<br />
|
||||
* For example, if you are comparing the group <code style="background-color:whitesmoke;">/groupA</code>
|
||||
* in two files and you want to exclude
|
||||
* <code style="background-color:whitesmoke;">/groupA/groupB/groupC</code> in both files,
|
||||
* the exclude option would read as follows:<br />
|
||||
* <code style="background-color:whitesmoke;">--exclude-path "/groupB/groupC"</code> <br />
|
||||
* <code style="background-color:whitesmoke;">\--exclude-path "/groupB/groupC"</code> <br />
|
||||
* If there are multiple paths to an object, only the specified path(s) will be excluded; the
|
||||
* comparison will include any path not explicitly excluded.<br />
|
||||
* This option can be used repeatedly to
|
||||
* exclude multiple paths.
|
||||
* \li <strong>--exclude-attribute "path/to/object/with/attribute"</strong> Exclude
|
||||
* \li <strong>\--exclude-attribute "path/to/object/with/attribute"</strong> Exclude
|
||||
* attributes on the specified path to an object when comparing files or groups.<br />
|
||||
* If there are multiple paths to an object, only the specified path(s) will be excluded;
|
||||
* the comparison will include any path not explicitly excluded.<br />
|
||||
@@ -168,11 +172,11 @@
|
||||
* The comparison is based on the return value of H5Tequal.
|
||||
* \li 4) <strong>Symbolic links</strong>
|
||||
* The paths to the target objects are compared.
|
||||
* (The option --follow-symlinks overrides the default behavior when
|
||||
* (The option \--follow-symlinks overrides the default behavior when
|
||||
* symbolic links are compared.)
|
||||
*
|
||||
* \subsubsection subsubsec_cltools_h5diff_subset Subsetting Options
|
||||
* \li <strong>--no-compact-subset</strong> Disable compact form of subsetting and allow the use
|
||||
* \li <strong>\--no-compact-subset</strong> Disable compact form of subsetting and allow the use
|
||||
* of "[" in dataset names.
|
||||
*
|
||||
* Subsetting is available by using the fcompact form of subsetting, as follows:
|
||||
|
||||
+74
-68
@@ -12,6 +12,7 @@
|
||||
#ifndef H5DUMP_H
|
||||
#define H5DUMP_H
|
||||
|
||||
/* clang-format off */
|
||||
/** \page H5TOOL_DP_UG The HDF5 h5dump Tool
|
||||
*
|
||||
* Navigate back: \ref index "Main" / \ref UG / \ref CommandTools
|
||||
@@ -23,96 +24,97 @@
|
||||
* With h5dump, you can display objects from an HDF5 file.
|
||||
*
|
||||
* \subsection subsec_cltools_h5dump_usage Usage
|
||||
* <h4>h5dump [OPTIONS] [files</h4>
|
||||
* <h4>h5dump [OPTIONS] [files]</h4>
|
||||
*
|
||||
* \subsection subsec_cltools_h5dump_error Error Report Option
|
||||
* \li <strong>--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
|
||||
* Optional value 2 also prints file open errors, --enable-error-stack=2.
|
||||
* \li <strong>\--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
|
||||
* Optional value 2 also prints file open errors, <code>\--enable-error-stack=2</code>.
|
||||
*
|
||||
* \subsection subsec_cltools_h5dump_options Options
|
||||
* \li <strong>--help</strong> Print a usage message and exit
|
||||
* \li <strong>--version</strong> Print the library version number and exit
|
||||
* \li <strong>\--help</strong> Print a usage message and exit
|
||||
* \li <strong>\--version</strong> Print the library version number and exit
|
||||
*
|
||||
* \subsection subsec_cltools_h5dump_options_file File Options
|
||||
* \li <strong>--contents</strong> Print a list of the file contents, group and dataset,
|
||||
* names and values, then exit. Optional value 1 also prints attributes, --contents=1.
|
||||
* \li <strong>--superblock</strong> Print the content of the super block
|
||||
* \li <strong>--header</strong> Print the header only; no data is displayed
|
||||
* \li <strong>--filedriver=D</strong> Specify which driver to open the file with
|
||||
* \li <strong>--output=F</strong> Output raw data into file F
|
||||
* \li <strong>--binary=B</strong> Binary file output, of form B
|
||||
* \li <strong>--ddl=F</strong> Output ddl text into file F
|
||||
* Use blank(empty) filename F to suppress ddl display
|
||||
* \li <strong>--page-buffer-size=N</strong> Set the page buffer cache size, N=non-negative integers
|
||||
* \li <strong>--endpoint-url=P</strong> Supply S3 endpoint url information to "ros3" vfd.
|
||||
* P is the AWS service endpoint.
|
||||
* Has no effect if filedriver is not "ros3".
|
||||
* \li <strong>--s3-cred=\<cred\></strong> Supply S3 authentication information to "ros3" vfd.
|
||||
* \code <cred> :: "(<aws-region>,<access-id>,<access-key>)" \endcode
|
||||
* \code <cred> :: "(<aws-region>,<access-id>,<access-key>,<session-token>)" \endcode
|
||||
* If absent or \code \<cred\> -> "(,,)" \endcode or \code \<cred\> -> "(,,,)"
|
||||
* \endcode, no authentication. Has no effect if filedriver is not "ros3". \li
|
||||
* <strong>--hdfs-attrs=\<attrs\></strong> Supply configuration information for HDFS file access. For use with
|
||||
* <strong>--filedriver=hdfs</strong> \code <attrs> :: (<namenode name>,<namenode port>, <kerberos cache
|
||||
* path>,<username>, <buffer size>) \endcode Any absent attribute will use a default value. \li
|
||||
* <strong>--vol-value</strong> Value (ID) of the VOL connector to use for opening the HDF5 file specified \li
|
||||
* <strong>--vol-name</strong> Name of the VOL connector to use for opening the HDF5 file specified \li
|
||||
* <strong>--vol-info</strong> VOL-specific info to pass to the VOL connector used for opening the HDF5 file
|
||||
* specified.<br /> If none of the above options are used to specify a VOL, then the VOL named by \b
|
||||
* HDF5_VOL_CONNECTOR (or the native VOL connector, if that environment variable is unset) will be used
|
||||
* \li<strong>--vfd-value</strong> Value (ID) of the VFL driver to use for opening the HDF5 file specified
|
||||
* \li <strong>--vfd-name</strong> Name of the VFL driver to use for opening the HDF5 file specified
|
||||
* \li <strong>--vfd-info</strong> VFD-specific info to pass to the VFL driver used for
|
||||
* \li <strong>\--contents</strong> Print a list of the file contents, group and dataset,
|
||||
* names and values, then exit. Optional value 1 also prints attributes, <code>\--contents=1</code>.
|
||||
* \li <strong>\--superblock</strong> Print the content of the super block
|
||||
* \li <strong>\--header</strong> Print the header only; no data is displayed
|
||||
* \li <strong>\--filedriver=D</strong> Specify which driver to open the file with
|
||||
* \li <strong>\--output=F</strong> Output raw data into file F
|
||||
* \li <strong>\--binary=B</strong> Binary file output, of form B
|
||||
* \li <strong>\--ddl=F</strong> Output ddl text into file F
|
||||
* Use blank(empty) filename F to suppress ddl display
|
||||
* \li <strong>\--page-buffer-size=N</strong> Set the page buffer cache size, N=non-negative integers
|
||||
* \li <strong>\--endpoint-url=P</strong> Supply S3 endpoint url information to "ros3" vfd.
|
||||
* P is the AWS service endpoint.
|
||||
* Has no effect if filedriver is not "ros3".
|
||||
* \li <strong>\--s3-cred=\<cred\></strong> Supply S3 authentication information to "ros3" vfd.
|
||||
* \code <cred> :: "(<aws-region>,<access-id>,<access-key>)" \endcode
|
||||
* \code <cred> :: "(<aws-region>,<access-id>,<access-key>,<session-token>)" \endcode
|
||||
* If absent or \code \<cred\> -> "(,,)" \endcode or \code \<cred\> -> "(,,,)" \endcode,
|
||||
* no authentication. Has no effect if filedriver is not "ros3".
|
||||
* \li <strong>\--hdfs-attrs=\<attrs\></strong> Supply configuration information for HDFS file access. For use with
|
||||
* <strong>\--filedriver=hdfs</strong>
|
||||
* \code <attrs> :: (<namenode name>,<namenode port>, <kerberos cache path>,<username>, <buffer size>) \endcode
|
||||
* Any absent attribute will use a default value.
|
||||
* \li <strong>\--vol-value</strong> Value (ID) of the VOL connector to use for opening the HDF5 file specified
|
||||
* \li <strong>\--vol-name</strong> Name of the VOL connector to use for opening the HDF5 file specified
|
||||
* \li <strong>\--vol-info</strong> VOL-specific info to pass to the VOL connector used for opening the HDF5 file specified.<br />
|
||||
* If none of the above options are used to specify a VOL, then the VOL named by
|
||||
* \b HDF5_VOL_CONNECTOR (or the native VOL connector, if that environment variable
|
||||
* is unset) will be used
|
||||
* \li <strong>\--vfd-value</strong> Value (ID) of the VFL driver to use for opening the HDF5 file specified
|
||||
* \li <strong>\--vfd-name</strong> Name of the VFL driver to use for opening the HDF5 file specified
|
||||
* \li <strong>\--vfd-info</strong> VFD-specific info to pass to the VFL driver used for
|
||||
* opening the HDF5 file specified
|
||||
*
|
||||
* \subsection subsec_cltools_h5dump_options_obj Object Options
|
||||
* \li <strong>--attribute=P</strong> Print the specified attribute
|
||||
* \li <strong>\--attribute=P</strong> Print the specified attribute.
|
||||
* If an attribute name contains a slash (/), escape the
|
||||
* slash with a preceding backslash (\).
|
||||
* slash with a preceding backslash (\\).
|
||||
* (See example section below.)
|
||||
* \li <strong>--dataset=P</strong> Print the specified dataset
|
||||
* \li <strong>--group=P</strong> Print the specified group and all members
|
||||
* \li <strong>--soft-link=P</strong> Print the value(s) of the specified soft link
|
||||
* \li <strong>--datatype=P</strong> Print the specified named datatype
|
||||
* \li <strong>--any_path=P</strong> Print any attribute, dataset, group, datatype, or link that matches P
|
||||
* \li <strong>\--dataset=P</strong> Print the specified dataset
|
||||
* \li <strong>\--group=P</strong> Print the specified group and all members
|
||||
* \li <strong>\--soft-link=P</strong> Print the value(s) of the specified soft link
|
||||
* \li <strong>\--datatype=P</strong> Print the specified named datatype
|
||||
* \li <strong>\--any_path=P</strong> Print any attribute, dataset, group, datatype, or link that matches P.
|
||||
* P can be the absolute path or just a relative path.
|
||||
* \li <strong>--onlyattr</strong> Print the header and value of attributes
|
||||
* \li <strong>\--onlyattr</strong> Print the header and value of attributes.
|
||||
* Optional value 0 suppresses printing attributes.
|
||||
* \li <strong>--vds-view-first-missing</strong> Set the VDS bounds to first missing mapped elements.
|
||||
* \li <strong>--vds-gap-size=N</strong> Set the missing file gap size, N=non-negative integers
|
||||
* \li <strong>\--vds-view-first-missing</strong> Set the VDS bounds to first missing mapped elements.
|
||||
* \li <strong>\--vds-gap-size=N</strong> Set the missing file gap size, N=non-negative integers
|
||||
*
|
||||
* \subsection subsec_cltools_h5dump_options_prop Object Property Options
|
||||
* \li <strong>--object-ids</strong> Print the object ids
|
||||
* \li <strong>--properties</strong> Print dataset filters, storage layout and fill value
|
||||
* \li <strong>--packedbits=L</strong> Print packed bits as unsigned integers, using mask
|
||||
* \li <strong>\--object-ids</strong> Print the object ids
|
||||
* \li <strong>\--properties</strong> Print dataset filters, storage layout and fill value
|
||||
* \li <strong>\--packedbits=L</strong> Print packed bits as unsigned integers, using mask
|
||||
* format L for an integer dataset specified with
|
||||
* option -d. L is a list of offset,length values,
|
||||
* separated by commas. Offset is the beginning bit in
|
||||
* the data value and length is the number of bits of
|
||||
* the mask.
|
||||
* \li <strong>--region</strong> Print dataset pointed by region references
|
||||
* \li <strong>\--region</strong> Print dataset pointed by region references
|
||||
*
|
||||
* \subsection subsec_cltools_h5dump_options_fmt Formatting Options
|
||||
* \li <strong>--escape</strong> Escape non printing characters
|
||||
* \li <strong>--string</strong> Print 1-byte integer datasets as ASCII
|
||||
* \li <strong>--noindex</strong> Do not print array indices with the data
|
||||
* \li <strong>--format=T</strong> Set the floating point output format
|
||||
* \li <strong>--lformat=T</strong> Set the floating point long double output format
|
||||
* \li <strong>--sort_by=Q</strong> Sort groups and attributes by index Q
|
||||
* \li <strong>--sort_order=Z</strong> Sort groups and attributes by order Z
|
||||
* \li <strong>--no-compact-subset</strong> Disable compact form of subsetting and allow the use
|
||||
* \li <strong>\--escape</strong> Escape non printing characters
|
||||
* \li <strong>\--string</strong> Print 1-byte integer datasets as ASCII
|
||||
* \li <strong>\--noindex</strong> Do not print array indices with the data
|
||||
* \li <strong>\--format=T</strong> Set the floating point output format
|
||||
* \li <strong>\--lformat=T</strong> Set the floating point long double output format
|
||||
* \li <strong>\--sort_by=Q</strong> Sort groups and attributes by index Q
|
||||
* \li <strong>\--sort_order=Z</strong> Sort groups and attributes by order Z
|
||||
* \li <strong>\--no-compact-subset</strong> Disable compact form of subsetting and allow the use
|
||||
* of "[" in dataset names.
|
||||
* \li <strong>--width=N</strong> Set the number of columns of output. A value of 0 (zero)
|
||||
* \li <strong>\--width=N</strong> Set the number of columns of output. A value of 0 (zero)
|
||||
* sets the number of columns to the maximum (65535).
|
||||
* Default width is 80 columns.
|
||||
*
|
||||
* \subsection subsec_cltools_h5dump_options_xml XML Options
|
||||
* \li <strong>--xml</strong> Output in XML using Schema
|
||||
* \li <strong>--use-dtd</strong> Output in XML using DTD
|
||||
* \li <strong>--xml-dtd=U</strong> Use the DTD or schema at U
|
||||
* \li <strong>--xml-ns=S</strong> (XML Schema) Use qualified names n the XML
|
||||
* \li <strong>\--xml</strong> Output in XML using Schema
|
||||
* \li <strong>\--use-dtd</strong> Output in XML using DTD
|
||||
* \li <strong>\--xml-dtd=U</strong> Use the DTD or schema at U
|
||||
* \li <strong>\--xml-ns=S</strong> (XML Schema) Use qualified names in the XML.
|
||||
* ":": no namespace, default: "hdf5:"
|
||||
* E.g., to dump a file called "-f", use h5dump -- -f
|
||||
*
|
||||
* \subsection subsec_cltools_h5dump_options_subset Subsetting Options
|
||||
* Subsetting is available by using the following options with a dataset
|
||||
@@ -122,21 +124,24 @@
|
||||
* The \b STRIDE, \b COUNT, and \b BLOCK parameters are optional and will default to 1 in
|
||||
* each dimension. \b START is optional and will default to 0 in each dimension.
|
||||
*
|
||||
* \li <strong>--start=START</strong> Offset of start of subsetting selection
|
||||
* \li <strong>\--start=START</strong> Offset of start of subsetting selection
|
||||
* \b START - is a list of integers, the number of which are equal to the
|
||||
* number of dimensions in the dataspace being queried.<br />
|
||||
* \li <strong>--stride=STRIDE</strong> Hyperslab stride
|
||||
* \b COUNT - is a list of integers, the number of which are equal to the
|
||||
* number of dimensions in the dataspace being queried.<br />
|
||||
* \li <strong>--count=COUNT</strong> Number of blocks to include in selection
|
||||
* \li <strong>\--stride=STRIDE</strong> Hyperslab stride
|
||||
* \b STRIDE - is a list of integers, the number of which are equal to the
|
||||
* number of dimensions in the dataspace being queried.<br />
|
||||
* \li <strong>--block=BLOCK</strong> Size of block in hyperslab
|
||||
* \li <strong>\--count=COUNT</strong> Number of blocks to include in selection
|
||||
* \b COUNT - is a list of integers, the number of which are equal to the
|
||||
* number of dimensions in the dataspace being queried.<br />
|
||||
* \li <strong>\--block=BLOCK</strong> Size of block in hyperslab
|
||||
* \b BLOCK - is a list of integers, the number of which are equal to the
|
||||
* number of dimensions in the dataspace being queried.<br />
|
||||
* (Alternate compact form of subsetting is described in the Reference Manual)
|
||||
*
|
||||
* \subsubsection subsubsec_cltools_h5dump_options_args Option Argument Conventions
|
||||
*
|
||||
* \li <strong>\--</strong> - Two dashes followed by whitespace. Indicates that the following argument is
|
||||
* not an option. For example, to dump a file called "-f", use <code>h5dump \-- -f</code>.
|
||||
* \li <strong>D</strong> - is the file driver to use in opening the file. Acceptable values are available
|
||||
* from https://support.hdfgroup.org/releases/hdf5/documentation/registered_virtual_file_drivers_vfds.md.
|
||||
* Without the file driver flag, the file will be opened with each driver in turn and in the order specified
|
||||
@@ -208,6 +213,7 @@
|
||||
* have been saved in the "source"/tools/test/h5dump/testfiles/xml folder.
|
||||
*
|
||||
*/
|
||||
/* clang-format on */
|
||||
|
||||
#include "hdf5.h"
|
||||
#include "H5private.h"
|
||||
|
||||
@@ -26,18 +26,18 @@
|
||||
* <h4>h5format_convert [OPTIONS] file_name</h4>
|
||||
*
|
||||
* \subsection subsec_cltools_h5format_convert_error Error Report Option
|
||||
* \li <strong>--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
|
||||
* Optional value 2 also prints file open errors, --enable-error-stack=2.
|
||||
* \li <strong>\--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
|
||||
* Optional value 2 also prints file open errors, <code>\--enable-error-stack=2</code>.
|
||||
*
|
||||
* \subsection subsec_cltools_h5format_convert_options Options
|
||||
* \li <strong>--help</strong> Print a usage message and exit
|
||||
* \li <strong>--version</strong> Print the library version number and exit
|
||||
* \li <strong>--verbose</strong> Turn on verbose mode
|
||||
* \li <strong>--dname=dataset_name</strong> Pathname for the dataset
|
||||
* \li <strong>--noop</strong> Perform all the steps except the actual conversion
|
||||
* \li <strong>\--help</strong> Print a usage message and exit
|
||||
* \li <strong>\--version</strong> Print the library version number and exit
|
||||
* \li <strong>\--verbose</strong> Turn on verbose mode
|
||||
* \li <strong>\--dname=dataset_name</strong> Pathname for the dataset
|
||||
* \li <strong>\--noop</strong> Perform all the steps except the actual conversion
|
||||
*
|
||||
* \subsubsection subsubsec_cltools_h5format_convert_examples Usage Examples
|
||||
* \li 1) h5format_convert --dname=/group/dataset file_name
|
||||
* \li 1) h5format_convert \--dname=/group/dataset file_name
|
||||
*
|
||||
* Convert the dataset </group/dataset> in the HDF5 file <file_name>:
|
||||
* - chunked dataset: convert the chunk indexing type to version 1 B-tree
|
||||
@@ -51,7 +51,7 @@
|
||||
* - compact/contiguous dataset: downgrade the layout version to 3
|
||||
* - virtual dataset: no action
|
||||
*
|
||||
* \li 3) h5format_convert --noop --dname=/group/dataset file_name
|
||||
* \li 3) h5format_convert \--noop \--dname=/group/dataset file_name
|
||||
*
|
||||
* Go through all the steps except the actual conversion when
|
||||
* converting the dataset </group/dataset> in the HDF5 file <file_name>.
|
||||
|
||||
@@ -25,8 +25,8 @@
|
||||
* data.
|
||||
*
|
||||
* \subsection subsec_cltools_h5jam_usage Usage
|
||||
* <h4>h5jam -i \<in_file.h5\> -u \<in_user_file\> [-o \<out_file.h5\>] [--clobber]</h4>
|
||||
* <h4>h5unjam -i \<in_file.h5\> [-o \<out_file.h5\> ] [-u \<out_user_file\> | --delete]</h4>
|
||||
* <h4>h5jam -i \<in_file.h5\> -u \<in_user_file\> [-o \<out_file.h5\>] [\--clobber]</h4>
|
||||
* <h4>h5unjam -i \<in_file.h5\> [-o \<out_file.h5\> ] [-u \<out_user_file\> | \--delete]</h4>
|
||||
*
|
||||
* \subsection subsec_cltools_h5jam_options h5jam Options
|
||||
* \li <strong>-i in_file.h5</strong> Specifies the input HDF5 file.
|
||||
@@ -35,7 +35,7 @@
|
||||
* \li <strong>-o out_file.h5</strong> Specifies the output HDF5 file.
|
||||
* If not specified, the user block will be concatenated in
|
||||
* place to the input HDF5 file.
|
||||
* \li <strong>--clobber</strong> Wipes out any existing user block before concatenating
|
||||
* \li <strong>\--clobber</strong> Wipes out any existing user block before concatenating
|
||||
* the given user block.
|
||||
* The size of the new user block will be the larger of:
|
||||
* - the size of existing user block in the input HDF5 file
|
||||
@@ -54,14 +54,14 @@
|
||||
* \li <strong>-u out_user_file</strong>
|
||||
* Specifies the output file containing the data from the
|
||||
* user block.
|
||||
* Cannot be used with --delete option.
|
||||
* \li <strong>--delete</strong> Remove the user block from the input HDF5 file. The content
|
||||
* Cannot be used with <strong>\--delete</strong> option.
|
||||
* \li <strong>\--delete</strong> Remove the user block from the input HDF5 file. The content
|
||||
* of the user block is discarded.
|
||||
* Cannot be used with the -u option.
|
||||
* \li <strong>-h</strong> Prints a usage message and exits.
|
||||
* \li <strong>-V</strong> Prints the HDF5 library version and exits.
|
||||
*
|
||||
* If neither <strong>--delete</strong> nor <strong>-u</strong> is specified, the user block from the input
|
||||
* If neither <strong>\--delete</strong> nor <strong>-u</strong> is specified, the user block from the input
|
||||
* file will be displayed to stdout stream.
|
||||
*
|
||||
* Previous Chapter \ref sec_cltools_h5import - Next Chapter \ref sec_cltools_h5ls
|
||||
|
||||
+36
-35
@@ -33,18 +33,18 @@
|
||||
* "%05d" to open a file family.
|
||||
*
|
||||
* \subsection subsec_cltools_h5ls_error Error Report Option
|
||||
* \li <strong>--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
|
||||
* Optional value 2 also prints file open errors, --enable-error-stack=2.
|
||||
* \li <strong>\--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
|
||||
* Optional value 2 also prints file open errors, <code>\--enable-error-stack=2</code>.
|
||||
*
|
||||
* \subsection subsec_cltools_h5ls_options Options
|
||||
* \li <strong>--help</strong> Print a usage message and exit
|
||||
* \li <strong>--address</strong> Print raw data address. If dataset is contiguous, address
|
||||
* \li <strong>\--help</strong> Print a usage message and exit
|
||||
* \li <strong>\--address</strong> Print raw data address. If dataset is contiguous, address
|
||||
* is offset in file of beginning of raw data. If chunked,
|
||||
* returned list of addresses indicates offset of each chunk.
|
||||
* Must be used with <strong>--verbose option</strong>.
|
||||
* Must be used with <strong>\--verbose</strong> option.
|
||||
* Provides no information for non-dataset objects.
|
||||
* \li <strong>--data</strong> Print the values of datasets
|
||||
* \li <strong>--follow-symlinks</strong>
|
||||
* \li <strong>\--data</strong> Print the values of datasets
|
||||
* \li <strong>\--follow-symlinks</strong>
|
||||
* Follow symbolic links (soft links and external links)
|
||||
* to display target object information.<br />
|
||||
* Without this option, h5ls identifies a symbolic link
|
||||
@@ -52,8 +52,8 @@
|
||||
* assigned to the symbolic link; it does not provide any
|
||||
* information regarding the target object or determine
|
||||
* whether the link is a dangling link.
|
||||
* \li <strong>--no-dangling-links</strong>
|
||||
* Must be used with <strong>--follow-symlinks</strong> option;
|
||||
* \li <strong>\--no-dangling-links</strong>
|
||||
* Must be used with <strong>\--follow-symlinks</strong> option;
|
||||
* otherwise, h5ls shows error message and returns an exit
|
||||
* code of 1.<br />
|
||||
* Check for any symbolic links (soft links or external links)
|
||||
@@ -61,53 +61,54 @@
|
||||
* or named datatype).<br />
|
||||
* If any dangling link is found, this situation is treated
|
||||
* as an error and h5ls returns an exit code of 1.
|
||||
* \li <strong>--full</strong> Print full path names instead of base names
|
||||
* \li <strong>--group</strong> Show information about a group, not its contents
|
||||
* \li <strong>--label</strong> Label members of compound datasets
|
||||
* \li <strong>--recursive</strong> List all groups recursively, avoiding cycles
|
||||
* \li <strong>--string</strong> Print 1-byte integer datasets as ASCII
|
||||
* \li <strong>--simple</strong> Use a machine-readable output format
|
||||
* \li <strong>--width=N</strong> Set the number of columns of output
|
||||
* \li <strong>--verbose</strong> Generate more verbose output
|
||||
* \li <strong>--version</strong> Print the library version number and exit
|
||||
* \li <strong>--page-buffer-size=N</strong> Set the page buffer cache size, N=non-negative integers
|
||||
* \li <strong>--vfd=DRIVER</strong> Use the specified virtual file driver
|
||||
* \li <strong>--hexdump</strong> Show raw data in hexadecimal format
|
||||
* \li <strong>--endpoint-url=P</strong> Supply S3 endpoint url information to "ros3" vfd.
|
||||
* \li <strong>\--full</strong> Print full path names instead of base names
|
||||
* \li <strong>\--group</strong> Show information about a group, not its contents
|
||||
* \li <strong>\--label</strong> Label members of compound datasets
|
||||
* \li <strong>\--recursive</strong> List all groups recursively, avoiding cycles
|
||||
* \li <strong>\--string</strong> Print 1-byte integer datasets as ASCII
|
||||
* \li <strong>\--simple</strong> Use a machine-readable output format
|
||||
* \li <strong>\--width=N</strong> Set the number of columns of output
|
||||
* \li <strong>\--verbose</strong> Generate more verbose output
|
||||
* \li <strong>\--version</strong> Print the library version number and exit
|
||||
* \li <strong>\--page-buffer-size=N</strong> Set the page buffer cache size, N=non-negative integers
|
||||
* \li <strong>\--vfd=DRIVER</strong> Use the specified virtual file driver
|
||||
* \li <strong>\--hexdump</strong> Show raw data in hexadecimal format
|
||||
* \li <strong>\--endpoint-url=P</strong> Supply S3 endpoint url information to "ros3" vfd.
|
||||
* P is the AWS service endpoint.
|
||||
* Has no effect if vfd flag not set to "ros3".
|
||||
* \li <strong>--s3-cred=C</strong> Supply S3 authentication information to "ros3" vfd.
|
||||
* \li <strong>\--s3-cred=C</strong> Supply S3 authentication information to "ros3" vfd.
|
||||
* Accepts tuple of \code (<aws-region>,<access-id>,<access-key>) \endcode
|
||||
* or \code (<aws-region>,<access-id>,<access-key>,<session-token>) \endcode.
|
||||
* If absent or C = \code (,,) \endcode or C = \code (,,,) \endcode defaults to
|
||||
* no-authentication. Has no effect if vfd flag not set to "ros3". \li <strong>--hdfs-attrs=A</strong> Supply
|
||||
* configuration information to Hadoop VFD. Accepts tuple of \code (<namenode name>,<namenode port>,
|
||||
* no-authentication. Has no effect if vfd flag not set to "ros3".
|
||||
* \li <strong>\--hdfs-attrs=A</strong> Supply configuration information to Hadoop VFD. Accepts
|
||||
* tuple of \code (<namenode name>,<namenode port>,
|
||||
* ...<kerberos cache path>,<username>,<buffer size>) \endcode
|
||||
* If absent or A == \code (,,,,) \endcode all default values are used.
|
||||
* Has no effect if vfd flag is not 'hdfs'.
|
||||
* \li <strong>--vol-value</strong> Value (ID) of the VOL connector to use for opening the
|
||||
* \li <strong>\--vol-value</strong> Value (ID) of the VOL connector to use for opening the
|
||||
* HDF5 file specified
|
||||
* \li <strong>--vol-name</strong> Name of the VOL connector to use for opening the
|
||||
* \li <strong>\--vol-name</strong> Name of the VOL connector to use for opening the
|
||||
* HDF5 file specified
|
||||
* \li <strong>--vol-info</strong> VOL-specific info to pass to the VOL connector used for
|
||||
* \li <strong>\--vol-info</strong> VOL-specific info to pass to the VOL connector used for
|
||||
* opening the HDF5 file specified
|
||||
* If none of the above options are used to specify a VOL, then
|
||||
* the VOL named by HDF5_VOL_CONNECTOR (or the native VOL connector,
|
||||
* if that environment variable is unset) will be used
|
||||
* \li <strong>--vfd-value</strong> Value (ID) of the VFL driver to use for opening the
|
||||
* \li <strong>\--vfd-value</strong> Value (ID) of the VFL driver to use for opening the
|
||||
* HDF5 file specified
|
||||
* \li <strong>--vfd-name</strong> Name of the VFL driver to use for opening the
|
||||
* \li <strong>\--vfd-name</strong> Name of the VFL driver to use for opening the
|
||||
* HDF5 file specified
|
||||
* \li <strong>--vfd-info</strong> VFD-specific info to pass to the VFL driver used for
|
||||
* \li <strong>\--vfd-info</strong> VFD-specific info to pass to the VFL driver used for
|
||||
* opening the HDF5 file specified
|
||||
*
|
||||
* \subsubsection subsubsec_cltools_h5ls_options_depre Deprecated Options
|
||||
* The following options have been removed in HDF5 1.12. Use the indicated
|
||||
* replacement option in all work.
|
||||
* \li <strong>--external</strong> Follow external links.<br />
|
||||
* Replaced by <strong>--follow-symlinks</strong>.
|
||||
* \li <strong>--errors</strong> Show all HDF5 error reporting<br />
|
||||
* Replaced by <strong>--enable-error-stack</strong>.
|
||||
* \li <strong>\--external</strong> Follow external links.<br />
|
||||
* Replaced by <strong>\--follow-symlinks</strong>.
|
||||
* \li <strong>\--errors</strong> Show all HDF5 error reporting<br />
|
||||
* Replaced by <strong>\--enable-error-stack</strong>.
|
||||
*
|
||||
* Previous Chapter \ref sec_cltools_h5jam - Next Chapter \ref sec_cltools_h5repack
|
||||
*
|
||||
|
||||
@@ -29,73 +29,74 @@
|
||||
* \li <strong>file2</strong> Output HDF5 File
|
||||
*
|
||||
* \subsection subsec_cltools_h5repack_error Error Report Option
|
||||
* \li <strong>--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
|
||||
* Optional value 2 also prints file open errors, --enable-error-stack=2.
|
||||
* \li <strong>\--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
|
||||
* Optional value 2 also prints file open errors, <code>\--enable-error-stack=2</code>.
|
||||
*
|
||||
* \subsection subsec_cltools_h5repack_options Options
|
||||
* \li <strong>--help</strong> Print a usage message and exit
|
||||
* \li <strong>--verbose=N</strong> Verbose mode, print object information.
|
||||
* \li <strong>\--help</strong> Print a usage message and exit
|
||||
* \li <strong>\--verbose=N</strong> Verbose mode, print object information.
|
||||
* N - is an integer greater than 1, 2 displays read/write timing
|
||||
* \li <strong>--version</strong> Print the library version number and exit
|
||||
* \li <strong>--native</strong> Use a native HDF5 type when repacking
|
||||
* \li <strong>--page-buffer-size=N</strong> Set the page buffer cache size, N=non-negative integers
|
||||
* \li <strong>--src-vol-value</strong> Value (ID) of the VOL connector to use for opening the
|
||||
* \li <strong>\--version</strong> Print the library version number and exit
|
||||
* \li <strong>\--native</strong> Use a native HDF5 type when repacking
|
||||
* \li <strong>\--page-buffer-size=N</strong> Set the page buffer cache size, N=non-negative integers
|
||||
* \li <strong>\--src-vol-value</strong> Value (ID) of the VOL connector to use for opening the
|
||||
* input HDF5 file specified
|
||||
* \li <strong>--src-vol-name</strong> Name of the VOL connector to use for opening the input
|
||||
* \li <strong>\--src-vol-name</strong> Name of the VOL connector to use for opening the input
|
||||
* HDF5 file specified
|
||||
* \li <strong>--src-vol-info</strong> VOL-specific info to pass to the VOL connector used for
|
||||
* \li <strong>\--src-vol-info</strong> VOL-specific info to pass to the VOL connector used for
|
||||
* opening the input HDF5 file specified
|
||||
* \li <strong>--dst-vol-value</strong> Value (ID) of the VOL connector to use for opening the
|
||||
* \li <strong>\--dst-vol-value</strong> Value (ID) of the VOL connector to use for opening the
|
||||
* output HDF5 file specified
|
||||
* \li <strong>--dst-vol-name</strong> Name of the VOL connector to use for opening the output
|
||||
* \li <strong>\--dst-vol-name</strong> Name of the VOL connector to use for opening the output
|
||||
* HDF5 file specified
|
||||
* \li <strong>--dst-vol-info</strong> VOL-specific info to pass to the VOL connector used for
|
||||
* \li <strong>\--dst-vol-info</strong> VOL-specific info to pass to the VOL connector used for
|
||||
* opening the output HDF5 file specified
|
||||
* \li <strong>--src-vfd-value</strong> Value (ID) of the VFL driver to use for opening the
|
||||
* \li <strong>\--src-vfd-value</strong> Value (ID) of the VFL driver to use for opening the
|
||||
* input HDF5 file specified
|
||||
* \li <strong>--src-vfd-name</strong> Name of the VFL driver to use for opening the input
|
||||
* \li <strong>\--src-vfd-name</strong> Name of the VFL driver to use for opening the input
|
||||
* HDF5 file specified
|
||||
* \li <strong>--src-vfd-info</strong> VFD-specific info to pass to the VFL driver used for
|
||||
* \li <strong>\--src-vfd-info</strong> VFD-specific info to pass to the VFL driver used for
|
||||
* opening the input HDF5 file specified
|
||||
* \li <strong>--dst-vfd-value</strong> Value (ID) of the VFL driver to use for opening the
|
||||
* \li <strong>\--dst-vfd-value</strong> Value (ID) of the VFL driver to use for opening the
|
||||
* output HDF5 file specified
|
||||
* \li <strong>--dst-vfd-name</strong> Name of the VFL driver to use for opening the output
|
||||
* \li <strong>\--dst-vfd-name</strong> Name of the VFL driver to use for opening the output
|
||||
* HDF5 file specified
|
||||
* \li <strong>--dst-vfd-info</strong> VFD-specific info to pass to the VFL driver used for
|
||||
* \li <strong>\--dst-vfd-info</strong> VFD-specific info to pass to the VFL driver used for
|
||||
* opening the output HDF5 file specified
|
||||
* \li <strong>--latest</strong> Use latest version of file format
|
||||
* \li <strong>\--latest</strong> Use latest version of file format
|
||||
* This option will take precedence over the options
|
||||
* --low and --high
|
||||
* \li <strong>--low=BOUND</strong> The low bound for library release versions to use
|
||||
* <strong>\--low</strong> and <strong>\--high</strong>
|
||||
* \li <strong>\--low=BOUND</strong> The low bound for library release versions to use
|
||||
* when creating objects in the file
|
||||
* (default is #H5F_LIBVER_EARLIEST)
|
||||
* \li <strong>--high=BOUND</strong> The high bound for library release versions to use
|
||||
* \li <strong>\--high=BOUND</strong> The high bound for library release versions to use
|
||||
* when creating objects in the file
|
||||
* (default is #H5F_LIBVER_LATEST)
|
||||
* \li <strong>--merge</strong> Follow external soft link recursively and merge data
|
||||
* \li <strong>--prune</strong> Do not follow external soft links and remove link
|
||||
* \li <strong>--merge --prune</strong> Follow external link, merge data and remove dangling link
|
||||
* \li <strong>--compact=L1</strong> Maximum number of links in header messages
|
||||
* \li <strong>--indexed=L2</strong> Minimum number of links in the indexed format
|
||||
* \li <strong>--ssize=S[:F]</strong> Shared object header message minimum size
|
||||
* \li <strong>--minimum=M</strong> Do not apply the filter to datasets smaller than M
|
||||
* \li <strong>--file=E</strong> Name of file E with the --file and --layout options
|
||||
* \li <strong>--ublock=U</strong> Name of file U with user block data to be added
|
||||
* \li <strong>--block=B</strong> Size of user block to be added
|
||||
* \li <strong>--metadata_block_size=A</strong> Metadata block size for #H5Pset_meta_block_size
|
||||
* \li <strong>--threshold=T</strong> Threshold value for #H5Pset_alignment
|
||||
* \li <strong>--alignment=A</strong> Alignment value for #H5Pset_alignment
|
||||
* \li <strong>--sort_by=Q</strong> Sort groups and attributes by index Q
|
||||
* \li <strong>--sort_order=Z</strong> Sort groups and attributes by order Z
|
||||
* \li <strong>--filter=FILT</strong> Filter type
|
||||
* \li <strong>--layout=LAYT</strong> Layout type
|
||||
* \li <strong>--fs_strategy=FS_STRATEGY</strong> File space management strategy for
|
||||
* \li <strong>\--merge</strong> Follow external soft link recursively and merge data
|
||||
* \li <strong>\--prune</strong> Do not follow external soft links and remove link
|
||||
* \li <strong>\--merge \--prune</strong> Follow external link, merge data and remove dangling link
|
||||
* \li <strong>\--compact=L1</strong> Maximum number of links in header messages
|
||||
* \li <strong>\--indexed=L2</strong> Minimum number of links in the indexed format
|
||||
* \li <strong>\--ssize=S[:F]</strong> Shared object header message minimum size
|
||||
* \li <strong>\--minimum=M</strong> Do not apply the filter to datasets smaller than M
|
||||
* \li <strong>\--file=E</strong> Name of file E with the <strong>\--file</strong> and
|
||||
* <strong>\--layout</strong> options
|
||||
* \li <strong>\--ublock=U</strong> Name of file U with user block data to be added
|
||||
* \li <strong>\--block=B</strong> Size of user block to be added
|
||||
* \li <strong>\--metadata_block_size=A</strong> Metadata block size for #H5Pset_meta_block_size
|
||||
* \li <strong>\--threshold=T</strong> Threshold value for #H5Pset_alignment
|
||||
* \li <strong>\--alignment=A</strong> Alignment value for #H5Pset_alignment
|
||||
* \li <strong>\--sort_by=Q</strong> Sort groups and attributes by index Q
|
||||
* \li <strong>\--sort_order=Z</strong> Sort groups and attributes by order Z
|
||||
* \li <strong>\--filter=FILT</strong> Filter type
|
||||
* \li <strong>\--layout=LAYT</strong> Layout type
|
||||
* \li <strong>\--fs_strategy=FS_STRATEGY</strong> File space management strategy for
|
||||
* #H5Pset_file_space_strategy
|
||||
* \li <strong>--fs_persist=FS_PERSIST</strong> Persisting or not
|
||||
* \li <strong>\--fs_persist=FS_PERSIST</strong> Persisting or not
|
||||
* persisting free-space for #H5Pset_file_space_strategy
|
||||
* \li <strong>--fs_threshold=FS_THRESHOLD</strong> : Free-space section
|
||||
* \li <strong>\--fs_threshold=FS_THRESHOLD</strong> : Free-space section
|
||||
* threshold for #H5Pset_file_space_strategy
|
||||
* \li <strong>--fs_pagesize=FS_PAGESIZE</strong> File space page size for #H5Pset_file_space_page_size
|
||||
* \li <strong>\--fs_pagesize=FS_PAGESIZE</strong> File space page size for #H5Pset_file_space_page_size
|
||||
*
|
||||
* \subsubsection subsubsec_cltools_h5repack_options_args Arguments to Certain Options
|
||||
* \li <strong>M</strong> - is an integer greater than 1, size of dataset in bytes (default is 0)
|
||||
@@ -207,33 +208,33 @@
|
||||
*
|
||||
* \subsection subsec_cltools_h5repack_examples Usage Examples
|
||||
*
|
||||
* \li 1) h5repack --verbose --filter=GZIP=1 file1 file2
|
||||
* \li 1) h5repack \--verbose \--filter=GZIP=1 file1 file2
|
||||
*
|
||||
* GZIP compression with level 1 to all objects
|
||||
*
|
||||
* \li 2) h5repack --verbose --filter=dset1:SZIP=8,NN file1 file2
|
||||
* \li 2) h5repack \--verbose \--filter=dset1:SZIP=8,NN file1 file2
|
||||
*
|
||||
* SZIP compression with 8 pixels per block and NN coding method to object dset1
|
||||
*
|
||||
* \li 3) h5repack --verbose --layout=dset1,dset2:CHUNK=20x10 --filter=dset3,dset4,dset5:NONE file1 file2
|
||||
* \li 3) h5repack \--verbose \--layout=dset1,dset2:CHUNK=20x10 \--filter=dset3,dset4,dset5:NONE file1 file2
|
||||
*
|
||||
* Chunked layout, with a layout size of 20x10, to objects dset1 and dset2
|
||||
* and remove filters to objects dset3, dset4, dset5
|
||||
*
|
||||
* \li 4) h5repack --latest --compact=10 --ssize=20:dtype file1 file2
|
||||
* \li 4) h5repack \--latest \--compact=10 \--ssize=20:dtype file1 file2
|
||||
*
|
||||
* Using latest file format with maximum compact group size of 10 and
|
||||
* minimum shared datatype size of 20
|
||||
*
|
||||
* \li 5) h5repack --filter=SHUF --filter=GZIP=1 file1 file2
|
||||
* \li 5) h5repack \--filter=SHUF \--filter=GZIP=1 file1 file2
|
||||
*
|
||||
* Add both filters SHUF and GZIP in this order to all datasets
|
||||
*
|
||||
* \li 6) h5repack --filter=UD=307,0,1,9 file1 file2
|
||||
* \li 6) h5repack \--filter=UD=307,0,1,9 file1 file2
|
||||
*
|
||||
* Add bzip2 filter to all datasets
|
||||
*
|
||||
* \li 7) h5repack --low=0 --high=1 file1 file2
|
||||
* \li 7) h5repack \--low=0 \--high=1 file1 file2
|
||||
*
|
||||
* Set low=H5F_LIBVER_EARLIEST and high=H5F_LIBVER_V18 via
|
||||
* H5Pset_libver_bounds() when creating the repacked file, file2
|
||||
|
||||
+29
-28
@@ -26,59 +26,60 @@
|
||||
* <h4>h5stat [OPTIONS] file</h4>
|
||||
*
|
||||
* \subsection subsec_cltools_h5stat_error Error Report Option
|
||||
* \li <strong>--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
|
||||
* Optional value 2 also prints file open errors, --enable-error-stack=2.
|
||||
* \li <strong>\--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
|
||||
* Optional value 2 also prints file open errors, <code>\--enable-error-stack=2</code>.
|
||||
*
|
||||
* \subsection subsec_cltools_h5stat_options Options
|
||||
* \li <strong>--help</strong> Print a usage message and exit
|
||||
* \li <strong>--version</strong> Print the library version number and exit
|
||||
* \li <strong>--file</strong> Print file information
|
||||
* \li <strong>--filemetadata</strong> Print file space information for file's metadata
|
||||
* \li <strong>--group</strong> Print group information
|
||||
* \li <strong>--links=N</strong> Set the threshold for the # of links when printing
|
||||
* \li <strong>\--help</strong> Print a usage message and exit
|
||||
* \li <strong>\--version</strong> Print the library version number and exit
|
||||
* \li <strong>\--file</strong> Print file information
|
||||
* \li <strong>\--filemetadata</strong> Print file space information for file's metadata
|
||||
* \li <strong>\--group</strong> Print group information
|
||||
* \li <strong>\--links=N</strong> Set the threshold for the # of links when printing
|
||||
* information for small groups. N is an integer greater
|
||||
* than 0. The default threshold is 10.
|
||||
* \li <strong>--groupmetadata </strong> Print file space information for groups' metadata
|
||||
* \li <strong>--dset</strong> Print dataset information
|
||||
* \li <strong>--dims=N</strong> Set the threshold for the dimension sizes when printing
|
||||
* \li <strong>\--groupmetadata </strong> Print file space information for groups' metadata
|
||||
* \li <strong>\--dset</strong> Print dataset information
|
||||
* \li <strong>\--dims=N</strong> Set the threshold for the dimension sizes when printing
|
||||
* information for small datasets. N is an integer greater
|
||||
* than 0. The default threshold is 10.
|
||||
* \li <strong>--dsetmetadata</strong> Print file space information for datasets' metadata
|
||||
* \li <strong>--dtypemetadata</strong> Print datasets' datatype information
|
||||
* \li <strong>--attribute</strong> Print attribute information
|
||||
* \li <strong>--numattrs=N</strong> Set the threshold for the number of attributes when printing
|
||||
* \li <strong>\--dsetmetadata</strong> Print file space information for datasets' metadata
|
||||
* \li <strong>\--dtypemetadata</strong> Print datasets' datatype information
|
||||
* \li <strong>\--attribute</strong> Print attribute information
|
||||
* \li <strong>\--numattrs=N</strong> Set the threshold for the number of attributes when printing
|
||||
* information for small number of attributes. N is an integer greater
|
||||
* than 0. The default threshold is 10.
|
||||
* \li <strong>--freespace</strong> Print free space information
|
||||
* \li <strong>--summary</strong> Print summary of file space information
|
||||
* \li <strong>--page-buffer-size=N</strong> Set the page buffer cache size, N=non-negative integers
|
||||
* \li <strong>--endpoint-url=P</strong> Supply S3 endpoint url information to "ros3" vfd.
|
||||
* \li <strong>\--freespace</strong> Print free space information
|
||||
* \li <strong>\--summary</strong> Print summary of file space information
|
||||
* \li <strong>\--page-buffer-size=N</strong> Set the page buffer cache size, N=non-negative integers
|
||||
* \li <strong>\--endpoint-url=P</strong> Supply S3 endpoint url information to "ros3" vfd.
|
||||
* P is the AWS service endpoint.
|
||||
* Has no effect if vfd flag not set to "ros3".
|
||||
* \li <strong>--s3-cred=C</strong> Supply S3 authentication information to "ros3" vfd.
|
||||
* \li <strong>\--s3-cred=C</strong> Supply S3 authentication information to "ros3" vfd.
|
||||
* Accepts tuple of \code (<aws-region>,<access-id>,<access-key>) \endcode
|
||||
* or \code (<aws-region>,<access-id>,<access-key>,<session-token>) \endcode.
|
||||
* If absent or C = \code (,,) \endcode or C = \code (,,,) \endcode defaults to
|
||||
* no-authentication. Has no effect if vfd flag not set to "ros3". \li <strong>--hdfs-attrs=A</strong> Supply
|
||||
* configuration information to Hadoop VFD. Accepts tuple of \code (\<namenode name\>,\<namenode port\>,
|
||||
* no-authentication. Has no effect if vfd flag not set to "ros3".
|
||||
* \li <strong>\--hdfs-attrs=A</strong> Supply configuration information to Hadoop VFD. Accepts
|
||||
* tuple of \code (\<namenode name\>,\<namenode port\>,
|
||||
* ...\<kerberos cache path\>,\<username\>,\<buffer size\>) \endcode
|
||||
* If absent or A == \code (,,,,) \endcode all default values are used.
|
||||
* Has no effect if vfd flag is not 'hdfs'.<br />
|
||||
* If an attribute is empty, a default value will be used.
|
||||
* \li <strong>--vol-value</strong> Value (ID) of the VOL connector to use for opening the
|
||||
* \li <strong>\--vol-value</strong> Value (ID) of the VOL connector to use for opening the
|
||||
* HDF5 file specified
|
||||
* \li <strong>--vol-name</strong> Name of the VOL connector to use for opening the
|
||||
* \li <strong>\--vol-name</strong> Name of the VOL connector to use for opening the
|
||||
* HDF5 file specified
|
||||
* \li <strong>--vol-info</strong> VOL-specific info to pass to the VOL connector used for
|
||||
* \li <strong>\--vol-info</strong> VOL-specific info to pass to the VOL connector used for
|
||||
* opening the HDF5 file specified
|
||||
* If none of the above options are used to specify a VOL, then
|
||||
* the VOL named by HDF5_VOL_CONNECTOR (or the native VOL connector,
|
||||
* if that environment variable is unset) will be used
|
||||
* \li <strong>--vfd-value</strong> Value (ID) of the VFL driver to use for opening the
|
||||
* \li <strong>\--vfd-value</strong> Value (ID) of the VFL driver to use for opening the
|
||||
* HDF5 file specified
|
||||
* \li <strong>--vfd-name</strong> Name of the VFL driver to use for opening the
|
||||
* \li <strong>\--vfd-name</strong> Name of the VFL driver to use for opening the
|
||||
* HDF5 file specified
|
||||
* \li <strong>--vfd-info</strong> VFD-specific info to pass to the VFL driver used for
|
||||
* \li <strong>\--vfd-info</strong> VFD-specific info to pass to the VFL driver used for
|
||||
* opening the HDF5 file specified
|
||||
*
|
||||
* Previous Chapter \ref sec_cltools_h5repack - Next Chapter \ref sec_cltools_h5clear
|
||||
|
||||
+10
-10
@@ -31,16 +31,16 @@
|
||||
* <h4>h5clear [OPTIONS] file_name</h4>
|
||||
*
|
||||
* \subsection subsec_cltools_h5clear_error Error Report Option
|
||||
* \li <strong>--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
|
||||
* Optional value 2 also prints file open errors, --enable-error-stack=2.
|
||||
* \li <strong>\--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
|
||||
* Optional value 2 also prints file open errors, <code>\--enable-error-stack=2</code>.
|
||||
*
|
||||
* \subsection subsec_cltools_h5clear_options Options
|
||||
* \li <strong>--help</strong> Print a usage message and exit
|
||||
* \li <strong>--version</strong> Print the library version number and exit
|
||||
* \li <strong>--status</strong> Clear the status_flags field in the file's superblock
|
||||
* \li <strong>--image</strong> Remove the metadata cache image from the file
|
||||
* \li <strong>--filesize </strong> Print the file's EOA and EOF
|
||||
* \li <strong>--increment=C</strong> Set the file's EOA to the maximum of (EOA, EOF) + C for
|
||||
* \li <strong>\--help</strong> Print a usage message and exit
|
||||
* \li <strong>\--version</strong> Print the library version number and exit
|
||||
* \li <strong>\--status</strong> Clear the status_flags field in the file's superblock
|
||||
* \li <strong>\--image</strong> Remove the metadata cache image from the file
|
||||
* \li <strong>\--filesize </strong> Print the file's EOA and EOF
|
||||
* \li <strong>\--increment=C</strong> Set the file's EOA to the maximum of (EOA, EOF) + C for
|
||||
* the file \<file_name\>.
|
||||
* C is >= 0; C is optional and will default to 1M when not set.
|
||||
* This option helps to repair a crashed SWMR file when the stored
|
||||
@@ -57,11 +57,11 @@
|
||||
*
|
||||
* Remove the metadata cache image from the HDF5 file <file_name>.
|
||||
*
|
||||
* \li 3) h5clear --increment file_name
|
||||
* \li 3) h5clear \--increment file_name
|
||||
*
|
||||
* Set the EOA to the maximum of (EOA, EOF) + 1M for the file <file_name>.
|
||||
*
|
||||
* \li 4) h5clear --increment=512 file_name
|
||||
* \li 4) h5clear \--increment=512 file_name
|
||||
*
|
||||
* Set the EOA to the maximum of (EOA, EOF) + 512 for the file\<file_name>.
|
||||
*
|
||||
|
||||
+13
-13
@@ -26,29 +26,29 @@
|
||||
* <h4>h5mkgrp [OPTIONS] FILE GROUP</h4>
|
||||
*
|
||||
* \subsection subsec_cltools_h5mkgrp_error Error Report Option
|
||||
* \li<strong>--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
|
||||
* Optional value 2 also prints file open errors, --enable-error-stack=2.
|
||||
* \li <strong>\--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
|
||||
* Optional value 2 also prints file open errors, <code>\--enable-error-stack=2</code>.
|
||||
*
|
||||
* \subsection subsec_cltools_h5mkgrp_options Options
|
||||
* \li <strong>--help</strong> Print a usage message and exit
|
||||
* \li <strong>--version</strong> Print the library version number and exit
|
||||
* \li <strong>--verbose</strong> Print information about OBJECTS and OPTIONS
|
||||
* \li <strong>--latest</strong> Use latest version of file format to create groups
|
||||
* \li <strong>--parents</strong> No error if existing, make parent groups as needed
|
||||
* \li <strong>--vol-value</strong> Value (ID) of the VOL connector to use for opening the
|
||||
* \li <strong>\--help</strong> Print a usage message and exit
|
||||
* \li <strong>\--version</strong> Print the library version number and exit
|
||||
* \li <strong>\--verbose</strong> Print information about OBJECTS and OPTIONS
|
||||
* \li <strong>\--latest</strong> Use latest version of file format to create groups
|
||||
* \li <strong>\--parents</strong> No error if existing, make parent groups as needed
|
||||
* \li <strong>\--vol-value</strong> Value (ID) of the VOL connector to use for opening the
|
||||
* HDF5 file specified
|
||||
* \li <strong>--vol-name</strong> Name of the VOL connector to use for opening the
|
||||
* \li <strong>\--vol-name</strong> Name of the VOL connector to use for opening the
|
||||
* HDF5 file specified
|
||||
* \li <strong>--vol-info</strong> VOL-specific info to pass to the VOL connector used for
|
||||
* \li <strong>\--vol-info</strong> VOL-specific info to pass to the VOL connector used for
|
||||
* opening the HDF5 file specified.<br />
|
||||
* If none of the above options are used to specify a VOL, then
|
||||
* the VOL named by HDF5_VOL_CONNECTOR (or the native VOL connector,
|
||||
* if that environment variable is unset) will be used
|
||||
* \li <strong>--vfd-value</strong> Value (ID) of the VFL driver to use for opening the
|
||||
* \li <strong>\--vfd-value</strong> Value (ID) of the VFL driver to use for opening the
|
||||
* HDF5 file specified
|
||||
* \li <strong>--vfd-name</strong> Name of the VFL driver to use for opening the
|
||||
* \li <strong>\--vfd-name</strong> Name of the VFL driver to use for opening the
|
||||
* HDF5 file specified
|
||||
* \li <strong>--vfd-info</strong> VFD-specific info to pass to the VFL driver used for
|
||||
* \li <strong>\--vfd-info</strong> VFD-specific info to pass to the VFL driver used for
|
||||
* opening the HDF5 file specified
|
||||
*
|
||||
* Previous Chapter \ref sec_cltools_h5delete - Next Chapter \ref sec_cltools_h5repart
|
||||
|
||||
Reference in New Issue
Block a user