From 20e019b748c8ae14044c2bbe58d8218541a2354a Mon Sep 17 00:00:00 2001
From: speedie <speedie@duck.com>
Date: Sun, 25 Jun 2023 22:21:54 +0200
Subject: [PATCH] Update documentation for spmenu_run to mention bookmarking

---
 docs/run-docs.md | 18 ++++++++++++++++++
 spmenu_run.1     | 24 ++++++++++++++++++++++++
 2 files changed, 42 insertions(+)

diff --git a/docs/run-docs.md b/docs/run-docs.md
index b6470f4..cab79fd 100644
--- a/docs/run-docs.md
+++ b/docs/run-docs.md
@@ -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
diff --git a/spmenu_run.1 b/spmenu_run.1
index 53570c8..b4fa325 100644
--- a/spmenu_run.1
+++ b/spmenu_run.1
@@ -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.