1
0
mirror of https://github.com/wting/autojump synced 2024-10-27 20:34:07 +00:00

update manpages

This commit is contained in:
William Ting 2013-05-14 19:14:03 -05:00
parent 2b6cfe7cdf
commit ba6b1e54ae
3 changed files with 24 additions and 62 deletions

View File

@ -10,12 +10,11 @@ Jump to a previously visited directory that contains 'foo':
j foo j foo
Jump to a previously visited subdirectory of the current working Jump to a previously visited subdirectory of the current directory:
directory:
jc bar jc bar
Show all database entries and their respective key weights: Show database entries and their respective key weights:
j --stat j --stat
@ -24,8 +23,7 @@ DESCRIPTION
autojump is a faster way to navigate your filesystem. It works by autojump is a faster way to navigate your filesystem. It works by
maintaining a database of the directories you use the most from the maintaining a database of the directories you use the most from the
command line. The `j --stat` command shows you the current contents of command line. Directories must be visited first before they can be
the database. Directories must be visited first before they can be
jumped to. jumped to.
INSTALLATION INSTALLATION
@ -130,11 +128,13 @@ OPTIONS
Options must be passed to 'autojump' and not the 'j' wrapper function. 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 --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 --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 a different entry. In the above example, `j w in` would then jump
you into /home/user/work/inbox. 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 Sometimes it's convenient to jump to a child directory
(sub-directory of current directory) rather than typing out the full (sub-directory of current directory) rather than typing out the full
@ -173,12 +173,6 @@ ADVANCED USAGE
jco images 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 ADDITIONAL CONFIGURATION
------------------------ ------------------------
@ -196,6 +190,10 @@ ADDITIONAL CONFIGURATION
autoload -U compinit && compinit -u 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 - Always Ignore Case
Default behavior is to prioritize exact matches over all else. For 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. 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 KNOWN ISSUES
------------ ------------

View File

@ -12,8 +12,7 @@ j\ foo
\f[] \f[]
.fi .fi
.PP .PP
Jump to a previously visited subdirectory of the current working Jump to a previously visited subdirectory of the current directory:
directory:
.IP .IP
.nf .nf
\f[C] \f[C]
@ -21,7 +20,7 @@ jc\ bar
\f[] \f[]
.fi .fi
.PP .PP
Show all database entries and their respective key weights: Show database entries and their respective key weights:
.IP .IP
.nf .nf
\f[C] \f[C]
@ -33,8 +32,6 @@ j\ --stat
autojump is a faster way to navigate your filesystem. autojump is a faster way to navigate your filesystem.
It works by maintaining a database of the directories you use the most It works by maintaining a database of the directories you use the most
from the command line. 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. Directories must be visited first before they can be jumped to.
.SS OPTIONS .SS OPTIONS
.PP .PP
@ -43,11 +40,13 @@ wrapper function.
.IP .IP
.nf .nf
\f[C] \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 --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 --version\ \ \ \ \ \ \ \ \ \ \ show\ version\ information\ and\ exit
\f[] \f[]
@ -74,7 +73,7 @@ In the above example, \f[C]j\ w\ in\f[] would then jump you into
/home/user/work/inbox. /home/user/work/inbox.
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
Jump to a Child Directory. Jump To A Child Directory.
.RS 2 .RS 2
.PP .PP
Sometimes it\[aq]s convenient to jump to a child directory Sometimes it\[aq]s convenient to jump to a child directory
@ -109,15 +108,6 @@ jco\ images
\f[] \f[]
.fi .fi
.RE .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 .SS ADDITIONAL CONFIGURATION
.IP \[bu] 2 .IP \[bu] 2
Enable ZSH Tab Completion Enable ZSH Tab Completion
@ -142,6 +132,11 @@ This check can be ignored by using the -u flag:
autoload\ -U\ compinit\ &&\ compinit\ -u autoload\ -U\ compinit\ &&\ compinit\ -u
\f[] \f[]
.fi .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 .RE
.IP \[bu] 2 .IP \[bu] 2
Always Ignore Case Always Ignore Case
@ -208,23 +203,6 @@ export\ AUTOJUMP_AUTOCOMPLETE_CMDS=\[aq]cp\ vim\[aq]
.PP .PP
Changes require reloading autojump to take into effect. Changes require reloading autojump to take into effect.
.RE .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 .SS KNOWN ISSUES
.IP \[bu] 2 .IP \[bu] 2
For bash users, autojump keeps track of directories as a pre-command For bash users, autojump keeps track of directories as a pre-command

View File

@ -1,9 +1,5 @@
#!/usr/bin/env python2 #!/usr/bin/env python2
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
"""
Tests autojump.
"""
from __future__ import division from __future__ import division
import autojump import autojump
import contextlib import contextlib