man/brawchannel.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 BRAWCHANNEL 1 "August 17, 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 brawchannel
  20 \- Barry Project's program to create a channel to a BlackBerry application
  21 .SH SYNOPSIS
  22 .B brawchannel [\-h][\-p pin][\-P pass][\-v] <channel name>
  23 .SH DESCRIPTION
  24 .PP
  25 .B brawchannel
  26 is a tool for connecting to an application channel on a BlackBerry device,
  27 as provided to on device programs by the
  28 .B net.rim.device.api.system.USBPort
  29 API. Data received on the channel will be output to STDOUT and any data
  30 received on STDIN in will be sent over the channel. Any errors or verbose
  31 output will be written to STDERR.
  32 .BR
  33 The
  34 .B channel name
  35 provided to this program should be the same as the channel name passed
  36 to the call to
  37 .B net.rim.device.api.system.USBPort.registerChannel
  38 .SH OPTIONS
  39 .TP
  40 .B \-h
  41 Display a command help summary.
  42 .TP
  43 .B \-p pin
  44 Specifies the PIN number of the device with which you wish to communicate,
  45 when multiple devices are connected.
  46 .TP
  47 .B \-P password
  48 A simplistic method to specify the device password.
  49 .TP
  50 .B \-v
  51 Verbose debug output.  This enables dumping of USB bus scanning, as
  52 well as the protocol packets used during communication.  This will
  53 cause libusb to output information on STDOUT, which will usually be
  54 undesirable. Setting the environment variable USB_DEBUG to 0, 1 or 2
  55 should prevent any addition output on STDOUT.
  56 .SH AUTHOR
  57 .nh
  58 .B brawchannel
  59 was initially written for the Barry project by RealVNC Ltd.,
  60 based on bjavaloader by Nicolas Vivien.
  61 .SH SEE ALSO
  62 .PP
  63 http://www.netdirect.ca/software/packages/barry
  64