Add .homerc information

1 files changed, 28 insertions, 2 deletions

diff --git a/README b/README
index 3b49667..1da404c 100644
--- a/README
+++ b/README
@@ -2,7 +2,7 @@
 2. Depending on your shell, put the following at the top of its initialization
 file.
 
-CSH (.cshrc):
+CSH (/home/$USER/.cshrc):
 
 setenv PATH ${HOME}/bin:${PATH}
 set MULTIHOME=`which multihome`
@@ -18,7 +18,7 @@ if ( -x $MULTIHOME ) then
 endif
 
 
-BASH (.bash_profile):
+BASH (/home/$USER/.bash_profile):
 
 export PATH=$HOME/bin:$PATH
 MULTIHOME=`which multihome`
@@ -35,3 +35,29 @@ if [ -x $MULTIHOME ]; then
 fi
 
 
+Custom Configuration (/home/$USER/.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:
+    None
+    
+    
+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.