shod

mouse-based window manager that can tile windows inside floating containers
Log | Files | Refs | README | LICENSE

README (3961B)

      1                                   shod
      2 
      3                              ┌───────────────────────┐
      4                              │                       │
      5                        ┌─────┼─────┬───────────┐     │
      6                        ├─────┴─────┼───────────┤     │
      7                  ┌─────┤           │           │     │
      8                  │     │           │           │     │
      9                  │     │           ├───┬───┬───┤     │
     10                  │     │           ├───┴───┴───┤     │
     11                  │     │           │           ├─────┘
     12                  │     │           │           │
     13                  │     └───────────┴─────┬─────┘
     14                  │                       │
     15                  └───────────────────────┘
     16 
     17 shod is a mouse-based X11 window manager which can tile and tab windows
     18 inside floating containers. To tile windows, drag-and-drop the titlebar
     19 of one window into the border of the other with the right mouse button.
     20 The entire grid of tiles is called “container”, and it can float around
     21 on the screen.
     22 
     23 shod automatically tabs related windows together on the same container.
     24 Dialogs and tornoff menus are only visible when their parent window is
     25 active, and are hidden otherwise.
     26 
     27 shod works via mouse (optionally with a given modifier, ALT by default)
     28 and by responding to client messages sent by the shodc utility  (shod's
     29 remote controller).  With the exception of the ALT-TAB combination (for
     30 cycling windows) shod does no keybinding by itself, and relies on other
     31 applications (such as sxhkd) for that.
     32 
     33 shod displays for each container titlebars with two buttons.  The right
     34 button closes the active window.  The left button calls a command named
     35 shodmenu.  This command is not provided with shod, it should be created
     36 by the user; as, for example, a xmenu script to control the window.
     37 
     38 shod has no default bar.  However shod has a dock where dockapps (small
     39 windows commonly used on other window managers like WindowMaker) can be
     40 placed on.  The dock does not appear unless a dockapp is opened.
     41 
     42 shod can be customized by setting X resources.
     43 
     44 shod was influenced by the following programs and window managers.  I'd
     45 like to thank their authors for the work that helped me writing shod.
     46 • notion: https://github.com/raboof/notion
     47 • wmii:   https://github.com/0intro/wmii
     48 • acme:   http://acme.cat-v.org/
     49 
     50 shod was made after studying the code of the following window managers.
     51 I'd like to thank their authors for the work, that helped me understand
     52 how a X Window Manager works.
     53 • dwm:      https://dwm.suckless.org
     54 • katriawm: https://www.uninformativ.de/git/katriawm/file/README.html
     55 
     56 Screenshots:
     57 See the images in the demos/ directory.
     58 
     59 Changelog:
     60 • 2.6.2 (2023-04-24): Bugfixes (wait for children processes).
     61 • 2.6.1 (2023-04-23): Bugfixes (dockupdate).
     62 • 2.6.0 (2023-04-22): Added auto tabbing, resource reloading, shodc exit.
     63 • 2.5.0 (2022-09-22): Added dockapp state, rio-like hiding, alttab, -d, -t.
     64 • 2.4.0 (2022-02-11): Added window rules, dockapp ordering, -s, -m;
     65 • 2.3.0 (2022-02-11): Added tornoff menu.
     66 • 2.2.0 (2021-12-31): Added dock, -c, snapping, shading, transparency, etc.
     67 • 2.1.4 (2021-09-28): Bugfixes (container placement, manual, shodc).
     68 • 2.1.3 (2021-09-21): Bugfixes (set container properties).
     69 • 2.1.2 (2021-09-20): Bugfixes (dialogs).
     70 • 2.1.1 (2021-09-19): Bugfixes (focus, grabbing and tab attatching).
     71 • 2.1.0 (2021-09-18): Added LICENSE.
     72 • 2.0.0 (2021-09-18): First version with floating tiled containers
     73 • 1.X.X (2020-??-??): First version, no floating tiled containers.