[Refdb-cvs] CVS: homepage install.html,NONE,1.1
Status: Beta
Brought to you by:
mhoenicka
Menu
▾
▴
[Refdb-cvs] CVS: homepage install.html,NONE,1.1
|
From: David N. <dav...@us...> - 2005-09-29 13:56:03
|
Update of /cvsroot/refdb/homepage In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv6754 Added Files: install.html Log Message: Separating download and install instructions. Covers source, debian debs and freebsd ports --- NEW FILE --- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <!-- $Id: install.html,v 1.1 2005/09/29 13:55:43 davidnebauer Exp $ --> <head> <title>RefDB Addons (Debian Packages)</title> <meta name="author" content="Markus Hoenicka, David Nebauer" /> <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" /> <meta name="description" content="Homepage of the RefDB project, a reference manager and bibliography tool for structured texts" /> <link rel="stylesheet" type="text/css" href="refdbn.css" title="RefDB" media="screen, projection" /> <link rel="alternate stylesheet" type="text/css" href="refdbprint.css" title="Printer friendly" media="print, embossed, screen, projection" /> </head> <body> <!-- the page header, to be displayed across the top of the page --> <div id="head"> <div id="headleft"> <a href="http://refdb.sourceforge.net/"><img src="logo.jpg" alt="logo" border="0" /></a> </div> <div id="headright"> <table> <tbody> <tr> <td class="tag"><</td> <td class="graphic"> </td> <td class="tag">/></td> </tr> <tr> <td> </td> <td class="text">bibliographies beyond word processors</td> <td> </td> </tr> </tbody> </table> </div> </div> <div id="left"> <!-- the navigation box --> <div class="leftcontent"> <table class="nav"> <thead> <tr> <td class="nav">Navigation</td> </tr> </thead> <tbody> <tr> <td class="nav"><a href="index.html">Home</a></td> </tr> <tr> <td class="nav"><a href="features.html">Features</a></td> </tr> <tr> <td class="nav"><a href="sysreq.html">System requirements</a></td> </tr> <tr> <td class="nav"><a href="status.html">Current Status</a></td> </tr> <tr> <td class="nav"><a href="doc.html">Documentation</a></td> </tr> <tr> <td class="nav"><a href="examples.html">Examples</a></td> </tr> <tr> <td class="navsel">Download</td> </tr> <tr> <td class="nav"><a href="addons.html">Add-ons</a></td> </tr> </tbody> </table> </div> <div class="leftcontent"> <table class="nav"> <thead> <tr> <td class="nav">Links</td> </tr> </thead> <tbody> <tr> <td class="nav"><a href="http://www.sourceforge.net/projects/refdb">Project page</a></td> </tr> <tr> <td class="nav"><a href="http://cvs.sourceforge.net/viewcvs.py/refdb/">Project CVS</a></td> </tr> <tr> <td class="nav"><a href="http://sourceforge.net"> <img src="http://sourceforge.net/sflogo.php?group_id=26091&type=1" width="88" height="31" border="0" alt="SourceForge Logo" /></a></td> </tr> <tr> <td class="nav"><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" border="0" /></a></td> </tr> <tr> <td class="nav"><a href="http://jigsaw.w3.org/css-validator/"><img src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" height="31" width="88" border="0" /></a></td> </tr> </tbody> </table> </div> </div> <!-- the main text area, fills most of the page --> <div id="main"> <h1>RefDB Software Install Instructions</h1> <p>There is more than one way to install RefDB and RefDB-related software. RefDB itself is currently available as source (pre-release and cvs), Debian packages (debs) and a FreeBSD port. Software available as <a href="addons.html">add-ons</a> is available as source and often as debs. Some dependencies are listed as available from a given internet address. Instructions for installing via any of these methods is given below.</p> <div class="localnav"> <table class="localnav"> <thead> <tr> <td class="localnav">On this page</td> </tr> </thead> <tbody> <tr> <td class="localnav"><a href="#source">Source</a></td> </tr> <tr> <td class="localnav"><a href="#debian">Debian packages</a></td> </tr> <tr> <td class="localnav"><a href="#freebsd">FreeBSD port</a></td> </tr> <tr> <td class="localnav"><a href="#web">Web</a></td> </tr> </tbody> </table> </div> <h2 id="source">Source</h2> <p>These install instructions apply to autotools-generated source packages, which includes all source archives available from the RefDB website. Source packages come as a gzipped archive, usually named something like <code>foo-1.2.tar.gz</code>. These archives should be copied to an empty directory. Unix-like systems usually include the <code>tar</code> utility which can be used to extract the archive contents. For the example archive mentioned above the command for the GNU version of <code>tar</code> is <pre> tar zxvf foo-1.2.gz </pre> After changing to the newly created subdirectory, <em>read the <code>INSTALL</code> and <code>README</code> files</em> and follow any directions or advice they give. The <code>INSTALL</code> file, in particular, will have comprehensive instructions for the remaining install process.</p> <p>In summary, the remainder of the install process consists of three steps, commonly written as <pre> ./configure && make && make install </pre> First, configure the package. This is done by running the command <code>./configure</code> which checks your system for required software. It can accept a number of parameters. It is <em>very</em> important that you check whether you need to use any parameters. A summary of the available parameters can be viewed with <pre> ./configure --help | more </pre> (the output is piped through <code>more</code> as it is often more than a page in length). The <code>README</code> and <code>INSTALL</code> files my indicate any important parameters. Debian users, for example, will want to override the default prefix of <code>/usr/local</code> to the debian-appropriate <code>/usr</code> using <code>./configure --prefix=/usr</code>.</p> <p>The next command <pre>make</pre> creates the files to be installed.</p> <p>The final step <pre>make install</pre> copies the newly created files to their target locations on your system. This command must be executed as root. If you are not the root user you can temporarily obtain the required privileges with the <pre>su</pre> command (see <code>man su</code> for more details).</p> <p>At this point, providing no errors have occurred, the source package is installed. The original source archive and the extracted files can all be safely deleted.</p> <h2 id="debian">Debian</h2> <p>The Debian packages ("debs") supplied for the RefDB project are made available from repositories hosted on the RefDB website. These repositories are made known to Debian's package management tools by adding lines to the <code>/etc/apt/sources.list</code> file (requires root access). Users unfamiliar with this process should examine the manpages for their package management tool as well as the output from <code>man sources.list</code>.</p> <p>In the following examples you must replace <em>distro</em> with either <em>testing</em> or <em>unstable</em> depending on the Debian distribution you are using. The <em>stable</em> distribution is not supported.</p> <p>To install from source packages rather than binary packages replace <em>deb</em> with <em>deb-src</em>. The only binary debs currently supplied are for the <em>i386</em> family of architectures. Users with other architectures will need to install from source.</p> <h3 id="deb-refdb-release">RefDB (pre-release)</h3> <p>RefDB has not yet reached the magic "1.0" initial formal release. Stable versions of RefDB are periodically released as <em>pre-releases</em>. The most recent pre-release is made available using the following line in <code>/etc/apt/sources.list</code>: <pre> deb http://refdb.sourceforge.net/debian/release <em>distro</em> main </pre> </p> <h3 id="deb-refdb-cvs">RefDB (CVS)</h3> <p>RefDB is continuously undergoing development. A recent CVS version of RefDB is always available. Add the following line to <code>/etc/apt/sources.list:</code> <pre> deb http://refdb.sourceforge.net/debian/cvs <em>distro</em> main </pre> The CVS version of RefDB currently requires more advanced versions of certain packages than are currently available from official Debian repositories. These more recent packages are included in the RefDB CVS repository. As a result, two versions of these packages will be visible to your package management tool. Different tools handle this situation differently. <code>aptitude</code>, for example, does not upgrade to the new version automatically but makes the new version available. You should examine the documentation for your package management tool to determine how it copes with multiple package versions.</p> <h3 id="deb-refdb-addons">Add-ons</h3> <p><a href="addons.html">Add-on</a> software is made available by adding the following line to <code>/etc/apt/sources.list</code> <pre> deb http://refdb.sourceforge.net/debian/addons <em>distro</em> main </pre> </p> <h2 id="freebsd">FreeBSD port</h2> <p>RefDB is in the FreeBSD ports collection as part of the <a href="http://www.freebsd.org/cgi/ports.cgi?query=refdb&stype=all">textproc category</a>. See <a href="http://logicsquad.net/refdb/">here</a> for additional information about this port.</p> <h2 id="web">Web</h2> <p>Some of the packages available from <a href="addons.html">add-ons</a> are dependent on software that is not available from the RefDB site. One example is the add-on <code>vim-docbk-xml-refdb</code> that depends, in part, on the <em>Fop</em> FO processor and the <em>xsltproc</em> XSLT processor. These applications are available from their respective internet sites, links to which are supplied. To install one of these apps, the user must navigate to the appropriate website and follow the download and install directions.</p> </div> <!-- the footer, to be displayed across the page at the bottom --> <div id="foot"> <div id="footleft">$Date: 2005/09/29 13:55:43 $</div> <div id="footright">Copyright 2004 <a href="mailto:mho...@us...">Markus Hoenicka</a></div> </div> </body> </html> |
