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. --- btimec.1 | 17 +++++++++++++++++ btimed.8 | 14 ++++++++++++++ qacp.1 | 28 ++++++++++++++++++++++++++++ qarsh.1 | 43 +++++++++++++++++++++++++++++++++++++++++++ qarshd.8 | 25 +++++++++++++++++++++++++ 5 files changed, 127 insertions(+) create mode 100644 btimec.1 create mode 100644 btimed.8 create mode 100644 qacp.1 create mode 100644 qarsh.1 create mode 100644 qarshd.8 diff --git a/btimec.1 b/btimec.1 new file mode 100644 index 0000000..1e67389 --- /dev/null +++ b/btimec.1 @@ -0,0 +1,17 @@ +.TH BTIMEC 1 "8 July 2008" +.SH NAME +btimec \- Get the boot time of a host from btimed(8). +.SH SYNOPSIS +\fBbtimec\fR [-\fBr\fR] \fIhost\fR [\fIhost\fR ...] +.SH DESCRIPTION +.B Btimec +connects to btimed(8) on the specified \fIhost\fR to determine the time the +host booted. The name of the host and time in seconds is printed to standard +output. If multiple hosts are listed, the value for each host is printed on a +separate line. +.SH OPTIONS +.TP +.B \-r +Print the boot time in a human readable form. +.SH "SEE ALSO" +btimed(8), qarsh(1) diff --git a/btimed.8 b/btimed.8 new file mode 100644 index 0000000..d30b9ee --- /dev/null +++ b/btimed.8 @@ -0,0 +1,14 @@ +.TH BTIMED 8 "8 July 2008" +.SH NAME +btimed \- Boot Time Daemon +.SH SYNOPSIS +.B btimed +.SH DESCRIPTION +.B Btimed +calculates the time the system was booted and provides it to client +applications qarsh(1) and btimec(1). + +.B Btimed +normally runs as a services of inetd. +.SH "SEE ALSO" +qarsh(1), btimec(1), qarshd(8) diff --git a/qacp.1 b/qacp.1 new file mode 100644 index 0000000..4fe27c2 --- /dev/null +++ b/qacp.1 @@ -0,0 +1,28 @@ +.TH QACP 1 "8 July 2008" +.SH NAME +qacp \- Quality Assurance Remote Copy +.SH SYNOPSIS +\fBqacp\fR [-\fBq\fR] \fIlocalpath...\fR [\fIuser\fR@]\fIhost\fR:\fIremotepath\fR +.br +\fBqacp\fR [-\fBq\fR] [\fIuser\fR@]\fIhost\fR:\fIremotepath...\fR \fIlocalpath\fR +.SH DESCRIPTION +.B Qacp +copies files between the remote host and the local host using qarshd(8). +It provides the same lack of security and authentication as qarsh(1). + +.B Qacp +does not support recursive operations. For copying directory structures +we recommend piping tar through qarsh(1) or using rsync(1). +.SH OPTIONS +.TP +.B \-q +Don't print out each file name as files are copied. +.SH EXAMPLES +.TP +Copying files to a remote host. +# qacp /tmp/somefile root@testhost:/tmp +.TP +Copying directory structures +# rsync -r -e qarsh /tmp/testsuite root@testhost:/tmp +.SH "SEE ALSO" +scp(1), rsync(1), qarsh(1), qarshd(8), btimed(8), btimec(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) diff --git a/qarshd.8 b/qarshd.8 new file mode 100644 index 0000000..5688363 --- /dev/null +++ b/qarshd.8 @@ -0,0 +1,25 @@ +.TH QARSHD 8 "8 July 2008" +.SH NAME +qarshd \- Quality Assurance Remote SHell Daemon +.SH SYNOPSIS +\fBqarshd\fR [-\fBd] +.SH DESCRIPTION +.B Qarshd +is the server process for qarsh(1) and qacp(1). It provides remote +access to execute commands as any user. All connections and commands +are logged in syslog. + +.B Qarshd +is normally started through inetd. It is not designed to run as a +stand alone server. +.SH WARNING +.B THIS DAEMON PROVIDES A METHOD FOR ANYONE TO EXECUTE ANY COMMAND AS +ANY USER, INCLUDING ROOT. DO NOT INSTALL IT ON ANY SYSTEMS ON AN +UNTRUSTED NETWORK. ESPECIALLY NOT PRODUCTION OR INTERNET FACING +SYSTEMS. +.SH OPTIONS +.TP +.B \-d +Turn on extra debug logging. +.SH "SEE ALSO" +qarsh(1), qacp(1), btimed(8), btimec(1) -- cgit