diff options
author | David Young <dyoung@hdfgroup.org> | 2020-09-02 16:08:34 (GMT) |
---|---|---|
committer | David Young <dyoung@hdfgroup.org> | 2020-09-02 16:08:34 (GMT) |
commit | f58c2c5cced54d0dbbd72c49bd5dd03c28865196 (patch) | |
tree | e006e6a5fb5707d531f8ded3434a3c2880b1d4e4 | |
parent | 79560265af7dd3ae34f12b3eb4045ca2f1cb7520 (diff) | |
parent | 135af42c0997f3fdcd7a7e58b4b65252c27d10db (diff) | |
download | hdf5-f58c2c5cced54d0dbbd72c49bd5dd03c28865196.zip hdf5-f58c2c5cced54d0dbbd72c49bd5dd03c28865196.tar.gz hdf5-f58c2c5cced54d0dbbd72c49bd5dd03c28865196.tar.bz2 |
Merge branch 'feature/vfd_swmr' into multi
-rw-r--r-- | doc/vfd-swmr-user-guide.md | 34 |
1 files changed, 18 insertions, 16 deletions
diff --git a/doc/vfd-swmr-user-guide.md b/doc/vfd-swmr-user-guide.md index dadd783..80c53ee 100644 --- a/doc/vfd-swmr-user-guide.md +++ b/doc/vfd-swmr-user-guide.md @@ -60,12 +60,9 @@ configure script: ``` % mkdir -p ../build/swmr % cd ../build/swmr -% ../../swmr/configure CFLAGS="-g -O3" +% ../../swmr/configure ``` -You don't have to provide the CFLAGS, but usually I want compiler -optimizations, and I want debugging symbols. - Build the project: ``` @@ -122,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 @@ -480,4 +482,4 @@ seconds. VFD SWMR is still under construction, so I think that you will find some bugs. Please do not hesitate to report them. -TBD: email addresses here +To contact the VFD SWMR developers, email vfdswmr@hdfgroup.org. |