summaryrefslogtreecommitdiff
path: root/docs/cli_tab_complete.md
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2024-05-30 10:00:28 +0100
committerGitHub <noreply@github.com>2024-05-30 10:00:28 +0100
commitb39285807e1d21300e8a5dbbf6f2c43a8aab3494 (patch)
tree311895a73c967f5d322885c1a9f1073a7b9f1b91 /docs/cli_tab_complete.md
parent6ef97172889ccd5db376b2a9f8825489e24fdac4 (diff)
[docs] Fix code blocks overflowing page width (#23829)
Fix code blocks overflowing page width
Diffstat (limited to 'docs/cli_tab_complete.md')
-rw-r--r--docs/cli_tab_complete.md16
1 files changed, 12 insertions, 4 deletions
diff --git a/docs/cli_tab_complete.md b/docs/cli_tab_complete.md
index 90950b82da..704439c5e1 100644
--- a/docs/cli_tab_complete.md
+++ b/docs/cli_tab_complete.md
@@ -10,22 +10,30 @@ There are several ways you can setup tab completion.
10 10
11Add this to the end of your `.profile` or `.bashrc`: 11Add this to the end of your `.profile` or `.bashrc`:
12 12
13 source ~/qmk_firmware/util/qmk_tab_complete.sh 13```
14source ~/qmk_firmware/util/qmk_tab_complete.sh
15```
14 16
15If you put `qmk_firmware` into another location you will need to adjust this path. 17If you put `qmk_firmware` into another location you will need to adjust this path.
16 18
17Zsh users will need to load `bashcompinit`. The following can be added to `~/.zshrc` file: 19Zsh users will need to load `bashcompinit`. The following can be added to `~/.zshrc` file:
18 20
19 autoload -Uz bashcompinit && bashcompinit 21```
22autoload -Uz bashcompinit && bashcompinit
23```
20 24
21### System Wide Symlink 25### System Wide Symlink
22 26
23If you want the tab completion available to all users of the system you can add a symlink to the `qmk_tab_complete.sh` script: 27If you want the tab completion available to all users of the system you can add a symlink to the `qmk_tab_complete.sh` script:
24 28
25 ln -s ~/qmk_firmware/util/qmk_tab_complete.sh /etc/profile.d/qmk_tab_complete.sh 29```
30ln -s ~/qmk_firmware/util/qmk_tab_complete.sh /etc/profile.d/qmk_tab_complete.sh
31```
26 32
27### System Wide Copy 33### System Wide Copy
28 34
29In some cases a symlink may not work. Instead you can copy the file directly into place. Be aware that updates to the tab complete script may happen from time to time, you will want to recopy the file periodically. 35In some cases a symlink may not work. Instead you can copy the file directly into place. Be aware that updates to the tab complete script may happen from time to time, you will want to recopy the file periodically.
30 36
31 cp util/qmk_tab_complete.sh /etc/profile.d 37```
38cp util/qmk_tab_complete.sh /etc/profile.d
39```