From 86ea1c16c2b59904d45fab83f5a078949ffd0799 Mon Sep 17 00:00:00 2001 From: Tzafrir Cohen Date: Sun, 3 Oct 2010 21:34:12 +0000 Subject: Document command-line usage git-svn-id: svn+ssh://xorcom/home/svn/debs/components/rapid-tunneling@8409 283159da-0705-0410-b60c-f2062b4bb6ad --- README | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) 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 -- cgit v1.2.3