OS Manuals

/usr/bin/wayvnc

VNC server for wlroots-based Wayland compositors, with the wayvncctl JSON IPC control client

From wayvnc 0.10.2-r4 (enterprise-packages), captured 2026-11-09 by running wayvnc --help (exit 0). permalink

Usage: wayvnc [options] [address...]

Starts a VNC server for $WAYLAND_DISPLAY

Arguments:
    address                   An address to listen on.
                              Default: localhost

Options:
    -a,--desktop              Capture all outputs.
    -C,--config=<path>        Select a config file.
    -d,--disable-input        Disable all remote input.
    -D,--detached             Start detached from a compositor.
    -e,--exit-on-disconnect
                              Exit when last client disconnects.
    -f,--max-fps=<fps>        Set rate limit.
                              Default: 30
    -F,--log-filter=<string>
                              Set log filter.
    -g,--gpu                  Enable features that need GPU.
    -h,--help                 Get help (this text).
    -k,--keyboard=<layout>[-<variant>]
                              Select keyboard layout with an optional variant.
    -L,--log-level=<level>
                              Set log level. The levels are: error, warning,
                              info, debug trace and quiet.
                              Default: warning
    -n,--name=<name>          Set the desktop name.
                              Default: WayVNC
    -o,--output=<name>        Select output to capture.
    -p,--show-performance
                              Show performance counters.
    -r,--render-cursor        Enable overlay cursor rendering.
    -R,--disable-resizing
                              Disable automatic resizing.
    -s,--seat=<name>          Select seat by name.
    -S,--socket=<path>        Control socket path.
    -t,--transient-seat
                              Use transient seat.
    -T,--toplevel=<identifier>
                              Capture a toplevel
    -u,--unix-socket          Create unix domain socket.
    -v,--verbose              Be more verbose. Same as setting --log-level=info
    -V,--version              Show version info.
    -w,--websocket            Create a websocket.
    -x,--external-listener-fd
                              The address is a pre-bound file descriptor.
Options (25)
OptionDescriptionSource
-a, --desktopCapture all outputs.help + man
-C, --config pathSelect a config file.help + man
-d, --disable-inputDisable all remote input.help + man
-D, --detachedStart detached from a compositor.help + man
-e, --exit-on-disconnectExit when last client disconnects.help
-f, --max-fps fpsSet the rate limit (default 30).help + man
-F, --log-filter stringSet a log filter.help + man
-g, --gpuEnable features that require GPU.help + man
-h, --helpGet help (this text).help + man
-k, --keyboard layout>[-<variantSelect keyboard layout with an optional variant.help + man
-L, --log-level levelSet log level.help + man
-n, --name nameSet the desktop name.help + man
-o, --output nameSelect output to capture.help + man
-p, --show-performanceShow performance counters.help + man
-r, --render-cursorEnable overlay cursor rendering.help + man
-R, --disable-resizingDisable automatic desktop resizing.help + man
-s, --seat nameSelect seat by name.help + man
-S, --socket pathSet wayvnc control socket path.help + man
-t, --transient-seatCreate a transient seat for each client session.help + man
-T, --toplevel identifierCapture a toplevel.help + man
-u, --unix-socketCreate unix domain socket.help
-v, --verboseBe more verbose.help + man
-V, --versionShow version info.help + man
-w, --websocketCreate a websocket.help
-x, --external-listener-fdThe address is a pre-bound file descriptor.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.