wting_autojump/docs/autojump.1

.TH autojump 1 "10 April 2012" "release-v22"
.SS NAME
.PP
autojump - a faster way to navigate your filesystem
.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.
.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
.nf
\f[C]
j\ foo
\f[]
.fi
.RE
.IP \[bu] 2
Jump To A Child Directory:
.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\ bar
\f[]
.fi
.RE
.IP \[bu] 2
Open File Manager To Directories (instead of jumping):
.RS 2
.PP
Instead of jumping to a directory, you can open a file explorer window
(Mac Finder, Windows Explorer, GNOME Nautilus, etc.)
 to the directory instead.
.IP
.nf
\f[C]
jo\ music
\f[]
.fi
.PP
Opening a file manager to a child directory is also supported:
.IP
.nf
\f[C]
jco\ images
\f[]
.fi
.RE
.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 change directory to
/home/user/work/inbox.
.RE
.PP
For more options refer to help:
.IP
.nf
\f[C]
autojump\ --help
\f[]
.fi
.SS KNOWN ISSUES
.IP \[bu] 2
autojump does not support directories that begin with \f[C]-\f[].
.IP \[bu] 2
For bash users, autojump keeps track of directories by modifying
\f[C]$PROMPT_COMMAND\f[].
Do not overwrite \f[C]$PROMPT_COMMAND\f[]:
.RS 2
.IP
.nf
\f[C]
export\ PROMPT_COMMAND="history\ -a"
\f[]
.fi
.PP
Instead append to the end of the existing $PROMPT_COMMAND:
.IP
.nf
\f[C]
export\ PROMPT_COMMAND="${PROMPT_COMMAND:+$PROMPT_COMMAND\ ;}\ history\ -a"
\f[]
.fi
.RE
.SS REPORTING BUGS
.PP
For any questions or issues please visit:
.IP
.nf
\f[C]
https://github.com/joelthelion/autojump/issues
\f[]
.fi
.SS AUTHORS
.PP
autojump was originally written by Joël Schaerer, and currently
maintained by William Ting.
More contributors can be found in \f[C]AUTHORS\f[].
.SS COPYRIGHT
.PP
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.
update documentation 2014-01-07 18:32:35 +00:00			`.TH autojump 1 "10 April 2012" "release-v22"`
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			`.SS NAME`
			`.PP`
update documentation 2014-01-07 18:32:35 +00:00			`autojump - a faster way to navigate your filesystem`
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			`.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.`
			`.PP`
update documentation 2014-01-07 18:32:35 +00:00			`\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.`
update docs 2013-02-01 20:45:47 +00:00			`.IP \[bu] 2`
update documentation 2014-01-07 18:32:35 +00:00			`Jump To A Directory That Contains \f[C]foo\f[]:`
update docs 2013-02-01 20:45:47 +00:00			`.RS 2`
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			`.IP`
			`.nf`
			`\f[C]`
update documentation 2014-01-07 18:32:35 +00:00			`j\ foo`
update docs 2013-02-01 20:45:47 +00:00			`\f[]`
			`.fi`
			`.RE`
			`.IP \[bu] 2`
Duplicate fbf932 changes in proper locations and rebuild docs. 2014-06-29 00:26:02 +00:00			`Jump To A Child Directory:`
update docs 2013-02-01 20:45:47 +00:00			`.RS 2`
			`.PP`
			`Sometimes it\[aq]s convenient to jump to a child directory`
update documentation 2014-01-07 18:32:35 +00:00			`(sub-directory of current directory) rather than typing out the full`
update docs 2013-02-01 20:45:47 +00:00			`name.`
			`.IP`
			`.nf`
			`\f[C]`
update documentation 2014-01-07 18:32:35 +00:00			`jc\ bar`
update docs 2013-02-01 20:45:47 +00:00			`\f[]`
			`.fi`
			`.RE`
			`.IP \[bu] 2`
update documentation 2014-01-07 18:32:35 +00:00			`Open File Manager To Directories (instead of jumping):`
update docs 2013-02-01 20:45:47 +00:00			`.RS 2`
			`.PP`
			`Instead of jumping to a directory, you can open a file explorer window`
update documentation 2014-01-07 18:32:35 +00:00			`(Mac Finder, Windows Explorer, GNOME Nautilus, etc.)`
			`to the directory instead.`
update docs 2013-02-01 20:45:47 +00:00			`.IP`
			`.nf`
			`\f[C]`
			`jo\ music`
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			`\f[]`
			`.fi`
update docs 2013-02-01 20:45:47 +00:00			`.PP`
Duplicate fbf932 changes in proper locations and rebuild docs. 2014-06-29 00:26:02 +00:00			`Opening a file manager to a child directory is also supported:`
update docs 2013-02-01 20:45:47 +00:00			`.IP`
			`.nf`
			`\f[C]`
			`jco\ images`
			`\f[]`
			`.fi`
			`.RE`
Update documentation, particularly how to prefer symbolic links or change directory weights within the database. 2012-04-08 15:52:47 +00:00			`.IP \[bu] 2`
update documentation 2014-01-07 18:32:35 +00:00			`Using Multiple Arguments:`
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			`.RS 2`
			`.PP`
update documentation 2014-01-07 18:32:35 +00:00			`Let\[aq]s assume the following database:`
minor docs update regarding compinit 2013-02-17 16:49:31 +00:00			`.IP`
			`.nf`
			`\f[C]`
update documentation 2014-01-07 18:32:35 +00:00			`30\ \ \ /home/user/mail/inbox`
			`10\ \ \ /home/user/work/inbox`
minor docs update regarding compinit 2013-02-17 16:49:31 +00:00			`\f[]`
			`.fi`
update manpages 2013-05-15 00:14:03 +00:00			`.PP`
update documentation 2014-01-07 18:32:35 +00:00			`\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 change directory to`
			`/home/user/work/inbox.`
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			`.RE`
Implements #110: use 'export AUTOJUMP_IGNORE_CASE=1' to make autojump case insensitive 2012-05-07 04:30:22 +00:00			`.PP`
update documentation 2014-01-07 18:32:35 +00:00			`For more options refer to help:`
Implements #110: use 'export AUTOJUMP_IGNORE_CASE=1' to make autojump case insensitive 2012-05-07 04:30:22 +00:00			`.IP`
			`.nf`
			`\f[C]`
update documentation 2014-01-07 18:32:35 +00:00			`autojump\ --help`
Implements #110: use 'export AUTOJUMP_IGNORE_CASE=1' to make autojump case insensitive 2012-05-07 04:30:22 +00:00			`\f[]`
			`.fi`
update documentation 2014-01-07 18:32:35 +00:00			`.SS KNOWN ISSUES`
Implements #110: use 'export AUTOJUMP_IGNORE_CASE=1' to make autojump case insensitive 2012-05-07 04:30:22 +00:00			`.IP \[bu] 2`
update documentation 2014-01-07 18:32:35 +00:00			`autojump does not support directories that begin with \f[C]-\f[].`
Disable bash autocompletion, make it optional. Add relevant documentation. Closes #140. 2012-11-23 14:30:15 +00:00			`.IP \[bu] 2`
update documentation 2014-01-07 18:32:35 +00:00			`For bash users, autojump keeps track of directories by modifying`
			`\f[C]$PROMPT_COMMAND\f[].`
			`Do not overwrite \f[C]$PROMPT_COMMAND\f[]:`
Disable bash autocompletion, make it optional. Add relevant documentation. Closes #140. 2012-11-23 14:30:15 +00:00			`.RS 2`
			`.IP`
			`.nf`
			`\f[C]`
update documentation 2014-01-07 18:32:35 +00:00			`export\ PROMPT_COMMAND="history\ -a"`
Disable bash autocompletion, make it optional. Add relevant documentation. Closes #140. 2012-11-23 14:30:15 +00:00			`\f[]`
			`.fi`
			`.PP`
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			`.IP`
			`.nf`
			`\f[C]`
update documentation 2014-01-07 18:32:35 +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			`\f[]`
			`.fi`
update documentation 2014-01-07 18:32:35 +00:00			`.RE`
			`.SS REPORTING BUGS`
set permission 0755 to _j in install.sh 2012-10-19 11:37:19 +00:00			`.PP`
update documentation 2014-01-07 18:32:35 +00:00			`For any questions or issues please visit:`
Version bump to v21.1.0, update relevant documentation. 2012-11-22 22:44:05 +00:00			`.IP`
			`.nf`
			`\f[C]`
update documentation 2014-01-07 18:32:35 +00:00			`https://github.com/joelthelion/autojump/issues`
Version bump to v21.1.0, update relevant documentation. 2012-11-22 22:44:05 +00:00			`\f[]`
			`.fi`
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			`.SS AUTHORS`
			`.PP`
			`autojump was originally written by Joël Schaerer, and currently`
			`maintained by William Ting.`
update documentation 2014-01-07 18:32:35 +00:00			`More contributors can be found in \f[C]AUTHORS\f[].`
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			`.SS COPYRIGHT`
			`.PP`
			`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.`