1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
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.9/rest-&rest-version;.tar.xz">
|
---|
8 | <!ENTITY rest-download-ftp " ">
|
---|
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)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="rest" xreflabel="rest-&rest-version;">
|
---|
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 make remote usage of the RESTful API easier.
|
---|
33 | </para>
|
---|
34 |
|
---|
35 | &lfs122_checked;
|
---|
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">
|
---|
75 | <xref linkend="json-glib"/>,
|
---|
76 | <xref linkend="libsoup3"/>, and
|
---|
77 | <xref linkend="make-ca"/>
|
---|
78 | </para>
|
---|
79 |
|
---|
80 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
81 | <para role="recommended">
|
---|
82 | &gobject-introspection;
|
---|
83 | </para>
|
---|
84 |
|
---|
85 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
86 | <para role="optional">
|
---|
87 | <xref linkend="gi-docgen"/>,
|
---|
88 | <xref linkend="libadwaita1"/> and
|
---|
89 | <xref linkend="gtksourceview5"/> (to build the demo), and
|
---|
90 | <xref linkend="vala"/>
|
---|
91 | </para>
|
---|
92 |
|
---|
93 | &test-use-internet;
|
---|
94 |
|
---|
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 |
|
---|
105 | <screen><userinput>mkdir build &&
|
---|
106 | cd build &&
|
---|
107 |
|
---|
108 | meson setup --prefix=/usr \
|
---|
109 | --buildtype=release \
|
---|
110 | -D examples=false \
|
---|
111 | -D gtk_doc=false \
|
---|
112 | .. &&
|
---|
113 | ninja</userinput></screen>
|
---|
114 |
|
---|
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 &&
|
---|
121 | meson configure -D gtk_doc=true &&
|
---|
122 | ninja</userinput></screen>
|
---|
123 |
|
---|
124 | <para>
|
---|
125 | To test the results, issue: <command>ninja test</command>.
|
---|
126 | </para>
|
---|
127 |
|
---|
128 | <para>
|
---|
129 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
130 | </para>
|
---|
131 |
|
---|
132 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
133 |
|
---|
134 | </sect2>
|
---|
135 |
|
---|
136 | <sect2 role="commands">
|
---|
137 | <title>Command Explanations</title>
|
---|
138 |
|
---|
139 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
140 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
141 |
|
---|
142 | <para>
|
---|
143 | <parameter>-D gtk_doc=false</parameter>: &gi-doc-disable;
|
---|
144 | </para>
|
---|
145 |
|
---|
146 | <para>
|
---|
147 | <parameter>-D examples=false</parameter>: Remove this option if
|
---|
148 | <xref linkend="libadwaita1"/> and <xref linkend="gtksourceview5"/> are
|
---|
149 | installed and you wish to build the demonstration application provided
|
---|
150 | by this package.
|
---|
151 | </para>
|
---|
152 |
|
---|
153 | <para>
|
---|
154 | <option>-D vapi=true</option>: Use this switch if <xref linkend="vala"/>
|
---|
155 | is installed and you wish to build the Vala bindings provided by this
|
---|
156 | package.
|
---|
157 | </para>
|
---|
158 | </sect2>
|
---|
159 |
|
---|
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>
|
---|
170 | librest-demo (optional)
|
---|
171 | </seg>
|
---|
172 | <seg>
|
---|
173 | librest-1.0.so and librest-extras-1.0.so
|
---|
174 | </seg>
|
---|
175 | <seg>
|
---|
176 | /usr/include/rest-1.0 and
|
---|
177 | /usr/share/gtk-doc/html/rest-1.0
|
---|
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 |
|
---|
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>
|
---|
202 | <listitem>
|
---|
203 | <para>
|
---|
204 | contains the RESTful Web API Query functions
|
---|
205 | </para>
|
---|
206 | <indexterm zone="rest librest-1.0">
|
---|
207 | <primary sortas="c-librest-1.0">librest-1.0.so</primary>
|
---|
208 | </indexterm>
|
---|
209 | </listitem>
|
---|
210 | </varlistentry>
|
---|
211 |
|
---|
212 | <varlistentry id="librest-extras-1.0">
|
---|
213 | <term><filename class="libraryfile">librest-extras-1.0.so</filename></term>
|
---|
214 | <listitem>
|
---|
215 | <para>
|
---|
216 | contains extra RESTful Web API Query functions
|
---|
217 | </para>
|
---|
218 | <indexterm zone="rest librest-extras-1.0">
|
---|
219 | <primary sortas="c-librest-extras-1.0">librest-extras-1.0.so</primary>
|
---|
220 | </indexterm>
|
---|
221 | </listitem>
|
---|
222 | </varlistentry>
|
---|
223 |
|
---|
224 | </variablelist>
|
---|
225 |
|
---|
226 | </sect2>
|
---|
227 |
|
---|
228 | </sect1>
|
---|