diff --git a/docs/agg-speed.md b/docs/agg-speed.md new file mode 100644 index 0000000..7f637e9 --- /dev/null +++ b/docs/agg-speed.md @@ -0,0 +1,134 @@ +# Command-Line Help for `agg-speed` + +This document contains the help content for the `agg-speed` command-line program. + +**Command Overview:** + +* [`agg-speed`↴](#agg-speed) +* [`agg-speed client`↴](#agg-speed-client) +* [`agg-speed server`↴](#agg-speed-server) +* [`agg-speed show-cfg`↴](#agg-speed-show-cfg) + +## `agg-speed` + +Run speed test using a connection consisting of aggregated TCP links. + +This uses Aggligator to combine multiple TCP links into one connection, providing the combined speed and resilience to individual link faults. + +**Usage:** `agg-speed [OPTIONS] ` + +###### **Subcommands:** + +* `client` — Raw speed test client +* `server` — Raw speed test server +* `show-cfg` — Shows the default configuration + +###### **Options:** + +* `--cfg ` — Configuration file +* `-d`, `--dump ` — Dump analysis data to file + + + +## `agg-speed client` + +Raw speed test client + +**Usage:** `agg-speed client [OPTIONS]` + +###### **Options:** + +* `-4`, `--ipv4` — Use IPv4 + + Possible values: `true`, `false` + +* `-6`, `--ipv6` — Use IPv6 + + Possible values: `true`, `false` + +* `-l`, `--limit ` — Limit test data to specified number of MB +* `-t`, `--time