[ec6047d8] | 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 libportal-download-http "https://github.com/flatpak/libportal/releases/download/&libportal-version;/libportal-&libportal-version;.tar.xz">
|
---|
| 8 | <!ENTITY libportal-download-ftp " ">
|
---|
[87e1d46] | 9 | <!ENTITY libportal-md5sum "f94be41e8495ae7d6aaed046481daa61">
|
---|
[1f45a0f] | 10 | <!ENTITY libportal-size "76 KB">
|
---|
[87e1d46] | 11 | <!ENTITY libportal-buildsize "3.0 MB (with tests)">
|
---|
[1f45a0f] | 12 | <!ENTITY libportal-time "0.1 SBU (add 0.3 SBU for tests)">
|
---|
[ec6047d8] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="libportal" xreflabel="libportal-&libportal-version;">
|
---|
| 16 | <?dbhtml filename="libportal.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>libportal-&libportal-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="libportal">
|
---|
| 22 | <primary sortas="a-libportal">libportal</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to libportal</title>
|
---|
| 27 |
|
---|
| 28 | <para>
|
---|
| 29 | The <application>libportal</application> package provides
|
---|
| 30 | a library that contains GIO-style async APIs for most Flatpak portals.
|
---|
| 31 | </para>
|
---|
| 32 |
|
---|
[d9dc0431] | 33 | &lfs120_checked;
|
---|
[ec6047d8] | 34 |
|
---|
| 35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 36 | <itemizedlist spacing="compact">
|
---|
| 37 | <listitem>
|
---|
| 38 | <para>
|
---|
| 39 | Download (HTTP): <ulink url="&libportal-download-http;"/>
|
---|
| 40 | </para>
|
---|
| 41 | </listitem>
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>
|
---|
| 44 | Download (FTP): <ulink url="&libportal-download-ftp;"/>
|
---|
| 45 | </para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>
|
---|
| 49 | Download MD5 sum: &libportal-md5sum;
|
---|
| 50 | </para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>
|
---|
| 54 | Download size: &libportal-size;
|
---|
| 55 | </para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>
|
---|
| 59 | Estimated disk space required: &libportal-buildsize;
|
---|
| 60 | </para>
|
---|
| 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>
|
---|
| 64 | Estimated build time: &libportal-time;
|
---|
| 65 | </para>
|
---|
| 66 | </listitem>
|
---|
| 67 | </itemizedlist>
|
---|
| 68 |
|
---|
| 69 | <bridgehead renderas="sect3">libportal Dependencies</bridgehead>
|
---|
| 70 |
|
---|
| 71 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 72 | <para role="required">
|
---|
[673f231] | 73 | <xref linkend="gobject-introspection"/>
|
---|
| 74 | </para>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 77 | <para role="recommended">
|
---|
[1f45a0f] | 78 | <xref linkend="gtk3"/> and
|
---|
| 79 | <xref linkend="gtk4"/>
|
---|
[f21106a] | 80 | </para>
|
---|
| 81 |
|
---|
| 82 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 83 | <para role="optional">
|
---|
[1f45a0f] | 84 | <xref linkend="gi-docgen"/> (for documentation),
|
---|
| 85 | <xref linkend="python-dbusmock"/> and
|
---|
| 86 | <xref linkend="pytest"/> (for testing),
|
---|
| 87 | &qt5-deps; (for the Qt5 version of libportal), and
|
---|
[f56d2e7] | 88 | <xref linkend="vala"/>
|
---|
[ec6047d8] | 89 | </para>
|
---|
| 90 |
|
---|
| 91 | </sect2>
|
---|
| 92 |
|
---|
| 93 | <sect2 role="installation">
|
---|
| 94 | <title>Installation of libportal</title>
|
---|
| 95 |
|
---|
[75b6dff] | 96 | <warning>
|
---|
| 97 | <para>
|
---|
| 98 | If a previous version of libportal is installed, move the
|
---|
| 99 | headers out of the way so that later packages do not encounter
|
---|
[77e8024] | 100 | conflicts (as the <systemitem role="username">root</systemitem>
|
---|
| 101 | user):
|
---|
[75b6dff] | 102 | </para>
|
---|
[77e8024] | 103 | <screen role="root"><userinput>if [ -e /usr/include/libportal ]; then
|
---|
[75b6dff] | 104 | rm -rf /usr/include/libportal.old &&
|
---|
| 105 | mv -vf /usr/include/libportal{,.old}
|
---|
| 106 | fi</userinput></screen>
|
---|
| 107 | </warning>
|
---|
| 108 |
|
---|
[ec6047d8] | 109 | <para>
|
---|
| 110 | Install <application>libportal</application> by running the following
|
---|
| 111 | commands:
|
---|
| 112 | </para>
|
---|
| 113 |
|
---|
| 114 | <screen><userinput>mkdir build &&
|
---|
| 115 | cd build &&
|
---|
| 116 |
|
---|
[91318eb] | 117 | meson setup --prefix=/usr --buildtype=release -Ddocs=false .. &&
|
---|
[a4bf068b] | 118 | ninja</userinput></screen>
|
---|
| 119 |
|
---|
| 120 | <para>
|
---|
| 121 | If you have <xref linkend='gi-docgen'/> installed and wish to build
|
---|
| 122 | the API documentation for this package, issue:
|
---|
| 123 | </para>
|
---|
| 124 |
|
---|
| 125 | <screen role='nodump'><userinput>sed "/output/s/-1/-&libportal-version;/" -i ../doc/meson.build &&
|
---|
| 126 | meson configure -Ddocs=true &&
|
---|
[ec6047d8] | 127 | ninja</userinput></screen>
|
---|
| 128 |
|
---|
| 129 | <para>
|
---|
[1f45a0f] | 130 | To test the results, issue: <command>ninja test</command>. Note that
|
---|
| 131 | additional <filename>dbus-daemon</filename> processes may need to be
|
---|
| 132 | killed after the tests are run.
|
---|
[ec6047d8] | 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>
|
---|
[215f39e] | 140 |
|
---|
[ec6047d8] | 141 | </sect2>
|
---|
| 142 |
|
---|
[f21106a] | 143 | <sect2 role="commands">
|
---|
| 144 | <title>Command Explanations</title>
|
---|
| 145 |
|
---|
[20f070d8] | 146 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 147 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 148 |
|
---|
[f21106a] | 149 | <para>
|
---|
[a51e56d5] | 150 | <parameter>-Ddocs=false</parameter>: &gi-doc-disable;
|
---|
[f21106a] | 151 | </para>
|
---|
| 152 |
|
---|
[1f45a0f] | 153 | <!-- These options are now automatically detected, so it doesn't make sense to
|
---|
| 154 | explicitly set which ones are used (as of version 0.7)
|
---|
[86bb3fe8] | 155 | <para>
|
---|
[1fe05eb] | 156 | <option>-Dbackends=gtk3,gtk4,qt5</option>: This switch allows you to set
|
---|
[86bb3fe8] | 157 | the available backends. You can use it to disable the dependency on gtk-3,
|
---|
[1fe05eb] | 158 | gtk-4, or qt-5. Most applications that use libportal will use either
|
---|
[86bb3fe8] | 159 | gtk-4 or gtk-3. The default is to build all three backends.
|
---|
| 160 | </para>
|
---|
[1f45a0f] | 161 | -->
|
---|
[86bb3fe8] | 162 |
|
---|
[f21106a] | 163 | </sect2>
|
---|
[ec6047d8] | 164 | <sect2 role="content">
|
---|
| 165 | <title>Contents</title>
|
---|
| 166 |
|
---|
| 167 | <segmentedlist>
|
---|
| 168 | <segtitle>Installed Programs</segtitle>
|
---|
| 169 | <segtitle>Installed Libraries</segtitle>
|
---|
| 170 | <segtitle>Installed Directories</segtitle>
|
---|
| 171 |
|
---|
| 172 | <seglistitem>
|
---|
| 173 | <seg>
|
---|
| 174 | None
|
---|
| 175 | </seg>
|
---|
| 176 | <seg>
|
---|
[673f231] | 177 | libportal.so,
|
---|
| 178 | libportal-gtk3.so,
|
---|
| 179 | libportal-gtk4.so, and
|
---|
| 180 | libportal-qt5.so
|
---|
[ec6047d8] | 181 | </seg>
|
---|
| 182 | <seg>
|
---|
| 183 | /usr/include/libportal and
|
---|
| 184 | /usr/share/gtk-doc/html/libportal
|
---|
| 185 | </seg>
|
---|
| 186 | </seglistitem>
|
---|
| 187 | </segmentedlist>
|
---|
| 188 |
|
---|
| 189 | <variablelist>
|
---|
| 190 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 191 | <?dbfo list-presentation="list"?>
|
---|
| 192 | <?dbhtml list-presentation="table"?>
|
---|
| 193 |
|
---|
| 194 | <varlistentry id="libportal-lib">
|
---|
| 195 | <term><filename class="libraryfile">libportal.so</filename></term>
|
---|
| 196 | <listitem>
|
---|
| 197 | <para>
|
---|
[4c24eb0a] | 198 | provides GIO-style async APIs for most Flatpak portals
|
---|
[ec6047d8] | 199 | </para>
|
---|
| 200 | <indexterm zone="libportal libportal-lib">
|
---|
| 201 | <primary sortas="c-libportal">libportal.so</primary>
|
---|
| 202 | </indexterm>
|
---|
| 203 | </listitem>
|
---|
| 204 | </varlistentry>
|
---|
[673f231] | 205 |
|
---|
| 206 | <varlistentry id="libportal-gtk3">
|
---|
| 207 | <term><filename class="libraryfile">libportal-gtk3.so</filename></term>
|
---|
| 208 | <listitem>
|
---|
| 209 | <para>
|
---|
| 210 | provides GTK+-3 specific functions for interacting with Flatpak
|
---|
[1f45a0f] | 211 | portals
|
---|
[673f231] | 212 | </para>
|
---|
| 213 | <indexterm zone="libportal libportal-gtk3">
|
---|
| 214 | <primary sortas="c-libportal-gtk3">libportal-gtk3.so</primary>
|
---|
| 215 | </indexterm>
|
---|
| 216 | </listitem>
|
---|
| 217 | </varlistentry>
|
---|
| 218 |
|
---|
| 219 | <varlistentry id="libportal-gtk4">
|
---|
| 220 | <term><filename class="libraryfile">libportal-gtk4.so</filename></term>
|
---|
| 221 | <listitem>
|
---|
| 222 | <para>
|
---|
| 223 | provides GTK-4 specific functions for interacting with Flatpak
|
---|
[1f45a0f] | 224 | portals
|
---|
[673f231] | 225 | </para>
|
---|
| 226 | <indexterm zone="libportal libportal-gtk4">
|
---|
| 227 | <primary sortas="c-libportal-gtk4">libportal-gtk4.so</primary>
|
---|
| 228 | </indexterm>
|
---|
| 229 | </listitem>
|
---|
| 230 | </varlistentry>
|
---|
| 231 |
|
---|
| 232 | <varlistentry id="libportal-qt5">
|
---|
| 233 | <term><filename class="libraryfile">libportal-qt5.so</filename></term>
|
---|
| 234 | <listitem>
|
---|
| 235 | <para>
|
---|
| 236 | provides Qt5 specific functions for interacting with Flatpak
|
---|
[1f45a0f] | 237 | portals
|
---|
[673f231] | 238 | </para>
|
---|
| 239 | <indexterm zone="libportal libportal-qt5">
|
---|
| 240 | <primary sortas="c-libportal-qt5">libportal-qt5.so</primary>
|
---|
| 241 | </indexterm>
|
---|
| 242 | </listitem>
|
---|
| 243 | </varlistentry>
|
---|
[ec6047d8] | 244 | </variablelist>
|
---|
| 245 | </sect2>
|
---|
[4c24eb0a] | 246 |
|
---|
[ec6047d8] | 247 | </sect1>
|
---|