number them
This commit is contained in:
speedie
parent
3cbbeda3a8
commit
a73b20bdc4
25
README.md
25
README.md
|
|
@ -1,12 +1,12 @@
|
|||
# speedwm
|
||||
|
||||
|
||||
## What is speedwm?
|
||||
## 1. What is speedwm?
|
||||
|
||||
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.
|
||||
## Installation
|
||||
## 2. Installation
|
||||
|
||||
In order to install this build of speedwm, all dependencies must be installed.
|
||||
You can see 'Dependencies' for a list of all dependencies required and optionally recommended to use speedwm.
|
||||
|
|
@ -28,7 +28,7 @@ Note that speedwm is not and will **never** be compatible with Wayland. I have n
|
|||
|
||||
If you're having any issues on operating systems with the BSD kernel, or something like NixOS, please file a bug report here.
|
||||
|
||||
## Layouts
|
||||
## 3. Layouts
|
||||
|
||||
speedwm comes with the following layouts:
|
||||
|
||||
|
|
@ -50,7 +50,7 @@ speedwm comes with the following layouts:
|
|||
They can be switched between using a little menu (See Keybinds for more information) or by right clicking the Layout indicator.
|
||||
The more commonly used layouts can be switched between using a quick keybind.
|
||||
|
||||
## Keybinds
|
||||
## 4. Keybinds
|
||||
|
||||
This is a full list of keybinds.
|
||||
Please let me know if any keybinds are missing as these have been manually added.
|
||||
|
|
@ -309,7 +309,7 @@ You can add, change and remove keybinds by editing `keybinds.h` and `mouse.h` an
|
|||
|
||||
And everything under `Features`.
|
||||
|
||||
## Important
|
||||
## 5. Important
|
||||
|
||||
If you're used to dwm, speedwm might be a little unfamiliar to you at first. This is because speedwm doesn't use config.h (or config.def.h).
|
||||
Instead, config.h is split into different parts to make it easier to edit. Instead of editing config.h you'll want to edit:
|
||||
|
|
@ -324,7 +324,7 @@ Instead, config.h is split into different parts to make it easier to edit. Inste
|
|||
- mouse.h for adding/removing mouse binds.
|
||||
- status.h for adding/removing status modules and aadding/removing statuscmd clicks.
|
||||
- ipc.h for adding/removing IPC commands. (If support is compiled in)
|
||||
- toggle.h for adding/removing features from getting compiled in.
|
||||
- toggle.h for adding/removing features from getting compiled in.
|
||||
|
||||
After you've edited one of the files, you need to run 'make clean install' to reinstall speedwm.
|
||||
Remember that you can change colors through your .Xresources file (see .Xresources and Pywal) meaning you do not need to recompile speedwm.
|
||||
|
|
@ -338,7 +338,7 @@ You can also configure it by editing '~/.config/speedwm/statusrc'.
|
|||
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).
|
||||
|
||||
## Configuration and .Xresources
|
||||
## 6. Configuration and .Xresources
|
||||
|
||||
speedwm has .Xresources support thanks to the .Xresources patch. It also has pywal support (tool which grabs colors based on your wallpaper).
|
||||
|
||||
|
|
@ -555,8 +555,7 @@ Below is a list of all .Xresources values you can define.
|
|||
- speedwm.status.leftpadding:
|
||||
- speedwm.status.rightpadding:
|
||||
- speedwm.status.separator:
|
||||
|
||||
## Signals
|
||||
## 7. 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.
|
||||
|
|
@ -690,7 +689,7 @@ Below is a list of all signums and what they do.
|
|||
- 120 - Toggle border for the focused window
|
||||
- 121 - Reset bar padding and gaps
|
||||
|
||||
## Status bar
|
||||
## 8. Status bar
|
||||
|
||||
speedwm has a status bar. It's the (by default) right part of the bar. It supports:
|
||||
|
||||
|
|
@ -711,13 +710,15 @@ Bundled with speedwm is a fork of dwmblocks. dwmblocks is a dwm status bar that
|
|||
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 runs.
|
||||
|
||||
The bundled status bar is autostarted by speedwm if it is installed. If you want to use your own status bar, comment out 'USESTATUS' in toggle.mk and remove /usr/bin/status if speedwm has been installed previously. Then simply start the status bar through autostart.h, ~/.config/speedwm/autostart.sh, .xinitrc or some other means of running a program.
|
||||
## Additional note on autostart
|
||||
|
||||
## 9. Additional note on autostart
|
||||
|
||||
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.
|
||||
Make sure your user has permission to execute the script.
|
||||
|
||||
Note that this script or any other commands in autostart.h will **not** run when speedwm is restarted, only when speedwm is first started.
|
||||
## Configuring the bar
|
||||
|
||||
## 10. Configuring the bar
|
||||
|
||||
As of 1.8, speedwm has a module system. It is based on the barmodules patch for dwm and allows extensive control over the way the speedwm bar functions. This control has its own header, `bar.h`.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# speedwm
|
||||
|
||||
|
||||
## What is speedwm?
|
||||
## 1. What is speedwm?
|
||||
|
||||
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).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
## Installation
|
||||
## 2. Installation
|
||||
|
||||
In order to install this build of speedwm, all dependencies must be installed.
|
||||
You can see 'Dependencies' for a list of all dependencies required and optionally recommended to use speedwm.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
## Layouts
|
||||
## 3. Layouts
|
||||
|
||||
speedwm comes with the following layouts:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
## Keybinds
|
||||
## 4. Keybinds
|
||||
|
||||
This is a full list of keybinds.
|
||||
Please let me know if any keybinds are missing as these have been manually added.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
## Important
|
||||
## 5. Important
|
||||
|
||||
If you're used to dwm, speedwm might be a little unfamiliar to you at first. This is because speedwm doesn't use config.h (or config.def.h).
|
||||
Instead, config.h is split into different parts to make it easier to edit. Instead of editing config.h you'll want to edit:
|
||||
|
|
@ -13,7 +13,7 @@ Instead, config.h is split into different parts to make it easier to edit. Inste
|
|||
- mouse.h for adding/removing mouse binds.
|
||||
- status.h for adding/removing status modules and aadding/removing statuscmd clicks.
|
||||
- ipc.h for adding/removing IPC commands. (If support is compiled in)
|
||||
- toggle.h for adding/removing features from getting compiled in.
|
||||
- toggle.h for adding/removing features from getting compiled in.
|
||||
|
||||
After you've edited one of the files, you need to run 'make clean install' to reinstall speedwm.
|
||||
Remember that you can change colors through your .Xresources file (see .Xresources and Pywal) meaning you do not need to recompile speedwm.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
## Configuration and .Xresources
|
||||
## 6. Configuration and .Xresources
|
||||
|
||||
speedwm has .Xresources support thanks to the .Xresources patch. It also has pywal support (tool which grabs colors based on your wallpaper).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
## Signals
|
||||
## 7. 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.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
## Status bar
|
||||
## 8. Status bar
|
||||
|
||||
speedwm has a status bar. It's the (by default) right part of the bar. It supports:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
## Additional note on autostart
|
||||
## 9. Additional note on autostart
|
||||
|
||||
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.
|
||||
Make sure your user has permission to execute the script.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
## Configuring the bar
|
||||
## 10. Configuring the bar
|
||||
|
||||
As of 1.8, speedwm has a module system. It is based on the barmodules patch for dwm and allows extensive control over the way the speedwm bar functions. This control has its own header, `bar.h`.
|
||||
|
||||
|
|
|
|||
23
speedwm.1
23
speedwm.1
|
|
@ -17,7 +17,7 @@
|
|||
.TH "speedwm" "1" "" "1.9" "speedie\[cq]s window manager."
|
||||
.hy
|
||||
.SH speedwm
|
||||
.SS What is speedwm?
|
||||
.SS 1. What is speedwm?
|
||||
.PP
|
||||
speedwm is a window manager forked from dwm or dynamic window manager.
|
||||
It manages the user\[cq]s open windows and tiles them according to a set
|
||||
|
|
@ -31,7 +31,8 @@ productive on.
|
|||
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
|
||||
also mouse binds and more can be added by the user if desired.
|
||||
## Installation
|
||||
## 2.
|
||||
Installation
|
||||
.PP
|
||||
In order to install this build of speedwm, all dependencies must be
|
||||
installed.
|
||||
|
|
@ -76,7 +77,7 @@ Please don\[cq]t create any issues regarding Wayland support.
|
|||
.PP
|
||||
If you\[cq]re having any issues on operating systems with the BSD
|
||||
kernel, or something like NixOS, please file a bug report here.
|
||||
.SS Layouts
|
||||
.SS 3. Layouts
|
||||
.PP
|
||||
speedwm comes with the following layouts:
|
||||
.IP \[bu] 2
|
||||
|
|
@ -112,7 +113,7 @@ They can be switched between using a little menu (See Keybinds for more
|
|||
information) or by right clicking the Layout indicator.
|
||||
The more commonly used layouts can be switched between using a quick
|
||||
keybind.
|
||||
.SS Keybinds
|
||||
.SS 4. Keybinds
|
||||
.PP
|
||||
This is a full list of keybinds.
|
||||
Please let me know if any keybinds are missing as these have been
|
||||
|
|
@ -605,7 +606,7 @@ tmux - Used for the music player and IRC client
|
|||
j4-dmenu-desktop - Listing .desktop entries
|
||||
.PP
|
||||
And everything under \f[V]Features\f[R].
|
||||
.SS Important
|
||||
.SS 5. Important
|
||||
.PP
|
||||
If you\[cq]re used to dwm, speedwm might be a little unfamiliar to you
|
||||
at first.
|
||||
|
|
@ -659,7 +660,7 @@ 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).
|
||||
.SS Configuration and .Xresources
|
||||
.SS 6. Configuration and .Xresources
|
||||
.PP
|
||||
speedwm has .Xresources support thanks to the .Xresources patch.
|
||||
It also has pywal support (tool which grabs colors based on your
|
||||
|
|
@ -1097,8 +1098,8 @@ speedwm.status.leftpadding:
|
|||
.IP \[bu] 2
|
||||
speedwm.status.rightpadding:
|
||||
.IP \[bu] 2
|
||||
speedwm.status.separator:
|
||||
.SS Signals
|
||||
speedwm.status.separator: ## 7.
|
||||
Signals
|
||||
.PP
|
||||
Thanks to the `fsignal' patch available on suckless.org\[cq]s website,
|
||||
we can easily write shell scripts to interact with dwm and therefore
|
||||
|
|
@ -1361,7 +1362,7 @@ Below is a list of all signums and what they do.
|
|||
120 - Toggle border for the focused window
|
||||
.IP \[bu] 2
|
||||
121 - Reset bar padding and gaps
|
||||
.SS Status bar
|
||||
.SS 8. Status bar
|
||||
.PP
|
||||
speedwm has a status bar.
|
||||
It\[cq]s the (by default) right part of the bar.
|
||||
|
|
@ -1410,7 +1411,7 @@ previously.
|
|||
Then simply start the status bar through autostart.h,
|
||||
\[ti]/.config/speedwm/autostart.sh, .xinitrc or some other means of
|
||||
running a program.
|
||||
## Additional note on autostart
|
||||
.SS 9. Additional note on autostart
|
||||
.PP
|
||||
If you wish to add autostart entries without recompiling, consider using
|
||||
$HOME/.config/speedwm/autostart.sh.
|
||||
|
|
@ -1421,7 +1422,7 @@ Make sure your user has permission to execute the script.
|
|||
Note that this script or any other commands in autostart.h will
|
||||
\f[B]not\f[R] run when speedwm is restarted, only when speedwm is first
|
||||
started.
|
||||
## Configuring the bar
|
||||
.SS 10. Configuring the bar
|
||||
.PP
|
||||
As of 1.8, speedwm has a module system.
|
||||
It is based on the barmodules patch for dwm and allows extensive control
|
||||
|
|
|
|||
Loading…
Reference in a new issue