summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRyo Nakamura <upa@haeena.net>2024-02-18 22:26:38 +0900
committerRyo Nakamura <upa@haeena.net>2024-02-18 22:26:38 +0900
commit692ea1d4e456f72aa61cc2827680cae4d810b1ce (patch)
tree873a7947420572b78e74f3a0a0909d168430d397 /doc
parent19c73af09d6262d41039c0906f5ea88471075910 (diff)
add validate for path object and update manpage
Diffstat (limited to 'doc')
-rw-r--r--doc/mscp.1.in12
-rw-r--r--doc/mscp.rst33
2 files changed, 20 insertions, 25 deletions
diff --git a/doc/mscp.1.in b/doc/mscp.1.in
index a56e26c..b50d6bc 100644
--- a/doc/mscp.1.in
+++ b/doc/mscp.1.in
@@ -139,7 +139,7 @@ determined as an attack. The default value is 0.
.TP
.B \-W \fICHECKPOINT\fR
-Specifies a checkpoint file path to save the state of a failed
+Specifies a checkpoint file to save the state of a failed
transfer. When transferring fails due to, for example, connection
disruption or user interrupt,
.B mscp
@@ -153,7 +153,7 @@ option with
.TP
.B \-R \fICHECKPOINT\fR
-Specifies a checkpoint file path to resume a transfer. When this
+Specifies a checkpoint file to resume a transfer. When this
option with a checkpoint file is passed,
.B mscp
loads a remote host, copy direction, and files and their chunks to be
@@ -163,14 +163,12 @@ can resume a past failed transfer from the checkpoint. Resumeing with
a checkpoint does not require
.I source ... target
arguments. Other options for establishing SSH connections, for
-example, username, port number, config file, should be specified as
+example, login_name, port number, config file, should be specified as
with the failed run. In addition, checkpoint files contain files as
relative paths. Thus, you must run
.B mscp
-in the same working directory as the failed run.
-
-
-You can see contents of a checkpoint file with
+in the same working directory as the failed run. You can see contents
+of a checkpoint file with
.B mscp
.I \-vvv \-D \-R CHECKOPOINT
command.
diff --git a/doc/mscp.rst b/doc/mscp.rst
index a183dde..99dabfd 100644
--- a/doc/mscp.rst
+++ b/doc/mscp.rst
@@ -2,7 +2,7 @@
MSCP
====
-:Date: v0.1.4-19-g5f628b6
+:Date: v0.1.4-20-g19c73af
NAME
====
@@ -71,27 +71,24 @@ OPTIONS
determined as an attack. The default value is 0.
**-W CHECKPOINT**
- Specifies a checkpoint file path to save the state of a failed
- transfer. When transferring fails due to, for example, connection
- disruption or user interrupt, **mscp** writes the information about
- remaining files and chunks to the specified checkpoint file. **-W**
- option with **-D** (dry-run mode) only writes a checkpoint file and
- exits.
+ Specifies a checkpoint file to save the state of a failed transfer.
+ When transferring fails due to, for example, connection disruption or
+ user interrupt, **mscp** writes the information about remaining files
+ and chunks to the specified checkpoint file. **-W** option with
+ **-D** (dry-run mode) only writes a checkpoint file and exits.
**-R CHECKPOINT**
- Specifies a checkpoint file path to resume a transfer. When this
- option with a checkpoint file is passed, **mscp** loads a remote
- host, copy direction, and files and their chunks to be transferred
- from the checkpoint file. Namely, **mscp** can resume a past failed
- transfer from the checkpoint. Resumeing with a checkpoint does not
- require *source ... target* arguments. Other options for establishing
- SSH connections, for example, username, port number, config file,
+ Specifies a checkpoint file to resume a transfer. When this option
+ with a checkpoint file is passed, **mscp** loads a remote host, copy
+ direction, and files and their chunks to be transferred from the
+ checkpoint file. Namely, **mscp** can resume a past failed transfer
+ from the checkpoint. Resumeing with a checkpoint does not require
+ *source ... target* arguments. Other options for establishing SSH
+ connections, for example, login_name, port number, config file,
should be specified as with the failed run. In addition, checkpoint
files contain files as relative paths. Thus, you must run **mscp** in
- the same working directory as the failed run.
-
-You can see contents of a checkpoint file with **mscp** *-vvv -D -R
-CHECKOPOINT* command.
+ the same working directory as the failed run. You can see contents of
+ a checkpoint file with **mscp** *-vvv -D -R CHECKOPOINT* command.
**-s MIN_CHUNK_SIZE**
Specifies the minimum chunk size. **mscp** divides a file into chunks