Fill in manpage SYNOPSIS and OPTIONS using cliapp magic.

1 files changed, 46 insertions, 0 deletions

diff --git a/summain.1.in b/summain.1.in
new file mode 100644
index 0000000..7f53734
--- /dev/null
+++ b/summain.1.in
@@ -0,0 +1,46 @@
+.TH SUMMAIN 1
+.SH NAME
+summain \- gather file checksums and metadata
+.SH SYNOPSIS
+.SH DESCRIPTION
+.B summain
+gathers metadata about files,
+and computes their checksums.
+It is inteded to create a 
+.I manifest
+of the files.
+The manifest can be used to see if something has changed:
+a new manfest can be created and compared with the old one with
+.BR diff (1).
+.PP
+The manifest looks like this:
+.IP
+.nf
+Name: foo/bar/foobar
+SHA1: 1234123413241324
+Mtime: 2010-01-01 02:08:00.127651 +0000
+Mode: 1755
+.fi
+.PP
+The filename is URL-encoded to ensure it is purely ASCII.
+Mode is in octal.
+.PP
+Only some inode fields are included.
+It does not make sense to compare, for example, the access time,
+so that is not included.
+.PP
+Time stamps are given using microsecond precision,
+for the benefit of those filesystems that can support precise timestamps.
+(Should be nanosecond, but Python return timestamps as floating point,
+and nanosecond precision is too much for the floating point type.)
+.PP
+The inode and device number fields will not be reported accurately.
+Instead, they are normalized so that manifests are useful after the files
+have been restored from backups.
+Accurate numbers would mean everything seems to have changed.
+Normalized means that there will be no differences.
+The numbers are reported so that hard links can be checked.
+.PP
+Directories named on the command line will be recursed automatically.
+.SH OPTIONS
+