Add simple manpage for 'swordfish' binary.

Signed-off-by: Chris Lamb <chris@playfire.com>
lamby · Apr 15, 2009 · 60469cf · 60469cf
1 parent 3d0b719
commit 60469cf
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 2 deletions.
diff --git a/Makefile.am b/Makefile.am
@@ -1 +1 @@
-SUBDIRS = src
+SUBDIRS = src man
diff --git a/configure.ac b/configure.ac
@@ -139,4 +139,4 @@ AC_PROG_CC
 
 AC_MSG_NOTICE([Using CFLAGS="$CFLAGS"])
 AC_MSG_NOTICE([Using LIBS="$LIBS"])
-AC_OUTPUT(Makefile src/Makefile)
+AC_OUTPUT(Makefile src/Makefile man/Makefile)
diff --git a/man/Makefile.am b/man/Makefile.am
@@ -0,0 +1,2 @@
+man_MANS = swordfish.1
+EXTRA_DIST = $(man_MANS)
diff --git a/man/swordfish.1 b/man/swordfish.1
@@ -0,0 +1,16 @@
+.TH SWORDFISH 1 "April 14, 2009"
+.SH NAME
+swordfish \- high-level persistent key-value database
+.SH SYNOPSIS
+.B sworfish
+.SH DESCRIPTION
+Swordfish is a key-value database for primarily storing and processing sorted
+sets (or "trees"). It is intended to supplement a relational database such as
+MySQL.
+.PP
+It can be interfaced from any language with a HTTP client.
+.SH OPTIONS
+.IP "configfile"
+Read options from specified configuration file.
+.SH AUTHOR
+\fBswordfish\fP was written by Chris Lamb <chris@playfire.com>.