diff --git a/Makefile b/Makefile index c7e361d..1bda221 100644 --- a/Makefile +++ b/Makefile @@ -30,17 +30,17 @@ xephyr: install: mkdir -p "$(DESTDIR)$(BINPREFIX)" -# cp -pf bspwm "$(DESTDIR)$(BINPREFIX)" - cp -pf bspc "$(DESTDIR)$(BINPREFIX)" +# cp -pf tspwm "$(DESTDIR)$(BINPREFIX)" + cp -pf tspc "$(DESTDIR)$(BINPREFIX)" mkdir -p "$(DESTDIR)$(MANPREFIX)"/man1 -# cp -p doc/bspwm.1 "$(DESTDIR)$(MANPREFIX)"/man1 - cp -Pp doc/bspc.1 "$(DESTDIR)$(MANPREFIX)"/man1 +# cp -p doc/tspwm.1 "$(DESTDIR)$(MANPREFIX)"/man1 + cp -Pp doc/tspc.1 "$(DESTDIR)$(MANPREFIX)"/man1 mkdir -p "$(DESTDIR)$(BASHCPL)" - cp -p contrib/bash_completion "$(DESTDIR)$(BASHCPL)"/bspc + cp -p contrib/bash_completion "$(DESTDIR)$(BASHCPL)"/tspc mkdir -p "$(DESTDIR)$(FISHCPL)" - cp -p contrib/fish_completion "$(DESTDIR)$(FISHCPL)"/bspc.fish + cp -p contrib/fish_completion "$(DESTDIR)$(FISHCPL)"/tspc.fish mkdir -p "$(DESTDIR)$(ZSHCPL)" - cp -p contrib/zsh_completion "$(DESTDIR)$(ZSHCPL)"/_bspc + cp -p contrib/zsh_completion "$(DESTDIR)$(ZSHCPL)"/_tspc mkdir -p "$(DESTDIR)$(DOCPREFIX)" cp -p $(MD_DOCS) "$(DESTDIR)$(DOCPREFIX)" mkdir -p "$(DESTDIR)$(DOCPREFIX)"/examples @@ -49,20 +49,20 @@ install: # cp -p contrib/freedesktop/bspwm.desktop "$(DESTDIR)$(XSESSIONS)" uninstall: - rm -f "$(DESTDIR)$(BINPREFIX)"/bspwm - rm -f "$(DESTDIR)$(BINPREFIX)"/bspc - rm -f "$(DESTDIR)$(MANPREFIX)"/man1/bspwm.1 - rm -f "$(DESTDIR)$(MANPREFIX)"/man1/bspc.1 - rm -f "$(DESTDIR)$(BASHCPL)"/bspc - rm -f "$(DESTDIR)$(FISHCPL)"/bspc.fish - rm -f "$(DESTDIR)$(ZSHCPL)"/_bspc + rm -f "$(DESTDIR)$(BINPREFIX)"/tspwm + rm -f "$(DESTDIR)$(BINPREFIX)"/tspc + rm -f "$(DESTDIR)$(MANPREFIX)"/man1/tspwm.1 + rm -f "$(DESTDIR)$(MANPREFIX)"/man1/tspc.1 + rm -f "$(DESTDIR)$(BASHCPL)"/tspc + rm -f "$(DESTDIR)$(FISHCPL)"/tspc.fish + rm -f "$(DESTDIR)$(ZSHCPL)"/_tspc rm -rf "$(DESTDIR)$(DOCPREFIX)" - rm -f "$(DESTDIR)$(XSESSIONS)"/bspwm.desktop + rm -f "$(DESTDIR)$(XSESSIONS)"/tspwm.desktop doc: - a2x -v -d manpage -f manpage -a revnumber=$(VERSION) doc/bspwm.1.asciidoc + a2x -v -d manpage -f manpage -a revnumber=$(VERSION) doc/tspwm.1.asciidoc clean: - rm -f $(WM_OBJ) $(CLI_OBJ) bspwm bspc + rm -f $(WM_OBJ) $(CLI_OBJ) tspwm tspc .PHONY: all install uninstall doc clean diff --git a/contrib/bash_completion b/contrib/bash_completion index 6ab1e12..d0ee7db 100644 --- a/contrib/bash_completion +++ b/contrib/bash_completion @@ -1,4 +1,4 @@ -_bspc() { +_tspc() { local commands='node desktop monitor query rule wm subscribe config quit' local settings='external_rules_command status_prefix normal_border_color active_border_color focused_border_color presel_feedback_color border_width window_gap top_padding right_padding bottom_padding left_padding top_monocle_padding right_monocle_padding bottom_monocle_padding left_monocle_padding split_ratio automatic_scheme removal_adjustment initial_polarity directional_focus_tightness presel_feedback borderless_monocle gapless_monocle single_monocle borderless_singleton pointer_motion_interval pointer_modifier pointer_action1 pointer_action2 pointer_action3 click_to_focus swallow_first_click focus_follows_pointer pointer_follows_focus pointer_follows_monitor mapping_events_count ignore_ewmh_focus ignore_ewmh_fullscreen ignore_ewmh_struts center_pseudo_tiled honor_size_hints remove_disabled_monitors remove_unplugged_monitors merge_overlapping_monitors' @@ -24,6 +24,6 @@ _bspc() { fi } -complete -F _bspc bspc +complete -F _tspc tspc # vim: set ft=sh: diff --git a/contrib/fish_completion b/contrib/fish_completion index 3cd6f4d..034282a 100644 --- a/contrib/fish_completion +++ b/contrib/fish_completion @@ -1,14 +1,14 @@ -function __fish_bspc_needs_command +function __fish_tspc_needs_command set cmd (commandline -opc) - [ (count $cmd) -eq 1 -a $cmd[1] = 'bspc' ]; and return 0 + [ (count $cmd) -eq 1 -a $cmd[1] = 'tspc' ]; and return 0 return 1 end -function __fish_bspc_using_command +function __fish_tspc_using_command set cmd (commandline -opc) [ (count $cmd) -gt 1 ]; and [ $argv[1] = $cmd[2] ]; and return 0 return 1 end -complete -f -c bspc -n '__fish_bspc_needs_command' -a 'node desktop monitor query rule wm subscribe config quit' -complete -f -c bspc -n '__fish_bspc_using_command config' -a 'external_rules_command status_prefix normal_border_color active_border_color focused_border_color presel_feedback_color border_width window_gap top_padding right_padding bottom_padding left_padding top_monocle_padding right_monocle_padding bottom_monocle_padding left_monocle_padding split_ratio automatic_scheme removal_adjustment initial_polarity directional_focus_tightness presel_feedback borderless_monocle gapless_monocle single_monocle borderless_singleton pointer_motion_interval pointer_modifier pointer_action1 pointer_action2 pointer_action3 click_to_focus swallow_first_click focus_follows_pointer pointer_follows_focus pointer_follows_monitor mapping_events_count ignore_ewmh_focus ignore_ewmh_fullscreen ignore_ewmh_struts center_pseudo_tiled honor_size_hints remove_disabled_monitors remove_unplugged_monitors merge_overlapping_monitors' +complete -f -c tspc -n '__fish_tspc_needs_command' -a 'node desktop monitor query rule wm subscribe config quit' +complete -f -c tspc -n '__fish_tspc_using_command config' -a 'external_rules_command status_prefix normal_border_color active_border_color focused_border_color presel_feedback_color border_width window_gap top_padding right_padding bottom_padding left_padding top_monocle_padding right_monocle_padding bottom_monocle_padding left_monocle_padding split_ratio automatic_scheme removal_adjustment initial_polarity directional_focus_tightness presel_feedback borderless_monocle gapless_monocle single_monocle borderless_singleton pointer_motion_interval pointer_modifier pointer_action1 pointer_action2 pointer_action3 click_to_focus swallow_first_click focus_follows_pointer pointer_follows_focus pointer_follows_monitor mapping_events_count ignore_ewmh_focus ignore_ewmh_fullscreen ignore_ewmh_struts center_pseudo_tiled honor_size_hints remove_disabled_monitors remove_unplugged_monitors merge_overlapping_monitors' diff --git a/contrib/freedesktop/bspwm.desktop b/contrib/freedesktop/bspwm.desktop deleted file mode 100644 index 2d3de88..0000000 --- a/contrib/freedesktop/bspwm.desktop +++ /dev/null @@ -1,5 +0,0 @@ -[Desktop Entry] -Name=bspwm -Comment=Binary space partitioning window manager -Exec=bspwm -Type=Application diff --git a/contrib/freedesktop/tspwm.desktop b/contrib/freedesktop/tspwm.desktop new file mode 100644 index 0000000..c9cf610 --- /dev/null +++ b/contrib/freedesktop/tspwm.desktop @@ -0,0 +1,5 @@ +[Desktop Entry] +Name=tspwm +Comment=Binary space partitioning window manager (written in go) +Exec=tspwm +Type=Application diff --git a/contrib/zsh_completion b/contrib/zsh_completion index 106997f..aed9ddd 100644 --- a/contrib/zsh_completion +++ b/contrib/zsh_completion @@ -1,6 +1,6 @@ -#compdef bspc +#compdef tspc -_bspc_selector() { +_tspc_selector() { [[ ${@[(r)--]} = '--' ]] && shift ${@[(i)--]} local -a completions=() completions_display=() local index=0 name id sel_type="$1" @@ -15,7 +15,7 @@ _bspc_selector() { (desktop*:) local ipfx=${${IPREFIX##*@}%:} while do - if completions=("${(@f)$(bspc query --names -D -m ${ipfx} 2> /dev/null)}") ;then + if completions=("${(@f)$(tspc query --names -D -m ${ipfx} 2> /dev/null)}") ;then until ((++index > $#completions)) do completions[index]="^${index}:${completions[index]}" done @@ -31,7 +31,7 @@ _bspc_selector() { done ;| (node*[^@/:.]) - bspc query -N -n .window 2> /dev/null | + tspc query -N -n .window 2> /dev/null | while read id ;do id=${id//:/\\:} if which xdotool &> /dev/null ;then @@ -50,10 +50,10 @@ _bspc_selector() { ((desktop|monitor)*[^:.]) local max_name_len=0 max_index_len i local -a snames names ids - bspc query -${(U)sel_type[1]} 2> /dev/null | + tspc query -${(U)sel_type[1]} 2> /dev/null | while read id ;do ((index++)) - name=$(bspc query --names -${(U)sel_type[1]} -${sel_type[1]} $id 2> /dev/null) + name=$(tspc query --names -${(U)sel_type[1]} -${sel_type[1]} $id 2> /dev/null) [[ "$name" == *[:.!]* ]] && sel_name="%${name//:/\\:}" || sel_name="$name" @@ -85,7 +85,7 @@ _bspc_selector() { (node*'/') ;; (*'.') - _bspc_prefix '!' "${sel_type} modifiers" ${sel_type}_mod $@ -J ${sel_type}_mod + _tspc_prefix '!' "${sel_type} modifiers" ${sel_type}_mod $@ -J ${sel_type}_mod ;| ((desktop|monitor)*@) ;& @@ -101,15 +101,15 @@ _bspc_selector() { (node*@*'#'*) ;; (node*@*) - _bspc_selector desktop -S ':' -qr ".#\-\n ${quote}" + _tspc_selector desktop -S ':' -qr ".#\-\n ${quote}" ;; (desktop*) - _bspc_selector monitor -S ':' -r ".#\-\n ${quote}" + _tspc_selector monitor -S ':' -r ".#\-\n ${quote}" ;; esac } -_bspc_prefix(){ +_tspc_prefix(){ [[ ${@[(r)--]} = '--' ]] && shift ${@[(i)--]} [[ "$PREFIX[1]" == "$1" ]] && local a="-n" b || @@ -117,9 +117,9 @@ _bspc_prefix(){ _describe $@[2,-1] $a -- $@[3,-1] $b -p "$1" } -_bspc_query_names() { +_tspc_query_names() { [[ ${@[(r)--]} = '--' ]] && shift ${@[(i)--]} - local -a items=("${(@f)$(bspc query $2 --names 2> /dev/null)}") || + local -a items=("${(@f)$(tspc query $2 --names 2> /dev/null)}") || return local c for c in '\' ':' '[' '(' '*' @@ -127,7 +127,7 @@ _bspc_query_names() { _values -w "$1" "${items[@]}" } -_bspc() { +_tspc() { local -a commands=(node desktop monitor query rule wm subscribe config quit) \ resize_handle=(top bottom top_left top_right bottom_left bottom_right left right) \ node_state=(tiled pseudo_tiled floating fullscreen) \ @@ -157,71 +157,71 @@ _bspc() { case $words[1] in (node) - ((CURRENT==2)) && _bspc_selector node + ((CURRENT==2)) && _tspc_selector node ((CURRENT>2)) && [[ "$words[2]" != '-'* ]] && compset -n 2 ((CURRENT>2)) && [[ "$words[CURRENT-2]" =~ "^-(m|d|n|s|-to-(monitor|desktop|node)|-swap)$" ]] && _values 'option' '--follow[If passed, the focused node will stay focused]' _arguments -C \ - '*'{-a,--activate}'[Activate the selected or given node]::node selector:_bspc_selector -- node'\ + '*'{-a,--activate}'[Activate the selected or given node]::node selector:_tspc_selector -- node'\ '*'{-B,--balance}'[Adjust the split ratios of the tree rooted at the selected node so that all windows occupy the same area]'\ '*'{-C,--circulate}'[Circulate the windows of the tree rooted at the selected node]:direction:(forward backward)'\ '*'{-c,--close}'[Close the windows rooted at the selected node]'\ - '*'{-d,--to-desktop}'[Send the selected node to the given desktop]:desktop selector:_bspc_selector -- desktop'\ + '*'{-d,--to-desktop}'[Send the selected node to the given desktop]:desktop selector:_tspc_selector -- desktop'\ '*'{-E,--equalize}'[Reset the split ratios of the tree rooted at the selected node to their default value]'\ '*'{-F,--flip}'[Flip the the tree rooted at selected node]: :(horizontal vertical)'\ - '*'{-f,--focus}'[Focus the selected or given node]::node selector:_bspc_selector -- node'\ + '*'{-f,--focus}'[Focus the selected or given node]::node selector:_tspc_selector -- node'\ '*'{-g,--flag}'[Set or toggle the given flag for the selected node]: :-> flag'\ '*'{-i,--insert-receptacle}'[Insert a receptacle node at the selected node]'\ '*'{-k,--kill}'[Kill the windows rooted at the selected node]'\ '*'{-l,--layer}"[Set the stacking layer of the selected window]:stacking layer:($layer)"\ - '*'{-m,--to-monitor}'[Send the selected node to the given monitor]:monitor selector:_bspc_selector -- monitor'\ - '*'{-n,--to-node}'[Transplant the selected node to the given node]:node selector:_bspc_selector -- node'\ + '*'{-m,--to-monitor}'[Send the selected node to the given monitor]:monitor selector:_tspc_selector -- monitor'\ + '*'{-n,--to-node}'[Transplant the selected node to the given node]:node selector:_tspc_selector -- node'\ '*'{-o,--presel-ratio}'[Set the splitting ratio of the preselection area]:preselect ratio: ( )'\ - '*'{-p,--presel-dir}'[Preselect the splitting area of the selected node or cancel the preselection]: :_bspc_prefix -- "~" preselect presel_dir'\ + '*'{-p,--presel-dir}'[Preselect the splitting area of the selected node or cancel the preselection]: :_tspc_prefix -- "~" preselect presel_dir'\ '*'{-y,--type}'[Set the splitting type of the selected node]: :(horizontal vertical)'\ '*'{-r,--ratio}'[Set the splitting ratio of the selected node (0 < ratio < 1)]: :( )'\ '*'{-R,--rotate}'[Rotate the tree rooted at the selected node]:angle:(90 270 180)'\ - '*'{-s,--swap}'[Swap the selected node with the given node]:node selector:_bspc_selector -- node'\ - '*'{-t,--state}'[Set the state of the selected window]: :_bspc_prefix -- "~" "node state" node_state '\ + '*'{-s,--swap}'[Swap the selected node with the given node]:node selector:_tspc_selector -- node'\ + '*'{-t,--state}'[Set the state of the selected window]: :_tspc_prefix -- "~" "node state" node_state '\ '*'{-v,--move}'[Move the selected window by dx pixels horizontally and dy pixels vertically]:dx:( ):dy:( )'\ '*'{-z,--resize}"[Resize the selected window by moving the given handle by dx pixels horizontally and dy pixels vertically]:handle:($resize_handle):dx:( ):dy:( )" [ "$state" = flag ] && _values 'flag' "${flag[@]:#urgent}::set flag:(on off)" ;; (desktop) - ((CURRENT==2)) && _bspc_selector desktop + ((CURRENT==2)) && _tspc_selector desktop ((CURRENT>2)) && [[ "$words[2]" != '-'* ]] && compset -n 2 ((CURRENT>2)) && [[ "$words[CURRENT-2]" =~ "^-m|-s|--monitor|--swap$" ]] && _values 'option' '--follow[If passed, the focused desktop will stay focused]' _arguments \ - '*'{-a,--activate}'[Activate the selected or given desktop]:: :_bspc_selector -- desktop'\ + '*'{-a,--activate}'[Activate the selected or given desktop]:: :_tspc_selector -- desktop'\ '*'{-b,--bubble}"[Bubble the selected desktop in the given direction]:direction:($cycle_dir)"\ - '*'{-f,--focus}'[Focus the selected or given desktop]:: :_bspc_selector -- desktop'\ + '*'{-f,--focus}'[Focus the selected or given desktop]:: :_tspc_selector -- desktop'\ '*'{-l,--layout}"[Set or cycle the layout of the selected desktop]:desktop layout:($cycle_dir monocle tiled)"\ - '*'{-m,--to-monitor}'[Send the selected desktop to the given monitor]: :_bspc_selector -- monitor'\ + '*'{-m,--to-monitor}'[Send the selected desktop to the given monitor]: :_tspc_selector -- monitor'\ '*'{-n,--rename}'[Rename the selected desktop]:desktop name:( )'\ '*'{-r,--remove}'[Remove the selected desktop]'\ - '*'{-s,--swap}'[Swap the selected desktop with the given desktop]: :_bspc_selector -- desktop' + '*'{-s,--swap}'[Swap the selected desktop with the given desktop]: :_tspc_selector -- desktop' ;; (monitor) - ((CURRENT==2)) && _bspc_selector monitor + ((CURRENT==2)) && _tspc_selector monitor ((CURRENT>2)) && [[ "$words[2]" != '-'* ]] && compset -n 2 _arguments \ '*'{-a,--add-desktops}'[Create desktops with the given names in the selected monitor]:*:add desktops:( )'\ '*'{-d,--reset-desktops}'[Rename, add or remove desktops]:*: :->desktops'\ - '*'{-f,--focus}'[Focus the selected or given monitor]:: :_bspc_selector -- monitor'\ + '*'{-f,--focus}'[Focus the selected or given monitor]:: :_tspc_selector -- monitor'\ '*'{-g,--rectangle}'[Set the rectangle of the selected monitor]:WxH+X+Y:( )'\ '*'{-n,--rename}'[Rename the selected monitor]: :( )'\ - '*'{-o,--reorder-desktops}'[Reorder the desktops of the selected monitor]:*:reorder desktops:_bspc_query_names -- desktops -D'\ + '*'{-o,--reorder-desktops}'[Reorder the desktops of the selected monitor]:*:reorder desktops:_tspc_query_names -- desktops -D'\ '*'{-r,--remove}'[Remove the selected monitor]'\ - '*'{-s,--swap}'[Swap the selected monitor with the given monitor]: :_bspc_selector -- monitor' + '*'{-s,--swap}'[Swap the selected monitor with the given monitor]: :_tspc_selector -- monitor' ;; (query) local -a cmds_no_names=('-T' '--tree' '-N' '--nodes') local -a cmds=($cmds_no_names '-D' '--desktops' '-M' '--monitors') _arguments \ - '*'{-d,--desktop}'[Constrain matches to the selected desktop]: :_bspc_selector -- desktop'\ - '*'{-m,--monitor}'[Constrain matches to the selected monitor]: :_bspc_selector -- monitor'\ - '*'{-n,--node}'[Constrain matches to the selected node]: :_bspc_selector -- node'\ + '*'{-d,--desktop}'[Constrain matches to the selected desktop]: :_tspc_selector -- desktop'\ + '*'{-m,--monitor}'[Constrain matches to the selected monitor]: :_tspc_selector -- monitor'\ + '*'{-n,--node}'[Constrain matches to the selected node]: :_tspc_selector -- node'\ "($cmds_no_names --names)--names[Print names instead of IDs. Can only be used with -M and -D]"\ "($cmds --names)"{-N,--nodes}'[List the IDs of the matching nodes]'\ "($cmds --names)"{-T,--tree}'[Print a JSON representation of the matching item]'\ @@ -233,7 +233,7 @@ _bspc() { '*'{-d,--dump-state}'[Dump the current world state on standard output]'\ '*'{-l,--load-state}'[Load a world state from the given file]:load state from file:_files'\ '*'{-a,--add-monitor}'[Add a monitor for the given name and rectangle]:add monitor:( )'\ - '*'{-O,--reorder-monitors}'[Reorder the list of monitors to match the given order]:*: :_bspc_query_names -- monitors -M'\ + '*'{-O,--reorder-monitors}'[Reorder the list of monitors to match the given order]:*: :_tspc_query_names -- monitors -M'\ '*'{-o,--adopt-orphans}'[Manage all the unmanaged windows remaining from a previous session]'\ '*'{-h,--record-history}'[Enable or disable the recording of node focus history]:history:(on off)'\ '*'{-g,--get-status}'[Print the current status information]'\ @@ -243,7 +243,7 @@ _bspc() { if [[ "$words[CURRENT-1]" != (-c|--count) ]] ;then _values -w "options" \ '(-f --fifo)'{-f,--fifo}'[Print a path to a FIFO from which events can be read and return]'\ - '(-c --count)'{-c,--count}'[Stop the corresponding bspc process after having received specified count of events]' + '(-c --count)'{-c,--count}'[Stop the corresponding tspc process after having received specified count of events]' _values -w -S "_" events all report pointer_action \ "monitor:: :(add rename remove swap focus geometry)"\ "desktop:: :(add rename remove swap transfer focus activate layout)"\ @@ -261,9 +261,9 @@ _bspc() { case $state$CURRENT in (add1) compset -P '*:' - bspc query -N -n '.window' 2> /dev/null | + tspc query -N -n '.window' 2> /dev/null | while read id ; do - json=$(bspc query -T -n $id 2>/dev/null) || continue + json=$(tspc query -T -n $id 2>/dev/null) || continue [[ "$json[1]" = '{' ]] || continue class=${${json##*\"className\":\"}%%\",\"*} instance=${${json##*\"instanceName\":\"}%%\",\"*} @@ -281,9 +281,9 @@ _bspc() { _values -w 'add rule' {border,focus,follow,manage,center}': :(on off)'\ '(--one-shot)-o'\ '(-o)--one-shot'\ - 'monitor: :_bspc_selector -- monitor'\ - 'desktop: :_bspc_selector -- desktop'\ - 'node: :_bspc_selector -- node'\ + 'monitor: :_tspc_selector -- monitor'\ + 'desktop: :_tspc_selector -- desktop'\ + 'node: :_tspc_selector -- node'\ 'rectangle: :( )'\ 'split_ratio:split ratio:( )'\ "split_dir:split direction:(${dir})"\ @@ -294,7 +294,7 @@ _bspc() { ;; (remove*) compset -P '*:' - bspc rule -l 2> /dev/null | + tspc rule -l 2> /dev/null | while IFS=" " read target settings ;do by_index+="^$((++index)):${target} ${settings}" if [ -n "$IPREFIX" ] ;then @@ -325,9 +325,9 @@ _bspc() { input=(click_to_focus pointer_motion_interval pointer_modifier pointer_action{1,2,3}) if [[ "$CURRENT" == (2|3) ]];then _arguments \ - '-d[Set settings for the selected desktop]: :_bspc_selector -- desktop'\ - '-m[Set settings for the selected monitor]: :_bspc_selector -- monitor'\ - '-n[Set settings for the selected node]: :_bspc_selector -- node' + '-d[Set settings for the selected desktop]: :_tspc_selector -- desktop'\ + '-m[Set settings for the selected monitor]: :_tspc_selector -- monitor'\ + '-n[Set settings for the selected node]: :_tspc_selector -- node' fi if [[ "${words[2]}" == -* ]] ;then (( CURRENT == 3 )) && return @@ -372,4 +372,4 @@ _bspc() { esac } -_bspc "$@" +_tspc "$@" diff --git a/doc/tspc.1 b/doc/tspc.1 new file mode 120000 index 0000000..c4543c7 --- /dev/null +++ b/doc/tspc.1 @@ -0,0 +1 @@ +tspwm.1 \ No newline at end of file diff --git a/doc/tspwm.1 b/doc/tspwm.1 new file mode 100644 index 0000000..f034e8c --- /dev/null +++ b/doc/tspwm.1 @@ -0,0 +1,1689 @@ +'\" t +.\" Title: bspwm +.\" Author: [see the "Author" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 04/05/2023 +.\" Manual: Bspwm Manual +.\" Source: Bspwm 0.9.10-49-gc58c67a +.\" Language: English +.\" +.TH "BSPWM" "1" "04/05/2023" "Bspwm 0\&.9\&.10\-49\-gc58c67a" "Bspwm Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +bspwm \- Binary space partitioning window manager +.SH "SYNOPSIS" +.sp +\fBbspwm\fR [\fB\-h\fR|\fB\-v\fR|\fB\-c\fR \fICONFIG_PATH\fR] +.sp +\fBbspc \-\-print\-socket\-path\fR +.sp +\fBbspc\fR \fIDOMAIN\fR [\fISELECTOR\fR] \fICOMMANDS\fR +.sp +\fBbspc\fR \fICOMMAND\fR [\fIOPTIONS\fR] [\fIARGUMENTS\fR] +.SH "DESCRIPTION" +.sp +\fBbspwm\fR is a tiling window manager that represents windows as the leaves of a full binary tree\&. +.sp +It is controlled and configured via \fBbspc\fR\&. +.SH "OPTIONS" +.PP +\fB\-h\fR +.RS 4 +Print the synopsis and exit\&. +.RE +.PP +\fB\-v\fR +.RS 4 +Print the version and exit\&. +.RE +.PP +\fB\-c\fR \fICONFIG_PATH\fR +.RS 4 +Use the given configuration file\&. +.RE +.PP +\fB\-\-print\-socket\-path\fR +.RS 4 +Print the +\fBbspwm\fR +socket path and exit\&. +.RE +.SH "COMMON DEFINITIONS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +DIR := north | west | south | east +CYCLE_DIR := next | prev +.fi +.if n \{\ +.RE +.\} +.SH "SELECTORS" +.sp +Selectors are used to select a target node, desktop, or monitor\&. A selector can either describe the target relatively or name it globally\&. +.sp +Selectors consist of an optional reference, a descriptor and any number of non\-conflicting modifiers as follows: +.sp +.if n \{\ +.RS 4 +.\} +.nf +[REFERENCE#]DESCRIPTOR(\&.MODIFIER)* +.fi +.if n \{\ +.RE +.\} +.sp +The relative targets are computed in relation to the given reference (the default reference value is \fBfocused\fR)\&. +.sp +An exclamation mark can be prepended to any modifier in order to reverse its meaning\&. +.sp +The following characters cannot be used in monitor or desktop names: \fB#\fR, \fB:\fR, \fB\&.\fR\&. +.sp +The special selector \fB%\fR can be used to select a monitor or a desktop with an invalid name\&. +.SS "Node" +.sp +Select a node\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +NODE_SEL := [NODE_SEL#](DIR|CYCLE_DIR|PATH|any|first_ancestor|last|newest| + older|newer|focused|pointed|biggest|smallest| + )[\&.[!]focused][\&.[!]active][\&.[!]automatic][\&.[!]local] + [\&.[!]leaf][\&.[!]window][\&.[!]STATE][\&.[!]FLAG][\&.[!]LAYER][\&.[!]SPLIT_TYPE] + [\&.[!]same_class][\&.[!]descendant_of][\&.[!]ancestor_of] + +STATE := tiled|pseudo_tiled|floating|fullscreen + +FLAG := hidden|sticky|private|locked|marked|urgent + +LAYER := below|normal|above + +SPLIT_TYPE := horizontal|vertical + +PATH := @[DESKTOP_SEL:][[/]JUMP](/JUMP)* + +JUMP := first|1|second|2|brother|parent|DIR +.fi +.if n \{\ +.RE +.\} +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBDescriptors\fR +.RS 4 +.PP +\fIDIR\fR +.RS 4 +Selects the window in the given (spacial) direction relative to the reference node\&. +.RE +.PP +\fICYCLE_DIR\fR +.RS 4 +Selects the node in the given (cyclic) direction relative to the reference node within a depth\-first in\-order traversal of the tree\&. +.RE +.PP +\fIPATH\fR +.RS 4 +Selects the node at the given path\&. +.RE +.PP +any +.RS 4 +Selects the first node that matches the given selectors\&. +.RE +.PP +first_ancestor +.RS 4 +Selects the first ancestor of the reference node that matches the given selectors\&. +.RE +.PP +last +.RS 4 +Selects the previously focused node relative to the reference node\&. +.RE +.PP +newest +.RS 4 +Selects the newest node in the history of the focused node\&. +.RE +.PP +older +.RS 4 +Selects the node older than the reference node in the history\&. +.RE +.PP +newer +.RS 4 +Selects the node newer than the reference node in the history\&. +.RE +.PP +focused +.RS 4 +Selects the currently focused node\&. +.RE +.PP +pointed +.RS 4 +Selects the leaf under the pointer\&. +.RE +.PP +biggest +.RS 4 +Selects the biggest leaf\&. +.RE +.PP +smallest +.RS 4 +Selects the smallest leaf\&. +.RE +.PP + +.RS 4 +Selects the node with the given ID\&. +.RE +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBPath Jumps\fR +.RS 4 +.sp +The initial node is the focused node (or the root if the path starts with \fI/\fR) of the reference desktop (or the selected desktop if the path has a \fIDESKTOP_SEL\fR prefix)\&. +.PP +1|first +.RS 4 +Jumps to the first child\&. +.RE +.PP +2|second +.RS 4 +Jumps to the second child\&. +.RE +.PP +brother +.RS 4 +Jumps to the brother node\&. +.RE +.PP +parent +.RS 4 +Jumps to the parent node\&. +.RE +.PP +\fIDIR\fR +.RS 4 +Jumps to the node holding the edge in the given direction\&. +.RE +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBModifiers\fR +.RS 4 +.PP +[!]focused +.RS 4 +Only consider the focused node\&. +.RE +.PP +[!]active +.RS 4 +Only consider nodes that are the focused node of their desktop\&. +.RE +.PP +[!]automatic +.RS 4 +Only consider nodes in automatic insertion mode\&. See also +\fB\-\-presel\-dir\fR +under +\fBNode\fR +in the +\fBDOMAINS\fR +section below\&. +.RE +.PP +[!]local +.RS 4 +Only consider nodes in the reference desktop\&. +.RE +.PP +[!]leaf +.RS 4 +Only consider leaf nodes\&. +.RE +.PP +[!]window +.RS 4 +Only consider nodes that hold a window\&. +.RE +.PP +[!](tiled|pseudo_tiled|floating|fullscreen) +.RS 4 +Only consider windows in the given state\&. +.RE +.PP +[!]same_class +.RS 4 +Only consider windows that have the same class as the reference window\&. +.RE +.PP +[!]descendant_of +.RS 4 +Only consider nodes that are descendants of the reference node\&. +.RE +.PP +[!]ancestor_of +.RS 4 +Only consider nodes that are ancestors of the reference node\&. +.RE +.PP +[!](hidden|sticky|private|locked|marked|urgent) +.RS 4 +Only consider windows that have the given flag set\&. +.RE +.PP +[!](below|normal|above) +.RS 4 +Only consider windows in the given layer\&. +.RE +.PP +[!](horizontal|vertical) +.RS 4 +Only consider nodes with the given split type\&. +.RE +.RE +.SS "Desktop" +.sp +Select a desktop\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +DESKTOP_SEL := [DESKTOP_SEL#](CYCLE_DIR|any|last|newest|older|newer| + [MONITOR_SEL:](focused|^)| + |)[\&.[!]focused][\&.[!]active] + [\&.[!]occupied][\&.[!]urgent][\&.[!]local] + [\&.[!]LAYOUT][\&.[!]user_LAYOUT] + +LAYOUT := tiled|monocle +.fi +.if n \{\ +.RE +.\} +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBDescriptors\fR +.RS 4 +.PP +\fICYCLE_DIR\fR +.RS 4 +Selects the desktop in the given direction relative to the reference desktop\&. +.RE +.PP +any +.RS 4 +Selects the first desktop that matches the given selectors\&. +.RE +.PP +last +.RS 4 +Selects the previously focused desktop relative to the reference desktop\&. +.RE +.PP +newest +.RS 4 +Selects the newest desktop in the history of the focused desktops\&. +.RE +.PP +older +.RS 4 +Selects the desktop older than the reference desktop in the history\&. +.RE +.PP +newer +.RS 4 +Selects the desktop newer than the reference desktop in the history\&. +.RE +.PP +focused +.RS 4 +Selects the currently focused desktop\&. +.RE +.PP +^ +.RS 4 +Selects the nth desktop\&. If +\fBMONITOR_SEL\fR +is given, selects the nth desktop on the selected monitor\&. +.RE +.PP + +.RS 4 +Selects the desktop with the given ID\&. +.RE +.PP + +.RS 4 +Selects the desktop with the given name\&. +.RE +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBModifiers\fR +.RS 4 +.PP +[!]focused +.RS 4 +Only consider the focused desktop\&. +.RE +.PP +[!]active +.RS 4 +Only consider desktops that are the focused desktop of their monitor\&. +.RE +.PP +[!]occupied +.RS 4 +Only consider occupied desktops\&. +.RE +.PP +[!]urgent +.RS 4 +Only consider urgent desktops\&. +.RE +.PP +[!]local +.RS 4 +Only consider desktops inside the reference monitor\&. +.RE +.PP +[!](tiled|monocle) +.RS 4 +Only consider desktops with the given layout\&. +.RE +.PP +[!](user_tiled|user_monocle) +.RS 4 +Only consider desktops which have the given layout as userLayout\&. +.RE +.RE +.SS "Monitor" +.sp +Select a monitor\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +MONITOR_SEL := [MONITOR_SEL#](DIR|CYCLE_DIR|any|last|newest|older|newer| + focused|pointed|primary|^| + |)[\&.[!]focused][\&.[!]occupied] +.fi +.if n \{\ +.RE +.\} +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBDescriptors\fR +.RS 4 +.PP +\fIDIR\fR +.RS 4 +Selects the monitor in the given (spacial) direction relative to the reference monitor\&. +.RE +.PP +\fICYCLE_DIR\fR +.RS 4 +Selects the monitor in the given (cyclic) direction relative to the reference monitor\&. +.RE +.PP +any +.RS 4 +Selects the first monitor that matches the given selectors\&. +.RE +.PP +last +.RS 4 +Selects the previously focused monitor relative to the reference monitor\&. +.RE +.PP +newest +.RS 4 +Selects the newest monitor in the history of the focused monitors\&. +.RE +.PP +older +.RS 4 +Selects the monitor older than the reference monitor in the history\&. +.RE +.PP +newer +.RS 4 +Selects the monitor newer than the reference monitor in the history\&. +.RE +.PP +focused +.RS 4 +Selects the currently focused monitor\&. +.RE +.PP +pointed +.RS 4 +Selects the monitor under the pointer\&. +.RE +.PP +primary +.RS 4 +Selects the primary monitor\&. +.RE +.PP +^ +.RS 4 +Selects the nth monitor\&. +.RE +.PP + +.RS 4 +Selects the monitor with the given ID\&. +.RE +.PP + +.RS 4 +Selects the monitor with the given name\&. +.RE +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBModifiers\fR +.RS 4 +.PP +[!]focused +.RS 4 +Only consider the focused monitor\&. +.RE +.PP +[!]occupied +.RS 4 +Only consider monitors where the focused desktop is occupied\&. +.RE +.RE +.SH "WINDOW STATES" +.PP +tiled +.RS 4 +Its size and position are determined by the window tree\&. +.RE +.PP +pseudo_tiled +.RS 4 +A tiled window that automatically shrinks but doesn\(cqt stretch beyond its floating size\&. +.RE +.PP +floating +.RS 4 +Can be moved/resized freely\&. Although it doesn\(cqt use any tiling space, it is still part of the window tree\&. +.RE +.PP +fullscreen +.RS 4 +Fills its monitor rectangle and has no borders\&. +.RE +.SH "NODE FLAGS" +.PP +hidden +.RS 4 +Is hidden and doesn\(cqt occupy any tiling space\&. +.RE +.PP +sticky +.RS 4 +Stays in the focused desktop of its monitor\&. +.RE +.PP +private +.RS 4 +Tries to keep the same tiling position/size\&. +.RE +.PP +locked +.RS 4 +Ignores the +\fBnode \-\-close\fR +message\&. +.RE +.PP +marked +.RS 4 +Is marked (useful for deferred actions)\&. A marked node becomes unmarked after being sent on a preselected node\&. +.RE +.PP +urgent +.RS 4 +Has its urgency hint set\&. This flag is set externally\&. +.RE +.SH "STACKING LAYERS" +.sp +There\(cqs three stacking layers: BELOW, NORMAL and ABOVE\&. +.sp +In each layer, the window are orderered as follow: tiled & pseudo\-tiled < floating < fullscreen\&. +.SH "RECEPTACLES" +.sp +A leaf node that doesn\(cqt hold any window is called a receptacle\&. When a node is inserted on a receptacle in automatic mode, it will replace the receptacle\&. A receptacle can be inserted on a node, preselected and killed\&. Receptacles can therefore be used to build a tree whose leaves are receptacles\&. Using the appropriate rules, one can then send windows on the leaves of this tree\&. This feature is used in \fIexamples/receptacles\fR to store and recreate layouts\&. +.SH "DOMAINS" +.SS "Node" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBGeneral Syntax\fR +.RS 4 +.sp +node [\fINODE_SEL\fR] \fICOMMANDS\fR +.sp +If \fINODE_SEL\fR is omitted, \fBfocused\fR is assumed\&. +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBCommands\fR +.RS 4 +.PP +\fB\-f\fR, \fB\-\-focus\fR [\fINODE_SEL\fR] +.RS 4 +Focus the selected or given node\&. +.RE +.PP +\fB\-a\fR, \fB\-\-activate\fR [\fINODE_SEL\fR] +.RS 4 +Activate the selected or given node\&. +.RE +.PP +\fB\-d\fR, \fB\-\-to\-desktop\fR \fIDESKTOP_SEL\fR [\fB\-\-follow\fR] +.RS 4 +Send the selected node to the given desktop\&. If +\fB\-\-follow\fR +is passed, the focused node will stay focused\&. +.RE +.PP +\fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR [\fB\-\-follow\fR] +.RS 4 +Send the selected node to the given monitor\&. If +\fB\-\-follow\fR +is passed, the focused node will stay focused\&. +.RE +.PP +\fB\-n\fR, \fB\-\-to\-node\fR \fINODE_SEL\fR [\fB\-\-follow\fR] +.RS 4 +Send the selected node on the given node\&. If +\fB\-\-follow\fR +is passed, the focused node will stay focused\&. +.RE +.PP +\fB\-s\fR, \fB\-\-swap\fR \fINODE_SEL\fR [\fB\-\-follow\fR] +.RS 4 +Swap the selected node with the given node\&. If +\fB\-\-follow\fR +is passed, the focused node will stay focused\&. +.RE +.PP +\fB\-p\fR, \fB\-\-presel\-dir\fR [~]\fIDIR\fR|cancel +.RS 4 +Preselect the splitting area of the selected node (or cancel the preselection)\&. If +\fB~\fR +is prepended to +\fIDIR\fR +and the current preselection direction matches +\fIDIR\fR, then the argument is interpreted as +\fBcancel\fR\&. A node with a preselected area is said to be in "manual insertion mode"\&. +.RE +.PP +\fB\-o\fR, \fB\-\-presel\-ratio\fR \fIRATIO\fR +.RS 4 +Set the splitting ratio of the preselection area\&. +.RE +.PP +\fB\-v\fR, \fB\-\-move\fR \fIdx\fR \fIdy\fR +.RS 4 +Move the selected window by +\fIdx\fR +pixels horizontally and +\fIdy\fR +pixels vertically\&. +.RE +.PP +\fB\-z\fR, \fB\-\-resize\fR top|left|bottom|right|top_left|top_right|bottom_right|bottom_left \fIdx\fR \fIdy\fR +.RS 4 +Resize the selected window by moving the given handle by +\fIdx\fR +pixels horizontally and +\fIdy\fR +pixels vertically\&. +.RE +.PP +\fB\-y\fR, \fB\-\-type\fR \fICYCLE_DIR\fR|horizontal|vertical +.RS 4 +Set or cycle the splitting type of the selected node\&. +.RE +.PP +\fB\-r\fR, \fB\-\-ratio\fR \fIRATIO\fR|(+|\-)(\fIPIXELS\fR|\fIFRACTION\fR) +.RS 4 +Set the splitting ratio of the selected node (0 < +\fIRATIO\fR +< 1)\&. +.RE +.PP +\fB\-R\fR, \fB\-\-rotate\fR \fI90|270|180\fR +.RS 4 +Rotate the tree rooted at the selected node\&. +.RE +.PP +\fB\-F\fR, \fB\-\-flip\fR \fIhorizontal|vertical\fR +.RS 4 +Flip the tree rooted at selected node\&. +.RE +.PP +\fB\-E\fR, \fB\-\-equalize\fR +.RS 4 +Reset the split ratios of the tree rooted at the selected node to their default value\&. +.RE +.PP +\fB\-B\fR, \fB\-\-balance\fR +.RS 4 +Adjust the split ratios of the tree rooted at the selected node so that all windows occupy the same area\&. +.RE +.PP +\fB\-C\fR, \fB\-\-circulate\fR forward|backward +.RS 4 +Circulate the windows of the tree rooted at the selected node\&. +.RE +.PP +\fB\-t\fR, \fB\-\-state\fR ~|[~]\fISTATE\fR +.RS 4 +Set the state of the selected window\&. If +\fB~\fR +is present and the current state matches +\fISTATE\fR, then the argument is interpreted as its last state\&. If the argument is just +\fB~\fR +with +\fISTATE\fR +omitted, then the state of the selected window is set to its last state\&. +.RE +.PP +\fB\-g\fR, \fB\-\-flag\fR hidden|sticky|private|locked|marked[=on|off] +.RS 4 +Set or toggle the given flag for the selected node\&. +.RE +.PP +\fB\-l\fR, \fB\-\-layer\fR below|normal|above +.RS 4 +Set the stacking layer of the selected window\&. +.RE +.PP +\fB\-i\fR, \fB\-\-insert\-receptacle\fR +.RS 4 +Insert a receptacle node at the selected node\&. +.RE +.PP +\fB\-c\fR, \fB\-\-close\fR +.RS 4 +Close the windows rooted at the selected node\&. +.RE +.PP +\fB\-k\fR, \fB\-\-kill\fR +.RS 4 +Kill the windows rooted at the selected node\&. +.RE +.RE +.SS "Desktop" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBGeneral Syntax\fR +.RS 4 +.sp +desktop [\fIDESKTOP_SEL\fR] \fICOMMANDS\fR +.sp +If \fIDESKTOP_SEL\fR is omitted, \fBfocused\fR is assumed\&. +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBCOMMANDS\fR +.RS 4 +.PP +\fB\-f\fR, \fB\-\-focus\fR [\fIDESKTOP_SEL\fR] +.RS 4 +Focus the selected or given desktop\&. +.RE +.PP +\fB\-a\fR, \fB\-\-activate\fR [\fIDESKTOP_SEL\fR] +.RS 4 +Activate the selected or given desktop\&. +.RE +.PP +\fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR [\fB\-\-follow\fR] +.RS 4 +Send the selected desktop to the given monitor\&. If +\fB\-\-follow\fR +is passed, the focused desktop will stay focused\&. +.RE +.PP +\fB\-s\fR, \fB\-\-swap\fR \fIDESKTOP_SEL\fR [\fB\-\-follow\fR] +.RS 4 +Swap the selected desktop with the given desktop\&. If +\fB\-\-follow\fR +is passed, the focused desktop will stay focused\&. +.RE +.PP +\fB\-l\fR, \fB\-\-layout\fR \fICYCLE_DIR\fR|monocle|tiled +.RS 4 +Set or cycle the layout of the selected desktop\&. +.RE +.PP +\fB\-n\fR, \fB\-\-rename\fR +.RS 4 +Rename the selected desktop\&. +.RE +.PP +\fB\-b\fR, \fB\-\-bubble\fR \fICYCLE_DIR\fR +.RS 4 +Bubble the selected desktop in the given direction\&. +.RE +.PP +\fB\-r\fR, \fB\-\-remove\fR +.RS 4 +Remove the selected desktop\&. +.RE +.RE +.SS "Monitor" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBGeneral Syntax\fR +.RS 4 +.sp +monitor [\fIMONITOR_SEL\fR] \fICOMMANDS\fR +.sp +If \fIMONITOR_SEL\fR is omitted, \fBfocused\fR is assumed\&. +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBCommands\fR +.RS 4 +.PP +\fB\-f\fR, \fB\-\-focus\fR [\fIMONITOR_SEL\fR] +.RS 4 +Focus the selected or given monitor\&. +.RE +.PP +\fB\-s\fR, \fB\-\-swap\fR \fIMONITOR_SEL\fR +.RS 4 +Swap the selected monitor with the given monitor\&. +.RE +.PP +\fB\-a\fR, \fB\-\-add\-desktops\fR \&... +.RS 4 +Create desktops with the given names in the selected monitor\&. +.RE +.PP +\fB\-o\fR, \fB\-\-reorder\-desktops\fR \&... +.RS 4 +Reorder the desktops of the selected monitor to match the given order\&. +.RE +.PP +\fB\-d\fR, \fB\-\-reset\-desktops\fR \&... +.RS 4 +Rename, add or remove desktops depending on whether the number of given names is equal, superior or inferior to the number of existing desktops\&. +.RE +.PP +\fB\-g\fR, \fB\-\-rectangle\fR WxH+X+Y +.RS 4 +Set the rectangle of the selected monitor\&. +.RE +.PP +\fB\-n\fR, \fB\-\-rename\fR +.RS 4 +Rename the selected monitor\&. +.RE +.PP +\fB\-r\fR, \fB\-\-remove\fR +.RS 4 +Remove the selected monitor\&. +.RE +.RE +.SS "Query" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBGeneral Syntax\fR +.RS 4 +.sp +query \fICOMMANDS\fR [\fIOPTIONS\fR] +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBCommands\fR +.RS 4 +.sp +The optional selectors are references\&. +.PP +\fB\-N\fR, \fB\-\-nodes\fR [\fINODE_SEL\fR] +.RS 4 +List the IDs of the matching nodes\&. +.RE +.PP +\fB\-D\fR, \fB\-\-desktops\fR [\fIDESKTOP_SEL\fR] +.RS 4 +List the IDs (or names) of the matching desktops\&. +.RE +.PP +\fB\-M\fR, \fB\-\-monitors\fR [\fIMONITOR_SEL\fR] +.RS 4 +List the IDs (or names) of the matching monitors\&. +.RE +.PP +\fB\-T\fR, \fB\-\-tree\fR +.RS 4 +Print a JSON representation of the matching item\&. +.RE +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBOptions\fR +.RS 4 +.PP +\fB\-m\fR,\fB\-\-monitor\fR [\fIMONITOR_SEL\fR|\fIMONITOR_MODIFIERS\fR], \fB\-d\fR,\fB\-\-desktop\fR [\fIDESKTOP_SEL\fR|\fIDESKTOP_MODIFIERS\fR], \fB\-n\fR,\fB\-\-node\fR [\fINODE_SEL\fR|\fINODE_MODIFIERS\fR] +.RS 4 +Constrain matches to the selected monitors, desktops or nodes\&. +.RE +.PP +\fB\-\-names\fR +.RS 4 +Print names instead of IDs\&. Can only be used with +\fI\-M\fR +and +\fI\-D\fR\&. +.RE +.RE +.SS "Wm" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBGeneral Syntax\fR +.RS 4 +.sp +wm \fICOMMANDS\fR +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBCommands\fR +.RS 4 +.PP +\fB\-d\fR, \fB\-\-dump\-state\fR +.RS 4 +Dump the current world state on standard output\&. +.RE +.PP +\fB\-l\fR, \fB\-\-load\-state\fR +.RS 4 +Load a world state from the given file\&. The path must be absolute\&. +.RE +.PP +\fB\-a\fR, \fB\-\-add\-monitor\fR WxH+X+Y +.RS 4 +Add a monitor for the given name and rectangle\&. +.RE +.PP +\fB\-O\fR, \fB\-\-reorder\-monitors\fR \&... +.RS 4 +Reorder the list of monitors to match the given order\&. +.RE +.PP +\fB\-o\fR, \fB\-\-adopt\-orphans\fR +.RS 4 +Manage all the unmanaged windows remaining from a previous session\&. +.RE +.PP +\fB\-h\fR, \fB\-\-record\-history\fR on|off +.RS 4 +Enable or disable the recording of node focus history\&. +.RE +.PP +\fB\-g\fR, \fB\-\-get\-status\fR +.RS 4 +Print the current status information\&. +.RE +.PP +\fB\-r\fR, \fB\-\-restart\fR +.RS 4 +Restart the window manager +.RE +.RE +.SS "Rule" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBGeneral Syntax\fR +.RS 4 +.sp +rule \fICOMMANDS\fR +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBCommands\fR +.RS 4 +.PP +\fB\-a\fR, \fB\-\-add\fR (|*)[:(|*)[:(|*)]] [\fB\-o\fR|\fB\-\-one\-shot\fR] [monitor=MONITOR_SEL|desktop=DESKTOP_SEL|node=NODE_SEL] [state=STATE] [layer=LAYER] [honor_size_hints=(true|false|tiled|floating)] [split_dir=DIR] [split_ratio=RATIO] [(hidden|sticky|private|locked|marked|center|follow|manage|focus|border)=(on|off)] [rectangle=WxH+X+Y] +.RS 4 +Create a new rule\&. Colons in the +\fIinstance_name\fR, +\fIclass_name\fR, or +\fIname\fR +fields can be escaped with a backslash\&. +.RE +.PP +\fB\-r\fR, \fB\-\-remove\fR ^|head|tail|(|*)[:(|*)[:(|*)]]\&... +.RS 4 +Remove the given rules\&. +.RE +.PP +\fB\-l\fR, \fB\-\-list\fR +.RS 4 +List the rules\&. +.RE +.RE +.SS "Config" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBGeneral Syntax\fR +.RS 4 +.PP +config [\-m \fIMONITOR_SEL\fR|\-d \fIDESKTOP_SEL\fR|\-n \fINODE_SEL\fR] [] +.RS 4 +Get or set the value of \&. +.RE +.RE +.SS "Subscribe" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBGeneral Syntax\fR +.RS 4 +.PP +subscribe [\fIOPTIONS\fR] (all|report|monitor|desktop|node|\&...)* +.RS 4 +Continuously print events\&. See the +\fBEVENTS\fR +section for the description of each event\&. +.RE +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBOptions\fR +.RS 4 +.PP +\fB\-f\fR, \fB\-\-fifo\fR +.RS 4 +Print a path to a FIFO from which events can be read and return\&. +.RE +.PP +\fB\-c\fR, \fB\-\-count\fR \fICOUNT\fR +.RS 4 +Stop the corresponding +\fBbspc\fR +process after having received +\fICOUNT\fR +events\&. +.RE +.RE +.SS "Quit" +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBGeneral Syntax\fR +.RS 4 +.PP +quit [] +.RS 4 +Quit with an optional exit status\&. +.RE +.RE +.SH "EXIT CODES" +.sp +If the server can\(cqt handle a message, \fBbspc\fR will return with a non\-zero exit code\&. +.SH "SETTINGS" +.sp +Colors are in the form \fI#RRGGBB\fR, booleans are \fItrue\fR, \fIon\fR, \fIfalse\fR or \fIoff\fR\&. +.sp +All the boolean settings are \fIfalse\fR by default unless stated otherwise\&. +.SS "Global Settings" +.PP +\fInormal_border_color\fR +.RS 4 +Color of the border of an unfocused window\&. +.RE +.PP +\fIactive_border_color\fR +.RS 4 +Color of the border of a focused window of an unfocused monitor\&. +.RE +.PP +\fIfocused_border_color\fR +.RS 4 +Color of the border of a focused window of a focused monitor\&. +.RE +.PP +\fIpresel_feedback_color\fR +.RS 4 +Color of the +\fBnode \-\-presel\-{dir,ratio}\fR +message feedback area\&. +.RE +.PP +\fIsplit_ratio\fR +.RS 4 +Default split ratio\&. +.RE +.PP +\fIstatus_prefix\fR +.RS 4 +Prefix prepended to each of the status lines\&. +.RE +.PP +\fIexternal_rules_command\fR +.RS 4 +Absolute path to the command used to retrieve rule consequences\&. The command will receive the following arguments: window ID, class name, instance name, and intermediate consequences\&. The output of that command must have the following format: +\fBkey1=value1 key2=value2 \&...\fR +(the valid key/value pairs are given in the description of the +\fIrule\fR +command)\&. +.RE +.PP +\fIautomatic_scheme\fR +.RS 4 +The insertion scheme used when the insertion point is in automatic mode\&. Accept the following values: +\fBlongest_side\fR, +\fBalternate\fR, +\fBspiral\fR\&. +.RE +.PP +\fIinitial_polarity\fR +.RS 4 +On which child should a new window be attached when adding a window on a single window tree in automatic mode\&. Accept the following values: +\fBfirst_child\fR, +\fBsecond_child\fR\&. +.RE +.PP +\fIdirectional_focus_tightness\fR +.RS 4 +The tightness of the algorithm used to decide whether a window is on the +\fIDIR\fR +side of another window\&. Accept the following values: +\fBhigh\fR, +\fBlow\fR\&. +.RE +.PP +\fIremoval_adjustment\fR +.RS 4 +Adjust the brother when unlinking a node from the tree in accordance with the automatic insertion scheme\&. +.RE +.PP +\fIpresel_feedback\fR +.RS 4 +Draw the preselection feedback area\&. Defaults to +\fItrue\fR\&. +.RE +.PP +\fIborderless_monocle\fR +.RS 4 +Remove borders of tiled windows for the +\fBmonocle\fR +desktop layout\&. +.RE +.PP +\fIgapless_monocle\fR +.RS 4 +Remove gaps of tiled windows for the +\fBmonocle\fR +desktop layout\&. +.RE +.PP +\fItop_monocle_padding\fR, \fIright_monocle_padding\fR, \fIbottom_monocle_padding\fR, \fIleft_monocle_padding\fR +.RS 4 +Padding space added at the sides of the screen for the +\fBmonocle\fR +desktop layout\&. +.RE +.PP +\fIsingle_monocle\fR +.RS 4 +Set the desktop layout to +\fBmonocle\fR +if there\(cqs only one tiled window in the tree\&. +.RE +.PP +\fIborderless_singleton\fR +.RS 4 +Remove borders of the only window on the only monitor regardless its layout\&. +.RE +.PP +\fIpointer_motion_interval\fR +.RS 4 +The minimum interval, in milliseconds, between two motion notify events\&. +.RE +.PP +\fIpointer_modifier\fR +.RS 4 +Keyboard modifier used for moving or resizing windows\&. Accept the following values: +\fBshift\fR, +\fBcontrol\fR, +\fBlock\fR, +\fBmod1\fR, +\fBmod2\fR, +\fBmod3\fR, +\fBmod4\fR, +\fBmod5\fR\&. +.RE +.PP +\fIpointer_action1\fR, \fIpointer_action2\fR, \fIpointer_action3\fR +.RS 4 +Action performed when pressing +\fIpointer_modifier\fR ++ +\fIbutton\fR\&. Accept the following values: +\fBmove\fR, +\fBresize_side\fR, +\fBresize_corner\fR, +\fBfocus\fR, +\fBnone\fR\&. +.RE +.PP +\fIclick_to_focus\fR +.RS 4 +Button used for focusing a window (or a monitor)\&. The possible values are: +\fBbutton1\fR, +\fBbutton2\fR, +\fBbutton3\fR, +\fBany\fR, +\fBnone\fR\&. Defaults to +\fBbutton1\fR\&. +.RE +.PP +\fIswallow_first_click\fR +.RS 4 +Don\(cqt replay the click that makes a window focused if +\fIclick_to_focus\fR +isn\(cqt +\fBnone\fR\&. +.RE +.PP +\fIfocus_follows_pointer\fR +.RS 4 +Focus the window under the pointer\&. +.RE +.PP +\fIpointer_follows_focus\fR +.RS 4 +When focusing a window, put the pointer at its center\&. +.RE +.PP +\fIpointer_follows_monitor\fR +.RS 4 +When focusing a monitor, put the pointer at its center\&. +.RE +.PP +\fImapping_events_count\fR +.RS 4 +Handle the next +\fBmapping_events_count\fR +mapping notify events\&. A negative value implies that every event needs to be handled\&. +.RE +.PP +\fIignore_ewmh_focus\fR +.RS 4 +Ignore EWMH focus requests coming from applications\&. +.RE +.PP +\fIignore_ewmh_fullscreen\fR +.RS 4 +Block the fullscreen state transitions that originate from an EWMH request\&. The possible values are: +\fBnone\fR, +\fBall\fR, or a comma separated list of the following values: +\fBenter\fR, +\fBexit\fR\&. +.RE +.PP +\fIignore_ewmh_struts\fR +.RS 4 +Ignore strut hinting from clients requesting to reserve space (i\&.e\&. task bars)\&. +.RE +.PP +\fIcenter_pseudo_tiled\fR +.RS 4 +Center pseudo tiled windows into their tiling rectangles\&. Defaults to +\fItrue\fR\&. +.RE +.PP +\fIremove_disabled_monitors\fR +.RS 4 +Consider disabled monitors as disconnected\&. +.RE +.PP +\fIremove_unplugged_monitors\fR +.RS 4 +Remove unplugged monitors\&. +.RE +.PP +\fImerge_overlapping_monitors\fR +.RS 4 +Merge overlapping monitors (the bigger remains)\&. +.RE +.SS "Monitor and Desktop Settings" +.PP +\fItop_padding\fR, \fIright_padding\fR, \fIbottom_padding\fR, \fIleft_padding\fR +.RS 4 +Padding space added at the sides of the monitor or desktop\&. +.RE +.SS "Desktop Settings" +.PP +\fIwindow_gap\fR +.RS 4 +Size of the gap that separates windows\&. +.RE +.SS "Node Settings" +.PP +\fIborder_width\fR +.RS 4 +Window border width\&. +.RE +.PP +\fIhonor_size_hints\fR +.RS 4 +If +\fItrue\fR, apply ICCCM window size hints to all windows\&. If +\fIfloating\fR, only apply them to floating and pseudo tiled windows\&. If +\fItiled\fR, only apply them to tiled windows\&. If +\fIfalse\fR, don\(cqt apply them\&. Defaults to +\fIfalse\fR\&. +.RE +.SH "POINTER BINDINGS" +.PP +\fIclick_to_focus\fR +.RS 4 +Focus the window (or the monitor) under the pointer if the value isn\(cqt +\fBnone\fR\&. +.RE +.PP +\fIpointer_modifier\fR + \fIbutton1\fR +.RS 4 +Move the window under the pointer\&. +.RE +.PP +\fIpointer_modifier\fR + \fIbutton2\fR +.RS 4 +Resize the window under the pointer by dragging the nearest side\&. +.RE +.PP +\fIpointer_modifier\fR + \fIbutton3\fR +.RS 4 +Resize the window under the pointer by dragging the nearest corner\&. +.RE +.sp +The behavior of \fIpointer_modifier\fR + \fIbutton\fR can be modified through the \fIpointer_action\fR setting\&. +.SH "EVENTS" +.PP +\fIreport\fR +.RS 4 +See the next section for the description of the format\&. +.RE +.PP +\fImonitor_add \fR +.RS 4 +A monitor is added\&. +.RE +.PP +\fImonitor_rename \fR +.RS 4 +A monitor is renamed\&. +.RE +.PP +\fImonitor_remove \fR +.RS 4 +A monitor is removed\&. +.RE +.PP +\fImonitor_swap \fR +.RS 4 +A monitor is swapped\&. +.RE +.PP +\fImonitor_focus \fR +.RS 4 +A monitor is focused\&. +.RE +.PP +\fImonitor_geometry \fR +.RS 4 +The geometry of a monitor changed\&. +.RE +.PP +\fIdesktop_add \fR +.RS 4 +A desktop is added\&. +.RE +.PP +\fIdesktop_rename \fR +.RS 4 +A desktop is renamed\&. +.RE +.PP +\fIdesktop_remove \fR +.RS 4 +A desktop is removed\&. +.RE +.PP +\fIdesktop_swap \fR +.RS 4 +A desktop is swapped\&. +.RE +.PP +\fIdesktop_transfer \fR +.RS 4 +A desktop is transferred\&. +.RE +.PP +\fIdesktop_focus \fR +.RS 4 +A desktop is focused\&. +.RE +.PP +\fIdesktop_activate \fR +.RS 4 +A desktop is activated\&. +.RE +.PP +\fIdesktop_layout tiled|monocle\fR +.RS 4 +The layout of a desktop changed\&. +.RE +.PP +\fInode_add \fR +.RS 4 +A node is added\&. +.RE +.PP +\fInode_remove \fR +.RS 4 +A node is removed\&. +.RE +.PP +\fInode_swap \fR +.RS 4 +A node is swapped\&. +.RE +.PP +\fInode_transfer \fR +.RS 4 +A node is transferred\&. +.RE +.PP +\fInode_focus \fR +.RS 4 +A node is focused\&. +.RE +.PP +\fInode_activate \fR +.RS 4 +A node is activated\&. +.RE +.PP +\fInode_presel (dir DIR|ratio RATIO|cancel)\fR +.RS 4 +A node is preselected\&. +.RE +.PP +\fInode_stack below|above \fR +.RS 4 +A node is stacked below or above another node\&. +.RE +.PP +\fInode_geometry \fR +.RS 4 +The geometry of a window changed\&. +.RE +.PP +\fInode_state tiled|pseudo_tiled|floating|fullscreen on|off\fR +.RS 4 +The state of a window changed\&. +.RE +.PP +\fInode_flag hidden|sticky|private|locked|marked|urgent on|off\fR +.RS 4 +One of the flags of a node changed\&. +.RE +.PP +\fInode_layer below|normal|above\fR +.RS 4 +The layer of a window changed\&. +.RE +.PP +\fIpointer_action move|resize_corner|resize_side begin|end\fR +.RS 4 +A pointer action occurred\&. +.RE +.sp +Please note that \fBbspwm\fR initializes monitors before it reads messages on its socket, therefore the initial monitor events can\(cqt be received\&. +.SH "REPORT FORMAT" +.sp +Each report event message is composed of items separated by colons\&. +.sp +Each item has the form \fI\fR where \fI\fR is the first character of the item\&. +.PP +\fIM\fR +.RS 4 +Focused monitor\&. +.RE +.PP +\fIm\fR +.RS 4 +Unfocused monitor\&. +.RE +.PP +\fIO\fR +.RS 4 +Occupied focused desktop\&. +.RE +.PP +\fIo\fR +.RS 4 +Occupied unfocused desktop\&. +.RE +.PP +\fIF\fR +.RS 4 +Free focused desktop\&. +.RE +.PP +\fIf\fR +.RS 4 +Free unfocused desktop\&. +.RE +.PP +\fIU\fR +.RS 4 +Urgent focused desktop\&. +.RE +.PP +\fIu\fR +.RS 4 +Urgent unfocused desktop\&. +.RE +.PP +\fIL(T|M)\fR +.RS 4 +Layout of the focused desktop of a monitor\&. +.RE +.PP +\fIT(T|P|F|=|@)\fR +.RS 4 +State of the focused node of a focused desktop\&. +.RE +.PP +\fIG(S?P?L?M?)\fR +.RS 4 +Active flags of the focused node of a focused desktop\&. +.RE +.SH "ENVIRONMENT VARIABLES" +.PP +\fIBSPWM_SOCKET\fR +.RS 4 +The path of the socket used for the communication between +\fBbspc\fR +and +\fBbspwm\fR\&. If it isn\(cqt defined, then the following path is used: +\fI/tmp/bspwm__\-socket\fR\&. +.RE +.SH "CONTRIBUTORS" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Steven Allen +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Thomas Adam +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Ivan Kanakarakis +.RE +.SH "AUTHOR" +.sp +Bastien Dejean diff --git a/doc/tspwm.1.asciidoc b/doc/tspwm.1.asciidoc new file mode 100644 index 0000000..2834978 --- /dev/null +++ b/doc/tspwm.1.asciidoc @@ -0,0 +1,985 @@ +:man source: Bspwm +:man version: {revnumber} +:man manual: Bspwm Manual + +bspwm(1) +======== + +Name +---- + +bspwm - Binary space partitioning window manager + +Synopsis +-------- + +*bspwm* [*-h*|*-v*|*-c* 'CONFIG_PATH'] + +*bspc --print-socket-path* + +*bspc* 'DOMAIN' ['SELECTOR'] 'COMMANDS' + +*bspc* 'COMMAND' ['OPTIONS'] ['ARGUMENTS'] + +Description +----------- + +*bspwm* is a tiling window manager that represents windows as the leaves of a full binary tree. + +It is controlled and configured via *bspc*. + + +Options +------- + +*-h*:: + Print the synopsis and exit. + +*-v*:: + Print the version and exit. + +*-c* 'CONFIG_PATH':: + Use the given configuration file. + +*--print-socket-path*:: + Print the *bspwm* socket path and exit. + +Common Definitions +------------------ + +---- +DIR := north | west | south | east +CYCLE_DIR := next | prev +---- + +Selectors +--------- + +Selectors are used to select a target node, desktop, or monitor. A selector +can either describe the target relatively or name it globally. + +Selectors consist of an optional reference, a descriptor and any number of +non-conflicting modifiers as follows: + + [REFERENCE#]DESCRIPTOR(.MODIFIER)* + +The relative targets are computed in relation to the given reference (the +default reference value is *focused*). + +An exclamation mark can be prepended to any modifier in order to reverse its +meaning. + +The following characters cannot be used in monitor or desktop names: *#*, *:*, *.*. + +The special selector *%* can be used to select a monitor or a desktop with an invalid name. + +Node +~~~~ + +Select a node. + +---- +NODE_SEL := [NODE_SEL#](DIR|CYCLE_DIR|PATH|any|first_ancestor|last|newest| + older|newer|focused|pointed|biggest|smallest| + )[.[!]focused][.[!]active][.[!]automatic][.[!]local] + [.[!]leaf][.[!]window][.[!]STATE][.[!]FLAG][.[!]LAYER][.[!]SPLIT_TYPE] + [.[!]same_class][.[!]descendant_of][.[!]ancestor_of] + +STATE := tiled|pseudo_tiled|floating|fullscreen + +FLAG := hidden|sticky|private|locked|marked|urgent + +LAYER := below|normal|above + +SPLIT_TYPE := horizontal|vertical + +PATH := @[DESKTOP_SEL:][[/]JUMP](/JUMP)* + +JUMP := first|1|second|2|brother|parent|DIR +---- + +Descriptors +^^^^^^^^^^^ + +'DIR':: + Selects the window in the given (spacial) direction relative to the reference node. + +'CYCLE_DIR':: + Selects the node in the given (cyclic) direction relative to the reference node within a depth-first in-order traversal of the tree. + +'PATH':: + Selects the node at the given path. + +any:: + Selects the first node that matches the given selectors. + +first_ancestor:: + Selects the first ancestor of the reference node that matches the given selectors. + +last:: + Selects the previously focused node relative to the reference node. + +newest:: + Selects the newest node in the history of the focused node. + +older:: + Selects the node older than the reference node in the history. + +newer:: + Selects the node newer than the reference node in the history. + +focused:: + Selects the currently focused node. + +pointed:: + Selects the leaf under the pointer. + +biggest:: + Selects the biggest leaf. + +smallest:: + Selects the smallest leaf. + +:: + Selects the node with the given ID. + +Path Jumps +^^^^^^^^^^ + +The initial node is the focused node (or the root if the path starts with '/') of the reference desktop (or the selected desktop if the path has a 'DESKTOP_SEL' prefix). + +1|first:: + Jumps to the first child. + +2|second:: + Jumps to the second child. + +brother:: + Jumps to the brother node. + +parent:: + Jumps to the parent node. + +'DIR':: + Jumps to the node holding the edge in the given direction. + +Modifiers +^^^^^^^^^ + +[!]focused:: + Only consider the focused node. + +[!]active:: + Only consider nodes that are the focused node of their desktop. + +[!]automatic:: + Only consider nodes in automatic insertion mode. See also *--presel-dir* under *Node* in the *DOMAINS* section below. + +[!]local:: + Only consider nodes in the reference desktop. + +[!]leaf:: + Only consider leaf nodes. + +[!]window:: + Only consider nodes that hold a window. + +[!](tiled|pseudo_tiled|floating|fullscreen):: + Only consider windows in the given state. + +[!]same_class:: + Only consider windows that have the same class as the reference window. + +[!]descendant_of:: + Only consider nodes that are descendants of the reference node. + +[!]ancestor_of:: + Only consider nodes that are ancestors of the reference node. + +[!](hidden|sticky|private|locked|marked|urgent):: + Only consider windows that have the given flag set. + +[!](below|normal|above):: + Only consider windows in the given layer. + +[!](horizontal|vertical):: + Only consider nodes with the given split type. + + +Desktop +~~~~~~~ + +Select a desktop. + +---- +DESKTOP_SEL := [DESKTOP_SEL#](CYCLE_DIR|any|last|newest|older|newer| + [MONITOR_SEL:](focused|^)| + |)[.[!]focused][.[!]active] + [.[!]occupied][.[!]urgent][.[!]local] + [.[!]LAYOUT][.[!]user_LAYOUT] + +LAYOUT := tiled|monocle +---- + +Descriptors +^^^^^^^^^^^ + +'CYCLE_DIR':: + Selects the desktop in the given direction relative to the reference desktop. + +any:: + Selects the first desktop that matches the given selectors. + +last:: + Selects the previously focused desktop relative to the reference desktop. + +newest:: + Selects the newest desktop in the history of the focused desktops. + +older:: + Selects the desktop older than the reference desktop in the history. + +newer:: + Selects the desktop newer than the reference desktop in the history. + +focused:: + Selects the currently focused desktop. + +^:: + Selects the nth desktop. If *MONITOR_SEL* is given, selects the nth desktop on the selected monitor. + +:: + Selects the desktop with the given ID. + +:: + Selects the desktop with the given name. + +Modifiers +^^^^^^^^^ + +[!]focused:: + Only consider the focused desktop. + +[!]active:: + Only consider desktops that are the focused desktop of their monitor. + +[!]occupied:: + Only consider occupied desktops. + +[!]urgent:: + Only consider urgent desktops. + +[!]local:: + Only consider desktops inside the reference monitor. + +[!](tiled|monocle):: + Only consider desktops with the given layout. + +[!](user_tiled|user_monocle):: + Only consider desktops which have the given layout as userLayout. + +Monitor +~~~~~~~ + +Select a monitor. + +---- +MONITOR_SEL := [MONITOR_SEL#](DIR|CYCLE_DIR|any|last|newest|older|newer| + focused|pointed|primary|^| + |)[.[!]focused][.[!]occupied] +---- + +Descriptors +^^^^^^^^^^^ + +'DIR':: + Selects the monitor in the given (spacial) direction relative to the reference monitor. + +'CYCLE_DIR':: + Selects the monitor in the given (cyclic) direction relative to the reference monitor. + +any:: + Selects the first monitor that matches the given selectors. + +last:: + Selects the previously focused monitor relative to the reference monitor. + +newest:: + Selects the newest monitor in the history of the focused monitors. + +older:: + Selects the monitor older than the reference monitor in the history. + +newer:: + Selects the monitor newer than the reference monitor in the history. + +focused:: + Selects the currently focused monitor. + +pointed:: + Selects the monitor under the pointer. + +primary:: + Selects the primary monitor. + +^:: + Selects the nth monitor. + +:: + Selects the monitor with the given ID. + +:: + Selects the monitor with the given name. + + +Modifiers +^^^^^^^^^ + +[!]focused:: + Only consider the focused monitor. + +[!]occupied:: + Only consider monitors where the focused desktop is occupied. + + + +Window States +------------- + +tiled:: + Its size and position are determined by the window tree. + +pseudo_tiled:: + A tiled window that automatically shrinks but doesn't stretch beyond its floating size. + +floating:: + Can be moved/resized freely. Although it doesn't use any tiling space, it is still part of the window tree. + +fullscreen:: + Fills its monitor rectangle and has no borders. + + +Node Flags +---------- + +hidden:: + Is hidden and doesn't occupy any tiling space. + +sticky:: + Stays in the focused desktop of its monitor. + +private:: + Tries to keep the same tiling position/size. + +locked:: + Ignores the *node --close* message. + +marked:: + Is marked (useful for deferred actions). A marked node becomes unmarked after being sent on a preselected node. + +urgent:: + Has its urgency hint set. This flag is set externally. + + +Stacking Layers +-------------- + +There's three stacking layers: BELOW, NORMAL and ABOVE. + +In each layer, the window are orderered as follow: tiled & pseudo-tiled < floating < fullscreen. + +Receptacles +----------- + +A leaf node that doesn't hold any window is called a receptacle. When a node is inserted on a receptacle in automatic mode, it will replace the receptacle. A receptacle can be inserted on a node, preselected and killed. Receptacles can therefore be used to build a tree whose leaves are receptacles. Using the appropriate rules, one can then send windows on the leaves of this tree. This feature is used in 'examples/receptacles' to store and recreate layouts. + + +Domains +------- + +Node +~~~~ + +General Syntax +^^^^^^^^^^^^^^ + +node ['NODE_SEL'] 'COMMANDS' + +If 'NODE_SEL' is omitted, *focused* is assumed. + +Commands +^^^^^^^^ +*-f*, *--focus* ['NODE_SEL']:: + Focus the selected or given node. + +*-a*, *--activate* ['NODE_SEL']:: + Activate the selected or given node. + +*-d*, *--to-desktop* 'DESKTOP_SEL' [*--follow*]:: + Send the selected node to the given desktop. If *--follow* is passed, the focused node will stay focused. + +*-m*, *--to-monitor* 'MONITOR_SEL' [*--follow*]:: + Send the selected node to the given monitor. If *--follow* is passed, the focused node will stay focused. + +*-n*, *--to-node* 'NODE_SEL' [*--follow*]:: + Send the selected node on the given node. If *--follow* is passed, the focused node will stay focused. + +*-s*, *--swap* 'NODE_SEL' [*--follow*]:: + Swap the selected node with the given node. If *--follow* is passed, the focused node will stay focused. + +*-p*, *--presel-dir* \[~]'DIR'|cancel:: + Preselect the splitting area of the selected node (or cancel the preselection). If *~* is prepended to 'DIR' and the current preselection direction matches 'DIR', then the argument is interpreted as *cancel*. A node with a preselected area is said to be in "manual insertion mode". + +*-o*, *--presel-ratio* 'RATIO':: + Set the splitting ratio of the preselection area. + +*-v*, *--move* 'dx' 'dy':: + Move the selected window by 'dx' pixels horizontally and 'dy' pixels vertically. + +*-z*, *--resize* top|left|bottom|right|top_left|top_right|bottom_right|bottom_left 'dx' 'dy':: + Resize the selected window by moving the given handle by 'dx' pixels horizontally and 'dy' pixels vertically. + +*-y*, *--type* 'CYCLE_DIR'|horizontal|vertical:: + Set or cycle the splitting type of the selected node. + +*-r*, *--ratio* 'RATIO'|(+|-)('PIXELS'|'FRACTION'):: + Set the splitting ratio of the selected node (0 < 'RATIO' < 1). + +*-R*, *--rotate* '90|270|180':: + Rotate the tree rooted at the selected node. + +*-F*, *--flip* 'horizontal|vertical':: + Flip the tree rooted at selected node. + +*-E*, *--equalize*:: + Reset the split ratios of the tree rooted at the selected node to their default value. + +*-B*, *--balance*:: + Adjust the split ratios of the tree rooted at the selected node so that all windows occupy the same area. + +*-C*, *--circulate* forward|backward:: + Circulate the windows of the tree rooted at the selected node. + +*-t*, *--state* \~|\[~]'STATE':: + Set the state of the selected window. If *\~* is present and the current state matches 'STATE', then the argument is interpreted as its last state. If the argument is just *~* with 'STATE' omitted, then the state of the selected window is set to its last state. + +*-g*, *--flag* hidden|sticky|private|locked|marked[=on|off]:: + Set or toggle the given flag for the selected node. + +*-l*, *--layer* below|normal|above:: + Set the stacking layer of the selected window. + +*-i*, *--insert-receptacle*:: + Insert a receptacle node at the selected node. + +*-c*, *--close*:: + Close the windows rooted at the selected node. + +*-k*, *--kill*:: + Kill the windows rooted at the selected node. + +Desktop +~~~~~~~ + +General Syntax +^^^^^^^^^^^^^^ + +desktop ['DESKTOP_SEL'] 'COMMANDS' + +If 'DESKTOP_SEL' is omitted, *focused* is assumed. + +COMMANDS +^^^^^^^^ +*-f*, *--focus* ['DESKTOP_SEL']:: + Focus the selected or given desktop. + +*-a*, *--activate* ['DESKTOP_SEL']:: + Activate the selected or given desktop. + +*-m*, *--to-monitor* 'MONITOR_SEL' [*--follow*]:: + Send the selected desktop to the given monitor. If *--follow* is passed, the focused desktop will stay focused. + +*-s*, *--swap* 'DESKTOP_SEL' [*--follow*]:: + Swap the selected desktop with the given desktop. If *--follow* is passed, the focused desktop will stay focused. + +*-l*, *--layout* 'CYCLE_DIR'|monocle|tiled:: + Set or cycle the layout of the selected desktop. + +*-n*, *--rename* :: + Rename the selected desktop. + +*-b*, *--bubble* 'CYCLE_DIR':: + Bubble the selected desktop in the given direction. + +*-r*, *--remove*:: + Remove the selected desktop. + +Monitor +~~~~~~~ + +General Syntax +^^^^^^^^^^^^^^ + +monitor ['MONITOR_SEL'] 'COMMANDS' + +If 'MONITOR_SEL' is omitted, *focused* is assumed. + +Commands +^^^^^^^^ +*-f*, *--focus* ['MONITOR_SEL']:: + Focus the selected or given monitor. + +*-s*, *--swap* 'MONITOR_SEL':: + Swap the selected monitor with the given monitor. + +*-a*, *--add-desktops* ...:: + Create desktops with the given names in the selected monitor. + +*-o*, *--reorder-desktops* ...:: + Reorder the desktops of the selected monitor to match the given order. + +*-d*, *--reset-desktops* ...:: + Rename, add or remove desktops depending on whether the number of given names is equal, superior or inferior to the number of existing desktops. + +*-g*, *--rectangle* WxH+X+Y:: + Set the rectangle of the selected monitor. + +*-n*, *--rename* :: + Rename the selected monitor. + +*-r*, *--remove*:: + Remove the selected monitor. + +Query +~~~~~ + +General Syntax +^^^^^^^^^^^^^^ + +query 'COMMANDS' ['OPTIONS'] + +Commands +^^^^^^^^ + +The optional selectors are references. + +*-N*, *--nodes* ['NODE_SEL']:: + List the IDs of the matching nodes. + +*-D*, *--desktops* ['DESKTOP_SEL']:: + List the IDs (or names) of the matching desktops. + +*-M*, *--monitors* ['MONITOR_SEL']:: + List the IDs (or names) of the matching monitors. + +*-T*, *--tree*:: + Print a JSON representation of the matching item. + +Options +^^^^^^^ + +*-m*,*--monitor* ['MONITOR_SEL'|'MONITOR_MODIFIERS']:: +*-d*,*--desktop* ['DESKTOP_SEL'|'DESKTOP_MODIFIERS']:: +*-n*,*--node* ['NODE_SEL'|'NODE_MODIFIERS']:: + Constrain matches to the selected monitors, desktops or nodes. + +*--names*:: + Print names instead of IDs. Can only be used with '-M' and '-D'. + +Wm +~~ + +General Syntax +^^^^^^^^^^^^^^ + +wm 'COMMANDS' + +Commands +^^^^^^^^ + +*-d*, *--dump-state*:: + Dump the current world state on standard output. + +*-l*, *--load-state* :: + Load a world state from the given file. The path must be absolute. + +*-a*, *--add-monitor* WxH+X+Y:: + Add a monitor for the given name and rectangle. + +*-O*, *--reorder-monitors* ...:: + Reorder the list of monitors to match the given order. + +*-o*, *--adopt-orphans*:: + Manage all the unmanaged windows remaining from a previous session. + +*-h*, *--record-history* on|off:: + Enable or disable the recording of node focus history. + +*-g*, *--get-status*:: + Print the current status information. + +*-r*, *--restart*:: + Restart the window manager + +Rule +~~~~ + +General Syntax +^^^^^^^^^^^^^^ + +rule 'COMMANDS' + +Commands +^^^^^^^^ + +*-a*, *--add* (|\*)[:(|\*)[:(|\*)]] [*-o*|*--one-shot*] [monitor=MONITOR_SEL|desktop=DESKTOP_SEL|node=NODE_SEL] [state=STATE] [layer=LAYER] [honor_size_hints=(true|false|tiled|floating)] [split_dir=DIR] [split_ratio=RATIO] [(hidden|sticky|private|locked|marked|center|follow|manage|focus|border)=(on|off)] [rectangle=WxH+X+Y]:: + Create a new rule. Colons in the 'instance_name', 'class_name', or 'name' + fields can be escaped with a backslash. + +*-r*, *--remove* ^|head|tail|(|\*)[:(|\*)[:(|*)]]...:: + Remove the given rules. + +*-l*, *--list*:: + List the rules. + +Config +~~~~~~ + +General Syntax +^^^^^^^^^^^^^^ + +config [-m 'MONITOR_SEL'|-d 'DESKTOP_SEL'|-n 'NODE_SEL'] []:: + Get or set the value of . + +Subscribe +~~~~~~~~~ + +General Syntax +^^^^^^^^^^^^^^ +subscribe ['OPTIONS'] (all|report|monitor|desktop|node|...)*:: + Continuously print events. See the *EVENTS* section for the description of each event. + +Options +^^^^^^^ + +*-f*, *--fifo*:: + Print a path to a FIFO from which events can be read and return. + +*-c*, *--count* 'COUNT':: + Stop the corresponding *bspc* process after having received 'COUNT' events. + +Quit +~~~~ + +General Syntax +^^^^^^^^^^^^^^ + +quit []:: + Quit with an optional exit status. + +Exit Codes +---------- + +If the server can't handle a message, *bspc* will return with a non-zero exit code. + +Settings +-------- +Colors are in the form '#RRGGBB', booleans are 'true', 'on', 'false' or 'off'. + +All the boolean settings are 'false' by default unless stated otherwise. + +Global Settings +~~~~~~~~~~~~~~~ + +'normal_border_color':: + Color of the border of an unfocused window. + +'active_border_color':: + Color of the border of a focused window of an unfocused monitor. + +'focused_border_color':: + Color of the border of a focused window of a focused monitor. + +'presel_feedback_color':: + Color of the *node --presel-{dir,ratio}* message feedback area. + +'split_ratio':: + Default split ratio. + +'status_prefix':: + Prefix prepended to each of the status lines. + +'external_rules_command':: + Absolute path to the command used to retrieve rule consequences. The command will receive the following arguments: window ID, class name, instance name, and intermediate consequences. The output of that command must have the following format: *key1=value1 key2=value2 ...* (the valid key/value pairs are given in the description of the 'rule' command). + +'automatic_scheme':: + The insertion scheme used when the insertion point is in automatic mode. Accept the following values: *longest_side*, *alternate*, *spiral*. + +'initial_polarity':: + On which child should a new window be attached when adding a window on a single window tree in automatic mode. Accept the following values: *first_child*, *second_child*. + +'directional_focus_tightness':: + The tightness of the algorithm used to decide whether a window is on the 'DIR' side of another window. Accept the following values: *high*, *low*. + +'removal_adjustment':: + Adjust the brother when unlinking a node from the tree in accordance with the automatic insertion scheme. + +'presel_feedback':: + Draw the preselection feedback area. Defaults to 'true'. + +'borderless_monocle':: + Remove borders of tiled windows for the *monocle* desktop layout. + +'gapless_monocle':: + Remove gaps of tiled windows for the *monocle* desktop layout. + +'top_monocle_padding':: +'right_monocle_padding':: +'bottom_monocle_padding':: +'left_monocle_padding':: + Padding space added at the sides of the screen for the *monocle* desktop layout. + +'single_monocle':: + Set the desktop layout to *monocle* if there's only one tiled window in the tree. + +'borderless_singleton':: + Remove borders of the only window on the only monitor regardless its layout. + +'pointer_motion_interval':: + The minimum interval, in milliseconds, between two motion notify events. + +'pointer_modifier':: + Keyboard modifier used for moving or resizing windows. Accept the following values: *shift*, *control*, *lock*, *mod1*, *mod2*, *mod3*, *mod4*, *mod5*. + +'pointer_action1':: +'pointer_action2':: +'pointer_action3':: + Action performed when pressing 'pointer_modifier' + 'button'. Accept the following values: *move*, *resize_side*, *resize_corner*, *focus*, *none*. + +'click_to_focus':: + Button used for focusing a window (or a monitor). The possible values are: *button1*, *button2*, *button3*, *any*, *none*. Defaults to *button1*. + +'swallow_first_click':: + Don't replay the click that makes a window focused if 'click_to_focus' isn't *none*. + +'focus_follows_pointer':: + Focus the window under the pointer. + +'pointer_follows_focus':: + When focusing a window, put the pointer at its center. + +'pointer_follows_monitor':: + When focusing a monitor, put the pointer at its center. + +'mapping_events_count':: + Handle the next *mapping_events_count* mapping notify events. A negative value implies that every event needs to be handled. + +'ignore_ewmh_focus':: + Ignore EWMH focus requests coming from applications. + +'ignore_ewmh_fullscreen':: + Block the fullscreen state transitions that originate from an EWMH request. The possible values are: *none*, *all*, or a comma separated list of the following values: *enter*, *exit*. + +'ignore_ewmh_struts':: + Ignore strut hinting from clients requesting to reserve space (i.e. task bars). + +'center_pseudo_tiled':: + Center pseudo tiled windows into their tiling rectangles. Defaults to 'true'. + +'remove_disabled_monitors':: + Consider disabled monitors as disconnected. + +'remove_unplugged_monitors':: + Remove unplugged monitors. + +'merge_overlapping_monitors':: + Merge overlapping monitors (the bigger remains). + +Monitor and Desktop Settings +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +'top_padding':: +'right_padding':: +'bottom_padding':: +'left_padding':: + Padding space added at the sides of the monitor or desktop. + +Desktop Settings +~~~~~~~~~~~~~~~~ + +'window_gap':: + Size of the gap that separates windows. + +Node Settings +~~~~~~~~~~~~~ + +'border_width':: + Window border width. + +'honor_size_hints':: + If 'true', apply ICCCM window size hints to all windows. If 'floating', only apply them to floating and pseudo tiled windows. If 'tiled', only apply them to tiled windows. If 'false', don't apply them. Defaults to 'false'. + +Pointer Bindings +---------------- + +'click_to_focus':: + Focus the window (or the monitor) under the pointer if the value isn't *none*. + +'pointer_modifier' + 'button1':: + Move the window under the pointer. + +'pointer_modifier' + 'button2':: + Resize the window under the pointer by dragging the nearest side. + +'pointer_modifier' + 'button3':: + Resize the window under the pointer by dragging the nearest corner. + +The behavior of 'pointer_modifier' + 'button' can be modified through the 'pointer_action' setting. + +Events +------ + +'report':: + See the next section for the description of the format. + +'monitor_add ':: + A monitor is added. + +'monitor_rename ':: + A monitor is renamed. + +'monitor_remove ':: + A monitor is removed. + +'monitor_swap ':: + A monitor is swapped. + +'monitor_focus ':: + A monitor is focused. + +'monitor_geometry ':: + The geometry of a monitor changed. + +'desktop_add ':: + A desktop is added. + +'desktop_rename ':: + A desktop is renamed. + +'desktop_remove ':: + A desktop is removed. + +'desktop_swap ':: + A desktop is swapped. + +'desktop_transfer ':: + A desktop is transferred. + +'desktop_focus ':: + A desktop is focused. + +'desktop_activate ':: + A desktop is activated. + +'desktop_layout tiled|monocle':: + The layout of a desktop changed. + +'node_add ':: + A node is added. + +'node_remove ':: + A node is removed. + +'node_swap ':: + A node is swapped. + +'node_transfer ':: + A node is transferred. + +'node_focus ':: + A node is focused. + +'node_activate ':: + A node is activated. + +'node_presel (dir DIR|ratio RATIO|cancel)':: + A node is preselected. + +'node_stack below|above ':: + A node is stacked below or above another node. + +'node_geometry ':: + The geometry of a window changed. + +'node_state tiled|pseudo_tiled|floating|fullscreen on|off':: + The state of a window changed. + +'node_flag hidden|sticky|private|locked|marked|urgent on|off':: + One of the flags of a node changed. + +'node_layer below|normal|above':: + The layer of a window changed. + +'pointer_action move|resize_corner|resize_side begin|end':: + A pointer action occurred. + +Please note that *bspwm* initializes monitors before it reads messages on its socket, therefore the initial monitor events can't be received. + +Report Format +------------- + +Each report event message is composed of items separated by colons. + +Each item has the form '' where '' is the first character of the item. + +'M':: + Focused monitor. + +'m':: + Unfocused monitor. + +'O':: + Occupied focused desktop. + +'o':: + Occupied unfocused desktop. + +'F':: + Free focused desktop. + +'f':: + Free unfocused desktop. + +'U':: + Urgent focused desktop. + +'u':: + Urgent unfocused desktop. + +'L(T|M)':: + Layout of the focused desktop of a monitor. + +'T(T|P|F|=|@)':: + State of the focused node of a focused desktop. + +'G(S?P?L?M?)':: + Active flags of the focused node of a focused desktop. + +Environment Variables +--------------------- + +'BSPWM_SOCKET':: + The path of the socket used for the communication between *bspc* and *bspwm*. If it isn't defined, then the following path is used: '/tmp/bspwm__-socket'. + +Contributors +------------ + +* Steven Allen +* Thomas Adam +* Ivan Kanakarakis + +Author +------ + +Bastien Dejean +