split up doc building for manpage and readme.md

12 years ago · f91c7e3954
parent 168865f138
commit f91c7e3954
5 changed files with 107 additions and 113 deletions
--- a/4
+++ b/4
@ -10,8 +10,8 @@ uninstall:
 	uninstall.sh

 docs:
-	pandoc -s -w man docs/manpage.md -o docs/autojump.1
-	pandoc -s -w markdown docs/manpage.md docs/install.md -o README.md
+	pandoc -s -w man docs/manpage_header.md docs/header.md docs/manpage.md -o docs/autojump.1
+	pandoc -s -w markdown docs/header.md docs/install.md docs/manpage.md -o README.md

 release:
 	# Check for tag existence
--- a/README.md
+++ b/README.md
@ -1,7 +1,3 @@
-% autojump(1) release-v20
-% 
-% 10 April 2012
-
 NAME
 ----

@ -27,92 +23,6 @@ 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 must be passed to 'autojump' and not the 'j' wrapper function.
-
-    -a, --add DIR       manually add path to database
-
-    --stat              show database entries and their key weights
-
-    --version           show version information and exit
-
-INTERNAL OPTIONS
----------------
-
-    -b, --bash          enclose directory with quotes to prevent errors
-
-    --completion        prevent key weight decay over time
-
-ADVANCED USAGE
--------------
-
-   Prefer Symbolic Links
-
-    Default behavior is to evaluate symbolic links into full paths as to
-    reduce duplicate entries in the database. However, some users prefer
-    a shorter working directory path in their shell prompt. To switch
-    behavior to prefer symbolic links, export the following
-    configuration in your \~/.bashrc:
-
-        export AUTOJUMP_KEEP_SYMLINKS=1
-
-   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
------------
-
-   zsh (bug \#86)
-
-    Tab completion does not work.
-
-   jumpapplet (bug \#59)
-
-    Does not work in Gnome 3 shell or LDXE.
-
-FILES
-----
-
-If installed locally, autojump is self-contained in *\~/.autojump/*.
-
-The database is stored in *$XDG\_DATA\_HOME/autojump/autojump.txt*.
-
-REPORTING BUGS
--------------
-
-For any issues please visit the following URL:
-
-*https://github.com/joelthelion/autojump/issues*
-
-THANKS
------
-
-Special thanks goes out to: Pierre Gueth, Simon Marache-Francisco,
-Daniel Jackoway, and many others.
-
-AUTHORS
-------
-
-autojump was originally written by Joël Schaerer, and currently
-maintained by William Ting.
-
-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
 ------------

@ -198,3 +108,89 @@ and follow on screen instructions.

 If you keep getting `autojump: command not found` at the prompt,
 do:`unset PROMPT_COMMAND`. You can also restart your shell.
+
+OPTIONS
+-------
+
+Options must be passed to 'autojump' and not the 'j' wrapper function.
+
+    -a, --add DIR       manually add path to database
+
+    --stat              show database entries and their key weights
+
+    --version           show version information and exit
+
+INTERNAL OPTIONS
+----------------
+
+    -b, --bash          enclose directory with quotes to prevent errors
+
+    --completion        prevent key weight decay over time
+
+ADVANCED USAGE
+--------------
+
+-   Prefer Symbolic Links
+
+    Default behavior is to evaluate symbolic links into full paths as to
+    reduce duplicate entries in the database. However, some users prefer
+    a shorter working directory path in their shell prompt. To switch
+    behavior to prefer symbolic links, export the following
+    configuration in your \~/.bashrc:
+
+        export AUTOJUMP_KEEP_SYMLINKS=1
+
+-   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
+------------
+
+-   zsh (bug \#86)
+
+    Tab completion does not work.
+
+-   jumpapplet (bug \#59)
+
+    Does not work in Gnome 3 shell or LDXE.
+
+FILES
+-----
+
+If installed locally, autojump is self-contained in *\~/.autojump/*.
+
+The database is stored in *$XDG\_DATA\_HOME/autojump/autojump.txt*.
+
+REPORTING BUGS
+--------------
+
+For any issues please visit the following URL:
+
+*https://github.com/joelthelion/autojump/issues*
+
+THANKS
+------
+
+Special thanks goes out to: Pierre Gueth, Simon Marache-Francisco,
+Daniel Jackoway, and many others.
+
+AUTHORS
+-------
+
+autojump was originally written by Joël Schaerer, and currently
+maintained by William Ting.
+
+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.
--- a/docs/header.md
+++ b/docs/header.md
@ -0,0 +1,16 @@
+## NAME
+
+autojump - a faster way to navigate your filesystem
+
+## SYNOPSIS
+Jump to a previously visited directory 'foobar':
+
+    j foo
+
+Show all database entries and their respective key weights:
+
+    jumpstat
+
+## 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 jumpstat command shows you the current contents of the database. Directories must be visited first before they can be jumped to.
--- a/docs/manpage.md
+++ b/docs/manpage.md
@ -1,24 +1,3 @@
-% autojump(1) release-v20
-%
-% 10 April 2012
-
-## NAME
-
-autojump - a faster way to navigate your filesystem
-
-## SYNOPSIS
-Jump to a previously visited directory 'foobar':
-
-    j foo
-
-Show all database entries and their respective key weights:
-
-    jumpstat
-
-## 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 jumpstat command shows you the current contents of the database. Directories must be visited first before they can be jumped to.
-
 ## OPTIONS

 Options must be passed to 'autojump' and not the 'j' wrapper function.
--- a/docs/manpage_header.md
+++ b/docs/manpage_header.md
@ -0,0 +1,3 @@
+% autojump(1) release-v20
+%
+% 10 April 2012