rapid-tunneling: man pages for client commands.

git-svn-id: svn+ssh://xorcom/home/svn/debs/components/rapid-tunneling@6823 283159da-0705-0410-b60c-f2062b4bb6ad

1 files changed, 58 insertions, 0 deletions

diff --git a/rapid-tunneling.8 b/rapid-tunneling.8
new file mode 100644
index 0000000..17e2502
--- /dev/null
+++ b/rapid-tunneling.8
@@ -0,0 +1,58 @@
+.TH RAPID-TUNNELING 8 "2009-03-04"
+.SH NAME
+rapid-tunneling \- Initiate a RapidTunneling tunnel
+.SH SYNOPSIS
+.B rapid-tunneling
+.I remote-access-file
+
+.SH DESCRIPTION
+.B rapid-tunneling 
+initiates a tunnel to the server whose details are provided in 
+.I remote-access-file. 
+This parameter is required.
+
+It must be run by the support user, as it relies on status files in the 
+home directory of that user.
+
+This file is a tarball. Its content is described in the README.
+But some technical details anyway:
+
+rapid-tunneling is intended to run as the support user (e.g.: through 
+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).
+
+The private key is sent upon connection to the remote server, which 
+allow the operator of the remote server to connect locally.
+
+.SH OPTIONS
+See description.
+
+.SH FILES
+
+.B /var/lib/rapid-tunneling/home
+.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.
+.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-status (8)
+is used to control 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>