aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2013-09-07 17:33:11 +1200
committerTom Ryder <tom@sanctum.geek.nz>2013-09-07 17:33:11 +1200
commit9c75b9d0da09e3a8ef3cae1a32ec49d751bf4d8c (patch)
tree3f587facbf973e90d8bf88213863f8420decd838
parent8ad39b0afe4376469d1661c3dc1688cff5302633 (diff)
downloaddotfiles-9c75b9d0da09e3a8ef3cae1a32ec49d751bf4d8c.tar.gz
dotfiles-9c75b9d0da09e3a8ef3cae1a32ec49d751bf4d8c.zip
Leading comment block explaining install script
-rwxr-xr-xinstall24
1 files changed, 24 insertions, 0 deletions
diff --git a/install b/install
index 7f14a532..a64e6a6f 100755
--- a/install
+++ b/install
@@ -1,5 +1,29 @@
#!/usr/bin/env bash
+#
+# Author: Tom Ryder (@tejr) <tom@sanctum.geek.nz>
+#
+# This script installs @tejr's dotfiles in $HOME with symlinks into the
+# expected $HOME/.dotfiles path.
+#
+# By default, it checks out all Git submodules, and links in configuration for
+# Bash, cURL, Git, Vim, and some terminfo(5) definitions. You can supply
+# additional flags to link in other configuration files:
+#
+# -g -- GnuPG
+# -m -- Mutt
+# -n -- Newsbeuter
+# -t -- tmux
+# -x -- X11
+#
+# You should be prompted about replacing any file or directory that already
+# exists. I have tried to make the function that does this relatively safe, but
+# there are almost certainly edge cases where it might break things, especially
+# on systems other than GNU/Linux or BSD.
+#
+# Run this at your own risk!
+#
+
# Replace existing file with link if user confirms
lns() {
local file=$1 link=$2