documentation improvements, xresources should require x11 support to be
compiled in
This commit is contained in:
parent
d4bfa5a5fc
commit
f9a95792d7
31
README.html
31
README.html
|
@ -176,15 +176,17 @@
|
||||||
<p>spmenu is a simple X11 and Wayland menu application which takes
|
<p>spmenu is a simple X11 and Wayland menu application which takes
|
||||||
standard input, parses it, lets the user choose an option and sends the
|
standard input, parses it, lets the user choose an option and sends the
|
||||||
selected option to standard output.</p>
|
selected option to standard output.</p>
|
||||||
<p>In addition to this, it also serves as a run launcher through the
|
<p>In addition to this, it also serves as a run launcher and desktop
|
||||||
included shell script <code>spmenu_run</code>, which handles both $PATH
|
launcher through the included shell script <code>spmenu_run</code>,
|
||||||
listing, .desktop entries and file listing.</p>
|
which handles both $PATH listing, .desktop entries, and file
|
||||||
|
listing.</p>
|
||||||
<p>While spmenu is based on dmenu, and is also fully compatible with
|
<p>While spmenu is based on dmenu, and is also fully compatible with
|
||||||
dmenu, spmenu introduces many new features which can be useful in shell
|
dmenu, spmenu introduces many new features which can be useful in shell
|
||||||
scripting. There are way too many to list, but spmenu has a <a
|
scripting, and notably Wayland support. There are way too many to list,
|
||||||
href="https://spmenu.speedie.site">wiki</a> which goes through features
|
but spmenu has a <a href="https://spmenu.speedie.site">wiki</a> which
|
||||||
in more detail.</p>
|
goes through features in more detail.</p>
|
||||||
<p>It also serves as a dmenu replacement for Wayland users.</p>
|
<p>spmenu also serves as a proper dmenu replacement for Wayland users,
|
||||||
|
and can be themed to look identical to dmenu.</p>
|
||||||
<h2 id="dependencies">Dependencies</h2>
|
<h2 id="dependencies">Dependencies</h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li>wayland-client
|
<li>wayland-client
|
||||||
|
@ -284,7 +286,7 @@ new changes to your Git repository, run
|
||||||
directory</strong>.</p>
|
directory</strong>.</p>
|
||||||
<p>To generate a tarball, run <code>scripts/make/generate-pkg.sh</code>
|
<p>To generate a tarball, run <code>scripts/make/generate-pkg.sh</code>
|
||||||
<strong>in the current directory</strong>. If you want to generate a
|
<strong>in the current directory</strong>. If you want to generate a
|
||||||
Pacman package, run <code>scripts/make/generate-pacman-pkg.sh</code>
|
pacman package, run <code>scripts/make/generate-pacman-pkg.sh</code>
|
||||||
instead.</p>
|
instead.</p>
|
||||||
<h2 id="wayland-support">Wayland support</h2>
|
<h2 id="wayland-support">Wayland support</h2>
|
||||||
<p>Note that Wayland support is still experimental, and some features do
|
<p>Note that Wayland support is still experimental, and some features do
|
||||||
|
@ -309,7 +311,16 @@ not possible due to the original implementation using XEmbed. If the
|
||||||
embed argument is passed it will simply be ignored and the window will
|
embed argument is passed it will simply be ignored and the window will
|
||||||
be layered as normal.</li>
|
be layered as normal.</li>
|
||||||
</ul></li>
|
</ul></li>
|
||||||
<li><code>--monitor</code> argument</li>
|
<li><code>--monitor</code> argument
|
||||||
|
<ul>
|
||||||
|
<li>Possible under Wayland, but not really useful.</li>
|
||||||
|
</ul></li>
|
||||||
|
<li><code>--vertical-padding</code> and
|
||||||
|
<code>--horizontal-padding</code> arguments
|
||||||
|
<ul>
|
||||||
|
<li>Not possible under Wayland due to layer_shell not supporting
|
||||||
|
it.</li>
|
||||||
|
</ul></li>
|
||||||
<li>Window borders</li>
|
<li>Window borders</li>
|
||||||
<li>Pasting</li>
|
<li>Pasting</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
@ -318,7 +329,7 @@ be layered as normal.</li>
|
||||||
href="https://spmenu.speedie.site/index.php/User+scripts">over on the
|
href="https://spmenu.speedie.site/index.php/User+scripts">over on the
|
||||||
wiki</a>. Feel free to contribute and try scripts on there.</p>
|
wiki</a>. Feel free to contribute and try scripts on there.</p>
|
||||||
<h2 id="more-information">More information</h2>
|
<h2 id="more-information">More information</h2>
|
||||||
<p>See the included <code>man</code> page.</p>
|
<p>See the included spmenu(1) and spmenu_run(1) man pages.</p>
|
||||||
<h2 id="license">License</h2>
|
<h2 id="license">License</h2>
|
||||||
<p>spmenu is licensed under the MIT license. See the included LICENSE
|
<p>spmenu is licensed under the MIT license. See the included LICENSE
|
||||||
file for more information!</p>
|
file for more information!</p>
|
||||||
|
|
20
README.md
20
README.md
|
@ -6,16 +6,17 @@ spmenu
|
||||||
spmenu is a simple X11 and Wayland menu application which takes standard input, parses
|
spmenu is a simple X11 and Wayland menu application which takes standard input, parses
|
||||||
it, lets the user choose an option and sends the selected option to standard output.
|
it, lets the user choose an option and sends the 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 and desktop launcher
|
||||||
shell script `spmenu_run`, which handles both $PATH listing, .desktop entries
|
through the included shell script `spmenu_run`, which handles both $PATH
|
||||||
and file listing.
|
listing, .desktop entries, 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
|
and notably Wayland support. There are way too many to list, but spmenu has a
|
||||||
[wiki](https://spmenu.speedie.site) which goes through features in more detail.
|
[wiki](https://spmenu.speedie.site) which goes through features in more detail.
|
||||||
|
|
||||||
It also serves as a dmenu replacement for Wayland users.
|
spmenu also serves as a proper dmenu replacement for Wayland users, and
|
||||||
|
can be themed to look identical to dmenu.
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
|
@ -107,7 +108,7 @@ to your Git repository, run `scripts/make/generate-docs.sh` **in the current
|
||||||
directory**.
|
directory**.
|
||||||
|
|
||||||
To generate a tarball, run `scripts/make/generate-pkg.sh` **in the current
|
To generate a tarball, run `scripts/make/generate-pkg.sh` **in the current
|
||||||
directory**. If you want to generate a Pacman package, run
|
directory**. If you want to generate a pacman package, run
|
||||||
`scripts/make/generate-pacman-pkg.sh` instead.
|
`scripts/make/generate-pacman-pkg.sh` instead.
|
||||||
|
|
||||||
## Wayland support
|
## Wayland support
|
||||||
|
@ -127,6 +128,9 @@ These are:
|
||||||
due to the original implementation using XEmbed. If the embed argument is passed
|
due to the original implementation using XEmbed. If the embed argument is passed
|
||||||
it will simply be ignored and the window will be layered as normal.
|
it will simply be ignored and the window will be layered as normal.
|
||||||
- `--monitor` argument
|
- `--monitor` argument
|
||||||
|
- Possible under Wayland, but not really useful.
|
||||||
|
- `--vertical-padding` and `--horizontal-padding` arguments
|
||||||
|
- Not possible under Wayland due to layer_shell not supporting it.
|
||||||
- Window borders
|
- Window borders
|
||||||
- Pasting
|
- Pasting
|
||||||
|
|
||||||
|
@ -138,7 +142,7 @@ free to contribute and try scripts on there.
|
||||||
|
|
||||||
## More information
|
## More information
|
||||||
|
|
||||||
See the included `man` page.
|
See the included spmenu(1) and spmenu_run(1) man pages.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
|
@ -78,7 +78,7 @@ if get_option('libconfig')
|
||||||
build_args += [ '-DCONFIG' ]
|
build_args += [ '-DCONFIG' ]
|
||||||
endif
|
endif
|
||||||
|
|
||||||
if get_option('xresources')
|
if get_option('xresources') and get_option('x11')
|
||||||
build_args += [ '-DXRESOURCES' ]
|
build_args += [ '-DXRESOURCES' ]
|
||||||
endif
|
endif
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue