doc/www/cvs.php

   1 <? include ("barry.inc"); ?>
   2
   3 <? createHeader("Installing Barry"); ?>
   4
   5 <? createSubHeader("Dependencies"); ?>
   6
   7 <p>See the <? createLink("dependencies", "software dependencies"); ?> page for
   8 detailed information on the software that Barry needs.</p>
   9
  10
  11 <? createSubHeader("Getting the Source"); ?>
  12
  13 <p>There are 3 ways to get the source code:
  14 <ul>
  15         <li>download the release tarball from the
  16                 <a href="http://sourceforge.net/project/showfiles.php?group_id=153722">download page</a></li>
  17         <li>download the development tree
  18                 <a href="http://sourceforge.net/cvs/?group_id=153722">using CVS</a></li>
  19         <li>download the development tree
  20                 <a href="http://repo.or.cz/w/barry.git">using git</a></li>
  21 </ul>
  22 </p>
  23
  24
  25 <? createSubHeader("Using The Tarball Release"); ?>
  26
  27 <p>There are multiple source packages available on the Sourceforge download page.
  28 The main tarball is always the tar.bz2 package.  This contains everything in
  29 CVS, including pre-built configure scripts and website documentation.</p>
  30
  31 <p>As an alternative, the tar.gz packages are Debian-specific.  This comes as
  32 an "orig" tarball, with the debian/ subdirectory contained in the diff.gz file.
  33 A .dsc file is included as well, for ease of Debian package building.  These
  34 files can be expanded into a Debian style source tree with the following
  35 command, for example:
  36 <pre>
  37         dpkg-source -x barry_0.15-0.dsc
  38 </pre>
  39 </p>
  40
  41 <p>Once the tar.gz and diff.gz files are combined, you will have a tree
  42 identical to what comes with the tar.bz2 package.</p>
  43
  44 <p>See <i>Building the Source</i> below for instructions on building the
  45 resulting tree.</p>
  46
  47 <p>Alternatively, there are rpm source packages, in the form of src.rpm files.
  48 These packages can be installed and built as usual, using the rpm and rpmbuild
  49 commands.</p>
  50
  51
  52 <? createSubHeader("Using CVS"); ?>
  53
  54 <p>Up to date instructions for connecting to Sourceforge CVS repositories
  55 are available on the
  56 <a href="http://sourceforge.net/cvs/?group_id=153722">CVS page</a>.  This
  57 usually involves commands like this:
  58
  59 <pre>
  60         cvs -d:pserver:anonymous@barry.cvs.sourceforge.net:/cvsroot/barry login
  61         (press enter when it asks for password)
  62         cvs -d:pserver:anonymous@barry.cvs.sourceforge.net:/cvsroot/barry co -P barry
  63 </pre>
  64 </p>
  65
  66 <p>This will place the Barry sources in the barry directory.  To update
  67 your source tree periodically, do the following:
  68 <pre>
  69         cd barry
  70         ./buildgen.sh cleanall      (optional)
  71         cvs update -Pd
  72 </pre>
  73 </p>
  74
  75
  76 <? createSubHeader("Using git"); ?>
  77
  78 <p>The same development tree is also available via git, and can be browsed
  79 on the web at the <a href="http://repo.or.cz/w/barry.git">Barry git page</a>.
  80 You can clone the repository like this:
  81
  82 <pre>
  83         git clone git://repo.or.cz/barry.git barry
  84 </pre>
  85 </p>
  86
  87 <p>This will place the Barry sources in the barry directory.  To update
  88 your source tree periodically, do the following:
  89
  90 <pre>
  91         cd barry
  92         ./buildgen.sh cleanall      (optional)
  93         git checkout master
  94         git pull origin
  95 </pre>
  96 </p>
  97
  98
  99
 100
 101
 102 <? createSubHeader("Preparing Development Sources for Configure"); ?>
 103
 104 <p>If you're using a development tree, you'll need to build the usual
 105 ./configure script before you can proceed.  To do this, you will need
 106 autoconf, automake, and libtool as stated on the dependencies page.
 107 The correct sequence of commands to build ./configure is already stored
 108 in the ./buildgen.sh shell script in the root level directory of the
 109 Barry tree.
 110
 111 <pre>
 112         cd barry
 113         ./buildgen.sh
 114 </pre>
 115
 116
 117
 118
 119 <? createSubHeader("Building the Source"); ?>
 120
 121 <p>At this point, or if you are using a source tarball, building Barry
 122 is a matter of the common set of commands:
 123 <pre>
 124         ./configure
 125         make
 126         make install          (possibly as root)
 127 </pre>
 128 </p>
 129
 130 <p> The top level configure script has two sub-package options:
 131 <ul>
 132         <li> --enable-gui </li>
 133         <li> --enable-opensync-plugin </li>
 134 </ul>
 135 </p>
 136
 137 <p>Each option will recurse into the gui/ (Backup application) and
 138 opensync-plugin/ directories respectively, and build the subprojects
 139 located there automatically.  Make sure you have the needed software
 140 dependencies installed beforehand.</p>
 141
 142 <p> If you want to generate doxygen documentation, run 'doxygen' from
 143 the root source directory.  The resulting files will be in
 144 doc/www/doxygen/html/.  Doxygen 1.5.6 has been used to do this,
 145 but presumably more recent versions will work as well.</p>
 146
 147
 148
 149 <? createSubHeader("Build Everything!"); ?>
 150
 151 <p>An example that will build everything, including the Boost features in
 152 btool:
 153 <pre>
 154         cd barry
 155         ./buildgen.sh cleanall         (this will make a pristine tree)
 156         ./buildgen.sh                  (this creates configure)
 157         ./configure --enable-boost --enable-gui --enable-opensync-plugin
 158         make
 159         make install
 160         doxygen
 161 </pre>
 162
 163 <p>This will give you a set of command line tools (bcharge, btool, breset,
 164 bidentify, bjavaloader, pppob), as well as the backup GUI (barrybackup),
 165 and will install the opensync plugin into the system directory for opensync
 166 plugins (usually /usr/lib/opensync/plugins).  Available man pages are also
 167 installed.</p>
 168
 169 <p>You can use 'btool' to explore your device from the command line.
 170 Use the -h switch for help on its command line options.  Some good ones to
 171 start with are <code>-l</code> to list the devices found, and <code>-t</code>
 172 to list the Database Database.</p>
 173
 174
 175 <? createSubHeader("Configure udev to Run bcharge Automatically"); ?>
 176
 177 <p>The makefiles do not install udev rules automatically.  There are sample
 178 udev rules files in the udev/ directory.  For a Debian system, copy the
 179 udev/debian/10-blackberry.rules file to /etc/udev/rules.d/10-blackberry.rules,
 180 and copy the file modprobe/blacklist-berry_charge to
 181 /etc/modprobe.d/blacklist-berry_charge.
 182 <pre>
 183         cd barry
 184         (become root)
 185         cp udev/debian/10-blackberry.rules /etc/udev/rules.d/10-blackberry.rules
 186         cp modprobe/blacklist-berry_charge /etc/modprobe.d/blacklist-berry_charge
 187 </pre>
 188 </p>
 189
 190 <p>Make sure that bcharge was installed to /usr/sbin.  If you used a different
 191 --prefix option on the ./configure command line, you will need to update
 192 your 10-blackberry.rules file to match.</p>
 193
 194
 195 <? createSubHeader("Configure PPP chat scripts for your system"); ?>
 196
 197 <p>The source tree comes with sample PPP chat scripts for using your
 198 Blackberry as a modem.  These sample scripts are located under ppp/ in
 199 your source directory.
 200 The binary packages install all the ppp options files under /etc/ppp/peers/
 201 and all the chat scripts (with the *.chat extensions) under
 202 /etc/chatscripts/.  These directories are important, since the pppd
 203 program expects to find options files under peers/ and the options files
 204 reference the chatscripts.</p>
 205
 206 <p>Copy the above samples to their appropriate directories to install
 207 modem support for your system.  Make sure you have pppd installed as well.</p>
 208
 209 <p>If you install Barry in a location other than /usr, you will need
 210 to edit the options files to correct the hard coded paths in these
 211 files.  The files assume that pppob is located in /usr/sbin/pppob.</p>
 212
 213 <p>See the <? createLink("modem", "modem usage"); ?> page for more
 214 information on using your Blackberry as a modem.</p>
 215
 216
 217 <? createSubHeader("Building Barry RPMs from CVS"); ?>
 218
 219 <p> Paul Dugas reports on the mailing list that he uses the following
 220 steps for building RPMs from CVS:</p>
 221
 222 <pre>
 223         $ cd ~/work
 224         $ cvs ... login
 225         $ cvs ... co barry
 226         $ cd barry
 227         $ ./buildgen.sh
 228         $ ./configure --enable-gui --enable-opensync-plugin
 229         $ make dist
 230         $ rpmbuild -tb barry-0.13.tar.gz
 231
 232         I prefer running rpmbuild from the tarball as it's typically the way
 233         non-developers would build them.  I have ~/.rpmmacros setting %_topdir
 234         to %(echo $HOME)/.rpmbuild so the RPM building can run as me and not
 235         root.  The resulting RPMs end up in ~/.rpmbuild/RPMS/x86_64.
 236 </pre>
 237
 238 <p> On an RPM based system, install <b>rpm-build</b> and <b>rpmdevtools</b>,
 239 then run <b>rpmdev-setuptree</b> to create an "rpmbuild" directory in your
 240 home directory. </p>
 241
 242
 243 <? createSubHeader("Building Barry DEBs from Source"); ?>
 244
 245 <p>Once you have ./configure generated as detailed above, you can
 246 create Debian-style binary packages for your system by running the
 247 following:
 248 <pre>
 249         cd barry
 250         fakeroot -- debian/rules binary
 251 </pre>
 252 </p>
 253