doc/www/index.php

   1 <? include ("barry.inc"); ?>
   2
   3 <? createHeader("barry - BlackBerry &trade; synchronization for Linux"); ?>
   4
   5 <? createSubHeader("Overview"); ?>
   6
   7 <p>Linux users who also use a BlackBerry &trade; now have an option for
   8 managing their BlackBerry directly from Linux.</p>
   9
  10 <p>Barry is an Open Source application that provides a Desktop GUI,
  11 synchronization, backup, restore and program management for
  12 BlackBerry &trade; devices.</p>
  13
  14 <p>Barry is primarily developed on Linux, but is intended as a cross platform
  15 library and application set, targeting Linux, BSD, 32/64bit, and big/little
  16 endian systems.</p>
  17
  18 <p>The Barry project began in October 2005 and has steadily added features
  19 and polish to Blackberry usage on Linux ever since.  We were the first to
  20 reverse engineer the battery charging handshake via USB.</p>
  21
  22 <p>Today, it is possible to (on BlackBerry devices <b>older</b> than the Z10):
  23
  24 <ul>
  25         <li> charge your Blackberry's battery from your USB port </li>
  26         <li> parse the following database records:
  27                 Address Book,
  28                 Browser Bookmarks,
  29                 Calendar,
  30                 Content Store,
  31                 Folders,
  32                 Handheld Agent (partial),
  33                 Memos,
  34                 Messages (Email),
  35                 Phone Call Logs,
  36                 PIN Messages,
  37                 Saved Email,
  38                 Service Book,
  39                 SMS messages,
  40                 Tasks,
  41                 Time Zones
  42                 </li>
  43         <li> create the following database records:
  44                 Address Book,
  45                 Calendar,
  46                 Content Store,
  47                 Memos,
  48                 Tasks
  49                 </li>
  50         <li> export Address Book contacts in text, LDAP LDIF format, or
  51                 as MIME vCards </li>
  52         <li> import data in MIME vCard, vEvent, vJournal, and vTodo formats</li>
  53         <li> make full data backups and restores of your device using
  54                 a GUI</li>
  55         <li> synchronize contact, calendar, memo, and task items with
  56                 Evolution using the Desktop GUI</li>
  57         <li> use the Blackberry as a modem</li>
  58         <li> install and manage Java applications from the command line </li>
  59         <li> take screenshots of your device </li>
  60         <li> set the device time from the command line </li>
  61         <li> use raw channel support to communicate with BlackBerry
  62                 applications </li>
  63         <li> ... and more </li>
  64 </ul>
  65 </p>
  66
  67 <div class="subHeader">Status</div>
  68
  69 <p>
  70 <ul>
  71         <li>Latest release: <b>0.19.0</b>, released on ????/??/??</li>
  72         <li>License: GPL v2 or later</li>
  73
  74         <li>Download official source and binary packages from
  75                 <a href="http://sourceforge.net/project/showfiles.php?group_id=153722">Sourceforge</a></li>
  76
  77         <li>General <a href="http://sourceforge.net/projects/barry/">Sourceforge project page</a></li>
  78
  79         <li><a href="http://repo.or.cz/w/barry.git">Barry git repo</a></li>
  80
  81         <li>Note that Barry is also available in various distros.  Some of these distros are listed below:
  82                 <ul>
  83                         <li>Debian and Ubuntu - maintianed in the Barry repo itself by Chris Frey</li>
  84                         <li>Fedora - packaged by Nathanael Noblet (RPM <a href="http://pkgs.fedoraproject.org/gitweb/?p=barry.git">git repo</a>)</li>
  85                         <li>Mandriva's RPM <a href="http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/barry/current/">SVN</a></li>
  86                 </ul>
  87         </li>
  88
  89         <li>Known Issues:
  90         <ul>
  91                 <li>International characters in calendar and contact records
  92                         cause some devices to switch to a different low-level
  93                         protocol, which Barry does not yet support.</li>
  94         </ul>
  95         </li>
  96 </ul>
  97 </p>
  98
  99 <? createSubHeader("Getting Started"); ?>
 100
 101 <p>How do I...
 102 <ul>
 103         <li><? createLink("installdebian", "Install Barry on Debian or Ubuntu"); ?></li>
 104         <li><? createLink("installfedora", "Install Barry on Fedora"); ?></li>
 105         <li><? createLink("install", "Install Barry from binary packages"); ?></li>
 106         <li><? createLink("cvs", "Compile Barry from tarball or git"); ?></li>
 107         <li><? createLink("desktop", "Use the Barry Desktop GUI"); ?> <i>(new!)</i></li>
 108         <li><? createLink("backups", "Make backups of my Blackberry data"); ?></li>
 109         <li><? createLink("sync", "Sync my Blackberry with Evolution"); ?></li>
 110         <li><? createLink("modem", "Use my Blackberry as a modem to surf the net"); ?></li>
 111         <li><? createLink("rawchannel", "Use Blackberry USB channels with Barry"); ?></li>
 112         <li><? createLink("wincebuild", "Build Barry for Windows CE"); ?></li>
 113         <li><? createLink("androidbuild", "Build Barry for Android"); ?></li>
 114         <li><? createLink("troubleshooting", "Find troubleshooting help"); ?></li>
 115         <li><? createLink("bugs", "Report a bug"); ?></li>
 116         <li><? createLink("patches", "Submit a patch"); ?></li>
 117         <li><? createLink("contact", "Contact the developers"); ?></li>
 118 </ul>
 119 </p>
 120
 121 <p>Some helpful pages:
 122 <ul>
 123         <li><? createLink("requirements", "System requirements"); ?></li>
 124         <li><? createLink("dependencies", "Software dependencies"); ?></li>
 125         <li><? createFileLink("doxygen/html/index.html", "Barry's Doxygen documentation"); ?></li>
 126 </ul>
 127 </p>
 128
 129
 130 <? createSubHeader("How to Help"); ?>
 131
 132 <p>If you are a C++ programmer, grab the source from
 133 <? createLink("cvs", "git"); ?> and take a look at the TODO file.
 134 Post a message to the
 135 <a href="http://sourceforge.net/mail/?group_id=153722">mailing list</a>
 136 when you start working on any of the listed features, so you can connect
 137 with other developers, and avoid duplicating effort.</p>
 138
 139 <p>If you are a Python programmer, contact the mailing list, since we
 140 would like to create and test a Python interface to the Barry library.</p>
 141
 142 <p>If you are not a programmer, but have a Blackberry, we can always use
 143 help in testing.  Install Barry on your system, and
 144 <? createLink("bugs", "report any bugs"); ?> you find.</p>
 145
 146 <p>If you prefer writing documentation, grab the source from
 147 <? createLink("cvs", "git"); ?> and look under the doc/www directory.
 148 Documentation is currently in html form, as well as doxygen-generated
 149 API documentation found in the comments of the source code itself.
 150 Patches updating either set of documentation are welcome.</p>
 151
 152 <p>There are dozens of databases that need to be documented and supported
 153 in the library.  If you have a BlackBerry &trade; device and are interested
 154 in helping decipher data, we have a
 155 <? createLink("hacking", "Barry hacking document"); ?> that will help you.
 156 </p>
 157
 158 <p>If you are interested in the low level USB protocol, you can download,
 159 or contribute, USB logs to the
 160 <? createLink("logs", "USB capture log archive"); ?>.</p>
 161
 162
 163 <? createSubHeader("Design"); ?>
 164
 165 <p>If you are interested in helping out or just interested in how it works,
 166 check out our <? createLink("design", "design notes"); ?>.
 167
 168
 169 <? createSubHeader("Roadmap"); ?>
 170
 171 <p>We have put together a document that describes where we are and where we
 172 want to take Barry. Check out our <? createLink("roadmap", "roadmap"); ?>
 173 to see what's happening.</p>
 174
 175
 176 <? createSubHeader("External Links"); ?>
 177
 178 <p>Barry users and others have contributed documentation and have
 179 put these howto's on the web.  Below is a list of some of these pages.
 180 These sites are not associated with NetDirect, and some of the information
 181 may be out of date, but they may still be helpful to new users.</P>
 182
 183 <p>
 184 <ul>
 185         <li><a href="http://www.progweb.com/modules/blackberry/index-en.html">How to use a Blackberry device with Linux</a>, by Nicolas Vivien (2009/03/06), and <a href="http://www.progweb.com/en/">his development blog</a></li>
 186         <li><a href="http://www.slashdev.ca/2008/04/03/blackberry-development-using-linux/">Blackberry development using Linux</a>, by Josh Kropf (2008/04/03)</li>
 187 </ul>
 188
 189 <ul>
 190         <li><a href="http://www.linuxjournal.com/article/10176">The BlackBerry In a World Without Windows</a>, by Carl Fink (2008/12/01)</li>
 191         <li><a href="http://www.chipbennett.net/wordpress/index.php/2008/05/synchronizing-a-blackberry-in-linux/">Synchronizing a Blackberry In Linux</a>, by Chip Bennett (2008/05/31)</li>
 192         <li><a href="http://www.linux.com/feature/123251">Syncing your Blackberry on Linux</a>, by Joe Barr (2007/12/21)</li>
 193 </ul>
 194
 195 <ul>
 196         <li><a href="http://off.net/cassis/protocol-description.html">The RIM Blackberry Serial Protocol</a>, by Phil Schwan, Mike Shaver, and Ian Goldberg, of the Cassis project</li>
 197         <li><a href="http://www.blackberryforums.com/blackberry-guides/2019-user-howto-use-blackberry-modem-laptop.html">HOWTO: Blackberry as Modem for Laptop</a>, by Mark Rejhon, (not Linux specific)</li>
 198 </ul>
 199 </p>
 200