update markdown

This commit is contained in:
speediegq 2022-10-24 17:52:05 +02:00
parent 7aca3d1a22
commit 5c78817f89

240
README.md
View file

@ -321,53 +321,39 @@ Note that the 'xrdb' dependency is required for both pywal and .Xresources suppo
Below is a list of all .Xresources values you can define. The .Xresources file should be placed in ~ or ~/.config by the user.
If it is not or you want it somewhere else, you can edit 'autostart.h' and 'make clean install'.
- speedwm.bar.height: 8 ! Height of the bar in pixels (<num>)
- speedwm.bar.position: 1 ! Position of the bar (0: Bottom, 1: Top)
- speedwm.bar.paddingh: 10 ! Horizontal padding (extra space) around the bar in pixels (<num>)
- speedwm.bar.paddingv: 10 ! Vertical padding (extra space) around the bar in pixels (<num>)
- speedwm.bar.hide: 0 ! Hide the bar by default (0/1)
- speedwm.bar.hide.tags: 0 ! Hide the tags (0/1)
- speedwm.bar.hide.emptytags: 1 ! Hide the tags that have no windows open (0/1)
- speedwm.bar.hide.powerline: 0 ! Hide the powerline drawn over the tags (0/1)
- speedwm.bar.hide.floating: 0 ! Hide the floating window indicator (0/1)
- speedwm.bar.hide.layout: 0 ! Hide the layout indicator (0/1)
- speedwm.bar.hide.sticky: 0 ! Hide the sticky indicator (0/1)
- speedwm.bar.hide.status: 0 ! Hide the status bar (0/1)
- speedwm.bar.hide.systray: 1 ! Hide the systray (0/1)
- speedwm.bar.hide.title: 0 ! Hide the window title (0/1)
- speedwm.bar.hide.unseltitle: 1 ! Hide the unselected window title (0/1)
- speedwm.bar.hide.icon: 0 ! Hide the window icon (0/1)
- speedwm.bar.layoutposition: 1 ! Position of the layout indicator (0: Right, 1: Left)
- speedwm.border.roundedcorners: 0 ! Enable rounded corners around the border of windows (0/1)
- speedwm.border.cornerradius: 2 ! Corner radius when rounded corners are enabled (<num>)
- speedwm.border.size: 1 ! Size of the border around windows in pixels (<num>)
- speedwm.client.allowurgent: 1 ! Allow windows to have the 'urgent' status (0/1)
- speedwm.client.autoresize: 1 ! Allow windows to resize themselves on demand (0/1)
- speedwm.client.decorhints: 1 ! Respect decoration hints for windows (0/1)
- speedwm.client.fade.inactive: 1 ! Fade inactive windows (windows that are not focused) (0/1)
- speedwm.client.fade.windows: 1 ! Fade windows (0/1)
- speedwm.client.floatscratchpad: 0 ! Float a scratchpad window when it is shown (0/1)
- speedwm.client.savefloat: 1 ! Save the position of floating windows when they are no longer floating (0/1)
- speedwm.client.swallow: 1 ! Allow clients to be swallowed by the terminal emulator (0/1)
- speedwm.client.swallowfloating: 1 ! Also allow floating clients to be swallowed (0/1)
- speedwm.client.wmclass: 1 ! Enable workaround for when a class cannot be grabbed from a client (0/1)
- speedwm.bar.height: 8
- speedwm.bar.position: 1
- speedwm.bar.paddingh: 10
- speedwm.bar.paddingv: 10
- speedwm.bar.hide: 0
- speedwm.bar.hide.tags: 0
- speedwm.bar.hide.emptytags: 1
- speedwm.bar.hide.powerline: 0
- speedwm.bar.hide.floating: 0
- speedwm.bar.hide.layout: 0
- speedwm.bar.hide.sticky: 0
- speedwm.bar.hide.status: 0
- speedwm.bar.hide.systray: 1
- speedwm.bar.hide.title: 0
- speedwm.bar.hide.unseltitle: 1
- speedwm.bar.hide.icon: 0
- speedwm.bar.layoutposition: 1
- speedwm.border.roundedcorners: 0
- speedwm.border.cornerradius: 2
- speedwm.border.size: 1
- speedwm.client.allowurgent: 1
- speedwm.client.autoresize: 1
- speedwm.client.decorhints: 1
- speedwm.client.fade.inactive: 1
- speedwm.client.fade.windows: 1
- speedwm.client.floatscratchpad: 0
- speedwm.client.savefloat: 1
- speedwm.client.swallow: 1
- speedwm.client.swallowfloating: 1
- speedwm.client.wmclass: 1
- speedwm.fonts.font1: NotoSans-Regular:size=8:antialiasing=true
- speedwm.fonts.font2: fontawesome:size=8:antialiasing=true
- speedwm.fonts.font3: Noto Color Emoji:size=8:antialiasing=true
- speedwm.col.background: #222222
- speedwm.col.layout: #99b3ff
- speedwm.col.layouttext: #000000
@ -415,113 +401,69 @@ If it is not or you want it somewhere else, you can edit 'autostart.h' and 'make
- speedwm.col.windowbordernorm: #000000
- speedwm.col.windowbordersel: #eeeeee
- speedwm.col.windowborderurg: #f0e68c
- speedwm.color.hiddentitle: 1 ! Color the hidden title (0/1)
- speedwm.color.layout: 0 ! Color the layout indicator (0/1)
- speedwm.color.selectedtitle: 0 ! Color the selected title (0/1)
- speedwm.cursor.warp: 1 ! Warp the cursor to the next focused window/monitor (0/1)
- speedwm.focus.spawned: 0 ! Focus the newly spawned window or keep focus (0/1)
- speedwm.fullscreen.hidebar: 1 ! Hide the bar when a client is fullscreened (0/1)
- speedwm.fullscreen.lockfullscreen: 1 ! Lock the fullscreen (0/1)
- speedwm.fullscreen.movefullscreenmon: 0 ! Allow moving fullscreened windows to another monitor (0/1)
- speedwm.gaps.enable: 1 ! Enable gaps around the windows
- speedwm.gaps.sizeih: 10 ! Horizontal inner gap size (<num>)
- speedwm.gaps.sizeiv: 10 ! Vertical inner gap size (<num>)
- speedwm.gaps.sizeoh: 10 ! Horizontal outer gap size (<num>)
- speedwm.gaps.sizeov: 10 ! Vertical outer gap size (<num>)
- speedwm.gaps.smartgaps: 0 ! Enable different gap size when only one client is spawned (0/1)
- speedwm.gaps.smartgapsize: 0 ! Size of the gaps when only one client is spawned (0/1)
- speedwm.icon.size: 10 ! Size of the window icon in the taskbar (<num>)
- speedwm.icon.spacing: 5 ! Spacing between icon and text in the taskbar (<num>)
- speedwm.layout.deck.count: 0 ! Enable deck count in the deck layout (0/1)
- speedwm.layout.deck.format: [0]
- speedwm.layout.dgrid.forcevsplit: 1 ! Force vertical splits in the dynamic grid layout (0/1)
- speedwm.layout.monocle.clientcount: 0 ! Enable client count in the monocle layout (0/1)
- speedwm.layout.monocle.count: 0 ! Enable focused client and number of total clients in the monocle layout (0/1)
- speedwm.layout.monocle.format: [0/0]
- speedwm.mfact: 0.50 ! Default mfact (0-1)
- speedwm.mfact.lowest: 0.05 ! Lowest possible mfact (0-1)
- speedwm.mouse.clicktofocus: 0 ! Require clicking on a window to focus or focus when the cursor touches it (0/1)
- speedwm.mouse.mfact: 1 ! Enable adjusting mfact with your mouse (0/1)
- speedwm.mouse.cfact: 1 ! Enable adjusting cfact with your mouse (0/1)
- speedwm.mouse.mousepreview: 1 ! Enable previewing tags by hovering over them with your cursor (0/1)
- speedwm.rule.refresh: 1 ! Allow rules to be refreshed if a title/class changes (0/1)
- speedwm.stack.attachdirection: 3 ! Direction to attach windows in (0: Default, 1: Above, 2: Aside, 3: Below, 4: Bottom, 5: Top)
- speedwm.stack.centerfloating: 1 ! Center floating windows (0/1)
- speedwm.stack.i3mcount: 0 ! Enable i3 like nmaster/mastercount (0/1)
- speedwm.stack.mastercount: 1 ! Number of master clients in the master stack to start with (0/1)
- speedwm.stack.snap: 20 ! Snap pixel (<char>)
- speedwm.color.hiddentitle: 1
- speedwm.color.layout: 0
- speedwm.color.selectedtitle: 0
- speedwm.cursor.warp: 1
- speedwm.focus.spawned: 0
- speedwm.fullscreen.hidebar: 1
- speedwm.fullscreen.lockfullscreen: 1
- speedwm.fullscreen.movefullscreenmon: 0
- speedwm.gaps.enable: 1
- speedwm.gaps.sizeih: 10
- speedwm.gaps.sizeiv: 10
- speedwm.gaps.sizeoh: 10
- speedwm.gaps.sizeov: 10
- speedwm.gaps.smartgaps: 0
- speedwm.gaps.smartgapsize: 0
- speedwm.icon.size: 10
- speedwm.icon.spacing: 5
- speedwm.layout.deck.count: 0
- speedwm.layout.deck.format: [%d]
- speedwm.layout.dgrid.forcevsplit: 1
- speedwm.layout.monocle.clientcount: 0
- speedwm.layout.monocle.count: 0
- speedwm.layout.monocle.format: [%d/%d]
- speedwm.mfact: 0.50
- speedwm.mfact.lowest: 0.05
- speedwm.mouse.clicktofocus: 0
- speedwm.mouse.mfact: 1
- speedwm.mouse.cfact: 1
- speedwm.mouse.mousepreview: 1
- speedwm.rule.refresh: 1
- speedwm.stack.attachdirection: 3
- speedwm.stack.centerfloating: 1
- speedwm.stack.i3mcount: 0
- speedwm.stack.mastercount: 1
- speedwm.stack.snap: 20
- speedwm.status.defaultstatus:
- speedwm.status.status: status
- speedwm.status.statusallmons: 1 ! Display status text on all monitors (0/1)
- speedwm.switcher.maxheight: 200 ! Max height of the switcher in pixels (<char>)
- speedwm.switcher.maxwidth: 600 ! Max width of the switcher in pixels (<char>)
- speedwm.switcher.menupositionv: 1 ! Menu position of the switcher vertically (0: Bottom, 1: Center, 2: Top)
- speedwm.switcher.menupositionh: 1 ! Menu position of the switcher horizontally (0: Left, 1: Center, 2: Right)
- speedwm.systray.padding: 2 ! Extra padding between status and systray (0/1)
- speedwm.systray.pinning: 0 ! Always show systray on the focused monitor or <num> (0/<monitor number>)
- speedwm.systray.position: 0 ! Position of the systray horizontally (0: Right, 1: Left)
- speedwm.tag.pertag: 1 ! Allow tags to have their own values (0/1)
- speedwm.tag.preview: 1 ! Enable tag previews (0/1)
- speedwm.tag.preview.bar: 0 ! Include the bar in the tag preview (0/1)
- speedwm.tag.preview.paddingh: 0 ! Extra horizontal padding between the tag preview and the edge of the screen (<num>)
- speedwm.tag.preview.paddingv: 0 ! Extra vertical padding between the tag preview and the bar (<num>)
- speedwm.tag.preview.scale: 2 ! Amount to scale down the preview picture by (<num>)
- speedwm.tag.resetgaps: 1 ! Reset gaps when the tag has no clients (0/1)
- speedwm.tag.resetlayout: 1 ! Reset layout when the tag has no clients (0/1)
- speedwm.tag.resetmfact: 1 ! Reset mfact when the tag has no clients (0/1)
- speedwm.tag.start: 1 ! Start on a tag on startup (0/1)
- speedwm.tag.underline: 0 ! Draw an underline on the tags (0/1)
- speedwm.tag.underlineall: 0 ! Show underline on all tags or just the selected tags (0/1)
- speedwm.tag.underlinepad: 5 ! Horizontal padding between the underline and tag (<num>)
- speedwm.tag.underlinestroke: 2 ! Height of the underline in pixels (<num>)
- speedwm.tag.underlinevoffset: 0 ! How far above the bottom of the bar the line should appear (<num)
- speedwm.tag.urgentwindows: 1 ! Color tags that have urgent tags on them (0/1)
- speedwm.tiling.resizehints: 0 ! Enable resize hints (0/1)
- speedwm.status.statusallmons: 1
- speedwm.switcher.maxheight: 200
- speedwm.switcher.maxwidth: 600
- speedwm.switcher.menupositionv: 1
- speedwm.switcher.menupositionh: 1
- speedwm.systray.padding: 2
- speedwm.systray.pinning: 0
- speedwm.systray.position: 0
- speedwm.tag.pertag: 1
- speedwm.tag.preview: 1
- speedwm.tag.preview.bar: 0
- speedwm.tag.preview.paddingh: 0
- speedwm.tag.preview.paddingv: 0
- speedwm.tag.preview.scale: 2
- speedwm.tag.resetgaps: 1
- speedwm.tag.resetlayout: 1
- speedwm.tag.resetmfact: 1
- speedwm.tag.start: 1
- speedwm.tag.underline: 0
- speedwm.tag.underlineall: 0
- speedwm.tag.underlinepad: 5
- speedwm.tag.underlinestroke: 2
- speedwm.tag.underlinevoffset: 0
- speedwm.tag.urgentwindows: 1
- speedwm.tiling.resizehints: 0
- speedwm.run.shell: /bin/sh
## Signals
Thanks to the 'fsignal' patch available on suckless.org's website, we can easily write shell scripts to interact with dwm and therefore speedwm.
I made some changes to this patch, because it has some.. questionable behaviour in my opinion.
@ -647,4 +589,4 @@ If you wish to add autostart entries without recompiling, consider using $HOME/.
Do note that it will NOT just run once. It will run every time you restart and start speedwm (signum 30 and 31 count as well).
To get around this, you may wrap stuff in a function in the script and have some way of checking if it has ran before. If it hasn't, call the function.
An alternative is to use the $HOME/.config/speedwm-de/autostart_once.sh path. This one is autostarted by speedwm_run and is therefore not hardcoded and not affected by speedwm restarting. Just like the previous autostart script, it does not exist so you need to create it.
An alternative is to use the $HOME/.config/speedwm-de/autostart_once.sh path. This one is autostarted by speedwm_run and is therefore not hardcoded and not affected by speedwm restarting. Just like the previous autostart script, it does not exist so you need to create it.