Ma/mscp
1
0
Fork 0
mirror of https://github.com/upa/mscp.git synced 2026-03-06 07:37:31 +08:00
Code Issues Packages Projects Releases 1 Wiki Activity

update doc for checkpoint

Browse Source
This commit is contained in:
Ryo Nakamura
2024-02-20 20:29:55 +09:00
parent fc0ced1828
commit dfdad6bca5
3 changed files with 43 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
doc/mscp.1.in
View File

@@ -143,7 +143,7 @@ Specifies a checkpoint file to save the state of a failed
transfer. When transferring fails due to, for example, connection transfer. When transferring fails due to, for example, connection
disruption or user interrupt, disruption or user interrupt,
.B mscp .B mscp
writes the information about remaining files and chunks to the writes the information about the remaining files and chunks to the
specified checkpoint file. specified checkpoint file.
.B \-W .B \-W
option with option with
@@ -153,27 +153,27 @@ option with
.TP .TP
.B \-R \fICHECKPOINT\fR .B \-R \fICHECKPOINT\fR
Specifies a checkpoint file to resume a transfer. When this Specifies a checkpoint file to resume a transfer. When a checkpoint
option with a checkpoint file is passed, file is passed,
.B mscp .B mscp
loads a remote host, copy direction, and files and their chunks to be reads the checkpoint to load a remote host, copy direction, and files
transferred from the checkpoint file. Namely, and their chunks to be transferred. Namely,
.B mscp .B mscp
can resume a past failed transfer from the checkpoint. Resumeing with can resume a past failed transfer from the checkpoint. Resumeing with
a checkpoint does not require a checkpoint does not require
.I source ... target .I source ... target
arguments. Other options for establishing SSH connections, for arguments. Other SSH connection options, such as port number and
example, login_name, port number, config file, should be specified as config file, should be specified as with the failed run. In addition,
with the failed run. In addition, checkpoint files contain files as checkpoint files have file paths as relative paths. Thus, you must run
relative paths. Thus, you must run
.B mscp .B mscp
in the same working directory as the failed run. You can see contents in the same working directory as the failed run. You can see the
of a checkpoint file with contents of a checkpoint file with the
.B mscp \-vv \-D \-R CHECKOPOINT
command (Dry-run mode). Note that the checkpoint file is not
automatically removed after the resumed transfer ends
successfully. Users should check the return value of
.B mscp .B mscp
.I \-vvv \-D \-R CHECKOPOINT and remove the checkpoint if it returns 0.
command.
.TP .TP
@@ -355,18 +355,18 @@ Copy a local file and a directory to /tmp at a remote host:
Save a checkpoint if transfer fails: Save a checkpoint if transfer fails:
.nf .nf
$ mscp -W checkpoint srcdir 10.0.0.1:dst/ $ mscp -W mscp.checkpoint many-large-files 10.0.0.1:dst/
.fi .fi
.PP .PP
Check remaining files and chunkes, and resume a failed transfer: Check the remaining files and chunkes, and resume the failed transfer:
.nf .nf
# dump a checkpoint and exit (dry-run mode) # Dump the content of a checkpoint and exit (dry-run mode)
$ mscp -vvv -D -R checkpoint $ mscp -vv -D -R mscp.checkpoint
# resume transferring from the checkpoint # resume transferring from the checkpoint
$ mscp -R checkpoint $ mscp -R mscp.checkpoint
.fi .fi
.PP .PP

41
doc/mscp.rst
View File

@@ -2,7 +2,7 @@
MSCP MSCP
==== ====
:Date: v0.1.4-20-g19c73af :Date: v0.1.4-24-g426c3d6
NAME NAME
==== ====
@@ -73,22 +73,25 @@ OPTIONS
**-W CHECKPOINT** **-W CHECKPOINT**
Specifies a checkpoint file to save the state of a failed transfer. Specifies a checkpoint file to save the state of a failed transfer.
When transferring fails due to, for example, connection disruption or When transferring fails due to, for example, connection disruption or
user interrupt, **mscp** writes the information about remaining files user interrupt, **mscp** writes the information about the remaining
and chunks to the specified checkpoint file. **-W** option with files and chunks to the specified checkpoint file. **-W** option with
**-D** (dry-run mode) only writes a checkpoint file and exits. **-D** (dry-run mode) only writes a checkpoint file and exits.
**-R CHECKPOINT** **-R CHECKPOINT**
Specifies a checkpoint file to resume a transfer. When this option Specifies a checkpoint file to resume a transfer. When a checkpoint
with a checkpoint file is passed, **mscp** loads a remote host, copy file is passed, **mscp** reads the checkpoint to load a remote host,
direction, and files and their chunks to be transferred from the copy direction, and files and their chunks to be transferred. Namely,
checkpoint file. Namely, **mscp** can resume a past failed transfer **mscp** can resume a past failed transfer from the checkpoint.
from the checkpoint. Resumeing with a checkpoint does not require Resumeing with a checkpoint does not require *source ... target*
*source ... target* arguments. Other options for establishing SSH arguments. Other SSH connection options, such as port number and
connections, for example, login_name, port number, config file, config file, should be specified as with the failed run. In addition,
should be specified as with the failed run. In addition, checkpoint checkpoint files have file paths as relative paths. Thus, you must
files contain files as relative paths. Thus, you must run **mscp** in run **mscp** in the same working directory as the failed run. You can
the same working directory as the failed run. You can see contents of see the contents of a checkpoint file with the **mscp -vv -D -R
a checkpoint file with **mscp** *-vvv -D -R CHECKOPOINT* command. CHECKOPOINT** command (Dry-run mode). Note that the checkpoint file
is not automatically removed after the resumed transfer ends
successfully. Users should check the return value of **mscp** and
remove the checkpoint if it returns 0.
**-s MIN_CHUNK_SIZE** **-s MIN_CHUNK_SIZE**
Specifies the minimum chunk size. **mscp** divides a file into chunks Specifies the minimum chunk size. **mscp** divides a file into chunks
@@ -224,17 +227,17 @@ Save a checkpoint if transfer fails:
:: ::
$ mscp -W checkpoint srcdir 10.0.0.1:dst/ $ mscp -W mscp.checkpoint many-large-files 10.0.0.1:dst/
Check remaining files and chunkes, and resume a failed transfer: Check the remaining files and chunkes, and resume the failed transfer:
:: ::
# dump a checkpoint and exit (dry-run mode) # Dump the content of a checkpoint and exit (dry-run mode)
$ mscp -vvv -D -R checkpoint $ mscp -vv -D -R mscp.checkpoint
# resume transferring from the checkpoint # resume transferring from the checkpoint
$ mscp -R checkpoint $ mscp -R mscp.checkpoint
In a long fat network, following options might improve performance: In a long fat network, following options might improve performance:

2
src/main.c
View File

@@ -42,7 +42,7 @@ void usage(bool print_help)
"(default: 8)\n" "(default: 8)\n"
" -I INTERVAL interval between SSH connection attempts (default: 0)\n" " -I INTERVAL interval between SSH connection attempts (default: 0)\n"
" -W CHECKPOINT write states to the checkpoint if transfer fails\n" " -W CHECKPOINT write states to the checkpoint if transfer fails\n"
" -R CHECKPOINT resume the transfer from the checkpoint\n" " -R CHECKPOINT resume transferring from the checkpoint\n"
"\n" "\n"
" -s MIN_CHUNK_SIZE min chunk size (default: 64MB)\n" " -s MIN_CHUNK_SIZE min chunk size (default: 64MB)\n"
" -S MAX_CHUNK_SIZE max chunk size (default: filesize/nr_conn)\n" " -S MAX_CHUNK_SIZE max chunk size (default: filesize/nr_conn)\n"