summaryrefslogtreecommitdiffstats
path: root/zsh/oh-my-zsh/plugins/git-escape-magic/README.md
diff options
context:
space:
mode:
authorLibravatarLibravatar Biswakalyan Bhuyan <biswa@surgot.in> 2022-10-03 21:42:20 +0530
committerLibravatarLibravatar Biswakalyan Bhuyan <biswa@surgot.in> 2022-10-03 21:42:20 +0530
commitaf120ab348f2e1a5a39dec035ed9dcf84189a64e (patch)
tree2a3aadd7ce1b7b771dfe3fe7c983569726c8d7ed /zsh/oh-my-zsh/plugins/git-escape-magic/README.md
downloaddotfiles-af120ab348f2e1a5a39dec035ed9dcf84189a64e.tar.gz
dotfiles-af120ab348f2e1a5a39dec035ed9dcf84189a64e.tar.bz2
dotfiles-af120ab348f2e1a5a39dec035ed9dcf84189a64e.zip
dotfiles
Diffstat (limited to 'zsh/oh-my-zsh/plugins/git-escape-magic/README.md')
-rw-r--r--zsh/oh-my-zsh/plugins/git-escape-magic/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/zsh/oh-my-zsh/plugins/git-escape-magic/README.md b/zsh/oh-my-zsh/plugins/git-escape-magic/README.md
new file mode 100644
index 0000000..7fefed3
--- /dev/null
+++ b/zsh/oh-my-zsh/plugins/git-escape-magic/README.md
@@ -0,0 +1,16 @@
+# Git Escape Magic
+
+This plugin is copied from the original at
+https://github.com/knu/zsh-git-escape-magic. All credit for the
+functionality enabled by this plugin should go to @knu.
+
+An excerpt from that project's readme explains its purpose.
+
+> It eliminates the need for manually escaping those meta-characters. The zle function it provides is context aware and recognizes the characteristics of each subcommand of git. Every time you type one of these meta-characters on a git command line, it automatically escapes the meta-character with a backslash as necessary and as appropriate.
+
+## Usage
+
+To use this plugin, add it to your list of plugins in your `.zshrc` file.
+
+**NOTE**: If you use url-quote-magic, it must be included before this
+plugin runs to prevent any conflicts.