summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2010-01-01 02:13:17 +0200
committerLars Wirzenius <liw@liw.fi>2010-01-01 02:13:17 +0200
commit01c25cc823a459196524cd7202c7c3c567ccddd8 (patch)
tree382eada5e35c3e20d2f4f18895a6a2fa2f4d870d
downloadsummain-01c25cc823a459196524cd7202c7c3c567ccddd8.tar.gz
Wrote manual page, first draft.
-rw-r--r--summain.134
1 files changed, 34 insertions, 0 deletions
diff --git a/summain.1 b/summain.1
new file mode 100644
index 0000000..3c37311
--- /dev/null
+++ b/summain.1
@@ -0,0 +1,34 @@
+.TH SUMMAIN 1
+.SH NAME
+summain \- gather file checksums and metadata
+.SH SYNOPSIS
+.B summain
+.RI [ file ...]
+.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
+Sha-1: 1234123413241324
+Mtime: 2010-01-01 02:08:00 +0200
+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
+Directories named on the command line will be recursed automatically.