From 9c93923501fec41aff7b6361d82014d535298d42 Mon Sep 17 00:00:00 2001
From: Chris Frey <cdfrey@foursquare.net>
Date: Thu, 2 Dec 2010 13:23:18 -0500
Subject: [PATCH] doc: clarified btardump help, and added btardump.1 manpage

---
 ChangeLog         |  2 ++
 man/Makefile.am   |  1 +
 man/btardump.1    | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 tools/btardump.cc |  2 ++
 4 files changed, 52 insertions(+)
 create mode 100644 man/btardump.1

diff --git a/ChangeLog b/ChangeLog
index 11488b7d..dcdc7c21 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,7 @@
 Release: version 0.17.0 - 2010/01/??
 ------------------------------------------------------------------------------
+2010/12/02
+	- doc: clarified btardump help, and added btardump.1 manpage
 2010/11/30
 	- lib: fixed but in Messages parser, which used CheckSize()
 		inappropriately
diff --git a/man/Makefile.am b/man/Makefile.am
index 2504d7d3..f336e97a 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -1,6 +1,7 @@
 dist_man_MANS = \
 	bcharge.1 \
 	btool.1 \
+	btardump.1 \
 	bfuse.1 \
 	bjavaloader.1 \
 	bjdwp.1 \
diff --git a/man/btardump.1 b/man/btardump.1
new file mode 100644
index 00000000..52f8f58b
--- /dev/null
+++ b/man/btardump.1
@@ -0,0 +1,47 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH BTARDUMP 1 "December 2, 2010"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+.B btardump
+\- Command line parser for Barry backup files
+.SH SYNOPSIS
+.B btardump
+[-d db][-h] filename [filenames...]
+.SH DESCRIPTION
+.PP
+.B btardump
+takes one or more Barry backup tar files on the command line, and
+dumps parsed database records to stdout.  By default, all records
+are dumped, but this can be limited by the -d option.
+.SH OPTIONS
+.TP
+.B \-d db
+Name of database to dump to stdout.  Can be used multiple times
+to parse multiple databases at once.  If not specified, all available
+databases from the backup file are dumped.
+.TP
+.B \-h, \-\-help
+Show summary of options.
+
+.SH AUTHOR
+.nh
+.B btardump
+is part of the Barry project.
+.SH SEE ALSO
+.PP
+http://www.netdirect.ca/barry
+
diff --git a/tools/btardump.cc b/tools/btardump.cc
index 27fca78c..c8c63c6c 100644
--- a/tools/btardump.cc
+++ b/tools/btardump.cc
@@ -43,6 +43,8 @@ void Usage()
    << "             at all, all available databases from the backup are\n"
    << "             dumped.\n"
    << "   -h        This help\n"
+   << "\n"
+   << "   [files...] Backup file(s), created by btool or the backup GUI.\n"
    << endl;
 }
 
-- 
2.11.4.GIT