From 1a0285ea11b0eac6bee99dd734af9dda4ec492fa Mon Sep 17 00:00:00 2001 From: wting Date: Mon, 26 Nov 2012 15:21:39 -0800 Subject: [PATCH] Add disclaimer regarding documentation updates. Modify formatting for consistency. --- Home.textile => Home.md | 37 +++++++++++++++++++++---------------- 1 file changed, 21 insertions(+), 16 deletions(-) rename Home.textile => Home.md (87%) diff --git a/Home.textile b/Home.md similarity index 87% rename from Home.textile rename to Home.md index 05f8226..4e102f8 100644 --- a/Home.textile +++ b/Home.md @@ -1,12 +1,16 @@ -Autojump: a cd command that learns +## This wiki is rarely updated. Please refer to the [readme.md](https://github.com/joelthelion/autojump#name) or man pages for up to date documentation. -For a quick introduction to Autojump, see [[this video.|http://www.youtube.com/watch?v=tnNyoMGnbKg]] +----------------------------------------------------------------------------- + +# Autojump: a cd command that learns + +For a quick introduction to Autojump, see [this video](http://www.youtube.com/watch?v=tnNyoMGnbKg). 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 you 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 `autojump -s` 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 "cd"ed directory by typing: - j dirspec + j 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. @@ -15,17 +19,17 @@ Autojump supports tab-completion. Try it! Autojump should be compatible with Bas 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. -*EXAMPLES* +## EXAMPLES -j mp3 + j mp3 could jump to "/home/gwb/my mp3 collection", if that is the directory in which you keep your mp3s. -j -s + j --stat will print out something in the lines of: -
+```shell
 54.5:   /home/shared/musique
 60.0:   /home/joel/workspace/coolstuff/glandu
 83.0:   /home/joel/workspace/abs_user/autojump
@@ -33,32 +37,33 @@ will print out something in the lines of:
 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. -*DOWNLOAD* +## DOWNLOAD Use the [[github dowloads|http://github.com/joelthelion/autojump/downloads]] to get the latest release, or use git to get the bleeding edge version (should usually work) -*INSTALLATION* +## INSTALLATION For automatic installation, make sure that install.sh is executable. If not (or if not sure), run 
chmod +x install.sh
Once it is executable, run 
./install.sh
It will tell you any necessary steps from there. -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: +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 the appropriate file in your .bashrc: - ```source /etc/profile``` + source /etc/profile.d/autojump.sh If you do not have root access to your machine, copy @autojump@ to a directory that is in the @PATH@ (for example, @$HOME/local/bin@), copy @autojump.bash@ somewhere convenient, and add @source /path/to/autojump.bash@ in your @.bashrc@. -*AUTHORS* +## AUTHORS Joel Schaerer William Ting -Autojump applet written by Pierre Gueth -Zsh support: Simon Marache-Francisco -Install script written by Daniel Jackoway and others. +Pierre Gueth (applet) +Simon Marache-Francisco (zsh) +Daniel Jackoway and others (installation) Contact us: autojump@googlegroups.com