diff options
author | David Young <dyoung@hdfgroup.org> | 2020-09-02 15:50:34 (GMT) |
---|---|---|
committer | David Young <dyoung@hdfgroup.org> | 2020-09-02 15:50:34 (GMT) |
commit | 135af42c0997f3fdcd7a7e58b4b65252c27d10db (patch) | |
tree | 98770cf7632efc5ad60434a9e414af59274a0d4f /doc | |
parent | bfc42a18ce8887795c6f873a487a545e3c02b398 (diff) | |
download | hdf5-135af42c0997f3fdcd7a7e58b4b65252c27d10db.zip hdf5-135af42c0997f3fdcd7a7e58b4b65252c27d10db.tar.gz hdf5-135af42c0997f3fdcd7a7e58b4b65252c27d10db.tar.bz2 |
Describe the command-line options for the bigset reader/writer
with a handful of bullets.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/vfd-swmr-user-guide.md | 27 |
1 files changed, 16 insertions, 11 deletions
diff --git a/doc/vfd-swmr-user-guide.md b/doc/vfd-swmr-user-guide.md index 6c4cf60..80c53ee 100644 --- a/doc/vfd-swmr-user-guide.md +++ b/doc/vfd-swmr-user-guide.md @@ -119,18 +119,23 @@ and in the other window, I run the reader: ``` The writer will wait for a signal before it quits. You may tap -Control-C to make it quit. If you don't want it to wait, then you can -pass option flag `-W`. (The reader accepts the same flag.) Use the `-q` -option to suppress the progress messages that the programs write to the -standard error stream. - -When the writer is creating a dataset extensible in one dimension -(`-d 1`), you can add the `-V` option flag to create a virtual -dataset with content in three source datasets in the same HDF5 -file. +Control-C to make it quit. + +The reader and writer programs support several command-line options: + +* `-h`: show program usage + +* `-W`: stop the program from waiting for a signal before it quits. + +* `-q`: suppress the progress messages that the programs write to the + standard error stream. + +* `-V`: create a virtual dataset with content in three source datasets + in the same HDF5 file---only available when the writer creates a + dataset extensible in one dimension (`-d 1`) -The `-M` option works like `-V`, only the writer creates the virtual -dataset on three source datasets, each in a different HDF5 file. +* `-M`: like `-V`, the writer creates the virtual dataset on three + source datasets, but each source dataset is in a different HDF5 file. ## The VFD SWMR demos |