etc/unicode: Added documentation

1 files changed, 18 insertions, 0 deletions

diff --git a/etc/unicode b/etc/unicode
index fd3b382..a846499 100644
--- a/etc/unicode
+++ b/etc/unicode
@@ -1,4 +1,22 @@
 ## vim:ft=zsh
+## This snippet serves two purposes:
+##  - it offers a central place to manage 'special' characters
+##  - it's used to enable / disable unicode
+##
+## The parameter unicode decides whether unicode is used or not,
+## the default is to use unicode.
+##
+## In the associative array chars, the 'special' characters are stored.
+## Each entry contains two characters, the first is ASCII,
+## the second may be unicode.
+##
+## To get a ascii-/unicode-char, the function zchar is used, which outputs a
+## character based on the setting of the unicode parameter
+##
+## disable unicode: unicode=0; reload
+## disable ALL unicode, even in PS4 and such: unicode=0 zsh
+##
+## Note: This only affects zsh, for other programs set $LANG or similar
 
 typeset -A chars
 typeset unicode=${unicode-1}