aboutsummaryrefslogtreecommitdiff
path: root/docs/cli_tab_complete.md
diff options
context:
space:
mode:
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.
Add this to the end of your `.profile` or `.bashrc`:
- source ~/qmk_firmware/util/qmk_tab_complete.sh
+```
+source ~/qmk_firmware/util/qmk_tab_complete.sh
+```
If you put `qmk_firmware` into another location you will need to adjust this path.
Zsh users will need to load `bashcompinit`. The following can be added to `~/.zshrc` file:
- autoload -Uz bashcompinit && bashcompinit
+```
+autoload -Uz bashcompinit && bashcompinit
+```
### System Wide Symlink
If you want the tab completion available to all users of the system you can add a symlink to the `qmk_tab_complete.sh` script:
- ln -s ~/qmk_firmware/util/qmk_tab_complete.sh /etc/profile.d/qmk_tab_complete.sh
+```
+ln -s ~/qmk_firmware/util/qmk_tab_complete.sh /etc/profile.d/qmk_tab_complete.sh
+```
### System Wide Copy
In 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.
- cp util/qmk_tab_complete.sh /etc/profile.d
+```
+cp util/qmk_tab_complete.sh /etc/profile.d
+```