wting_autojump/README.md

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

### 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

## Windows

Windows support is enabled by [clink](https://code.google.com/p/clink/) which should be installed prior to installing autojump.

Completion support on windows has not yet been added.

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
---------

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.
Fixes #112, fixes #116. Simplify documentation build. Documentation is now generated through Pandoc by running ./make_doc.sh. Man page is generated from manpage.md, while INSTALL.md + manpage.md = README.md. 2012-04-07 16:57:16 +00: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`
update documentation 2014-01-07 18:32:35 +00:00			`command line.`
Fixes #112, fixes #116. Simplify documentation build. Documentation is now generated through Pandoc by running ./make_doc.sh. Man page is generated from manpage.md, while INSTALL.md + manpage.md = README.md. 2012-04-07 16:57:16 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`Directories must be visited first before they can be jumped to.`
Fixes #112, fixes #116. Simplify documentation build. Documentation is now generated through Pandoc by running ./make_doc.sh. Man page is generated from manpage.md, while INSTALL.md + manpage.md = README.md. 2012-04-07 16:57:16 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`USAGE`
			`-----`
Add dev section to README.md and update makefile to reflect new section. 2012-05-13 02:38:09 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`j` is a convenience wrapper function around `autojump`. Any option that
			can be used with `autojump` can be used with `j` and vice versa.
Add dev section to README.md and update makefile to reflect new section. 2012-05-13 02:38:09 +00:00
update documentation 2014-01-07 18:32:35 +00:00			- Jump To A Directory That Contains `foo`:
Add dev section to README.md and update makefile to reflect new section. 2012-05-13 02:38:09 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`j foo`
Add dev section to README.md and update makefile to reflect new section. 2012-05-13 02:38:09 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`- Jump To A Child Directory`
split up doc building for manpage and readme.md 2012-04-18 00:26:54 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`Sometimes it's convenient to jump to a child directory`
			`(sub-directory of current directory) rather than typing out the full`
			`name.`
split up doc building for manpage and readme.md 2012-04-18 00:26:54 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`jc bar`
update manpages 2013-05-15 00:14:03 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`- Open File Manager To Directories (instead of jumping):`
split up doc building for manpage and readme.md 2012-04-18 00:26:54 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`Instead of jumping to a directory, you can open a file explorer`
			`window (Mac Finder, Windows Explorer, GNOME Nautilus, etc.) to the`
			`directory instead.`
add purge option to clear database of missing entries 2012-05-07 06:50:40 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`jo music`
split up doc building for manpage and readme.md 2012-04-18 00:26:54 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`Opening a file manager to a child directory is also supported.`
split up doc building for manpage and readme.md 2012-04-18 00:26:54 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`jco images`
update docs 2013-02-01 20:45:47 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`- Using Multiple Arguments:`
update docs 2013-02-01 20:45:47 +00:00
			`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`
update documentation 2014-01-07 18:32:35 +00:00			a different entry. In the above example, `j w in` would then change
			`directory to /home/user/work/inbox.`
update docs 2013-02-01 20:45:47 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`For more options refer to help:`
split up doc building for manpage and readme.md 2012-04-18 00:26:54 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`autojump --help`
update docs 2013-02-01 20:45:47 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`INSTALLATION`
			`------------`
update docs 2013-02-01 20:45:47 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`### REQUIREMENTS`
update docs 2013-02-01 20:45:47 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`- Python v2.6+`
added note about windows to readme 2014-01-13 19:13:36 +00:00			`- Bash v4.0+, zsh, fish or clink (Windows)`
split up doc building for manpage and readme.md 2012-04-18 00:26:54 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`### AUTOMATIC`
Remove loading compinit module from autojump.zsh. I've updated the documentation to notify end users to add compinit to their ~/.zshrc if they want tab completion. 2012-07-03 03:34:21 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`#### Linux`
Remove loading compinit module from autojump.zsh. I've updated the documentation to notify end users to add compinit to their ~/.zshrc if they want tab completion. 2012-07-03 03:34:21 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`autojump is included in the following distro repositories, please use`
			`relevant package management utilities to install (e.g. yum, apt-get,`
			`etc):`
Remove loading compinit module from autojump.zsh. I've updated the documentation to notify end users to add compinit to their ~/.zshrc if they want tab completion. 2012-07-03 03:34:21 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`- Debian testing/unstable, Ubuntu, Linux Mint`
minor docs update regarding compinit 2013-02-17 16:49:31 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`All Debian-derived distros require manual activation for policy`
			reasons, please see `/usr/share/doc/autojump/README.Debian`.
minor docs update regarding compinit 2013-02-17 16:49:31 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`- RedHat, Fedora, CentOS`
			`- ArchLinux`
			`- Gentoo`
			`- Frugalware`
			`- Slackware`
update manpages 2013-05-15 00:14:03 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`#### OS X`
Implements #110: use 'export AUTOJUMP_IGNORE_CASE=1' to make autojump case insensitive 2012-05-07 04:30:22 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`Homebrew is the recommended installation method for Mac OS X:`
Implements #110: use 'export AUTOJUMP_IGNORE_CASE=1' to make autojump case insensitive 2012-05-07 04:30:22 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`brew install autojump`
Implements #110: use 'export AUTOJUMP_IGNORE_CASE=1' to make autojump case insensitive 2012-05-07 04:30:22 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`MacPorts also available:`
split up doc building for manpage and readme.md 2012-04-18 00:26:54 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`port install autojump`
split up doc building for manpage and readme.md 2012-04-18 00:26:54 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`### MANUAL`
split up doc building for manpage and readme.md 2012-04-18 00:26:54 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`Grab a copy of autojump:`
Disable bash autocompletion, make it optional. Add relevant documentation. Closes #140. 2012-11-23 14:30:15 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`git clone git://github.com/joelthelion/autojump.git`
Disable bash autocompletion, make it optional. Add relevant documentation. Closes #140. 2012-11-23 14:30:15 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`Run the installation script and follow on screen instructions.`
Disable bash autocompletion, make it optional. Add relevant documentation. Closes #140. 2012-11-23 14:30:15 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`cd autojump`
			`./install.py or ./uinstall.py`
Disable bash autocompletion, make it optional. Add relevant documentation. Closes #140. 2012-11-23 14:30:15 +00:00
added note about windows to readme 2014-01-13 19:13:36 +00:00			`## Windows`

			`Windows support is enabled by [clink](https://code.google.com/p/clink/) which should be installed prior to installing autojump.`

			`Completion support on windows has not yet been added.`

split up doc building for manpage and readme.md 2012-04-18 00:26:54 +00:00			`KNOWN ISSUES`
			`------------`

update documentation 2014-01-07 18:32:35 +00:00			- 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`:
set permission 0755 to _j in install.sh 2012-10-19 11:37:19 +00:00
			`export PROMPT_COMMAND="history -a"`

update documentation 2014-01-07 18:32:35 +00:00			`Instead append to the end of the existing $PROMPT\_COMMAND:`
set permission 0755 to _j in install.sh 2012-10-19 11:37:19 +00:00
Version bump to v21.1.0, update relevant documentation. 2012-11-22 22:44:05 +00:00			`export PROMPT_COMMAND="${PROMPT_COMMAND:+$PROMPT_COMMAND ;} history -a"`
set permission 0755 to _j in install.sh 2012-10-19 11:37:19 +00:00
split up doc building for manpage and readme.md 2012-04-18 00:26:54 +00:00			`REPORTING BUGS`
			`--------------`

update documentation 2014-01-07 18:32:35 +00:00			`For any questions or issues please visit:`
split up doc building for manpage and readme.md 2012-04-18 00:26:54 +00:00
update documentation 2014-01-07 18:32:35 +00:00			`https://github.com/joelthelion/autojump/issues`
split up doc building for manpage and readme.md 2012-04-18 00:26:54 +00:00
			`AUTHORS`
			`-------`

			`autojump was originally written by Joël Schaerer, and currently`
update documentation 2014-01-07 18:32:35 +00:00			maintained by William Ting. More contributors can be found in `AUTHORS`.
split up doc building for manpage and readme.md 2012-04-18 00:26:54 +00:00
			`COPYRIGHT`
			`---------`

update documentation 2014-01-07 18:32:35 +00:00			`Copyright © 2012 Free Software Foundation, Inc. License GPLv3+: GNU GPL`
split up doc building for manpage and readme.md 2012-04-18 00:26:54 +00:00			`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.`