[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 " ">
|
---|
[5070c5f] | 9 | <!ENTITY libportal-md5sum "e16c8ca2621aff64774a1d2ad6a2a346">
|
---|
| 10 | <!ENTITY libportal-size "64 KB">
|
---|
| 11 | <!ENTITY libportal-buildsize "2.9 MB">
|
---|
[0f870c5] | 12 | <!ENTITY libportal-time "0.1 SBU">
|
---|
[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 |
|
---|
[74b918b] | 33 | &lfs113_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">
|
---|
| 78 | <xref linkend="gtk3"/>,
|
---|
| 79 | <xref linkend="gtk4"/>, and
|
---|
[b3867c5] | 80 | &qt5-deps;
|
---|
[f21106a] | 81 | </para>
|
---|
| 82 |
|
---|
| 83 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 84 | <para role="optional">
|
---|
[f56d2e7] | 85 | <xref linkend="gi-docgen"/> and
|
---|
| 86 | <xref linkend="vala"/>
|
---|
[ec6047d8] | 87 | </para>
|
---|
| 88 |
|
---|
| 89 | </sect2>
|
---|
| 90 |
|
---|
| 91 | <sect2 role="installation">
|
---|
| 92 | <title>Installation of libportal</title>
|
---|
| 93 |
|
---|
[75b6dff] | 94 | <warning>
|
---|
| 95 | <para>
|
---|
| 96 | If a previous version of libportal is installed, move the
|
---|
| 97 | headers out of the way so that later packages do not encounter
|
---|
[77e8024] | 98 | conflicts (as the <systemitem role="username">root</systemitem>
|
---|
| 99 | user):
|
---|
[75b6dff] | 100 | </para>
|
---|
[77e8024] | 101 | <screen role="root"><userinput>if [ -e /usr/include/libportal ]; then
|
---|
[75b6dff] | 102 | rm -rf /usr/include/libportal.old &&
|
---|
| 103 | mv -vf /usr/include/libportal{,.old}
|
---|
| 104 | fi</userinput></screen>
|
---|
| 105 | </warning>
|
---|
| 106 |
|
---|
[ec6047d8] | 107 | <para>
|
---|
| 108 | Install <application>libportal</application> by running the following
|
---|
| 109 | commands:
|
---|
| 110 | </para>
|
---|
| 111 |
|
---|
| 112 | <screen><userinput>mkdir build &&
|
---|
| 113 | cd build &&
|
---|
| 114 |
|
---|
[91318eb] | 115 | meson setup --prefix=/usr --buildtype=release -Ddocs=false .. &&
|
---|
[a4bf068b] | 116 | ninja</userinput></screen>
|
---|
| 117 |
|
---|
| 118 | <para>
|
---|
| 119 | If you have <xref linkend='gi-docgen'/> installed and wish to build
|
---|
| 120 | the API documentation for this package, issue:
|
---|
| 121 | </para>
|
---|
| 122 |
|
---|
| 123 | <screen role='nodump'><userinput>sed "/output/s/-1/-&libportal-version;/" -i ../doc/meson.build &&
|
---|
| 124 | meson configure -Ddocs=true &&
|
---|
[ec6047d8] | 125 | ninja</userinput></screen>
|
---|
| 126 |
|
---|
| 127 | <para>
|
---|
| 128 | This package does not come with a test suite.
|
---|
| 129 | </para>
|
---|
| 130 |
|
---|
| 131 | <para>
|
---|
| 132 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 133 | </para>
|
---|
| 134 |
|
---|
| 135 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[215f39e] | 136 |
|
---|
[ec6047d8] | 137 | </sect2>
|
---|
| 138 |
|
---|
[f21106a] | 139 | <sect2 role="commands">
|
---|
| 140 | <title>Command Explanations</title>
|
---|
| 141 |
|
---|
[20f070d8] | 142 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 143 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 144 |
|
---|
[f21106a] | 145 | <para>
|
---|
[a51e56d5] | 146 | <parameter>-Ddocs=false</parameter>: &gi-doc-disable;
|
---|
[f21106a] | 147 | </para>
|
---|
| 148 |
|
---|
[86bb3fe8] | 149 | <para>
|
---|
[1fe05eb] | 150 | <option>-Dbackends=gtk3,gtk4,qt5</option>: This switch allows you to set
|
---|
[86bb3fe8] | 151 | the available backends. You can use it to disable the dependency on gtk-3,
|
---|
[1fe05eb] | 152 | gtk-4, or qt-5. Most applications that use libportal will use either
|
---|
[86bb3fe8] | 153 | gtk-4 or gtk-3. The default is to build all three backends.
|
---|
| 154 | </para>
|
---|
| 155 |
|
---|
[f21106a] | 156 | </sect2>
|
---|
[ec6047d8] | 157 | <sect2 role="content">
|
---|
| 158 | <title>Contents</title>
|
---|
| 159 |
|
---|
| 160 | <segmentedlist>
|
---|
| 161 | <segtitle>Installed Programs</segtitle>
|
---|
| 162 | <segtitle>Installed Libraries</segtitle>
|
---|
| 163 | <segtitle>Installed Directories</segtitle>
|
---|
| 164 |
|
---|
| 165 | <seglistitem>
|
---|
| 166 | <seg>
|
---|
| 167 | None
|
---|
| 168 | </seg>
|
---|
| 169 | <seg>
|
---|
[673f231] | 170 | libportal.so,
|
---|
| 171 | libportal-gtk3.so,
|
---|
| 172 | libportal-gtk4.so, and
|
---|
| 173 | libportal-qt5.so
|
---|
[ec6047d8] | 174 | </seg>
|
---|
| 175 | <seg>
|
---|
| 176 | /usr/include/libportal and
|
---|
| 177 | /usr/share/gtk-doc/html/libportal
|
---|
| 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="libportal-lib">
|
---|
| 188 | <term><filename class="libraryfile">libportal.so</filename></term>
|
---|
| 189 | <listitem>
|
---|
| 190 | <para>
|
---|
[4c24eb0a] | 191 | provides GIO-style async APIs for most Flatpak portals
|
---|
[ec6047d8] | 192 | </para>
|
---|
| 193 | <indexterm zone="libportal libportal-lib">
|
---|
| 194 | <primary sortas="c-libportal">libportal.so</primary>
|
---|
| 195 | </indexterm>
|
---|
| 196 | </listitem>
|
---|
| 197 | </varlistentry>
|
---|
[673f231] | 198 |
|
---|
| 199 | <varlistentry id="libportal-gtk3">
|
---|
| 200 | <term><filename class="libraryfile">libportal-gtk3.so</filename></term>
|
---|
| 201 | <listitem>
|
---|
| 202 | <para>
|
---|
| 203 | provides GTK+-3 specific functions for interacting with Flatpak
|
---|
| 204 | portals.
|
---|
| 205 | </para>
|
---|
| 206 | <indexterm zone="libportal libportal-gtk3">
|
---|
| 207 | <primary sortas="c-libportal-gtk3">libportal-gtk3.so</primary>
|
---|
| 208 | </indexterm>
|
---|
| 209 | </listitem>
|
---|
| 210 | </varlistentry>
|
---|
| 211 |
|
---|
| 212 | <varlistentry id="libportal-gtk4">
|
---|
| 213 | <term><filename class="libraryfile">libportal-gtk4.so</filename></term>
|
---|
| 214 | <listitem>
|
---|
| 215 | <para>
|
---|
| 216 | provides GTK-4 specific functions for interacting with Flatpak
|
---|
| 217 | portals.
|
---|
| 218 | </para>
|
---|
| 219 | <indexterm zone="libportal libportal-gtk4">
|
---|
| 220 | <primary sortas="c-libportal-gtk4">libportal-gtk4.so</primary>
|
---|
| 221 | </indexterm>
|
---|
| 222 | </listitem>
|
---|
| 223 | </varlistentry>
|
---|
| 224 |
|
---|
| 225 | <varlistentry id="libportal-qt5">
|
---|
| 226 | <term><filename class="libraryfile">libportal-qt5.so</filename></term>
|
---|
| 227 | <listitem>
|
---|
| 228 | <para>
|
---|
| 229 | provides Qt5 specific functions for interacting with Flatpak
|
---|
| 230 | portals.
|
---|
| 231 | </para>
|
---|
| 232 | <indexterm zone="libportal libportal-qt5">
|
---|
| 233 | <primary sortas="c-libportal-qt5">libportal-qt5.so</primary>
|
---|
| 234 | </indexterm>
|
---|
| 235 | </listitem>
|
---|
| 236 | </varlistentry>
|
---|
[ec6047d8] | 237 | </variablelist>
|
---|
| 238 | </sect2>
|
---|
[4c24eb0a] | 239 |
|
---|
[ec6047d8] | 240 | </sect1>
|
---|