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 2 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://repo.or.cz/w/barry.git">using git</a></li>
  19 </ul>
  20 </p>
  21
  22
  23 <? createSubHeader("Using The Tarball Release"); ?>
  24
  25 <p>There are multiple source packages available on the Sourceforge download page.
  26 The main tarball is always the tar.bz2 package.  This contains everything in
  27 git, including pre-built configure scripts and website documentation.</p>
  28
  29 <p>As an alternative, the tar.gz packages are Debian-specific.  This comes as
  30 an "orig" tarball, with the debian/ subdirectory contained in the diff.gz file.
  31 A .dsc file is included as well, for ease of Debian package building.  These
  32 files can be expanded into a Debian style source tree with the following
  33 command, for example:
  34 <pre>
  35         dpkg-source -x barry_0.15-0.dsc
  36 </pre>
  37 </p>
  38
  39 <p>Once the tar.gz and diff.gz files are combined, you will have a tree
  40 identical to what comes with the tar.bz2 package.</p>
  41
  42 <p>See <i>Building the Source</i> below for instructions on building the
  43 resulting tree.</p>
  44
  45 <p>Alternatively, there are rpm source packages, in the form of src.rpm files.
  46 These packages can be installed and built as usual, using the rpm and rpmbuild
  47 commands.</p>
  48
  49
  50 <? createSubHeader("Using git"); ?>
  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 <? createSubHeader("Preparing Development Sources for Configure"); ?>
  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 <? createSubHeader("Building the Source"); ?>
  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 sub-package 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 the root source directory.  The resulting files will be in
 118 doc/www/doxygen/html/.  Doxygen 1.5.6 has been used to do this,
 119 but presumably more recent versions will work as well.</p>
 120
 121
 122
 123 <? createSubHeader("Build Everything!"); ?>
 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 --enable-boost --enable-gui --enable-opensync-plugin
 132         make
 133         make install
 134         doxygen
 135 </pre>
 136
 137 <p>This will give you a set of command line tools (bcharge, btool, breset,
 138 bidentify, bjavaloader, pppob), as well as the backup GUI (barrybackup),
 139 and will install the opensync plugin into the system directory for opensync
 140 plugins (usually /usr/lib/opensync/plugins).  Available man pages are also
 141 installed.</p>
 142
 143 <p>You can use 'btool' to explore your device from the command line.
 144 Use the -h switch for help on its command line options.  Some good ones to
 145 start with are <code>-l</code> to list the devices found, and <code>-t</code>
 146 to list the Database Database.</p>
 147
 148
 149 <? createSubHeader("Configure udev to Run bcharge Automatically"); ?>
 150
 151 <p>The makefiles do not install udev rules automatically.  There are sample
 152 udev rules files in the udev/ directory.  For a Debian system, copy the
 153 udev/debian/10-blackberry.rules file to /etc/udev/rules.d/10-blackberry.rules,
 154 and copy the file modprobe/blacklist-berry_charge to
 155 /etc/modprobe.d/blacklist-berry_charge.
 156 <pre>
 157         cd barry
 158         (become root)
 159         cp udev/debian/10-blackberry.rules /etc/udev/rules.d/10-blackberry.rules
 160         cp modprobe/blacklist-berry_charge /etc/modprobe.d/blacklist-berry_charge
 161 </pre>
 162 </p>
 163
 164 <p>Make sure that bcharge was installed to /usr/sbin.  If you used a different
 165 --prefix option on the ./configure command line, you will need to update
 166 your 10-blackberry.rules file to match.</p>
 167
 168
 169 <? createSubHeader("Configure PPP chat scripts for your system"); ?>
 170
 171 <p>The source tree comes with sample PPP chat scripts for using your
 172 Blackberry as a modem.  These sample scripts are located under ppp/ in
 173 your source directory.
 174 The binary packages install all the ppp options files under /etc/ppp/peers/
 175 and all the chat scripts (with the *.chat extensions) under
 176 /etc/chatscripts/.  These directories are important, since the pppd
 177 program expects to find options files under peers/ and the options files
 178 reference the chatscripts.</p>
 179
 180 <p>Copy the above samples to their appropriate directories to install
 181 modem support for your system.  Make sure you have pppd installed as well.</p>
 182
 183 <p>If you install Barry in a location other than /usr, you will need
 184 to edit the options files to correct the hard coded paths in these
 185 files.  The files assume that pppob is located in /usr/sbin/pppob.</p>
 186
 187 <p>See the <? createLink("modem", "modem usage"); ?> page for more
 188 information on using your Blackberry as a modem.</p>
 189
 190
 191 <? createSubHeader("Building Barry RPMs from git"); ?>
 192
 193 <p> Paul Dugas reports on the mailing list that he uses the following
 194 steps for building RPMs from git:</p>
 195
 196 <pre>
 197         $ cd ~/work
 198         $ git clone...
 199         $ cd barry
 200         $ ./buildgen.sh
 201         $ ./configure --enable-gui --enable-opensync-plugin
 202         $ make dist
 203         $ rpmbuild -tb barry-0.13.tar.gz
 204
 205         I prefer running rpmbuild from the tarball as it's typically the way
 206         non-developers would build them.  I have ~/.rpmmacros setting %_topdir
 207         to %(echo $HOME)/.rpmbuild so the RPM building can run as me and not
 208         root.  The resulting RPMs end up in ~/.rpmbuild/RPMS/x86_64.
 209 </pre>
 210
 211 <p> On an RPM based system, install <b>rpm-build</b> and <b>rpmdevtools</b>,
 212 then run <b>rpmdev-setuptree</b> to create an "rpmbuild" directory in your
 213 home directory. </p>
 214
 215
 216 <? createSubHeader("Building Barry DEBs from Source"); ?>
 217
 218 <p>Once you have ./configure generated as detailed above, you can
 219 create Debian-style binary packages for your system by running the
 220 following:
 221 <pre>
 222         cd barry
 223         fakeroot -- debian/rules binary
 224 </pre>
 225 </p>
 226