GSR-KMS-SERVER(1)

NAME
gsr-kms-server - KMS (Kernel Mode Setting) server for GPU Screen Recorder

SYNOPSIS
gsr-kms-server <domain_socket_path> <card_path>

DESCRIPTION
gsr-kms-server is a companion daemon for GPU Screen Recorder that provides Kernel Mode Setting (KMS) access for screen capture in environments where direct DRM access is required. It acts as a local server that communicates via a Unix domain socket, allowing GPU Screen Recorder to capture screen content through the KMS interface.

This component is typically used when GPU Screen Recorder needs to access display hardware directly, bypassing the windowing system for more efficient or lower-level capture. It runs as a separate process and communicates with the main GPU Screen Recorder instance.

ARGUMENTS

domain_socket_path
    Path to the Unix domain socket that the server will create and listen on. This socket is used for communication between GPU Screen Recorder and the KMS server. The path should be in a location where both processes have appropriate permissions to read and write.

card_path
    Path to the DRM device file (typically /dev/dri/cardX) that the server will use for KMS operations. This corresponds to a specific graphics card in the system.

EXAMPLES
Start the KMS server using card0 and create socket at /tmp/gsr-kms.sock:
    gsr-kms-server /tmp/gsr-kms.sock /dev/dri/card0

Start the KMS server using card1 and create socket in a user-specific location:
    gsr-kms-server ~/.cache/gsr-kms.sock /dev/dri/card1

NOTES

•   The gsr-kms-server typically runs with elevated permissions to access DRM devices, which requires root permission.

•   Only one instance should run per DRM card at a time.

•   The server will exit when the client disconnects or when terminated by a signal.

•   The socket file is created by the server and removed when the server exits.

FILES

/dev/dri/card*
    DRM device files for graphics cards

/tmp/gsr-kms.sock
    Typical location for the domain socket (user-configurable)

AUTHORS
gsr-kms-server was written by the GPU Screen Recorder contributors.

REPORTING BUGS
Report bugs to: dec05eba@protonmail.com (mailto:dec05eba@protonmail.com).

COPYRIGHT
Copyright © dec05eba. Licensed under GPL-3.0-only.

SEE ALSO
gpu-screen-recorder(1), drm(4)

Project homepage: <https://git.dec05eba.com/gpu-screen-recorder/about/>