diff options
| author | Matthias Clasen <mclasen@redhat.com> | 2016-07-12 00:53:07 -0400 |
|---|---|---|
| committer | Matthias Clasen <mclasen@redhat.com> | 2016-07-12 00:53:07 -0400 |
| commit | 6121256a6dc623564f249b55432ed6668621ad3e (patch) | |
| tree | 26b9bb8293c1ae48d4d9823a5091df2db8fde75a | |
| download | flatpak-6121256a6dc623564f249b55432ed6668621ad3e.tar.gz | |
Initial documentaiton commit
24 files changed, 7196 insertions, 0 deletions
diff --git a/docbook.css b/docbook.css new file mode 100644 index 00000000..6a7373e2 --- /dev/null +++ b/docbook.css @@ -0,0 +1,78 @@ +body +{ + font-family: sans-serif; +} +h1.title +{ +} +.permission +{ + color: #ee0000; + text-decoration: underline; +} +.synopsis, .classsynopsis +{ + background: #eeeeee; + border: solid 1px #aaaaaa; + padding: 0.5em; +} +.programlisting +{ + background: #eeeeff; + border: solid 1px #aaaaff; + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} +td.shortcuts +{ + color: #770000; + font-size: 80%; +} +div.refnamediv +{ + margin-top: 2em; +} +div.toc +{ + border: 2em; +} +a +{ + text-decoration: none; +} +a:hover +{ + text-decoration: underline; + color: #FF0000; +} + +div.table table +{ + border-collapse: collapse; + border-spacing: 0px; + border-style: solid; + border-color: #777777; + border-width: 1px; +} + +div.table table td, div.table table th +{ + border-style: solid; + border-color: #777777; + border-width: 1px; + padding: 3px; + vertical-align: top; +} + +div.table table th +{ + background-color: #eeeeee; +} diff --git a/flatpak-docs.html b/flatpak-docs.html new file mode 100644 index 00000000..e2f73056 --- /dev/null +++ b/flatpak-docs.html @@ -0,0 +1,1612 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Flatpak Command Reference</title><link rel="stylesheet" type="text/css" href="docbook.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /></head><body><div class="reference"><div class="titlepage"><div><div><h1 class="title"><a id="idm139925460057248"></a>Flatpak Command Reference</h1></div><div><p class="releaseinfo">Version 0.6.7</p></div></div><hr /></div><div class="partintro"><div></div><p> + Flatpak comes with a rich commandline interface. + </p><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="refentrytitle"><a href="#flatpak-install">flatpak install</a></span><span class="refpurpose"> — Install an application or runtime</span></dt><dt><span class="refentrytitle"><a href="#flatpak-update">flatpak update</a></span><span class="refpurpose"> — Update a runtime</span></dt><dt><span class="refentrytitle"><a href="#flatpak-uninstall">flatpak uninstall</a></span><span class="refpurpose"> — Uninstall an application or runtime</span></dt><dt><span class="refentrytitle"><a href="#flatpak-list">flatpak list</a></span><span class="refpurpose"> — List installed applications and/or runtimes</span></dt><dt><span class="refentrytitle"><a href="#flatpak-info">flatpak info</a></span><span class="refpurpose"> — Show information about installed application and/or runtime</span></dt><dt><span class="refentrytitle"><a href="#flatpak-run">flatpak run</a></span><span class="refpurpose"> — Run an application</span></dt><dt><span class="refentrytitle"><a href="#flatpak-override">flatpak override</a></span><span class="refpurpose"> — Override application requirements</span></dt><dt><span class="refentrytitle"><a href="#flatpak-enter">flatpak enter</a></span><span class="refpurpose"> — Enter an application</span></dt><dt><span class="refentrytitle"><a href="#flatpak-document-export">flatpak document-export</a></span><span class="refpurpose"> — Export a file to a sandboxed application</span></dt><dt><span class="refentrytitle"><a href="#flatpak-document-unexport">flatpak document-unexport</a></span><span class="refpurpose"> — Stop exporting a file</span></dt><dt><span class="refentrytitle"><a href="#flatpak-document-info">flatpak document-info</a></span><span class="refpurpose"> — Show information about exported files</span></dt><dt><span class="refentrytitle"><a href="#flatpak-document-list">flatpak document-list</a></span><span class="refpurpose"> — List exported files</span></dt><dt><span class="refentrytitle"><a href="#flatpak-remote-add">flatpak remote-add</a></span><span class="refpurpose"> — Add a remote repository</span></dt><dt><span class="refentrytitle"><a href="#flatpak-remote-modify">flatpak remote-modify</a></span><span class="refpurpose"> — Modify a remote repository</span></dt><dt><span class="refentrytitle"><a href="#flatpak-remote-delete">flatpak remote-delete</a></span><span class="refpurpose"> — Delete a remote repository</span></dt><dt><span class="refentrytitle"><a href="#flatpak-remote-list">flatpak remote-list</a></span><span class="refpurpose"> — List remote repositories</span></dt><dt><span class="refentrytitle"><a href="#flatpak-remote-ls">flatpak remote-ls</a></span><span class="refpurpose"> — Show available runtimes and applications</span></dt><dt><span class="refentrytitle"><a href="#flatpak-build-init">flatpak build-init</a></span><span class="refpurpose"> — Initialize a build directory</span></dt><dt><span class="refentrytitle"><a href="#flatpak-build">flatpak build</a></span><span class="refpurpose"> — Build in a directory</span></dt><dt><span class="refentrytitle"><a href="#flatpak-build-finish">flatpak build-finish</a></span><span class="refpurpose"> — Finalize a build directory</span></dt><dt><span class="refentrytitle"><a href="#flatpak-build-export">flatpak build-export</a></span><span class="refpurpose"> — Create a repository from a build directory</span></dt><dt><span class="refentrytitle"><a href="#flatpak-build-bundle">flatpak build-bundle</a></span><span class="refpurpose"> — Create a single-file bundle from a local repository</span></dt><dt><span class="refentrytitle"><a href="#flatpak-build-import-bundle">flatpak build-import-bundle</a></span><span class="refpurpose"> — Import a file bundle into a local repository</span></dt><dt><span class="refentrytitle"><a href="#flatpak-build-update-repo">flatpak build-update-repo</a></span><span class="refpurpose"> — Create a repository from a build directory</span></dt><dt><span class="refentrytitle"><a href="#flatpak-build-export">flatpak build-sign</a></span><span class="refpurpose"> — Sign an application or runtime</span></dt><dt><span class="refentrytitle"><a href="#flatpak-builder">flatpak-builder</a></span><span class="refpurpose"> — Help build application dependencies</span></dt><dt><span class="refentrytitle"><a href="#flatpak-metadata">flatpak metadata</a></span><span class="refpurpose"> — Information about an application or runtime</span></dt><dt><span class="refentrytitle"><a href="#flatpak-make-current">flatpak make-current</a></span><span class="refpurpose"> — Make a specific version of an app current</span></dt></dl></div></div><div class="refentry"><a id="flatpak-install"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-install — Install an application or runtime</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak install</code> [OPTION...] REMOTE NAME [BRANCH]</p></div><div class="cmdsynopsis"><p><code class="command">flatpak install</code> [OPTION...] --bundle FILENAME </p></div></div><div class="refsect1"><a id="idm139925450185776"></a><h2>Description</h2><p> + Installs an application or runtime. REMOTE must name + an existing remote and NAME is the name of the + application or runtime to install. Optionally, BRANCH can + be specified to install a branch other than the default branch. This required + if there are multiple matches in the selected remote. + </p><p> + By default this looks for both apps and runtime with the given NAME in + the specified REMOTE , but you can limit this by using the --app or --runtime option. + </p><p> + Note that flatpak allows one to have multiple branches of an application and runtimes + installed and used at the same time. However, only version of an application one can be current, + meaning its exported files (for instance desktop files and icons) are + visible to the host. The last installed version is made current by + default, but you can manually change with make-current. + </p><p> + Unless overridden with the --user option, this command creates a + system-wide installation. + </p><p> + The alternative form of the command installs an application from a + single-file bundle instead of a configured remote. Such bundles can + be created with the flatpak build-bundle command. + </p></div><div class="refsect1"><a id="idm139925450087360"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">--bundle</code></span></dt><dd><p> + Install from a bundle file instead + of a configured remote. + </p></dd><dt><span class="term"><code class="option">--user</code></span></dt><dd><p> + Create a per-user installation. + </p></dd><dt><span class="term"><code class="option">--user</code></span></dt><dd><p> + Create a per-user installation. + </p></dd><dt><span class="term"><code class="option">--system</code></span></dt><dd><p> + Create a system-wide installation. + </p></dd><dt><span class="term"><code class="option">--arch=ARCH</code></span></dt><dd><p> + The architecture to install for. + </p></dd><dt><span class="term"><code class="option">--subpath=PATH</code></span></dt><dd><p> + Install only a subpath of the ref. This is mainly used to install a subset of locales. + This can be added multiple times to install multiple subpaths., + </p></dd><dt><span class="term"><code class="option">--no-deploy</code></span></dt><dd><p> + Download the latest version, but don't deploy it. + </p></dd><dt><span class="term"><code class="option">--no-pull</code></span></dt><dd><p> + Don't download the latest version, deploy it whatever is locally available. + </p></dd><dt><span class="term"><code class="option">--no-related</code></span></dt><dd><p> + Don't download related extensions, such as the locale data. + </p></dd><dt><span class="term"><code class="option">--app</code></span></dt><dd><p> + Only look for an app with the given name. + </p></dd><dt><span class="term"><code class="option">--runtime</code></span></dt><dd><p> + Only look for an runtime with the given name. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925451149040"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak --user install test-repo org.gnome.GEdit</strong></span> + </p></div><div class="refsect1"><a id="idm139925452156048"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-update-app</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-list-apps</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build-bundle</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-update"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-update — Update a runtime</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak update</code> [OPTION...] [NAME] [BRANCH]</p></div></div><div class="refsect1"><a id="idm139925450461104"></a><h2>Description</h2><p> + Updates an application or runtime. NAME is the + name of an installed application or runtime. Optionally, + BRANCH can be specified to update a + specific branch, otherwise all installed branches are updated. If + no NAME is given, then everything installed + is updated. + </p><p> + By default this looks for both installed applications and + runtimes, but you can limit this by using the --app or + --runtime option. + </p><p> + Normally, this command updates the application to the tip + of its branch. But it is possible to check out another commit, + with the --commit option. + </p><p> + Note that updating a is different from installing + a different branch, and runtime updates are expected to keep + strict compatibility. If an application update does cause + a problem, it is possible to go back to the previous + version, with the --commit option. + </p><p> + Unless overridden with the --user option, this command updates + a system-wide installation. + </p></div><div class="refsect1"><a id="idm139925453667776"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">--user</code></span></dt><dd><p> + Update a per-user installation. + </p></dd><dt><span class="term"><code class="option">--system</code></span></dt><dd><p> + Update a system-wide installation. + </p></dd><dt><span class="term"><code class="option">--arch=ARCH</code></span></dt><dd><p> + The architecture to update for. + </p></dd><dt><span class="term"><code class="option">--subpath=PATH</code></span></dt><dd><p> + Install only a subpath of the ref. This is mainly used to install a subset of locales. + This can be added multiple times to install multiple subpaths. + If this is not specified the subpaths specified at install time are reused. + </p></dd><dt><span class="term"><code class="option">--commit=COMMIT</code></span></dt><dd><p> + Update to this commit, instead of the tip of the branch. + </p></dd><dt><span class="term"><code class="option">--no-deploy</code></span></dt><dd><p> + Download the latest version, but don't deploy it. + </p></dd><dt><span class="term"><code class="option">--no-pull</code></span></dt><dd><p> + Don't download the latest version, deploy it whatever is locally available. + </p></dd><dt><span class="term"><code class="option">--no-related</code></span></dt><dd><p> + Don't download related extensions, such as the locale data. + </p></dd><dt><span class="term"><code class="option">--app</code></span></dt><dd><p> + Only look for an app with the given name. + </p></dd><dt><span class="term"><code class="option">--runtime</code></span></dt><dd><p> + Only look for an runtime with the given name. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925451792432"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak --user update org.gnome.GEdit</strong></span> + </p></div><div class="refsect1"><a id="idm139925451790400"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-install-app</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-list-apps</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-uninstall"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-uninstall — Uninstall an application or runtime</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak uninstall</code> [OPTION...] NAME [BRANCH]</p></div></div><div class="refsect1"><a id="idm139925449836912"></a><h2>Description</h2><p> + Uninstalls an application or runtime. The NAME , + ARCH and BRANCH + arguments must identify an installed application. + If BRANCH is not specified, it defaults + to whatever is installed, unless there are multiple versions, then you + have to specify a branch. + </p><p> + By default this looks for both installed apps and runtime + with the given NAME , but you can + limit this by using the --app or --runtime option. + </p><p> + Normally, this command removes the ref for this application/runtime from the + local OSTree repository and purges and objects that are no longer + needed to free up disk space. If the same application is later + reinstalled, the objects will be pulled from the remote repository + again. The --keep-ref option can be used to prevent this. + </p><p> + If all branches of the application/runtime are removed, this command + also purges the data directory for the application. + </p><p> + Unless overridden with the --user option, this command updates + a system-wide installation. + </p></div><div class="refsect1"><a id="idm139925453486496"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">--keep-ref</code></span></dt><dd><p> + Keep the ref for the application and the objects belonging to it + in the local repository. + </p></dd><dt><span class="term"><code class="option">--user</code></span></dt><dd><p> + Remove a per-user installation. + </p></dd><dt><span class="term"><code class="option">--system</code></span></dt><dd><p> + Remove a system-wide installation. + </p></dd><dt><span class="term"><code class="option">--arch=ARCH</code></span></dt><dd><p> + The architecture to uninstall, instead of the architecture of + the host system. + </p></dd><dt><span class="term"><code class="option">--app</code></span></dt><dd><p> + Only look for an app with the given name. + </p></dd><dt><span class="term"><code class="option">--runtime</code></span></dt><dd><p> + Only look for an runtime with the given name. + </p></dd><dt><span class="term"><code class="option">--no-related</code></span></dt><dd><p> + Don't uninstall related extensions, such as the locale data. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925450037072"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak --user uninstall org.gnome.GEdit</strong></span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-list"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-list — List installed applications and/or runtimes</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak list</code> [OPTION...]</p></div></div><div class="refsect1"><a id="idm139925450314064"></a><h2>Description</h2><p> + Lists the names of the installed applications and/or runtime. + </p><p> + By default, both per-user and system-wide installations + are shown. Use the --user or --system options to change + this. + </p><p> + By default this lists the installed apps, but you can + change this by using the --app or --runtime option. + </p></div><div class="refsect1"><a id="idm139925449856448"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">--user</code></span></dt><dd><p> + List per-user installations. + </p></dd><dt><span class="term"><code class="option">--system</code></span></dt><dd><p> + List system-wide installations. + </p></dd><dt><span class="term"><code class="option">--show-details</code></span></dt><dd><p> + Show arches and branches, in addition to the application names. + </p></dd><dt><span class="term"><code class="option">--app</code></span></dt><dd><p> + List applications. + </p></dd><dt><span class="term"><code class="option">--runtime</code></span></dt><dd><p> + List runtimes. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925451093376"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak --user list</strong></span> + </p><pre class="programlisting"> +org.gnome.Builder +org.freedesktop.glxgears +org.gnome.MyApp +org.gnome.GEdit +</pre></div><div class="refsect1"><a id="idm139925451090624"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-install-app</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-update-app</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-info"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-info — Show information about installed application and/or runtime</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak info</code> [OPTION...] NAME [BRANCH]</p></div></div><div class="refsect1"><a id="idm139925451704640"></a><h2>Description</h2><p> + Show info about and installed application and/or runtime. + </p><p> + By default, both per-user and system-wide installations + are queried. Use the --user or --system options to change + this. + </p><p> + By default this queries the installed apps and runtimes, but you can + limit this by using the --app or --runtime option. + </p></div><div class="refsect1"><a id="idm139925451515488"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">--user</code></span></dt><dd><p> + Query per-user installations. + </p></dd><dt><span class="term"><code class="option">--system</code></span></dt><dd><p> + Query system-wide installations. + </p></dd><dt><span class="term"><code class="option">--app</code></span></dt><dd><p> + Query for applications. + </p></dd><dt><span class="term"><code class="option">--runtime</code></span></dt><dd><p> + Query for runtimes. + </p></dd><dt><span class="term"><code class="option">-r</code>, </span><span class="term"><code class="option">--show-ref</code></span></dt><dd><p> + Show the installed ref. + </p></dd><dt><span class="term"><code class="option">-o</code>, </span><span class="term"><code class="option">--show-origin</code></span></dt><dd><p> + Show the remote the ref is installed from. + </p></dd><dt><span class="term"><code class="option">-c</code>, </span><span class="term"><code class="option">--show-commit</code></span></dt><dd><p> + Show the installed commit id. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925452777856"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak --user list</strong></span> + </p><pre class="programlisting"> +org.gnome.Builder +org.freedesktop.glxgears +org.gnome.MyApp +org.gnome.GEdit +</pre></div><div class="refsect1"><a id="idm139925452775104"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-install-app</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-update-app</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-run"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-run — Run an application</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak run</code> [OPTION...] APP [ARG...]</p></div></div><div class="refsect1"><a id="idm139925450178464"></a><h2>Description</h2><p> + Runs an application in a sandboxed environment. + APP must name an installed application. + Extra arguments are passed on to the application. + </p><p> + flatpak creates a sandboxed environment for the application to run in + by mounting the right runtime at <code class="filename">/usr</code> and a writable + directory at <code class="filename">/var</code>, whose content is preserved between + application runs. The application itself is mounted at <code class="filename">/app</code>. + </p><p> + The details of the sandboxed environment are controlled by the application + metadata and various options like --share and --socket that are passed to the run + command: Access is allowed if it was requested either in the application + metadata file or with an option and the user hasn't overridden it. + </p></div><div class="refsect1"><a id="idm139925453116464"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd><dt><span class="term"><code class="option">--arch=ARCH</code></span></dt><dd><p> + The architecture to install for. + </p></dd><dt><span class="term"><code class="option">--command=COMMAND</code></span></dt><dd><p> + The command to run instead of the one listed in the application metadata. + </p></dd><dt><span class="term"><code class="option">--branch=BRANCH</code></span></dt><dd><p> + The branch to use. + </p></dd><dt><span class="term"><code class="option">-d</code>, </span><span class="term"><code class="option">--devel</code></span></dt><dd><p> + Use the devel runtime that is specified in the application metadata instead of the regular runtime, and use a seccomp profile that is less likely to break development tools. + </p></dd><dt><span class="term"><code class="option">--runtime=RUNTIME</code></span></dt><dd><p> + Use this runtime instead of the one that is specified in the application metadata. + This is a full tuple, like for example org.freedesktop.Sdk/x86_64/1.2 , but + partial tuples are allowed. Any empty or missing parts are filled in with the corresponding + values specified by the app. + </p></dd><dt><span class="term"><code class="option">--runtime-version=VERSION</code></span></dt><dd><p> + Use this version of the runtime instead of the one that is specified in the application metadata. + This overrides any version specified with the --runtime option. + </p></dd><dt><span class="term"><code class="option">--share=SUBSYSTEM</code></span></dt><dd><p> + Share a subsystem with the host session. This overrides + the Context section from the application metadata. + SUBSYSTEM must be one of: network, ipc. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--unshare=SUBSYSTEM</code></span></dt><dd><p> + Don't share a subsystem with the host session. This overrides + the Context section from the application metadata. + SUBSYSTEM must be one of: network, ipc. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--socket=SOCKET</code></span></dt><dd><p> + Expose a well known socket to the application. This overrides to + the Context section from the application metadata. + SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--nosocket=SOCKET</code></span></dt><dd><p> + Don't expose a well known socket to the application. This overrides to + the Context section from the application metadata. + SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--device=DEVICE</code></span></dt><dd><p> + Expose a device to the application. This overrides to + the Context section from the application metadata. + DEVICE must be one of: dri, all. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--nodevice=DEVICE</code></span></dt><dd><p> + Don't expose a device to the application. This overrides to + the Context section from the application metadata. + DEVICE must be one of: dri, all. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--filesystem=FS</code></span></dt><dd><p> + Allow the application access to a subset of the filesystem. + This overrides to the Context section from the application metadata. + FS can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, + an absolute path, or a homedir-relative path like ~/dir or paths + relative to the xdg dirs, like xdg-download/subdir. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--env=VAR=VALUE</code></span></dt><dd><p> + Set an environment variable in the application. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--own-name=NAME</code></span></dt><dd><p> + Allow the application to own the well known name NAME on the session bus. + If NAME ends with .*, it allows the application to own all matching names. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--talk-name=NAME</code></span></dt><dd><p> + Allow the application to talk to the well known name NAME on the session bus. + If NAME ends with .*, it allows the application to talk to all matching names. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--system-own-name=NAME</code></span></dt><dd><p> + Allow the application to own the well known name NAME on the system bus. + If NAME ends with .*, it allows the application to own all matching names. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--system-talk-name=NAME</code></span></dt><dd><p> + Allow the application to talk to the well known name NAME on the system bus. + If NAME ends with .*, it allows the application to talk to all matching names. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--persist=FILENAME</code></span></dt><dd><p> + If the application doesn't have access to the real homedir, make the (homedir-relative) path + FILENAME a bind mount to the corresponding path in the per-application directory, + allowing that location to be used for persistent data. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--no-desktop</code></span></dt><dd><p> + Don't require a running session, meaning that no cgroups creation will happen. This can be + useful for certain scenarios when you might want to run a flatpak without a valid user + session available (e.g. from a socket-activated systemd service), and not having a + properly sandboxed environment is not an issue. + </p></dd><dt><span class="term"><code class="option">--log-session-bus</code></span></dt><dd><p> + Log session bus traffic. This can be useful to see what access you need to allow in + your D-Bus policy. + </p></dd><dt><span class="term"><code class="option">--log-system-bus</code></span></dt><dd><p> + Log system bus traffic. This can be useful to see what access you need to allow in + your D-Bus policy. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925452580784"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak run org.gnome.GEdit</strong></span> + </p><p> + <span class="command"><strong>$ flatpak run --devel --command=bash org.gnome.Builder</strong></span> + </p></div><div class="refsect1"><a id="idm139925452577568"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-override</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-enter</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-override"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-override — Override application requirements</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak override</code> [OPTION...] APP </p></div></div><div class="refsect1"><a id="idm139925450845792"></a><h2>Description</h2><p> + Overrides the application specified runtime requirements. This can be used + to grant a sandboxed application more or less resources than it requested. + </p><p> + By default the application gets access to the resources it + requested when it is started. But the user can override it + on a particular instance by specifying extra arguments to + flatpak run, or every time by using flatpak override. + </p></div><div class="refsect1"><a id="idm139925449828368"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">--share=SUBSYSTEM</code></span></dt><dd><p> + Share a subsystem with the host session. This overrides + the Context section from the application metadata. + SUBSYSTEM must be one of: network, ipc. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--unshare=SUBSYSTEM</code></span></dt><dd><p> + Don't share a subsystem with the host session. This overrides + the Context section from the application metadata. + SUBSYSTEM must be one of: network, ipc. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--socket=SOCKET</code></span></dt><dd><p> + Expose a well-known socket to the application. This overrides to + the Context section from the application metadata. + SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--nosocket=SOCKET</code></span></dt><dd><p> + Don't expose a well-known socket to the application. This overrides to + the Context section from the application metadata. + SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--device=DEVICE</code></span></dt><dd><p> + Expose a device to the application. This overrides to + the Context section from the application metadata. + DEVICE must be one of: dri, all. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--nodevice=DEVICE</code></span></dt><dd><p> + Don't expose a device to the application. This overrides to + the Context section from the application metadata. + DEVICE must be one of: dri, all. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--filesystem=FS</code></span></dt><dd><p> + Allow the application access to a subset of the filesystem. + This overrides to the Context section from the application metadata. + FS can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, + an absolute path, or a homedir-relative path like ~/dir or paths + relative to the xdg dirs, like xdg-download/subdir. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--env=VAR=VALUE</code></span></dt><dd><p> + Set an environment variable in the application. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--own-name=NAME</code></span></dt><dd><p> + Allow the application to own the well-known name NAME on the session bus. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--talk-name=NAME</code></span></dt><dd><p> + Allow the application to talk to the well-known name NAME on the session bus. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--system-own-name=NAME</code></span></dt><dd><p> + Allow the application to own the well known name NAME on the system bus. + If NAME ends with .*, it allows the application to own all matching names. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--system-talk-name=NAME</code></span></dt><dd><p> + Allow the application to talk to the well known name NAME on the system bus. + If NAME ends with .*, it allows the application to talk to all matching names. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--persist=FILENAME</code></span></dt><dd><p> + If the application doesn't have access to the real homedir, make the (homedir-relative) path + FILENAME a bind mount to the corresponding path in the per-application directory, + allowing that location to be used for persistent data. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925449948288"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak override --nosocket=wayland org.gnome.GEdit</strong></span> + </p><p> + <span class="command"><strong>$ flatpak override --filesystem=home org.mozilla.Firefox</strong></span> + </p></div><div class="refsect1"><a id="idm139925449945120"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-run</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-enter"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-enter — Enter an application</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak enter</code> [OPTION...] MONITORPID COMMAND [ARG...]</p></div></div><div class="refsect1"><a id="idm139925453141904"></a><h2>Description</h2><p> + Enter a running sandbox. + MONITORPID must be the pid of the monitor process for a running sandbox. + COMMAND is the command to run in the sandbox. + Extra arguments are passed on to the command. + </p><p> + This creates a new process within the running sandbox, with the same environment. This is useful + when you want to debug a problem with a running application. + </p></div><div class="refsect1"><a id="idm139925460194320"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925450789872"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak enter 15345 sh</strong></span> + </p></div><div class="refsect1"><a id="idm139925450330864"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-run</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-document-export"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-document-export — Export a file to a sandboxed application</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak document-export</code> [OPTION...] FILE </p></div></div><div class="refsect1"><a id="idm139925452970880"></a><h2>Description</h2><p> + Creates a document id for a local file that can be exposed to + sandboxed applications, allowing them access to files that they + would not otherwise see. The exported files are exposed in a + fuse filesystem at /run/user/$UID/doc/. + </p><p> + This command also lets you modify the per-application + permissions of the documents, granting or revoking access + to the file on a per-application basis. + </p></div><div class="refsect1"><a id="idm139925453526224"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">--unique</code></span></dt><dd><p> Don't reuse an existing document id + for the file. This makes it safe to later remove the + document when you're finished with it. + </p></dd><dt><span class="term"><code class="option">--transient</code></span></dt><dd><p> + The document will only exist for the length of + the session. This is useful for temporary grants. + </p></dd><dt><span class="term"><code class="option">--app=APPID</code></span></dt><dd><p> + Grant read access to the specified application. The + --allow and --forbid options can be used to grant + or remove additional privileges. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--allow-read</code></span></dt><dd><p> + Grant read access to the applications specified with --app. + This defaults to TRUE. + </p></dd><dt><span class="term"><code class="option">--forbid-read</code></span></dt><dd><p> + Revoke read access for the applications specified with --app. + </p></dd><dt><span class="term"><code class="option">--allow-write</code></span></dt><dd><p> + Grant write access to the applications specified with --app. + </p></dd><dt><span class="term"><code class="option">--forbid-write</code></span></dt><dd><p> + Revoke write access for the applications specified with --app. + </p></dd><dt><span class="term"><code class="option">--allow-delete</code></span></dt><dd><p> + Grant the ability to remove the document from the document portal to the applications specified with --app. + </p></dd><dt><span class="term"><code class="option">--forbid-delete</code></span></dt><dd><p> + Revoke the ability to remove the document from the document portal from the applications specified with --app. + </p></dd><dt><span class="term"><code class="option">--allow-grant-permission</code></span></dt><dd><p> + Grant the ability to grant further permissions to the applications specified with --app. + </p></dd><dt><span class="term"><code class="option">--forbid-grant-permission</code></span></dt><dd><p> + Revoke the ability to grant further permissions for the applications specified with --app. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925453376000"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak document-export --app=org.gnome.GEdit ~/test.txt</strong></span> + </p><pre class="programlisting"> +/run/user/1000/doc/e52f9c6a/test.txt +</pre></div><div class="refsect1"><a id="idm139925453373232"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-document-unexport</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-document-info</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-document-list</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-document-unexport"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-document-unexport — Stop exporting a file</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak document-export</code> [OPTION...] FILE </p></div></div><div class="refsect1"><a id="idm139925450853280"></a><h2>Description</h2><p> + Removes the document id for the file from the + document portal. This will make the document unavailable + to all sandboxed applications. + </p></div><div class="refsect1"><a id="idm139925451084992"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925451871712"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-document-export</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-document-info</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-document-list</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-document-info"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-document-info — Show information about exported files</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak document-info</code> [OPTION...] FILE </p></div></div><div class="refsect1"><a id="idm139925450218656"></a><h2>Description</h2><p> + Shows information about an exported file, such as the + document id, the fuse path, the original location in the + filesystem, and the per-application permissions. + </p><p> + FILE can either be a file in the fuse filesystem at /run/user/$UID/doc/, + or a file anywhere else. + </p></div><div class="refsect1"><a id="idm139925452702672"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925450816096"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak document-info ~/Sources/gtk/gail-3.0.pc</strong></span> + </p><pre class="programlisting"> +id: dd32c34a +path: /run/user/1000/doc/dd32c34a/gail-3.0.pc +origin: /home/mclasen/Sources/gtk/gail-3.0.pc +permissions: + org.gnome.gedit read, write +</pre></div><div class="refsect1"><a id="idm139925451914848"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-document-export</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-document-unexport</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-document-list</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-document-list"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-document-list — List exported files</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak document-list</code> [OPTION...] [APPID]</p></div></div><div class="refsect1"><a id="idm139925450050160"></a><h2>Description</h2><p> + Lists exported files, with their document id and the + full path to their origin. If an APPID is specified, + only the files exported to this app are listed. + </p></div><div class="refsect1"><a id="idm139925453200528"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925454335392"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-document-export</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-document-unexport</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-document-info</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-remote-add"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-remote-add — Add a remote repository</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak remote-add</code> [OPTION...] NAME LOCATION </p></div></div><div class="refsect1"><a id="idm139925453839872"></a><h2>Description</h2><p> + Adds a remote repository to the flatpak repository configuration. + NAME is the name for the new remote, and + LOCATION is the url or pathname for the repository. + </p><p> + Unless overridden with the --user option, this command changes + the system-wide configuration. + </p></div><div class="refsect1"><a id="idm139925450194768"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">--user</code></span></dt><dd><p> + Modify the per-user configuration. + </p></dd><dt><span class="term"><code class="option">--system</code></span></dt><dd><p> + Modify the system-wide configuration. + </p></dd><dt><span class="term"><code class="option">--no-gpg-verify</code></span></dt><dd><p> + Disable GPG verification for the added remote. + </p></dd><dt><span class="term"><code class="option">--prio=PRIO</code></span></dt><dd><p> + Set the priority for the remote. Default is 1, higher is more prioritized. This is + mainly used for graphical installation tools. + </p></dd><dt><span class="term"><code class="option">--no-enumerate</code></span></dt><dd><p> + Mark the remote as not enumerated. This means the remote will + not be used to list applications, for instance in graphical + installation tools. + </p></dd><dt><span class="term"><code class="option">--if-not-exists</code></span></dt><dd><p> + Do nothing if the provided remote already exists. + </p></dd><dt><span class="term"><code class="option">--disable</code></span></dt><dd><p> + Disable the added remote. + </p></dd><dt><span class="term"><code class="option">--title=TITLE</code></span></dt><dd><p> + A title for the remote, e.g. for display in a UI. + </p></dd><dt><span class="term"><code class="option">--gpg-import=FILE</code></span></dt><dd><p> + Import gpg keys from the specified keyring file as + trusted for the new remote. If the file is - the + keyring is read from standard input. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925449702864"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak --user remote-add --no-gpg-verify test-repo https://people.gnome.org/~alexl/gnome-sdk/repo/</strong></span> + </p></div><div class="refsect1"><a id="idm139925449700720"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-modify-remote</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-delete-remote</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-list-remotes</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-remote-modify"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-remote-modify — Modify a remote repository</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak remote-modify</code> [OPTION...] NAME </p></div></div><div class="refsect1"><a id="idm139925453978704"></a><h2>Description</h2><p> + Modifies options for an existing remote repository in the flatpak repository configuration. + NAME is the name for the remote. + </p><p> + Unless overridden with the --user option, this command changes + the system-wide configuration. + </p></div><div class="refsect1"><a id="idm139925450308176"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">--user</code></span></dt><dd><p> + Modify the per-user configuration. + </p></dd><dt><span class="term"><code class="option">--system</code></span></dt><dd><p> + Modify the system-wide configuration. + </p></dd><dt><span class="term"><code class="option">--no-gpg-verify</code></span></dt><dd><p> + Disable GPG verification for the added remote. + </p></dd><dt><span class="term"><code class="option">--gpg-verify</code></span></dt><dd><p> + Enable GPG verification for the added remote. + </p></dd><dt><span class="term"><code class="option">--prio=PRIO</code></span></dt><dd><p> + Set the priority for the remote. Default is 1, higher is more prioritized. This is + mainly used for graphical installation tools. + </p></dd><dt><span class="term"><code class="option">--no-enumerate</code></span></dt><dd><p> + Mark the remote as not enumerated. This means the remote will + not be used to list applications, for instance in graphical + installation tools. + </p></dd><dt><span class="term"><code class="option">--disable</code></span></dt><dd><p> + Disable the remote. Disabled remotes will not be automatically updated from. + </p></dd><dt><span class="term"><code class="option">--enable</code></span></dt><dd><p> + Enable the remote. + </p></dd><dt><span class="term"><code class="option">--enumerate</code></span></dt><dd><p> + Mark the remote as enumerated. This means the remote will + be used to list applications, for instance in graphical + installation tools. + </p></dd><dt><span class="term"><code class="option">--title=TITLE</code></span></dt><dd><p> + A title for the remote, e.g. for display in a UI. + </p></dd><dt><span class="term"><code class="option">--gpg-import=FILE</code></span></dt><dd><p> + Import gpg keys from the specified keyring file as + trusted for the new remote. If the file is - the + keyring is read from standard input. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925451143360"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak --user remote-modify --no-gpg-verify test-repo</strong></span> + </p></div><div class="refsect1"><a id="idm139925451141328"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-remote-add</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-remote-delete</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-remote-list</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-remote-delete"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-remote-delete — Delete a remote repository</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak remote-delete</code> [OPTION...] NAME </p></div></div><div class="refsect1"><a id="idm139925450810192"></a><h2>Description</h2><p> + Removes a remote repository from the flatpak repository configuration. + NAME is the name of an existing remote. + </p><p> + Unless overridden with the --user option, this command changes + the system-wide configuration. + </p></div><div class="refsect1"><a id="idm139925452042512"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">--user</code></span></dt><dd><p> + Modify the per-user configuration. + </p></dd><dt><span class="term"><code class="option">--system</code></span></dt><dd><p> + Modify the system-wide configuration. + </p></dd><dt><span class="term"><code class="option">--force</code></span></dt><dd><p> + Remove remote even if its in use by installed apps or runtimes. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925449607200"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak --user remote-delete dried-raisins</strong></span> + </p></div><div class="refsect1"><a id="idm139925449605168"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-add-remote</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-modify-remote</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-list-remotes</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-remote-list"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-remote-list — List remote repositories</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak remote-list</code> [OPTION...]</p></div></div><div class="refsect1"><a id="idm139925450895808"></a><h2>Description</h2><p> + Lists the known remote repositories, in priority order. + </p><p> + By default, both per-user and system-wide installations + are shown. Use the --user or --system options to change + this. + </p></div><div class="refsect1"><a id="idm139925451764368"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">--user</code></span></dt><dd><p> + Show the per-user configuration. + </p></dd><dt><span class="term"><code class="option">--system</code></span></dt><dd><p> + Show the system-wide configuration. + </p></dd><dt><span class="term"><code class="option">--show-details</code></span></dt><dd><p> + Show more information each repository in addition to the name. + </p></dd><dt><span class="term"><code class="option">--show-disabled</code></span></dt><dd><p> + Show disabled repos. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925453389376"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak remote-list --user --show-details</strong></span> + </p><pre class="programlisting"> +testrepo Test Repository http://209.132.179.91/repo/ no-gpg-verify +</pre></div><div class="refsect1"><a id="idm139925453386656"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-add-remote</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-delete-remote</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-remote-ls"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-remote-ls — Show available runtimes and applications</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak remote-ls</code> [OPTION...] REMOTE </p></div></div><div class="refsect1"><a id="idm139925451248576"></a><h2>Description</h2><p> + Shows runtimes and applications that are available in the + remote repository with the name REMOTE . + You can find all configured remote repositories with flatpak list-repos. + </p><p> + Unless overridden with the --user option, this command uses + the system-wide configuration. + </p></div><div class="refsect1"><a id="idm139925452012048"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">--user</code></span></dt><dd><p> + Use the per-user configuration. + </p></dd><dt><span class="term"><code class="option">--system</code></span></dt><dd><p> + Use the system-wide configuration. + </p></dd><dt><span class="term"><code class="option">-d</code>, </span><span class="term"><code class="option">--show-details</code></span></dt><dd><p> + Show arches, branches and commit ids, in addition to the names. + </p></dd><dt><span class="term"><code class="option">--runtime</code></span></dt><dd><p> + Show only runtimes, omit applications. + </p></dd><dt><span class="term"><code class="option">--app</code></span></dt><dd><p> + Show only applications, omit runtimes. + </p></dd><dt><span class="term"><code class="option">--updates</code></span></dt><dd><p> + Show only those which have updates available. + </p></dd><dt><span class="term"><code class="option">--arch=ARCH</code></span></dt><dd><p> + Show only those matching the specied architecture. By default, only + supported architectures are shown. Use --arch=* to show all archtectures. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925452516192"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak --user remote-ls --only-apps testrepo</strong></span> + </p><pre class="programlisting"> +org.gnome.Builder +org.freedesktop.glxgears +</pre></div><div class="refsect1"><a id="idm139925452355104"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-remote-list</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-build-init"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-build-init — Initialize a build directory</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak build-init</code> [OPTION...] DIRECTORY APPNAME SDK RUNTIME [BRANCH]</p></div></div><div class="refsect1"><a id="idm139925453424272"></a><h2>Description</h2><p> + Initializes a directory for building an application. + DIRECTORY is the name of the directory. + APPNAME is the application id of the app + that will be built. + SDK and RUNTIME + specify the sdk and runtime that the application should be built + against and run in. + </p><p> + The result of this command is that a <code class="filename">metadata</code> + file is created inside the given directory. Additionally, empty + <code class="filename">files</code> and <code class="filename">var</code> subdirectories + are created. + </p><p> + It is an error to run build-init on a directory that has already + been initialized as a build directory. + </p></div><div class="refsect1"><a id="idm139925454196816"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">--arch=ARCH</code></span></dt><dd><p> + The architecture to use. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--var=RUNTIME</code></span></dt><dd><p> + Initialize var from the named runtime. + </p></dd><dt><span class="term"><code class="option">-w</code>, </span><span class="term"><code class="option">--writable-sdk</code></span></dt><dd><p> + Initialize /usr with a copy of the sdk, which is writable during flatpak build. This can be used + if you need to install build tools in /usr during the build. This is stored in the + <code class="filename">usr</code> subdirectory of the app dir, but will not be part of the final + app. + </p></dd><dt><span class="term"><code class="option">--tag=TAG</code></span></dt><dd><p> + Add a tag to the metadata file. + </p></dd><dt><span class="term"><code class="option">--sdk-extension=EXTENSION</code></span></dt><dd><p> + When using --writable-sdk, in addition to the sdk, also install the specified extension. + </p></dd><dt><span class="term"><code class="option">--sdk-dir</code></span></dt><dd><p> + Specify a custom subdirectory to use instead of <code class="filename">usr</code> for --writable-sdk. + </p></dd><dt><span class="term"><code class="option">--update</code></span></dt><dd><p> + Re-initialize the sdk and var, don't fail if already initialized. + </p></dd><dt><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925452529488"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak build-init /build/my-app org.gnome.Sdk org.gnome.Platform 3.16</strong></span> + </p></div><div class="refsect1"><a id="idm139925452527456"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build-finish</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build-export</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-build"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-build — Build in a directory</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak build</code> [OPTION...] DIRECTORY [COMMAND [ARG...]]</p></div></div><div class="refsect1"><a id="idm139925451729168"></a><h2>Description</h2><p> + Runs a build command in a directory. DIRECTORY + must have been initialized with <span class="command"><strong>flatpak build-init</strong></span>. + </p><p> + The sdk that is specified in the <code class="filename">metadata</code> file + in the directory is mounted at <code class="filename">/usr</code> and the + <code class="filename">files</code> and <code class="filename">var</code> subdirectories + are mounted at <code class="filename">/app</code> and <code class="filename">/var</code>, + respectively. They are writable, and their contents are preserved between + build commands, to allow accumulating build artifacts there. + </p></div><div class="refsect1"><a id="idm139925449545344"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd><dt><span class="term"><code class="option">-r</code>, </span><span class="term"><code class="option">--runtime</code></span></dt><dd><p> + Use the non-devel runtime that is specified in the application metadata instead of the devel runtime. + </p></dd><dt><span class="term"><code class="option">--bind-mount=DEST=SOURCE</code></span></dt><dd><p> + Add a custom bind mount in the build namespace. Can be specified multiple times. + </p></dd><dt><span class="term"><code class="option">--build-dir=PATH</code></span></dt><dd><p> + Start the build in this directory (default is in the current directory). + </p></dd><dt><span class="term"><code class="option">--share=SUBSYSTEM</code></span></dt><dd><p> + Share a subsystem with the host session. This overrides + the Context section from the application metadata. + SUBSYSTEM must be one of: network, ipc. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--unshare=SUBSYSTEM</code></span></dt><dd><p> + Don't share a subsystem with the host session. This overrides + the Context section from the application metadata. + SUBSYSTEM must be one of: network, ipc. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--socket=SOCKET</code></span></dt><dd><p> + Expose a well-known socket to the application. This overrides to + the Context section from the application metadata. + SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--nosocket=SOCKET</code></span></dt><dd><p> + Don't expose a well-known socket to the application. This overrides to + the Context section from the application metadata. + SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--device=DEVICE</code></span></dt><dd><p> + Expose a device to the application. This overrides to + the Context section from the application metadata. + DEVICE must be one of: dri, all. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--nodevice=DEVICE</code></span></dt><dd><p> + Don't expose a device to the application. This overrides to + the Context section from the application metadata. + DEVICE must be one of: dri, all. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--filesystem=FILESYSTEM[:ro]</code></span></dt><dd><p> + Allow the application access to a subset of the filesystem. + This overrides to the Context section from the application metadata. + FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, + an absolute path, or a homedir-relative path like ~/dir. + The optional :ro suffix indicates that the location will be read-only. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--nofilesystem=FILESYSTEM</code></span></dt><dd><p> + Remove access to the specified subset of the filesystem from + the application. This overrides to the Context section from the + application metadata. + FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, + an absolute path, or a homedir-relative path like ~/dir. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--env=VAR=VALUE</code></span></dt><dd><p> + Set an environment variable in the application. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--own-name=NAME</code></span></dt><dd><p> + Allow the application to own the well-known name NAME on the session bus. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--talk-name=NAME</code></span></dt><dd><p> + Allow the application to talk to the well-known name NAME on the session bus. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--system-own-name=NAME</code></span></dt><dd><p> + Allow the application to own the well-known name NAME on the system bus. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--system-talk-name=NAME</code></span></dt><dd><p> + Allow the application to talk to the well-known name NAME on the system bus. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--persist=FILENAME</code></span></dt><dd><p> + If the application doesn't have access to the real homedir, make the (homedir-relative) path + FILENAME a bind mount to the corresponding path in the per-application directory, + allowing that location to be used for persistent data. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925449263856"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak build /build/my-app rpmbuild my-app.src.rpm</strong></span> + </p></div><div class="refsect1"><a id="idm139925449261824"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build-init</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build-finish</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build-export</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-build-finish"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-build-finish — Finalize a build directory</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak build-finish</code> [OPTION...] DIRECTORY </p></div></div><div class="refsect1"><a id="idm139925451752944"></a><h2>Description</h2><p> + Finalizes a build directory, to prepare it for exporting. + DIRECTORY is the name of the directory. + </p><p> + The result of this command is that desktop files, icons and + D-Bus service files from the <code class="filename">files</code> subdirectory + are copied to a new <code class="filename">export</code> subdirectory. In the + <code class="filename">metadata</code> file, the command key is set in the + [Application] group, and the supported keys in the [Environment] + group are set according to the options. + </p><p> + You should review the exported files and the application metadata + before creating and distributing an application bundle. + </p><p> + It is an error to run build-finish on a directory that has not + been initialized as a build directory, or has already been finalized. + </p></div><div class="refsect1"><a id="idm139925453852960"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">--command=COMMAND</code></span></dt><dd><p> + The command to use. If this option is not specified, + the first executable found in <code class="filename">files/bin</code> + is used. + </p></dd><dt><span class="term"><code class="option">--share=SUBSYSTEM</code></span></dt><dd><p> + Share a subsystem with the host session. This updates + the [Context] group in the metadata. + SUBSYSTEM must be one of: network, ipc. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--unshare=SUBSYSTEM</code></span></dt><dd><p> + Don't share a subsystem with the host session. This updates + the [Context] group in the metadata. + SUBSYSTEM must be one of: network, ipc. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--socket=SOCKET</code></span></dt><dd><p> + Expose a well known socket to the application. This updates + the [Context] group in the metadata. + SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--nosocket=SOCKET</code></span></dt><dd><p> + Don't expose a well known socket to the application. This updates + the [Context] group in the metadata. + SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--device=DEVICE</code></span></dt><dd><p> + Expose a device to the application. This updates + the [Context] group in the metadata. + DEVICE must be one of: dri, all. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--nodevice=DEVICE</code></span></dt><dd><p> + Don't expose a device to the application. This updates + the [Context] group in the metadata. + DEVICE must be one of: dri, all. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--filesystem=FS</code></span></dt><dd><p> + Allow the application access to a subset of the filesystem. + This updates the [Context] group in the metadata. + FS can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, + an absolute path, or a homedir-relative path like ~/dir or paths + relative to the xdg dirs, like xdg-download/subdir. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--env=VAR=VALUE</code></span></dt><dd><p> + Set an environment variable in the application. + This updates the [Environment] group in the metadata. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--own-name=NAME</code></span></dt><dd><p> + Allow the application to own the well known name NAME on the session bus. + If NAME ends with .*, it allows the application to own all matching names. + + This updates the [Session Bus Policy] group in the metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--talk-name=NAME</code></span></dt><dd><p> + Allow the application to talk to the well known name NAME on the session bus. + If NAME ends with .*, it allows the application to talk to all matching names. + This updates the [Session Bus Policy] group in the metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--system-own-name=NAME</code></span></dt><dd><p> + Allow the application to own the well known name NAME on the system bus. + If NAME ends with .*, it allows the application to own all matching names. + This updates the [System Bus Policy] group in the metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--system-talk-name=NAME</code></span></dt><dd><p> + Allow the application to talk to the well known name NAME on the system bus. + If NAME ends with .*, it allows the application to talk to all matching names. + This updates the [System Bus Policy] group in the metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--persist=FILENAME</code></span></dt><dd><p> + If the application doesn't have access to the real homedir, make the (homedir-relative) path + FILENAME a bind mount to the corresponding path in the per-application directory, + allowing that location to be used for persistent data. + This updates the [Context] group in the metadata. + This option can be used multiple times. + </p></dd><dt><span class="term"><code class="option">--no-exports</code></span></dt><dd><p> + Don't look for exports in the build. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925452558512"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak build-finish /build/my-app --socket=x11 --share=ipc</strong></span> + </p><pre class="programlisting"> +Exporting share/applications/gnome-calculator.desktop +Exporting share/dbus-1/services/org.gnome.Calculator.SearchProvider.service +More than one executable +Using gcalccmd as command +Please review the exported files and the metadata +</pre></div><div class="refsect1"><a id="idm139925452555536"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build-init</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build-export</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-build-export"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-build-export — Create a repository from a build directory</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak build-export</code> [OPTION...] LOCATION DIRECTORY [BRANCH]</p></div></div><div class="refsect1"><a id="idm139925452621472"></a><h2>Description</h2><p> + Creates or updates a repository with an application build. + LOCATION is the location of the + repository. DIRECTORY must be a + finalized build directory. If BRANCH + is not specified, it is assumed to be "master". + </p><p> + If LOCATION exists, it is assumed to + be an OSTree repository, otherwise a new OSTree repository is + created at this location. The repository can be inspected with + the <span class="command"><strong>ostree</strong></span> tool. + </p><p> + The contents of DIRECTORY are committed + on the branch with name <code class="literal">app/APPNAME/ARCH/BRANCH</code>, + where ARCH is the architecture of the runtime that the application + is using. A commit filter is used to enforce that only the contents + of the <code class="filename">files/</code> and <code class="filename">export/</code> + subdirectories and the <code class="filename">metadata</code> file are included + in the commit, anything else is ignored. + </p><p> + The repo-update command should be used to update repository + metadata whenever application builds are added to a repository. + </p></div><div class="refsect1"><a id="idm139925450149792"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">-s</code>, </span><span class="term"><code class="option">--subject=SUBJECT</code></span></dt><dd><p> + One line subject for the commit message. + </p></dd><dt><span class="term"><code class="option">-b</code>, </span><span class="term"><code class="option">--body=BODY</code></span></dt><dd><p> + Full description for the commit message. + </p></dd><dt><span class="term"><code class="option">--arch=ARCH</code></span></dt><dd><p> + Specify the architecture component of the branch to export. Only host compatible architectures can be specified. + </p></dd><dt><span class="term"><code class="option">--exclude=PATTERN</code></span></dt><dd><p> + Exclude files matching PATTERN from the commit. + </p></dd><dt><span class="term"><code class="option">--include=PATTERN</code></span></dt><dd><p> + Don't exclude files matching PATTERN from the commit, even if they match the --export patterns. + </p></dd><dt><span class="term"><code class="option">--metadata=FILENAME</code></span></dt><dd><p> + Use the specified filename as metadata in the exported app instead of + the default file (called <code class="filename">metadata</code>). This is useful + if you want to commit multiple things from a single build tree, typically + used in combination with --files and --exclude. + </p></dd><dt><span class="term"><code class="option">--files=SUBDIR</code></span></dt><dd><p> + Use the files in the specified subdirectory as the file contents, rather + than the regular <code class="filename">files</code> directory. + </p></dd><dt><span class="term"><code class="option">--update-appstream</code></span></dt><dd><p> + Run appstream-builder and to update the appstream branch after build. + </p></dd><dt><span class="term"><code class="option">--gpg-sign=KEYID</code></span></dt><dd><p> + Sign the commit with this GPG key + </p></dd><dt><span class="term"><code class="option">--gpg-homedir=PATH</code></span></dt><dd><p> + GPG Homedir to use when looking for keyrings + </p></dd><dt><span class="term"><code class="option">--runtime</code></span></dt><dd><p> + Export a runtime instead for an app (this uses the usr subdir as files). + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925449560528"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak build-export ~/repos/gnome-calculator/ ~/build/gnome-calculator/ org.gnome.Calculator</strong></span> + </p><pre class="programlisting"> +Commit: 9d0044ea480297114d03aec85c3d7ae3779438f9d2cb69d717fb54237acacb8c +Metadata Total: 605 +Metadata Written: 5 +Content Total: 1174 +Content Written: 1 +Content Bytes Written: 305 +</pre></div><div class="refsect1"><a id="idm139925449557504"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">ostree</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build-init</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build-finish</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build-sign</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-repo-update</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-build-bundle"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-build-bundle — Create a single-file bundle from a local repository</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak build-bundle</code> [OPTION...] LOCATION FILENAME NAME [BRANCH]</p></div></div><div class="refsect1"><a id="idm139925451554624"></a><h2>Description</h2><p> + Creates a single-file named FILENAME + for the application (or runtime) named NAME + in the repository at LOCATION . If + a BRANCH is specified, this branch of + the application is used. + </p><p> + The format of the bundle file is that of an ostree static delta + (against an empty base) with some flatpak specific metadata for + the application icons and appdata. + </p></div><div class="refsect1"><a id="idm139925449431728"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">--runtime</code></span></dt><dd><p> + Export a runtime instead of an application. + </p></dd><dt><span class="term"><code class="option">--arch=ARCH</code></span></dt><dd><p> + The arch to create a bundle for. + </p></dd><dt><span class="term"><code class="option">--repo-url=URL</code></span></dt><dd><p> + The URL for the repository from which the + application can be updated. Installing the + bundle will automatically configure a remote + for this URL. + </p></dd><dt><span class="term"><code class="option">--gpg-keys=FILE</code></span></dt><dd><p> + Add the GPG key from FILE (use - for stdin). + </p></dd><dt><span class="term"><code class="option">--gpg-homedir=PATH</code></span></dt><dd><p> + GPG Homedir to use when looking for keyrings. + </p></dd><dt><span class="term"><code class="option">--oci</code></span></dt><dd><p> + Export to an OCI image instead of a Flatpak bundle. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925453857488"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">ostree</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build-init</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build-finish</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build-import-bundle</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-repo-update</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-build-import-bundle"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-build-import-bundle — Import a file bundle into a local repository</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak build-import-bundle</code> [OPTION...] LOCATION FILENAME </p></div></div><div class="refsect1"><a id="idm139925451352480"></a><h2>Description</h2><p> + Imports a bundle from a file named FILENAME + into the repository at LOCATION . + </p><p> + The format of the bundle file is that generated by build-bundle. + </p></div><div class="refsect1"><a id="idm139925452834624"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--ref=REF</code></span></dt><dd><p> + Override the ref specified in the bundle. + </p></dd><dt><span class="term"><code class="option">--oci</code></span></dt><dd><p> + Import an OCI image instead of a Flatpak bundle. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925451045744"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">ostree</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build-bundle</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-repo-update</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-build-update-repo"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-build-update-repo — Create a repository from a build directory</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak build-update-repo</code> [OPTION...] LOCATION </p></div></div><div class="refsect1"><a id="idm139925452083376"></a><h2>Description</h2><p> + Updates repository metadata for the repository at + LOCATION . This command generates + an OSTree summary file that lists the contents of the repository. + The summary is used by flatpak repo-contents and other commands + to display the contents of remote repositories. + </p><p> + After this command, LOCATION can be + used as the repository location for flatpak add-repo, either by + exporting it over http, or directly with a file: url. + </p></div><div class="refsect1"><a id="idm139925451282464"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">--title=TITLE</code></span></dt><dd><p> + A title for the repository, e.g. for display in a UI. + The title is stored in the repository summary. + </p></dd><dt><span class="term"><code class="option">--gpg-sign=KEYID</code></span></dt><dd><p> + Sign the commit with this GPG key + </p></dd><dt><span class="term"><code class="option">--gpg-homedir=PATH</code></span></dt><dd><p> + GPG Homedir to use when looking for keyrings + </p></dd><dt><span class="term"><code class="option">--generate-static-deltas</code></span></dt><dd><p> + Generate static deltas for all references. This generates from-empty and + delta static files that allow for faster download. + </p></dd><dt><span class="term"><code class="option">--prune</code></span></dt><dd><p> + Remove unreferences objects in repo. + </p></dd><dt><span class="term"><code class="option">--prune-depth</code></span></dt><dd><p> + Only keep at most this number of old versions for any particular ref. Default is -1 which means infinite. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925449884256"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">ostree</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-repo-contents</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build-export</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-build-export"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-build-sign — Sign an application or runtime</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak build-sign</code> [OPTION...] LOCATION ID [BRANCH]</p></div></div><div class="refsect1"><a id="idm139925451152496"></a><h2>Description</h2><p> + Signs the commit for a specified application or runtime in + a local repository. LOCATION is + the location of the repository. ID is the name of the application, or + runtime if --runtime is specified. If BRANCH is not specified, it is + assumed to be "master". + </p><p> + Applications can also be signed during build-export, but + it is sometimes useful to add additional signatures later. + </p></div><div class="refsect1"><a id="idm139925452359040"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">--gpg-sign=KEYID</code></span></dt><dd><p> + Sign the commit with this GPG key + </p></dd><dt><span class="term"><code class="option">--gpg-homedir=PATH</code></span></dt><dd><p> + GPG Homedir to use when looking for keyrings + </p></dd><dt><span class="term"><code class="option">--runtime</code></span></dt><dd><p> + Sign a runtime instead of an app. + </p></dd><dt><span class="term"><code class="option">--arch=ARCH</code></span></dt><dd><p> + The architecture to use. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925449683072"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak build-export ~/repos/gnome-calculator/ ~/build/gnome-calculator/ org.gnome.Calculator</strong></span> + </p><pre class="programlisting"> +Commit: 9d0044ea480297114d03aec85c3d7ae3779438f9d2cb69d717fb54237acacb8c +Metadata Total: 605 +Metadata Written: 5 +Content Total: 1174 +Content Written: 1 +Content Bytes Written: 305 +</pre></div><div class="refsect1"><a id="idm139925453764544"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">ostree</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build-export</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build</span>(1)</span>, + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-builder"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-builder — Help build application dependencies</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak-builder</code> [OPTION...] DIRECTORY MANIFEST </p></div><div class="cmdsynopsis"><p><code class="command">flatpak-builder</code> --run [OPTION...] DIRECTORY MANIFEST COMMAND </p></div></div><div class="refsect1"><a id="idm139925448786880"></a><h2>Description</h2><p> + <span class="command"><strong>flatpak-builder</strong></span> is a wrapper around the <span class="command"><strong>flatpak build</strong></span> command + that automates the building of applications and their dependencies. It is one option you can use + to build applications. + </p><p> + The goal of <span class="command"><strong>flatpak-builder</strong></span> is to push as much knowledge about how to build modules to + the individual upstream projects. It does this by assuming that the modules adhere to the Build API specified + at https://github.com/cgwalters/build-api. This essentially means that it follows the <span class="command"><strong>./configure + && make && make install</strong></span> scheme with an optional autogen script. If the upstream + does not adhere to the API you can make it do so by adding patches and extra files. + </p><p> + An invocation of <span class="command"><strong>flatpak-builder</strong></span> proceeds in these stages, each being specified + in detail in json format in MANIFEST : + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: bullet; "><li class="listitem" style="list-style-type: disc"><p>Download all sources</p></li><li class="listitem" style="list-style-type: disc"><p>Initialize the application directory with <span class="command"><strong>flatpak build-init</strong></span></p></li><li class="listitem" style="list-style-type: disc"><p>Build and install each module with <span class="command"><strong>flatpak build</strong></span></p></li><li class="listitem" style="list-style-type: disc"><p>Clean up the final build tree by removing unwanted files and e.g. stripping binaries</p></li><li class="listitem" style="list-style-type: disc"><p>Finish the application directory with <span class="command"><strong>flatpak build-finish</strong></span></p></li></ul></div><p> + + After this you will end up with a build of the application in DIRECTORY , which you can + export to a repository with the <span class="command"><strong>flatpak build-export</strong></span> command. If you use the <code class="option">--repo</code> + option, flatpack-builder will do the export for you at the end of the build process. When flatpak-builder does the + export, it also stores the manifest that was used for the build in /app/manifest.json. The manifest is 'resolved', + i.e. git branch names are replaced by the actual commit IDs that were used in the build. + </p><p> + At each of the above steps flatpak caches the result, and if you build the same file again, it will start + of at the first step where something changes. For instance the first version controlled source that had + new commits added, or the first module where some changes to the MANIFEST file caused + the build environment to change. This makes flatpak-builder very efficient for incremental builds. + </p></div><div class="refsect1"><a id="idm139925452386064"></a><h2>Manifest format</h2><div class="refsect2"><a id="idm139925452385328"></a><h3>Toplevel</h3><p> + The top level of the json file describes global + attributes of the application, and how it can be + build, and the list of modules that need to be + built. + </p><p> + These are the properties that are accepted: + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">id</code> or <code class="option">app-id</code> (string)</span></dt><dd><p>A string defining the application id.</p></dd><dt><span class="term"><code class="option">branch</code> (string)</span></dt><dd><p>The branch of the application, defaults to master.</p></dd><dt><span class="term"><code class="option">runtime</code> (string)</span></dt><dd><p>The name of the runtime that the application uses.</p></dd><dt><span class="term"><code class="option">runtime-version</code> (string)</span></dt><dd><p>The version of the runtime that the application uses, defaults to master.</p></dd><dt><span class="term"><code class="option">sdk</code> (string)</span></dt><dd><p>The name of the development runtime that the application builds with.</p></dd><dt><span class="term"><code class="option">var</code> (string)</span></dt><dd><p>Initialize the (otherwise empty) writable /var in the build with a copy of this runtime.</p></dd><dt><span class="term"><code class="option">metadata</code> (string)</span></dt><dd><p>Use this file as the base metadata file when finishing.</p></dd><dt><span class="term"><code class="option">command</code> (string)</span></dt><dd><p>The filename or path to the main binary of the application. Note that this is really just a single file, not a commandline. If you want to pass arguments, install a shell script wrapper and use that as the command.</p></dd><dt><span class="term"><code class="option">build-runtime</code> (boolean)</span></dt><dd><p>Build a new runtime instead of an application.</p></dd><dt><span class="term"><code class="option">separate-locales</code> (boolean)</span></dt><dd><p>Separate out locale files and translations to an extension runtime. Defaults to true.</p></dd><dt><span class="term"><code class="option">id-platform</code> (string)</span></dt><dd><p>When building a runtime sdk, also create a platform based on it with this id.</p></dd><dt><span class="term"><code class="option">metadata-platform</code> (string)</span></dt><dd><p>The metadata file to use for the platform we create.</p></dd><dt><span class="term"><code class="option">writable-sdk</code> (boolean)</span></dt><dd><p>If true, use a writable copy of the sdk for /usr. + Defaults to true if --build-runtime is specified.</p></dd><dt><span class="term"><code class="option">appstream-compose</code> (boolean)</span></dt><dd><p>Run appstream-compose during cleanup phase. Defaults to true.</p></dd><dt><span class="term"><code class="option">sdk-extensions</code> (array of strings)</span></dt><dd><p>Install these extra sdk extensions in /usr.</p></dd><dt><span class="term"><code class="option">platform-extensions</code> (array of strings)</span></dt><dd><p>Install these extra sdk extensions when creating the platform.</p></dd><dt><span class="term"><code class="option">tags</code> (array of strings)</span></dt><dd><p>Add these tags to the metadata file.</p></dd><dt><span class="term"><code class="option">build-options</code> (object)</span></dt><dd><p>Object specifying the build environment. See below for details.</p></dd><dt><span class="term"><code class="option">modules</code> (array of objects or string)</span></dt><dd><p>An array of object specifying the modules to be built in order. + String members in the array are interpreted as the name of a separate json file that contains a module. + See below for details.</p></dd><dt><span class="term"><code class="option">cleanup</code> (array of strings)</span></dt><dd><p>An array of file patterns that should be removed at the end. + Patterns starting with / are taken to be full pathnames (without the /app prefix), otherwise they just match + the basename.</p></dd><dt><span class="term"><code class="option">cleanup-commands</code> (array of strings)</span></dt><dd><p>An array of commandlines that are run during the cleanup phase.</p></dd><dt><span class="term"><code class="option">cleanup-platform</code> (array of strings)</span></dt><dd><p>Extra files to clean up in the platform.</p></dd><dt><span class="term"><code class="option">finish-args</code> (array of strings)</span></dt><dd><p>An array of arguments passed to the <span class="command"><strong>flatpak build-finish</strong></span> command.</p></dd><dt><span class="term"><code class="option">rename-desktop-file</code> (string)</span></dt><dd><p>Any desktop file with this name will be renamed to a name based on id during the cleanup phase.</p></dd><dt><span class="term"><code class="option">rename-appdata-file</code> (string)</span></dt><dd><p>Any appdata file with this name will be renamed to a name based on id during the cleanup phase.</p></dd><dt><span class="term"><code class="option">rename-icon</code> (string)</span></dt><dd><p>Any icon with this name will be renamed to a name based on id during the cleanup phase.</p></dd><dt><span class="term"><code class="option">copy-icon</code> (boolean)</span></dt><dd><p>If rename-icon is set, keep a copy of the old icon file.</p></dd><dt><span class="term"><code class="option">desktop-file-name-prefix</code> (string)</span></dt><dd><p>This string will be prefixed to the Name key in the main application desktop file.</p></dd><dt><span class="term"><code class="option">desktop-file-name-suffix</code> (string)</span></dt><dd><p>This string will be suffixed to the Name key in the main application desktop file.</p></dd></dl></div></div><div class="refsect2"><a id="idm139925449216192"></a><h3>Build Options</h3><p> + Build options specify the build environment of a module, and can be specified globally as + well as per-module. Options can also be specified on a per-architecture basis using the arch property. + </p><p> + These are the properties that are accepted: + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">cflags</code> (string)</span></dt><dd><p>This is set in the environment variable CFLAGS during the build.</p></dd><dt><span class="term"><code class="option">cxxflags</code> (string)</span></dt><dd><p>This is set in the environment variable CXXFLAGS during the build.</p></dd><dt><span class="term"><code class="option">prefix</code> (string)</span></dt><dd><p>The build prefix for the modules (defaults to <code class="filename">/app</code> for + applications and <code class="filename">/usr</code> for runtimes).</p></dd><dt><span class="term"><code class="option">env</code> (object)</span></dt><dd><p>This is a dictionary defining environment variables to be set during the build.</p></dd><dt><span class="term"><code class="option">build-args</code> (array of strings)</span></dt><dd><p>This is an array containing extra options to pass to flatpak build.</p></dd><dt><span class="term"><code class="option">strip</code> (boolean)</span></dt><dd><p>If this is true (the default is false) then all ELF files will be stripped after install.</p></dd><dt><span class="term"><code class="option">no-debuginfo</code> (boolean)</span></dt><dd><p>If this is true (the default is false) and strip is not set then all ELF files will have their debug info extracted to a separate file.</p></dd><dt><span class="term"><code class="option">arch</code> (object)</span></dt><dd><p>This is a dictionary defining for each arch a separate build options object that override the main one.</p></dd></dl></div></div><div class="refsect2"><a id="idm139925449197728"></a><h3>Module</h3><p> + Each module specifies a source that has to be separately built and installed. It contains + the build options and a list of sources to download and extract before building. + </p><p> + Modules can be nested, in order to turn related modules on and off with a single key. + </p><p> + These are the properties that are accepted: + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">name</code> (string)</span></dt><dd><p>The name of the module, used in e.g. build logs. The name is also used for constructing filenames and commandline arguments, therefore using spaces or '/' in this string is a bad idea.</p></dd><dt><span class="term"><code class="option">disabled</code> (boolean)</span></dt><dd><p>If true, skip this module</p></dd><dt><span class="term"><code class="option">sources</code> (array of objects)</span></dt><dd><p>An array of objects defining sources that will be downloaded and extracted in order</p></dd><dt><span class="term"><code class="option">config-opts</code> (array of strings)</span></dt><dd><p>An array of options that will be passed to configure</p></dd><dt><span class="term"><code class="option">make-args</code> (array of strings)</span></dt><dd><p>An array of arguments that will be passed to make</p></dd><dt><span class="term"><code class="option">make-install-args</code> (array of strings)</span></dt><dd><p>An array of arguments that will be passed to make install</p></dd><dt><span class="term"><code class="option">rm-configure</code> (boolean)</span></dt><dd><p>If true, remove the configure script before starting build</p></dd><dt><span class="term"><code class="option">no-autogen</code> (boolean)</span></dt><dd><p>Ignore the existence of an autogen script</p></dd><dt><span class="term"><code class="option">no-parallel-make</code> (boolean)</span></dt><dd><p>Don't call make with arguments to build in parallel</p></dd><dt><span class="term"><code class="option">no-python-timestamp-fix</code> (boolean)</span></dt><dd><p>Don't fix up the *.py[oc] header timestamps for ostree use.</p></dd><dt><span class="term"><code class="option">cmake</code> (boolean)</span></dt><dd><p>Use cmake instead of configure</p></dd><dt><span class="term"><code class="option">builddir</code> (boolean)</span></dt><dd><p>Use a build directory that is separate from the source directory</p></dd><dt><span class="term"><code class="option">subdir</code> (string)</span></dt><dd><p>Build inside this subdirectory of the extracted sources</p></dd><dt><span class="term"><code class="option">build-options</code> (object)</span></dt><dd><p>A build options object that can override global options</p></dd><dt><span class="term"><code class="option">post-install</code> (array of strings)</span></dt><dd><p>An array of shell command that are run after the install phase. Can for example + clean up the install dir, or install extra files. + </p></dd><dt><span class="term"><code class="option">cleanup</code> (array of strings)</span></dt><dd><p>An array of file patterns that should be removed at the end. + Patterns starting with / are taken to be full pathnames (without the /app prefix), otherwise they just match + the basename. Note that any patterns will only match files installed by this module. + </p></dd><dt><span class="term"><code class="option">cleanup-platform</code> (array of strings)</span></dt><dd><p>Extra files to clean up in the platform.</p></dd><dt><span class="term"><code class="option">modules</code> (array of objects or strings)</span></dt><dd><p>An array of object specifying nested modules to be built before this one. + String members in the array are interpreted as names of a separate json file that contains a module.</p></dd></dl></div></div><div class="refsect2"><a id="idm139925449162096"></a><h3>Sources</h3><p> + These contain a pointer to the source that will be extracted into the source directory before + the build starts. They can be of several types, distinguished by the type property. + </p><div class="refsect3"><a id="idm139925449160704"></a><h4>Archive sources (tar, zip)</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">type</code></span></dt><dd><p>"archive"</p></dd><dt><span class="term"><code class="option">path</code> (string)</span></dt><dd><p>The path of the archive</p></dd><dt><span class="term"><code class="option">url</code> (string)</span></dt><dd><p>The url of a remote archive that will be downloaded. This overrides path if both are specified.</p></dd><dt><span class="term"><code class="option">sha256</code> (string)</span></dt><dd><p>The sha256 checksum of the file, verified after download</p></dd><dt><span class="term"><code class="option">strip-components</code> (integer)</span></dt><dd><p>The number of initial pathname components to strip during extraction. Defaults to 1.</p></dd><dt><span class="term"><code class="option">dest</code> (string)</span></dt><dd><p>Directory inside the source dir where the archive will be extracted.</p></dd></dl></div></div><div class="refsect3"><a id="idm139925449148512"></a><h4>Git sources</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">type</code></span></dt><dd><p>"git"</p></dd><dt><span class="term"><code class="option">url</code> (string)</span></dt><dd><p>URL of the git repository</p></dd><dt><span class="term"><code class="option">branch</code> (string)</span></dt><dd><p>The branch/tag/commit to use from the git repository</p></dd><dt><span class="term"><code class="option">dest</code> (string)</span></dt><dd><p>Directory inside the source dir where the repository will be checked out.</p></dd></dl></div></div><div class="refsect3"><a id="idm139925449140112"></a><h4>Bzr sources</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">type</code></span></dt><dd><p>"bzr"</p></dd><dt><span class="term"><code class="option">url</code> (string)</span></dt><dd><p>URL of the bzr repository</p></dd><dt><span class="term"><code class="option">revision</code> (string)</span></dt><dd><p>A specific revision to use in the branch</p></dd><dt><span class="term"><code class="option">dest</code> (string)</span></dt><dd><p>Directory inside the source dir where the repository will be checked out.</p></dd></dl></div></div><div class="refsect3"><a id="idm139925449131712"></a><h4>File sources</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">type</code></span></dt><dd><p>"file"</p></dd><dt><span class="term"><code class="option">path</code> (string)</span></dt><dd><p>The path of a local file that will be copied into the source dir</p></dd><dt><span class="term"><code class="option">url</code> (string)</span></dt><dd><p>The url of a remote file that will be downloaded and copied into the source dir. This overrides path if both are specified.</p></dd><dt><span class="term"><code class="option">sha256</code> (string)</span></dt><dd><p>The sha256 checksum of the file, verified after download. This is optional for local files.</p></dd><dt><span class="term"><code class="option">dest-filename</code> (string)</span></dt><dd><p>Filename to use inside the source dir, default to the basename of path.</p></dd><dt><span class="term"><code class="option">dest</code> (string)</span></dt><dd><p>Directory inside the source dir where the file will be copied.</p></dd></dl></div></div><div class="refsect3"><a id="idm139925449119440"></a><h4>Script sources</h4><p> + This is a way to create a shell (/bin/sh) script from an inline set of commands. + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">type</code></span></dt><dd><p>"script"</p></dd><dt><span class="term"><code class="option">commands</code> (array of strings)</span></dt><dd><p>An array of shell commands that will be put in a shellscript file</p></dd><dt><span class="term"><code class="option">dest-filename</code> (string)</span></dt><dd><p>Filename to use inside the source dir, default to the basename of path.</p></dd><dt><span class="term"><code class="option">dest</code> (string)</span></dt><dd><p>Directory inside the source dir where the file will be copied.</p></dd></dl></div></div><div class="refsect3"><a id="idm139925449110400"></a><h4>Shell sources</h4><p> + This is a to create/modify the sources by running shell commands. + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">type</code></span></dt><dd><p>"shell"</p></dd><dt><span class="term"><code class="option">commands</code> (array of strings)</span></dt><dd><p>An array of shell commands that will be run during source extraction</p></dd></dl></div></div><div class="refsect3"><a id="idm139925449105056"></a><h4>Patch sources</h4><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">type</code></span></dt><dd><p>"patch"</p></dd><dt><span class="term"><code class="option">path</code> (string)</span></dt><dd><p>The path of a patch file that will be applied in the source dir</p></dd><dt><span class="term"><code class="option">strip-components</code> (integer)</span></dt><dd><p>The value of the -p argument to patch, defaults to 1.</p></dd><dt><span class="term"><code class="option">dest</code> (string)</span></dt><dd><p>Directory inside the source dir where the patch will be applied.</p></dd><dt><span class="term"><code class="option">use-git</code> (boolean)</span></dt><dd><p>Whether to use "git apply" rather than "patch" to apply the patch, required when the patch file contains binary diffs.</p></dd></dl></div></div></div></div><div class="refsect1"><a id="idm139925449094432"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd><dt><span class="term"><code class="option">--arch=ARCH</code></span></dt><dd><p> + Specify the machine architecture to build for. If no architecture is specified, the host architecture will be automatically detected. Only host compatible architectures can be specified. + </p></dd><dt><span class="term"><code class="option">--disable-cache</code></span></dt><dd><p> + Don't look at the existing cache for a previous build, instead always rebuild modules. + </p></dd><dt><span class="term"><code class="option">--disable-download</code></span></dt><dd><p> + Don't download any sources. This only works if some version of all sources are downloaded + already. This is useful if you want to guarantee that no network i/o is done. However, the + build will fail if some source is not locally available. + </p></dd><dt><span class="term"><code class="option">--disable-updates</code></span></dt><dd><p> + Download missing sources, but don't update local mirrors of version control repos. This is useful + to rebuild things but without updating git or bzr repositories from the remote repository. + </p></dd><dt><span class="term"><code class="option">--run</code></span></dt><dd><p> + Run a command in a sandbox based on the build dir. This starts flatpak build, with some extra + arguments to give the same environment as the build, and the same permissions the final app + will have. The command to run must be the last argument passed to + flatpak-builder, after the directory and the manifest. + </p></dd><dt><span class="term"><code class="option">--download-only</code></span></dt><dd><p> + Exit successfully after downloading the required sources. + </p></dd><dt><span class="term"><code class="option">--build-only</code></span></dt><dd><p> + Don't do the cleanup and finish stages, which is useful if you + want to build more things into the app. + </p></dd><dt><span class="term"><code class="option">--require-changes</code></span></dt><dd><p> + Do nothing, leaving a non-existent DIRECTORY if nothing changes since + last cached build. If this is not specified, the latest version from the cache will be put + into DIRECTORY . + </p></dd><dt><span class="term"><code class="option">--keep-build-dirs</code></span></dt><dd><p> + Don't remove the sources and build after having built and installed each module. + This also creates a symlink to the build directory with a stable name ("build-modulename"). + </p></dd><dt><span class="term"><code class="option">--ccache</code></span></dt><dd><p> + Enable use of ccache in the build (needs ccache in the sdk) + </p></dd><dt><span class="term"><code class="option">--repo=DIR</code></span></dt><dd><p> + When build is done, run export the result to this repository. + </p></dd><dt><span class="term"><code class="option">-s</code>, </span><span class="term"><code class="option">--subject=SUBJECT</code></span></dt><dd><p> + One line subject for the commit message. + Used when exporting the build results. + </p></dd><dt><span class="term"><code class="option">-b</code>, </span><span class="term"><code class="option">--body=BODY</code></span></dt><dd><p> + Full description for the commit message. + Used when exporting the build results. + </p></dd><dt><span class="term"><code class="option">--gpg-sign=KEYID</code></span></dt><dd><p> + Sign the commit with this GPG key. + Used when exporting the build results. + </p></dd><dt><span class="term"><code class="option">--gpg-homedir=PATH</code></span></dt><dd><p> + GPG Homedir to use when looking for keyrings. + Used when exporting the build results. + </p></dd><dt><span class="term"><code class="option">--force-clean</code></span></dt><dd><p> + Erase the previous contents of DIRECTORY if it is + not empty. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925449055136"></a><h2>Caching</h2><p> + flatpak-builder caches sources and partial build results in + the .flatpak-builder subdirectory of the current directory. If you + use <code class="option">--keep-build-dirs</code>, build directories for each + module are also stored here. + </p><p> + It is safe to remove the contents of the .flatpak-builder + directory. This will force a full build the next time you build. + </p></div><div class="refsect1"><a id="idm139925449052528"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak-builder my-app-dir manifest.json</strong></span> + </p><p> + Example manifest file: + </p><pre class="programlisting"> +{ + "id": "org.test.TestApp", + "runtime": "org.freedesktop.Platform", + "runtime-version": "1.2", + "sdk": "org.freedesktop.Sdk", + "command": "test", + "clean": [ "/include", "*.la" ], + "build-options" : { + "cflags": "-O2 -g", + "cxxflags": "-O2 -g", + "env": { + "V": "1" + }, + "arch": { + "x86_64": { + "cflags": "-O3 -g", + } + } + }, + "modules": [ + { + "name": "pygobject", + "config-opts": [ "--disable-introspection" ], + "sources": [ + { + "type": "archive", + "url": "http://ftp.gnome.org/pub/GNOME/sources/pygobject/2.28/pygobject-2.28.6.tar.xz", + "sha256": "fb8a1d4f665130a125011659bd347c7339c944232163dbb9a34fd0686577adb8" + }, + { + "type": "patch", + "path": "required-pygobject-fix.patch" + }, + { + "type": "file", + "path": "pygobject-extra-file", + "dest-filename": "extra-file" + } + ] + }, + { + "name": "babl", + "build-options" : { "cxxflags": "-O2 -g -std=c++11" }, + "cleanup": [ "/bin" ], + "sources": [ + { + "type": "git", + "url": "git://git.gnome.org/babl" + } + ] + }, + { + "name": "testapp", + "sources": [ + { + "type": "bzr", + "url": "lp:testapp" + } + ] + } + ] +} +</pre></div><div class="refsect1"><a id="idm139925449047648"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build-init</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build-finish</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-build-export</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-metadata"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-metadata — Information about an application or runtime</p></div><div class="refsect1"><a id="idm139925452189056"></a><h2>Description</h2><p> + Flatpak uses metadata files to describe applications and runtimes. + The <code class="filename">metadata</code> file for a deployed application or + runtime is placed in the toplevel deploy directory. For example, the + metadata for the locally installed application org.gnome.Calculator + is in + <code class="filename">~/.local/share/flatpak/app/org.gnome.Calculator/current/active/metadata</code>. + </p><p> + Most aspects of the metadata configuration can be overridden when + launching applications, either temporarily via options of the flatpak + run command, or permanently with the flatpak override command. + </p><p> + A metadata file describing the effective configuration is available + inside the running sandbox at <code class="filename">/run/user/$UID/flatpak-info</code>. + </p></div><div class="refsect1"><a id="idm139925452886848"></a><h2>File format</h2><p> + The metadata file is using the same .ini file format that is used for + systemd unit files or application .desktop files. + </p><div class="refsect2"><a id="idm139925449041600"></a><h3>[Application] or [Runtime]</h3><p> + Metadata for applications starts with an [Application] group, + metadata for runtimes with a [Runtime] group. + </p><p> + The following keys can be present in these groups: + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">name</code> (string)</span></dt><dd><p>The name of the application or runtime. This key is mandatory.</p></dd><dt><span class="term"><code class="option">runtime</code> (string)</span></dt><dd><p>The fully qualified name of the runtime that is used by the application. This key is mandatory for applications.</p></dd><dt><span class="term"><code class="option">sdk</code> (string)</span></dt><dd><p>The fully qualified name of the sdk that matches the runtime.</p></dd><dt><span class="term"><code class="option">command</code> (string)</span></dt><dd><p>The command to run. Only relevant for applications.</p></dd></dl></div></div><div class="refsect2"><a id="idm139925452250704"></a><h3>[Context]</h3><p> + This group determines various system resources that may be shared + with the application when it is run in a flatpak sandbox. + </p><p> + All keys in this group (and the group itself) are optional. + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">shared</code> (list)</span></dt><dd><p> + List of subsystems to share with the host system. + Possible subsystems: network, ipc. + </p></dd><dt><span class="term"><code class="option">sockets</code> (list)</span></dt><dd><p> + List of well-known sockets to make available in the sandbox. + Possible sockets: x11, wayland, pulseaudio, session-bus, system-bus. + When making a socket available, flatpak also sets + well-known environment variables like DISPLAY or + DBUS_SYSTEM_BUS_ADDRESS to let the application + find sockets that are not in a fixed location. + </p></dd><dt><span class="term"><code class="option">devices</code> (list)</span></dt><dd><p> + List of devices to make available in the sandbox. + Possible values: dri, all. + </p></dd><dt><span class="term"><code class="option">filesystems</code> (list)</span></dt><dd><p> + List of filesystem subsets to make available to the + application. Possible values: home, host, xdg-desktop, + xdg-documents, xdg-download xdg-music, xdg-pictures, + xdg-public-share, xdg-templates, xdg-videos, xdg-run, + an absolute path, or a homedir-relative path like + ~/dir or paths relative to the xdg dirs, like + xdg-download/subdir. The xdg-* arguments can also + specify a subdirectory, such as xdg-pictures/screenshots. + Each entry can have a suffix of + :ro or :rw to indicate if the path should be shared + read-only or read-write (default is read-write). + </p></dd><dt><span class="term"><code class="option">persistent</code> (list)</span></dt><dd><p> + List of homedir-relative paths to make available at + the corresponding path in the per-application home directory, + allowing the locations to be used for persistent data when + the application does not have access to the real homedir. + For instance making ".myapp" persistent would make "~/.myapp" + in the sandbox a bind mount to "~/.var/app/org.my.App/.myapp", + thus allowing an unmodified application to save data in + the per-application location. + </p></dd></dl></div></div><div class="refsect2"><a id="idm139925448247520"></a><h3>[Session Bus Policy]</h3><p> + If the <code class="option">sockets</code> key is not allowing full access + to the D-Bus session bus, then flatpak provides filtered access. + </p><p> + The default policy for the session bus only allows the + application to own its own application ID and + subnames. For instance if the app is called + "org.my.App", it can only own "org.my.App" and + "org.my.App.*". Its also only allowed to talk to the + bus itself (org.freedesktop.DBus) and the portal APIs + APIs (bus names of the form org.freedesktop.portal.*). + </p><p> + Additionally the app is always allowed to reply to + messages sent to it, and emit broadcast signals (but + these will not reach other sandboxed apps unless they + are allowed to talk to your app. + </p><p> + If the [Session Bus Policy] group is present, it provides + policy for session bus access. + </p><p> + Each key in this group has the form of a D-Bus bus name or + prefix thereof, for example <code class="option">org.gnome.SessionManager</code> + or <code class="option">org.freedesktop.portal.*</code> + </p><p> + The possible values for entry are, in increasing order or + access: + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">none</code></span></dt><dd><p> + The bus name or names in question is invisible to the application. + </p></dd><dt><span class="term"><code class="option">see</code></span></dt><dd><p> + The bus name or names can be enumerated by the application. + </p></dd><dt><span class="term"><code class="option">talk</code></span></dt><dd><p> + The application can send messages/ and receive replies and signals from the bus name or names. + </p></dd><dt><span class="term"><code class="option">own</code></span></dt><dd><p> + The application can own the bus name or names (as well as all the above). + </p></dd></dl></div></div><div class="refsect2"><a id="idm139925449579072"></a><h3>[System Bus Policy]</h3><p> + If the <code class="option">sockets</code> key is not allowing full access + to the D-Bus system bus, then flatpak does not make the system + bus available unless the [System Bus Policy] group is present + and provides a policy for filtered access. + </p><p> + Entries in this group have the same form as for the [Session Bus Policy] group. + However, the app has no permissions by default. + </p></div><div class="refsect2"><a id="idm139925453925920"></a><h3>[Environment]</h3><p> + The [Environment] group specifies environment variables to set + when running the application. + </p><p> + Entries in this group have the form <code class="option">VAR=VALUE</code> + where <code class="option">VAR</code> is the name of an environment variable + to set. + </p></div><div class="refsect2"><a id="idm139925453961360"></a><h3>[Extension NAME]</h3><p> + Runtimes and applications can define extensions, which are optional, + additional runtimes to be mounted at a specified location inside + the sandbox when they are present on the system. Typical uses for + extensions include translations for applications, or debuginfo + for sdks. The name of the extension is specified as part of the + group heading. + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">directory</code> (string)</span></dt><dd><p> + The relative path at which the extension will be mounted in + the sandbox. If the extension is for an application, the + path is relative to <code class="filename">/app</code>, otherwise + it is relative to <code class="filename">/usr</code>. This key + is mandatory. + </p></dd><dt><span class="term"><code class="option">version</code> (string)</span></dt><dd><p> + The branch to use when looking for the extension. If this is + not specified, it defaults to the branch of the application or + runtime that the extension is for. + </p></dd><dt><span class="term"><code class="option">subdirectories</code> (boolean)</span></dt><dd><p> + If this key is set to true, then flatpak will look for + extensions whose name is a prefix of the extension name, and + mount them at the corresponding name below the subdirectory. + </p></dd><dt><span class="term"><code class="option">no-autodownload</code> (boolean)</span></dt><dd><p> + Whether to automatically download this extension + when updating or installing a 'related' application + or runtime. + </p></dd><dt><span class="term"><code class="option">autodelete</code> (boolean)</span></dt><dd><p> + Whether to automatically delete this extension + when deleting a 'related' application or runtime. + </p></dd></dl></div></div></div><div class="refsect1"><a id="idm139925450131856"></a><h2>Example</h2><pre class="programlisting"> +[Application] +name=org.gnome.Calculator +runtime=org.gnome.Platform/x86_64/3.20 +sdk=org.gnome.Sdk/x86_64/3.20 +command=gnome-calculator + +[Context] +shared=network;ipc; +sockets=x11;wayland; +filesystems=xdg-run/dconf;~/.config/dconf:ro; + +[Session Bus Policy] +ca.desrt.dconf=talk + +[Environment] +DCONF_USER_CONFIG_DIR=.config/dconf + +[Extension org.gnome.Calculator.Locale] +directory=share/runtime/locale +subdirectories=true + +[Extension org.gnome.Calculator.Debug] +directory=lib/debug +</pre></div><div class="refsect1"><a id="idm139925451953200"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-run</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-override</span>(1)</span> + </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-make-current"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-make-current — Make a specific version of an app current</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak make-current</code> [OPTION...] APP BRANCH </p></div></div><div class="refsect1"><a id="idm139925451552848"></a><h2>Description</h2><p> + Makes a particular branch of an application current. Only the current branch + of an app has its exported files (such as desktop files and icons) made visible + to the host. + </p><p> + When a new branch is installed it will automatically be made current, so this + command is often not needed. + </p><p> + Unless overridden with the --user option, this command creates a + system-wide installation. + </p></div><div class="refsect1"><a id="idm139925451014912"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></dt><dd><p> + Show help options and exit. + </p></dd><dt><span class="term"><code class="option">--user</code></span></dt><dd><p> + Create a per-user installation. + </p></dd><dt><span class="term"><code class="option">--system</code></span></dt><dd><p> + Create a system-wide installation. + </p></dd><dt><span class="term"><code class="option">--arch=ARCH</code></span></dt><dd><p> + The architecture to install for. + </p></dd><dt><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> + Print debug information during command processing. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Print version information and exit. + </p></dd></dl></div></div><div class="refsect1"><a id="idm139925453896384"></a><h2>Examples</h2><p> + <span class="command"><strong>$ flatpak --user make-current org.gnome.GEdit 3.14</strong></span> + </p></div><div class="refsect1"><a id="idm139925453894352"></a><h2>See also</h2><p> + <span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-install-app</span>(1)</span>, + <span class="citerefentry"><span class="refentrytitle">flatpak-list-apps</span>(1)</span> + </p></div></div></div></body></html>
\ No newline at end of file diff --git a/reference/html/FlatpakInstallation.html b/reference/html/FlatpakInstallation.html new file mode 100644 index 00000000..2edd18e4 --- /dev/null +++ b/reference/html/FlatpakInstallation.html @@ -0,0 +1,1849 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>FlatpakInstallation: Flatpak Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Flatpak Library Reference Manual"> +<link rel="up" href="ch01.html" title="Flatpak"> +<link rel="prev" href="ch01.html" title="Flatpak"> +<link rel="next" href="FlatpakRef.html" title="FlatpakRef"> +<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#FlatpakInstallation.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#FlatpakInstallation.object-hierarchy" class="shortcut">Object Hierarchy</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="FlatpakRef.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="FlatpakInstallation"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="FlatpakInstallation.top_of_page"></a>FlatpakInstallation</span></h2> +<p>FlatpakInstallation — Installation information</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="FlatpakInstallation.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="returnvalue">FlatpakInstallation</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-new-system" title="flatpak_installation_new_system ()">flatpak_installation_new_system</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="returnvalue">FlatpakInstallation</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-new-user" title="flatpak_installation_new_user ()">flatpak_installation_new_user</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="returnvalue">FlatpakInstallation</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-new-for-path" title="flatpak_installation_new_for_path ()">flatpak_installation_new_for_path</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-get-is-user" title="flatpak_installation_get_is_user ()">flatpak_installation_get_is_user</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../gio/GFile.html#GFile-struct"><span class="returnvalue">GFile</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-get-path" title="flatpak_installation_get_path ()">flatpak_installation_get_path</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../gio/GFileMonitor.html#GFileMonitor-struct"><span class="returnvalue">GFileMonitor</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-create-monitor" title="flatpak_installation_create_monitor ()">flatpak_installation_create_monitor</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="returnvalue">FlatpakInstalledRef</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-install" title="flatpak_installation_install ()">flatpak_installation_install</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="returnvalue">FlatpakInstalledRef</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-update" title="flatpak_installation_update ()">flatpak_installation_update</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-uninstall" title="flatpak_installation_uninstall ()">flatpak_installation_uninstall</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-launch" title="flatpak_installation_launch ()">flatpak_installation_launch</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="returnvalue">FlatpakInstalledRef</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-get-current-installed-app" title="flatpak_installation_get_current_installed_app ()">flatpak_installation_get_current_installed_app</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="returnvalue">FlatpakInstalledRef</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-get-installed-ref" title="flatpak_installation_get_installed_ref ()">flatpak_installation_get_installed_ref</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-list-installed-refs" title="flatpak_installation_list_installed_refs ()">flatpak_installation_list_installed_refs</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-list-installed-refs-by-kind" title="flatpak_installation_list_installed_refs_by_kind ()">flatpak_installation_list_installed_refs_by_kind</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-list-installed-refs-for-update" title="flatpak_installation_list_installed_refs_for_update ()">flatpak_installation_list_installed_refs_for_update</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-list-remote-refs-sync" title="flatpak_installation_list_remote_refs_sync ()">flatpak_installation_list_remote_refs_sync</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-list-remotes" title="flatpak_installation_list_remotes ()">flatpak_installation_list_remotes</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="returnvalue">FlatpakRemote</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-get-remote-by-name" title="flatpak_installation_get_remote_by_name ()">flatpak_installation_get_remote_by_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Byte-Arrays.html#GBytes"><span class="returnvalue">GBytes</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-fetch-remote-metadata-sync" title="flatpak_installation_fetch_remote_metadata_sync ()">flatpak_installation_fetch_remote_metadata_sync</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="FlatpakRemoteRef.html" title="FlatpakRemoteRef"><span class="returnvalue">FlatpakRemoteRef</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-fetch-remote-ref-sync" title="flatpak_installation_fetch_remote_ref_sync ()">flatpak_installation_fetch_remote_ref_sync</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-fetch-remote-size-sync" title="flatpak_installation_fetch_remote_size_sync ()">flatpak_installation_fetch_remote_size_sync</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-load-app-overrides" title="flatpak_installation_load_app_overrides ()">flatpak_installation_load_app_overrides</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-update-appstream-sync" title="flatpak_installation_update_appstream_sync ()">flatpak_installation_update_appstream_sync</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="returnvalue">FlatpakInstalledRef</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-install-bundle" title="flatpak_installation_install_bundle ()">flatpak_installation_install_bundle</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-drop-caches" title="flatpak_installation_drop_caches ()">flatpak_installation_drop_caches</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-modify-remote" title="flatpak_installation_modify_remote ()">flatpak_installation_modify_remote</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-remove-remote" title="flatpak_installation_remove_remote ()">flatpak_installation_remove_remote</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstallation.html#flatpak-get-default-arch" title="flatpak_get_default_arch ()">flatpak_get_default_arch</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="FlatpakInstallation.html#FlatpakProgressCallback" title="FlatpakProgressCallback ()">*FlatpakProgressCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="FlatpakInstallation.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="FlatpakInstallation.html#FlatpakInstallation-struct" title="struct FlatpakInstallation">FlatpakInstallation</a></td> +</tr> +<tr> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="FlatpakInstallation.html#FlatpakUpdateFlags" title="enum FlatpakUpdateFlags">FlatpakUpdateFlags</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="FlatpakInstallation.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> + <span class="lineart">╰──</span> FlatpakInstallation +</pre> +</div> +<div class="refsect1"> +<a name="FlatpakInstallation.description"></a><h2>Description</h2> +<p>FlatpakInstallation is the toplevel object that software installers +should use to operate on an flatpak applications.</p> +<p>An FlatpakInstallation object provides information about an installation +location for flatpak applications. Typical installation locations are either +system-wide (in /var/lib/flatpak) or per-user (in ~/.local/share/flatpak).</p> +<p>FlatpakInstallation can list configured remotes as well as installed application +and runtime references (in short: refs). It can also run, install, update and +uninstall applications and runtimes.</p> +</div> +<div class="refsect1"> +<a name="FlatpakInstallation.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="flatpak-installation-new-system"></a><h3>flatpak_installation_new_system ()</h3> +<pre class="programlisting"><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="returnvalue">FlatpakInstallation</span></a> * +flatpak_installation_new_system (<em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Creates a new <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> for the system-wide installation.</p> +<div class="refsect3"> +<a name="flatpak-installation-new-system.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-new-system.returns"></a><h4>Returns</h4> +<p> a new <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a>. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-new-user"></a><h3>flatpak_installation_new_user ()</h3> +<pre class="programlisting"><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="returnvalue">FlatpakInstallation</span></a> * +flatpak_installation_new_user (<em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Creates a new <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> for the per-user installation.</p> +<div class="refsect3"> +<a name="flatpak-installation-new-user.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-new-user.returns"></a><h4>Returns</h4> +<p> a new <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a>. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-new-for-path"></a><h3>flatpak_installation_new_for_path ()</h3> +<pre class="programlisting"><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="returnvalue">FlatpakInstallation</span></a> * +flatpak_installation_new_for_path (<em class="parameter"><code><a href="../gio/GFile.html#GFile-struct"><span class="type">GFile</span></a> *path</code></em>, + <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> user</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Creates a new <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> for the installation at the given <em class="parameter"><code>path</code></em> +.</p> +<div class="refsect3"> +<a name="flatpak-installation-new-for-path.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>path</p></td> +<td class="parameter_description"><p>a <a href="../gio/GFile.html#GFile-struct"><span class="type">GFile</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user</p></td> +<td class="parameter_description"><p>whether this is a user-specific location</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-new-for-path.returns"></a><h4>Returns</h4> +<p> a new <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a>. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-get-is-user"></a><h3>flatpak_installation_get_is_user ()</h3> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +flatpak_installation_get_is_user (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>);</pre> +<p>Returns whether the installation is for a user-specific location.</p> +<div class="refsect3"> +<a name="flatpak-installation-get-is-user.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-get-is-user.returns"></a><h4>Returns</h4> +<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>self</code></em> +is a per-user installation</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-get-path"></a><h3>flatpak_installation_get_path ()</h3> +<pre class="programlisting"><a href="../gio/GFile.html#GFile-struct"><span class="returnvalue">GFile</span></a> * +flatpak_installation_get_path (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>);</pre> +<p>Returns the installation location for <em class="parameter"><code>self</code></em> +.</p> +<div class="refsect3"> +<a name="flatpak-installation-get-path.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-get-path.returns"></a><h4>Returns</h4> +<p> an <a href="../gio/GFile.html#GFile-struct"><span class="type">GFile</span></a>. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-create-monitor"></a><h3>flatpak_installation_create_monitor ()</h3> +<pre class="programlisting"><a href="../gio/GFileMonitor.html#GFileMonitor-struct"><span class="returnvalue">GFileMonitor</span></a> * +flatpak_installation_create_monitor (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Gets monitor object for the installation. The returned file monitor will +emit the <a href="../gio/GFileMonitor.html#GFileMonitor-changed"><span class="type">“changed”</span></a> signal whenever an application or runtime +was installed, uninstalled or updated.</p> +<div class="refsect3"> +<a name="flatpak-installation-create-monitor.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-create-monitor.returns"></a><h4>Returns</h4> +<p> a new <a href="../gio/GFileMonitor.html#GFileMonitor-struct"><span class="type">GFileMonitor</span></a> instance, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-install"></a><h3>flatpak_installation_install ()</h3> +<pre class="programlisting"><a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="returnvalue">FlatpakInstalledRef</span></a> * +flatpak_installation_install (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *remote_name</code></em>, + <em class="parameter"><code><a class="link" href="FlatpakRef.html#FlatpakRefKind" title="enum FlatpakRefKind"><span class="type">FlatpakRefKind</span></a> kind</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *arch</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *branch</code></em>, + <em class="parameter"><code><a class="link" href="FlatpakInstallation.html#FlatpakProgressCallback" title="FlatpakProgressCallback ()"><span class="type">FlatpakProgressCallback</span></a> progress</code></em>, + <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> progress_data</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Install a new application or runtime.</p> +<div class="refsect3"> +<a name="flatpak-installation-install.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>remote_name</p></td> +<td class="parameter_description"><p>name of the remote to use</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>kind</p></td> +<td class="parameter_description"><p>what this ref contains (an <a class="link" href="FlatpakRef.html#FlatpakRefKind" title="enum FlatpakRefKind"><span class="type">FlatpakRefKind</span></a>)</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>name of the app/runtime to fetch</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>arch</p></td> +<td class="parameter_description"><p> which architecture to fetch (default: current architecture). </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>branch</p></td> +<td class="parameter_description"><p> which branch to fetch (default: 'master'). </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>progress</p></td> +<td class="parameter_description"><p> progress callback. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>progress_data</p></td> +<td class="parameter_description"><p>user data passed to <em class="parameter"><code>progress</code></em> +</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-install.returns"></a><h4>Returns</h4> +<p> The ref for the newly installed app or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-update"></a><h3>flatpak_installation_update ()</h3> +<pre class="programlisting"><a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="returnvalue">FlatpakInstalledRef</span></a> * +flatpak_installation_update (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code><a class="link" href="FlatpakInstallation.html#FlatpakUpdateFlags" title="enum FlatpakUpdateFlags"><span class="type">FlatpakUpdateFlags</span></a> flags</code></em>, + <em class="parameter"><code><a class="link" href="FlatpakRef.html#FlatpakRefKind" title="enum FlatpakRefKind"><span class="type">FlatpakRefKind</span></a> kind</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *arch</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *branch</code></em>, + <em class="parameter"><code><a class="link" href="FlatpakInstallation.html#FlatpakProgressCallback" title="FlatpakProgressCallback ()"><span class="type">FlatpakProgressCallback</span></a> progress</code></em>, + <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> progress_data</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Update an application or runtime.</p> +<div class="refsect3"> +<a name="flatpak-installation-update.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>flags</p></td> +<td class="parameter_description"><p>set of <a class="link" href="FlatpakInstallation.html#FlatpakUpdateFlags" title="enum FlatpakUpdateFlags"><span class="type">FlatpakUpdateFlags</span></a> flag</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>kind</p></td> +<td class="parameter_description"><p>whether this is an app or runtime</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>name of the app or runtime to update</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>arch</p></td> +<td class="parameter_description"><p> architecture of the app or runtime to update (default: current architecture). </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>branch</p></td> +<td class="parameter_description"><p> name of the branch of the app or runtime to update (default: master). </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>progress</p></td> +<td class="parameter_description"><p> the callback. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>progress_data</p></td> +<td class="parameter_description"><p>user data passed to <em class="parameter"><code>progress</code></em> +</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-update.returns"></a><h4>Returns</h4> +<p> The ref for the newly updated app (or the same if no update) or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-uninstall"></a><h3>flatpak_installation_uninstall ()</h3> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +flatpak_installation_uninstall (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code><a class="link" href="FlatpakRef.html#FlatpakRefKind" title="enum FlatpakRefKind"><span class="type">FlatpakRefKind</span></a> kind</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *arch</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *branch</code></em>, + <em class="parameter"><code><a class="link" href="FlatpakInstallation.html#FlatpakProgressCallback" title="FlatpakProgressCallback ()"><span class="type">FlatpakProgressCallback</span></a> progress</code></em>, + <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> progress_data</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Uninstall an application or runtime.</p> +<div class="refsect3"> +<a name="flatpak-installation-uninstall.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>kind</p></td> +<td class="parameter_description"><p>what this ref contains (an <a class="link" href="FlatpakRef.html#FlatpakRefKind" title="enum FlatpakRefKind"><span class="type">FlatpakRefKind</span></a>)</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>name of the app or runtime to uninstall</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>arch</p></td> +<td class="parameter_description"><p>architecture of the app or runtime to uninstall</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>branch</p></td> +<td class="parameter_description"><p>name of the branch of the app or runtime to uninstall</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>progress</p></td> +<td class="parameter_description"><p> the callback. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>progress_data</p></td> +<td class="parameter_description"><p>user data passed to <em class="parameter"><code>progress</code></em> +</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-uninstall.returns"></a><h4>Returns</h4> +<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-launch"></a><h3>flatpak_installation_launch ()</h3> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +flatpak_installation_launch (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *arch</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *branch</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *commit</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Launch an installed application.</p> +<p>You can use <a class="link" href="FlatpakInstallation.html#flatpak-installation-get-installed-ref" title="flatpak_installation_get_installed_ref ()"><code class="function">flatpak_installation_get_installed_ref()</code></a> or +<a class="link" href="FlatpakInstallation.html#flatpak-installation-get-current-installed-app" title="flatpak_installation_get_current_installed_app ()"><code class="function">flatpak_installation_get_current_installed_app()</code></a> to find out what builds +are available, in order to get a value for <em class="parameter"><code>commit</code></em> +.</p> +<div class="refsect3"> +<a name="flatpak-installation-launch.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>name of the app to launch</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>arch</p></td> +<td class="parameter_description"><p> which architecture to launch (default: current architecture). </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>branch</p></td> +<td class="parameter_description"><p> which branch of the application (default: "master"). </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>commit</p></td> +<td class="parameter_description"><p> the commit of <em class="parameter"><code>branch</code></em> +to launch. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-launch.returns"></a><h4>Returns</h4> +<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, unless an error occurred</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-get-current-installed-app"></a><h3>flatpak_installation_get_current_installed_app ()</h3> +<pre class="programlisting"><a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="returnvalue">FlatpakInstalledRef</span></a> * +flatpak_installation_get_current_installed_app + (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Get the last build of reference <em class="parameter"><code>name</code></em> + that was installed with +<a class="link" href="FlatpakInstallation.html#flatpak-installation-install" title="flatpak_installation_install ()"><code class="function">flatpak_installation_install()</code></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the reference has +never been installed locally.</p> +<div class="refsect3"> +<a name="flatpak-installation-get-current-installed-app.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>the name of the app</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-get-current-installed-app.returns"></a><h4>Returns</h4> +<p> an <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="type">FlatpakInstalledRef</span></a>. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-get-installed-ref"></a><h3>flatpak_installation_get_installed_ref ()</h3> +<pre class="programlisting"><a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="returnvalue">FlatpakInstalledRef</span></a> * +flatpak_installation_get_installed_ref + (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code><a class="link" href="FlatpakRef.html#FlatpakRefKind" title="enum FlatpakRefKind"><span class="type">FlatpakRefKind</span></a> kind</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *arch</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *branch</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Returns information about an installed ref, such as the available builds, +its size, location, etc.</p> +<div class="refsect3"> +<a name="flatpak-installation-get-installed-ref.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>kind</p></td> +<td class="parameter_description"><p>whether this is an app or runtime</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>name of the app/runtime to fetch</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>arch</p></td> +<td class="parameter_description"><p> which architecture to fetch (default: current architecture). </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>branch</p></td> +<td class="parameter_description"><p> which branch to fetch (default: "master"). </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-get-installed-ref.returns"></a><h4>Returns</h4> +<p> an <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="type">FlatpakInstalledRef</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an error occurred. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-list-installed-refs"></a><h3>flatpak_installation_list_installed_refs ()</h3> +<pre class="programlisting"><a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * +flatpak_installation_list_installed_refs + (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Lists the installed references.</p> +<div class="refsect3"> +<a name="flatpak-installation-list-installed-refs.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-list-installed-refs.returns"></a><h4>Returns</h4> +<p> an GPtrArray of +<a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="type">FlatpakInstalledRef</span></a> instances. </p> +<p><span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> FlatpakInstalledRef]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-list-installed-refs-by-kind"></a><h3>flatpak_installation_list_installed_refs_by_kind ()</h3> +<pre class="programlisting"><a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * +flatpak_installation_list_installed_refs_by_kind + (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code><a class="link" href="FlatpakRef.html#FlatpakRefKind" title="enum FlatpakRefKind"><span class="type">FlatpakRefKind</span></a> kind</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Lists the installed references of a specific kind.</p> +<div class="refsect3"> +<a name="flatpak-installation-list-installed-refs-by-kind.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>kind</p></td> +<td class="parameter_description"><p>the kind of installation</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-list-installed-refs-by-kind.returns"></a><h4>Returns</h4> +<p> an GPtrArray of +<a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="type">FlatpakInstalledRef</span></a> instances. </p> +<p><span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> FlatpakInstalledRef]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-list-installed-refs-for-update"></a><h3>flatpak_installation_list_installed_refs_for_update ()</h3> +<pre class="programlisting"><a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * +flatpak_installation_list_installed_refs_for_update + (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Lists the installed references that has a remote update that is not +locally available. However, even though an app is not returned by this +it can have local updates available that has not been deployed. Look +at commit vs latest_commit on installed apps for this.</p> +<div class="refsect3"> +<a name="flatpak-installation-list-installed-refs-for-update.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-list-installed-refs-for-update.returns"></a><h4>Returns</h4> +<p> an GPtrArray of +<a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="type">FlatpakInstalledRef</span></a> instances. </p> +<p><span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> FlatpakInstalledRef]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-list-remote-refs-sync"></a><h3>flatpak_installation_list_remote_refs_sync ()</h3> +<pre class="programlisting"><a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * +flatpak_installation_list_remote_refs_sync + (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *remote_name</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Lists all the applications and runtimes in a remote.</p> +<div class="refsect3"> +<a name="flatpak-installation-list-remote-refs-sync.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>remote_name</p></td> +<td class="parameter_description"><p>the name of the remote</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-list-remote-refs-sync.returns"></a><h4>Returns</h4> +<p> an GPtrArray of +<a class="link" href="FlatpakRemoteRef.html" title="FlatpakRemoteRef"><span class="type">FlatpakRemoteRef</span></a> instances. </p> +<p><span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> FlatpakRemoteRef]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-list-remotes"></a><h3>flatpak_installation_list_remotes ()</h3> +<pre class="programlisting"><a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * +flatpak_installation_list_remotes (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Lists the remotes, in priority (highest first) order. For same priority, +an earlier added remote comes before a later added one.</p> +<div class="refsect3"> +<a name="flatpak-installation-list-remotes.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-list-remotes.returns"></a><h4>Returns</h4> +<p> an GPtrArray of +<a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> instances. </p> +<p><span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> FlatpakRemote]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-get-remote-by-name"></a><h3>flatpak_installation_get_remote_by_name ()</h3> +<pre class="programlisting"><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="returnvalue">FlatpakRemote</span></a> * +flatpak_installation_get_remote_by_name + (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Looks up a remote by name.</p> +<div class="refsect3"> +<a name="flatpak-installation-get-remote-by-name.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>a remote name</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-get-remote-by-name.returns"></a><h4>Returns</h4> +<p> a <a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> instances, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> error. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-fetch-remote-metadata-sync"></a><h3>flatpak_installation_fetch_remote_metadata_sync ()</h3> +<pre class="programlisting"><a href="../glib/glib-Byte-Arrays.html#GBytes"><span class="returnvalue">GBytes</span></a> * +flatpak_installation_fetch_remote_metadata_sync + (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *remote_name</code></em>, + <em class="parameter"><code><a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a> *ref</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Obtains the metadata file from a commit.</p> +<div class="refsect3"> +<a name="flatpak-installation-fetch-remote-metadata-sync.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>remote_name</p></td> +<td class="parameter_description"><p>the name of the remote</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>ref</p></td> +<td class="parameter_description"><p>the ref</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-fetch-remote-metadata-sync.returns"></a><h4>Returns</h4> +<p> a <a href="../glib/glib-Byte-Arrays.html#GBytes"><span class="type">GBytes</span></a> containing the flatpak metadata file, +or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an error occurred. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-fetch-remote-ref-sync"></a><h3>flatpak_installation_fetch_remote_ref_sync ()</h3> +<pre class="programlisting"><a class="link" href="FlatpakRemoteRef.html" title="FlatpakRemoteRef"><span class="returnvalue">FlatpakRemoteRef</span></a> * +flatpak_installation_fetch_remote_ref_sync + (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *remote_name</code></em>, + <em class="parameter"><code><a class="link" href="FlatpakRef.html#FlatpakRefKind" title="enum FlatpakRefKind"><span class="type">FlatpakRefKind</span></a> kind</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *arch</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *branch</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Gets the current remote branch of a ref in the remote.</p> +<div class="refsect3"> +<a name="flatpak-installation-fetch-remote-ref-sync.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>remote_name</p></td> +<td class="parameter_description"><p>the name of the remote</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>kind</p></td> +<td class="parameter_description"><p>what this ref contains (an <a class="link" href="FlatpakRef.html#FlatpakRefKind" title="enum FlatpakRefKind"><span class="type">FlatpakRefKind</span></a>)</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>name of the app/runtime to fetch</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>arch</p></td> +<td class="parameter_description"><p> which architecture to fetch (default: current architecture). </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>branch</p></td> +<td class="parameter_description"><p> which branch to fetch (default: 'master'). </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-fetch-remote-ref-sync.returns"></a><h4>Returns</h4> +<p> a <a class="link" href="FlatpakRemoteRef.html" title="FlatpakRemoteRef"><span class="type">FlatpakRemoteRef</span></a> instance, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-fetch-remote-size-sync"></a><h3>flatpak_installation_fetch_remote_size_sync ()</h3> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +flatpak_installation_fetch_remote_size_sync + (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *remote_name</code></em>, + <em class="parameter"><code><a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a> *ref</code></em>, + <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> *download_size</code></em>, + <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> *installed_size</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Gets information about the maximum amount of data that needs to be transferred +to pull the ref from a remote repository, and about the amount of +local disk space that is required to check out this commit.</p> +<p>Note that if there are locally available data that are in the ref, which is common +for instance if you're doing an update then the real download size may be smaller +than what is returned here.</p> +<div class="refsect3"> +<a name="flatpak-installation-fetch-remote-size-sync.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>remote_name</p></td> +<td class="parameter_description"><p>the name of the remote</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>ref</p></td> +<td class="parameter_description"><p>the ref</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>download_size</p></td> +<td class="parameter_description"><p> return location for the (maximum) download size. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>installed_size</p></td> +<td class="parameter_description"><p> return location for the installed size. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-fetch-remote-size-sync.returns"></a><h4>Returns</h4> +<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, unless an error occurred</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-load-app-overrides"></a><h3>flatpak_installation_load_app_overrides ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * +flatpak_installation_load_app_overrides + (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *app_id</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Loads the metadata overrides file for an application.</p> +<div class="refsect3"> +<a name="flatpak-installation-load-app-overrides.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>app_id</p></td> +<td class="parameter_description"><p>an application id</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-load-app-overrides.returns"></a><h4>Returns</h4> +<p> the contents of the overrides files, +or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an error occurred. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-update-appstream-sync"></a><h3>flatpak_installation_update_appstream_sync ()</h3> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +flatpak_installation_update_appstream_sync + (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *remote_name</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *arch</code></em>, + <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *out_changed</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Updates the local copy of appstream for <em class="parameter"><code>remote_name</code></em> + for the specified <em class="parameter"><code>arch</code></em> +.</p> +<div class="refsect3"> +<a name="flatpak-installation-update-appstream-sync.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>remote_name</p></td> +<td class="parameter_description"><p>the name of the remote</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>arch</p></td> +<td class="parameter_description"><p>Architecture to update, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the local machine arch</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>out_changed</p></td> +<td class="parameter_description"><p> Set to <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the contents of the appstream changed, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if nothing changed. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-update-appstream-sync.returns"></a><h4>Returns</h4> +<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, or <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-install-bundle"></a><h3>flatpak_installation_install_bundle ()</h3> +<pre class="programlisting"><a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="returnvalue">FlatpakInstalledRef</span></a> * +flatpak_installation_install_bundle (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code><a href="../gio/GFile.html#GFile-struct"><span class="type">GFile</span></a> *file</code></em>, + <em class="parameter"><code><a class="link" href="FlatpakInstallation.html#FlatpakProgressCallback" title="FlatpakProgressCallback ()"><span class="type">FlatpakProgressCallback</span></a> progress</code></em>, + <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> progress_data</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Install an application or runtime from an flatpak bundle file. +See flatpak-build-bundle(1) for how to create brundles.</p> +<div class="refsect3"> +<a name="flatpak-installation-install-bundle.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>file</p></td> +<td class="parameter_description"><p>a <a href="../gio/GFile.html#GFile-struct"><span class="type">GFile</span></a> that is an flatpak bundle</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>progress</p></td> +<td class="parameter_description"><p> progress callback. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>progress_data</p></td> +<td class="parameter_description"><p>user data passed to <em class="parameter"><code>progress</code></em> +</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-install-bundle.returns"></a><h4>Returns</h4> +<p> The ref for the newly installed app or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-drop-caches"></a><h3>flatpak_installation_drop_caches ()</h3> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +flatpak_installation_drop_caches (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Drops all internal (in-memory) caches. For instance, this may be needed to pick up new or changed +remotes configured outside this installation instance.</p> +<div class="refsect3"> +<a name="flatpak-installation-drop-caches.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-drop-caches.returns"></a><h4>Returns</h4> +<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-modify-remote"></a><h3>flatpak_installation_modify_remote ()</h3> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +flatpak_installation_modify_remote (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *remote</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Saves changes in the <em class="parameter"><code>remote</code></em> + object.</p> +<div class="refsect3"> +<a name="flatpak-installation-modify-remote.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>remote</p></td> +<td class="parameter_description"><p>the modified <a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-modify-remote.returns"></a><h4>Returns</h4> +<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the modifications have been committed successfully</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installation-remove-remote"></a><h3>flatpak_installation_remove_remote ()</h3> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +flatpak_installation_remove_remote (<em class="parameter"><code><a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Removes the remote with the given name from the installation.</p> +<div class="refsect3"> +<a name="flatpak-installation-remove-remote.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation"><span class="type">FlatpakInstallation</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>the name of the remote to remove</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installation-remove-remote.returns"></a><h4>Returns</h4> +<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the remote has been removed successfully</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-get-default-arch"></a><h3>flatpak_get_default_arch ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +flatpak_get_default_arch (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p>Returns the canonical name for the arch of the current machine.</p> +<div class="refsect3"> +<a name="flatpak-get-default-arch.returns"></a><h4>Returns</h4> +<p> an arch string</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="FlatpakProgressCallback"></a><h3>FlatpakProgressCallback ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*FlatpakProgressCallback<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">char</span> *status</code></em>, + <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> progress</code></em>, + <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> estimating</code></em>, + <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> +<p>The progress callback is called repeatedly during long-running operations +such as installations or updates, and can be used to update progress information +in a user interface.</p> +<p>The callback occurs in the thread-default context of the caller.</p> +<div class="refsect3"> +<a name="FlatpakProgressCallback.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>status</p></td> +<td class="parameter_description"><p>A status string, suitable for display</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>progress</p></td> +<td class="parameter_description"><p>percentage of completion</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>estimating</p></td> +<td class="parameter_description"><p>whether <em class="parameter"><code>progress</code></em> +is just an estimate</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>User data passed to the caller</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="FlatpakInstallation.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="FlatpakInstallation-struct"></a><h3>struct FlatpakInstallation</h3> +<pre class="programlisting">struct FlatpakInstallation;</pre> +</div> +<hr> +<div class="refsect2"> +<a name="FlatpakUpdateFlags"></a><h3>enum FlatpakUpdateFlags</h3> +<p>Flags to alter the behavior of <a class="link" href="FlatpakInstallation.html#flatpak-installation-update" title="flatpak_installation_update ()"><code class="function">flatpak_installation_update()</code></a>.</p> +<div class="refsect3"> +<a name="FlatpakUpdateFlags.members"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="enum_members_name"> +<col class="enum_members_description"> +<col width="200px" class="enum_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="enum_member_name"><p><a name="FLATPAK-UPDATE-FLAGS-NONE:CAPS"></a>FLATPAK_UPDATE_FLAGS_NONE</p></td> +<td class="enum_member_description"> +<p>Fetch remote builds and install the latest one (default)</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="FLATPAK-UPDATE-FLAGS-NO-DEPLOY:CAPS"></a>FLATPAK_UPDATE_FLAGS_NO_DEPLOY</p></td> +<td class="enum_member_description"> +<p>Don't install any new builds that might be fetched</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="FLATPAK-UPDATE-FLAGS-NO-PULL:CAPS"></a>FLATPAK_UPDATE_FLAGS_NO_PULL</p></td> +<td class="enum_member_description"> +<p>Don't try to fetch new builds from the remote repo</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25.1</div> +</body> +</html>
\ No newline at end of file diff --git a/reference/html/FlatpakInstalledRef.html b/reference/html/FlatpakInstalledRef.html new file mode 100644 index 00000000..093f76c2 --- /dev/null +++ b/reference/html/FlatpakInstalledRef.html @@ -0,0 +1,435 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>FlatpakInstalledRef: Flatpak Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Flatpak Library Reference Manual"> +<link rel="up" href="ch01.html" title="Flatpak"> +<link rel="prev" href="FlatpakRef.html" title="FlatpakRef"> +<link rel="next" href="FlatpakRemoteRef.html" title="FlatpakRemoteRef"> +<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#FlatpakInstalledRef.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#FlatpakInstalledRef.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#FlatpakInstalledRef.properties" class="shortcut">Properties</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="FlatpakRef.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="FlatpakRemoteRef.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="FlatpakInstalledRef"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="FlatpakInstalledRef.top_of_page"></a>FlatpakInstalledRef</span></h2> +<p>FlatpakInstalledRef — Installed application reference</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="FlatpakInstalledRef.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type">const <span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstalledRef.html#flatpak-installed-ref-get-deploy-dir" title="flatpak_installed_ref_get_deploy_dir ()">flatpak_installed_ref_get_deploy_dir</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstalledRef.html#flatpak-installed-ref-get-installed-size" title="flatpak_installed_ref_get_installed_size ()">flatpak_installed_ref_get_installed_size</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstalledRef.html#flatpak-installed-ref-get-is-current" title="flatpak_installed_ref_get_is_current ()">flatpak_installed_ref_get_is_current</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstalledRef.html#flatpak-installed-ref-get-latest-commit" title="flatpak_installed_ref_get_latest_commit ()">flatpak_installed_ref_get_latest_commit</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstalledRef.html#flatpak-installed-ref-get-origin" title="flatpak_installed_ref_get_origin ()">flatpak_installed_ref_get_origin</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Byte-Arrays.html#GBytes"><span class="returnvalue">GBytes</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstalledRef.html#flatpak-installed-ref-load-metadata" title="flatpak_installed_ref_load_metadata ()">flatpak_installed_ref_load_metadata</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">char</span> * const * +</td> +<td class="function_name"> +<a class="link" href="FlatpakInstalledRef.html#flatpak-installed-ref-get-subpaths" title="flatpak_installed_ref_get_subpaths ()">flatpak_installed_ref_get_subpaths</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="FlatpakInstalledRef.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"> +<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="FlatpakInstalledRef.html#FlatpakInstalledRef--deploy-dir" title="The “deploy-dir” property">deploy-dir</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="../glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td> +<td class="property_name"><a class="link" href="FlatpakInstalledRef.html#FlatpakInstalledRef--installed-size" title="The “installed-size” property">installed-size</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="FlatpakInstalledRef.html#FlatpakInstalledRef--is-current" title="The “is-current” property">is-current</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"> +<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="FlatpakInstalledRef.html#FlatpakInstalledRef--latest-commit" title="The “latest-commit” property">latest-commit</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"> +<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="FlatpakInstalledRef.html#FlatpakInstalledRef--origin" title="The “origin” property">origin</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="../glib/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></td> +<td class="property_name"><a class="link" href="FlatpakInstalledRef.html#FlatpakInstalledRef--subpaths" title="The “subpaths” property">subpaths</a></td> +<td class="property_flags">Read / Write</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="FlatpakInstalledRef.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody><tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="FlatpakInstalledRef.html#FlatpakInstalledRef-struct" title="struct FlatpakInstalledRef">FlatpakInstalledRef</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="FlatpakInstalledRef.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> + <span class="lineart">╰──</span> <a class="link" href="FlatpakRef.html" title="FlatpakRef">FlatpakRef</a> + <span class="lineart">╰──</span> FlatpakInstalledRef +</pre> +</div> +<div class="refsect1"> +<a name="FlatpakInstalledRef.description"></a><h2>Description</h2> +<p>A FlatpakInstalledRef provides information about an installed +application or runtime (in short: ref), such as the available +builds, its size, location, etc.</p> +</div> +<div class="refsect1"> +<a name="FlatpakInstalledRef.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="flatpak-installed-ref-get-deploy-dir"></a><h3>flatpak_installed_ref_get_deploy_dir ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +flatpak_installed_ref_get_deploy_dir (<em class="parameter"><code><a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="type">FlatpakInstalledRef</span></a> *self</code></em>);</pre> +<p>Gets the deploy dir of the ref.</p> +<div class="refsect3"> +<a name="flatpak-installed-ref-get-deploy-dir.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="type">FlatpakInstalledRef</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installed-ref-get-deploy-dir.returns"></a><h4>Returns</h4> +<p> the deploy dir. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installed-ref-get-installed-size"></a><h3>flatpak_installed_ref_get_installed_size ()</h3> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> +flatpak_installed_ref_get_installed_size + (<em class="parameter"><code><a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="type">FlatpakInstalledRef</span></a> *self</code></em>);</pre> +<p>Returns the installed size of the ref.</p> +<div class="refsect3"> +<a name="flatpak-installed-ref-get-installed-size.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="type">FlatpakInstalledRef</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installed-ref-get-installed-size.returns"></a><h4>Returns</h4> +<p> the installed size</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installed-ref-get-is-current"></a><h3>flatpak_installed_ref_get_is_current ()</h3> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +flatpak_installed_ref_get_is_current (<em class="parameter"><code><a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="type">FlatpakInstalledRef</span></a> *self</code></em>);</pre> +<p>Returns whether the ref is current.</p> +<div class="refsect3"> +<a name="flatpak-installed-ref-get-is-current.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="type">FlatpakInstalledRef</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installed-ref-get-is-current.returns"></a><h4>Returns</h4> +<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the ref is current</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installed-ref-get-latest-commit"></a><h3>flatpak_installed_ref_get_latest_commit ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +flatpak_installed_ref_get_latest_commit + (<em class="parameter"><code><a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="type">FlatpakInstalledRef</span></a> *self</code></em>);</pre> +<p>Gets the latest commit of the ref.</p> +<div class="refsect3"> +<a name="flatpak-installed-ref-get-latest-commit.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="type">FlatpakInstalledRef</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installed-ref-get-latest-commit.returns"></a><h4>Returns</h4> +<p> the latest commit. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installed-ref-get-origin"></a><h3>flatpak_installed_ref_get_origin ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +flatpak_installed_ref_get_origin (<em class="parameter"><code><a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="type">FlatpakInstalledRef</span></a> *self</code></em>);</pre> +<p>Gets the origin of the ref.</p> +<div class="refsect3"> +<a name="flatpak-installed-ref-get-origin.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="type">FlatpakInstalledRef</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installed-ref-get-origin.returns"></a><h4>Returns</h4> +<p> the origin. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installed-ref-load-metadata"></a><h3>flatpak_installed_ref_load_metadata ()</h3> +<pre class="programlisting"><a href="../glib/glib-Byte-Arrays.html#GBytes"><span class="returnvalue">GBytes</span></a> * +flatpak_installed_ref_load_metadata (<em class="parameter"><code><a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="type">FlatpakInstalledRef</span></a> *self</code></em>, + <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Loads the metadata file for this ref.</p> +<div class="refsect3"> +<a name="flatpak-installed-ref-load-metadata.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="type">FlatpakInstalledRef</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p> a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>a return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installed-ref-load-metadata.returns"></a><h4>Returns</h4> +<p> a <a href="../glib/glib-Byte-Arrays.html#GBytes"><span class="type">GBytes</span></a> containing the metadata file, +or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an error occurred. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-installed-ref-get-subpaths"></a><h3>flatpak_installed_ref_get_subpaths ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * const * +flatpak_installed_ref_get_subpaths (<em class="parameter"><code><a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="type">FlatpakInstalledRef</span></a> *self</code></em>);</pre> +<p>Returns the subpaths that are installed, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if all files installed.</p> +<div class="refsect3"> +<a name="flatpak-installed-ref-get-subpaths.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="type">FlatpakInstalledRef</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-installed-ref-get-subpaths.returns"></a><h4>Returns</h4> +<p> A strv, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="FlatpakInstalledRef.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="FlatpakInstalledRef-struct"></a><h3>struct FlatpakInstalledRef</h3> +<pre class="programlisting">struct FlatpakInstalledRef;</pre> +</div> +</div> +<div class="refsect1"> +<a name="FlatpakInstalledRef.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="FlatpakInstalledRef--deploy-dir"></a><h3>The <code class="literal">“deploy-dir”</code> property</h3> +<pre class="programlisting"> “deploy-dir” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>Where the application is installed.</p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="FlatpakInstalledRef--installed-size"></a><h3>The <code class="literal">“installed-size”</code> property</h3> +<pre class="programlisting"> “installed-size” <a href="../glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre> +<p>The installed size of the application.</p> +<p>Flags: Read / Write</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2"> +<a name="FlatpakInstalledRef--is-current"></a><h3>The <code class="literal">“is-current”</code> property</h3> +<pre class="programlisting"> “is-current” <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Whether the application is current.</p> +<p>Flags: Read / Write</p> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2"> +<a name="FlatpakInstalledRef--latest-commit"></a><h3>The <code class="literal">“latest-commit”</code> property</h3> +<pre class="programlisting"> “latest-commit” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>The latest commit.</p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="FlatpakInstalledRef--origin"></a><h3>The <code class="literal">“origin”</code> property</h3> +<pre class="programlisting"> “origin” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>The origin.</p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="FlatpakInstalledRef--subpaths"></a><h3>The <code class="literal">“subpaths”</code> property</h3> +<pre class="programlisting"> “subpaths” <a href="../glib/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></pre> +<p>Flags: Read / Write</p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25.1</div> +</body> +</html>
\ No newline at end of file diff --git a/reference/html/FlatpakRef.html b/reference/html/FlatpakRef.html new file mode 100644 index 00000000..2a0b4fed --- /dev/null +++ b/reference/html/FlatpakRef.html @@ -0,0 +1,467 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>FlatpakRef: Flatpak Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Flatpak Library Reference Manual"> +<link rel="up" href="ch01.html" title="Flatpak"> +<link rel="prev" href="FlatpakInstallation.html" title="FlatpakInstallation"> +<link rel="next" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"> +<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#FlatpakRef.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#FlatpakRef.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#FlatpakRef.properties" class="shortcut">Properties</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="FlatpakInstallation.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="FlatpakInstalledRef.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="FlatpakRef"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="FlatpakRef.top_of_page"></a>FlatpakRef</span></h2> +<p>FlatpakRef — Application reference</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="FlatpakRef.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakRef.html#flatpak-ref-format-ref" title="flatpak_ref_format_ref ()">flatpak_ref_format_ref</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakRef.html#flatpak-ref-get-arch" title="flatpak_ref_get_arch ()">flatpak_ref_get_arch</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakRef.html#flatpak-ref-get-branch" title="flatpak_ref_get_branch ()">flatpak_ref_get_branch</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakRef.html#flatpak-ref-get-commit" title="flatpak_ref_get_commit ()">flatpak_ref_get_commit</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="FlatpakRef.html#FlatpakRefKind" title="enum FlatpakRefKind"><span class="returnvalue">FlatpakRefKind</span></a> +</td> +<td class="function_name"> +<a class="link" href="FlatpakRef.html#flatpak-ref-get-kind" title="flatpak_ref_get_kind ()">flatpak_ref_get_kind</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakRef.html#flatpak-ref-get-name" title="flatpak_ref_get_name ()">flatpak_ref_get_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="returnvalue">FlatpakRef</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakRef.html#flatpak-ref-parse" title="flatpak_ref_parse ()">flatpak_ref_parse</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="FlatpakRef.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"> +<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="FlatpakRef.html#FlatpakRef--arch" title="The “arch” property">arch</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"> +<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="FlatpakRef.html#FlatpakRef--branch" title="The “branch” property">branch</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"> +<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="FlatpakRef.html#FlatpakRef--commit" title="The “commit” property">commit</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a class="link" href="FlatpakRef.html#FlatpakRefKind" title="enum FlatpakRefKind"><span class="type">FlatpakRefKind</span></a></td> +<td class="property_name"><a class="link" href="FlatpakRef.html#FlatpakRef--kind" title="The “kind” property">kind</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"> +<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="FlatpakRef.html#FlatpakRef--name" title="The “name” property">name</a></td> +<td class="property_flags">Read / Write</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="FlatpakRef.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="FlatpakRef.html#FlatpakRef-struct" title="struct FlatpakRef">FlatpakRef</a></td> +</tr> +<tr> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="FlatpakRef.html#FlatpakRefKind" title="enum FlatpakRefKind">FlatpakRefKind</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="FlatpakRef.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> + <span class="lineart">╰──</span> FlatpakRef + <span class="lineart">├──</span> <a class="link" href="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef">FlatpakBundleRef</a> + <span class="lineart">├──</span> <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef">FlatpakInstalledRef</a> + <span class="lineart">╰──</span> <a class="link" href="FlatpakRemoteRef.html" title="FlatpakRemoteRef">FlatpakRemoteRef</a> +</pre> +</div> +<div class="refsect1"> +<a name="FlatpakRef.description"></a><h2>Description</h2> +<p>Currently flatpak manages two types of binary artifacts: applications, and +runtimes. Applications contain a program that desktop users can run, while +runtimes contain only libraries and data. An FlatpakRef object (or short: ref) +can refer to either of these.</p> +<p>Both applications and runtimes are identified by a 4-tuple of strings: kind, +name, arch and branch, e.g. app/org.gnome.evince/x86_64/master. The functions +<a class="link" href="FlatpakRef.html#flatpak-ref-parse" title="flatpak_ref_parse ()"><code class="function">flatpak_ref_parse()</code></a> and <a class="link" href="FlatpakRef.html#flatpak-ref-format-ref" title="flatpak_ref_format_ref ()"><code class="function">flatpak_ref_format_ref()</code></a> can be used to convert +FlatpakRef objects into this string representation and back.</p> +<p>To uniquely identify a particular version of an application or runtime, you +need a commit.</p> +<p>The subclasses <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"><span class="type">FlatpakInstalledRef</span></a> and <a class="link" href="FlatpakRemoteRef.html" title="FlatpakRemoteRef"><span class="type">FlatpakRemoteRef</span></a> provide more information +for artifacts that are locally installed or available from a remote repository.</p> +</div> +<div class="refsect1"> +<a name="FlatpakRef.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="flatpak-ref-format-ref"></a><h3>flatpak_ref_format_ref ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * +flatpak_ref_format_ref (<em class="parameter"><code><a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a> *self</code></em>);</pre> +<p>Convert an FlatpakRef object into a string representation that +can be parsed by <a class="link" href="FlatpakRef.html#flatpak-ref-parse" title="flatpak_ref_parse ()"><code class="function">flatpak_ref_parse()</code></a>.</p> +<div class="refsect3"> +<a name="flatpak-ref-format-ref.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-ref-format-ref.returns"></a><h4>Returns</h4> +<p> string representation. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-ref-get-arch"></a><h3>flatpak_ref_get_arch ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +flatpak_ref_get_arch (<em class="parameter"><code><a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a> *self</code></em>);</pre> +<p>Gets the arch or the ref.</p> +<div class="refsect3"> +<a name="flatpak-ref-get-arch.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-ref-get-arch.returns"></a><h4>Returns</h4> +<p> the arch. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-ref-get-branch"></a><h3>flatpak_ref_get_branch ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +flatpak_ref_get_branch (<em class="parameter"><code><a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a> *self</code></em>);</pre> +<p>Gets the branch of the ref.</p> +<div class="refsect3"> +<a name="flatpak-ref-get-branch.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-ref-get-branch.returns"></a><h4>Returns</h4> +<p> the branch. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-ref-get-commit"></a><h3>flatpak_ref_get_commit ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +flatpak_ref_get_commit (<em class="parameter"><code><a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a> *self</code></em>);</pre> +<p>Gets the commit of the ref.</p> +<div class="refsect3"> +<a name="flatpak-ref-get-commit.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-ref-get-commit.returns"></a><h4>Returns</h4> +<p> the commit. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-ref-get-kind"></a><h3>flatpak_ref_get_kind ()</h3> +<pre class="programlisting"><a class="link" href="FlatpakRef.html#FlatpakRefKind" title="enum FlatpakRefKind"><span class="returnvalue">FlatpakRefKind</span></a> +flatpak_ref_get_kind (<em class="parameter"><code><a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a> *self</code></em>);</pre> +<p>Gets the kind of artifact that this ref refers to.</p> +<div class="refsect3"> +<a name="flatpak-ref-get-kind.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-ref-get-kind.returns"></a><h4>Returns</h4> +<p> the kind of artifact</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-ref-get-name"></a><h3>flatpak_ref_get_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +flatpak_ref_get_name (<em class="parameter"><code><a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a> *self</code></em>);</pre> +<p>Gets the name of the ref.</p> +<div class="refsect3"> +<a name="flatpak-ref-get-name.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-ref-get-name.returns"></a><h4>Returns</h4> +<p> the name. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-ref-parse"></a><h3>flatpak_ref_parse ()</h3> +<pre class="programlisting"><a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="returnvalue">FlatpakRef</span></a> * +flatpak_ref_parse (<em class="parameter"><code>const <span class="type">char</span> *ref</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Tries to parse a full ref name and return a <a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a> (without a +commit set) or fail if the ref is invalid somehow.</p> +<div class="refsect3"> +<a name="flatpak-ref-parse.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>ref</p></td> +<td class="parameter_description"><p>A string ref name, such as "app/org.test.App/86_64/master"</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-ref-parse.returns"></a><h4>Returns</h4> +<p> an <a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="FlatpakRef.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="FlatpakRef-struct"></a><h3>struct FlatpakRef</h3> +<pre class="programlisting">struct FlatpakRef;</pre> +</div> +<hr> +<div class="refsect2"> +<a name="FlatpakRefKind"></a><h3>enum FlatpakRefKind</h3> +<p>The kind of artifact that a FlatpakRef refers to.</p> +<div class="refsect3"> +<a name="FlatpakRefKind.members"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="enum_members_name"> +<col class="enum_members_description"> +<col width="200px" class="enum_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="enum_member_name"><p><a name="FLATPAK-REF-KIND-APP:CAPS"></a>FLATPAK_REF_KIND_APP</p></td> +<td class="enum_member_description"> +<p>An application</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="FLATPAK-REF-KIND-RUNTIME:CAPS"></a>FLATPAK_REF_KIND_RUNTIME</p></td> +<td class="enum_member_description"> +<p>A runtime that applications can use.</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="FlatpakRef.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="FlatpakRef--arch"></a><h3>The <code class="literal">“arch”</code> property</h3> +<pre class="programlisting"> “arch” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>The architecture of the application or runtime.</p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="FlatpakRef--branch"></a><h3>The <code class="literal">“branch”</code> property</h3> +<pre class="programlisting"> “branch” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>The branch of the application or runtime.</p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="FlatpakRef--commit"></a><h3>The <code class="literal">“commit”</code> property</h3> +<pre class="programlisting"> “commit” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>The commit.</p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="FlatpakRef--kind"></a><h3>The <code class="literal">“kind”</code> property</h3> +<pre class="programlisting"> “kind” <a class="link" href="FlatpakRef.html#FlatpakRefKind" title="enum FlatpakRefKind"><span class="type">FlatpakRefKind</span></a></pre> +<p>The kind of artifact.</p> +<p>Flags: Read / Write</p> +<p>Default value: FLATPAK_REF_KIND_APP</p> +</div> +<hr> +<div class="refsect2"> +<a name="FlatpakRef--name"></a><h3>The <code class="literal">“name”</code> property</h3> +<pre class="programlisting"> “name” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>The name of the application or runtime.</p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25.1</div> +</body> +</html>
\ No newline at end of file diff --git a/reference/html/FlatpakRemote.html b/reference/html/FlatpakRemote.html new file mode 100644 index 00000000..ba5c6bd1 --- /dev/null +++ b/reference/html/FlatpakRemote.html @@ -0,0 +1,774 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>FlatpakRemote: Flatpak Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Flatpak Library Reference Manual"> +<link rel="up" href="ch01.html" title="Flatpak"> +<link rel="prev" href="FlatpakRemoteRef.html" title="FlatpakRemoteRef"> +<link rel="next" href="flatpak-flatpak-bundle-ref.html" title="flatpak-bundle-ref"> +<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#FlatpakRemote.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#FlatpakRemote.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#FlatpakRemote.properties" class="shortcut">Properties</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="FlatpakRemoteRef.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="flatpak-flatpak-bundle-ref.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="FlatpakRemote"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="FlatpakRemote.top_of_page"></a>FlatpakRemote</span></h2> +<p>FlatpakRemote — Remote repository</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="FlatpakRemote.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="returnvalue">FlatpakRemote</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakRemote.html#flatpak-remote-new" title="flatpak_remote_new ()">flatpak_remote_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakRemote.html#flatpak-remote-get-name" title="flatpak_remote_get_name ()">flatpak_remote_get_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../gio/GFile.html#GFile-struct"><span class="returnvalue">GFile</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakRemote.html#flatpak-remote-get-appstream-dir" title="flatpak_remote_get_appstream_dir ()">flatpak_remote_get_appstream_dir</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../gio/GFile.html#GFile-struct"><span class="returnvalue">GFile</span></a> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakRemote.html#flatpak-remote-get-appstream-timestamp" title="flatpak_remote_get_appstream_timestamp ()">flatpak_remote_get_appstream_timestamp</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="FlatpakRemote.html#flatpak-remote-get-gpg-verify" title="flatpak_remote_get_gpg_verify ()">flatpak_remote_get_gpg_verify</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="FlatpakRemote.html#flatpak-remote-set-gpg-verify" title="flatpak_remote_set_gpg_verify ()">flatpak_remote_set_gpg_verify</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="FlatpakRemote.html#flatpak-remote-set-gpg-key" title="flatpak_remote_set_gpg_key ()">flatpak_remote_set_gpg_key</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="FlatpakRemote.html#flatpak-remote-get-noenumerate" title="flatpak_remote_get_noenumerate ()">flatpak_remote_get_noenumerate</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="FlatpakRemote.html#flatpak-remote-set-noenumerate" title="flatpak_remote_set_noenumerate ()">flatpak_remote_set_noenumerate</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<a class="link" href="FlatpakRemote.html#flatpak-remote-get-prio" title="flatpak_remote_get_prio ()">flatpak_remote_get_prio</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="FlatpakRemote.html#flatpak-remote-set-prio" title="flatpak_remote_set_prio ()">flatpak_remote_set_prio</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakRemote.html#flatpak-remote-get-title" title="flatpak_remote_get_title ()">flatpak_remote_get_title</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="FlatpakRemote.html#flatpak-remote-set-title" title="flatpak_remote_set_title ()">flatpak_remote_set_title</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakRemote.html#flatpak-remote-get-url" title="flatpak_remote_get_url ()">flatpak_remote_get_url</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="FlatpakRemote.html#flatpak-remote-set-url" title="flatpak_remote_set_url ()">flatpak_remote_set_url</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="FlatpakRemote.html#flatpak-remote-get-disabled" title="flatpak_remote_get_disabled ()">flatpak_remote_get_disabled</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="FlatpakRemote.html#flatpak-remote-set-disabled" title="flatpak_remote_set_disabled ()">flatpak_remote_set_disabled</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="FlatpakRemote.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody><tr> +<td class="property_type"> +<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="FlatpakRemote.html#FlatpakRemote--name" title="The “name” property">name</a></td> +<td class="property_flags">Read / Write</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="FlatpakRemote.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody><tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="FlatpakRemote.html#FlatpakRemote-struct" title="struct FlatpakRemote">FlatpakRemote</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="FlatpakRemote.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> + <span class="lineart">╰──</span> FlatpakRemote +</pre> +</div> +<div class="refsect1"> +<a name="FlatpakRemote.description"></a><h2>Description</h2> +<p>A <a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> object provides information about a remote +repository (or short: remote) that has been configured.</p> +<p>At its most basic level, a remote has a name and the URL for +the repository. In addition, they provide some additional +information that can be useful when presenting repositories +in a UI, such as a title, a priority or a "don't enumerate" +flags.</p> +<p>To obtain FlatpakRemote objects for the configured remotes +on a system, use <a class="link" href="FlatpakInstallation.html#flatpak-installation-list-remotes" title="flatpak_installation_list_remotes ()"><code class="function">flatpak_installation_list_remotes()</code></a> or +<a class="link" href="FlatpakInstallation.html#flatpak-installation-get-remote-by-name" title="flatpak_installation_get_remote_by_name ()"><code class="function">flatpak_installation_get_remote_by_name()</code></a>.</p> +</div> +<div class="refsect1"> +<a name="FlatpakRemote.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="flatpak-remote-new"></a><h3>flatpak_remote_new ()</h3> +<pre class="programlisting"><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="returnvalue">FlatpakRemote</span></a> * +flatpak_remote_new (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> +<p>Returns a new remote object which can be used to configure a new remote.</p> +<p>Note: This is a local configuration object, you must commit changes +using <a class="link" href="FlatpakInstallation.html#flatpak-installation-modify-remote" title="flatpak_installation_modify_remote ()"><code class="function">flatpak_installation_modify_remote()</code></a> for the changes to take +effect.</p> +<div class="refsect3"> +<a name="flatpak-remote-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>a name</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-remote-new.returns"></a><h4>Returns</h4> +<p> a new <a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a>. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-remote-get-name"></a><h3>flatpak_remote_get_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +flatpak_remote_get_name (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>);</pre> +<p>Returns the name of the remote repository.</p> +<div class="refsect3"> +<a name="flatpak-remote-get-name.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-remote-get-name.returns"></a><h4>Returns</h4> +<p> the name. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-remote-get-appstream-dir"></a><h3>flatpak_remote_get_appstream_dir ()</h3> +<pre class="programlisting"><a href="../gio/GFile.html#GFile-struct"><span class="returnvalue">GFile</span></a> * +flatpak_remote_get_appstream_dir (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *arch</code></em>);</pre> +<p>Returns the directory where this remote will store locally cached +appstream information for the specified <em class="parameter"><code>arch</code></em> +.</p> +<div class="refsect3"> +<a name="flatpak-remote-get-appstream-dir.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>arch</p></td> +<td class="parameter_description"><p> which architecture to fetch (default: current architecture). </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-remote-get-appstream-dir.returns"></a><h4>Returns</h4> +<p> a <a href="../gio/GFile.html#GFile-struct"><span class="type">GFile</span></a>. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-remote-get-appstream-timestamp"></a><h3>flatpak_remote_get_appstream_timestamp ()</h3> +<pre class="programlisting"><a href="../gio/GFile.html#GFile-struct"><span class="returnvalue">GFile</span></a> * +flatpak_remote_get_appstream_timestamp + (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *arch</code></em>);</pre> +<p>Returns the timestamp file that will be updated whenever the appstream information +has been updated (or tried to update) for the specified <em class="parameter"><code>arch</code></em> +.</p> +<div class="refsect3"> +<a name="flatpak-remote-get-appstream-timestamp.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>arch</p></td> +<td class="parameter_description"><p> which architecture to fetch (default: current architecture). </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-remote-get-appstream-timestamp.returns"></a><h4>Returns</h4> +<p> a <a href="../gio/GFile.html#GFile-struct"><span class="type">GFile</span></a>. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-remote-get-gpg-verify"></a><h3>flatpak_remote_get_gpg_verify ()</h3> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +flatpak_remote_get_gpg_verify (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>);</pre> +<p>Returns whether GPG verification is enabled for the remote.</p> +<div class="refsect3"> +<a name="flatpak-remote-get-gpg-verify.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-remote-get-gpg-verify.returns"></a><h4>Returns</h4> +<p> whether GPG verification is enabled</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-remote-set-gpg-verify"></a><h3>flatpak_remote_set_gpg_verify ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +flatpak_remote_set_gpg_verify (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>, + <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> gpg_verify</code></em>);</pre> +<p>Sets the gpg_verify config of this remote. See <a class="link" href="FlatpakRemote.html#flatpak-remote-get-gpg-verify" title="flatpak_remote_get_gpg_verify ()"><code class="function">flatpak_remote_get_gpg_verify()</code></a>.</p> +<p>Note: This is a local modification of this object, you must commit changes +using <a class="link" href="FlatpakInstallation.html#flatpak-installation-modify-remote" title="flatpak_installation_modify_remote ()"><code class="function">flatpak_installation_modify_remote()</code></a> for the changes to take +effect.</p> +<div class="refsect3"> +<a name="flatpak-remote-set-gpg-verify.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>gpg_verify</p></td> +<td class="parameter_description"><p>a bool</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-remote-set-gpg-key"></a><h3>flatpak_remote_set_gpg_key ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +flatpak_remote_set_gpg_key (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>, + <em class="parameter"><code><a href="../glib/glib-Byte-Arrays.html#GBytes"><span class="type">GBytes</span></a> *gpg_key</code></em>);</pre> +<p>Sets the trusted gpg key for this remote.</p> +<p>Note: This is a local modification of this object, you must commit changes +using <a class="link" href="FlatpakInstallation.html#flatpak-installation-modify-remote" title="flatpak_installation_modify_remote ()"><code class="function">flatpak_installation_modify_remote()</code></a> for the changes to take +effect.</p> +<div class="refsect3"> +<a name="flatpak-remote-set-gpg-key.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>gpg_key</p></td> +<td class="parameter_description"><p>a <a href="../glib/glib-Byte-Arrays.html#GBytes"><span class="type">GBytes</span></a> with gpg binary key data</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-remote-get-noenumerate"></a><h3>flatpak_remote_get_noenumerate ()</h3> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +flatpak_remote_get_noenumerate (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>);</pre> +<p>Returns whether this remote should be used to list applications.</p> +<div class="refsect3"> +<a name="flatpak-remote-get-noenumerate.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-remote-get-noenumerate.returns"></a><h4>Returns</h4> +<p> whether the remote is marked as "don't enumerate"</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-remote-set-noenumerate"></a><h3>flatpak_remote_set_noenumerate ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +flatpak_remote_set_noenumerate (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>, + <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> noenumerate</code></em>);</pre> +<p>Sets the noenumeration config of this remote. See <a class="link" href="FlatpakRemote.html#flatpak-remote-get-noenumerate" title="flatpak_remote_get_noenumerate ()"><code class="function">flatpak_remote_get_noenumerate()</code></a>.</p> +<p>Note: This is a local modification of this object, you must commit changes +using <a class="link" href="FlatpakInstallation.html#flatpak-installation-modify-remote" title="flatpak_installation_modify_remote ()"><code class="function">flatpak_installation_modify_remote()</code></a> for the changes to take +effect.</p> +<div class="refsect3"> +<a name="flatpak-remote-set-noenumerate.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>noenumerate</p></td> +<td class="parameter_description"><p>a bool</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-remote-get-prio"></a><h3>flatpak_remote_get_prio ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +flatpak_remote_get_prio (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>);</pre> +<p>Returns the priority for the remote.</p> +<div class="refsect3"> +<a name="flatpak-remote-get-prio.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-remote-get-prio.returns"></a><h4>Returns</h4> +<p> the priority</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-remote-set-prio"></a><h3>flatpak_remote_set_prio ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +flatpak_remote_set_prio (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>, + <em class="parameter"><code><span class="type">int</span> prio</code></em>);</pre> +<p>Sets the prio config of this remote. See <a class="link" href="FlatpakRemote.html#flatpak-remote-get-prio" title="flatpak_remote_get_prio ()"><code class="function">flatpak_remote_get_prio()</code></a>.</p> +<p>Note: This is a local modification of this object, you must commit changes +using <a class="link" href="FlatpakInstallation.html#flatpak-installation-modify-remote" title="flatpak_installation_modify_remote ()"><code class="function">flatpak_installation_modify_remote()</code></a> for the changes to take +effect.</p> +<div class="refsect3"> +<a name="flatpak-remote-set-prio.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>prio</p></td> +<td class="parameter_description"><p>a bool</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-remote-get-title"></a><h3>flatpak_remote_get_title ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * +flatpak_remote_get_title (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>);</pre> +<p>Returns the title of the remote.</p> +<div class="refsect3"> +<a name="flatpak-remote-get-title.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-remote-get-title.returns"></a><h4>Returns</h4> +<p> the title. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-remote-set-title"></a><h3>flatpak_remote_set_title ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +flatpak_remote_set_title (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *title</code></em>);</pre> +<p>Sets the repository title of this remote.</p> +<p>Note: This is a local modification of this object, you must commit changes +using <a class="link" href="FlatpakInstallation.html#flatpak-installation-modify-remote" title="flatpak_installation_modify_remote ()"><code class="function">flatpak_installation_modify_remote()</code></a> for the changes to take +effect.</p> +<div class="refsect3"> +<a name="flatpak-remote-set-title.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>title</p></td> +<td class="parameter_description"><p>The new title</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-remote-get-url"></a><h3>flatpak_remote_get_url ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * +flatpak_remote_get_url (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>);</pre> +<p>Returns the repository URL of this remote.</p> +<div class="refsect3"> +<a name="flatpak-remote-get-url.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-remote-get-url.returns"></a><h4>Returns</h4> +<p> the URL. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-remote-set-url"></a><h3>flatpak_remote_set_url ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +flatpak_remote_set_url (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *url</code></em>);</pre> +<p>Sets the repository URL of this remote.</p> +<p>Note: This is a local modification of this object, you must commit changes +using <a class="link" href="FlatpakInstallation.html#flatpak-installation-modify-remote" title="flatpak_installation_modify_remote ()"><code class="function">flatpak_installation_modify_remote()</code></a> for the changes to take +effect.</p> +<div class="refsect3"> +<a name="flatpak-remote-set-url.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>url</p></td> +<td class="parameter_description"><p>The new url</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-remote-get-disabled"></a><h3>flatpak_remote_get_disabled ()</h3> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +flatpak_remote_get_disabled (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>);</pre> +<p>Returns whether this remote is disabled.</p> +<div class="refsect3"> +<a name="flatpak-remote-get-disabled.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-remote-get-disabled.returns"></a><h4>Returns</h4> +<p> whether the remote is marked as "don't enumerate"</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-remote-set-disabled"></a><h3>flatpak_remote_set_disabled ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +flatpak_remote_set_disabled (<em class="parameter"><code><a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a> *self</code></em>, + <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> disabled</code></em>);</pre> +<p>Sets the disabled config of this remote. See <code class="function">flatpak_remote_get_disable()</code>.</p> +<p>Note: This is a local modification of this object, you must commit changes +using <a class="link" href="FlatpakInstallation.html#flatpak-installation-modify-remote" title="flatpak_installation_modify_remote ()"><code class="function">flatpak_installation_modify_remote()</code></a> for the changes to take +effect.</p> +<div class="refsect3"> +<a name="flatpak-remote-set-disabled.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRemote.html" title="FlatpakRemote"><span class="type">FlatpakRemote</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>disabled</p></td> +<td class="parameter_description"><p>a bool</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="FlatpakRemote.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="FlatpakRemote-struct"></a><h3>struct FlatpakRemote</h3> +<pre class="programlisting">struct FlatpakRemote;</pre> +</div> +</div> +<div class="refsect1"> +<a name="FlatpakRemote.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="FlatpakRemote--name"></a><h3>The <code class="literal">“name”</code> property</h3> +<pre class="programlisting"> “name” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>The name of the remote.</p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25.1</div> +</body> +</html>
\ No newline at end of file diff --git a/reference/html/FlatpakRemoteRef.html b/reference/html/FlatpakRemoteRef.html new file mode 100644 index 00000000..974e51e6 --- /dev/null +++ b/reference/html/FlatpakRemoteRef.html @@ -0,0 +1,143 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>FlatpakRemoteRef: Flatpak Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Flatpak Library Reference Manual"> +<link rel="up" href="ch01.html" title="Flatpak"> +<link rel="prev" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef"> +<link rel="next" href="FlatpakRemote.html" title="FlatpakRemote"> +<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#FlatpakRemoteRef.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#FlatpakRemoteRef.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#FlatpakRemoteRef.properties" class="shortcut">Properties</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="FlatpakInstalledRef.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="FlatpakRemote.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="FlatpakRemoteRef"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="FlatpakRemoteRef.top_of_page"></a>FlatpakRemoteRef</span></h2> +<p>FlatpakRemoteRef — Remote application reference</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="FlatpakRemoteRef.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody><tr> +<td class="function_type">const <span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="FlatpakRemoteRef.html#flatpak-remote-ref-get-remote-name" title="flatpak_remote_ref_get_remote_name ()">flatpak_remote_ref_get_remote_name</a> <span class="c_punctuation">()</span> +</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="FlatpakRemoteRef.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody><tr> +<td class="property_type"> +<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="FlatpakRemoteRef.html#FlatpakRemoteRef--remote-name" title="The “remote-name” property">remote-name</a></td> +<td class="property_flags">Read / Write</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="FlatpakRemoteRef.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody><tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="FlatpakRemoteRef.html#FlatpakRemoteRef-struct" title="struct FlatpakRemoteRef">FlatpakRemoteRef</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="FlatpakRemoteRef.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> + <span class="lineart">╰──</span> <a class="link" href="FlatpakRef.html" title="FlatpakRef">FlatpakRef</a> + <span class="lineart">╰──</span> FlatpakRemoteRef +</pre> +</div> +<div class="refsect1"> +<a name="FlatpakRemoteRef.description"></a><h2>Description</h2> +<p>A FlatpakRemoteRef provides information about an application or runtime +(in short: ref) that is available from a remote repository.</p> +</div> +<div class="refsect1"> +<a name="FlatpakRemoteRef.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="flatpak-remote-ref-get-remote-name"></a><h3>flatpak_remote_ref_get_remote_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +flatpak_remote_ref_get_remote_name (<em class="parameter"><code><a class="link" href="FlatpakRemoteRef.html" title="FlatpakRemoteRef"><span class="type">FlatpakRemoteRef</span></a> *self</code></em>);</pre> +<p>Gets the remote name of the ref.</p> +<div class="refsect3"> +<a name="flatpak-remote-ref-get-remote-name.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="FlatpakRemoteRef.html" title="FlatpakRemoteRef"><span class="type">FlatpakRemoteRef</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-remote-ref-get-remote-name.returns"></a><h4>Returns</h4> +<p> the remote name. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="FlatpakRemoteRef.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="FlatpakRemoteRef-struct"></a><h3>struct FlatpakRemoteRef</h3> +<pre class="programlisting">struct FlatpakRemoteRef;</pre> +</div> +</div> +<div class="refsect1"> +<a name="FlatpakRemoteRef.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="FlatpakRemoteRef--remote-name"></a><h3>The <code class="literal">“remote-name”</code> property</h3> +<pre class="programlisting"> “remote-name” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>The name of the remote.</p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25.1</div> +</body> +</html>
\ No newline at end of file diff --git a/reference/html/annotation-glossary.html b/reference/html/annotation-glossary.html new file mode 100644 index 00000000..43dfee49 --- /dev/null +++ b/reference/html/annotation-glossary.html @@ -0,0 +1,60 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Annotation Glossary: Flatpak Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Flatpak Library Reference Manual"> +<link rel="up" href="index.html" title="Flatpak Library Reference Manual"> +<link rel="prev" href="full-api-index.html" title="API Index"> +<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"><span id="nav_glossary"><a class="shortcut" href="#glsA">A</a> + <span class="dim">|</span> + <a class="shortcut" href="#glsE">E</a> + <span class="dim">|</span> + <a class="shortcut" href="#glsN">N</a> + <span class="dim">|</span> + <a class="shortcut" href="#glsO">O</a> + <span class="dim">|</span> + <a class="shortcut" href="#glsS">S</a> + <span class="dim">|</span> + <a class="shortcut" href="#glsT">T</a></span></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="full-api-index.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><img src="right-insensitive.png" width="16" height="16" border="0"></td> +</tr></table> +<div class="glossary"> +<div class="titlepage"><div><div><h1 class="title"> +<a name="annotation-glossary"></a>Annotation Glossary</h1></div></div></div> +<a name="glsA"></a><h3 class="title">A</h3> +<dt><span class="glossterm"><a name="annotation-glossterm-allow-none"></a>allow-none</span></dt> +<dd class="glossdef"><p>NULL is OK, both for passing and for returning.</p></dd> +<a name="glsE"></a><h3 class="title">E</h3> +<dt><span class="glossterm"><a name="annotation-glossterm-element-type"></a>element-type</span></dt> +<dd class="glossdef"><p>Generics and defining elements of containers and arrays.</p></dd> +<a name="glsN"></a><h3 class="title">N</h3> +<dt><span class="glossterm"><a name="annotation-glossterm-nullable"></a>nullable</span></dt> +<dd class="glossdef"><p>NULL may be passed as the value in, out, in-out; or as a return value.</p></dd> +<a name="glsO"></a><h3 class="title">O</h3> +<dt><span class="glossterm"><a name="annotation-glossterm-out"></a>out</span></dt> +<dd class="glossdef"><p>Parameter for returning results. Default is <acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>.</p></dd> +<a name="glsS"></a><h3 class="title">S</h3> +<dt><span class="glossterm"><a name="annotation-glossterm-scope%20call"></a>scope call</span></dt> +<dd class="glossdef"><p>The callback is valid only during the call to the method.</p></dd> +<a name="glsT"></a><h3 class="title">T</h3> +<dt><span class="glossterm"><a name="annotation-glossterm-transfer%20container"></a>transfer container</span></dt> +<dd class="glossdef"><p>Free data container after the code is done.</p></dd> +<dt><span class="glossterm"><a name="annotation-glossterm-transfer%20full"></a>transfer full</span></dt> +<dd class="glossdef"><p>Free data after the code is done.</p></dd> +<dt><span class="glossterm"><a name="annotation-glossterm-transfer%20none"></a>transfer none</span></dt> +<dd class="glossdef"><p>Don't free data after the code is done.</p></dd> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25.1</div> +</body> +</html>
\ No newline at end of file diff --git a/reference/html/ch01.html b/reference/html/ch01.html new file mode 100644 index 00000000..d7ddc588 --- /dev/null +++ b/reference/html/ch01.html @@ -0,0 +1,55 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Flatpak: Flatpak Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Flatpak Library Reference Manual"> +<link rel="up" href="index.html" title="Flatpak Library Reference Manual"> +<link rel="prev" href="index.html" title="Flatpak Library Reference Manual"> +<link rel="next" href="FlatpakInstallation.html" title="FlatpakInstallation"> +<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="index.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="FlatpakInstallation.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h1 class="title"> +<a name="id-1.2"></a>Flatpak</h1></div></div></div> +<div class="toc"><dl class="toc"> +<dt> +<span class="refentrytitle"><a href="FlatpakInstallation.html">FlatpakInstallation</a></span><span class="refpurpose"> — Installation information</span> +</dt> +<dt> +<span class="refentrytitle"><a href="FlatpakRef.html">FlatpakRef</a></span><span class="refpurpose"> — Application reference</span> +</dt> +<dt> +<span class="refentrytitle"><a href="FlatpakInstalledRef.html">FlatpakInstalledRef</a></span><span class="refpurpose"> — Installed application reference</span> +</dt> +<dt> +<span class="refentrytitle"><a href="FlatpakRemoteRef.html">FlatpakRemoteRef</a></span><span class="refpurpose"> — Remote application reference</span> +</dt> +<dt> +<span class="refentrytitle"><a href="FlatpakRemote.html">FlatpakRemote</a></span><span class="refpurpose"> — Remote repository</span> +</dt> +<dt> +<span class="refentrytitle"><a href="flatpak-flatpak-bundle-ref.html">flatpak-bundle-ref</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="flatpak-Error-codes.html">Error codes</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="flatpak-Version-information.html">Version information</a></span><span class="refpurpose"></span> +</dt> +</dl></div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25.1</div> +</body> +</html>
\ No newline at end of file diff --git a/reference/html/flatpak-Error-codes.html b/reference/html/flatpak-Error-codes.html new file mode 100644 index 00000000..19beec39 --- /dev/null +++ b/reference/html/flatpak-Error-codes.html @@ -0,0 +1,124 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Error codes: Flatpak Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Flatpak Library Reference Manual"> +<link rel="up" href="ch01.html" title="Flatpak"> +<link rel="prev" href="flatpak-flatpak-bundle-ref.html" title="flatpak-bundle-ref"> +<link rel="next" href="flatpak-Version-information.html" title="Version information"> +<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#flatpak-Error-codes.description" class="shortcut">Description</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="flatpak-flatpak-bundle-ref.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="flatpak-Version-information.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="flatpak-Error-codes"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="flatpak-Error-codes.top_of_page"></a>Error codes</span></h2> +<p>Error codes</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="flatpak-Error-codes.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody><tr> +<td class="function_type"> +<a href="../glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> +</td> +<td class="function_name"> +<a class="link" href="flatpak-Error-codes.html#flatpak-error-quark" title="flatpak_error_quark ()">flatpak_error_quark</a> <span class="c_punctuation">()</span> +</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="flatpak-Error-codes.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="flatpak-Error-codes.html#FLATPAK-ERROR:CAPS" title="FLATPAK_ERROR">FLATPAK_ERROR</a></td> +</tr> +<tr> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="flatpak-Error-codes.html#FlatpakError" title="enum FlatpakError">FlatpakError</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="flatpak-Error-codes.description"></a><h2>Description</h2> +</div> +<div class="refsect1"> +<a name="flatpak-Error-codes.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="flatpak-error-quark"></a><h3>flatpak_error_quark ()</h3> +<pre class="programlisting"><a href="../glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> +flatpak_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +</div> +</div> +<div class="refsect1"> +<a name="flatpak-Error-codes.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="FLATPAK-ERROR:CAPS"></a><h3>FLATPAK_ERROR</h3> +<pre class="programlisting">#define FLATPAK_ERROR flatpak_error_quark () +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="FlatpakError"></a><h3>enum FlatpakError</h3> +<p>Error codes for library functions.</p> +<div class="refsect3"> +<a name="FlatpakError.members"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="enum_members_name"> +<col class="enum_members_description"> +<col width="200px" class="enum_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="enum_member_name"><p><a name="FLATPAK-ERROR-ALREADY-INSTALLED:CAPS"></a>FLATPAK_ERROR_ALREADY_INSTALLED</p></td> +<td class="enum_member_description"> +<p>App/runtime is already installed</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="FLATPAK-ERROR-NOT-INSTALLED:CAPS"></a>FLATPAK_ERROR_NOT_INSTALLED</p></td> +<td class="enum_member_description"> +<p>App/runtime is not installed</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25.1</div> +</body> +</html>
\ No newline at end of file diff --git a/reference/html/flatpak-Version-information.html b/reference/html/flatpak-Version-information.html new file mode 100644 index 00000000..7ae0991d --- /dev/null +++ b/reference/html/flatpak-Version-information.html @@ -0,0 +1,98 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Version information: Flatpak Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Flatpak Library Reference Manual"> +<link rel="up" href="ch01.html" title="Flatpak"> +<link rel="prev" href="flatpak-Error-codes.html" title="Error codes"> +<link rel="next" href="object-tree.html" title="Object Hierarchy"> +<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#flatpak-Version-information.description" class="shortcut">Description</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="flatpak-Error-codes.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="flatpak-Version-information"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="flatpak-Version-information.top_of_page"></a>Version information</span></h2> +<p>Version information</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="flatpak-Version-information.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="flatpak-Version-information.html#FLATPAK-MAJOR-VERSION:CAPS" title="FLATPAK_MAJOR_VERSION">FLATPAK_MAJOR_VERSION</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="flatpak-Version-information.html#FLATPAK-MINOR-VERSION:CAPS" title="FLATPAK_MINOR_VERSION">FLATPAK_MINOR_VERSION</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="flatpak-Version-information.html#FLATPAK-MICRO-VERSION:CAPS" title="FLATPAK_MICRO_VERSION">FLATPAK_MICRO_VERSION</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="flatpak-Version-information.html#FLATPAK-EXTERN:CAPS" title="FLATPAK_EXTERN">FLATPAK_EXTERN</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="flatpak-Version-information.description"></a><h2>Description</h2> +</div> +<div class="refsect1"> +<a name="flatpak-Version-information.functions_details"></a><h2>Functions</h2> +<p></p> +</div> +<div class="refsect1"> +<a name="flatpak-Version-information.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="FLATPAK-MAJOR-VERSION:CAPS"></a><h3>FLATPAK_MAJOR_VERSION</h3> +<pre class="programlisting">#define FLATPAK_MAJOR_VERSION (0) +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="FLATPAK-MINOR-VERSION:CAPS"></a><h3>FLATPAK_MINOR_VERSION</h3> +<pre class="programlisting">#define FLATPAK_MINOR_VERSION (6) +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="FLATPAK-MICRO-VERSION:CAPS"></a><h3>FLATPAK_MICRO_VERSION</h3> +<pre class="programlisting">#define FLATPAK_MICRO_VERSION (7) +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="FLATPAK-EXTERN:CAPS"></a><h3>FLATPAK_EXTERN</h3> +<pre class="programlisting">#define FLATPAK_EXTERN extern +</pre> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25.1</div> +</body> +</html>
\ No newline at end of file diff --git a/reference/html/flatpak-flatpak-bundle-ref.html b/reference/html/flatpak-flatpak-bundle-ref.html new file mode 100644 index 00000000..4ba60519 --- /dev/null +++ b/reference/html/flatpak-flatpak-bundle-ref.html @@ -0,0 +1,361 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>flatpak-bundle-ref: Flatpak Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Flatpak Library Reference Manual"> +<link rel="up" href="ch01.html" title="Flatpak"> +<link rel="prev" href="FlatpakRemote.html" title="FlatpakRemote"> +<link rel="next" href="flatpak-Error-codes.html" title="Error codes"> +<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#flatpak-flatpak-bundle-ref.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#flatpak-flatpak-bundle-ref.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#flatpak-flatpak-bundle-ref.properties" class="shortcut">Properties</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="FlatpakRemote.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="flatpak-Error-codes.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="flatpak-flatpak-bundle-ref"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="flatpak-flatpak-bundle-ref.top_of_page"></a>flatpak-bundle-ref</span></h2> +<p>flatpak-bundle-ref</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="flatpak-flatpak-bundle-ref.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef"><span class="returnvalue">FlatpakBundleRef</span></a> * +</td> +<td class="function_name"> +<a class="link" href="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-new" title="flatpak_bundle_ref_new ()">flatpak_bundle_ref_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../gio/GFile.html#GFile-struct"><span class="returnvalue">GFile</span></a> * +</td> +<td class="function_name"> +<a class="link" href="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-get-file" title="flatpak_bundle_ref_get_file ()">flatpak_bundle_ref_get_file</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Byte-Arrays.html#GBytes"><span class="returnvalue">GBytes</span></a> * +</td> +<td class="function_name"> +<a class="link" href="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-get-metadata" title="flatpak_bundle_ref_get_metadata ()">flatpak_bundle_ref_get_metadata</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Byte-Arrays.html#GBytes"><span class="returnvalue">GBytes</span></a> * +</td> +<td class="function_name"> +<a class="link" href="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-get-appstream" title="flatpak_bundle_ref_get_appstream ()">flatpak_bundle_ref_get_appstream</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Byte-Arrays.html#GBytes"><span class="returnvalue">GBytes</span></a> * +</td> +<td class="function_name"> +<a class="link" href="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-get-icon" title="flatpak_bundle_ref_get_icon ()">flatpak_bundle_ref_get_icon</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-get-origin" title="flatpak_bundle_ref_get_origin ()">flatpak_bundle_ref_get_origin</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> +</td> +<td class="function_name"> +<a class="link" href="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-get-installed-size" title="flatpak_bundle_ref_get_installed_size ()">flatpak_bundle_ref_get_installed_size</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="flatpak-flatpak-bundle-ref.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody><tr> +<td class="property_type"> +<a href="../gio/GFile.html#GFile-struct"><span class="type">GFile</span></a> *</td> +<td class="property_name"><a class="link" href="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef--file" title="The “file” property">file</a></td> +<td class="property_flags">Read / Write</td> +</tr></tbody> +</table></div> +</div> +<a name="FlatpakBundleRef"></a><div class="refsect1"> +<a name="flatpak-flatpak-bundle-ref.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody><tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef-struct" title="struct FlatpakBundleRef">FlatpakBundleRef</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="flatpak-flatpak-bundle-ref.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> + <span class="lineart">╰──</span> <a class="link" href="FlatpakRef.html" title="FlatpakRef">FlatpakRef</a> + <span class="lineart">╰──</span> FlatpakBundleRef +</pre> +</div> +<div class="refsect1"> +<a name="flatpak-flatpak-bundle-ref.description"></a><h2>Description</h2> +</div> +<div class="refsect1"> +<a name="flatpak-flatpak-bundle-ref.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="flatpak-bundle-ref-new"></a><h3>flatpak_bundle_ref_new ()</h3> +<pre class="programlisting"><a class="link" href="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef"><span class="returnvalue">FlatpakBundleRef</span></a> * +flatpak_bundle_ref_new (<em class="parameter"><code><a href="../gio/GFile.html#GFile-struct"><span class="type">GFile</span></a> *file</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>Creates a new bundle ref for the given file.</p> +<div class="refsect3"> +<a name="flatpak-bundle-ref-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>file</p></td> +<td class="parameter_description"><p>a <a href="../gio/GFile.html#GFile-struct"><span class="type">GFile</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p> return location for an error. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-bundle-ref-new.returns"></a><h4>Returns</h4> +<p> a new bundle ref.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-bundle-ref-get-file"></a><h3>flatpak_bundle_ref_get_file ()</h3> +<pre class="programlisting"><a href="../gio/GFile.html#GFile-struct"><span class="returnvalue">GFile</span></a> * +flatpak_bundle_ref_get_file (<em class="parameter"><code><a class="link" href="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef"><span class="type">FlatpakBundleRef</span></a> *self</code></em>);</pre> +<p>Get the file this bundle is stored in.</p> +<div class="refsect3"> +<a name="flatpak-bundle-ref-get-file.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef"><span class="type">FlatpakBundleRef</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-bundle-ref-get-file.returns"></a><h4>Returns</h4> +<p> (transfer full) : an <a href="../gio/GFile.html#GFile-struct"><span class="type">GFile</span></a></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-bundle-ref-get-metadata"></a><h3>flatpak_bundle_ref_get_metadata ()</h3> +<pre class="programlisting"><a href="../glib/glib-Byte-Arrays.html#GBytes"><span class="returnvalue">GBytes</span></a> * +flatpak_bundle_ref_get_metadata (<em class="parameter"><code><a class="link" href="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef"><span class="type">FlatpakBundleRef</span></a> *self</code></em>);</pre> +<p>Get the metadata for the app/runtime</p> +<div class="refsect3"> +<a name="flatpak-bundle-ref-get-metadata.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef"><span class="type">FlatpakBundleRef</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-bundle-ref-get-metadata.returns"></a><h4>Returns</h4> +<p> (transfer full) : an <a href="../glib/glib-Byte-Arrays.html#GBytes"><span class="type">GBytes</span></a> with the metadata contents, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-bundle-ref-get-appstream"></a><h3>flatpak_bundle_ref_get_appstream ()</h3> +<pre class="programlisting"><a href="../glib/glib-Byte-Arrays.html#GBytes"><span class="returnvalue">GBytes</span></a> * +flatpak_bundle_ref_get_appstream (<em class="parameter"><code><a class="link" href="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef"><span class="type">FlatpakBundleRef</span></a> *self</code></em>);</pre> +<p>Get the compressed appstream for the app/runtime</p> +<div class="refsect3"> +<a name="flatpak-bundle-ref-get-appstream.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef"><span class="type">FlatpakBundleRef</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-bundle-ref-get-appstream.returns"></a><h4>Returns</h4> +<p> (transfer full) : an <a href="../glib/glib-Byte-Arrays.html#GBytes"><span class="type">GBytes</span></a> with the appstream contents, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-bundle-ref-get-icon"></a><h3>flatpak_bundle_ref_get_icon ()</h3> +<pre class="programlisting"><a href="../glib/glib-Byte-Arrays.html#GBytes"><span class="returnvalue">GBytes</span></a> * +flatpak_bundle_ref_get_icon (<em class="parameter"><code><a class="link" href="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef"><span class="type">FlatpakBundleRef</span></a> *self</code></em>, + <em class="parameter"><code><span class="type">int</span> size</code></em>);</pre> +<p>Get the icon png data for the app/runtime</p> +<div class="refsect3"> +<a name="flatpak-bundle-ref-get-icon.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef"><span class="type">FlatpakBundleRef</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>size</p></td> +<td class="parameter_description"><p>64 or 128</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-bundle-ref-get-icon.returns"></a><h4>Returns</h4> +<p> (transfer full) : an <a href="../glib/glib-Byte-Arrays.html#GBytes"><span class="type">GBytes</span></a> with png contents</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-bundle-ref-get-origin"></a><h3>flatpak_bundle_ref_get_origin ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * +flatpak_bundle_ref_get_origin (<em class="parameter"><code><a class="link" href="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef"><span class="type">FlatpakBundleRef</span></a> *self</code></em>);</pre> +<p>Get the origin url stored in the bundle</p> +<div class="refsect3"> +<a name="flatpak-bundle-ref-get-origin.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a <a class="link" href="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef"><span class="type">FlatpakBundleRef</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-bundle-ref-get-origin.returns"></a><h4>Returns</h4> +<p> (transfer full) : an url string, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="flatpak-bundle-ref-get-installed-size"></a><h3>flatpak_bundle_ref_get_installed_size ()</h3> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> +flatpak_bundle_ref_get_installed_size (<em class="parameter"><code><a class="link" href="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef"><span class="type">FlatpakBundleRef</span></a> *self</code></em>);</pre> +<p>Returns the installed size for the bundle.</p> +<div class="refsect3"> +<a name="flatpak-bundle-ref-get-installed-size.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>self</p></td> +<td class="parameter_description"><p>a FlatpakBundleRef</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="flatpak-bundle-ref-get-installed-size.returns"></a><h4>Returns</h4> +<p> the installed size</p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="flatpak-flatpak-bundle-ref.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="FlatpakBundleRef-struct"></a><h3>struct FlatpakBundleRef</h3> +<pre class="programlisting">struct FlatpakBundleRef;</pre> +</div> +</div> +<div class="refsect1"> +<a name="flatpak-flatpak-bundle-ref.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="FlatpakBundleRef--file"></a><h3>The <code class="literal">“file”</code> property</h3> +<pre class="programlisting"> “file” <a href="../gio/GFile.html#GFile-struct"><span class="type">GFile</span></a> *</pre> +<p>Flags: Read / Write</p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25.1</div> +</body> +</html>
\ No newline at end of file diff --git a/reference/html/flatpak.devhelp2 b/reference/html/flatpak.devhelp2 new file mode 100644 index 00000000..b0800cce --- /dev/null +++ b/reference/html/flatpak.devhelp2 @@ -0,0 +1,124 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<book xmlns="http://www.devhelp.net/book" title="Flatpak Library Reference Manual" link="index.html" author="" name="flatpak" version="2" language="c"> + <chapters> + <sub name="Flatpak" link="ch01.html"> + <sub name="FlatpakInstallation" link="FlatpakInstallation.html"/> + <sub name="FlatpakRef" link="FlatpakRef.html"/> + <sub name="FlatpakInstalledRef" link="FlatpakInstalledRef.html"/> + <sub name="FlatpakRemoteRef" link="FlatpakRemoteRef.html"/> + <sub name="FlatpakRemote" link="FlatpakRemote.html"/> + <sub name="flatpak-bundle-ref" link="flatpak-flatpak-bundle-ref.html"/> + <sub name="Error codes" link="flatpak-Error-codes.html"/> + <sub name="Version information" link="flatpak-Version-information.html"/> + </sub> + <sub name="Object Hierarchy" link="object-tree.html"/> + <sub name="API Index" link="full-api-index.html"/> + <sub name="Annotation Glossary" link="annotation-glossary.html"/> + </chapters> + <functions> + <keyword type="function" name="flatpak_installation_new_system ()" link="FlatpakInstallation.html#flatpak-installation-new-system"/> + <keyword type="function" name="flatpak_installation_new_user ()" link="FlatpakInstallation.html#flatpak-installation-new-user"/> + <keyword type="function" name="flatpak_installation_new_for_path ()" link="FlatpakInstallation.html#flatpak-installation-new-for-path"/> + <keyword type="function" name="flatpak_installation_get_is_user ()" link="FlatpakInstallation.html#flatpak-installation-get-is-user"/> + <keyword type="function" name="flatpak_installation_get_path ()" link="FlatpakInstallation.html#flatpak-installation-get-path"/> + <keyword type="function" name="flatpak_installation_create_monitor ()" link="FlatpakInstallation.html#flatpak-installation-create-monitor"/> + <keyword type="function" name="flatpak_installation_install ()" link="FlatpakInstallation.html#flatpak-installation-install"/> + <keyword type="function" name="flatpak_installation_update ()" link="FlatpakInstallation.html#flatpak-installation-update"/> + <keyword type="function" name="flatpak_installation_uninstall ()" link="FlatpakInstallation.html#flatpak-installation-uninstall"/> + <keyword type="function" name="flatpak_installation_launch ()" link="FlatpakInstallation.html#flatpak-installation-launch"/> + <keyword type="function" name="flatpak_installation_get_current_installed_app ()" link="FlatpakInstallation.html#flatpak-installation-get-current-installed-app"/> + <keyword type="function" name="flatpak_installation_get_installed_ref ()" link="FlatpakInstallation.html#flatpak-installation-get-installed-ref"/> + <keyword type="function" name="flatpak_installation_list_installed_refs ()" link="FlatpakInstallation.html#flatpak-installation-list-installed-refs"/> + <keyword type="function" name="flatpak_installation_list_installed_refs_by_kind ()" link="FlatpakInstallation.html#flatpak-installation-list-installed-refs-by-kind"/> + <keyword type="function" name="flatpak_installation_list_installed_refs_for_update ()" link="FlatpakInstallation.html#flatpak-installation-list-installed-refs-for-update"/> + <keyword type="function" name="flatpak_installation_list_remote_refs_sync ()" link="FlatpakInstallation.html#flatpak-installation-list-remote-refs-sync"/> + <keyword type="function" name="flatpak_installation_list_remotes ()" link="FlatpakInstallation.html#flatpak-installation-list-remotes"/> + <keyword type="function" name="flatpak_installation_get_remote_by_name ()" link="FlatpakInstallation.html#flatpak-installation-get-remote-by-name"/> + <keyword type="function" name="flatpak_installation_fetch_remote_metadata_sync ()" link="FlatpakInstallation.html#flatpak-installation-fetch-remote-metadata-sync"/> + <keyword type="function" name="flatpak_installation_fetch_remote_ref_sync ()" link="FlatpakInstallation.html#flatpak-installation-fetch-remote-ref-sync"/> + <keyword type="function" name="flatpak_installation_fetch_remote_size_sync ()" link="FlatpakInstallation.html#flatpak-installation-fetch-remote-size-sync"/> + <keyword type="function" name="flatpak_installation_load_app_overrides ()" link="FlatpakInstallation.html#flatpak-installation-load-app-overrides"/> + <keyword type="function" name="flatpak_installation_update_appstream_sync ()" link="FlatpakInstallation.html#flatpak-installation-update-appstream-sync"/> + <keyword type="function" name="flatpak_installation_install_bundle ()" link="FlatpakInstallation.html#flatpak-installation-install-bundle"/> + <keyword type="function" name="flatpak_installation_drop_caches ()" link="FlatpakInstallation.html#flatpak-installation-drop-caches"/> + <keyword type="function" name="flatpak_installation_modify_remote ()" link="FlatpakInstallation.html#flatpak-installation-modify-remote"/> + <keyword type="function" name="flatpak_installation_remove_remote ()" link="FlatpakInstallation.html#flatpak-installation-remove-remote"/> + <keyword type="function" name="flatpak_get_default_arch ()" link="FlatpakInstallation.html#flatpak-get-default-arch"/> + <keyword type="function" name="FlatpakProgressCallback ()" link="FlatpakInstallation.html#FlatpakProgressCallback"/> + <keyword type="struct" name="struct FlatpakInstallation" link="FlatpakInstallation.html#FlatpakInstallation-struct"/> + <keyword type="enum" name="enum FlatpakUpdateFlags" link="FlatpakInstallation.html#FlatpakUpdateFlags"/> + <keyword type="function" name="flatpak_ref_format_ref ()" link="FlatpakRef.html#flatpak-ref-format-ref"/> + <keyword type="function" name="flatpak_ref_get_arch ()" link="FlatpakRef.html#flatpak-ref-get-arch"/> + <keyword type="function" name="flatpak_ref_get_branch ()" link="FlatpakRef.html#flatpak-ref-get-branch"/> + <keyword type="function" name="flatpak_ref_get_commit ()" link="FlatpakRef.html#flatpak-ref-get-commit"/> + <keyword type="function" name="flatpak_ref_get_kind ()" link="FlatpakRef.html#flatpak-ref-get-kind"/> + <keyword type="function" name="flatpak_ref_get_name ()" link="FlatpakRef.html#flatpak-ref-get-name"/> + <keyword type="function" name="flatpak_ref_parse ()" link="FlatpakRef.html#flatpak-ref-parse"/> + <keyword type="struct" name="struct FlatpakRef" link="FlatpakRef.html#FlatpakRef-struct"/> + <keyword type="enum" name="enum FlatpakRefKind" link="FlatpakRef.html#FlatpakRefKind"/> + <keyword type="property" name="The “arch” property" link="FlatpakRef.html#FlatpakRef--arch"/> + <keyword type="property" name="The “branch” property" link="FlatpakRef.html#FlatpakRef--branch"/> + <keyword type="property" name="The “commit” property" link="FlatpakRef.html#FlatpakRef--commit"/> + <keyword type="property" name="The “kind” property" link="FlatpakRef.html#FlatpakRef--kind"/> + <keyword type="property" name="The “name” property" link="FlatpakRef.html#FlatpakRef--name"/> + <keyword type="function" name="flatpak_installed_ref_get_deploy_dir ()" link="FlatpakInstalledRef.html#flatpak-installed-ref-get-deploy-dir"/> + <keyword type="function" name="flatpak_installed_ref_get_installed_size ()" link="FlatpakInstalledRef.html#flatpak-installed-ref-get-installed-size"/> + <keyword type="function" name="flatpak_installed_ref_get_is_current ()" link="FlatpakInstalledRef.html#flatpak-installed-ref-get-is-current"/> + <keyword type="function" name="flatpak_installed_ref_get_latest_commit ()" link="FlatpakInstalledRef.html#flatpak-installed-ref-get-latest-commit"/> + <keyword type="function" name="flatpak_installed_ref_get_origin ()" link="FlatpakInstalledRef.html#flatpak-installed-ref-get-origin"/> + <keyword type="function" name="flatpak_installed_ref_load_metadata ()" link="FlatpakInstalledRef.html#flatpak-installed-ref-load-metadata"/> + <keyword type="function" name="flatpak_installed_ref_get_subpaths ()" link="FlatpakInstalledRef.html#flatpak-installed-ref-get-subpaths"/> + <keyword type="struct" name="struct FlatpakInstalledRef" link="FlatpakInstalledRef.html#FlatpakInstalledRef-struct"/> + <keyword type="property" name="The “deploy-dir” property" link="FlatpakInstalledRef.html#FlatpakInstalledRef--deploy-dir"/> + <keyword type="property" name="The “installed-size” property" link="FlatpakInstalledRef.html#FlatpakInstalledRef--installed-size"/> + <keyword type="property" name="The “is-current” property" link="FlatpakInstalledRef.html#FlatpakInstalledRef--is-current"/> + <keyword type="property" name="The “latest-commit” property" link="FlatpakInstalledRef.html#FlatpakInstalledRef--latest-commit"/> + <keyword type="property" name="The “origin” property" link="FlatpakInstalledRef.html#FlatpakInstalledRef--origin"/> + <keyword type="property" name="The “subpaths” property" link="FlatpakInstalledRef.html#FlatpakInstalledRef--subpaths"/> + <keyword type="function" name="flatpak_remote_ref_get_remote_name ()" link="FlatpakRemoteRef.html#flatpak-remote-ref-get-remote-name"/> + <keyword type="struct" name="struct FlatpakRemoteRef" link="FlatpakRemoteRef.html#FlatpakRemoteRef-struct"/> + <keyword type="property" name="The “remote-name” property" link="FlatpakRemoteRef.html#FlatpakRemoteRef--remote-name"/> + <keyword type="function" name="flatpak_remote_new ()" link="FlatpakRemote.html#flatpak-remote-new"/> + <keyword type="function" name="flatpak_remote_get_name ()" link="FlatpakRemote.html#flatpak-remote-get-name"/> + <keyword type="function" name="flatpak_remote_get_appstream_dir ()" link="FlatpakRemote.html#flatpak-remote-get-appstream-dir"/> + <keyword type="function" name="flatpak_remote_get_appstream_timestamp ()" link="FlatpakRemote.html#flatpak-remote-get-appstream-timestamp"/> + <keyword type="function" name="flatpak_remote_get_gpg_verify ()" link="FlatpakRemote.html#flatpak-remote-get-gpg-verify"/> + <keyword type="function" name="flatpak_remote_set_gpg_verify ()" link="FlatpakRemote.html#flatpak-remote-set-gpg-verify"/> + <keyword type="function" name="flatpak_remote_set_gpg_key ()" link="FlatpakRemote.html#flatpak-remote-set-gpg-key"/> + <keyword type="function" name="flatpak_remote_get_noenumerate ()" link="FlatpakRemote.html#flatpak-remote-get-noenumerate"/> + <keyword type="function" name="flatpak_remote_set_noenumerate ()" link="FlatpakRemote.html#flatpak-remote-set-noenumerate"/> + <keyword type="function" name="flatpak_remote_get_prio ()" link="FlatpakRemote.html#flatpak-remote-get-prio"/> + <keyword type="function" name="flatpak_remote_set_prio ()" link="FlatpakRemote.html#flatpak-remote-set-prio"/> + <keyword type="function" name="flatpak_remote_get_title ()" link="FlatpakRemote.html#flatpak-remote-get-title"/> + <keyword type="function" name="flatpak_remote_set_title ()" link="FlatpakRemote.html#flatpak-remote-set-title"/> + <keyword type="function" name="flatpak_remote_get_url ()" link="FlatpakRemote.html#flatpak-remote-get-url"/> + <keyword type="function" name="flatpak_remote_set_url ()" link="FlatpakRemote.html#flatpak-remote-set-url"/> + <keyword type="function" name="flatpak_remote_get_disabled ()" link="FlatpakRemote.html#flatpak-remote-get-disabled"/> + <keyword type="function" name="flatpak_remote_set_disabled ()" link="FlatpakRemote.html#flatpak-remote-set-disabled"/> + <keyword type="struct" name="struct FlatpakRemote" link="FlatpakRemote.html#FlatpakRemote-struct"/> + <keyword type="property" name="The “name” property" link="FlatpakRemote.html#FlatpakRemote--name"/> + <keyword type="function" name="flatpak_bundle_ref_new ()" link="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-new"/> + <keyword type="function" name="flatpak_bundle_ref_get_file ()" link="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-get-file"/> + <keyword type="function" name="flatpak_bundle_ref_get_metadata ()" link="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-get-metadata"/> + <keyword type="function" name="flatpak_bundle_ref_get_appstream ()" link="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-get-appstream"/> + <keyword type="function" name="flatpak_bundle_ref_get_icon ()" link="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-get-icon"/> + <keyword type="function" name="flatpak_bundle_ref_get_origin ()" link="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-get-origin"/> + <keyword type="function" name="flatpak_bundle_ref_get_installed_size ()" link="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-get-installed-size"/> + <keyword type="struct" name="struct FlatpakBundleRef" link="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef-struct"/> + <keyword type="property" name="The “file” property" link="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef--file"/> + <keyword type="function" name="flatpak_error_quark ()" link="flatpak-Error-codes.html#flatpak-error-quark"/> + <keyword type="macro" name="FLATPAK_ERROR" link="flatpak-Error-codes.html#FLATPAK-ERROR:CAPS"/> + <keyword type="enum" name="enum FlatpakError" link="flatpak-Error-codes.html#FlatpakError"/> + <keyword type="macro" name="FLATPAK_MAJOR_VERSION" link="flatpak-Version-information.html#FLATPAK-MAJOR-VERSION:CAPS"/> + <keyword type="macro" name="FLATPAK_MINOR_VERSION" link="flatpak-Version-information.html#FLATPAK-MINOR-VERSION:CAPS"/> + <keyword type="macro" name="FLATPAK_MICRO_VERSION" link="flatpak-Version-information.html#FLATPAK-MICRO-VERSION:CAPS"/> + <keyword type="macro" name="FLATPAK_EXTERN" link="flatpak-Version-information.html#FLATPAK-EXTERN:CAPS"/> + <keyword type="constant" name="FLATPAK_UPDATE_FLAGS_NONE" link="FlatpakInstallation.html#FLATPAK-UPDATE-FLAGS-NONE:CAPS"/> + <keyword type="constant" name="FLATPAK_UPDATE_FLAGS_NO_DEPLOY" link="FlatpakInstallation.html#FLATPAK-UPDATE-FLAGS-NO-DEPLOY:CAPS"/> + <keyword type="constant" name="FLATPAK_UPDATE_FLAGS_NO_PULL" link="FlatpakInstallation.html#FLATPAK-UPDATE-FLAGS-NO-PULL:CAPS"/> + <keyword type="constant" name="FLATPAK_REF_KIND_APP" link="FlatpakRef.html#FLATPAK-REF-KIND-APP:CAPS"/> + <keyword type="constant" name="FLATPAK_REF_KIND_RUNTIME" link="FlatpakRef.html#FLATPAK-REF-KIND-RUNTIME:CAPS"/> + <keyword type="constant" name="FLATPAK_ERROR_ALREADY_INSTALLED" link="flatpak-Error-codes.html#FLATPAK-ERROR-ALREADY-INSTALLED:CAPS"/> + <keyword type="constant" name="FLATPAK_ERROR_NOT_INSTALLED" link="flatpak-Error-codes.html#FLATPAK-ERROR-NOT-INSTALLED:CAPS"/> + </functions> +</book> diff --git a/reference/html/full-api-index.html b/reference/html/full-api-index.html new file mode 100644 index 00000000..dfba9196 --- /dev/null +++ b/reference/html/full-api-index.html @@ -0,0 +1,439 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>API Index: Flatpak Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Flatpak Library Reference Manual"> +<link rel="up" href="index.html" title="Flatpak Library Reference Manual"> +<link rel="prev" href="object-tree.html" title="Object Hierarchy"> +<link rel="next" href="annotation-glossary.html" title="Annotation Glossary"> +<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"><span id="nav_index"><a class="shortcut" href="#idxB">B</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxE">E</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxG">G</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxI">I</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxM">M</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxP">P</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxR">R</a> + <span class="dim">|</span> + <a class="shortcut" href="#idxU">U</a></span></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="object-tree.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="annotation-glossary.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="index"> +<div class="titlepage"><div><div><h1 class="title"> +<a name="full-api-index"></a>API Index</h1></div></div></div> +<a name="idx"></a><a name="idxB"></a><h3 class="title">B</h3> +<dt> +<a class="link" href="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef-struct" title="struct FlatpakBundleRef">FlatpakBundleRef</a>, struct in <a class="link" href="flatpak-flatpak-bundle-ref.html" title="flatpak-bundle-ref">flatpak-bundle-ref</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef--file" title="The “file” property">FlatpakBundleRef:file</a>, object property in <a class="link" href="flatpak-flatpak-bundle-ref.html" title="flatpak-bundle-ref">flatpak-bundle-ref</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-get-appstream" title="flatpak_bundle_ref_get_appstream ()">flatpak_bundle_ref_get_appstream</a>, function in <a class="link" href="flatpak-flatpak-bundle-ref.html" title="flatpak-bundle-ref">flatpak-bundle-ref</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-get-file" title="flatpak_bundle_ref_get_file ()">flatpak_bundle_ref_get_file</a>, function in <a class="link" href="flatpak-flatpak-bundle-ref.html" title="flatpak-bundle-ref">flatpak-bundle-ref</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-get-icon" title="flatpak_bundle_ref_get_icon ()">flatpak_bundle_ref_get_icon</a>, function in <a class="link" href="flatpak-flatpak-bundle-ref.html" title="flatpak-bundle-ref">flatpak-bundle-ref</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-get-installed-size" title="flatpak_bundle_ref_get_installed_size ()">flatpak_bundle_ref_get_installed_size</a>, function in <a class="link" href="flatpak-flatpak-bundle-ref.html" title="flatpak-bundle-ref">flatpak-bundle-ref</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-get-metadata" title="flatpak_bundle_ref_get_metadata ()">flatpak_bundle_ref_get_metadata</a>, function in <a class="link" href="flatpak-flatpak-bundle-ref.html" title="flatpak-bundle-ref">flatpak-bundle-ref</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-get-origin" title="flatpak_bundle_ref_get_origin ()">flatpak_bundle_ref_get_origin</a>, function in <a class="link" href="flatpak-flatpak-bundle-ref.html" title="flatpak-bundle-ref">flatpak-bundle-ref</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="flatpak-flatpak-bundle-ref.html#flatpak-bundle-ref-new" title="flatpak_bundle_ref_new ()">flatpak_bundle_ref_new</a>, function in <a class="link" href="flatpak-flatpak-bundle-ref.html" title="flatpak-bundle-ref">flatpak-bundle-ref</a> +</dt> +<dd></dd> +<a name="idxE"></a><h3 class="title">E</h3> +<dt> +<a class="link" href="flatpak-Error-codes.html#FLATPAK-ERROR:CAPS" title="FLATPAK_ERROR">FLATPAK_ERROR</a>, macro in <a class="link" href="flatpak-Error-codes.html" title="Error codes">Error codes</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="flatpak-Error-codes.html#FlatpakError" title="enum FlatpakError">FlatpakError</a>, enum in <a class="link" href="flatpak-Error-codes.html" title="Error codes">Error codes</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="flatpak-Error-codes.html#flatpak-error-quark" title="flatpak_error_quark ()">flatpak_error_quark</a>, function in <a class="link" href="flatpak-Error-codes.html" title="Error codes">Error codes</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="flatpak-Version-information.html#FLATPAK-EXTERN:CAPS" title="FLATPAK_EXTERN">FLATPAK_EXTERN</a>, macro in <a class="link" href="flatpak-Version-information.html" title="Version information">Version information</a> +</dt> +<dd></dd> +<a name="idxG"></a><h3 class="title">G</h3> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-get-default-arch" title="flatpak_get_default_arch ()">flatpak_get_default_arch</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<a name="idxI"></a><h3 class="title">I</h3> +<dt> +<a class="link" href="FlatpakInstallation.html#FlatpakInstallation-struct" title="struct FlatpakInstallation">FlatpakInstallation</a>, struct in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-create-monitor" title="flatpak_installation_create_monitor ()">flatpak_installation_create_monitor</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-drop-caches" title="flatpak_installation_drop_caches ()">flatpak_installation_drop_caches</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-fetch-remote-metadata-sync" title="flatpak_installation_fetch_remote_metadata_sync ()">flatpak_installation_fetch_remote_metadata_sync</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-fetch-remote-ref-sync" title="flatpak_installation_fetch_remote_ref_sync ()">flatpak_installation_fetch_remote_ref_sync</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-fetch-remote-size-sync" title="flatpak_installation_fetch_remote_size_sync ()">flatpak_installation_fetch_remote_size_sync</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-get-current-installed-app" title="flatpak_installation_get_current_installed_app ()">flatpak_installation_get_current_installed_app</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-get-installed-ref" title="flatpak_installation_get_installed_ref ()">flatpak_installation_get_installed_ref</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-get-is-user" title="flatpak_installation_get_is_user ()">flatpak_installation_get_is_user</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-get-path" title="flatpak_installation_get_path ()">flatpak_installation_get_path</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-get-remote-by-name" title="flatpak_installation_get_remote_by_name ()">flatpak_installation_get_remote_by_name</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-install" title="flatpak_installation_install ()">flatpak_installation_install</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-install-bundle" title="flatpak_installation_install_bundle ()">flatpak_installation_install_bundle</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-launch" title="flatpak_installation_launch ()">flatpak_installation_launch</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-list-installed-refs" title="flatpak_installation_list_installed_refs ()">flatpak_installation_list_installed_refs</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-list-installed-refs-by-kind" title="flatpak_installation_list_installed_refs_by_kind ()">flatpak_installation_list_installed_refs_by_kind</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-list-installed-refs-for-update" title="flatpak_installation_list_installed_refs_for_update ()">flatpak_installation_list_installed_refs_for_update</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-list-remotes" title="flatpak_installation_list_remotes ()">flatpak_installation_list_remotes</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-list-remote-refs-sync" title="flatpak_installation_list_remote_refs_sync ()">flatpak_installation_list_remote_refs_sync</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-load-app-overrides" title="flatpak_installation_load_app_overrides ()">flatpak_installation_load_app_overrides</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-modify-remote" title="flatpak_installation_modify_remote ()">flatpak_installation_modify_remote</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-new-for-path" title="flatpak_installation_new_for_path ()">flatpak_installation_new_for_path</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-new-system" title="flatpak_installation_new_system ()">flatpak_installation_new_system</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-new-user" title="flatpak_installation_new_user ()">flatpak_installation_new_user</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-remove-remote" title="flatpak_installation_remove_remote ()">flatpak_installation_remove_remote</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-uninstall" title="flatpak_installation_uninstall ()">flatpak_installation_uninstall</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-update" title="flatpak_installation_update ()">flatpak_installation_update</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstallation.html#flatpak-installation-update-appstream-sync" title="flatpak_installation_update_appstream_sync ()">flatpak_installation_update_appstream_sync</a>, function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstalledRef.html#FlatpakInstalledRef-struct" title="struct FlatpakInstalledRef">FlatpakInstalledRef</a>, struct in <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef">FlatpakInstalledRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstalledRef.html#FlatpakInstalledRef--deploy-dir" title="The “deploy-dir” property">FlatpakInstalledRef:deploy-dir</a>, object property in <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef">FlatpakInstalledRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstalledRef.html#FlatpakInstalledRef--installed-size" title="The “installed-size” property">FlatpakInstalledRef:installed-size</a>, object property in <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef">FlatpakInstalledRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstalledRef.html#FlatpakInstalledRef--is-current" title="The “is-current” property">FlatpakInstalledRef:is-current</a>, object property in <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef">FlatpakInstalledRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstalledRef.html#FlatpakInstalledRef--latest-commit" title="The “latest-commit” property">FlatpakInstalledRef:latest-commit</a>, object property in <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef">FlatpakInstalledRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstalledRef.html#FlatpakInstalledRef--origin" title="The “origin” property">FlatpakInstalledRef:origin</a>, object property in <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef">FlatpakInstalledRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstalledRef.html#FlatpakInstalledRef--subpaths" title="The “subpaths” property">FlatpakInstalledRef:subpaths</a>, object property in <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef">FlatpakInstalledRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstalledRef.html#flatpak-installed-ref-get-deploy-dir" title="flatpak_installed_ref_get_deploy_dir ()">flatpak_installed_ref_get_deploy_dir</a>, function in <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef">FlatpakInstalledRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstalledRef.html#flatpak-installed-ref-get-installed-size" title="flatpak_installed_ref_get_installed_size ()">flatpak_installed_ref_get_installed_size</a>, function in <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef">FlatpakInstalledRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstalledRef.html#flatpak-installed-ref-get-is-current" title="flatpak_installed_ref_get_is_current ()">flatpak_installed_ref_get_is_current</a>, function in <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef">FlatpakInstalledRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstalledRef.html#flatpak-installed-ref-get-latest-commit" title="flatpak_installed_ref_get_latest_commit ()">flatpak_installed_ref_get_latest_commit</a>, function in <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef">FlatpakInstalledRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstalledRef.html#flatpak-installed-ref-get-origin" title="flatpak_installed_ref_get_origin ()">flatpak_installed_ref_get_origin</a>, function in <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef">FlatpakInstalledRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstalledRef.html#flatpak-installed-ref-get-subpaths" title="flatpak_installed_ref_get_subpaths ()">flatpak_installed_ref_get_subpaths</a>, function in <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef">FlatpakInstalledRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakInstalledRef.html#flatpak-installed-ref-load-metadata" title="flatpak_installed_ref_load_metadata ()">flatpak_installed_ref_load_metadata</a>, function in <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef">FlatpakInstalledRef</a> +</dt> +<dd></dd> +<a name="idxM"></a><h3 class="title">M</h3> +<dt> +<a class="link" href="flatpak-Version-information.html#FLATPAK-MAJOR-VERSION:CAPS" title="FLATPAK_MAJOR_VERSION">FLATPAK_MAJOR_VERSION</a>, macro in <a class="link" href="flatpak-Version-information.html" title="Version information">Version information</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="flatpak-Version-information.html#FLATPAK-MICRO-VERSION:CAPS" title="FLATPAK_MICRO_VERSION">FLATPAK_MICRO_VERSION</a>, macro in <a class="link" href="flatpak-Version-information.html" title="Version information">Version information</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="flatpak-Version-information.html#FLATPAK-MINOR-VERSION:CAPS" title="FLATPAK_MINOR_VERSION">FLATPAK_MINOR_VERSION</a>, macro in <a class="link" href="flatpak-Version-information.html" title="Version information">Version information</a> +</dt> +<dd></dd> +<a name="idxP"></a><h3 class="title">P</h3> +<dt> +<a class="link" href="FlatpakInstallation.html#FlatpakProgressCallback" title="FlatpakProgressCallback ()">FlatpakProgressCallback</a>, user_function in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +<a name="idxR"></a><h3 class="title">R</h3> +<dt> +<a class="link" href="FlatpakRef.html#FlatpakRef-struct" title="struct FlatpakRef">FlatpakRef</a>, struct in <a class="link" href="FlatpakRef.html" title="FlatpakRef">FlatpakRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRef.html#FlatpakRef--arch" title="The “arch” property">FlatpakRef:arch</a>, object property in <a class="link" href="FlatpakRef.html" title="FlatpakRef">FlatpakRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRef.html#FlatpakRef--branch" title="The “branch” property">FlatpakRef:branch</a>, object property in <a class="link" href="FlatpakRef.html" title="FlatpakRef">FlatpakRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRef.html#FlatpakRef--commit" title="The “commit” property">FlatpakRef:commit</a>, object property in <a class="link" href="FlatpakRef.html" title="FlatpakRef">FlatpakRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRef.html#FlatpakRef--kind" title="The “kind” property">FlatpakRef:kind</a>, object property in <a class="link" href="FlatpakRef.html" title="FlatpakRef">FlatpakRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRef.html#FlatpakRef--name" title="The “name” property">FlatpakRef:name</a>, object property in <a class="link" href="FlatpakRef.html" title="FlatpakRef">FlatpakRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRef.html#FlatpakRefKind" title="enum FlatpakRefKind">FlatpakRefKind</a>, enum in <a class="link" href="FlatpakRef.html" title="FlatpakRef">FlatpakRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRef.html#flatpak-ref-format-ref" title="flatpak_ref_format_ref ()">flatpak_ref_format_ref</a>, function in <a class="link" href="FlatpakRef.html" title="FlatpakRef">FlatpakRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRef.html#flatpak-ref-get-arch" title="flatpak_ref_get_arch ()">flatpak_ref_get_arch</a>, function in <a class="link" href="FlatpakRef.html" title="FlatpakRef">FlatpakRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRef.html#flatpak-ref-get-branch" title="flatpak_ref_get_branch ()">flatpak_ref_get_branch</a>, function in <a class="link" href="FlatpakRef.html" title="FlatpakRef">FlatpakRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRef.html#flatpak-ref-get-commit" title="flatpak_ref_get_commit ()">flatpak_ref_get_commit</a>, function in <a class="link" href="FlatpakRef.html" title="FlatpakRef">FlatpakRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRef.html#flatpak-ref-get-kind" title="flatpak_ref_get_kind ()">flatpak_ref_get_kind</a>, function in <a class="link" href="FlatpakRef.html" title="FlatpakRef">FlatpakRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRef.html#flatpak-ref-get-name" title="flatpak_ref_get_name ()">flatpak_ref_get_name</a>, function in <a class="link" href="FlatpakRef.html" title="FlatpakRef">FlatpakRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRef.html#flatpak-ref-parse" title="flatpak_ref_parse ()">flatpak_ref_parse</a>, function in <a class="link" href="FlatpakRef.html" title="FlatpakRef">FlatpakRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemote.html#FlatpakRemote-struct" title="struct FlatpakRemote">FlatpakRemote</a>, struct in <a class="link" href="FlatpakRemote.html" title="FlatpakRemote">FlatpakRemote</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemote.html#FlatpakRemote--name" title="The “name” property">FlatpakRemote:name</a>, object property in <a class="link" href="FlatpakRemote.html" title="FlatpakRemote">FlatpakRemote</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemoteRef.html#FlatpakRemoteRef-struct" title="struct FlatpakRemoteRef">FlatpakRemoteRef</a>, struct in <a class="link" href="FlatpakRemoteRef.html" title="FlatpakRemoteRef">FlatpakRemoteRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemoteRef.html#FlatpakRemoteRef--remote-name" title="The “remote-name” property">FlatpakRemoteRef:remote-name</a>, object property in <a class="link" href="FlatpakRemoteRef.html" title="FlatpakRemoteRef">FlatpakRemoteRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemote.html#flatpak-remote-get-appstream-dir" title="flatpak_remote_get_appstream_dir ()">flatpak_remote_get_appstream_dir</a>, function in <a class="link" href="FlatpakRemote.html" title="FlatpakRemote">FlatpakRemote</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemote.html#flatpak-remote-get-appstream-timestamp" title="flatpak_remote_get_appstream_timestamp ()">flatpak_remote_get_appstream_timestamp</a>, function in <a class="link" href="FlatpakRemote.html" title="FlatpakRemote">FlatpakRemote</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemote.html#flatpak-remote-get-disabled" title="flatpak_remote_get_disabled ()">flatpak_remote_get_disabled</a>, function in <a class="link" href="FlatpakRemote.html" title="FlatpakRemote">FlatpakRemote</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemote.html#flatpak-remote-get-gpg-verify" title="flatpak_remote_get_gpg_verify ()">flatpak_remote_get_gpg_verify</a>, function in <a class="link" href="FlatpakRemote.html" title="FlatpakRemote">FlatpakRemote</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemote.html#flatpak-remote-get-name" title="flatpak_remote_get_name ()">flatpak_remote_get_name</a>, function in <a class="link" href="FlatpakRemote.html" title="FlatpakRemote">FlatpakRemote</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemote.html#flatpak-remote-get-noenumerate" title="flatpak_remote_get_noenumerate ()">flatpak_remote_get_noenumerate</a>, function in <a class="link" href="FlatpakRemote.html" title="FlatpakRemote">FlatpakRemote</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemote.html#flatpak-remote-get-prio" title="flatpak_remote_get_prio ()">flatpak_remote_get_prio</a>, function in <a class="link" href="FlatpakRemote.html" title="FlatpakRemote">FlatpakRemote</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemote.html#flatpak-remote-get-title" title="flatpak_remote_get_title ()">flatpak_remote_get_title</a>, function in <a class="link" href="FlatpakRemote.html" title="FlatpakRemote">FlatpakRemote</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemote.html#flatpak-remote-get-url" title="flatpak_remote_get_url ()">flatpak_remote_get_url</a>, function in <a class="link" href="FlatpakRemote.html" title="FlatpakRemote">FlatpakRemote</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemote.html#flatpak-remote-new" title="flatpak_remote_new ()">flatpak_remote_new</a>, function in <a class="link" href="FlatpakRemote.html" title="FlatpakRemote">FlatpakRemote</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemoteRef.html#flatpak-remote-ref-get-remote-name" title="flatpak_remote_ref_get_remote_name ()">flatpak_remote_ref_get_remote_name</a>, function in <a class="link" href="FlatpakRemoteRef.html" title="FlatpakRemoteRef">FlatpakRemoteRef</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemote.html#flatpak-remote-set-disabled" title="flatpak_remote_set_disabled ()">flatpak_remote_set_disabled</a>, function in <a class="link" href="FlatpakRemote.html" title="FlatpakRemote">FlatpakRemote</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemote.html#flatpak-remote-set-gpg-key" title="flatpak_remote_set_gpg_key ()">flatpak_remote_set_gpg_key</a>, function in <a class="link" href="FlatpakRemote.html" title="FlatpakRemote">FlatpakRemote</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemote.html#flatpak-remote-set-gpg-verify" title="flatpak_remote_set_gpg_verify ()">flatpak_remote_set_gpg_verify</a>, function in <a class="link" href="FlatpakRemote.html" title="FlatpakRemote">FlatpakRemote</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemote.html#flatpak-remote-set-noenumerate" title="flatpak_remote_set_noenumerate ()">flatpak_remote_set_noenumerate</a>, function in <a class="link" href="FlatpakRemote.html" title="FlatpakRemote">FlatpakRemote</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemote.html#flatpak-remote-set-prio" title="flatpak_remote_set_prio ()">flatpak_remote_set_prio</a>, function in <a class="link" href="FlatpakRemote.html" title="FlatpakRemote">FlatpakRemote</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemote.html#flatpak-remote-set-title" title="flatpak_remote_set_title ()">flatpak_remote_set_title</a>, function in <a class="link" href="FlatpakRemote.html" title="FlatpakRemote">FlatpakRemote</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="FlatpakRemote.html#flatpak-remote-set-url" title="flatpak_remote_set_url ()">flatpak_remote_set_url</a>, function in <a class="link" href="FlatpakRemote.html" title="FlatpakRemote">FlatpakRemote</a> +</dt> +<dd></dd> +<a name="idxU"></a><h3 class="title">U</h3> +<dt> +<a class="link" href="FlatpakInstallation.html#FlatpakUpdateFlags" title="enum FlatpakUpdateFlags">FlatpakUpdateFlags</a>, enum in <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> +</dt> +<dd></dd> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25.1</div> +</body> +</html>
\ No newline at end of file diff --git a/reference/html/home.png b/reference/html/home.png Binary files differnew file mode 100644 index 00000000..9346b336 --- /dev/null +++ b/reference/html/home.png diff --git a/reference/html/index.html b/reference/html/index.html new file mode 100644 index 00000000..52013ede --- /dev/null +++ b/reference/html/index.html @@ -0,0 +1,60 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Flatpak Library Reference Manual: Flatpak Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Flatpak Library Reference Manual"> +<link rel="next" href="ch01.html" title="Flatpak"> +<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<div class="book"> +<div class="titlepage"> +<div> +<div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">Flatpak Library Reference Manual</p></th></tr></table></div> +<div><p class="releaseinfo"> + For flatpak 0.6.7 + + </p></div> +</div> +<hr> +</div> +<div class="toc"><dl class="toc"> +<dt><span class="chapter"><a href="ch01.html">Flatpak</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="FlatpakInstallation.html">FlatpakInstallation</a></span><span class="refpurpose"> — Installation information</span> +</dt> +<dt> +<span class="refentrytitle"><a href="FlatpakRef.html">FlatpakRef</a></span><span class="refpurpose"> — Application reference</span> +</dt> +<dt> +<span class="refentrytitle"><a href="FlatpakInstalledRef.html">FlatpakInstalledRef</a></span><span class="refpurpose"> — Installed application reference</span> +</dt> +<dt> +<span class="refentrytitle"><a href="FlatpakRemoteRef.html">FlatpakRemoteRef</a></span><span class="refpurpose"> — Remote application reference</span> +</dt> +<dt> +<span class="refentrytitle"><a href="FlatpakRemote.html">FlatpakRemote</a></span><span class="refpurpose"> — Remote repository</span> +</dt> +<dt> +<span class="refentrytitle"><a href="flatpak-flatpak-bundle-ref.html">flatpak-bundle-ref</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="flatpak-Error-codes.html">Error codes</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="flatpak-Version-information.html">Version information</a></span><span class="refpurpose"></span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="object-tree.html">Object Hierarchy</a></span></dt> +<dt><span class="index"><a href="full-api-index.html">API Index</a></span></dt> +<dt><span class="glossary"><a href="annotation-glossary.html">Annotation Glossary</a></span></dt> +</dl></div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25.1</div> +</body> +</html>
\ No newline at end of file diff --git a/reference/html/left-insensitive.png b/reference/html/left-insensitive.png Binary files differnew file mode 100644 index 00000000..3269393a --- /dev/null +++ b/reference/html/left-insensitive.png diff --git a/reference/html/left.png b/reference/html/left.png Binary files differnew file mode 100644 index 00000000..2abde032 --- /dev/null +++ b/reference/html/left.png diff --git a/reference/html/object-tree.html b/reference/html/object-tree.html new file mode 100644 index 00000000..8b123695 --- /dev/null +++ b/reference/html/object-tree.html @@ -0,0 +1,38 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Object Hierarchy: Flatpak Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Flatpak Library Reference Manual"> +<link rel="up" href="index.html" title="Flatpak Library Reference Manual"> +<link rel="prev" href="flatpak-Version-information.html" title="Version information"> +<link rel="next" href="full-api-index.html" title="API Index"> +<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="flatpak-Version-information.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="full-api-index.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h1 class="title"> +<a name="object-tree"></a>Object Hierarchy</h1></div></div></div> +<pre class="screen"> + <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> + <span class="lineart">├──</span> <a class="link" href="FlatpakRef.html" title="FlatpakRef">FlatpakRef</a> + <span class="lineart">│</span> <span class="lineart">├──</span> <a class="link" href="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef">FlatpakBundleRef</a> + <span class="lineart">│</span> <span class="lineart">├──</span> <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef">FlatpakInstalledRef</a> + <span class="lineart">│</span> <span class="lineart">╰──</span> <a class="link" href="FlatpakRemoteRef.html" title="FlatpakRemoteRef">FlatpakRemoteRef</a> + <span class="lineart">├──</span> <a class="link" href="FlatpakInstallation.html" title="FlatpakInstallation">FlatpakInstallation</a> + <span class="lineart">╰──</span> <a class="link" href="FlatpakRemote.html" title="FlatpakRemote">FlatpakRemote</a> +</pre> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25.1</div> +</body> +</html>
\ No newline at end of file diff --git a/reference/html/right-insensitive.png b/reference/html/right-insensitive.png Binary files differnew file mode 100644 index 00000000..4c95785b --- /dev/null +++ b/reference/html/right-insensitive.png diff --git a/reference/html/right.png b/reference/html/right.png Binary files differnew file mode 100644 index 00000000..76260ec8 --- /dev/null +++ b/reference/html/right.png diff --git a/reference/html/style.css b/reference/html/style.css new file mode 100644 index 00000000..36754209 --- /dev/null +++ b/reference/html/style.css @@ -0,0 +1,479 @@ +body +{ + font-family: cantarell, sans-serif; +} +.synopsis, .classsynopsis +{ + /* tango:aluminium 1/2 */ + background: #eeeeec; + background: rgba(238, 238, 236, 0.5); + border: solid 1px rgb(238, 238, 236); + padding: 0.5em; +} +.programlisting +{ + /* tango:sky blue 0/1 */ + /* fallback for no rgba support */ + background: #e6f3ff; + border: solid 1px #729fcf; + background: rgba(114, 159, 207, 0.1); + border: solid 1px rgba(114, 159, 207, 0.2); + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} + +div.gallery-float +{ + float: left; + padding: 10px; +} +div.gallery-float img +{ + border-style: none; +} +div.gallery-spacer +{ + clear: both; +} + +a, a:visited +{ + text-decoration: none; + /* tango:sky blue 2 */ + color: #3465a4; +} +a:hover +{ + text-decoration: underline; + /* tango:sky blue 1 */ + color: #729fcf; +} + +div.informaltable table +{ + border-collapse: separate; + border-spacing: 1em 0.3em; + border: none; +} + +div.informaltable table td, div.informaltable table th +{ + vertical-align: top; +} + +.function_type, +.variable_type, +.property_type, +.signal_type, +.parameter_name, +.struct_member_name, +.union_member_name, +.define_keyword, +.datatype_keyword, +.typedef_keyword +{ + text-align: right; +} + +/* dim non-primary columns */ +.c_punctuation, +.function_type, +.variable_type, +.property_type, +.signal_type, +.define_keyword, +.datatype_keyword, +.typedef_keyword, +.property_flags, +.signal_flags, +.parameter_annotations, +.enum_member_annotations, +.struct_member_annotations, +.union_member_annotations +{ + color: #888a85; +} + +.function_type a, +.function_type a:visited, +.function_type a:hover, +.property_type a, +.property_type a:visited, +.property_type a:hover, +.signal_type a, +.signal_type a:visited, +.signal_type a:hover, +.signal_flags a, +.signal_flags a:visited, +.signal_flags a:hover +{ + color: #729fcf; +} + +td p +{ + margin: 0.25em; +} + +div.table table +{ + border-collapse: collapse; + border-spacing: 0px; + /* tango:aluminium 3 */ + border: solid 1px #babdb6; +} + +div.table table td, div.table table th +{ + /* tango:aluminium 3 */ + border: solid 1px #babdb6; + padding: 3px; + vertical-align: top; +} + +div.table table th +{ + /* tango:aluminium 2 */ + background-color: #d3d7cf; +} + +h4 +{ + color: #555753; + margin-top: 1em; + margin-bottom: 1em; +} + +hr +{ + /* tango:aluminium 1 */ + color: #d3d7cf; + background: #d3d7cf; + border: none 0px; + height: 1px; + clear: both; + margin: 2.0em 0em 2.0em 0em; +} + +dl.toc dt +{ + padding-bottom: 0.25em; +} + +dl.toc > dt +{ + padding-top: 0.25em; + padding-bottom: 0.25em; + font-weight: bold; +} + +dl.toc > dl +{ + padding-bottom: 0.5em; +} + +.parameter +{ + font-style: normal; +} + +.footer +{ + padding-top: 3.5em; + /* tango:aluminium 3 */ + color: #babdb6; + text-align: center; + font-size: 80%; +} + +.informalfigure, +.figure +{ + margin: 1em; +} + +.informalexample, +.example +{ + margin-top: 1em; + margin-bottom: 1em; +} + +.warning +{ + /* tango:orange 0/1 */ + background: #ffeed9; + background: rgba(252, 175, 62, 0.1); + border-color: #ffb04f; + border-color: rgba(252, 175, 62, 0.2); +} +.note +{ + /* tango:chameleon 0/0.5 */ + background: #d8ffb2; + background: rgba(138, 226, 52, 0.1); + border-color: #abf562; + border-color: rgba(138, 226, 52, 0.2); +} +div.blockquote +{ + border-color: #eeeeec; +} +.note, .warning, div.blockquote +{ + padding: 0.5em; + border-width: 1px; + border-style: solid; + margin: 2em; +} +.note p, .warning p +{ + margin: 0; +} + +div.warning h3.title, +div.note h3.title +{ + display: none; +} + +p + div.section +{ + margin-top: 1em; +} + +div.refnamediv, +div.refsynopsisdiv, +div.refsect1, +div.refsect2, +div.toc, +div.section +{ + margin-bottom: 1em; +} + +/* blob links */ +h2 .extralinks, h3 .extralinks +{ + float: right; + /* tango:aluminium 3 */ + color: #babdb6; + font-size: 80%; + font-weight: normal; +} + +.lineart +{ + color: #d3d7cf; + font-weight: normal; +} + +.annotation +{ + /* tango:aluminium 5 */ + color: #555753; + font-weight: normal; +} + +.structfield +{ + font-style: normal; + font-weight: normal; +} + +acronym,abbr +{ + border-bottom: 1px dotted gray; +} + +/* code listings */ + +.listing_code .programlisting .normal, +.listing_code .programlisting .normal a, +.listing_code .programlisting .number, +.listing_code .programlisting .cbracket, +.listing_code .programlisting .symbol { color: #555753; } +.listing_code .programlisting .comment, +.listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */ +.listing_code .programlisting .function, +.listing_code .programlisting .function a, +.listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */ +.listing_code .programlisting .string { color: #ad7fa8; } /* tango: plum */ +.listing_code .programlisting .keyword, +.listing_code .programlisting .usertype, +.listing_code .programlisting .type, +.listing_code .programlisting .type a { color: #4e9a06; } /* tango: chameleon 3 */ + +.listing_frame { + /* tango:sky blue 1 */ + border: solid 1px #729fcf; + border: solid 1px rgba(114, 159, 207, 0.2); + padding: 0px; +} + +.listing_lines, .listing_code { + margin-top: 0px; + margin-bottom: 0px; + padding: 0.5em; +} +.listing_lines { + /* tango:sky blue 0.5 */ + background: #a6c5e3; + background: rgba(114, 159, 207, 0.2); + /* tango:aluminium 6 */ + color: #2e3436; +} +.listing_code { + /* tango:sky blue 0 */ + background: #e6f3ff; + background: rgba(114, 159, 207, 0.1); +} +.listing_code .programlisting { + /* override from previous */ + border: none 0px; + padding: 0px; + background: none; +} +.listing_lines pre, .listing_code pre { + margin: 0px; +} + +@media screen { + /* these have a <sup> as a first child, but since there are no parent selectors + * we can't use that. */ + a.footnote + { + position: relative; + top: 0em ! important; + } + /* this is needed so that the local anchors are displayed below the naviagtion */ + div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] + { + display: inline-block; + position: relative; + top:-5em; + } + /* this seems to be a bug in the xsl style sheets when generating indexes */ + div.index div.index + { + top: 0em; + } + /* make space for the fixed navigation bar and add space at the bottom so that + * link targets appear somewhat close to top + */ + body + { + padding-top: 2.5em; + padding-bottom: 500px; + max-width: 60em; + } + p + { + max-width: 60em; + } + /* style and size the navigation bar */ + table.navigation#top + { + position: fixed; + background: #e2e2e2; + border-bottom: solid 1px #babdb6; + border-spacing: 5px; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + z-index: 10; + } + table.navigation#top td + { + padding-left: 6px; + padding-right: 6px; + } + .navigation a, .navigation a:visited + { + /* tango:sky blue 3 */ + color: #204a87; + } + .navigation a:hover + { + /* tango:sky blue 2 */ + color: #3465a4; + } + td.shortcuts + { + /* tango:sky blue 2 */ + color: #3465a4; + font-size: 80%; + white-space: nowrap; + } + td.shortcuts .dim + { + color: #babdb6; + } + .navigation .title + { + font-size: 80%; + max-width: none; + margin: 0px; + font-weight: normal; + } +} +@media screen and (min-width: 60em) { + /* screen larger than 60em */ + body { margin: auto; } +} +@media screen and (max-width: 60em) { + /* screen less than 60em */ + #nav_hierarchy { display: none; } + #nav_interfaces { display: none; } + #nav_prerequisites { display: none; } + #nav_derived_interfaces { display: none; } + #nav_implementations { display: none; } + #nav_child_properties { display: none; } + #nav_style_properties { display: none; } + #nav_index { display: none; } + #nav_glossary { display: none; } + .gallery_image { display: none; } + .property_flags { display: none; } + .signal_flags { display: none; } + .parameter_annotations { display: none; } + .enum_member_annotations { display: none; } + .struct_member_annotations { display: none; } + .union_member_annotations { display: none; } + /* now that a column is hidden, optimize space */ + col.parameters_name { width: auto; } + col.parameters_description { width: auto; } + col.struct_members_name { width: auto; } + col.struct_members_description { width: auto; } + col.enum_members_name { width: auto; } + col.enum_members_description { width: auto; } + col.union_members_name { width: auto; } + col.union_members_description { width: auto; } + .listing_lines { display: none; } +} +@media print { + table.navigation { + visibility: collapse; + display: none; + } + div.titlepage table.navigation { + visibility: visible; + display: table; + background: #e2e2e2; + border: solid 1px #babdb6; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + } +} + diff --git a/reference/html/up-insensitive.png b/reference/html/up-insensitive.png Binary files differnew file mode 100644 index 00000000..f4049860 --- /dev/null +++ b/reference/html/up-insensitive.png diff --git a/reference/html/up.png b/reference/html/up.png Binary files differnew file mode 100644 index 00000000..80b4b37e --- /dev/null +++ b/reference/html/up.png |
