Skip to content

Commit f40e58d

Browse files
committed
Add 0.10.0 documentation to readme
1 parent cc00a8d commit f40e58d

File tree

2 files changed

+189
-0
lines changed

2 files changed

+189
-0
lines changed

โ€ŽREADME.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -705,6 +705,21 @@ $ cb --clr
705705
# These all work great!
706706
```
707707

708+
Clear a certain range of history entries.
709+
```sh
710+
$ cb clear 69-420
711+
# Clears entries 69 through 420 inclusive
712+
$ cb clr 0-100
713+
# Clears entries 0 through 100 inclusive
714+
# Note: Entry 0 is always the most recent one
715+
```
716+
717+
Just clear everything.
718+
```sh
719+
$ cb clear -a
720+
# Note: This will really clear everything in all clipboards!
721+
```
722+
708723
<br>
709724

710725
<h3><b>Edit Clipboard Content</b> &emsp; <code>cb [--](edit|ed)[(num)|_(id)] [editor]</code></h3>
@@ -732,6 +747,82 @@ cb ed code
732747

733748
<br>
734749

750+
<h3><b>Add Script to Clipboard</b> &emsp; <code>cb [--](script|sc)[(num)|_(id)] [script path|content]</code></h3>
751+
752+
Start simple.
753+
```sh
754+
$ cb script pwd # Note: The exact output of "pwd" will vary depending on your system.
755+
$ cb
756+
/run/user/1000/Clipboard/0/data/0
757+
# The output of CB will be here
758+
/run/user/1000/Clipboard/0/data/0
759+
```
760+
761+
Use a script file instead.
762+
```sh
763+
$ cat myscript.sh
764+
echo "Hello Clipboard!"
765+
echo "Here's what's in the directory:"
766+
ls
767+
$ cb script myscript.sh
768+
$ cb
769+
Hello Clipboard!
770+
Here's what's in the directory:
771+
rawdata.clipboard
772+
# The output of CB will be here
773+
Hello Clipboard!
774+
Here's what's in the directory:
775+
rawdata.clipboard
776+
```
777+
778+
Customize during what action the script runs.
779+
```sh
780+
$ cb script ls --actions search,history
781+
$ cb
782+
$ cb history
783+
rawdata.clipboard
784+
# The output of CB will be here
785+
rawdata.clipboard
786+
$ cb search
787+
rawdata.clipboard
788+
# The output of CB will be here
789+
rawdata.clipboard
790+
$ cb copy
791+
$
792+
```
793+
794+
Customize if the script runs before, after, or both.
795+
```sh
796+
$ cb script ls --timings before
797+
$ cb
798+
rawdata.clipboard
799+
# The output of CB will be here
800+
$ cb script ls --timings after
801+
$ cb
802+
# The output of CB will be here
803+
rawdata.clipboard
804+
$ cb script ls --timings before,after
805+
rawdata.clipboard
806+
# The output of CB will be here
807+
rawdata.clipboard
808+
```
809+
810+
Customize both during what action the script runs and if the script runs before, after, or both.
811+
```sh
812+
$ cb script ls --actions copy --timings before
813+
$ cb
814+
$ cb copy
815+
rawdata.clipboard
816+
# The output of CB will be here
817+
```
818+
819+
View the current script.
820+
```sh
821+
$ cb script
822+
# Script content shows here
823+
```
824+
825+
<br>
735826

736827
### <img src="documentation/readme-assets/MoveThingsAround.png" alt="Move Things Around" height=25px />
737828

@@ -1460,6 +1551,12 @@ $ export CLIPBOARD_THEME=darkhighcontrast
14601551
$ cb show
14611552
```
14621553

1554+
Fully customize your style.
1555+
```sh
1556+
$ export CLIPBOARD_THEME=help=r;g;b,info=r;g;b,error=r;g;b,success=r;g;b,progress=r;g;b
1557+
# Note: You must put in a number within range 0-255 for each r, g, and b
1558+
```
1559+
14631560
<br>
14641561

14651562
<h3><b><code>FORCE_COLOR</code> &emsp; Set this to "true" or "1" to make CB always show color regardless of what you set <code>NO_COLOR</code> to.</b></h3>

โ€Ždocumentation/website/content/_docs.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,21 @@ $ cb --clr
324324
# These all work great!
325325
```
326326

327+
Clear a certain range of history entries.
328+
```sh
329+
$ cb clear 69-420
330+
# Clears entries 69 through 420 inclusive
331+
$ cb clr 0-100
332+
# Clears entries 0 through 100 inclusive
333+
# Note: Entry 0 is always the most recent one
334+
```
335+
336+
Just clear everything.
337+
```sh
338+
$ cb clear -a
339+
# Note: This will really clear everything in all clipboards!
340+
```
341+
327342
<br>
328343

329344
<h3><b>Edit Clipboard Content</b> &emsp; <code>cb [--](edit|ed)[(num)|_(id)] [editor]</code></h3>
@@ -351,6 +366,83 @@ cb ed code
351366

352367
<br>
353368

369+
<h3><b>Add Script to Clipboard</b> &emsp; <code>cb [--](script|sc)[(num)|_(id)] [script path|content]</code></h3>
370+
371+
Start simple.
372+
```sh
373+
$ cb script pwd # Note: The exact output of "pwd" will vary depending on your system.
374+
$ cb
375+
/run/user/1000/Clipboard/0/data/0
376+
# The output of CB will be here
377+
/run/user/1000/Clipboard/0/data/0
378+
```
379+
380+
Use a script file instead.
381+
```sh
382+
$ cat myscript.sh
383+
echo "Hello Clipboard!"
384+
echo "Here's what's in the directory:"
385+
ls
386+
$ cb script myscript.sh
387+
$ cb
388+
Hello Clipboard!
389+
Here's what's in the directory:
390+
rawdata.clipboard
391+
# The output of CB will be here
392+
Hello Clipboard!
393+
Here's what's in the directory:
394+
rawdata.clipboard
395+
```
396+
397+
Customize during what action the script runs.
398+
```sh
399+
$ cb script ls --actions search,history
400+
$ cb
401+
$ cb history
402+
rawdata.clipboard
403+
# The output of CB will be here
404+
rawdata.clipboard
405+
$ cb search
406+
rawdata.clipboard
407+
# The output of CB will be here
408+
rawdata.clipboard
409+
$ cb copy
410+
$
411+
```
412+
413+
Customize if the script runs before, after, or both.
414+
```sh
415+
$ cb script ls --timings before
416+
$ cb
417+
rawdata.clipboard
418+
# The output of CB will be here
419+
$ cb script ls --timings after
420+
$ cb
421+
# The output of CB will be here
422+
rawdata.clipboard
423+
$ cb script ls --timings before,after
424+
rawdata.clipboard
425+
# The output of CB will be here
426+
rawdata.clipboard
427+
```
428+
429+
Customize both during what action the script runs and if the script runs before, after, or both.
430+
```sh
431+
$ cb script ls --actions copy --timings before
432+
$ cb
433+
$ cb copy
434+
rawdata.clipboard
435+
# The output of CB will be here
436+
```
437+
438+
View the current script.
439+
```sh
440+
$ cb script
441+
# Script content shows here
442+
```
443+
444+
<br>
445+
354446
<h3><b>Load Contents</b> &emsp; <code>cb [--](load|ld)[(num)|_(id)] [clipboard] [clipboards]</code></h3>
355447

356448
Start by copying something.

0 commit comments

Comments
ย (0)