Skip to content

Commit d09e82c

Browse files
committed
docs: Doc updates prior to clipmenu 7 release
There are a few things out of whack, like American spelling creeping in, and a few things that are not really well documented. Before we release v7 let's make sure this is all reasonably consistent and has good information.
1 parent 4760fbf commit d09e82c

4 files changed

Lines changed: 48 additions & 21 deletions

File tree

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,20 +30,25 @@ invoke clipmenu in exactly the same way to get the same effect, like so:
3030

3131
clipmenu -i -fn Terminus:size=8 -nb '#002b36' -nf '#839496' -sb '#073642' -sf '#93a1a1'
3232

33-
For a full list of environment variables that clipmenud can take, please see
34-
`man clipmenud`.
33+
By default, clipmenu also adds dmenu-compatible defaults such as `-p` and `-l`.
34+
If that gets in the way for a custom launcher, set `launcher_pass_dmenu_args` to
35+
0 in `clipmenu.conf`.
3536

36-
There is also `clipdel` to delete clips, and `clipctl` to enable or disable
37-
clipboard monitoring.
37+
For a full list of configuration options (and their environment variable
38+
equivalents), please see `man clipmenu.conf`.
39+
40+
There is also `clipdel` to delete clips, `clipdelmenu` for interactive deletion,
41+
and `clipctl` to enable or disable clipboard monitoring.
3842

3943
# Features
4044

41-
The behavior of `clipmenud` can be customized through a config file. As some
45+
The behaviour of `clipmenud` can be customised through a config file. As some
4246
examples of things you can change:
4347

4448
* Customising the maximum number of clips stored (default 1000)
4549
* Disabling clip collection temporarily with `clipctl disable`, reenabling with
4650
`clipctl enable`
51+
* Deduplicating repeated clips so only the newest remains
4752
* Not storing clipboard changes from certain applications, like password
4853
managers
4954
* Taking direct ownership of the clipboard

man/clipmenu.1

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ clipmenu \- interactive launcher for clipboard entry selection
77
.SH DESCRIPTION
88
.B clipmenu
99
provides an interactive interface for browsing and selecting clipboard entries
10-
stored by the clipmenud. It launches a menu using a configured launcher
11-
(e.g., dmenu, rofi, or another custom command) and displays a numbered list of stored
12-
clips. Once a selection is made, clipmenu calls
10+
stored by clipmenud. It launches a menu using a configured launcher
11+
(e.g., dmenu, rofi, or another custom command) and displays a numbered list of
12+
stored clips. Once a selection is made, clipmenu calls
1313
.BR clipserve
14-
to set the chosen clip as the current X11 clipboard.
14+
to set the chosen clip as the current X11 selections (PRIMARY and CLIPBOARD).
1515
.SH OPTIONS
1616
.TP
1717
.B \-h, \--help

man/clipmenu.conf.5

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
clipmenu.conf \- configuration file for clipmenu applications
44
.SH DESCRIPTION
55
clipmenu.conf defines the runtime settings for clipmenu applications (including
6-
clipmenu itself, clipmenud, clipctl, clipdel, and clipserve).
6+
clipmenu itself, clipmenud, clipctl, clipdel, clipdelmenu, and clipserve).
77
.SH FORMAT
88
Each non-comment line in clipmenu.conf consists of a key followed by one or
99
more whitespace-separated values. Blank lines and lines starting with '#' are
@@ -23,6 +23,10 @@ entries. Default: 100.
2323
If set to 1, clipmenud processes clipboard selections only once before exiting.
2424
Default: 0.
2525
.TP
26+
.B deduplicate
27+
If set to 1, clipmenud keeps only the newest copy of duplicate clips instead of
28+
storing every duplicate entry. Default: 0.
29+
.TP
2630
.B own_clipboard
2731
Determines whether clipmenud should claim ownership of the X11 clipboard. Works
2832
together with own_selections. Default: 0.
@@ -44,8 +48,8 @@ Specifies the launcher command to use with clipmenu. Alternative choices
4448
include rofi's dmenu mode or a custom command. Default: "dmenu".
4549
.TP
4650
.B launcher_pass_dmenu_args
47-
When enabled, extra command-line arguments passed to clipmenu are forwarded to
48-
the launcher. Default: 1.
51+
When enabled, clipmenu and clipdelmenu add dmenu-compatible defaults (such as
52+
-p and -l) before any user-provided arguments. Default: 1.
4953
.TP
5054
.B touch_on_select
5155
When an entry is selected via
@@ -61,17 +65,35 @@ incrementally update the clipboard (e.g. progressive text selection in
6165
browsers). Set to 0 to disable partial merging entirely. Default: 2.
6266
.TP
6367
.B cm_dir
64-
Overrides the default directory for the clip store. This is by default at a
65-
subdirectory inside XDG_RUNTIME_DIR, TMPDIR, or if both are unset, inside /tmp.
66-
The path must be absolute.
67-
A leading ~ expands to $HOME.
68+
Overrides the default base directory for clipmenu runtime data. The clip store
69+
is created at a subdirectory named clipmenu.<version>.<uid> inside this
70+
directory. By default, it uses XDG_RUNTIME_DIR, TMPDIR, or /tmp if neither are
71+
set. The path must be absolute. A leading ~ expands to $HOME.
6872
.SH FILE LOCATION
6973
Typically, clipmenu.conf is located at
7074
.BR ~/.config/clipmenu/clipmenu.conf
7175
.
7276
The file location can be overridden with $CM_CONFIG, which must be an absolute
73-
path.
74-
A leading ~ expands to $HOME.
77+
path. A leading ~ expands to $HOME. If $CM_CONFIG is unset, $XDG_CONFIG_HOME is
78+
used (falling back to ~/.config).
79+
.SH ENVIRONMENT
80+
.TP
81+
.B CM_CONFIG
82+
Absolute path (or a path beginning with ~) to the configuration file. This
83+
takes precedence over $XDG_CONFIG_HOME.
84+
.TP
85+
.B XDG_CONFIG_HOME
86+
Base directory for configuration files. If unset, ~/.config is used.
87+
.TP
88+
.B CM_DEBUG
89+
If set to 1, enable debug logging.
90+
.TP
91+
.B Config environment variables
92+
CM_MAX_CLIPS, CM_MAX_CLIPS_BATCH, CM_ONESHOT, CM_DEDUPLICATE, CM_OWN_CLIPBOARD,
93+
CM_SELECTIONS, CM_OWN_SELECTIONS, CM_IGNORE_WINDOW, CM_LAUNCHER,
94+
CM_LAUNCHER_PASS_DMENU_ARGS, and CM_DIR are environment variable equivalents for
95+
the configuration keys of the same name. These override values from the config
96+
file and are provided for compatibility with versions prior to 7.
7597
.SH SEE ALSO
7698
.BR clipctl (1),
7799
.BR clipdel (1),

man/clipserve.1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ clipserve \- serve a selected clipboard entry to X11 selections
77
.SH DESCRIPTION
88
.B clipserve
99
serves the clipboard content identified by a hash from the clip store on the
10-
X11 clipboard.
10+
X11 selections (PRIMARY and CLIPBOARD).
1111

1212
This program is not usually invoked directly, but is instead called from inside
1313
other clipmenu applications.
@@ -16,8 +16,8 @@ other clipmenu applications.
1616
.B \-h, \--help
1717
Display the help message (invokes the manual page).
1818
.TP
19-
clipserve requires exactly one argument, which is the hash of the clipboard
20-
entry to be served.
19+
clipserve requires exactly one argument, which is the hexadecimal hash of the
20+
clipboard entry to be served.
2121
.SH CONFIGURATION
2222
See
2323
.BR clipmenu.conf (5).

0 commit comments

Comments
 (0)