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 libgdata-download-http "&gnome-download-http;/libgdata/0.18/libgdata-&libgdata-version;.tar.xz">
|
---|
8 | <!ENTITY libgdata-download-ftp " ">
|
---|
9 | <!ENTITY libgdata-md5sum "92b058d1a0af5d1b96c86c21820f1eff">
|
---|
10 | <!ENTITY libgdata-size "832 KB">
|
---|
11 | <!ENTITY libgdata-buildsize "54 MB (with tests)">
|
---|
12 | <!ENTITY libgdata-time "0.5 SBU (with tests)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="libgdata" xreflabel="libgdata-&libgdata-version;">
|
---|
16 | <?dbhtml filename="libgdata.html"?>
|
---|
17 |
|
---|
18 |
|
---|
19 | <title>libgdata-&libgdata-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="libgdata">
|
---|
22 | <primary sortas="a-libgdata">libgdata</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to libgdata</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | The <application>libgdata</application> package is a GLib-based
|
---|
30 | library for accessing online service APIs using the GData protocol, most
|
---|
31 | notably, Google's services. It provides APIs to access the common Google
|
---|
32 | services and has full asynchronous support.
|
---|
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="&libgdata-download-http;"/>
|
---|
42 | </para>
|
---|
43 | </listitem>
|
---|
44 | <listitem>
|
---|
45 | <para>
|
---|
46 | Download (FTP): <ulink url="&libgdata-download-ftp;"/>
|
---|
47 | </para>
|
---|
48 | </listitem>
|
---|
49 | <listitem>
|
---|
50 | <para>
|
---|
51 | Download MD5 sum: &libgdata-md5sum;
|
---|
52 | </para>
|
---|
53 | </listitem>
|
---|
54 | <listitem>
|
---|
55 | <para>
|
---|
56 | Download size: &libgdata-size;
|
---|
57 | </para>
|
---|
58 | </listitem>
|
---|
59 | <listitem>
|
---|
60 | <para>
|
---|
61 | Estimated disk space required: &libgdata-buildsize;
|
---|
62 | </para>
|
---|
63 | </listitem>
|
---|
64 | <listitem>
|
---|
65 | <para>
|
---|
66 | Estimated build time: &libgdata-time;
|
---|
67 | </para>
|
---|
68 | </listitem>
|
---|
69 | </itemizedlist>
|
---|
70 |
|
---|
71 | <bridgehead renderas="sect3">libgdata Dependencies</bridgehead>
|
---|
72 |
|
---|
73 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
74 | <para role="required">
|
---|
75 | <xref linkend="libsoup"/>,
|
---|
76 | <xref linkend="gnome-online-accounts"/>,
|
---|
77 | <xref linkend="gtk3"/>,
|
---|
78 | <xref linkend="json-glib"/>, and
|
---|
79 | <xref linkend="vala"/>
|
---|
80 | </para>
|
---|
81 |
|
---|
82 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
83 | <para role="recommended">
|
---|
84 | <xref linkend="gcr"/> and
|
---|
85 | &gobject-introspection;
|
---|
86 | </para>
|
---|
87 |
|
---|
88 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
89 | <para role="optional">
|
---|
90 | <xref linkend="gtk-doc"/> (for documentation), and
|
---|
91 | <xref linkend="liboauth"/> (for OAuth v1 support) <!-- and
|
---|
92 | <xref linkend="uhttpmock"/> (required for tests)-->
|
---|
93 | <!-- uhttpmock is commented out until libgdata is ported to soup3 -->
|
---|
94 | </para>
|
---|
95 |
|
---|
96 | </sect2>
|
---|
97 |
|
---|
98 | <sect2 role="installation">
|
---|
99 | <title>Installation of libgdata</title>
|
---|
100 |
|
---|
101 | <para>
|
---|
102 | Install <application>libgdata</application> by running the following
|
---|
103 | commands:
|
---|
104 | </para>
|
---|
105 |
|
---|
106 | <screen><userinput>mkdir build &&
|
---|
107 | cd build &&
|
---|
108 |
|
---|
109 | meson setup --prefix=/usr \
|
---|
110 | --buildtype=release \
|
---|
111 | -D gtk_doc=false \
|
---|
112 | -D always_build_tests=false \
|
---|
113 | .. &&
|
---|
114 | ninja</userinput></screen>
|
---|
115 |
|
---|
116 | <!--
|
---|
117 | <para>
|
---|
118 | If you wish to run the test suite, make sure
|
---|
119 | <xref linkend="uhttpmock"/> is installed and remove
|
---|
120 | <parameter>-D always_build_tests=false</parameter> in the
|
---|
121 | <command>meson</command> command line. To test the results,
|
---|
122 | issue: <command>ninja test</command>. Note that
|
---|
123 | the tests need network access.
|
---|
124 | </para>
|
---|
125 | -->
|
---|
126 |
|
---|
127 | <!-- Tests requires uhttpmock, but they are only compatible with a version that
|
---|
128 | uses libsoup2. Without this version, all of the tests fail due to mixing
|
---|
129 | symbols from libsoup3 and libsoup2 in the same program. -->
|
---|
130 |
|
---|
131 | <para>
|
---|
132 | This package does not come with a functional test suite.
|
---|
133 | </para>
|
---|
134 |
|
---|
135 | <para>
|
---|
136 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
137 | </para>
|
---|
138 |
|
---|
139 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
140 |
|
---|
141 | </sect2>
|
---|
142 |
|
---|
143 | <sect2 role="commands">
|
---|
144 | <title>Command Explanations</title>
|
---|
145 |
|
---|
146 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
147 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
148 |
|
---|
149 | <para>
|
---|
150 | <parameter>-D gtk_doc=false</parameter>: Remove this if you have
|
---|
151 | <xref linkend="gtk-doc"/> installed and want to rebuild the
|
---|
152 | documentation with it.
|
---|
153 | </para>
|
---|
154 | <para>
|
---|
155 | <option>-D oauth1=enabled</option>: Use this option if you wish to build
|
---|
156 | in support for OAuth v1. Note that you must have
|
---|
157 | <xref linkend="liboauth"/> installed in order to enable this option.
|
---|
158 | </para>
|
---|
159 |
|
---|
160 | </sect2>
|
---|
161 |
|
---|
162 | <sect2 role="content">
|
---|
163 | <title>Contents</title>
|
---|
164 |
|
---|
165 | <segmentedlist>
|
---|
166 | <segtitle>Installed Programs</segtitle>
|
---|
167 | <segtitle>Installed Libraries</segtitle>
|
---|
168 | <segtitle>Installed Directories</segtitle>
|
---|
169 |
|
---|
170 | <seglistitem>
|
---|
171 | <seg>
|
---|
172 | None
|
---|
173 | </seg>
|
---|
174 | <seg>
|
---|
175 | libgdata.so
|
---|
176 | </seg>
|
---|
177 | <seg>
|
---|
178 | /usr/include/libgdata and
|
---|
179 | /usr/share/gtk-doc/html/gdata
|
---|
180 | </seg>
|
---|
181 | </seglistitem>
|
---|
182 | </segmentedlist>
|
---|
183 |
|
---|
184 | <variablelist>
|
---|
185 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
186 | <?dbfo list-presentation="list"?>
|
---|
187 | <?dbhtml list-presentation="table"?>
|
---|
188 |
|
---|
189 | <varlistentry id="libgdata-lib">
|
---|
190 | <term><filename class="libraryfile">libgdata.so</filename></term>
|
---|
191 | <listitem>
|
---|
192 | <para>
|
---|
193 | contains the <application>libgdata</application> API functions
|
---|
194 | </para>
|
---|
195 | <indexterm zone="libgdata libgdata-lib">
|
---|
196 | <primary sortas="c-libgdata">libgdata.so</primary>
|
---|
197 | </indexterm>
|
---|
198 | </listitem>
|
---|
199 | </varlistentry>
|
---|
200 |
|
---|
201 | </variablelist>
|
---|
202 |
|
---|
203 | </sect2>
|
---|
204 |
|
---|
205 | </sect1>
|
---|