summaryrefslogtreecommitdiffstats
path: root/hl/tools/testfiles/w-help1.ddl
blob: e6510f2563855ddb2d72e0c84e86cc652b3abe40 (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
Usage: h5watch [OPTIONS] [OBJECT]

     OPTIONS
        --help            Print a usage message and exit.
        --version         Print version number and exit.
        --label           Label members of compound typed dataset.
        --simple          Use a machine-readable output format.
        --dim             Monitor changes in size of dataset dimensions only.
        --width=N         Set the number of columns to N for output.
                              A value of 0 sets the number of columns to the
                              maximum (65535). The default width is 80 columns.
        --polling=N       Set the polling interval to N (in seconds) when the
                              dataset will be checked for appended data.  The default
                              polling interval is 1.
        --fields=<list_of_fields>
                              Display data for the fields specified in <list_of_fields>
                              for a compound data type.  <list_of_fields> can be
                              specified as follows:
                                   1) A comma-separated list of field names in a
                                   compound data type.  "," is the separator
                                   for field names while "." is the separator
                                   for a nested field.
                                   2) A single field name in a compound data type.
                                   Can use this option multiple times.
                              Note that backslash is the escape character to avoid
                              characters in field names that conflict with the tool's
                              separators.

     OBJECT is specified as [<filename>/<path_to_dataset>/<dsetname>]
        <filename>            Name of the HDF5 file.  It may be preceded by path
                              separated by slashes to the specified HDF5 file.
        <path_to_dataset>     Path separated by slashes to the specified dataset
        <dsetname>            Name of the dataset

     User can end the h5watch process by ctrl-C (SIGINT) or kill the process (SIGTERM).