.TH RAPID-TUNNELING-STATUS 8 "2011-06-14"
.SH NAME
rapid-tunneling-status \- Monitor a RapidTunneling tunnel
.SH SYNOPSIS
.B rapid-tunneling-status
.I [\-p] [\-s] [<pid-file>]
- show and/or kill a running connection.

.I \-r [<pid-file>]
- Remove left-over entries from .ssh/authorized_keys

.B rapid-tunneling-status
.I \-\-help
- Just prints a help message

.SH DESCRIPTION
.B rapid-tunneling-status
checks if a RapidTunneling connection is running and returns its status.

It can optionally print the PID of the ssh process that maintains the 
tunnel or kill it and thus disconnect the tunnel.

It must be run by the support user, as it relies on status files in the 
home directory of that user.

.SH OPTIONS
.B \-s
.RS
Terminate a running connection. If this option is not provided, the 
status of the connection will be reported. Also deletes the entry from
the authorized_keys file.
.RE

.B \-p
.RS
If a process is running, print its PID rather than "Connected". Return 
status remains the same.
.RE

.B \-r
.RS
Remove any entries for rapid-runneling if the connection is no longer
active.
.RE

.B pid-file
.RS
A file in which to check the PID of the running ssh process. Defaults to
$HOME/.rapid-tunneling/pid
.RE

.SH RETURN STATUS
.B 0
.RS
Returned if a process was found and is connected or if it was running 
and has been killed.
.RE

.B 1
.RS
Returned if there is an ssh process running and attempting to establish
a tunnel.
.RE

.B 2
.RS
Returnd if no running connection is found.
.RE

.SH FILES
.B $HOME/.rapid\-tunneling/pid
.RS
PID of the potentially currently running process. Set by rapid\-tunneling .
That directory may include several other files.
.RE

.B $HOME/.ssh/authorized_keys
.RS
The entry added there by rapid\-tunneling is removed at disconnect (\-s)
time.
.RE

.SH SEE ALSO
Full description of the operation is provided in the README file, which 
may be /usr/share/doc/rapid\-runneling/README.gz (Debian) 
/usr/share/doc/rapid-tunneling-1.*/README (RedHat and similar) or 
similar locations on binary packages.

.BR rapid\-tunneling (8)
is used to set up the connection.

.SH BUGS
Before running rapid-tunneling, better be sure that the remote-access-file 
comes indeed from a trusted source. Recall that once you initiate a tunnel,
the operator at the remote side can log into your system.

.SH AUTHOR
RapidTunneling was written by Alex Landau <alex.landau@xorcom.com>.

This manual page was written by Tzafrir Cohen <tzafrir.cohen@xorcom.com>