8bb9b044699f5c96830c7fe2bb78de19854d4973

Message

singlechar: add README (#8232)


Co-authored-by: Marc Cornellà <marc.cornella@live.com>

Diff

This diff is truncated to protect this page.

  1diff --git a/plugins/singlechar/README.md b/plugins/singlechar/README.md
  2new file mode 100644
  3index 0000000000000000000000000000000000000000..d89029900e651036d9d3c5f8b8f54e2321edd631
  4--- /dev/null
  5+++ b/plugins/singlechar/README.md
  6@@ -0,0 +1,118 @@
  7+# Singlechar plugin
  8+
  9+This plugin adds single char shortcuts (and combinations) for some commands.
 10+
 11+To use it, add `singlechar` to the plugins array of your zshrc file:
 12+```
 13+plugins=(... singlechar)
 14+```
 15+
 16+## Aliases
 17+
 18+### CAT, GREP, CURL, WGET
 19+
 20+| Alias | Command          | Description |
 21+|-------|------------------|-------------|
 22+| y     | `grep -Ri`       | Find case-insensitive string in all files and directories, recursively. Follows symlinks. |
 23+| n     | `grep -Rvi`      | Same as above but only show lines that don't match the string.                            |
 24+| f     | `grep -Rli`      | Same as 'y' but only print the filenames where the string is found.                       |
 25+| fn    | `grep -Rlvi`     | Same as above but only show files that don't contain the string.                          |
 26+| f.    | `find . \| grep` | Grep list of files in current directory                                                   |
 27+| f:    | `find`           | 'find' command                                                                            |
 28+| p     | `less`           | 'less' command                                                                            |
 29+| m     | `man`            | 'man' command                                                                             |
 30+| d     | `wget`           | 'wget' command                                                                            |
 31+| u     | `curl`           | 'curl' command                                                                            |
 32+| c     | `cat`            | 'cat' command                                                                             |
 33+| w     | `echo >`         | Write arguments to file, overwriting it if it exists.                                     |
 34+| a     | `echo >>`        | Write arguments to file, appending them if the file exists.                               |
 35+| w:    | `cat >`          | Write stdin to file, overwriting if it exists.                                            |
 36+| a:    | `cat >>`         | Write stdin to file, appending it if the file exists.                                     |
 37+
 38+### XARGS
 39+
 40+These aliases are versions of the aliases above but using xargs. This can be used
 41+by piping the arguments to the xargs aliases.
 42+
 43+| Alias | Command              | Description                     |
 44+|-------|----------------------|---------------------------------|
 45+| x     | `xargs`              | 'xargs' command                 |
 46+| xy    | `xargs grep -Ri`     | Same as 'y' alias using xargs.  |
 47+| xn    | `xargs grep -Rvi`    | Same as 'n' alias using xargs.  |
 48+| xf    | `xargs grep -Rli`    | Same as 'f' alias using xargs.  |
 49+| xfn   | `xargs grep -Rlvi`   | Same as 'fn' alias using xargs. |
 50+| xf.   | `xargs find \| grep` | Same as 'f.' alias using xargs. |
 51+| xf:   | `xargs find`         | Same as 'f:' alias using xargs. |
 52+| xc    | `xargs cat`          | Same as 'c' alias using xargs.  |
 53+| xp    | `xargs less`         | Same as 'p' alias using xargs.  |
 54+| xm    | `xargs man`          | Same as 'm' alias using xargs.  |
 55+| xd    | `xargs wget`         | Same as 'd' alias using xargs.  |
 56+| xu    | `xargs curl`         | Same as 'u' alias using xargs.  |
 57+| xw    | `xargs echo >`       | Same as 'w' alias using xargs.  |
 58+| xa    | `xargs echo >>`      | Same as 'a' alias using xargs.  |
 59+| xw:   | `xargs cat >`        | Same as 'w:' alias using xargs. |
 60+| xa:   | `xargs >>`           | Same as 'a:' alias using xargs. |
 61+
 62+### SUDO
 63+
 64+These aliases are versions of the aliases above in [CAT, GREP, CURL, WGET](#cat-grep-curl-wget)
 65+but using sudo to run them with root permission.
 66+
 67+| Alias | Command               | Description                    |
 68+|-------|-----------------------|--------------------------------|
 69+| s     | `sudo`                | 'sudo' command                 |
 70+| sy    | `sudo grep -Ri`       | Same as 'y' alias using sudo.  |
 71+| sn    | `sudo grep -Riv`      | Same as 'n' alias using sudo.  |
 72+| sf    | `sudo grep -Rli`      | Same as 'f' alias using sudo.  |
 73+| sfn   | `sudo grep -Rlvi`     | Same as 'fn' alias using sudo. |
 74+| sf.   | `sudo find . \| grep` | Same as 'f.' alias using sudo. |
 75+| sf:   | `sudo find`           | Same as 'f:' alias using sudo. |
 76+| sp    | `sudo less`           | Same as 'p' alias using sudo.  |
 77+| sm    | `sudo man`            | Same as 'm' alias using sudo.  |
 78+| sd    | `sudo wget`           | Same as 'd' alias using sudo.  |
 79+| sc    | `sudo cat`            | Same as 'c' alias using sudo.  |
 80+| sw    | `sudo echo >`         | Same as 'w' alias using sudo.  |
 81+| sa    | `sudo echo >>`        | Same as 'a' alias using sudo.  |
 82+| sw:   | `sudo cat >`          | Same as 'w:' alias using sudo. |
 83+| sa:   | `sudo cat >>`         | Same as 'a:' alias using sudo. |
 84+
 85+### SUDO-XARGS
 86+
 87+Same as above but using both sudo and xargs.
 88+
 89+| Alias | Command                   | Description                     |
 90+|-------|---------------------------|---------------------------------|
 91+| sx    | `sudo xargs`              | 'sudo xargs' command            |
 92+| sxy   | `sudo xargs grep -Ri`     | Same as 'xy' alias using sudo.  |
 93+| sxn   | `sudo xargs grep -Riv`    | Same as 'xn' alias using sudo.  |
 94+| sxf   | `sudo xargs grep -li`     | Same as 'xf' alias using sudo.  |
 95+| sxfn  | `sudo xargs grep -lvi`    | Same as 'xfn' alias using sudo. |
 96+| sxf.  | `sudo xargs find \| grep` | Same as 'xf.' alias using sudo. |
 97+| sxf:  | `sudo xargs find`         | Same as 'xf:' alias using sudo. |
 98+| sxp   | `sudo xargs less`         | Same as 'xp' alias using sudo.  |
 99+| sxm   | `sudo xargs man`          | Same as 'xm' alias using sudo.  |
100+| sxd   | `sudo xargs wget`         | Same as 'xd' alias using sudo.  |
101+| sxu   | `sudo xargs curl`         | Same as 'xu' alias using sudo.  |
102+| sxc   | `sudo xargs cat`          | Same as 'xc' alias using sudo.  |
103+| sxw   | `sudo xargs echo >`       | Same as 'xw' alias using sudo.  |
104+| sxa   | `sudo xargs echo >>`      | Same as 'xa' alias using sudo.  |
105+| sxw:  | `sudo xargs cat >`        | Same as 'xw:' alias using sudo. |
106diff --git a/plugins/singlechar/singlechar.plugin.zsh b/plugins/singlechar/singlechar.plugin.zsh
107index 44bd998aa56b1bd0099fb477fc3e1ea92aa5b2fd..d4b0b6735136582c956829665ee36db698d45fca 100644
108--- a/plugins/singlechar/singlechar.plugin.zsh
109+++ b/plugins/singlechar/singlechar.plugin.zsh
110@@ -1,13 +1,3 @@
111-################################################################################
112-#          FILE:  singlechar.plugin.zsh
113-#   DESCRIPTION:  oh-my-zsh plugin file.
114-#        AUTHOR:  Michael Varner (musikmichael@web.de)
115-#       VERSION:  1.0.0
116-#
117-# This plugin adds single char shortcuts (and combinations) for some commands.
118-#
119-################################################################################
120-
121 ###########################
122 # Settings 
123 
124@@ -130,4 +120,4 @@ alias sxd='"$ROOT" xargs "$WGET"'
125 alias sxu='"$ROOT" xargs "$CURL"'
126 
127 alias sxw:='"$ROOT" xargs cat >'
128-alias sxa:='"$ROOT" xargs cat >>'
129+alias sxa:='"$ROOT" xargs cat >>'