clipmenu

commit 64e3c97c0c1069fafe718fcef4f829baeeed7e80
parent 25c7503c6a8466e2890e310f245bd6bbee084865
Author: Mark Stosberg <mark@rideamigos.com>
Date:   Fri, 13 Mar 2020 11:03:58 -0400

document options for clipmenu

For privacy considerations, it's important to know about the max
clip option.

Users could also use a hint about how to cleanly override environment
variables with systemd.

Diffstat:
M
README.md
 | 
28
++++++++++++++++++++++++++++

1 file changed, 28 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -49,6 +49,34 @@ there, but it basically works like this:
 2. If `clipmenud` detects changes to the clipboard contents, it writes them out
    to the cache directory.
 
+### Features of `clipmenud`
+
+The behavior of `clipmenud` can be customized through environment variables. Features include:
+
+ * Customizing max number of clips (Default: 1000)
+ * Choosing which selections to manage
+ * Ignoring certain windows, like password managers
+ * Enabling debugging
+ * Customizing the cache dir location
+ * Disable looping
+ * Option to "own" the clipboard
+
+Check the online help to view the details:
+
+    clipmenud --help
+
+If you managing `clipmenud` with `systemd`, you can override the defaults by using this command to generate an override file:
+
+    systemctl --user edit clipmenud
+
+Then add a new section sets your environment variables. For example:
+
+```
+[Service]
+Environment="CM_MAX_CLIPS=30"
+Environment="CM_SELECTIONS=clipboard"
+```
+
 ## clipmenu
 
 1. `clipmenu` reads the cache directory to find all available clips.