Archives/wting_autojump
1
0
Fork 0
mirror of https://github.com/wting/autojump synced 2024-09-28 05:50:47 +00:00
Code Issues Releases Wiki Activity
342 Commits 2 Branches 53 Tags 1.6 MiB
Python 90.9%
Shell 6.6%
Makefile 1.1%
Batchfile 0.8%
Lua 0.6%
8decc17f3e
Go to file
William Ting 8decc17f3e Update documentation and install scripts to reflect new minimum Python requirements. 
Documentation and install scripts now instruct older Python users to upgrade
their Python version or install older versions of autojump.

'install.sh' now gets a -f|--force option, which makes the install ignore
Python dependency requirements.
2012-04-11 23:03:03 -10:00
tools minor fixes 2010-11-25 15:33:53 +01:00
_j fix completion for zsh (thanks simon!) 2010-04-27 14:16:08 +02:00
.gitignore attempt fixing jumpapplet, even though I think nobody uses it :) 2011-08-19 11:22:12 +02:00
autojump version numbering 2012-04-10 14:51:54 -10:00
autojump.1 remove leftover syntax when docs were in ReST format 2012-04-11 22:31:36 -10:00
autojump.bash #114: Error message when directory does not exist or not in autojump database. 2012-04-02 21:58:43 +09:00
autojump.py turns out this symbolic link is required for jumpapplet now 2011-09-27 15:22:16 +02:00
autojump.sh fix bash local installation paths 2012-02-08 11:27:43 -10:00
autojump.zsh Fixes #113, #115, refactor autojump to use argparse over optparse. 2012-04-07 04:21:07 -10:00
ChangeLog Modify documentation to notify that minimum Python version is 2.7 instead of 2012-04-11 19:44:18 -10:00
COPYING license stuff 2009-05-13 11:32:19 +02:00
git-version.sh avoid making the tag on the wrongly numbered autojump 2011-11-18 14:25:54 +01:00
icon.png path specific action + decorator 2009-03-27 11:46:21 +01:00
INSTALL.md Update documentation and install scripts to reflect new minimum Python requirements. 2012-04-11 23:03:03 -10:00
install.sh Update documentation and install scripts to reflect new minimum Python requirements. 2012-04-11 23:03:03 -10:00
jumpapplet Merge branch 'contrib/xdg-base-directory' of git://git.ortolo.eu/pkg-autojump into tanguy 2011-08-26 15:59:02 +02:00
make_doc.sh Fixes #112, fixes #116. Simplify documentation build. 2012-04-07 06:57:16 -10:00
make_release.sh automated version numbering commit 2011-11-18 14:27:31 +01:00
manpage.md update documentation with known issues (i.e. long standing bugs) 2012-04-11 20:37:02 -10:00
README.md Update documentation and install scripts to reflect new minimum Python requirements. 2012-04-11 23:03:03 -10:00
uninstall.sh minor documentation update in preparation for release-v20 2012-04-10 14:43:02 -10:00

README.md

% autojump(1) release-v20 % % 10 April 2012

NAME

autojump - a faster way to navigate your filesystem

SYNOPSIS

Jump to a previously visited directory 'foobar':

j foo

Show all database entries and their respective key weights:

jumpstat

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. The jumpstat command shows you the current contents of the database. Directories must be visited first before they can be jumped to.

OPTIONS

Options must be passed to 'autojump' and not the 'j' wrapper function.

-a, --add DIR       manually add path to database

--stat              show database entries and their key weights

--version           show version information and exit

INTERNAL OPTIONS

-b, --bash          enclose directory with quotes to prevent errors

--completion        prevent key weight decay over time

ADVANCED USAGE

  • Prefer Symbolic Links

    Default behavior is to evaluate symbolic links into full paths as to reduce duplicate entries in the database. However, some users prefer a shorter working directory path in their shell prompt. To switch behavior to prefer symbolic links, export the following configuration in your ~/.bashrc:

    export AUTOJUMP_KEEP_SYMLINKS=1

  • Change Directory Weight

    To manually change a directory's key weight, you can edit the file $XDG_DATA_HOME/autojump/autojump.txt. Each entry has two columns. The first is the key weight and the second is the path:

    29.3383211216   /home/user/downloads

    All negative key weights are purged automatically.

KNOWN ISSUES

  • zsh (bug #86)

    Tab completion does not work.

  • jumpapplet (bug #59)

    Does not work in Gnome 3 shell or LDXE.

FILES

If installed locally, autojump is self-contained in ~/.autojump/.

The database is stored in $XDG_DATA_HOME/autojump/autojump.txt.

REPORTING BUGS

For any issues please visit the following URL:

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

THANKS

Special thanks goes out to: Pierre Gueth, Simon Marache-Francisco, Daniel Jackoway, and many others.

AUTHORS

autojump was originally written by Joël Schaerer, and currently maintained by William Ting.

COPYRIGHT

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.

INSTALLATION

REQUIREMENTS

Python v2.7+ or 3.2+

Bash v4.0+ for tab completion

If you are unable to update Python to a supported version, older versions of autojump can be downloaded and installed manually.

Python v2.6+ is supported by release v19.

Python v2.4+ is supported by release v12.

AUTOMATIC INSTALLATION

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

On Debian only, autojump requires manual activation for policy reasons. Please see ``/usr/share/doc/autojump/README.Debian``.

- RedHat, Fedora, CentOS
- ArchLinux
- Gentoo
- Frugalware
- Slackware

Mac

Homebrew is the recommended installation method for Mac OS X:

brew install autojump

MacPorts also available:

port install autojump

Other

Please check the Wiki for an up to date listing of installation methods.

MANUAL INSTALLATION

Grab a copy of autojump:

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

Run the installation script:

cd autojump
./install.sh [ --local ] [ --zsh ]

and follow on screen instructions.

MANUAL UNINSTALLATION

It is recommended to use your distribution's relevant package management utilities, unless you installed manually or ran into uninstallation issues.

Grab a copy of autojump:

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

Run the uninstallation script:

cd autojump
./uninstall.sh

and follow on screen instructions.

If you keep getting autojump: command not found at the prompt, do:unset PROMPT_COMMAND. You can also restart your shell.