speedie/spmenu-wiki
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Rename one article, remove one article, modify some articles,

Browse source 
add theme.conf documentation
This commit is contained in:
speedie 2023-07-20 15:12:38 +02:00
parent 9b22830b7c
commit e11583329a
7 changed files with 499 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
articles/Configurable keybindings.md
View file

@ -1,4 +1,4 @@
# Configurable keybindings # Configurable keybinds
spmenu has since version 1.0 supported configuring keybinds and mouse binds spmenu has since version 1.0 supported configuring keybinds and mouse binds
through a config file. The default config file *should* have the default through a config file. The default config file *should* have the default

14
articles/Configuring spmenu.md
View file

@ -1,14 +0,0 @@
# Configuring spmenu
A fully complete configuration file is available in
/usr/share/spmenu/spmenu.conf. This config is more or less identical to the
default options. This makes it an excellent place to start because everything
is already defined, you just make the changes you want. To use this config,
simply copy it to ~/.config/spmenu/spmenu.conf and restart spmenu. It should be
used immediately.
What may be useful to know is that keybinds in your spmenu.conf (by default)
override **all** hardcoded keybindings. This is because otherwise keybindings
can conflict or be executed twice. This creates a problem, because if a new
function is implemented the user must manually add it to their config or
restore the default config. This is the case with the fullscreen image feature.

2
articles/Getting Started.md
View file

@ -93,4 +93,4 @@ to ~/.config/spmenu/binds.conf.
That's it. That's all you need to know to get started with spmenu.. and That's it. That's all you need to know to get started with spmenu.. and
a little more for good measure. From here, you can take a break, or check a little more for good measure. From here, you can take a break, or check
out [[User scripts]], [[User themes]], [[Functions in spmenu_run]], out [[User scripts]], [[User themes]], [[Functions in spmenu_run]],
[[Using spmenu to parse text]], or [[Configuring spmenu]] if you're hungry for more. [[Using spmenu to parse text]], or [[spmenu.conf documentation]] if you're hungry for more.

3
articles/Sidebar.md
View file

@ -1,11 +1,12 @@
##### Basics ##### Basics
- [[Home]] - [[Home]]
- [[Download spmenu]]
- [[Getting Started]] - [[Getting Started]]
- [[Using spmenu as a run launcher]] - [[Using spmenu as a run launcher]]
- [[Configuring spmenu]]
- [[User scripts]] - [[User scripts]]
- [[User themes]] - [[User themes]]
- [[spmenu.conf documentation]]
##### Hacker ##### Hacker

5
articles/binds.conf documentation.md
View file

@ -1,7 +1,7 @@
# binds.conf documentation # binds.conf documentation
**NOTE: A list of modes, modifiers, keys, functions and what arguments **NOTE: A list of modes, modifiers, keys, functions and what arguments
those functions expect can be found in [[Configurable keybindings]].** those functions expect can be found in [[Configurable keybinds]].**
The binds.conf allows key and mouse binds to be configurated outside of the The binds.conf allows key and mouse binds to be configurated outside of the
regular spmenu.conf config file. regular spmenu.conf config file.
@ -92,7 +92,6 @@ Tip: Use `Ctrl+f` to search this list, because it is quite long.
## See also ## See also
- [[Configuring spmenu]] - [[Configurable keybinds]]
- [[Configurable keybindings]]
- [[spmenu.conf documentation]] - [[spmenu.conf documentation]]
- [[theme.conf documentation]] - [[theme.conf documentation]]

5
articles/spmenu.conf documentation.md
View file

@ -1,7 +1,7 @@
# spmenu.conf documentation # spmenu.conf documentation
**NOTE: A list of modes, modifiers, keys, functions and what arguments **NOTE: A list of modes, modifiers, keys, functions and what arguments
those functions expect can be found in [[Configurable keybindings]].** those functions expect can be found in [[Configurable keybinds]].**
The spmenu.conf configuration file (usually located in The spmenu.conf configuration file (usually located in
~/.config/spmenu/spmenu.conf and is XDG Base Directory compliant) can ~/.config/spmenu/spmenu.conf and is XDG Base Directory compliant) can
@ -734,8 +734,7 @@ Tip: Use `Ctrl+f` to search this list, because it is quite long.
## See also ## See also
- [[Configuring spmenu]] - [[Configurable keybinds]]
- [[Configurable keybindings]]
- [[binds.conf documentation]] - [[binds.conf documentation]]
- [[theme.conf documentation]] - [[theme.conf documentation]]
- [libconfig documentation](https://hyperrealm.github.io/libconfig/libconfig_manual.pdf) - [libconfig documentation](https://hyperrealm.github.io/libconfig/libconfig_manual.pdf)

492
articles/theme.conf documentation.md
View file

@ -1,3 +1,493 @@
# theme.conf documentation # theme.conf documentation
TODO. The theme.conf configuration file (usually located in ~/.config/spmenu/theme.conf)
is loaded on startup by spmenu if it exists. This configuration file specifies
options that can be used for theming, but leaves many options alone. This is by
design, as themes should only specify the theming and not the user's keybinds
or other options.
While a default theme.conf doesn't exist, there are many themes that use this
configuration file. See [[User themes]] for more information.
## Syntax
Syntax is nearly identical to the spmenu.conf and binds.conf config file.
See [[spmenu.conf documentation]] for information on libconfig syntax.
## Supported strings
Tip: Use `Ctrl+f` to search this list, because it is quite long.
- **theme.window.position**
- Description: Position to spawn spmenu in (0: Bottom, 1: Top, 2: Center)
- Type: Integer
- **theme.window.border**
- Description: Window border size (in pixels)
- Type: Integer
- Note: Only applies for X11
- **theme.window.margin-vertical**
- Description: Inner vertical padding (in pixels)
- Type: Integer
- **theme.window.margin-horizontal**
- Description: Inner horizontal padding (in pixels)
- Type: Integer
- **theme.window.padding-vertical**
- Description: Outer vertical padding (in pixels)
- Type: Integer
- Note: Only applies for X11
- **theme.window.padding-horizontal**
- Description: Outer horizontal padding (in pixels)
- Type: Integer
- Note: Only applies for X11
- **theme.window.width**
- Description: spmenu window width (in pixels)
- Type: Integer
- Note: Only applied when the spmenu window position isn't center
- **theme.window.alpha**
- Description: Enable alpha (transparency) for spmenu
- Type: Integer
- **theme.window.x**
- Description: X position offset (in pixels)
- Type: Integer
- Note: Only applies for X11
- **theme.window.y**
- Description: Y position offset (in pixels)
- Type: Integer
- Note: Only applies for X11
- **theme.text.font**
- Description: Primary font to use when drawing text
- Type: String
- **theme.text.padding**
- Description: Horizontal padding around all text (in pixels)
- Type: Integer
- **theme.text.normitempadding**
- Description: Horizontal padding around normal items (in pixels)
- Type: Integer
- **theme.text.selitempadding**
- Description: Horizontal padding around selected items (in pixels)
- Type: Integer
- **theme.text.priitempadding**
- Description: Horizontal padding around high priority items (in pixels)
- Type: Integer
- **theme.text.leftarrow**
- Description: Character/text to draw when drawing the left arrow
- Type: String
- **theme.text.rightarrow**
- Description: Character/text to draw when drawing the right arrow
- Type: String
- **theme.text.password**
- Description: Character to draw for each hidden character in the input when -P
- Type: String
- **theme.text.prompt**
- Description: Prompt to display when one was not specified
- Type: String
- **theme.text.input**
- Description: Input to start spmenu with
- Type: String
- **theme.text.regex**
- Description: Text to display when regex matching is enabled
- Type: String
- **theme.text.capslockon**
- Description: Text to display when Caps Lock is on
- Type: String
- **theme.text.capslockoff**
- Description: Text to display when Caps Lock is off
- Type: String
- **theme.color.itemnormfg**
- Description: Normal item foreground color (#RRGGBB)
- Type: String
- **theme.color.itemnormbg**
- Description: Normal item background color (#RRGGBB)
- Type: String
- **theme.color.itemnormfg2**
- Description: Normal next item foreground color (#RRGGBB)
- Type: String
- **theme.color.itemnormbg2**
- Description: Normal next item background color (#RRGGBB)
- Type: String
- **theme.color.itemselfg**
- Description: Selected item foreground color (#RRGGBB)
- Type: String
- **theme.color.itemselbg**
- Description: Selected item background color (#RRGGBB)
- Type: String
- **theme.color.itemmarkedfg**
- Description: Marked item foreground color (#RRGGBB)
- Type: String
- **theme.color.itemmarkedbg**
- Description: Marked item background color (#RRGGBB)
- Type: String
- **theme.color.itemnormprifg**
- Description: Normal priority item foreground color (#RRGGBB)
- Type: String
- **theme.color.itemnormpribg**
- Description: Normal priority item background color (#RRGGBB)
- Type: String
- **theme.color.itemselprifg**
- Description: Selected priority item foreground color (#RRGGBB)
- Type: String
- **theme.color.itemselpribg**
- Description: Selected priority item background color (#RRGGBB)
- Type: String
- **theme.color.inputfg**
- Description: Input foreground color (#RRGGBB)
- Type: String
- **theme.color.inputbg**
- Description: Input background color (#RRGGBB)
- Type: String
- **theme.color.menu**
- Description: Menu color (#RRGGBB)
- Type: String
- **theme.color.promptfg**
- Description: Prompt foreground color (#RRGGBB)
- Type: String
- **theme.color.promptbg**
- Description: Prompt background color (#RRGGBB)
- Type: String
- **theme.color.larrowfg**
- Description: Left arrow foreground color (#RRGGBB)
- Type: String
- **theme.color.larrowbg**
- Description: Left arrow background color (#RRGGBB)
- Type: String
- **theme.color.rarrowfg**
- Description: Right arrow foreground color (#RRGGBB)
- Type: String
- **theme.color.rarrowbg**
- Description: Right arrow background color (#RRGGBB)
- Type: String
- **theme.color.hlnormfg**
- Description: Normal highlight foreground color (#RRGGBB)
- Type: String
- **theme.color.hlnormbg**
- Description: Normal highlight background color (#RRGGBB)
- Type: String
- **theme.color.hlselfg**
- Description: Selected highlight foreground color (#RRGGBB)
- Type: String
- **theme.color.hlselbg**
- Description: Selected highlight background color (#RRGGBB)
- Type: String
- **theme.color.numfg**
- Description: Match count foreground color (#RRGGBB)
- Type: String
- **theme.color.numbg**
- Description: Match count background color (#RRGGBB)
- Type: String
- **theme.color.modefg**
- Description: Mode indicator foreground color (#RRGGBB)
- Type: String
- **theme.color.modebg**
- Description: Mode indicator background color (#RRGGBB)
- Type: String
- **theme.color.capsfg**
- Description: Caps Lock foreground color (#RRGGBB)
- Type: String
- **theme.color.capsbg**
- Description: Caps Lock background color (#RRGGBB)
- Type: String
- **theme.color.border**
- Description: Border color (#RRGGBB)
- Type: String
- Note: Only applies for X11
- **theme.color.caretfg**
- Description: Caret foreground color (#RRGGBB)
- Type: String
- **theme.color.caretbg**
- Description: Caret background color (#RRGGBB)
- Type: String
- **theme.color.sgr0**
- Description: SGR 0 color (#RRGGBB)
- Type: String
- **theme.color.sgr1**
- Description: SGR 1 color (#RRGGBB)
- Type: String
- **theme.color.sgr2**
- Description: SGR 2 color (#RRGGBB)
- Type: String
- **theme.color.sgr3**
- Description: SGR 3 color (#RRGGBB)
- Type: String
- **theme.color.sgr4**
- Description: SGR 4 color (#RRGGBB)
- Type: String
- **theme.color.sgr5**
- Description: SGR 5 color (#RRGGBB)
- Type: String
- **theme.color.sgr6**
- Description: SGR 6 color (#RRGGBB)
- Type: String
- **theme.color.sgr7**
- Description: SGR 7 color (#RRGGBB)
- Type: String
- **theme.color.sgr8**
- Description: SGR 8 color (#RRGGBB)
- Type: String
- **theme.color.sgr9**
- Description: SGR 9 color (#RRGGBB)
- Type: String
- **theme.color.sgr10**
- Description: SGR 10 color (#RRGGBB)
- Type: String
- **theme.color.sgr11**
- Description: SGR 11 color (#RRGGBB)
- Type: String
- **theme.color.sgr12**
- Description: SGR 12 color (#RRGGBB)
- Type: String
- **theme.color.sgr13**
- Description: SGR 13 color (#RRGGBB)
- Type: String
- **theme.color.sgr14**
- Description: SGR 14 color (#RRGGBB)
- Type: String
- **theme.color.sgr15**
- Description: SGR 15 color (#RRGGBB)
- Type: String
- **theme.color.coloritems**
- Description: Color the selected items (0/1)
- Type: Integer
- **theme.color.sgr**
- Description: Interpret SGR sequences (0/1)
- Type: Integer
- **theme.alpha.itemnormfg**
- Description: Normal item foreground alpha (0-255)
- Type: Integer
- **theme.alpha.itemnormbg**
- Description: Normal item background alpha (0-255)
- Type: Integer
- **theme.alpha.itemnormfg2**
- Description: Normal next item foreground alpha (0-255)
- Type: Integer
- **theme.alpha.itemnormbg2**
- Description: Normal next item background alpha (0-255)
- Type: Integer
- **theme.alpha.itemselfg**
- Description: Selected item foreground alpha (0-255)
- Type: Integer
- **theme.alpha.itemselbg**
- Description: Selected item background alpha (0-255)
- Type: Integer
- **theme.alpha.itemmarkedfg**
- Description: Marked item foreground alpha (0-255)
- Type: Integer
- **theme.alpha.itemmarkedbg**
- Description: Marked item background alpha (0-255)
- Type: Integer
- **theme.alpha.itemnormprifg**
- Description: Normal priority item foreground alpha (0-255)
- Type: Integer
- **theme.alpha.itemnormpribg**
- Description: Normal priority item background alpha (0-255)
- Type: Integer
- **theme.alpha.itemselprifg**
- Description: Selected priority item foreground alpha (0-255)
- Type: Integer
- **theme.alpha.itemselpribg**
- Description: Selected priority item background alpha (0-255)
- Type: Integer
- **theme.alpha.inputfg**
- Description: Input foreground alpha (0-255)
- Type: Integer
- **theme.alpha.inputbg**
- Description: Input background alpha (0-255)
- Type: Integer
- **theme.alpha.menu**
- Description: Menu alpha (0-255)
- Type: Integer
- **theme.alpha.promptfg**
- Description: Prompt foreground alpha (0-255)
- Type: Integer
- **theme.alpha.promptbg**
- Description: Prompt background alpha (0-255)
- Type: Integer
- **theme.alpha.larrowfg**
- Description: Left arrow foreground alpha (0-255)
- Type: Integer
- **theme.alpha.larrowbg**
- Description: Left arrow background alpha (0-255)
- Type: Integer
- **theme.alpha.rarrowfg**
- Description: Right arrow foreground alpha (0-255)
- Type: Integer
- **theme.alpha.rarrowbg**
- Description: Right arrow background alpha (0-255)
- Type: Integer
- **theme.alpha.hlnormfg**
- Description: Normal highlight foreground alpha (0-255)
- Type: Integer
- **theme.alpha.hlnormbg**
- Description: Normal highlight background alpha (0-255)
- Type: Integer
- **theme.alpha.hlselfg**
- Description: Selected highlight foreground alpha (0-255)
- Type: Integer
- **theme.alpha.hlselbg**
- Description: Selected highlight background alpha (0-255)
- Type: Integer
- **theme.alpha.numfg**
- Description: Match count foreground alpha (0-255)
- Type: Integer
- **theme.alpha.numbg**
- Description: Match count background alpha (0-255)
- Type: Integer
- **theme.alpha.modefg**
- Description: Mode indicator foreground alpha (0-255)
- Type: Integer
- **theme.alpha.modebg**
- Description: Mode indicator background alpha (0-255)
- Type: Integer
- **theme.alpha.capsfg**
- Description: Caps Lock foreground alpha (0-255)
- Type: Integer
- **theme.alpha.capsbg**
- Description: Caps Lock background alpha (0-255)
- Type: Integer
- **theme.alpha.border**
- Description: Border alpha (0-255)
- Type: Integer
- Note: Only applies for X11
- **theme.alpha.caretfg**
- Description: Caret foreground alpha (0-255)
- Type: Integer
- **theme.alpha.caretbg**
- Description: Caret background alpha (0-255)
- Type: Integer
- **theme.powerline.promptstyle**
- Description: Prompt powerline style (0: >, 1: \, 2: ))
- Type: Integer
- **theme.powerline.matchcountstyle**
- Description: Match count powerline style (0: >, 1: \, 2: ))
- Type: Integer
- **theme.powerline.modestyle**
- Description: Mode indicator powerline style (0: >, 1: \, 2: ))
- Type: Integer
- **theme.powerline.capsstyle**
- Description: Caps Lock indicator powerline style (0: >, 1: \, 2: ))
- Type: Integer
- **theme.powerline.itemstyle**
- Description: Item powerline style (0: >, 1: \, 2: ))
- Type: Integer
- **theme.powerline.prompt**
- Description: Enable prompt powerline (0/1)
- Type: Integer
- **theme.powerline.matchcount**
- Description: Enable match count powerline (0/1)
- Type: Integer
- **theme.powerline.mode**
- Description: Enable mode indicator powerline (0/1)
- Type: Integer
- **theme.powerline.caps**
- Description: Enable caps lock indicator powerline (0/1)
- Type: Integer
- **theme.powerline.item**
- Description: Enable item powerline (0/1)
- Type: Integer
- **theme.hide.input**
- Description: Hide input (0/1)
- Type: Integer
- **theme.hide.larrow**
- Description: Hide left arrow (0/1)
- Type: Integer
- **theme.hide.rarrow**
- Description: Hide right arrow (0/1)
- Type: Integer
- **theme.hide.items**
- Description: Hide items (0/1)
- Type: Integer
- **theme.hide.prompt**
- Description: Hide prompt (0/1)
- Type: Integer
- **theme.hide.powerline**
- Description: Hide powerline (0/1)
- Type: Integer
- **theme.hide.caret**
- Description: Hide caret (0/1)
- Type: Integer
- **theme.hide.highlight**
- Description: Hide highlighting (0/1)
- Type: Integer
- **theme.hide.matchcount**
- Description: Hide match count (0/1)
- Type: Integer
- **theme.hide.mode**
- Description: Hide mode indicator (0/1)
- Type: Integer
- **theme.hide.caps**
- Description: Hide caps lock indicator (0/1)
- Type: Integer
- **theme.hide.image**
- Description: Hide images (0/1)
- Type: Integer
- **theme.line.height**
- Description: Height of each line (in pixels)
- Type: Integer
- **theme.line.indentitems**
- Description: Indent item X position to prompt width (0/1)
- Type: Integer
- **theme.center.width**
- Description: Menu width when centered (in pixels)
- Type: Integer
- **theme.image.width**
- Description: Default image width (in pixels)
- Type: Integer
- **theme.image.height**
- Description: Default image height (in pixels)
- Type: Integer
- **theme.image.gaps**
- Description: Image gaps (in pixels)
- Type: Integer
- **theme.image.position**
- Description: Image position (0: Top, 1: Bottom, 2: Center, 3: Top center)
- Type: Integer
- **theme.file.global**
- Description: Load \*.color\* colors on startup (0/1)
- Type: Integer
- **theme.caret.width**
- Description: Caret width, 0 means default (in pixels)
- Type: Integer
- **theme.caret.height**
- Description: Caret height, 0 means default (in pixels)
- Type: Integer
- **theme.caret.padding**
- Description: Caret padding (in pixels)
- Type: Integer
- **theme.mode.normal_text**
- Description: Text to display when in Normal mode
- Type: String
- **theme.mode.insert_text**
- Description: Text to display when in Insert mode
- Type: String
- **theme.pango.item**
- Description: Interpret Pango markup for items (0/1)
- Type: Integer
- **theme.pango.prompt**
- Description: Interpret Pango markup for the prompt (0/1)
- Type: Integer
- **theme.pango.input**
- Description: Interpret Pango markup for the input (0/1)
- Type: Integer
- **theme.pango.leftarrow**
- Description: Interpret Pango markup for the left arrow (0/1)
- Type: Integer
- **theme.pango.rightarrow**
- Description: Interpret Pango markup for the right arrow (0/1)
- Type: Integer
- **theme.pango.numbers**
- Description: Interpret Pango markup for the match count (0/1)
- Type: Integer
- **theme.pango.mode**
- Description: Interpret Pango markup for the mode indicator (0/1)
- Type: Integer
- **theme.pango.caps**
- Description: Interpret Pango markup for the caps lock indicator (0/1)
- Type: Integer
- **theme.pango.password**
- Description: Interpret Pango markup for the password input (0/1)
- Type: Integer
## See also
- [[Configurable keybinds]]
- [[spmenu.conf documentation]]
- [[binds.conf documentation]]