diff options
Diffstat (limited to 'rapid-tunneling-status.8')
| -rw-r--r-- | rapid-tunneling-status.8 | 24 |
1 files changed, 12 insertions, 12 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 |