aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 91f8a89bcd53216100120478277b05e48273f5f6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
monsterwm
=========

### ~ it's minimal and dynamic

[moetunes][] started this based on [catwm][] 31/12/10 ([ArchLinux forums][catf]) creating [dminiwm][]
Credits and licensing included in `monsterwm.c` and/or `config.def.h`.
For screenshots and ramblings/updates check [the topic on ArchLinux forums][dminif]

  [moetunes]: https://github.com/moetunes
  [catwm]: https://github.com/pyknite/catwm
  [catf]: https://bbs.archlinux.org/viewtopic.php?id=100215&p=1
  [dminiwm]: https://github.com/moetunes/dminiwm
  [dminif]: https://bbs.archlinux.org/viewtopic.php?id=126463


Summary
-------

**monsterwm** is a very minimal, lightweight, monsterous, dynamic tiling window manager.
It will try to stay as small as possible. Currently under 750 lines with the config file included.

Modes
-----

It allows the "normal" method of tiling window managers (with the new window as the master)
and with the new window opened at the bottom of the stack (like `dwm`'s attach\_aside)

---

*Common tiling mode:*

    --------------
    |        | W |
    |        |___|
    | Master |   |
    |        |___|
    |        |   |
    --------------

---

*Bottom Stack (bstack) tiling mode:*

    -------------
    |           |
    |  Master   |
    |-----------|
    | W |   |   |
    -------------

---

 *Grid tiling mode:*

    -------------
    |      | W  |
    |      |    |
    |------|----|
    |      |    |
    -------------

---

 *Monocycle mode* (aka fullscreen - you'll know when you see it)

    -------------
    |           |
    |           |
    |           |
    |           |
    -------------

---

All accessible with keyboard shortcuts defined in the config.h file.

 * The window W at the top of the stack can be resized on a per desktop basis.
 * Changing a tiling mode or window size on one desktop doesn't affect the other desktops.


Installation
------------

You need Xlib, then,
copy the `config.def.h` file as `config.h`
and edit to suit your needs.
Build and install.

    $ cp config.def.h config.h
    $ $EDITOR config.h
    $ make
    # make clean install


Bugs
----

For any bug or request [fill an issue][bug] on [GitHub][ghp]

  [bug]: https://github.com/c00kiemon5ter/monsterwm/issues
  [ghp]: https://github.com/c00kiemon5ter/monsterwm