man/bidentify.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 BIDENTIFY 1 "November 30, 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 bidentify
  20 \- Barry Project's program to identify BlackBerry handhelds
  21 .SH SYNOPSIS
  22 .B bidentify
  23 [-B busname][-N devname][-h][-v]
  24 .SH DESCRIPTION
  25 .PP
  26 .B bidentify
  27 scans the USB system for available BlackBerry devices and probes each
  28 one it finds, then sends the identifying information to stdout in a
  29 computer-friendly format.
  30 .SH OPTIONS
  31 .TP
  32 .B \-B busname
  33 Specify the USB bus to search for Blackberry devices on.  This is the
  34 first number displayed in the output from the lsusb command, such as 002.
  35 If the busname is numeric on your system, 2 and 002 are equal.  See
  36 also the \-N option, which can be used together with this option
  37 to precisely select the device to work with.
  38 .TP
  39 .B \-N devname
  40 Specify the USB device name.  This is the second number displayed in the
  41 output from the lsusb command, such as 005.  If the device name is numeric
  42 on your system, 5 and 005 are equal.  See also the \-B option.
  43 .TP
  44 .B \-v
  45 Dump verbose protocol data during operation.
  46 .TP
  47 .B \-h, \-\-help
  48 Show summary of options.
  49
  50
  51 .SH RETURN STATUS
  52 If
  53 .B bidentify
  54 detects a BlackBerry device, but cannot access it for some reason, it
  55 will write an error message to stderr describing the access problem,
  56 and return a count of the number of such failed devices as the error code.
  57 A return code of 0 means there were no BlackBerry devices found that
  58 could not be probed.
  59
  60 In the event of a fatal error, the message will be written to stderr,
  61 with an error code of 1.
  62
  63
  64 .SH AUTHOR
  65 .nh
  66 .B bidentify
  67 is part of the Barry project.
  68 This manual page was written by Chris Frey.
  69 .SH SEE ALSO
  70 .PP
  71 http://www.netdirect.ca/software/packages/barry
  72