Skip to content

Commit

Permalink
doc: refresh man pages
Browse files Browse the repository at this point in the history
Signed-off-by: Adam Moody <moody20@llnl.gov>
  • Loading branch information
adammoody committed Jan 29, 2021
1 parent eb7b561 commit 3281687
Show file tree
Hide file tree
Showing 13 changed files with 493 additions and 61 deletions.
4 changes: 2 additions & 2 deletions man/dbcast.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DBCAST" "1" "Jul 04, 2020" "0.10.1" "mpiFileUtils"
.TH "DBCAST" "1" "Jan 26, 2021" "0.11.0" "mpiFileUtils"
.SH NAME
dbcast \- distributed broadcast
.
Expand Down Expand Up @@ -88,6 +88,6 @@ from <\fI\%https://github.com/hpc/mpifileutils\fP>
.SH AUTHOR
HPC
.SH COPYRIGHT
2018, LLNL/LANL/UT-Battelle/DDN
2021, LLNL/LANL/UT-Battelle/DDN
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/dbz2.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DBZ2" "1" "Jul 04, 2020" "0.10.1" "mpiFileUtils"
.TH "DBZ2" "1" "Jan 26, 2021" "0.11.0" "mpiFileUtils"
.SH NAME
dbz2 \- distributed bz2 compression
.
Expand Down Expand Up @@ -107,6 +107,6 @@ from <\fI\%https://github.com/hpc/mpifileutils\fP>
.SH AUTHOR
HPC
.SH COPYRIGHT
2018, LLNL/LANL/UT-Battelle/DDN
2021, LLNL/LANL/UT-Battelle/DDN
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/dchmod.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DCHMOD" "1" "Jul 04, 2020" "0.10.1" "mpiFileUtils"
.TH "DCHMOD" "1" "Jan 26, 2021" "0.11.0" "mpiFileUtils"
.SH NAME
dchmod \- distributed tool to set permissions and group
.
Expand Down Expand Up @@ -160,6 +160,6 @@ from <\fI\%https://github.com/hpc/mpifileutils\fP>
.SH AUTHOR
HPC
.SH COPYRIGHT
2018, LLNL/LANL/UT-Battelle/DDN
2021, LLNL/LANL/UT-Battelle/DDN
.\" Generated by docutils manpage writer.
.
39 changes: 37 additions & 2 deletions man/dcmp.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DCMP" "1" "Jul 04, 2020" "0.10.1" "mpiFileUtils"
.TH "DCMP" "1" "Jan 26, 2021" "0.11.0" "mpiFileUtils"
.SH NAME
dcmp \- distributed compare
.
Expand Down Expand Up @@ -63,6 +63,41 @@ Enable base checks and normal stdout results when –output is used.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-bufsize SIZE
Set the I/O buffer to be SIZE bytes. Units like “MB” and “GB” may
immediately follow the number without spaces (eg. 8MB). The default
bufsize is 64MB.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-chunksize SIZE
Multiple processes copy a large file in parallel by dividing it into chunks.
Set chunk to be at minimum SIZE bytes. Units like “MB” and
“GB” can immediately follow the number without spaces (eg. 64MB).
The default chunksize is 64MB.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-daos\-prefix PREFIX
Specify the DAOS prefix to be used. This is only necessary
if copying a subset of a POSIX container in DAOS using a
Unified Namespace path.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-daos\-api API
Specify the DAOS API to be used. By default, the API is automatically
determined based on the container type, where POSIX containers use the
DFS API, and all other containers use the DAOS object API.
Values must be in {DFS, DAOS}.
.UNINDENT
.INDENT 0.0
.TP
.B \-s, \-\-direct
Use O_DIRECT to avoid caching file data.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-progress N
Print progress message to stdout approximately every N seconds.
The number of seconds must be a non\-negative integer.
Expand Down Expand Up @@ -324,6 +359,6 @@ from <\fI\%https://github.com/hpc/mpifileutils\fP>
.SH AUTHOR
HPC
.SH COPYRIGHT
2018, LLNL/LANL/UT-Battelle/DDN
2021, LLNL/LANL/UT-Battelle/DDN
.\" Generated by docutils manpage writer.
.
51 changes: 39 additions & 12 deletions man/dcp.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DCP" "1" "Jul 04, 2020" "0.10.1" "mpiFileUtils"
.TH "DCP" "1" "Jan 26, 2021" "0.11.0" "mpiFileUtils"
.SH NAME
dcp \- distributed copy
.
Expand Down Expand Up @@ -45,10 +45,33 @@ file system, and it splits large file copies across multiple processes.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-b, \-\-blocksize SIZE
.B \-\-bufsize SIZE
Set the I/O buffer to be SIZE bytes. Units like “MB” and “GB” may
immediately follow the number without spaces (eg. 8MB). The default
blocksize is 1MB.
bufsize is 64MB.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-chunksize SIZE
Multiple processes copy a large file in parallel by dividing it into chunks.
Set chunk to be at minimum SIZE bytes. Units like “MB” and
“GB” can immediately follow the number without spaces (eg. 64MB).
The default chunksize is 64MB.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-daos\-prefix PREFIX
Specify the DAOS prefix to be used. This is only necessary
if copying a subset of a POSIX container in DAOS using a
Unified Namespace path.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-daos\-api API
Specify the DAOS API to be used. By default, the API is automatically
determined based on the container type, where POSIX containers use the
DFS API, and all other containers use the DAOS object API.
Values must be in {DFS, DAOS}.
.UNINDENT
.INDENT 0.0
.TP
Expand All @@ -58,11 +81,16 @@ from the mpiFileUtils suite.
.UNINDENT
.INDENT 0.0
.TP
.B \-k, \-\-chunksize SIZE
Split large files into chunks of SIZE bytes to be processed. Multiple
process ranks may copy a large file in parallel. Units like “MB” and
“GB” can immediately follow the number without spaces (eg. 64MB).
The default chunksize is 1MB.
.B \-L, \-\-dereference
Dereference symbolic links and copy the target file or directory
that each symbolic link refers to.
.UNINDENT
.INDENT 0.0
.TP
.B \-P, \-\-no\-dereference
Do not follow symbolic links in source paths. Effectviely allows
symbolic links to be copied when the link target is not valid
or there is not permission to read the link’s target.
.UNINDENT
.INDENT 0.0
.TP
Expand All @@ -71,9 +99,8 @@ Preserve permissions, group, timestamps, and extended attributes.
.UNINDENT
.INDENT 0.0
.TP
.B \-s, \-\-synchronous
Use synchronous read/write calls (open files with O_DIRECT).
This also avoids caching the file data on the client nodes.
.B \-s, \-\-direct
Use O_DIRECT to avoid caching file data.
.UNINDENT
.INDENT 0.0
.TP
Expand Down Expand Up @@ -146,6 +173,6 @@ from <\fI\%https://github.com/hpc/mpifileutils\fP>
.SH AUTHOR
HPC
.SH COPYRIGHT
2018, LLNL/LANL/UT-Battelle/DDN
2021, LLNL/LANL/UT-Battelle/DDN
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/ddup.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DDUP" "1" "Jul 04, 2020" "0.10.1" "mpiFileUtils"
.TH "DDUP" "1" "Jan 26, 2021" "0.11.0" "mpiFileUtils"
.SH NAME
ddup \- report files with identical content
.
Expand Down Expand Up @@ -77,6 +77,6 @@ from <\fI\%https://github.com/hpc/mpifileutils\fP>
.SH AUTHOR
HPC
.SH COPYRIGHT
2018, LLNL/LANL/UT-Battelle/DDN
2021, LLNL/LANL/UT-Battelle/DDN
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/dfind.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DFIND" "1" "Jul 04, 2020" "0.10.1" "mpiFileUtils"
.TH "DFIND" "1" "Jan 26, 2021" "0.11.0" "mpiFileUtils"
.SH NAME
dfind \- distributed file filtering
.
Expand Down Expand Up @@ -273,6 +273,6 @@ from <\fI\%https://github.com/hpc/mpifileutils\fP>
.SH AUTHOR
HPC
.SH COPYRIGHT
2018, LLNL/LANL/UT-Battelle/DDN
2021, LLNL/LANL/UT-Battelle/DDN
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/dreln.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DRELN" "1" "Jul 04, 2020" "0.10.1" "mpiFileUtils"
.TH "DRELN" "1" "Jan 26, 2021" "0.11.0" "mpiFileUtils"
.SH NAME
dreln \- distributed relink
.
Expand Down Expand Up @@ -114,6 +114,6 @@ from <\fI\%https://github.com/hpc/mpifileutils\fP>
.SH AUTHOR
HPC
.SH COPYRIGHT
2018, LLNL/LANL/UT-Battelle/DDN
2021, LLNL/LANL/UT-Battelle/DDN
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/drm.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DRM" "1" "Jul 04, 2020" "0.10.1" "mpiFileUtils"
.TH "DRM" "1" "Jan 26, 2021" "0.11.0" "mpiFileUtils"
.SH NAME
drm \- distributed remove
.
Expand Down Expand Up @@ -174,6 +174,6 @@ from <\fI\%https://github.com/hpc/mpifileutils\fP>
.SH AUTHOR
HPC
.SH COPYRIGHT
2018, LLNL/LANL/UT-Battelle/DDN
2021, LLNL/LANL/UT-Battelle/DDN
.\" Generated by docutils manpage writer.
.
4 changes: 2 additions & 2 deletions man/dstripe.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DSTRIPE" "1" "Jul 04, 2020" "0.10.1" "mpiFileUtils"
.TH "DSTRIPE" "1" "Jan 26, 2021" "0.11.0" "mpiFileUtils"
.SH NAME
dstripe \- restripe files on underlying storage
.
Expand Down Expand Up @@ -136,6 +136,6 @@ from <\fI\%https://github.com/hpc/mpifileutils\fP>
.SH AUTHOR
HPC
.SH COPYRIGHT
2018, LLNL/LANL/UT-Battelle/DDN
2021, LLNL/LANL/UT-Battelle/DDN
.\" Generated by docutils manpage writer.
.
52 changes: 50 additions & 2 deletions man/dsync.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DSYNC" "1" "Jul 04, 2020" "0.10.1" "mpiFileUtils"
.TH "DSYNC" "1" "Jan 26, 2021" "0.11.0" "mpiFileUtils"
.SH NAME
dsync \- synchronize directory trees
.
Expand Down Expand Up @@ -53,6 +53,36 @@ Batch files into groups of up to size N during copy operation.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-bufsize SIZE
Set the I/O buffer to be SIZE bytes. Units like “MB” and “GB” may
immediately follow the number without spaces (eg. 8MB). The default
bufsize is 64MB.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-chunksize SIZE
Multiple processes copy a large file in parallel by dividing it into chunks.
Set chunk to be at minimum SIZE bytes. Units like “MB” and
“GB” can immediately follow the number without spaces (eg. 64MB).
The default chunksize is 64MB.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-daos\-prefix PREFIX
Specify the DAOS prefix to be used. This is only necessary
if copying a subset of a POSIX container in DAOS using a
Unified Namespace path.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-daos\-api API
Specify the DAOS API to be used. By default, the API is automatically
determined based on the container type, where POSIX containers use the
DFS API, and all other containers use the DAOS object API.
Values must be in {DFS, DAOS}.
.UNINDENT
.INDENT 0.0
.TP
.B \-c, \-\-contents
Compare files byte\-by\-byte rather than checking size and mtime
to determine whether file contents are different.
Expand All @@ -64,6 +94,24 @@ Delete extraneous files from destination.
.UNINDENT
.INDENT 0.0
.TP
.B \-L, \-\-dereference
Dereference symbolic links and copy the target file or directory
that each symbolic link refers to.
.UNINDENT
.INDENT 0.0
.TP
.B \-P, \-\-no\-dereference
Do not follow symbolic links in source paths. Effectviely allows
symbolic links to be copied when the link target is not valid
or there is not permission to read the link’s target.
.UNINDENT
.INDENT 0.0
.TP
.B \-s, \-\-direct
Use O_DIRECT to avoid caching file data.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-link\-dest DIR
Create hardlink in DEST to files in DIR when file is unchanged
rather than create a new file. One can use this option to conserve
Expand Down Expand Up @@ -122,6 +170,6 @@ from <\fI\%https://github.com/hpc/mpifileutils\fP>
.SH AUTHOR
HPC
.SH COPYRIGHT
2018, LLNL/LANL/UT-Battelle/DDN
2021, LLNL/LANL/UT-Battelle/DDN
.\" Generated by docutils manpage writer.
.
10 changes: 8 additions & 2 deletions man/dwalk.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DWALK" "1" "Jul 04, 2020" "0.10.1" "mpiFileUtils"
.TH "DWALK" "1" "Jan 26, 2021" "0.11.0" "mpiFileUtils"
.SH NAME
dwalk \- distributed walk and list
.
Expand Down Expand Up @@ -103,6 +103,12 @@ Print files to the screen.
.UNINDENT
.INDENT 0.0
.TP
.B \-L, \-\-dereference
Dereference symbolic links and walk the target file or directory
that each symbolic link refers to.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-progress N
Print progress message to stdout approximately every N seconds.
The number of seconds must be a non\-negative integer.
Expand Down Expand Up @@ -167,6 +173,6 @@ from <\fI\%https://github.com/hpc/mpifileutils\fP>
.SH AUTHOR
HPC
.SH COPYRIGHT
2018, LLNL/LANL/UT-Battelle/DDN
2021, LLNL/LANL/UT-Battelle/DDN
.\" Generated by docutils manpage writer.
.

0 comments on commit 3281687

Please sign in to comment.