about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorCase Duckworth2022-09-14 09:16:18 -0500
committerCase Duckworth2022-09-14 09:16:18 -0500
commit5613ebb0387f90fd90f39d5bad8eb173196f931f (patch)
treef5c58c3c04cff93453a89bc129de5f47b5b1fcba
parentAdd README and COPYING and stuff (diff)
downloadfoil-5613ebb0387f90fd90f39d5bad8eb173196f931f.tar.gz
foil-5613ebb0387f90fd90f39d5bad8eb173196f931f.zip
Update README HEAD main
-rw-r--r--README.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/README.md b/README.md index 2e4ce10..dbf4953 100644 --- a/README.md +++ b/README.md
@@ -6,3 +6,55 @@ This is a POSIX-sh clone of
6that I made for my friend L. 6that I made for my friend L.
7 7
8No guarantees or promises are made. 8No guarantees or promises are made.
9
10## usage
11
12```
13$ foil.sh copy # copy from stdin to clipboard
14$ foil.sh paste # paste from clipboard to stdout
15```
16
17there are cool aliases too:
18
19```
20$ foil.sh yeet # copy
21$ foil.sh yoink # paste
22```
23
24**IN ADDITION**, you can just symlink `foil.sh` to `copy`, `paste`, `yoink`, or
25`yeet`, and it'll Do The Right Thing:
26
27```
28$ yeet # same as foil.sh yeet
29$ yoink # same as foil.sh yoink
30```
31
32`make install` from this repo will copy `foil.sh` to `yoink` and `yeet` in
33`$(PREFIX)/bin` (default: `/usr/local/bin`).
34
35## dependencies
36
37`foil.sh` doesn't actually mangle your clipboard by itself.
38instead it shells out (heh) to one of these:
39
40- `tmux` (if you're in tmux)
41- `termux-clipboard-set`/`termux-clipboard-get` (if you're in termux)
42- `wl-copy`/`wl-paste` (if you're using wayland)
43- `pbpaste`
44- `xsel`
45- `xclip`
46- `lemonade`
47- `doitclient`
48- `win32yank`
49- `clip.exe`/`powershell.exe` (if you're using Windows)
50
51under cygwin-type systems, it'll write to or read from `/dev/clipboard`.
52
53basically, I try to follow the ZSH plugin above as closely as possible.
54
55## contributing
56
57of course, new clipboard technology is coming out all the time (allegedly). if
58you have a new fancy clipboard editor and want me to add it, or if you've added
59it yourself and have a patch, feel free to [email me](mailto:foil+git@acdw.net)
60with a feature or merge request.