VNC: instructions

1 files changed, 28 insertions, 2 deletions

diff --git a/vnc b/vnc
index 2b190f7..94ce3d6 100755
--- a/vnc
+++ b/vnc
@@ -15,13 +15,39 @@ REMOTEPORT="${3:-5901}"
 # This is probably a bug on xtigervncviewer
 VIEWER_OPTS="-AcceptClipboard=off -SendClipboard=off -SetPrimary=off -SendPrimary=off"
 
+function usage {
+  echo "usage: $BASENAME <server> [localport] [remoteport]"
+  cat <<EOF
+
+setup instructions
+==================
+
+* in the remote:
+
+  sudo apt install tigervnc-standalone-server # install in the remote server
+  vncpasswd                                   # generate a ~/.vnc/passwd in the remote server
+
+* in the local box:
+
+  scp <server>:~/.vnc/passwd ~/.vnc/<server>.passwd # copy the secret
+  $BASENAME <server>                                      # use our magic script to do everything else
+
+EOF
+
+  exit 1
+}
+
+# Usage
+if [ "$1" == "--help" ]; then
+  usage
+fi
+
 # Check
 if [ -z "$SERVER" ]; then
   if [ -h "$HOME/.vnc/default.passwd" ]; then
     SERVER="$(basename `readlink $HOME/.vnc/default.passwd` .passwd)"
   else
-    echo "usage: $BASENAME <server> [localport] [remoteport]"
-    exit 1
+    usage
   fi
 fi