From: Francois Fleuret <francois@fleuret.org>
Date: Wed, 2 Nov 2011 08:03:03 +0000 (+0100)
Subject: Added comments.
X-Git-Url: https://www.fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=selector.git;a=commitdiff_plain;h=a2e9ecbe63af0f7b4b84b1b2a81562714746bcdc

Added comments.
---

diff --git a/bash-selector.sh b/bash-selector.sh
index 64cda91..32e4925 100755
--- a/bash-selector.sh
+++ b/bash-selector.sh
@@ -17,19 +17,34 @@
 # Contact <francois.fleuret@idiap.ch> for comments & bug reports        #
 #########################################################################
 
-# Selector based history
+# This script installs two keybinding:
+#
+# Alt-R for selector-based command history
+#
+# Alt-C for selector-based directoy history
+#
+# It has to be called with ". bash-selector.sh"
+
+######################################################################
+# Selector-based command history
+######################################################################
 
 function selector-history () {
     selector --bash -u -c 7,4,0,3 -q <(history)
 }
 
-# Maintains a list of visited directories and provide a selector-based
-# command to go back to any of them.
+######################################################################
+# Selector-based directory history
+######################################################################
+
+# The file where we will keep track of the directories
 
 export SELECTOR_CD_HISTORY
 
 [[ "${SELECTOR_CD_HISTORY}" ]] || SELECTOR_CD_HISTORY=${HOME}/.selector-cd-history
 
+# The function to use in place of the standard "cd"
+
 function selector-cd () {
     if [[ -z "$1" ]]; then
         cd
@@ -55,6 +70,10 @@ function selector-cd-search () {
 
 alias cd=selector-cd
 
+######################################################################
+# The key-bindings themselves
+######################################################################
+
 # M-r puts the selected history line in place of the current one
 
 bind '"\C-[r":"\C-a\C-kselector-history\C-m"'