Skip to content

Commit

Permalink
improve readme notes on CLI options
Browse files Browse the repository at this point in the history
  • Loading branch information
crazyscot committed Oct 27, 2024
1 parent e4ae15a commit ce878b6
Showing 1 changed file with 18 additions and 7 deletions.
25 changes: 18 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,27 +50,38 @@ cargo build --release --locked

The basic syntax is the same as scp or rcp.

You can run the program like this:
```
qcp [OPTIONS] <SOURCE> <DESTINATION>
```

The program has a comprehensive help message, accessed via `qcp -h` (brief) or `qcp --help` (long form).

For example:

```bash
$ qcp my-server:/tmp/testfile /tmp/
⠂ Transferring data, instant rate: 2.1MB/s
testfile ████████████████████████████████████░░░░░░░░░░░░░░░░░░░░░░░░ 1s @ 6.71 MB/s [60%/10.49 MB]
```

The program uses ssh to connect to the target machine and run `qcp --server`. ssh will check the remote host key and prompt you for a password or passphrase in the usual way.
**The program uses the ssh binary on your system to connect to the target machine**.
ssh will check the remote host key and prompt you for a password or passphrase in the usual way.

#### Tuning

By default qcp is tuned for a 100Mbit connection, with 300ms round-trip time to the target server.

The default options are for a 100Mbit connection, with 300ms round-trip time to the target server.
Various network tuning options are available.

You may care to set the options for your internet connection. For example, if you have 300Mbit/s (37.5MB/s) download and 100Mbit/s (12.5MB/s) upload:
For example, if you have 300Mbit/s (37.5MB/s) download and 100Mbit/s (12.5MB/s) upload, you might use these options:

```bash
qcp my-server:/tmp/testfile /tmp/ --tx 12M --rx 37M
qcp my-server:/tmp/testfile /tmp/ --rx 37M --tx 12M
```

Getting good performance can be a tricky subject. See the [performance] documentation.
Performance tuning can be a tricky subject. See the [performance] documentation.

## 📖 How it works
## 📖 How qcp works

The brief version:

Expand Down

0 comments on commit ce878b6

Please sign in to comment.