summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Makefile7
-rw-r--r--summain.1.in (renamed from summain.1)45
2 files changed, 7 insertions, 45 deletions
diff --git a/Makefile b/Makefile
index 4db3341..3d07544 100644
--- a/Makefile
+++ b/Makefile
@@ -14,11 +14,14 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
-all:
+all: summain.1
+
+summain.1: summain.1.in
+ python summain --generate-manpage=summain.1.in > summain.1
check:
python -m CoverageTestRunner
rm .coverage
clean:
- rm -f *.pyc .coverage
+ rm -f *.pyc .coverage summain.1
diff --git a/summain.1 b/summain.1.in
index 90ccb01..7f53734 100644
--- a/summain.1
+++ b/summain.1.in
@@ -2,13 +2,6 @@
.SH NAME
summain \- gather file checksums and metadata
.SH SYNOPSIS
-.B summain
-.RB [ \-m ]
-.RB [ \-\-mangle\-paths ]
-.RB [ \-r ]
-.RB [ \-\-relative\-paths ]
-.RB [ \-\-exclude =\fIFIELD\fR]
-.RI [ file ...]
.SH DESCRIPTION
.B summain
gathers metadata about files,
@@ -24,7 +17,7 @@ The manifest looks like this:
.IP
.nf
Name: foo/bar/foobar
-Sha-1: 1234123413241324
+SHA1: 1234123413241324
Mtime: 2010-01-01 02:08:00.127651 +0000
Mode: 1755
.fi
@@ -50,38 +43,4 @@ The numbers are reported so that hard links can be checked.
.PP
Directories named on the command line will be recursed automatically.
.SH OPTIONS
-.TP
-.BR \-r ", " \-\-relative\-paths
-Print pathnames relative to the command line argument they derive from.
-If the command line argument is the directory called
-.I foo
-and there is a file called
-.IR bar ,
-normally
-.I foo/bar
-is printed as the name.
-With this option,
-.I bar
-is printed instead.
-This can be handy for normalizing the paths for comparing two copies of the
-same directory tree in two different locations on disk:
-run
-.B summain
-on both,
-and compare the output with
-.BR diff (1).
-.TP
-.BR \-m ", " \-\-mangle\-paths
-Mangle or obfuscate all paths in the output.
-This is good if you need to share the output with someone else,
-and your filenames may contain sensitive information,
-such a client names.
-.TP
-.BR \-\-exclude =\fIFIELD
-Don't write out the given
-.IR FIELD .
-Can be given multiple times.
-The field value is also not computed,
-so excluding the
-.I SHA-1
-field will result in much speedup.
+