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

documentation improvements

Browse Source
This commit is contained in:
Joël Schaerer 2009-02-12 09:52:31 +01:00
parent b63ddeed3a
commit dbb4d9ae20
3 changed files with 61 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README Normal file
View File

@ -0,0 +1,54 @@
AUTOJUMP - A faster way to navigate your filesystem
===================================================
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 jstat 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:
<b>j</b> dirspec
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.
EXAMPLES
<b>j</b> mp3
could jump to "/home/gwb/my mp3 collection", if that is the directory in which you keep your mp3s.
<b>jstat</b>
will print out something in the lines of:
...
54.5: /home/shared/musique
60.0: /home/joel/workspace/coolstuff/glandu
83.0: /home/joel/workspace/abs_user/autojump
96.9: /home/joel/workspace/autojump
141.8: /home/joel/workspace/vv
161.7: /home/joel
Total key weight: 1077
The "key weight" reflects the amount of time you spend in a directory.
AUTHOR
Joel Schaerer (joel.schaerer (at) laposte.net)
LICENSE
autojump is distributed under the terms of the GPL, version 3.
INSTALLATION
Manual installation of autojump is very simple: copy autojump to /usr/bin, autojump.sh to /etc/profile.d, and autojump.1 to /usr/share/man/man1. Make sure you source /etc/profile in your .bashrc, and voilà!
PACKAGING
For now I have packaged autojump for arch linux. It is available from the AUR. To install, type:
yaourt -S autojump
I would be very interested by pacakges for other distros. If you think you can help me with the packaging, please contact me!

7
autojump.1
View File

@ -10,6 +10,8 @@ dirspec
.P
.B jstat
.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 jstat
@ -23,7 +25,7 @@ where dirspec is a few characters of the directory you want to jump to. It will
.B j
mp3
.P
could jump to /home/gwb/my\ mp3\ collection, if that is the directory in which you keep your mp3s.
could jump to "/home/gwb/my\ mp3\ collection", if that is the directory in which you keep your mp3s.
.P
.B jstat
.P
@ -52,3 +54,6 @@ Joel Schaerer (joel.schaerer@laposte.net)
.fi
.SH HISTORY
2009 \- First version.
.SH LICENSE
.B autojump
is distributed under the terms of the GPL, version 3.

2
autojump.install
View File

@ -1,6 +1,6 @@
# arg 1: the new package version
post_install() {
echo " > You need to source /etc/profile in your ~/.bash_profile our ~/.bashrc for this to work"
echo " > You need to source /etc/profile in your ~/.bashrc for this to work"
echo " > Only guaranteed to work with bash"
echo " > man autojump for instructions."
/bin/true