aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README17
1 files changed, 13 insertions, 4 deletions
diff --git a/README b/README
index 1da404c..c442403 100644
--- a/README
+++ b/README
@@ -1,4 +1,6 @@
-1. Put multihome in your path (i.e. ~/bin)
+## 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.
@@ -35,7 +37,12 @@ if [ -x $MULTIHOME ]; then
fi
-Custom Configuration (/home/$USER/.homerc):
+## Configuration ##
+
+1. Create /home/$USER/.homerc file
+
+
+### Options for .homerc ###
1. cluster_force=true|false
Type: Boolean
@@ -43,7 +50,7 @@ Default: false
Description:
Setting this "true" creates a stand-alone home directory for every machine under the "standard" cluster directory.
Example:
- None
+ cluster_force=false
2. clusters=( host_pattern [host_pattern ... ] )
@@ -52,7 +59,7 @@ Default: Empty
Description:
Hostname substrings that denote particular clusters
Example:
-cluster=( ops dev test prod )
+ cluster=( ops dev test prod )
3. transfer_env=( file [file ...] )
@@ -61,3 +68,5 @@ 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 )