X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=bspwm.1;h=628b1b0443b4995edbdd26c03d2acfaf478a2ca0;hb=387c6243b4143c4fefe792ba42a91fde3b711e3d;hp=c2bc7a8f486413b9d648b1d393b9dcabc2422ef4;hpb=6b2d8152ca1271159e60506e79d951869a7724b8;p=bspwm.git diff --git a/bspwm.1 b/bspwm.1 index c2bc7a8..628b1b0 100644 --- a/bspwm.1 +++ b/bspwm.1 @@ -3,14 +3,16 @@ bspwm \- Tiling window manager based on binary space partitioning .SH SYNOPSIS .B bspwm -.RI [ -v | "-s STATUS_FIFO" ] +.RI [ -h | -v | "-s PANEL_FIFO" | "-p PANEL_PREFIX" ] .P .BI bspc " MESSAGE" .RI [ ARGUMENTS ] .RI [ OPTIONS ] .SH DESCRIPTION .B bspwm -is a tiling window manager where each window is represented as the leaf of a binary tree. It is controlled and configured via +is a tiling window manager where each window is represented as the leaf of a binary tree. +.P +It is controlled and configured via .BR bspc . .SH CONFIGURATION .B bspwm @@ -18,28 +20,15 @@ have only two sources of informations: the .B X events it receives and the messages it reads on a dedicated socket. .P -Those messages are sent via -.BR bspc . -.P -If the -.I BSPWM_SOCKET -environment variable is defined, it will be used as the socket path, otherwise -.I /tmp/bspwm-socket -is used. +Its configuration file is +.IR $XDG_CONFIG_HOME/bspwm/autostart . .P -The recommended way of defining keyboard shortcuts is to use -.BR shkd " or " xbindkeys . +Keyboard and pointer bindings are defined through +.BR sxhkd . .P -The only way to configure -.B bspwm -is by sending -.I set -messages via the client, hence -.BR bspwm \'s -configuration file is an executable called -.I autostart -which lives in -.IR $XDG_CONFIG_HOME/bspwm/ . +Example configuration files can be found in the +.I examples +directory. .SH SPLITTING MODES There is only two splitting modes: .IR automatic " and " manual . @@ -55,6 +44,7 @@ message. Example: insertion of a new node (number 4) into the given tree in .I automatic mode: +.EX b c / \\ / \\ @@ -73,12 +63,14 @@ mode: | | | | | | | +-------------------------+ +-------------------------+ +.EE .P Same departure, but the mode is .IR manual , and a .BI presel " up" message was sent beforehand: +.EX b b / \\ / \\ @@ -96,6 +88,7 @@ message was sent beforehand: | | | | | | +-------------------------+ +-------------------------+ +.EE .SH MESSAGES .TP .BI get " SETTING" @@ -137,6 +130,9 @@ Focus the neighbor window situated in the given direction. .BI shift " left|right|up|down" Exchange the current window with the given neighbor. .TP +.BI swap " [biggest|smallest]" +Swap the focused window with the biggest/smallest window or with the last focused window if no arguments are given. +.TP .BI push " left|right|up|down" Push the fence located in the given direction. .TP @@ -152,6 +148,15 @@ Focus the nearest window matching the given constraints. .BI circulate " forward|backward" Circulate the leaves in the given direction. .TP +.BI grab_pointer " focus|move|resize_side|resize_corner" +Begin the specified pointer action. +.TP +.BI track_pointer " ROOT_X ROOT_Y" +Pass the pointer root coordinates for the current pointer action. +.TP +.BI ungrab_pointer +End the current pointer action. +.TP .BI toggle_fullscreen Toggle the fullscreen state of the current window. .TP @@ -175,9 +180,15 @@ Kill the focused window. .BI send_to " DESKTOP_NAME [--follow]" Send the focused window to the given desktop. .TP +.BI drop_to " next|prev [--follow]" +Send the focused window to the next or previous desktop. +.TP .BI send_to_monitor " MONITOR_NAME [--follow]" Send the focused window to the given monitor. .TP +.BI drop_to_monitor " next|prev [--follow]" +Send the focused window to the next or previous monitor. +.TP .BI use " DESKTOP_NAME" Select the given desktop. .TP @@ -218,19 +229,28 @@ Set the layout of the given desktops (current if none given). Cycle the layout of the current desktop. .TP .BI rotate " clockwise|counter_clockwise|full_cycle" -Rotate the tree of the current desktop. +Rotate the window tree. +.TP +.BI flip " horizontal|vertical" +Flip the window tree. .TP -.BI rule " PATTERN [DESKTOP_NAME] [floating] " +.B balance +Adjust the split ratios so that all windows occupy the same area. +.TP +.BI rule " PATTERN [DESKTOP_NAME] [floating] [follow]" Create a new rule (PATTERN must match the class or instance name). .TP +.BI remove_rule " UID ..." +Remove the rules with the given UIDs. +.TP +.BI put_status +Output the current state to the panel fifo. +.TP .BI adopt_orphans Manage all the unmanaged windows remaining from a previous session. .TP -.BI reload_autostart -Reload the autostart file. -.TP -.BI reload_settings -Reload the default settings. +.BI restore " FILE_PATH" +Restore the layout of each desktop from the content of FILE_PATH. .TP .BI quit " [EXIT_STATUS]" Quit. @@ -247,19 +267,13 @@ or .IR "true " "or " false . .TP .I focused_border_color -Color of the main border of a focused window of a focused monitor. +Color of the border of a focused window of a focused monitor. .TP .I active_border_color -Color of the main border of a focused window of an unfocused monitor. +Color of the border of a focused window of an unfocused monitor. .TP .I normal_border_color -Color of the main border of an unfocused window. -.TP -.I inner_border_color -Color of the inner border of a window. -.TP -.I outer_border_color -Color of the outer border of a window. +Color of the border of an unfocused window. .TP .I presel_border_color Color of the @@ -267,24 +281,33 @@ Color of the message feedback. .TP .I focused_locked_border_color -Color of the main border of a focused locked window of a focused monitor. +Color of the border of a focused locked window of a focused monitor. .TP .I active_locked_border_color -Color of the main border of a focused locked window of an unfocused monitor. +Color of the border of a focused locked window of an unfocused monitor. .TP .I normal_locked_border_color -Color of the main border of an unfocused locked window. +Color of the border of an unfocused locked window. .TP .I urgent_border_color Color of the border of an urgent window. .TP -.I {inner,main,outer}_border_width -Width of the inner, main and outer borders. +.I border_width +Window border width. .TP .I window_gap Value of the gap that separates windows. .TP -.I {top,right,bottom,left}_padding +.I split_ratio +Default split ratio. +.TP +.I top_padding +.TQ +.I right_padding +.TQ +.I bottom_padding +.TQ +.I left_padding Padding space added at the sides of the current monitor. .TP .I wm_name @@ -292,44 +315,41 @@ The value that shall be used for the .B _NET_WM_NAME property of the root window. .TP -.I button_modifier -The modifier mask used for mouse bindings (possible values: -.BR shift ", " control ", " lock ", " mod1 " ... " mod5 ). -.TP -.I numlock_modifier -The modifier holding Num_Lock (cf. -.BR xmodmap (1)). -.TP -.I capslock_modifier -The modifier holding Lock. -.TP .I borderless_monocle Whether to remove borders for tiled windows in monocle mode. .TP .I gapless_monocle Whether to remove gaps for tiled windows in monocle mode. .TP -.I focus_follows_mouse -Wether to focus the window under the mouse pointer. +.I focus_follows_pointer +Whether to focus the window under the pointer. .TP .I adaptative_raise Prevent floating windows from being raised when they might cover other floating windows. -.SH MOUSE BINDINGS .TP -.I button_modifier + left mouse button -Move the window under the pointer. +.I apply_shadow_property +Enable shadows for floating windows via the +.B _COMPTON_SHADOW +property. .TP -.I button_modifier + middle mouse button -Focus the window under the pointer. +.I auto_alernate +Whether to interpret two consecutive identical +.B use +messages as an +.B alternate +message. +.SH ENVIRONMENT VARIABLES .TP -.I button_modifier + right mouse button -Resize the window under the pointer (by moving one of its four corners). +.I BSPWM_SOCKET +The path of the socket used for the communication between +.BR bspc " and " bspwm . .SH AUTHOR .EX Bastien Dejean .SH CONTRIBUTORS .EX Ivan Kanakarakis +Thomas Adam .EE .SH HOMEPAGE .TP