summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSam Tay <samctay@pm.me>2022-08-20 23:53:26 -0700
committerSam Tay <samctay@pm.me>2022-08-20 23:53:26 -0700
commit8814a90ac85fb007aa394e34ac4290fd3fe1d2e2 (patch)
tree911d12489f74b050f26ef5b8d6c6981ecccd304f
parentbba9a0d70cbcf1608ad3748edfb608068898edd9 (diff)
Add docs for sys clipboard
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 972a475..95a7535 100644
--- a/README.md
+++ b/README.md
@@ -139,6 +139,20 @@ In the same directory you'll find `colors.toml` which is self-documented. The
default theme attempts to blend in with your default terminal theme, but you can
change it as necessary. In particular, you may want to change the `highlight_text` if the current selection is difficult to read. There are some themes in the [themes](./themes) directory as well.
+#### system clipboard integration
+There's a very primitive integration in place to copy the contents of
+the currently focused question or answer to the system clipboard. This requires
+some command in your PATH that can accept stdin and pipe to the clipboard.
+On mac & windows, this will work out of the box with the default set to `pbcopy`
+& `clip` respectively. On Linux, I've made the assumption that `xclip` is likely
+the most popular, but if you use something else (e.g. `wl-copy` on wayland),
+you'll need to set the command directly:
+```yaml
+# config.yml
+---
+copy_cmd: copy --option-to-take-stdin
+```
+
#### api keys
If you want to use your own [StackExchange API
Key](https://api.stackexchange.com/docs) you can set it via