Add Config docs

Slackadays · Dec 15, 2023 · fee25e1 · fee25e1
1 parent 14371ba
commit fee25e1
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1098,6 +1098,23 @@ $ cb status | cat
 
 <br>
 
+<details><summary> &ensp; <b>Check Your Configuration</b> &emsp; <code>cb [[--]config|cfg]</code></summary>
+
+<br>
+
+Check your configuration of CB.
+```sh
+$ cb config
+$ cb --config
+$ cb cfg
+$ cb --cfg
+# These all work great!
+```
+
+</details>
+
+<br>
+
 ### <img src="documentation/readme-assets/TipsAndTricks.png" alt="Tips And Tricks" height=25px />
 
 Need to paste a funky symbol somewhere a lot? Copy it to a persistent clipboard.

diff --git a/documentation/completions/cb.bash b/documentation/completions/cb.bash
@@ -1,7 +1,7 @@
 #/usr/bin/env bash
 complete_cb() {
     if [ "${#COMP_WORDS[@]}" == "2" ]; then
-        COMPREPLY=($(compgen -W "cut copy paste clear show edit add remove note swap status info load import export history ignore search help" ${COMP_WORDS[1]}))
+        COMPREPLY=($(compgen -W "cut copy paste clear show edit add remove note swap status info load import export history ignore search config help" ${COMP_WORDS[1]}))
         return
     fi
     if [ "${COMP_WORDS[1]}" == "cut" ] || [ "${COMP_WORDS[1]}" == "ct" ] || [ "${COMP_WORDS[1]}" == "copy" ] || [ "${COMP_WORDS[1]}" == "cp" ] || [ "${COMP_WORDS[1]}" == "add" ] || [ "${COMP_WORDS[1]}" == "ad" ]; then

diff --git a/documentation/completions/cb.fish b/documentation/completions/cb.fish
@@ -1,4 +1,4 @@
-set -l commands cut copy paste clear show edit add remove note swap status info load import export history ignore search help
+set -l commands cut copy paste clear show edit add remove note swap status info load import export history ignore search config help
 
 complete -c cb -f -n "not __fish_seen_subcommand_from $commands" -a cut -d 'cut something'
 complete -c cb -f -n "not __fish_seen_subcommand_from $commands" -a copy -d 'copy something'
@@ -18,4 +18,5 @@ complete -c cb -f -n "not __fish_seen_subcommand_from $commands" -a export -d 'e
 complete -c cb -f -n "not __fish_seen_subcommand_from $commands" -a history -d 'show clipboard history'
 complete -c cb -f -n "not __fish_seen_subcommand_from $commands" -a ignore -d 'ignore content'
 complete -c cb -f -n "not __fish_seen_subcommand_from $commands" -a search -d 'search clipboard content'
+complete -c cb -f -n "not __fish_seen_subcommand_from $commands" -a config -d 'show CB config'
 complete -c cb -f -n "not __fish_seen_subcommand_from $commands" -a help -d 'show help for CB'
diff --git a/documentation/completions/cb.zsh b/documentation/completions/cb.zsh
@@ -19,6 +19,7 @@ actions=(
     "history:show clipboard history"
     "ignore:ignore content"
     "search:search clipboard content"
+    "config:show CB config"
     "help:show help for CB"
 )
 # only put up to one action in front of the cb command

diff --git a/documentation/manpages/man.1 b/documentation/manpages/man.1
@@ -16,7 +16,7 @@
 \f[B]cb\f[R] [--](paste)[(num)|_(id)] (regex) [regexes] | (stdin)
 .PP
 \f[B]cb\f[R]
-[--](clear|edit|export|history|help|status|show|info)[(num)|_(id)]
+[--](clear|edit|export|history|help|status|show|info|config)[(num)|_(id)]
 .PP
 \f[B]cb\f[R] [--](load|swap)[(num)|_(id)] (clipboard) [clipboards]
 .PP

diff --git a/documentation/manpages/man.md b/documentation/manpages/man.md
@@ -13,7 +13,7 @@ cb(1) -- cut, copy, and paste anything in the terminal
 
 **cb** \[\-\-](paste)[(num)|_(id)] (regex) [regexes] | (stdin)
 
-**cb** \[\-\-](clear|edit|export|history|help|status|show|info)[(num)|_(id)]
+**cb** \[\-\-](clear|edit|export|history|help|status|show|info|config)[(num)|_(id)]
 
 **cb** \[\-\-](load|swap)[(num)|_(id)] (clipboard) [clipboards]
 

diff --git a/documentation/website/content/_docs.md b/documentation/website/content/_docs.md
@@ -738,6 +738,23 @@ $ cb status | cat
 
 <br>
 
+<details><summary> &ensp; <b>Check Your Configuration</b> &emsp; <code>cb [[--]config|cfg]</code></summary>
+
+<br>
+
+Check your configuration of CB.
+```sh
+$ cb config
+$ cb --config
+$ cb cfg
+$ cb --cfg
+# These all work great!
+```
+
+</details>
+
+<br>
+
 <br>
 
 # Action Tips and Tricks