doc/www/cvs.php

   1 <? createHeader("Installing Barry"); ?>
   2
   3 <? include ("barry.inc"); ?>
   4
   5
   6 <div class="subHeader">Dependencies</div>
   7
   8 <p>See the <? createLink("dependencies", "software dependencies"); ?> page for
   9 detailed information on the software that Barry needs.</p>
  10
  11
  12 <div class="subHeader">Getting the Source</div>
  13
  14 <p>There are 3 ways to get the source code:
  15 <ul>
  16         <li>download the release tarball from the
  17                 <a href="http://sourceforge.net/project/showfiles.php?group_id=153722">download page</a></li>
  18         <li>download the development tree
  19                 <a href="http://sourceforge.net/cvs/?group_id=153722">using CVS</a></li>
  20         <li>download the development tree
  21                 <a href="http://repo.or.cz/w/barry.git">using git</a></li>
  22 </ul>
  23 </p>
  24
  25
  26 <div class="subHeader">Using CVS</div>
  27
  28 <p>Up to date instructions for connecting to Sourceforge CVS repositories
  29 are available on the
  30 <a href="http://sourceforge.net/cvs/?group_id=153722">CVS page</a>.  This
  31 usually involves commands like this:
  32
  33 <pre>
  34         cvs -d:pserver:anonymous@barry.cvs.sourceforge.net:/cvsroot/barry login
  35         (press enter when it asks for password)
  36         cvs -d:pserver:anonymous@barry.cvs.sourceforge.net:/cvsroot/barry co -P barry
  37 </pre>
  38 </p>
  39
  40 <p>This will place the Barry sources in the barry directory.  To update
  41 your source tree periodically, do the following:
  42 <pre>
  43         cd barry
  44         ./buildgen.sh cleanall      (optional)
  45         cvs update -Pd
  46 </pre>
  47 </p>
  48
  49
  50 <div class="subHeader">Using git</div>
  51
  52 <p>The same development tree is also available via git, and can be browsed
  53 on the web at the <a href="http://repo.or.cz/w/barry.git">Barry git page</a>.
  54 You can clone the repository like this:
  55
  56 <pre>
  57         git clone git://repo.or.cz/barry.git barry
  58 </pre>
  59 </p>
  60
  61 <p>This will place the Barry sources in the barry directory.  To update
  62 your source tree periodically, do the following:
  63
  64 <pre>
  65         cd barry
  66         ./buildgen.sh cleanall      (optional)
  67         git checkout master
  68         git pull origin
  69 </pre>
  70 </p>
  71
  72
  73
  74
  75
  76 <div class="subHeader">Preparing Development Sources for Configure</div>
  77
  78 <p>If you're using a development tree, you'll need to build the usual
  79 ./configure script before you can proceed.  To do this, you will need
  80 autoconf, automake, and libtool as stated on the dependencies page.
  81 The correct sequence of commands to build ./configure is already stored
  82 in the ./buildgen.sh shell script in the root level directory of the
  83 Barry tree.
  84
  85 <pre>
  86         cd barry
  87         ./buildgen.sh
  88 </pre>
  89
  90
  91
  92
  93 <div class="subHeader">Building the Source</div>
  94
  95 <p>At this point, or if you are using a source tarball, building Barry
  96 is a matter of the common set of commands:
  97 <pre>
  98         ./configure
  99         make
 100         make install          (possibly as root)
 101 </pre>
 102 </p>
 103
 104 <p> The top level configure script has two options:
 105 <ul>
 106         <li> --enable-gui </li>
 107         <li> --enable-opensync-plugin </li>
 108 </ul>
 109 </p>
 110
 111 <p>Each option will recurse into the gui/ (Backup application) and
 112 opensync-plugin/ directories respectively, and build the subprojects
 113 located there automatically.  Make sure you have the needed software
 114 dependencies installed beforehand.</p>
 115
 116 <p> If you want to generate doxygen documentation, run 'doxygen' from
 117 within the src/ directory.  The resulting files will be in doc/doxygen/html/.
 118 Doxygen 1.4.5 has been used to do this, but presumably more recent versions
 119 will work as well.</p>
 120
 121
 122
 123 <div class="subHeader">Build Everything!</div>
 124
 125 <p>An example that will build everything, including the Boost features in
 126 btool:
 127 <pre>
 128         cd barry
 129         ./buildgen.sh cleanall         (this will make a pristine tree)
 130         ./buildgen.sh                  (this creates configure)
 131         ./configure --with-boost=/usr --enable-gui --enable-opensync-plugin
 132         make
 133         make install
 134         cd src && doxygen
 135 </pre>
 136
 137 <p>This will give you a set of command line tools (bcharge, btool, breset,
 138 bidentify, pppob), as well as the backup GUI (barrybackup), and will install the
 139 opensync plugin into the system directory for opensync plugins (usually
 140 /usr/lib/opensync/plugins).  Available man pages are also installed.</p>
 141
 142 <p>You can use 'btool' to explore your device from the command line.
 143 Use the -h switch for help on its command line options.  Some good ones to
 144 start with are <code>-l</code> to list the devices found, and <code>-t</code>
 145 to list the Database Database.</p>
 146
 147
 148 <div class="subHeader">Configure udev to Run bcharge Automatically</div>
 149
 150 <p>The makefiles do not install udev rules automatically.  There are sample
 151 udev rules files in the udev/ directory.  For a Debian system, copy the
 152 udev/10-blackberry.rules.Debian file to /etc/udev/rules.d/10-blackberry.rules,
 153 and copy the file modprobe/blacklist-berry_charge to
 154 /etc/modprobe.d/blacklist-berry_charge.
 155 <pre>
 156         cd barry
 157         (become root)
 158         cp udev/10-blackberry.rules.Debian /etc/udev/rules.d/10-blackberry.rules
 159         cp modprobe/blacklist-berry_charge /etc/modprobe.d/blacklist-berry_charge
 160 </pre>
 161 </p>
 162
 163 <p>Make sure that bcharge was installed to /usr/sbin.  If you used a different
 164 --prefix option on the ./configure command line, you will need to update
 165 your 10-blackberry.rules file to match.</p>
 166
 167
 168
 169 <div class="subHeader">Building Barry RPMs from CVS</div>
 170
 171 <p> Paul Dugas reports on the mailing list that he uses the following
 172 steps for building RPMs from CVS:</p>
 173
 174 <pre>
 175         $ cd ~/work
 176         $ cvs ... login
 177         $ cvs ... co barry
 178         $ cd barry
 179         $ ./buildgen.sh
 180         $ ./configure
 181         $ make dist
 182         $ rpmbuild -tb barry-0.12.tar.gz --with gui --with opensync
 183
 184         I prefer running rpmbuild from the tarball as it's typically the way
 185         non-developers would build them.  I have ~/.rpmmacros setting %_topdir
 186         to %(echo $HOME)/.rpmbuild so the RPM building can run as me and not
 187         root.  The resulting RPMs end up in ~/.rpmbuild/RPMS/x86_64.
 188 </pre>
 189
 190
 191 <div class="subHeader">Building Barry DEBs from CVS</div>
 192
 193 <p>Once you have ./configure generated as detailed above, you can
 194 create Debian-style binary packages for your system by running the
 195 following:
 196 <pre>
 197         cd barry
 198         fakeroot -- debian/rules binary
 199 </pre>
 200 </p>
 201