Add 'assh ping' usage example in the README.md

moul · Oct 23, 2017 · 922c2d7 · 922c2d7
1 parent fa4ba12
commit 922c2d7
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -561,6 +561,7 @@ AUTHOR(S):
    Manfred Touron <https://github.com/moul/advanced-ssh-config>
 
 COMMANDS:
+   ping          Send packets to the SSH server and display statistics
    info          Display system-wide information
    config        Manage ssh and assh configuration
    sockets       Manage control sockets
@@ -713,6 +714,23 @@ Create a master control sockets.
 $ assh sockets master
 ```
 
+#### `assh ping`
+
+Send packets to the SSH server and display stats.
+
+```console
+$ assh ping -c 4 localhost
+PING localhost (127.0.0.1) PORT 22 (ssh) PROTO tcp
+Connected to 127.0.0.1: seq=0 time=321µs protocol=tcp port=22
+Connected to 127.0.0.1: seq=1 time=501µs protocol=tcp port=22
+Connected to 127.0.0.1: seq=2 time=550µs protocol=tcp port=22
+Connected to 127.0.0.1: seq=3 time=641µs protocol=tcp port=22
+
+--- localhost assh ping statistics ---
+4 packets transmitted, 4 packets received, 0.00% packet loss
+round-trip min/avg/max = 321µs/503.25µs/641µs
+```
+
 ## Install
 
 Get the latest version using GO (recommended way):

diff --git a/pkg/commands/commands.go b/pkg/commands/commands.go
@@ -47,6 +47,7 @@ var Commands = []cli.Command{
 	},
 	{
 		Name:   "ping",
+		Usage:  "Send packets to the SSH server and display statistics",
 		Action: cmdPing,
 		Flags: []cli.Flag{
 			cli.IntFlag{