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 "August 21, 2007"
   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 [-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]
  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 \-c dn
  38 Convert address book database to LDIF format, using the
  39 specified dn as the baseDN.  Sends LDIF output to stdout.
  40 .TP
  41 .B \-C dnattr
  42 Spcify LDIF attribute name to use when building the FQDN in the dn attribute.
  43 Defaults to 'cn'.  If you modify the mapping with the \-m
  44 switch, make sure that the new dnattr exists.
  45 .TP
  46 .B \-d db
  47 Load database 'db' FROM device and dump to stdout.
  48 Can be used multiple times to fetch more than one database.  See the -t
  49 option for a list of device databases.
  50 .TP
  51 .B \-e epp
  52 Override endpoint pair detection.  'epp' is a single string separated
  53 by a comma, holding the read,write endpoint pair.
  54
  55 Example: -e 83,5
  56
  57 Note: Endpoints are specified in hex.  Use the same numbers given by the
  58 lsusb -v output.
  59
  60 You should never need to use this option, as endpoints are autodetected.
  61 .TP
  62 .B \-f file
  63 Filename to write or read handheld data to/from.  Used in conjunction with
  64 the -d and -s options, respectively.
  65 .TP
  66 .B \-l
  67 Lists attached Blackberry devices, and their PIN numbers.
  68 .TP
  69 .B \-L
  70 List Contact field names.  Each name represents a contact field that the
  71 Barry library recognizes.  Use these names with the -m option to adjust
  72 the LDIF name to field mapping.
  73 .TP
  74 .B \-m command
  75 Map LDIF name to Contact field, or unmap LDIF name.  To map a new or existing
  76 LDIF attribute name to a Barry contact field, use the format 'ldif,read,write'
  77 where ldif represents the name of the attribute to map, read is the
  78 contact field name used to read data from the record, and write is the
  79 contact field name used to write data to the record.
  80
  81 To unmap an LDIF name, specify the LDIF attribute alone.
  82
  83 For example, to map a new LDIF attribute called "strange" to read from
  84 FirstName and write to LastName, use:
  85
  86 \-m strange,FirstName,LastName
  87
  88 The -m option can be specified multiple times to create the desired mapping.
  89 .TP
  90 .B \-M
  91 List current LDIF mapping to stdout.
  92 .TP
  93 .B \-p pin
  94 PIN of device to talk with.  Only needed if you have more than one Blackberry
  95 connected at once.
  96 .TP
  97 .B \-P password
  98 Simplistic method to specify device password.  In a real application, this
  99 would be done using a more secure prompt.
 100 .TP
 101 .B \-s db
 102 Save database 'db' TO device from data loaded from -f file.  See the -t
 103 option for a list of device databases.
 104 .TP
 105 .B \-S
 106 Show list of supported database parsers and builders.  Parsers are used
 107 when reading data out of the device, and builders are used when writing
 108 data to the device.  If a parser is supported, but its associated builder
 109 is not, that means you cannot change the database programmatically, such
 110 as with the -s option.
 111 .TP
 112 .B \-t
 113 Show device's database table.
 114 .TP
 115 .B \-T db
 116 Show record state table for given database.
 117 .TP
 118 .B \-v
 119 Dump verbose protocol data during operation.
 120 .TP
 121 .B \-X
 122 Reset device.
 123 .TP
 124 .B \-h, \-\-help
 125 Show summary of options.
 126
 127 .SH DATABASE COMMAND MODIFIERS
 128 The following options modify the -d command option above, and can be used
 129 multiple times for more than one record.
 130 .TP
 131 .B \-r #
 132 Fetch specific record, given a record index number as seen in the -T state table.
 133 Can be used multiple times to fetch specific records from a single database.
 134 .TP
 135 .B \-R #
 136 Same as -r, but also clears the record's dirty flags.
 137 .TP
 138 .B \-D #
 139 Delete the specified record using the index number as seen in the -T state table.
 140
 141
 142 .SH AUTHOR
 143 .nh
 144 .B btool
 145 is part of the Barry project.
 146 This manual page was written by Ian Darwin and Chris Frey.
 147 .SH SEE ALSO
 148 .PP
 149 http://www.netdirect.ca/software/packages/barry/index.php
 150 .br
 151 Especially the caveats, and the call for developers and others
 152 to help with the project.
 153