From 729a2265e09a6c646fec6d539c27ffa14ac8407d Mon Sep 17 00:00:00 2001
From: Eric Wong <normalperson@yhbt.net>
Date: Sun, 26 Jul 2009 22:18:48 -0700
Subject: [PATCH] INSTALL is Markdown and thus Pandoc-able

---
 INSTALL  | 32 ++++++++++++++++++--------------
 Makefile |  7 +++++--
 2 files changed, 23 insertions(+), 16 deletions(-)

diff --git a/INSTALL b/INSTALL
index 011e178..344a7ad 100644
--- a/INSTALL
+++ b/INSTALL
@@ -4,34 +4,38 @@ Installing page cache utilities
 Dependencies
 ------------
 
-These utilities are dependent on the posix_fadvise and mincore syscalls.
+These utilities are dependent on the
+[posix_fadvise(2)](http://linux.die.net/man/2/posix_fadvise) and
+[mincore(2)](http://linux.die.net/man/2/mincore) syscalls.
 
-pcu-fadvise needs a kernel that supports the posix_fadvise(2) syscall and C
-library support.  For GNU/Linux systems, this means you'll need a kernel
-newer than 2.5.60 and the GNU C library 2.2 or later.
+pcu-fadvise needs a kernel that supports the
+[posix_fadvise(2)](http://linux.die.net/man/2/posix_fadvise) and syscall
+and C library support.  For GNU/Linux systems, this means you'll need a
+kernel newer than 2.5.60 and the GNU C library 2.2 or later.
 
-pcu-mincore should work on most somewhat-modern UNIX/UNIX-like kernels that
-support the mincore(2) system call.  While the mincore(2) system call is not
-specified by current versions of POSIX, it is fairly common.
+pcu-mincore should work on most somewhat-modern UNIX/UNIX-like kernels
+that support the [mincore(2)](http://linux.die.net/man/2/mincore) system
+call.  While the [mincore(2)](http://linux.die.net/man/2/mincore) system
+call is not specified by current versions of POSIX, it is fairly common.
 
 Standard build tools such as a C compiler, GNU make, install are required.
 
-If you wish to build and install the manpages, you'll also need the txt2man
-utility available here: http://mvertes.free.fr/download/
-The documentation is otherwise viewable in plain text form.
+If you wish to build and install the manpages or HTML documentation,
+you'll also need [Pandoc](http://johnmacfarlane.net/pandoc/).  The
+documentation is otherwise viewable as Markdown.
 
 Instructions
 ------------
 
 To install executables into your home directory in ~/bin:
 
-  $ make
-  $ make install
+    $ make
+    $ make install
 
 To install executables globally in /usr/local/bin:
 
-  $ make ; # as yourself
-  # make install prefix=/usr/local/bin ; # as root
+    $ make ; # as yourself
+    # make install prefix=/usr/local/bin ; # as root
 
 All pcu-* executables are relocatable and have no dependencies outside
 of the system C library and kernel support for the syscalls they need.
diff --git a/Makefile b/Makefile
index d7daceb..48d18bf 100644
--- a/Makefile
+++ b/Makefile
@@ -52,7 +52,7 @@ install-strip: strip
 	mv $@+ $@
 
 man1 := $(addsuffix .1,$(PCU_BIN))
-html := index.html $(addsuffix .html, $(man1))
+html := index.html INSTALL.html $(addsuffix .html, $(man1))
 html: $(html)
 man: $(man1)
 doc: html man
@@ -69,8 +69,11 @@ clean:
 	$(RM) $(PCU_BIN) $(DISTNAME).tar.gz* GIT-VERSION-FILE
 	$(RM) $(man1) $(html)
 
-index.html: title = $(shell sed -ne 1p < $<)
+INSTALL.html index.html: title = $(shell sed -ne 1p < $<)
+INSTALL.html: INSTALL
 index.html: README
+
+index.html INSTALL.html:
 	$(pandoc_html) -T "$(title)" < $< > $@+
 	mv $@+ $@
 
-- 
2.11.4.GIT