mirror of
https://github.com/wting/autojump
synced 2024-10-27 20:34:07 +00:00
8decc17f3e
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.
201 lines
4.6 KiB
Markdown
201 lines
4.6 KiB
Markdown
% 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](https://github.com/joelthelion/autojump/downloads) and
|
|
installed manually.
|
|
|
|
Python v2.6+ is supported by [release
|
|
v19](https://github.com/downloads/joelthelion/autojump/autojump_v19.tar.gz).
|
|
|
|
Python v2.4+ is supported by [release
|
|
v12](https://github.com/downloads/joelthelion/autojump/autojump_v12.tar.gz).
|
|
|
|
### 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](https://github.com/joelthelion/autojump/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.
|