Archives/wting_autojump
1
0
Fork 0
mirror of https://github.com/wting/autojump synced 2026-03-02 03:49:26 +00:00
Code Issues Releases Wiki Activity

restructure files, working make doc and make release

Browse Source
This commit is contained in:
William Ting
2012-04-17 13:09:39 -10:00
parent 2ebcdba5bd
commit acfc5c13ef
16 changed files with 28 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

125
docs/autojump.1 Normal file
View File

@@ -0,0 +1,125 @@
.TH autojump 1 "10 April 2012" "release-v20"
.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
\f[C]
j\ foo
\f[]
.fi
.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.
.SS OPTIONS
.PP
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
--stat\ \ \ \ \ \ \ \ \ \ \ \ \ \ show\ database\ entries\ and\ their\ key\ weights
--version\ \ \ \ \ \ \ \ \ \ \ show\ version\ information\ and\ exit
\f[]
.fi
.SS INTERNAL OPTIONS
.IP
.nf
\f[C]
-b,\ --bash\ \ \ \ \ \ \ \ \ \ enclose\ directory\ with\ quotes\ to\ prevent\ errors
--completion\ \ \ \ \ \ \ \ prevent\ key\ weight\ decay\ over\ time
\f[]
.fi
.SS ADVANCED USAGE
.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, export the following
configuration in your ~/.bashrc:
.IP
.nf
\f[C]
export\ AUTOJUMP_KEEP_SYMLINKS=1
\f[]
.fi
.RE
.IP \[bu] 2
Change Directory Weight
.RS 2
.PP
To manually change a directory\[aq]s key weight, you can edit the file
\f[I]$XDG_DATA_HOME/autojump/autojump.txt\f[].
Each entry has two columns.
The first is the key weight and the second is the path:
.IP
.nf
\f[C]
29.3383211216\ \ \ /home/user/downloads
\f[]
.fi
.PP
All negative key weights are purged automatically.
.RE
.SS KNOWN ISSUES
.IP \[bu] 2
zsh (bug #86)
.RS 2
.PP
Tab completion does not work.
.RE
.IP \[bu] 2
jumpapplet (bug #59)
.RS 2
.PP
Does not work in Gnome 3 shell or LDXE.
.RE
.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
.PP
For any issues please visit the following URL:
.PP
\f[I]https://github.com/joelthelion/autojump/issues\f[]
.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.

73
docs/install.md Normal file
View File

@@ -0,0 +1,73 @@
## INSTALLATION
### REQUIREMENTS
Python v2.7+ or 3.2+
Bash v4.0+ for tab completion
If you are unable to update Python to a supported version, older versions of autojump can be [downloaded](https://github.com/joelthelion/autojump/downloads) and installed manually.
Python v2.6+ is supported by [release v19](https://github.com/downloads/joelthelion/autojump/autojump_v19.tar.gz).
Python v2.4+ is supported by [release v12](https://github.com/downloads/joelthelion/autojump/autojump_v12.tar.gz).
### 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
MacPorts also available:
port install autojump
**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.

86
docs/manpage.md Normal file
View File

@@ -0,0 +1,86 @@
% 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.