1From ce84087f50788d895b1335bcf1c9e6d3b47e7846 Mon Sep 17 00:00:00 2001
2From: Philipp Zabel <p.zabel@pengutronix.de>
3Date: Fri, 30 Sep 2022 12:04:15 +0200
4Subject: [PATCH 85/93] man: add a man page for the VNC backend
5
6Add a new weston-vnc man page, based on the weston-rdp man page.
7Also add links in the main weston man page.
8
9Signed-off-by: Philipp Zabel <p.zabel@pengutronix.de>
10(cherry picked from commit ad936f1de89ab7306455785fc0f9ebcba2380e1d)
11Signed-off-by: Jeffy Chen <jeffy.chen@rock-chips.com>
12---
13 man/meson.build    |  9 ++++++++
14 man/weston-vnc.man | 57 ++++++++++++++++++++++++++++++++++++++++++++++
15 man/weston.man     | 12 ++++++++++
16 3 files changed, 78 insertions(+)
17 create mode 100644 man/weston-vnc.man
18
19diff --git a/man/meson.build b/man/meson.build
20index a2b8edc..5d3b8d8 100644
21--- a/man/meson.build
22+++ b/man/meson.build
23@@ -53,3 +53,12 @@ if get_option('backend-rdp')
24 		configuration: man_conf
25 	)
26 endif
27+
28+if get_option('backend-vnc')
29+	configure_file(
30+		input: 'weston-vnc.man',
31+		output: 'weston-vnc.7',
32+		install_dir: join_paths(dir_man, 'man7'),
33+		configuration: man_conf
34+	)
35+endif
36diff --git a/man/weston-vnc.man b/man/weston-vnc.man
37new file mode 100644
38index 0000000..6491097
39--- /dev/null
40+++ b/man/weston-vnc.man
41@@ -0,0 +1,57 @@
42+.TH WESTON-RDP 7 "2017-12-14" "Weston @version@"
43+.SH NAME
44+weston-vnc \- the VNC backend for Weston
45+.SH SYNOPSIS
46+.B weston --backend=vnc-backend.so
47+.
48+.\" ***************************************************************
49+.SH DESCRIPTION
50+The VNC backend allows to run a
51+.B weston
52+environment without the need of specific graphic hardware, or input devices. Users can interact with
53+.B weston
54+only by connecting using the remote framebuffer protocol (RFB).
55+
56+The VNC backend uses Neat VNC to implement the VNC part, it acts as a VNC server
57+listening for incoming connections. It supports different encodings for encoding
58+the graphical content, depending on what is supported by the VNC client.
59+
60+The VNC backend is not multi-seat aware, so if a second client connects to the
61+backend, the first client will be disconnected.
62+
63+Note that authentication and encryption are not supported yet. Anyone with
64+access to the port can get control of the desktop via the VNC output, and
65+all data is transferred in plaintext.
66+
67+.\" ***************************************************************
68+.SH CONFIGURATION
69+.
70+The VNC backend uses the following entries from
71+.BR weston.ini .
72+.SS Section vnc
73+.TP
74+\fBrefresh-rate\fR=\fIrate\fR
75+Specifies the desktop redraw rate in Hz. If unspecified, the default is 60Hz. Changing
76+this may be useful if you have a faster than 60Hz display, or if you want to reduce updates to
77+reduce network traffic.
78+
79+.\" ***************************************************************
80+.SH OPTIONS
81+.
82+When the VNC backend is loaded,
83+.B weston
84+will understand the following additional command line options.
85+.TP
86+.B \-\-width\fR=\fIwidth\fR
87+The width of the framebuffer. It defaults to 640.
88+.TP
89+.B \-\-height\fR=\fIheight\fR
90+The height of the framebuffer. It defaults to 480.
91+.TP
92+\fB\-\-port\fR=\fIport\fR
93+The TCP port to listen on for connections. It defaults to 5900.
94+
95+.\" ***************************************************************
96+.SH "SEE ALSO"
97+.BR weston (1)
98+.\".BR weston.ini (5)
99diff --git a/man/weston.man b/man/weston.man
100index 654c0da..0c6e5c5 100644
101--- a/man/weston.man
102+++ b/man/weston.man
103@@ -45,6 +45,13 @@ to the desktop is done by using the RDP protocol. Each connecting
104 client has its own seat making it a cheap way to test multi-seat support. See
105 .BR weston-rdp (7),
106 if installed.
107+.TP
108+.I vnc-backend.so
109+The VNC backend runs in memory without the need of graphical hardware. Access
110+to the desktop is done by using the RFB protocol. Currently only one
111+connecting client is supported. See
112+.BR weston-vnc (7),
113+if installed.
114 .
115 .\" ***************************************************************
116 .SH SHELLS
117@@ -264,6 +271,10 @@ pixman library for software compsiting.
118 See
119 .BR weston-rdp (7).
120 .
121+.SS VNC backend options:
122+See
123+.BR weston-vnc (7).
124+.
125 .
126 .\" ***************************************************************
127 .SH FILES
128@@ -367,4 +378,5 @@ weston
129 .BR weston-debug (1),
130 .BR weston-drm (7),
131 .BR weston-rdp (7),
132+.BR weston-vnc (7),
133 .BR weston.ini (5)
134--
1352.20.1
136
137