From ba6b1e54ae000f634acb4657df7996b5369c9310 Mon Sep 17 00:00:00 2001 From: William Ting Date: Tue, 14 May 2013 19:14:03 -0500 Subject: [PATCH] update manpages --- README.md | 36 ++++++++++++------------------------ docs/autojump.1 | 46 ++++++++++++---------------------------------- tests/runtests.py | 4 ---- 3 files changed, 24 insertions(+), 62 deletions(-) diff --git a/README.md b/README.md index 07eb6d2..a0e74e2 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,11 @@ Jump to a previously visited directory that contains 'foo': j foo -Jump to a previously visited subdirectory of the current working -directory: +Jump to a previously visited subdirectory of the current directory: jc bar -Show all database entries and their respective key weights: +Show database entries and their respective key weights: j --stat @@ -24,8 +23,7 @@ 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 `j --stat` command shows you the current contents of -the database. Directories must be visited first before they can be +command line. Directories must be visited first before they can be jumped to. INSTALLATION @@ -130,11 +128,13 @@ OPTIONS Options must be passed to 'autojump' and not the 'j' wrapper function. - -a, --add DIR manually add path to database + -i, --increase manually increase current directory weight + + -d, --decrease manually decrease current directory weight --purge deletes database entries that no longer exist on system - -s, --stat show database entries and their key weights + -s, --stat show general stats and top 100 database entries --version show version information and exit @@ -153,7 +153,7 @@ ADVANCED USAGE a different entry. In the above example, `j w in` would then jump you into /home/user/work/inbox. -- Jump to a Child Directory. +- Jump To A Child Directory. Sometimes it's convenient to jump to a child directory (sub-directory of current directory) rather than typing out the full @@ -173,12 +173,6 @@ ADVANCED USAGE jco images -- ZSH Tab Completion - - Tab completion requires two tabs before autojump will display the - completion menu. However if `setopt nolistambiguous` is enabled, - then only one tab is required. - ADDITIONAL CONFIGURATION ------------------------ @@ -196,6 +190,10 @@ ADDITIONAL CONFIGURATION autoload -U compinit && compinit -u + Tab completion requires two tabs before autojump will display the + completion menu. However if `setopt nolistambiguous` is enabled, + then only one tab is required. + - Always Ignore Case Default behavior is to prioritize exact matches over all else. For @@ -234,16 +232,6 @@ ADDITIONAL CONFIGURATION Changes require reloading autojump to take into effect. -- 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 ------------ diff --git a/docs/autojump.1 b/docs/autojump.1 index 343551f..fec5601 100644 --- a/docs/autojump.1 +++ b/docs/autojump.1 @@ -12,8 +12,7 @@ j\ foo \f[] .fi .PP -Jump to a previously visited subdirectory of the current working -directory: +Jump to a previously visited subdirectory of the current directory: .IP .nf \f[C] @@ -21,7 +20,7 @@ jc\ bar \f[] .fi .PP -Show all database entries and their respective key weights: +Show database entries and their respective key weights: .IP .nf \f[C] @@ -33,8 +32,6 @@ j\ --stat 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 \f[C]j\ --stat\f[] command shows you the current contents of the -database. Directories must be visited first before they can be jumped to. .SS OPTIONS .PP @@ -43,11 +40,13 @@ wrapper function. .IP .nf \f[C] --a,\ --add\ DIR\ \ \ \ \ \ \ manually\ add\ path\ to\ database +-i,\ --increase\ \ \ \ \ \ manually\ increase\ current\ directory\ weight + +-d,\ --decrease\ \ \ \ \ \ manually\ decrease\ current\ directory\ weight --purge\ \ \ \ \ \ \ \ \ \ \ \ \ deletes\ database\ entries\ that\ no\ longer\ exist\ on\ system --s,\ --stat\ \ \ \ \ \ \ \ \ \ show\ database\ entries\ and\ their\ key\ weights +-s,\ --stat\ \ \ \ \ \ \ \ \ \ show\ general\ stats\ and\ top\ 100\ database\ entries --version\ \ \ \ \ \ \ \ \ \ \ show\ version\ information\ and\ exit \f[] @@ -74,7 +73,7 @@ In the above example, \f[C]j\ w\ in\f[] would then jump you into /home/user/work/inbox. .RE .IP \[bu] 2 -Jump to a Child Directory. +Jump To A Child Directory. .RS 2 .PP Sometimes it\[aq]s convenient to jump to a child directory @@ -109,15 +108,6 @@ jco\ images \f[] .fi .RE -.IP \[bu] 2 -ZSH Tab Completion -.RS 2 -.PP -Tab completion requires two tabs before autojump will display the -completion menu. -However if \f[C]setopt\ nolistambiguous\f[] is enabled, then only one -tab is required. -.RE .SS ADDITIONAL CONFIGURATION .IP \[bu] 2 Enable ZSH Tab Completion @@ -142,6 +132,11 @@ This check can be ignored by using the -u flag: autoload\ -U\ compinit\ &&\ compinit\ -u \f[] .fi +.PP +Tab completion requires two tabs before autojump will display the +completion menu. +However if \f[C]setopt\ nolistambiguous\f[] is enabled, then only one +tab is required. .RE .IP \[bu] 2 Always Ignore Case @@ -208,23 +203,6 @@ export\ AUTOJUMP_AUTOCOMPLETE_CMDS=\[aq]cp\ vim\[aq] .PP Changes require reloading autojump to take into effect. .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 For bash users, autojump keeps track of directories as a pre-command diff --git a/tests/runtests.py b/tests/runtests.py index 3bfb3cb..ece746f 100755 --- a/tests/runtests.py +++ b/tests/runtests.py @@ -1,9 +1,5 @@ #!/usr/bin/env python2 # -*- coding: utf-8 -*- -""" - Tests autojump. -""" - from __future__ import division import autojump import contextlib