"Fossies" - the Fresh Open Source Software Archive

Member "xapian-core-1.4.14/docs/install.html" (23 Nov 2019, 14124 Bytes) of package /linux/www/xapian-core-1.4.14.tar.xz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) HTML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 <?xml version="1.0" encoding="utf-8" ?>
    2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    4 <head>
    5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    6 <meta name="generator" content="Docutils 0.15.2: http://docutils.sourceforge.net/" />
    7 <title>Installing Xapian</title>
    8 <style type="text/css">
    9 
   10 /*
   11 :Author: David Goodger (goodger@python.org)
   12 :Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
   13 :Copyright: This stylesheet has been placed in the public domain.
   14 
   15 Default cascading style sheet for the HTML output of Docutils.
   16 
   17 See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
   18 customize this style sheet.
   19 */
   20 
   21 /* used to remove borders from tables and images */
   22 .borderless, table.borderless td, table.borderless th {
   23   border: 0 }
   24 
   25 table.borderless td, table.borderless th {
   26   /* Override padding for "table.docutils td" with "! important".
   27      The right padding separates the table cells. */
   28   padding: 0 0.5em 0 0 ! important }
   29 
   30 .first {
   31   /* Override more specific margin styles with "! important". */
   32   margin-top: 0 ! important }
   33 
   34 .last, .with-subtitle {
   35   margin-bottom: 0 ! important }
   36 
   37 .hidden {
   38   display: none }
   39 
   40 .subscript {
   41   vertical-align: sub;
   42   font-size: smaller }
   43 
   44 .superscript {
   45   vertical-align: super;
   46   font-size: smaller }
   47 
   48 a.toc-backref {
   49   text-decoration: none ;
   50   color: black }
   51 
   52 blockquote.epigraph {
   53   margin: 2em 5em ; }
   54 
   55 dl.docutils dd {
   56   margin-bottom: 0.5em }
   57 
   58 object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
   59   overflow: hidden;
   60 }
   61 
   62 /* Uncomment (and remove this text!) to get bold-faced definition list terms
   63 dl.docutils dt {
   64   font-weight: bold }
   65 */
   66 
   67 div.abstract {
   68   margin: 2em 5em }
   69 
   70 div.abstract p.topic-title {
   71   font-weight: bold ;
   72   text-align: center }
   73 
   74 div.admonition, div.attention, div.caution, div.danger, div.error,
   75 div.hint, div.important, div.note, div.tip, div.warning {
   76   margin: 2em ;
   77   border: medium outset ;
   78   padding: 1em }
   79 
   80 div.admonition p.admonition-title, div.hint p.admonition-title,
   81 div.important p.admonition-title, div.note p.admonition-title,
   82 div.tip p.admonition-title {
   83   font-weight: bold ;
   84   font-family: sans-serif }
   85 
   86 div.attention p.admonition-title, div.caution p.admonition-title,
   87 div.danger p.admonition-title, div.error p.admonition-title,
   88 div.warning p.admonition-title, .code .error {
   89   color: red ;
   90   font-weight: bold ;
   91   font-family: sans-serif }
   92 
   93 /* Uncomment (and remove this text!) to get reduced vertical space in
   94    compound paragraphs.
   95 div.compound .compound-first, div.compound .compound-middle {
   96   margin-bottom: 0.5em }
   97 
   98 div.compound .compound-last, div.compound .compound-middle {
   99   margin-top: 0.5em }
  100 */
  101 
  102 div.dedication {
  103   margin: 2em 5em ;
  104   text-align: center ;
  105   font-style: italic }
  106 
  107 div.dedication p.topic-title {
  108   font-weight: bold ;
  109   font-style: normal }
  110 
  111 div.figure {
  112   margin-left: 2em ;
  113   margin-right: 2em }
  114 
  115 div.footer, div.header {
  116   clear: both;
  117   font-size: smaller }
  118 
  119 div.line-block {
  120   display: block ;
  121   margin-top: 1em ;
  122   margin-bottom: 1em }
  123 
  124 div.line-block div.line-block {
  125   margin-top: 0 ;
  126   margin-bottom: 0 ;
  127   margin-left: 1.5em }
  128 
  129 div.sidebar {
  130   margin: 0 0 0.5em 1em ;
  131   border: medium outset ;
  132   padding: 1em ;
  133   background-color: #ffffee ;
  134   width: 40% ;
  135   float: right ;
  136   clear: right }
  137 
  138 div.sidebar p.rubric {
  139   font-family: sans-serif ;
  140   font-size: medium }
  141 
  142 div.system-messages {
  143   margin: 5em }
  144 
  145 div.system-messages h1 {
  146   color: red }
  147 
  148 div.system-message {
  149   border: medium outset ;
  150   padding: 1em }
  151 
  152 div.system-message p.system-message-title {
  153   color: red ;
  154   font-weight: bold }
  155 
  156 div.topic {
  157   margin: 2em }
  158 
  159 h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
  160 h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  161   margin-top: 0.4em }
  162 
  163 h1.title {
  164   text-align: center }
  165 
  166 h2.subtitle {
  167   text-align: center }
  168 
  169 hr.docutils {
  170   width: 75% }
  171 
  172 img.align-left, .figure.align-left, object.align-left, table.align-left {
  173   clear: left ;
  174   float: left ;
  175   margin-right: 1em }
  176 
  177 img.align-right, .figure.align-right, object.align-right, table.align-right {
  178   clear: right ;
  179   float: right ;
  180   margin-left: 1em }
  181 
  182 img.align-center, .figure.align-center, object.align-center {
  183   display: block;
  184   margin-left: auto;
  185   margin-right: auto;
  186 }
  187 
  188 table.align-center {
  189   margin-left: auto;
  190   margin-right: auto;
  191 }
  192 
  193 .align-left {
  194   text-align: left }
  195 
  196 .align-center {
  197   clear: both ;
  198   text-align: center }
  199 
  200 .align-right {
  201   text-align: right }
  202 
  203 /* reset inner alignment in figures */
  204 div.align-right {
  205   text-align: inherit }
  206 
  207 /* div.align-center * { */
  208 /*   text-align: left } */
  209 
  210 .align-top    {
  211   vertical-align: top }
  212 
  213 .align-middle {
  214   vertical-align: middle }
  215 
  216 .align-bottom {
  217   vertical-align: bottom }
  218 
  219 ol.simple, ul.simple {
  220   margin-bottom: 1em }
  221 
  222 ol.arabic {
  223   list-style: decimal }
  224 
  225 ol.loweralpha {
  226   list-style: lower-alpha }
  227 
  228 ol.upperalpha {
  229   list-style: upper-alpha }
  230 
  231 ol.lowerroman {
  232   list-style: lower-roman }
  233 
  234 ol.upperroman {
  235   list-style: upper-roman }
  236 
  237 p.attribution {
  238   text-align: right ;
  239   margin-left: 50% }
  240 
  241 p.caption {
  242   font-style: italic }
  243 
  244 p.credits {
  245   font-style: italic ;
  246   font-size: smaller }
  247 
  248 p.label {
  249   white-space: nowrap }
  250 
  251 p.rubric {
  252   font-weight: bold ;
  253   font-size: larger ;
  254   color: maroon ;
  255   text-align: center }
  256 
  257 p.sidebar-title {
  258   font-family: sans-serif ;
  259   font-weight: bold ;
  260   font-size: larger }
  261 
  262 p.sidebar-subtitle {
  263   font-family: sans-serif ;
  264   font-weight: bold }
  265 
  266 p.topic-title {
  267   font-weight: bold }
  268 
  269 pre.address {
  270   margin-bottom: 0 ;
  271   margin-top: 0 ;
  272   font: inherit }
  273 
  274 pre.literal-block, pre.doctest-block, pre.math, pre.code {
  275   margin-left: 2em ;
  276   margin-right: 2em }
  277 
  278 pre.code .ln { color: grey; } /* line numbers */
  279 pre.code, code { background-color: #eeeeee }
  280 pre.code .comment, code .comment { color: #5C6576 }
  281 pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
  282 pre.code .literal.string, code .literal.string { color: #0C5404 }
  283 pre.code .name.builtin, code .name.builtin { color: #352B84 }
  284 pre.code .deleted, code .deleted { background-color: #DEB0A1}
  285 pre.code .inserted, code .inserted { background-color: #A3D289}
  286 
  287 span.classifier {
  288   font-family: sans-serif ;
  289   font-style: oblique }
  290 
  291 span.classifier-delimiter {
  292   font-family: sans-serif ;
  293   font-weight: bold }
  294 
  295 span.interpreted {
  296   font-family: sans-serif }
  297 
  298 span.option {
  299   white-space: nowrap }
  300 
  301 span.pre {
  302   white-space: pre }
  303 
  304 span.problematic {
  305   color: red }
  306 
  307 span.section-subtitle {
  308   /* font-size relative to parent (h1..h6 element) */
  309   font-size: 80% }
  310 
  311 table.citation {
  312   border-left: solid 1px gray;
  313   margin-left: 1px }
  314 
  315 table.docinfo {
  316   margin: 2em 4em }
  317 
  318 table.docutils {
  319   margin-top: 0.5em ;
  320   margin-bottom: 0.5em }
  321 
  322 table.footnote {
  323   border-left: solid 1px black;
  324   margin-left: 1px }
  325 
  326 table.docutils td, table.docutils th,
  327 table.docinfo td, table.docinfo th {
  328   padding-left: 0.5em ;
  329   padding-right: 0.5em ;
  330   vertical-align: top }
  331 
  332 table.docutils th.field-name, table.docinfo th.docinfo-name {
  333   font-weight: bold ;
  334   text-align: left ;
  335   white-space: nowrap ;
  336   padding-left: 0 }
  337 
  338 /* "booktabs" style (no vertical lines) */
  339 table.docutils.booktabs {
  340   border: 0px;
  341   border-top: 2px solid;
  342   border-bottom: 2px solid;
  343   border-collapse: collapse;
  344 }
  345 table.docutils.booktabs * {
  346   border: 0px;
  347 }
  348 table.docutils.booktabs th {
  349   border-bottom: thin solid;
  350   text-align: left;
  351 }
  352 
  353 h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
  354 h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  355   font-size: 100% }
  356 
  357 ul.auto-toc {
  358   list-style-type: none }
  359 
  360 </style>
  361 </head>
  362 <body>
  363 <div class="document" id="installing-xapian">
  364 <h1 class="title">Installing Xapian</h1>
  365 
  366 <div class="section" id="introduction">
  367 <h1>Introduction</h1>
  368 <p>This document is intended to give a quick guide to how to install
  369 Xapian. You can find more detailed instructions in the <tt class="docutils literal">INSTALL</tt> file
  370 which is in top level directory of each source tree.</p>
  371 <p>Xapian can be built on UNIX systems (including MacOS X), and also
  372 Microsoft Windows systems using GCC with mingw or cygwin, or MSVC.</p>
  373 </div>
  374 <div class="section" id="packaged-binary-versions">
  375 <h1>Packaged binary versions</h1>
  376 <p>Pre-built Xapian packages are available for a number of platforms,
  377 including most of the popular Linux distributions and BSD variants, and
  378 also Cygwin and MSVC. If you are using such a platform, you'll probably
  379 find it easiest to use pre-built packages - it saves having to compile
  380 by hand and you'll generally get updates automatically.</p>
  381 <p>There are some links on our <a class="reference external" href="https://xapian.org/download">download
  382 page</a> but it's likely that Xapian packages
  383 are available for platforms we aren't aware of. Feel free to let us know
  384 and we'll add a link.</p>
  385 <p>In some cases, the version packaged may be rather old, in which case you
  386 can either request the packager to update, or build from source. If you
  387 find we're linking to a package which isn't being updated, please let us
  388 know so we can remove the link.</p>
  389 </div>
  390 <div class="section" id="installing-from-source">
  391 <h1>Installing from Source</h1>
  392 <div class="section" id="download">
  393 <h2>Download</h2>
  394 <p>The first step is to obtain a copy of the software from the <a class="reference external" href="https://xapian.org/download">Xapian
  395 download page</a>.</p>
  396 </div>
  397 <div class="section" id="unpacking">
  398 <h2>Unpacking</h2>
  399 <p>Use the usual tools to unpack the archives. For example, on a Linux
  400 system:</p>
  401 <pre class="literal-block">
  402 tar xf xapian-core-&lt;versionnumber&gt;.tar.xz
  403 tar xf xapian-omega-&lt;versionnumber&gt;.tar.xz
  404 tar xf xapian-bindings-&lt;versionnumber&gt;.tar.xz
  405 </pre>
  406 <p>If tar on your system doesn't support xz decompression, you can instead use:</p>
  407 <pre class="literal-block">
  408 xz -dc xapian-core-&lt;versionnumber&gt;.tar.xz|tar xf -
  409 xz -dc xapian-omega-&lt;versionnumber&gt;.tar.xz|tar xf -
  410 xz -dc xapian-bindings-&lt;versionnumber&gt;.tar.xz|tar xf -
  411 </pre>
  412 <p>These commands should unpack the archives into separate subdirectories
  413 (<tt class="docutils literal"><span class="pre">xapian-core-&lt;versionnumber&gt;</span></tt>, <tt class="docutils literal"><span class="pre">xapian-omega-&lt;versionnumber&gt;</span></tt> and
  414 <tt class="docutils literal"><span class="pre">xapian-bindings-&lt;versionnumber&gt;</span></tt>).</p>
  415 </div>
  416 <div class="section" id="configuring-and-building-the-xapian-library">
  417 <h2>Configuring and building the Xapian library</h2>
  418 <p>For full details of the different options available when configuring and
  419 building, read the file &quot;INSTALL&quot; in the top level directory of your
  420 newly unpacked source tree. But in many cases, the following quick
  421 summary is all you need to know.</p>
  422 <p>Each directory contains a <tt class="docutils literal">configure</tt> script which checks various
  423 features of your system. Assuming this runs successfully, you can then
  424 run <tt class="docutils literal">make</tt> to build the software, and <tt class="docutils literal">make install</tt> to actually
  425 install it. By default, the software installs under <tt class="docutils literal">/usr/local</tt>, but
  426 you can change this by passing <tt class="docutils literal"><span class="pre">--prefix=/path/to/install</span></tt> to
  427 <tt class="docutils literal">configure</tt>. So for example, you might use the following series of
  428 commands to build and install xapian-core under <tt class="docutils literal">/opt</tt>:</p>
  429 <pre class="literal-block">
  430 cd xapian-core-&lt;version&gt;
  431 ./configure --prefix=/opt
  432 make
  433 sudo make install
  434 </pre>
  435 <p>If you don't have root access to install Xapian, you can specify a
  436 prefix in your home directory, for example:</p>
  437 <pre class="literal-block">
  438 ./configure --prefix=/home/jenny/xapian-install
  439 </pre>
  440 </div>
  441 <div class="section" id="configuring-and-building-omega">
  442 <h2>Configuring and building Omega</h2>
  443 <p>Omega can be built in almost exactly the same way as the core library.
  444 Omega's <tt class="docutils literal">configure</tt> script will try to locate your Xapian installation
  445 by looking for the <tt class="docutils literal"><span class="pre">xapian-config</span></tt> script, which is installed as
  446 <tt class="docutils literal"><span class="pre">&lt;prefix&gt;/bin/xapian-config</span></tt>. If <tt class="docutils literal"><span class="pre">&lt;prefix&gt;/bin/xapian-config</span></tt> isn't
  447 on your <tt class="docutils literal">PATH</tt>, or you have multiple installations of Xapian (perhaps
  448 a debug and non-debug build, or two different versions), you can specify
  449 a <tt class="docutils literal"><span class="pre">xapian-config</span></tt> to use by passing <tt class="docutils literal">XAPIAN_CONFIG</tt> on the configure
  450 command line, as shown below:</p>
  451 <pre class="literal-block">
  452 cd xapian-omega-&lt;version&gt;
  453 ./configure --prefix=/opt XAPIAN_CONFIG=/opt/bin/xapian-config
  454 make
  455 sudo make install
  456 </pre>
  457 <p>Note that we use GNU libtool, which will set the runtime library search
  458 path if your Xapian installation isn't in the dynamic linker search
  459 path, so there's no need to mess around with setting
  460 <tt class="docutils literal">LD_LIBRARY_PATH</tt>.</p>
  461 </div>
  462 <div class="section" id="configuring-and-building-xapian-bindings">
  463 <h2>Configuring and building Xapian-bindings</h2>
  464 <p>Xapian-bindings is built much like Omega. One thing to be aware of is
  465 that by default we install the built bindings where they need to go to
  466 work without further intervention, so they may get installed under
  467 <tt class="docutils literal">/usr</tt> even if the prefix is elsewhere. See the <tt class="docutils literal">INSTALL</tt> file for
  468 xapian-bindings for details of how you can override this, and what steps
  469 you'll need to take to run scripts which use the bindings if you do.</p>
  470 </div>
  471 <div class="section" id="building-from-git">
  472 <h2>Building from git</h2>
  473 <p>If you wish to help develop Xapian, read <a class="reference external" href="https://xapian.org/bleeding">how to build from the Xapian
  474 git repository</a>.</p>
  475 </div>
  476 </div>
  477 </div>
  478 </body>
  479 </html>