[8615350] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY rest-download-http "&gnome-download-http;/rest/0.8/rest-&rest-version;.tar.xz">
|
---|
| 8 | <!ENTITY rest-download-ftp "&gnome-download-ftp;/rest/0.8/rest-&rest-version;.tar.xz">
|
---|
[ee9107e] | 9 | <!ENTITY rest-md5sum "ece4547298a81105f307369d73c21b9d">
|
---|
| 10 | <!ENTITY rest-size "332 KB">
|
---|
[262a108] | 11 | <!ENTITY rest-buildsize "12.5 MB (with tests)">
|
---|
| 12 | <!ENTITY rest-time "0.2 SBU (with tests)">
|
---|
[8615350] | 13 | ]>
|
---|
| 14 |
|
---|
[51dfb3e] | 15 | <sect1 id="rest" xreflabel="rest-&rest-version;">
|
---|
[8615350] | 16 | <?dbhtml filename="rest.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <date>$Date$</date>
|
---|
| 20 | </sect1info>
|
---|
| 21 |
|
---|
| 22 | <title>rest-&rest-version;</title>
|
---|
| 23 |
|
---|
| 24 | <indexterm zone="rest">
|
---|
| 25 | <primary sortas="a-rest">rest</primary>
|
---|
| 26 | </indexterm>
|
---|
| 27 |
|
---|
| 28 | <sect2 role="package">
|
---|
| 29 | <title>Introduction to rest</title>
|
---|
| 30 |
|
---|
| 31 | <para>
|
---|
| 32 | The <application>rest</application> package contains a library
|
---|
| 33 | that was designed to make it easier to access web services that
|
---|
| 34 | claim to be "RESTful". It includes convenience wrappers for
|
---|
| 35 | libsoup and libxml to ease remote use of the RESTful API.
|
---|
| 36 | </para>
|
---|
| 37 |
|
---|
[519aed4] | 38 | &lfs111_checked;
|
---|
[8615350] | 39 |
|
---|
| 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>
|
---|
| 44 | Download (HTTP): <ulink url="&rest-download-http;"/>
|
---|
| 45 | </para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>
|
---|
| 49 | Download (FTP): <ulink url="&rest-download-ftp;"/>
|
---|
| 50 | </para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>
|
---|
| 54 | Download MD5 sum: &rest-md5sum;
|
---|
| 55 | </para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>
|
---|
| 59 | Download size: &rest-size;
|
---|
| 60 | </para>
|
---|
| 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>
|
---|
| 64 | Estimated disk space required: &rest-buildsize;
|
---|
| 65 | </para>
|
---|
| 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
| 68 | <para>
|
---|
| 69 | Estimated build time: &rest-time;
|
---|
| 70 | </para>
|
---|
| 71 | </listitem>
|
---|
| 72 | </itemizedlist>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect3">rest Dependencies</bridgehead>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 77 | <para role="required">
|
---|
[2198a32] | 78 | <xref linkend="make-ca"/> and
|
---|
[8615350] | 79 | <xref linkend="libsoup"/>
|
---|
| 80 | </para>
|
---|
| 81 |
|
---|
| 82 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 83 | <para role="recommended">
|
---|
| 84 | <xref linkend="gobject-introspection"/>
|
---|
| 85 | </para>
|
---|
| 86 |
|
---|
| 87 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 88 | <para role="optional">
|
---|
[9a363500] | 89 | <xref linkend="gtk-doc"/> and
|
---|
| 90 | <ulink url="http://ltp.sourceforge.net/coverage/lcov.php">LCOV</ulink>
|
---|
[8615350] | 91 | </para>
|
---|
| 92 |
|
---|
| 93 | <para condition="html" role="usernotes">User Notes:
|
---|
| 94 | <ulink url="&blfs-wiki;/rest"/>
|
---|
| 95 | </para>
|
---|
| 96 | </sect2>
|
---|
| 97 |
|
---|
| 98 | <sect2 role="installation">
|
---|
| 99 | <title>Installation of rest</title>
|
---|
| 100 |
|
---|
| 101 | <para>
|
---|
| 102 | Install <application>rest</application> by running the following
|
---|
| 103 | commands:
|
---|
| 104 | </para>
|
---|
| 105 |
|
---|
[7ad7842] | 106 | <screen><userinput>./configure --prefix=/usr &&
|
---|
[8615350] | 107 | make</userinput></screen>
|
---|
| 108 |
|
---|
| 109 | <para>
|
---|
[9a363500] | 110 | To test the results, issue: <command>make check</command>.
|
---|
[83349bf] | 111 | The flickr test will fail due to Public API changes on their site.
|
---|
[815f8eff] | 112 | The OAuth tests will fail because the website that it uses to test
|
---|
| 113 | connectivity via OAuth no longer exists.
|
---|
[8615350] | 114 | </para>
|
---|
| 115 |
|
---|
| 116 | <para>
|
---|
| 117 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 118 | </para>
|
---|
| 119 |
|
---|
| 120 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 121 |
|
---|
| 122 | </sect2>
|
---|
| 123 |
|
---|
[d278ced] | 124 | <sect2 role="commands">
|
---|
| 125 | <title>Command Explanations</title>
|
---|
| 126 |
|
---|
[9a363500] | 127 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 128 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
| 129 |
|
---|
[d278ced] | 130 | </sect2>
|
---|
| 131 |
|
---|
[8615350] | 132 | <sect2 role="content">
|
---|
| 133 | <title>Contents</title>
|
---|
| 134 |
|
---|
| 135 | <segmentedlist>
|
---|
| 136 | <segtitle>Installed Programs</segtitle>
|
---|
| 137 | <segtitle>Installed Libraries</segtitle>
|
---|
| 138 | <segtitle>Installed Directories</segtitle>
|
---|
| 139 |
|
---|
| 140 | <seglistitem>
|
---|
| 141 | <seg>
|
---|
| 142 | None
|
---|
| 143 | </seg>
|
---|
| 144 | <seg>
|
---|
| 145 | librest-0.7.so and librest-extras-0.7.so
|
---|
| 146 | </seg>
|
---|
| 147 | <seg>
|
---|
| 148 | /usr/include/rest-0.7 and
|
---|
| 149 | /usr/share/gtk-doc/html/rest-0.7
|
---|
| 150 | </seg>
|
---|
| 151 | </seglistitem>
|
---|
| 152 | </segmentedlist>
|
---|
| 153 |
|
---|
| 154 | <variablelist>
|
---|
| 155 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 156 | <?dbfo list-presentation="list"?>
|
---|
| 157 | <?dbhtml list-presentation="table"?>
|
---|
| 158 |
|
---|
| 159 | <varlistentry id="librest-0.7">
|
---|
| 160 | <term><filename class="libraryfile">librest-0.7.so</filename></term>
|
---|
| 161 | <listitem>
|
---|
| 162 | <para>
|
---|
[4c24eb0a] | 163 | contains the RESTful Web API Query functions
|
---|
[8615350] | 164 | </para>
|
---|
| 165 | <indexterm zone="rest librest-0.7">
|
---|
| 166 | <primary sortas="c-librest-0.7">librest-0.7.so</primary>
|
---|
| 167 | </indexterm>
|
---|
| 168 | </listitem>
|
---|
| 169 | </varlistentry>
|
---|
| 170 |
|
---|
| 171 | <varlistentry id="librest-extras-0.7">
|
---|
| 172 | <term><filename class="libraryfile">librest-extras-0.7.so</filename></term>
|
---|
| 173 | <listitem>
|
---|
| 174 | <para>
|
---|
[4c24eb0a] | 175 | contains extra RESTful Web API Query functions
|
---|
[8615350] | 176 | </para>
|
---|
| 177 | <indexterm zone="rest librest-extras-0.7">
|
---|
| 178 | <primary sortas="c-librest-extras-0.7">librest-extras-0.7.so</primary>
|
---|
| 179 | </indexterm>
|
---|
| 180 | </listitem>
|
---|
| 181 | </varlistentry>
|
---|
| 182 |
|
---|
| 183 | </variablelist>
|
---|
| 184 |
|
---|
| 185 | </sect2>
|
---|
| 186 |
|
---|
| 187 | </sect1>
|
---|