clipman - Man Page

Synopsis

clipman [<flags>] <command> [<args> ...]

Description

A clipboard manager for Wayland

Options

-h,  --help

Show context-sensitive help (also try --help-long and --help-man).

--histpath="~/.local/share/clipman.json"

Path of history file

--notify

Send desktop notifications on errors

-v,  --version

Show application version.

Commands

help [<command>...]

Show help.

store [<flags>]

Record clipboard events (run as argument to `wl-paste --watch`)

--max-items=15

history size

-P,  --no-persist

Don't persist a copy buffer after a program exits

pick --tool=TOOL [<flags>]

Pick an item from clipboard history

--max-items=15

scrollview length

-t, --tool=TOOL

Which selector to use: wofi/bemenu/CUSTOM/dmenu/rofi/STDOUT

-T, --tool-args=""

Extra arguments to pass to the --tool

--print0

Separate items using NULL; recommended if your tool supports --read0 or similar

clear [<flags>]

Remove item/s from history

--max-items=15

scrollview length

-t, --tool=TOOL

Which selector to use: wofi/bemenu/CUSTOM/dmenu/rofi/STDOUT

-T, --tool-args=""

Extra arguments to pass to the --tool

-a, --all

Remove all items

--print0

Separate items using NULL; recommended if your tool supports --read0 or similar

restore

Serve the last recorded item from history

Usage

Run the binary in your Sway session by adding `exec wl-paste -t text --watch clipman store` (or `exec wl-paste -t text --watch clipman store 1>> PATH/TO/LOGFILE 2>&1 &` to log errors) at the beginning of your config. For primary clipboard support, also add `exec wl-paste -p -t text --watch clipman store --histpath="~/.local/share/clipman-primary.json`.

To query the history and select items, run the binary as `clipman pick -t wofi`. You can assign it to a keybinding: `bindsym $mod+h exec clipman pick -t wofi`. For primary clipboard support, `clipman pick -t wofi --histpath="~/.local/share/clipman-primary.json`. You can pass additional arguments to the selector like this: `clipman pick --tool wofi -T'--prompt=my-prompt -i'` (both `--prompt` and `-i` are flags of wofi). You can use a custom selector like this: `clipman pick --print0 --tool=CUSTOM --tool-args="fzf --prompt 'pick > ' --bind 'tab:up' --cycle --read0"`.

To remove items from history, `clipman clear -t wofi` and `clipman clear --all`.

To serve the last history item at startup, add `exec clipman restore` to your Sway config.

Known Issues

All items stored in history are treated as plain text.

By default, we continue serving the last copied item even after its owner has exited. This means that, unless you run with the `--no-persist` option, you'll always immediately lose rich content: for example, if you copy formatted text inside Libre Office you'll lose all formatting on paste; or, if you copy a bookmark in Firefox, you won't be able to paste it in another bookmark folder.

Info

1.5.2