commit c4a9071b3e07c1f4bc1f920f42034d0d62f1eb38
parent 84fd3614ab71eade20d33fbbd474dff651001b97
Author: Chris Down <chris@chrisdown.name>
Date: Wed, 25 Mar 2020 19:10:41 +0000
readme: Tersify and use British English
We also don't explain too much about systemd -- you're expected to find
out or know about that agnostically of this project.
Also some features that we don't really want to advertise super widely
are not worth mentioning here.
Diffstat:
| M | README.md | | | 77 | ++++++++++++++++++++++++++--------------------------------------------------- |
1 file changed, 26 insertions(+), 51 deletions(-)
diff --git a/README.md b/README.md
@@ -10,13 +10,8 @@ clipmenu is a simple clipboard manager using [dmenu][] (or [rofi][] with
# Usage
Start `clipmenud`, then run `clipmenu` to select something to put on the
-clipboard.
-
-A systemd user service for starting clipmenud is installed as part of the project.
-
-If you want to start `clipmenud` immediately via systemd and have it be started when you login, run:
-
- systemctl --user enable --now clipmenud
+clipboard. For systemd users, a user service called `clipmenud` is packaged as
+part of the project.
You may wish to bind a shortcut in your window manager to launch `clipmenu`.
@@ -26,33 +21,42 @@ invoke clipmenu in exactly the same way to get the same effect, like so:
clipmenu -i -fn Terminus:size=8 -nb '#002b36' -nf '#839496' -sb '#073642' -sf '#93a1a1'
-If you prefer to collect clips on demand rather than running clipmenud as a
-daemon, you can bind a key to the following command for one-off collection:
-
- CM_ONESHOT=1 clipmenud
-
For a full list of environment variables that clipmenud can take, please see
`clipmenud --help`.
+# Features
+
+The behavior of `clipmenud` can be customized through environment variables.
+Despite being only <300 lines, clipmenu has many useful features, including:
+
+* Customising the maximum number of clips stored (default 1000)
+* Disabling clip collection temporarily with `clipctl disable`, reenabling with
+ `clipctl enable`
+* Not storing clipboard changes from certain applications, like password
+ managers
+* Taking direct ownership of the clipboard
+* ...and much more.
+
+Check `clipmenud --help` to view all possible environment variables and what
+they do. If you manage `clipmenud` with `systemd`, you can override the
+defaults by using `systemctl --user edit clipmenud` to generate an override
+file.
+
# Installation
Several distributions, including Arch and Nix, provide clipmenu as an official
package called `clipmenu`.
-## Installation - Manual
-
-If your distribution doesn't provide a package, you can run the following
-the commands to install this. (Or better yet, create package for your distribution!).
-You'll first need to install `xsel` and `clipnotify`. If you'll also need `dmenu` unless
-you plan to set `CM_LAUNCHER` to a different value, like `rofi`.
+## Manual installation
- git clone https://github.com/cdown/clipmenu.git
- cd clipmenu
- sudo make install
+If your distribution doesn't provide a package, you can manually install using
+`make install` (or better yet, create a package for your distribution!). You
+will need `xsel` and `clipnotify` installed, and also `dmenu` unless you plan
+to use a different launcher.
# How does it work?
-clipmenud is less than 200 lines, and clipmenu is less than 100, so hopefully
+clipmenud is less than 300 lines, and clipmenu is less than 100, so hopefully
it should be fairly self-explanatory. However, at the most basic level:
## clipmenud
@@ -62,35 +66,6 @@ it should be fairly self-explanatory. However, at the most basic level:
2. If `clipmenud` detects changes to the clipboard contents, it writes them out
to the cache directory and an index using a hash as the filename.
-### 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
- * Disabling clip collection temporarily with `clipctl disable`, reenabling with `clipctl enable`
- * 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 index to find all available clips.
