From 9e2a28ed77506d778a6a17ccfcefbe4766968c80 Mon Sep 17 00:00:00 2001 From: Johnny Kuan Date: Thu, 12 Apr 2012 02:39:15 -0400 Subject: [PATCH 1/3] ran make_doc.sh --- README.md | 36 ++++++++++++------------------------ autojump.1 | 7 +++---- 2 files changed, 15 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 1c0cda0..01f8913 100644 --- a/README.md +++ b/README.md @@ -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 . 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 diff --git a/autojump.1 b/autojump.1 index 5f036ca..acdfb47 100644 --- a/autojump.1 +++ b/autojump.1 @@ -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: From 1c7b930d9f11ed3a71934d862c48a5b2eefacc8e Mon Sep 17 00:00:00 2001 From: Johnny Kuan Date: Thu, 12 Apr 2012 02:40:18 -0400 Subject: [PATCH 2/3] Macports command instead of link to Portfile --- INSTALL.md | 4 +++- README.md | 5 +++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index be3298b..6387104 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -28,7 +28,9 @@ Homebrew is the recommended installation method for Mac OS X:: brew install autojump -A MacPorts installation method is also [available](https://trac.macports.org/browser/trunk/dports/sysutils/autojump/Portfile). +MacPorts also available:: + + port install autojump **Other** diff --git a/README.md b/README.md index 01f8913..d1aebdf 100644 --- a/README.md +++ b/README.md @@ -123,8 +123,9 @@ Homebrew is the recommended installation method for Mac OS X:: brew install autojump -A MacPorts installation method is also -[available](https://trac.macports.org/browser/trunk/dports/sysutils/autojump/Portfile). +MacPorts also available:: + + port install autojump **Other** From 3a767d1d9c14dbacfddc2db6be947567fdf63fc9 Mon Sep 17 00:00:00 2001 From: William Ting Date: Wed, 11 Apr 2012 22:31:36 -1000 Subject: [PATCH 3/3] remove leftover syntax when docs were in ReST format --- INSTALL.md | 8 ++++---- README.md | 44 ++++++++++++++++++++++++++++---------------- autojump.1 | 7 ++++--- 3 files changed, 36 insertions(+), 23 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 6387104..5dc1012 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -24,11 +24,11 @@ autojump is included in the following distro repositories, please use relevant p **Mac** -Homebrew is the recommended installation method for Mac OS X:: +Homebrew is the recommended installation method for Mac OS X: brew install autojump -MacPorts also available:: +MacPorts also available: port install autojump @@ -38,11 +38,11 @@ Please check the [Wiki](https://github.com/joelthelion/autojump/wiki) for an up ### MANUAL INSTALLATION -Grab a copy of autojump:: +Grab a copy of autojump: git clone git://github.com/joelthelion/autojump.git -Run the installation script:: +Run the installation script: cd autojump ./install.sh [ --local ] [ --zsh ] diff --git a/README.md b/README.md index d1aebdf..5f14f9a 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,13 @@ % % 10 April 2012 -## NAME +NAME +---- autojump - a faster way to navigate your filesystem -## SYNOPSIS +SYNOPSIS +-------- Jump to a previously visited directory 'foobar': @@ -16,7 +18,8 @@ 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 @@ -24,7 +27,8 @@ 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. @@ -34,13 +38,15 @@ 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 @@ -62,36 +68,42 @@ Options must be passed to 'autojump' and not the 'j' wrapper function. 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 . 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 @@ -119,11 +131,11 @@ etc): **Mac** -Homebrew is the recommended installation method for Mac OS X:: +Homebrew is the recommended installation method for Mac OS X: brew install autojump -MacPorts also available:: +MacPorts also available: port install autojump @@ -134,11 +146,11 @@ for an up to date listing of installation methods. ### MANUAL INSTALLATION -Grab a copy of autojump:: +Grab a copy of autojump: git clone git://github.com/joelthelion/autojump.git -Run the installation script:: +Run the installation script: cd autojump ./install.sh [ --local ] [ --zsh ] diff --git a/autojump.1 b/autojump.1 index acdfb47..5f036ca 100644 --- a/autojump.1 +++ b/autojump.1 @@ -4,7 +4,7 @@ autojump - a faster way to navigate your filesystem .SS SYNOPSIS .PP -Jump to a previously visited directory `foobar': +Jump to a previously visited directory \[aq]foobar\[aq]: .IP .nf \f[C] @@ -28,7 +28,8 @@ 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 `autojump' and not the `j' wrapper function. +Options must be passed to \[aq]autojump\[aq] and not the \[aq]j\[aq] +wrapper function. .IP .nf \f[C] @@ -70,7 +71,7 @@ export\ AUTOJUMP_KEEP_SYMLINKS=1 Change Directory Weight .RS 2 .PP -To manually change a directory's key weight, you can edit the file +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: