1wayvnc(1)                   General Commands Manual                  wayvnc(1)
2
3
4

NAME

6       wayvnc - A VNC server for wlroots based Wayland compositors.
7

SYNOPSIS

9       wayvnc [options] [address [port]]
10

OPTIONS

12       -C, --config=<path>
13           Select a config file.
14
15       -o, --output=<name>
16           Select output to capture.
17
18       -k, --keyboard=<layout>[-variant]
19           Select keyboard layout. The variant can be appended if needed.
20
21       -s, --seat=<name>
22           Select seat by name.
23
24       -r, --render-cursor
25           Enable overlay cursor rendering.
26
27       -f, --max-fps=<fps>
28           Set the rate limit (default 30).
29
30       -p, --show-performance
31           Show performance counters.
32
33       -V, --version
34           Show version info.
35
36       -h, --help
37           Get help.
38

DESCRIPTION

40       This is a VNC server for wlroots based Wayland compositors. It attaches
41       to a running Wayland session, creates virtual input devices and exposes
42       a single display via the RFB protocol. The Wayland session may be a
43       headless one, so it is also possible to run wayvnc without a physical
44       display attached.
45

CONFIGURATION

47       wayvnc searches for a config file in the location
48           ~/$XDG_CONFIG_HOME/wayvnc/config
49       or if $XDG_CONFIG_HOME is not set
50           ~/.config/wayvnc/config
51
52   SYNTAX
53       The configuration file is composed of key-value pairs separated with an
54       equal sign. Whitespace around either the key or the value is insignifi‐
55       cant and is not considered to be part of the key or the value.
56
57   KEYWORDS
58       address
59           The address to which the server shall bind, e.g. 0.0.0.0 or local‐
60           host.
61
62       certificate_file
63           The path to the certificate file for encryption. Only applicable
64           when enable_auth=true.
65
66       enable_auth
67           Enable authentication and encryption. Setting this value to true
68           requires also setting certificate_file, private_key_file, username
69           and password.
70
71       password
72           Choose a password for authentication.
73
74       port
75           The port to which the server shall bind. Default is 5900.
76
77       private_key_file
78           The path to the private key file for encryption. Only applicable
79           when enable_auth=true.
80
81       username
82           Choose a username for authentication.
83
84       xkb_layout
85           The keyboard layout to use for key code lookup.
86
87           Default: XKB_DEFAULT_LAYOUT or system default.
88
89       xkb_model
90           The keyboard model by which to interpret keycodes and LEDs.
91
92           Default: "pc105"
93
94       xkb_options
95           A comma separated list of options, through which the user specifies
96           non-layout related preferences such as which key is the Compose
97           key.
98
99           Default: XKB_DEFAULT_OPTIONS or system default.
100
101       xkb_rules
102           The rules file describes how to interpret the values of the model,
103           layout, variant and options fields.
104
105           Default: XKB_DEFAULT_RULES or system default.
106
107       xkb_variant
108           The keyboard variant to use for keycode lookup.
109
110           Default: XKB_DEFAULT_VARIANT or system default.
111
112   EXAMPLE
113           address=0.0.0.0
114           enable_auth=true
115           username=luser
116           password=p455w0rd
117           private_key_file=/path/to/key.pem
118           certificate_file=/path/to/cert.pem
119

ENVIRONMENT

121       The following environment variables have an effect on wayvnc:
122
123       WAYLAND_DISPLAY
124           Specifies the name of the Wayland display that the compositor to
125           which wayvnc shall bind is running on.
126
127       XDG_CONFIG_HOME
128           Specifies the location of configuration files.
129

FAQ

131       How can I run wayvnc in headless mode/over an SSH session?
132
133           Set the environment variables WLR_BACKENDS=headless and WLR_LIBIN‐
134           PUT_NO_DEVICES=1 before starting the compositor, then run wayvnc as
135           normal.
136
137       How can I pass my mod-key from Sway to the remote desktop session?
138
139           Create an almost empty mode in your sway config. Example:
140               mode passthrough {
141                    bindsym $mod+Pause mode default
142               }
143               bindsym $mod+Pause mode passthrough
144           This makes it so that when you press $mod+Pause, all keybindings,
145           except the one to switch back, are disabled.
146
147       Not all symbols show up when I'm typing. What can I do to fix this?
148
149           Try setting the keyboard layout in wayvnc to the one that most
150           closely matches the keyboard layout that you're using on the client
151           side. An exact layout isn't needed, just one that has all the sym‐
152           bols that you use.
153
154       How do I enable the Compose key?
155
156           Set "xkb_options=compose:menu" in the config file. Any key that is
157           not otherwise used will work. There just needs to be some key for
158           wayvnc to match against.
159

AUTHORS

161       Maintained by Andri Yngvason <andri@yngvason.is>. Up-to-date sources
162       can be found at https://github.com/any1/wayvnc and bugs reports or
163       patches can be submitted to GitHub's issue tracker.
164
165
166
167                                  2021-01-04                         wayvnc(1)