swm · commit

Update docs

c19105270b20d0227cfc0e3f164bd44ce6a3542d

Alexis Sellier committed 22 days ago 1 parent 287190b6

README +12 -3

* wayland and wayland-protocols
* libinput and xkbcommon
* libxcb and xcb-icccm

Xwayland is optional at runtime. Without it, swm continues to run but cannot
manage X11 applications. The default configuration also expects `foot` and
`wmenu-run`; change these commands in `config.h` if they are not installed.
manage X11 applications. The default configuration uses these runtime commands:

* `foot` for the terminal, also started when swm starts
* `fuzzel` for the application launcher
* `swaylock` for screen locking
* `wpctl` for audio volume and mute controls
* `brightnessctl` for display and keyboard backlight controls
* `playerctl` for media playback controls

Install the commands for the features you use, or change them in `config.h`
and rebuild swm. The corresponding bindings require these commands to work.


# BUILD AND CONFIGURATION

    make

`XDG_CURRENT_DESKTOP=swm` for programs it starts.


# USAGE

The defaults use Alt as Mod and provide ten global workspaces. A workspace can
The defaults use Super as Mod and provide ten global workspaces. A workspace can
appear on only one output; selecting one already visible elsewhere swaps the
two outputs' workspaces. Each workspace keeps its own layout state. Available
layouts place the master area on the left, top, right, or bottom, plus a max
layout. Floating and fullscreen are independent of the selected layout.


swm.1.adoc +17 -3

Start a shell process running _command_. On exit, send `SIGTERM` to the child
process group and wait for it to stop.

== KEY BINDINGS

The default key bindings (Mod = Alt) are as follows:
The default key bindings (Mod = Super) are as follows:

=== Workspaces

[cols="1,3", options="header"]
|===

[cols="1,3", options="header"]
|===
|Binding |Action

|*Mod-x* |Lock the screen with *swaylock*(1).
|*Mod-p* |Spawn *wmenu-run*(1).
|*Mod-p* |Spawn *fuzzel*(1).
|*Mod-Shift-Return* |Spawn *foot*(1).
|*Mod-Shift-q* |Quit *swm*.
|===

Window focus follows the mouse. Windows can be moved with Mod-left-click and
resized with Mod-right-click. Mod-middle-click toggles floating.

== RUNTIME COMMANDS

The default configuration uses *foot*(1) for the terminal, *fuzzel*(1) for the
application launcher, and *swaylock*(1) for screen locking. It also starts
*foot* when *swm* starts.

Hardware keys use *wpctl*(1) for audio volume and mute controls,
*brightnessctl*(1) for display and keyboard backlight controls, and
*playerctl*(1) for media playback controls. These bindings require no modifier.

Install the commands for the features you use, or change them in _config.h_
and rebuild *swm*. The corresponding bindings require these commands to work.

== SEE ALSO

*foot*(1), *swmctl*(1), *wmenu*(1)
*brightnessctl*(1), *foot*(1), *fuzzel*(1), *playerctl*(1), *swmctl*(1),
*swaylock*(1), *wpctl*(1)

== AUTHORS

*swm* is a fork of *dwl*; see the LICENSE files for its authors.

92	101		`XDG_CURRENT_DESKTOP=swm` for programs it starts.
93	102
94	103
95	104		# USAGE
96	105
97		-	The defaults use Alt as Mod and provide ten global workspaces. A workspace can
	106	+	The defaults use Super as Mod and provide ten global workspaces. A workspace can
98	107		appear on only one output; selecting one already visible elsewhere swaps the
99	108		two outputs' workspaces. Each workspace keeps its own layout state. Available
100	109		layouts place the master area on the left, top, right, or bottom, plus a max
101	110		layout. Floating and fullscreen are independent of the selected layout.
102	111

48	48		Start a shell process running _command_. On exit, send `SIGTERM` to the child
49	49		process group and wait for it to stop.
50	50
51	51		== KEY BINDINGS
52	52
53		-	The default key bindings (Mod = Alt) are as follows:
	53	+	The default key bindings (Mod = Super) are as follows:
54	54
55	55		=== Workspaces
56	56
57	57		[cols="1,3", options="header"]
58	58		\|===

105	105		[cols="1,3", options="header"]
106	106		\|===
107	107		\|Binding \|Action
108	108
109	109		\|Mod-x \|Lock the screen with swaylock(1).
110		-	\|Mod-p \|Spawn wmenu-run(1).
	110	+	\|Mod-p \|Spawn fuzzel(1).
111	111		\|Mod-Shift-Return \|Spawn foot(1).
112	112		\|Mod-Shift-q \|Quit swm.
113	113		\|===
114	114
115	115		Window focus follows the mouse. Windows can be moved with Mod-left-click and
116	116		resized with Mod-right-click. Mod-middle-click toggles floating.
117	117
	118	+	== RUNTIME COMMANDS
	119	+
	120	+	The default configuration uses foot(1) for the terminal, fuzzel(1) for the
	121	+	application launcher, and swaylock(1) for screen locking. It also starts
	122	+	foot when swm starts.
	123	+
	124	+	Hardware keys use wpctl(1) for audio volume and mute controls,
	125	+	brightnessctl(1) for display and keyboard backlight controls, and
	126	+	playerctl(1) for media playback controls. These bindings require no modifier.
	127	+
	128	+	Install the commands for the features you use, or change them in _config.h_
	129	+	and rebuild swm. The corresponding bindings require these commands to work.
	130	+
118	131		== SEE ALSO
119	132
120		-	foot(1), swmctl(1), wmenu(1)
	133	+	brightnessctl(1), foot(1), fuzzel(1), playerctl(1), swmctl(1),
	134	+	swaylock(1), wpctl(1)
121	135
122	136		== AUTHORS
123	137
124	138		swm is a fork of dwl; see the LICENSE files for its authors.

34	34		* wayland and wayland-protocols
35	35		* libinput and xkbcommon
36	36		* libxcb and xcb-icccm
37	37
38	38		Xwayland is optional at runtime. Without it, swm continues to run but cannot
39		-	manage X11 applications. The default configuration also expects `foot` and
40		-	`wmenu-run`; change these commands in `config.h` if they are not installed.
	39	+	manage X11 applications. The default configuration uses these runtime commands:
	40	+
	41	+	* `foot` for the terminal, also started when swm starts
	42	+	* `fuzzel` for the application launcher
	43	+	* `swaylock` for screen locking
	44	+	* `wpctl` for audio volume and mute controls
	45	+	* `brightnessctl` for display and keyboard backlight controls
	46	+	* `playerctl` for media playback controls
	47	+
	48	+	Install the commands for the features you use, or change them in `config.h`
	49	+	and rebuild swm. The corresponding bindings require these commands to work.
41	50
42	51
43	52		# BUILD AND CONFIGURATION
44	53
45	54		make