diff options
| author | theimpostor <sahirhoda@gmail.com> | 2024-08-18 11:43:07 -0500 |
|---|---|---|
| committer | theimpostor <sahirhoda@gmail.com> | 2024-08-18 11:43:07 -0500 |
| commit | 2f42995ff3cceea702f9d92bb1d505600955dcd4 (patch) | |
| tree | bc5a75510233517fb160ba69ff2b9df453344dac /README.md | |
| parent | 2a3415446574c63d7912c2be2f7493eb369435a4 (diff) | |
check stdin readable and update readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 33 |
1 files changed, 20 insertions, 13 deletions
@@ -5,15 +5,27 @@ System clipboard access includes writing (i.e. copy) and reading (i.e. paste), e ## Examples -``` -❯ echo asdf | osc copy +#### Copying to the clipboard +``` +❯ echo -n asdf | osc copy # String 'asdf' copied to clipboard +``` +#### Pasting from the clipboard + +``` ❯ osc paste asdf ``` +#### Clearing the clipboard + +``` +❯ osc copy /dev/null +# Clipboard cleared +``` + ## Usage ``` @@ -30,13 +42,13 @@ Available Commands: version Outputs version information Flags: - -d, --device string select device - -h, --help help for osc - -l, --log string write logs to file - -v, --verbose verbose logging + -d, --device string select device (default "/dev/tty") + -h, --help help for osc + -l, --log string write logs to file + -t, --timeout float tty read timeout in seconds (default 5) + -v, --verbose verbose logging Use "osc [command] --help" for more information about a command. - ``` ## Compatibility @@ -57,8 +69,7 @@ Terminal | Terminal OS | Shell OS | Copy | Paste | Notes #### Terminal Multiplexer support -Using [alacritty](https://github.com/alacritty/alacritty) as the terminal, -default configuration options for multiplexer: +Using [alacritty](https://github.com/alacritty/alacritty) as the terminal: Terminal Multiplexer | Copy | Paste | Notes --- | --- | --- | --- @@ -74,10 +85,6 @@ go install -v github.com/theimpostor/osc@latest This will install the latest version of osc to `$GOPATH/bin`. To find out where `$GOPATH` is, run `go env GOPATH` -## TODO - -- [ ] [copy] check is stdin is readable - ## For neovim - set init.lua |
