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

Improve documentation a bit

Browse source
This commit is contained in:
Jacob 2023-09-09 19:00:15 +02:00
parent 8c7cfd0ace
commit e6a96842a3
5 changed files with 16 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -182,3 +182,5 @@ Before contributing, please see [this article](https://spmenu.speedie.site/Contr
spmenu has [a wiki](https://spmenu.speedie.site) for more extensive
documentation. Contributions to the wiki are appreciated, and
can be done through [the Git repository](https://git.speedie.site/speedie/spmenu-wiki).
If you need help, you can also check out [my Matrix space](https://matrix.speedie.site).

5
docs/run-docs.md
View file

@ -52,6 +52,11 @@ cache (useful if you just installed/uninstalled a program) run `spmenu_run -cc`.
**NOTE: By default it will hide any entries matching `spmenu` (for convenience)
but you can unhide these if you wish through the configuration file.**
Flatpaks are also functional, provided they use valid .desktop entries. You
can use Flatpaks with spmenu_run by passing `-d`. $DESKTOP_DIR and
$ICON_DIR must contain Flatpak paths though. If you have a new config,
these variables should be defined properly already.
## Bookmarking
spmenu_run provides bookmarking entries or just general text if preferred. To

2
spmenu.1
View file

@ -1,5 +1,5 @@
'\" t
.\" Automatically generated by Pandoc 3.1.2
.\" Automatically generated by Pandoc 3.1.6
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.

8
spmenu_run.1
View file

@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 3.1.2
.\" Automatically generated by Pandoc 3.1.6
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
@ -77,6 +77,12 @@ run \f[V]spmenu_run -cc\f[R].
\f[B]NOTE: By default it will hide any entries matching
\f[VB]spmenu\f[B] (for convenience) but you can unhide these if you wish
through the configuration file.\f[R]
.PP
Flatpaks are also functional, provided they use valid .desktop entries.
You can use Flatpaks with spmenu_run by passing \f[V]-d\f[R].
$DESKTOP_DIR and $ICON_DIR must contain Flatpak paths though.
If you have a new config, these variables should be defined properly
already.
.SS Bookmarking
.PP
spmenu_run provides bookmarking entries or just general text if

2
spmenu_test.1
View file

@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 3.1.2
.\" Automatically generated by Pandoc 3.1.6
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.