add markdown script, update speedwm page
This commit is contained in:
speedie
parent
2bd476e0cb
commit
d0dbf1c9a8
Binary file not shown.
|
Before Width: | Height: | Size: 1.6 MiB After Width: | Height: | Size: 2.5 MiB |
|
|
@ -61,6 +61,7 @@ file ~/.config/speedwm/autostart.sh.</li>
|
|||
<li>Horizonal Grid</li>
|
||||
<li>Dynamic Grid</li>
|
||||
<li>Custom</li>
|
||||
<li>Empty</li>
|
||||
</ul>
|
||||
<p>They can be switched between using a little menu (See Keybinds for
|
||||
more information) or by right clicking the Layout indicator. The more
|
||||
|
|
@ -138,6 +139,7 @@ Windows-like Alt+Tab)</li>
|
|||
<li>Super+Shift+q - Close the current window</li>
|
||||
<li>Super+Shift+. - Increase bar padding and gaps by 1</li>
|
||||
<li>Super+Shift+, - Decrease bar padding and gaps by 1</li>
|
||||
<li>Super+Shift+/ - Reset bar padding and gaps</li>
|
||||
<li>Super+Shift+h/j/k/l - Rotates a stack.</li>
|
||||
<li>Super+Shift+Arrow - Resizes a window in floating mode</li>
|
||||
<li>Super+Shift+Escape - Ask the user if they want to shutdown or reboot
|
||||
|
|
@ -208,8 +210,8 @@ speedwm-extras)</li>
|
|||
</ul>
|
||||
<p>Chained keybinds</p>
|
||||
<ul>
|
||||
<li>Super+r & s - Run screenkey if it is installed Super+r & d -
|
||||
Kill screenkey</li>
|
||||
<li>Super+r & s - Run screenkey if it is installed</li>
|
||||
<li>Super+r & d - Kill screenkey</li>
|
||||
<li>Super+t & r - Reorganize tags and move windows</li>
|
||||
<li>Super+t & t - Toggle tag area in the bar</li>
|
||||
<li>Super+t & y - Toggle empty tag area in the bar</li>
|
||||
|
|
@ -252,8 +254,7 @@ buttons.</p>
|
|||
<ul>
|
||||
<li>Mute button - Mutes your audio</li>
|
||||
<li>Up Volume button - Increases your volume</li>
|
||||
<li>Next/Previous song button - Switch to the next/previous track<br />
|
||||
</li>
|
||||
<li>Next/Previous song button - Switch to the next/previous track</li>
|
||||
<li>Down Volume button - Decreases your volume</li>
|
||||
<li>Pause button - Pauses the current track</li>
|
||||
<li>Stop button - Stops your defined music player</li>
|
||||
|
|
@ -270,9 +271,12 @@ computer. (requires speedwm-extras)</li>
|
|||
<li>Tag <num> (Left click) - Switch to tag <num></li>
|
||||
<li>Tag (Scrolling up/down) - Switch to the next/previous tag</li>
|
||||
<li>Layout indicator (Left click) - Switch to the next layout</li>
|
||||
<li>Layout indicator (Middle click) - Switch to the previous layout</li>
|
||||
<li>Layout indicator (Right click) - Open a dmenu list of all layouts
|
||||
<li>Layout indicator (Right click) - Switch to the previous layout</li>
|
||||
<li>Layout indicator (Middle click) - Open a dmenu list of all layouts
|
||||
(requires speedwm-extras)</li>
|
||||
<li>Layout indicator (Scrolling up/down) - Switch to the next/previous
|
||||
layout</li>
|
||||
<li>Window title (Left click) - Show/hide the window</li>
|
||||
<li>Window title (Right click) - Open speedwm-utils (requires
|
||||
speedwm-extras)</li>
|
||||
<li>Focused window (Super+Alt+Left click) - Move the focused window
|
||||
|
|
@ -364,7 +368,8 @@ won’t need to edit it.</li>
|
|||
<li>rules.h for adding/removing rules</li>
|
||||
<li>keybinds.h for adding/removing keybinds.</li>
|
||||
<li>mouse.h for adding/removing mouse binds.</li>
|
||||
<li>statusbar.h for adding/removing statuscmd clicks.</li>
|
||||
<li>status.h for adding/removing status modules and aadding/removing
|
||||
statuscmd clicks.</li>
|
||||
<li>ipc.h for adding/removing IPC commands. (If support is compiled
|
||||
in)</li>
|
||||
<li>toggle.h for adding/removing features from getting compiled in.</li>
|
||||
|
|
@ -384,13 +389,21 @@ configure it by editing ‘~/.config/speedwm/statusrc’.</p>
|
|||
<p>If you want to change status bar, edit options.h and set ‘static char
|
||||
status’ to your status bar binary (must be in $PATH). Alternatively, you
|
||||
can also set it in .Xresources (See .Xresources and Pywal).</p>
|
||||
<h2 id="xresources-and-pywal">.Xresources and Pywal</h2>
|
||||
<p>This fork of speedwm has .Xresources support thanks to the
|
||||
.Xresources patch. It also has pywal support (tool which grabs colors
|
||||
based on your wallpaper).</p>
|
||||
<h2 id="configuration-and-.xresources">Configuration and
|
||||
.Xresources</h2>
|
||||
<p>speedwm has .Xresources support thanks to the .Xresources patch. It
|
||||
also has pywal support (tool which grabs colors based on your
|
||||
wallpaper).</p>
|
||||
<p>To configure speedwm, you may /usr/share/speedwm/example.Xresources
|
||||
to either ~/.speedwmrc or ~/.config/speedwm/speedwmrc. Alternatively,
|
||||
you can also copy the values to your .Xresources file.</p>
|
||||
<p>.speedwmrc or speedwm/speedwmrc will be loaded when speedwm restarts.
|
||||
If you want to load a .Xresources file you’ll need to add that to
|
||||
autostart.sh.</p>
|
||||
<p>Colors do not reload automatically though, you must reload them
|
||||
manually. Use a signal for this (See list of signals above) or simply
|
||||
‘libspeedwm –perform core_wm_reload’.</p>
|
||||
‘libspeedwm –perform core_wm_reload’. This won’t restart speedwm, but it
|
||||
will reload colors.</p>
|
||||
<p>To use .Xresources, make sure ‘xrdb’ is installed. If a .xinitrc is
|
||||
used, add ‘xrdb /path/to/.Xresources/file’ before ‘speedwm’. If a
|
||||
.Xresources file is not used, add it to ~/.config/speedwm/autostart.sh
|
||||
|
|
@ -407,10 +420,12 @@ regular speedwm colors. This is so that speedwm is compatible with Pywal
|
|||
and more general/mainstream .Xresources configurations.</p>
|
||||
<p>Below is a list of all .Xresources values you can define.</p>
|
||||
<ul>
|
||||
<li>speedwm.bar.height: 4</li>
|
||||
<li>speedwm.bar.height: 3</li>
|
||||
<li>speedwm.bar.position: 1</li>
|
||||
<li>speedwm.bar.paddingh: 10</li>
|
||||
<li>speedwm.bar.paddingv: 10</li>
|
||||
<li>speedwm.bar.paddingoh: 0</li>
|
||||
<li>speedwm.bar.paddingov: 0</li>
|
||||
<li>speedwm.bar.paddingih: 0</li>
|
||||
<li>speedwm.bar.paddingiv: 0</li>
|
||||
<li>speedwm.bar.hide: 0</li>
|
||||
<li>speedwm.bar.hide.tags: 0</li>
|
||||
<li>speedwm.bar.hide.emptytags: 1</li>
|
||||
|
|
@ -418,21 +433,26 @@ and more general/mainstream .Xresources configurations.</p>
|
|||
<li>speedwm.bar.hide.layout: 0</li>
|
||||
<li>speedwm.bar.hide.sticky: 0</li>
|
||||
<li>speedwm.bar.hide.status: 0</li>
|
||||
<li>speedwm.bar.hide.systray: 0</li>
|
||||
<li>speedwm.bar.hide.systray: 1</li>
|
||||
<li>speedwm.bar.hide.unselected.title: 0</li>
|
||||
<li>speedwm.bar.hide.title: 0</li>
|
||||
<li>speedwm.bar.hide.icon: 0</li>
|
||||
<li>speedwm.bar.hide.clientindicator: 0</li>
|
||||
<li>speedwm.inset.x: 0</li>
|
||||
<li>speedwm.inset.y: 0</li>
|
||||
<li>speedwm.inset.w: 0</li>
|
||||
<li>speedwm.inset.h: 0</li>
|
||||
<li>speedwm.bar.titleposition: 1</li>
|
||||
<li>speedwm.border.roundedcorners: 0</li>
|
||||
<li>speedwm.border.cornerradius: 2</li>
|
||||
<li>speedwm.border.size: 1</li>
|
||||
<li>speedwm.client.map: 1</li>
|
||||
<li>speedwm.client.allowurgent: 1</li>
|
||||
<li>speedwm.client.automove: 1</li>
|
||||
<li>speedwm.client.autofocus: 1</li>
|
||||
<li>speedwm.client.autoresize: 1</li>
|
||||
<li>speedwm.client.decorhints: 1</li>
|
||||
<li>speedwm.client.hide.border: 0</li>
|
||||
<li>speedwm.client.hide.singleborder: 1</li>
|
||||
<li>speedwm.client.hide.unselected.border: 1</li>
|
||||
<li>speedwm.client.hide.single.border: 1</li>
|
||||
<li>speedwm.client.fade.inactive: 1</li>
|
||||
<li>speedwm.client.fade.windows: 1</li>
|
||||
<li>speedwm.client.floatscratchpad: 0</li>
|
||||
|
|
@ -440,8 +460,7 @@ and more general/mainstream .Xresources configurations.</p>
|
|||
<li>speedwm.client.swallow: 1</li>
|
||||
<li>speedwm.client.swallowfloating: 1</li>
|
||||
<li>speedwm.client.wmclass: 1</li>
|
||||
<li>speedwm.fonts.font: NotoSans Regular 8</li>
|
||||
<li>speedwm.col.background: #222222</li>
|
||||
<li>speedwm.fonts.font: NotoSans Regular 9</li>
|
||||
<li>speedwm.col.layout: #99b3ff</li>
|
||||
<li>speedwm.col.layouttext: #000000</li>
|
||||
<li>speedwm.col.status0: #131210</li>
|
||||
|
|
@ -478,24 +497,25 @@ and more general/mainstream .Xresources configurations.</p>
|
|||
<li>speedwm.col.powerline7_text: #131210</li>
|
||||
<li>speedwm.col.systray: #222222</li>
|
||||
<li>speedwm.col.tag1: #99b3ff</li>
|
||||
<li>speedwm.col.tag1.text: #eeeeee</li>
|
||||
<li>speedwm.col.tag2: #99b3ff</li>
|
||||
<li>speedwm.col.tag2.text: #eeeeee</li>
|
||||
<li>speedwm.col.tag3: #99b3ff</li>
|
||||
<li>speedwm.col.tag3.text: #eeeeee</li>
|
||||
<li>speedwm.col.tag4: #99b3ff</li>
|
||||
<li>speedwm.col.tag4.text: #eeeeee</li>
|
||||
<li>speedwm.col.tag5: #99b3ff</li>
|
||||
<li>speedwm.col.tag5.text: #eeeeee</li>
|
||||
<li>speedwm.col.tag6: #99b3ff</li>
|
||||
<li>speedwm.col.tag6.text: #eeeeee</li>
|
||||
<li>speedwm.col.tag7: #99b3ff</li>
|
||||
<li>speedwm.col.tag7.text: #eeeeee</li>
|
||||
<li>speedwm.col.tag8: #99b3ff</li>
|
||||
<li>speedwm.col.tag8.text: #eeeeee</li>
|
||||
<li>speedwm.col.tag9: #99b3ff</li>
|
||||
<li>speedwm.col.tag1.text: #eeeeee</li>
|
||||
<li>speedwm.col.tag2.text: #eeeeee</li>
|
||||
<li>speedwm.col.tag3.text: #eeeeee</li>
|
||||
<li>speedwm.col.tag4.text: #eeeeee</li>
|
||||
<li>speedwm.col.tag5.text: #eeeeee</li>
|
||||
<li>speedwm.col.tag6.text: #eeeeee</li>
|
||||
<li>speedwm.col.tag7.text: #eeeeee</li>
|
||||
<li>speedwm.col.tag8.text: #eeeeee</li>
|
||||
<li>speedwm.col.tag9.text: #eeeeee</li>
|
||||
<li>speedwm.col.tagurgent: #f0e68c</li>
|
||||
<li>speedwm.col.background: #222222</li>
|
||||
<li>speedwm.col.textnorm: #bbbbbb</li>
|
||||
<li>speedwm.col.textsel: #222222</li>
|
||||
<li>speedwm.col.titlenorm: #222222</li>
|
||||
|
|
@ -504,12 +524,43 @@ and more general/mainstream .Xresources configurations.</p>
|
|||
<li>speedwm.col.windowbordernorm: #000000</li>
|
||||
<li>speedwm.col.windowbordersel: #eeeeee</li>
|
||||
<li>speedwm.col.windowborderurg: #f0e68c</li>
|
||||
<li>speedwm.text.tag1.empty: </li>
|
||||
<li>speedwm.text.tag2.empty: </li>
|
||||
<li>speedwm.text.tag3.empty: </li>
|
||||
<li>speedwm.text.tag4.empty: </li>
|
||||
<li>speedwm.text.tag5.empty: </li>
|
||||
<li>speedwm.text.tag6.empty: </li>
|
||||
<li>speedwm.text.tag7.empty: </li>
|
||||
<li>speedwm.text.tag8.empty: </li>
|
||||
<li>speedwm.text.tag9.empty: </li>
|
||||
<li>speedwm.text.tag1.used: </li>
|
||||
<li>speedwm.text.tag2.used: </li>
|
||||
<li>speedwm.text.tag3.used: </li>
|
||||
<li>speedwm.text.tag4.used: </li>
|
||||
<li>speedwm.text.tag5.used: </li>
|
||||
<li>speedwm.text.tag6.used: </li>
|
||||
<li>speedwm.text.tag7.used: </li>
|
||||
<li>speedwm.text.tag8.used: </li>
|
||||
<li>speedwm.text.tag9.used: </li>
|
||||
<li>speedwm.text.layout1: </li>
|
||||
<li>speedwm.text.layout2: </li>
|
||||
<li>speedwm.text.layout3: </li>
|
||||
<li>speedwm.text.layout4: </li>
|
||||
<li>speedwm.text.layout5: </li>
|
||||
<li>speedwm.text.layout6: </li>
|
||||
<li>speedwm.text.layout7: </li>
|
||||
<li>speedwm.text.layout8: </li>
|
||||
<li>speedwm.text.layout9: </li>
|
||||
<li>speedwm.text.layout10: </li>
|
||||
<li>speedwm.text.layout11: </li>
|
||||
<li>speedwm.text.layout12: </li>
|
||||
<li>speedwm.text.layout13: </li>
|
||||
<li>speedwm.text.layout14: </li>
|
||||
<li>speedwm.text.layout15: </li>
|
||||
<li>speedwm.color.hiddentitle: 1</li>
|
||||
<li>speedwm.color.layout: 0</li>
|
||||
<li>speedwm.color.selectedtitle: 1</li>
|
||||
<li>speedwm.color.selectedtitle: 0</li>
|
||||
<li>speedwm.bar.powerline.tag.shape: 0</li>
|
||||
<li>speedwm.cursor.warp: 1</li>
|
||||
<li>speedwm.focus.spawned: 0</li>
|
||||
<li>speedwm.fullscreen.hidebar: 1</li>
|
||||
<li>speedwm.fullscreen.lockfullscreen: 1</li>
|
||||
<li>speedwm.fullscreen.movefullscreenmon: 0</li>
|
||||
|
|
@ -520,7 +571,7 @@ and more general/mainstream .Xresources configurations.</p>
|
|||
<li>speedwm.gaps.sizeov: 10</li>
|
||||
<li>speedwm.gaps.smartgaps: 0</li>
|
||||
<li>speedwm.gaps.smartgapsize: 0</li>
|
||||
<li>speedwm.icon.size: 10</li>
|
||||
<li>speedwm.icon.size: 15</li>
|
||||
<li>speedwm.icon.spacing: 5</li>
|
||||
<li>speedwm.layout.deck.count: 0</li>
|
||||
<li>speedwm.layout.deck.format: [%d]</li>
|
||||
|
|
@ -564,6 +615,10 @@ and more general/mainstream .Xresources configurations.</p>
|
|||
<li>speedwm.tag.urgentwindows: 1</li>
|
||||
<li>speedwm.tiling.resizehints: 0</li>
|
||||
<li>speedwm.run.shell: /bin/sh</li>
|
||||
<li>speedwm.status.hideemptymodule: 1</li>
|
||||
<li>speedwm.status.leftpadding:</li>
|
||||
<li>speedwm.status.rightpadding:</li>
|
||||
<li>speedwm.status.separator:</li>
|
||||
</ul>
|
||||
<h2 id="signals">Signals</h2>
|
||||
<p>Thanks to the ‘fsignal’ patch available on suckless.org’s website, we
|
||||
|
|
@ -612,9 +667,9 @@ libspeedwm when writing scripts.</p>
|
|||
<li>30 - Kill the focused window</li>
|
||||
<li>31 - Rotate the stack up</li>
|
||||
<li>32 - Rotate the stack down</li>
|
||||
<li>33 - Increase number of clients in the master stack</li>
|
||||
<li>34 - Decrease number of clients in the master stack</li>
|
||||
<li>35 - Focus the Master client</li>
|
||||
<li>33 - Increase number of windows in the master stack</li>
|
||||
<li>34 - Decrease number of windows in the master stack</li>
|
||||
<li>35 - Focus the Master window</li>
|
||||
<li>36 - Switch focus between windows +1</li>
|
||||
<li>37 - Switch focus between windows -1</li>
|
||||
<li>38 - Switch focus between hidden windows +1</li>
|
||||
|
|
@ -632,7 +687,7 @@ libspeedwm when writing scripts.</p>
|
|||
<li>50 - Decrease inner gaps by 1</li>
|
||||
<li>51 - Increase outer gaps by 1</li>
|
||||
<li>52 - Decrease outer gaps by 1</li>
|
||||
<li>53 - Kill all clients except focused</li>
|
||||
<li>53 - Kill all windows except focused</li>
|
||||
<li>54 - Focus the next monitor</li>
|
||||
<li>55 - Focus the previous monitor</li>
|
||||
<li>56 - Show the scratchpad</li>
|
||||
|
|
@ -692,13 +747,16 @@ libspeedwm when writing scripts.</p>
|
|||
<li>110 - Rotate backwards in the stack axis</li>
|
||||
<li>111 - Rotate backwards in the secondary stack axis</li>
|
||||
<li>112 - Mirror the layout</li>
|
||||
<li>113 - Enter an empty layout where all clients are hidden</li>
|
||||
<li>113 - Enter an empty layout where all windows are hidden</li>
|
||||
<li>114 - Increase barpadding and gaps by 1</li>
|
||||
<li>115 - Decrease barpadding and gaps by 1</li>
|
||||
<li>116 - Toggle mark on a client.</li>
|
||||
<li>117 - Swap focus with the marked client.</li>
|
||||
<li>118 - Swap the focused client with the marked client.</li>
|
||||
<li>116 - Toggle mark on a window.</li>
|
||||
<li>117 - Swap focus with the marked window.</li>
|
||||
<li>118 - Swap the focused window with the marked window.</li>
|
||||
<li>119 - Center the focused window</li>
|
||||
<li>120 - Toggle border for the focused window</li>
|
||||
<li>121 - Toggle border for when there’s only one window.</li>
|
||||
<li>122 - Reset bar padding and gaps</li>
|
||||
</ul>
|
||||
<h2 id="status-bar">Status bar</h2>
|
||||
<p>speedwm has a status bar. It’s the right part of the bar. It supports
|
||||
|
|
@ -709,8 +767,7 @@ colored emojis or glyphs. To override this status, you can use the
|
|||
status bar that handles this all for you through a block system. This
|
||||
fork has been integrated into the Makefile and is (by default) installed
|
||||
when speedwm is compiled. The status bar can be configured in the
|
||||
status.c and status.h and clickability can be configured in
|
||||
statusbar.h.</p>
|
||||
status.c and status.h.</p>
|
||||
<p>By default the status bar runs modules that are also bundled with
|
||||
speedwm (see modules/ directory). To configure these modules, you can
|
||||
edit ~/.config/speedwm/statusrc which should be created when a module
|
||||
|
|
@ -724,12 +781,7 @@ previously. Then simply start the status bar through autostart.h,
|
|||
<p>If you wish to add autostart entries without recompiling, consider
|
||||
using $HOME/.config/speedwm/autostart.sh. This is a path added to
|
||||
autostart.h and you can fill it with anything you want.</p>
|
||||
<p>Do note that it will NOT just run once. It will run every time you
|
||||
restart and start speedwm (restart signals count as well, color reloads
|
||||
do not). 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 such as pgrep.
|
||||
If it hasn’t, call the function.</p>
|
||||
<h2 id="credits">Credits</h2>
|
||||
<p>These will NOT run when speedwm restarts. ## Credits</p>
|
||||
<p>I far from wrote this entire project myself. Below are people who
|
||||
made this project what it is through submitting patches to suckless or
|
||||
otherwise contributing code in some way in alphabetical order.</p>
|
||||
|
|
|
|||
4
scripts/markdown.sh
Executable file
4
scripts/markdown.sh
Executable file
|
|
@ -0,0 +1,4 @@
|
|||
#!/bin/sh
|
||||
[ -z "$1" ] && printf "You must specify a markdown document to convert to HTML.\n"
|
||||
pandoc -f markdown -t html5 -o "$1.html" "$1" && printf "Converted '%s' to HTML (see '%s.md')\n" "$1" $1" || exit 1
|
||||
exit 0
|
||||
Reference in a new issue