docs/wiki/geda-gaf_building_git_version.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html>
   4 <head>
   5   <link rel="stylesheet" media="screen" type="text/css" href="./style.css" />
   6   <link rel="stylesheet" media="screen" type="text/css" href="./design.css" />
   7   <link rel="stylesheet" media="print" type="text/css" href="./print.css" />
   8
   9   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  10 </head>
  11 <body>
  12
  13 <h1 id="buildingthegedagafgitrepositoryversion">Building the gEDA/gaf git repository version</h1>
  14 <div class="level1">
  15
  16 </div>
  17
  18 <h2 id="generalinstructions">General Instructions</h2>
  19 <div class="level2">
  20
  21 <p>
  22 To build the git repository version of gEDA/gaf, follow these instructions:
  23 </p>
  24 <ul>
  25 <li class="level1 node"><div class="li"> Download and install all the following dependencies.  You will probably want to use your distributions package management system (such as apt-get or yum) to install the dependencies.</div>
  26 <ul>
  27 <li class="level2"><div class="li"> A C compiler and C standard library ( GCC  and  GNU Libc  are recommended)</div>
  28 </li>
  29 <li class="level2"><div class="li">  flex  current</div>
  30 </li>
  31 <li class="level2"><div class="li">  GNU awk  current</div>
  32 </li>
  33 <li class="level2"><div class="li">  automake  1.6.x or later</div>
  34 </li>
  35 <li class="level2"><div class="li">  autoconf   2.60 or later</div>
  36 </li>
  37 <li class="level2"><div class="li">  libtool  current</div>
  38 </li>
  39 <li class="level2"><div class="li">  texinfo  current</div>
  40 </li>
  41 <li class="level2"><div class="li">  pkg-config  current</div>
  42 </li>
  43 <li class="level2"><div class="li">  gettext   0.16 or later</div>
  44 </li>
  45 <li class="level2"><div class="li">  guile   1.8.x (1.6.x is no longer supported)</div>
  46 </li>
  47 <li class="level2"><div class="li">  gtk+  2.10.x or later</div>
  48 </li>
  49 <li class="level2"><div class="li">  groff  current</div>
  50 </li>
  51 <li class="level2"><div class="li">  git  1.6.x or later</div>
  52 </li>
  53 <li class="level2"><div class="li">  cvs  current</div>
  54 </li>
  55 <li class="level2"><div class="li">  freedesktop.org MIME info database  current</div>
  56 </li>
  57 <li class="level2"><div class="li">  freedesktop.org utilities for manipulating .desktop files  current</div>
  58 </li>
  59 </ul>
  60 </li>
  61 </ul>
  62 <ul>
  63 <li class="level1"><div class="li"> It is pretty important to have all of the above programs (especially automake, autoconf, libtool, gtk, and guile) installed in the same prefix (like /usr or /usr/local).  If you do not have them all installed in the same prefix, then building and installing gEDA/gaf is much harder.</div>
  64 </li>
  65 </ul>
  66 <ul>
  67 <li class="level1"><div class="li"> Clone the source from the official git repository.  For information on how to do this, read the <a href="geda-scm.html" class="wikilink1" title="geda-scm.html"> gEDA SCM page </a></div>
  68 </li>
  69 </ul>
  70 <ul>
  71 <li class="level1"><div class="li"> Build the software by executing the following commands inside of the newly cloned git repository:<pre class="code">$ ./autogen.sh
  72 $ ./configure --prefix=$HOME/geda
  73 $ make
  74 $ make install</pre>
  75 </div>
  76 </li>
  77 <li class="level1"><div class="li"> If the above commands execute without <strong>any</strong> error messages, then you have successfully built and installed gEDA/gaf.  If you encounter any errors, be sure to read the README and INSTALL files contained within the tarball.</div>
  78 </li>
  79 </ul>
  80 <ul>
  81 <li class="level1"><div class="li"> You can now run the various programs in the gEDA suite.  Please read the toplevel README file which describes what is available.</div>
  82 </li>
  83 </ul>
  84 <ul>
  85 <li class="level1"><div class="li"> gschem is the schematic capture program and can be run by executing: <code>PATH_WHERE_gEDA_GAF_IS_INSTALLED/bin/gschem</code></div>
  86 </li>
  87 </ul>
  88 <ul>
  89 <li class="level1"><div class="li"> It is recommended that you add <code>PATH_WHERE_gEDA_GAF_IS_INSTALLED/bin</code> to your PATH environment variable (typically done by modifying one of the following files: <code>$HOME/.bashrc</code>, <code>$HOME/.bash_profile</code>, or <code>$HOME/.profile</code>).</div>
  90 </li>
  91 </ul>
  92 <ul>
  93 <li class="level1"><div class="li"> It is highly recommended that you read the gEDA documentation at this point.  You can access the gEDA documentation by running gschem and select Help/gEDA Documentation... from the top menu.</div>
  94 </li>
  95 </ul>
  96 <ul>
  97 <li class="level1"><div class="li"> If you want to get gEDA/gaf repository commit log e-mail messages, please subscribe to the geda-cvs mailing list.  Please see the <a href="geda-mailinglists.html" class="wikilink1" title="geda-mailinglists.html"> mailing lists page </a> for info on how to do this.</div>
  98 </li>
  99 </ul>
 100 <ul>
 101 <li class="level1"><div class="li"> For build problems, please be sure to read the <a href="geda-mailinglists.html" class="wikilink1" title="geda-mailinglists.html"> mailing list archives </a> or  search  this site.  Also look at the <a href="start.html" class="wikilink1" title="start.html"> gEDA wiki </a> for more hints.</div>
 102 </li>
 103 </ul>
 104
 105 </div>
 106
 107 <h2 id="distro-specificinformation">Distro-specific information</h2>
 108 <div class="level2">
 109
 110 </div>
 111
 112 <h3 id="debian-based">Debian-based</h3>
 113 <div class="level3">
 114
 115 <p>
 116 This is tested on Crunchbang Linux but should work on Debian Wheezy and possibly Ubuntu also.
 117 </p>
 118 <ol>
 119 <li class="level1"><div class="li"> Install the build dependencies for the packaged version of gEDA:<pre class="code">$ sudo apt-get build-dep geda</pre>
 120 </div>
 121 </li>
 122 <li class="level1"><div class="li"> Install the packages that don&#039;t get pulled in by the above command:<pre class="code">$ sudo apt-get install texinfo
 123 $ sudo apt-get install autopoint
 124 $ sudo apt-get install libtool</pre>
 125 </div>
 126 </li>
 127 <li class="level1"><div class="li"> If you want to generate doxygen output, install it and the other prerequisites:<pre class="code">$ sudo apt-get install doxygen
 128 $ sudo apt-get install imagemagick
 129 $ sudo apt-get install graphviz</pre>
 130 </div>
 131 </li>
 132 <li class="level1"><div class="li"> Clone the source from the official git repository.  For information on how to do this, read the <a href="geda-scm.html" class="wikilink1" title="geda-scm.html"> gEDA SCM topic </a>.</div>
 133 </li>
 134 <li class="level1"><div class="li"> From inside the newly cloned repository, build gEDA/gaf:<pre class="code">$ ./autogen.sh
 135 $ ./configure --prefix=$HOME/geda [--enable-doxygen]
 136 $ make
 137 $ make install</pre>
 138 </div>
 139 </li>
 140 </ol>
 141
 142 </div>
 143
 144 <h3 id="macports">MacPorts</h3>
 145 <div class="level3">
 146
 147 <p>
 148 MacPorts is an open-source community initiative to design an easy-to-use system for compiling, installing, and upgrading open-source software on the Mac OS X operating system. MacPorts has a packaged installation of gEDA/gaf but occasionally one needs a more up-to-date version (such as that from git). The easiest way to build from git HEAD on MacPorts is to install the packaged version (at time of writing, 1.6.2) as a way of bringing most of the dependencies into the MacPorts tree.
 149 </p>
 150 <ol>
 151 <li class="level1"><div class="li"> Install MacPorts.</div>
 152 </li>
 153 <li class="level1"><div class="li"> Install the MacPorts-packaged version of gEDA/gaf. As a happy side-effect, this brings in most of the build prerequisites. Also install autoconf and automake:<pre class="code">$ sudo port install geda-gaf
 154 $ sudo port install autoconf
 155 $ sudo port install automake</pre>
 156 </div>
 157 </li>
 158 <li class="level1"><div class="li"> If you want to generate doxygen output, install doxygen:<pre class="code">$ sudo port install doxygen</pre>
 159 </div>
 160 </li>
 161 <li class="level1"><div class="li"> Clone the source from the official git repository.  For information on how to do this, read the <a href="geda-scm.html" class="wikilink1" title="geda-scm.html"> gEDA SCM topic </a>.</div>
 162 </li>
 163 <li class="level1"><div class="li"> From inside the newly cloned repository, build gEDA/gaf:<pre class="code">$ ./autogen.sh
 164 $ ./configure --prefix=$HOME/geda --disable-update-xdg-database [--enable-doxygen]
 165 $ make
 166 $ make install</pre>
 167 </div>
 168 </li>
 169 <li class="level1"><div class="li"> If you are running a recent release of OS X, X server is not included by default so you might need to install XQuartz</div>
 170 </li>
 171 <li class="level1"><div class="li"> To run the software, you need to set an environment variable to allow Guile to load its shared libraries:<pre class="code">$ export LTDL_LIBRARY_PATH=/opt/local/lib
 172 $ gschem</pre>
 173 </div>
 174 </li>
 175 </ol>
 176
 177 </div>
 178 </body>
 179 </html>