X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=dwm.h;h=8e665eaa02338b0c58521b5278df1b2767325dcd;hb=cbfc69e310e41cf0d9d4ae7529856014f2b88822;hp=c67004ad95f301433f51336f353008941d935de3;hpb=868159fd0a8ce45f1e362bc762260741eabce4ed;p=dwm.git

diff --git a/dwm.h b/dwm.h
index c67004a..8e665ea 100644
--- a/dwm.h
+++ b/dwm.h
@@ -1,6 +1,41 @@
 /*
  * (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 child 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 event queue of the X connection are
+ * blocking.  Due the fact, that dwm reads 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 window of the root window is called a client in window manager
+ * terminology, 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. There are no other data structures to organize the clients
+ * in tag lists. All clients which have at least one tag enabled of the current
+ * tags viewed, will be visible on the screen, all other clients are banned to
+ * the x-location x + 2 * screen width.  This avoids having additional layers
+ * of workspace handling.
+ *
+ * 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"