mirror of
https://github.com/Zeckmathederg/glfs.git
synced 2025-01-24 23:32:12 +08:00
277 lines
8.6 KiB
XML
277 lines
8.6 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
|
<!ENTITY % general-entities SYSTEM "../../general.ent">
|
|
%general-entities;
|
|
|
|
<!ENTITY libportal-download-http "https://github.com/flatpak/libportal/releases/download/&libportal-version;/libportal-&libportal-version;.tar.xz">
|
|
<!ENTITY libportal-download-ftp " ">
|
|
<!ENTITY libportal-md5sum "f94be41e8495ae7d6aaed046481daa61">
|
|
<!ENTITY libportal-size "76 KB">
|
|
<!ENTITY libportal-buildsize "3.0 MB (with tests)">
|
|
<!ENTITY libportal-time "0.1 SBU (add 0.3 SBU for tests)">
|
|
]>
|
|
|
|
<sect1 id="libportal" xreflabel="libportal-&libportal-version;">
|
|
<?dbhtml filename="libportal.html"?>
|
|
|
|
|
|
<title>libportal-&libportal-version;</title>
|
|
|
|
<indexterm zone="libportal">
|
|
<primary sortas="a-libportal">libportal</primary>
|
|
</indexterm>
|
|
|
|
<sect2 role="package">
|
|
<title>Introduction to libportal</title>
|
|
|
|
<para>
|
|
The <application>libportal</application> package provides
|
|
a library that contains GIO-style async APIs for most Flatpak portals.
|
|
</para>
|
|
|
|
&lfs120_checked;
|
|
|
|
<bridgehead renderas="sect3">Package Information</bridgehead>
|
|
<itemizedlist spacing="compact">
|
|
<listitem>
|
|
<para>
|
|
Download (HTTP): <ulink url="&libportal-download-http;"/>
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Download (FTP): <ulink url="&libportal-download-ftp;"/>
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Download MD5 sum: &libportal-md5sum;
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Download size: &libportal-size;
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Estimated disk space required: &libportal-buildsize;
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Estimated build time: &libportal-time;
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
|
|
<bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
|
<itemizedlist spacing="compact">
|
|
<listitem>
|
|
<para>
|
|
Optional patch (required for running the test suite):
|
|
<ulink url="&patch-root;/libportal-&libportal-version;-testsuite_fix-1.patch"/>
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
|
|
<bridgehead renderas="sect3">libportal Dependencies</bridgehead>
|
|
|
|
<bridgehead renderas="sect4">Required</bridgehead>
|
|
<para role="required">
|
|
<xref linkend="gobject-introspection"/>
|
|
</para>
|
|
|
|
<bridgehead renderas="sect4">Recommended</bridgehead>
|
|
<para role="recommended">
|
|
<xref linkend="gtk3"/> and
|
|
<xref linkend="gtk4"/>
|
|
</para>
|
|
|
|
<bridgehead renderas="sect4">Recommended (Runtime)</bridgehead>
|
|
<para role="runtime">
|
|
To make this package really useful, install
|
|
<xref linkend="xdg-desktop-portal"/>,
|
|
<xref linkend="xdg-desktop-portal-gtk"/>,
|
|
<xref role="nodep" linkend="xdg-desktop-portal-gnome"/> (if running
|
|
a GNOME desktop environment), and
|
|
<xref role="nodep" linkend="xdg-desktop-portal-lxqt"/> (if running
|
|
a LXQt desktop environment). They are not needed if only using this
|
|
package to satisfy a build dependency.
|
|
</para>
|
|
|
|
<bridgehead renderas="sect4">Optional</bridgehead>
|
|
<para role="optional">
|
|
<xref linkend="gi-docgen"/> (for documentation),
|
|
<xref linkend="python-dbusmock"/> and
|
|
<xref linkend="pytest"/> (for testing),
|
|
&qt5-deps; (for the Qt5 version of libportal), and
|
|
<xref linkend="vala"/>
|
|
</para>
|
|
|
|
</sect2>
|
|
|
|
<sect2 role="installation">
|
|
<title>Installation of libportal</title>
|
|
|
|
<warning>
|
|
<para>
|
|
If a previous version of libportal is installed, move the
|
|
headers out of the way so that later packages do not encounter
|
|
conflicts (as the <systemitem role="username">root</systemitem>
|
|
user):
|
|
</para>
|
|
<screen role="root"><userinput>if [ -e /usr/include/libportal ]; then
|
|
rm -rf /usr/include/libportal.old &&
|
|
mv -vf /usr/include/libportal{,.old}
|
|
fi</userinput></screen>
|
|
</warning>
|
|
|
|
<para>
|
|
If running the test suite, apply a patch to fix a dozen of test
|
|
failures with python-dbusmock 0.30.0 or later:
|
|
</para>
|
|
|
|
<screen><userinput>patch -Np1 -i ../libportal-&libportal-version;-testsuite_fix-1.patch</userinput></screen>
|
|
|
|
<para>
|
|
Install <application>libportal</application> by running the following
|
|
commands:
|
|
</para>
|
|
|
|
<screen><userinput>mkdir build &&
|
|
cd build &&
|
|
|
|
meson setup --prefix=/usr --buildtype=release -Ddocs=false .. &&
|
|
ninja</userinput></screen>
|
|
|
|
<para>
|
|
If you have <xref linkend='gi-docgen'/> installed and wish to build
|
|
the API documentation for this package, issue:
|
|
</para>
|
|
|
|
<screen role='nodump'><userinput>sed "/output/s/-1/-&libportal-version;/" -i ../doc/meson.build &&
|
|
meson configure -Ddocs=true &&
|
|
ninja</userinput></screen>
|
|
|
|
<para>
|
|
To test the results, issue: <command>ninja test</command>. Note that
|
|
additional <filename>dbus-daemon</filename> processes may need to be
|
|
killed after the tests are run.
|
|
</para>
|
|
|
|
<para>
|
|
Now, as the <systemitem class="username">root</systemitem> user:
|
|
</para>
|
|
|
|
<screen role="root"><userinput>ninja install</userinput></screen>
|
|
|
|
</sect2>
|
|
|
|
<sect2 role="commands">
|
|
<title>Command Explanations</title>
|
|
|
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
href="../../xincludes/meson-buildtype-release.xml"/>
|
|
|
|
<para>
|
|
<parameter>-Ddocs=false</parameter>: &gi-doc-disable;
|
|
</para>
|
|
|
|
<!-- These options are now automatically detected, so it doesn't make sense to
|
|
explicitly set which ones are used (as of version 0.7)
|
|
<para>
|
|
<option>-Dbackends=gtk3,gtk4,qt5</option>: This switch allows you to set
|
|
the available backends. You can use it to disable the dependency on gtk-3,
|
|
gtk-4, or qt-5. Most applications that use libportal will use either
|
|
gtk-4 or gtk-3. The default is to build all three backends.
|
|
</para>
|
|
-->
|
|
|
|
</sect2>
|
|
<sect2 role="content">
|
|
<title>Contents</title>
|
|
|
|
<segmentedlist>
|
|
<segtitle>Installed Programs</segtitle>
|
|
<segtitle>Installed Libraries</segtitle>
|
|
<segtitle>Installed Directories</segtitle>
|
|
|
|
<seglistitem>
|
|
<seg>
|
|
None
|
|
</seg>
|
|
<seg>
|
|
libportal.so,
|
|
libportal-gtk3.so,
|
|
libportal-gtk4.so, and
|
|
libportal-qt5.so
|
|
</seg>
|
|
<seg>
|
|
/usr/include/libportal and
|
|
/usr/share/gtk-doc/html/libportal
|
|
</seg>
|
|
</seglistitem>
|
|
</segmentedlist>
|
|
|
|
<variablelist>
|
|
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|
<?dbfo list-presentation="list"?>
|
|
<?dbhtml list-presentation="table"?>
|
|
|
|
<varlistentry id="libportal-lib">
|
|
<term><filename class="libraryfile">libportal.so</filename></term>
|
|
<listitem>
|
|
<para>
|
|
provides GIO-style async APIs for most Flatpak portals
|
|
</para>
|
|
<indexterm zone="libportal libportal-lib">
|
|
<primary sortas="c-libportal">libportal.so</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="libportal-gtk3">
|
|
<term><filename class="libraryfile">libportal-gtk3.so</filename></term>
|
|
<listitem>
|
|
<para>
|
|
provides GTK+-3 specific functions for interacting with Flatpak
|
|
portals
|
|
</para>
|
|
<indexterm zone="libportal libportal-gtk3">
|
|
<primary sortas="c-libportal-gtk3">libportal-gtk3.so</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="libportal-gtk4">
|
|
<term><filename class="libraryfile">libportal-gtk4.so</filename></term>
|
|
<listitem>
|
|
<para>
|
|
provides GTK-4 specific functions for interacting with Flatpak
|
|
portals
|
|
</para>
|
|
<indexterm zone="libportal libportal-gtk4">
|
|
<primary sortas="c-libportal-gtk4">libportal-gtk4.so</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="libportal-qt5">
|
|
<term><filename class="libraryfile">libportal-qt5.so</filename></term>
|
|
<listitem>
|
|
<para>
|
|
provides Qt5 specific functions for interacting with Flatpak
|
|
portals
|
|
</para>
|
|
<indexterm zone="libportal libportal-qt5">
|
|
<primary sortas="c-libportal-qt5">libportal-qt5.so</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</sect2>
|
|
|
|
</sect1>
|