Archives/wting_autojump
1
0
Fork 0
mirror of https://github.com/wting/autojump synced 2024-10-27 20:34:07 +00:00
Code Issues Releases Wiki Activity

update documentation

Browse Source
This commit is contained in:
William Ting 2014-01-07 12:32:35 -06:00
parent 1a0003d852
commit de85828b79
9 changed files with 208 additions and 560 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -11,7 +11,7 @@ uninstall:
docs: docs:
pandoc -s -w man docs/manpage_header.md docs/header.md docs/body.md -o docs/autojump.1 pandoc -s -w man docs/manpage_header.md docs/header.md docs/body.md -o docs/autojump.1
pandoc -s -w markdown docs/header.md docs/install.md docs/development.md docs/body.md -o README.md pandoc -s -w markdown docs/header.md docs/install.md docs/body.md -o README.md
lint: lint:
@flake8 ./ --config=setup.cfg @flake8 ./ --config=setup.cfg

271
README.md
View File

@ -3,28 +3,60 @@ NAME
autojump - a faster way to navigate your filesystem autojump - a faster way to navigate your filesystem
SYNOPSIS
--------
Jump to a previously visited directory that contains 'foo':
j foo
Jump to a previously visited subdirectory of the current directory:
jc bar
Show database entries and their respective key weights:
j --stat
DESCRIPTION DESCRIPTION
----------- -----------
autojump is a faster way to navigate your filesystem. It works by autojump is a faster way to navigate your filesystem. It works by
maintaining a database of the directories you use the most from the maintaining a database of the directories you use the most from the
command line. Directories must be visited first before they can be command line.
jumped to.
*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 INSTALLATION
------------ ------------
@ -32,32 +64,28 @@ INSTALLATION
### REQUIREMENTS ### REQUIREMENTS
- Python v2.6+ - Python v2.6+
- Bash v4.0 for tab completion (or zsh) - Bash v4.0+, zsh, or fish
If you are unable to update Python to a supported version, older ### AUTOMATIC
versions of autojump can be [downloaded][dl] and installed manually.
- Python v2.4 is supported by [release v12][v12]. #### Linux
### AUTOMATIC INSTALLATION
**Linux**
autojump is included in the following distro repositories, please use autojump is included in the following distro repositories, please use
relevant package management utilities to install (e.g. yum, apt-get, relevant package management utilities to install (e.g. yum, apt-get,
etc): etc):
- Debian\* testing/unstable, Ubuntu, Linux Mint - 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 - RedHat, Fedora, CentOS
- ArchLinux - ArchLinux
- Gentoo - Gentoo
- Frugalware - Frugalware
- Slackware - Slackware
\* Requires manual activation for policy reasons, please see #### OS X
`/usr/share/doc/autojump/README.Debian`.
**Mac**
Homebrew is the recommended installation method for Mac OS X: Homebrew is the recommended installation method for Mac OS X:
@ -67,207 +95,48 @@ MacPorts also available:
port install autojump port install autojump
**Other** ### MANUAL
Please check the [Wiki][wiki] for an up to date listing of installation methods.
### MANUAL INSTALLATION
Grab a copy of autojump: Grab a copy of autojump:
git clone git://github.com/joelthelion/autojump.git git clone git://github.com/joelthelion/autojump.git
Run the installation script: Run the installation script and follow on screen instructions.
cd autojump cd autojump
./install.sh [ --local ] ./install.py or ./uinstall.py
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.
DEVELOPMENT
-----------
The source code is primarily in `./bin/autojump`. Various shell wrapper
scripts are also available in `./bin/`.
Documentation is in various files under `./docs/`. Build documentation
with the command:
make docs
OPTIONS
-------
Options must be passed to 'autojump' and not the 'j' wrapper function.
-i, --increase manually increase current directory weight
-d, --decrease manually decrease current directory weight
--purge deletes database entries that no longer exist on system
-s, --stat show general stats and top 100 database entries
--version show version information and exit
ADVANCED USAGE
--------------
- 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 jump
you into /home/user/work/inbox.
- 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 images
- 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
ADDITIONAL CONFIGURATION
------------------------
- Enable ZSH Tab Completion
ZSH tab completion requires the `compinit` module to be loaded.
Please add the following line to your \~/.zshrc *after* loading
autojump:
autoload -U compinit && compinit
For security compinit checks completion system if files will be
owned by root or the current user. This check can be ignored by
using the -u flag:
autoload -U compinit && compinit -u
Tab completion requires two tabs before autojump will display the
completion menu. However if `setopt nolistambiguous` is enabled,
then only one tab is required.
- Always Ignore Case
Default behavior is to prioritize exact matches over all else. For
example, `j foo` will prefer /foobar over /FooBar even if the latter
has a higher weight. To change this behavior and ignore case, add
the following environmental variable in your \~/.bashrc:
export AUTOJUMP_IGNORE_CASE=1
- 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, add the following environmental
variable in your \~/.bashrc:
export AUTOJUMP_KEEP_SYMLINKS=1
- Autocomplete Additional Commands (Bash only)
Autojump can be used to autocomplete other commands (e.g. cp or
vim). To use this feature, add the following environmental variable
in your \~/.bashrc:
export AUTOJUMP_AUTOCOMPLETE_CMDS='cp vim'
Changes require reloading autojump to take into effect.
KNOWN ISSUES KNOWN ISSUES
------------ ------------
- For bash users, autojump keeps track of directories as a pre-command - autojump does not support directories that begin with `-`.
hook by modifying \$PROMPT\_COMMAND. If you overwrite
\$PROMPT\_COMMAND in \~/.bashrc you can cause problems. Don't do - For bash users, autojump keeps track of directories by modifying
this: `$PROMPT_COMMAND`. Do not overwrite `$PROMPT_COMMAND`:
export PROMPT_COMMAND="history -a" export PROMPT_COMMAND="history -a"
Do this: Instead append to the end of the existing $PROMPT\_COMMAND:
export PROMPT_COMMAND="${PROMPT_COMMAND:+$PROMPT_COMMAND ;} history -a" export PROMPT_COMMAND="${PROMPT_COMMAND:+$PROMPT_COMMAND ;} history -a"
- The jump function `j` does not support directories that begin with
`-`. If you want to jump a directory called `--music`, try using
`j music` instead of `j --music`.
FILES
-----
If installed locally, autojump is self-contained in *\~/.autojump/*.
The database is stored in *\$XDG\_DATA\_HOME/autojump/autojump.txt*.
REPORTING BUGS REPORTING BUGS
-------------- --------------
For any usage related issues or feature requests please visit: For any questions or issues please visit:
*https://github.com/joelthelion/autojump/issues* https://github.com/joelthelion/autojump/issues
THANKS
------
Special thanks goes out to: Pierre Gueth, Simon Marache-Francisco,
Daniel Jackoway, and many others.
AUTHORS AUTHORS
------- -------
autojump was originally written by Joël Schaerer, and currently autojump was originally written by Joël Schaerer, and currently
maintained by William Ting. maintained by William Ting. More contributors can be found in `AUTHORS`.
COPYRIGHT COPYRIGHT
--------- ---------
Copyright © 2013 Free Software Foundation, Inc. License GPLv3+: GNU GPL Copyright © 2012 Free Software Foundation, Inc. License GPLv3+: GNU GPL
version 3 or later <http://gnu.org/licenses/gpl.html>. This is free 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 software: you are free to change and redistribute it. There is NO
WARRANTY, to the extent permitted by law. WARRANTY, to the extent permitted by law.
[dl]: https://github.com/joelthelion/autojump/downloads
[mock]: https://pypi.python.org/pypi/mock
[v12]: https://github.com/downloads/joelthelion/autojump/autojump_v12.tar.gz
[wiki]: https://github.com/joelthelion/autojump/wiki

217
docs/autojump.1
View File

@ -1,98 +1,50 @@
.TH autojump 1 "10 April 2012" "release\-v20" .TH autojump 1 "10 April 2012" "release-v22"
.SS NAME .SS NAME
.PP .PP
autojump \- a faster way to navigate your filesystem autojump - a faster way to navigate your filesystem
.SS SYNOPSIS .SS DESCRIPTION
.PP .PP
Jump to a previously visited directory that contains \[aq]foo\[aq]: 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.
.PP
\f[I]Directories must be visited first before they can be jumped to.\f[]
.SS USAGE
.PP
\f[C]j\f[] is a convenience wrapper function around \f[C]autojump\f[].
Any option that can be used with \f[C]autojump\f[] can be used with
\f[C]j\f[] and vice versa.
.IP \[bu] 2
Jump To A Directory That Contains \f[C]foo\f[]:
.RS 2
.IP .IP
.nf .nf
\f[C] \f[C]
j\ foo j\ foo
\f[] \f[]
.fi .fi
.RE
.IP \[bu] 2
Jump To A Child Directory
.RS 2
.PP .PP
Jump to a previously visited subdirectory of the current directory: Sometimes it\[aq]s convenient to jump to a child directory
(sub-directory of current directory) rather than typing out the full
name.
.IP .IP
.nf .nf
\f[C] \f[C]
jc\ bar jc\ bar
\f[] \f[]
.fi .fi
.PP
Show database entries and their respective key weights:
.IP
.nf
\f[C]
j\ \-\-stat
\f[]
.fi
.SS DESCRIPTION
.PP
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.
.SS OPTIONS
.PP
Options must be passed to \[aq]autojump\[aq] and not the \[aq]j\[aq]
wrapper function.
.IP
.nf
\f[C]
\-i,\ \-\-increase\ \ \ \ \ \ manually\ increase\ current\ directory\ weight
\-d,\ \-\-decrease\ \ \ \ \ \ manually\ decrease\ current\ directory\ weight
\-\-purge\ \ \ \ \ \ \ \ \ \ \ \ \ deletes\ database\ entries\ that\ no\ longer\ exist\ on\ system
\-s,\ \-\-stat\ \ \ \ \ \ \ \ \ \ show\ general\ stats\ and\ top\ 100\ database\ entries
\-\-version\ \ \ \ \ \ \ \ \ \ \ show\ version\ information\ and\ exit
\f[]
.fi
.SS ADVANCED USAGE
.IP \[bu] 2
Using Multiple Arguments
.RS 2
.PP
Let\[aq]s assume the following database:
.IP
.nf
\f[C]
30\ \ \ /home/user/mail/inbox
10\ \ \ /home/user/work/inbox
\f[]
.fi
.PP
\f[C]j\ in\f[] 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, \f[C]j\ w\ in\f[] would then jump you into
/home/user/work/inbox.
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
Jump To A Child Directory. Open File Manager To Directories (instead of jumping):
.RS 2
.PP
Sometimes it\[aq]s convenient to jump to a child directory
(sub\-directory of current directory) rather than typing out the full
name.
.IP
.nf
\f[C]
jc\ images
\f[]
.fi
.RE
.IP \[bu] 2
Open File Manager To Directories (instead of jumping)
.RS 2 .RS 2
.PP .PP
Instead of jumping to a directory, you can open a file explorer window Instead of jumping to a directory, you can open a file explorer window
(Mac Finder, Windows Explorer, GNOME Nautilus, etc) to the directory (Mac Finder, Windows Explorer, GNOME Nautilus, etc.)
instead. to the directory instead.
.IP .IP
.nf .nf
\f[C] \f[C]
@ -108,132 +60,71 @@ jco\ images
\f[] \f[]
.fi .fi
.RE .RE
.SS ADDITIONAL CONFIGURATION
.IP \[bu] 2 .IP \[bu] 2
Enable ZSH Tab Completion Using Multiple Arguments:
.RS 2 .RS 2
.PP .PP
ZSH tab completion requires the \f[C]compinit\f[] module to be loaded. Let\[aq]s assume the following database:
Please add the following line to your ~/.zshrc \f[I]after\f[] loading
autojump:
.IP .IP
.nf .nf
\f[C] \f[C]
autoload\ \-U\ compinit\ &&\ compinit 30\ \ \ /home/user/mail/inbox
10\ \ \ /home/user/work/inbox
\f[] \f[]
.fi .fi
.PP .PP
For security compinit checks completion system if files will be owned by \f[C]j\ in\f[] would jump into /home/user/mail/inbox as the higher
root or the current user. weighted entry.
This check can be ignored by using the \-u flag: However you can pass multiple arguments to autojump to prefer a
.IP different entry.
.nf In the above example, \f[C]j\ w\ in\f[] would then change directory to
\f[C] /home/user/work/inbox.
autoload\ \-U\ compinit\ &&\ compinit\ \-u
\f[]
.fi
.PP
Tab completion requires two tabs before autojump will display the
completion menu.
However if \f[C]setopt\ nolistambiguous\f[] is enabled, then only one
tab is required.
.RE .RE
.IP \[bu] 2
Always Ignore Case
.RS 2
.PP .PP
Default behavior is to prioritize exact matches over all else. For more options refer to help:
For example, \f[C]j\ foo\f[] will prefer /foobar over /FooBar even if
the latter has a higher weight.
To change this behavior and ignore case, add the following environmental
variable in your ~/.bashrc:
.IP .IP
.nf .nf
\f[C] \f[C]
export\ AUTOJUMP_IGNORE_CASE=1 autojump\ --help
\f[] \f[]
.fi .fi
.RE
.IP \[bu] 2
Prefer Symbolic Links
.RS 2
.PP
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, add the following
environmental variable in your ~/.bashrc:
.IP
.nf
\f[C]
export\ AUTOJUMP_KEEP_SYMLINKS=1
\f[]
.fi
.RE
.IP \[bu] 2
Autocomplete Additional Commands (Bash only)
.RS 2
.PP
Autojump can be used to autocomplete other commands (e.g.
cp or vim).
To use this feature, add the following environmental variable in your
~/.bashrc:
.IP
.nf
\f[C]
export\ AUTOJUMP_AUTOCOMPLETE_CMDS=\[aq]cp\ vim\[aq]
\f[]
.fi
.PP
Changes require reloading autojump to take into effect.
.RE
.SS KNOWN ISSUES .SS KNOWN ISSUES
.IP \[bu] 2 .IP \[bu] 2
For bash users, autojump keeps track of directories as a pre\-command autojump does not support directories that begin with \f[C]-\f[].
hook by modifying $PROMPT_COMMAND. .IP \[bu] 2
If you overwrite $PROMPT_COMMAND in ~/.bashrc you can cause problems. For bash users, autojump keeps track of directories by modifying
Don\[aq]t do this: \f[C]$PROMPT_COMMAND\f[].
Do not overwrite \f[C]$PROMPT_COMMAND\f[]:
.RS 2 .RS 2
.IP .IP
.nf .nf
\f[C] \f[C]
export\ PROMPT_COMMAND="history\ \-a" export\ PROMPT_COMMAND="history\ -a"
\f[] \f[]
.fi .fi
.PP .PP
Do this: Instead append to the end of the existing $PROMPT_COMMAND:
.IP .IP
.nf .nf
\f[C] \f[C]
export\ PROMPT_COMMAND="${PROMPT_COMMAND:+$PROMPT_COMMAND\ ;}\ history\ \-a" export\ PROMPT_COMMAND="${PROMPT_COMMAND:+$PROMPT_COMMAND\ ;}\ history\ -a"
\f[] \f[]
.fi .fi
.RE .RE
.IP \[bu] 2
The jump function \f[C]j\f[] does not support directories that begin
with \f[C]\-\f[].
If you want to jump a directory called \f[C]\-\-music\f[], try using
\f[C]j\ music\f[] instead of \f[C]j\ \ \ \-\-music\f[].
.SS FILES
.PP
If installed locally, autojump is self\-contained in
\f[I]~/.autojump/\f[].
.PP
The database is stored in \f[I]$XDG_DATA_HOME/autojump/autojump.txt\f[].
.SS REPORTING BUGS .SS REPORTING BUGS
.PP .PP
For any usage related issues or feature requests please visit: For any questions or issues please visit:
.PP .IP
\f[I]https://github.com/joelthelion/autojump/issues\f[] .nf
.SS THANKS \f[C]
.PP https://github.com/joelthelion/autojump/issues
Special thanks goes out to: Pierre Gueth, Simon Marache\-Francisco, \f[]
Daniel Jackoway, and many others. .fi
.SS AUTHORS .SS AUTHORS
.PP .PP
autojump was originally written by Joël Schaerer, and currently autojump was originally written by Joël Schaerer, and currently
maintained by William Ting. maintained by William Ting.
More contributors can be found in \f[C]AUTHORS\f[].
.SS COPYRIGHT .SS COPYRIGHT
.PP .PP
Copyright © 2012 Free Software Foundation, Inc. Copyright © 2012 Free Software Foundation, Inc.

135
docs/body.md
View File

@ -1,137 +1,32 @@
## OPTIONS KNOWN ISSUES
------------
Options must be passed to 'autojump' and not the 'j' wrapper function. - autojump does not support directories that begin with `-`.
-i, --increase manually increase current directory weight - For bash users, autojump keeps track of directories by modifying
`$PROMPT_COMMAND`. Do not overwrite `$PROMPT_COMMAND`:
-d, --decrease manually decrease current directory weight
--purge deletes database entries that no longer exist on system
-s, --stat show general stats and top 100 database entries
--version show version information and exit
ADVANCED USAGE
--------------
- 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 jump
you into /home/user/work/inbox.
- 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 images
- 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
ADDITIONAL CONFIGURATION
------------------------
- Enable ZSH Tab Completion
ZSH tab completion requires the `compinit` module to be loaded.
Please add the following line to your \~/.zshrc *after* loading autojump:
autoload -U compinit && compinit
For security compinit checks completion system if files will be owned by
root or the current user. This check can be ignored by using the -u flag:
autoload -U compinit && compinit -u
Tab completion requires two tabs before autojump will display the
completion menu. However if `setopt nolistambiguous` is enabled,
then only one tab is required.
- Always Ignore Case
Default behavior is to prioritize exact matches over all else. For
example, `j foo` will prefer /foobar over /FooBar even if the latter
has a higher weight. To change this behavior and ignore case, add
the following environmental variable in your \~/.bashrc:
export AUTOJUMP_IGNORE_CASE=1
- 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, add the following environmental
variable in your \~/.bashrc:
export AUTOJUMP_KEEP_SYMLINKS=1
- Autocomplete Additional Commands (Bash only)
Autojump can be used to autocomplete other commands (e.g. cp or
vim). To use this feature, add the following environmental variable
in your \~/.bashrc:
export AUTOJUMP_AUTOCOMPLETE_CMDS='cp vim'
Changes require reloading autojump to take into effect.
## KNOWN ISSUES
- For bash users, autojump keeps track of directories as a pre-command hook by
modifying \$PROMPT\_COMMAND. If you overwrite \$PROMPT\_COMMAND in ~/.bashrc you
can cause problems. Don't do this:
export PROMPT_COMMAND="history -a" export PROMPT_COMMAND="history -a"
Do this: Instead append to the end of the existing \$PROMPT\_COMMAND:
export PROMPT_COMMAND="${PROMPT_COMMAND:+$PROMPT_COMMAND ;} history -a" export PROMPT_COMMAND="${PROMPT_COMMAND:+$PROMPT_COMMAND ;} history -a"
- The jump function `j` does not support directories that begin with `-`. If you REPORTING BUGS
want to jump a directory called `--music`, try using `j music` instead of `j --------------
--music`.
## FILES For any questions or issues please visit:
If installed locally, autojump is self-contained in _~/.autojump/_. https://github.com/joelthelion/autojump/issues
The database is stored in _$XDG\_DATA\_HOME/autojump/autojump.txt_. AUTHORS
-------
## REPORTING BUGS
For any usage related issues or feature requests please visit:
_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 autojump was originally written by Joël Schaerer, and currently maintained by
William Ting. William Ting. More contributors can be found in `AUTHORS`.
## COPYRIGHT COPYRIGHT
---------
Copyright © 2012 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 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 3 or later <http://gnu.org/licenses/gpl.html>. This is free software: you are

9
docs/development.md
View File

@ -1,9 +0,0 @@
## DEVELOPMENT
The source code is primarily in `./bin/autojump`. Various shell wrapper scripts
are also available in `./bin/`.
Documentation is in various files under `./docs/`. Build documentation with the
command:
make docs

53
docs/header.md
View File

@ -1,23 +1,56 @@
## NAME NAME
----
autojump - a faster way to navigate your filesystem autojump - a faster way to navigate your filesystem
## SYNOPSIS DESCRIPTION
-----------
Jump to a previously visited directory that contains 'foo': 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 j foo
Jump to a previously visited subdirectory of the current directory: - 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 jc bar
Show database entries and their respective key weights: - Open File Manager To Directories (instead of jumping):
j --stat Instead of jumping to a directory, you can open a file explorer window (Mac
Finder, Windows Explorer, GNOME Nautilus, etc.) to the directory instead.
## DESCRIPTION jo music
autojump is a faster way to navigate your filesystem. It works by maintaining a Opening a file manager to a child directory is also supported.
database of the directories you use the most from the command line. Directories
must be visited first before they can be jumped to. 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

59
docs/install.md
View File

@ -2,32 +2,28 @@
### REQUIREMENTS ### REQUIREMENTS
- Python v2.7+ - Python v2.6+
- Bash v4.0 for tab completion (or zsh) - Bash v4.0+, zsh, or fish
If you are unable to update Python to a supported version, older versions of ### AUTOMATIC
autojump can be [downloaded][dl] and installed manually.
- Python v2.4 is supported by [release v12][v12]. #### Linux
### AUTOMATIC INSTALLATION
**Linux**
autojump is included in the following distro repositories, please use relevant autojump is included in the following distro repositories, please use relevant
package management utilities to install (e.g. yum, apt-get, etc): package management utilities to install (e.g. yum, apt-get, etc):
- Debian\* testing/unstable, Ubuntu, Linux Mint - 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 - RedHat, Fedora, CentOS
- ArchLinux - ArchLinux
- Gentoo - Gentoo
- Frugalware - Frugalware
- Slackware - Slackware
\* Requires manual activation for policy reasons, please see #### OS X
``/usr/share/doc/autojump/README.Debian``.
**Mac**
Homebrew is the recommended installation method for Mac OS X: Homebrew is the recommended installation method for Mac OS X:
@ -37,42 +33,13 @@ MacPorts also available:
port install autojump port install autojump
**Other** ### MANUAL
Please check the [Wiki][wiki] for an up to date listing of installation methods.
### MANUAL INSTALLATION
Grab a copy of autojump: Grab a copy of autojump:
git clone git://github.com/joelthelion/autojump.git git clone git://github.com/joelthelion/autojump.git
Run the installation script: Run the installation script and follow on screen instructions.
cd autojump cd autojump
./install.sh [ --local ] ./install.py or ./uinstall.py
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.
[dl]: https://github.com/joelthelion/autojump/downloads
[v12]: https://github.com/downloads/joelthelion/autojump/autojump_v12.tar.gz
[wiki]: https://github.com/joelthelion/autojump/wiki

2
docs/manpage_header.md
View File

@ -1,3 +1,3 @@
% autojump(1) release-v20 % autojump(1) release-v22
% %
% 10 April 2012 % 10 April 2012

4
install.py
View File

@ -124,8 +124,10 @@ def print_post_installation_message(etc_dir):
else: else:
rcfile = '~/.%src' % get_shell() rcfile = '~/.%src' % get_shell()
print("\nPlease manually add the following line to %s:" % rcfile) print("\nPlease manually add the following line(s) to %s:" % rcfile)
print('\n\t' + source_msg) print('\n\t' + source_msg)
if get_shell() == 'zsh':
print("\n\tautoload -U compinit && compinit -u")
print("\nPlease restart terminal(s) before running autojump.\n") print("\nPlease restart terminal(s) before running autojump.\n")