Resolve "Clarify the meaning -h connection parameter (or rename/split it)"

Author: Nastradamus

README.md

@@ -100,20 +100,19 @@ Cluster `slony` contains two servers - `db1.vpn.local` and `db1.vpn.local`.
 Postgres-checkup automatically detects which one is a master:
 
 ```bash
-./checkup -h db1.vpn.local -p 5432 --username postgres --dbname postgres --project prod1
+./checkup -h db1.vpn.local -p 5432 --username postgres --dbname postgres --project prod1 -e 1
 ```
 
 ```bash
 ./checkup -h db2.vpn.local -p 5432 --username postgres --dbname postgres --project prod1 -e 1
 ```
 
-Which literally means: "connect to the server with given credentials, save data into `prod1`
-project directory as epoch of check `1`. Epoch is a numerical (**integer**) sign of current iteration.
+Which literally means: connect to the server with given credentials, save data into `prod1`
+project directory, as epoch of check `1`. Epoch is a numerical (**integer**) sign of current iteration.
 For example: in half a year we can switch to "epoch number `2`".
 
-At the first run we can skip `-e 1` because default epoch is `1`, but at the second argument `-e`  
-must exist: we don't want to overwrite historical results.
-
+`-h db2.vpn.local` means: try to connect to host via SSH and then use remote `psql` command to perform checks.  
+If SSH is not available the local 'psql' will be used (non-psql reports will be skipped).
 
 As a result of postgres-checkup we have got two directories with .json files and .md files:
 
@@ -128,7 +127,7 @@ all instances of the postgres cluster `prod1`.
 A human-readable report can be found at:
 
 ```bash
-./artifacts/prod1/e1_full_report.md
+./artifacts/prod1/md_reports/1_2018_12_06T14_12_36_+0300/Full_report.md
 ```
 
 Open it with your favorite Markdown files viewer or just upload to a service such as gist.github.com.

checkup

@@ -489,20 +489,21 @@ usage() {
       done
       echo -n " --help" >&${out_descriptor}
       echo    "   this help" >&${out_descriptor}
-      # additional info
-      echo >&${out_descriptor}
-      echo "Example:" >&${out_descriptor}
-      echo "  PGPASSWORD=mypasswd ./${SCRIPT_NAME} -h [ssh_user]@host_to_connect_via_ssh \\"
-      echo "    --username ${USER} --dbname postgres \\"
-      echo "    --project dummy ${BOLD}-e %EPOCH_NUMBER%${RESET}" >&${out_descriptor}
-      echo >&${out_descriptor}
-      echo "You can add more checks into './resources/checks/' directory." >&${out_descriptor}
-      echo >&${out_descriptor}
-      echo "Report bugs to https://gitlab.com/postgres-ai-team/postgres-checkup." >&${out_descriptor}
     fi
     prev_section=${SECTION[$i]}
   done
 
+  # Print example
+  echo >&${out_descriptor}
+  echo "Example:" >&${out_descriptor}
+  echo "  PGPASSWORD=mypasswd ./${SCRIPT_NAME} -h [ssh_user]@host_to_connect_via_ssh \\"
+  echo "    --username ${USER} --dbname postgres \\"
+  echo "    --project dummy ${BOLD}-e %EPOCH_NUMBER%${RESET}" >&${out_descriptor}
+  echo >&${out_descriptor}
+  echo "You can add more checks into './resources/checks/' directory." >&${out_descriptor}
+  echo >&${out_descriptor}
+  echo "Report bugs to https://gitlab.com/postgres-ai-team/postgres-checkup." >&${out_descriptor}
+
   exit $exit_code
 }
 

resources/cli.conf

@@ -7,11 +7,11 @@
 #
 # please put items in order by section
 
+Connection options|h|hostname|HOST|text|mandatory|connect to host via SSH and then use 'psql' installed on that server OR the local 'psql' will be used
 Connection options|p|port|PGPORT|number|optional|PostgreSQL database server port (default: "5432")
 Connection options|d|dbname|DBNAME|word|optional|database name to connect to (default: "postgres")
 Connection options|None|ss-dbname|SSDBNAME|word|optional|database name with enabled 'pg_stat_statements' extension (for Kxxx checks)
 Connection options|U|username|USERNAME|word|optional|database user name (default: psql's default if not given)
-Connection options|h|hostname|HOST|text|mandatory|database and ssh server host
 Connection options|s|pg-socket-dir|PGSOCKET|text|optional|PostgreSQL domain socket dir (default: psql's default)
 Connection options|None|psql-binary|PSQLBINARY|text|optional|psql utility path (default: from $PATH)
 Connection options|S|statement-timeout|STIMEOUT|number|optional|statement timeout for sql commands (default: 15 seconds)