updated program name

yuriescl · Dec 7, 2019 · f60004a · f60004a
1 parent 7a68783
commit f60004a
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 30 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,7 @@
+3.0.2:
+
+- Updated program description
+
 3.0.1:
 
 - Updated documentation

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 ## Run Over SSH
 
-Run a shell command or script over ssh in one or more hosts.
+Run shell commands over ssh.
 
 ### Installation
 
@@ -16,7 +16,30 @@ sudo curl -L "https://raw.githubusercontent.com/yuriescl/runoverssh/master/runov
 
 ### Usage
 ```
-$ runoverssh [OPTIONS] USERNAME COMMAND HOSTS...
+runoverssh [OPTIONS] USERNAME COMMAND HOSTS...
+
+Options:
+  -g, --globalpw             Prompt a global password for all connections
+  -s, --script FILE          Read commands from a script file, disables
+                              the default COMMAND argument
+  -r, --hostsfile FILE       Read the list of hosts from a file (one host
+                              per line), disables the default HOSTS argument
+  -a, --args ARGS            Arguments (in a single string) to be passed to
+                              the script file.
+  -q, --quiet                Disable all screen output, except for password
+                              prompts. If logfile is set, output is written
+                              there
+  -v, --verbose              Print verbose messages
+  --shell SHELL              Remote shell to be used. Supported values:
+                              sh, bash
+                             default: bash
+  --shellflags FLAGS         Remote shell flags
+                             default: ''
+  --sshflags FLAGS           Local SSH flags
+                             default:  -o ConnectTimeout=5
+                                       -o StrictHostKeyChecking=no
+                                       -o UserKnownHostsFile=/dev/null
+  --logfile FILE             Append SSH output to a file
 ```
 
 ### Default behavior
@@ -30,31 +53,6 @@ A global password can be used for all SSH connections.
 It requires `sshpass` to be installed.  
 See the `-g` flag.
 
-### Options:
-```
-   -g, --globalpw             Prompt a global password for all connections
-   -s, --script FILE          Read commands from a script file, disables
-                               the default COMMAND argument
-   -r, --hostsfile FILE       Read the list of hosts from a file (one host
-                               per line), disables the default HOSTS argument
-   -a, --args ARGS            Arguments (in a single string) to be passed to
-                               the script file.
-   -q, --quiet                Disable all screen output, except for password
-                               prompts. If logfile is set, output is written
-                               there
-   -v, --verbose              Print verbose messages
-   --shell SHELL              Remote shell to be used. Supported values:
-                               sh, bash
-                              default: bash
-   --shellflags FLAGS         Remote shell flags
-                              default: ''
-   --sshflags FLAGS           Local SSH flags
-                              default:  -o ConnectTimeout=5
-                                        -o StrictHostKeyChecking=no
-                                        -o UserKnownHostsFile=/dev/null
-   --logfile FILE             Append SSH output to a file
-```
-
 ### Examples
 Restart Apache webserver in two hosts
 ```

diff --git a/runoverssh b/runoverssh
@@ -24,7 +24,6 @@ script_alias=`basename -s .sh "$0"`
 # Print help
 print_help() {
   error "Usage: $script_name [OPTIONS] USERNAME COMMAND HOSTS..."
-  error "Runs a shell command/script over ssh in one or more hosts."
   error "Options:"
   error ""
   error "   -g, --globalpw             Prompt a global password for all connections"

diff --git a/runoverssh.1 b/runoverssh.1
@@ -1,6 +1,6 @@
 .TH RUNOVERSSH 1
 .SH NAME
-runoverssh \- Run a shell command or script over ssh in one or more hosts
+runoverssh \- Run shell commands over ssh
 .SH SYNOPSIS
 .B runoverssh
 [\fBOPTIONS\fR]
@@ -9,7 +9,7 @@ COMMAND
 HOSTS...
 .SH DESCRIPTION
 .B runoverssh
-Run a shell command or script over ssh in one or more hosts
+Run shell commands over ssh
 .SH OPTIONS
 .TP
 .BR \-g ", " \-\-globalpw