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