source: x/lib/xdg-desktop-portal.xml@ d93c6b0

12.1 12.2 gimp3 ken/TL2024 lazarus plabs/newcss rahul/power-profiles-daemon trunk xry111/for-12.3 xry111/llvm18 xry111/spidermonkey128
Last change on this file since d93c6b0 was 7da4bea5, checked in by Pierre Labastie <pierre.labastie@…>, 9 months ago

xdg-desktop-portal: add runtime dep on backend

Also small nitpick on text...
  • Property mode set to 100644
File size: 9.3 KB
Line 
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
7 <!ENTITY xdg-desktop-portal-download-http "https://github.com/flatpak/xdg-desktop-portal/releases/download/&xdg-desktop-portal-version;/xdg-desktop-portal-&xdg-desktop-portal-version;.tar.xz">
8 <!ENTITY xdg-desktop-portal-download-ftp " ">
9 <!ENTITY xdg-desktop-portal-md5sum "20e0b28c1528e57b13cc236ba7840e03">
10 <!ENTITY xdg-desktop-portal-size "683 KB">
11 <!ENTITY xdg-desktop-portal-buildsize "45 MB (with tests)">
12 <!ENTITY xdg-desktop-portal-time "?? SBU">
13]>
14
15<sect1 id="xdg-desktop-portal" xreflabel="xdg-desktop-portal-&xdg-desktop-portal-version;">
16 <?dbhtml filename="xdg-desktop-portal.html"?>
17
18 <title>xdg-desktop-portal-&xdg-desktop-portal-version;</title>
19
20 <indexterm zone="xdg-desktop-portal">
21 <primary sortas="a-xdg-desktop-portal">xdg-desktop-portal</primary>
22 </indexterm>
23
24 <sect2 role="package">
25 <title>Introduction to xdg-desktop-portal</title>
26
27 <para>
28 <application>xdg-desktop-portal</application> is a D-Bus service that
29 allows applications to interact with the desktop in a safe way. Several
30 aspects of desktop interaction, like file chooser, desktop style, etc
31 are implmented in different D-Bus APIs, known as
32 <emphasis>portals</emphasis>. Sandboxed
33 applications benefit the most from this service since they don't need
34 special permissions to use the portal APIs, but any application can use
35 it. <application>xdg-desktop-portal</application> safeguards many
36 resources and features with a user-controlled permission system. This
37 service needs a backend implementing desktop-specific portal interfaces.
38 </para>
39
40 &lfs120_checked;
41
42 <bridgehead renderas="sect3">Package Information</bridgehead>
43 <itemizedlist spacing="compact">
44 <listitem>
45 <para>
46 Download (HTTP): <ulink url="&xdg-desktop-portal-download-http;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download (FTP): <ulink url="&xdg-desktop-portal-download-ftp;"/>
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download MD5 sum: &xdg-desktop-portal-md5sum;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Download size: &xdg-desktop-portal-size;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated disk space required: &xdg-desktop-portal-buildsize;
67 </para>
68 </listitem>
69 <listitem>
70 <para>
71 Estimated build time: &xdg-desktop-portal-time;
72 </para>
73 </listitem>
74 </itemizedlist>
75
76 <!--
77 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
78 <itemizedlist spacing="compact">
79 <listitem>
80 <para>
81 Required patch:
82 <ulink url="&patch-root;/xdg-desktop-portal-&xdg-desktop-portal-version;-patch_name-patch_version.patch"/>
83 </para>
84 </listitem>
85 </itemizedlist>
86 -->
87 <bridgehead renderas="sect3">xdg-desktop-portal Dependencies</bridgehead>
88
89 <bridgehead renderas="sect4">Required</bridgehead>
90 <para role="required">
91 <xref linkend="fuse3"/>,
92 <xref linkend="gdk-pixbuf"/>,
93 <xref linkend="json-glib"/>,
94 <xref linkend="pipewire"/>, and
95 <xref role="runtime" linkend="dbus"/> (at runtime).
96 Furthermore, a backend is needed at runtime for this package to be of
97 any use, either
98 <xref role="runtime" linkend="xdg-desktop-portal-gtk"/> or
99 <xref role="nodep" linkend="xdg-desktop-portal-gnome"/> or
100 <xref role="nodep" linkend="xdg-desktop-portal-lxqt"/>
101 </para>
102
103 <bridgehead renderas="sect4">Recommended</bridgehead>
104 <para role="recommended">
105 <xref linkend="bubblewrap"/> and
106 <xref linkend="docutils"/> (for building the manual pages)
107 </para>
108
109 <note>
110 <para>
111 Although there is an option to build the package
112 without <application>bubblewrap</application>, upstream
113 developers and LFS editors alike highly recommend to not
114 use this possibility, that would create a big security
115 hole.
116 </para>
117 </note>
118
119 <bridgehead renderas="sect4">Optional</bridgehead>
120 <para role="optional">
121 <xref linkend="geoclue2"/> (for the <quote>location</quote> portal), and
122 <xref linkend="pytest"/> with
123 <xref linkend="libportal"/> (for running tests)
124 </para>
125
126 <bridgehead renderas="sect4">Optional (for building
127 the documentation)</bridgehead>
128 <para role="optional">
129 <xref linkend="sphinx"/> with
130 <ulink url="https://pypi.org/project/sphinxext-opengraph/">sphinxext.opengraph</ulink>,
131 <ulink url="https://pypi.org/project/sphinx-copybutton/">sphinx_copybutton</ulink>,
132 <ulink url="https://pypi.org/project/furo/">furo</ulink>, and
133 <ulink url="https://github.com/flatpak/flatpak">flatpak</ulink>
134 </para>
135
136 </sect2>
137
138 <sect2 role="installation">
139 <title>Installation of xdg-desktop-portal</title>
140
141 <para>
142 Install <application>xdg-desktop-portal</application> by running the
143 following commands:
144 </para>
145
146<screen><userinput>mkdir build &amp;&amp;
147cd build &amp;&amp;
148
149meson setup .. --prefix=/usr &amp;&amp;
150ninja</userinput></screen>
151
152 <para>
153 If you have installed the needed dependencies, you can test the results
154 by running <command>ninja test</command>.
155 </para>
156
157 <para>
158 Now, as the &root; user:
159 </para>
160
161<screen role="root"><userinput>ninja install</userinput></screen>
162
163 <para revision="sysv">
164 Remove systemd files that are useless: as the &root; user:
165 </para>
166
167<screen role="root" revision="sysv"><userinput>rm -rvf /usr/lib/systemd</userinput></screen>
168
169 </sect2>
170
171 <sect2 role="configuration">
172 <title>Configuring xdg-desktop-portal</title>
173
174 <sect3 id="xdg-desktop-portal-config">
175 <title>Config Files</title>
176 <para>
177 The main configuration files are
178 <filename>~/.config/xdg-desktop-portal/portals.conf</filename>,
179 <filename>/etc/xdg-desktop-portal/portals.conf</filename>, and
180 <filename>/usr/share/xdg-desktop-portal/portals.conf</filename>.
181 Several other locations can be searched for configuration files. See
182 <filename>portals.conf(5)</filename>.
183 </para>
184
185 <indexterm zone="xdg-desktop-portal xdg-desktop-portal-config">
186 <primary sortas="e-AA.config-xdg-desktop-portal-portals.conf">~/.config/xdg-desktop-portal/portals.conf</primary>
187 </indexterm>
188
189 <indexterm zone="xdg-desktop-portal xdg-desktop-portal-config">
190 <primary
191 sortas="e-etc-xdg-desktop-portal-portals.conf">/etc/xdg-desktop-portal/portals.conf</primary>
192 </indexterm>
193
194 <indexterm zone="xdg-desktop-portal xdg-desktop-portal-config">
195 <primary
196 sortas="e-usr-share-xdg-desktop-portal-portals.conf">/usr/share/xdg-desktop-portal/portals.conf</primary>
197 </indexterm>
198 </sect3>
199
200 <sect3><title>Configuration Information</title>
201
202 <para>
203 The various configuration files are used to choose the backend
204 depending of various conditions. See
205 <filename>portals.conf(5)</filename> for details.
206 </para>
207 </sect3>
208
209 </sect2>
210
211 <sect2 role="content">
212 <title>Contents</title>
213
214 <segmentedlist>
215 <segtitle>Installed Programs</segtitle>
216 <segtitle>Installed Librar(y,ies)</segtitle>
217 <segtitle>Installed Director(y,ies)</segtitle>
218
219 <seglistitem>
220 <seg>
221 several daemons in /usr/libexec
222 </seg>
223 <seg>
224 None
225 </seg>
226 <seg>
227 None
228 </seg>
229 </seglistitem>
230 </segmentedlist>
231 <!--
232 <variablelist>
233 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
234 <?dbfo list-presentation="list"?>
235 <?dbhtml list-presentation="table"?>
236
237 <!- - If the program or library name conflicts with (is the same as) the
238 package name, add -prog or -lib to the varlistentry entity id
239 and the 2nd entry of the indexterm zone entity - ->
240
241 <varlistentry id="PROGRAM1">
242 <term><command>PROGRAM1</command></term>
243 <listitem>
244 <para>
245 does this ..... (no period at the end)
246 </para>
247 <indexterm zone="xdg-desktop-portal PROGRAM1">
248 <primary sortas="b-PROGRAM1">PROGRAM1</primary>
249 </indexterm>
250 </listitem>
251 </varlistentry>
252
253 <varlistentry id="PROGRAM2">
254 <term><command>PROGRAM2</command></term>
255 <listitem>
256 <para>
257 does this ..... (no period at the end)
258 </para>
259 <indexterm zone="xdg-desktop-portal PROGRAM2">
260 <primary sortas="b-PROGRAM2">PROGRAM2</primary>
261 </indexterm>
262 </listitem>
263 </varlistentry>
264
265 <varlistentry id="libLIBRARY1">
266 <term><filename class="libraryfile">libLIBRARY1.so</filename></term>
267 <listitem>
268 <para>
269 contains functions that ..... (no period at the end)
270 </para>
271 <indexterm zone="xdg-desktop-portal libLIBRARY1">
272 <primary sortas="c-libLIBRARY1">libLIBRARY1.so</primary>
273 </indexterm>
274 </listitem>
275 </varlistentry>
276 </variablelist>
277 -->
278 </sect2>
279</sect1>
Note: See TracBrowser for help on using the repository browser.