1wayvnc(1) General Commands Manual wayvnc(1)
2
6 wayvnc - A VNC server for wlroots based Wayland compositors.
7
9 wayvnc [options] [address [port]]
10
12 -C, --config=<path>
13 Select a config file.
14 -o, --output=<name>
16 Select output to capture.
17 -k, --keyboard=<layout>[-variant]
19 Select keyboard layout. The variant can be appended if needed.
20 -s, --seat=<name>
22 Select seat by name.
23 -r, --render-cursor
25 Enable overlay cursor rendering.
26 -f, --max-fps=<fps>
28 Set the rate limit (default 30).
29 -p, --show-performance
31 Show performance counters.
32 -u, --unix-socket
34 Create a UNIX domain socket instead of TCP, treating the address as
35 a path.
36 -d, --disable-input
38 Disable all remote input. This allows using wayvnc without composi‐
39 tor support of virtual mouse / keyboard protocols.
40 -V, --version
42 Show version info.
43 -h, --help
45 Get help.
46
48 This is a VNC server for wlroots based Wayland compositors. It attaches
49 to a running Wayland session, creates virtual input devices and exposes
50 a single display via the RFB protocol. The Wayland session may be a
51 headless one, so it is also possible to run wayvnc without a physical
52 display attached.
53
55 wayvnc searches for a config file in the location
56 ~/$XDG_CONFIG_HOME/wayvnc/config
57 or if $XDG_CONFIG_HOME is not set
58 ~/.config/wayvnc/config
59 SYNTAX
61 The configuration file is composed of key-value pairs separated with an
62 equal sign. Whitespace around either the key or the value is insignifi‐
63 cant and is not considered to be part of the key or the value.
64 KEYWORDS
66 address
67 The address to which the server shall bind, e.g. 0.0.0.0 or local‐
68 host.
69 certificate_file
71 The path to the certificate file for encryption. Only applicable
72 when enable_auth=true.
73 enable_auth
75 Enable authentication and encryption. Setting this value to true
76 requires also setting certificate_file, private_key_file, username
77 and password.
78 password
80 Choose a password for authentication.
81 port
83 The port to which the server shall bind. Default is 5900.
84 private_key_file
86 The path to the private key file for encryption. Only applicable
87 when enable_auth=true.
88 username
90 Choose a username for authentication.
91 xkb_layout
93 The keyboard layout to use for key code lookup.
94 Default: XKB_DEFAULT_LAYOUT or system default.
96 xkb_model
98 The keyboard model by which to interpret keycodes and LEDs.
99 Default: "pc105"
101 xkb_options
103 A comma separated list of options, through which the user specifies
104 non-layout related preferences such as which key is the Compose
105 key.
106 Default: XKB_DEFAULT_OPTIONS or system default.
108 xkb_rules
110 The rules file describes how to interpret the values of the model,
111 layout, variant and options fields.
112 Default: XKB_DEFAULT_RULES or system default.
114 xkb_variant
116 The keyboard variant to use for keycode lookup.
117 Default: XKB_DEFAULT_VARIANT or system default.
119 EXAMPLE
121 address=0.0.0.0
122 enable_auth=true
123 username=luser
124 password=p455w0rd
125 private_key_file=/path/to/key.pem
126 certificate_file=/path/to/cert.pem
127
129 The following environment variables have an effect on wayvnc:
130 WAYLAND_DISPLAY
132 Specifies the name of the Wayland display that the compositor to
133 which wayvnc shall bind is running on.
134 XDG_CONFIG_HOME
136 Specifies the location of configuration files.
137
139 How can I run wayvnc in headless mode/over an SSH session?
140 Set the environment variables WLR_BACKENDS=headless and WLR_LIBIN‐
142 PUT_NO_DEVICES=1 before starting the compositor, then run wayvnc as
143 normal.
144 How can I pass my mod-key from Sway to the remote desktop session?
146 Create an almost empty mode in your sway config. Example:
148 mode passthrough {
149 bindsym $mod+Pause mode default
150 }
151 bindsym $mod+Pause mode passthrough
152 This makes it so that when you press $mod+Pause, all keybindings,
153 except the one to switch back, are disabled.
154 Not all symbols show up when I'm typing. What can I do to fix this?
156 Try setting the keyboard layout in wayvnc to the one that most
158 closely matches the keyboard layout that you're using on the client
159 side. An exact layout isn't needed, just one that has all the sym‐
160 bols that you use.
161 How do I enable the Compose key?
163 Set "xkb_options=compose:menu" in the config file. Any key that is
165 not otherwise used will work. There just needs to be some key for
166 wayvnc to match against.
167
169 Maintained by Andri Yngvason <andri@yngvason.is>. Up-to-date sources
170 can be found at https://github.com/any1/wayvnc and bugs reports or
171 patches can be submitted to GitHub's issue tracker.
172 2022-07-10 wayvnc(1)