[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 |
|
---|
[7a81c7f] | 7 | <!ENTITY rest-download-http "&gnome-download-http;/rest/0.9/rest-&rest-version;.tar.xz">
|
---|
| 8 | <!ENTITY rest-download-ftp "&gnome-download-ftp;/rest/0.9/rest-&rest-version;.tar.xz">
|
---|
| 9 | <!ENTITY rest-md5sum "b997b83232be3814a1b78530c5700df9">
|
---|
| 10 | <!ENTITY rest-size "72 KB">
|
---|
| 11 | <!ENTITY rest-buildsize "3.2 MB (with tests)">
|
---|
| 12 | <!ENTITY rest-time "0.1 SBU (with tests)">
|
---|
[8615350] | 13 | ]>
|
---|
| 14 |
|
---|
[51dfb3e] | 15 | <sect1 id="rest" xreflabel="rest-&rest-version;">
|
---|
[8615350] | 16 | <?dbhtml filename="rest.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>rest-&rest-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="rest">
|
---|
| 22 | <primary sortas="a-rest">rest</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to rest</title>
|
---|
| 27 |
|
---|
| 28 | <para>
|
---|
| 29 | The <application>rest</application> package contains a library
|
---|
| 30 | that was designed to make it easier to access web services that
|
---|
| 31 | claim to be "RESTful". It includes convenience wrappers for
|
---|
| 32 | libsoup and libxml to ease remote use of the RESTful API.
|
---|
| 33 | </para>
|
---|
| 34 |
|
---|
[0942224] | 35 | &lfs112_checked;
|
---|
[8615350] | 36 |
|
---|
| 37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing="compact">
|
---|
| 39 | <listitem>
|
---|
| 40 | <para>
|
---|
| 41 | Download (HTTP): <ulink url="&rest-download-http;"/>
|
---|
| 42 | </para>
|
---|
| 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>
|
---|
| 46 | Download (FTP): <ulink url="&rest-download-ftp;"/>
|
---|
| 47 | </para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>
|
---|
| 51 | Download MD5 sum: &rest-md5sum;
|
---|
| 52 | </para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>
|
---|
| 56 | Download size: &rest-size;
|
---|
| 57 | </para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>
|
---|
| 61 | Estimated disk space required: &rest-buildsize;
|
---|
| 62 | </para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>
|
---|
| 66 | Estimated build time: &rest-time;
|
---|
| 67 | </para>
|
---|
| 68 | </listitem>
|
---|
| 69 | </itemizedlist>
|
---|
| 70 |
|
---|
| 71 | <bridgehead renderas="sect3">rest Dependencies</bridgehead>
|
---|
| 72 |
|
---|
| 73 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 74 | <para role="required">
|
---|
[7a81c7f] | 75 | <xref linkend="json-glib"/>,
|
---|
| 76 | <xref linkend="libsoup3"/>, and
|
---|
| 77 | <xref linkend="make-ca"/>
|
---|
[8615350] | 78 | </para>
|
---|
| 79 |
|
---|
| 80 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 81 | <para role="recommended">
|
---|
| 82 | <xref linkend="gobject-introspection"/>
|
---|
| 83 | </para>
|
---|
| 84 |
|
---|
| 85 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 86 | <para role="optional">
|
---|
[479c7fe] | 87 | <xref linkend="libadwaita1"/> (to build the demo),
|
---|
[7a81c7f] | 88 | <xref linkend="vala"/>, and
|
---|
[c5408a2] | 89 | <ulink url="&gi-docgen-url;">gi-docgen</ulink>
|
---|
[8615350] | 90 | </para>
|
---|
| 91 |
|
---|
| 92 | <para condition="html" role="usernotes">User Notes:
|
---|
| 93 | <ulink url="&blfs-wiki;/rest"/>
|
---|
| 94 | </para>
|
---|
| 95 | </sect2>
|
---|
| 96 |
|
---|
| 97 | <sect2 role="installation">
|
---|
| 98 | <title>Installation of rest</title>
|
---|
| 99 |
|
---|
| 100 | <para>
|
---|
| 101 | Install <application>rest</application> by running the following
|
---|
| 102 | commands:
|
---|
| 103 | </para>
|
---|
| 104 |
|
---|
[7a81c7f] | 105 | <screen><userinput>mkdir build &&
|
---|
| 106 | cd build &&
|
---|
| 107 |
|
---|
| 108 | meson --prefix=/usr \
|
---|
| 109 | --buildtype=release \
|
---|
| 110 | -Dexamples=false \
|
---|
| 111 | -Dgtk_doc=false .. &&
|
---|
| 112 | ninja</userinput></screen>
|
---|
[8615350] | 113 |
|
---|
| 114 | <para>
|
---|
[7a81c7f] | 115 | To test the results, issue: <command>ninja test</command>.
|
---|
[8615350] | 116 | </para>
|
---|
| 117 |
|
---|
| 118 | <para>
|
---|
| 119 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 120 | </para>
|
---|
| 121 |
|
---|
[7a81c7f] | 122 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[8615350] | 123 |
|
---|
| 124 | </sect2>
|
---|
| 125 |
|
---|
[d278ced] | 126 | <sect2 role="commands">
|
---|
| 127 | <title>Command Explanations</title>
|
---|
| 128 |
|
---|
[9a363500] | 129 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[7a81c7f] | 130 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 131 |
|
---|
| 132 | <para>
|
---|
| 133 | <parameter>-Dgtk_doc=false</parameter>: Remove this option if
|
---|
[c5408a2] | 134 | <ulink url="&gi-docgen-url;">gi-docgen</ulink>
|
---|
[7a81c7f] | 135 | is installed and you wish to build and install the API documentation.
|
---|
| 136 | </para>
|
---|
[9a363500] | 137 |
|
---|
[7a81c7f] | 138 | <para>
|
---|
| 139 | <parameter>-Dexamples=false</parameter>: Remove this option if
|
---|
[479c7fe] | 140 | <xref linkend="libadwaita1"/> is installed and you wish to build the
|
---|
[7a81c7f] | 141 | demonstration application provided by this package.
|
---|
| 142 | </para>
|
---|
| 143 |
|
---|
| 144 | <para>
|
---|
| 145 | <option>-Dvapi=true</option>: Use this switch if <xref linkend="vala"/>
|
---|
| 146 | is installed and you wish to build the Vala bindings provided by this
|
---|
| 147 | package.
|
---|
| 148 | </para>
|
---|
[d278ced] | 149 | </sect2>
|
---|
| 150 |
|
---|
[8615350] | 151 | <sect2 role="content">
|
---|
| 152 | <title>Contents</title>
|
---|
| 153 |
|
---|
| 154 | <segmentedlist>
|
---|
| 155 | <segtitle>Installed Programs</segtitle>
|
---|
| 156 | <segtitle>Installed Libraries</segtitle>
|
---|
| 157 | <segtitle>Installed Directories</segtitle>
|
---|
| 158 |
|
---|
| 159 | <seglistitem>
|
---|
| 160 | <seg>
|
---|
[7a81c7f] | 161 | librest-demo (optional)
|
---|
[8615350] | 162 | </seg>
|
---|
| 163 | <seg>
|
---|
[7a81c7f] | 164 | librest-1.0.so and librest-extras-1.0.so
|
---|
[8615350] | 165 | </seg>
|
---|
| 166 | <seg>
|
---|
[7a81c7f] | 167 | /usr/include/rest-1.0 and
|
---|
| 168 | /usr/share/gtk-doc/html/rest-1.0
|
---|
[8615350] | 169 | </seg>
|
---|
| 170 | </seglistitem>
|
---|
| 171 | </segmentedlist>
|
---|
| 172 |
|
---|
| 173 | <variablelist>
|
---|
| 174 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 175 | <?dbfo list-presentation="list"?>
|
---|
| 176 | <?dbhtml list-presentation="table"?>
|
---|
| 177 |
|
---|
[7a81c7f] | 178 | <varlistentry id="librest-demo">
|
---|
| 179 | <term><command>librest-demo</command></term>
|
---|
| 180 | <listitem>
|
---|
| 181 | <para>
|
---|
| 182 | provides an example of how to use the RESTful Web API Query
|
---|
| 183 | functions
|
---|
| 184 | </para>
|
---|
| 185 | <indexterm zone="rest librest-demo">
|
---|
| 186 | <primary sortas="b-librest-demo">librest-demo</primary>
|
---|
| 187 | </indexterm>
|
---|
| 188 | </listitem>
|
---|
| 189 | </varlistentry>
|
---|
| 190 |
|
---|
| 191 | <varlistentry id="librest-1.0">
|
---|
| 192 | <term><filename class="libraryfile">librest-1.0.so</filename></term>
|
---|
[8615350] | 193 | <listitem>
|
---|
| 194 | <para>
|
---|
[4c24eb0a] | 195 | contains the RESTful Web API Query functions
|
---|
[8615350] | 196 | </para>
|
---|
[7a81c7f] | 197 | <indexterm zone="rest librest-1.0">
|
---|
| 198 | <primary sortas="c-librest-1.0">librest-1.0.so</primary>
|
---|
[8615350] | 199 | </indexterm>
|
---|
| 200 | </listitem>
|
---|
| 201 | </varlistentry>
|
---|
| 202 |
|
---|
[7a81c7f] | 203 | <varlistentry id="librest-extras-1.0">
|
---|
| 204 | <term><filename class="libraryfile">librest-extras-1.0.so</filename></term>
|
---|
[8615350] | 205 | <listitem>
|
---|
| 206 | <para>
|
---|
[4c24eb0a] | 207 | contains extra RESTful Web API Query functions
|
---|
[8615350] | 208 | </para>
|
---|
[7a81c7f] | 209 | <indexterm zone="rest librest-extras-1.0">
|
---|
| 210 | <primary sortas="c-librest-extras-1.0">librest-extras-1.0.so</primary>
|
---|
[8615350] | 211 | </indexterm>
|
---|
| 212 | </listitem>
|
---|
| 213 | </varlistentry>
|
---|
| 214 |
|
---|
| 215 | </variablelist>
|
---|
| 216 |
|
---|
| 217 | </sect2>
|
---|
| 218 |
|
---|
| 219 | </sect1>
|
---|