Files
hdf5/tools/test/h5stat/expected/h5stat_help1.ddl
T
0743df227f Add documentation and s3proxy testing for ROS3 VFD (#5560)
Adds workflow to build ROS3 VFD and optionally build aws-c-s3 library
from source or use package managers

Adds testing of ROS3 VFD with s3proxy and docker

Adds new H5Pset_fapl_ros3_endpoint()/H5Pget_fapl_ros3_endpoint() API
functions to set/get an alternative endpoint URL to use when opening
files with the ROS3 VFD

Cleans up warnings in tools and tests related to ROS3 VFD structure size

Co-authored-by: Larry Knox <lrknox@hdfgroup.org>
Co-authored-by: Allen Byrne <50328838+byrnHDF@users.noreply.github.com>
2025-06-19 16:22:49 -05:00

60 lines
3.9 KiB
Plaintext

usage: h5stat [OPTIONS] file
OPTIONS
-h, --help Print a usage message and exit
-V, --version Print version number and exit
--------------- Error Options ---------------
--enable-error-stack Prints messages from the HDF5 error stack as they occur.
Optional value 2 also prints file open errors.
Default setting disables any error reporting.
--------------- File Options ---------------
-f, --file Print file information
-F, --filemetadata Print file space information for file's metadata
-s, --freespace Print free space information
-S, --summary Print summary of file space information
--page-buffer-size=N Set the page buffer cache size, N=non-negative integers
--endpoint-url=P Supply S3 endpoint url information to "ros3" vfd.
P is the AWS service endpoint.
Has no effect if filedriver is not "ros3".
--s3-cred=<cred> Supply S3 authentication information to "ros3" vfd.
<cred> :: "(<aws-region>,<access-id>,<access-key>)"
<cred> :: "(<aws-region>,<access-id>,<access-key>,<session-token>)"
If absent, <cred> -> "(,,)" or <cred> -> "(,,,)", no authentication.
Has no effect if filedriver is not "ros3".
--hdfs-attrs=<attrs> Supply configuration information for HDFS file access.
For use with "--filedriver=hdfs"
<attrs> :: (<namenode name>,<namenode port>,
<kerberos cache path>,<username>,
<buffer size>)
Any absent attribute will use a default value.
--vol-value Value (ID) of the VOL connector to use for opening the
HDF5 file specified
--vol-name Name of the VOL connector to use for opening the
HDF5 file specified
--vol-info 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
--vfd-value Value (ID) of the VFL driver to use for opening the
HDF5 file specified
--vfd-name Name of the VFL driver to use for opening the
HDF5 file specified
--vfd-info VFD-specific info to pass to the VFL driver used for
opening the HDF5 file specified
--------------- Object Options ---------------
-g, --group Print group information
-l N, --links=N 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.
-G, --groupmetadata Print file space information for groups' metadata
-d, --dset Print dataset information
-m N, --dims=N 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.
-D, --dsetmetadata Print file space information for datasets' metadata
-T, --dtypemetadata Print datasets' datatype information
-A, --attribute Print attribute information
-a N, --numattrs=N Set the threshold for the # of attributes when printing
information for small # of attributes. N is an integer greater
than 0. The default threshold is 10.