OS Manuals

/usr/bin/wayvncctl

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 wayvncctl --help (exit 0). permalink

Usage: wayvncctl [options] <command> [parameters]

Connects to and interacts with a running wayvnc instance.

Options:
    -S,--socket=<path>        Control socket path.
    -w,--wait                 Wait for wayvnc to start up if it's not already
                              running.
    -r,--reconnect            If disconnected while waiting for events, wait for
                              wayvnc to restart.
    -j,--json                 Output json on stdout.
    -V,--version              Show version info.
    -v,--verbose              Be more verbose.
    -h,--help                 Get help (this text).

Commands:
    attach                    Attach to a running wayland compositor
    detach                    Detach from the wayland compositor
    event-receive             Register to begin receiving asynchronous events
                              from wayvnc
    client-list               Return a list of all currently connected VNC
                              sessions
    client-disconnect         Disconnect a VNC session
    set-desktop-name          Update the desktop name
    output-list               Return a list of all currently detected Wayland
                              outputs
    output-cycle              Cycle the actively captured output to the next
                              available output, wrapping through all outputs.
    output-set                Switch the actively captured output
    version                   Query the version of the wayvnc process
    wayvnc-exit               Disconnect all clients and shut down wayvnc

Run 'wayvncctl command-name --help' for command-specific details.
Options (7)
OptionDescriptionSource
-S, --socket pathSet wayvnc control socket path.help + man
-w, --waitWait for wayvnc to start up if it's not already running.help + man
-r, --reconnectIf disconnected while waiting for events, wait for wayvnc to restart and re-register for events.help + man
-j, --jsonProduce JSON output to stdout.help + man
-V, --versionShow version info.help + man
-v, --verboseBe more verbose.help + man
-h, --helpGet help about the wayvncctl command itself (lists these options).help + man
Examples (4) from the manual page, untested

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