From 2c34650a633d7f0fd83614ed5fd955fe57a8b2fc Mon Sep 17 00:00:00 2001 From: speedie Date: Mon, 1 May 2023 22:46:13 +0200 Subject: [PATCH] update documentation to reflect today's changes --- docs/docs.md | 47 ++++++++++++++------------------------- spmenu.1 | 62 +++++++++++++++++++--------------------------------- spmenu.html | 55 ++++++++++++++++++---------------------------- 3 files changed, 60 insertions(+), 104 deletions(-) diff --git a/docs/docs.md b/docs/docs.md index f821ed8..d9314b0 100644 --- a/docs/docs.md +++ b/docs/docs.md @@ -631,45 +631,30 @@ You can also include other configuration files in the configuration file using spmenu also has .Xresources (xrdb) support built in. It reads the xrdb (.Xresources database) on runtime. You may disable it by passing -nxrdb, -or enable it by padding -xrdb. You can also set this in the regular config file. - -spmenu loads `~/.config/spmenu/spmenurc` or alternatively if you're -old fashioned, `~/.spmenurc` on startup. This requires that `xrdb` is -available on your operating system. Of course, you don't NEED to use them, -as you can just `xrdb -override` any .Xresources file you want. +or enable it by padding -xrdb. You can also set this in the config file. You can also use wildcards (such as `*`) to achieve a global colorscheme. Programs like `pywal` do this to apply universal colorschemes. -## Profiles +## Themes -spmenu supports profiles. Profiles are like configuration -files (See `Configuration`) that can be switched between quickly using a keybind. +You could just `@include` themes from the aforementioned `spmenu.conf`, but +it's kind of inconvenient. For this reason, spmenu reads `.theme.conf` +and `.config/spmenu/theme.conf` on startup as well. To apply a basic theme, +you simply replace theme.conf with the theme you want to use. -Pressing (by default) Ctrl+Shift+p will list out profiles, and also -allow you to add/remove existing profiles. Selecting a profile will switch -to that profile. The selected profile will now be loaded on startup just -like the spmenurc until another profile is selected. +`themes/` in the [Git repository](https://git.speedie.site/spmenu) contains +a bunch of themes written for spmenu, and you can use them as a template +when making your own themes. -Selecting 'Add' allows you to create a new profile. When a new profile is -created it is going to use the spmenu defaults (copied from `/usr/share/spmenu/example.Xresources`). -Profiles are going to be in `~/.config/spmenu/profiles/` and the current profile -is in `~/.config/spmenu/.profile`. The profile can simply be edited using -any text editor and be configured in .Xresources syntax. +Do however note that the theme file is **not** the same as the config file. +There are quite a lot of differences, and many options are not available. +This is by design, as these options should be set by the user, not the theme. -Selecting `Remove` will allow you to pick a profile which will be permanently -removed. Selecting `Default` will simply load `spmenurc` and nothing -else on startup, as if this feature did not exist. - -Not only can profiles be used to configure color schemes and fonts, allowing you -to swap color schemes quickly, but also any other options you may want. - -Note that any profiles are applied ON TOP of the current loaded profile, -meaning if any options are missing from the selected profile, the setting in -the profile used before will be used in place. - -There are a few color schemes for spmenu included in the repository, see -the `themes/` directory. Feel free to copy those to your profile directory. +This is not very convenient if you have many themes because you constantly +have to replace your theme file, so theme managers exist to make this a +bit easier. [spmenuify](https://git.speedie.site/spmenuify) is the official +theme manager, but you could use another one or write your own. ## Run launcher diff --git a/spmenu.1 b/spmenu.1 index 10f4f44..21c19aa 100644 --- a/spmenu.1 +++ b/spmenu.1 @@ -674,53 +674,37 @@ using \f[V]\[at]include \[dq]path/to/config\[dq]\f[R]. spmenu also has .Xresources (xrdb) support built in. It reads the xrdb (.Xresources database) on runtime. You may disable it by passing -nxrdb, or enable it by padding -xrdb. -You can also set this in the regular config file. -.PP -spmenu loads \f[V]\[ti]/.config/spmenu/spmenurc\f[R] or alternatively if -you\[cq]re old fashioned, \f[V]\[ti]/.spmenurc\f[R] on startup. -This requires that \f[V]xrdb\f[R] is available on your operating system. -Of course, you don\[cq]t NEED to use them, as you can just -\f[V]xrdb -override\f[R] any .Xresources file you want. +You can also set this in the config file. .PP You can also use wildcards (such as \f[V]*\f[R]) to achieve a global colorscheme. Programs like \f[V]pywal\f[R] do this to apply universal colorschemes. -.SS Profiles +.SS Themes .PP -spmenu supports profiles. -Profiles are like configuration files (See \f[V]Configuration\f[R]) that -can be switched between quickly using a keybind. +You could just \f[V]\[at]include\f[R] themes from the aforementioned +\f[V]spmenu.conf\f[R], but it\[cq]s kind of inconvenient. +For this reason, spmenu reads \f[V].theme.conf\f[R] and +\f[V].config/spmenu/theme.conf\f[R] on startup as well. +To apply a basic theme, you simply replace theme.conf with the theme you +want to use. .PP -Pressing (by default) Ctrl+Shift+p will list out profiles, and also -allow you to add/remove existing profiles. -Selecting a profile will switch to that profile. -The selected profile will now be loaded on startup just like the -spmenurc until another profile is selected. +\f[V]themes/\f[R] in the Git +repository (https://git.speedie.site/spmenu) contains a bunch of themes +written for spmenu, and you can use them as a template when making your +own themes. .PP -Selecting `Add' allows you to create a new profile. -When a new profile is created it is going to use the spmenu defaults -(copied from \f[V]/usr/share/spmenu/example.Xresources\f[R]). -Profiles are going to be in \f[V]\[ti]/.config/spmenu/profiles/\f[R] and -the current profile is in \f[V]\[ti]/.config/spmenu/.profile\f[R]. -The profile can simply be edited using any text editor and be configured -in .Xresources syntax. +Do however note that the theme file is \f[B]not\f[R] the same as the +config file. +There are quite a lot of differences, and many options are not +available. +This is by design, as these options should be set by the user, not the +theme. .PP -Selecting \f[V]Remove\f[R] will allow you to pick a profile which will -be permanently removed. -Selecting \f[V]Default\f[R] will simply load \f[V]spmenurc\f[R] and -nothing else on startup, as if this feature did not exist. -.PP -Not only can profiles be used to configure color schemes and fonts, -allowing you to swap color schemes quickly, but also any other options -you may want. -.PP -Note that any profiles are applied ON TOP of the current loaded profile, -meaning if any options are missing from the selected profile, the -setting in the profile used before will be used in place. -.PP -There are a few color schemes for spmenu included in the repository, see -the \f[V]themes/\f[R] directory. -Feel free to copy those to your profile directory. +This is not very convenient if you have many themes because you +constantly have to replace your theme file, so theme managers exist to +make this a bit easier. +spmenuify (https://git.speedie.site/spmenuify) is the official theme +manager, but you could use another one or write your own. .SS Run launcher .PP spmenu includes a powerful Bash script called spmenu_run. diff --git a/spmenu.html b/spmenu.html index dda7c74..31170ed 100644 --- a/spmenu.html +++ b/spmenu.html @@ -935,43 +935,30 @@ file using @include "path/to/config".

spmenu also has .Xresources (xrdb) support built in. It reads the xrdb (.Xresources database) on runtime. You may disable it by passing -nxrdb, or enable it by padding -xrdb. You can also set this in the -regular config file.

-

spmenu loads ~/.config/spmenu/spmenurc or alternatively -if you’re old fashioned, ~/.spmenurc on startup. This -requires that xrdb is available on your operating system. -Of course, you don’t NEED to use them, as you can just -xrdb -override any .Xresources file you want.

+config file.

You can also use wildcards (such as *) to achieve a global colorscheme. Programs like pywal do this to apply universal colorschemes.

-

Profiles

-

spmenu supports profiles. Profiles are like configuration files (See -Configuration) that can be switched between quickly using a -keybind.

-

Pressing (by default) Ctrl+Shift+p will list out profiles, and also -allow you to add/remove existing profiles. Selecting a profile will -switch to that profile. The selected profile will now be loaded on -startup just like the spmenurc until another profile is selected.

-

Selecting ‘Add’ allows you to create a new profile. When a new -profile is created it is going to use the spmenu defaults (copied from -/usr/share/spmenu/example.Xresources). Profiles are going -to be in ~/.config/spmenu/profiles/ and the current profile -is in ~/.config/spmenu/.profile. The profile can simply be -edited using any text editor and be configured in .Xresources -syntax.

-

Selecting Remove will allow you to pick a profile which -will be permanently removed. Selecting Default will simply -load spmenurc and nothing else on startup, as if this -feature did not exist.

-

Not only can profiles be used to configure color schemes and fonts, -allowing you to swap color schemes quickly, but also any other options -you may want.

-

Note that any profiles are applied ON TOP of the current loaded -profile, meaning if any options are missing from the selected profile, -the setting in the profile used before will be used in place.

-

There are a few color schemes for spmenu included in the repository, -see the themes/ directory. Feel free to copy those to your -profile directory.

+

Themes

+

You could just @include themes from the aforementioned +spmenu.conf, but it’s kind of inconvenient. For this +reason, spmenu reads .theme.conf and +.config/spmenu/theme.conf on startup as well. To apply a +basic theme, you simply replace theme.conf with the theme you want to +use.

+

themes/ in the Git repository contains a +bunch of themes written for spmenu, and you can use them as a template +when making your own themes.

+

Do however note that the theme file is not the same +as the config file. There are quite a lot of differences, and many +options are not available. This is by design, as these options should be +set by the user, not the theme.

+

This is not very convenient if you have many themes because you +constantly have to replace your theme file, so theme managers exist to +make this a bit easier. spmenuify is the official +theme manager, but you could use another one or write your own.

Run launcher

spmenu includes a powerful Bash script called spmenu_run. It lists executable programs in $PATH and displays them to the user in a list.