X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;f=dwm.h;h=9b497c9404e5a29b07e04b58b81e4ab45a93e93a;hb=d504005e9117d325456642501b9cc61649b6ffcd;hp=c67004ad95f301433f51336f353008941d935de3;hpb=868159fd0a8ce45f1e362bc762260741eabce4ed;p=dwm.git

diff --git a/dwm.h b/dwm.h
index c67004a..9b497c9 100644
--- a/dwm.h
+++ b/dwm.h
@@ -1,6 +1,35 @@
 /*
  * (C)opyright MMVI Anselm R. Garbe <garbeam at gmail dot com>
  * See LICENSE file for license details.
+ *
+ * dynamic window manager is designed like any other X client as well. It is
+ * driven through handling X events. In contrast to other X clients, a window
+ * manager like dwm selects for SubstructureRedirectMask on the root window, to
+ * receive events about window appearance and disappearance.  Only one X
+ * connection at a time is allowed to select for this event mask.
+ *
+ * Calls to fetch an X event from the X event queue connection are blocking.
+ * Due reading status text from standard input, a select-driven main loop has
+ * been implemented which selects for reads on the X connection and
+ * STDIN_FILENO to handle all data smoothly and without busy-loop quirks. The
+ * event handlers of dwm are organized in an array which is accessed whenever a
+ * new event has been fetched. This allows event dispatching in O(1) time.
+ *
+ * Each child of the root window is called a client, except windows which have
+ * set the override_redirect flag.  Clients are organized in a global
+ * doubly-linked client list, the focus history is remembered through a global
+ * stack list. Each client contains an array of Bools of the same size as the
+ * global tags array to indicate the tags of a client.  For each client dwm
+ * creates a small title window which is resized whenever the WM_NAME or
+ * _NET_WM_NAME properties are updated or the client is resized.
+ *
+ * Keys and tagging rules are organized as arrays and defined in the config.h
+ * file. These arrays are kept static in event.o and tag.o respectively,
+ * because no other part of dwm needs access to them.  The current mode is
+ * represented by the arrange function pointer which wether points to dofloat
+ * or dotile. 
+ *
+ * To understand everything else, start with reading main.c:main().
  */
 
 #include "config.h"