doc/book.xml

   1 <?xml version="1.0" standalone="no"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   3     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
   4 [
   5      <!ENTITY % local SYSTEM "local.ent">
   6      %local;
   7      <!ENTITY manref SYSTEM "manref.xml">
   8      <!ENTITY gpl2 SYSTEM "gpl-2.0.xml">
   9      <!ENTITY % idcommon SYSTEM "common/common.ent">
  10      %idcommon;
  11 ]>
  12 <book>
  13  <bookinfo>
  14   <title>MP-SPARQL - User's Guide and Reference</title>
  15   <authorgroup>
  16    <author>
  17     <firstname>Adam</firstname><surname>Dickmeiss</surname>
  18    </author>
  19   </authorgroup>
  20   <releaseinfo>&version;</releaseinfo>
  21   <copyright>
  22    <year>2014-2015</year>
  23    <holder>Index Data</holder>
  24   </copyright>
  25   <abstract>
  26    <simpara>
  27     This manual is part of MP-SPARQL version &version;.
  28     </simpara>
  29    <simpara>
  30     MP-XQuery is a Metaproxy module that converts Type-1/RPN Queries
  31     to SPARQL.
  32    </simpara>
  33    <simpara>
  34     MP-SPARQL is covered by the GNU General Public License version 2.
  35    </simpara>
  36    <simpara>
  37     <inlinemediaobject>
  38      <imageobject>
  39       <imagedata fileref="common/id.png" format="PNG"/>
  40      </imageobject>
  41      <imageobject>
  42       <imagedata fileref="common/id.eps" format="EPS"/>
  43      </imageobject>
  44     </inlinemediaobject>
  45    </simpara>
  46   </abstract>
  47  </bookinfo>
  48  <chapter id="introduction">
  49   <title>Introduction</title>
  50   <para>
  51    MP-SPARQL is a <ulink url="&url.metaproxy;">Metaproxy</ulink> module
  52    that converts Type-1/RPN queries to SPARQL.
  53   </para>
  54  </chapter>
  55  <chapter id="installation">
  56   <title>Installation</title>
  57   <para>
  58    MP-SPARQL is available as packages for CentOS/RHEL 5+6 and most
  59    recent Ubuntu/Debian versions. For other systems, the module must be build
  60    from source.
  61   </para>
  62   <sect1 id="installation.packages">
  63    <title>Installing packages</title>
  64    <para>
  65     You need to enable the relevant software repositories.
  66     For setting up refer to one of:
  67     <ulink
  68         url="http://ftp.indexdata.dk/pub/mp-sparql/redhat/centos/5.5/README">CentOS 5</ulink>,
  69     <ulink
  70         url="http://ftp.indexdata.dk/pub/mp-sparql/redhat/centos/6/README">CentOS 6</ulink>
  71     ,
  72     <ulink
  73         url="http://ftp.indexdata.dk/pub/mp-sparql/ubuntu/README">Ubuntu</ulink>
  74     and
  75     <ulink
  76         url="http://ftp.indexdata.dk/pub/mp-sparql/debian/README">Debian</ulink>
  77    </para>
  78    <para>
  79     The package is called <literal>mp-sparql</literal> on RHEL/Debian systems.
  80     Install that package and you are ready to use filter "sparql" in your
  81     setup.
  82    </para>
  83   </sect1>
  84   <sect1 id="installation.source">
  85    <title>Installing from source</title>
  86    <para>
  87     To build from source, you need metaproxy development
  88     packages. Metaproxy can be installed as follows:
  89     <screen>
  90      ./configure
  91      make
  92      sudo make install
  93     </screen>
  94     But consult the Metaproxy documentation for requirements and
  95     options.
  96    </para>
  97    <para>
  98     We are now ready to build the MP-SPARQL module with:
  99     <screen>
 100      cd mp-sparql-version
 101      make MP_CONFIG=/usr/local/bin/mp-config
 102     </screen>
 103     Adjust <literal>MP_CONFIG</literal> value
 104     above for the correct location of installed
 105     Metaproxy's mp-config. <literal>MP_CONFIG</literal> can be omitted
 106     if Metaproxy was installed in the system <filename>PATH</filename>.
 107    </para>
 108    <para>
 109     You can now install the <filename>metaproxy_filter_sparql.so</filename>
 110     in a directory searched by Metaproxy daemon.
 111     Specifically, that's the directories
 112     given by the <literal>dlpath</literal> configuration.
 113    </para>
 114    <para>
 115     If dlpath includes <filename>/usr/lib/metaproxy6/modules</filename>,
 116     the module can be installed with:
 117     <screen>
 118      cp src/metaproxy_filter_sparql.so /usr/lib/metaproxy6/modules
 119     </screen>
 120    </para>
 121    <note>
 122     <para>
 123      For RHEL/CentOS systems on 64-bit architectures, the correct paths is:
 124      <filename>/usr/lib64/metaproxy6/modules</filename>.
 125     </para>
 126    </note>
 127   </sect1>
 128  </chapter>
 129  <reference id="reference">
 130   <title>Reference</title>
 131    <partintro id="reference-introduction">
 132     <para>
 133      The material in this chapter is drawn directly from the individual
 134      manual entries.
 135     </para>
 136    </partintro>
 137    &manref;
 138  </reference>
 139
 140  <appendix id="license">
 141   <title>License</title>
 142   <para>
 143    Copyright (C) 2014-2015 Index Data
 144   </para>
 145
 146   <para>
 147    Metaproxy is free software; you can redistribute it and/or modify it under
 148    the terms of the GNU General Public License as published by the Free
 149    Software Foundation; either version 2, or (at your option) any later
 150    version.
 151    </para>
 152
 153   <para>
 154    Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
 155    WARRANTY; without even the implied warranty of MERCHANTABILITY or
 156    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 157    for more details.
 158   </para>
 159
 160   <para>
 161    You should have received a copy of the GNU General Public License
 162    along with Metaproxy; see the file LICENSE.  If not, write to the
 163    Free Software Foundation,
 164    51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 165    </para>
 166
 167  </appendix>
 168
 169  &gpl2;
 170 </book>
 171
 172 <!-- Keep this comment at the end of the file
 173 Local variables:
 174 mode: nxml
 175 nxml-child-indent: 1
 176 End:
 177 -->