mirror of
				https://github.com/wting/autojump
				synced 2025-06-13 12:54:07 +00:00 
			
		
		
		
	update docs
This commit is contained in:
		
							parent
							
								
									3573321ec7
								
							
						
					
					
						commit
						c3a0900191
					
				| @ -2,6 +2,12 @@ | ||||
| # Summary of release changes, see commit history for more details: | ||||
| # https://github.com/joelthelion/autojump/commits/master/ | ||||
| 
 | ||||
| * Release v21.6.8: | ||||
| 
 | ||||
| 	- fix --increase and --decrease options | ||||
| 	- heavy refactoring | ||||
| 	- remove unused unit tests | ||||
| 
 | ||||
| * Release v21.5.8: | ||||
| 
 | ||||
| 	- fix security bug: | ||||
|  | ||||
| @ -227,9 +227,8 @@ KNOWN ISSUES | ||||
| ------------ | ||||
| 
 | ||||
| -   For bash users, autojump keeps track of directories as a pre-command | ||||
|     hook by modifying $PROMPT\_COMMAND. If you overwrite | ||||
|     $PROMPT\_COMMAND in \~/.bashrc you can cause problems. Don't do | ||||
|     this: | ||||
|     hook by modifying $PROMPT_COMMAND. If you overwrite $PROMPT\_COMMAND | ||||
|     in \~/.bashrc you can cause problems. Don't do this: | ||||
| 
 | ||||
|         export PROMPT_COMMAND="history -a" | ||||
| 
 | ||||
| @ -246,7 +245,7 @@ FILES | ||||
| 
 | ||||
| If installed locally, autojump is self-contained in *\~/.autojump/*. | ||||
| 
 | ||||
| The database is stored in *$XDG\_DATA\_HOME/autojump/autojump.txt*. | ||||
| The database is stored in *\$XDG*DATA\_HOME/autojump/autojump.txt\_. | ||||
| 
 | ||||
| REPORTING BUGS | ||||
| -------------- | ||||
|  | ||||
| @ -1,7 +1,7 @@ | ||||
| .TH autojump 1 "10 April 2012" "release-v20" | ||||
| .TH autojump 1 "10 April 2012" "release\-v20" | ||||
| .SS NAME | ||||
| .PP | ||||
| autojump - a faster way to navigate your filesystem | ||||
| autojump \- a faster way to navigate your filesystem | ||||
| .SS SYNOPSIS | ||||
| .PP | ||||
| Jump to a previously visited directory that contains \[aq]foo\[aq]: | ||||
| @ -24,7 +24,7 @@ Show database entries and their respective key weights: | ||||
| .IP | ||||
| .nf | ||||
| \f[C] | ||||
| j\ --stat | ||||
| j\ \-\-stat | ||||
| \f[] | ||||
| .fi | ||||
| .SS DESCRIPTION | ||||
| @ -40,15 +40,15 @@ wrapper function. | ||||
| .IP | ||||
| .nf | ||||
| \f[C] | ||||
| -i,\ --increase\ \ \ \ \ \ manually\ increase\ current\ directory\ weight | ||||
| \-i,\ \-\-increase\ \ \ \ \ \ manually\ increase\ current\ directory\ weight | ||||
| 
 | ||||
| -d,\ --decrease\ \ \ \ \ \ manually\ decrease\ 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\ general\ stats\ and\ top\ 100\ database\ entries | ||||
| \-s,\ \-\-stat\ \ \ \ \ \ \ \ \ \ show\ general\ stats\ and\ top\ 100\ database\ entries | ||||
| 
 | ||||
| --version\ \ \ \ \ \ \ \ \ \ \ show\ version\ information\ and\ exit | ||||
| \-\-version\ \ \ \ \ \ \ \ \ \ \ show\ version\ information\ and\ exit | ||||
| \f[] | ||||
| .fi | ||||
| .SS ADVANCED USAGE | ||||
| @ -77,7 +77,7 @@ Jump To A Child Directory. | ||||
| .RS 2 | ||||
| .PP | ||||
| Sometimes it\[aq]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 | ||||
| name. | ||||
| .IP | ||||
| .nf | ||||
| @ -119,17 +119,17 @@ autojump: | ||||
| .IP | ||||
| .nf | ||||
| \f[C] | ||||
| autoload\ -U\ compinit\ &&\ compinit | ||||
| autoload\ \-U\ compinit\ &&\ compinit | ||||
| \f[] | ||||
| .fi | ||||
| .PP | ||||
| For security compinit checks completion system if files will be owned by | ||||
| root or the current user. | ||||
| This check can be ignored by using the -u flag: | ||||
| This check can be ignored by using the \-u flag: | ||||
| .IP | ||||
| .nf | ||||
| \f[C] | ||||
| autoload\ -U\ compinit\ &&\ compinit\ -u | ||||
| autoload\ \-U\ compinit\ &&\ compinit\ \-u | ||||
| \f[] | ||||
| .fi | ||||
| .PP | ||||
| @ -190,15 +190,16 @@ Changes require reloading autojump to take into effect. | ||||
| .RE | ||||
| .SS KNOWN ISSUES | ||||
| .IP \[bu] 2 | ||||
| For bash users, autojump keeps track of directories as a pre-command | ||||
| hook by modifying $PROMPT_COMMAND. | ||||
| If you overwrite $PROMPT_COMMAND in ~/.bashrc you can cause problems. | ||||
| For bash users, autojump keeps track of directories as a pre\-command | ||||
| hook by modifying | ||||
| \f[I]P\f[]\f[I]R\f[]\f[I]O\f[]\f[I]M\f[]\f[I]P\f[]\f[I]T\f[]~\f[I]C\f[]~\f[I]O\f[]\f[I]M\f[]\f[I]M\f[]\f[I]A\f[]\f[I]N\f[]\f[I]D\f[]. \f[I]I\f[]\f[I]f\f[]\f[I]y\f[]\f[I]o\f[]\f[I]u\f[]\f[I]o\f[]\f[I]v\f[]\f[I]e\f[]\f[I]r\f[]\f[I]w\f[]\f[I]r\f[]\f[I]i\f[]\f[I]t\f[]\f[I]e\f[]PROMPT_COMMAND | ||||
| in ~/.bashrc you can cause problems. | ||||
| Don\[aq]t do this: | ||||
| .RS 2 | ||||
| .IP | ||||
| .nf | ||||
| \f[C] | ||||
| export\ PROMPT_COMMAND="history\ -a" | ||||
| export\ PROMPT_COMMAND="history\ \-a" | ||||
| \f[] | ||||
| .fi | ||||
| .PP | ||||
| @ -206,21 +207,21 @@ Do this: | ||||
| .IP | ||||
| .nf | ||||
| \f[C] | ||||
| export\ PROMPT_COMMAND="${PROMPT_COMMAND:+$PROMPT_COMMAND\ ;}\ history\ -a" | ||||
| export\ PROMPT_COMMAND="${PROMPT_COMMAND:+$PROMPT_COMMAND\ ;}\ history\ \-a" | ||||
| \f[] | ||||
| .fi | ||||
| .RE | ||||
| .IP \[bu] 2 | ||||
| The jump function \f[C]j\f[] does not support directories that begin | ||||
| with \f[C]-\f[]. | ||||
| If you want to jump a directory called \f[C]--music\f[], try using | ||||
| \f[C]j\ music\f[] instead of \f[C]j\ \ \ --music\f[]. | ||||
| with \f[C]\-\f[]. | ||||
| If you want to jump a directory called \f[C]\-\-music\f[], try using | ||||
| \f[C]j\ music\f[] instead of \f[C]j\ \ \ \-\-music\f[]. | ||||
| .SS FILES | ||||
| .PP | ||||
| If installed locally, autojump is self-contained in | ||||
| 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[]. | ||||
| The database is stored in \f[I]$XDG\f[]DATA_HOME/autojump/autojump.txt_. | ||||
| .SS REPORTING BUGS | ||||
| .PP | ||||
| For any usage related issues or feature requests please visit: | ||||
| @ -228,7 +229,7 @@ For any usage related issues or feature requests please visit: | ||||
| \f[I]https://github.com/joelthelion/autojump/issues\f[] | ||||
| .SS THANKS | ||||
| .PP | ||||
| Special thanks goes out to: Pierre Gueth, Simon Marache-Francisco, | ||||
| Special thanks goes out to: Pierre Gueth, Simon Marache\-Francisco, | ||||
| Daniel Jackoway, and many others. | ||||
| .SS AUTHORS | ||||
| .PP | ||||
|  | ||||
		Loading…
	
		Reference in New Issue
	
	Block a user