From 9e3a5b3a597804947dd2cb59a923abca08a5b28e Mon Sep 17 00:00:00 2001 From: Matt Martz Date: Tue, 13 Sep 2016 09:02:29 -0500 Subject: [PATCH] update usage information --- README.rst | 11 +++++++---- speedtest-cli.1 | 34 ++++++++++++++++++++++++++++++++-- 2 files changed, 39 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 8b33952..08e3c87 100644 --- a/README.rst +++ b/README.rst @@ -75,8 +75,8 @@ Usage $ speedtest-cli -h usage: speedtest-cli [-h] [--bytes] [--share] [--simple] [--csv] - [--csv-delimiter CSV_DELIMITER] [--json] [--list] - [--server SERVER] [--mini MINI] [--source SOURCE] + [--csv-delimiter CSV_DELIMITER] [--csv-header] [--json] + [--list] [--server SERVER] [--mini MINI] [--source SOURCE] [--timeout TIMEOUT] [--secure] [--version] Command line interface for testing internet bandwidth using speedtest.net. @@ -91,12 +91,15 @@ Usage results image --simple Suppress verbose output, only show basic information --csv Suppress verbose output, only show basic information - in CSV format + in CSV format. Speeds listed in bit/s and not affected + by --bytes --csv-delimiter CSV_DELIMITER Single character delimiter to use in CSV output. Default "," + --csv-header Print CSV headers --json Suppress verbose output, only show basic information - in JSON format + in JSON format. Speeds listed in bit/s and not + affected by --bytes --list Display a list of speedtest.net servers sorted by distance --server SERVER Specify a server ID to test against diff --git a/speedtest-cli.1 b/speedtest-cli.1 index eb20ea7..9e1befe 100644 --- a/speedtest-cli.1 +++ b/speedtest-cli.1 @@ -1,9 +1,9 @@ .TH "speedtest-cli" 1 "2014-04-23" "speedtest-cli" .SH NAME -speedtest\-cli \- Test your bandwidth througput using speedtest.net +speedtest\-cli \- Command line interface for testing internet bandwidth using speedtest.net .SH SYNOPSIS .B speedtest\-cli -[OPTION]... +[OPTION...] .SH DESCRIPTION Speedtest.net is a web service for testing your broadband connection by downloading a file from a nearby speedtest.net server on the web. This tool allows you to access the service @@ -38,6 +38,26 @@ Generate and provide a URL to the speedtest.net share results image Suppress verbose output, only show basic information .RE +\fB\-\-csv\fR +.RS +Suppress verbose output, only show basic information in CSV format. Speeds listed in bit/s and not affected by \-\-bytes +.RE + +\fB\-\-csv-delimiter CSV_DELIMITER\fR +.RS +Single character delimiter to use in CSV output. Default "," +.RE + +\fB\-\-csv-header\fR +.RS +Print CSV headers +.RE + +\fB\-\-json\fR +.RS +Suppress verbose output, only show basic information in JSON format. Speeds listed in bit/s and not affected by \-\-bytes +.RE + \fB\-\-list\fR .RS Display a list of speedtest.net servers sorted by distance @@ -58,6 +78,16 @@ URL of the Speedtest Mini server Source IP address to bind to .RE +\fB\-\-timeout TIMEOUT\fR +.RS +HTTP timeout in seconds. Default 10 +.RE + +\fB\-\-secure\fR +.RS +Use HTTPS instead of HTTP when communicating with speedtest.net operated servers +.RE + \fB\-\-version\fR .RS Show the version number and exit