diff options
| author | Ryo Nakamura <upa@haeena.net> | 2024-04-10 18:40:05 +0900 |
|---|---|---|
| committer | Ryo Nakamura <upa@haeena.net> | 2024-04-10 20:57:11 +0900 |
| commit | 2bfd599ad9264253c455f63adbdf4607db6b2bb7 (patch) | |
| tree | 2cf291c856dcc04e38026cc9172fca61a9e8f37a /doc | |
| parent | 9b8ba69a61f09fbcd40574d0b912846eeaaaa1e2 (diff) | |
add -L limit bitrate option (#14)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/mscp.1.in | 8 | ||||
| -rw-r--r-- | doc/mscp.rst | 22 |
2 files changed, 21 insertions, 9 deletions
diff --git a/doc/mscp.1.in b/doc/mscp.1.in index a99bb88..92d8651 100644 --- a/doc/mscp.1.in +++ b/doc/mscp.1.in @@ -38,6 +38,9 @@ mscp \- copy files over multiple SSH connections .BI \-b \ BUF_SIZE\c ] [\c +.BI \-L \ LIMIT_BITRATE\c +] +[\c .BI \-l \ LOGIN_NAME\c ] [\c @@ -199,6 +202,11 @@ value is 16384. Note that the SSH specification restricts buffer size delivered over SSH. Changing this value is not recommended at present. .TP +.B \-L \fILIMIT_BITRATE\fR +Limits the bitrate, specified with k (K), m (M), and g (G), e.g., 100m +indicates 100 Mbps. + +.TP .B \-4 Uses IPv4 addresses only. diff --git a/doc/mscp.rst b/doc/mscp.rst index 9a53134..60d32a4 100644 --- a/doc/mscp.rst +++ b/doc/mscp.rst @@ -2,7 +2,7 @@ MSCP ==== -:Date: v0.1.4-28-g0d248c5 +:Date: v0.1.5-4-g9b8ba69 NAME ==== @@ -12,14 +12,14 @@ mscp - copy files over multiple SSH connections SYNOPSIS ======== -**mscp** [**-46vqDpHdNh**] [ **-n**\ *NR_CONNECTIONS* ] [ -**-m**\ *COREMASK* ] [ **-u**\ *MAX_STARTUPS* ] [ **-I**\ *INTERVAL* ] [ -**-W**\ *CHECKPOINT* ] [ **-R**\ *CHECKPOINT* ] [ -**-s**\ *MIN_CHUNK_SIZE* ] [ **-S**\ *MAX_CHUNK_SIZE* ] [ -**-a**\ *NR_AHEAD* ] [ **-b**\ *BUF_SIZE* ] [ **-l**\ *LOGIN_NAME* ] [ -**-P**\ *PORT* ] [ **-F**\ *CONFIG* ] [ **-i**\ *IDENTITY* ] [ -**-c**\ *CIPHER* ] [ **-M**\ *HMAC* ] [ **-C**\ *COMPRESS* ] [ -**-g**\ *CONGESTION* ] *source ... target* +**mscp** [**-46vqDpHdNh**] [ **-n** *NR_CONNECTIONS* ] [ **-m** +*COREMASK* ] [ **-u** *MAX_STARTUPS* ] [ **-I** *INTERVAL* ] [ **-W** +*CHECKPOINT* ] [ **-R** *CHECKPOINT* ] [ **-s** *MIN_CHUNK_SIZE* ] [ +**-S** *MAX_CHUNK_SIZE* ] [ **-a** *NR_AHEAD* ] [ **-b** *BUF_SIZE* ] [ +**-L** *LIMIT_BITRATE* ] [ **-l** *LOGIN_NAME* ] [ **-P** *PORT* ] [ +**-F** *CONFIG* ] [ **-i** *IDENTITY* ] [ **-c** *CIPHER* ] [ **-M** +*HMAC* ] [ **-C** *COMPRESS* ] [ **-g** *CONGESTION* ] *source ... +target* DESCRIPTION =========== @@ -111,6 +111,10 @@ OPTIONS delivered over SSH. Changing this value is not recommended at present. +**-L LIMIT_BITRATE** + Limits the bitrate, specified with k (K), m (M), and g (G), e.g., + 100m indicates 100 Mbps. + **-4** Uses IPv4 addresses only. |