From: A-Larsen
Date: Wed, 14 Oct 2026 22:00:24 +0000 (-0400)
Subject: readme
X-Git-Url: https://nyquistdev.net/git/?a=commitdiff_plain;h=35f4fc9671c411aac83ce4aff488a10da2637163;p=dwm-config.git
readme
---
diff --git a/.images/rules-struct.png b/.images/rules-struct.png
index ef4b26a..47ef5dc 100644
Binary files a/.images/rules-struct.png and b/.images/rules-struct.png differ
diff --git a/README.adoc b/README.adoc
index 918b89d..fb97315 100644
--- a/README.adoc
+++ b/README.adoc
@@ -34,11 +34,14 @@ Extra keyboard shortcuts:
| Super+Shift+w | open sidepanel loader
|===
+== Side Pannel Applications
+
Specific application are designed to be sidepannel application. These are
applications that will only launch on the far right side of your monitor. These
application do not interfere with window tiling functionality to the left of
them.
+
== Tag icons
image::sidepannel-apps.png[tag-icons]
@@ -60,3 +63,58 @@ image::geticon-function.png[tag-icons]
There is also quite a bit of changes to the rules struct.
image::rules-struct.png[rules-struct]
+
+`isSidePannel`::
+ Tells dwm if this is a sidepannel application.
+
+`isCentered`::
+ Tells dwm whether or not to center the application to the middle
+ of the screen.
+
+`layout`::
+ Tells dwm if there is a layout to have the applicatoin launch in, you can
+ have `NULL` to not specify.
+
+`switchto`::
+ Tells dwm if it should focus the application when it launches or launch it
+ silently.
+
+== Dependency Scripts
+
+There are several scripts that work with my DWM config. You can find these
+scripts here: https://nyquistdev.net/git/?p=ubuntu-rice.git;a=tree;f=usr-local-bin;h=HEAD[scripts].
+
+Most of these scripts start with the 'dwm' prefix, for the exception of
+`facecam`, `brightness-launch`, `ffsrec-stop-recoding`, `wake-up`, `ffsrec`.
+That is because those applications can work independently of dwm.
+
+[source, c]
+----
+/* commands */
+static char dmenumon[2] = "0"; /* component of dmenucmd, manipulated in spawn() */
+static const char *dmenucmd[] = { "dmenu_run", "-m", dmenumon, "-fn", dmenufont, "-nb", col_gray1, "-nf", col_gray3, "-sb", col_cyan, "-sf", col_gray4, NULL };
+static const char *termcmd[] = { "alacritty", "--title", "Alacritty", NULL };
+static const char *flameshotcmd[] = { "flameshot", "gui", NULL };
+static const char *suscmd[] = { "systemctl", "suspend", NULL };
+static const char *volupcmd[] = { "/usr/local/bin/dwm_volume_up", NULL };
+static const char *voldowncmd[] = { "/usr/local/bin/dwm_volume_down", NULL };
+static const char *volmutecmd[] = { "/usr/local/bin/dwm_volume_mute", NULL };
+static const char *mixercmd[] = { "/usr/local/bin/dwm-term-toggle", "pulsemixer", NULL };
+static const char *calc_mcw_cmd[] = { "/usr/local/bin/dwm-speedcrunch-move", "cw", NULL };
+static const char *calc_mccw_cmd[] = { "/usr/local/bin/dwm-speedcrunch-move", "ccw", NULL };
+static const char *facecamcmd[] = { "/usr/local/bin/facecam", NULL };
+static const char *cpucmd[] = { "/usr/local/bin/dwm-term-toggle", "htop", NULL };
+static const char *brightnesscmd[] = { "/usr/local/bin/brightness-launch", NULL };
+static const char *ffsrecstartcmd[] = { "/usr/local/bin/ffsrec", NULL };
+static const char *ffsrecstopcmd[] = { "/usr/local/bin/ffsrec-stop-recording", NULL };
+static const char *wakeupcmd[] = { "/usr/local/bin/wake-up", "toggle", NULL };
+static const char *calendarcmd[] = { "/usr/local/bin/dwm-calendar", NULL };
+static const char *windowcontainercmd[] = { "/usr/local/bin/dwm-window-container-toggle", NULL };
+static const char *gotowindowcmd[] = { "/usr/local/bin/dwm-goto-window", NULL };
+----
+
+== Other changes
+
+* each tag has a unique layout
+* gaps for each application
+* centered applicatoins
diff --git a/config.def.h b/config.def.h
index 9bc0e21..1a3e54e 100644
--- a/config.def.h
+++ b/config.def.h
@@ -90,19 +90,11 @@ static const Layout layouts[] = {
};
static const Rule rules[] = {
- /* xprop(1):
- * WM_CLASS(STRING) = instance, class
- * WM_NAME(STRING) = title
- */
- // Keep ffplay floating a and in all tags for facecam script
- // last tag is for calendar
/* class instance title tags mask isfloating isCentered isSidePanel monitor resize hint layout switchto*/
//
{ NULL, NULL, NULL, 0, 1, 1, 0, -1, 0, NULL, 0},
{ NULL, NULL, "facecam", (1<<4)-1, 0, 0, 1, 1, 1, NULL, 0},
- // { "SpeedCrunch", NULL, "calculator", 0, 1, 0, 0, -1, 0, NULL, 0},
{ "SpeedCrunch", NULL, "calculator", 0, 0, 0, 1, 1, 0, NULL, 1},
- //{ "SpeedCrunch", NULL, "SpeedCrunch", 0, 0, 0, 0, -1, 1, NULL, 0},
{ NULL, NULL, "youtube-upload", (1<<9)-1, 1, 0, 0, -1, 0, NULL, 0},
{ NULL, NULL, "Calendar", 0, 0, 0, 0, 1, 0, NULL, 1},
{ "Xephyr", NULL, NULL, 0, 0, 0, 1, 1, 0, NULL, 1},
@@ -121,15 +113,6 @@ static const Rule rules[] = {
{ NULL, NULL, "note", 0, 1, 0, 0, -1, 0, NULL, 0},
{ NULL, NULL, "pulsemixer", (1<<9)-1, 1, 0, 0, 1, 0, NULL, 1},
{ NULL, NULL, "htop", (1<<9)-1, 1, 0, 0, 1, 0, NULL, 1},
- // { NULL, NULL, NULL, 0, 0, 1, 0, -1 },
-
- // there is a possibility to need a terminal in misc tag as well..
- // { NULL, NULL, "Alacritty", 1 << 0, 0, -1 },
- // { "Brave", NULL, NULL, 1 << 1, 0, -1 },
- // { "Gimp", NULL, NULL, 1 << 2, 0, -1 },
- // { "Discord", NULL, NULL, 1 << 3, 0, -1 },
- // { "OBS", NULL, NULL, 1 << 4, 0, -1 },
- // { "KeePassXC", NULL, NULL, 1 << 4, 0, -1 },
};
const char *
diff --git a/rendered.html b/rendered.html
index 81cacc2..3890387 100644
--- a/rendered.html
+++ b/rendered.html
@@ -433,6 +433,88 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
+
@@ -1122,6 +1204,11 @@ changes to the source code.
+
+
+
+
Side Pannel Applications
+
Specific application are designed to be sidepannel application. These are
applications that will only launch on the far right side of your monitor. These
@@ -1169,6 +1256,86 @@ Just find the geticon function and change the icon for your application.
+
+
+
isSidePannel
+
+
Tells dwm if this is a sidepannel application.
+
+
isCentered
+
+
Tells dwm whether or not to center the application to the middle
+of the screen.
+
+
layout
+
+
Tells dwm if there is a layout to have the applicatoin launch in, you can
+have NULL to not specify.
+
+
switchto
+
+
Tells dwm if it should focus the application when it launches or launch it
+silently.
+
+
+
+
+
+
+
Dependency Scripts
+
+
+
There are several scripts that work with my DWM config. You can find these
+scripts here: scripts.
+
+
+
Most of these scripts start with the 'dwm' prefix, for the exception of
+facecam, brightness-launch, ffsrec-stop-recoding, wake-up, ffsrec.
+That is because those applications can work independently of dwm.