From ba24589c85a2b87fa8789d15c09fb1301f1f31cd Mon Sep 17 00:00:00 2001 From: Abhinav Prasai Date: Wed, 8 Oct 2025 15:21:16 +0100 Subject: update sxwm-dev docs to include headers --- docs/sxwm-dev.md | 41 ++++++++++++++++++++--------------------- src/defs.h | 2 ++ 2 files changed, 22 insertions(+), 21 deletions(-) diff --git a/docs/sxwm-dev.md b/docs/sxwm-dev.md index bc1087f..ee75b16 100644 --- a/docs/sxwm-dev.md +++ b/docs/sxwm-dev.md @@ -1,30 +1,29 @@ # sxwm developer docs # Table of Contents -1. [sxwm.c](#sxwmc) - 1. [Headers](#headers) - 2. [Functions](#functions) +1. [Headers](#headers) +2. [sxwm.c](#sxwmc) + 1. [Functions](#functions) -## sxwm.c -### Headers +## Headers + +| Header | Job | +|------------------------------|--------------------------------------------------------------------------| +| `signal.h` | Signal handling functions and definitions | +| `unistd.h` | Standard POSIX functionality | +| `X11/Xatom.h` | Definitions for Atom types | +| `X11/Xlib.h` | Core X Window System protocol and routines for creating windows | +| `X11/Xproto.h` | Protocol definitions for X Window System communication | +| `X11/Xutil.h` | Used for getting `Hints` about windows | +| `X11/extensions/Xinerama.h` | Xinerama extension definitions for multi-monitor setups | +| `X11/Xcursor/Xcursor.h` | Modern cursor handling | +| `linux/limits.h` | Linux specific limits for various data types | +| | | +| `defs.h` | Custom definitions and macros specific to the application or project | +| `parser.h` | Config file parser components | -| Header | Job | -|------------------------------|----------------------------------------------------------------------------------------------| -| `X11/X.h` | Basic definitions | -| `limits.h` | Defines constants related to data type limits | -| `signal.h` | Signal handling functions and definitions | -| `unistd.h` | Standard symbolic constants and types; includes functions for POSIX operating system API. | -| `X11/Xatom.h` | Definitions for X Window System atom types. | -| `X11/XKBlib.h` | Keyboard interface definitions for X Window System. | -| `X11/Xlib.h` | Core X Window System protocol and routines for creating windows. | -| `X11/Xproto.h` | Protocol definitions for X Window System communication. | -| `X11/Xutil.h` | Utility functions for X Window System, including graphics operations. | -| `X11/extensions/Xinerama.h` | Xinerama extension definitions for multi-monitor setups. | -| `X11/Xcursor/Xcursor.h` | Cursor handling functions and definitions for X Window System. | -| `linux/limits.h` | Linux-specific limits for various data types. | -| `defs.h` | Custom definitions and macros specific to the application or project. | -| `parser.h` | Declarations for functions that parse data or configuration files. | +## sxwm.c ### Functions diff --git a/src/defs.h b/src/defs.h index 1e59e50..1815147 100644 --- a/src/defs.h +++ b/src/defs.h @@ -27,6 +27,8 @@ #define CALL(mod, key, fnptr) {(mod), XK_##key, {.fn = fnptr}, True} #define CMD(name, ...) const char *name[] = {__VA_ARGS__, NULL} +#define PATH_MAX 4096 + /* workspaces */ #define TYPE_FUNC 2 #define TYPE_WS_CHANGE 0 -- cgit v1.2.3