Add documentation for gnu-utils

This commit is contained in:
Colin Hebert 2012-04-04 14:01:25 +01:00 committed by Sorin Ionescu
parent b24ac116e7
commit d044479bc5
2 changed files with 31 additions and 7 deletions

View File

@ -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/

View File

@ -4,13 +4,6 @@
# Authors: # Authors:
# Sorin Ionescu <sorin.ionescu@gmail.com> # Sorin Ionescu <sorin.ionescu@gmail.com>
# #
# 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. # Get the prefix or use the default.
zstyle -s ':omz:plugin:gnu-utils' prefix '_gnu_utils_prefix' || zstyle -s ':omz:plugin:gnu-utils' prefix '_gnu_utils_prefix' ||