config.h: document everything

This commit is contained in:
Iris Lightshard 2021-03-10 00:21:17 -05:00
parent 836136e153
commit 1102e26707
Signed by: Iris Lightshard
GPG key ID: 3B7FBC22144E6398

View file

@ -3,7 +3,7 @@
**********************/ **********************/
/*************** /***************
* LOOK & FEEL * * LOOK & FEEL * [All of these are required options]
**************/ **************/
/* Border colors */ /* Border colors */
@ -54,8 +54,9 @@
0 \ 0 \
} }
/* Names for the virtual desktops. You can define all 12, or only /* Names for the virtual desktops. Even if you don't use all of them,
* as many as you use. * it's safer to keep dummy or null values for all of them in case you
* start the program with a different number of virtuals by happenstance.
* Remember the backslash at the end of non-terminating lines! * Remember the backslash at the end of non-terminating lines!
*/ */
@ -78,14 +79,14 @@
// clang-format on // clang-format on
/************ /************
* BEHAVIOR * * BEHAVIOR * [Everything in this section is optional unless otherwise noted]
***********/ ***********/
/* This sets the size ratio for windows spawned via keyboard or /* This sets the size ratio for windows spawned via keyboard or
* center-snapped; CENTERNUM should be >= 2, so use 2/4 instead of 1/2 * center-snapped; CENTERNUM should be >= 2, so use 2/4 instead of 1/2
*/ */
#define CENTERNUM 2 #define CENTERNUM 2 // required unless you also comment/omit SNAPCENTER_KEY
#define CENTERDEN 3 #define CENTERDEN 3 // required unless you also comment/omit SNAPCENTER_KEY
/* Centered windows should maximize vertically by default? /* Centered windows should maximize vertically by default?
* This is the behavior of new windows spawned with the launch shortcut * This is the behavior of new windows spawned with the launch shortcut
@ -95,10 +96,10 @@
#define CENTERVMAX #define CENTERVMAX
/* Show 'Maximize' menuitem? */ /* Show 'Maximize' menuitem? */
//#define SHOWMAX // #define SHOWMAX
/* Show 'Stick' menuitem? */ /* Show 'Stick' menuitem? */
//#define SHOWSTICK // #define SHOWSTICK
/* Notify on virtual desktop switch? */ /* Notify on virtual desktop switch? */
#define VIRTNOTIFY #define VIRTNOTIFY
@ -115,20 +116,25 @@
* Remember the backslash at the end of non-terminating lines! * Remember the backslash at the end of non-terminating lines!
*/ */
/* You can remove/comment the entire macro to improve performance if you
* don't use this feature!
*/
#define AUTOSTICK {\ #define AUTOSTICK {\
"XOsview", \ "XOsview", \
"XClock", \ "XClock", \
0 \ 0 \
} }
/* List of window classes to REQUIRE window sweeping when spawning;
* Remember the backslash at the end of non-terminating lines!
*/
#define ALWAYSDRAW {\
"cmapcube", \
0 \
}
// clang-format on // clang-format on
/*************** /***************
* KEYBINDINGS * * KEYBINDINGS * [Any shortcut key can be omitted]
**************/ **************/
/* Modifier key and associated modifier bits; /* Modifier key and associated modifier bits;
@ -146,9 +152,6 @@
#define MODBITS (1 << 6) #define MODBITS (1 << 6)
/* Shortcut keys */ /* Shortcut keys */
/* Any of these can be commented out/omitted if you want to free up
* your keyboard shortcuts for other things. Alt-tab is always bound.
*/
#define MAX_KEY XK_m #define MAX_KEY XK_m
#define ICON_KEY XK_i #define ICON_KEY XK_i