man/btool.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 BTOOL 1 "May 16, 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 btool
  20 \- Barry Project's program to interface with BlackBerry handheld
  21 .SH SYNOPSIS
  22 .B btool
  23 [-B busname][-N devname][-c dn][-C dnattr][-d db [-f file][-r#][-R#]-D#]][-h][-l][-L][-m cmd][-M][-p pin][-s db -f file][-S][-t][-v][-X][-z][-Z]
  24 .SH DESCRIPTION
  25 .PP
  26 .B btool
  27 is a very early version of a program that communicates with a
  28 BlackBerry device over USB; there is no intention to support ancient
  29 serial-port BlackBerries.
  30 Since the protocols used by BlackBerry are not documented
  31 by the manufacturer Research In Motion, this program is
  32 experimental and you \fBuse at own risk\fP.
  33 Be sure your device is backed up by another program
  34 if it contains important data.
  35 .SH OPTIONS
  36 .TP
  37 .B \-B busname
  38 Specify the USB bus to search for Blackberry devices on.  This is the
  39 first number displayed in the output from the lsusb command, such as 002.
  40 If the busname is numeric on your system, 2 and 002 are equal.  See
  41 also the \-N option, which can be used together with this option
  42 to precisely select the device to work with.
  43 .TP
  44 .B \-c dn
  45 Convert address book database to LDIF format, using the
  46 specified dn as the baseDN.  Sends LDIF output to stdout.
  47 .TP
  48 .B \-C dnattr
  49 Spcify LDIF attribute name to use when building the FQDN in the dn attribute.
  50 Defaults to 'cn'.  If you modify the mapping with the \-m
  51 switch, make sure that the new dnattr exists.
  52 .TP
  53 .B \-d db
  54 Load database 'db' FROM device and dump to stdout.
  55 Can be used multiple times to fetch more than one database.  See the -t
  56 option for a list of device databases.
  57 .TP
  58 .B \-e epp
  59 Override endpoint pair detection.  'epp' is a single string separated
  60 by a comma, holding the read,write endpoint pair.
  61
  62 Example: -e 83,5
  63
  64 Note: Endpoints are specified in hex.  Use the same numbers given by the
  65 lsusb -v output.
  66
  67 You should never need to use this option, as endpoints are autodetected.
  68 .TP
  69 .B \-f file
  70 Filename to write or read handheld data to/from.  Used in conjunction with
  71 the -d and -s options, respectively.
  72 .TP
  73 .B \-l
  74 Lists attached Blackberry devices, and their PIN numbers.
  75 .TP
  76 .B \-L
  77 List Contact field names.  Each name represents a contact field that the
  78 Barry library recognizes.  Use these names with the -m option to adjust
  79 the LDIF name to field mapping.
  80 .TP
  81 .B \-m command
  82 Map LDIF name to Contact field, or unmap LDIF name.  To map a new or existing
  83 LDIF attribute name to a Barry contact field, use the format 'ldif,read,write'
  84 where ldif represents the name of the attribute to map, read is the
  85 contact field name used to read data from the record, and write is the
  86 contact field name used to write data to the record.
  87
  88 To unmap an LDIF name, specify the LDIF attribute alone.
  89
  90 For example, to map a new LDIF attribute called "strange" to read from
  91 FirstName and write to LastName, use:
  92
  93 \-m strange,FirstName,LastName
  94
  95 The -m option can be specified multiple times to create the desired mapping.
  96 .TP
  97 .B \-M
  98 List current LDIF mapping to stdout.
  99 .TP
 100 .B \-N devname
 101 Specify the USB device name.  This is the second number displayed in the
 102 output from the lsusb command, such as 005.  If the device name is numeric
 103 on your system, 5 and 005 are equal.  See also the \-B option.
 104 .TP
 105 .B \-p pin
 106 PIN of device to talk with.  Only needed if you have more than one Blackberry
 107 connected at once.
 108 .TP
 109 .B \-P password
 110 Simplistic method to specify device password.  In a real application, this
 111 would be done using a more secure prompt.
 112 .TP
 113 .B \-s db
 114 Save database 'db' TO device from data loaded from -f file.  See the -t
 115 option for a list of device databases.
 116 .TP
 117 .B \-S
 118 Show list of supported database parsers and builders.  Parsers are used
 119 when reading data out of the device, and builders are used when writing
 120 data to the device.  If a parser is supported, but its associated builder
 121 is not, that means you cannot change the database programmatically, such
 122 as with the -s option.
 123 .TP
 124 .B \-t
 125 Show device's database table.
 126 .TP
 127 .B \-T db
 128 Show record state table for given database.
 129 .TP
 130 .B \-v
 131 Dump verbose protocol data during operation.
 132 .TP
 133 .B \-X
 134 Reset device.
 135 .TP
 136 .B \-z
 137 Use non-threaded sockets when communicating with the device.  This is
 138 the behaviour seen in versions 0.12 and earlier, since threads were
 139 not yet supported.  This option, along with -Z, are for debugging
 140 and testing.
 141 .TP
 142 .B \-Z
 143 Use a threaded socket router when communicating with the device.
 144 This is the default for btool.  This option, along with -Z, are for
 145 debugging and testing.
 146 .TP
 147 .B \-h, \-\-help
 148 Show summary of options.
 149
 150 .SH DATABASE COMMAND MODIFIERS
 151 The following options modify the -d command option above, and can be used
 152 multiple times for more than one record.
 153 .TP
 154 .B \-r #
 155 Fetch specific record, given a record index number as seen in the -T state table.
 156 Can be used multiple times to fetch specific records from a single database.
 157 .TP
 158 .B \-R #
 159 Same as -r, but also clears the record's dirty flags.
 160 .TP
 161 .B \-D #
 162 Delete the specified record using the index number as seen in the -T state table.
 163
 164
 165 .SH AUTHOR
 166 .nh
 167 .B btool
 168 is part of the Barry project.
 169 This manual page was written by Ian Darwin and Chris Frey.
 170 .SH SEE ALSO
 171 .PP
 172 http://www.netdirect.ca/software/packages/barry/index.php
 173 .br
 174 Especially the caveats, and the call for developers and others
 175 to help with the project.
 176