From 3a687c33dcd84a5851b98766e3a52fd9502cbc4f Mon Sep 17 00:00:00 2001 From: Khas'Mek Date: Sun, 31 May 2015 08:46:37 -0400 Subject: [PATCH] Consistency in design and formatting update. --- Troubleshooting.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/Troubleshooting.md b/Troubleshooting.md index e2a7e8d..64ed0d5 100644 --- a/Troubleshooting.md +++ b/Troubleshooting.md @@ -3,7 +3,7 @@ This page is meant to describe the most common problems with oh-my-zsh and what ### Keyboard shortcut problems Example: -```sh +```shell bindkey '^L' clear-screen ``` @@ -11,10 +11,11 @@ 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. + 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: +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` @@ -29,13 +30,13 @@ Many completion problems, including the infamous `command not found: compdef`, c 1. First, try to remove your completion cache with `rm ~/.zcompdump*`, close and reopen your shells. -2. If you still have problems, try fully resetting the completion system, as explained by [**@dragon788**](https://github.com/robbyrussell/oh-my-zsh/issues/630#issuecomment-70291622). +2. If you still have problems, try fully resetting the completion system, as explained by + [**@dragon788**](https://github.com/robbyrussell/oh-my-zsh/issues/630#issuecomment-70291622). ### Everything else As a last resort, if you're getting weird behavior and can't find the culprit, run the following command to enable debug mode: -```sh +```shell zsh -xv &> >(tee ~/omz-debug.log 2>/dev/null) ``` -Afterwards, reproduce the behavior (_i.e._ if it's a particular command, run it), and when you're done, run `exit` to stop the debugging session. -This will create a `omz-debug.log` file on your home directory, which you can upload to [gist.github.com](https://gist.github.com/) and link to it on the issue you'll open next. \ No newline at end of file +Afterwards, reproduce the behavior (_i.e._ if it's a particular command, run it), and when you're done, run `exit` to stop the debugging session. This will create a `omz-debug.log` file on your home directory, which you can upload to [gist.github.com](https://gist.github.com/) and link to it on the issue you'll open next.