table of contents
wayvnc(1) | General Commands Manual | wayvnc(1) |
NAME¶
wayvnc - A VNC server for wlroots based Wayland compositors.
SYNOPSIS¶
wayvnc [options] [address [port]]
OPTIONS¶
-C, --config=<path>
-o, --output=<name>
-k, --keyboard=<layout>[-variant]
-s, --seat=<name>
-r, --render-cursor
-f, --max-fps=<fps>
-p, --show-performance
-u, --unix-socket
-d, --disable-input
-V, --version
-h, --help
DESCRIPTION¶
This is a VNC server for wlroots based Wayland compositors. It attaches to a running Wayland session, creates virtual input devices and exposes a single display via the RFB protocol. The Wayland session may be a headless one, so it is also possible to run wayvnc without a physical display attached.
CONFIGURATION¶
wayvnc searches for a config file in the location
SYNTAX¶
The configuration file is composed of key-value pairs separated with an equal sign. Whitespace around either the key or the value is insignificant and is not considered to be part of the key or the value.
KEYWORDS¶
address
certificate_file
enable_auth
password
port
private_key_file
username
xkb_layout
Default: XKB_DEFAULT_LAYOUT or system default.
xkb_model
Default: "pc105"
xkb_options
Default: XKB_DEFAULT_OPTIONS or system default.
xkb_rules
Default: XKB_DEFAULT_RULES or system default.
xkb_variant
Default: XKB_DEFAULT_VARIANT or system default.
EXAMPLE¶
address=0.0.0.0 enable_auth=true username=luser password=p455w0rd private_key_file=/path/to/key.pem certificate_file=/path/to/cert.pem
ENVIRONMENT¶
The following environment variables have an effect on wayvnc:
WAYLAND_DISPLAY
XDG_CONFIG_HOME
FAQ¶
How can I run wayvnc in headless mode/over an SSH session?
How can I pass my mod-key from Sway to the remote desktop session?
mode passthrough { bindsym $mod+Pause mode default } bindsym $mod+Pause mode passthrough
Not all symbols show up when I'm typing. What can I do to fix this?
How do I enable the Compose key?
AUTHORS¶
Maintained by Andri Yngvason <andri@yngvason.is>. Up-to-date sources can be found at https://github.com/any1/wayvnc and bugs reports or patches can be submitted to GitHub's issue tracker.
2022-07-16 |