Merge branch 'master' of bitbucket.org:jhunkeler/multihome

1 files changed, 63 insertions, 22 deletions

diff --git a/README b/README
index 8835f3d..c442403 100644
--- a/README
+++ b/README
@@ -1,31 +1,72 @@
-1. Put multihome in your path
+## Installation ##
+1. Place multihome in your path (i.e. ~/bin)
+
 2. Depending on your shell, put the following at the top of its initialization
 file.
 
-CSH (.cshrc):
-
-if ( -f ~/bin/multihome ) then
-	# Destroy environment
-	env -i
-	# Resassign HOME
-	eval `~/bin/multihome`
-	if ( -d $HOME ) then
-		cd $HOME
-	endif
-	source ~/.cshrc
+CSH (/home/$USER/.cshrc):
+
+setenv PATH ${HOME}/bin:${PATH}
+set MULTIHOME=`which multihome`
+if ( -x $MULTIHOME ) then
+    # Destroy environment
+    env -i
+    # Resassign HOME
+    eval `$MULTIHOME`
+    if ( "$HOME" != "$HOME_ORIG" ) then
+        cd $HOME
+        source ~/.cshrc
+    endif
 endif
 
 
-BASH (.bash_profile):
+BASH (/home/$USER/.bash_profile):
 
-if [ -f ~/bin/multihome ]; then
-	# Destroy environment
-	env -i
-	# Resassign HOME
-	eval `~/bin/multihome`
-	if [ -d "$HOME" ]; then
-		cd $HOME
-	fi
-	source ~/.bash_profile
+export PATH=$HOME/bin:$PATH
+MULTIHOME=`which multihome`
+if [ -x $MULTIHOME ]; then
+    HOME_ORIG=$HOME
+    # Destroy environment
+    env -i
+    # Resassign HOME
+    eval `$MULTIHOME`
+    if [[ "$HOME" != "$HOME_ORIG" ]]; then
+        cd $HOME
+        source ~/.bash_profile
+    fi  
 fi
 
+
+## Configuration ##
+
+1. Create /home/$USER/.homerc file
+
+
+### Options for .homerc ###
+
+1. cluster_force=true|false 
+Type: Boolean
+Default: false
+Description: 
+    Setting this "true" creates a stand-alone home directory for every machine under the "standard" cluster directory.
+Example:
+    cluster_force=false
+    
+    
+2. clusters=( host_pattern [host_pattern ... ] )
+Type: Array
+Default: Empty
+Description:
+    Hostname substrings that denote particular clusters
+Example:
+    cluster=( ops dev test prod )
+
+
+3. transfer_env=( file [file ...] )
+Type: Array
+Default: .*profile .*login .*cshrc* .bash* .ssh .Xauthority
+Description:
+    Files and/or directories to be copied from /home/$USER into the new home structure.
+    These files are *NOT* linked back to /home/$USER.  *All* modifications are independent for each home directory.
+Example:
+    transfer_env=( .*profile .*login .*cshrc* .bash* .ssh .Xauthority )