From d044479bc5364ab9b87af66ba0d416b897acdd3f Mon Sep 17 00:00:00 2001 From: Colin Hebert Date: Wed, 4 Apr 2012 14:01:25 +0100 Subject: [PATCH] Add documentation for gnu-utils --- plugins/gnu-utils/README.md | 31 +++++++++++++++++++++++++++++++ plugins/gnu-utils/init.zsh | 7 ------- 2 files changed, 31 insertions(+), 7 deletions(-) create mode 100644 plugins/gnu-utils/README.md diff --git a/plugins/gnu-utils/README.md b/plugins/gnu-utils/README.md new file mode 100644 index 0000000..747f4bf --- /dev/null +++ b/plugins/gnu-utils/README.md @@ -0,0 +1,31 @@ +gnu-utils +========= + +Provides for the interactive use of [GNU Core Utilities][1] on non-GNU systems. + +Installing the GNU Core Utilities on non-GNU systems in `$PATH` without +a prefix, i.e. `ls` instead of `gls`, is not recommended since scripts that +target other core utilities will be broken. + +However, for interactive use, prefixed commands can be hashed to their +non-prefixed counterparts. + +Settings +-------- + +### Prefix + +To use a different prefix, add the following to *zshrc*, and replace 'g' with +the desired prefix: + + zstyle ':omz:plugin:gnu-utils' prefix 'g' + +Authors +------- + +*The authors of this plugin should be contacted via the GitHub issue tracker.* + + - [Sorin Ionescu](/sorin-ionescu) + +[1]: http://www.gnu.org/software/coreutils/ + diff --git a/plugins/gnu-utils/init.zsh b/plugins/gnu-utils/init.zsh index bcb8321..62e8850 100644 --- a/plugins/gnu-utils/init.zsh +++ b/plugins/gnu-utils/init.zsh @@ -4,13 +4,6 @@ # Authors: # Sorin Ionescu # -# Usage: -# -# To use a different prefix, add the following to zshrc, -# and replace 'g' with the desired prefix: -# -# zstyle ':omz:plugin:gnu-utils' prefix 'g' -# # Get the prefix or use the default. zstyle -s ':omz:plugin:gnu-utils' prefix '_gnu_utils_prefix' ||