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 "December 7, 2010"
   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][-i charset][-l][-L][-m cmd][-M][-p pin][-P password][-s db -f file][-S][-t][-v][-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 \-I
  87 Sort records before dumping them to stdout.  This uses the default library
  88 sorting order, which is specific to each database.
  89 .TP
  90 .B \-l
  91 Lists attached Blackberry devices, and their PIN numbers.
  92 .TP
  93 .B \-L
  94 List Contact field names.  Each name represents a contact field that the
  95 Barry library recognizes.  Use these names with the -m option to adjust
  96 the LDIF name to field mapping.
  97 .TP
  98 .B \-m command
  99 Map LDIF name to Contact field, or unmap LDIF name.  To map a new or existing
 100 LDIF attribute name to a Barry contact field, use the format 'ldif,read,write'
 101 where ldif represents the name of the attribute to map, read is the
 102 contact field name used to read data from the record, and write is the
 103 contact field name used to write data to the record.
 104
 105 To unmap an LDIF name, specify the LDIF attribute alone.
 106
 107 For example, to map a new LDIF attribute called "strange" to read from
 108 FirstName and write to LastName, use:
 109
 110 \-m strange,FirstName,LastName
 111
 112 The -m option can be specified multiple times to create the desired mapping.
 113 .TP
 114 .B \-M
 115 List current LDIF mapping to stdout.
 116 .TP
 117 .B \-N devname
 118 Specify the USB device name.  This is the second number displayed in the
 119 output from the lsusb command, such as 005.  If the device name is numeric
 120 on your system, 5 and 005 are equal.  See also the \-B option.
 121 .TP
 122 .B \-p pin
 123 PIN of device to talk with.  Only needed if you have more than one Blackberry
 124 connected at once.
 125 .TP
 126 .B \-P password
 127 Simplistic method to specify device password.  In a real application, this
 128 would be done using a more secure prompt.
 129 .TP
 130 .B \-s db
 131 Save database 'db' TO device from data loaded from -f file.  See the -t
 132 option for a list of device databases.
 133 .TP
 134 .B \-S
 135 Show list of supported database parsers and builders.  Parsers are used
 136 when reading data out of the device, and builders are used when writing
 137 data to the device.  If a parser is supported, but its associated builder
 138 is not, that means you cannot change the database programmatically, such
 139 as with the -s option.
 140 .TP
 141 .B \-t
 142 Show device's database table.
 143 .TP
 144 .B \-T db
 145 Show record state table for given database.
 146 .TP
 147 .B \-v
 148 Dump verbose protocol data during operation.
 149 .TP
 150 .B \-V
 151 Enable vformat MIME output where available.  Address Book gets printed
 152 in vCard format, Calendar in vEvent format, Memos in vJournal, and
 153 Tasks in vTodo, etc.
 154 .TP
 155 .B \-X
 156 Perform a USB reset on the device.  Similar to the breset command,
 157 and does a virtual "replug" of the device.
 158 .TP
 159 .B \-z
 160 Use non-threaded sockets when communicating with the device.  This is
 161 the behaviour seen in versions 0.12 and earlier, since threads were
 162 not yet supported.  This option, along with -Z, are for debugging
 163 and testing.
 164 .TP
 165 .B \-Z
 166 Use a threaded socket router when communicating with the device.
 167 This is the default for btool.  This option, along with -Z, are for
 168 debugging and testing.
 169 .TP
 170 .B \-h, \-\-help
 171 Show summary of options.
 172
 173 .SH DATABASE COMMAND MODIFIERS
 174 The following options modify the -d command option above, and can be used
 175 multiple times for more than one record.
 176 .TP
 177 .B \-r #
 178 Fetch specific record, given a record index number as seen in the -T state table.
 179 Can be used multiple times to fetch specific records from a single database.
 180 .TP
 181 .B \-R #
 182 Same as -r, but also clears the record's dirty flags.
 183 .TP
 184 .B \-D #
 185 Delete the specified record using the index number as seen in the -T state table.
 186
 187
 188 .SH AUTHOR
 189 .nh
 190 .B btool
 191 is part of the Barry project.
 192 This manual page was written by Ian Darwin and Chris Frey.
 193 .SH SEE ALSO
 194 .PP
 195 http://www.netdirect.ca/software/packages/barry
 196 .br
 197 Especially the caveats, and the call for developers and others
 198 to help with the project.
 199