maint: fixed missing argument in tagged release script
[barry.git] / man / bcharge.1
blobea43d41b3ed7737cf34b20cfc534081158e1dc2e
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 BCHARGE 1 "October 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 bcharge \- program to set BlackBerry handhelds to 500mA
20 .SH SYNOPSIS
21 .B bcharge
22 .SH DESCRIPTION
23 .PP
24 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
25 .\" \fI<whatever>\fP escape sequences to invode bold face and italics,
26 .\" respectively.
27 \fBbcharge\fP is a program that sends a special handshake to all BlackBerry
28 devices it finds on the USB bus.  This handshake causes the device to reset
29 itself, and then request 500mA instead of the usual 100mA.  This allows
30 proper charging on Linux.
31 .PP
32 It is safe to run this command multiple times, as it only changes devices
33 that are not already set to 500mA, or are not in the desired mode.
35 .SH OPTIONS
36 .TP
37 .B \-o
38 For Blackberry Pearl devices, using this switch causes bcharge to set the
39 Product ID to 0001.
41 When the Pearl is in 0004 mode, two USB interfaces are presented:
42 one for database access and one for mass storage.  In 0001 mode, only
43 the database access is available.
45 Before bcharge is run, the Pearl shows up with a Product ID of 0006,
46 which only gives mass storage functionality.  You must run bcharge
47 for the Pearl before using btool.
48 .TP
49 .B \-d
50 This switch is for the Blackberry Pearl to switch it back to
51 0004 dual mode after having run bcharge with the -o option.  Alternately,
52 newer devices (such as Storm with product ID of 8007) will be switched
53 to 0004.  Since a Pearl in mode 0001 is practically indistinguishable
54 from a classic Blackberry, the -d switch is needed to tell bcharge
55 that you really are working with a Pearl.
56 .TP
57 .B \-g
58 Guess whether Dual mode is needed.  If USB Interface Class 255 is not
59 found on the device (the class used for database access), then dual
60 mode is set.  Otherwise, the device is left as-is.
61 .TP
62 .B \-h
63 Help summary.
64 .TP
65 .B \-p devpath
66 If your system runs a kernel with CONFIG_USB_SUSPEND enabled (some Ubuntu
67 kernels have this turned on, as well as some Fedora 7 kernels), then you
68 also need to adjust the suspend state to avoid going into power saving mode.
69 This option is used when run from udev, using a rule such as:
71 BUS=="usb", SUBSYSTEM=="usb_device", ACTION=="add", SYSFS{idVendor}=="0fca", SYSFS{idProduct}=="0001", SYMLINK+="bb-%k", GROUP="plugdev", MODE="0660", RUN="/usr/sbin/bcharge \-p %p"
73 When using this option, you will almost always need to be root.
74 .TP
75 .B \-s path
76 Specify the mount point for the sysfs filesystem.  On most systems this is
77 mounted at /sys which is the default.
79 .SH AUTHOR
80 bcharge and this manual page were written by Chris Frey <cdfrey@foursquare.net>
81 for the Barry project.
82 .PP
83 http://www.netdirect.ca/software/packages/barry