Add extra cleanup sauce to buildgen.sh for gettext mess
[barry.git] / man / brecsum.1
blob73fe66e82128e68e38aa6f8c6f7c46dc39f164f0
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH BRECSUM 1 "May 29, 2008"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh        disable hyphenation
10 .\" .hy        enable hyphenation
11 .\" .ad l      left justify
12 .\" .ad b      justify to both left and right margins
13 .\" .nf        disable filling
14 .\" .fi        enable filling
15 .\" .br        insert line break
16 .\" .sp <n>    insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 .B brecsum
20 \- Generate SHA1 sums of raw Blackberry database records.
21 .SH SYNOPSIS
22 .B brecsum
23 [-d db][-h][-p pin][-P pass][-v]
24 .SH DESCRIPTION
25 .PP
26 .B brecsum
27 downloads the specified database(s) and computes a SHA1 checksum on
28 each raw record it finds.  The SHA1 sums are written to stdout.
30 This is mainly useful for verifying the integrity of restored data
31 during testing.
32 .SH OPTIONS
33 .TP
34 .B \-d db
35 Specify the database to download and sum.  This option may be given
36 multiple times to fetch more than one database.  See btool's \-t
37 option to retrieve a list of databases on your device.
38 .TP
39 .B \-p pin
40 Specify the PIN of the device to talk to.  Only needed if there are
41 multiple Blackberries plugged into your system at once.
42 .TP
43 .B \-P pass
44 Simplistic method to specify device password.  In a real application, this
45 would be done using a more secure prompt.
46 .TP
47 .B \-v
48 Dump verbose protocol data during operation.
49 .TP
50 .B \-h, \-\-help
51 Show summary of options.
54 .SH RETURN STATUS
55 In the event of a fatal error, the message will be written to stderr,
56 with an error code of 1.
59 .SH AUTHOR
60 .nh
61 .B brecsum
62 is part of the Barry project.
63 This manual page was written by Chris Frey.
64 .SH SEE ALSO
65 .PP
66 http://www.netdirect.ca/software/packages/barry