man pages and such for release v0.9.1 (#263)

* update version number to 0.9.1 * refresh of man pages Signed-off-by: Elsa Gonsiorowski (Uranus) <gonsiorowski1@llnl.gov>
hpc · Apr 17, 2019 · 5866e67 · 5866e67
1 parent 893643d
commit 5866e67
Show file tree

Hide file tree

Showing 17 changed files with 557 additions and 416 deletions.
diff --git a/doc/rst/conf.py b/doc/rst/conf.py
@@ -54,9 +54,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'0.9'
+version = u'0.9.1'
 # The full version, including alpha/beta/rc tags.
-release = u'0.9'
+release = u'0.9.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -76,11 +76,11 @@
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 
-from recommonmark.parser import CommonMarkParser
+#from recommonmark.parser import CommonMarkParser
 
-source_parsers = {
-    '.md': CommonMarkParser,
-}
+# source_parsers = {
+#     '.md': CommonMarkParser,
+# }
 
 source_suffix = ['.rst', '.md']
 

diff --git a/doc/rst/tools.rst b/doc/rst/tools.rst
@@ -20,9 +20,9 @@ invocation of the tool has sufficient time to complete before it is killed.
 - dsync - Synchronize files.
 - dwalk - List, sort, and profile files.
 
-===============
+==============================
 Experimental Utilities
-===============
+==============================
 
 Experimental utilities are under active development. They are not considered to
 be production worthy, but they are available in the distribution for those

diff --git a/man/dbcast.1 b/man/dbcast.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "DBCAST" "1" "Jan 28, 2019" "0.9" "mpiFileUtils"
+.TH "DBCAST" "1" "Apr 17, 2019" "0.9.1" "mpiFileUtils"
 .SH NAME
 dbcast \- distributed broadcast
 .

diff --git a/man/dbz2.1 b/man/dbz2.1
@@ -0,0 +1,107 @@
+.\" Man page generated from reStructuredText.
+.
+.TH "DBZ2" "1" "Apr 17, 2019" "0.9.1" "mpiFileUtils"
+.SH NAME
+dbz2 \- distributed bz2 compression
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.SH SYNOPSIS
+.sp
+\fBdbz2 [OPTIONS] [\-z|\-d] FILE\fP
+.SH DESCRIPTION
+.sp
+Parallel MPI application to compress or decompress a file.
+.sp
+When compressing, a new file will be created with a .dbz2 extension.
+When decompressing, the .dbz2 extension will be dropped from the file name.
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.B \-d, \-\-decompress
+Decompress the file
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-z, \-\-compress
+Compress the file
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-k, \-\-keep
+Keep the input file.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-f, \-\-overwrite
+Overwrite the output file, if it exists.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-b, \-\-block SIZE
+Set the compression block size, from 1 to 9.
+Where 1=100kB ... and 9=900kB. Default is 9.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-v, \-\-verbose
+Verbose output (optional).
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-h, \-\-help
+Print usage.
+.UNINDENT
+.SH EXAMPLES
+.INDENT 0.0
+.IP 1. 3
+To compress a file:
+.UNINDENT
+.sp
+\fBmpirun \-np 128 dbz2 \-\-compress /path/to/file\fP
+.INDENT 0.0
+.IP 2. 3
+To compress a file and overwrite any existing output file:
+.UNINDENT
+.sp
+\fBmpirun \-np 128 dbz2 \-\-force \-\-compress /path/to/file\fP
+.INDENT 0.0
+.IP 3. 3
+To decompress a file:
+.UNINDENT
+.sp
+\fBmpirun \-np 128 dbz2 \-\-decompress /path/to/file.dbz2\fP
+.SH SEE ALSO
+.sp
+The mpiFileUtils source code and all documentation may be downloaded
+from <\fI\%https://github.com/hpc/mpifileutils\fP>
+.SH AUTHOR
+HPC
+.SH COPYRIGHT
+2018, LLNL/LANL/UT-Battelle/DDN
+.\" Generated by docutils manpage writer.
+.
diff --git a/man/dchmod.1 b/man/dchmod.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "DCHMOD" "1" "Jan 28, 2019" "0.9" "mpiFileUtils"
+.TH "DCHMOD" "1" "Apr 17, 2019" "0.9.1" "mpiFileUtils"
 .SH NAME
 dchmod \- distributed tool to set permissions and group
 .
@@ -94,6 +94,11 @@ the files/sec rate for each of those.
 .UNINDENT
 .INDENT 0.0
 .TP
+.B \-q, \-\-quiet
+Run tool silently. No output is printed.
+.UNINDENT
+.INDENT 0.0
+.TP
 .B \-h, \-\-help
 Print the command usage, and the list of options available.
 .UNINDENT

diff --git a/man/dcmp.1 b/man/dcmp.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "DCMP" "1" "Jan 28, 2019" "0.9" "mpiFileUtils"
+.TH "DCMP" "1" "Apr 17, 2019" "0.9.1" "mpiFileUtils"
 .SH NAME
 dcmp \- distributed compare
 .
@@ -70,6 +70,11 @@ read, byte rate, and file rate.
 .UNINDENT
 .INDENT 0.0
 .TP
+.B \-q, \-\-quiet
+Run tool silently. No output is printed.
+.UNINDENT
+.INDENT 0.0
+.TP
 .B \-l, \-\-lite
 lite mode does a comparison of file modification time and size. If
 modification time and size are the same, then the contents are assumed
@@ -219,7 +224,7 @@ EXIST=COMMON@TYPE=DIFFER
 .UNINDENT
 .sp
 The AND operator binds with higher precedence than the OR operator.
-For example, the following expression matches on entries which either (exist in both soure and destination and whose types differ) or (only exist in the source):
+For example, the following expression matches on entries which either (exist in both source and destination and whose types differ) or (only exist in the source):
 .INDENT 0.0
 .INDENT 3.5
 .sp

diff --git a/man/dcp.1 b/man/dcp.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "DCP" "1" "Jan 28, 2019" "0.9" "mpiFileUtils"
+.TH "DCP" "1" "Apr 17, 2019" "0.9.1" "mpiFileUtils"
 .SH NAME
 dcp \- distributed copy
 .
@@ -70,6 +70,11 @@ Run in verbose mode.
 .UNINDENT
 .INDENT 0.0
 .TP
+.B \-q, \-\-quiet
+Run tool silently. No output is printed.
+.UNINDENT
+.INDENT 0.0
+.TP
 .B \-h, \-\-help
 Print a brief message listing the \fBdcp(1)\fP options and usage.
 .UNINDENT

diff --git a/man/ddup.1 b/man/ddup.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "DDUP" "1" "Jan 28, 2019" "0.9" "mpiFileUtils"
+.TH "DDUP" "1" "Apr 17, 2019" "0.9.1" "mpiFileUtils"
 .SH NAME
 ddup \- report files with identical content
 .
@@ -50,6 +50,16 @@ Set verbosity level.  LEVEL can be one of: fatal, err, warn, info, dbg.
 .UNINDENT
 .INDENT 0.0
 .TP
+.B \-v, \-\-verbose
+Run in verbose mode.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-q, \-\-quiet
+Run tool silently. No output is printed.
+.UNINDENT
+.INDENT 0.0
+.TP
 .B \-h, \-\-help
 Print the command usage, and the list of options available.
 .UNINDENT

diff --git a/man/dfilemaker.1 b/man/dfilemaker.1
diff --git a/man/dfind.1 b/man/dfind.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "DFIND" "1" "Jan 28, 2019" "0.9" "mpiFileUtils"
+.TH "DFIND" "1" "Apr 17, 2019" "0.9.1" "mpiFileUtils"
 .SH NAME
 dfind \- distributed file filtering
 .
@@ -61,6 +61,11 @@ Run in verbose mode.
 .UNINDENT
 .INDENT 0.0
 .TP
+.B \-q, \-\-quiet
+Run tool silently. No output is printed.
+.UNINDENT
+.INDENT 0.0
+.TP
 .B \-h, \-\-help
 Print a brief message listing the \fBdfind(1)\fP options and usage.
 .UNINDENT