shell/env: Improve readability of LS_COLORS settings.

[config/dotfiles.git] / shell / env

diff --git a/shell/env b/shell/env
index 84705b62d57af4eac107905443f3703d33f4e413..ba94f390f9dc13b3f2249b5eca1b5f08c78f3fc9 100644 (file)
--- a/shell/env
+++ b/shell/env
@@ -1,9 +1,32 @@
 # Configuration file for environment related options for all shells.
 
 
-# Use UTF-8 encoding in the terminal.
-LC_ALL=en_US.UTF-8
-export LC_ALL
+# Helper function to print debug information if $DEBUG is not empty.
+#
+# Doesn't fit perfectly in this file, but this is the best place to make it
+# available everywhere.
+source_debug() {
+    if [ x$DEBUG != x ]; then
+        echo $@
+    fi
+}
+
+
+source_debug "sourcing ~/.shell/env"
+
+
+# Use UTF-8 encoding in the terminal. Don't use LC_ALL as it's used for
+# debugging purposes. Thanks to twb in Freenode/#screen (2009-10-02 10:25).
+LANG=en_US.UTF-8
+export LANG
+
+# Add ~/bin and ~/.bin to PATH if available.
+if [ -d ~/bin ]; then
+    PATH=~/bin:$PATH
+fi
+if [ -d ~/.bin ]; then
+    PATH=~/.bin:$PATH
+fi
 
 # Use Vim as editor.
 EDITOR=vim
@@ -13,15 +36,34 @@ export EDITOR
 PAGER=less
 export PAGER
 
-# Set colors for GNU ls (and zsh completions). This colors files normal (fi),
-# directories blue bold (di), symbolic links cyan (ln), named pipes normal
-# (pi), sockets normal (so), block devices normal (bd), character devices
-# normal (cd) and executables bold red (ex).
+# Use ~/tmp as directory for temporary files if available to reduce security
+# problems on multi-user systems.
+if [ -O ~/tmp -a -d ~/tmp ]; then
+    TMP=~/tmp
+    TEMP=$TMP
+    TMPDIR=$TMP
+    export TMP TEMP TMPDIR
+fi
+
+# Set colors for GNU ls (and zsh completions).
 # See `dircolors --print-database` for possible colors.
-LS_COLORS='no=00:fi=00:di=34;01:ln=36:pi=00:so=00:bd=00:cd=00:ex=31;01'
+LS_COLORS='no=00'
+LS_COLORS=$LS_COLORS':fi=00'       # normal files: normal
+LS_COLORS=$LS_COLORS':di=34;01'    # directories: blue bold
+LS_COLORS=$LS_COLORS':ln=36'       # symbolic links: cyan
+LS_COLORS=$LS_COLORS':pi=00'       # named pipes: normal
+LS_COLORS=$LS_COLORS':so=00'       # sockets: normal
+LS_COLORS=$LS_COLORS':bd=00'       # block devices: normal
+LS_COLORS=$LS_COLORS':cd=00'       # character devices: normal
+LS_COLORS=$LS_COLORS':or=36;41'    # orphaned links: red background
+LS_COLORS=$LS_COLORS':su=31;01;43' # setuid files: yellow background
+LS_COLORS=$LS_COLORS':sg=31;01;43' # setgid files: yellow background
+LS_COLORS=$LS_COLORS':ow=34;01;41' # directories writable by others: blue background
+LS_COLORS=$LS_COLORS':ex=31;01'    # executables: bold red
 export LS_COLORS
-# Set the same colors for non GNU ls.
-LSCOLORS='ExgxxxxxBxxxxxBxBxExEx'
+# Set the same colors for non GNU ls, except for orphaned links which aren't
+# supported.
+LSCOLORS='ExgxxxxxBxxxxxBdBdExEb'
 #         ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^
 #         | | | | | | | | | | |
 #         | | | | | | | | | | *- directory writable to others, without sticky bit
@@ -47,6 +89,7 @@ export LSCOLORS
 #     in $1.
 # $3: Base name of file in $2, for example "rc" or "env".
 # $4: Extension for $3, if this file doesn't exist "$1/$3.local" is sourced.
+#     Can be empty, then no extension is used.
 # $5: Additional options, set to nolocal to prevent loading of "$1/$3.local"
 #                         if "$1/$2/$3.$4" doesn't exist.
 #
@@ -73,32 +116,47 @@ export LSCOLORS
 # source_config zsh os   env $os       nolocal # loads os/rc.Darwin
 # source_config zsh host env $hostname         # loads env.local
 #
+# By letting $4 empty normal configuration files can be sourced. A .local can
+# still be used.
+#
+# source_config zsh "" file # loads zsh/file if it exists
+#
 # Doesn't fit perfectly in this file, but this is the best place to make it
 # available everywhere.
-function source_config() {
+#
+# If DEBUG is set to a non empty value additional debug output is printed.
+source_config() {
     # Path to the file to source and its local counterpart.
-    local source_file=$1/$2/$3.$4
-    local source_file_local=$1/$3.local
+    if [ x$4 != x ]; then
+        source_file=$1/$2/$3.$4
+    # If $4 is empty don't append a trailing dot. This allows source_config()
+    # to load normal configuration files.
+    else
+        source_file=$1/$2/$3
+    fi
+    source_file_local=$1/$3.local
 
     # Additional debug output.
-    if [ x$DEBUG != x ]; then
-        echo "source_config(): checking if $source_file exists"
-        echo "source_config(): checking if $source_file_local exists"
-    fi
+    source_debug "source_config(): checking if $source_file exists"
+    source_debug "source_config(): checking if $source_file_local exists"
 
     # If the file does exist then source it.
     if [ -f $source_file ]; then
-        if [ x$DEBUG != x ]; then
-            echo "source_config(): sourcing $source_file"
-        fi
-        source $source_file
+        source_debug "source_config(): -> sourcing $source_file"
+        . $source_file
 
     # Otherwise load the .local file if it exists and .local files are
     # allowed.
     elif [ -f $source_file_local -a x$5 != xnolocal ]; then
-        if [ x$DEBUG != x ]; then
-            echo "source_config(): sourcing $source_file_local"
-        fi
-        source $source_file_local
+        source_debug "source_config(): -> sourcing $source_file_local"
+        . $source_file_local
+    else
+        source_debug "source_config(): -> neither exists"
     fi
+
+    unset source_file source_file_local
 }
+
+source_debug "finished sourcing ~/.shell/env"
+
+# vim: ft=sh