From 91308d4d6a1dd75f17075896112d8e4aa82b9a8b Mon Sep 17 00:00:00 2001 From: cdfrey Date: Wed, 28 Feb 2007 22:21:32 +0000 Subject: [PATCH] - updated README, gui/README, and doc/USB-capture.txt --- ChangeLog | 1 + README | 48 ++++++++++++++++++++++++++++++++++++++++++------ doc/USB-capture.txt | 6 +++--- gui/README | 40 ++++++++++++++++++++++++++++++++++++++-- 4 files changed, 84 insertions(+), 11 deletions(-) diff --git a/ChangeLog b/ChangeLog index 7b4368a8..5777638a 100644 --- a/ChangeLog +++ b/ChangeLog @@ -9,6 +9,7 @@ Release: version 0.6 - 2007/02/?? Thanks to Michael Brown for the bug report. - added udev permissions file patch from Michael Brown - added Michael Brown to AUTHORS + - updated README, gui/README, and doc/USB-capture.txt 2007/02/23 - changed library behaviour so it only turns on libusb debug output if in data dump mode. In btool, -v controls this output. diff --git a/README b/README index 38683e28..f5936750 100644 --- a/README +++ b/README @@ -55,6 +55,31 @@ OpenSSL is needed for password hashing. +Dependency packages for common distributions: +--------------------------------------------- +The following is a list of packages you'll need to install to build Barry, +if you are using one of the below common distributions. Other distributions +should have similar package names. + + Fedora 5 and 6: + --------------- + Use the yum package manager to install the following: + + pkgconfig + libusb-devel + openssl-devel + boost-devel (optional) + + Debian stable: + -------------- + Use the apt-get package manager to install the following: + + pkg-config + libusb-dev + libssl-dev + libboost-serialization-dev + + To build Barry: --------------- @@ -159,15 +184,12 @@ Some notes on code architecture: -------------------------------- Lowest level: - Lowest level is the libusb software, currently using the DEVEL branch + Lowest level is the libusb software, currently using the stable branch USB layer: usbwrap.{h,cc} - C++ wrapper for libusb data.{h,cc} - C++ data class for buffer management and hex log file input and output - connect.cc - low level USB test program, capable of - using data file scripts to talk to a - device via bulk read/write debug.h - general debugging output support @@ -186,7 +208,8 @@ Barry API layer: base64.{h,cc} - base64 encoding and decoding (for LDIF) builder.h - C++ virtual wrappers to connect record and controller in a generic way - endian.h - big/little endian defines + endian.h - big/little endian defines... only used for + compiling the library, never installed error.{h,cc} - common exception classes for Barry layer probe.{h,cc} - USB probe class to find Blackberry devices protocol.{h,cc} - structs and defines for packets seen on wire @@ -198,20 +221,33 @@ Barry API layer: and controller in a generic way controller.{h,cc} - high level API class controllertmpl.h + version.{h,cc} - library version information s11n-boost.h - serialization functions for record.h classes - barry.h - application header (only one needed) + barry.h - C++ application header (only one needed) + cbarry.h - C application header (incomplete) Misc utilities: btool.cc - command line testing utility + bcharge.cc - set device to use 500mA, and also enables + database access for Blackberry Pearl devices + breset.cc - does a USB level software reset on all + Blackberry devices found convo.awk - script to convert UsbSnoop log files into trimmed-down request/response conversations + ktrans.cc - turns USB kernel capture logs from 2.6 + kernels into hex+ascii dumps translate.cc - translate UsbSnoop log file data into hex+ascii dumps upldif.cc - takes an ldap LDIF file on stdin and uploads contact data to the Blackberry +Example code: + addcontact.cc - example on adding a contact record to + the device + + Enjoy! February 2007 diff --git a/doc/USB-capture.txt b/doc/USB-capture.txt index 86f1d529..cc8dbe82 100644 --- a/doc/USB-capture.txt +++ b/doc/USB-capture.txt @@ -86,8 +86,8 @@ All USB data going through the usbdevfs interface (this includes all data transferred through libusb) will be logged from the kernel. This shows up in dmesg output, and /var/log/kern.log on most systems. -The data captured is very raw, in disorganized hex, so you'll need a script -or tool to help with the conversion something readable. +The data captured is very raw, in disorganized hex. Use the ktrans +program in the tools/ directory to convert it to something readable. But what if you only have a Windows driver? The nice thing is that VMWare uses the usbdevfs interface to share USB devices with the virtual machines. @@ -103,5 +103,5 @@ from: Happy Hacking! Chris Frey -2006/12/15 +February 2007 diff --git a/gui/README b/gui/README index a3a7e0cf..5ef4695c 100644 --- a/gui/README +++ b/gui/README @@ -4,6 +4,11 @@ Barry library compiled and installed to use this. This directory contains a fully standalone build tree, and is not built automatically when you build Barry. + + +Library Dependencies: +--------------------- + You will need the following packages installed on your system, including any dev or devel packages that come along with them: (all of these packages are easily available on Debian stable... your mileage may vary @@ -28,8 +33,39 @@ following: ./configure --prefix=/home/cdfrey/Barry -And if you have any trouble, please send mail to the mailing list and + +Dependency packages for common distributions: +--------------------------------------------- +The following is a list of packages you'll need to install to build the GUI, +if you are using one of the below common distributions. Other distributions +should have similar package names. + + Fedora 5 and 6: + --------------- + Use the yum package manager to install the following: + + pkgconfig + libtar (libtar-devel on Fedora 6) + libusb-devel + gtkmm24-devel + glibmm24-devel + zlib-devel + + Debian stable: + -------------- + Use the apt-get package manager to install the following: + + pkg-config + libtar-dev + libusb-dev + libgtkmm-2.4-dev + libglibmm-2.4-dev + zlib1g-dev + + + +If you have any trouble, please send mail to the mailing list and ask for help! -January 2007 +February 2007 -- 2.11.4.GIT