speedie/speedwm-personal
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

rename to credits, fix doc-02, some newline cleanup

Browse source
This commit is contained in:
speedie 2023-01-24 22:27:56 +01:00
parent a73b20bdc4
commit 8d090f1842
6 changed files with 20 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -6,6 +6,7 @@
speedwm is a window manager forked from dwm or dynamic window manager. It manages the user's open windows and tiles them according to a set layout (dynamic). speedwm is a window manager forked from dwm or dynamic window manager. It manages the user's open windows and tiles them according to a set layout (dynamic).
Just like dwm, speedwm also tries to be minimal but also has functionality and aesthetics as a goal. Tiling window managers (unlike floating window managers that you may be used to) tile windows based on a set layout making them easy to get productive on. They also encourage the user to use their keyboard instead of the mouse so that the user doesn't have to move his hands much but there are also mouse binds and more can be added by the user if desired. Just like dwm, speedwm also tries to be minimal but also has functionality and aesthetics as a goal. Tiling window managers (unlike floating window managers that you may be used to) tile windows based on a set layout making them easy to get productive on. They also encourage the user to use their keyboard instead of the mouse so that the user doesn't have to move his hands much but there are also mouse binds and more can be added by the user if desired.
## 2. Installation ## 2. Installation
In order to install this build of speedwm, all dependencies must be installed. In order to install this build of speedwm, all dependencies must be installed.
@ -55,7 +56,7 @@ The more commonly used layouts can be switched between using a quick keybind.
This is a full list of keybinds. This is a full list of keybinds.
Please let me know if any keybinds are missing as these have been manually added. Please let me know if any keybinds are missing as these have been manually added.
Keybinds for regular applications ### Keybinds for regular applications
- Super+Shift+Enter - Opens the defined terminal (default is st) - Super+Shift+Enter - Opens the defined terminal (default is st)
- Super+Shift+Colon - Opens an spmenu prompt - Super+Shift+Colon - Opens an spmenu prompt
@ -73,7 +74,7 @@ Keybinds for regular applications
- Super+Shift+u - Opens the defined RSS reader - Super+Shift+u - Opens the defined RSS reader
- Super+Shift+r - Opens the defined email client - Super+Shift+r - Opens the defined email client
These keybinds are for navigating speedwm ### These keybinds are for navigating speedwm
- Super+f - Fullscreen the selected window - Super+f - Fullscreen the selected window
- Super+b - Show/hide the speedwm bar - Super+b - Show/hide the speedwm bar
@ -177,7 +178,7 @@ These keybinds are for navigating speedwm
- Super+Control+Shift+Equal - Increase bar height by 1 - Super+Control+Shift+Equal - Increase bar height by 1
- Super+Control+Shift+Minus - Decrease bar height by 1 - Super+Control+Shift+Minus - Decrease bar height by 1
Chained keybinds ### Chained keybinds
- Super+r & s - Run screenkey if its not running, otherwise kill it. - Super+r & s - Run screenkey if its not running, otherwise kill it.
- Super+t & r - Reorganize tags and move windows - Super+t & r - Reorganize tags and move windows
@ -220,7 +221,7 @@ Chained keybinds
- Super+Shift+e & r - Randomize wallpaper - Super+Shift+e & r - Randomize wallpaper
- Super+Shift+e & p - Set wallpaper to the previous - Super+Shift+e & p - Set wallpaper to the previous
These will only work if your keyboard has special multimedia buttons. ### These will only work if your keyboard has special multimedia buttons.
- Mute button - Mutes your audio - Mute button - Mutes your audio
- Up Volume button - Increases your volume - Up Volume button - Increases your volume
@ -235,7 +236,7 @@ These will only work if your keyboard has special multimedia buttons.
- Music button - Open your defined music player - Music button - Open your defined music player
- WLAN button - Disconnect from WLAN (requires speedwm-extras) - WLAN button - Disconnect from WLAN (requires speedwm-extras)
These binds can be activated using your mouse ### These binds can be activated using your mouse
- Tag <num> (Left click) - Switch to tag <num> - Tag <num> (Left click) - Switch to tag <num>
- Tag (Scrolling up/down) - Switch to the next/previous tag - Tag (Scrolling up/down) - Switch to the next/previous tag

0
docs/doc-11 → docs/credits
View file

1
docs/doc-01
View file

@ -6,3 +6,4 @@
speedwm is a window manager forked from dwm or dynamic window manager. It manages the user's open windows and tiles them according to a set layout (dynamic). speedwm is a window manager forked from dwm or dynamic window manager. It manages the user's open windows and tiles them according to a set layout (dynamic).
Just like dwm, speedwm also tries to be minimal but also has functionality and aesthetics as a goal. Tiling window managers (unlike floating window managers that you may be used to) tile windows based on a set layout making them easy to get productive on. They also encourage the user to use their keyboard instead of the mouse so that the user doesn't have to move his hands much but there are also mouse binds and more can be added by the user if desired. Just like dwm, speedwm also tries to be minimal but also has functionality and aesthetics as a goal. Tiling window managers (unlike floating window managers that you may be used to) tile windows based on a set layout making them easy to get productive on. They also encourage the user to use their keyboard instead of the mouse so that the user doesn't have to move his hands much but there are also mouse binds and more can be added by the user if desired.

10
docs/keybinds
View file

@ -1,4 +1,4 @@
Keybinds for regular applications ### Keybinds for regular applications
- Super+Shift+Enter - Opens the defined terminal (default is st) - Super+Shift+Enter - Opens the defined terminal (default is st)
- Super+Shift+Colon - Opens an spmenu prompt - Super+Shift+Colon - Opens an spmenu prompt
@ -16,7 +16,7 @@ Keybinds for regular applications
- Super+Shift+u - Opens the defined RSS reader - Super+Shift+u - Opens the defined RSS reader
- Super+Shift+r - Opens the defined email client - Super+Shift+r - Opens the defined email client
These keybinds are for navigating speedwm ### These keybinds are for navigating speedwm
- Super+f - Fullscreen the selected window - Super+f - Fullscreen the selected window
- Super+b - Show/hide the speedwm bar - Super+b - Show/hide the speedwm bar
@ -120,7 +120,7 @@ These keybinds are for navigating speedwm
- Super+Control+Shift+Equal - Increase bar height by 1 - Super+Control+Shift+Equal - Increase bar height by 1
- Super+Control+Shift+Minus - Decrease bar height by 1 - Super+Control+Shift+Minus - Decrease bar height by 1
Chained keybinds ### Chained keybinds
- Super+r & s - Run screenkey if its not running, otherwise kill it. - Super+r & s - Run screenkey if its not running, otherwise kill it.
- Super+t & r - Reorganize tags and move windows - Super+t & r - Reorganize tags and move windows
@ -163,7 +163,7 @@ Chained keybinds
- Super+Shift+e & r - Randomize wallpaper - Super+Shift+e & r - Randomize wallpaper
- Super+Shift+e & p - Set wallpaper to the previous - Super+Shift+e & p - Set wallpaper to the previous
These will only work if your keyboard has special multimedia buttons. ### These will only work if your keyboard has special multimedia buttons.
- Mute button - Mutes your audio - Mute button - Mutes your audio
- Up Volume button - Increases your volume - Up Volume button - Increases your volume
@ -178,7 +178,7 @@ These will only work if your keyboard has special multimedia buttons.
- Music button - Open your defined music player - Music button - Open your defined music player
- WLAN button - Disconnect from WLAN (requires speedwm-extras) - WLAN button - Disconnect from WLAN (requires speedwm-extras)
These binds can be activated using your mouse ### These binds can be activated using your mouse
- Tag <num> (Left click) - Switch to tag <num> - Tag <num> (Left click) - Switch to tag <num>
- Tag (Scrolling up/down) - Switch to the next/previous tag - Tag (Scrolling up/down) - Switch to the next/previous tag

4
scripts/speedwm-help
View file

@ -101,7 +101,7 @@ cat "${DOCDIR}/${PREFIX}doc-01" \
"${DOCDIR}/${PREFIX}doc-08" \ "${DOCDIR}/${PREFIX}doc-08" \
"${DOCDIR}/${PREFIX}doc-09" \ "${DOCDIR}/${PREFIX}doc-09" \
"${DOCDIR}/${PREFIX}doc-10" \ "${DOCDIR}/${PREFIX}doc-10" \
"${DOCDIR}/${PREFIX}doc-11" | \ "${DOCDIR}/${PREFIX}credits" | \
grep -v "!!" > "/tmp/${PREFIX}doc" grep -v "!!" > "/tmp/${PREFIX}doc"
# check arguments and perform actions based on it # check arguments and perform actions based on it
@ -124,7 +124,7 @@ case "$1" in
"-9") cat "${DOCDIR}/${PREFIX}doc-05" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;; "-9") cat "${DOCDIR}/${PREFIX}doc-05" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
"-10") cat "${DOCDIR}/${PREFIX}doc-09" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;; "-10") cat "${DOCDIR}/${PREFIX}doc-09" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
"-11") cat "${DOCDIR}/${PREFIX}doc-10" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;; "-11") cat "${DOCDIR}/${PREFIX}doc-10" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
"-12") cat "${DOCDIR}/${PREFIX}doc-11" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;; "-12") cat "${DOCDIR}/${PREFIX}credits" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
"-a") cat "/tmp/${PREFIX}doc" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;; "-a") cat "/tmp/${PREFIX}doc" > /tmp/stdout ; $VIEWER /tmp/stdout ; exit 0 ;;
esac esac

18
speedwm.1
View file

@ -31,8 +31,7 @@ productive on.
They also encourage the user to use their keyboard instead of the mouse They also encourage the user to use their keyboard instead of the mouse
so that the user doesn\[cq]t have to move his hands much but there are so that the user doesn\[cq]t have to move his hands much but there are
also mouse binds and more can be added by the user if desired. also mouse binds and more can be added by the user if desired.
## 2. .SS 2. Installation
Installation
.PP .PP
In order to install this build of speedwm, all dependencies must be In order to install this build of speedwm, all dependencies must be
installed. installed.
@ -118,8 +117,7 @@ keybind.
This is a full list of keybinds. This is a full list of keybinds.
Please let me know if any keybinds are missing as these have been Please let me know if any keybinds are missing as these have been
manually added. manually added.
.PP .SS Keybinds for regular applications
Keybinds for regular applications
.IP \[bu] 2 .IP \[bu] 2
Super+Shift+Enter - Opens the defined terminal (default is st) Super+Shift+Enter - Opens the defined terminal (default is st)
.IP \[bu] 2 .IP \[bu] 2
@ -153,8 +151,7 @@ Super+Shift+d - Opens iron in the terminal if it is installed
Super+Shift+u - Opens the defined RSS reader Super+Shift+u - Opens the defined RSS reader
.IP \[bu] 2 .IP \[bu] 2
Super+Shift+r - Opens the defined email client Super+Shift+r - Opens the defined email client
.PP .SS These keybinds are for navigating speedwm
These keybinds are for navigating speedwm
.IP \[bu] 2 .IP \[bu] 2
Super+f - Fullscreen the selected window Super+f - Fullscreen the selected window
.IP \[bu] 2 .IP \[bu] 2
@ -367,8 +364,7 @@ Super+Control+Shift+j/k - Change window size vertically (cfact)
Super+Control+Shift+Equal - Increase bar height by 1 Super+Control+Shift+Equal - Increase bar height by 1
.IP \[bu] 2 .IP \[bu] 2
Super+Control+Shift+Minus - Decrease bar height by 1 Super+Control+Shift+Minus - Decrease bar height by 1
.PP .SS Chained keybinds
Chained keybinds
.IP \[bu] 2 .IP \[bu] 2
Super+r & s - Run screenkey if its not running, otherwise kill it. Super+r & s - Run screenkey if its not running, otherwise kill it.
.IP \[bu] 2 .IP \[bu] 2
@ -449,8 +445,7 @@ Super+Shift+e & e - Open a list of all emojis and copy the selection
Super+Shift+e & r - Randomize wallpaper Super+Shift+e & r - Randomize wallpaper
.IP \[bu] 2 .IP \[bu] 2
Super+Shift+e & p - Set wallpaper to the previous Super+Shift+e & p - Set wallpaper to the previous
.PP .SS These will only work if your keyboard has special multimedia buttons.
These will only work if your keyboard has special multimedia buttons.
.IP \[bu] 2 .IP \[bu] 2
Mute button - Mutes your audio Mute button - Mutes your audio
.IP \[bu] 2 .IP \[bu] 2
@ -477,8 +472,7 @@ System button - Open your defined status viewer in a terminal
Music button - Open your defined music player Music button - Open your defined music player
.IP \[bu] 2 .IP \[bu] 2
WLAN button - Disconnect from WLAN (requires speedwm-extras) WLAN button - Disconnect from WLAN (requires speedwm-extras)
.PP .SS These binds can be activated using your mouse
These binds can be activated using your mouse
.IP \[bu] 2 .IP \[bu] 2
Tag (Left click) - Switch to tag Tag (Left click) - Switch to tag
.IP \[bu] 2 .IP \[bu] 2