Lucas-mother3/spmenu
1
0
Fork 0
forked from speedie/spmenu
Code Pull requests Activity

update documentation to reflect today's changes

Browse source
This commit is contained in:
speedie 2023-05-01 22:46:13 +02:00
parent efecf674e8
commit 2c34650a63
3 changed files with 60 additions and 104 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

47
docs/docs.md
View file

@ -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 spmenu also has .Xresources (xrdb) support built in. It reads the xrdb
(.Xresources database) on runtime. You may disable it by passing -nxrdb, (.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. or enable it by padding -xrdb. You can also set this in the 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.
You can also use wildcards (such as `*`) to achieve a global colorscheme. You can also use wildcards (such as `*`) to achieve a global colorscheme.
Programs like `pywal` do this to apply universal colorschemes. Programs like `pywal` do this to apply universal colorschemes.
## Profiles ## Themes
spmenu supports profiles. Profiles are like configuration You could just `@include` themes from the aforementioned `spmenu.conf`, but
files (See `Configuration`) that can be switched between quickly using a keybind. 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 `themes/` in the [Git repository](https://git.speedie.site/spmenu) contains
allow you to add/remove existing profiles. Selecting a profile will switch a bunch of themes written for spmenu, and you can use them as a template
to that profile. The selected profile will now be loaded on startup just when making your own themes.
like the spmenurc until another profile is selected.
Selecting 'Add' allows you to create a new profile. When a new profile is Do however note that the theme file is **not** the same as the config file.
created it is going to use the spmenu defaults (copied from `/usr/share/spmenu/example.Xresources`). There are quite a lot of differences, and many options are not available.
Profiles are going to be in `~/.config/spmenu/profiles/` and the current profile This is by design, as these options should be set by the user, not the theme.
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 This is not very convenient if you have many themes because you constantly
removed. Selecting `Default` will simply load `spmenurc` and nothing have to replace your theme file, so theme managers exist to make this a
else on startup, as if this feature did not exist. bit easier. [spmenuify](https://git.speedie.site/spmenuify) is the official
theme manager, but you could use another one or write your own.
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.
## Run launcher ## Run launcher

62
spmenu.1
View file

@ -674,53 +674,37 @@ using \f[V]\[at]include \[dq]path/to/config\[dq]\f[R].
spmenu also has .Xresources (xrdb) support built in. spmenu also has .Xresources (xrdb) support built in.
It reads the xrdb (.Xresources database) on runtime. It reads the xrdb (.Xresources database) on runtime.
You may disable it by passing -nxrdb, or enable it by padding -xrdb. You may disable it by passing -nxrdb, or enable it by padding -xrdb.
You can also set this in the regular config file. You can also set this in the 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.
.PP .PP
You can also use wildcards (such as \f[V]*\f[R]) to achieve a global You can also use wildcards (such as \f[V]*\f[R]) to achieve a global
colorscheme. colorscheme.
Programs like \f[V]pywal\f[R] do this to apply universal colorschemes. Programs like \f[V]pywal\f[R] do this to apply universal colorschemes.
.SS Profiles .SS Themes
.PP .PP
spmenu supports profiles. You could just \f[V]\[at]include\f[R] themes from the aforementioned
Profiles are like configuration files (See \f[V]Configuration\f[R]) that \f[V]spmenu.conf\f[R], but it\[cq]s kind of inconvenient.
can be switched between quickly using a keybind. 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 .PP
Pressing (by default) Ctrl+Shift+p will list out profiles, and also \f[V]themes/\f[R] in the Git
allow you to add/remove existing profiles. repository (https://git.speedie.site/spmenu) contains a bunch of themes
Selecting a profile will switch to that profile. written for spmenu, and you can use them as a template when making your
The selected profile will now be loaded on startup just like the own themes.
spmenurc until another profile is selected.
.PP .PP
Selecting `Add' allows you to create a new profile. Do however note that the theme file is \f[B]not\f[R] the same as the
When a new profile is created it is going to use the spmenu defaults config file.
(copied from \f[V]/usr/share/spmenu/example.Xresources\f[R]). There are quite a lot of differences, and many options are not
Profiles are going to be in \f[V]\[ti]/.config/spmenu/profiles/\f[R] and available.
the current profile is in \f[V]\[ti]/.config/spmenu/.profile\f[R]. This is by design, as these options should be set by the user, not the
The profile can simply be edited using any text editor and be configured theme.
in .Xresources syntax.
.PP .PP
Selecting \f[V]Remove\f[R] will allow you to pick a profile which will This is not very convenient if you have many themes because you
be permanently removed. constantly have to replace your theme file, so theme managers exist to
Selecting \f[V]Default\f[R] will simply load \f[V]spmenurc\f[R] and make this a bit easier.
nothing else on startup, as if this feature did not exist. spmenuify (https://git.speedie.site/spmenuify) is the official theme
.PP manager, but you could use another one or write your own.
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.
.SS Run launcher .SS Run launcher
.PP .PP
spmenu includes a powerful Bash script called spmenu_run. spmenu includes a powerful Bash script called spmenu_run.

55
spmenu.html
View file

@ -935,43 +935,30 @@ file using <code>@include "path/to/config"</code>.</p>
<p>spmenu also has .Xresources (xrdb) support built in. It reads the <p>spmenu also has .Xresources (xrdb) support built in. It reads the
xrdb (.Xresources database) on runtime. You may disable it by passing 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 -nxrdb, or enable it by padding -xrdb. You can also set this in the
regular config file.</p> config file.</p>
<p>spmenu loads <code>~/.config/spmenu/spmenurc</code> or alternatively
if you’re old fashioned, <code>~/.spmenurc</code> on startup. This
requires that <code>xrdb</code> is available on your operating system.
Of course, you don’t NEED to use them, as you can just
<code>xrdb -override</code> any .Xresources file you want.</p>
<p>You can also use wildcards (such as <code>*</code>) to achieve a <p>You can also use wildcards (such as <code>*</code>) to achieve a
global colorscheme. Programs like <code>pywal</code> do this to apply global colorscheme. Programs like <code>pywal</code> do this to apply
universal colorschemes.</p> universal colorschemes.</p>
<h2 id="profiles">Profiles</h2> <h2 id="themes">Themes</h2>
<p>spmenu supports profiles. Profiles are like configuration files (See <p>You could just <code>@include</code> themes from the aforementioned
<code>Configuration</code>) that can be switched between quickly using a <code>spmenu.conf</code>, but it’s kind of inconvenient. For this
keybind.</p> reason, spmenu reads <code>.theme.conf</code> and
<p>Pressing (by default) Ctrl+Shift+p will list out profiles, and also <code>.config/spmenu/theme.conf</code> on startup as well. To apply a
allow you to add/remove existing profiles. Selecting a profile will basic theme, you simply replace theme.conf with the theme you want to
switch to that profile. The selected profile will now be loaded on use.</p>
startup just like the spmenurc until another profile is selected.</p> <p><code>themes/</code> in the <a
<p>Selecting ‘Add’ allows you to create a new profile. When a new href="https://git.speedie.site/spmenu">Git repository</a> contains a
profile is created it is going to use the spmenu defaults (copied from bunch of themes written for spmenu, and you can use them as a template
<code>/usr/share/spmenu/example.Xresources</code>). Profiles are going when making your own themes.</p>
to be in <code>~/.config/spmenu/profiles/</code> and the current profile <p>Do however note that the theme file is <strong>not</strong> the same
is in <code>~/.config/spmenu/.profile</code>. The profile can simply be as the config file. There are quite a lot of differences, and many
edited using any text editor and be configured in .Xresources options are not available. This is by design, as these options should be
syntax.</p> set by the user, not the theme.</p>
<p>Selecting <code>Remove</code> will allow you to pick a profile which <p>This is not very convenient if you have many themes because you
will be permanently removed. Selecting <code>Default</code> will simply constantly have to replace your theme file, so theme managers exist to
load <code>spmenurc</code> and nothing else on startup, as if this make this a bit easier. <a
feature did not exist.</p> href="https://git.speedie.site/spmenuify">spmenuify</a> is the official
<p>Not only can profiles be used to configure color schemes and fonts, theme manager, but you could use another one or write your own.</p>
allowing you to swap color schemes quickly, but also any other options
you may want.</p>
<p>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.</p>
<p>There are a few color schemes for spmenu included in the repository,
see the <code>themes/</code> directory. Feel free to copy those to your
profile directory.</p>
<h2 id="run-launcher">Run launcher</h2> <h2 id="run-launcher">Run launcher</h2>
<p>spmenu includes a powerful Bash script called spmenu_run. It lists <p>spmenu includes a powerful Bash script called spmenu_run. It lists
executable programs in $PATH and displays them to the user in a list. executable programs in $PATH and displays them to the user in a list.