lcd.sh: doc comments.

1 files changed, 15 insertions, 0 deletions

diff --git a/lcd.sh b/lcd.sh
index 1494a10..1cd19ea 100644
--- a/lcd.sh
+++ b/lcd.sh
@@ -1,3 +1,18 @@
+# lcd.sh - "Linked" cd, for people who use multiple terminals.
+
+# Copy me to e.g. ~/.lcd.sh, then in your .bash_profile, .bashrc,
+# or whatever shell startup script you use:
+
+#   [ -e ~/.lcd.sh ] && source ~/.lcd.sh
+
+# Log out & back in, or close and restart all your terminal windows.
+
+# Now when you type a cd command in one shell, such as:
+#   cd /usr/src/linux-$( uname -r )/Documentation
+# ...you can switch over to another terminal and type:
+#   lcd
+# ...and now that terminal is cd'ed to the same directory.
+
 cd() {
   builtin cd "$@"
   pwd > ~/.lcd.dir