aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Steven Schubiger <stsc@refcnt.org>2016-03-09 17:11:26 +0100
committerGravatar Steven Schubiger <stsc@refcnt.org>2016-03-09 17:11:26 +0100
commit02ff24b4d080945fa5b5eecd8b57780b0035ecea (patch)
tree772535dabfc801f7f5c1151b3df7a094e5360c66
parent189af18c6bd1f1f01d410fff4bc9d3996136b373 (diff)
downloadcolorize-02ff24b4d080945fa5b5eecd8b57780b0035ecea.tar.gz
colorize-02ff24b4d080945fa5b5eecd8b57780b0035ecea.tar.bz2
Add Usage example
-rw-r--r--README12
1 files changed, 12 insertions, 0 deletions
diff --git a/README b/README
index a25dded..afd40b9 100644
--- a/README
+++ b/README
@@ -43,6 +43,18 @@ Documentation
-------------
See man page source file: colorize.1.
+Usage example
+-------------
+In ~/.bashrc:
+
+| ls_color() {
+| ls "$@" | colorize green -
+| }
+| alias ls=ls_color
+
+This excerpt defines an alias which will set the color being
+printed for literal ls invocations to green.
+
Afterword
---------
Let me know, if you have ideas, bug reports, patches, etc.