diff --git a/CHANGELOG b/CHANGELOG index 611e9a9..72aa347 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,14 @@ +3.0.1: + +- Updated documentation + +3.0: + +- POSIX compliance +- No longer uses sshpass by default +- Added --shell option +- Added --verbose option + 2.2: - added option to pass arguments to the script file (ex: --script "test.sh" --args "arg1 arg2") diff --git a/README.md b/README.md index 5f01511..389b12b 100644 --- a/README.md +++ b/README.md @@ -37,13 +37,13 @@ See the `-g` flag. 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 Arguments (in a single string) to be passed to + -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 Remote shell to be used. Supported values: + --shell SHELL Remote shell to be used. Supported values: sh, bash default: bash --shellflags FLAGS Remote shell flags diff --git a/runoverssh b/runoverssh index a8dd678..02f0a86 100755 --- a/runoverssh +++ b/runoverssh @@ -32,13 +32,13 @@ print_help() { error " the default COMMAND argument" error " -r, --hostsfile FILE Read the list of hosts from a file (one host" error " per line), disables the default HOSTS argument" - error " -a, --args Arguments (in a single string) to be passed to" + error " -a, --args ARGS Arguments (in a single string) to be passed to" error " the script file." error " -q, --quiet Disable all screen output, except for password" error " prompts. If logfile is set, output is written" error " there" error " -v, --verbose Print verbose messages" - error " --shell Remote shell to be used. Supported values:" + error " --shell SHELL Remote shell to be used. Supported values:" error " sh, bash" error " default: bash" error " --shellflags FLAGS Remote shell flags" diff --git a/runoverssh.1 b/runoverssh.1 index 7dc4ebb..2463e4c 100644 --- a/runoverssh.1 +++ b/runoverssh.1 @@ -1,6 +1,6 @@ .TH RUNOVERSSH 1 .SH NAME -runoverssh \- Runs a Bash command/script over ssh in one or more hosts +runoverssh \- Run a shell command or script over ssh in one or more hosts .SH SYNOPSIS .B runoverssh [\fBOPTIONS\fR] @@ -9,49 +9,53 @@ COMMAND HOSTS... .SH DESCRIPTION .B runoverssh -This program runs a Bash command/script over ssh in one or more hosts. +Run a shell command or script over ssh in one or more hosts .SH OPTIONS .TP .BR \-g ", " \-\-globalpw -ask one global password for all connections +Prompt a global password for all connections .TP .BR \-s ", " \-\-script " " [file] -read commands from a script file instead +Read commands from a script file, disables the default COMMAND argument .TP .BR \-r ", " \-\-hostsfile " " [file] -use the list of hosts from a file (one host per line) +Read the list of hosts from a file (one host per line), disables the default HOSTS argument .TP -.BR \-n ", " \-\-nopw " " [file] -no password (use ssh directly instead of sshpass) +.BR \-a ", " \-\-args " " [args] +Arguments (in a single string) to be passed to the script file. .TP -.BR \-a ", " \-\-args " " [args] -specify the arguments to be passed to the script file +.BR \-q ", " \-\-quiet " " +Disable all screen output, except for password prompts. If logfile is set, output is written there .TP -.BR \-l ", " \-\-log -save ssh output (default: runoverssh.log) (append) +.BR \-v ", " \-\-verbose " " +Print verbose messages .TP -.BR \-q ", " \-\-quiet " " [file] -disable ssh screen output +.BR \-\-shell " " [shell] +Remote shell to be used. +Supported values: sh, bash. +Default: bash .TP -.BR \-\-bashflags " " [flags] -set custom bash flags. -default: '-l' +.BR \-\-shellflags " " [shellflags] +Remote shell flags. +Default: '' .TP -.BR \-\-sshflags " " [flags] -set custom ssh flags. -default: '-o ConnectTimeout=5 -o StrictHostKeyChecking=no' +.BR \-\-sshflags " " [shellflags] +Local SSH flags. +Default: -o ConnectTimeout=5 + -o StrictHostKeyChecking=no + -o UserKnownHostsFile=/dev/null .TP .BR \-\-logfile " " [file] -save ssh output to a custom file (append) +Append SSH output to a file .SH AUTHOR runoverssh was written by Yuri Escalianti.