mirror of
				https://github.com/wting/autojump
				synced 2025-06-13 12:54:07 +00:00 
			
		
		
		
	update documentation
This commit is contained in:
		
							parent
							
								
									96a2206931
								
							
						
					
					
						commit
						e21292e573
					
				| @ -211,7 +211,7 @@ class Database: | ||||
| def set_defaults(): | ||||
|     config = {} | ||||
| 
 | ||||
|     config['version'] = 'release-v21.6.1' | ||||
|     config['version'] = 'release-v21.6.2' | ||||
|     config['max_weight'] = 1000 | ||||
|     config['max_paths'] = 1000 | ||||
|     config['separator'] = '__' | ||||
|  | ||||
							
								
								
									
										28
									
								
								docs/body.md
									
									
									
									
									
								
							
							
						
						
									
										28
									
								
								docs/body.md
									
									
									
									
									
								
							| @ -2,11 +2,13 @@ | ||||
| 
 | ||||
| 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 | ||||
| 
 | ||||
| @ -25,7 +27,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 name. | ||||
| @ -43,12 +45,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 | ||||
| ------------------------ | ||||
| 
 | ||||
| @ -64,6 +60,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 | ||||
| @ -102,16 +102,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 | ||||
| 
 | ||||
| - For bash users, autojump keeps track of directories as a pre-command hook by | ||||
|  | ||||
| @ -3,21 +3,21 @@ | ||||
| autojump - a faster way to navigate your filesystem | ||||
| 
 | ||||
| ## SYNOPSIS | ||||
| 
 | ||||
| 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 | ||||
| 
 | ||||
| ## 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 jumped to. | ||||
| database of the directories you use the most from the command line. Directories | ||||
| must be visited first before they can be jumped to. | ||||
|  | ||||
		Loading…
	
		Reference in New Issue
	
	Block a user