1
0
mirror of https://github.com/wting/autojump synced 2024-10-27 20:34:07 +00:00
Go to file
William Ting 681068a2bc Don't check path existence when displaying tab completion menu.
The check is to avoided since tab menu paths may be on slow IO devices (network
mounts, low power devices, etc).

Closes #258.
2014-01-28 23:55:15 -06:00
bin Don't check path existence when displaying tab completion menu. 2014-01-28 23:55:15 -06:00
docs update Windows documentation 2014-01-15 15:16:41 -06:00
tests simplify file structure 2014-01-11 11:46:50 -06:00
tools Add Python 2.6 support back. 2014-01-07 09:56:30 -06:00
.gitattributes ensure batch files are crlf 2014-01-13 19:25:05 +00:00
.gitignore add helper functions unit tests 2013-12-31 18:47:08 -06:00
.travis.yml update Travis build to use Makefile 2014-01-08 12:09:54 -06:00
AUTHORS update authors list 2013-05-25 05:32:58 -07:00
CHANGES.md Add Python 2.6 support back. 2014-01-07 09:56:30 -06:00
dev-requirements.txt add iteration test cases 2013-12-31 16:33:32 -06:00
install.py whitespace fixes 2014-01-18 09:08:36 -06:00
LICENSE Remove license from individual files, consolidate information into AUTHORS and LICENSE 2012-05-06 12:56:01 -10:00
Makefile update documentation 2014-01-08 11:05:25 -06:00
README.md update Windows documentation 2014-01-15 15:16:41 -06:00
setup.cfg whitespace fixes 2014-01-18 09:08:36 -06:00
uninstall.py whitespace fixes 2014-01-18 09:08:36 -06:00

NAME

autojump - a faster way to navigate your filesystem

DESCRIPTION

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.

Directories must be visited first before they can be jumped to.

USAGE

j is a convenience wrapper function around autojump. Any option that can be used with autojump can be used with j and vice versa.

  • Jump To A Directory That Contains foo:

    j foo
    
  • Jump To A Child Directory

    Sometimes it's convenient to jump to a child directory (sub-directory of current directory) rather than typing out the full name.

    jc bar
    
  • Open File Manager To Directories (instead of jumping):

    Instead of jumping to a directory, you can open a file explorer window (Mac Finder, Windows Explorer, GNOME Nautilus, etc.) to the directory instead.

    jo music
    

    Opening a file manager to a child directory is also supported.

    jco images
    
  • Using Multiple Arguments:

    Let's assume the following database:

    30   /home/user/mail/inbox
    10   /home/user/work/inbox
    

    j in would jump into /home/user/mail/inbox as the higher weighted entry. However you can pass multiple arguments to autojump to prefer a different entry. In the above example, j w in would then change directory to /home/user/work/inbox.

For more options refer to help:

autojump --help

INSTALLATION

REQUIREMENTS

  • Python v2.6+
  • Bash v4.0+, zsh, fish, or clink (Windows)

AUTOMATIC

Linux

autojump is included in the following distro repositories, please use relevant package management utilities to install (e.g. yum, apt-get, etc):

  • Debian testing/unstable, Ubuntu, Linux Mint

    All Debian-derived distros require manual activation for policy reasons, please see /usr/share/doc/autojump/README.Debian.

  • RedHat, Fedora, CentOS

  • ArchLinux

  • Gentoo

  • Frugalware

  • Slackware

OS X

Homebrew is the recommended installation method for Mac OS X:

brew install autojump

MacPorts also available:

port install autojump

Windows

Windows support is enabled by clink which should be installed prior to installing autojump.

MANUAL

Grab a copy of autojump:

git clone git://github.com/joelthelion/autojump.git

Run the installation script and follow on screen instructions.

cd autojump
./install.py or ./uinstall.py

KNOWN ISSUES

  • autojump does not support directories that begin with -.

  • For bash users, autojump keeps track of directories by modifying $PROMPT_COMMAND. Do not overwrite $PROMPT_COMMAND:

    export PROMPT_COMMAND="history -a"
    

    Instead append to the end of the existing $PROMPT_COMMAND:

    export PROMPT_COMMAND="${PROMPT_COMMAND:+$PROMPT_COMMAND ;} history -a"
    

REPORTING BUGS

For any questions or issues please visit:

https://github.com/joelthelion/autojump/issues

AUTHORS

autojump was originally written by Joël Schaerer, and currently maintained by William Ting. More contributors can be found in AUTHORS.

Copyright © 2012 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later http://gnu.org/licenses/gpl.html. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.