goomwwm.1

.TH GOOMWWM 1 goomwwm
.SH NAME
goomwwm \- Get out of my way, Window Manager!
.SH SYNOPSIS
.B goomwwm
.RB [ \-blur
.IR color ]
.RB [ \-border
.IR pixels ]
.RB [ \-focus
.IR color ]
.RB [ \-attention
.IR color ]
.RB [ \-flashon
.IR color ]
.RB [ \-flashoff
.IR color ]
.RB [ \-flashpx
.IR pixels ]
.RB [ \-flashms
.IR msec ]
.RB [ \-launcher
.IR command ]
.RB [ \-menuwidth
.IR pct_scr ]
.RB [ \-menulines
.IR lines ]
.RB [ \-menufont
.IR xftfont ]
.RB [ \-menufg
.IR color ]
.RB [ \-menubg
.IR color ]
.RB [ \-menuhlfg
.IR color ]
.RB [ \-menuhlbg
.IR color ]
.RB [ \-modkey
.IR mask ]
.RB [ \-switcher
.IR command ]
.RB [ \-1
.IR app ]
.RB [ \-2
.IR app ]
.RB [ \-3
.IR app ]
.RB [ \-4
.IR app ]
.RB [ \-5
.IR app ]
.RB [ \-6
.IR app ]
.RB [ \-7
.IR app ]
.RB [ \-8
.IR app ]
.RB [ \-9
.IR app ]
.RB [ \-0
.IR app ]
.RB [ \-right
.IR key ]
.RB [ \-left
.IR key ]
.RB [ \-up
.IR key ]
.RB [ \-down
.IR key ]
.RB [ \-focusright
.IR key ]
.RB [ \-focusleft
.IR key ]
.RB [ \-focusup
.IR key ]
.RB [ \-focusdown
.IR key ]
.RB [ \-grow
.IR key ]
.RB [ \-shrink
.IR key ]
.RB [ \-fullscreen
.IR key ]
.RB [ \-above
.IR key ]
.RB [ \-vmax
.IR key ]
.RB [ \-hmax
.IR key ]
.RB [ \-expand
.IR key ]
.RB [ \-evmax
.IR key ]
.RB [ \-ehmax
.IR key ]
.RB [ \-tag
.IR key ]
.RB [ \-switch
.IR key ]
.RB [ \-tswitch
.IR key ]
.RB [ \-cycle
.IR key ]
.RB [ \-close
.IR key ]
.RB [ \-htile
.IR key ]
.RB [ \-vtile
.IR key ]
.RB [ \-launch
.IR key ]
.SH DESCRIPTION
.I goomwwm
is an X11 window manager implemented in C as a cleanroom software project. It manages windows in a minimal floating layout with normal mouse controls, while also providing flexible keyboard-driven controls for window switching, sizing, moving, tagging, and tiling. It is fast, lightweight, modeless, Xinerama-aware, and EWMH compatible wherever possible.
.P
Keyboard window movement occurs on a 3x3 fullscreen grid. For example, a top-left aligned window moved to the right would reappear top-center, and if moved again, top-right.
.P
Keyboard window sizing moves windows through four basic sizes that tile well: 1/9th of screen (1/3 width, 1/3 height), 1/4th, 4/9th, and fullscreen. Combined with EWMH horizontal and vertical maxmimization, plus some snap-to-edge and expand-to-fill-space controls, manual tiling is easy.
.P
Windows are grouped by tags. Activating a tag raises all windows in the tag. A window may have multiple tags. EWMH panels, pagers, and taskbars see tags as desktops.
.P
License: MIT/X11
.SH USAGE
See options below for custom key combinations. These are the defaults.
.TP
.B Mod4-Button1
(Mouse!) Move a window.
.TP
.B Mod4-Button3
(Mouse!) Resize a window.
.TP
.B Mod4-[F1-F9]
Set the current tag and raise all its windows. A window may be in multiple tags. For EWMH panel and pager integration tags roughly simulate desktops (always 9), but there will be differences in behavior.
.TP
.B Mod4-[1-9]
Do a case-insensitive keyword search for window by WM_CLASS and title. If found, raise and focus. If not found, try to execute the keyword and start the app. See
.B -1
through
.B -9
args.
.TP
.B Mod4-Tab
Switch between all windows by popup menu. This is partly based on
.B dmenu
but more tightly integrated with the window manager, and centered on screen. Type text to filter the menu entries. Navigate with the arrow keys. Return to select.
.TP
.B Mod4-`
(Grave/Backtick) Switch between all windows in current tag by popup menu.
.TP
.B Mod4-c
Cycle through windows in the same tag, position, and size as the active window.
.TP
.B Mod4-Escape
Close the active window.
.TP
.B Mod4-Page_Up
Grow the active window through four basic sizes that tile well together: 1/9th, 1/4th, 4/9th, or fullscreen.
.TP
.B Mod4-Page_Down
Shrink the active window through the same four sizes.
.TP
.B Mod4-h
Horizontally tile the active window and the highest window with the same tag, position, and size.
.TP
.B Mod4-v
Vertically tile the active window and the highest window with the same tag, position, and size.
.TP
.B Mod4-x
Run the launcher (by default: dmenu_run).
.TP
.B Mod4-a
Toggle _NET_WM_STATE_ABOVE for the active window. Corners will flash to acknowledge.
.TP
.B Mod4-f
Toggle _NET_WM_STATE_FULLSCREEN for the active window. Corners will flash to acknowledge.
.TP
.B Mod4-Home
Toggle _NET_WM_STATE_MAXIMIXED_HORZ for the active window. Corners will flash to acknowledge.
.TP
.B Mod4-End
Toggle _NET_WM_STATE_MAXIMIXED_VERT for the active window. Corners will flash to acknowledge.
.TP
.B Mod4-Return
Expand active window to fill surrounding space without obscuring any fully visible window.
.TP
.B Mod4-Insert
Expand active window vertically to fill adjacent space without obscuring any fully visible window.
.TP
.B Mod4-Delete
Expand active window horizontally to fill adjacent space without obscuring any fully visible window.
.TP
.B Mod4-Left
Move the active window left within a 3x3 grid.
.TP
.B Mod4-Right
Move the active window right within a 3x3 grid.
.TP
.B Mod4-Up
Move the active window up within a 3x3 grid.
.TP
.B Mod4-Down
Move the active window down within a 3x3 grid.
.TP
.B Mod4-j
Switch focus to the left of the active window.
.TP
.B Mod4-l
Switch focus to the right of the active window.
.TP
.B Mod4-i
Switch focus upward from the active window.
.TP
.B Mod4-k
Switch focus downward from the active window.
.TP
.B Mod4-t
Toggle the active window's membership of the current tag.

.SH OPTIONS
.P
All key combinations use the same global modifier key (default: Mod4). If the modkey is changed with
.B -modkey
then all key combinations change to use it. All options below that set a custom key implicitly combine it with the modifier key.
.TP
.B -1 -2 -3 -4 -5 -6 -7 -8 -9
Set a number key to a keyword to search for a window by WM_CLASS or title, and then raise and focus it. If a window is not found, the string supplied will be executed as a shell command to start the application.
.RS
.P
goomwwm -1 chromium -2 firefox -3 xterm
.P
Above, Mod4-1 would match the top-most Chromium window.
.P
Many applications politely set their WM_CLASS to a sane value (eg, Chromium uses Chromium, xterm uses XTerm) or append their name to their window titles, which nicely matches their binary names if we use case-insensitive string comparison. This allows us to use the one string to both search and start.
.P
Applications that are not so friendly can sometimes be wrapped in a shell script of the appropriate name in your $PATH somewhere.
.RE
.TP
.B -above
Set an X11 key name to toggle _NET_WM_STATE_ABOVE for the active window (default: XK_a).
.P
.RS
goomwwm -above a
.RE
.TP
.B -attention
Set the border color (X11 named color or hex #rrggbb) for an inactive window with _NET_WM_STATE_DEMANDS_ATTENTION (default: Red).
.P
.RS
goomwwm -attention Red
.RE
.TP
.B -blur
Set the border color (X11 named color or hex #rrggbb) for unfocused windows (default: Dark Gray).
.P
.RS
goomwwm -blur "Dark Gray"
.RE
.TP
.B -border
Set the border width in pixels for all managed windows (default: 2).
.P
.RS
goomwwm -border 2
.RE
.TP
.B -close
Set an X11 key name to gracefully close the active window (default: XK_Escape).
.P
.RS
goomwwm -close Escape
.RE
.TP
.B -cycle
Set an X11 key name to cycle windows in the same tag, position, and size as the active window (default: XK_c).
.P
.RS
goomwwm -close Escape
.RE
.TP
.B -down
Set an X11 key name to move the active window downward in a 3x3 grid (default: XK_Down).
.P
.RS
goomwwm -down Down
.RE
.TP
.B -expand
Set an X11 key name to expand the active window to fill adjacent space without obscuring any other fully visible window (default: XK_Return).
.P
.RS
goomwwm -expand Return
.RE
.TP
.B -ehmax
Set an X11 key name to expand the active window horizontally to fill adjacent space without obscuring any other fully visible window (default: XK_Delete).
.P
.RS
goomwwm -ehmax Delete
.RE
.TP
.B -evmax
Set an X11 key name to expand the active window vertically to fill adjacent space without obscuring any other fully visible window (default: XK_Insert).
.P
.RS
goomwwm -evmax Insert
.RE
.TP
.B -launch
Set an X11 key to run the application launcher (default: XK_x).
.P
.RS
goomwwm -launch x
.RE
.TP
.B -launcher
Set a custom application launcher to execute on
.B Mod4-x
(default: dmenu_run).
.P
.RS
goomwwm -launcher dmenu_run
.RE
.TP
.B -flashms
Set the duration in milliseconds of the window flash indicators (default: 300).
.P
.RS
goomwwm -flashms 300
.RE
.TP
.B -flashon
Set the color (X11 named color or hex #rrggbb) of the flash indicator when toggling _NET_WM_STATE_* on (default: Dark Green).
.P
.RS
goomwwm -flashon "Dark Green"
.RE
.TP
.B -flashoff
Set the color (X11 named color or hex #rrggbb) of the flash indicator when toggling _NET_WM_STATE_* off (default: Dark Red).
.P
.RS
goomwwm -flashon "Dark Red"
.RE
.TP
.B -flashpx
Set the size in pixels of window flash indicators (currently a colored square in each window corner) (default: 20).
.P
.RS
goomwwm -flashpx 20
.RE
.TP
.B -focus
Set the border color (X11 named color or hex #rrggbb) for the focused window (default: Royal Blue).
.P
.RS
goomwwm -focus "Royal Blue"
.RE
.TP
.B -focusleft
Set an X11 key name to switch focus to left of the active window (default: XK_j).
.P
.RS
goomwwm -focusleft j
.RE
.TP
.B -focusright
Set an X11 key name to switch focus to right of the active window (default: XK_l).
.P
.RS
goomwwm -focusright l
.RE
.TP
.B -focusup
Set an X11 key name to switch focus upward form the active window (default: XK_i).
.P
.RS
goomwwm -focusup i
.RE
.TP
.B -focusdown
Set an X11 key name to switch focus downward form the active window (default: XK_k).
.P
.RS
goomwwm -focusdown k
.RE
.TP
.B -fullscreen
Set an X11 key name to toggle _NET_WM_STATE_FULLSCREEN for the active window (default: XK_f).
.P
.RS
goomwwm -fullscreen f
.RE
.TP
.B -grow
Set an X11 key name to increase the active window size (default: XK_Page_Up) through four basic sizes that tile well together: 1/9th, 1/4th, 4/9th, or fullscreen.
.P
.RS
goomwwm -grow Page_Up
.RE
.TP
.B -hmax
Set an X11 key name to toggle _NET_WM_STATE_MAXIMIXED_HORZ for the active window (default: XK_End).
.P
.RS
goomwwm -hmax End
.RE
.TP
.B -htile
Set an X11 key to horizontally tile the active window and the highest window with the same tag, position, and size (default: XK_h).
.P
.RS
goomwwm -htile h
.RE
.TP
.B -left
Set an X11 key name to move the active window to the left in a 3x3 grid (default: XK_Left).
.P
.RS
goomwwm -left Left
.RE
.TP
.B -menubg
Set the background text color (X11 named color or hex #rrggbb) for the window-switcher menu (default: #222222).
.P
.RS
goomwwm -menufg "#222222"
.RE
.TP
.B -menufg
Set the foreground text color (X11 named color or hex #rrggbb) for the window-switcher menu (default: #cccccc).
.P
.RS
goomwwm -menufg "#cccccc"
.RE
.TP
.B -menufont
Xft font name for use by the window-switcher menu (default: mono-14).
.P
.RS
goomwwm -menufont monospace-14:medium
.RE
.TP
.B -menuhlbg
Set the background text color (X11 named color or hex #rrggbb) for the highlighted item in the window-switcher menu (default: #005577).
.P
.RS
goomwwm -menufg "#005577"
.RE
.TP
.B -menuhlfg
Set the foreground text color (X11 named color or hex #rrggbb) for the highlighted item in the window-switcher menu (default: #ffffff).
.P
.RS
goomwwm -menufg "#ffffff"
.RE
.TP
.B -menulines
Maximum number of entries the window-switcher menu may show before scrolling (default: 25).
.P
.RS
goomwwm -menulines 25
.RE
.TP
.B -menuwidth
Set the width of the window-switcher menu as a percentage of the screen width (default: 60).
.P
.RS
goomwwm -menuwidth 60
.RE
.TP
.B -modkey
Change the modifier key mask to any combination of: shift,control,mod1,mod2,mod3,mod4,mod5 (default: mod4).
.P
.RS
goomwwm -modkey control,shift
.RE
.TP
.B -right
Set an X11 key name to move the active window to the right in a 3x3 grid (default: XK_Right).
.P
.RS
goomwwm -right Right
.RE
.TP
.B -shrink
Set an X11 key name to decrease the active window size (default: XK_Page_Down) through four basic sizes that tile well together: 1/9th, 1/4th, 4/9th, or fullscreen.
.P
.RS
goomwwm -shrink Page_Down
.RE
.TP
.B -switch
Set an X11 key to start display window-switcher showing all open windows (default: XK_Tab).
.P
.RS
goomwwm -switch Tab
.RE
.TP
.B -switcher
Command to run an alternate window-switcher (default: built-in menu).
.P
.RS
goomwwm -switcher dswitch
.RE
.TP
.B -tag
Set an X11 key to toggle the active window's membership of the current tag (default: XK_t).
.P
.RS
goomwwm -tag t
.RE
.TP
.B -tswitch
Set an X11 key to start display window-switcher showing only windows in the current tag (default: XK_grave).
.P
.RS
goomwwm -tswitch grave
.RE
.TP
.B -up
Set an X11 key name to move the active window upward in a 3x3 grid (default: XK_Up).
.P
.RS
goomwwm -up Up
.RE
.TP
.B -vmax
Set an X11 key name to toggle _NET_WM_STATE_MAXIMIXED_VERT for the active window (default: XK_Home).
.P
.RS
goomwwm -vmax Home
.RE
.TP
.B -vtile
Set an X11 key to vertically tile the active window and the highest window with the same tag, position, and size (default: XK_v).
.P
.RS
goomwwm -vtile h
.RE
.SH SEE ALSO
.BR dmenu (1)
.SH AUTHOR
Sean Pringle <sean.pringle@gmail.com>