novnc/novnc-0.3-manpage.patch

85 lines
2.2 KiB
Diff

From 42d5fa61a47fb156bf4e6bea7051c9198f8fb938 Mon Sep 17 00:00:00 2001
From: Adam Young <ayoung@redhat.com>
Date: Fri, 8 Jun 2012 10:34:38 -0400
Subject: [PATCH] added Man pages.
---
docs/nova-novncproxy.1 | 35 +++++++++++++++++++++++++++++++++++
docs/novnc_server.1 | 22 ++++++++++++++++++++++
2 files changed, 57 insertions(+)
create mode 100644 docs/nova-novncproxy.1
create mode 100644 docs/novnc_server.1
diff --git a/docs/nova-novncproxy.1 b/docs/nova-novncproxy.1
new file mode 100644
index 0000000..198b634
--- /dev/null
+++ b/docs/nova-novncproxy.1
@@ -0,0 +1,35 @@
+.TH nova-novncproxy 1 "June 8, 2012" "version 0.3" "USER COMMANDS"
+
+.SH NAME
+nova-novncproxy | noVNC proxy for Openstack Nova
+.SH SYNOPSIS
+.B nova-novncproxy [options]
+
+.SH OPTIONS
+.TP
+record : Record sessions to FILE.[session_number]
+.TP
+daemon : Become a daemon (background process)
+.TP
+ssl_only : Disallow non-encrypted connections'),
+.TP
+source_is_ipv6 : Source is ipv6
+.TP
+cert : SSL certificate file
+.TP
+key : SSL key file (if separate from cert)
+.TP
+web : Run webserver on same port. Serve files from DIR.
+.TP
+novncproxy_host : Host on which to listen for incoming requests.
+ defaults to ='0.0.0.0'
+.TP
+novncproxy_port: Port on which to listen for incoming requests
+ defaults to 6080
+
+
+.SH AUTHOR
+Joel Martin (github@martintribe.org)
+
+.SH SEE ALSO
+websockify(1)
diff --git a/docs/novnc_server.1 b/docs/novnc_server.1
new file mode 100644
index 0000000..5bcbd1b
--- /dev/null
+++ b/docs/novnc_server.1
@@ -0,0 +1,22 @@
+.TH novnc_server 1 "June 8, 2012" "version 0.3" "USER COMMANDS"
+
+.SH NAME
+novnc_server | noVNC proxy server
+.SH SYNOPSIS
+.B novnc_server [--listen PORT] [--vnc VNC_HOST:PORT] [--cert CERT]
+
+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
+ Default: self.pem
+
+.SH AUTHOR
+Joel Martin (github@martintribe.org)
+
+.SH SEE ALSO
+websockify(1)
--
1.7.10.2