Skip to content
Permalink
Browse files

dbz2: update rst and usage

  • Loading branch information...
adammoody committed Mar 6, 2019
1 parent e5d1ea0 commit 4c1e9bc486e5aff910c9df1e03cdb001011068b1
Showing with 33 additions and 13 deletions.
  1. +29 −9 doc/rst/experimental/dbz2.1.rst
  2. +4 −4 src/dbz2/dbz2.c
@@ -11,6 +11,9 @@ DESCRIPTION

Parallel MPI application to compress or decompress a file.

When compressing, a new file will be created with a .dbz2 extension.
When decompressing, the .dbz2 extension will be dropped from the file name.

OPTIONS
-------

@@ -24,25 +27,42 @@ OPTIONS

.. option:: -k, --keep

Keep the input file (optional).
Keep the input file.

.. option:: -f, --overwrite

Overwrite the output file, if it exists (optional).
Overwrite the output file, if it exists.

.. option:: -b, --block SIZE

Set the compression block size, from 1 to 9.
Where 1=100kB ... and 9=900kB. Default is 9 (optional).

.. option:: -m, --memory SIZE

Limit the memory that can be used by a process, in bytes (optional).
Where 1=100kB ... and 9=900kB. Default is 9.

.. option:: -v, --verbose

Verbose output (optional).

.. option:: --debug
.. option:: -h, --help

Print usage.

EXAMPLES
--------

1. To compress a file:

``mpirun -np 128 dbz2 --compress /path/to/file``

2. To compress a file and overwrite any existing output file:

``mpirun -np 128 dbz2 --force --compress /path/to/file``

3. To decompress a file:

``mpirun -np 128 dbz2 --decompress /path/to/file.dbz2``

SEE ALSO
--------

Show debug output (optional).
The mpiFileUtils source code and all documentation may be downloaded
from <https://github.com/hpc/mpifileutils>
@@ -34,13 +34,13 @@ static void print_usage(void)
printf("Options:\n");
printf(" -c, --compress - compress file\n");
printf(" -d, --decompress - decompress file\n");
printf(" -k, --keep - keep existing input file(s)\n");
printf(" -k, --keep - keep existing input file\n");
printf(" -f, --force - overwrite output file\n");
printf(" -b, --blocksize <num> - block size (1-9)\n");
printf(" -m, --memory <size> - memory limit in bytes\n");
//printf(" -m, --memory <size> - memory limit in bytes\n");
printf(" -v, --verbose - verbose output\n");
printf(" -q, --quiet - quiet output\n");
printf(" --debug - debug output\n");
//printf(" --debug - debug output\n");
printf(" -h, --help - print usage\n");
printf("\n");
fflush(stdout);
@@ -136,7 +136,7 @@ int main(int argc, char** argv)
usage = 1;
}

if (!opts_compress && !opts_decompress) {
if (!usage && !opts_compress && !opts_decompress) {
MFU_LOG(MFU_LOG_ERR, "Must use either compression or decompression");
usage = 1;
}

0 comments on commit 4c1e9bc

Please sign in to comment.
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.