update getting started
This commit is contained in:
parent
67ae1175cc
commit
8cd71f5ebd
|
@ -1,9 +1,8 @@
|
||||||
Getting Started
|
Getting Started
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
spmenu is an X11 menu application which takes standard input, parses
|
spmenu is a simple X11 and Wayland menu application which takes standard input, parses
|
||||||
it, and lets the user choose an option and sends the
|
it, lets the user choose an option and sends the selected option to standard output.
|
||||||
selected option to standard output.
|
|
||||||
|
|
||||||
In addition to this, it also serves as a run launcher through the included
|
In addition to this, it also serves as a run launcher through the included
|
||||||
shell script `spmenu_run`, which handles both $PATH listing, .desktop entries
|
shell script `spmenu_run`, which handles both $PATH listing, .desktop entries
|
||||||
|
@ -11,8 +10,8 @@ and file listing.
|
||||||
|
|
||||||
While spmenu is based on dmenu, and is also fully compatible with dmenu,
|
While spmenu is based on dmenu, and is also fully compatible with dmenu,
|
||||||
spmenu introduces many new features which can be useful in shell scripting.
|
spmenu introduces many new features which can be useful in shell scripting.
|
||||||
There are way too many to list, but spmenu has a
|
|
||||||
[wiki](https://spmenu.speedie.site) which goes through features in more detail.
|
It also serves as a dmenu replacement for Wayland users.
|
||||||
|
|
||||||
### Supported operating systems
|
### Supported operating systems
|
||||||
|
|
||||||
|
@ -35,6 +34,8 @@ it. macOS has some different steps.
|
||||||
- macOS/Mac OS X
|
- macOS/Mac OS X
|
||||||
- macOS *should* be supported, however it requires `Xquartz` to be installed
|
- macOS *should* be supported, however it requires `Xquartz` to be installed
|
||||||
on the system. See [[Using spmenu on macOS]] for more information.
|
on the system. See [[Using spmenu on macOS]] for more information.
|
||||||
|
- As far as I know, there is no Wayland display server for macOS, so
|
||||||
|
Wayland support will need to be disabled.
|
||||||
|
|
||||||
### Installation on Gentoo GNU/Linux
|
### Installation on Gentoo GNU/Linux
|
||||||
|
|
||||||
|
@ -74,11 +75,19 @@ While the list of dependencies will vary depending on the spmenu version
|
||||||
you're going to install (see README.md for your specific version),
|
you're going to install (see README.md for your specific version),
|
||||||
below is a list for the latest release.
|
below is a list for the latest release.
|
||||||
|
|
||||||
|
- wayland-client
|
||||||
|
- For Wayland support, which is optional.
|
||||||
|
- wayland-scanner
|
||||||
|
- For Wayland support, which is optional.
|
||||||
|
- wayland-protocols
|
||||||
|
- For Wayland support, which is optional.
|
||||||
|
- xkbcommon
|
||||||
|
- For Wayland support, which is optional.
|
||||||
- libX11
|
- libX11
|
||||||
|
- For X11 support
|
||||||
- If you're using macOS, XQuartz is a dependency instead.
|
- If you're using macOS, XQuartz is a dependency instead.
|
||||||
- If you're using Wayland, `xorg-xwayland` is a dependency.
|
- If you're using Wayland, `xorg-xwayland` is a dependency.
|
||||||
- libXrender
|
- libXrender
|
||||||
- freetype
|
|
||||||
- imlib2
|
- imlib2
|
||||||
- Used for image support, can be disabled during compile time.
|
- Used for image support, can be disabled during compile time.
|
||||||
- libXinerama
|
- libXinerama
|
||||||
|
@ -207,4 +216,4 @@ spmenu also has a config file through libconfig. A default config should be inst
|
||||||
|
|
||||||
Great, you should now know how spmenu works on a basic level. Now, if you are a tiling window manager user or just want a better run launcher, you can check out the article 'Using spmenu as a run launcher'. Alternatively, if you want to use this for scripting you can check out [[Scripting with spmenu]]. There are also many scripts that use spmenu to display items, see [[User scripts]] for that.
|
Great, you should now know how spmenu works on a basic level. Now, if you are a tiling window manager user or just want a better run launcher, you can check out the article 'Using spmenu as a run launcher'. Alternatively, if you want to use this for scripting you can check out [[Scripting with spmenu]]. There are also many scripts that use spmenu to display items, see [[User scripts]] for that.
|
||||||
|
|
||||||
If you want to theme spmenu, you can see [[User themes]].
|
If you want to theme spmenu, you can see [[User themes]]. If you want some scripts to go along with spmenu, see [[User scripts]].
|
||||||
|
|
Loading…
Reference in a new issue