Skip to content

Commit

Permalink
update manpage
Browse files Browse the repository at this point in the history
  • Loading branch information
upa committed Apr 13, 2024
1 parent a1b9afe commit 94563c3
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 12 deletions.
13 changes: 8 additions & 5 deletions doc/mscp.1.in
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ of/large files over networks.
.PP
The usage of
.B mscp
imitates the
follows the
.B scp
command of
.I OpenSSH,
Expand Down Expand Up @@ -120,8 +120,10 @@ formula: floor(log(nr_cores)*2)+1.

.TP
.B \-m \fICOREMASK\fR
Configures CPU cores to be used by the hexadecimal bitmask. All CPU
cores are used by default.
Configures CPU cores to be used by the hexadecimal bitmask. For
example, -m 0x25 pins threads onto CPU cores 0, 2, and 5. The default
value is not specified: all CPU cores are used and no threads are
pinned to any cores.

.TP
.B \-u \fIMAX_STARTUPS\fR
Expand Down Expand Up @@ -186,7 +188,8 @@ and remove the checkpoint if it returns 0.
.B \-s \fIMIN_CHUNK_SIZE\fR
Specifies the minimum chunk size.
.B mscp
divides a file into chunks and copies the chunks in parallel.
divides a single file into chunks and copies the chunks in
parallel. The default value is 67108864 (64MB).

.TP
.B \-S \fIMAX_CHUNK_SIZE\fR
Expand Down Expand Up @@ -247,7 +250,7 @@ Specifies the username to log in on the remote machine as with
.TP
.B \-P \fIPORT\fR
Specifies the port number to connect to on the remote machine as with
ssh(1) and scp(1).
.I scp(1).

.TP
.B \-F \fISSH_CONFIG\fR
Expand Down
17 changes: 10 additions & 7 deletions doc/mscp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
MSCP
====

:Date: v0.1.5-13-gf2f0dab
:Date: v0.1.5-16-ga1ba6f1

NAME
====
Expand All @@ -29,7 +29,7 @@ threads. It enables transferring (1) multiple files simultaneously and
(2) a large file in parallel, reducing the transfer time for a lot
of/large files over networks.

The usage of **mscp** imitates the **scp** command of *OpenSSH,* for
The usage of **mscp** follows the **scp** command of *OpenSSH,* for
example:

::
Expand All @@ -54,8 +54,10 @@ OPTIONS
following formula: floor(log(nr_cores)*2)+1.

**-m COREMASK**
Configures CPU cores to be used by the hexadecimal bitmask. All CPU
cores are used by default.
Configures CPU cores to be used by the hexadecimal bitmask. For
example, -m 0x25 pins threads onto CPU cores 0, 2, and 5. The default
value is not specified: all CPU cores are used and no threads are
pinned to any cores.

**-u MAX_STARTUPS**
Specifies the number of concurrent outgoing SSH connections. **sshd**
Expand Down Expand Up @@ -94,8 +96,9 @@ OPTIONS
remove the checkpoint if it returns 0.

**-s MIN_CHUNK_SIZE**
Specifies the minimum chunk size. **mscp** divides a file into chunks
and copies the chunks in parallel.
Specifies the minimum chunk size. **mscp** divides a single file into
chunks and copies the chunks in parallel. The default value is
67108864 (64MB).

**-S MAX_CHUNK_SIZE**
Specifies the maximum chunk size. The default is file size divided by
Expand Down Expand Up @@ -142,7 +145,7 @@ OPTIONS

**-P PORT**
Specifies the port number to connect to on the remote machine as with
ssh(1) and scp(1).
*scp(1).*

**-F SSH_CONFIG**
Specifies an alternative per-user ssh configuration file. Note that
Expand Down

0 comments on commit 94563c3

Please sign in to comment.