X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=blobdiff_plain;f=bash-selector.sh;h=020f3edb72afa8b20e35091cbffc98762a20545e;hb=56285429e6ad644e31f66b006eeff8a92053def8;hp=64cda91182f8a93b48318758809c8c633aeb829a;hpb=cc3b3d1e8410cca68cbaf7556786aa79f1b0ba0e;p=selector.git

diff --git a/bash-selector.sh b/bash-selector.sh
index 64cda91..020f3ed 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"'