diff options
| -rw-r--r-- | rapid-tunneling-status.8 | 24 | ||||
| -rw-r--r-- | rapid-tunneling.8 | 26 |
2 files changed, 27 insertions, 23 deletions
diff --git a/rapid-tunneling-status.8 b/rapid-tunneling-status.8 index d83e8ed..009d88c 100644 --- a/rapid-tunneling-status.8 +++ b/rapid-tunneling-status.8 @@ -1,13 +1,13 @@ -.TH RAPID-TUNNELING-STATUS 8 "2009-03-04" +.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>] +.I [\-p] [\-s] [<pid-file>] - show and/or kill a running connection. .B rapid-tunneling-status -.I --help +.I \-\-help - Just prints a help message .SH DESCRIPTION @@ -21,13 +21,13 @@ 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 +.B \-s .RS Terminate a running connection. If this option is not provided, the status of the connection will be reported. .RE -.B -p +.B \-p .RS If a process is running, print its PID rather than "Connected". Return status remains the same. @@ -36,7 +36,7 @@ status remains the same. .B pid-file .RS A file in which to check the PID of the running ssh process. Defaults to -/var/lib/rapid-tunneling/home/pid +$HOME/.rapid-tunneling/pid .RE .SH RETURN STATUS @@ -58,20 +58,20 @@ Returnd if no running connection is found. .RE .SH FILES -.B /var/lib/rapid-tunneling/home +.B $HOME/.rapid\-tunneling/pid .RS -Home directory of the client support user. Used for status and temporary -files. Anything there can be deleted when there's no running connection. +PID of the potentially currently running process. Set by rapid\-tunneling . +That directory may include several other files. .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) +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-status (8) -is used to control the connection. +.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 diff --git a/rapid-tunneling.8 b/rapid-tunneling.8 index b3463b8..f73b312 100644 --- a/rapid-tunneling.8 +++ b/rapid-tunneling.8 @@ -1,4 +1,4 @@ -.TH RAPID-TUNNELING 8 "2010-10-06" +.TH RAPID-TUNNELING 8 "2011-06-14" .SH NAME rapid-tunneling \- Initiate a RapidTunneling tunnel .SH SYNOPSIS @@ -22,7 +22,7 @@ sudo). It will generate a new temporary private key that is allowed to connect to the support user. Next it will daemonize and connect to the remote support server. The daemonized ssh process (if connected) keeps the tunnel running. It also makes port 22 of the local system available -to the remote system (through ssh -R). +to the remote system (through ssh \-R). The private key is sent upon connection to the remote server, which allow the operator of the remote server to connect locally. @@ -31,42 +31,43 @@ allow the operator of the remote server to connect locally. The following options allow you to override settings from the tarball with your own. -.B -D +.B \-D .RS Stay in the background and don't daemonize. Useful when running under a monitor process (upstart, systemd) or for debugging. .RE -.B -h \fIhost\fR +.B \-h \fIhost\fR .RS Overide the SSH host name of the server. .RE -.B -p \fIport\fR +.B \-p \fIport\fR .RS Overide the SSH port number of the server. .RE -.B -u \fIuser\fR +.B \-u \fIuser\fR .RS Overide the SSH username to use. Normally should not be needed. .RE .SH FILES -.B /var/lib/rapid-tunneling/home +.B $HOME/.rapid-tunneling/pid .RS -Home directory of the client support user. Used for status and temporary -files. Anything there can be deleted when there's no running connection. +PID of the potentially currently running process. Used by +rapid\-tunneling\-status to check for it. That directory may include +several other files. .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) +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-status (8) +.BR rapid\-tunneling\-status (8) is used to control the connection. .SH BUGS @@ -74,6 +75,9 @@ 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. +Also, in order to simplify the implementation, we currently only allow a +single tunnel per-user. Shouldn't be too much of a problem to fix. + .SH AUTHOR RapidTunneling was written by Alex Landau <alex.landau@xorcom.com>. |