From fe3982fa1a3c297697184192c7f9e705b75a9e3c Mon Sep 17 00:00:00 2001
From: Gard Spreemann <gspreemann@gmail.com>
Date: Wed, 30 Jan 2019 15:10:13 +0100
Subject: Man page for phat utility.

---
 debian/phat-utils.manpages |  1 +
 debian/phat.1              | 40 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 41 insertions(+)
 create mode 100644 debian/phat-utils.manpages
 create mode 100644 debian/phat.1

diff --git a/debian/phat-utils.manpages b/debian/phat-utils.manpages
new file mode 100644
index 0000000..135ffdc
--- /dev/null
+++ b/debian/phat-utils.manpages
@@ -0,0 +1 @@
+debian/phat.1
diff --git a/debian/phat.1 b/debian/phat.1
new file mode 100644
index 0000000..61478e9
--- /dev/null
+++ b/debian/phat.1
@@ -0,0 +1,40 @@
+.TH PHAT 1
+.SH NAME
+phat \- persistent homology utility from the PHAT library
+.SH SYNOPSIS
+.B phat
+[\fIoptions\fR]
+\fIinput_file\fR
+\fIoutput_file\fR
+.SH DESCRIPTION
+.B phat
+is a simple persistent homology utility built using the PHAT
+library. It reads a (filtered) boundary matrix and applies an
+algorithm of the user's choosing to compute the associated persistent
+homology module.
+.SH OPTIONS
+.TP
+.BR \-\-ascii
+Use ASCII input file.
+.TP
+.BR \-\-binary
+Use binary input file (default).
+.TP
+.BR \-\-help
+Print help screen.
+.TP
+.BR \-\-dualize
+Use dualization approach.
+.TP
+.BR \-\-vector_vector ", " \-\-vector_heap ", " \-\-vector_set ", " \-\-vector_list ", " \-\-full_pivot_column ", " \-\-sparse_pivot_column ", " \-\-heap_pivot_column ", " \-\-bit_tree_pivot_column
+Choose a matrix representation. Default is \fB\-\-bit_tree_pivot_column\fR.
+.TP
+.BR --standard ", " \-\-twist ", " \-\-chunk ", " \-\-chunk_sequential ", " \-\-spectral_sequence ", " \-\-row
+Choose a reduction algorithm. Default is \fB\-\-twist\fR.
+.SH ARGUMENTS
+.TP
+.BR input_file
+Input boundary matrix file.
+.TP
+.BR output_file
+Output file for persistence diagram.
-- 
cgit v1.2.3