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

various changes

Browse source
This commit is contained in:
speedie 2023-06-04 22:20:27 +02:00
parent 8cd71f5ebd
commit 25f9f160f2
8 changed files with 20 additions and 119 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
pages/Patches.md
View file

@ -1,51 +0,0 @@
Patches
=======
spmenu includes the functionality of several suckless patches. Some have been changed heavily and others were patched in as-is.
- allowcolorfont
- Remove code from libdrw preventing color emojis from being drawn.
- alpha
- Transparency support
- barheight
- Allows overriding the bar height, works very differently in spmenu.
- bidi
- Implements right to left language support (such as Arabic)
- border
- Adds a border around the window
- case insensitive
- This patch was never applied, but spmenu has similar functionality for most arguments including case (in)sensitivity
- center
- Allows the window to be positioned in the center rather than top or bottom. spmenu has a very different version of this patch.
- colored caret
- This patch was never applied, but spmenu allows all colorschemes and colors to be configured individually.
- dracula
- This patch was never applied, but spmenu can have Dracula colors through [[User themes]].
- fuzzyhighlight
- Adds in highlighting for fuzzy matching.
- fuzzymatch
- Adds in fzf like matching.
- grid
- Allows grid (column) number to be changed.
- gridnav
- Allows moving left/right
- gruvbox
- This patch was never applied but spmenu can have Gruvbox colors through [[User themes]].
- highpriority
- Allows you to define items that match higher than others.
- incremental
- Returns input text on every keypress.
- initialtext
- Input text to start spmenu with.
- lines below prompt
- This patch was never applied but spmenu allows item indentation to be toggled.
- managed
- Allows your window manager to manage the window.
- mouse support
- Adds basic mouse features.
- navhistory
- Adds built in history and history buffer navigation
- no sort
- Adds a toggle for sorting items
- numbers
- Adds a match/item count indicator

2
pages/Reading files.md
View file

@ -30,4 +30,4 @@ func &
spmenu -lf /tmp/date-file -p "The time is:"
```
[speedwm-extras](https://git.speedie.site/speedie/speedwm-extras)' speedwm-btctrl uses this feature to load Bluetooth entries every 5 seconds.
[speedwm-extras](https://git.speedie.site/speedie/speedwm-extras)' speedwm-btctrl uses this feature to load Bluetooth entries every 5 seconds. There are more example scripts that also read from file in the `scripts/examples` directory.

2
pages/Theme managers.md
View file

@ -19,3 +19,5 @@ This article is intended to be a list of theme managers that can be installed an
- spmenuify is the official theme manager for spmenu. It allows installation, previewing, enabling and disabling of themes.
# User theme managers
None have been addedto this list yet.

12
pages/User themes.md
View file

@ -16,7 +16,11 @@ Tip: Use `Ctrl+f` to search through the page.
- Please try to use stable hosting if possible for links. If this is not possible, consider [emailing me](mailto:speedie@speedie.site) so I can host it on my site.
- Outdated profiles may be removed if necessary. Please try to maintain it, if you don't have time to do so a disclaimer would be nice.
### Official themes
### Themes
- [Default](https://git.speedie.site/speedie/spmenu-themes/raw/branch/master/spmenu.conf)
- Author: [speedie](https://speedie.site) ([speedie@speedie.site](mailto:speedie@speedie.site))
- This config is the default configuration for spmenu. This is automatically installed to `/usr/share/spmenu/spmenu.conf` so you *usually* don't need a copy of this.
![image](/pages/images/arc-dark.png)
@ -97,9 +101,3 @@ Tip: Use `Ctrl+f` to search through the page.
- [dmenu](https://git.speedie.site/speedie/spmenu-themes/raw/branch/master/dmenu.conf)
- Author: [speedie](https://speedie.site) ([speedie@speedie.site](mailto:speedie@speedie.site))
- This config tries to match dmenu as closely as possible, even stripping away spmenu only features to an extent.
- [Default](https://git.speedie.site/speedie/spmenu-themes/raw/branch/master/spmenu.conf)
- Author: [speedie](https://speedie.site) ([speedie@speedie.site](mailto:speedie@speedie.site))
- This config is the default configuration for spmenu. This is automatically installed to `/usr/share/spmenu/spmenu.conf` so you *usually* don't need a copy of this.
### User-submitted themes

3
pages/Using spmenu on macOS.md
View file

@ -1,6 +1,7 @@
Using spmenu on macOS
=====================
**NOTE: This article features information that may not apply to newer spmenu versions. An update to this article needs to be made.**
**NOTE: This article features information that no longer applies to current spmenu versions. macOS users should now be able to install it the same way as everyone else, provided Wayland support is disabled and Xquartz is installed.**
spmenu (sort of) supports macOS. This is done through an X11 implementation for macOS called [XQuartz](https://www.xquartz.org/). It requires some extra effort however.

24
pages/Using the wiki.md
View file

@ -1,24 +0,0 @@
Using the wiki
==============
Lost? If you don't know where to go, you can click the icon on the top bar. The `All` button allows you to get a view of all articles that have been posted on the wiki.
There is also a search bar at the top of every page which allows you to search for any article that has been posted.
## Basic wiki features
The wiki, based on a fork of w2wiki allows you to create new articles, edit existing articles, read existing articles (that's pretty much given), [host it yourself](https://codeberg.org/speedie/speedwm-wiki), and delete articles.
Now, please note that I am giving you this power, and with great power comes great responsibility. I want everyone to be able to help with the project. However, if it gets abused by people then I will have to remove this functionality and go back to using purely Git.
So please don't ruin it for everyone. If the wiki has to be shut down due to your vandalism, we hate you forever. That said, we do make Git backups fairly often (I will not say how often to prevent vandalism), so if an article is deleted it should be possible to restore it with minor changes lost.
## The sidebar
The sidebar is a markdown page like any other and can also be edited as any other. It is supposed to be used as a list of links, but of course there is no limit to what you can do with it.
To edit it, click `All` and edit `_sidebar`. From there, you can follow regular markdown syntax.
## Testing locally
Please, please, please test locally if you're new to markdown. That way, you avoid (for example) deleting pages by accident. You can easily test an identical (minus some pages perhaps) copy of the wiki locally by installing `php` with your distro's package manager and cloning [the repo](https://codeberg.org/speedie/speedwm-wiki) somewhere. If you don't know what you're doing, just cd into it, run `php -S localhost:1337` to start PHP, open any web browser and go to `localhost:1337`. Of course, the `1337` here can be swapped out for almost any value, it's just what I happen to go with.

24
pages/Where do I go?.md
View file

@ -1,24 +0,0 @@
Where do I go?
==============
Lost? If you don't know where to go, you can click the icon on the top bar. The `All` button allows you to get a view of all articles that have been posted on the wiki.
There is also a search bar at the top of every page which allows you to search for any article that has been posted.
## Basic wiki features
The wiki, based on a fork of w2wiki allows you to create new articles, edit existing articles, read existing articles (that's pretty much given), [host it yourself](https://codeberg.org/speedie/speedwm-wiki), and delete articles.
Now, please note that I am giving you this power, and with great power comes great responsibility. I want everyone to be able to help with the project. However, if it gets abused by people then I will have to remove this functionality and go back to using purely Git.
So please don't ruin it for everyone. If the wiki has to be shut down due to your vandalism, we hate you forever. That said, we do make Git backups fairly often (I will not say how often to prevent vandalism), so if an article is deleted it should be possible to restore it with minor changes lost.
## The sidebar
The sidebar is a markdown page like any other and can also be edited as any other. It is supposed to be used as a list of links, but of course there is no limit to what you can do with it.
To edit it, click `All` and edit `_sidebar`. From there, you can follow regular markdown syntax.
## Testing locally
Please, please, please test locally if you're new to markdown. That way, you avoid (for example) deleting pages by accident. You can easily test an identical (minus some pages perhaps) copy of the wiki locally by installing `php` with your distro's package manager and cloning [the repo](https://codeberg.org/speedie/speedwm-wiki) somewhere. If you don't know what you're doing, just cd into it, run `php -S localhost:1337` to start PHP, open any web browser and go to `localhost:1337`. Of course, the `1337` here can be swapped out for almost any value, it's just what I happen to go with.

19
pages/_sidebar.md
View file

@ -1,21 +1,20 @@
Getting Started
===============
- [[Home]]
- [[Where do I go?]]
- [[Getting Started]]
Basics
======
- [[Home]]
- [[Getting Started]]
- [[Using spmenu as a run launcher]]
- [[User scripts]]
- [[Configuring spmenu]]
- [[User scripts]]
- [[User themes]]
Advanced
========
Hacker
======
- [[Scripting with spmenu]]
- [[Functions in spmenu_run]]
Developer
=========
- [[Extensive code documentation]]