mirror of https://github.com/wting/autojump
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.pull/119/head
William Ting
12 years ago
parent
079abfdbe6
commit
efa8bbcf81
@ -0,0 +1,63 @@
|
||||
## INSTALLATION
|
||||
|
||||
### REQUIREMENTS
|
||||
|
||||
Python v2.6+ or 3.0+
|
||||
|
||||
### 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
|
||||
|
||||
A MacPorts installation method is also [available](https://trac.macports.org/browser/trunk/dports/sysutils/autojump/Portfile).
|
||||
|
||||
**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.
|
||||
@ -0,0 +1,162 @@
|
||||
% autojump(1) release-v19
|
||||
%
|
||||
% 07 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.
|
||||
|
||||
autojump supports tab completion in Bash v4.0+.
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
|
||||
Below 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
|
||||
|
||||
--completion prevent key weight decay over time
|
||||
|
||||
ADVANCED USAGE
|
||||
--------------
|
||||
|
||||
To manually change an entry's weight, edit the file
|
||||
$XDG\_DATA\_HOME/autojump/autojump.txt.
|
||||
|
||||
FILES
|
||||
-----
|
||||
|
||||
If installed locally, autojump is self-contained in the directory
|
||||
\~/.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.6+ or 3.0+
|
||||
|
||||
### 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
|
||||
|
||||
A MacPorts installation method is also
|
||||
[available](https://trac.macports.org/browser/trunk/dports/sysutils/autojump/Portfile).
|
||||
|
||||
**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.
|
||||
@ -1,137 +0,0 @@
|
||||
========
|
||||
AUTOJUMP
|
||||
========
|
||||
|
||||
----------------------------
|
||||
A ``cd`` command that learns
|
||||
----------------------------
|
||||
|
||||
One of the most used shell commands is ``cd``. A quick survey among my friends revealed that between 10 and 20% of all commands they type are actually ``cd`` commands! Unfortunately, jumping from one part of your system to another with ``cd`` requires to enter almost the full path, which isn't very practical and requires a lot of keystrokes.
|
||||
|
||||
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. You need to work a little bit before the database becomes usable. Once your database is reasonably complete, you can "jump" to a commonly used directory by typing:
|
||||
|
||||
j <dir>
|
||||
|
||||
where <dir> is a few characters of the directory you want to jump to. It will jump to the most used directory whose name matches the pattern given in dirspec. Note that autojump isn't meant to be a drop-in replacement for cd, but rather a complement. Cd is fine when staying in the same area of the filesystem; autojump is there to help when you need to jump far away from your current location.
|
||||
|
||||
Autojump supports tab completion starting with bash v4.0+.
|
||||
|
||||
Pierre Gueth contributed a very nice applet for freedesktop desktops (Gnome/KDE/...). It is called "jumpapplet", try it!
|
||||
|
||||
Thanks to Simon Marache-Francisco's outstanding work, autojump now works perfectly with zsh.
|
||||
|
||||
Usage Examples
|
||||
==============
|
||||
|
||||
::
|
||||
|
||||
j music
|
||||
|
||||
would jump to ``/home/user/music/``, if that's a commonly directory traversed by command line. ::
|
||||
|
||||
autojump music
|
||||
|
||||
displays the directory autojump would jump to if invoked. ::
|
||||
|
||||
jumpstat
|
||||
|
||||
displays a listing of tracked directories and their respective weights. For example: ::
|
||||
|
||||
...
|
||||
54.5: /home/shared/misc
|
||||
60.0: /home/user/Dropbox
|
||||
96.9: /home/user/code/autojump
|
||||
161.7: /home/user
|
||||
Total key weight: 1077
|
||||
|
||||
The "key weight" reflects the amount of time you spend in a directory.
|
||||
|
||||
Authors
|
||||
=======
|
||||
|
||||
- Joel Schaerer (joel.schaerer (at) laposte.net)
|
||||
- autojump applet: Pierre Gueth
|
||||
- zsh support: Simon Marache-Francisco, William Ting
|
||||
- installation: Daniel Jackoway, William Ting, and others.
|
||||
|
||||
License
|
||||
=======
|
||||
|
||||
autojump is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
||||
|
||||
autojump is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License along with autojump. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Requirements
|
||||
============
|
||||
|
||||
Python v2.6+ or 3.0+
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
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
|
||||
|
||||
A MacPorts installation method is also `available <https://trac.macports.org/browser/trunk/dports/sysutils/autojump/Portfile>`_.
|
||||
|
||||
**Other**
|
||||
|
||||
Please check the 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.
|
||||
|
||||
Use --local to install into current user's home directory.
|
||||
|
||||
Use --zsh to install for Z shell.
|
||||
|
||||
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 Bash prompt, do:``unset PROMPT_COMMAND``. You can also restart your shell.
|
||||
@ -1,76 +1,83 @@
|
||||
.\" A sample man page.
|
||||
.\" Contact admin@yourcompany.com to correct errors or omissions.
|
||||
.TH autojump 1 "10 February 2009" "1.0" "A faster way to navigate your filesystem"
|
||||
.SH NAME
|
||||
autojump \- a faster way to navigate your filesystem
|
||||
.SH SYNOPSIS
|
||||
.\" Syntax goes here.
|
||||
.B j
|
||||
dirspec
|
||||
.P
|
||||
.B jumpstat
|
||||
.SH DESCRIPTION
|
||||
One of the most used shell commands is "cd". A quick survey among my friends revealed that between 10 and 20% of all commands they type are actually cd commands! Unfortunately, jumping from one part of your system to another with cd requires to enter almost the full path, which isn't very practical and requires a lot of keystrokes.
|
||||
.P
|
||||
.B 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
|
||||
.B jumpstat
|
||||
command shows you the current contents of the database. You need to work a little bit before the database becomes useable. Once your database is reasonably complete, you can "jump" to a directory by typing:
|
||||
.P
|
||||
.B j
|
||||
dirspec
|
||||
.P
|
||||
where dirspec is a few characters of the directory you want to jump to. It will jump to the most used directory whose name matches the pattern given in dirspec. Note that autojump isn't meant to be a drop-in replacement for cd, but rather a complement. Cd is fine when staying in the same area of the filesystem; autojump is there to help when you need to jump far away from your current location.
|
||||
.P
|
||||
Autojump supports autocompletion. Try it!
|
||||
.SH EXAMPLES
|
||||
.B j
|
||||
mp3
|
||||
.P
|
||||
could jump to "/home/gwb/my\ mp3\ collection", if that is the directory in which you keep your mp3s.
|
||||
.P
|
||||
.B autojump
|
||||
mp3
|
||||
.P
|
||||
prints out something like "/home/gwb/my\ mp3\ collection", but does not jump to that directory.
|
||||
.P
|
||||
.B jumpstat
|
||||
.P
|
||||
will print out something along the lines of:
|
||||
.P
|
||||
54.5: /home/shared/musique
|
||||
.P
|
||||
60.0: /home/joel/workspace/coolstuff/glandu
|
||||
.P
|
||||
83.0: /home/joel/workspace/abs_user/autojump
|
||||
.P
|
||||
97.9: /home/joel/workspace/autojump
|
||||
.P
|
||||
141.8: /home/joel/workspace/vv
|
||||
.P
|
||||
161.7: /home/joel
|
||||
.P
|
||||
Total key weight: 1079
|
||||
.P
|
||||
The "key weight" reflects the amount of time you spend in a directory.
|
||||
.SH BUGS
|
||||
No known bugs at this time.
|
||||
.SH AUTHOR
|
||||
.TH autojump 1 "07 April 2012" "release-v19"
|
||||
.SS NAME
|
||||
.PP
|
||||
autojump - a faster way to navigate your filesystem
|
||||
.SS SYNOPSIS
|
||||
.PP
|
||||
Jump to a previously visited directory \[aq]foobar\[aq]:
|
||||
.IP
|
||||
.nf
|
||||
Joel Schaerer (joel.schaerer@laposte.net)
|
||||
\f[C]
|
||||
j\ foo
|
||||
\f[]
|
||||
.fi
|
||||
.SH LICENSE
|
||||
.B autojump
|
||||
is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
.PP
|
||||
Show all database entries and their respective key weights:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
jumpstat
|
||||
\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.
|
||||
The jumpstat command shows you the current contents of the database.
|
||||
Directories must be visited first before they can be jumped to.
|
||||
.PP
|
||||
autojump supports tab completion in Bash v4.0+.
|
||||
.SS OPTIONS
|
||||
.PP
|
||||
Below options must be passed to \[aq]autojump\[aq] and not the
|
||||
\[aq]j\[aq] wrapper function.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
-a,\ --add\ DIR\ \ \ \ \ \ \ manually\ add\ path\ to\ database
|
||||
|
||||
autojump is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
--stat\ \ \ \ \ \ \ \ \ \ \ \ \ \ show\ database\ entries\ and\ their\ key\ weights
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with autojump. If not, see <http://www.gnu.org/licenses/>.
|
||||
--version\ \ \ \ \ \ \ \ \ \ \ show\ version\ information\ and\ exit
|
||||
\f[]
|
||||
.fi
|
||||
.SS INTERNAL OPTIONS
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
-b,\ --bash
|
||||
|
||||
--completion\ \ \ \ \ \ \ \ prevent\ key\ weight\ decay\ over\ time
|
||||
\f[]
|
||||
.fi
|
||||
.SS ADVANCED USAGE
|
||||
.PP
|
||||
To manually change an entry\[aq]s weight, edit the file
|
||||
$XDG_DATA_HOME/autojump/autojump.txt.
|
||||
.SS FILES
|
||||
.PP
|
||||
If installed locally, autojump is self-contained in the directory
|
||||
~/.autojump/.
|
||||
.PP
|
||||
The database is stored in $XDG_DATA_HOME/autojump/autojump.txt.
|
||||
.SS REPORTING BUGS
|
||||
.PP
|
||||
For any issues please visit the following URL:
|
||||
.PP
|
||||
https://github.com/joelthelion/autojump/issues
|
||||
.SS THANKS
|
||||
.PP
|
||||
Special thanks goes out to: Pierre Gueth, Simon Marache-Francisco,
|
||||
Daniel Jackoway, and many others.
|
||||
.SS AUTHORS
|
||||
.PP
|
||||
autojump was originally written by Joël Schaerer, and currently
|
||||
maintained by William Ting.
|
||||
.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.
|
||||
|
||||
@ -0,0 +1,4 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
pandoc -s -w man manpage.md -o autojump.1
|
||||
pandoc -s -w markdown manpage.md INSTALL.md -o README.md
|
||||
@ -0,0 +1,66 @@
|
||||
% autojump(1) release-v19
|
||||
%
|
||||
% 07 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.
|
||||
|
||||
autojump supports tab completion in Bash v4.0+.
|
||||
|
||||
## OPTIONS
|
||||
|
||||
Below 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
|
||||
|
||||
--completion prevent key weight decay over time
|
||||
|
||||
## ADVANCED USAGE
|
||||
|
||||
To manually change an entry's weight, edit the file $XDG_DATA_HOME/autojump/autojump.txt.
|
||||
|
||||
## FILES
|
||||
|
||||
If installed locally, autojump is self-contained in the directory ~/.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.
|
||||
Loading…
Reference in new issue