Implement new 'sticky' command to manually set, remove or toggle the sticky state...

[i3/i3] / docs / userguide

diff --git a/docs/userguide b/docs/userguide
index 5e148ff547ef930ca89ad6fb978aa691adcfc18c..d1660c49e2c2fc46ad489843a4970510febeab1b 100644 (file)
--- a/docs/userguide
+++ b/docs/userguide
@@ -1834,6 +1834,27 @@ bindsym $mod+c move absolute position center
 bindsym $mod+m move position mouse
 -------------------------------------------------------
 
+=== Sticky floating windows
+
+If you want a window to stick to the glass, i.e., have it stay on screen even
+if you switch to another workspace, you can use the +sticky+ command. For
+example, this can be useful for notepads, a media player or a video chat
+window.
+
+Note that while any window can be made sticky through this command, it will
+only take effect if the window is floating.
+
+*Syntax*:
+----------------------------
+sticky enable|disable|toggle
+----------------------------
+
+*Examples*:
+------------------------------------------------------
+# make a terminal sticky that was started as a notepad
+for_window [instance=notepad] sticky enable
+------------------------------------------------------
+
 === Changing (named) workspaces/moving to workspaces
 
 To change to a specific workspace, use the +workspace+ command, followed by the