From e6a96842a37ebbbfd329ba2a4ca345d2a3e4eea2 Mon Sep 17 00:00:00 2001 From: speedie Date: Sat, 9 Sep 2023 19:00:15 +0200 Subject: [PATCH] Improve documentation a bit --- README.md | 2 ++ docs/run-docs.md | 5 +++++ spmenu.1 | 2 +- spmenu_run.1 | 8 +++++++- spmenu_test.1 | 2 +- 5 files changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f8bc9db..65e573d 100644 --- a/README.md +++ b/README.md @@ -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). diff --git a/docs/run-docs.md b/docs/run-docs.md index cab79fd..f34a7b0 100644 --- a/docs/run-docs.md +++ b/docs/run-docs.md @@ -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 diff --git a/spmenu.1 b/spmenu.1 index bd55282..6bc93c9 100644 --- a/spmenu.1 +++ b/spmenu.1 @@ -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. diff --git a/spmenu_run.1 b/spmenu_run.1 index 9080029..5b13182 100644 --- a/spmenu_run.1 +++ b/spmenu_run.1 @@ -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 diff --git a/spmenu_test.1 b/spmenu_test.1 index 449c3c0..db91bfe 100644 --- a/spmenu_test.1 +++ b/spmenu_test.1 @@ -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.