[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 |
|
---|
[03c0def] | 35 | &lfs113_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">
|
---|
[f56d2e7] | 87 | <xref linkend="gi-docgen"/>,
|
---|
[0fd2551d] | 88 | <xref linkend="libadwaita1"/> and
|
---|
| 89 | <xref linkend="gtksourceview5"/> (to build the demo), and
|
---|
[f56d2e7] | 90 | <xref linkend="vala"/>
|
---|
[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 |
|
---|
[7a81c7f] | 106 | <screen><userinput>mkdir build &&
|
---|
| 107 | cd build &&
|
---|
| 108 |
|
---|
[91318eb] | 109 | meson setup --prefix=/usr \
|
---|
| 110 | --buildtype=release \
|
---|
| 111 | -Dexamples=false \
|
---|
| 112 | -Dgtk_doc=false \
|
---|
| 113 | .. &&
|
---|
[7a81c7f] | 114 | ninja</userinput></screen>
|
---|
[8615350] | 115 |
|
---|
[5b086fb] | 116 | <para>
|
---|
| 117 | If you have <xref linkend='gi-docgen'/> installed and wish to build
|
---|
| 118 | the API documentation for this package, issue:
|
---|
| 119 | </para>
|
---|
| 120 |
|
---|
| 121 | <screen role='nodump'><userinput>sed "/output/s/librest-1.0/rest-&rest-version;/" -i ../docs/meson.build &&
|
---|
| 122 | meson configure -Dgtk_doc=true &&
|
---|
| 123 | ninja</userinput></screen>
|
---|
| 124 |
|
---|
[8615350] | 125 | <para>
|
---|
[7a81c7f] | 126 | To test the results, issue: <command>ninja test</command>.
|
---|
[8615350] | 127 | </para>
|
---|
| 128 |
|
---|
| 129 | <para>
|
---|
| 130 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 131 | </para>
|
---|
| 132 |
|
---|
[7a81c7f] | 133 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[8615350] | 134 |
|
---|
| 135 | </sect2>
|
---|
| 136 |
|
---|
[d278ced] | 137 | <sect2 role="commands">
|
---|
| 138 | <title>Command Explanations</title>
|
---|
| 139 |
|
---|
[9a363500] | 140 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[7a81c7f] | 141 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 142 |
|
---|
[a51e56d5] | 143 | <para>
|
---|
| 144 | <parameter>-Dgtk_doc=false</parameter>: &gi-doc-disable;
|
---|
| 145 | </para>
|
---|
| 146 |
|
---|
[7a81c7f] | 147 | <para>
|
---|
| 148 | <parameter>-Dexamples=false</parameter>: Remove this option if
|
---|
[0fd2551d] | 149 | <xref linkend="libadwaita1"/> and <xref linkend="gtksourceview5"/> are
|
---|
| 150 | installed and you wish to build the demonstration application provided
|
---|
| 151 | by this package.
|
---|
[7a81c7f] | 152 | </para>
|
---|
| 153 |
|
---|
| 154 | <para>
|
---|
| 155 | <option>-Dvapi=true</option>: Use this switch if <xref linkend="vala"/>
|
---|
| 156 | is installed and you wish to build the Vala bindings provided by this
|
---|
| 157 | package.
|
---|
| 158 | </para>
|
---|
[d278ced] | 159 | </sect2>
|
---|
| 160 |
|
---|
[8615350] | 161 | <sect2 role="content">
|
---|
| 162 | <title>Contents</title>
|
---|
| 163 |
|
---|
| 164 | <segmentedlist>
|
---|
| 165 | <segtitle>Installed Programs</segtitle>
|
---|
| 166 | <segtitle>Installed Libraries</segtitle>
|
---|
| 167 | <segtitle>Installed Directories</segtitle>
|
---|
| 168 |
|
---|
| 169 | <seglistitem>
|
---|
| 170 | <seg>
|
---|
[7a81c7f] | 171 | librest-demo (optional)
|
---|
[8615350] | 172 | </seg>
|
---|
| 173 | <seg>
|
---|
[7a81c7f] | 174 | librest-1.0.so and librest-extras-1.0.so
|
---|
[8615350] | 175 | </seg>
|
---|
| 176 | <seg>
|
---|
[7a81c7f] | 177 | /usr/include/rest-1.0 and
|
---|
| 178 | /usr/share/gtk-doc/html/rest-1.0
|
---|
[8615350] | 179 | </seg>
|
---|
| 180 | </seglistitem>
|
---|
| 181 | </segmentedlist>
|
---|
| 182 |
|
---|
| 183 | <variablelist>
|
---|
| 184 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 185 | <?dbfo list-presentation="list"?>
|
---|
| 186 | <?dbhtml list-presentation="table"?>
|
---|
| 187 |
|
---|
[7a81c7f] | 188 | <varlistentry id="librest-demo">
|
---|
| 189 | <term><command>librest-demo</command></term>
|
---|
| 190 | <listitem>
|
---|
| 191 | <para>
|
---|
| 192 | provides an example of how to use the RESTful Web API Query
|
---|
| 193 | functions
|
---|
| 194 | </para>
|
---|
| 195 | <indexterm zone="rest librest-demo">
|
---|
| 196 | <primary sortas="b-librest-demo">librest-demo</primary>
|
---|
| 197 | </indexterm>
|
---|
| 198 | </listitem>
|
---|
| 199 | </varlistentry>
|
---|
| 200 |
|
---|
| 201 | <varlistentry id="librest-1.0">
|
---|
| 202 | <term><filename class="libraryfile">librest-1.0.so</filename></term>
|
---|
[8615350] | 203 | <listitem>
|
---|
| 204 | <para>
|
---|
[4c24eb0a] | 205 | contains the RESTful Web API Query functions
|
---|
[8615350] | 206 | </para>
|
---|
[7a81c7f] | 207 | <indexterm zone="rest librest-1.0">
|
---|
| 208 | <primary sortas="c-librest-1.0">librest-1.0.so</primary>
|
---|
[8615350] | 209 | </indexterm>
|
---|
| 210 | </listitem>
|
---|
| 211 | </varlistentry>
|
---|
| 212 |
|
---|
[7a81c7f] | 213 | <varlistentry id="librest-extras-1.0">
|
---|
| 214 | <term><filename class="libraryfile">librest-extras-1.0.so</filename></term>
|
---|
[8615350] | 215 | <listitem>
|
---|
| 216 | <para>
|
---|
[4c24eb0a] | 217 | contains extra RESTful Web API Query functions
|
---|
[8615350] | 218 | </para>
|
---|
[7a81c7f] | 219 | <indexterm zone="rest librest-extras-1.0">
|
---|
| 220 | <primary sortas="c-librest-extras-1.0">librest-extras-1.0.so</primary>
|
---|
[8615350] | 221 | </indexterm>
|
---|
| 222 | </listitem>
|
---|
| 223 | </varlistentry>
|
---|
| 224 |
|
---|
| 225 | </variablelist>
|
---|
| 226 |
|
---|
| 227 | </sect2>
|
---|
| 228 |
|
---|
| 229 | </sect1>
|
---|