clipman/README.md

# Clipman

A basic clipboard manager for Wayland, with support for persisting copy buffers after an application exits.

## Installing

Requirements:

- a windows manager that uses `wlr-data-control`, like Sway and other wlroots-based WMs.
- wl-clipboard >= 2.0
- dmenu, rofi or wofi

[Install go](https://golang.org/doc/install), add `$GOPATH/bin` to your path, then run `go get github.com/yory8/clipman` OR run `go install` inside this folder.

Archlinux users can find a PKGBUILD [here](https://aur.archlinux.org/packages/clipman/).

## 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`. You can assign it to a keybinding: `bindsym $mod+h exec clipman pick`.
For primary clipboard support, `clipman pick --histpath="~/.local/share/clipman-primary.json`.

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

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

For more options: `clipman -h`.

## Known Issues

### Loss of rich text

- 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. The trade-off is that we *always immediately* lose rich content: for example, if you copy some bold text in LibreOffice, when you paste it right after it will be unformatted text; or, if you copy a bookmark in Firefox, you won't be able to paste it in another bookmark folder. To disable this behaviour, you must give up persistency-after-exit by passing the `-P` option to `clipman store`. (Items manually picked from history will still be just plain text.)

## Versions

This projects follows SemVer conventions.
first 2019-03-22 15:13:41 +01:00			`# Clipman`

better docs 2019-03-23 12:22:29 +01:00			`A basic clipboard manager for Wayland, with support for persisting copy buffers after an application exits.`
first 2019-03-22 15:13:41 +01:00
docs: add installing instructions 2019-05-13 12:41:44 +02:00			`## Installing`

			`Requirements:`
first 2019-03-22 15:13:41 +01:00
docs + style 2019-05-09 08:42:43 +02:00			- a windows manager that uses `wlr-data-control`, like Sway and other wlroots-based WMs.
perf!: move from polling to event-driven model BREAKING CHANGE: requires wl-clipboard >= 2.0 Closes #1. 2019-09-10 16:20:27 +02:00			`- wl-clipboard >= 2.0`
docs: mention wofi support 2019-09-29 10:16:08 +02:00			`- dmenu, rofi or wofi`
first 2019-03-22 15:13:41 +01:00
fix: use gomodules properly 2019-05-22 11:36:39 +02:00			[Install go](https://golang.org/doc/install), add `$GOPATH/bin` to your path, then run `go get github.com/yory8/clipman` OR run `go install` inside this folder.
docs: add installing instructions 2019-05-13 12:41:44 +02:00
			`Archlinux users can find a PKGBUILD [here](https://aur.archlinux.org/packages/clipman/).`

first 2019-03-22 15:13:41 +01:00			`## Usage`

fix: update readme with correct wl-paste flag 2019-10-31 17:42:46 +01:00			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`.
first 2019-03-22 15:13:41 +01:00
refac!: move from demon to oneshot storer Breaking change: requires calling with `wl-paste -t text --watch clipman store`. As a side-effect, enable primary clipboard support: `wl-paste -p -t text --watch clipman store --histpath="~/.local/share/clipman-primary.json`! Closes #12 2019-09-16 19:39:53 +02:00			To query the history and select items, run the binary as `clipman pick`. You can assign it to a keybinding: `bindsym $mod+h exec clipman pick`.
			For primary clipboard support, `clipman pick --histpath="~/.local/share/clipman-primary.json`.
better docs 2019-03-23 12:22:29 +01:00
docs: mention cmd `clear` in readme 2019-09-16 21:44:20 +02:00			To remove items from history, `clipman clear` and `clipman clear --all`.

docs: document new `restore` command 2019-10-27 09:22:40 +01:00			To serve the last history item at startup, add `exec clipman restore` to your Sway config.

better docs 2019-03-23 12:22:29 +01:00			For more options: `clipman -h`.
docs: declare that we use SemVer 2019-09-09 19:30:24 +02:00
docs: warn about loss of rich text 2019-10-13 15:39:48 +02:00			`## Known Issues`

			`### Loss of rich text`

docs: reword 2019-10-13 16:51:25 +02:00			`- All items stored in history are treated as plain text.`
docs: warn about loss of rich text 2019-10-13 15:39:48 +02:00
docs: reword 2019-10-13 16:51:25 +02:00			- By default, we continue serving the last copied item even after its owner has exited. The trade-off is that we always immediately lose rich content: for example, if you copy some bold text in LibreOffice, when you paste it right after it will be unformatted text; or, if you copy a bookmark in Firefox, you won't be able to paste it in another bookmark folder. To disable this behaviour, you must give up persistency-after-exit by passing the `-P` option to `clipman store`. (Items manually picked from history will still be just plain text.)
docs: warn about loss of rich text 2019-10-13 15:39:48 +02:00
docs: declare that we use SemVer 2019-09-09 19:30:24 +02:00			`## Versions`

			`This projects follows SemVer conventions.`