.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "wayvnc" "1" "2022-07-16"
.P
.SH NAME
.P
wayvnc - A VNC server for wlroots based Wayland compositors.\&
.P
.SH SYNOPSIS
.P
\fBwayvnc\fR [options] [address [port]]
.P
.SH OPTIONS
.P
\fB-C, --config=<path>\fR
.RS 4
Select a config file.\&
.P
.RE
\fB-o, --output=<name>\fR
.RS 4
Select output to capture.\&
.P
.RE
\fB-k, --keyboard=<layout>[-variant]\fR
.RS 4
Select keyboard layout.\& The variant can be appended if needed.\&
.P
.RE
\fB-s, --seat=<name>\fR
.RS 4
Select seat by name.\&
.P
.RE
\fB-r, --render-cursor\fR
.RS 4
Enable overlay cursor rendering.\&
.P
.RE
\fB-f, --max-fps=<fps>\fR
.RS 4
Set the rate limit (default 30).\&
.P
.RE
\fB-p, --show-performance\fR
.RS 4
Show performance counters.\&
.P
.RE
\fB-u, --unix-socket\fR
.RS 4
Create a UNIX domain socket instead of TCP, treating the address as a
path.\&
.P
.RE
\fB-d, --disable-input\fR
.RS 4
Disable all remote input.\& This allows using wayvnc without compositor
support of virtual mouse / keyboard protocols.\&
.P
.RE
\fB-V, --version\fR
.RS 4
Show version info.\&
.P
.RE
\fB-h, --help\fR
.RS 4
Get help.\&
.P
.RE
.SH DESCRIPTION
.P
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.\&
.P
.SH CONFIGURATION
.P
wayvnc searches for a config file in the location
.RS 4
~/$XDG_CONFIG_HOME/wayvnc/config
.RE
or if $XDG_CONFIG_HOME is not set
.RS 4
~/.\&config/wayvnc/config
.P
.RE
.SS SYNTAX
.P
The configuration file is composed of key-value pairs separated with an \fBequal\fR
sign.\& Whitespace around either the key or the value is insignificant and is not
considered to be part of the key or the value.\&
.P
.SS KEYWORDS
.P
\fBaddress\fR
.RS 4
The address to which the server shall bind, e.\&g.\& 0.\&0.\&0.\&0 or localhost.\&
.P
.RE
\fBcertificate_file\fR
.RS 4
The path to the certificate file for encryption.\& Only applicable when
\fBenable_auth\fR=true.\&
.P
.RE
\fBenable_auth\fR
.RS 4
Enable authentication and encryption.\& Setting this value to \fBtrue\fR
requires also setting \fBcertificate_file\fR, \fBprivate_key_file\fR,
\fBusername\fR and \fBpassword\fR.\&
.P
.RE
\fBpassword\fR
.RS 4
Choose a password for authentication.\&
.P
.RE
\fBport\fR
.RS 4
The port to which the server shall bind.\& Default is 5900.\&
.P
.RE
\fBprivate_key_file\fR
.RS 4
The path to the private key file for encryption.\& Only applicable when
\fBenable_auth\fR=true.\&
.P
.RE
\fBusername\fR
.RS 4
Choose a username for authentication.\&
.P
.RE
\fBxkb_layout\fR
.RS 4
The keyboard layout to use for key code lookup.\&
.P
Default: \fIXKB_DEFAULT_LAYOUT\fR or system default.\&
.P
.RE
\fBxkb_model\fR
.RS 4
The keyboard model by which to interpret keycodes and LEDs.\&
.P
Default: "pc105"
.P
.RE
\fBxkb_options\fR
.RS 4
A comma separated list of options, through which the user specifies
non-layout related preferences such as which key is the Compose key.\& 
.P
Default: \fIXKB_DEFAULT_OPTIONS\fR or system default.\&
.P
.RE
\fBxkb_rules\fR
.RS 4
The rules file describes how to interpret the values of the model,
layout, variant and options fields.\&
.P
Default: \fIXKB_DEFAULT_RULES\fR or system default.\&
.P
.RE
\fBxkb_variant\fR
.RS 4
The keyboard variant to use for keycode lookup.\&
.P
Default: \fIXKB_DEFAULT_VARIANT\fR or system default.\&
.P
.RE
.SS EXAMPLE
.P
.nf
.RS 4
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
.fi
.RE
.P
.SH ENVIRONMENT
.P
The following environment variables have an effect on wayvnc:
.P
\fIWAYLAND_DISPLAY\fR
.RS 4
Specifies the name of the Wayland display that the compositor to which
wayvnc shall bind is running on.\&
.P
.RE
\fIXDG_CONFIG_HOME\fR
.RS 4
Specifies the location of configuration files.\&
.P
.RE
.SH FAQ
.P
\fBHow can I run wayvnc in headless mode/over an SSH session?\&\fR
.P
.RS 4
Set the environment variables \fIWLR_BACKENDS\fR=headless and
\fIWLR_LIBINPUT_NO_DEVICES\fR=1 before starting the compositor, then run
wayvnc as normal.\&
.P
.RE
\fBHow can I pass my mod-key from Sway to the remote desktop session?\&\fR
.P
.RS 4
Create an almost empty mode in your sway config.\& Example:
.nf
.RS 4
mode passthrough {
	bindsym $mod+Pause mode default
}
bindsym $mod+Pause mode passthrough
.fi
.RE
This makes it so that when you press $mod+Pause, all keybindings, except
the one to switch back, are disabled.\&
.P
.RE
\fBNot all symbols show up when I'\&m typing.\& What can I do to fix this?\&\fR
.P
.RS 4
Try setting the keyboard layout in wayvnc to the one that most closely
matches the keyboard layout that you'\&re using on the client side.\& An
exact layout isn'\&t needed, just one that has all the symbols that you
use.\&
.P
.RE
\fBHow do I enable the Compose key?\&\fR
.P
.RS 4
Set "xkb_options=compose:menu" in the config file.\& Any key that is not
otherwise used will work.\& There just needs to be some key for wayvnc to
match against.\&
.P
.RE
.SH AUTHORS
.P
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.\&