summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTzafrir Cohen <tzafrir.cohen@xorcom.com>2010-10-03 21:34:12 +0000
committerTzafrir Cohen <tzafrir.cohen@xorcom.com>2010-10-03 21:34:12 +0000
commit86ea1c16c2b59904d45fab83f5a078949ffd0799 (patch)
treeaf90fab5be6b2517b5d05bc195cef786d4151154
parent82fc0c0babb268db839d1aa8af3db34ee0c8d79d (diff)
Document command-line usage
git-svn-id: svn+ssh://xorcom/home/svn/debs/components/rapid-tunneling@8409 283159da-0705-0410-b60c-f2062b4bb6ad
-rw-r--r--README25
1 files changed, 25 insertions, 0 deletions
diff --git a/README b/README
index b73da4b..14d3682 100644
--- a/README
+++ b/README
@@ -81,6 +81,31 @@ When the client has had enough, the client selects "disconnect" from
the web interface.
+Command-Line Usage
+------------------
+Generating the tarball is as above. On the client side:
+
+ rapid-tunneling path/to/remote-access-clint.tar.gz
+
+This will fork a background demon process to keep the connection alive. As
+this is done in the background you will not get any potential errors. Thus
+you should run:
+
+ rapid-tunneling-status
+
+
+Command Line Usage: Root
+~~~~~~~~~~~~~~~~~~~~~~~~
+If you run this as root, it is preffered that you run the above commands
+as the dedicated tunneling user, to avoid leftovers. That is:
+
+ su -c 'rapid-tunneling path/to/remote-access-clint.tar.gz' rapid-tunneling -
+ su -c 'rapid-tunneling-status' rapid-tunneling -
+
+The '-' in the end is required, to use the home directory of the dedicated
+user.
+
+
Server Operation
----------------
rtadm