BossBey File Manager
PHP:
8.2.28
OS:
Linux
User:
www-data
Root
/
usr
/
share
/
doc
/
flatpak
📤 Upload
📝 New File
📁 New Folder
Close
Editing: flatpak-docs.html
<?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 Vsnapshot" /></head><body><div class="reference"><div class="titlepage"><div><div><h1 class="title"><a id="id1337"></a>Flatpak Command Reference</h1></div><div><p class="releaseinfo">Version 1.14.6</p></div></div><hr /></div><div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Important</h3><p> The command reference is generated from the flatpak repo; see <a class="ulink" href="https://github.com/flatpak/flatpak/tree/main/doc" target="_top">https://github.com/flatpak/flatpak/tree/main/doc</a> </p></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="chapter"><a href="#id1338">Executables</a></span></dt><dd><dl><dt><span class="refentrytitle"><a href="#flatpak">flatpak</a></span><span class="refpurpose"> — Build, install and run applications and runtimes</span></dt></dl></dd><dt><span class="chapter"><a href="#id1339">Commands</a></span></dt><dd><dl><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-commit-from">flatpak build-commit-from</a></span><span class="refpurpose"> — Create new commits based on existing one (possibly from another repository)</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-finish">flatpak build-finish</a></span><span class="refpurpose"> — Finalize a build directory</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-init">flatpak build-init</a></span><span class="refpurpose"> — Initialize a build directory</span></dt><dt><span class="refentrytitle"><a href="#flatpak-build-sign">flatpak build-sign</a></span><span class="refpurpose"> — Sign an application or runtime</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">flatpak build</a></span><span class="refpurpose"> — Build in a directory</span></dt><dt><span class="refentrytitle"><a href="#flatpak-config">flatpak config</a></span><span class="refpurpose"> — Manage configuration</span></dt><dt><span class="refentrytitle"><a href="#flatpak-create-usb">flatpak create-usb</a></span><span class="refpurpose"> — Copy apps and/or runtimes onto removable media.</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-info">flatpak document-info</a></span><span class="refpurpose"> — Show information about exported files</span></dt><dt><span class="refentrytitle"><a href="#flatpak-documents">flatpak documents</a></span><span class="refpurpose"> — List exported files</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-enter">flatpak enter</a></span><span class="refpurpose"> — Enter an application or runtime's sandbox</span></dt><dt><span class="refentrytitle"><a href="#flatpak-history">flatpak history</a></span><span class="refpurpose"> — Show history</span></dt><dt><span class="refentrytitle"><a href="#flatpak-info">flatpak info</a></span><span class="refpurpose"> — Show information about an installed application or runtime</span></dt><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-kill">flatpak kill</a></span><span class="refpurpose"> — Stop a running application</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-make-current">flatpak make-current</a></span><span class="refpurpose"> — Make a specific version of an app current</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-permission-remove">flatpak permission-remove</a></span><span class="refpurpose"> — Remove permissions</span></dt><dt><span class="refentrytitle"><a href="#flatpak-permissions">flatpak permissions</a></span><span class="refpurpose"> — List permissions</span></dt><dt><span class="refentrytitle"><a href="#flatpak-permission-show">flatpak permission-show</a></span><span class="refpurpose"> — Show permissions</span></dt><dt><span class="refentrytitle"><a href="#flatpak-permission-reset">flatpak permission-reset</a></span><span class="refpurpose"> — Reset permissions</span></dt><dt><span class="refentrytitle"><a href="#flatpak-permission-set">flatpak permission-set</a></span><span class="refpurpose"> — Set permissions</span></dt><dt><span class="refentrytitle"><a href="#flatpak-ps">flatpak ps</a></span><span class="refpurpose"> — Enumerate running instances</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-delete">flatpak remote-delete</a></span><span class="refpurpose"> — Delete a remote repository</span></dt><dt><span class="refentrytitle"><a href="#flatpak-remote-info">flatpak remote-info</a></span><span class="refpurpose"> — Show information about an application or runtime in a remote</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-remote-modify">flatpak remote-modify</a></span><span class="refpurpose"> — Modify a remote repository</span></dt><dt><span class="refentrytitle"><a href="#flatpak-remotes">flatpak remotes</a></span><span class="refpurpose"> — List remote repositories</span></dt><dt><span class="refentrytitle"><a href="#flatpak-repair">flatpak repair</a></span><span class="refpurpose"> — Repair a flatpak installation</span></dt><dt><span class="refentrytitle"><a href="#flatpak-repo">flatpak repo</a></span><span class="refpurpose"> — Show information about a local repository</span></dt><dt><span class="refentrytitle"><a href="#flatpak-run">flatpak run</a></span><span class="refpurpose"> — Run an application or open a shell in a runtime</span></dt><dt><span class="refentrytitle"><a href="#flatpak-search">flatpak search</a></span><span class="refpurpose"> — Search for applications and runtimes</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-update">flatpak update</a></span><span class="refpurpose"> — Update an application or runtime</span></dt><dt><span class="refentrytitle"><a href="#flatpak-spawn">flatpak spawn</a></span><span class="refpurpose"> — Run commands in a sandbox</span></dt></dl></dd><dt><span class="chapter"><a href="#id1340">File Formats</a></span></dt><dd><dl><dt><span class="refentrytitle"><a href="#flatpak-flatpakrepo">flatpakrepo</a></span><span class="refpurpose"> — Reference to a remote</span></dt><dt><span class="refentrytitle"><a href="#flatpak-flatpakref">flatpakref</a></span><span class="refpurpose"> — Reference to a remote for an application or runtime</span></dt><dt><span class="refentrytitle"><a href="#flatpak-installation">flatpak installation</a></span><span class="refpurpose"> — Configuration for an installation location</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-remote">flatpak remote</a></span><span class="refpurpose"> — Configuration for a remote</span></dt></dl></dd></dl></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="id1338"></a>Executables</h2></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="refentrytitle"><a href="#flatpak">flatpak</a></span><span class="refpurpose"> — Build, install and run applications and runtimes</span></dt></dl></div><div class="refentry"><a id="flatpak"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak — Build, install and run applications and runtimes</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak</code> [OPTION...] {COMMAND}</p></div></div><div class="refsect1"><a id="id1341"></a><h2>Description</h2><p> Flatpak is a tool for managing applications and the runtimes they use. In the Flatpak model, applications can be built and distributed independently from the host system they are used on, and they are isolated from the host system ('sandboxed') to some degree, at runtime. </p><p> Flatpak can operate in system-wide or per-user mode. The system-wide data (runtimes, applications and configuration) is located in <code class="filename">$prefix/var/lib/flatpak/</code>, and the per-user data is in <code class="filename">$HOME/.local/share/flatpak/</code>. Below these locations, there is a local repository in the <code class="filename">repo/</code> subdirectory and installed runtimes and applications are in the corresponding <code class="filename">runtime/</code> and <code class="filename">app/</code> subdirectories. </p><p> System-wide remotes can be statically preconfigured by dropping flatpakrepo files into <code class="filename">/etc/flatpak/remotes.d/</code>. </p><p> In addition to the system-wide installation in <code class="filename">$prefix/var/lib/flatpak/</code>, which is always considered the default one unless overridden, more system-wide installations can be defined via configuration files in <code class="filename">/etc/flatpak/installations.d/</code>, which must define at least the id of the installation and the absolute path to it. Other optional parameters like DisplayName , Priority or StorageType are also supported. </p><p> Flatpak uses OSTree to distribute and deploy data. The repositories it uses are OSTree repositories and can be manipulated with the <span class="command"><strong>ostree</strong></span> utility. Installed runtimes and applications are OSTree checkouts. </p><p> Basic commands for building flatpaks such as build-init, build and build-finish are included in the flatpak utility. For higher-level build support, see the separate <a class="citerefentry" href="#flatpak-builder"><span class="citerefentry"><span class="refentrytitle">flatpak-builder</span>(1)</span></a> tool. </p><p> Flatpak supports installing from sideload repos. These are partial copies of a repository (generated by <span class="command"><strong>flatpak create-usb</strong></span>) that are used as an installation source when offline (and online as a performance improvement). Such repositories are configured by creating symlinks to the sideload sources in the <code class="filename">sideload-repos</code> subdirectory of the installation directory (i.e. typically <code class="filename">/var/lib/flatpak/sideload-repos</code> or <code class="filename">~/.local/share/flatpak/sideload-repos</code>). Additionally symlinks can be created in <code class="filename">/run/flatpak/sideload-repos</code> which is a better location for non-persistent sources (as it is cleared on reboot). These symlinks can point to either the directory given to <span class="command"><strong>flatpak create-usb</strong></span> which by default writes to the subpath <code class="filename">.ostree/repo</code>, or directly to an ostree repo. </p></div><div class="refsect1"><a id="id1342"></a><h2>Options</h2><p> The following global options are understood. Individual commands have their own options. </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> Show debug information during command processing. Use -vv for more detail. </p></dd><dt><span class="term"><code class="option">--ostree-verbose</code></span></dt><dd><p> Show OSTree 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">--default-arch</code></span></dt><dd><p> Print the default arch and exit. </p></dd><dt><span class="term"><code class="option">--supported-arches</code></span></dt><dd><p> Print the supported arches in priority order and exit. </p></dd><dt><span class="term"><code class="option">--gl-drivers</code></span></dt><dd><p> Print the list of active gl drivers and exit. </p></dd><dt><span class="term"><code class="option">--installations</code></span></dt><dd><p> Print paths of system installations and exit. </p></dd><dt><span class="term"><code class="option">--print-system-only</code></span></dt><dd><p> When the <span class="command"><strong>flatpak --print-updated-env</strong></span> command is run, only print the environment for system flatpak installations, not including the user’s home installation. </p></dd><dt><span class="term"><code class="option">--print-updated-env</code></span></dt><dd><p> Print the set of environment variables needed to use flatpaks, amending the current set of environment variables. This is intended to be used in a systemd environment generator, and should not need to be run manually. </p></dd></dl></div></div><div class="refsect1"><a id="id1343"></a><h2>Commands</h2><p>Commands for managing installed applications and runtimes:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><a class="citerefentry" href="#flatpak-install"><span class="citerefentry"><span class="refentrytitle">flatpak-install</span>(1)</span></a></span></dt><dd><p> Install an application or a runtime from a remote or bundle. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-update"><span class="citerefentry"><span class="refentrytitle">flatpak-update</span>(1)</span></a></span></dt><dd><p> Update an installed application or runtime. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-uninstall"><span class="citerefentry"><span class="refentrytitle">flatpak-uninstall</span>(1)</span></a></span></dt><dd><p> Uninstall an installed application or runtime. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-mask"><span class="citerefentry"><span class="refentrytitle">flatpak-mask</span>(1)</span></a></span></dt><dd><p> Mask out updates and automatic installation. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-pin"><span class="citerefentry"><span class="refentrytitle">flatpak-pin</span>(1)</span></a></span></dt><dd><p> Pin runtimes to prevent automatic removal. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-list"><span class="citerefentry"><span class="refentrytitle">flatpak-list</span>(1)</span></a></span></dt><dd><p> List installed applications and/or runtimes. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-info"><span class="citerefentry"><span class="refentrytitle">flatpak-info</span>(1)</span></a></span></dt><dd><p> Show information for an installed application or runtime. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-history"><span class="citerefentry"><span class="refentrytitle">flatpak-history</span>(1)</span></a></span></dt><dd><p> Show history. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-config"><span class="citerefentry"><span class="refentrytitle">flatpak-config</span>(1)</span></a></span></dt><dd><p> Manage flatpak configuration. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-repair"><span class="citerefentry"><span class="refentrytitle">flatpak-repair</span>(1)</span></a></span></dt><dd><p> Repair flatpak installation. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-create-usb"><span class="citerefentry"><span class="refentrytitle">flatpak-create-usb</span>(1)</span></a></span></dt><dd><p> Copy apps and/or runtimes onto removable media. </p></dd></dl></div><p>Commands for finding applications and runtimes:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><a class="citerefentry" href="#flatpak-search"><span class="citerefentry"><span class="refentrytitle">flatpak-search</span>(1)</span></a></span></dt><dd><p> Search for applications and runtimes. </p></dd></dl></div><p>Commands for managing running applications:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><a class="citerefentry" href="#flatpak-run"><span class="citerefentry"><span class="refentrytitle">flatpak-run</span>(1)</span></a></span></dt><dd><p> Run an application. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-kill"><span class="citerefentry"><span class="refentrytitle">flatpak-kill</span>(1)</span></a></span></dt><dd><p> Stop a running application. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-override"><span class="citerefentry"><span class="refentrytitle">flatpak-override</span>(1)</span></a></span></dt><dd><p> Override permissions for an application. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-make-current"><span class="citerefentry"><span class="refentrytitle">flatpak-make-current</span>(1)</span></a></span></dt><dd><p> Specify the default version to run. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-enter"><span class="citerefentry"><span class="refentrytitle">flatpak-enter</span>(1)</span></a></span></dt><dd><p> Enter the namespace of a running application. </p></dd></dl></div><p>Commands for managing file access:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><a class="citerefentry" href="#flatpak-document-export"><span class="citerefentry"><span class="refentrytitle">flatpak-document-export</span>(1)</span></a></span></dt><dd><p> Grant an application access to a specific file. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-document-unexport"><span class="citerefentry"><span class="refentrytitle">flatpak-document-unexport</span>(1)</span></a></span></dt><dd><p> Revoke access to a specific file. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-document-info"><span class="citerefentry"><span class="refentrytitle">flatpak-document-info</span>(1)</span></a></span></dt><dd><p> Show information about a specific file. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-documents"><span class="citerefentry"><span class="refentrytitle">flatpak-documents</span>(1)</span></a></span></dt><dd><p> List exported files. </p></dd></dl></div><p>Commands for managing the dynamic permission store:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><a class="citerefentry" href="#flatpak-permission-remove"><span class="citerefentry"><span class="refentrytitle">flatpak-permission-remove</span>(1)</span></a></span></dt><dd><p> Remove item from permission store. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-permissions"><span class="citerefentry"><span class="refentrytitle">flatpak-permissions</span>(1)</span></a></span></dt><dd><p> List permissions. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-permission-show"><span class="citerefentry"><span class="refentrytitle">flatpak-permission-show</span>(1)</span></a></span></dt><dd><p> Show app permissions. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-permission-reset"><span class="citerefentry"><span class="refentrytitle">flatpak-permission-reset</span>(1)</span></a></span></dt><dd><p> Reset app permissions. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-permission-set"><span class="citerefentry"><span class="refentrytitle">flatpak-permission-set</span>(1)</span></a></span></dt><dd><p> Set app permissions. </p></dd></dl></div><p>Commands for managing remote repositories:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><a class="citerefentry" href="#flatpak-remotes"><span class="citerefentry"><span class="refentrytitle">flatpak-remotes</span>(1)</span></a></span></dt><dd><p> List all configured remote repositories. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-remote-add"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-add</span>(1)</span></a></span></dt><dd><p> Add a new remote repository. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-remote-modify"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-modify</span>(1)</span></a></span></dt><dd><p> Modify properties of a configured remote repository. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-remote-delete"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-delete</span>(1)</span></a></span></dt><dd><p> Delete a configured remote repository. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-remote-ls"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-ls</span>(1)</span></a></span></dt><dd><p> List contents of a configured remote repository. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-remote-info"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-info</span>(1)</span></a></span></dt><dd><p> Show information about a ref in a configured remote repository. </p></dd></dl></div><p>Commands for building applications:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><a class="citerefentry" href="#flatpak-build-init"><span class="citerefentry"><span class="refentrytitle">flatpak-build-init</span>(1)</span></a></span></dt><dd><p> Initialize a build directory. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-build"><span class="citerefentry"><span class="refentrytitle">flatpak-build</span>(1)</span></a></span></dt><dd><p> Run a build command in a build directory. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-build-finish"><span class="citerefentry"><span class="refentrytitle">flatpak-build-finish</span>(1)</span></a></span></dt><dd><p> Finalizes a build directory for export. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-build-export"><span class="citerefentry"><span class="refentrytitle">flatpak-build-export</span>(1)</span></a></span></dt><dd><p> Export a build directory to a repository. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-build-bundle"><span class="citerefentry"><span class="refentrytitle">flatpak-build-bundle</span>(1)</span></a></span></dt><dd><p> Create a bundle file from a ref in a local repository. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-build-import-bundle"><span class="citerefentry"><span class="refentrytitle">flatpak-build-import-bundle</span>(1)</span></a></span></dt><dd><p> Import a file bundle into a local repository. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-build-sign"><span class="citerefentry"><span class="refentrytitle">flatpak-build-sign</span>(1)</span></a></span></dt><dd><p> Sign an application or runtime after its been exported. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-build-update-repo"><span class="citerefentry"><span class="refentrytitle">flatpak-build-update-repo</span>(1)</span></a></span></dt><dd><p> Update the summary file in a repository. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-build-commit-from"><span class="citerefentry"><span class="refentrytitle">flatpak-build-commit-from</span>(1)</span></a></span></dt><dd><p> Create a new commit based on an existing ref. </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-repo"><span class="citerefentry"><span class="refentrytitle">flatpak-repo</span>(1)</span></a></span></dt><dd><p> Print information about a repo. </p></dd></dl></div><p>Commands available inside the sandbox:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><a class="citerefentry" href="#flatpak-spawn"><span class="citerefentry"><span class="refentrytitle">flatpak-spawn</span>(1)</span></a></span></dt><dd><p> Run a command in another sandbox. </p></dd></dl></div></div><div class="refsect1"><a id="id1344"></a><h2>File formats</h2><p>File formats that are used by Flatpak commands:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><a class="citerefentry" href="#flatpak-flatpakref"><span class="citerefentry"><span class="refentrytitle">flatpak-flatpakref</span>(5)</span></a></span></dt><dd><p> Reference to a remote for an application or runtime </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-flatpakrepo"><span class="citerefentry"><span class="refentrytitle">flatpak-flatpakrepo</span>(5)</span></a></span></dt><dd><p> Reference to a remote </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-remote"><span class="citerefentry"><span class="refentrytitle">flatpak-remote</span>(5)</span></a></span></dt><dd><p> Configuration for a remote </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-installation"><span class="citerefentry"><span class="refentrytitle">flatpak-installation</span>(5)</span></a></span></dt><dd><p> Configuration for an installation location </p></dd><dt><span class="term"><a class="citerefentry" href="#flatpak-metadata"><span class="citerefentry"><span class="refentrytitle">flatpak-metadata</span>(5)</span></a></span></dt><dd><p> Information about an application or runtime </p></dd></dl></div></div><div class="refsect1"><a id="id1345"></a><h2>Environment</h2><p> Besides standard environment variables such as <code class="envar">XDG_DATA_DIRS</code> and <code class="envar">XDG_DATA_HOME</code>, flatpak is consulting some of its own. </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="envar">FLATPAK_USER_DIR</code></span></dt><dd><p> The location of the per-user installation. If this is not set, <code class="filename">$XDG_DATA_HOME/flatpak</code> is used. </p></dd><dt><span class="term"><code class="envar">FLATPAK_SYSTEM_DIR</code></span></dt><dd><p> The location of the default system-wide installation. If this is not set, <code class="filename">/var/lib/flatpak</code> is used (unless overridden at build time by --localstatedir or --with-system-install-dir). </p></dd><dt><span class="term"><code class="envar">FLATPAK_SYSTEM_CACHE_DIR</code></span></dt><dd><p> The location where temporary child repositories will be created during pulls into the system-wide installation. If this is not set, a directory in <code class="filename">/var/tmp/</code> is used. This is useful because it is more likely to be on the same filesystem as the system repository (thus increasing the chances for e.g. reflink copying), and we can avoid filling the user's home directory with temporary data. </p></dd><dt><span class="term"><code class="envar">FLATPAK_CONFIG_DIR</code></span></dt><dd><p> The location of flatpak site configuration. If this is not set, <code class="filename">/etc/flatpak</code> is used (unless overridden at build time by --sysconfdir). </p></dd><dt><span class="term"><code class="envar">FLATPAK_RUN_DIR</code></span></dt><dd><p> The location of flatpak runtime global files. If this is not set, <code class="filename">/run/flatpak</code> is used. </p></dd></dl></div></div><div class="refsect1"><a id="id1346"></a><h2>See also</h2><p> <a class="citerefentry" href="#ostree"><span class="citerefentry"><span class="refentrytitle">ostree</span>(1)</span></a>, <a class="citerefentry" href="#ostree.repo"><span class="citerefentry"><span class="refentrytitle">ostree.repo</span>(5)</span></a>, <a class="citerefentry" href="#flatpak-remote"><span class="citerefentry"><span class="refentrytitle">flatpak-remote</span>(5)</span></a>, <a class="citerefentry" href="#flatpak-installation"><span class="citerefentry"><span class="refentrytitle">flatpak-installation</span>(5)</span></a>, <a class="ulink" href="https://www.flatpak.org" target="_top">https://www.flatpak.org</a> </p></div></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="id1339"></a>Commands</h2></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><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-commit-from">flatpak build-commit-from</a></span><span class="refpurpose"> — Create new commits based on existing one (possibly from another repository)</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-finish">flatpak build-finish</a></span><span class="refpurpose"> — Finalize a build directory</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-init">flatpak build-init</a></span><span class="refpurpose"> — Initialize a build directory</span></dt><dt><span class="refentrytitle"><a href="#flatpak-build-sign">flatpak build-sign</a></span><span class="refpurpose"> — Sign an application or runtime</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">flatpak build</a></span><span class="refpurpose"> — Build in a directory</span></dt><dt><span class="refentrytitle"><a href="#flatpak-config">flatpak config</a></span><span class="refpurpose"> — Manage configuration</span></dt><dt><span class="refentrytitle"><a href="#flatpak-create-usb">flatpak create-usb</a></span><span class="refpurpose"> — Copy apps and/or runtimes onto removable media.</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-info">flatpak document-info</a></span><span class="refpurpose"> — Show information about exported files</span></dt><dt><span class="refentrytitle"><a href="#flatpak-documents">flatpak documents</a></span><span class="refpurpose"> — List exported files</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-enter">flatpak enter</a></span><span class="refpurpose"> — Enter an application or runtime's sandbox</span></dt><dt><span class="refentrytitle"><a href="#flatpak-history">flatpak history</a></span><span class="refpurpose"> — Show history</span></dt><dt><span class="refentrytitle"><a href="#flatpak-info">flatpak info</a></span><span class="refpurpose"> — Show information about an installed application or runtime</span></dt><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-kill">flatpak kill</a></span><span class="refpurpose"> — Stop a running application</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-make-current">flatpak make-current</a></span><span class="refpurpose"> — Make a specific version of an app current</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-permission-remove">flatpak permission-remove</a></span><span class="refpurpose"> — Remove permissions</span></dt><dt><span class="refentrytitle"><a href="#flatpak-permissions">flatpak permissions</a></span><span class="refpurpose"> — List permissions</span></dt><dt><span class="refentrytitle"><a href="#flatpak-permission-show">flatpak permission-show</a></span><span class="refpurpose"> — Show permissions</span></dt><dt><span class="refentrytitle"><a href="#flatpak-permission-reset">flatpak permission-reset</a></span><span class="refpurpose"> — Reset permissions</span></dt><dt><span class="refentrytitle"><a href="#flatpak-permission-set">flatpak permission-set</a></span><span class="refpurpose"> — Set permissions</span></dt><dt><span class="refentrytitle"><a href="#flatpak-ps">flatpak ps</a></span><span class="refpurpose"> — Enumerate running instances</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-delete">flatpak remote-delete</a></span><span class="refpurpose"> — Delete a remote repository</span></dt><dt><span class="refentrytitle"><a href="#flatpak-remote-info">flatpak remote-info</a></span><span class="refpurpose"> — Show information about an application or runtime in a remote</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-remote-modify">flatpak remote-modify</a></span><span class="refpurpose"> — Modify a remote repository</span></dt><dt><span class="refentrytitle"><a href="#flatpak-remotes">flatpak remotes</a></span><span class="refpurpose"> — List remote repositories</span></dt><dt><span class="refentrytitle"><a href="#flatpak-repair">flatpak repair</a></span><span class="refpurpose"> — Repair a flatpak installation</span></dt><dt><span class="refentrytitle"><a href="#flatpak-repo">flatpak repo</a></span><span class="refpurpose"> — Show information about a local repository</span></dt><dt><span class="refentrytitle"><a href="#flatpak-run">flatpak run</a></span><span class="refpurpose"> — Run an application or open a shell in a runtime</span></dt><dt><span class="refentrytitle"><a href="#flatpak-search">flatpak search</a></span><span class="refpurpose"> — Search for applications and runtimes</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-update">flatpak update</a></span><span class="refpurpose"> — Update an application or runtime</span></dt><dt><span class="refentrytitle"><a href="#flatpak-spawn">flatpak spawn</a></span><span class="refpurpose"> — Run commands in a sandbox</span></dt></dl></div><div class="refentry"><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="id1347"></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 collection ID set on the repository at LOCATION (if set) will be used for the bundle. </p><p> Unless <code class="option">--oci</code> is used, 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="id1348"></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. See <span class="command"><strong>flatpak --supported-arches</strong></span> for architectures supported by the host. </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">--runtime-repo=URL</code></span></dt><dd><p> The URL for a <code class="filename">.flatpakrepo</code> file that contains the information about the repository that supplies the runtimes required by the app. </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">--from-commit=COMMIT</code></span></dt><dd><p> The OSTree commit to create a delta bundle from. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1349"></a><h2>Examples</h2><p> <span class="command"><strong>$ flatpak build-bundle /var/lib/flatpak/repo gnome-calculator.flatpak org.gnome.Calculator stable</strong></span> </p><p> <span class="command"><strong>$ flatpak build-bundle ~/.local/share/flatpak/repo gnome-calculator.flatpak org.gnome.Calculator stable</strong></span> </p></div><div class="refsect1"><a id="id1350"></a><h2>See also</h2><p> <a class="citerefentry" href="#ostree"><span class="citerefentry"><span class="refentrytitle">ostree</span>(1)</span></a>, <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-init"><span class="citerefentry"><span class="refentrytitle">flatpak-build-init</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build"><span class="citerefentry"><span class="refentrytitle">flatpak-build</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-finish"><span class="citerefentry"><span class="refentrytitle">flatpak-build-finish</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-import-bundle"><span class="citerefentry"><span class="refentrytitle">flatpak-build-import-bundle</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-update-repo"><span class="citerefentry"><span class="refentrytitle">flatpak-build-update-repo</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-build-commit-from"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-build-commit-from — Create new commits based on existing one (possibly from another repository)</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak build-commit-from</code> [OPTION...] DST-REPO DST-REF... </p></div></div><div class="refsect1"><a id="id1351"></a><h2>Description</h2><p> Creates new commits on the DST-REF branch in the DST-REPO , with the contents (and most of the metadata) taken from another branch, either from another repo, or from another branch in the same repository. </p><p> The collection ID set on DST-REPO (if set) will be used for the newly created commits. </p><p> This command is very useful when you want to maintain a branch with a clean history that has no unsigned or broken commits. For instance, you can import the head from a different repository from an automatic builder when you've verified that it worked. The new commit will have no parents or signatures from the autobuilder, and can be properly signed with the official key. </p><p> Any deltas that affect the original commit and that match parent commits in the destination repository are copied and rewritten for the new commit id. </p></div><div class="refsect1"><a id="id1352"></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">--src-repo=SRC-REPO</code></span></dt><dd><p> The (local) repository to pull the source branch from. Defaults to the destination repository. </p></dd><dt><span class="term"><code class="option">--src-ref=SRC-REF</code></span></dt><dd><p> The branch to use as the source for the new commit. Defaults to the same as the destination ref, which is useful only if a different source repo has been specified. </p></dd><dt><span class="term"><code class="option">--extra-collection-id=COLLECTION-ID</code></span></dt><dd><p> Add an extra collection-ref binding for this collection, in addition to whatever would normally be added due to the destination repository collection id. This option can be used multiple times. </p></dd><dt><span class="term"><code class="option">--subset=SUBSET</code></span></dt><dd><p> Mark the commit to be included in the named subset. This will cause the commit to be put in the named subset summary (in addition to the main one), allowing users to see only this subset instead of the whole repo. </p></dd><dt><span class="term"><code class="option">--untrusted</code></span></dt><dd><p> The source repostory is not trusted, all objects are copied (not hardlinked) and all checksums are verified. </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. If not specified, will be taken from the source commit. </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. If not specified, will be taken from the source commit. </p></dd><dt><span class="term"><code class="option">--update-appstream</code></span></dt><dd><p> Update the appstream branch after the build. </p></dd><dt><span class="term"><code class="option">--no-update-summary</code></span></dt><dd><p> Don't update the summary file after the new commit is added. This means the repository will not be useful for serving over http until build-update-repo has been run. This is useful is you want to do multiple repo operations before finally updating the summary. </p></dd><dt><span class="term"><code class="option">--force</code></span></dt><dd><p> Create new commit even if the content didn't change from the existing branch head. </p></dd><dt><span class="term"><code class="option">--disable-fsync</code></span></dt><dd><p> Don't fsync when writing to the repository. This can result in data loss in exceptional situations, but can improve performance when working with temporary or test repositories. </p></dd><dt><span class="term"><code class="option">--gpg-sign=KEYID</code></span></dt><dd><p> Sign the commit with this GPG key. This option can be used multiple times. </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">--end-of-life=REASON</code></span></dt><dd><p> Mark build as end-of-life </p></dd><dt><span class="term"><code class="option">--end-of-life-rebase=OLDID=NEWID</code></span></dt><dd><p> Mark new refs as end-of-life. Unlike <code class="option">--end-of-life</code>, this one takes an ID that supersedes the current one. By the user's request, the application data may be preserved for the new application. Note, this is actually a prefix match, so if you say org.the.app=org.new.app, then something like org.the.app.Locale will be rebased to org.new.app.Locale. </p></dd><dt><span class="term"><code class="option">--timestamp=TIMESTAMP</code></span></dt><dd><p> Override the timestamp of the commit. Use an ISO 8601 formatted date, or NOW for the current time </p></dd><dt><span class="term"><code class="option">--disable-fsync</code></span></dt><dd><p> Don't fsync when writing to the repository. This can result in data loss in exceptional situations, but can improve performance when working with temporary or test repositories. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1353"></a><h2>Examples</h2><p> To revert a commit to the commit before: </p><p> <span class="command"><strong>$ flatpak build-commit-from --timestamp=NOW --src-ref=app/org.gnome.gedit/x86_64/master^ repo app/org.gnome.gedit/x86_64/master</strong></span> </p></div><div class="refsect1"><a id="id1354"></a><h2>See also</h2><p> <a class="citerefentry" href="#ostree"><span class="citerefentry"><span class="refentrytitle">ostree</span>(1)</span></a>, <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-init"><span class="citerefentry"><span class="refentrytitle">flatpak-build-init</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build"><span class="citerefentry"><span class="refentrytitle">flatpak-build</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-finish"><span class="citerefentry"><span class="refentrytitle">flatpak-build-finish</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-sign"><span class="citerefentry"><span class="refentrytitle">flatpak-build-sign</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-update-repo"><span class="citerefentry"><span class="refentrytitle">flatpak-build-update-repo</span>(1)</span></a> </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="id1355"></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> When exporting a flatpak to be published to the internet, <code class="option">--collection-id=COLLECTION-ID</code> should be specified as a globally unique reverse DNS value to identify the collection of flatpaks this will be added to. Setting a globally unique collection ID allows the apps in the repository to be shared over peer to peer systems without needing further configuration. </p><p> The build-update-repo command should be used to update repository metadata whenever application builds are added to a repository. </p></div><div class="refsect1"><a id="id1356"></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">--collection-id=COLLECTION-ID</code></span></dt><dd><p> Set as the collection ID of the repository. Setting a globally unique collection ID allows the apps in the repository to be shared over peer to peer systems without needing further configuration. If exporting to an existing repository, the collection ID must match the existing configured collection ID for that repository. </p></dd><dt><span class="term"><code class="option">--subset=SUBSET</code></span></dt><dd><p> Mark the commit to be included in the named subset. This will cause the commit to be put in the named subset summary (in addition to the main one), allowing users to see only this subset instead of the whole repo. </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; see <span class="command"><strong>flatpak --supported-arches</strong></span> for valid values. </p></dd><dt><span class="term"><code class="option">--exclude=PATTERN</code></span></dt><dd><p> Exclude files matching PATTERN from the commit. This option can be used multiple times. </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 <code class="option">--exclude</code> patterns. This option can be used multiple times. </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 <code class="option">--files</code> and <code class="option">--exclude</code>. </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">--timestamp=DATE</code></span></dt><dd><p> Use the specified ISO 8601 formatted date or NOW, for the current time, in the commit metadata and, if <code class="option">--update-appstream</code> is used, the appstream data. </p></dd><dt><span class="term"><code class="option">--end-of-life=REASON</code></span></dt><dd><p> Mark the build as end-of-life. REASON is a message that may be shown to users installing this build. </p></dd><dt><span class="term"><code class="option">--end-of-life-rebase=ID</code></span></dt><dd><p> Mark the build as end-of-life. Unlike <code class="option">--end-of-life</code>, this one takes an ID that supersedes the current one. By the user's request, the application data may be preserved for the new application. </p></dd><dt><span class="term"><code class="option">--disable-fsync</code></span></dt><dd><p> Don't fsync when writing to the repository. This can result in data loss in exceptional situations, but can improve performance when working with temporary or test repositories. </p></dd><dt><span class="term"><code class="option">--update-appstream</code></span></dt><dd><p> Update the appstream branch after the build. </p></dd><dt><span class="term"><code class="option">--no-update-summary</code></span></dt><dd><p> Don't update the summary file after the new commit is added. This means the repository will not be useful for serving over http until build-update-repo has been run. This is useful is you want to do multiple repo operations before finally updating the 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. This option can be used multiple times. </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">-r</code>, </span><span class="term"><code class="option">--runtime</code></span></dt><dd><p> Export a runtime instead of 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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1357"></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="id1358"></a><h2>See also</h2><p> <a class="citerefentry" href="#ostree"><span class="citerefentry"><span class="refentrytitle">ostree</span>(1)</span></a>, <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-init"><span class="citerefentry"><span class="refentrytitle">flatpak-build-init</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build"><span class="citerefentry"><span class="refentrytitle">flatpak-build</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-finish"><span class="citerefentry"><span class="refentrytitle">flatpak-build-finish</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-sign"><span class="citerefentry"><span class="refentrytitle">flatpak-build-sign</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-update-repo"><span class="citerefentry"><span class="refentrytitle">flatpak-build-update-repo</span>(1)</span></a> </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="id1359"></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, D-Bus service files, and AppStream metainfo 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> As part of finalization you can also specify permissions that the app needs, using the various options specified below. Additionally during finalization the permissions from the runtime are inherited into the app unless you specify <code class="option">--no-inherit-permissions</code> </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="id1360"></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><p> Note that the command is used when the application is run via <span class="command"><strong>flatpak run</strong></span>, and does not affect what gets executed when the application is run in other ways, e.g. via the desktop file or D-Bus activation. </p></dd><dt><span class="term"><code class="option">--require-version=MAJOR.MINOR.MICRO</code></span></dt><dd><p> Require this version or later of flatpak to install/update to this build. </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, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth, pcsc, cups, gpg-agent. This option can be used multiple times. </p><p> The fallback-x11 option makes the X11 socket available only if there is no Wayland socket. This option was introduced in 0.11.3. To support older Flatpak releases, specify both x11 and fallback-x11. The fallback-x11 option takes precedence when both are supported. </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, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth, pcsc, cups, gpg-agent. 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, kvm, shm, 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, kvm, shm, all. This option can be used multiple times. </p></dd><dt><span class="term"><code class="option">--allow=FEATURE</code></span></dt><dd><p> Allow access to a specific feature. This updates the [Context] group in the metadata. FEATURE must be one of: devel, multiarch, bluetooth, canbus, per-app-dev-shm. This option can be used multiple times. </p><p> The <code class="code">devel</code> feature allows the application to access certain syscalls such as <code class="code">ptrace()</code>, and <code class="code">perf_event_open()</code>. </p><p> The <code class="code">multiarch</code> feature allows the application to execute programs compiled for an ABI other than the one supported natively by the system. For example, for the <code class="code">x86_64</code> architecture, 32-bit <code class="code">x86</code> binaries will be allowed as well. </p><p> The <code class="code">bluetooth</code> feature allows the application to use bluetooth (AF_BLUETOOTH) sockets. Note, for bluetooth to fully work you must also have network access. </p><p> The <code class="code">canbus</code> feature allows the application to use canbus (AF_CAN) sockets. Note, for this work you must also have network access. </p><p> The <code class="code">per-app-dev-shm</code> feature shares a single instance of <code class="filename">/dev/shm</code> between the application, any unrestricted subsandboxes that it creates, and any other instances of the application that are launched while it is running. </p></dd><dt><span class="term"><code class="option">--disallow=FEATURE</code></span></dt><dd><p> Disallow access to a specific feature. This updates the [Context] group in the metadata. FEATURE must be one of: devel, multiarch, bluetooth, canbus, per-app-dev-shm. 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, host-os, host-etc, xdg-desktop, xdg-documents, xdg-download, xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, xdg-config, xdg-cache, xdg-data, an absolute path, or a homedir-relative path like ~/dir or paths relative to the xdg dirs, like xdg-download/subdir. The optional :ro suffix indicates that the location will be read-only. The optional :create suffix indicates that the location will be read-write and created if it doesn't exist. This option can be used multiple times. See the "[Context] filesystems" list in <a class="citerefentry" href="#flatpak-metadata"><span class="citerefentry"><span class="refentrytitle">flatpak-metadata</span>(5)</span></a> for details of the meanings of these filesystems. </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, host-os, host-etc, 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">--add-policy=SUBSYSTEM.KEY=VALUE</code></span></dt><dd><p> Add generic policy option. For example, "--add-policy=subsystem.key=v1 --add-policy=subsystem.key=v2" would map to this metadata: </p><pre class="programlisting"> [Policy subsystem] key=v1;v2; </pre><p> </p><p> This option can be used multiple times. </p></dd><dt><span class="term"><code class="option">--remove-policy=SUBSYSTEM.KEY=VALUE</code></span></dt><dd><p> Remove generic policy option. 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">--unset-env=VAR</code></span></dt><dd><p> Unset an environment variable in the application. This updates the unset-environment entry in the [Context] group of the metadata. This option can be used multiple times. </p></dd><dt><span class="term"><code class="option">--env-fd=<em class="replaceable"><code>FD</code></em></code></span></dt><dd><p> Read environment variables from the file descriptor <em class="replaceable"><code>FD</code></em>, and set them as if via <code class="option">--env</code>. This can be used to avoid environment variables and their values becoming visible to other users. </p><p> Each environment variable is in the form <em class="replaceable"><code>VAR</code></em>=<em class="replaceable"><code>VALUE</code></em> followed by a zero byte. This is the same format used by <code class="literal">env -0</code> and <code class="filename">/proc/*/environ</code>. </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">--runtime=RUNTIME</code>, </span><span class="term"><code class="option">--sdk=SDK</code></span></dt><dd><p> Change the runtime or sdk used by the app to the specified partial ref. Unspecified parts of the ref are taken from the old values or defaults. </p></dd><dt><span class="term"><code class="option">--metadata=GROUP=KEY[=VALUE]</code></span></dt><dd><p> Set a generic key in the metadata file. If value is left out it will be set to "true". </p></dd><dt><span class="term"><code class="option">--extension=NAME=VARIABLE[=VALUE]</code></span></dt><dd><p> Add extension point info. See the documentation for <a class="citerefentry" href="#flatpak-metadata"><span class="citerefentry"><span class="refentrytitle">flatpak-metadata</span>(5)</span></a> for the possible values of <em class="replaceable"><code>VARIABLE</code></em> and <em class="replaceable"><code>VALUE</code></em>. </p></dd><dt><span class="term"><code class="option">--remove-extension=NAME</code></span></dt><dd><p> Remove extension point info. </p></dd><dt><span class="term"><code class="option">--extension-priority=VALUE</code></span></dt><dd><p> Set the priority (library override order) of the extension point. Only useful for extensions. 0 is the default, and higher value means higher priority. </p></dd><dt><span class="term"><code class="option">--extra-data=NAME:SHA256:DOWNLOAD-SIZE:INSTALL-SIZE:URL</code></span></dt><dd><p> Adds information about extra data uris to the app. These will be downloaded and verified by the client when the app is installed and placed in the <code class="filename">/app/extra</code> directory. You can also supply an <code class="filename">/app/bin/apply_extra</code> script that will be run after the files are downloaded. </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">--no-inherit-permissions</code></span></dt><dd><p> Don't inherit runtime permissions in the 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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1361"></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="id1362"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-init"><span class="citerefentry"><span class="refentrytitle">flatpak-build-init</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build"><span class="citerefentry"><span class="refentrytitle">flatpak-build</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-export"><span class="citerefentry"><span class="refentrytitle">flatpak-build-export</span>(1)</span></a> </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="id1363"></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="id1364"></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">--ostree-verbose</code></span></dt><dd><p> Print OSTree 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">--update-appstream</code></span></dt><dd><p> Update the appstream branch after the build. </p></dd><dt><span class="term"><code class="option">--no-update-summary</code></span></dt><dd><p> Don't update the summary file after the new commit is added. This means the repository will not be useful for serving over http until build-update-repo has been run. This is useful is you want to do multiple repo operations before finally updating the 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. This option can be used multiple times. </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></dl></div></div><div class="refsect1"><a id="id1365"></a><h2>See also</h2><p> <a class="citerefentry" href="#ostree"><span class="citerefentry"><span class="refentrytitle">ostree</span>(1)</span></a>, <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-bundle"><span class="citerefentry"><span class="refentrytitle">flatpak-build-bundle</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-update-repo"><span class="citerefentry"><span class="refentrytitle">flatpak-build-update-repo</span>(1)</span></a> </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="id1366"></a><h2>Description</h2><p> Initializes a separate build directory. 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. BRANCH specify the version of sdk and runtime </p><p> Initializes a directory as build directory which can be used as target directory of <span class="command"><strong>flatpak build</strong></span>. It creates a <code class="filename">metadata</code> 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="id1367"></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. See <span class="command"><strong>flatpak --supported-arches</strong></span> for architectures supported by the host. </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. This option can be used multiple times. </p></dd><dt><span class="term"><code class="option">--sdk-extension=EXTENSION</code></span></dt><dd><p> When using <code class="option">--writable-sdk</code>, in addition to the sdk, also install the specified extension. This option can be used multiple times. </p></dd><dt><span class="term"><code class="option">--extension=NAME=VARIABLE[=VALUE]</code></span></dt><dd><p> Add extension point info. </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 <code class="option">--writable-sdk</code>. </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">--base=APP</code></span></dt><dd><p> Initialize the application with files from another specified application. </p></dd><dt><span class="term"><code class="option">--base-version=VERSION</code></span></dt><dd><p> Specify the version to use for <code class="option">--base</code>. If not specified, will default to "master". </p></dd><dt><span class="term"><code class="option">--base-extension=EXTENSION</code></span></dt><dd><p> When using <code class="option">--base</code>, also install the specified extension from the app. This option can be used multiple times. </p></dd><dt><span class="term"><code class="option">--type=TYPE</code></span></dt><dd><p> This can be used to build different types of things. The default is "app" which is a regular app, but "runtime" creates a runtime based on an existing runtime, and "extension" creates an extension for an app or runtime. </p></dd><dt><span class="term"><code class="option">--extension-tag=EXTENSION_TAG</code></span></dt><dd><p> If building an extension, the tag to use when searching for the mount point of the extension. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1368"></a><h2>Examples</h2><p> <span class="command"><strong>$ flatpak build-init /build/my-app org.example.myapp org.gnome.Sdk org.gnome.Platform 3.36</strong></span> </p></div><div class="refsect1"><a id="id1369"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build"><span class="citerefentry"><span class="refentrytitle">flatpak-build</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-finish"><span class="citerefentry"><span class="refentrytitle">flatpak-build-finish</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-export"><span class="citerefentry"><span class="refentrytitle">flatpak-build-export</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-build-sign"></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="id1370"></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="id1371"></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. This option can be used multiple times. </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. See <span class="command"><strong>flatpak --supported-arches</strong></span> for architectures supported by the host. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1372"></a><h2>Examples</h2><p> <span class="command"><strong>$ flatpak build-sign --gpg-sign=D8BA6573DDD2418027736F1BC33B315E53C1E9D6 /some/repo org.my.App</strong></span> </p></div><div class="refsect1"><a id="id1373"></a><h2>See also</h2><p> <a class="citerefentry" href="#ostree"><span class="citerefentry"><span class="refentrytitle">ostree</span>(1)</span></a>, <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-export"><span class="citerefentry"><span class="refentrytitle">flatpak-build-export</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build"><span class="citerefentry"><span class="refentrytitle">flatpak-build</span>(1)</span></a>, </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="id1374"></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 remote-ls 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 remote-add, either by exporting it over http, or directly with a file: url. </p></div><div class="refsect1"><a id="id1375"></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">--redirect-url=URL</code></span></dt><dd><p> Redirect this repo to a new URL. </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">--comment=COMMENT</code></span></dt><dd><p> A single-line comment for the remote, e.g. for display in a UI. The comment is stored in the repository summary. </p></dd><dt><span class="term"><code class="option">--description=DESCRIPTION</code></span></dt><dd><p> A full-paragraph description for the remote, e.g. for display in a UI. The description is stored in the repository summary. </p></dd><dt><span class="term"><code class="option">--homepage=URL</code></span></dt><dd><p> URL for a website for the remote, e.g. for display in a UI. The url is stored in the repository summary. </p></dd><dt><span class="term"><code class="option">--icon=URL</code></span></dt><dd><p> URL for an icon for the remote, e.g. for display in a UI. The url is stored in the repository summary. </p></dd><dt><span class="term"><code class="option">--default-branch=BRANCH</code></span></dt><dd><p> A default branch for the repository, mainly for use in a UI. </p></dd><dt><span class="term"><code class="option">--gpg-import=FILE</code></span></dt><dd><p> Import a new default GPG public key from the given file. </p></dd><dt><span class="term"><code class="option">--collection-id=COLLECTION-ID</code></span></dt><dd><p> The globally unique identifier of the remote repository, to allow mirrors to be grouped. This must be set to a globally unique reverse DNS string if the repository is to be made publicly available. If a collection ID is already set on an existing repository, this will update it. If not specified, the existing collection ID will be left unchanged. </p></dd><dt><span class="term"><code class="option">--deploy-collection-id</code></span></dt><dd><p> Deploy the collection ID (set using <code class="option">--collection-id</code>) in the static remote configuration for all clients. This is irrevocable once published in a repository. Use it to decide when to roll out a collection ID to users of an existing repository. If constructing a new repository which has a collection ID, you should typically always pass this option. </p></dd><dt><span class="term"><code class="option">--deploy-sideload-collection-id</code></span></dt><dd><p> This is similar to --deploy-collection-id, but it only applies the deploy to clients newer than flatpak 1.7 which supports the new form of sideloads. </p></dd><dt><span class="term"><code class="option">--gpg-sign=KEYID</code></span></dt><dd><p> Sign the commit with this GPG key. This option can be used multiple times. </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">--static-delta-jobs=NUM-JOBS</code></span></dt><dd><p> Limit the number of parallel jobs creating static deltas. The default is the number of cpus. </p></dd><dt><span class="term"><code class="option">--static-delta-ignore-ref=PATTERN</code></span></dt><dd><p> Don't generate deltas for runtime or application id matching this pattern. For instance, --static-delta-ignore-ref=*.Sources means there will not be any deltas for source refs. </p></dd><dt><span class="term"><code class="option">--prune</code></span></dt><dd><p> Remove unreferenced 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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1376"></a><h2>See also</h2><p> <a class="citerefentry" href="#ostree"><span class="citerefentry"><span class="refentrytitle">ostree</span>(1)</span></a>, <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-remote-ls"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-ls</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-export"><span class="citerefentry"><span class="refentrytitle">flatpak-build-export</span>(1)</span></a> </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="id1377"></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="id1378"></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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </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">-p</code>, </span><span class="term"><code class="option">--die-with-parent</code></span></dt><dd><p> Kill the build process and all children when the launching process dies. </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, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth, pcsc, cups, gpg-agent. 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, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth, pcsc, cups, gpg-agent. 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, kvm, shm, 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, kvm, shm, all. This option can be used multiple times. </p></dd><dt><span class="term"><code class="option">--allow=FEATURE</code></span></dt><dd><p> Allow access to a specific feature. This updates the [Context] group in the metadata. FEATURE must be one of: devel, multiarch, bluetooth, canbus, per-app-dev-shm. This option can be used multiple times. </p><p> See <a class="citerefentry" href="#flatpak-build-finish"><span class="citerefentry"><span class="refentrytitle">flatpak-build-finish</span>(1)</span></a> for the meaning of the various features. </p></dd><dt><span class="term"><code class="option">--disallow=FEATURE</code></span></dt><dd><p> Disallow access to a specific feature. This updates the [Context] group in the metadata. FEATURE must be one of: devel, multiarch, bluetooth, canbus, per-app-dev-shm. This option can be used multiple times. </p></dd><dt><span class="term"><code class="option">--filesystem=FILESYSTEM[:ro|:create]</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, host-os, host-etc, xdg-desktop, xdg-documents, xdg-download, xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, xdg-config, xdg-cache, xdg-data, an absolute path, or a homedir-relative path like ~/dir or paths relative to the xdg dirs, like xdg-download/subdir. The optional :ro suffix indicates that the location will be read-only. The optional :create suffix indicates that the location will be read-write and created if it doesn't exist. This option can be used multiple times. See the "[Context] filesystems" list in <a class="citerefentry" href="#flatpak-metadata"><span class="citerefentry"><span class="refentrytitle">flatpak-metadata</span>(5)</span></a> for details of the meanings of these filesystems. </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, host-os, host-etc, 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">--with-appdir</code></span></dt><dd><p> Expose and configure access to the per-app storage directory in <code class="filename">$HOME/.var/app</code>. This is not normally useful when building, but helps when testing built apps. </p></dd><dt><span class="term"><code class="option">--add-policy=SUBSYSTEM.KEY=VALUE</code></span></dt><dd><p> Add generic policy option. For example, "--add-policy=subsystem.key=v1 --add-policy=subsystem.key=v2" would map to this metadata: </p><pre class="programlisting"> [Policy subsystem] key=v1;v2; </pre><p> </p><p> This option can be used multiple times. </p></dd><dt><span class="term"><code class="option">--remove-policy=SUBSYSTEM.KEY=VALUE</code></span></dt><dd><p> Remove generic policy option. 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">--unset-env=VAR</code></span></dt><dd><p> Unset an environment variable in the application. This overrides the unset-environment entry in the [Context] group of the metadata, and the [Environment] group. This option can be used multiple times. </p></dd><dt><span class="term"><code class="option">--env-fd=<em class="replaceable"><code>FD</code></em></code></span></dt><dd><p> Read environment variables from the file descriptor <em class="replaceable"><code>FD</code></em>, and set them as if via <code class="option">--env</code>. This can be used to avoid environment variables and their values becoming visible to other users. </p><p> Each environment variable is in the form <em class="replaceable"><code>VAR</code></em>=<em class="replaceable"><code>VALUE</code></em> followed by a zero byte. This is the same format used by <code class="literal">env -0</code> and <code class="filename">/proc/*/environ</code>. </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><dt><span class="term"><code class="option">--sdk-dir=DIR</code></span></dt><dd><p> Normally if there is a <code class="filename">usr</code> directory in the build dir, this is used for the runtime files (this can be created by <code class="option">--writable-sdk</code> or <code class="option">--type=runtime</code> arguments to build-init). If you specify <code class="option">--sdk-dir</code>, this directory will be used instead. Use this if you passed <code class="option">--sdk-dir</code> to build-init. </p></dd><dt><span class="term"><code class="option">--readonly</code></span></dt><dd><p> Mount the normally writable destination directories read-only. This can be useful if you want to run something in the sandbox but guarantee that it doesn't affect the build results. For example tests. </p></dd><dt><span class="term"><code class="option">--metadata=FILE</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 build multiple things from a single build tree (such as both a platform and a sdk). </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="id1379"></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="id1380"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-init"><span class="citerefentry"><span class="refentrytitle">flatpak-build-init</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-finish"><span class="citerefentry"><span class="refentrytitle">flatpak-build-finish</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-export"><span class="citerefentry"><span class="refentrytitle">flatpak-build-export</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-config"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-config — Manage configuration</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak config</code> [OPTION...]</p></div><div class="cmdsynopsis"><p><code class="command">flatpak config</code> [OPTION...] --set KEY VALUE </p></div><div class="cmdsynopsis"><p><code class="command">flatpak config</code> [OPTION...] --unset|--get KEY </p></div></div><div class="refsect1"><a id="id1381"></a><h2>Description</h2><p> The flatpak config command shows or modifies the configuration of a flatpak installation. The following keys are supported: </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="varname">languages</code></span></dt><dd><p> The languages that are included when installing Locale extensions. The value is a semicolon-separated list of two-letter language codes, or one of the special values <code class="literal">*</code> or <code class="literal">all</code>. If this key is unset, flatpak defaults to including the <code class="varname">extra-languages</code> key and the current locale. </p></dd><dt><span class="term"><code class="varname">extra-languages</code></span></dt><dd><p> This key is used when languages is not set, and it defines extra locale extensions on top of the system configured languages. The value is a semicolon-separated list of locale identifiers (language, optional locale, optional codeset, optional modifier) as documented by <a class="citerefentry" href="#setlocale"><span class="citerefentry"><span class="refentrytitle">setlocale</span>(3)</span></a> (for example, <code class="literal">en;en_DK;zh_HK.big5hkscs;uz_UZ.utf8@cyrillic</code>). </p></dd></dl></div><p> For configuration of individual remotes, see <a class="citerefentry" href="#flatpak-remote-modify"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-modify</span>(1)</span></a>. For configuration of individual applications, see <a class="citerefentry" href="#flatpak-override"><span class="citerefentry"><span class="refentrytitle">flatpak-override</span>(1)</span></a>. </p></div><div class="refsect1"><a id="id1382"></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">--list</code></span></dt><dd><p> Print all keys and their values. </p></dd><dt><span class="term"><code class="option">--set</code></span></dt><dd><p> Set key KEY to VALUE . </p></dd><dt><span class="term"><code class="option">--unset</code></span></dt><dd><p> Unset key KEY . </p></dd><dt><span class="term"><code class="option">--get</code></span></dt><dd><p> Print value of KEY . </p></dd><dt><span class="term"><code class="option">-u</code>, </span><span class="term"><code class="option">--user</code></span></dt><dd><p> Configure per-user installation. </p></dd><dt><span class="term"><code class="option">--system</code></span></dt><dd><p> Configure system-wide installation. </p></dd><dt><span class="term"><code class="option">--installation=NAME</code></span></dt><dd><p> Configure the system-wide installation specified by NAME among those defined in <code class="filename">/etc/flatpak/installations.d/</code>. Using <code class="option">--installation=default</code> is equivalent to using <code class="option">--system</code>. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1383"></a><h2>Examples</h2><p> <span class="command"><strong>$ flatpak config --set languages "sv;en;fi"</strong></span> </p></div><div class="refsect1"><a id="id1384"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-remote-modify"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-modify</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-override"><span class="citerefentry"><span class="refentrytitle">flatpak-override</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-create-usb"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-create-usb — Copy apps and/or runtimes onto removable media.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak create-usb</code> [OPTION...] MOUNT-PATH REF... </p></div></div><div class="refsect1"><a id="id1385"></a><h2>Description</h2><p> Copies the specified apps and/or runtimes REF s onto the removable media mounted at MOUNT-PATH , along with all the dependencies and metadata needed for installing them. This is one way of transferring flatpaks between computers that doesn't require an Internet connection. After using this command, the USB drive can be connected to another computer which already has the relevant remote(s) configured, and Flatpak will install or update from the drive offline (see below). If online, the drive will be used as a cache, meaning some objects will be pulled from it and others from the Internet. For this process to work a collection ID must be configured on the relevant remotes on both the source and destination computers, and on the remote server. </p><p> On the destination computer one can install from the USB (or any mounted filesystem) using the <code class="option">--sideload-repo</code> option with <span class="command"><strong>flatpak install</strong></span>. It's also possible to configure sideload paths using symlinks; see <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>. Flatpak also includes systemd units to automatically sideload from hot-plugged USB drives, but these may or may not be enabled depending on your Linux distribution. </p><p> Each REF argument is a full or partial identifier in the flatpak ref format, which looks like "(app|runtime)/ID/ARCH/BRANCH". All elements except ID are optional and can be left out, including the slashes, so most of the time you need only specify ID. Any part left out will be matched against what is installed, and if there are multiple matches an error message will list the alternatives. </p><p> By default this looks for both installed apps and runtimes with the given REF , but you can limit this by using the <code class="option">--app</code> or <code class="option">--runtime</code> option. </p><p> All REF s must be in the same installation (user, system, or other). Otherwise it's ambiguous which repository metadata refs to put on the USB drive. </p><p> By default <span class="command"><strong>flatpak create-usb</strong></span> uses <code class="filename">.ostree/repo</code> as the destination directory under MOUNT-PATH but if you specify another location using <code class="option">--destination-repo</code> a symbolic link will be created for you in <code class="filename">.ostree/repos.d</code>. This ensures that either way the repository will be found by flatpak (and other consumers of libostree) for install/update operations. </p><p> Unless overridden with the <code class="option">--system</code>, <code class="option">--user</code>, or <code class="option">--installation</code> options, this command searches both the system-wide installation and the per-user one for REF and errors out if it exists in more than one. </p></div><div class="refsect1"><a id="id1386"></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">-u</code>, </span><span class="term"><code class="option">--user</code></span></dt><dd><p> Copy refs from the per-user installation. </p></dd><dt><span class="term"><code class="option">--system</code></span></dt><dd><p> Copy refs from the default system-wide installation. </p></dd><dt><span class="term"><code class="option">--installation=NAME</code></span></dt><dd><p> Copy refs from a system-wide installation specified by NAME among those defined in <code class="filename">/etc/flatpak/installations.d/</code>. Using <code class="option">--installation=default</code> is equivalent to using <code class="option">--system</code>. </p></dd><dt><span class="term"><code class="option">--app</code></span></dt><dd><p> Assume that all REF s are apps if not explicitly specified. </p></dd><dt><span class="term"><code class="option">--runtime</code></span></dt><dd><p> Assume that all REF s are runtimes if not explicitly specified. </p></dd><dt><span class="term"><code class="option">--destination-repo</code>=DEST</span></dt><dd><p> Create the repository in DEST under MOUNT-PATH , rather than the default location. </p></dd><dt><span class="term"><code class="option">--allow-partial</code></span></dt><dd><p> Don't print a warning when exporting partially installed commits, for example locale extensions without all languages. These can cause problems when installing them, for example if the language config is different on the installing side. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1387"></a><h2>Examples</h2><p> <span class="command"><strong>$ flatpak create-usb /run/media/mwleeds/1a9b4cb2-a7ef-4d9b-91a5-6eaf8fdd2bf6/ com.endlessm.wiki_art.en</strong></span> </p></div><div class="refsect1"><a id="id1388"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak remote-modify"><span class="citerefentry"><span class="refentrytitle">flatpak remote-modify</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-install"><span class="citerefentry"><span class="refentrytitle">flatpak-install</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-list"><span class="citerefentry"><span class="refentrytitle">flatpak-list</span>(1)</span></a>, <a class="citerefentry" href="#ostree-create-usb"><span class="citerefentry"><span class="refentrytitle">ostree-create-usb</span>(1)</span></a> </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="id1389"></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 <code class="filename">/run/user/$UID/doc/</code>. </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="id1390"></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">-u</code>, </span><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">-t</code>, </span><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">-n</code>, </span><span class="term"><code class="option">--noexist</code></span></dt><dd><p> Don't require the file to exist already. </p></dd><dt><span class="term"><code class="option">-a</code>, </span><span class="term"><code class="option">--app=APPID</code></span></dt><dd><p> Grant read access to the specified application. The <code class="option">--allow</code> and <code class="option">--forbid</code> 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">-r</code>, </span><span class="term"><code class="option">--allow-read</code></span></dt><dd><p> Grant read access to the applications specified with <code class="option">--app</code>. 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 <code class="option">--app</code>. </p></dd><dt><span class="term"><code class="option">-w</code>, </span><span class="term"><code class="option">--allow-write</code></span></dt><dd><p> Grant write access to the applications specified with <code class="option">--app</code>. </p></dd><dt><span class="term"><code class="option">--forbid-write</code></span></dt><dd><p> Revoke write access for the applications specified with <code class="option">--app</code>. </p></dd><dt><span class="term"><code class="option">-d</code>, </span><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 <code class="option">--app</code>. </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 <code class="option">--app</code>. </p></dd><dt><span class="term"><code class="option">-g</code>, </span><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 <code class="option">--app</code>. </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 <code class="option">--app</code>. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1391"></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="id1392"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-document-unexport"><span class="citerefentry"><span class="refentrytitle">flatpak-document-unexport</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-document-info"><span class="citerefentry"><span class="refentrytitle">flatpak-document-info</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-documents"><span class="citerefentry"><span class="refentrytitle">flatpak-documents</span>(1)</span></a> </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="id1393"></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 <code class="filename">/run/user/$UID/doc/</code>, or a file anywhere else. </p></div><div class="refsect1"><a id="id1394"></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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1395"></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="id1396"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-document-export"><span class="citerefentry"><span class="refentrytitle">flatpak-document-export</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-document-unexport"><span class="citerefentry"><span class="refentrytitle">flatpak-document-unexport</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-documents"><span class="citerefentry"><span class="refentrytitle">flatpak-documents</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-documents"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-documents — List exported files</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak documents</code> [OPTION...] [APPID]</p></div></div><div class="refsect1"><a id="id1397"></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="id1398"></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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1399"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-document-export"><span class="citerefentry"><span class="refentrytitle">flatpak-document-export</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-document-unexport"><span class="citerefentry"><span class="refentrytitle">flatpak-document-unexport</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-document-info"><span class="citerefentry"><span class="refentrytitle">flatpak-document-info</span>(1)</span></a> </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-unexport</code> [OPTION...] FILE </p></div></div><div class="refsect1"><a id="id1400"></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="id1401"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">--doc-id</code></span></dt><dd><p> Interpret FILE as a document ID rather than a file path. This is useful for example when the file has been deleted. </p></dd><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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1402"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-document-export"><span class="citerefentry"><span class="refentrytitle">flatpak-document-export</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-document-info"><span class="citerefentry"><span class="refentrytitle">flatpak-document-info</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-documents"><span class="citerefentry"><span class="refentrytitle">flatpak-documents</span>(1)</span></a> </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 or runtime's sandbox</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak enter</code> [OPTION...] INSTANCE COMMAND [ARG...]</p></div></div><div class="refsect1"><a id="id1403"></a><h2>Description</h2><p> Enter a running sandbox. </p><p> INSTANCE must be either the pid of a process running in a flatpak sandbox, or the ID of a running application, or the instance ID of a running sandbox. You can use <span class="command"><strong>flatpak ps</strong></span> to find the instance IDs of running flatpaks. </p><p> 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><p> This command works as a regular user if the system support unprivileged user namespace. If that is not available you need to run run it like: <span class="command"><strong>sudo -E flatpak enter</strong></span>. </p></div><div class="refsect1"><a id="id1404"></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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1405"></a><h2>Examples</h2><p> <span class="command"><strong>$ flatpak enter 15345 sh</strong></span> </p></div><div class="refsect1"><a id="id1406"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-run"><span class="citerefentry"><span class="refentrytitle">flatpak-run</span>(1)</span></a> <a class="citerefentry" href="#flatpak-ps"><span class="citerefentry"><span class="refentrytitle">flatpak-ps</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-history"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-history — Show history</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak history</code> [OPTION...]</p></div></div><div class="refsect1"><a id="id1407"></a><h2>Description</h2><p> Shows changes to the flatpak installations on the system. This includes installs, updates and removals of applications and runtimes. </p><p> By default, both per-user and system-wide installations are shown. Use the <code class="option">--user</code>, <code class="option">--installation</code> or <code class="option">--system</code> options to change this. </p><p> The information for the history command is taken from the systemd journal, and can also be accessed using e.g. <span class="command"><strong>journalctl MESSAGE_ID=c7b39b1e006b464599465e105b361485</strong></span> </p></div><div class="refsect1"><a id="id1408"></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">-u</code>, </span><span class="term"><code class="option">--user</code></span></dt><dd><p> Show changes to the user installation. </p></dd><dt><span class="term"><code class="option">--system</code></span></dt><dd><p> Show changes to the default system-wide installation. </p></dd><dt><span class="term"><code class="option">--installation=NAME</code></span></dt><dd><p> Show changes to the installation specified by NAME among those defined in <code class="filename">/etc/flatpak/installations.d/</code>. Using <code class="option">--installation=default</code> is equivalent to using <code class="option">--system</code>. </p></dd><dt><span class="term"><code class="option">--since=TIME</code></span></dt><dd><p> Only show changes that are newer than the time specified by TIME . </p><p> TIME can be either an absolute time in a format like YYYY-MM-DD HH:MM:SS, or a relative time like "2h", "7days", "4days 2hours". </p></dd><dt><span class="term"><code class="option">--until=TIME</code></span></dt><dd><p> Only show changes that are older than the time specified by TIME . </p></dd><dt><span class="term"><code class="option">--reverse</code></span></dt><dd><p> Show newest entries first. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd><dt><span class="term"><code class="option">--columns=FIELD,…</code></span></dt><dd><p> Specify what information to show about each ref. You can list multiple fields, or use this option multiple times. </p><p> Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization. </p></dd></dl></div></div><div class="refsect1"><a id="id1409"></a><h2>Fields</h2><p>The following fields are understood by the <code class="option">--columns</code> option:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">time</span></dt><dd><p> Show when the change happened </p></dd><dt><span class="term">change</span></dt><dd><p> Show the kind of change </p></dd><dt><span class="term">ref</span></dt><dd><p> Show the ref </p></dd><dt><span class="term">application</span></dt><dd><p> Show the application/runtime ID </p></dd><dt><span class="term">arch</span></dt><dd><p> Show the architecture </p></dd><dt><span class="term">branch</span></dt><dd><p> Show the branch </p></dd><dt><span class="term">installation</span></dt><dd><p> Show the affected installation. </p><p> This will be either the ID of a Flatpak installation, or the path to a temporary OSTree repository. </p></dd><dt><span class="term">remote</span></dt><dd><p> Show the remote that is used. </p><p> This will be either the name of a configured remote, or the path to a temporary OSTree repository. </p></dd><dt><span class="term">old-commit</span></dt><dd><p> Show the previous commit. For pulls, this is the previous HEAD of the branch. For deploys, it is the previously active commit </p></dd><dt><span class="term">commit</span></dt><dd><p> Show the current commit. For pulls, this is the HEAD of the branch. For deploys, it is the active commit </p></dd><dt><span class="term">url</span></dt><dd><p> Show the remote url </p></dd><dt><span class="term">user</span></dt><dd><p> Show the user doing the change. </p><p> If this is the system helper operating as root, also show which user triggered the change. </p></dd><dt><span class="term">tool</span></dt><dd><p> Show the tool that was used. </p><p> If this is the system helper, also show which tool was used to triggered the change. </p></dd><dt><span class="term">all</span></dt><dd><p> Show all columns </p></dd><dt><span class="term">help</span></dt><dd><p> Show the list of available columns </p></dd></dl></div><p> Note that field names can be abbreviated to a unique prefix. </p></div><div class="refsect1"><a id="id1410"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#journalctl"><span class="citerefentry"><span class="refentrytitle">journalctl</span>(1)</span></a> </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 an installed application 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="id1411"></a><h2>Description</h2><p> Show info about an installed application or runtime. </p><p> By default, the output is formatted in a friendly format. If you specify any of the <code class="option">--show-…</code> or <code class="option">--file-access</code> options, the output is instead formatted in a machine-readable format. </p><p> By default, both per-user and system-wide installations are queried. Use the <code class="option">--user</code>, <code class="option">--system</code> or <code class="option">--installation</code> options to change this. </p></div><div class="refsect1"><a id="id1412"></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">-u</code>, </span><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 the default system-wide installation. </p></dd><dt><span class="term"><code class="option">--installation=NAME</code></span></dt><dd><p> Query a system-wide installation by NAME among those defined in <code class="filename">/etc/flatpak/installations.d/</code>. Using <code class="option">--installation=default</code> is equivalent to using <code class="option">--system</code>. </p></dd><dt><span class="term"><code class="option">--arch=ARCH</code></span></dt><dd><p> Query for this architecture. See <span class="command"><strong>flatpak --supported-arches</strong></span> for architectures supported by the host. </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">-s</code>, </span><span class="term"><code class="option">--show-size</code></span></dt><dd><p> Show the installed size. </p></dd><dt><span class="term"><code class="option">-m</code>, </span><span class="term"><code class="option">--show-metadata</code></span></dt><dd><p> Show the metadata. </p></dd><dt><span class="term"><code class="option">--show-runtime</code></span></dt><dd><p> Show the runtime. </p></dd><dt><span class="term"><code class="option">--show-sdk</code></span></dt><dd><p> Show the SDK. </p></dd><dt><span class="term"><code class="option">-M</code>, </span><span class="term"><code class="option">--show-permissions</code></span></dt><dd><p> Show the permissions. </p></dd><dt><span class="term"><code class="option">--file-access=PATH</code></span></dt><dd><p> Show the level of access to the given path. </p></dd><dt><span class="term"><code class="option">-e</code>, </span><span class="term"><code class="option">--show-extensions</code></span></dt><dd><p> Show the matching extensions. </p></dd><dt><span class="term"><code class="option">-l</code>, </span><span class="term"><code class="option">--show-location</code></span></dt><dd><p> Show the on-disk location of the app or runtime. See the examples below. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1413"></a><h2>Examples</h2><p> <span class="command"><strong>$ flatpak info org.gnome.Builder//master</strong></span> </p><p> <span class="command"><strong>$ tree `flatpak info -l org.gnome.Builder//master`/files</strong></span> </p></div><div class="refsect1"><a id="id1414"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-install"><span class="citerefentry"><span class="refentrytitle">flatpak-install</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-update"><span class="citerefentry"><span class="refentrytitle">flatpak-update</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><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] REF... </p></div><div class="cmdsynopsis"><p><code class="command">flatpak install</code> [OPTION...] [--from|--bundle] LOCATION </p></div></div><div class="refsect1"><a id="id1415"></a><h2>Description</h2><p> Installs an application or runtime. The primary way to install is to specify a REMOTE name as the source and one ore more REF s to specify the application or runtime to install. If REMOTE is omitted, the configured remotes are searched for the first REF and the user is asked to confirm the resulting choice. </p><p> Each REF argument is a full or partial identifier in the flatpak ref format, which looks like "(app|runtime)/ID/ARCH/BRANCH". All elements except ID are optional and can be left out, including the slashes, so most of the time you need only specify ID. Any part left out will be matched against what is in the remote, and if there are multiple matches you will be prompted to choose one of them. You will also be prompted with choices if REF doesn't match anything in the remote exactly but is similar to one or more refs in the remote (e.g. "devhelp" is similar to "org.gnome.Devhelp"), but this fuzzy matching behavior is disabled if REF contains any slashes or periods. </p><p> By default this looks for both apps and runtimes with the given REF in the specified REMOTE , but you can limit this by using the <code class="option">--app</code> or <code class="option">--runtime</code> option, or by supplying the initial element in the REF . </p><p> If REMOTE is a uri or a path (absolute or relative starting with ./) to a local repository, then that repository will be used as the source, and a temporary remote will be created for the lifetime of the REF . </p><p> If the specified REMOTE has a collection ID configured on it, Flatpak will search the <code class="filename">sideload-repos</code> directories configured either with the <code class="option">--sideload-repo</code> option, or on a per-installation or system-wide basis (see <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>). </p><p> The alternative form of the command (with <code class="option">--from</code> or <code class="option">--bundle</code>) allows to install directly from a source such as a <code class="filename">.flatpak</code> single-file bundle or a <code class="filename">.flatpakref</code> application description. The options are optional if the first argument has the expected filename extension. </p><p> Note that flatpak allows to have multiple branches of an application and runtimes installed and used at the same time. However, only one version of an application 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 this can manually changed with flatpak make-current. </p><p> Unless overridden with the <code class="option">--user</code> or the <code class="option">--installation</code> option, this command installs the application or runtime in the default system-wide installation. </p></div><div class="refsect1"><a id="id1416"></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> Treat LOCATION as a single-bundle file. This is assumed if the argument ends with <code class="filename">.flatpak</code>. </p></dd><dt><span class="term"><code class="option">--from</code></span></dt><dd><p> Treat LOCATION as an application description file. This is assumed if the argument ends with <code class="filename">.flatpakref</code>. </p></dd><dt><span class="term"><code class="option">--reinstall</code></span></dt><dd><p> Uninstall first if already installed. </p></dd><dt><span class="term"><code class="option">-u</code>, </span><span class="term"><code class="option">--user</code></span></dt><dd><p> Install the application or runtime in a per-user installation. </p></dd><dt><span class="term"><code class="option">--system</code></span></dt><dd><p> Install the application or runtime in the default system-wide installation. </p></dd><dt><span class="term"><code class="option">--installation=NAME</code></span></dt><dd><p> Install the application or runtime in a system-wide installation specified by NAME among those defined in <code class="filename">/etc/flatpak/installations.d/</code>. Using <code class="option">--installation=default</code> is equivalent to using <code class="option">--system</code>. </p></dd><dt><span class="term"><code class="option">--arch=ARCH</code></span></dt><dd><p> The default architecture to install for, if not given explicitly in the REF . See <span class="command"><strong>flatpak --supported-arches</strong></span> for architectures supported by the host. </p></dd><dt><span class="term"><code class="option">--subpath=PATH</code></span></dt><dd><p> Install only a subpath of 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">--gpg-file=FILE</code></span></dt><dd><p> Check bundle signatures with GPG key from FILE (- for stdin). </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 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">--no-deps</code></span></dt><dd><p> Don't verify runtime dependencies when installing. </p></dd><dt><span class="term"><code class="option">--or-update</code></span></dt><dd><p> Normally install just ignores things that are already installed (printing a warning), but if --or-update is specified it silently turns it into an update operation instead. </p></dd><dt><span class="term"><code class="option">--app</code></span></dt><dd><p> Assume that all REF s are apps if not explicitly specified. </p></dd><dt><span class="term"><code class="option">--runtime</code></span></dt><dd><p> Assume that all REF s are runtimes if not explicitly specified. </p></dd><dt><span class="term"><code class="option">--sideload-repo=PATH</code></span></dt><dd><p> Adds an extra local ostree repo as a source for installation. This is equivalent to using the <code class="filename">sideload-repos</code> directories (see <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>), but can be done on a per-command basis. Any path added here is used in addition to ones in those directories. </p></dd><dt><span class="term"><code class="option">--include-sdk</code></span></dt><dd><p> For each app being installed, also installs the SDK that was used to build it. Implies <code class="option">--or-update</code>; incompatible with <code class="option">--no-deps</code>. </p></dd><dt><span class="term"><code class="option">--include-debug</code></span></dt><dd><p> For each ref being installed, as well as all dependencies, also installs its debug info. Implies <code class="option">--or-update</code>; incompatible with <code class="option">--no-deps</code>. </p></dd><dt><span class="term"><code class="option">-y</code>, </span><span class="term"><code class="option">--assumeyes</code></span></dt><dd><p> Automatically answer yes to all questions (or pick the most prioritized answer). This is useful for automation. </p></dd><dt><span class="term"><code class="option">--noninteractive</code></span></dt><dd><p> Produce minimal output and avoid most questions. This is suitable for use in non-interactive situations, e.g. in a build script. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1417"></a><h2>Examples</h2><p> <span class="command"><strong>$ flatpak install gedit</strong></span> </p><p> <span class="command"><strong>$ flatpak install flathub org.gnome.gedit</strong></span> </p><p> <span class="command"><strong>$ flatpak --installation=default install flathub org.gnome.gedit</strong></span> </p><p> <span class="command"><strong>$ flatpak --user install flathub org.gnome.gedit//3.30</strong></span> </p><p> <span class="command"><strong>$ flatpak --user install https://flathub.org/repo/appstream/org.gnome.gedit.flatpakref</strong></span> </p><p> <span class="command"><strong>$ flatpak --system install org.gnome.gedit.flatpakref</strong></span> </p></div><div class="refsect1"><a id="id1418"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-update"><span class="citerefentry"><span class="refentrytitle">flatpak-update</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-list"><span class="citerefentry"><span class="refentrytitle">flatpak-list</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-build-bundle"><span class="citerefentry"><span class="refentrytitle">flatpak-build-bundle</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-flatpakref"><span class="citerefentry"><span class="refentrytitle">flatpak-flatpakref</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-make-current"><span class="citerefentry"><span class="refentrytitle">flatpak-make-current</span>(1)</span></a>, <a class="citerefentry" href="#ostree-find-remotes"><span class="citerefentry"><span class="refentrytitle">ostree-find-remotes</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-kill"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-kill — Stop a running application</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak kill</code> INSTANCE </p></div></div><div class="refsect1"><a id="id1419"></a><h2>Description</h2><p> Stop a running Flatpak instance. </p><p> INSTANCE can be either the numeric instance ID or the application ID of a running Flatpak. You can use <span class="command"><strong>flatpak ps</strong></span> to find the instance IDs of running flatpaks. </p></div><div class="refsect1"><a id="id1420"></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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1421"></a><h2>Examples</h2><p> <span class="command"><strong>$ flatpak kill org.gnome.Todo</strong></span> </p></div><div class="refsect1"><a id="id1422"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-run"><span class="citerefentry"><span class="refentrytitle">flatpak-run</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-ps"><span class="citerefentry"><span class="refentrytitle">flatpak-ps</span>(1)</span></a> </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="id1423"></a><h2>Description</h2><p> Lists the names of the installed applications and runtimes. </p><p> By default, both apps and runtimes are shown, but you can change this by using the <code class="option">--app</code> or <code class="option">--runtime</code> options. </p><p> By default, both per-user and system-wide installations are shown. Use the <code class="option">--user</code>, <code class="option">--installation</code> or <code class="option">--system</code> options to change this. </p><p> The list command can also be used to find installed apps that use a certain runtime, with the <code class="option">--app-runtime</code> option. </p></div><div class="refsect1"><a id="id1424"></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">-u</code>, </span><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 the default system-wide installations. </p></dd><dt><span class="term"><code class="option">--installation=NAME</code></span></dt><dd><p> List a system-wide installation specified by NAME among those defined in <code class="filename">/etc/flatpak/installations.d/</code>. Using <code class="option">--installation=default</code> is equivalent to using <code class="option">--system</code>. </p></dd><dt><span class="term"><code class="option">--arch=ARCH</code></span></dt><dd><p> List apps/runtimes for this architecture. See <span class="command"><strong>flatpak --supported-arches</strong></span> for architectures supported by the host. </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 origin, sizes and other extra information. Equivalent to <code class="option">--columns=all</code>. </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">--all</code>, </span><span class="term"><code class="option">-a</code></span></dt><dd><p> List all installed runtimes, including locale and debug extensions. These are hidden by default. </p></dd><dt><span class="term"><code class="option">--app-runtime=RUNTIME</code></span></dt><dd><p> List applications that use the given runtime. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd><dt><span class="term"><code class="option">--columns=FIELD,…</code></span></dt><dd><p> Specify what information to show about each ref. You can list multiple fields, or use this option multiple times. </p><p> Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization. </p></dd></dl></div></div><div class="refsect1"><a id="id1425"></a><h2>Fields</h2><p>The following fields are understood by the <code class="option">--columns</code> option:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">name</span></dt><dd><p> Show the name </p></dd><dt><span class="term">description</span></dt><dd><p> Show the description </p></dd><dt><span class="term">application</span></dt><dd><p> Show the application or runtime ID </p></dd><dt><span class="term">arch</span></dt><dd><p> Show the architecture </p></dd><dt><span class="term">branch</span></dt><dd><p> Show the branch </p></dd><dt><span class="term">runtime</span></dt><dd><p> Show the used runtime </p></dd><dt><span class="term">version</span></dt><dd><p> Show the version </p></dd><dt><span class="term">ref</span></dt><dd><p> Show the ref </p></dd><dt><span class="term">origin</span></dt><dd><p> Show the origin remote </p></dd><dt><span class="term">installation</span></dt><dd><p> Show the installation </p></dd><dt><span class="term">active</span></dt><dd><p> Show the active commit </p></dd><dt><span class="term">latest</span></dt><dd><p> Show the latest commit </p></dd><dt><span class="term">size</span></dt><dd><p> Show the installed size </p></dd><dt><span class="term">options</span></dt><dd><p> Show options </p></dd><dt><span class="term">all</span></dt><dd><p> Show all columns </p></dd><dt><span class="term">help</span></dt><dd><p> Show the list of available columns </p></dd></dl></div><p> Note that field names can be abbreviated to a unique prefix. </p></div><div class="refsect1"><a id="id1426"></a><h2>Examples</h2><p> <span class="command"><strong>$ flatpak --user --columns=app list</strong></span> </p><pre class="programlisting"> <span class="command"><strong>Application</strong></span> org.gnome.Builder org.freedesktop.glxgears org.gnome.MyApp org.gnome.gedit </pre></div><div class="refsect1"><a id="id1427"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-install"><span class="citerefentry"><span class="refentrytitle">flatpak-install</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-update"><span class="citerefentry"><span class="refentrytitle">flatpak-update</span>(1)</span></a> </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="id1428"></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 <code class="option">--user</code> or <code class="option">--installation</code> options, this command changes the default system-wide installation. </p></div><div class="refsect1"><a id="id1429"></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">-u</code>, </span><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 the default system-wide installation. </p></dd><dt><span class="term"><code class="option">--installation=NAME</code></span></dt><dd><p> Updates a system-wide installation specified by NAME among those defined in <code class="filename">/etc/flatpak/installations.d/</code>. Using <code class="option">--installation=default</code> is equivalent to using <code class="option">--system</code>. </p></dd><dt><span class="term"><code class="option">--arch=ARCH</code></span></dt><dd><p> The architecture to make current for. See <span class="command"><strong>flatpak --supported-arches</strong></span> for architectures supported by the host. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1430"></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="id1431"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-install"><span class="citerefentry"><span class="refentrytitle">flatpak-install</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-list"><span class="citerefentry"><span class="refentrytitle">flatpak-list</span>(1)</span></a> </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="id1432"></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 <span class="command"><strong>flatpak run</strong></span>, or every time by using <span class="command"><strong>flatpak override</strong></span>. </p><p> If the application ID APP is not specified then the overrides affect all applications, but the per-application overrides can override the global overrides. </p><p> Unless overridden with the <code class="option">--user</code> or <code class="option">--installation</code> options, this command changes the default system-wide installation. </p></div><div class="refsect1"><a id="id1433"></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">-u</code>, </span><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 the default system-wide installation. </p></dd><dt><span class="term"><code class="option">--installation=NAME</code></span></dt><dd><p> Updates a system-wide installation specified by NAME among those defined in <code class="filename">/etc/flatpak/installations.d/</code>. Using <code class="option">--installation=default</code> is equivalent to using <code class="option">--system</code>. </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, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth, pcsc, cups, gpg-agent. 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, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth, pcsc, cups, gpg-agent. 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, kvm, shm, 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, kvm, shm, all. This option can be used multiple times. </p></dd><dt><span class="term"><code class="option">--allow=FEATURE</code></span></dt><dd><p> Allow access to a specific feature. This updates the [Context] group in the metadata. FEATURE must be one of: devel, multiarch, bluetooth, canbus, per-app-dev-shm. This option can be used multiple times. </p><p> See <a class="citerefentry" href="#flatpak-build-finish"><span class="citerefentry"><span class="refentrytitle">flatpak-build-finish</span>(1)</span></a> for the meaning of the various features. </p></dd><dt><span class="term"><code class="option">--disallow=FEATURE</code></span></dt><dd><p> Disallow access to a specific feature. This updates the [Context] group in the metadata. FEATURE must be one of: devel, multiarch, bluetooth, canbus, per-app-dev-shm. This option can be used multiple times. </p></dd><dt><span class="term"><code class="option">--filesystem=FILESYSTEM</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, host-os, host-etc, xdg-desktop, xdg-documents, xdg-download, xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, xdg-config, xdg-cache, xdg-data, an absolute path, or a homedir-relative path like ~/dir or paths relative to the xdg dirs, like xdg-download/subdir. The optional :ro suffix indicates that the location will be read-only. The optional :create suffix indicates that the location will be read-write and created if it doesn't exist. This option can be used multiple times. See the "[Context] filesystems" list in <a class="citerefentry" href="#flatpak-metadata"><span class="citerefentry"><span class="refentrytitle">flatpak-metadata</span>(5)</span></a> for details of the meanings of these filesystems. </p></dd><dt><span class="term"><code class="option">--nofilesystem=FILESYSTEM</code></span></dt><dd><p> Undo the effect of a previous <code class="option">--filesystem=</code> FILESYSTEM in the app's manifest or a lower-precedence layer of overrides, and/or remove a previous <code class="option">--filesystem=</code> FILESYSTEM from this layer of overrides. This overrides the Context section of the application metadata. FILESYSTEM can take the same values as for <code class="option">--filesystem</code>, but the :ro and :create suffixes are not used here. This option can be used multiple times. </p><p> This option does not prevent access to a more narrowly-scoped <code class="option">--filesystem</code>. For example, if an application has the equivalent of <code class="option">--filesystem=xdg-config/MyApp</code> in its manifest or as a system-wide override, and <code class="literal">flatpak override --user --nofilesystem=home</code> as a per-user override, then it will be prevented from accessing most of the home directory, but it will still be allowed to access <code class="filename">$XDG_CONFIG_HOME/MyApp</code>. </p><p> As a special case, <code class="option">--nofilesystem=host:reset</code> will ignore all <code class="option">--filesystem</code> permissions inherited from the app manifest or a lower-precedence layer of overrides, in addition to having the behaviour of <code class="option">--nofilesystem=host</code>. </p></dd><dt><span class="term"><code class="option">--add-policy=SUBSYSTEM.KEY=VALUE</code></span></dt><dd><p> Add generic policy option. For example, "--add-policy=subsystem.key=v1 --add-policy=subsystem.key=v2" would map to this metadata: </p><pre class="programlisting"> [Policy subsystem] key=v1;v2; </pre><p> </p><p> This option can be used multiple times. </p></dd><dt><span class="term"><code class="option">--remove-policy=SUBSYSTEM.KEY=VALUE</code></span></dt><dd><p> Remove generic policy option. 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">--unset-env=VAR</code></span></dt><dd><p> Unset an environment variable in the application. This overrides the unset-environment entry in the [Context] group of the metadata, and the [Environment] group. This option can be used multiple times. </p></dd><dt><span class="term"><code class="option">--env-fd=<em class="replaceable"><code>FD</code></em></code></span></dt><dd><p> Read environment variables from the file descriptor <em class="replaceable"><code>FD</code></em>, and set them as if via <code class="option">--env</code>. This can be used to avoid environment variables and their values becoming visible to other users. </p><p> Each environment variable is in the form <em class="replaceable"><code>VAR</code></em>=<em class="replaceable"><code>VALUE</code></em> followed by a zero byte. This is the same format used by <code class="literal">env -0</code> and <code class="filename">/proc/*/environ</code>. </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">--no-talk-name=NAME</code></span></dt><dd><p> Don't 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">--system-no-talk-name=NAME</code></span></dt><dd><p> Don't 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">--reset</code></span></dt><dd><p> Remove overrides. If an APP is given, remove the overrides for that application, otherwise remove the global overrides. </p></dd><dt><span class="term"><code class="option">--show</code></span></dt><dd><p> Shows overrides. If an APP is given, shows the overrides for that application, otherwise shows the global overrides. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1434"></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="id1435"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-run"><span class="citerefentry"><span class="refentrytitle">flatpak-run</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-permission-remove"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-permission-remove — Remove permissions</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak permission-remove</code> [OPTION...] TABLE ID [APP_ID]</p></div></div><div class="refsect1"><a id="id1436"></a><h2>Description</h2><p> Removes an entry for the object with id ID to the permission store table TABLE . The ID must be in a suitable format for the table. If APP_ID is specified, only the entry for that application is removed. </p><p> The permission store is used by portals. Each portal generally has its own table in the permission store, and the format of the table entries is specific to each portal. </p></div><div class="refsect1"><a id="id1437"></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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1438"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-permissions"><span class="citerefentry"><span class="refentrytitle">flatpak-permissions</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-permission-show"><span class="citerefentry"><span class="refentrytitle">flatpak-permission-show</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-permission-reset"><span class="citerefentry"><span class="refentrytitle">flatpak-permission-reset</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-permission-set"><span class="citerefentry"><span class="refentrytitle">flatpak-permission-set</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-permissions"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-permissions — List permissions</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak permissions</code> [OPTION...] [TABLE] [ID]</p></div></div><div class="refsect1"><a id="id1439"></a><h2>Description</h2><p> Lists dynamic permissions which are stored in the Flatpak permission store. </p><p> When called without arguments, lists all the entries in all permission store tables. When called with one argument, lists all the entries in the named table. When called with two arguments, lists the entry in the named table for the given object ID . </p><p> The permission store is used by portals. Each portal generally has its own table in the permission store, and the format of the table entries is specific to each portal. </p></div><div class="refsect1"><a id="id1440"></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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1441"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-permission-show"><span class="citerefentry"><span class="refentrytitle">flatpak-permission-show</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-permission-remove"><span class="citerefentry"><span class="refentrytitle">flatpak-permission-remove</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-permission-reset"><span class="citerefentry"><span class="refentrytitle">flatpak-permission-reset</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-permission-set"><span class="citerefentry"><span class="refentrytitle">flatpak-permission-set</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-permission-show"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-permission-show — Show permissions</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak permission-show</code> [OPTION...] APP_ID </p></div></div><div class="refsect1"><a id="id1442"></a><h2>Description</h2><p> Lists dynamic permissions for the given app which are stored in the Flatpak permission store. </p><p> When called without arguments, lists all the entries in all permission store tables. When called with one argument, lists all the entries in the named table. When called with two arguments, lists the entry in the named table for the given object ID. </p><p> The permission store is used by portals. Each portal generally has its own table in the permission store, and the format of the table entries is specific to each portal. </p></div><div class="refsect1"><a id="id1443"></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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1444"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-permissions"><span class="citerefentry"><span class="refentrytitle">flatpak-permissions</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-permission-remove"><span class="citerefentry"><span class="refentrytitle">flatpak-permission-remove</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-permission-reset"><span class="citerefentry"><span class="refentrytitle">flatpak-permission-reset</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-permission-set"><span class="citerefentry"><span class="refentrytitle">flatpak-permission-set</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-permission-reset"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-permission-reset — Reset permissions</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak permission-reset</code> [OPTION...] APP_ID </p></div><div class="cmdsynopsis"><p><code class="command">flatpak permission-reset</code> [OPTION...] --all </p></div></div><div class="refsect1"><a id="id1445"></a><h2>Description</h2><p> Removes all permissions for the given app from the Flatpak permission store. </p><p> The permission store is used by portals. Each portal generally has its own table in the permission store, and the format of the table entries is specific to each portal. </p></div><div class="refsect1"><a id="id1446"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">--all</code></span></dt><dd><p> Remove permissions for all applications. </p></dd><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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1447"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-permissions"><span class="citerefentry"><span class="refentrytitle">flatpak-permissions</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-permission-show"><span class="citerefentry"><span class="refentrytitle">flatpak-permission-show</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-permission-remove"><span class="citerefentry"><span class="refentrytitle">flatpak-permission-remove</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-permission-set"><span class="citerefentry"><span class="refentrytitle">flatpak-permission-set</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-permission-set"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-permission-set — Set permissions</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak permission-set</code> [OPTION...] TABLE ID APP_ID [PERMISSION...]</p></div></div><div class="refsect1"><a id="id1448"></a><h2>Description</h2><p> Set the permissions for an application in an entry in the permission store. The entry is identified by TABLE and ID, the application is identified by APP_ID. The PERMISSION strings must be in a format suitable for the table. </p><p> The permission store is used by portals. Each portal generally has its own table in the permission store, and the format of the table entries is specific to each portal. </p></div><div class="refsect1"><a id="id1449"></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">--data=DATA</code></span></dt><dd><p> Associate DATA with the entry. The data must be a serialized GVariant. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1450"></a><h2>Examples</h2><p> <span class="command"><strong>$ flatpak permission-set --data "{'always-ask':<true>}" desktop-used-apps text/plain org.mozilla.Firefox org.gnome.gedit 0 3</strong></span> </p></div><div class="refsect1"><a id="id1451"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-permissions"><span class="citerefentry"><span class="refentrytitle">flatpak-permissions</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-permission-remove"><span class="citerefentry"><span class="refentrytitle">flatpak-permission-remove</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-permission-reset"><span class="citerefentry"><span class="refentrytitle">flatpak-permission-reset</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-permission-show"><span class="citerefentry"><span class="refentrytitle">flatpak-permission-show</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-ps"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-ps — Enumerate running instances</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak ps</code> [OPTION...]</p></div></div><div class="refsect1"><a id="id1452"></a><h2>Description</h2><p> Lists useful information about running Flatpak instances. </p><p> To see full details of a running instance, you can open the file <code class="filename">/run/user/$UID/.flatpak/$INSTANCE/info</code>, where <em class="replaceable"><code>$INSTANCE</code></em> is the instance ID reported by flatpak ps. </p></div><div class="refsect1"><a id="id1453"></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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd><dt><span class="term"><code class="option">--columns=FIELD,…</code></span></dt><dd><p> Specify what information to show about each instance. You can list multiple fields, or use this option multiple times. </p><p> Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization. </p></dd></dl></div></div><div class="refsect1"><a id="id1454"></a><h2>Fields</h2><p>The following fields are understood by the <code class="option">--columns</code> option:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">instance</span></dt><dd><p> Show the instance ID </p></dd><dt><span class="term">application</span></dt><dd><p> Show the application ID </p></dd><dt><span class="term">arch</span></dt><dd><p> Show the architecture </p></dd><dt><span class="term">branch</span></dt><dd><p> Show the application branch </p></dd><dt><span class="term">commit</span></dt><dd><p> Show the application commit </p></dd><dt><span class="term">runtime</span></dt><dd><p> Show the runtime ID </p></dd><dt><span class="term">runtime-branch</span></dt><dd><p> Show the runtime branch </p></dd><dt><span class="term">runtime-commit</span></dt><dd><p> Show the runtime commit </p></dd><dt><span class="term">pid</span></dt><dd><p> Show the PID of the wrapper process </p></dd><dt><span class="term">child-pid</span></dt><dd><p> Show the PID of the sandbox process </p></dd><dt><span class="term">active</span></dt><dd><p> Show whether the app is active (i.e. has an active window) </p></dd><dt><span class="term">background</span></dt><dd><p> Show whether the app is in the background (with no open windows) </p></dd><dt><span class="term">all</span></dt><dd><p> Show all columns </p></dd><dt><span class="term">help</span></dt><dd><p> Show the list of available columns </p></dd></dl></div><p> Note that field names can be abbreviated to a unique prefix. </p></div><div class="refsect1"><a id="id1455"></a><h2>Examples</h2><p> <span class="command"><strong>$ flatpak ps --columns=application,pid,runtime,runtime-branch</strong></span> </p></div><div class="refsect1"><a id="id1456"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-run"><span class="citerefentry"><span class="refentrytitle">flatpak-run</span>(1)</span></a> </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="id1457"></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 a url or pathname. The LOCATION is either a flatpak repository, or a <code class="filename">.flatpakrepo</code> file which describes a repository. In the former case you may also have to specify extra options, such as the gpg key for the repo. </p><p> Unless overridden with the <code class="option">--user</code> or <code class="option">--installation</code> options, this command changes the default system-wide installation. </p></div><div class="refsect1"><a id="id1458"></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">--from</code></span></dt><dd><p> Assume the URI is a .flatpakrepo file rather than the repository itself. This is enabled by default if the extension is .flatpakrepo, so generally you don't need this option. </p></dd><dt><span class="term"><code class="option">-u</code>, </span><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 default system-wide configuration. </p></dd><dt><span class="term"><code class="option">--installation=NAME</code></span></dt><dd><p> Modify a system-wide installation specified by NAME among those defined in <code class="filename">/etc/flatpak/installations.d/</code>. Using <code class="option">--installation=default</code> is equivalent to using <code class="option">--system</code>. </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. It is also used when searching for a remote to provide an app's runtime. The app's origin is checked before other remotes with the same priority. </p></dd><dt><span class="term"><code class="option">--subset=SUBSET</code></span></dt><dd><p> Limit the refs available from the remote to those that are part of the named subset. </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">--no-use-for-deps</code></span></dt><dd><p> Mark the remote as not to be used for automatic runtime dependency resolution. </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">--comment=COMMENT</code></span></dt><dd><p> A single-line comment for the remote, e.g. for display in a UI. </p></dd><dt><span class="term"><code class="option">--description=DESCRIPTION</code></span></dt><dd><p> A full-paragraph description for the remote, e.g. for display in a UI. </p></dd><dt><span class="term"><code class="option">--homepage=URL</code></span></dt><dd><p> URL for a website for the remote, e.g. for display in a UI. </p></dd><dt><span class="term"><code class="option">--icon=URL</code></span></dt><dd><p> URL for an icon for the remote, e.g. for display in a UI. </p></dd><dt><span class="term"><code class="option">--default-branch=BRANCH</code></span></dt><dd><p> A default branch for the remote, mainly for use in a UI. </p></dd><dt><span class="term"><code class="option">--filter=PATH</code></span></dt><dd><p> Add a local filter to the remote. A filter file is a list of lines, each file starting with "allow" or "deny", and then a glob for the ref to allow or disallow. The globs specify a partial ref (i.e. you can leave out trailing parts which will then match everything), but otherwise only "*" is special, matching anything in that part of the ref. </p><p> By default all refs are allowed, but if a ref matches a deny rule it is disallowed unless it specifically matches an allow rule. This means you can use this to implement both allowlisting and blocklisting. </p><p> Here is an example filter file: </p><pre class="programlisting"> # This is an allowlist style filter as it denies all first deny * allow runtime/org.freedesktop.* allow org.some.app/arm allow org.signal.Signal/*/stable allow org.signal.Signal.*/*/stable </pre><p> </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">--authenticator-name=NAME</code></span></dt><dd><p> Specify the authenticator to use for the remote. </p></dd><dt><span class="term"><code class="option">--authenticator-option=KEY=VALUE</code></span></dt><dd><p> Specify an authenticator option for the remote. </p></dd><dt><span class="term"><code class="option">--authenticator-install</code></span></dt><dd><p> Enable auto-installation of authenticator. </p></dd><dt><span class="term"><code class="option">--no-authenticator-install</code></span></dt><dd><p> Disable auto-installation of authenticator. </p></dd><dt><span class="term"><code class="option">--no-follow-redirect</code></span></dt><dd><p> Do not follow xa.redirect-url defined in the summary file. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1459"></a><h2>Examples</h2><p> <span class="command"><strong>$ flatpak remote-add gnome https://sdk.gnome.org/gnome.flatpakrepo</strong></span> </p><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="id1460"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-remote-modify"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-modify</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-remote-delete"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-delete</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-remotes"><span class="citerefentry"><span class="refentrytitle">flatpak-remotes</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-flatpakrepo"><span class="citerefentry"><span class="refentrytitle">flatpak-flatpakrepo</span>(5)</span></a> </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="id1461"></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 <code class="option">--system</code>, <code class="option">--user</code>, or <code class="option">--installation</code> options, this command uses either the default system-wide installation or the per-user one, depending on which has the specified REMOTE . </p></div><div class="refsect1"><a id="id1462"></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">-u</code>, </span><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 default system-wide configuration. </p></dd><dt><span class="term"><code class="option">--installation=NAME</code></span></dt><dd><p> Modify a system-wide installation specified by NAME among those defined in <code class="filename">/etc/flatpak/installations.d/</code>. Using <code class="option">--installation=default</code> is equivalent to using <code class="option">--system</code>. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1463"></a><h2>Examples</h2><p> <span class="command"><strong>$ flatpak --user remote-delete dried-raisins</strong></span> </p></div><div class="refsect1"><a id="id1464"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-remote-add"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-add</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-remote-modify"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-modify</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-remotes"><span class="citerefentry"><span class="refentrytitle">flatpak-remotes</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-remote-info"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-remote-info — Show information about an application or runtime in a remote</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak remote-info</code> [OPTION...] REMOTE REF </p></div></div><div class="refsect1"><a id="id1465"></a><h2>Description</h2><p> Shows information about the runtime or application REF from the remote repository with the name REMOTE . You can find all configured remote repositories with flatpak remotes. </p><p> By default, the output is formatted in a friendly format. If you specify one of the <code class="option">--show-…</code> options, the output is instead formatted in a machine-readable format. </p><p> Unless overridden with the <code class="option">--system</code>, <code class="option">--user</code>, or <code class="option">--installation</code> options, this command uses either the default system-wide installation or the per-user one, depending on which has the specified REMOTE . </p></div><div class="refsect1"><a id="id1466"></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">-u</code>, </span><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 default system-wide configuration. </p></dd><dt><span class="term"><code class="option">--installation=NAME</code></span></dt><dd><p> Use a system-wide installation specified by NAME among those defined in <code class="filename">/etc/flatpak/installations.d/</code>. Using <code class="option">--installation=default</code> is equivalent to using <code class="option">--system</code>. </p></dd><dt><span class="term"><code class="option">--cached</code></span></dt><dd><p> Prefer to use locally cached information if possible, even though it may be out of date. This is faster, but risks returning stale information. Also, some information is not cached so will not be available. </p></dd><dt><span class="term"><code class="option">--runtime</code></span></dt><dd><p> Assume that REF is a runtime if not explicitly specified. </p></dd><dt><span class="term"><code class="option">--app</code></span></dt><dd><p> Assume that REF is an app if not explicitly specified. </p></dd><dt><span class="term"><code class="option">--arch=ARCH</code></span></dt><dd><p> The default architecture to look for, if not given explicitly in the REF . See <span class="command"><strong>flatpak --supported-arches</strong></span> for architectures supported by the host. </p></dd><dt><span class="term"><code class="option">--commit=COMMIT</code></span></dt><dd><p> Show information about the specific commit, rather than the latest version. </p></dd><dt><span class="term"><code class="option">--log</code></span></dt><dd><p> Display a log of previous versions. </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 matched ref. </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 commit id. </p></dd><dt><span class="term"><code class="option">-p</code>, </span><span class="term"><code class="option">--show-parent</code></span></dt><dd><p> Show the parent commit id. </p></dd><dt><span class="term"><code class="option">-m</code>, </span><span class="term"><code class="option">--show-metadata</code></span></dt><dd><p> Show the metadata. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1467"></a><h2>Examples</h2><p> <span class="command"><strong>$ flatpak --user remote-info flathub org.gnome.gedit</strong></span> </p><pre class="programlisting"> Ref: app/org.gnome.gedit/x86_64/stable ID: org.gnome.gedit Arch: x86_64 Branch: stable Date: 2017-07-31 16:05:22 +0000 Subject: Build org.gnome.gedit at 3ec291fc1ce4d78220527fa79576f4cc1481ebe5 Commit: 3de7e9dde3bb8382aad9dfbbff20eccd9bf2100bc1887a3619ec0372e8066bf7 Parent: - Download size: 3,4 MB Installed size: 11,1 MB Runtime: org.gnome.Platform/x86_64/3.24 </pre></div><div class="refsect1"><a id="id1468"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-remotes"><span class="citerefentry"><span class="refentrytitle">flatpak-remotes</span>(1)</span></a> <a class="citerefentry" href="#flatpak-remote-ls"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-ls</span>(1)</span></a> </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="id1469"></a><h2>Description</h2><p> Shows runtimes and applications that are available in the remote repository with the name REMOTE , or all remotes if one isn't specified. You can find all configured remote repositories with <span class="command"><strong>flatpak remotes</strong></span>. </p><p> REMOTE can be a file:// URI pointing to a local repository instead of a remote name. </p><p> Unless overridden with the <code class="option">--system</code>, <code class="option">--user</code>, or <code class="option">--installation</code> options, this command uses either the default system-wide installation or the per-user one, depending on which has the specified REMOTE . </p></div><div class="refsect1"><a id="id1470"></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">-u</code>, </span><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 default system-wide configuration. </p></dd><dt><span class="term"><code class="option">--installation=NAME</code></span></dt><dd><p> Use a system-wide installation specified by NAME among those defined in <code class="filename">/etc/flatpak/installations.d/</code>. Using <code class="option">--installation=default</code> is equivalent to using <code class="option">--system</code>. </p></dd><dt><span class="term"><code class="option">--cached</code></span></dt><dd><p> Prefer to use locally cached information if possible, even though it may be out of date. This is faster, but risks returning stale information. </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. Equivalent to <code class="option">--columns=all</code>. </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">--all</code>, </span><span class="term"><code class="option">-a</code></span></dt><dd><p> Show everything. By default locale and debug extensions as well as secondary arches when the primary arch is available are hidden. </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 specified architecture. By default, only supported architectures are shown. Use <code class="option">--arch=*</code> to show all architectures. See <span class="command"><strong>flatpak --supported-arches</strong></span> for architectures supported by the host. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd><dt><span class="term"><code class="option">--app-runtime=RUNTIME</code></span></dt><dd><p> List applications that use the given runtime </p></dd><dt><span class="term"><code class="option">--columns=FIELD,…</code></span></dt><dd><p> Specify what information to show about each ref. You can list multiple fields, or use this option multiple times. </p><p> Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization. </p></dd></dl></div></div><div class="refsect1"><a id="id1471"></a><h2>Fields</h2><p>The following fields are understood by the <code class="option">--columns</code> option:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">name</span></dt><dd><p> Show the name </p></dd><dt><span class="term">description</span></dt><dd><p> Show the application description </p></dd><dt><span class="term">application</span></dt><dd><p> Show the application or runtime ID </p></dd><dt><span class="term">arch</span></dt><dd><p> Show the arch </p></dd><dt><span class="term">branch</span></dt><dd><p> Show the branch </p></dd><dt><span class="term">version</span></dt><dd><p> Show the version </p></dd><dt><span class="term">ref</span></dt><dd><p> Show the ref </p></dd><dt><span class="term">origin</span></dt><dd><p> Show the origin remote </p></dd><dt><span class="term">commit</span></dt><dd><p> Show the active commit </p></dd><dt><span class="term">runtime</span></dt><dd><p> Show the used runtime </p></dd><dt><span class="term">installed-size</span></dt><dd><p> Show the installed size </p></dd><dt><span class="term">download-size</span></dt><dd><p> Show the download size </p></dd><dt><span class="term">options</span></dt><dd><p> Show options </p></dd><dt><span class="term">all</span></dt><dd><p> Show all columns </p></dd><dt><span class="term">help</span></dt><dd><p> Show the list of available columns </p></dd></dl></div><p> Note that field names can be abbreviated to a unique prefix. </p></div><div class="refsect1"><a id="id1472"></a><h2>Examples</h2><p> <span class="command"><strong>$ flatpak --user remote-ls --app testrepo</strong></span> </p><pre class="programlisting"> Ref org.gnome.Builder org.freedesktop.glxgears </pre><p> <span class="command"><strong>$ flatpak remote-ls file:///run/media/mwleeds/d4d37026-cde2-4e5e-8bcc-d23ebbf231f9/.ostree/repo</strong></span> </p><pre class="programlisting"> Ref org.kde.Khangman </pre></div><div class="refsect1"><a id="id1473"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-remotes"><span class="citerefentry"><span class="refentrytitle">flatpak-remotes</span>(1)</span></a> </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="id1474"></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 <code class="option">--system</code>, <code class="option">--user</code>, or <code class="option">--installation</code> options, this command uses either the default system-wide installation or the per-user one, depending on which has the specified REMOTE . </p></div><div class="refsect1"><a id="id1475"></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">-u</code>, </span><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 default system-wide configuration. </p></dd><dt><span class="term"><code class="option">--installation=NAME</code></span></dt><dd><p> Modify a system-wide installation specified by NAME among those defined in <code class="filename">/etc/flatpak/installations.d/</code>. Using <code class="option">--installation=default</code> is equivalent to using <code class="option">--system</code>. </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">--subset=SUBSET</code></span></dt><dd><p> Limit the refs available from the remote to those that are part of the named subset. </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. It will also not be used for runtime dependency resolution (as with <code class="option">--no-use-for-deps</code>). </p></dd><dt><span class="term"><code class="option">--no-use-for-deps</code></span></dt><dd><p> Mark the remote as not to be used for automatic runtime dependency resolution. </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">--use-for-deps</code></span></dt><dd><p> Mark the remote as to be used for automatic runtime dependency resolution. </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">--comment=COMMENT</code></span></dt><dd><p> A single-line comment for the remote, e.g. for display in a UI. </p></dd><dt><span class="term"><code class="option">--description=DESCRIPTION</code></span></dt><dd><p> A full-paragraph description for the remote, e.g. for display in a UI. </p></dd><dt><span class="term"><code class="option">--homepage=URL</code></span></dt><dd><p> URL for a website for the remote, e.g. for display in a UI. </p></dd><dt><span class="term"><code class="option">--icon=URL</code></span></dt><dd><p> URL for an icon for the remote, e.g. for display in a UI. </p></dd><dt><span class="term"><code class="option">--default-branch=BRANCH</code></span></dt><dd><p> A default branch for the remote, mainly for use in a UI. </p></dd><dt><span class="term"><code class="option">--collection-id=COLLECTION-ID</code></span></dt><dd><p> The globally unique identifier of the remote repository, to allow mirrors to be grouped. This must only be set to the collection ID provided by the remote, and must not be set if the remote does not provide a collection ID. </p></dd><dt><span class="term"><code class="option">--url=URL</code></span></dt><dd><p> Set a new URL. </p></dd><dt><span class="term"><code class="option">--update-metadata</code></span></dt><dd><p> Update the remote's extra metadata from the OSTree repository's summary file. Only xa.title and xa.default-branch are supported at the moment. </p></dd><dt><span class="term"><code class="option">--no-filter</code>, </span><span class="term"><code class="option">--filter=FILE</code></span></dt><dd><p> Modify the path (or unset) for the local filter used for this remote. See <a class="citerefentry" href="#flatpak-remote-add"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-add</span>(1)</span></a> for details about the filter file format. </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">--authenticator-name=NAME</code></span></dt><dd><p> Specify the authenticator to use for the remote. </p></dd><dt><span class="term"><code class="option">--authenticator-option=KEY=VALUE</code></span></dt><dd><p> Specify an authenticator option for the remote. </p></dd><dt><span class="term"><code class="option">--authenticator-install</code></span></dt><dd><p> Enable auto-installation of authenticator. </p></dd><dt><span class="term"><code class="option">--no-authenticator-install</code></span></dt><dd><p> Disable auto-installation of authenticator. </p></dd><dt><span class="term"><code class="option">--follow-redirect</code></span></dt><dd><p> Follow xa.redirect-url defined in the summary file. </p></dd><dt><span class="term"><code class="option">--no-follow-redirect</code></span></dt><dd><p> Do not follow xa.redirect-url defined in the summary file. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1476"></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="id1477"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-remote-add"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-add</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-remote-delete"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-delete</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-remotes"><span class="citerefentry"><span class="refentrytitle">flatpak-remotes</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-remotes"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-remotes — List remote repositories</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak remotes</code> [OPTION...]</p></div></div><div class="refsect1"><a id="id1478"></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 <code class="option">--user</code>, <code class="option">--system</code> or <code class="option">--installation</code> options to change this. </p></div><div class="refsect1"><a id="id1479"></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">-u</code>, </span><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 default system-wide configuration. </p></dd><dt><span class="term"><code class="option">--installation=NAME</code></span></dt><dd><p> Show a system-wide installation by NAME among those defined in <code class="filename">/etc/flatpak/installations.d/</code>. Using <code class="option">--installation=default</code> is equivalent to using <code class="option">--system</code>. </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 more information for each repository in addition to the name. Equivalent to <code class="option">--columns=all</code>. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd><dt><span class="term"><code class="option">--columns=FIELD,…</code></span></dt><dd><p> Specify what information to show about each ref. You can list multiple fields, or use this option multiple times. </p><p> Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization. </p></dd></dl></div></div><div class="refsect1"><a id="id1480"></a><h2>Fields</h2><p>The following fields are understood by the <code class="option">--columns</code> option:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">name</span></dt><dd><p> Show the name of the remote </p></dd><dt><span class="term">title</span></dt><dd><p> Show the title of the remote </p></dd><dt><span class="term">url</span></dt><dd><p> Show the URL of the remote </p></dd><dt><span class="term">filter</span></dt><dd><p> Show the path to the client-side filter of the remote. </p></dd><dt><span class="term">collection</span></dt><dd><p> Show the collection ID of the remote </p></dd><dt><span class="term">priority</span></dt><dd><p> Show the priority of the remote </p></dd><dt><span class="term">options</span></dt><dd><p> Show options </p></dd><dt><span class="term">comment</span></dt><dd><p> Show comment </p></dd><dt><span class="term">description</span></dt><dd><p> Show description </p></dd><dt><span class="term">homepage</span></dt><dd><p> Show homepage </p></dd><dt><span class="term">icon</span></dt><dd><p> Show icon </p></dd><dt><span class="term">all</span></dt><dd><p> Show all columns </p></dd><dt><span class="term">help</span></dt><dd><p> Show the list of available columns </p></dd></dl></div><p> Note that field names can be abbreviated to a unique prefix. </p></div><div class="refsect1"><a id="id1481"></a><h2>Examples</h2><p> <span class="command"><strong>$ flatpak remotes --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="id1482"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-remote-add"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-add</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-remote-delete"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-delete</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-repair"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-repair — Repair a flatpak installation</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak repair</code> [OPTION...]</p></div></div><div class="refsect1"><a id="id1483"></a><h2>Description</h2><p> Repair a flatpak installation by pruning and reinstalling invalid objects. The repair command does all of the following: </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> Scan all locally available refs, removing any that don't correspond to a deployed ref. </p></li><li class="listitem"><p> Verify each commit they point to, removing any invalid objects and noting any missing objects. </p></li><li class="listitem"><p> Remove any refs that had an invalid object, and any non-partial refs that had missing objects. </p></li><li class="listitem"><p> Prune all objects not referenced by a ref, which gets rid of any possibly invalid non-scanned objects. </p></li><li class="listitem"><p> Enumerate all deployed refs and re-install any that are not in the repo (or are partial for a non-subdir deploy). </p></li></ul></div><p> Note that <span class="command"><strong>flatpak repair</strong></span> has to be run with root privileges to operate on the system installation. </p><p> An alternative command for repairing OSTree repositories is ostree fsck. </p></div><div class="refsect1"><a id="id1484"></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">-u</code>, </span><span class="term"><code class="option">--user</code></span></dt><dd><p> Repair per-user installation. </p></dd><dt><span class="term"><code class="option">--system</code></span></dt><dd><p> Repair system-wide installation. </p></dd><dt><span class="term"><code class="option">--installation=NAME</code></span></dt><dd><p> Repair the system-wide installation specified by NAME among those defined in <code class="filename">/etc/flatpak/installations.d/</code>. Using --installation=default is equivalent to using --system . </p></dd><dt><span class="term"><code class="option">--dry-run</code></span></dt><dd><p> Only report inconsistencies, don't make any changes </p></dd><dt><span class="term"><code class="option">--reinstall-all</code></span></dt><dd><p> Reinstall all refs, regardless of whether they were removed from the repo or not </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1485"></a><h2>Examples</h2><p> <span class="command"><strong>$ sudo flatpak repair</strong></span> </p><p> <span class="command"><strong>$ flatpak repair --user</strong></span> </p></div><div class="refsect1"><a id="id1486"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#ostree-fsck"><span class="citerefentry"><span class="refentrytitle">ostree-fsck</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-repo"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-repo — Show information about a local repository</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak repo</code> [OPTION...] LOCATION </p></div></div><div class="refsect1"><a id="id1487"></a><h2>Description</h2><p> Show information about a local repository. </p><p> If you need to modify a local repository, see the <span class="command"><strong>flatpak build-update-repo</strong></span> command, or use the <span class="command"><strong>ostree</strong></span> tool. </p></div><div class="refsect1"><a id="id1488"></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">--info</code></span></dt><dd><p> Print general information about a local repository. </p></dd><dt><span class="term"><code class="option">--branches</code></span></dt><dd><p> List the branches in a local repository. </p></dd><dt><span class="term"><code class="option">--metadata=BRANCH</code></span></dt><dd><p> Print metadata for a branch in the repository. </p></dd><dt><span class="term"><code class="option">--commits=BRANCH</code></span></dt><dd><p> Show commits and deltas for a branch in the repository. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1489"></a><h2>Examples</h2><p> <span class="command"><strong>$ flatpak repo --info ~/my-repo</strong></span> </p></div><div class="refsect1"><a id="id1490"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-info"><span class="citerefentry"><span class="refentrytitle">flatpak-info</span>(1)</span></a> <a class="citerefentry" href="#flatpak-build-update-repo"><span class="citerefentry"><span class="refentrytitle">flatpak-build-update-repo</span>(1)</span></a> <a class="citerefentry" href="#ostree"><span class="citerefentry"><span class="refentrytitle">ostree</span>(1)</span></a> </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 or open a shell in a runtime</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak run</code> [OPTION...] REF [ARG...]</p></div></div><div class="refsect1"><a id="id1491"></a><h2>Description</h2><p> If REF names an installed application, Flatpak runs the application in a sandboxed environment. Extra arguments are passed on to the application. The current branch and arch of the application is used unless otherwise specified with <code class="option">--branch</code> or <code class="option">--arch</code>. See <a class="citerefentry" href="#flatpak-make-current"><span class="citerefentry"><span class="refentrytitle">flatpak-make-current</span>(1)</span></a>. </p><p> If REF names a runtime, a shell is opened in the runtime. This is useful for development and testing. If there is ambiguity about which branch to use, you will be prompted to choose. Use <code class="option">--branch</code> to avoid this. The primary arch is used unless otherwise specified with <code class="option">--arch</code>. </p><p> By default, Flatpak will look for the application or runtime in the per-user installation first, then in all system installations. This can be overridden with the <code class="option">--user</code>, <code class="option">--system</code> and <code class="option">--installation</code> options. </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 <code class="option">--share</code> and <code class="option">--socket</code> 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><p> The remaining arguments are passed to the command that gets run in the sandboxed environment. See the <code class="option">--file-forwarding</code> option for handling of file arguments. </p><p> Environment variables are generally passed on to the sandboxed application, with certain exceptions. The application metadata can override environment variables, as well as the <code class="option">--env</code> option. Apart from that, Flatpak always unsets or overrides the following variables, since their session values are likely to interfere with the functioning of the sandbox: </p><table border="0" summary="Simple list" class="simplelist"><tr><td>PATH</td></tr><tr><td>LD_LIBRARY_PATH</td></tr><tr><td>XDG_CONFIG_DIRS</td></tr><tr><td>XDG_DATA_DIRS</td></tr><tr><td>XDG_RUNTIME_DIR</td></tr><tr><td>SHELL</td></tr><tr><td>TEMP</td></tr><tr><td>TEMPDIR</td></tr><tr><td>TMP</td></tr><tr><td>TMPDIR</td></tr><tr><td>PYTHONPATH</td></tr><tr><td>PERLLIB</td></tr><tr><td>PERL5LIB</td></tr><tr><td>XCURSOR_PATH</td></tr><tr><td>KRB5CCNAME</td></tr><tr><td>XKB_CONFIG_ROOT</td></tr><tr><td>GIO_EXTRA_MODULES</td></tr><tr><td>GDK_BACKEND</td></tr><tr><td>VK_DRIVER_FILES</td></tr><tr><td>VK_ICD_FILENAMES</td></tr></table><p> Also several environment variables with the prefix "GST_" that are used by gstreamer are unset (since Flatpak 1.12.5). </p><p> Flatpak also overrides the XDG environment variables to point sandboxed applications at their writable filesystem locations below <code class="filename">~/.var/app/$APPID/</code>: </p><table border="0" summary="Simple list" class="simplelist"><tr><td>XDG_DATA_HOME</td></tr><tr><td>XDG_CONFIG_HOME</td></tr><tr><td>XDG_CACHE_HOME</td></tr><tr><td>XDG_STATE_HOME (since Flatpak 1.13)</td></tr></table><p> Apps can use the <code class="option">--persist=.local/state</code> and <code class="option">--unset-env=XDG_STATE_HOME</code> options to get a Flatpak 1.13-compatible <code class="filename">~/.local/state</code> on older versions of Flatpak. </p><p> The host values of these variables are made available inside the sandbox via these HOST_-prefixed variables: </p><table border="0" summary="Simple list" class="simplelist"><tr><td>HOST_XDG_DATA_HOME</td></tr><tr><td>HOST_XDG_CONFIG_HOME</td></tr><tr><td>HOST_XDG_CACHE_HOME</td></tr><tr><td>HOST_XDG_STATE_HOME (since Flatpak 1.13)</td></tr></table><p> Flatpak sets the environment variable <code class="envar">FLATPAK_ID</code> to the application ID of the running app. </p><p> Flatpak also bind-mounts as read-only the host's <code class="filename">/etc/os-release</code> (if available, or <code class="filename">/usr/lib/os-release</code> as a fallback) to <code class="filename">/run/host/os-release</code> in accordance with the <a class="ulink" href="https://www.freedesktop.org/software/systemd/man/os-release.html" target="_top"> os-release specification</a>. </p><p> If parental controls support is enabled, flatpak will check the current user’s parental controls settings, and will refuse to run an app if it is blocklisted for the current user. </p></div><div class="refsect1"><a id="id1492"></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">-u</code>, </span><span class="term"><code class="option">--user</code></span></dt><dd><p> Look for the application and runtime in per-user installations. </p></dd><dt><span class="term"><code class="option">--system</code></span></dt><dd><p> Look for the application and runtime in the default system-wide installations. </p></dd><dt><span class="term"><code class="option">--installation=NAME</code></span></dt><dd><p> Look for the application and runtime in the system-wide installation specified by NAME among those defined in <code class="filename">/etc/flatpak/installations.d/</code>. Using <code class="option">--installation=default</code> is equivalent to using <code class="option">--system</code>. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd><dt><span class="term"><code class="option">--arch=ARCH</code></span></dt><dd><p> The architecture to run. See <span class="command"><strong>flatpak --supported-arches</strong></span> for architectures supported by the host. </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">--cwd=DIR</code></span></dt><dd><p> The directory to run the command in. Note that this must be a directory inside the sandbox. </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, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth, pcsc, cups, gpg-agent. 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, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth, pcsc, cups, gpg-agent. 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, kvm, shm, 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, kvm, shm, all. This option can be used multiple times. </p></dd><dt><span class="term"><code class="option">--allow=FEATURE</code></span></dt><dd><p> Allow access to a specific feature. This overrides to the Context section from the application metadata. FEATURE must be one of: devel, multiarch, bluetooth. This option can be used multiple times. </p><p> See <a class="citerefentry" href="#flatpak-build-finish"><span class="citerefentry"><span class="refentrytitle">flatpak-build-finish</span>(1)</span></a> for the meaning of the various features. </p></dd><dt><span class="term"><code class="option">--disallow=FEATURE</code></span></dt><dd><p> Disallow access to a specific feature. This overrides to the Context section from the application metadata. FEATURE must be one of: devel, multiarch, bluetooth. This option can be used multiple times. </p></dd><dt><span class="term"><code class="option">--filesystem=FILESYSTEM</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, host-os, host-etc, xdg-desktop, xdg-documents, xdg-download, xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, xdg-config, xdg-cache, xdg-data, an absolute path, or a homedir-relative path like ~/dir or paths relative to the xdg dirs, like xdg-download/subdir. The optional :ro suffix indicates that the location will be read-only. The optional :create suffix indicates that the location will be read-write and created if it doesn't exist. This option can be used multiple times. See the "[Context] filesystems" list in <a class="citerefentry" href="#flatpak-metadata"><span class="citerefentry"><span class="refentrytitle">flatpak-metadata</span>(5)</span></a> for details of the meanings of these filesystems. </p></dd><dt><span class="term"><code class="option">--nofilesystem=FILESYSTEM</code></span></dt><dd><p> Undo the effect of a previous <code class="option">--filesystem=</code> FILESYSTEM in the app's manifest and/or the overrides set up with <a class="citerefentry" href="#flatpak-override"><span class="citerefentry"><span class="refentrytitle">flatpak-override</span>(1)</span></a>. This overrides the Context section of the application metadata. FILESYSTEM can take the same values as for <code class="option">--filesystem</code>, but the :ro and :create suffixes are not used here. This option can be used multiple times. </p><p> This option does not prevent access to a more narrowly-scoped <code class="option">--filesystem</code>. For example, if an application has the equivalent of <code class="option">--filesystem=xdg-config/MyApp</code> in its manifest or as a system-wide override, and <code class="literal">flatpak override --user --nofilesystem=home</code> as a per-user override, then it will be prevented from accessing most of the home directory, but it will still be allowed to access <code class="filename">$XDG_CONFIG_HOME/MyApp</code>. </p><p> As a special case, <code class="option">--nofilesystem=host:reset</code> will ignore all <code class="option">--filesystem</code> permissions inherited from the app manifest or <a class="citerefentry" href="#flatpak-override"><span class="citerefentry"><span class="refentrytitle">flatpak-override</span>(1)</span></a>, in addition to having the behaviour of <code class="option">--nofilesystem=host</code>. </p></dd><dt><span class="term"><code class="option">--add-policy=SUBSYSTEM.KEY=VALUE</code></span></dt><dd><p> Add generic policy option. For example, "--add-policy=subsystem.key=v1 --add-policy=subsystem.key=v2" would map to this metadata: </p><pre class="programlisting"> [Policy subsystem] key=v1;v2; </pre><p> </p><p> This option can be used multiple times. </p></dd><dt><span class="term"><code class="option">--remove-policy=SUBSYSTEM.KEY=VALUE</code></span></dt><dd><p> Remove generic policy option. 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">--unset-env=VAR</code></span></dt><dd><p> Unset an environment variable in the application. This overrides the unset-environment entry in the [Context] group of the metadata, and the [Environment] group. This option can be used multiple times. </p></dd><dt><span class="term"><code class="option">--env-fd=<em class="replaceable"><code>FD</code></em></code></span></dt><dd><p> Read environment variables from the file descriptor <em class="replaceable"><code>FD</code></em>, and set them as if via <code class="option">--env</code>. This can be used to avoid environment variables and their values becoming visible to other users. </p><p> Each environment variable is in the form <em class="replaceable"><code>VAR</code></em>=<em class="replaceable"><code>VALUE</code></em> followed by a zero byte. This is the same format used by <code class="literal">env -0</code> and <code class="filename">/proc/*/environ</code>. </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">--no-talk-name=NAME</code></span></dt><dd><p> Don't 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">--system-no-talk-name=NAME</code></span></dt><dd><p> Don't 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-session-bus</code></span></dt><dd><p> Run this instance without the filtered access to the session dbus connection. Note, this is the default when run with --sandbox. </p></dd><dt><span class="term"><code class="option">--session-bus</code></span></dt><dd><p> Allow filtered access to the session dbus connection. This is the default, except when run with --sandbox. </p><p> In sandbox mode, even if you allow access to the session bus the sandbox cannot talk to or own the application ids (org.the.App.*) on the bus (unless explicitly added), only names in the .Sandboxed subset (org.the.App.Sandboxed.* and org.mpris.MediaPlayer2.org.the.App.Sandboxed.*). </p></dd><dt><span class="term"><code class="option">--no-a11y-bus</code></span></dt><dd><p> Run this instance without the access to the accessibility bus. Note, this is the default when run with --sandbox. </p></dd><dt><span class="term"><code class="option">--a11y-bus</code></span></dt><dd><p> Allow access to the accessibility bus. This is the default, except when run with --sandbox. </p></dd><dt><span class="term"><code class="option">--sandbox</code></span></dt><dd><p> Run the application in sandboxed mode, which means dropping all the extra permissions it would otherwise have, as well as access to the session/system/a11y busses and document portal. </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><dt><span class="term"><code class="option">-p</code>, </span><span class="term"><code class="option">--die-with-parent</code></span></dt><dd><p> Kill the entire sandbox when the launching process dies. </p></dd><dt><span class="term"><code class="option">--parent-pid=PID</code></span></dt><dd><p> Specifies the pid of the "parent" flatpak, used by --parent-expose-pids and --parent-share-pids. </p></dd><dt><span class="term"><code class="option">--parent-expose-pids</code></span></dt><dd><p> Make the processes of the new sandbox visible in the sandbox of the parent flatpak, as defined by --parent-pid. </p></dd><dt><span class="term"><code class="option">--parent-share-pids</code></span></dt><dd><p> Use the same process ID namespace for the processes of the new sandbox and the sandbox of the parent flatpak, as defined by --parent-pid. Implies --parent-expose-pids. </p></dd><dt><span class="term"><code class="option">--instance-id-fd</code></span></dt><dd><p> Write the instance ID string to the given file descriptor. </p></dd><dt><span class="term"><code class="option">--file-forwarding</code></span></dt><dd><p> If this option is specified, the remaining arguments are scanned, and all arguments that are enclosed between a pair of '@@' arguments are interpreted as file paths, exported in the document store, and passed to the command in the form of the resulting document path. Arguments between '@@u' and '@@' are considered uris, and any file: uris are exported. The exports are non-persistent and with read and write permissions for the application. </p></dd><dt><span class="term"><code class="option">--app-path=<em class="replaceable"><code>PATH</code></em></code></span></dt><dd><p> Instead of mounting the app's content on <code class="filename">/app</code> in the sandbox, mount <em class="replaceable"><code>PATH</code></em> on <code class="filename">/app</code>, and the app's content on <code class="filename">/run/parent/app</code>. If the app has extensions, they will also be redirected into <code class="filename">/run/parent/app</code>, and will not be included in the <code class="envar">LD_LIBRARY_PATH</code> inside the sandbox. </p></dd><dt><span class="term"><code class="option">--app-path=</code></span></dt><dd><p> As a special case, <code class="option">--app-path=</code> (with an empty <em class="replaceable"><code>PATH</code></em>) results in an empty directory being mounted on <code class="filename">/app</code>. </p></dd><dt><span class="term"><code class="option">--usr-path=<em class="replaceable"><code>PATH</code></em></code></span></dt><dd><p> Instead of mounting the runtime's files on <code class="filename">/usr</code> in the sandbox, mount <em class="replaceable"><code>PATH</code></em> on <code class="filename">/usr</code>, and the runtime's normal files on <code class="filename">/run/parent/usr</code>. If the runtime has extensions, they will also be redirected into <code class="filename">/run/parent/usr</code>, and will not be included in the <code class="envar">LD_LIBRARY_PATH</code> inside the sandbox. </p><p> This option will usually only be useful if it is combined with <code class="option">--app-path=</code> and <code class="option">--env=LD_LIBRARY_PATH=<em class="replaceable"><code>...</code></em></code>. </p></dd></dl></div></div><div class="refsect1"><a id="id1493"></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><p> <span class="command"><strong>$ flatpak run --command=bash org.gnome.Sdk</strong></span> </p></div><div class="refsect1"><a id="id1494"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-override"><span class="citerefentry"><span class="refentrytitle">flatpak-override</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-enter"><span class="citerefentry"><span class="refentrytitle">flatpak-enter</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-search"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-search — Search for applications and runtimes</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak search</code> TEXT </p></div></div><div class="refsect1"><a id="id1495"></a><h2>Description</h2><p> Searches for applications and runtimes matching TEXT . Note that this uses appstream data that can be updated with the <span class="command"><strong>flatpak update</strong></span> command. The appstream data is updated automatically only if it's at least a day old. </p></div><div class="refsect1"><a id="id1496"></a><h2>Options</h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-u</code>, </span><span class="term"><code class="option">--user</code></span></dt><dd><p> Only search through remotes in the per-user installation. </p></dd><dt><span class="term"><code class="option">--system</code></span></dt><dd><p> Only search through remotes in the default system-wide installation. </p></dd><dt><span class="term"><code class="option">--installation=NAME</code></span></dt><dd><p> Show a system-wide installation by NAME among those defined in <code class="filename">/etc/flatpak/installations.d/</code>. Using <code class="option">--installation=default</code> is equivalent to using <code class="option">--system</code>. </p></dd><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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd><dt><span class="term"><code class="option">--columns=FIELD,…</code></span></dt><dd><p> Specify what information to show about each result. You can list multiple fields, or use this option multiple times. </p><p> Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column names to change ellipsization. </p></dd></dl></div></div><div class="refsect1"><a id="id1497"></a><h2>Fields</h2><p>The following fields are understood by the <code class="option">--columns</code> option:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">name</span></dt><dd><p> Show the name </p></dd><dt><span class="term">description</span></dt><dd><p> Show the description </p></dd><dt><span class="term">application</span></dt><dd><p> Show the application ID </p></dd><dt><span class="term">version</span></dt><dd><p> Show the version </p></dd><dt><span class="term">branch</span></dt><dd><p> Show the branch </p></dd><dt><span class="term">remotes</span></dt><dd><p> Show the remotes </p></dd><dt><span class="term">all</span></dt><dd><p> Show all columns </p></dd><dt><span class="term">help</span></dt><dd><p> Show the list of available columns </p></dd></dl></div><p> Note that field names can be abbreviated to a unique prefix. </p></div><div class="refsect1"><a id="id1498"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a> </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...] [REF...]</p></div></div><div class="refsect1"><a id="id1499"></a><h2>Description</h2><p> Uninstalls an application or runtime. REF is a reference to the application or runtime to uninstall. </p><p> Each REF argument is a full or partial identifier in the flatpak ref format, which looks like "(app|runtime)/ID/ARCH/BRANCH". All elements except ID are optional and can be left out, including the slashes, so most of the time you need only specify ID. Any part left out will be matched against what is installed, and if there are multiple matches you will be prompted to choose between them. You will also be prompted if REF doesn't match any installed ref exactly but is similar (e.g. "gedit" is similar to "org.gnome.gedit"), but this fuzzy matching behavior is disabled if REF contains any slashes or periods. </p><p> By default this looks for both installed apps and runtimes with the given REF , but you can limit this by using the <code class="option">--app</code> or <code class="option">--runtime</code> option, or by supplying the initial element in the REF . </p><p> Normally, this command removes the ref for this application/runtime from the local OSTree repository and purges any 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 <code class="option">--keep-ref</code> option can be used to prevent this. </p><p> When <code class="option">--delete-data</code> is specified while removing an app, its data directory in <code class="filename">~/.var/app</code> and any permissions it might have are removed. When <code class="option">--delete-data</code> is used without a REF , all 'unowned' app data is removed. </p><p> Unless overridden with the <code class="option">--system</code>, <code class="option">--user</code>, or <code class="option">--installation</code> options, this command searches both the system-wide installation and the per-user one for REF and errors out if it exists in more than one. </p></div><div class="refsect1"><a id="id1500"></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">-u</code>, </span><span class="term"><code class="option">--user</code></span></dt><dd><p> Uninstalls from a per-user installation. </p></dd><dt><span class="term"><code class="option">--system</code></span></dt><dd><p> Uninstalls from the default system-wide installation. </p></dd><dt><span class="term"><code class="option">--installation=NAME</code></span></dt><dd><p> Uninstalls from a system-wide installation specified by NAME among those defined in <code class="filename">/etc/flatpak/installations.d/</code>. Using <code class="option">--installation=default</code> is equivalent to using <code class="option">--system</code>. </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. See <span class="command"><strong>flatpak --supported-arches</strong></span> for architectures supported by the host. </p></dd><dt><span class="term"><code class="option">--all</code></span></dt><dd><p> Remove all refs on the system. </p></dd><dt><span class="term"><code class="option">--unused</code></span></dt><dd><p> Remove unused refs on the system. </p></dd><dt><span class="term"><code class="option">-y</code>, </span><span class="term"><code class="option">--assumeyes</code></span></dt><dd><p> Automatically answer yes to all questions. This is useful for automation. </p></dd><dt><span class="term"><code class="option">--noninteractive</code></span></dt><dd><p> Produce minimal output and avoid most questions. This is suitable for use in non-interactive situations, e.g. in a build script. </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 a 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">--force-remove</code></span></dt><dd><p> Remove files even if they're in use by a running application. </p></dd><dt><span class="term"><code class="option">--delete-data</code></span></dt><dd><p> Remove app data in <code class="filename">~/.var/app</code> and in the permission store. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1501"></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-update"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-update — Update an application or runtime</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak update</code> [OPTION...] [REF...]</p></div><div class="cmdsynopsis"><p><code class="command">flatpak update</code> [OPTION...] --appstream [REMOTE]</p></div></div><div class="refsect1"><a id="id1502"></a><h2>Description</h2><p> Updates applications and runtimes. REF is a reference to the application or runtime to update. If no REF is given, everything is updated, as well as appstream info for all remotes. </p><p> Each REF argument is a full or partial identifier in the flatpak ref format, which looks like "(app|runtime)/ID/ARCH/BRANCH". All elements except ID are optional and can be left out, including the slashes, so most of the time you need only specify ID. Any part left out will be matched against what is installed, and if there are multiple matches an error message will list the alternatives. </p><p> By default this looks for both apps and runtimes with the given REF , but you can limit this by using the <code class="option">--app</code> or <code class="option">--runtime</code> option, or by supplying the initial element in the REF . </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 <code class="option">--commit</code> option. </p><p> If the configured remote for a ref being updated has a collection ID configured on it, Flatpak will search the <code class="filename">sideload-repos</code> directories configured either with the <code class="option">--sideload-repo</code> option, or on a per-installation or system-wide basis (see <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>). </p><p> Note that updating a runtime 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 <code class="option">--commit</code> option. </p><p> In addition to updates, this command will offer to uninstall any unused end-of-life runtimes. Runtimes that were explicitly installed (not as a dependency) or explicitly pinned (see <a class="citerefentry" href="#flatpak-pin"><span class="citerefentry"><span class="refentrytitle">flatpak-pin</span>(1)</span></a>) are left installed even if unused and end-of-life. </p><p> Unless overridden with the <code class="option">--user</code>, <code class="option">--system</code> or <code class="option">--installation</code> option, this command updates any matching refs in the standard system-wide installation and the per-user one. </p></div><div class="refsect1"><a id="id1503"></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">-u</code>, </span><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 the default system-wide installation. </p></dd><dt><span class="term"><code class="option">--installation=NAME</code></span></dt><dd><p> Updates a system-wide installation specified by NAME among those defined in <code class="filename">/etc/flatpak/installations.d/</code>. Using <code class="option">--installation=default</code> is equivalent to using <code class="option">--system</code>. </p></dd><dt><span class="term"><code class="option">--arch=ARCH</code></span></dt><dd><p> The architecture to update for. See <span class="command"><strong>flatpak --supported-arches</strong></span> for architectures supported by the host. </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. You can find commits using <span class="command"><strong>flatpak remote-info --log REMOTE REF</strong></span>. </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 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">--no-deps</code></span></dt><dd><p> Don't update or install runtime dependencies when installing. </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">--appstream</code></span></dt><dd><p> Update appstream for REMOTE , or all remotes if no remote is specified. </p></dd><dt><span class="term"><code class="option">--runtime</code></span></dt><dd><p> Only look for a runtime with the given name. </p></dd><dt><span class="term"><code class="option">--sideload-repo=PATH</code></span></dt><dd><p> Adds an extra local ostree repo as a source for installation. This is equivalent to using the <code class="filename">sideload-repos</code> directories (see <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>), but can be done on a per-command basis. Any path added here is used in addition to ones in those directories. </p></dd><dt><span class="term"><code class="option">-y</code>, </span><span class="term"><code class="option">--assumeyes</code></span></dt><dd><p> Automatically answer yes to all questions (or pick the most prioritized answer). This is useful for automation. </p></dd><dt><span class="term"><code class="option">--noninteractive</code></span></dt><dd><p> Produce minimal output and avoid most questions. This is suitable for use in non-interactive situations, e.g. in a build script. </p></dd><dt><span class="term"><code class="option">--force-remove</code></span></dt><dd><p> Remove old files even if they're in use by a running application. </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">--ostree-verbose</code></span></dt><dd><p> Print OSTree debug information during command processing. </p></dd></dl></div></div><div class="refsect1"><a id="id1504"></a><h2>Examples</h2><p> <span class="command"><strong>$ flatpak --user update org.gnome.gedit</strong></span> </p></div><div class="refsect1"><a id="id1505"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-install"><span class="citerefentry"><span class="refentrytitle">flatpak-install</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-list"><span class="citerefentry"><span class="refentrytitle">flatpak-list</span>(1)</span></a>, <a class="citerefentry" href="#ostree-find-remotes"><span class="citerefentry"><span class="refentrytitle">ostree-find-remotes</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-spawn"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-spawn — Run commands in a sandbox</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">flatpak-spawn</code> [OPTION...] COMMAND [ARGUMENT...]</p></div></div><div class="refsect1"><a id="id1506"></a><h2>Description</h2><p> Unlike other flatpak commands, <span class="command"><strong>flatpak-spawn</strong></span> is available to applications inside the sandbox. It runs COMMAND outside the sandbox: either in another sandbox, or on the host. </p><p> When called without <code class="option">--host</code>, <span class="command"><strong>flatpak-spawn</strong></span> uses the Flatpak portal to create a copy of the sandbox it was called from, optionally using tighter permissions and optionally the latest version of the app and runtime (see <code class="option">--latest-version</code>). </p></div><div class="refsect1"><a id="id1507"></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 </p></dd><dt><span class="term"><code class="option">--forward-fd=FD</code></span></dt><dd><p> Forward a file descriptor </p></dd><dt><span class="term"><code class="option">--clear-env</code></span></dt><dd><p> Run with a clean environment </p></dd><dt><span class="term"><code class="option">--watch-bus</code></span></dt><dd><p> Make the spawned command exit if the caller disappears from the session bus </p></dd><dt><span class="term"><code class="option">--env=VAR=VALUE</code></span></dt><dd><p> Set an environment variable </p></dd><dt><span class="term"><code class="option">--latest-version</code></span></dt><dd><p> Use the latest version of the refs that are used to set up the sandbox </p></dd><dt><span class="term"><code class="option">--no-network</code></span></dt><dd><p> Run without network access </p></dd><dt><span class="term"><code class="option">--sandbox</code></span></dt><dd><p> Run fully sandboxed. See the documentation for the <code class="option">--sandbox</code> option in <a class="citerefentry" href="#flatpak-run"><span class="citerefentry"><span class="refentrytitle">flatpak-run</span>(1)</span></a> </p><p> See the <code class="option">--sandbox-expose</code> and <code class="option">--sandbox-expose-ro</code> options for selective file access. </p></dd><dt><span class="term"><code class="option">--sandbox-expose=NAME</code></span></dt><dd><p> Expose read-write access to a file in the sandbox. </p><p> Note that absolute paths or subdirectories are not allowed. The files must be in the <code class="filename">sandbox</code> subdirectory of the instance directory (i.e. <code class="filename">~/.var/app/$APP_ID/sandbox</code>). </p><p></p><p> This option is useful in combination with <code class="option">--sandbox</code> (otherwise the instance directory is accessible anyway). </p></dd><dt><span class="term"><code class="option">--sandbox-expose-ro=NAME</code></span></dt><dd><p> Expose readonly access to a file in the sandbox. </p><p> Note that absolute paths or subdirectories are not allowed. The files must be in the <code class="filename">sandbox</code> subdirectory of the instance directory (i.e. <code class="filename">~/.var/app/$APP_ID/sandbox</code>). </p><p></p><p> This option is useful in combination with <code class="option">--sandbox</code> (otherwise the instance directory is accessible anyway). </p></dd><dt><span class="term"><code class="option">--host</code></span></dt><dd><p> Run the command unsandboxed on the host. This requires access to the org.freedesktop.Flatpak D-Bus interface. </p></dd><dt><span class="term"><code class="option">--directory=DIR</code></span></dt><dd><p> The working directory in which to run the command. </p><p> Note that the given directory must exist in the sandbox or, when used in conjunction with <code class="option">--host</code>, on the host. </p></dd></dl></div></div><div class="refsect1"><a id="id1508"></a><h2>Examples</h2><p> <span class="command"><strong>$ flatpak-spawn ls /var/run</strong></span> </p></div><div class="refsect1"><a id="id1509"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a> </p></div></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="id1340"></a>File Formats</h2></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="refentrytitle"><a href="#flatpak-flatpakrepo">flatpakrepo</a></span><span class="refpurpose"> — Reference to a remote</span></dt><dt><span class="refentrytitle"><a href="#flatpak-flatpakref">flatpakref</a></span><span class="refpurpose"> — Reference to a remote for an application or runtime</span></dt><dt><span class="refentrytitle"><a href="#flatpak-installation">flatpak installation</a></span><span class="refpurpose"> — Configuration for an installation location</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-remote">flatpak remote</a></span><span class="refpurpose"> — Configuration for a remote</span></dt></dl></div><div class="refentry"><a id="flatpak-flatpakrepo"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-flatpakrepo — Reference to a remote</p></div><div class="refsect1"><a id="id1510"></a><h2>Description</h2><p> Flatpak uses flatpakrepo files to share information about remotes. The <code class="filename">flatpakrepo</code> file contains enough information to add the remote. Use the <span class="command"><strong>flatpak remote-add --from</strong></span> command to do so. </p><p> flatpakrepo files may also contain additional information that is useful when displaying a remote to the user, e.g. in an app store. </p><p> The filename extension commonly used for flatpakrepo files is <code class="filename">.flatpakrepo</code>. </p></div><div class="refsect1"><a id="id1511"></a><h2>File format</h2><p> The flatpakrepo 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="id1512"></a><h3>[Flatpak Repo]</h3><p> All the information is contained in the [Flatpak Repo] group. </p><p> The following keys can be present in this group: </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">Version</code> (uint64)</span></dt><dd><p>The version of the file format, must be 1 if present.</p></dd><dt><span class="term"><code class="option">Url</code> (string)</span></dt><dd><p>The url for the remote. This key is mandatory.</p></dd><dt><span class="term"><code class="option">GPGKey</code> (string)</span></dt><dd><p>The base64-encoded gpg key for the remote.</p></dd><dt><span class="term"><code class="option">DefaultBranch</code> (string)</span></dt><dd><p>The default branch to use for this remote.</p></dd><dt><span class="term"><code class="option">Subset</code> (string)</span></dt><dd><p>Limit the remote to the named subset of refs.</p></dd><dt><span class="term"><code class="option">Title</code> (string)</span></dt><dd><p>The title of the remote. This should be a user-friendly name that can be displayed e.g. in an app store.</p></dd><dt><span class="term"><code class="option">Comment</code> (string)</span></dt><dd><p>A short summary of the remote, for display e.g. in an app store.</p></dd><dt><span class="term"><code class="option">Description</code> (string)</span></dt><dd><p>A longer description of the remote, for display e.g. in an app store.</p></dd><dt><span class="term"><code class="option">Icon</code> (string)</span></dt><dd><p>The url for an icon that can be used to represent the remote.</p></dd><dt><span class="term"><code class="option">Homepage</code> (string)</span></dt><dd><p>The url of a webpage describing the remote.</p></dd><dt><span class="term"><code class="option">Filter</code> (string)</span></dt><dd><p>The path of a local file to use to filter remote refs. See <a class="citerefentry" href="#flatpak-remote-add"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-add</span>(1)</span></a> for details on the format of the file. </p><p> Note: This field is treated a bit special by flatpak remote-add. If you install a remote with --if-not-exists then and the remote is already configured, then the filter field of the remote configuration will be update anyway. And, if the filter field is *not* specified then any existing filters are cleared. The goal here is to allow a pre-configured filtered remote to be replaced with the regular one if you add the normal upstream (unfiltered) flatpakrepo file. </p></dd><dt><span class="term"><code class="option">DeploySideloadCollectionID</code> (string)</span></dt><dd><p> The collection ID of the remote, if it has one. This uniquely identifies the collection of apps in the remote, to allow peer to peer redistribution (see <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>). It is recommended to use this key over DeployCollectionID or CollectionID because only newer clients (Flatpak 1.12.8 or later) pay attention to it (and older clients don't handle collection IDs properly). </p></dd><dt><span class="term"><code class="option">DeployCollectionID</code> (string)</span></dt><dd><p>This is deprecated but still supported for backwards compatibility. Use DeploySideloadCollectionID instead.</p></dd><dt><span class="term"><code class="option">CollectionID</code> (string)</span></dt><dd><p>This is deprecated but still supported for backwards compatibility. Use DeploySideloadCollectionID instead.</p></dd></dl></div></div></div><div class="refsect1"><a id="id1513"></a><h2>Example</h2><pre class="programlisting"> [Flatpak Repo] Title=gedit Url=http://sdk.gnome.org/repo-apps/ GPGKey=mQENBFUUCGcBCAC/K9WeV4xCaKr3NKRqPXeY5mpaXAJyasLqCtrDx92WUgbu0voWrhohNAKpqizod2dvzc/XTxm3rHyIxmNfdhz1gaGhynU75Qw4aJVcly2eghTIl++gfDtOvrOZo/VuAq30f32dMIgHQdRwEpgCwz7WyjpqZYltPAEcCNL4MTChAfiHJeeiQ5ibystNBW8W6Ymf7sO4m4g5+/aOxI54oCOzD9TwBAe+yXcJJWtc2rAhMCjtyPJzxd0ZVXqIzCe1xRvJ6Rq7YCiMbiM2DQFWXKnmYQbj4TGNMnwNdAajCdrcBWEMSbzq7EzuThIJRd8Ky4BkEe1St6tuqwFaMZz+F9eXABEBAAG0KEdub21lIFNESyAzLjE2IDxnbm9tZS1vcy1saXN0QGdub21lLm9yZz6JATgEEwECACIFAlUUCGcCGwMGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEArkz6VV0VKBa5cH/0vXa31YgEjNk78gGFXqnQxdD1WYA87OYxDi189l4lA802EFTF4wCBuZyDOqdd5BhS3Ab0cR778DmZXRUP2gwe+1zTJypU2JMnDpkwJ4NK1VP6/tE4SAPrznBtmb76BKaWBqUfZ9Wq1zg3ugvqkZB/Exq+usypIOwQVp1KL58TrjBRda0HvRctzkNhr0qYAtkfLFe0GvksBp4vBm8uGwAx7fw/HbhIjQ9pekTwvB+5GwDPO/tSip/1bQfCS+XJB8Ffa04HYPLGedalnWBrwhYY+G/kn5Zh9L/AC8xeLwTJTHM212rBjPa9CWs9C6a57MSaeGIEHLC1hEyiJJ15w8jmY= DeployCollectionID=org.gnome.Apps </pre></div><div class="refsect1"><a id="id1514"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-remote-add"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-add</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-flatpakref"><span class="citerefentry"><span class="refentrytitle">flatpak-flatpakref</span>(5)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-flatpakref"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-flatpakref — Reference to a remote for an application or runtime</p></div><div class="refsect1"><a id="id1515"></a><h2>Description</h2><p> Flatpak uses flatpakref files to share information about a remote for a single application. The <code class="filename">flatpakref</code> file contains enough information to add the remote and install the application. Use the <span class="command"><strong>flatpak install --from</strong></span> command to do so. </p><p> flatpakref files may also contain additional information that is useful when displaying the application to the user, e.g. in an app store. </p><p> The filename extension commonly used for flatpakref files is <code class="filename">.flatpakref</code>. </p><p> A flatpakref file can also refer to a remote for a runtime. </p></div><div class="refsect1"><a id="id1516"></a><h2>File format</h2><p> The flatpakref 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="id1517"></a><h3>[Flatpak Ref]</h3><p> All the information is contained in the [Flatpak Ref] group. </p><p> The following keys can be present in this group: </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">Version</code> (uint64)</span></dt><dd><p>The version of the file format, must be 1 if present.</p></dd><dt><span class="term"><code class="option">Name</code> (string)</span></dt><dd><p>The fully qualified name of the runtime or application. This key is mandatory.</p></dd><dt><span class="term"><code class="option">Url</code> (string)</span></dt><dd><p>The url for the remote. This key is mandatory.</p></dd><dt><span class="term"><code class="option">Branch</code> (string)</span></dt><dd><p>The name of the branch from which to install the application or runtime. If this key is not specified, the "master" branch is used.</p></dd><dt><span class="term"><code class="option">Title</code> (string)</span></dt><dd><p>The title of the application or runtime. This should be a user-friendly name that can be displayed e.g. in an app store.</p></dd><dt><span class="term"><code class="option">Comment</code> (string)</span></dt><dd><p>A short summary of the application or runtime, for display e.g. in an app store.</p></dd><dt><span class="term"><code class="option">Description</code> (string)</span></dt><dd><p>A longer description of the application or runtime, for display e.g. in an app store.</p></dd><dt><span class="term"><code class="option">Icon</code> (string)</span></dt><dd><p>The url for an icon that can be used to represent the application or runtime.</p></dd><dt><span class="term"><code class="option">Homepage</code> (string)</span></dt><dd><p>The url of a webpage describing the application or runtime.</p></dd><dt><span class="term"><code class="option">DeploySideloadCollectionID</code> (string)</span></dt><dd><p> The collection ID of the remote, if it has one. This uniquely identifies the collection of apps in the remote, to allow peer to peer redistribution (see <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>). It is recommended to use this key over DeployCollectionID or CollectionID because only newer clients (Flatpak 1.12.8 or later) pay attention to it (and older clients don't handle collection IDs properly). </p></dd><dt><span class="term"><code class="option">DeployCollectionID</code> (string)</span></dt><dd><p>This is deprecated but still supported for backwards compatibility. Use DeploySideloadCollectionID instead.</p></dd><dt><span class="term"><code class="option">CollectionID</code> (string)</span></dt><dd><p>This is deprecated but still supported for backwards compatibility. Use DeploySideloadCollectionID instead.</p></dd><dt><span class="term"><code class="option">IsRuntime</code> (boolean)</span></dt><dd><p>Whether this file refers to a runtime. If this key is not specified, the file is assumed to refer to an application.</p></dd><dt><span class="term"><code class="option">GPGKey</code> (string)</span></dt><dd><p>The base64-encoded gpg key for the remote.</p></dd><dt><span class="term"><code class="option">RuntimeRepo</code> (string)</span></dt><dd><p>The url for a .flatpakrepo file for the remote where the runtime can be found. Note that if the runtime is available in the remote providing the app, that remote may be used instead but the one specified by this option will still be added.</p></dd><dt><span class="term"><code class="option">SuggestRemoteName</code> (string)</span></dt><dd><p>A suggested name for the remote.</p></dd></dl></div></div></div><div class="refsect1"><a id="id1518"></a><h2>Example</h2><pre class="programlisting"> [Flatpak Ref] Title=gedit Name=org.gnome.gedit Branch=stable Url=http://sdk.gnome.org/repo-apps/ IsRuntime=false GPGKey=mQENBFUUCGcBCAC/K9WeV4xCaKr3NKRqPXeY5mpaXAJyasLqCtrDx92WUgbu0voWrhohNAKpqizod2dvzc/XTxm3rHyIxmNfdhz1gaGhynU75Qw4aJVcly2eghTIl++gfDtOvrOZo/VuAq30f32dMIgHQdRwEpgCwz7WyjpqZYltPAEcCNL4MTChAfiHJeeiQ5ibystNBW8W6Ymf7sO4m4g5+/aOxI54oCOzD9TwBAe+yXcJJWtc2rAhMCjtyPJzxd0ZVXqIzCe1xRvJ6Rq7YCiMbiM2DQFWXKnmYQbj4TGNMnwNdAajCdrcBWEMSbzq7EzuThIJRd8Ky4BkEe1St6tuqwFaMZz+F9eXABEBAAG0KEdub21lIFNESyAzLjE2IDxnbm9tZS1vcy1saXN0QGdub21lLm9yZz6JATgEEwECACIFAlUUCGcCGwMGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEArkz6VV0VKBa5cH/0vXa31YgEjNk78gGFXqnQxdD1WYA87OYxDi189l4lA802EFTF4wCBuZyDOqdd5BhS3Ab0cR778DmZXRUP2gwe+1zTJypU2JMnDpkwJ4NK1VP6/tE4SAPrznBtmb76BKaWBqUfZ9Wq1zg3ugvqkZB/Exq+usypIOwQVp1KL58TrjBRda0HvRctzkNhr0qYAtkfLFe0GvksBp4vBm8uGwAx7fw/HbhIjQ9pekTwvB+5GwDPO/tSip/1bQfCS+XJB8Ffa04HYPLGedalnWBrwhYY+G/kn5Zh9L/AC8xeLwTJTHM212rBjPa9CWs9C6a57MSaeGIEHLC1hEyiJJ15w8jmY= DeployCollectionID=org.gnome.Apps </pre></div><div class="refsect1"><a id="id1519"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-install"><span class="citerefentry"><span class="refentrytitle">flatpak-install</span>(1)</span></a> <a class="citerefentry" href="#flatpak-flatpakrepo"><span class="citerefentry"><span class="refentrytitle">flatpak-flatpakrepo</span>(5)</span></a>, </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-installation"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-installation — Configuration for an installation location</p></div><div class="refsect1"><a id="id1520"></a><h2>Description</h2><p> flatpak can operate in system-wide or per-user mode. The system-wide data is located in <code class="filename">$prefix/var/lib/flatpak/</code>, and the per-user data is in <code class="filename">$HOME/.local/share/flatpak/</code>. </p><p> In addition to the default installation locations, more system-wide installations can be defined via configuration files <code class="filename">/etc/flatpak/installations.d/</code>, which must have the .conf extension and follow the format described below. </p></div><div class="refsect1"><a id="id1521"></a><h2>File format</h2><p> The installation config file format is using the same .ini file format that is used for systemd unit files or application .desktop files. </p><div class="refsect2"><a id="id1522"></a><h3>[Installation …]</h3><p> All the configuration for the the installation location with name NAME is contained in the [Installation "NAME"] group. </p><p> The following keys are recognized: </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">Path</code> (string)</span></dt><dd><p>The path for this installation. This key is mandatory.</p></dd><dt><span class="term"><code class="option">DisplayName</code> (string)</span></dt><dd><p>The name to use when showing this installation in the UI.</p></dd><dt><span class="term"><code class="option">Priority</code> (integer)</span></dt><dd><p>A priority for this installation.</p></dd><dt><span class="term"><code class="option">StorageType</code> (string)</span></dt><dd><p>The type of storage used for this installation. Possible values include: network, mmc, sdcard, harddisk.</p></dd></dl></div></div></div><div class="refsect1"><a id="id1523"></a><h2>Examples</h2><pre class="programlisting"> [Installation "extra"] Path=/location/of/sdcard DisplayName=Extra Installation StorageType=sdcard </pre></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="id1524"></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">/.flatpak-info</code>. For compatibility with older Flatpak versions, <code class="filename">/run/user/$UID/flatpak-info</code> is a symbolic link to the same file. </p></div><div class="refsect1"><a id="id1525"></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="application-runtime-metadata"></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. Available since 0.1.</p></dd><dt><span class="term"><code class="option">command</code> (string)</span></dt><dd><p> The command to run. Only relevant for applications. Available since 0.1. </p></dd><dt><span class="term"><code class="option">required-flatpak</code> (string list)</span></dt><dd><p> The required version of Flatpak to run this application or runtime. For applications, this was available since 0.8.0. For runtimes, this was available since 0.9.1, and backported to 0.8.3 for the 0.8.x branch. </p><p> Flatpak after version 1.4.3 and 1.2.5 support multiple versions here. This can be useful if you need to support features that are backported to a previous stable series. For example if you want to use a feature added in 1.6.0 that was also backported to 1.4.4 you would use <code class="literal">1.6.0;1.4.4;</code>. Note that older versions of flatpak will just use the first element in the list, so make that the largest version. </p></dd><dt><span class="term"><code class="option">tags</code> (string list)</span></dt><dd><p> Tags to include in AppStream XML. Typical values in use on Flathub include <code class="option">beta</code>, <code class="option">stable</code>, <code class="option">proprietary</code> and <code class="option">upstream-maintained</code>. Available since 0.4.12. </p></dd></dl></div></div><div class="refsect2"><a id="context-metadata"></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. Available since 0.3. </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, fallback-x11, pulseaudio, session-bus, system-bus, ssh-auth, pcsc, cups. 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. Available since 0.3. </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: </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">dri</code></span></dt><dd><p> Graphics direct rendering (<code class="filename">/dev/dri</code>). Available since 0.3. </p></dd><dt><span class="term"><code class="option">kvm</code></span></dt><dd><p> Virtualization (<code class="filename">/dev/kvm</code>). Available since 0.6.12. </p></dd><dt><span class="term"><code class="option">all</code></span></dt><dd><p> All device nodes in <code class="filename">/dev</code>, but not /dev/shm (which is separately specified). Available since 0.6.6. </p></dd><dt><span class="term"><code class="option">shm</code></span></dt><dd><p> Access to the host /dev/shm (<code class="filename">/dev/shm</code>). Available since 1.6.1. </p></dd></dl></div><p> </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: </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">home</code></span></dt><dd><p> The entire home directory. Available since 0.3. </p></dd><dt><span class="term"><code class="option">home/<em class="replaceable"><code>path</code></em></code></span></dt><dd><p> Alias for <code class="filename">~/path</code> Available since 1.10. For better compatibility with older Flatpak versions, prefer to write this as <code class="filename">~/path</code>. </p></dd><dt><span class="term"><code class="option">host</code></span></dt><dd><p> The entire host file system, except for directories that are handled specially by Flatpak. In particular, this shares <code class="filename">/home</code>, <code class="filename">/media</code>, <code class="filename">/opt</code>, <code class="filename">/run/media</code> and <code class="filename">/srv</code> if they exist. </p><p> <code class="filename">/dev</code> is not shared: use <code class="option">devices=all;</code> instead. </p><p> Parts of <code class="filename">/sys</code> are always shared. This option does not make additional files in /sys available. </p><p> Additionally, this keyword provides all of the same directories in <code class="filename">/run/host</code> as the <code class="option">host-os</code> and <code class="option">host-etc</code> keywords. If this keyword is used in conjunction with one of the <code class="option">host-</code> keywords, whichever access level is higher (more permissive) will be used for the directories in <code class="filename">/run/host</code>: for example, <code class="code">host:rw;host-os:ro;</code> is equivalent to <code class="code">host:rw;</code>. </p><p> These other reserved directories are currently excluded: <code class="filename">/app</code>, <code class="filename">/bin</code>, <code class="filename">/boot</code>, <code class="filename">/efi</code>, <code class="filename">/etc</code>, <code class="filename">/lib</code>, <code class="filename">/lib32</code>, <code class="filename">/lib64</code>, <code class="filename">/proc</code>, <code class="filename">/root</code>, <code class="filename">/run</code>, <code class="filename">/sbin</code>, <code class="filename">/tmp</code>, <code class="filename">/usr</code>, <code class="filename">/var</code>. </p><p> Available since 0.3. </p></dd><dt><span class="term"><code class="option">host-os</code></span></dt><dd><p> The host operating system's libraries, executables and static data from <code class="filename">/usr</code> and the related directories <code class="filename">/bin</code>, <code class="filename">/lib</code>, <code class="filename">/lib32</code>, <code class="filename">/lib64</code>, <code class="filename">/sbin</code>. Additionally, this keyword provides access to a subset of <code class="filename">/etc</code> that is associated with packaged libraries and executables, even if the <code class="option">host-etc</code> keyword was not used: <code class="filename">/etc/ld.so.cache</code>, (used by the dynamic linker) and <code class="filename">/etc/alternatives</code> (on operating systems that use it, such as Debian). </p><p> To avoid conflicting with the Flatpak runtime, these are mounted in the sandbox at <code class="filename">/run/host/usr</code>, <code class="filename">/run/host/etc/ld.so.cache</code> and so on. </p><p> Available since 1.7. </p></dd><dt><span class="term"><code class="option">host-etc</code></span></dt><dd><p> The host operating system's configuration from <code class="filename">/etc</code>. </p><p> To avoid conflicting with the Flatpak runtime, this is mounted in the sandbox at <code class="filename">/run/host/etc</code>. </p><p> Available since 1.7. </p></dd><dt><span class="term"><code class="option">xdg-desktop</code>, <code class="option">xdg-documents</code>, <code class="option">xdg-download</code>, <code class="option">xdg-music</code>, <code class="option">xdg-pictures</code>, <code class="option">xdg-public-share</code>, <code class="option">xdg-videos</code>, <code class="option">xdg-templates</code> </span></dt><dd><p> <a class="ulink" href="https://www.freedesktop.org/wiki/Software/xdg-user-dirs/" target="_top">freedesktop.org special directories</a>. Available since 0.3. </p></dd><dt><span class="term"><code class="option">xdg-desktop/<em class="replaceable"><code>path</code></em></code>, <code class="option">xdg-documents/<em class="replaceable"><code>path</code></em></code>, etc. </span></dt><dd><p> Subdirectories of freedesktop.org special directories. Available since 0.4.13. </p></dd><dt><span class="term"> <code class="option">xdg-cache</code>, <code class="option">xdg-config</code>, <code class="option">xdg-data</code> </span></dt><dd><p> Directories defined by the <a class="ulink" href="https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html" target="_top">freedesktop.org Base Directory Specification</a>. Available since 0.6.14. </p></dd><dt><span class="term"> <code class="option">xdg-cache/<em class="replaceable"><code>path</code></em></code>, <code class="option">xdg-config/<em class="replaceable"><code>path</code></em></code>, <code class="option">xdg-data/<em class="replaceable"><code>path</code></em></code> </span></dt><dd><p> Subdirectories of directories defined by the freedesktop.org Base Directory Specification. Available since 0.6.14. </p></dd><dt><span class="term"> <code class="option">xdg-run/<em class="replaceable"><code>path</code></em></code> </span></dt><dd><p> Subdirectories of the <code class="envar">XDG_RUNTIME_DIR</code> defined by the freedesktop.org Base Directory Specification. Note that <code class="option">xdg-run</code> on its own is not supported. Available since 0.4.13. </p></dd><dt><span class="term"> <code class="option">/<em class="replaceable"><code>path</code></em></code> </span></dt><dd><p> An arbitrary absolute path. Available since 0.3. </p></dd><dt><span class="term"> <code class="option">~/<em class="replaceable"><code>path</code></em></code> </span></dt><dd><p> An arbitrary path relative to the home directory. Available since 0.3. </p></dd><dt><span class="term"><code class="option">~</code></span></dt><dd><p> The same as <code class="option">home</code>. Available since 1.10. For better compatibility with older Flatpak versions, prefer to write this as <code class="option">home</code>. </p></dd><dt><span class="term"> One of the above followed by <code class="option">:ro</code> </span></dt><dd><p> Make the given directory available read-only. </p></dd><dt><span class="term"> One of the above followed by <code class="option">:rw</code> </span></dt><dd><p> Make the given directory available read/write. This is the default. </p></dd><dt><span class="term"> One of the above followed by <code class="option">:create</code> </span></dt><dd><p> Make the given directory available read/write, and create it if it does not already exist. </p></dd></dl></div><p> </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. Available since 0.3. </p></dd><dt><span class="term"><code class="option">features</code> (list)</span></dt><dd><p> List of features available or unavailable to the application, currently from the following list: </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">devel</code></span></dt><dd><p> Allow system calls used by development-oriented tools such as <span class="command"><strong>perf</strong></span>, <span class="command"><strong>strace</strong></span> and <span class="command"><strong>gdb</strong></span>. Available since 0.6.10. </p></dd><dt><span class="term"><code class="option">multiarch</code></span></dt><dd><p> Allow running multilib/multiarch binaries, for example <code class="literal">i386</code> binaries in an <code class="literal">x86_64</code> environment. Available since 0.6.12. </p></dd><dt><span class="term"><code class="option">bluetooth</code></span></dt><dd><p> Allow the application to use bluetooth (AF_BLUETOOTH) sockets. Note, for bluetooth to fully work you must also have network access. Available since 0.11.8. </p></dd><dt><span class="term"><code class="option">canbus</code></span></dt><dd><p> Allow the application to use canbus (AF_CAN) sockets. Note, for this work you must also have network access. Available since 1.0.3. </p></dd><dt><span class="term"><code class="option">per-app-dev-shm</code></span></dt><dd><p> Share a single instance of <code class="filename">/dev/shm</code> between all instances of this application run by the same user ID, including sub-sandboxes. If the application has the <code class="option">shm</code> device permission in its <code class="option">devices</code> list, then this feature flag is ignored. Available since 1.12.0. </p></dd></dl></div><p> A feature can be prefixed with <code class="option">!</code> to indicate the absence of that feature, for example <code class="option">!devel</code> if development and debugging are not allowed. </p></dd><dt><span class="term"><code class="option">unset-environment</code> (list)</span></dt><dd><p> A list of names of environment variables to unset. Note that environment variables to set to a value (possibly empty) appear in the [Environment] group instead. </p></dd></dl></div></div><div class="refsect2"><a id="instance-metadata"></a><h3>[Instance]</h3><p> This group only appears in <code class="filename">/.flatpak-info</code> for a running app, and not in the metadata files written by application authors. It is filled in by Flatpak itself. </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">instance-id</code> (string)</span></dt><dd><p> The ID of the running instance. This number is used as the name of the directory in <code class="filename"><code class="envar">XDG_RUNTIME_DIR</code>/.flatpak</code> where Flatpak stores information about this instance. </p></dd><dt><span class="term"><code class="option">instance-path</code> (string)</span></dt><dd><p> The absolute path on the host system of the app's persistent storage area in <code class="filename">$HOME/.var</code>. </p></dd><dt><span class="term"><code class="option">app-path</code> (string)</span></dt><dd><p> The absolute path on the host system of the app's app files, as mounted at <code class="filename">/app</code> inside the container. Available since 0.6.10. </p><p> Since 1.12.0, if <span class="command"><strong>flatpak run</strong></span> was run with the <code class="option">--app-path</code> option, this key gives the absolute path of whatever files were mounted on <code class="filename">/app</code>, even if that differs from the app's normal app files. </p><p> If <span class="command"><strong>flatpak run</strong></span> was run with <code class="option">--app-path=</code> (resulting in an empty directory being mounted on <code class="filename">/app</code>), the value is set to the empty string. </p></dd><dt><span class="term"><code class="option">original-app-path</code> (string)</span></dt><dd><p> If <span class="command"><strong>flatpak run</strong></span> was run with the <code class="option">--app-path</code> option, this key gives the absolute path of the app's original files, as mounted at <code class="filename">/run/parent/app</code> inside the container. Available since 1.12.0. </p><p> If this key is missing, the app files are given by <code class="option">app-path</code>. </p></dd><dt><span class="term"><code class="option">app-commit</code> (string)</span></dt><dd><p> The commit ID of the application that is running. The filename of a deployment of this commit can be found in <code class="option">original-app-path</code> if present, or <code class="option">app-path</code> otherwise. </p></dd><dt><span class="term"><code class="option">app-extensions</code> (list of strings)</span></dt><dd><p> A list of app extensions that are mounted into the running instance. The format for each list item is <code class="option">EXTENSION_ID=COMMIT</code>. If <code class="option">original-app-path</code> is present, the extensions are mounted below <code class="filename">/run/parent/app</code>; otherwise, they are mounted below <code class="filename">/app</code>. </p></dd><dt><span class="term"><code class="option">branch</code> (string)</span></dt><dd><p> The branch of the app, for example <code class="literal">stable</code>. Available since 0.6.10. </p></dd><dt><span class="term"><code class="option">arch</code> (string)</span></dt><dd><p> The architecture of the running instance. </p></dd><dt><span class="term"><code class="option">flatpak-version</code> (string)</span></dt><dd><p> The version number of the Flatpak version that ran this app. Available since 0.6.11. </p></dd><dt><span class="term"><code class="option">runtime-path</code> (string)</span></dt><dd><p> The absolute path on the host system of the app's runtime files, as mounted at <code class="filename">/usr</code> inside the container. Available since 0.6.10. </p><p> Since 1.12.0, if <span class="command"><strong>flatpak run</strong></span> was run with the <code class="option">--usr-path</code> option, this key gives the absolute path of whatever files were mounted on <code class="filename">/usr</code>, even if that differs from the app's normal runtime files. </p></dd><dt><span class="term"><code class="option">original-runtime-path</code> (string)</span></dt><dd><p> If <span class="command"><strong>flatpak run</strong></span> was run with the <code class="option">--runtime-path</code> option, this key gives the absolute path of the app's original runtime, as mounted at <code class="filename">/run/parent/usr</code> inside the container. Available since 1.12.0. </p><p> If this key is missing, the runtime files are given by <code class="option">runtime-path</code>. </p></dd><dt><span class="term"><code class="option">runtime-commit</code> (string)</span></dt><dd><p> The commit ID of the runtime that is used. The filename of a deployment of this commit can be found in <code class="option">original-runtime-path</code> if present, or <code class="option">runtime-path</code> otherwise. </p></dd><dt><span class="term"><code class="option">runtime-extensions</code> (list of strings)</span></dt><dd><p> A list of runtime extensions that are mounted into the running instance. The format for each list item is <code class="option">EXTENSION_ID=COMMIT</code>. If <code class="option">original-app-path</code> is present, the extensions are mounted below <code class="filename">/run/parent/usr</code>; otherwise, they are mounted below <code class="filename">/usr</code>. </p></dd><dt><span class="term"><code class="option">extra-args</code> (string)</span></dt><dd><p> Extra arguments that were passed to flatpak run. </p></dd><dt><span class="term"><code class="option">sandbox</code> (boolean)</span></dt><dd><p> Whether the <code class="option">--sandbox</code> option was passed to flatpak run. </p></dd><dt><span class="term"><code class="option">build</code> (boolean)</span></dt><dd><p> Whether this instance was created by flatpak build. </p></dd><dt><span class="term"><code class="option">session-bus-proxy</code> (boolean)</span></dt><dd><p> True if this app cannot access the D-Bus session bus directly (either it goes via a proxy, or it cannot access the session bus at all). Available since 0.8.0. </p></dd><dt><span class="term"><code class="option">system-bus-proxy</code> (boolean)</span></dt><dd><p> True if this app cannot access the D-Bus system bus directly (either it goes via a proxy, or it cannot access the system bus at all). Available since 0.8.0. </p></dd></dl></div></div><div class="refsect2"><a id="session-bus-policy-metadata"></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, its subnames and its own application id as a subname of "org.mpris.MediaPlayer2". For instance if the app is called "org.my.App", it can only own "org.my.App", "org.my.App.*" and "org.mpris.MediaPlayer2.org.my.App". It is only allowed to talk to names matching those patterns, plus the bus itself (org.freedesktop.DBus) and the portal 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. Available since 0.2. </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. Available since 0.2. </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. Available since 0.2. </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). Available since 0.2. </p></dd></dl></div></div><div class="refsect2"><a id="system-bus-policy-metadata"></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. Available since 0.2. </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="environment-metadata"></a><h3>[Environment]</h3><p> The [Environment] group specifies environment variables to set when running the application. Available since 0.3. </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><p> Note that environment variables can also be unset (removed from the environment) by listing them in the <code class="option">unset-environment</code> entry of the [Context] group. </p></div><div class="refsect2"><a id="extension-metadata"></a><h3>[Extension NAME]</h3><p> Runtimes and applications can define extension points, which allow optional, additional runtimes to be mounted at a specified location inside the sandbox when they are present on the system. Typical uses for extension points include translations for applications, or debuginfo for sdks. The name of the extension point is specified as part of the group heading. Since 0.11.4, the name may optionally include a tag in the NAME in the name@tag ref syntax if you wish to use different configurations (eg, versions) of the same extension concurrently. The "tag" is effectively ignored, but is necessary in order to allow the same extension name to be specified more than once. </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 point 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. Available since 0.1. </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 point is for. Available since 0.4.1. </p></dd><dt><span class="term"><code class="option">versions</code> (string)</span></dt><dd><p> The branches 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 point is for. Available since 0.9.1, and backported to the 0.8.x branch in 0.8.4. </p></dd><dt><span class="term"><code class="option">add-ld-path</code> (string)</span></dt><dd><p> A path relative to the extension point directory that will be appended to LD_LIBRARY_PATH. Available since 0.9.1, and backported to the 0.8.x branch in 0.8.3. </p></dd><dt><span class="term"><code class="option">merge-dirs</code> (string)</span></dt><dd><p> A list of relative paths of directories below the extension point directory that will be merged. Available since 0.9.1, and backported to the 0.8.x branch in 0.8.3. </p></dd><dt><span class="term"><code class="option">download-if</code> (string)</span></dt><dd><p> A condition that must be true for the extension to be auto-downloaded. As of 1.1.1 this supports multiple conditions separated by semi-colons. </p><p> These are the supported conditions: </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">active-gl-driver</code></span></dt><dd></dd><dt><span class="term"><code class="option">active-gtk-theme</code></span></dt><dd></dd><dt><span class="term"><code class="option">have-intel-gpu</code></span></dt><dd></dd><dt><span class="term"><code class="option">have-kernel-module-*</code></span></dt><dd></dd><dt><span class="term"><code class="option">on-xdg-desktop-*</code></span></dt><dd></dd></dl></div></dd><dt><span class="term"><code class="option">autoprune-unless</code> (string)</span></dt><dd><p> A condition that must be false for the extension to be considered unused when pruning. For example, <span class="command"><strong>flatpak uninstall --unused</strong></span> uses this information. The only currently recognized value is active-gl-driver, which is true if the name of the active GL driver matches the extension point basename. Available since 0.11.8. </p></dd><dt><span class="term"><code class="option">enable-if</code> (string)</span></dt><dd><p> A condition that must be true for the extension to be enabled. As of 1.1.1 this supports multiple conditions separated by semi-colons. See <code class="option">download-if</code> for available conditions. </p></dd><dt><span class="term"><code class="option">subdirectory-suffix</code> (string)</span></dt><dd><p> A suffix that gets appended to the directory name. This is very useful when the extension point naming scheme is "reversed". For example, an extension point for GTK+ themes would be /usr/share/themes/$NAME/gtk-3.0, which could be achieved using subdirectory-suffix=gtk-3.0. Available since 0.9.1, and backported to the 0.8.x branch in 0.8.3. </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 point name, and mount them at the corresponding name below the subdirectory. Available since 0.1. </p></dd><dt><span class="term"><code class="option">no-autodownload</code> (boolean)</span></dt><dd><p> Whether to automatically download extensions matching this extension point when updating or installing a 'related' application or runtime. Available since 0.6.7. </p></dd><dt><span class="term"><code class="option">locale-subset</code> (boolean)</span></dt><dd><p> If set, then the extensions are partially downloaded by default, based on the currently configured locales. This means that the extension contents should be a set of directories with the language code as name. Available since 0.9.13 (and 0.6.6 for any extensions called *.Locale) </p></dd><dt><span class="term"><code class="option">autodelete</code> (boolean)</span></dt><dd><p> Whether to automatically delete extensions matching this extension point when deleting a 'related' application or runtime. Available since 0.6.7. </p></dd><dt><span class="term"><code class="option">collection-id</code> (string)</span></dt><dd><p> The ID of the collection that this extension point belongs to. If this is unspecified, it defaults to the collection ID of the application or runtime that the extension point is for. Currently, extension points must be in the same collection as the application or runtime that they are for. Available since 0.99.1. </p></dd></dl></div></div><div class="refsect2"><a id="extension-of-metadata"></a><h3>[ExtensionOf]</h3><p> This optional group may be present if the runtime is an extension. </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">ref</code> (string)</span></dt><dd><p> The ref of the runtime or application that this extension belongs to. Available since 0.9.1. </p></dd><dt><span class="term"><code class="option">runtime</code> (string)</span></dt><dd><p> The runtime this extension will be inside of. If it is an app extension, this is the app's runtime; otherwise, this is identical to ref, without the runtime/ prefix. Available since 1.5.0. </p></dd><dt><span class="term"><code class="option">priority</code> (integer)</span></dt><dd><p> The priority to give this extension when looking for the best match. Default is 0. Available since 0.9.1, and backported to the 0.8.x branch in 0.8.3. </p></dd><dt><span class="term"><code class="option">tag</code> (string)</span></dt><dd><p> The tag name to use when searching for this extension's mount point in the parent flatpak. Available since 0.11.4. </p></dd></dl></div></div><div class="refsect2"><a id="extra-data-metadata"></a><h3>[Extra Data]</h3><p> This optional group may be present if the runtime or application uses extra data that gets downloaded separately. The data in this group gets merged into the repository summary, with the xa.extra-data-sources key. </p><p> If multiple extra data sources are present, their uri, size and checksum keys are grouped together by using the same suffix. If only one extra data source is present, the suffix can be omitted. </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">NoRuntime</code> (boolean)</span></dt><dd><p> Whether to mount the runtime while running the /app/bin/apply_extra script. Defaults to true, i.e. not mounting the runtime. Available since 0.9.1, and backported to the 0.8.x branch in 0.8.4. </p></dd><dt><span class="term"><code class="option">uri<em class="replaceable"><code>X</code></em></code> (string)</span></dt><dd><p> The uri for extra data source <em class="replaceable"><code>X</code></em>. The only supported uri schemes are http and https. Available since 0.6.13. </p></dd><dt><span class="term"><code class="option">size<em class="replaceable"><code>X</code></em></code> (integer)</span></dt><dd><p> The size for extra data source <em class="replaceable"><code>X</code></em>. Available since 0.6.13. </p></dd><dt><span class="term"><code class="option">checksum<em class="replaceable"><code>X</code></em></code> (string)</span></dt><dd><p> The sha256 sum for extra data source <em class="replaceable"><code>X</code></em>. Available since 0.6.13. </p></dd></dl></div></div><div class="refsect2"><a id="policy-metadata"></a><h3>[Policy SUBSYSTEM]</h3><p> Subsystems can define their own policies to be placed in a group whose name has this form. Their values are treated as lists, in which items can have their meaning negated by prepending ! to the value. They are not otherwise parsed by Flatpak. Available since 0.6.13. </p></div></div><div class="refsect1"><a id="id1526"></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="id1527"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak"><span class="citerefentry"><span class="refentrytitle">flatpak</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-run"><span class="citerefentry"><span class="refentrytitle">flatpak-run</span>(1)</span></a>, <a class="citerefentry" href="#flatpak-override"><span class="citerefentry"><span class="refentrytitle">flatpak-override</span>(1)</span></a> </p></div></div><div class="refentry"><div class="refentry.separator"><hr /></div><a id="flatpak-remote"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>flatpak-remote — Configuration for a remote</p></div><div class="refsect1"><a id="id1528"></a><h2>Description</h2><p> Flatpak stores information about configured remotes for an installation location in <code class="filename">$installation/repo/config</code>. For example, the remotes for the default system-wide installation are in <code class="filename">$prefix/var/lib/flatpak/repo/config</code>, and the remotes for the per-user installation are in <code class="filename">$HOME/.local/share/flatpak/repo/config</code>. </p><p> Normally, it is not necessary to edit remote config files directly, the <span class="command"><strong>flatpak remote-modify</strong></span> command should be used to change properties of remotes. </p><p> System-wide remotes can be statically preconfigured by dropping flatpakref files into <code class="filename">/etc/flatpak/remotes.d/</code>. </p></div><div class="refsect1"><a id="id1529"></a><h2>File format</h2><p> The remote config file format is using the same .ini file format that is used for systemd unit files or application .desktop files. </p><div class="refsect2"><a id="id1530"></a><h3>[remote …]</h3><p> All the configuration for the the remote with name NAME is contained in the [remote "NAME"] group. </p><p> The following keys are recognized by OSTree, among others: </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">url</code> (string)</span></dt><dd><p> The url for the remote. An URL of the form oci+https:// or oci+http:// is a Flatpak extension that indicates that the remote is not an ostree repository, but is rather an URL to an index of OCI images that are stored within a container image registry. </p></dd><dt><span class="term"><code class="option">gpg-verify</code> (boolean)</span></dt><dd><p>Whether to use GPG verification for content from this remote.</p></dd><dt><span class="term"><code class="option">gpg-verify-summary</code> (boolean)</span></dt><dd><p>Whether to use GPG verification for the summary of this remote.</p><p>This is ignored if <code class="option">collection-id</code> is set, as refs are verified in commit metadata in that case. Enabling <code class="option">gpg-verify-summary</code> would break peer to peer distribution of refs.</p></dd><dt><span class="term"><code class="option">collection-id</code> (string)</span></dt><dd><p>The globally unique identifier for the upstream collection repository, to allow mirrors to be grouped.</p></dd></dl></div><p> All flatpak-specific keys have a xa. prefix: </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">xa.disable</code> (boolean)</span></dt><dd><p>Whether the remote is disabled. Defaults to false.</p></dd><dt><span class="term"><code class="option">xa.prio</code> (integer)</span></dt><dd><p>The priority for the remote. This is used when listing remotes, and when searching them for the runtime needed by an app. The remote providing the app is searched for its runtime before others with equal priority. Defaults to 1.</p></dd><dt><span class="term"><code class="option">xa.noenumerate</code> (boolean)</span></dt><dd><p>Whether this remote should be ignored when presenting available apps/runtimes, or when searching for a runtime dependency. Defaults to false.</p></dd><dt><span class="term"><code class="option">xa.nodeps</code> (boolean)</span></dt><dd><p>Whether this remote should be excluded when searching for dependencies. Defaults to false.</p></dd><dt><span class="term"><code class="option">xa.title</code> (string)</span></dt><dd><p>An optional title to use when presenting this remote in a UI.</p></dd><dt><span class="term"><code class="option">xa.title-is-set</code> (boolean)</span></dt><dd><p>This key is set to true if <code class="option">xa.title</code> has been explicitly set.</p></dd><dt><span class="term"><code class="option">xa.comment</code> (string)</span></dt><dd><p>An optional single-line comment to use when presenting this remote in a UI.</p></dd><dt><span class="term"><code class="option">xa.comment-is-set</code> (boolean)</span></dt><dd><p>This key is set to true if <code class="option">xa.comment</code> has been explicitly set.</p></dd><dt><span class="term"><code class="option">xa.description</code> (string)</span></dt><dd><p>An optional full-paragraph of text to use when presenting this remote in a UI.</p></dd><dt><span class="term"><code class="option">xa.description-is-set</code> (boolean)</span></dt><dd><p>This key is set to true if <code class="option">xa.description</code> has been explicitly set.</p></dd><dt><span class="term"><code class="option">xa.homepage</code> (string)</span></dt><dd><p>An optional URL that points to a website for this repository to use when presenting this remote in a UI.</p></dd><dt><span class="term"><code class="option">xa.homepage-is-set</code> (boolean)</span></dt><dd><p>This key is set to true if <code class="option">xa.homepage</code> has been explicitly set.</p></dd><dt><span class="term"><code class="option">xa.icon</code> (string)</span></dt><dd><p>An optional URL that points to an icon for this repository to use when presenting this remote in a UI.</p></dd><dt><span class="term"><code class="option">xa.icon-is-set</code> (boolean)</span></dt><dd><p>This key is set to true if <code class="option">xa.icon</code> has been explicitly set.</p></dd><dt><span class="term"><code class="option">xa.default-branch</code> (string)</span></dt><dd><p>The default branch to use when installing from this remote.</p></dd><dt><span class="term"><code class="option">xa.default-branch-is-set</code> (boolean)</span></dt><dd><p>This key is set to true if <code class="option">xa.default-branch</code> has been explicitly set.</p></dd><dt><span class="term"><code class="option">xa.main-ref</code> (string)</span></dt><dd><p>The main reference served by this remote. This is used for origin remotes of applications installed via a flatpakref file.</p></dd></dl></div></div></div><div class="refsect1"><a id="id1531"></a><h2>Examples</h2><pre class="programlisting"> [remote "gnome-nightly-apps"] gpg-verify=true gpg-verify-summary=true url=https://sdk.gnome.org/nightly/repo-apps/ xa.title=GNOME Applications </pre><pre class="programlisting"> [remote "flathub"] gpg-verify=true gpg-verify-summary=false collection-id=org.flathub.Stable url=https://dl.flathub.org/repo/ xa.title=Flathub </pre></div><div class="refsect1"><a id="id1532"></a><h2>See also</h2><p> <a class="citerefentry" href="#flatpak-remote-modify"><span class="citerefentry"><span class="refentrytitle">flatpak-remote-modify</span>(1)</span></a> </p></div></div></div></div></body></html>
Save
Cancel