diff --git a/Troubleshooting.md b/Troubleshooting.md index 4f57a5f..4a88d0a 100644 --- a/Troubleshooting.md +++ b/Troubleshooting.md @@ -1,3 +1,33 @@ -What to do if you're having a problem +This page is meant to describe the most common problems with oh-my-zsh and what you can do to diagnose them: -*...to be filled...* \ No newline at end of file +### Keyboard shortcut problems + +Example: +```sh +bindkey '^L' clear-screen +``` + +Two main things could go wrong: + +1. The key sequence (`^L` in the example) does not match the key sequence being sent to the terminal: + + You can see the exact sequence a keyboard shortcut sents by pressing `CTRL`+`V` and then the keyboard shortcut. + For example: `CTRL`+`V`, `CTRL`+`L` will output `^L` (`^` represents the Control key). + +2. The command executed (`clear-screen` in the example) has an error. In that case, post both the key binding and the definition of the command if exists, like so: + + - **key binding:** `bindkey '^[[1;6D'` + will print `"^[[1;6D" insert-cycledleft` + - **command definition:** `which insert-cycledleft` + will print `insert-cycledleft () { ... }` + +Notice that sometimes the command is a builtin [zle widget](http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html) and so the `which` command won't work. Just post the key binding and we'll figure it out. + +### Completion problems + +*...to be filled...* + + +### Everything else + +*...to be filled...*