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 "February 23, 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][-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 \-f file
  52 Filename to write or read handheld data to/from.  Used in conjunction with
  53 the -d and -s options, respectively.
  54 .TP
  55 .B \-l
  56 Lists attached Blackberry devices, and their PIN numbers.
  57 .TP
  58 .B \-L
  59 List Contact field names.  Each name represents a contact field that the
  60 Barry library recognizes.  Use these names with the -m option to adjust
  61 the LDIF name to field mapping.
  62 .TP
  63 .B \-m command
  64 Map LDIF name to Contact field, or unmap LDIF name.  To map a new or existing
  65 LDIF attribute name to a Barry contact field, use the format 'ldif,read,write'
  66 where ldif represents the name of the attribute to map, read is the
  67 contact field name used to read data from the record, and write is the
  68 contact field name used to write data to the record.
  69
  70 To unmap an LDIF name, specify the LDIF attribute alone.
  71
  72 For example, to map a new LDIF attribute called "strange" to read from
  73 FirstName and write to LastName, use:
  74
  75 \-m strange,FirstName,LastName
  76
  77 The -m option can be specified multiple times to create the desired mapping.
  78 .TP
  79 .B \-M
  80 List current LDIF mapping to stdout.
  81 .TP
  82 .B \-p pin
  83 PIN of device to talk with.  Only needed if you have more than one Blackberry
  84 connected at once.
  85 .TP
  86 .B \-P password
  87 Simplistic method to specify device password.  In a real application, this
  88 would be done using a more secure prompt.
  89 .TP
  90 .B \-s db
  91 Save database 'db' TO device from data loaded from -f file.  See the -t
  92 option for a list of device databases.
  93 .TP
  94 .B \-t
  95 Show device's database table.
  96 .TP
  97 .B \-T db
  98 Show record state table for given database.
  99 .TP
 100 .B \-v
 101 Dump verbose protocol data during operation.
 102 .TP
 103 .B \-X
 104 Reset device.
 105 .TP
 106 .B \-h, \-\-help
 107 Show summary of options.
 108
 109 .SH DATABASE COMMAND MODIFIERS
 110 The following options modify the -d command option above, and can be used
 111 multiple times for more than one record.
 112 .TP
 113 .B \-r #
 114 Fetch specific record, given a record index number as seen in the -T state table.
 115 Can be used multiple times to fetch specific records from a single database.
 116 .TP
 117 .B \-R #
 118 Same as -r, but also clears the record's dirty flags.
 119 .TP
 120 .B \-D #
 121 Delete the specified record using the index number as seen in the -T state table.
 122
 123
 124 .SH AUTHOR
 125 .nh
 126 .B btool
 127 is part of the Barry project.
 128 This manual page was written by Ian Darwin and Chris Frey.
 129 .SH SEE ALSO
 130 .PP
 131 http://www.netdirect.ca/software/packages/barry/index.php
 132 .br
 133 Especially the caveats, and the call for developers and others
 134 to help with the project.
 135