Merge pull request #1449 from JanZerebecki/manpage

add Man page for launch.sh and rename to novnc_proxy

6 files changed, 45 insertions, 8 deletions

diff --git a/README.md b/README.md
index 42b5d22..7bcb52a 100644
--- a/README.md
+++ b/README.md
@@ -108,13 +108,13 @@ proxy.
 
 ### Quick Start
 
-* Use the launch script to automatically download and start websockify, which
+* Use the `novnc_proxy` script to automatically download and start websockify, which
   includes a mini-webserver and the WebSockets proxy. The `--vnc` option is
   used to specify the location of a running VNC server:
 
-    `./utils/launch.sh --vnc localhost:5901`
+    `./utils/novnc_proxy --vnc localhost:5901`
 
-* Point your browser to the cut-and-paste URL that is output by the launch
+* Point your browser to the cut-and-paste URL that is output by the `novnc_procy`
   script. Hit the Connect button, enter a password if the VNC server has one
   configured, and enjoy!
 
diff --git a/docs/novnc_proxy.1 b/docs/novnc_proxy.1
new file mode 100644
index 0000000..11a003b
--- /dev/null
+++ b/docs/novnc_proxy.1
@@ -0,0 +1,37 @@
+.TH novnc_proxy 1  "June 25, 2020" "version 1.2.0" "USER COMMANDS"
+
+.SH NAME
+novnc_proxy - noVNC proxy server
+.SH SYNOPSIS
+.B novnc_proxy [--listen PORT] [--vnc VNC_HOST:PORT] [--cert CERT] [--ssl-only]
+
+Starts the WebSockets proxy and a mini-webserver and
+provides a cut-and-paste URL to go to.
+
+    --listen PORT         Port for proxy/webserver to listen on
+                          Default: 6080
+    --vnc VNC_HOST:PORT   VNC server host:port proxy target
+                          Default: localhost:5900
+    --cert CERT           Path to combined cert/key file, or just
+                          the cert file if used with --key
+                          Default: self.pem
+    --key KEY             Path to key file, when not combined with cert
+    --web WEB             Path to web files (e.g. vnc.html)
+                          Default: ./
+    --ssl-only            Disable non-https connections.
+
+    --record FILE         Record traffic to FILE.session.js
+
+    --syslog SERVER       Can be local socket such as /dev/log, or a UDP host:port pair.
+
+    --heartbeat SEC       send a ping to the client every SEC seconds
+    --timeout SEC         after SEC seconds exit when not connected
+    --idle-timeout SEC    server exits after SEC seconds if there are no
+                          active connections
+
+.SH AUTHOR
+The noVNC Authors
+https://github.com/novnc/noVNC
+
+.SH SEE ALSO
+websockify(1), nova-novncproxy(1)
diff --git a/snap/local/svc_wrapper.sh b/snap/local/svc_wrapper.sh
index 7b0be23..77db539 100755
--- a/snap/local/svc_wrapper.sh
+++ b/snap/local/svc_wrapper.sh
@@ -24,6 +24,6 @@ snapctl get services | jq -c '.[]' | while read service; do # for each service t
         echo "novnc: not starting service ${service} with listen_port ${listen_port} and vnc_host_port ${vnc_host_port}"
     else
         # start (and fork with '&') the service using the specified listen port and VNC host:port
-        $SNAP/launch.sh --listen $listen_port --vnc $vnc_host_port &
+        $SNAP/novnc_proxy --listen $listen_port --vnc $vnc_host_port &
     fi
 done
diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml
index b5b26a0..ffba501 100644
--- a/snap/snapcraft.yaml
+++ b/snap/snapcraft.yaml
@@ -16,13 +16,13 @@ parts:
         source: .
         plugin: dump
         organize:
-            utils/launch.sh: /
+            utils/novnc_proxy: /
         stage:
             - vnc.html
             - app
             - core/**/*.js
             - vendor/**/*.js
-            - launch.sh
+            - novnc_proxy
         stage-packages:
             - bash
 
@@ -47,7 +47,7 @@ hooks:
 
 apps:
     novnc:
-        command: ./launch.sh
+        command: ./novnc_proxy
         plugs: [network, network-bind]
     novncsvc:
         command: ./svc_wrapper.sh
diff --git a/utils/README.md b/utils/README.md
index 32582e6..05d75c9 100644
--- a/utils/README.md
+++ b/utils/README.md
@@ -1,6 +1,6 @@
 ## WebSockets Proxy/Bridge
 
-Websockify has been forked out into its own project.  `launch.sh` wil
+Websockify has been forked out into its own project. `novnc_proxy` will
 automatically download it here if it is not already present and not
 installed as system-wide.
 
diff --git a/utils/launch.sh b/utils/novnc_proxy
index 0900f7e..0900f7e 100755
--- a/utils/launch.sh
+++ b/utils/novnc_proxy