speedie/spmenu
2
0
Fork 1
Code Issues 1 Pull requests Packages Projects Releases 15 Wiki Activity

Update documentation for spmenu_run to mention bookmarking

Browse source
This commit is contained in:
speedie 2023-06-25 22:21:54 +02:00
parent 6bc994399f
commit 20e019b748
2 changed files with 42 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/run-docs.md
View file

@ -52,6 +52,24 @@ 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.**
## Bookmarking
spmenu_run provides bookmarking entries or just general text if preferred. To
view the saved bookmarks, open `spmenu_run -x` (the run launcher component) and
type in `@`. If you have no bookmarks what you're going to get is an empty menu.
To add bookmarks, type @ followed by a command. For example `@chromium` will
bookmark an entry called `chromium`, which will open Chromium.
If you want a longer command, you might want a shorter title to be displayed
. In that case you can type @ followed by a name and a colon.
Anything you type *after* the colon will be executed using a shell. For example
`@spmenu documentation:chromium https://spmenu.speedie.site` will add an entry called
`spmenu documentation` which when selected will open the spmenu wiki in Chromium.
For traditional bookmarking, consider something like
`@spmenu documentation:echo spmenu.speedie.site | xclip -sel clipboard`. spmenu_run
bookmarks should be treated as shell commands.
## File manager component
Finally, it also comes with a file manager component. Out of the box

24
spmenu_run.1
View file

@ -77,6 +77,30 @@ 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]
.SS Bookmarking
.PP
spmenu_run provides bookmarking entries or just general text if
preferred.
To view the saved bookmarks, open \f[V]spmenu_run -x\f[R] (the run
launcher component) and type in \f[V]\[at]\f[R].
If you have no bookmarks what you\[cq]re going to get is an empty menu.
To add bookmarks, type \[at] followed by a command.
For example \f[V]\[at]chromium\f[R] will bookmark an entry called
\f[V]chromium\f[R], which will open Chromium.
.PP
If you want a longer command, you might want a shorter title to be
displayed .
In that case you can type \[at] followed by a name and a colon.
Anything you type \f[I]after\f[R] the colon will be executed using a
shell.
For example
\f[V]\[at]spmenu documentation:chromium https://spmenu.speedie.site\f[R]
will add an entry called \f[V]spmenu documentation\f[R] which when
selected will open the spmenu wiki in Chromium.
.PP
For traditional bookmarking, consider something like
\f[V]\[at]spmenu documentation:echo spmenu.speedie.site | xclip -sel clipboard\f[R].
spmenu_run bookmarks should be treated as shell commands.
.SS File manager component
.PP
Finally, it also comes with a file manager component.