From 2624f55f8decf7f1cc1dd64a3f72b130f7ef77e8 Mon Sep 17 00:00:00 2001 From: Tony Crisci Date: Sat, 16 Dec 2017 08:19:33 -0500 Subject: [PATCH] input and seat command docs --- sway/sway-input.5.txt | 50 +++++++++++++++++++++++++++++++++++++++---- sway/sway.1.txt | 23 +------------------- sway/sway.5.txt | 7 +++++- 3 files changed, 53 insertions(+), 27 deletions(-) diff --git a/sway/sway-input.5.txt b/sway/sway-input.5.txt index f0c8f87c..d4652a82 100644 --- a/sway/sway-input.5.txt +++ b/sway/sway-input.5.txt @@ -1,5 +1,5 @@ ///// -vim:set ts=4 sw=4 tw=82 noet: +vim:set ft=asciidoc ts=4 sw=4 tw=82 noet: ///// sway-input (5) ============== @@ -11,12 +11,37 @@ sway-input - input configuration file and commands Description ----------- -Sway allows for configuration of libinput devices within the sway configuration file. +Sway allows for configuration of devices within the sway configuration file. sway-input commands must be used inside an _input { }_ block in the config. To obtain a list of available device identifiers, run **swaymsg -t get_inputs**. -Commands --------- +Input Commands +-------------- + +Keyboard Configuration +~~~~~~~~~~~~~~~~~~~~~~ + +For more information on these xkb configuration options, see +**xkeyboard-config**(7). + +**input** xkb_layout :: + Sets the layout of the keyboard like _us_ or _de_. + +**input** xkb_model :: + Sets the model of the keyboard. This has an influence for some extra keys your + keyboard might have. + +**input** xkb_options :: + Sets extra xkb configuration options for the keyboard. + +**input** xkb_rules :: + Sets files of rules to be used for keyboard mapping composition. + +**input** xkb_variant :: + Sets the variant of the keyboard like _dvorak_ or _colemak_. + +Libinput Configuration +~~~~~~~~~~~~~~~~~~~~~~ **input** accel_profile :: Sets the pointer acceleration profile for the specified input device. @@ -53,6 +78,23 @@ Commands **input** tap :: Enables or disables tap for specified input device. +Seat Configuration +------------------ + +Configure options for multiseat mode. sway-seat commands must be used inside a +_seat { }_ block in the config. + +A _seat_ is a collection of input devices that act independently of each other. +Seats are identified by name and the default seat is _seat0_ if no seats are +configured. Each seat has an independent keyboard focus and a separate cursor that +is controlled by the pointer devices of the seat. This is useful for multiple +people using the desktop at the same time with their own devices (each sitting in +their own "seat"). + +**seat** attach :: + Attach an input device to this seat by its input identifier. A special value + of _*_ will attach all devices to the seat. + See Also -------- diff --git a/sway/sway.1.txt b/sway/sway.1.txt index 14ab9f49..17fc13da 100644 --- a/sway/sway.1.txt +++ b/sway/sway.1.txt @@ -1,5 +1,5 @@ ///// -vim:set ts=4 sw=4 tw=82 noet: +vim:set ft=asciidoc ts=4 sw=4 tw=82 noet: ///// :quotes.~: @@ -93,27 +93,6 @@ The following environment variables have an effect on sway: *SWAYSOCK*:: Specifies the path to the sway IPC socket. -*WLC_DRM_DEVICE*:: - Specifies the device to use in DRM mode. - -*WLC_SHM*:: - Set 1 to force EGL clients to use shared memory. - -*WLC_OUTPUTS*:: - Number of fake outputs to use when running in X11 mode. - -*WLC_XWAYLAND*:: - Set to 0 to disable Xwayland support. - -*WLC_LIBINPUT*:: - Set to 1 to force libinput (even in X11 mode). - -*WLC_REPEAT_DELAY*:: - Configures the keyboard repeat delay. - -*WLC_REPEAT_RATE*:: - Configures the keyboard repeat rate. - *XKB_DEFAULT_RULES*, *XKB_DEFAULT_MODEL*, *XKB_DEFAULT_LAYOUT*, *XKB_DEFAULT_VARIANT*, *XKB_DEFAULT_OPTIONS*:: Configures the xkb keyboard settings. See xkeyboard-config(7). diff --git a/sway/sway.5.txt b/sway/sway.5.txt index 2a4ef205..afd3c9fa 100644 --- a/sway/sway.5.txt +++ b/sway/sway.5.txt @@ -312,7 +312,7 @@ The default colors are: **hide_edge_borders** :: Hide window borders adjacent to the screen edges. Default is _none_. -**input** :: +**input** :: Append _{_ to this command, the following lines will be commands to configure the named input device, and _}_ on its own line will close the block. + @@ -320,6 +320,11 @@ The default colors are: + See **sway-input**(5) for details. +**seat** :: + Append _{_ to this command, the following lines will be commands to configure + the named seat, and _}_ on its own line will close the block. + See **sway-input**(5) for details. + **kill**:: Kills (force-closes) the currently-focused container and all of its children.