summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authortheimpostor <theimpostor@users.noreply.github.com>2022-02-20 10:22:01 -0600
committerGitHub <noreply@github.com>2022-02-20 10:22:01 -0600
commite70aca4241769a4730cf9f53de0cbf649ae44c5c (patch)
tree150fe2da5a8a2719e39a60337f739cbac228e322 /README.md
parent2b1414bee0e5e9c18705adc459e36491c08278b0 (diff)
Create README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ee56b58
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# osc52
+A command line tool to copy text to the system clipboard from anywhere using the [ANSI OSC52](https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Operating-System-Commands) sequence.
+
+When this sequence is printed, the terminal will copy the given text into the system clipboard. This is totally location independent, users can copy from anywhere including from remote SSH sessions.
+
+[List of supported terminals](https://github.com/ojroques/vim-oscyank/blob/main/README.md#vim-oscyank)
+
+## Installation
+```
+go install -v github.com/theimpostor/osc52@latest
+```
+
+## Usage
+```
+Usage: ./osc52 [file1 [...fileN]]
+Copies input to system clipboard using the OSC52 escape sequence.
+With no file arguments, will read from stdin
+```
+
+## Credits
+Credit and thanks to the the [vim-ocsyank](https://github.com/ojroques/vim-oscyank) plugin