Skip to content

Commit

Permalink
generate man pages for release v0.12
Browse files Browse the repository at this point in the history
man pages include updates to the version number as well as new features
and changes related to external factors like github URLs for asset
downloads.

See the release notes for details.

Signed-off-by: Olaf Faaland <[email protected]>
  • Loading branch information
ofaaland committed Oct 21, 2024
1 parent ba72f9d commit 8f23850
Show file tree
Hide file tree
Showing 14 changed files with 145 additions and 106 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" "Feb 04, 2022" "0.11.1" "mpiFileUtils"
.TH "DBCAST" "1" "May 31, 2024" "0.12" "mpiFileUtils"
.SH NAME
dbcast \- distributed broadcast
.
Expand Down Expand Up @@ -56,7 +56,7 @@ number of MPI processes.
.TP
.B \-s, \-\-size SIZE
The chunk size in bytes used to segment files during the broadcast.
Units like “MB” and “GB” should be immediately follow the number
Units like "MB" and "GB" should be immediately follow the number
without spaces (ex. 2MB). The default size is 1MB. It is recommended
to use the stripe size of a file if this is known.
.UNINDENT
Expand Down
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" "Feb 04, 2022" "0.11.1" "mpiFileUtils"
.TH "DBZ2" "1" "May 31, 2024" "0.12" "mpiFileUtils"
.SH NAME
dbz2 \- distributed bz2 compression
.
Expand Down Expand Up @@ -64,7 +64,7 @@ Overwrite the output file, if it exists.
.TP
.B \-b, \-\-blocksize SIZE
Set the compression block size, from 1 to 9.
Where 1=100kB and 9=900kB. Default is 9.
Where 1=100kB ... and 9=900kB. Default is 9.
.UNINDENT
.INDENT 0.0
.TP
Expand Down
14 changes: 7 additions & 7 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" "Feb 04, 2022" "0.11.1" "mpiFileUtils"
.TH "DCHMOD" "1" "May 31, 2024" "0.12" "mpiFileUtils"
.SH NAME
dchmod \- distributed tool to set permissions and group
.
Expand Down Expand Up @@ -32,7 +32,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
..
.SH SYNOPSIS
.sp
\fBdchmod [OPTION] PATH \fP
\fBdchmod [OPTION] PATH ...\fP
.SH DESCRIPTION
.sp
Parallel MPI application to recursively change permissions and/or group
Expand Down Expand Up @@ -62,8 +62,8 @@ Change group to specified GROUP name or numeric group id.
.TP
.B \-m, \-\-mode MODE
The mode to apply to each item. MODE may be octal or symbolic syntax
similar to \fBchmod(1)\fP\&. In symbolic notation, ugoa are supported
as are rwxX. As with chmod, if no leading letter ugoa is provided,
similar to \fBchmod(1)\fP\&. In symbolic notation, "ugoa" are supported
as are "rwxX". As with chmod, if no leading letter "ugoa" is provided,
mode bits are combined with umask to determine the actual mode.
.UNINDENT
.INDENT 0.0
Expand All @@ -73,7 +73,7 @@ Attempt to change every item. By default, dchmod avoids unncessary
chown and chmod calls, for example trying to change the group
on an item that already has the correct group, or trying to change
the group on an item that is not owned by the user running the tool.
With force, dchmod executes chown/chmod calls on every item.
With \-\-force, dchmod executes chown/chmod calls on every item.
.UNINDENT
.INDENT 0.0
.TP
Expand All @@ -96,7 +96,7 @@ Only modify items whose full path matches REGEX, processed by
.INDENT 0.0
.TP
.B \-n, \-\-name
Change exclude and match to apply to item name rather than its
Change \-\-exclude and \-\-match to apply to item name rather than its
full path.
.UNINDENT
.INDENT 0.0
Expand Down Expand Up @@ -151,7 +151,7 @@ regex:
.sp
\fBmpirun \-np 128 dchmod \-\-name \-\-exclude ‘afilename’ \-\-mode u+rw /directory\fP
.sp
Note: You can use match to change file permissions on all of the
Note: You can use \-\-match to change file permissions on all of the
files/directories that match the regex.
.SH SEE ALSO
.sp
Expand Down
23 changes: 14 additions & 9 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" "Feb 04, 2022" "0.11.1" "mpiFileUtils"
.TH "DCMP" "1" "May 31, 2024" "0.12" "mpiFileUtils"
.SH NAME
dcmp \- distributed compare
.
Expand Down Expand Up @@ -54,26 +54,26 @@ in which case, each option should provide a different output file name.
.INDENT 0.0
.TP
.B \-t, \-\-text
Change output to write files in text format rather than binary.
Change \-\-output to write files in text format rather than binary.
.UNINDENT
.INDENT 0.0
.TP
.B \-b, \-\-base
Enable base checks and normal stdout results when output is used.
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
Set the I/O buffer to be SIZE bytes. Units like "MB" and "GB" may
immediately follow the number without spaces (e.g. 8MB). The default
bufsize is 4MB.
.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 (e.g. 64MB).
Set chunk to be at minimum SIZE bytes. Units like "MB" and
"GB" can immediately follow the number without spaces (e.g. 64MB).
The default chunksize is 4MB.
.UNINDENT
.INDENT 0.0
Expand All @@ -91,6 +91,11 @@ Use O_DIRECT to avoid caching file data.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-open\-noatime
Open files with O_NOATIME flag.
.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 @@ -125,7 +130,7 @@ Print the command usage, and the list of options available.
.SH EXPRESSIONS
.sp
An expression is made up of one or more conditions, where each condition specifies a field and a state.
A single condition consists of a field name, an ‘=’ sign, and a state name.
A single condition consists of a field name, an \(aq=\(aq sign, and a state name.
.sp
Valid fields are listed below, along with the property of the entry that is checked.
.TS
Expand Down Expand Up @@ -288,7 +293,7 @@ CONTENT=COMMON => EXISTS=COMMON@TYPE=COMMON@SIZE=COMMON@CONTENT=COMMON
.sp
A successful check on any other field also implies that EXIST=COMMON.
.sp
When used with the \-o option, one must also specify a file name at the end of the expression, separated with a ‘:’.
When used with the \-o option, one must also specify a file name at the end of the expression, separated with a \(aq:\(aq.
The list of any entries that match the expression are written to the named file.
For example, to list any entries matching the above expression to a file named outfile1,
one should use the following option:
Expand All @@ -303,7 +308,7 @@ one should use the following option:
.UNINDENT
.UNINDENT
.sp
If the base option is given or when no output option is specified,
If the \-\-base option is given or when no output option is specified,
the following expressions are checked and numeric results are reported to stdout:
.INDENT 0.0
.INDENT 3.5
Expand Down
29 changes: 23 additions & 6 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" "Feb 04, 2022" "0.11.1" "mpiFileUtils"
.TH "DCP" "1" "May 31, 2024" "0.12" "mpiFileUtils"
.SH NAME
dcp \- distributed copy
.
Expand Down Expand Up @@ -46,22 +46,22 @@ file system, and it splits large file copies across multiple processes.
.INDENT 0.0
.TP
.B \-\-bufsize SIZE
Set the I/O buffer to be SIZE bytes. Units like “MB” and “GB” may
Set the I/O buffer to be SIZE bytes. Units like "MB" and "GB" may
immediately follow the number without spaces (e.g. 8MB). The default
bufsize is 4MB.
.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 (e.g. 64MB).
Set chunk to be at minimum SIZE bytes. Units like "MB" and
"GB" can immediately follow the number without spaces (e.g. 64MB).
The default chunksize is 4MB.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-xattrs WHICH
Copy extended attributes (xattrs) from source files to target files.
Copy extended attributes ("xattrs") from source files to target files.
WHICH determines which xattrs are copied. Options are to copy no xattrs,
all xattrs, xattrs not excluded by /etc/xattr.conf, or all xattrs except
those which have special meaning to Lustre. Certain xattrs control Lustre
Expand Down Expand Up @@ -104,7 +104,7 @@ that each symbolic link refers to.
.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.
or there is not permission to read the link\(aqs target.
.UNINDENT
.INDENT 0.0
.TP
Expand All @@ -118,6 +118,11 @@ Use O_DIRECT to avoid caching file data.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-open\-noatime
Open files with O_NOATIME flag.
.UNINDENT
.INDENT 0.0
.TP
.B \-S, \-\-sparse
Create sparse files when possible.
.UNINDENT
Expand All @@ -130,6 +135,18 @@ A value of 0 disables progress messages.
.UNINDENT
.INDENT 0.0
.TP
.B \-G, \-\-gid GID
Set the effective group ID to perform the copy operation. The copy
may fail if the group does not have sufficient privileges.
.UNINDENT
.INDENT 0.0
.TP
.B \-U, \-\-uid UID
Set the effective user ID to perform the copy operation. The copy
may fail if the user does not have sufficient privileges.
.UNINDENT
.INDENT 0.0
.TP
.B \-v, \-\-verbose
Run in verbose mode.
.UNINDENT
Expand Down
7 changes: 6 additions & 1 deletion 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" "Feb 04, 2022" "0.11.1" "mpiFileUtils"
.TH "DDUP" "1" "May 31, 2024" "0.12" "mpiFileUtils"
.SH NAME
ddup \- report files with identical content
.
Expand Down Expand Up @@ -45,6 +45,11 @@ Multiple sets of duplicate files can be matched using this final reported hash.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-\-open\-noatime
Open files with O_NOATIME flag, if possible.
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-debug LEVEL
Set verbosity level. LEVEL can be one of: fatal, err, warn, info, dbg.
.UNINDENT
Expand Down
24 changes: 12 additions & 12 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" "Feb 04, 2022" "0.11.1" "mpiFileUtils"
.TH "DFIND" "1" "May 31, 2024" "0.12" "mpiFileUtils"
.SH NAME
dfind \- distributed file filtering
.
Expand Down Expand Up @@ -32,7 +32,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
..
.SH SYNOPSIS
.sp
\fBdfind [OPTION] [EXPRESSION] PATH \fP
\fBdfind [OPTION] [EXPRESSION] PATH ...\fP
.SH DESCRIPTION
.sp
Parallel MPI application to filter a list of files according to an expression.
Expand All @@ -57,7 +57,7 @@ Write the processed list to a file.
.INDENT 0.0
.TP
.B \-t, \-\-text
Must be used with the output option. Write processed list of files to
Must be used with the \-\-output option. Write processed list of files to
FILE in ascii text format.
.UNINDENT
.INDENT 0.0
Expand Down Expand Up @@ -123,22 +123,22 @@ File was last accessed N days ago.
.INDENT 0.0
.TP
.B \-\-cmin N
File’s status was last changed N minutes ago.
File\(aqs status was last changed N minutes ago.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-cnewer FILE
File’s status was last changed more recently than FILE was modified.
File\(aqs status was last changed more recently than FILE was modified.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ctime N
File’s status was last changed N days ago.
File\(aqs status was last changed N days ago.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-mmin N
File’s data was last modified N minutes ago.
File\(aqs data was last modified N minutes ago.
.UNINDENT
.INDENT 0.0
.TP
Expand All @@ -148,12 +148,12 @@ File was modified more recently than FILE.
.INDENT 0.0
.TP
.B \-\-mtime N
File’s data was last modified N days ago.
File\(aqs data was last modified N days ago.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-gid N
File’s numeric group ID is N.
File\(aqs numeric group ID is N.
.UNINDENT
.INDENT 0.0
.TP
Expand All @@ -163,7 +163,7 @@ File belongs to group NAME.
.INDENT 0.0
.TP
.B \-\-uid N
File’s numeric user ID is N.
File\(aqs numeric user ID is N.
.UNINDENT
.INDENT 0.0
.TP
Expand All @@ -188,7 +188,7 @@ Full path to file matches POSIX regular expression REGEX. Regular expressions p
.INDENT 0.0
.TP
.B \-\-size N
File size is N bytes. Units can be used like ‘KB’, ‘MB’, ‘GB’.
File size is N bytes. Units can be used like \(aqKB\(aq, \(aqMB\(aq, \(aqGB\(aq.
.UNINDENT
.INDENT 0.0
.TP
Expand Down Expand Up @@ -251,7 +251,7 @@ Print file name to stdout.
.INDENT 0.0
.TP
.B \-\-exec CMD ;
Execute command CMD on file. All following arguments are taken as arguments to the command until ‘;’ is encountered. The string ‘{}’ is replaced by the current file name.
Execute command CMD on file. All following arguments are taken as arguments to the command until \(aq;\(aq is encountered. The string \(aq{}\(aq is replaced by the current file name.
.UNINDENT
.SH EXAMPLES
.INDENT 0.0
Expand Down
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" "Feb 04, 2022" "0.11.1" "mpiFileUtils"
.TH "DRELN" "1" "May 31, 2024" "0.12" "mpiFileUtils"
.SH NAME
dreln \- distributed relink
.
Expand Down Expand Up @@ -32,7 +32,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
..
.SH SYNOPSIS
.sp
\fBdreln [OPTION] OLDPATH NEWPATH PATH \fP
\fBdreln [OPTION] OLDPATH NEWPATH PATH ...\fP
.SH DESCRIPTION
.sp
Parallel MPI application to recursively update symlinks within a
Expand Down
Loading

0 comments on commit 8f23850

Please sign in to comment.