summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2013-11-11 21:15:16 +0000
committerLars Wirzenius <liw@liw.fi>2013-11-11 21:15:16 +0000
commit56e992a974a82ef9a7569c40874aca5dee694d23 (patch)
treec31bf9ee5188611c2ba367d63a5fc9a4c3fdd771
parentd4c62edac4cb9a7f6eeee14a0e3b2cc22d1fd349 (diff)
downloadsummain-56e992a974a82ef9a7569c40874aca5dee694d23.tar.gz
Add an example to the manpage
-rw-r--r--summain.1.in19
1 files changed, 18 insertions, 1 deletions
diff --git a/summain.1.in b/summain.1.in
index 41397e1..39cfb80 100644
--- a/summain.1.in
+++ b/summain.1.in
@@ -43,4 +43,21 @@ The numbers are reported so that hard links can be checked.
.PP
Directories named on the command line will be recursed automatically.
.SH OPTIONS
-
+.SH EXAMPLE
+To make a complete manifest of a directory tree so that you can later
+verify that nothing at all has changed:
+.PP
+.nf
+.RS
+summain foo > foo.summain
+.RE
+.fi
+.PP
+To verify that nothing has changed:
+.PP
+.nf
+.RS
+summain foo > foo.summain-2
+diff -u foo.summain foo.summain-2
+.RE
+.fi