fixed issue pointed out by Jukka

[dwm.git] / dwm.h

diff --git a/dwm.h b/dwm.h
index c67004a..2298369 100644 (file)
--- 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 selects for SubstructureRedirectMask on the root window, to receive
+ * events about window (dis-)appearance.  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 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. 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 (_NET_)WM_NAME
+ * properties are updated or the client is moved/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 reading main.c:main().
  */
 
 #include "config.h"
@@ -70,7 +99,7 @@ extern unsigned int ntags, numlockmask;               /* number of tags, dynamic lock mask */
 extern void (*handler[LASTEvent])(XEvent *);   /* event handler */
 extern void (*arrange)(Arg *);                 /* arrange function, indicates mode  */
 extern Atom wmatom[WMLast], netatom[NetLast];
-extern Bool running, issel, maximized, *seltag;        /* seltag is array of Bool */
+extern Bool running, issel, *seltag;           /* seltag is array of Bool */
 extern Client *clients, *sel, *stack;          /* global cleint list and stack */
 extern Cursor cursor[CurLast];
 extern DC dc;                                  /* global draw context */
@@ -88,7 +117,6 @@ extern void manage(Window w, XWindowAttributes *wa); /* manage new client */
 extern void resize(Client *c, Bool sizehints, Corner sticky); /* resize c*/
 extern void updatesize(Client *c);                     /* update the size structs of c */
 extern void updatetitle(Client *c);            /* update the name of c */
-extern void togglemax(Arg *arg);               /* (un)maximize c */
 extern void unmanage(Client *c);               /* destroy c */
 
 /* draw.c */