summaryrefslogtreecommitdiffstats
path: root/tools/testfiles/help-1.ls
blob: 6ed1aabd0251819daaf578868398d57045135877 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
usage: h5ls [OPTIONS] file[/OBJECT] [file[/[OBJECT]...]
  OPTIONS
   -h, -?, --help  Print a usage message and exit
   -a, --address   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 -v, --verbose option.
                   Provides no information for non-dataset objects.
   -d, --data      Print the values of datasets
   --enable-error-stack
                   Prints messages from the HDF5 error stack as they occur.
   --follow-symlinks
                   Follow symbolic links (soft links and external links)
                   to display target object information.
                   Without this option, h5ls identifies a symbolic link
                   as a soft link or external link and prints the value
                   assigned to the symbolic link; it does not provide any
                   information regarding the target object or determine
                   whether the link is a dangling link.
   --no-dangling-links
                   Must be used with --follow-symlinks option;
                   otherwise, h5ls shows error message and returns an exit
                   code of 1.
                   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 h5ls returns an exit code of 1.
   -f, --full      Print full path names instead of base names
   -g, --group     Show information about a group, not its contents
   -l, --label     Label members of compound datasets
   -r, --recursive List all groups recursively, avoiding cycles
   -s, --string    Print 1-byte integer datasets as ASCII
   -S, --simple    Use a machine-readable output format
   -wN, --width=N  Set the number of columns of output
   -v, --verbose   Generate more verbose output
   -V, --version   Print version number and exit
   --vfd=DRIVER    Use the specified virtual file driver
   -x, --hexdump   Show raw data in hexadecimal format
   --s3-cred=C     Supply S3 authentication information to "ros3" vfd.
                   Accepts tuple of "(<aws-region>,<access-id>,<access-key>)".
                   If absent or C->"(,,)", defaults to no-authentication.
                   Has no effect if vfd flag not set to "ros3".
   --hdfs-attrs=A  Supply configuration information to Hadoop VFD.
                   Accepts tuple of (<namenode name>,<namenode port>,
                   ...<kerberos cache path>,<username>,<buffer size>)
                   If absent or A == '(,,,,)', all default values are used.
                   Has no effect if vfd flag is not 'hdfs'.
   --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
   --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

  file/OBJECT
    Each object consists of an HDF5 file name optionally followed by a
    slash and an object name within the file (if no object is specified
    within the file then the contents of the root group are displayed).
    The file name may include a printf(3C) integer format such as
    "%05d" to open a file family.

  Deprecated Options
    The following options have been removed in HDF5 1.12. Use the indicated
    replacement option in all work.

   -E or --external   Follow external links.
                      Replaced by --follow-symlinks.
   -e, --errors       Show all HDF5 error reporting
                      Replaced by --enable-error-stack.