diff --git a/README b/README deleted file mode 100644 index 843054a..0000000 --- a/README +++ /dev/null @@ -1,75 +0,0 @@ -AUTOJUMP - A cd command that learns -=================================== - -One of the most used shell commands is "cd". A quick survey among my friends revealed that between 10 and 20% of all commands they type are actually cd commands! Unfortunately, jumping from one part of your system to another with cd requires to enter almost the full path, which isn't very practical and requires a lot of keystrokes. - -autojump is a faster way to navigate your filesystem. It works by maintaining a database of the directories you use the most from the command line. The jumpstat command shows you the current contents of the database. You need to work a little bit before the database becomes useable. Once your database is reasonably complete, you can "jump" to a directory by typing: - - j dirspec - -where dirspec is a few characters of the directory you want to jump to. It will jump to the most used directory whose -name matches the pattern given in dirspec. - -Autojump supports tab completion. Try it! - -EXAMPLES - - j mp3 - -could jump to "/home/gwb/my mp3 collection", if that is the directory in which you keep your mp3s. - - jumpstat - -will print out something in the lines of: - - ... - 54.5: /home/shared/musique - 60.0: /home/joel/workspace/coolstuff/glandu - 83.0: /home/joel/workspace/abs_user/autojump - 96.9: /home/joel/workspace/autojump - 141.8: /home/joel/workspace/vv - 161.7: /home/joel - Total key weight: 1077 - -The "key weight" reflects the amount of time you spend in a directory. - -AUTHOR - -Joel Schaerer (joel.schaerer (at) laposte.net) -Install script written by Daniel Jackoway - -LICENSE - -autojump is distributed under the terms of the GPL, version 3. - -INSTALLATION - -Auto Installation: -run - - ./install.sh - -Enter your root password if it asks. -Add the line - - source /etc/profile - -to ~/.bashrc if it isn't already there. -TROUBLESHOOT If the script fails, you may need to do - - chmod +x install.sh - -before the first step. - - -Manual installation of autojump is very simple: copy autojump to /usr/bin, autojump.sh to /etc/profile.d, and autojump.1 to /usr/share/man/man1. Make sure you source /etc/profile in your .bashrc: - - source /etc/profile - -PACKAGING - -For now I have packaged autojump for arch linux. It is available from the AUR. To install, type: - - yaourt -S autojump - -I would be very interested by pacakges for other distros. If you think you can help me with the packaging, please contact me! diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..5d93d03 --- /dev/null +++ b/README.rst @@ -0,0 +1,100 @@ +======== +AUTOJUMP +======== + +---------------------------- +A ``cd`` command that learns +---------------------------- + +One of the most used shell commands is ``cd``. A quick survey among my friends revealed that between 10 and 20% of all commands they type are actually ``cd`` commands! Unfortunately, jumping from one part of your system to another with ``cd`` requires to enter almost the full path, which isn't very practical and requires a lot of keystrokes. + +autojump is a faster way to navigate your filesystem. It works by maintaining a database of the directories you use the most from the command line. The jumpstat command shows you the current contents of the database. You need to work a little bit before the database becomes useable. Once your database is reasonably complete, you can "jump" to a directory by typing:: + + j dirspec + +where dirspec is a few characters of the directory you want to jump to. It will jump to the most used directory whose +name matches the pattern given in dirspec. + +Autojump supports tab completion. Try it! + +Examples +======== + +:: + + j mp3 + +could jump to ``/home/gwb/my mp3 collection``, if that is the directory in which you keep your mp3s. :: + + jumpstat + +will print out something in the lines of:: + + ... + 54.5: /home/shared/musique + 60.0: /home/joel/workspace/coolstuff/glandu + 83.0: /home/joel/workspace/abs_user/autojump + 96.9: /home/joel/workspace/autojump + 141.8: /home/joel/workspace/vv + 161.7: /home/joel + Total key weight: 1077 + +The "key weight" reflects the amount of time you spend in a directory. + +Author +====== + +Joel Schaerer (joel.schaerer (at) laposte.net) +Install script written by Daniel Jackoway + +License +======= + +autojump is distributed under the terms of the GPL, version 3. + +Installation +============ + +Auto Installation +----------------- + +run:: + + ./install.sh + +Enter your root password if it asks. + +Add the line:: + + source /etc/profile + +to ``~/.bashrc`` if it isn't already there. + +Troubleshoot +------------ + +If the script fails, you may need to do:: + + chmod +x install.sh + +before the first step. + + +Manual installation of autojump is very simple: copy + +- autojump to /usr/bin, +- autojump.sh to /etc/profile.d, +- autojump.1 to /usr/share/man/man1. + +Make sure to source ``/etc/profile`` in your ``.bashrc``:: + + source /etc/profile + +Packaging +========= + +For now gcarrier and I have packaged autojump for Arch Linux. It is available in [community]. To install, type:: + + pacman -S autojump + +I would be very interested by packages for other distros. If you think you can help me with the packaging, please contact me! diff --git a/packaging/PKGBUILD b/packaging/PKGBUILD deleted file mode 100644 index bb6d80d..0000000 --- a/packaging/PKGBUILD +++ /dev/null @@ -1,33 +0,0 @@ -# Contributor: Joël Schaerer -pkgname=autojump -pkgver=20090210 -pkgrel=3 -pkgdesc="A faster way to navigate your filesystem from the command line" -arch=(i686 x86_64) -url="http://wiki.github.com/joelthelion/autojump" -license=('GPL') -depends=('bash' 'python') -makedepends=('git') -install=(autojump.install) - -_gitroot="git://github.com/joelthelion/autojump.git" -_gitname="autojump" - -build() { - cd "$srcdir" - msg "Connecting to GIT server...." - - if [ -d $_gitname ] ; then - cd $_gitname && git pull origin || return 1 - msg "The local files are updated." - else - git clone $_gitroot && cd $_gitname || return 1 - fi - gzip -f autojump.1 - - msg "GIT checkout done" - install -Dm 755 autojump ${pkgdir}/usr/bin/autojump - install -Dm 755 autojump.sh ${pkgdir}/etc/profile.d/autojump.bash - install -Dm 755 autojump.sh ${pkgdir}/etc/profile.d/autojump.sh - install -Dm 644 autojump.1.gz ${pkgdir}/usr/share/man/man1/autojump.1.gz -} diff --git a/packaging/autojump.install b/packaging/autojump.install deleted file mode 100644 index 30d43fe..0000000 --- a/packaging/autojump.install +++ /dev/null @@ -1,21 +0,0 @@ -#This code is licensed under the GPL, version 3. -#A full copy of the license can be obtained by contacting the author at the following email adress: joel.schaerer@laposte.net - -# arg 1: the new package version -post_install() { - echo " > You need to source /etc/profile in your ~/.bashrc for this to work" - echo " > Only guaranteed to work with bash" - echo " > man autojump for instructions." - /bin/true -} - -# arg 1: the new package version -# arg 2: the old package version -post_upgrade() { - post_install $1 - /bin/true -} - -op=$1 -shift -$op $*