diff --git a/docs/man/kmscon.conf.1.xml.in b/docs/man/kmscon.conf.1.xml.in new file mode 100644 index 00000000..d9849a34 --- /dev/null +++ b/docs/man/kmscon.conf.1.xml.in @@ -0,0 +1,436 @@ + + + + + + + + kmscon.conf + kmscon.conf + January 2023 + + + Developer + Mirco + Müller + macslow@gmail.com + + + + + + kmscon.conf + 1 + + + + kmscon.conf + Configuration file for KMS/DRM based System Console + + + + Description + kmscon.conf is the configuration file to control the behavior of kmscon + and adjust it to your system-setup. It allows to remap the bindings of + keyboard-shortcuts, define the desired keyboard-layout, select font + attributes for text-rendering, hardware-accelerationn, orientation of + output and much more. + + Below is a complete list of all recognized Options, their meaning and + possible values. In section Example is a typical real-world sample of + a configuration to guide you in creating your own. + + + + Example + Here is a real-world example of a typical kmscon.conf file: + +### General Options ### +verbose + +### Seat Options ### +vt=1 +switchvt + +### Session Options ### +session-max=6 +session-control + +### Terminal Options ### +term=linux + +### Input Options ### +xkb-model=pc102 +xkb-layout=de +xkb-repeat-delay=200 +xkb-repeat-rate=65 + +### Video Options ### +drm +hwaccel +gpus=all +render-engine=gltex +rotate=normal + +### Font Options ### +font-engine=pango +font-size=18 +font-name=Ubuntu Mono + + Any line starting with a #-character is ignored and considered to be a comment. + + + + Options + Below is a complete list of all recognized options, their meaning and + possible values. + + + ### General Options ### + + + + Make kmscon be very chatty about what it is doing. It prints to + stdout unless redirected. Off if not present in kmsconf.conf or + commented out. (default: off) + + + + + + + Let kmscon be even more chatty. The text-output goes to stdout or + any file it was redirected to. Off if not present in kmsconf.conf + or commented out. (default: off) + + + + + + + Suppress notices and warnings. (default: off) + + + + + + + Path to config directory. (default: /etc/kmscon) + + + + + + + Listen for new seats and spawn sessions accordingly. (default: off) + + + + ### Seat Options ### + + + + Select which VT to run on. (default: auto) + + + + + + + Automatically switch to VT. (default: on) + + + + + + + Select seats to run on. (default: current) + + + + ### Session Options ### + + + + + Maximum number of sessions. (default: 50) + + + + + + + Allow keyboard session-control. (default: off) + + + + + + + Enable terminal session. (default: on) + + + + ### Terminal Options ### + + + + + Start the given login process instead of the default process; all arguments following '--' will be be parsed as argv to this process. No more options after '--' will be parsed so use it at the end of the argument string. (default: /bin/login -p) + + + + + + + Value of the TERM environment variable for the child process. (default: xterm-256color) + + + + + + + Reset environment before running child process. (default: on) + + + + + + + Select the used color palette. (default: default) + + + + + + + Size of the scrollback-buffer in lines. (default: 1000) + + + + ### Input Options ### + + + + Set XkbModel for input devices. (default: unset) + + + + + + + Set XkbLayout for input devices. (default: unset) + + + + + + + Set XkbVariant for input devices. (default: unset) + + + + + + + Set XkbOptions for input devices. (default: unset) + + + + + + + Use a predefined keymap for input devices. (default: unset) + + + + + + + Initial delay for key-repeat in ms. (default: 250) + + + + + + + Delay between two key-repeats in ms. (default: 50) + + + + ### Grabs/Keyboard-Shortcuts ### + + + + Shortcut to scroll up. (default: <Shift>Up) + + + + + + + Shortcut to scroll down. (default: <Shift>Down) + + + + + + + Shortcut to scroll page up. (default: <Shift>Prior) + + + + + + + Shortcut to scroll page down. (default: <Shift>Next) + + + + + + + Shortcut to increase font size. (default: <Ctrl>Plus) + + + + + + + Shortcut to decrease font size. (default: <Ctrl>Minus) + + + + + + + Switch to next session. (default: <Ctrl><Logo>Right) + + + + + + + Switch to previous session. (default: <Ctrl><Logo>Left) + + + + + + + Switch to dummy session. (default: <Ctrl><Logo>Escape) + + + + + + + Close current session. (default: <Ctrl><Logo>BackSpace) + + + + + + + Create new terminal session. (default: <Ctrl><Logo>Return) + + + + ### Video Options ### + + + + Use DRM if available. (default: on) + + + + + + + Use 3D hardware-acceleration if available. (default: off) + + + + + + + GPU selection mode. (default: all) + + + + + + + Console renderer. (default: not set) + + + + + + + Print renderer timing information. (default: off) + + + + + + + Use the original KMS video mode. (default: on) + + + + + + + Set the resolution to {width}x{height} + + + + ### Font Options ### + + + + Font engine to use. (default: pango) + + + + + + + Font size in points. (default: 12) + + + + + + + Font name to use. (default: monospace) + + + + + + + Force DPI value for all fonts. (default: 96) + + + + + + + + Files + /etc/kmsconf.conf + + + + See Also + + kmscon1 + + + diff --git a/docs/meson.build b/docs/meson.build index a26e520f..cf33578c 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -4,6 +4,7 @@ manpages = [ 'kmscon.1.xml.in', + 'kmscon.conf.1.xml.in', ] data = configuration_data()