From 21899d76b350709a06d9ebcb9cb50052e7ebe567 Mon Sep 17 00:00:00 2001 From: Nate Straz Date: Tue, 8 Jul 2008 19:05:33 +0000 Subject: Add man pages for all commands. --- qarsh.1 | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 qarsh.1 (limited to 'qarsh.1') diff --git a/qarsh.1 b/qarsh.1 new file mode 100644 index 0000000..cf3d35a --- /dev/null +++ b/qarsh.1 @@ -0,0 +1,43 @@ +.TH QARSH 1 "8 July 2008" +.SH NAME +qarsh \- Quality Assurance Remote SHell +.SH SYNOPSIS +\fBqarsh\fR [-\fBl \fIuser\fR] [-\fBg \fIgroup\fR] [-\fBp \fIport\fR] [-\fBt \fItimeout\fR] [\fIuser\fR[.\fIgroup\fR]@]\fIhost command\fR +.SH DESCRIPTION +.B Qarsh +is used to execute commands on remote hosts as the specified user in a +test environment. It is intended as a replacement for ssh(1) in trusted +test environments where remote execution as arbitrary users is needed, +but security features like authentication or encryption are not. + +.B Qarsh +transparently passes standard input, standard output, and standard +error. The signals SIGHUP, SIGINT, SIGTERM, SIGUSR1, and SIGUSR2 are +propagated to the remote command. The return status of the remote +command is recreated by \fBqarsh\fR, including death by signal. + +.B Qarsh +talks to btimed(8) to determine if the host is up, down, or has +rebooted. This allows \fBqarsh\fR to exit with an error when a remote +host is not responsive or reboots during the execution of a command. + +.B Qarsh +does support interactive logins. +.SH OPTIONS +.TP +.BI \-g " group" +sets the remote group to \fIgroup\fR. Otherwise the default group of +the remote user will be used. +.TP +.BI \-l " user" +sets the remote user to \fIuser\fR. Otherwise the current local user +will be used. +.TP +.BI \-p " port" +connect to port \fIport\fR instead of the default port of 5008. +.TP +.BI \-t " timeout" +sets the number of seconds to wait when the remote host is not +responding to declare the host dead and exit. +.SH "SEE ALSO" +ssh(1), qacp(1), qarshd(8), btimed(8), btimec(1) -- cgit