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 6, 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][-a db][-c dn][-C dnattr][-d db [-f file][-r#][-R#]-D#]][-h][-l][-L][-m cmd][-M][-p pin][-P password][-s db -f file][-S][-t][-v][-X][-z][-Z]
  24 .SH DESCRIPTION
  25 .PP
  26 .B btool
  27 is 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 \-a db
  45 Delete all records from specified database.  This can be used multiple
  46 times to clear multiple databases.
  47 .TP
  48 .B \-c dn
  49 Convert address book database to LDIF format, using the
  50 specified dn as the baseDN.  Sends LDIF output to stdout.
  51 .TP
  52 .B \-C dnattr
  53 Spcify LDIF attribute name to use when building the FQDN in the dn attribute.
  54 Defaults to 'cn'.  If you modify the mapping with the \-m
  55 switch, make sure that the new dnattr exists.
  56 .TP
  57 .B \-d db
  58 Load database 'db' FROM device and dump to stdout.
  59 Can be used multiple times to fetch more than one database.  See the -t
  60 option for a list of device databases.
  61 .TP
  62 .B \-e epp
  63 Override endpoint pair detection.  'epp' is a single string separated
  64 by a comma, holding the read,write endpoint pair.
  65
  66 Example: -e 83,5
  67
  68 Note: Endpoints are specified in hex.  Use the same numbers given by the
  69 lsusb -v output.
  70
  71 You should never need to use this option, as endpoints are autodetected.
  72 .TP
  73 .B \-f file
  74 Filename to write or read handheld data to/from.  Used in conjunction with
  75 the -d and -s options, respectively.  Note: the file format of this file
  76 is not backward compatible between devel releases.
  77 .TP
  78 .B \-i charset
  79 Specifies the iconv charset to use for converting international strings.
  80 The Blackberry uses the WINDOWS-1252 charset, which is incompatible with
  81 the more common code pages used in Linux.  The most useful charset to use
  82 with this option is UTF-8, and is highly recommended.  Any other charset
  83 available via 'iconv --list' can be used here too, but may not be
  84 successful for some character conversions.
  85 .TP
  86 .B \-l
  87 Lists attached Blackberry devices, and their PIN numbers.
  88 .TP
  89 .B \-L
  90 List Contact field names.  Each name represents a contact field that the
  91 Barry library recognizes.  Use these names with the -m option to adjust
  92 the LDIF name to field mapping.
  93 .TP
  94 .B \-m command
  95 Map LDIF name to Contact field, or unmap LDIF name.  To map a new or existing
  96 LDIF attribute name to a Barry contact field, use the format 'ldif,read,write'
  97 where ldif represents the name of the attribute to map, read is the
  98 contact field name used to read data from the record, and write is the
  99 contact field name used to write data to the record.
 100
 101 To unmap an LDIF name, specify the LDIF attribute alone.
 102
 103 For example, to map a new LDIF attribute called "strange" to read from
 104 FirstName and write to LastName, use:
 105
 106 \-m strange,FirstName,LastName
 107
 108 The -m option can be specified multiple times to create the desired mapping.
 109 .TP
 110 .B \-M
 111 List current LDIF mapping to stdout.
 112 .TP
 113 .B \-N devname
 114 Specify the USB device name.  This is the second number displayed in the
 115 output from the lsusb command, such as 005.  If the device name is numeric
 116 on your system, 5 and 005 are equal.  See also the \-B option.
 117 .TP
 118 .B \-p pin
 119 PIN of device to talk with.  Only needed if you have more than one Blackberry
 120 connected at once.
 121 .TP
 122 .B \-P password
 123 Simplistic method to specify device password.  In a real application, this
 124 would be done using a more secure prompt.
 125 .TP
 126 .B \-s db
 127 Save database 'db' TO device from data loaded from -f file.  See the -t
 128 option for a list of device databases.
 129 .TP
 130 .B \-S
 131 Show list of supported database parsers and builders.  Parsers are used
 132 when reading data out of the device, and builders are used when writing
 133 data to the device.  If a parser is supported, but its associated builder
 134 is not, that means you cannot change the database programmatically, such
 135 as with the -s option.
 136 .TP
 137 .B \-t
 138 Show device's database table.
 139 .TP
 140 .B \-T db
 141 Show record state table for given database.
 142 .TP
 143 .B \-v
 144 Dump verbose protocol data during operation.
 145 .TP
 146 .B \-X
 147 Reset device.
 148 .TP
 149 .B \-z
 150 Use non-threaded sockets when communicating with the device.  This is
 151 the behaviour seen in versions 0.12 and earlier, since threads were
 152 not yet supported.  This option, along with -Z, are for debugging
 153 and testing.
 154 .TP
 155 .B \-Z
 156 Use a threaded socket router when communicating with the device.
 157 This is the default for btool.  This option, along with -Z, are for
 158 debugging and testing.
 159 .TP
 160 .B \-h, \-\-help
 161 Show summary of options.
 162
 163 .SH DATABASE COMMAND MODIFIERS
 164 The following options modify the -d command option above, and can be used
 165 multiple times for more than one record.
 166 .TP
 167 .B \-r #
 168 Fetch specific record, given a record index number as seen in the -T state table.
 169 Can be used multiple times to fetch specific records from a single database.
 170 .TP
 171 .B \-R #
 172 Same as -r, but also clears the record's dirty flags.
 173 .TP
 174 .B \-D #
 175 Delete the specified record using the index number as seen in the -T state table.
 176
 177
 178 .SH AUTHOR
 179 .nh
 180 .B btool
 181 is part of the Barry project.
 182 This manual page was written by Ian Darwin and Chris Frey.
 183 .SH SEE ALSO
 184 .PP
 185 http://www.netdirect.ca/software/packages/barry
 186 .br
 187 Especially the caveats, and the call for developers and others
 188 to help with the project.
 189