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

Update a few docs

Browse source
This commit is contained in:
speedie 2022-11-27 12:19:31 +01:00
parent ca04439989
commit ea24892f1c
3 changed files with 34 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -449,7 +449,6 @@ Below is a list of all .Xresources values you can define.
- speedwm.stack.mastercount: 1
- speedwm.stack.snap: 20
- speedwm.status.defaultstatus:
- speedwm.status.status: speedwm_status
- speedwm.status.statusallmons: 1
- speedwm.switcher.maxheight: 200
- speedwm.switcher.maxwidth: 600
@ -603,20 +602,15 @@ Below is a list of all signums and what they do.
- 112 - Mirror the layout
- 113 - Enter an empty layout where all clients are hidden
## Maintaining settings easily
## Status bar
speedwm is a personal fork of dwm and will therefore likely have keybinds and other options you may not like.
speedwm has a status bar. It's the right part of the bar. It supports Pango, status2d and statuscmd markup as well as regular plain text and colored emojis or glyphs. To override this status, you can use the 'speedwm -s <status>' command.
Because of this, I recommend that you use the patching system to manage your "custom" settings. speedwm has a patching system. It allows you to create a patch with your changes to most of the headers.
Bundled with speedwm is a fork of dwmblocks. dwmblocks is a dwm 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.
To create a patch, simply make clean install once and then the docs folder will contain backups of your source code. If you perform changes to any of these four files, run make patch to create patches against the backups in docs and your modified files. Then once you're updating, do make patch_remove, git pull, make patch_install, and make clean install and all your settings will be there.
The only (obvious) problem with doing this is that eventually the backup files patches are being created against will be pretty old causing patches to no longer apply correctly. If this is the case you will need to create new patches and backups.
If this seems like more effort than it is worth, maintaining your own fork is always an option. This allows you to perform any options you want yourself. This however doesn't allow you to grab any updates so this should be your second choice.
Another option, if you use Gentoo, you can add my overlay and install speedwm using the 'savedconfig' USE flag. This USE flag will combine all the headers into one and will be placed in /etc/portage/savedconfig/x11-wm/speedwm-version. To use the settings, simply emerge speedwm again.
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 or .xinitrc if you are using that.
## 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.

15
docs/doc-08
View file

@ -1,14 +1,9 @@
## Maintaining settings easily
## Status bar
speedwm is a personal fork of dwm and will therefore likely have keybinds and other options you may not like.
speedwm has a status bar. It's the right part of the bar. It supports Pango, status2d and statuscmd markup as well as regular plain text and colored emojis or glyphs. To override this status, you can use the 'speedwm -s <status>' command.
Because of this, I recommend that you use the patching system to manage your "custom" settings. speedwm has a patching system. It allows you to create a patch with your changes to most of the headers.
Bundled with speedwm is a fork of dwmblocks. dwmblocks is a dwm 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.
To create a patch, simply make clean install once and then the docs folder will contain backups of your source code. If you perform changes to any of these four files, run make patch to create patches against the backups in docs and your modified files. Then once you're updating, do make patch_remove, git pull, make patch_install, and make clean install and all your settings will be there.
The only (obvious) problem with doing this is that eventually the backup files patches are being created against will be pretty old causing patches to no longer apply correctly. If this is the case you will need to create new patches and backups.
If this seems like more effort than it is worth, maintaining your own fork is always an option. This allows you to perform any options you want yourself. This however doesn't allow you to grab any updates so this should be your second choice.
Another option, if you use Gentoo, you can add my overlay and install speedwm using the 'savedconfig' USE flag. This USE flag will combine all the headers into one and will be placed in /etc/portage/savedconfig/x11-wm/speedwm-version. To use the settings, simply emerge speedwm again.
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 or .xinitrc if you are using that.

58
speedwm.1
View file

@ -892,8 +892,6 @@ speedwm.stack.snap: 20
.IP \[bu] 2
speedwm.status.defaultstatus:
.IP \[bu] 2
speedwm.status.status: speedwm_status
.IP \[bu] 2
speedwm.status.statusallmons: 1
.IP \[bu] 2
speedwm.switcher.maxheight: 200
@ -1192,42 +1190,34 @@ Below is a list of all signums and what they do.
112 - Mirror the layout
.IP \[bu] 2
113 - Enter an empty layout where all clients are hidden
.SS Maintaining settings easily
.SS Status bar
.PP
speedwm is a personal fork of dwm and will therefore likely have
keybinds and other options you may not like.
speedwm has a status bar.
It\[cq]s the right part of the bar.
It supports Pango, status2d and statuscmd markup as well as regular
plain text and colored emojis or glyphs.
To override this status, you can use the `speedwm -s ' command.
.PP
Because of this, I recommend that you use the patching system to manage
your \[lq]custom\[rq] settings.
speedwm has a patching system.
It allows you to create a patch with your changes to most of the
headers.
Bundled with speedwm is a fork of dwmblocks.
dwmblocks is a dwm 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.
.PP
To create a patch, simply make clean install once and then the docs
folder will contain backups of your source code.
If you perform changes to any of these four files, run make patch to
create patches against the backups in docs and your modified files.
Then once you\[cq]re updating, do make patch_remove, git pull, make
patch_install, and make clean install and all your settings will be
there.
By default the status bar runs modules that are also bundled with
speedwm (see modules/ directory).
To configure these modules, you can edit \[ti]/.config/speedwm/statusrc
which should be created when a module runs.
.PP
The only (obvious) problem with doing this is that eventually the backup
files patches are being created against will be pretty old causing
patches to no longer apply correctly.
If this is the case you will need to create new patches and backups.
.PP
If this seems like more effort than it is worth, maintaining your own
fork is always an option.
This allows you to perform any options you want yourself.
This however doesn\[cq]t allow you to grab any updates so this should be
your second choice.
.PP
Another option, if you use Gentoo, you can add my overlay and install
speedwm using the `savedconfig' USE flag.
This USE flag will combine all the headers into one and will be placed
in /etc/portage/savedconfig/x11-wm/speedwm-version.
To use the settings, simply emerge speedwm again.
.SS Additional note on autostart
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,
\[ti]/.config/speedwm/autostart.sh or .xinitrc if you are using that.
## Additional note on autostart
.PP
If you wish to add autostart entries without recompiling, consider using
$HOME/.config/speedwm/autostart.sh.