man/brecsum.1

   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.
  29
  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 \-i
  40 Include DB Name, Type, and Unique record IDs in the checksums.
  41 .TP
  42 .B \-p pin
  43 Specify the PIN of the device to talk to.  Only needed if there are
  44 multiple Blackberries plugged into your system at once.
  45 .TP
  46 .B \-P pass
  47 Simplistic method to specify device password.  In a real application, this
  48 would be done using a more secure prompt.
  49 .TP
  50 .B \-v
  51 Dump verbose protocol data during operation.
  52 .TP
  53 .B \-h, \-\-help
  54 Show summary of options.
  55
  56
  57 .SH RETURN STATUS
  58 In the event of a fatal error, the message will be written to stderr,
  59 with an error code of 1.
  60
  61
  62 .SH AUTHOR
  63 .nh
  64 .B brecsum
  65 is part of the Barry project.
  66 This manual page was written by Chris Frey.
  67 .SH SEE ALSO
  68 .PP
  69 http://www.netdirect.ca/software/packages/barry
  70