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

ran make_doc.sh

This commit is contained in:
Johnny Kuan 2012-04-12 02:39:15 -04:00
parent 2cfd91bf72
commit 9e2a28ed77
2 changed files with 15 additions and 28 deletions

View File

@ -2,13 +2,11 @@
%
% 10 April 2012
NAME
----
## NAME
autojump - a faster way to navigate your filesystem
SYNOPSIS
--------
## SYNOPSIS
Jump to a previously visited directory 'foobar':
@ -18,8 +16,7 @@ Show all database entries and their respective key weights:
jumpstat
DESCRIPTION
-----------
## 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
@ -27,8 +24,7 @@ command line. The jumpstat command shows you the current contents of the
database. Directories must be visited first before they can be jumped
to.
OPTIONS
-------
## OPTIONS
Options must be passed to 'autojump' and not the 'j' wrapper function.
@ -38,15 +34,13 @@ Options must be passed to 'autojump' and not the 'j' wrapper function.
--version show version information and exit
INTERNAL OPTIONS
----------------
## INTERNAL OPTIONS
-b, --bash enclose directory with quotes to prevent errors
--completion prevent key weight decay over time
ADVANCED USAGE
--------------
## ADVANCED USAGE
- Prefer Symbolic Links
@ -68,42 +62,36 @@ ADVANCED USAGE
All negative key weights are purged automatically.
FILES
-----
## FILES
If installed locally, autojump is self-contained in *\~/.autojump/*.
The database is stored in *$XDG\_DATA\_HOME/autojump/autojump.txt*.
REPORTING BUGS
--------------
## REPORTING BUGS
For any issues please visit the following URL:
*https://github.com/joelthelion/autojump/issues*
THANKS
------
## THANKS
Special thanks goes out to: Pierre Gueth, Simon Marache-Francisco,
Daniel Jackoway, and many others.
AUTHORS
-------
## AUTHORS
autojump was originally written by Joël Schaerer, and currently
maintained by William Ting.
COPYRIGHT
---------
## COPYRIGHT
Copyright © 2012 Free Software Foundation, Inc. License GPLv3+: GNU GPL
version 3 or later <http://gnu.org/licenses/gpl.html>. This is free
software: you are free to change and redistribute it. There is NO
WARRANTY, to the extent permitted by law.
INSTALLATION
------------
## INSTALLATION
### REQUIREMENTS

View File

@ -4,7 +4,7 @@
autojump - a faster way to navigate your filesystem
.SS SYNOPSIS
.PP
Jump to a previously visited directory \[aq]foobar\[aq]:
Jump to a previously visited directory `foobar':
.IP
.nf
\f[C]
@ -28,8 +28,7 @@ The jumpstat command shows you the current contents of the database.
Directories must be visited first before they can be jumped to.
.SS OPTIONS
.PP
Options must be passed to \[aq]autojump\[aq] and not the \[aq]j\[aq]
wrapper function.
Options must be passed to `autojump' and not the `j' wrapper function.
.IP
.nf
\f[C]
@ -71,7 +70,7 @@ export\ AUTOJUMP_KEEP_SYMLINKS=1
Change Directory Weight
.RS 2
.PP
To manually change a directory\[aq]s key weight, you can edit the file
To manually change a directory'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: