aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--sshexec.199
-rw-r--r--sshexec.c2
2 files changed, 100 insertions, 1 deletions
diff --git a/sshexec.1 b/sshexec.1
new file mode 100644
index 0000000..905c656
--- /dev/null
+++ b/sshexec.1
@@ -0,0 +1,99 @@
+.TH SSHEXEC 1 sshexec
+
+.SH NAME
+sshexec - run a command through ssh(1) with normal command syntax
+
+.SH SYNOPSIS
+.B sshexec
+.RB [ {
+.RI [\fBssh=\fP ssh-command ]
+.RI [\fBdir=\fP directory ]
+.BR } ]
+[ssh-option] ...\,
+.I destination
+.I command
+.RI [ argument ]\ ...\,
+
+.SH DESCRIPTION
+TODO
+
+.SH OPTIONS
+TODO
+
+.SH OPERANDS
+TODO
+
+.SH STDIN
+The
+.B sshexec
+utility itself does not use the standard input.
+
+.SH INPUT FILES
+None.
+
+.SH ENVIRONMENT VARIABLES
+The following environment variables affects the execution of
+.BR sshexec :
+.TP
+.SH PATH
+Default. See to the Base Definitions volume of POSIX.1-2017, Section 8.3, Other Environment Variables.
+This environment variable affects where the
+.B sshexec
+utility can find the
+.B ssh
+utility or
+.IR ssh-command .
+
+.SH ASYNCHRONOUS EVENTS
+Default.
+
+.SH STDOUT
+The
+.B sshexec
+utility itself does not use the standard output.
+
+.SH STDERR
+The standard error is used for diagnostic messages in the
+.B sshexec
+utility itself.
+
+.SH OUTPUT FILES
+None.
+
+.SH EXTENDED DESCRIPTION
+None.
+
+.SH EXIT STATUS
+The
+.B sshexec
+utility exits with the exit status of the
+.B ssh
+utility or with 255 if an error occurred.
+
+.SH CONSEQUENCES OF ERRORS
+Default.
+
+.SH APPLICATION USAGE
+None.
+
+.SH EXAMPLES
+None.
+
+.SH RATIONALE
+None.
+
+.SH NOTES
+None.
+
+.SH BUGS
+None.
+
+.SH FUTURE DIRECTIONS
+None.
+
+.SH SEE ALSO
+.BR ssh (1)
+
+.SH AUTHORS
+Mattias Andrée
+.RI < maandree@kth.se >
diff --git a/sshexec.c b/sshexec.c
index b5eae7c..f8eaed6 100644
--- a/sshexec.c
+++ b/sshexec.c
@@ -18,7 +18,7 @@ static const char *argv0 = "sshexec";
static void
usage(void)
{
- exitf("usage: %s { %s } [ssh-option] ... destination command [argument] ...\n",
+ exitf("usage: %s [{ %s }] [ssh-option] ... destination command [argument] ...\n",
argv0, "[ssh=command] [dir=directory]");
}