source: gnome/platform/gnome-online-accounts.xml@ 206a253d

trunk
Last change on this file since 206a253d was 206a253d, checked in by Xi Ruoyao <xry111@…>, 4 hours ago

gnome-online-accounts: Make gi-docgen optional

  • Property mode set to 100644
File size: 8.0 KB
Line 
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 gnome-online-accounts-download-http
8 "&gnome-download-http;/gnome-online-accounts/&gnome-minor-52;/gnome-online-accounts-&gnome-online-accounts-version;.tar.xz">
9 <!ENTITY gnome-online-accounts-download-ftp " ">
10 <!ENTITY gnome-online-accounts-md5sum "7565f47b3d630d13921f15df82bd3413">
11 <!ENTITY gnome-online-accounts-size "464 KB">
12 <!ENTITY gnome-online-accounts-buildsize "33 MB">
13 <!ENTITY gnome-online-accounts-time "0.3 SBU">
14]>
15
16<sect1 id="gnome-online-accounts" xreflabel="gnome-online-accounts-&gnome-online-accounts-version;">
17 <?dbhtml filename="gnome-online-accounts.html"?>
18
19
20 <title>gnome-online-accounts-&gnome-online-accounts-version;</title>
21
22 <indexterm zone="gnome-online-accounts">
23 <primary sortas="a-gnome-online-accounts">gnome-online-accounts</primary>
24 </indexterm>
25
26 <sect2 role="package">
27 <title>Introduction to GNOME Online Accounts</title>
28
29 <para>
30 The <application>GNOME Online Accounts</application> package contains a
31 framework used to access the user's online accounts.
32 </para>
33
34 &lfs122_checked;
35
36 <bridgehead renderas="sect3">Package Information</bridgehead>
37 <itemizedlist spacing="compact">
38 <listitem>
39 <para>
40 Download (HTTP): <ulink url="&gnome-online-accounts-download-http;"/>
41 </para>
42 </listitem>
43 <listitem>
44 <para>
45 Download (FTP): <ulink url="&gnome-online-accounts-download-ftp;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download MD5 sum: &gnome-online-accounts-md5sum;
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download size: &gnome-online-accounts-size;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Estimated disk space required: &gnome-online-accounts-buildsize;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated build time: &gnome-online-accounts-time;
66 </para>
67 </listitem>
68 </itemizedlist>
69
70 <bridgehead renderas="sect3">GNOME Online Accounts Dependencies</bridgehead>
71
72 <bridgehead renderas="sect4">Required</bridgehead>
73 <para role="required">
74 <xref linkend="gcr4"/>,
75 <xref linkend="json-glib"/>,
76 <xref linkend="libadwaita1"/>,
77 <xref linkend="rest"/>, and
78 <xref linkend="vala"/>
79 </para>
80
81 <bridgehead renderas="sect4">Recommended</bridgehead>
82 <para role="recommended">
83 &gobject-introspection;
84 </para>
85
86 <bridgehead renderas="sect4">Optional</bridgehead>
87 <para role="optional">
88 <xref linkend="gi-docgen"/>,
89 <xref linkend="mitkrb"/>, and
90 <xref linkend="valgrind"/>
91 <!-- <ulink url="https://gitlab.com/accounts-sso/libaccounts-glib">libaccounts-glib</ulink>, and
92 <ulink url="https://launchpad.net/account-plugins">account-plugins</ulink> -->
93
94 </para>
95
96 </sect2>
97
98 <sect2 role="installation">
99 <title>Installation of GNOME Online Accounts</title>
100
101 <note>
102 <para>
103 <!-- Taken from Arch Linux - an immensely helpful link - Thanks -->
104 The Google API Key and OAuth tokens below are specific to LFS. If using
105 these instructions for another distro, or if you intend to distribute
106 binary copies of the software using these instructions, please obtain
107 your own keys following the instructions located at
108 <ulink url="https://www.chromium.org/developers/how-tos/api-keys"/>.
109 <!-- BLFS Devs, register an account at Google with your
110 @linuxfromscratch.org email address, and I'll make you an administrator
111 for the 'Google APIs for LFS' project (where the API and OAuth keys
112 were created for use in the book).-->
113 </para>
114 </note>
115
116 <para>
117 Install <application>GNOME Online Accounts</application> by running the following
118 commands:
119 </para>
120
121<screen><userinput>mkdir build &amp;&amp;
122cd build &amp;&amp;
123
124meson setup \
125 --prefix=/usr \
126 --buildtype=release \
127 -D documentation=false \
128 -D kerberos=false \
129 -D google_client_secret=5ntt6GbbkjnTVXx-MSxbmx5e \
130 -D google_client_id=595013732528-llk8trb03f0ldpqq6nprjp1s79596646.apps.googleusercontent.com \
131 .. &amp;&amp;
132ninja</userinput></screen>
133
134 <para>
135 If you've installed <xref linkend='gi-docgen'/> and you wish to
136 build and install the API documentation of this package, issue:
137 </para>
138
139<screen remap='doc'><userinput>meson configure -D documentation=true &amp;&amp;
140sed "s/project_name()/&amp; + '-' + meson.project_version()/" \
141 -i ../doc/meson.build &amp;&amp;
142ninja</userinput></screen>
143
144 <para>
145 This package does not come with a test suite.
146 </para>
147
148 <para>
149 Now, as the <systemitem class="username">root</systemitem> user:
150 </para>
151
152<screen role="root"><userinput>ninja install</userinput></screen>
153
154 </sect2>
155
156 <sect2 role="commands">
157 <title>Command Explanations</title>
158
159 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
160 href="../../xincludes/meson-buildtype-release.xml"/>
161
162 <para>
163 <parameter>-D google_*</parameter>: These switches set the
164 BLFS OAuth ID and secret for Google services.
165 </para>
166
167 <para>
168 <option>-D kerberos=true</option>: Use this switch if you have
169 installed <xref linkend="mitkrb" role="nodep"/> and wish to use it with
170 <application>GNOME Online Accounts</application>.
171 </para>
172
173 </sect2>
174
175 <sect2 role="content">
176 <title>Contents</title>
177
178 <segmentedlist>
179 <segtitle>Installed Programs</segtitle>
180 <segtitle>Installed Libraries</segtitle>
181 <segtitle>Installed Directories</segtitle>
182
183 <seglistitem>
184 <seg>
185 None
186 <!-- Let'snot include library executables for consistency -->
187 <!--goa-daemon and goa-identity-service (library executables)-->
188 </seg>
189 <seg>
190 libgoa-1.0.so and libgoa-backend-1.0.so
191 </seg>
192 <seg>
193 /usr/include/goa-1.0,
194 /usr/lib/goa-1.0, and
195 /usr/share/gtk-doc/html/goa (optional)
196 </seg>
197 </seglistitem>
198 </segmentedlist>
199
200 <variablelist>
201 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
202 <?dbfo list-presentation="list"?>
203 <?dbhtml list-presentation="table"?>
204
205 <!-- library executable, so let's not include it
206 <varlistentry id="goa-daemon">
207 <term><command>goa-daemon</command></term>
208 <listitem>
209 <para>
210 is the <application>GNOME Online Accounts</application> Daemon
211 </para>
212 <indexterm zone="gnome-online-accounts goa-daemon">
213 <primary sortas="b-goa-daemon">goa-daemon</primary>
214 </indexterm>
215 </listitem>
216 </varlistentry>
217 -->
218
219 <varlistentry id="libgoa-1">
220 <term><filename class="libraryfile">libgoa-1.0.so</filename></term>
221 <listitem>
222 <para>
223 contains the <application>GNOME Online Accounts</application>
224 API functions
225 </para>
226 <indexterm zone="gnome-online-accounts libgoa-1">
227 <primary sortas="c-libgoa-1">libgoa-1.0.so</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 <varlistentry id="libgoa-backend-1.0">
233 <term><filename class="libraryfile">libgoa-backend-1.0.so</filename></term>
234 <listitem>
235 <para>
236 contains functions used by <application>GNOME Online Accounts</application>
237 backends
238 </para>
239 <indexterm zone="gnome-online-accounts libgoa-backend-1.0">
240 <primary sortas="c-libgoa-backend-1.0">libgoa-backend-1.0.so</primary>
241 </indexterm>
242 </listitem>
243 </varlistentry>
244
245 </variablelist>
246
247 </sect2>
248
249</sect1>
Note: See TracBrowser for help on using the repository browser.