1
0
mirror of https://github.com/wting/autojump synced 2024-10-27 20:34:07 +00:00
wting_autojump/docs/manpage.md

87 lines
2.5 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.