+
Flatpak comes with a rich commandline interface. -
Table of Contents
flatpak-install — Install an application or runtime
flatpak install [OPTION...] REMOTE REF...
flatpak install [OPTION...] [ --bundle | --from ] FILENAME
- Installs an application or runtime. REMOTE must name - an existing remote and REF is a reference to the - application or runtime to install. +
Table of Contents
Table of Contents
flatpak — Build, install and run applications and runtimes
flatpak [OPTION...] {COMMAND}
+ 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.
- Each REF arguments is a full or partial indentifier 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 an error message
- will list the alternatives.
+ flatpak can operate in system-wide or per-user mode. The system-wide
+ data (runtimes, applications and configuration) is located in
+ $prefix/var/lib/flatpak/, and the per-user
+ data is in $HOME/.local/share/flatpak/.
+ Below these locations, there is a local repository in the
+ repo/ subdirectory and installed runtimes
+ and applications are in the corresponding runtime/
+ and app/ subdirectories.
- By default this looks for both apps and runtime with the given REF in
- the specified REMOTE , but you can limit this by using the --app or
- --runtime option, or by supplying the initial element in the REF.
+ System-wide remotes can be statically preconfigured by dropping
+ config fragments into /etc/flatpak/remotes.d/.
- Note that flatpak allows one to have multiple branches of an application and runtimes
- installed and used at the same time. However, only version of an application one can be current,
- meaning its exported files (for instance desktop files and icons) are
- visible to the host. The last installed version is made current by
- default, but you can manually change with make-current.
+ In addition to the system-wide installation in $prefix/var/lib/flatpak/,
+ which is always considered the default one unless overridden, more
+ system-wide installations can be defined via configuration files in
+ /etc/flatpak/installations.d/, 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.
- Unless overridden with the --user option, this command creates a - system-wide installation. -
- The alternative form of the command installs an application from a - single-file bundle or a flatpakref file instead of a configured remote. - Bundles can be created with the flatpak build-bundle command, flatpakref - files are simple references to a remote repo for an application. -
The following options are understood:
-h, --help+ flatpak uses OSTree to distribute and deploy data. The repositories + it uses are OSTree repositories and can be manipulated with the + ostree utility. Installed runtimes and + applications are OSTree checkouts. +
The following options are understood:
-h, --help+ Show help options and exit. +
-v, --verbose+ Print debug information during command processing. Use -vv for more detail. +
--ostree-verbose+ Print OSTree debug information during command processing. +
--version+ Print version information and exit. +
--default-arch+ Print the default arch and exit. +
--supported-arches+ Print the supported arches in priority order and exit. +
--gl-drivers+ Print the list of active gl drivers and exit. +
Commands for managing installed applications and runtimes:
+ Install an application or a runtime from a remote or bundle. +
+ Update an installed application or runtime. +
+ Uninstall an installed application or runtime. +
+ List installed applications and/or runtimes. +
+ Show information for an installed application or runtime. +
+ Manage flatpak configuration. +
Commands for finding applications and runtimes:
+ Search for applications and runtimes. +
Commands for running applications:
+ Run an application. +
+ Override permissions for an application. +
+ Specify the default version to run. +
+ Enter the namespace of a running application. +
Commands for managing file access:
+ Grant an application access to a specific file. +
+ Revoke access to a specific file. +
+ Show information about a specific file. +
+ List exported files. +
Commands for managing remote repositories:
+ List all configured remote repositories. +
+ Add a new remote repository. +
+ Modify properties of a configured remote repository. +
+ Delete a configured remote repository. +
+ List contents of a configured remote repository. +
+ Show information about a ref in a configured remote repository. +
Commands for building applications:
+ Initialize a build directory. +
+ Run a build command in a build directory. +
+ Finalizes a build directory for export. +
+ Export a build directory to a repository. +
+ Create a bundle file from a ref in a local repository. +
+ Import a file bundle into a local repository. +
+ Sign an application or runtime after its been exported. +
+ Update the summary file in a repository. +
+ Create a new commit based on an existing ref. +
+ Besides standard environment variables such as XDG_DATA_DIRS and
+ XDG_DATA_HOME, flatpak is consulting some of its own.
+
FLATPAK_USER_DIR
+ The location of the per-user installation. If this is not set,
+ $XDG_DATA_HOME/flatpak is used.
+
FLATPAK_SYSTEM_DIR
+ The location of the default system-wide installation. If this is not set,
+ /var/lib/flatpak is used (unless overridden at build
+ time by --localstatedir or --with-system-install-dir).
+
FLATPAK_CONFIG_DIR
+ The location of flatpak site configuration. If this is not set,
+ /etc/flatpak is used (unless overridden at build
+ time by --sysconfdir).
+
Table of Contents
flatpak-build-bundle — Create a single-file bundle from a local repository
flatpak build-bundle [OPTION...] LOCATION FILENAME NAME [BRANCH]
+ 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. + +
+ 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. +
The following options are understood:
-h, --helpShow help options and exit. -
--bundle- Install from a bundle file instead - of a configured remote. -
--from- Install from a flatpakref file instead - of a configured remote. -
--user- Create a per-user installation. -
--system- Create a system-wide installation. -
--arch=ARCH- The default architecture to install for, if not given explicitly in the REF . -
--subpath=PATH- 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., -
--no-deploy- Download the latest version, but don't deploy it. -
--no-pull- Don't download the latest version, deploy whatever is locally available. -
--no-related- Don't download related extensions, such as the locale data. -
--no-deps- Don't verify runtime dependencies when installing. -
--app- Assume that all REF s are apps if not explicitly specified.
--runtime- Assume that all REF s are runtimes if not explicitly specified. -
-v, --verbose- Print debug information during command processing. -
--ostree-verbose- Print OSTree debug information during command processing. -
--version- Print version information and exit. -
flatpak-update — Update an application or runtime
flatpak update [OPTION...] [REF...]
- Updates applications and runtimes. REF is a reference to the - application or runtime to install. If no REF is given, everything - is updated. -
- Each REF arguments is a full or partial indentifier 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. -
- By default this looks for both apps and runtime with the given REF in - the specified REMOTE , but you can limit this by using the --app or - --runtime option, or by supplying the initial element in the REF. -
- Normally, this command updates the application to the tip - of its branch. But it is possible to check out another commit, - with the --commit option. -
- 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 --commit option. -
- Unless overridden with the --user option, this command updates - a system-wide installation. -
The following options are understood:
-h, --help- Show help options and exit. -
--user- Update a per-user installation. -
--system- Update a system-wide installation. + Export a runtime instead of an application.
--arch=ARCH- The architecture to update for. -
--subpath=PATH- 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. -
--commit=COMMIT- Update to this commit, instead of the tip of the branch. -
--no-deploy- Download the latest version, but don't deploy it. -
--no-pull- Don't download the latest version, deploy it whatever is locally available. -
--no-related- Don't download related extensions, such as the locale data. -
--no-deps- Don't update or install runtime dependencies when installing. -
--app- Only look for an app with the given name. -
--appstream- Update appstream for the remote. -
--runtime- Only look for an runtime with the given name. -
-v, --verbose- Print debug information during command processing. -
--ostree-verbose- Print OSTree debug information during command processing. -
--version- Print version information and exit. -
flatpak-uninstall — Uninstall an application or runtime
flatpak uninstall [OPTION...] [REF...]
- Uninstalls an application or runtime. REF is a reference to the - application or runtime to install. If no REF is given, everything - is updated. -
- Each REF arguments is a full or partial indentifier 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. -
- By default this looks for both installed apps and runtime - with the given NAME , but you can - limit this by using the --app or --runtime option. -
- Normally, this command removes the ref for this application/runtime from the - local OSTree repository and purges and objects that are no longer - needed to free up disk space. If the same application is later - reinstalled, the objects will be pulled from the remote repository - again. The --keep-ref option can be used to prevent this. -
- If all branches of the application/runtime are removed, this command - also purges the data directory for the application. -
- Unless overridden with the --user option, this command updates - a system-wide installation. -
The following options are understood:
-h, --help- Show help options and exit. -
--keep-ref- Keep the ref for the application and the objects belonging to it - in the local repository. -
--user- Remove a per-user installation. -
--system- Remove a system-wide installation. -
--arch=ARCH- The architecture to uninstall, instead of the architecture of - the host system. -
--app- Only look for an app with the given name. -
--runtime- Only look for an runtime with the given name. -
--no-related- Don't uninstall related extensions, such as the locale data. -
-v, --verbose- Print debug information during command processing. -
--ostree-verbose- Print OSTree debug information during command processing. -
--version- Print version information and exit. -
flatpak-list — List installed applications and/or runtimes
flatpak list [OPTION...]
- Lists the names of the installed applications and/or runtime. -
- By default, both per-user and system-wide installations - are shown. Use the --user or --system options to change - this. -
- By default this lists the installed apps, but you can - change this by using the --app or --runtime option. -
The following options are understood:
-h, --help- Show help options and exit. -
--user- List per-user installations. -
--system- List system-wide installations. -
--arch=ARCH- List installations for this architecture. -
--show-details- Show arches and branches, in addition to the application names. -
--app- List applications. -
--runtime- List runtimes. -
-v, --verbose- Print debug information during command processing. -
--ostree-verbose- Print OSTree debug information during command processing. -
--version- Print version information and exit. -
flatpak-info — Show information about installed application and/or runtime
flatpak info [OPTION...] NAME [BRANCH]
- Show info about and installed application and/or runtime. -
- By default, both per-user and system-wide installations - are queried. Use the --user or --system options to change - this. -
- By default this queries the installed apps and runtimes, but you can - limit this by using the --app or --runtime option. -
The following options are understood:
-h, --help- Show help options and exit. -
--user- Query per-user installations. -
--system- Query system-wide installations. -
--app- Query for applications. -
--runtime- Query for runtimes. -
-r, --show-ref- Show the installed ref. -
-o, --show-origin- Show the remote the ref is installed from. -
-c, --show-commit- Show the installed commit id. + The arch to create a bundle for. +
--repo-url=URL+ The URL for the repository from which the + application can be updated. Installing the + bundle will automatically configure a remote + for this URL. +
--runtime-repo=URL+ The URL for a .flatpakrepo file that contains + the information about the repository that supplies + the runtimes required by the app. +
--gpg-keys=FILE+ Add the GPG key from FILE (use - for stdin). +
--gpg-homedir=PATH+ GPG Homedir to use when looking for keyrings. +
--oci+ Export to an OCI image instead of a Flatpak bundle.
-v, --verbosePrint debug information during command processing.
--versionPrint version information and exit. -
+ ostree(1), + flatpak(1), + flatpak-build-init(1), + flatpak-build(1), + flatpak-build-finish(1), + flatpak-build-import-bundle(1), + flatpak-build-update-repo(1) +
flatpak-build-commit-from — Create new commits based on existing one (possibly from another repository)
flatpak build-commit-from [OPTION...] DST-REPO DST-REF...
+ 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. +
- flatpak creates a sandboxed environment for the application to run in
- by mounting the right runtime at /usr and a writable
- directory at /var, whose content is preserved between
- application runs. The application itself is mounted at /app.
+ 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.
- The details of the sandboxed environment are controlled by the application - metadata and various options like --share and --socket that are passed to the run - command: Access is allowed if it was requested either in the application - metadata file or with an option and the user hasn't overridden it. -
The following options are understood:
-h, --help+ 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. +
The following options are understood:
-h, --helpShow help options and exit. -
-v, --verbose- Print debug information during command processing. -
--version- Print version information and exit. -
--arch=ARCH- The architecture to install for. -
--command=COMMAND- The command to run instead of the one listed in the application metadata. -
--branch=BRANCH- The branch to use. -
-d, --devel- 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. -
--runtime=RUNTIME- 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. -
--runtime-version=VERSION- 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. -
--share=SUBSYSTEM- 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. -
--unshare=SUBSYSTEM- 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. -
--socket=SOCKET- Expose a well known socket to the application. This overrides to - the Context section from the application metadata. - SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. - This option can be used multiple times. -
--nosocket=SOCKET- Don't expose a well known socket to the application. This overrides to - the Context section from the application metadata. - SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. - This option can be used multiple times. -
--device=DEVICE- Expose a device to the application. This overrides to - the Context section from the application metadata. - DEVICE must be one of: dri, kvm, all. - This option can be used multiple times. -
--nodevice=DEVICE- 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, all. - This option can be used multiple times. -
--allow=FEATURE- Allow access to a specific feature. This overrides to - the Context section from the application metadata. - FEATURE must be one of: devel, multiarch. - This option can be used multiple times. -
--disallow=FEATURE- Disallow access to a specific feature. This overrides to - the Context section from the application metadata. - FEATURE must be one of: devel, multiarch. - This option can be used multiple times. -
--filesystem=FS- Allow the application access to a subset of the filesystem. - This overrides to the Context section from the application metadata. - FS can be one of: home, host, xdg-desktop, xdg-documents, xdg-download - xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, - an absolute path, or a homedir-relative path like ~/dir or paths - relative to the xdg dirs, like xdg-download/subdir. - This option can be used multiple times. -
--env=VAR=VALUE- Set an environment variable in the application. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -
--own-name=NAME- 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. -
--talk-name=NAME- 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. -
--system-own-name=NAME- 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. -
--system-talk-name=NAME- 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. -
--persist=FILENAME- 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. -
--log-session-bus- Log session bus traffic. This can be useful to see what access you need to allow in - your D-Bus policy. -
--log-system-bus- Log system bus traffic. This can be useful to see what access you need to allow in - your D-Bus policy. -
flatpak-override — Override application requirements
flatpak override [OPTION...] APP
- Overrides the application specified runtime requirements. This can be used - to grant a sandboxed application more or less resources than it requested. -
- By default the application gets access to the resources it - requested when it is started. But the user can override it - on a particular instance by specifying extra arguments to - flatpak run, or every time by using flatpak override. -
The following options are understood:
-h, --help- Show help options and exit. -
--share=SUBSYSTEM- 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. -
--unshare=SUBSYSTEM- 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. -
--socket=SOCKET- Expose a well-known socket to the application. This overrides to - the Context section from the application metadata. - SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. - This option can be used multiple times. -
--nosocket=SOCKET- Don't expose a well-known socket to the application. This overrides to - the Context section from the application metadata. - SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. - This option can be used multiple times. -
--device=DEVICE- Expose a device to the application. This overrides to - the Context section from the application metadata. - DEVICE must be one of: dri, kvm, all. - This option can be used multiple times. -
--nodevice=DEVICE- 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, all. - This option can be used multiple times. -
--filesystem=FS- Allow the application access to a subset of the filesystem. - This overrides to the Context section from the application metadata. - FS can be one of: home, host, xdg-desktop, xdg-documents, xdg-download - xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, - an absolute path, or a homedir-relative path like ~/dir or paths - relative to the xdg dirs, like xdg-download/subdir. - This option can be used multiple times. -
--env=VAR=VALUE- Set an environment variable in the application. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -
--own-name=NAME- 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. -
--talk-name=NAME- 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. -
--system-own-name=NAME- 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. -
--system-talk-name=NAME- 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. -
--persist=FILENAME- 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. -
-v, --verbose- Print debug information during command processing. -
--version- Print version information and exit. -
flatpak-enter — Enter an application
flatpak enter [OPTION...] MONITORPID COMMAND [ARG...]
- Enter a running sandbox. - SANDBOXEDPID must be the pid of a process running in a flatpak sandbox. - COMMAND is the command to run in the sandbox. - Extra arguments are passed on to the command. -
- 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. -
- This command requires extra privileges, so must be run as root or via e.g. sudo. -
flatpak-document-export — Export a file to a sandboxed application
flatpak document-export [OPTION...] FILE
- Creates a document id for a local file that can be exposed to - sandboxed applications, allowing them access to files that they - would not otherwise see. The exported files are exposed in a - fuse filesystem at /run/user/$UID/doc/. -
- 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. -
The following options are understood:
-h, --help- Show help options and exit. -
--uniqueDon't reuse an existing document id - for the file. This makes it safe to later remove the - document when you're finished with it. -
--transient- The document will only exist for the length of - the session. This is useful for temporary grants. -
--app=APPID- Grant read access to the specified application. The - --allow and --forbid options can be used to grant - or remove additional privileges. - This option can be used multiple times. -
--allow-read- Grant read access to the applications specified with --app. - This defaults to TRUE. -
--forbid-read- Revoke read access for the applications specified with --app. -
--allow-write- Grant write access to the applications specified with --app. -
--forbid-write- Revoke write access for the applications specified with --app. -
--allow-delete- Grant the ability to remove the document from the document portal to the applications specified with --app. -
--forbid-delete- Revoke the ability to remove the document from the document portal from the applications specified with --app. -
--allow-grant-permission- Grant the ability to grant further permissions to the applications specified with --app. -
--forbid-grant-permission- Revoke the ability to grant further permissions for the applications specified with --app. -
-v, --verbose- Print debug information during command processing. -
--version- Print version information and exit. -
flatpak-document-unexport — Stop exporting a file
flatpak document-export [OPTION...] FILE
- Removes the document id for the file from the - document portal. This will make the document unavailable - to all sandboxed applications. -
flatpak-document-info — Show information about exported files
flatpak document-info [OPTION...] FILE
- 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. -
- FILE can either be a file in the fuse filesystem at /run/user/$UID/doc/, - or a file anywhere else. -
The following options are understood:
-h, --help- Show help options and exit. -
-v, --verbose- Print debug information during command processing. -
--version- Print version information and exit. -
flatpak-document-list — List exported files
flatpak document-list [OPTION...] [APPID]
- 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. -
flatpak-remote-add — Add a remote repository
flatpak remote-add [OPTION...] NAME LOCATION
- Adds a remote repository to the flatpak repository configuration. - NAME is the name for the new remote, and - LOCATION is the url or pathname for the repository. -
- Unless overridden with the --user option, this command changes - the system-wide configuration. -
- The alternative form of the command adds a remote from a flatpakrepo - file. -
The following options are understood:
-h, --help- Show help options and exit. -
--from- Add from a flatpakrepo file (local or http uri) instead of from commandline arguments. This means the LOCATION argument specifies the filename/uri of a flatpakref rather than a repo url. -
--user- Modify the per-user configuration. -
--system- Modify the system-wide configuration. -
--no-gpg-verify- Disable GPG verification for the added remote. -
--prio=PRIO- Set the priority for the remote. Default is 1, higher is more prioritized. This is - mainly used for graphical installation tools. -
--no-enumerate- Mark the remote as not enumerated. This means the remote will - not be used to list applications, for instance in graphical - installation tools. -
--no-use-for-deps- Mark the remote as not to be used for automatic runtime - dependency resolution. -
--if-not-exists- Do nothing if the provided remote already exists. -
--disable- Disable the added remote. -
--title=TITLE- A title for the remote, e.g. for display in a UI. -
--default-branch=BRANCH- A default branch to for the remote, mainly for use in a UI. -
--gpg-import=FILE- 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. -
-v, --verbose- Print debug information during command processing. -
--ostree-verbose- Print OSTree debug information during command processing. -
--version- Print version information and exit. -
flatpak-remote-modify — Modify a remote repository
flatpak remote-modify [OPTION...] NAME
- Modifies options for an existing remote repository in the flatpak repository configuration. - NAME is the name for the remote. -
- Unless overridden with the --user option, this command changes - the system-wide configuration. -
The following options are understood:
-h, --help- Show help options and exit. -
--user- Modify the per-user configuration. -
--system- Modify the system-wide configuration. -
--no-gpg-verify- Disable GPG verification for the added remote. -
--gpg-verify- Enable GPG verification for the added remote. -
--prio=PRIO- Set the priority for the remote. Default is 1, higher is more prioritized. This is - mainly used for graphical installation tools. -
--no-enumerate- Mark the remote as not enumerated. This means the remote will - not be used to list applications, for instance in graphical - installation tools. -
--no-use-for-deps- Mark the remote as not to be used for automatic runtime - dependency resolution. -
--disable- Disable the remote. Disabled remotes will not be automatically updated from. -
--enable- Enable the remote. -
--enumerate- Mark the remote as enumerated. This means the remote will - be used to list applications, for instance in graphical - installation tools. -
--use-for-deps- Mark the remote as to be used for automatic runtime - dependency resolution. -
--title=TITLE- A title for the remote, e.g. for display in a UI. -
--default-branch=BRANCH- A default branch to for the remote, mainly for use in a UI. -
--update-metadata- A default branch to for the remote, mainly for use in a UI. -
- 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. -
--gpg-import=FILE- 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. -
-v, --verbose- Print debug information during command processing. -
--ostree-verbose- Print OSTree debug information during command processing. -
--version- Print version information and exit. -
flatpak-remote-delete — Delete a remote repository
flatpak remote-delete [OPTION...] NAME
- Removes a remote repository from the flatpak repository configuration. - NAME is the name of an existing remote. -
- Unless overridden with the --user option, this command changes - the system-wide configuration. -
The following options are understood:
-h, --help- Show help options and exit. -
--user- Modify the per-user configuration. -
--system- Modify the system-wide configuration. +
--src-repo=SRC-REPO+ The (local) repository to pull the source branch from. Defaults to the + destination repository. +
--src-ref=SRC-REF+ 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. +
--untrusted+ The source repostory is not trusted, all objects are copied (not hardlinked) and + all checksums are verified. +
-s, --subject=SUBJECT+ One line subject for the commit message. If not specified, will be taken from the source commit. +
-b, --body=BODY+ Full description for the commit message. If not specified, will be taken from the source commit. +
--update-appstream+ Update the appstream branch after the build. +
--no-update-summary+ 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.
--force- Remove remote even if its in use by installed apps or runtimes. + Create new commit even if the content didn't change from the existing branch head. +
--gpg-sign=KEYID+ Sign the commit with this GPG key. + This option can be used multiple times. +
--gpg-homedir=PATH+ GPG Homedir to use when looking for keyrings
-v, --verbosePrint debug information during command processing.
--ostree-verbosePrint OSTree debug information during command processing.
--versionPrint version information and exit. -
flatpak-remote-list — List remote repositories
flatpak remote-list [OPTION...]
- Lists the known remote repositories, in priority order. -
- By default, both per-user and system-wide installations - are shown. Use the --user or --system options to change - this. -
The following options are understood:
-h, --help- Show help options and exit. -
--user- Show the per-user configuration. -
--system- Show the system-wide configuration. -
--show-details- Show more information each repository in addition to the name. -
--show-disabled- Show disabled repos. -
-v, --verbose- Print debug information during command processing. -
--ostree-verbose- Print OSTree debug information during command processing. -
--version- Print version information and exit. -
flatpak-remote-ls — Show available runtimes and applications
flatpak remote-ls [OPTION...] REMOTE
- Shows runtimes and applications that are available in the - remote repository with the name REMOTE . - You can find all configured remote repositories with flatpak remote-list. +Commit: 9d0044ea480297114d03aec85c3d7ae3779438f9d2cb69d717fb54237acacb8c +Metadata Total: 605 +Metadata Written: 5 +Content Total: 1174 +Content Written: 1 +Content Bytes Written: 305 +
+ ostree(1), + flatpak(1), + flatpak-build-init(1), + flatpak-build(1), + flatpak-build-finish(1), + flatpak-build-sign(1), + flatpak-build-update-repo(1) +
flatpak-build-export — Create a repository from a build directory
flatpak build-export [OPTION...] LOCATION DIRECTORY [BRANCH]
+ 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".
- Unless overridden with the --user option, this command uses - the system-wide configuration. -
The following options are understood:
-h, --help+ 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 ostree tool. +
+ The contents of DIRECTORY are committed
+ on the branch with name app/APPNAME/ARCH/BRANCH,
+ 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 files/ and export/
+ subdirectories and the metadata file are included
+ in the commit, anything else is ignored.
+
+ The build-update-repo command should be used to update repository + metadata whenever application builds are added to a repository. +
The following options are understood:
-h, --helpShow help options and exit. -
--user- Use the per-user configuration. -
--system- Use the system-wide configuration. -
-d, --show-details- Show arches, branches and commit ids, in addition to the names. -
--runtime- Show only runtimes, omit applications. -
--app- Show only applications, omit runtimes. -
--updates- Show only those which have updates available. +
-s, --subject=SUBJECT+ One line subject for the commit message. +
-b, --body=BODY+ Full description for the commit message.
--arch=ARCH- Show only those matching the specied architecture. By default, only - supported architectures are shown. Use --arch=* to show all archtectures. -
-v, --verbose- Print debug information during command processing. -
--ostree-verbose- Print OSTree debug information during command processing. -
--version- Print version information and exit. -
flatpak-build-init — Initialize a build directory
flatpak build-init [OPTION...] DIRECTORY APPNAME SDK RUNTIME [BRANCH]
- Initializes a directory for building an application. - DIRECTORY is the name of the directory. - APPNAME is the application id of the app - that will be built. - SDK and RUNTIME - specify the sdk and runtime that the application should be built - against and run in. -
- The result of this command is that a metadata
- file is created inside the given directory. Additionally, empty
- files and var subdirectories
- are created.
-
- It is an error to run build-init on a directory that has already - been initialized as a build directory. -
The following options are understood:
-h, --help- Show help options and exit. -
--arch=ARCH- The architecture to use. -
-v, --var=RUNTIME- Initialize var from the named runtime. -
-w, --writable-sdk
- 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
- usr subdirectory of the app dir, but will not be part of the final
- app.
-
--tag=TAG- Add a tag to the metadata file. + Specify the architecture component of the branch to export. Only host compatible architectures can be specified. +
--exclude=PATTERN+ Exclude files matching PATTERN from the commit. This option can be used multiple times. -
--sdk-extension=EXTENSION- When using --writable-sdk, in addition to the sdk, also install the specified extension. +
--include=PATTERN+ Don't exclude files matching PATTERN from the commit, even if they match the --export patterns. This option can be used multiple times. -
--sdk-dir
- Specify a custom subdirectory to use instead of usr for --writable-sdk.
-
--update- Re-initialize the sdk and var, don't fail if already initialized. -
--base=APP- Initialize the application with files from another specified application. -
--base-version=VERSION- Specify the version to use for --base. If not specified, will default to - "master". -
--base-extension=EXTENSION- When using --base, also install the specified extension from the app. +
--metadata=FILENAME
+ Use the specified filename as metadata in the exported app instead of
+ the default file (called metadata). This is useful
+ if you want to commit multiple things from a single build tree, typically
+ used in combination with --files and --exclude.
+
--files=SUBDIR
+ Use the files in the specified subdirectory as the file contents, rather
+ than the regular files directory.
+
--timestamp=DATE
+ Use the specified ISO 8601 formatted date in the commit metadata and, if --update-appstream is used, the appstream data.
+
--update-appstream+ Update the appstream branch after the build. +
--no-update-summary+ 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. +
--gpg-sign=KEYID+ Sign the commit with this GPG key. This option can be used multiple times. -
--verbose- Print debug information during command processing. -
--version- Print version information and exit. -
flatpak-build — Build in a directory
flatpak build [OPTION...] DIRECTORY [COMMAND [ARG...]]
- Runs a build command in a directory. DIRECTORY - must have been initialized with flatpak build-init. -
- The sdk that is specified in the metadata file
- in the directory is mounted at /usr and the
- files and var subdirectories
- are mounted at /app and /var,
- respectively. They are writable, and their contents are preserved between
- build commands, to allow accumulating build artifacts there.
-
The following options are understood:
-h, --help- Show help options and exit. -
-v, --verbose- Print debug information during command processing. -
--version- Print version information and exit. +
--gpg-homedir=PATH+ GPG Homedir to use when looking for keyrings
-r, --runtime- Use the non-devel runtime that is specified in the application metadata instead of the devel runtime. -
--bind-mount=DEST=SOURCE- Add a custom bind mount in the build namespace. Can be specified multiple times. -
--build-dir=PATH- Start the build in this directory (default is in the current directory). -
--share=SUBSYSTEM- 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. -
--unshare=SUBSYSTEM- 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. -
--socket=SOCKET- Expose a well-known socket to the application. This overrides to - the Context section from the application metadata. - SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. - This option can be used multiple times. -
--nosocket=SOCKET- Don't expose a well-known socket to the application. This overrides to - the Context section from the application metadata. - SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. - This option can be used multiple times. -
--device=DEVICE- Expose a device to the application. This overrides to - the Context section from the application metadata. - DEVICE must be one of: dri, kvm, all. - This option can be used multiple times. -
--nodevice=DEVICE- 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, all. - This option can be used multiple times. -
--filesystem=FILESYSTEM[:ro]- Allow the application access to a subset of the filesystem. - This overrides to the Context section from the application metadata. - FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download - xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, - an absolute path, or a homedir-relative path like ~/dir. - The optional :ro suffix indicates that the location will be read-only. - This option can be used multiple times. -
--nofilesystem=FILESYSTEM- Remove access to the specified subset of the filesystem from - the application. This overrides to the Context section from the - application metadata. - FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download - xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, - an absolute path, or a homedir-relative path like ~/dir. - This option can be used multiple times. -
--env=VAR=VALUE- Set an environment variable in the application. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -
--own-name=NAME- 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. -
--talk-name=NAME- 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. -
--system-own-name=NAME- 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. -
--system-talk-name=NAME- 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. -
--persist=FILENAME- 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. -
flatpak-build-finish — Finalize a build directory
flatpak build-finish [OPTION...] DIRECTORY
+ $ flatpak build-export ~/repos/gnome-calculator/ ~/build/gnome-calculator/ org.gnome.Calculator +
+Commit: 9d0044ea480297114d03aec85c3d7ae3779438f9d2cb69d717fb54237acacb8c +Metadata Total: 605 +Metadata Written: 5 +Content Total: 1174 +Content Written: 1 +Content Bytes Written: 305 +
+ ostree(1), + flatpak(1), + flatpak-build-init(1), + flatpak-build(1), + flatpak-build-finish(1), + flatpak-build-sign(1), + flatpak-build-update-repo(1) +
flatpak-build-finish — Finalize a build directory
flatpak build-finish [OPTION...] DIRECTORY
Finalizes a build directory, to prepare it for exporting. DIRECTORY is the name of the directory.
@@ -1005,12 +340,14 @@ org.freedesktop.glxgears
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. -
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
--command=COMMAND
The command to use. If this option is not specified,
the first executable found in files/bin
is used.
+
--require-version=MAJOR.MINOR.MICRO+ Require this version of later of flatpak to install/update to this build.
--share=SUBSYSTEMShare a subsystem with the host session. This updates the [Context] group in the metadata. @@ -1024,12 +361,12 @@ org.freedesktop.glxgears
--socket=SOCKETExpose a well known socket to the application. This updates the [Context] group in the metadata. - SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. + SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus. This option can be used multiple times.
--nosocket=SOCKETDon't expose a well known socket to the application. This updates the [Context] group in the metadata. - SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. + SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus. This option can be used multiple times.
--device=DEVICEExpose a device to the application. This updates @@ -1066,9 +403,29 @@ org.freedesktop.glxgears This updates the [Context] group in the metadata. FS can be one of: home, host, xdg-desktop, xdg-documents, xdg-download xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, - an absolute path, or a homedir-relative path like ~/dir or paths - relative to the xdg dirs, like xdg-download/subdir. + 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. +
--nofilesystem=FILESYSTEM+ Remove access to the specified subset of the filesystem from + the application. This overrides to the Context section from the + application metadata. + FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, + an absolute path, or a homedir-relative path like ~/dir. + This option can be used multiple times. +
--add-policy=SUBSYSTEM.KEY=VALUE+ Add generic policy option. For example, "--add-policy=subsystem.key=v1 --add-policy=subsystem.key=v2" would map to this metadata: +
+[Policy subsystem] +key=v1;v2; +
+
+ This option can be used multiple times. +
--remove-policy=SUBSYSTEM.KEY=VALUE+ Remove generic policy option. This option can be used multiple times.
--env=VAR=VALUESet an environment variable in the application. This updates the [Environment] group in the metadata. @@ -1101,6 +458,18 @@ org.freedesktop.glxgears allowing that location to be used for persistent data. This updates the [Context] group in the metadata. This option can be used multiple times. +
--runtime=RUNTIME, --sdk=SDK+ 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. +
--metadata=GROUP=KEY[=VALUE]+ Set a generic key in the metadata file. If value is left out it will + be set to "true". +
--extension=NAME=VARIABLE[=VALUE]+ Add extension point info. +
--extension-priority=VALUE+ Set the priority (library override order) of the extension point. + Only useful for extensions. 0 is the default, and higher value means higher + priority.
--extra-data=NAME:SHA256:DOWNLOAD-SIZE:INSTALL-SIZE:URLAdds 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 @@ -1114,7 +483,7 @@ org.freedesktop.glxgears Print OSTree debug information during command processing.
--versionPrint version information and exit. -
$ flatpak build-finish /build/my-app --socket=x11 --share=ipc
Exporting share/applications/gnome-calculator.desktop @@ -1122,137 +491,17 @@ 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 -
flatpak-build-export — Create a repository from a build directory
flatpak build-export [OPTION...] LOCATION DIRECTORY [BRANCH]
- 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". -
- 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 ostree tool. -
- The contents of DIRECTORY are committed
- on the branch with name app/APPNAME/ARCH/BRANCH,
- 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 files/ and export/
- subdirectories and the metadata file are included
- in the commit, anything else is ignored.
-
- The repo-update command should be used to update repository - metadata whenever application builds are added to a repository. -
The following options are understood:
-h, --help- Show help options and exit. -
-s, --subject=SUBJECT- One line subject for the commit message. -
-b, --body=BODY- Full description for the commit message. -
--arch=ARCH- Specify the architecture component of the branch to export. Only host compatible architectures can be specified. -
--exclude=PATTERN- Exclude files matching PATTERN from the commit. - This option can be used multiple times. -
--include=PATTERN- Don't exclude files matching PATTERN from the commit, even if they match the --export patterns. - This option can be used multiple times. -
--metadata=FILENAME
- Use the specified filename as metadata in the exported app instead of
- the default file (called metadata). This is useful
- if you want to commit multiple things from a single build tree, typically
- used in combination with --files and --exclude.
-
--files=SUBDIR
- Use the files in the specified subdirectory as the file contents, rather
- than the regular files directory.
-
--update-appstream- Run appstream-builder and to update the appstream branch after build. -
--no-update-summary- 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-repo-update - has been run. This is useful is you want to do multiple repo operations before - finally updating the summary. -
--gpg-sign=KEYID- Sign the commit with this GPG key. - This option can be used multiple times. -
--gpg-homedir=PATH- GPG Homedir to use when looking for keyrings -
--runtime- Export a runtime instead for an app (this uses the usr subdir as files). -
-v, --verbose- Print debug information during command processing. -
--ostree-verbose- Print OSTree debug information during command processing. -
--version- Print version information and exit. -
flatpak-build-bundle — Create a single-file bundle from a local repository
flatpak build-bundle [OPTION...] LOCATION FILENAME NAME [BRANCH]
- 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. -
- 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. -
The following options are understood:
-h, --help- Show help options and exit. -
--runtime- Export a runtime instead of an application. -
--arch=ARCH- The arch to create a bundle for. -
--repo-url=URL- The URL for the repository from which the - application can be updated. Installing the - bundle will automatically configure a remote - for this URL. -
--gpg-keys=FILE- Add the GPG key from FILE (use - for stdin). -
--gpg-homedir=PATH- GPG Homedir to use when looking for keyrings. -
--oci- Export to an OCI image instead of a Flatpak bundle. -
-v, --verbose- Print debug information during command processing. -
--version- Print version information and exit. -
flatpak-build-import-bundle — Import a file bundle into a local repository
flatpak build-import-bundle [OPTION...] LOCATION FILENAME
flatpak-build-import-bundle — Import a file bundle into a local repository
flatpak build-import-bundle [OPTION...] LOCATION FILENAME
Imports a bundle from a file named FILENAME into the repository at LOCATION .
The format of the bundle file is that generated by build-bundle. -
The following options are understood:
-h, --help+
The following options are understood:
-h, --helpShow help options and exit.
-v, --verbosePrint debug information during command processing. @@ -1263,10 +512,10 @@ Content Bytes Written: 305
--ociImport an OCI image instead of a Flatpak bundle.
--update-appstream- Run appstream-builder and to update the appstream branch after build. + Update the appstream branch after the build.
--no-update-summaryDon'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-repo-update + 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.
--gpg-sign=KEYID@@ -1276,50 +525,73 @@ Content Bytes Written: 305 GPG Homedir to use when looking for keyrings
--versionPrint version information and exit. -
flatpak-build-init — Initialize a build directory
flatpak build-init [OPTION...] DIRECTORY APPNAME SDK RUNTIME [BRANCH]
+ Initializes a directory for building an application. + DIRECTORY is the name of the directory. + APPNAME is the application id of the app + that will be built. + SDK and RUNTIME + specify the sdk and runtime that the application should be built + against and run in.
- After this command, LOCATION can be - used as the repository location for flatpak add-repo, either by - exporting it over http, or directly with a file: url. -
The following options are understood:
-h, --help
+ The result of this command is that a metadata
+ file is created inside the given directory. Additionally, empty
+ files and var subdirectories
+ are created.
+
+ It is an error to run build-init on a directory that has already + been initialized as a build directory. +
The following options are understood:
-h, --helpShow help options and exit. -
--title=TITLE- A title for the repository, e.g. for display in a UI. - The title is stored in the repository summary. -
--gpg-sign=KEYID- Sign the commit with this GPG key. +
--arch=ARCH+ The architecture to use. +
-v, --var=RUNTIME+ Initialize var from the named runtime. +
-w, --writable-sdk
+ 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
+ usr subdirectory of the app dir, but will not be part of the final
+ app.
+
--tag=TAG+ Add a tag to the metadata file. This option can be used multiple times. -
--gpg-homedir=PATH- GPG Homedir to use when looking for keyrings -
--generate-static-deltas- Generate static deltas for all references. This generates from-empty and - delta static files that allow for faster download. -
--prune- Remove unreferences objects in repo. -
--prune-depth- Only keep at most this number of old versions for any particular ref. Default is -1 which means infinite. -
-v, --verbose+
--sdk-extension=EXTENSION+ When using --writable-sdk, in addition to the sdk, also install the specified extension. + This option can be used multiple times. +
--sdk-dir
+ Specify a custom subdirectory to use instead of usr for --writable-sdk.
+
--update+ Re-initialize the sdk and var, don't fail if already initialized. +
--base=APP+ Initialize the application with files from another specified application. +
--base-version=VERSION+ Specify the version to use for --base. If not specified, will default to + "master". +
--base-extension=EXTENSION+ When using --base, also install the specified extension from the app. + This option can be used multiple times. +
--type=TYPE+ 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. +
--verbosePrint debug information during command processing. -
--ostree-verbose- Print OSTree debug information during command processing.
--versionPrint version information and exit. -
flatpak-build-sign — Sign an application or runtime
flatpak build-sign [OPTION...] LOCATION ID [BRANCH]
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 @@ -1328,7 +600,7 @@ Content Bytes Written: 305
Applications can also be signed during build-export, but it is sometimes useful to add additional signatures later. -
The following options are understood:
-h, --help+
flatpak-build-update-repo — Create a repository from a build directory
flatpak build-update-repo [OPTION...] LOCATION
+ 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. +
+ 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. +
The following options are understood:
-h, --help+ Show help options and exit. +
--redirect-url=URL+ Redirect this repo to a new URL. +
--title=TITLE+ A title for the repository, e.g. for display in a UI. + The title is stored in the repository summary. +
--default-branch=BRANCH+ A default branch for the repository, mainly for use in a UI. +
--gpg-import=FILE+ Import a new default GPG public key from the + given file. +
--gpg-sign=KEYID+ Sign the commit with this GPG key. + This option can be used multiple times. +
--gpg-homedir=PATH+ GPG Homedir to use when looking for keyrings +
--generate-static-deltas+ Generate static deltas for all references. This generates from-empty and + delta static files that allow for faster download. +
--prune+ Remove unreferenced objects in repo. +
--prune-depth+ Only keep at most this number of old versions for any particular ref. Default is -1 which means infinite. +
-v, --verbose+ Print debug information during command processing. +
--ostree-verbose+ Print OSTree debug information during command processing. +
--version+ Print version information and exit. +
flatpak-build — Build in a directory
flatpak build [OPTION...] DIRECTORY [COMMAND [ARG...]]
+ Runs a build command in a directory. DIRECTORY + must have been initialized with flatpak build-init. +
+ The sdk that is specified in the metadata file
+ in the directory is mounted at /usr and the
+ files and var subdirectories
+ are mounted at /app and /var,
+ respectively. They are writable, and their contents are preserved between
+ build commands, to allow accumulating build artifacts there.
+
The following options are understood:
-h, --help+ Show help options and exit. +
-v, --verbose+ Print debug information during command processing. +
-r, --runtime+ Use the non-devel runtime that is specified in the application metadata instead of the devel runtime. +
-p, --die-with-parent+ Kill the build process and all children when the launching process dies. +
--bind-mount=DEST=SOURCE+ Add a custom bind mount in the build namespace. Can be specified multiple times. +
--build-dir=PATH+ Start the build in this directory (default is in the current directory). +
--share=SUBSYSTEM+ 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. +
--unshare=SUBSYSTEM+ 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. +
--socket=SOCKET+ 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. + This option can be used multiple times. +
--nosocket=SOCKET+ 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. + This option can be used multiple times. +
--device=DEVICE+ Expose a device to the application. This overrides to + the Context section from the application metadata. + DEVICE must be one of: dri, kvm, all. + This option can be used multiple times. +
--nodevice=DEVICE+ 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, all. + This option can be used multiple times. +
--allow=FEATURE+ Allow access to a specific feature. This updates + the [Context] group in the metadata. + FEATURE must be one of: devel, multiarch. + This option can be used multiple times. +
+ The devel feature allows the application to
+ access certain syscalls such as ptrace(), and
+ perf_event_open().
+
+ The multiarch feature allows the application to
+ execute programs compiled for an ABI other than the one supported
+ natively by the system. For example, for the x86_64
+ architecture, 32-bit x86 binaries will be allowed as
+ well.
+
--disallow=FEATURE+ Disallow access to a specific feature. This updates + the [Context] group in the metadata. + FEATURE must be one of: devel, multiarch. + This option can be used multiple times. +
--filesystem=FILESYSTEM[:ro|:create]+ Allow the application access to a subset of the filesystem. + This overrides to the Context section from the application metadata. + FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, 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. +
--nofilesystem=FILESYSTEM+ Remove access to the specified subset of the filesystem from + the application. This overrides to the Context section from the + application metadata. + FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, + an absolute path, or a homedir-relative path like ~/dir. + This option can be used multiple times. +
--with-appdir+ Expose and configure access to the per-app storage directory in $HOME/.var/app. This is + not normally useful when building, but helps when testing built apps. +
--add-policy=SUBSYSTEM.KEY=VALUE+ Add generic policy option. For example, "--add-policy=subsystem.key=v1 --add-policy=subsystem.key=v2" would map to this metadata: +
+[Policy subsystem] +key=v1;v2; +
+
+ This option can be used multiple times. +
--remove-policy=SUBSYSTEM.KEY=VALUE+ Remove generic policy option. This option can be used multiple times. +
--env=VAR=VALUE+ Set an environment variable in the application. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +
--own-name=NAME+ 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. +
--talk-name=NAME+ 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. +
--system-own-name=NAME+ 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. +
--system-talk-name=NAME+ 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. +
--persist=FILENAME+ 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. +
--sdk-dir=DIR
+ Normally if there is a usr directory in the build dir, this is used
+ for the runtime files (this can be created by --writable-sdk or --type=runtime arguments
+ to build-init). If you specify --sdk-dir this directoryname will be used instead.
+ Use this if you passed --sdk-dir to build-init.
+
--readonly+ 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. +
--metadata=FILE
+ Use the specified filename as metadata in the exported app instead of
+ the default file (called metadata). This is useful
+ if you build multiple things from a single build tree (such as both a
+ platform and a sdk).
+
--log-session-bus+ Log session bus traffic. This can be useful to see what access you need to allow in + your D-Bus policy. +
--log-system-bus+ Log system bus traffic. This can be useful to see what access you need to allow in + your D-Bus policy. +
+ flatpak(1), + flatpak-build-init(1), + flatpak-build-finish(1), + flatpak-build-export(1) +
flatpak-config — Manage configuration
flatpak config [OPTION...] KEY VALUE
The following options are understood:
-h, --help+ Show help options and exit. +
--list+ Print all keys and their values +
--set+ Set key KEY to VALUE +
--unset+ Unset key KEY +
--get+ Print value of KEY. +
--user+ Configure per-user installation. +
--system+ Configure system-wide installation. +
--installation=NAME
+ Configure the system-wide installation
+ specified by NAME among those defined in
+ /etc/flatpak/installations.d/. Using
+ --installation=default is equivalent to using
+ --system .
+
flatpak-document-export — Export a file to a sandboxed application
flatpak document-export [OPTION...] FILE
+ Creates a document id for a local file that can be exposed to + sandboxed applications, allowing them access to files that they + would not otherwise see. The exported files are exposed in a + fuse filesystem at /run/user/$UID/doc/. +
+ 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. +
The following options are understood:
-h, --help+ Show help options and exit. +
-u, --uniqueDon't reuse an existing document id + for the file. This makes it safe to later remove the + document when you're finished with it. +
-t, --transient+ The document will only exist for the length of + the session. This is useful for temporary grants. +
-n, --noexist+ Don't require the file to exist already. +
-a, --app=APPID+ Grant read access to the specified application. The + --allow and --forbid options can be used to grant + or remove additional privileges. + This option can be used multiple times. +
-r, --allow-read+ Grant read access to the applications specified with --app. + This defaults to TRUE. +
--forbid-read+ Revoke read access for the applications specified with --app. +
-w, --allow-write+ Grant write access to the applications specified with --app. +
--forbid-write+ Revoke write access for the applications specified with --app. +
-d, --allow-delete+ Grant the ability to remove the document from the document portal to the applications specified with --app. +
--forbid-delete+ Revoke the ability to remove the document from the document portal from the applications specified with --app. +
-g, --allow-grant-permission+ Grant the ability to grant further permissions to the applications specified with --app. +
--forbid-grant-permission+ Revoke the ability to grant further permissions for the applications specified with --app. +
-v, --verbose+ Print debug information during command processing. +
--version+ Print version information and exit. +
flatpak-builder — Help build application dependencies
flatpak-builder [OPTION...] DIRECTORY MANIFEST
flatpak-builder --run [OPTION...] DIRECTORY MANIFEST COMMAND
flatpak-builder --show-deps [OPTION...] MANIFEST
- flatpak-builder is a wrapper around the flatpak build command - that automates the building of applications and their dependencies. It is one option you can use - to build applications. +/run/user/1000/doc/e52f9c6a/test.txt +
+ flatpak(1), + flatpak-document-unexport(1), + flatpak-document-info(1), + flatpak-document-list(1) +
flatpak-document-info — Show information about exported files
flatpak document-info [OPTION...] FILE
+ 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.
- The goal of flatpak-builder is to push as much knowledge about how to build modules to - the individual upstream projects. It does this by assuming that the modules adhere to the Build API specified - at https://github.com/cgwalters/build-api. This essentially means that it follows the ./configure - && make && make install scheme with an optional autogen script. If the upstream - does not adhere to the API you can make it do so by adding patches and extra files. + FILE can either be a file in the fuse filesystem at /run/user/$UID/doc/, + or a file anywhere else. +
The following options are understood:
-h, --help+ Show help options and exit. +
-v, --verbose+ Print debug information during command processing. +
--version+ Print version information and exit. +
+ $ flatpak document-info ~/Sources/gtk/gail-3.0.pc +
+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 +
+ flatpak(1), + flatpak-document-export(1), + flatpak-document-unexport(1), + flatpak-document-list(1) +
flatpak-document-list — List exported files
flatpak document-list [OPTION...] [APPID]
+ 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. +
The following options are understood:
-h, --help+ Show help options and exit. +
-v, --verbose+ Print debug information during command processing. +
--version+ Print version information and exit. +
+ flatpak(1), + flatpak-document-export(1), + flatpak-document-unexport(1), + flatpak-document-info(1) +
flatpak-document-unexport — Stop exporting a file
flatpak document-export [OPTION...] FILE
+ Removes the document id for the file from the + document portal. This will make the document unavailable + to all sandboxed applications. +
The following options are understood:
-h, --help+ Show help options and exit. +
-v, --verbose+ Print debug information during command processing. +
--version+ Print version information and exit. +
+ flatpak(1), + flatpak-document-export(1), + flatpak-document-info(1), + flatpak-document-list(1) +
flatpak-enter — Enter an application
flatpak enter [OPTION...] MONITORPID COMMAND [ARG...]
+ Enter a running sandbox. + SANDBOXEDPID must be the pid of a process running in a flatpak sandbox. + COMMAND is the command to run in the sandbox. + Extra arguments are passed on to the command.
- An invocation of flatpak-builder proceeds in these stages, each being specified - in detail in json format in MANIFEST : -
Download all sources
Initialize the application directory with flatpak build-init
Build and install each module with flatpak build
Clean up the final build tree by removing unwanted files and e.g. stripping binaries
Finish the application directory with flatpak build-finish
-
- After this you will end up with a build of the application in DIRECTORY , which you can
- export to a repository with the flatpak build-export command. If you use the --repo
- option, flatpack-builder will do the export for you at the end of the build process. When flatpak-builder does the
- export, it also stores the manifest that was used for the build in /app/manifest.json. The manifest is 'resolved',
- i.e. git branch names are replaced by the actual commit IDs that were used in the build.
+ 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.
- At each of the above steps flatpak caches the result, and if you build the same file again, it will start - of at the first step where something changes. For instance the first version controlled source that had - new commits added, or the first module where some changes to the MANIFEST file caused - the build environment to change. This makes flatpak-builder very efficient for incremental builds. -
- The top level of the json file describes global - attributes of the application, and how it can be - build, and the list of modules that need to be - built. -
- These are the properties that are accepted: -
id or app-id (string)A string defining the application id.
branch (string)The branch of the application, defaults to master.
runtime (string)The name of the runtime that the application uses.
runtime-version (string)The version of the runtime that the application uses, defaults to master.
sdk (string)The name of the development runtime that the application builds with.
var (string)Initialize the (otherwise empty) writable /var in the build with a copy of this runtime.
metadata (string)Use this file as the base metadata file when finishing.
command (string)The filename or path to the main binary of the application. Note that this is really just a single file, not a commandline. If you want to pass arguments, install a shell script wrapper and use that as the command.
build-runtime (boolean)Build a new runtime instead of an application.
separate-locales (boolean)Separate out locale files and translations to an extension runtime. Defaults to true.
id-platform (string)When building a runtime sdk, also create a platform based on it with this id.
metadata-platform (string)The metadata file to use for the platform we create.
writable-sdk (boolean)If true, use a writable copy of the sdk for /usr. - Defaults to true if --build-runtime is specified.
appstream-compose (boolean)Run appstream-compose during cleanup phase. Defaults to true.
sdk-extensions (array of strings)Install these extra sdk extensions in /usr.
platform-extensions (array of strings)Install these extra sdk extensions when creating the platform.
base (string)Start with the files from the specified application. This can be - used to create applications that extend another application.
base-version (string)Use this specific version of the application specified in base. - If unspecified, this uses the value specified in branch
base-extensions (array of strings)Install these extra extensions from the base application when initializing - the application directory.
tags (array of strings)Add these tags to the metadata file.
build-options (object)Object specifying the build environment. See below for details.
modules (array of objects or string)An array of objects specifying the modules to be built in order. - String members in the array are interpreted as the name of a separate json file that contains a module. - See below for details.
cleanup (array of strings)An array of file patterns that should be removed at the end. - Patterns starting with / are taken to be full pathnames (without the /app prefix), otherwise they just match - the basename.
cleanup-commands (array of strings)An array of commandlines that are run during the cleanup phase.
cleanup-platform (array of strings)Extra files to clean up in the platform.
finish-args (array of strings)An array of arguments passed to the flatpak build-finish command.
rename-desktop-file (string)Any desktop file with this name will be renamed to a name based on id during the cleanup phase.
rename-appdata-file (string)Any appdata file with this name will be renamed to a name based on id during the cleanup phase.
rename-icon (string)Any icon with this name will be renamed to a name based on id during the cleanup phase.
copy-icon (boolean)If rename-icon is set, keep a copy of the old icon file.
desktop-file-name-prefix (string)This string will be prefixed to the Name key in the main application desktop file.
desktop-file-name-suffix (string)This string will be suffixed to the Name key in the main application desktop file.
- Build options specify the build environment of a module, and can be specified globally as - well as per-module. Options can also be specified on a per-architecture basis using the arch property. -
- These are the properties that are accepted: -
cflags (string)This is set in the environment variable CFLAGS during the build.
cxxflags (string)This is set in the environment variable CXXFLAGS during the build.
prefix (string)The build prefix for the modules (defaults to /app for
- applications and /usr for runtimes).
env (object)This is a dictionary defining environment variables to be set during the build.
build-args (array of strings)This is an array containing extra options to pass to flatpak build.
strip (boolean)If this is true (the default is false) then all ELF files will be stripped after install.
no-debuginfo (boolean)By default (if strip is not true) flatpak-builder extracts all debug info in ELF files to a separate files - and puts this in an extension. If you want to disable this, set no-debuginfo to true.
arch (object)This is a dictionary defining for each arch a separate build options object that override the main one.
- Each module specifies a source that has to be separately built and installed. It contains - the build options and a list of sources to download and extract before building. -
- Modules can be nested, in order to turn related modules on and off with a single key. -
- These are the properties that are accepted: -
name (string)The name of the module, used in e.g. build logs. The name is also used for constructing filenames and commandline arguments, therefore using spaces or '/' in this string is a bad idea.
disabled (boolean)If true, skip this module
sources (array of objects)An array of objects defining sources that will be downloaded and extracted in order
config-opts (array of strings)An array of options that will be passed to configure
make-args (array of strings)An array of arguments that will be passed to make
make-install-args (array of strings)An array of arguments that will be passed to make install
rm-configure (boolean)If true, remove the configure script before starting build
no-autogen (boolean)Ignore the existence of an autogen script
no-parallel-make (boolean)Don't call make with arguments to build in parallel
no-python-timestamp-fix (boolean)Don't fix up the *.py[oc] header timestamps for ostree use.
cmake (boolean)Use cmake instead of configure
builddir (boolean)Use a build directory that is separate from the source directory
subdir (string)Build inside this subdirectory of the extracted sources
build-options (object)A build options object that can override global options
post-install (array of strings)An array of shell commands that are run after the install phase. Can for example - clean up the install dir, or install extra files. -
cleanup (array of strings)An array of file patterns that should be removed at the end. - Patterns starting with / are taken to be full pathnames (without the /app prefix), otherwise they just match - the basename. Note that any patterns will only match files installed by this module. -
cleanup-platform (array of strings)Extra files to clean up in the platform.
modules (array of objects or strings)An array of objects specifying nested modules to be built before this one. - String members in the array are interpreted as names of a separate json file that contains a module.
- These contain a pointer to the source that will be extracted into the source directory before - the build starts. They can be of several types, distinguished by the type property. -
type"archive"
path (string)The path of the archive
url (string)The URL of a remote archive that will be downloaded. This overrides path if both are specified.
sha256 (string)The sha256 checksum of the file, verified after download
strip-components (integer)The number of initial pathname components to strip during extraction. Defaults to 1.
dest (string)Directory inside the source dir where the archive will be extracted.
type"git"
path (string)The path to a local checkout of the git repository. Due to how git-clone works, this will be much faster than specifying a URL of file:///...
url (string)URL of the git repository. This overrides path if both are specified.
branch (string)The branch/tag/commit to use from the git repository
dest (string)Directory inside the source dir where the repository will be checked out.
type"bzr"
url (string)URL of the bzr repository
revision (string)A specific revision to use in the branch
dest (string)Directory inside the source dir where the repository will be checked out.
type"file"
path (string)The path of a local file that will be copied into the source dir
url (string)The URL of a remote file that will be downloaded and copied into the source dir. This overrides path if both are specified.
sha256 (string)The sha256 checksum of the file, verified after download. This is optional for local files.
dest-filename (string)Filename to use inside the source dir, default to the basename of path.
dest (string)Directory inside the source dir where the file will be copied.
- This is a way to create a shell (/bin/sh) script from an inline set of commands. -
type"script"
commands (array of strings)An array of shell commands that will be put in a shellscript file
dest-filename (string)Filename to use inside the source dir, default to the basename of path.
dest (string)Directory inside the source dir where the file will be copied.
- This is a way to create/modify the sources by running shell commands. -
type"shell"
commands (array of strings)An array of shell commands that will be run during source extraction
type"patch"
path (string)The path of a patch file that will be applied in the source dir
strip-components (integer)The value of the -p argument to patch, defaults to 1.
dest (string)Directory inside the source dir where the patch will be applied.
use-git (boolean)Whether to use "git apply" rather than "patch" to apply the patch, required when the patch file contains binary diffs.
The following options are understood:
-h, --help+ This command requires extra privileges, so must be run as root or via e.g. sudo. +
flatpak-info — Show information about installed application and/or runtime
flatpak info [OPTION...] NAME [BRANCH]
+ Show info about and installed application and/or runtime. +
+ By default, the output is formatted in a friendly format. + If you specify one of the options --show-ref, --show-commit, + --show-origin, --show-metadata or --show-size, the output is instead formatted + in a machine-readable format. +
+ By default, both per-user and system-wide installations + are queried. Use the --user, --system or --installation + options to change this. +
The following options are understood:
-h, --help+ Show help options and exit. +
--user+ Query per-user installations. +
--system+ Query the default system-wide installation. +
--installation=NAME
+ Query a system-wide installation by NAME among
+ those defined in /etc/flatpak/installations.d/.
+ Using --installation=default is equivalent to using
+ --system .
+
--arch=ARCH+ Query for this architecture. +
-r, --show-ref+ Show the installed ref. +
-o, --show-origin+ Show the remote the ref is installed from. +
-c, --show-commit+ Show the installed commit id. +
-s, --show-size+ Show the installed size. +
-m, --show-metadata+ Show the metadata. +
-e, --show-extensions+ Show the matching extensions. +
-v, --verbose+ Print debug information during command processing. +
--version+ Print version information and exit. +
flatpak-install — Install an application or runtime
Install from a configured remote:
flatpak install [OPTION...] REMOTE-NAME REF...
Install from a .flatpakref file:
flatpak install [OPTION...] [--from] LOCATION
Install from a .flatpak bundle:
flatpak install [OPTION...] [--bundle] FILENAME
+ 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. +
+ Each REF argument is a full or partial indentifier 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 an error message + will list the alternatives. +
+ 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 --app or + --runtime option, or by supplying the initial element in the REF. +
+ 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 . +
+ The alternative form of the command ([--from] or + [--bundle] allows you to + install directly from a source such as a .flatpak + single-file bundle, a .flatpakref app description. The options are optional if the first + argument have the right extension. +
+ Note that flatpak allows one to have multiple branches of an application and runtimes + installed and used at the same time. However, only version of an application one can be current, + meaning its exported files (for instance desktop files and icons) are + visible to the host. The last installed version is made current by + default, but you can manually change with make-current. +
+ Unless overridden with the --user or the --installation option, this command installs + the application or runtime in the default system-wide installation. +
The following options are understood:
-h, --help+ Show help options and exit. +
--bundle+ Assume LOCATION is a .flatpak single-bundle file. + This is optional if the arguments ends with .flatpak. +
--from+ Assume LOCATION is a .flatpakref file containing the details of the app to be installed. + This is optional if the arguments ends with .flatpakref. +
--user+ Install the application or runtime in a per-user installation. +
--system+ Install the application or runtime in the default system-wide installation. +
--installation=NAME
+ Install the application or runtime in a system-wide installation
+ specified by NAME among those defined in
+ /etc/flatpak/installations.d/. Using
+ --installation=default is equivalent to using
+ --system .
+
--arch=ARCH+ The default architecture to install for, if not given explicitly in the REF . +
--subpath=PATH+ 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., +
--gpg-file=FILE+ Check bundle signatures with GPG key from FILE (- for stdin). +
--no-deploy+ Download the latest version, but don't deploy it. +
--no-pull+ Don't download the latest version, deploy whatever is locally available. +
--no-related+ Don't download related extensions, such as the locale data. +
--no-deps+ Don't verify runtime dependencies when installing. +
--app+ Assume that all REF s are apps if not explicitly specified. +
--runtime+ Assume that all REF s are runtimes if not explicitly specified. +
-y, --assumeyes+ Automatically answer yes to all questions (or pick the most prioritized answer). This is useful for automation. +
-v, --verbose+ Print debug information during command processing. +
--ostree-verbose+ Print OSTree debug information during command processing. +
--version+ Print version information and exit. +
+ $ flatpak install gnome org.gnome.gedit2 +
+ $ flatpak --installation=default install gnome org.gnome.gedit2 +
+ $ flatpak --user install gnome org.gnome.gedit//3.22 +
+ $ flatpak --user install https://sdk.gnome.org/gedit.flatpakref +
+ flatpak(1), + flatpak-update(1), + flatpak-list(1), + flatpak-build-bundle(1), + flatpak-flatpakref(1) +
flatpak-list — List installed applications and/or runtimes
flatpak list [OPTION...]
+ Lists the names of the installed applications and/or runtime. +
+ By default, both per-user and system-wide installations + are shown. Use the --user, --installation or --system + options to change this. +
+ By default this lists both installed apps and runtime, but you can + change this by using the --app or --runtime option. +
The following options are understood:
-h, --help+ Show help options and exit. +
--user+ List per-user installations. +
--system+ List the default system-wide installations. +
--installation=NAME
+ List a system-wide installation specified by NAME
+ among those defined in /etc/flatpak/installations.d/.
+ Using --installation=default is equivalent to using
+ --system .
+
--arch=ARCH+ List installations for this architecture. +
-d, --show-details+ Show origin, sizes and other extra information. +
--app+ List applications. +
--runtime+ List runtimes. +
--all, -a+ List all installed runtimes, including locale and debug extensions. These are hidden by default. +
-v, --verbose+ Print debug information during command processing. +
--ostree-verbose+ Print OSTree debug information during command processing. +
--version+ Print version information and exit. +
flatpak-make-current — Make a specific version of an app current
flatpak make-current [OPTION...] APP BRANCH
+ 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. +
+ When a new branch is installed it will automatically be made current, so this + command is often not needed. +
+ Unless overridden with the --user or --installation options, this command + changes the default system-wide installation. +
The following options are understood:
-h, --help+ Show help options and exit. +
--user+ Update a per-user installation. +
--system+ Update the default system-wide installation. +
--installation=NAME
+ Updates a system-wide installation specified by NAME
+ among those defined in /etc/flatpak/installations.d/.
+ Using --installation=default is equivalent to using
+ --system .
+
--arch=ARCH+ The architecture to install for. +
-v, --verbose+ Print debug information during command processing. +
--version+ Print version information and exit. +
flatpak-override — Override application requirements
flatpak override [OPTION...] [APP]
+ Overrides the application specified runtime requirements. This can be used + to grant a sandboxed application more or less resources than it requested. +
+ By default the application gets access to the resources it + requested when it is started. But the user can override it + on a particular instance by specifying extra arguments to + flatpak run, or every time by using flatpak override. +
+ If the application id is not specified then the overrides affect all applications, + but the per-application overrides can override the global overrides. +
+ Unless overridden with the --user or --installation options, this command + changes the default system-wide installation. +
The following options are understood:
-h, --help+ Show help options and exit. +
--user+ Update a per-user installation. +
--system+ Update the default system-wide installation. +
--installation=NAME
+ Updates a system-wide installation specified by NAME
+ among those defined in /etc/flatpak/installations.d/.
+ Using --installation=default is equivalent to using
+ --system .
+
--share=SUBSYSTEM+ 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. +
--unshare=SUBSYSTEM+ 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. +
--socket=SOCKET+ 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. + This option can be used multiple times. +
--nosocket=SOCKET+ 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. + This option can be used multiple times. +
--device=DEVICE+ Expose a device to the application. This overrides to + the Context section from the application metadata. + DEVICE must be one of: dri, kvm, all. + This option can be used multiple times. +
--nodevice=DEVICE+ 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, all. + This option can be used multiple times. +
--allow=FEATURE+ Allow access to a specific feature. This updates + the [Context] group in the metadata. + FEATURE must be one of: devel, multiarch. + This option can be used multiple times. +
+ The devel feature allows the application to
+ access certain syscalls such as ptrace(), and
+ perf_event_open().
+
+ The multiarch feature allows the application to
+ execute programs compiled for an ABI other than the one supported
+ natively by the system. For example, for the x86_64
+ architecture, 32-bit x86 binaries will be allowed as
+ well.
+
--disallow=FEATURE+ Disallow access to a specific feature. This updates + the [Context] group in the metadata. + FEATURE must be one of: devel, multiarch. + This option can be used multiple times. +
--filesystem=FS+ Allow the application access to a subset of the filesystem. + This overrides to the Context section from the application metadata. + FS can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, + 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. +
--nofilesystem=FILESYSTEM+ Remove access to the specified subset of the filesystem from + the application. This overrides to the Context section from the + application metadata. + FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, + an absolute path, or a homedir-relative path like ~/dir. + This option can be used multiple times. +
--add-policy=SUBSYSTEM.KEY=VALUE+ Add generic policy option. For example, "--add-policy=subsystem.key=v1 --add-policy=subsystem.key=v2" would map to this metadata: +
+[Policy subsystem] +key=v1;v2; +
+
+ This option can be used multiple times. +
--remove-policy=SUBSYSTEM.KEY=VALUE+ Remove generic policy option. This option can be used multiple times. +
--env=VAR=VALUE+ Set an environment variable in the application. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +
--own-name=NAME+ 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. +
--talk-name=NAME+ 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. +
--system-own-name=NAME+ 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. +
--system-talk-name=NAME+ 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. +
--persist=FILENAME+ 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. +
-v, --verbose+ Print debug information during command processing. +
--version+ Print version information and exit. +
flatpak-remote-add — Add a remote repository
Add from a .flatpakrepo file:
flatpak remote-add [OPTION...] [--from] NAME LOCATION
Manually specify repo uri and options:
flatpak remote-add [OPTION...] NAME LOCATION
+ 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 + .flatpakrepo 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. +
+ Unless overridden with the --user or --installation options, this command + changes the default system-wide installation. +
The following options are understood:
-h, --help+ Show help options and exit. +
--from+ 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. +
--user+ Modify the per-user configuration. +
--system+ Modify the default system-wide configuration. +
--installation=NAME
+ Modify a system-wide installation specified by NAME
+ among those defined in /etc/flatpak/installations.d/.
+ Using --installation=default is equivalent to using
+ --system .
+
--no-gpg-verify+ Disable GPG verification for the added remote. +
--prio=PRIO+ Set the priority for the remote. Default is 1, higher is more prioritized. This is + mainly used for graphical installation tools. +
--no-enumerate+ Mark the remote as not enumerated. This means the remote will + not be used to list applications, for instance in graphical + installation tools. +
--no-use-for-deps+ Mark the remote as not to be used for automatic runtime + dependency resolution. +
--if-not-exists+ Do nothing if the provided remote already exists. +
--disable+ Disable the added remote. +
--title=TITLE+ A title for the remote, e.g. for display in a UI. +
--default-branch=BRANCH+ A default branch for the remote, mainly for use in a UI. +
--gpg-import=FILE+ 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. +
--oci+ This is a OCI format registry rather than a regular + flatpak repository. +
-v, --verbose+ Print debug information during command processing. +
--ostree-verbose+ Print OSTree debug information during command processing. +
--version+ Print version information and exit. +
+ $ flatpak remote-add gnome https://sdk.gnome.org/gnome.flatpakrepo +
+ $ flatpak --user remote-add --no-gpg-verify test-repo https://people.gnome.org/~alexl/gnome-sdk/repo/ +
+ flatpak(1), + flatpak-remote-modify(1), + flatpak-remote-delete(1), + flatpak-remotes(1), + flatpak-flatpakrepo(1) +
flatpak-remote-delete — Delete a remote repository
flatpak remote-delete [OPTION...] NAME
+ Removes a remote repository from the flatpak repository configuration. + NAME is the name of an existing remote. +
+ Unless overridden with the --system, --user, or --installation options, + this command uses either the default system-wide installation or the + per-user one, depending on which has the specified + REMOTE . +
The following options are understood:
-h, --help+ Show help options and exit. +
--user+ Modify the per-user configuration. +
--system+ Modify the default system-wide configuration. +
--installation=NAME
+ Modify a system-wide installation specified by NAME
+ among those defined in /etc/flatpak/installations.d/.
+ Using --installation=default is equivalent to using
+ --system .
+
--force+ Remove remote even if its in use by installed apps or runtimes. +
-v, --verbose+ Print debug information during command processing. +
--ostree-verbose+ Print OSTree debug information during command processing. +
--version+ Print version information and exit. +
flatpak-remote-info — Show information about an application or runtime in a remote
flatpak remote-info [OPTION...] REMOTE REF
+ 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. +
+ By default, the output is formatted in a friendly format. + If you specify one of the options --show-ref, --show-commit, + --show-parent, or --show-metadata, the output is instead formatted + in a machine-readable format. +
+ Unless overridden with the --system, --user, or --installation options, + this command uses either the default system-wide installation or the + per-user one, depending on which has the specified + REMOTE . +
The following options are understood:
-h, --help+ Show help options and exit. +
--user+ Use the per-user configuration. +
--system+ Use the default system-wide configuration. +
--installation=NAME
+ Use a system-wide installation specified by NAME
+ among those defined in /etc/flatpak/installations.d/.
+ Using --installation=default is equivalent to using
+ --system .
+
--runtime+ Assume that REF is a runtime if not explicitly specified. +
--app+ Assume that REF is an app if not explicitly specified. +
--arch=ARCH+ The default architecture to look for, if not given explicitly in the REF . +
--commit=COMMIT+ Show information about the specific commit, rather than the latest version. +
--log+ Display a log of previous versions. +
-r, --show-ref+ Show the matched ref. +
-c, --show-commit+ Show the commit id. +
-p, --show-parent+ Show the parent commit id. +
-m, --show-metadata+ Show the metadata. +
-v, --verbose+ Print debug information during command processing. +
--ostree-verbose+ Print OSTree debug information during command processing. +
+ $ flatpak --user remote-info flathub org.gnome.gedit +
+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 +
flatpak-remote-ls — Show available runtimes and applications
flatpak remote-ls [OPTION...] [REMOTE]
+ 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 flatpak-remotes(1). +
+ Unless overridden with the --system, --user, or --installation options, + this command uses either the default system-wide installation or the + per-user one, depending on which has the specified + REMOTE . +
The following options are understood:
-h, --help+ Show help options and exit. +
--user+ Use the per-user configuration. +
--system+ Use the default system-wide configuration. +
--installation=NAME
+ Use a system-wide installation specified by NAME
+ among those defined in /etc/flatpak/installations.d/.
+ Using --installation=default is equivalent to using
+ --system .
+
-d, --show-details+ Show arches, branches and commit ids, in addition to the names. +
--runtime+ Show only runtimes, omit applications. +
--app+ Show only applications, omit runtimes. +
--all, -aShow everything. By default locale and + debug extensions as well as secondary arches when the primary + arch in available are hidden. +
--updates+ Show only those which have updates available. +
--arch=ARCH+ Show only those matching the specied architecture. By default, only + supported architectures are shown. Use --arch=* to show all archtectures. +
-v, --verbose+ Print debug information during command processing. +
--ostree-verbose+ Print OSTree debug information during command processing. +
--version+ Print version information and exit. +
flatpak-remote-modify — Modify a remote repository
flatpak remote-modify [OPTION...] NAME
+ Modifies options for an existing remote repository in the flatpak repository configuration. + NAME is the name for the remote. +
+ Unless overridden with the --system, --user, or --installation options, + this command uses either the default system-wide installation or the + per-user one, depending on which has the specified + REMOTE . +
The following options are understood:
-h, --help+ Show help options and exit. +
--user+ Modify the per-user configuration. +
--system+ Modify the default system-wide configuration. +
--installation=NAME
+ Modify a system-wide installation specified by NAME
+ among those defined in /etc/flatpak/installations.d/.
+ Using --installation=default is equivalent to using
+ --system .
+
--no-gpg-verify+ Disable GPG verification for the added remote. +
--gpg-verify+ Enable GPG verification for the added remote. +
--prio=PRIO+ Set the priority for the remote. Default is 1, higher is more prioritized. This is + mainly used for graphical installation tools. +
--no-enumerate+ Mark the remote as not enumerated. This means the remote will + not be used to list applications, for instance in graphical + installation tools. +
--no-use-for-deps+ Mark the remote as not to be used for automatic runtime + dependency resolution. +
--disable+ Disable the remote. Disabled remotes will not be automatically updated from. +
--enable+ Enable the remote. +
--enumerate+ Mark the remote as enumerated. This means the remote will + be used to list applications, for instance in graphical + installation tools. +
--use-for-deps+ Mark the remote as to be used for automatic runtime + dependency resolution. +
--title=TITLE+ A title for the remote, e.g. for display in a UI. +
--default-branch=BRANCH+ A default branch to for the remote, mainly for use in a UI. +
--url=URL+ Set a new URL. +
--update-metadata+ A default branch to for the remote, mainly for use in a UI. +
+ 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. +
--gpg-import=FILE+ 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. +
-v, --verbose+ Print debug information during command processing. +
--ostree-verbose+ Print OSTree debug information during command processing. +
--version+ Print version information and exit. +
flatpak-remotes — List remote repositories
flatpak remotes [OPTION...]
+ Lists the known remote repositories, in priority order. +
+ By default, both per-user and system-wide installations + are shown. Use the --user, --system or --installation + options to change this. +
The following options are understood:
-h, --help+ Show help options and exit. +
--user+ Show the per-user configuration. +
--system+ Show the default system-wide configuration. +
--installation=NAME
+ Show a system-wide installation by NAME among
+ those defined in /etc/flatpak/installations.d/.
+ Using --installation=default is equivalent to using
+ --system .
+
-d, --show-details+ Show more information for each repository in addition to the name. +
--show-disabled+ Show disabled repos. +
-v, --verbose+ Print debug information during command processing. +
--ostree-verbose+ Print OSTree debug information during command processing. +
--version+ Print version information and exit. +
flatpak-repo — Show information about a local repository
flatpak repo [OPTION...] LOCATION
flatpak-run — Run an application or open a shell in a runtime
flatpak run [OPTION...] REF [ARG...]
+ If REF names an installed application, + flatpak runs the application in a sandboxed environment. Extra + arguments are passed on to the application. +
+ If REF names a runtime, a shell is opened in the + runtime. This is useful for development and testing. +
+ flatpak creates a sandboxed environment for the application to run in
+ by mounting the right runtime at /usr and a writable
+ directory at /var, whose content is preserved between
+ application runs. The application itself is mounted at /app.
+
+ The details of the sandboxed environment are controlled by the application + metadata and various options like --share and --socket that are passed to the run + command: Access is allowed if it was requested either in the application + metadata file or with an option and the user hasn't overridden it. +
+ The remaining arguments are passed to the command that gets run in the sandboxed
+ environment. See the --file-forwarding for handling of file arguments.
+
The following options are understood:
-h, --helpShow help options and exit.
-v, --verbosePrint debug information during command processing.
--versionPrint version information and exit.
--arch=ARCH- Specify the machine architecture to build for. If no architecture is specified, the host architecture will be automatically detected. Only host compatible architectures can be specified. -
--disable-cache- Don't look at the existing cache for a previous build, instead always rebuild modules. -
--disable-download- Don't download any sources. This only works if some version of all sources are downloaded - already. This is useful if you want to guarantee that no network i/o is done. However, the - build will fail if some source is not locally available. -
--disable-updates- Download missing sources, but don't update local mirrors of version control repos. This is useful - to rebuild things but without updating git or bzr repositories from the remote repository. -
--run- Run a command in a sandbox based on the build dir. This starts flatpak build, with some extra - arguments to give the same environment as the build, and the same permissions the final app - will have. The command to run must be the last argument passed to - flatpak-builder, after the directory and the manifest. -
--show-deps- List all the (local) files that the manifest depends on. -
--download-only- Exit successfully after downloading the required sources. -
--build-only- Don't do the cleanup and finish stages, which is useful if you - want to build more things into the app. -
--finish-only- Only do the cleanup, finish and export stages, picking up - where a --build-only command left off. -
--require-changes- Do nothing, leaving a non-existent DIRECTORY if nothing changes since - last cached build. If this is not specified, the latest version from the cache will be put - into DIRECTORY . -
--keep-build-dirs- Don't remove the sources and build after having built and installed each module. - This also creates a symlink to the build directory with a stable name ("build-modulename"). -
--ccache- Enable use of ccache in the build (needs ccache in the sdk) -
--stop-at=MODULENAME- Stop building at the specified module, ignoring all the following ones. - This is useful for debugging and development. For instance, you can - build all the dependencies, but stop at the main application so that - you can then do a build from a pre-existing checkout. - Implies --build-only. -
--repo=DIR- When build is done, run export the result to this repository. -
-s, --subject=SUBJECT- One line subject for the commit message. - Used when exporting the build results. -
-b, --body=BODY- Full description for the commit message. - Used when exporting the build results. -
--gpg-sign=KEYID- Sign the commit with this GPG key. - Used when exporting the build results. + The architecture to install for. +
--command=COMMAND+ The command to run instead of the one listed in the application metadata. +
--branch=BRANCH+ The branch to use. +
-d, --devel+ 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. +
--runtime=RUNTIME+ 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. +
--runtime-version=VERSION+ 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. +
--share=SUBSYSTEM+ 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. -
--gpg-homedir=PATH- GPG Homedir to use when looking for keyrings. - Used when exporting the build results. -
--force-clean- Erase the previous contents of DIRECTORY if it is - not empty. -
--sandbox- Disable the possibility to specify build-args that - are passed to flatpak build. This means the build - process can't break out of its sandbox, and is - useful when building less trusted software. -
--allow-missing-runtimes- Do not immediately fail if the sdk or platform runtimes - are not installed on this system. Attempting to build any - manifest modules will still fail if the sdk is missing, but - may be useful for apps that install files without a sandbox - build. -
- flatpak-builder caches sources and partial build results in
- the .flatpak-builder subdirectory of the current directory. If you
- use --keep-build-dirs, build directories for each
- module are also stored here.
+
--unshare=SUBSYSTEM+ 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. +
--socket=SOCKET+ 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. + This option can be used multiple times. +
--nosocket=SOCKET+ 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. + This option can be used multiple times. +
--device=DEVICE+ Expose a device to the application. This overrides to + the Context section from the application metadata. + DEVICE must be one of: dri, kvm, all. + This option can be used multiple times. +
--nodevice=DEVICE+ 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, all. + This option can be used multiple times. +
--allow=FEATURE+ Allow access to a specific feature. This overrides to + the Context section from the application metadata. + FEATURE must be one of: devel, multiarch. + This option can be used multiple times. +
--disallow=FEATURE+ Disallow access to a specific feature. This overrides to + the Context section from the application metadata. + FEATURE must be one of: devel, multiarch. + This option can be used multiple times. +
--filesystem=FS+ Allow the application access to a subset of the filesystem. + This overrides to the Context section from the application metadata. + FS can be one of: home, host, xdg-desktop, xdg-documents, xdg-download, + xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, + xdg-run, 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. +
--nofilesystem=FILESYSTEM+ Remove access to the specified subset of the filesystem from + the application. This overrides to the Context section from the + application metadata. + FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, + an absolute path, or a homedir-relative path like ~/dir. + This option can be used multiple times. +
--add-policy=SUBSYSTEM.KEY=VALUE+ Add generic policy option. For example, "--add-policy=subsystem.key=v1 --add-policy=subsystem.key=v2" would map to this metadata: +
+[Policy subsystem] +key=v1;v2; +
+
+ This option can be used multiple times. +
--remove-policy=SUBSYSTEM.KEY=VALUE+ Remove generic policy option. This option can be used multiple times. +
--env=VAR=VALUE+ Set an environment variable in the application. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +
--own-name=NAME+ 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. +
--talk-name=NAME+ 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. +
--system-own-name=NAME+ 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. +
--system-talk-name=NAME+ 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. +
--persist=FILENAME+ 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. +
--log-session-bus+ Log session bus traffic. This can be useful to see what access you need to allow in + your D-Bus policy. +
--log-system-bus+ Log system bus traffic. This can be useful to see what access you need to allow in + your D-Bus policy. +
--file-forwarding+ 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. +
+ $ flatpak run org.gnome.GEdit
- It is safe to remove the contents of the .flatpak-builder - directory. This will force a full build the next time you build. -
- $ flatpak-builder my-app-dir manifest.json + $ flatpak run --devel --command=bash org.gnome.Builder
- Example manifest file: -
-{
- "id": "org.test.TestApp",
- "runtime": "org.freedesktop.Platform",
- "runtime-version": "1.2",
- "sdk": "org.freedesktop.Sdk",
- "command": "test",
- "clean": [ "/include", "*.la" ],
- "build-options" : {
- "cflags": "-O2 -g",
- "cxxflags": "-O2 -g",
- "env": {
- "V": "1"
- },
- "arch": {
- "x86_64": {
- "cflags": "-O3 -g",
- }
- }
- },
- "modules": [
- {
- "name": "pygobject",
- "config-opts": [ "--disable-introspection" ],
- "sources": [
- {
- "type": "archive",
- "url": "http://ftp.gnome.org/pub/GNOME/sources/pygobject/2.28/pygobject-2.28.6.tar.xz",
- "sha256": "fb8a1d4f665130a125011659bd347c7339c944232163dbb9a34fd0686577adb8"
- },
- {
- "type": "patch",
- "path": "required-pygobject-fix.patch"
- },
- {
- "type": "file",
- "path": "pygobject-extra-file",
- "dest-filename": "extra-file"
- }
- ]
- },
- {
- "name": "babl",
- "build-options" : { "cxxflags": "-O2 -g -std=c++11" },
- "cleanup": [ "/bin" ],
- "sources": [
- {
- "type": "git",
- "url": "git://git.gnome.org/babl"
- }
- ]
- },
- {
- "name": "testapp",
- "sources": [
- {
- "type": "bzr",
- "url": "lp:testapp"
- }
- ]
- }
- ]
-}
-flatpak-search — Search for applications and runtimes
flatpak search TEXT
+ Searches for applications and runtimes matching + TEXT . Note that this uses appstream data + that can be updated with flatpak-update(1). + The appstream data is updated automatically only if it's at least a day old. +
The following options are understood:
--user+ Only search through remotes in the per-user installation. +
--system+ Only search through remotes in the default system-wide installation. +
--installation=NAME
+ Show a system-wide installation by NAME among
+ those defined in /etc/flatpak/installations.d/.
+ Using --installation=default is equivalent to using
+ --system .
+
-h, --help+ Show help options and exit. +
-v, --verbose+ Print debug information during command processing. +
flatpak-uninstall — Uninstall an application or runtime
flatpak uninstall [OPTION...] [REF...]
+ Uninstalls an application or runtime. REF is a reference to the + application or runtime to uninstall. +
+ Each REF arguments is a full or partial indentifier 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. +
+ By default this looks for both installed apps and runtime + with the given NAME , but you can + limit this by using the --app or --runtime option. +
+ Normally, this command removes the ref for this application/runtime from the + local OSTree repository and purges and objects that are no longer + needed to free up disk space. If the same application is later + reinstalled, the objects will be pulled from the remote repository + again. The --keep-ref option can be used to prevent this. +
+ If all branches of the application/runtime are removed, this command + also purges the data directory for the application. +
+ Unless overridden with the --user or the --installation option, this command updates + the default system-wide installation. +
The following options are understood:
-h, --help+ Show help options and exit. +
--keep-ref+ Keep the ref for the application and the objects belonging to it + in the local repository. +
--user+ Updates a per-user installation. +
--system+ Updates the default system-wide installation. +
--installation=NAME
+ Updates a system-wide installation specified by NAME
+ among those defined in /etc/flatpak/installations.d/.
+ Using --installation=default is equivalent to using
+ --system .
+
--arch=ARCH+ The architecture to uninstall, instead of the architecture of + the host system. +
--app+ Only look for an app with the given name. +
--runtime+ Only look for a runtime with the given name. +
--no-related+ Don't uninstall related extensions, such as the locale data. +
--force-remove+ Remove files even if they're in use by a running application. +
-v, --verbose+ Print debug information during command processing. +
--ostree-verbose+ Print OSTree debug information during command processing. +
--version+ Print version information and exit. +
flatpak-update — Update an application or runtime
flatpak update [OPTION...] [REF...]
flatpak update [OPTION...] --appstream [REMOTE]
+ 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. +
+ Each REF arguments is a full or partial indentifier 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. +
+ By default this looks for both apps and runtimes with the given REF , + but you can limit this by using the --app or --runtime option, or by supplying the initial + element in the REF. +
+ Normally, this command updates the application to the tip + of its branch. But it is possible to check out another commit, + with the --commit option. +
+ 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 --commit option. +
+ Unless overridden with the --user, --system or --installation option, this command updates + any matching refs in the standard system-wide installation and the per-user one. +
The following options are understood:
-h, --help+ Show help options and exit. +
--user+ Update a per-user installation. +
--system+ Update the default system-wide installation. +
--installation=NAME
+ Updates a system-wide installation specified by NAME
+ among those defined in /etc/flatpak/installations.d/.
+ Using --installation=default is equivalent to using
+ --system .
+
--arch=ARCH+ The architecture to update for. +
--subpath=PATH+ 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. +
--commit=COMMIT+ Update to this commit, instead of the tip of the branch. +
--no-deploy+ Download the latest version, but don't deploy it. +
--no-pull+ Don't download the latest version, deploy whatever is locally available. +
--no-related+ Don't download related extensions, such as the locale data. +
--no-deps+ Don't update or install runtime dependencies when installing. +
--app+ Only look for an app with the given name. +
--appstream+ Update appstream for REMOTE , or all remotes if no remote is specified. +
--runtime+ Only look for a runtime with the given name. +
-y, --assumeyes+ Automatically answer yes to all questions (or pick the most prioritized answer). This is useful for automation. +
--force-remove+ Remove old files even if they're in use by a running application. +
-v, --verbose+ Print debug information during command processing. +
--ostree-verbose+ Print OSTree debug information during command processing. +
--version+ Print version information and exit. +
Table of Contents
flatpak-flatpakrepo — Reference to a remote
+ Flatpak uses flatpakrepo files to share information about remotes.
+ The flatpakrepo file contains enough information
+ to add the remote. Use the flatpak remote-add --from
+ command to do so.
+
+ flatpakrepo files may also contain additional information that is useful + when displaying a remote to the user, e.g. in an app store. +
+ The filename extension commonly used for flatpakrepo files is .flatpakrepo.
+
+ The flatpakrepo file is using the same .ini file format that is used for + systemd unit files or application .desktop files. +
+ All the information is contained in the [Flatpak Repo] group. +
+ The following keys can be present in this group: +
Version (uint64)The version of the file format, must be 1 if present.
Url (string)The url for the remote. This key is mandatory.
GPGKey (string)The base64-encoded gpg key for the remote.
DefaultBranch (string)The default branch to use for this remote.
Title (string)The title of the remote. This should be a user-friendly name that can be displayed e.g. in an app store.
Comment (string)A short summary of the remote, for display e.g. in an app store.
Description (string)A longer description of the remote, for display e.g. in an app store..
Icon (string)The url for an icon that can be used to represent the remote.
Homepage (string)The url of a webpage describing the remote.
+[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= + +
flatpak-flatpakref — Reference to a remote for an application or runtime
+ Flatpak uses flatpakref files to share information about a remote for
+ a single application. The flatpakref file contains
+ enough information to add the remote and install the application.
+ Use the flatpak install --from command to do so.
+
+ flatpakref files may also contain additional information that is useful + when displaying the application to the user, e.g. in an app store. +
+ The filename extension commonly used for flatpakref files is .flatpakref.
+
+ A flatpakref file can also refer to a remote for a runtime. +
+ The flatpakref file is using the same .ini file format that is used for + systemd unit files or application .desktop files. +
+ All the information is contained in the [Flatpak Ref] group. +
+ The following keys can be present in this group: +
Version (uint64)The version of the file format, must be 1 if present.
Name (string)The fully qualified name of the runtime that is used by the application. This key is mandatory.
Url (string)The url for the remote. This key is mandatory.
Branch (string)The name of the branch from which to install the application or runtime. If this key is not specified, the "master" branch is used.
Title (string)The title of the application or runtime. This should be a user-friendly name that can be displayed e.g. in an app store.
Comment (string)A short summary of the application or runtime, for display e.g. in an app store.
Description (string)A longer description of the application or runtime, for display e.g. in an app store..
Icon (string)The url for an icon that can be used to represent the application or runtime.
Homepage (string)The url of a webpage describing the application or runtime.
IsRuntime (boolean)Whether this file refers to a runtime. If this key is not specified, the file is assumed to refer to an application.
GPGKey (string)The base64-encoded gpg key for the remote.
RuntimeRepo (string)The url for a .flatpakref file for the runtime.
+[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= +
flatpak-installation — Configuration for an installation location
+ flatpak can operate in system-wide or per-user mode. The system-wide data
+ is located in $prefix/var/lib/flatpak/, and the per-user data is in
+ $HOME/.local/share/flatpak/.
+
+ In addition to the default installation locations, more system-wide installations
+ can be defined via configuration files /etc/flatpak/installations.d/,
+ which must have the .conf extension and follow the format described below.
+
+ The installation config file format is using the same .ini file format that is used + for systemd unit files or application .desktop files. +
+ All the configuration for the the installation location with name NAME is contained + in the [Installation "NAME"] group. +
+ The following keys are recognized: +
Path (string)The path for this installation. This key is mandatory.
DisplayName (string)The name to use when showing this installation in the UI.
Priority (integer)A priority for this installation.
StorageType (string)The type of storage used for this installation. Possible values include: network, mmc, sdcard, harddisk.
flatpak-metadata — Information about an application or runtime
Flatpak uses metadata files to describe applications and runtimes.
The metadata file for a deployed application or
runtime is placed in the toplevel deploy directory. For example, the
@@ -1596,16 +2093,33 @@ Content Bytes Written: 305
run command, or permanently with the flatpak override command.
A metadata file describing the effective configuration is available
- inside the running sandbox at /run/user/$UID/flatpak-info.
-
+ inside the running sandbox at /.flatpak-info.
+ For compatibility with older Flatpak versions,
+ /run/user/$UID/flatpak-info is a symbolic
+ link to the same file.
+
The metadata file is using the same .ini file format that is used for systemd unit files or application .desktop files. -
+
Metadata for applications starts with an [Application] group, metadata for runtimes with a [Runtime] group.
The following keys can be present in these groups: -
name (string)The name of the application or runtime. This key is mandatory.
runtime (string)The fully qualified name of the runtime that is used by the application. This key is mandatory for applications.
sdk (string)The fully qualified name of the sdk that matches the runtime.
command (string)The command to run. Only relevant for applications.
+
name (string)The name of the application or runtime. This key is mandatory.
runtime (string)The fully qualified name of the runtime that is used by the application. This key is mandatory for applications.
sdk (string)+ The fully qualified name of the sdk that matches the + runtime. Available since 0.1.
command (string)+ The command to run. Only relevant for applications. + Available since 0.1. +
required-flatpak (string)+ 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. +
tags (string list)+ Tags to include in AppStream XML. + Available since 0.4.12. + +
This group determines various system resources that may be shared with the application when it is run in a flatpak sandbox.
@@ -1613,28 +2127,143 @@ Content Bytes Written: 305
shared (list)List of subsystems to share with the host system. Possible subsystems: network, ipc. + Available since 0.3.
sockets (list)List of well-known sockets to make available in the sandbox. - Possible sockets: x11, wayland, pulseaudio, session-bus, system-bus. + Possible sockets: x11, wayland, fallback-x11, pulseaudio, session-bus, system-bus. When making a socket available, flatpak also sets well-known environment variables like DISPLAY or DBUS_SYSTEM_BUS_ADDRESS to let the application find sockets that are not in a fixed location. + Available since 0.3.
devices (list)List of devices to make available in the sandbox. - Possible values: dri, kvm, all. + Possible values: +
dri
+ Graphics direct rendering
+ (/dev/dri).
+ Available since 0.3.
+
kvm
+ Virtualization
+ (/dev/kvm).
+ Available since 0.6.12.
+
all
+ All device nodes in /dev.
+ Available since 0.6.6.
+
filesystems (list)List of filesystem subsets to make available to the - application. Possible values: home, host, xdg-desktop, - xdg-documents, xdg-download xdg-music, xdg-pictures, - xdg-public-share, xdg-templates, xdg-videos, xdg-run, - an absolute path, or a homedir-relative path like - ~/dir or paths relative to the xdg dirs, like - xdg-download/subdir. The xdg-* arguments can also - specify a subdirectory, such as xdg-pictures/screenshots. - Each entry can have a suffix of - :ro or :rw to indicate if the path should be shared - read-only or read-write (default is read-write). + application. Possible values: +
home+ The entire home directory. + Available since 0.3. +
host
+ The entire host file system, except for
+ directories that are handled specially by
+ Flatpak.
+ In particular, this shares
+ /home,
+ /media,
+ /opt,
+ /run/media and
+ /srv if they exist.
+
+ /dev is not shared:
+ use devices=all; instead.
+
+ Parts of /sys are always
+ shared. This option does not make additional
+ files in /sys available.
+
+ These other reserved directories are
+ currently excluded:
+ /app,
+ /bin,
+ /boot,
+ /etc,
+ /lib,
+ /lib32,
+ /lib64,
+ /proc,
+ /root,
+ /run,
+ /sbin,
+ /tmp,
+ /usr,
+ /var.
+
+ Available since 0.3. +
xdg-desktop,
+ xdg-documents,
+ xdg-download,
+ xdg-music,
+ xdg-pictures,
+ xdg-public-share,
+ xdg-videos,
+ xdg-templates
+ + freedesktop.org special directories. + Available since 0.3. +
xdg-desktop/path,
+ xdg-documents/path,
+ etc.
+ + Subdirectories of freedesktop.org special + directories. Available since 0.4.13. +
xdg-cache,
+ xdg-config,
+ xdg-data
+ + Directories defined by the + freedesktop.org Base Directory + Specification. + Available since 0.6.14. +
xdg-cache/path,
+ xdg-config/path,
+ xdg-data/path
+ + Subdirectories of directories defined by the + freedesktop.org Base Directory Specification. + Available since 0.6.14. +
xdg-run/path
+
+ Subdirectories of the
+ XDG_RUNTIME_DIR defined by
+ the
+ freedesktop.org Base Directory
+ Specification. Note that
+ xdg-run on its own is not
+ supported. Available since 0.4.13.
+
/path
+ + An arbitrary absolute path. Available since 0.3. +
~/path
+ + An arbitrary path relative to the home + directory. Available since 0.3. +
:ro
+ + Make the given directory available read-only. +
:rw
+ + Make the given directory available read/write. + This is the default. +
:create
+ + Make the given directory available read/write, + and create it if it does not already exist. +
persistent (list)List of homedir-relative paths to make available at the corresponding path in the per-application home directory, @@ -1643,8 +2272,56 @@ Content Bytes Written: 305 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. -
+ the per-application location. Available since 0.3. +
features (list)+ List of features available or unavailable to the + application, currently from the following list: +
devel+ Allow system calls used by development-oriented + tools such as perf, + strace and + gdb. + Available since 0.6.10. +
multiarch
+ Allow running multilib/multiarch binaries, for
+ example i386 binaries in an
+ x86_64 environment.
+ Available since 0.6.12.
+
+ A feature can be prefixed with ! to
+ indicate the absence of that feature, for example
+ !devel if development and debugging
+ are not allowed.
+
+ This group only appears in /.flatpak-info
+ for a running app, and not in the metadata files written by
+ application authors. It is filled in by Flatpak itself.
+
app-path (string)
+ The absolute path on the host system of the app's
+ app files, as mounted at /app
+ inside the container. Available since 0.6.10.
+
branch (string)
+ The branch of the app, for example
+ stable. Available since
+ 0.6.10.
+
flatpak-version (string)+ The version number of the Flatpak version that ran + this app. Available since 0.6.11. +
runtime-path (string)
+ The absolute path on the host system of the app's
+ runtime files, as mounted at /usr
+ inside the container. Available since 0.6.10.
+
session-bus-proxy (boolean)+ 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. + +
system-bus-proxy (boolean)+ 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. + +
If the sockets key is not allowing full access
to the D-Bus session bus, then flatpak provides filtered access.
@@ -1672,56 +2349,140 @@ Content Bytes Written: 305 access:
noneThe bus name or names in question is invisible to the application. + Available since 0.2.
seeThe bus name or names can be enumerated by the application. + Available since 0.2.
talkThe application can send messages/ and receive replies and signals from the bus name or names. + Available since 0.2.
ownThe application can own the bus name or names (as well as all the above). -
If the sockets 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.
+ and provides a policy for filtered access. Available since 0.2.
Entries in this group have the same form as for the [Session Bus Policy] group. However, the app has no permissions by default. -
The [Environment] group specifies environment variables to set - when running the application. + when running the application. Available since 0.3.
Entries in this group have the form VAR=VALUE
where VAR is the name of an environment variable
to set.
-
- Runtimes and applications can define extensions, which are optional, - additional runtimes to be mounted at a specified location inside - the sandbox when they are present on the system. Typical uses for - extensions include translations for applications, or debuginfo - for sdks. The name of the extension is specified as part of the +
+ 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.
directory (string)
The relative path at which the extension will be mounted in
- the sandbox. If the extension is for an application, the
+ the sandbox. If the extension point is for an application, the
path is relative to /app, otherwise
it is relative to /usr. This key
- is mandatory.
+ is mandatory. Available since 0.1.
version (string)The branch to use when looking for the extension. If this is not specified, it defaults to the branch of the application or - runtime that the extension is for. + runtime that the extension point is for. + Available since 0.4.1. +
versions (string)+ 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. +
add-ld-path (string)+ 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. +
merge-dirs (string)+ 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. +
download-if (string)+ A condition that must be true for the extension to be auto-downloaded. + 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.9.1, and backported to the 0.8.x + branch in 0.8.3. +
enable-if (string)+ A condition that must be true for the extension to be enabled. + 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.9.1, and backported to the 0.8.x + branch in 0.8.3. +
subdirectory-suffix (string)+ 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.
subdirectories (boolean)If this key is set to true, then flatpak will look for - extensions whose name is a prefix of the extension name, and + 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.
no-autodownload (boolean)- Whether to automatically download this extension - when updating or installing a 'related' application - or runtime. + Whether to automatically download extensions matching this extension + point when updating or installing a 'related' application or runtime. + Available since 0.6.7. +
locale-subset (boolean)+ 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)
autodelete (boolean)- Whether to automatically delete this extension - when deleting a 'related' application or runtime. -
+ This optional group may be present if the runtime is an extension. +
ref (string)+ The ref of the runtime or application that this extension + belongs to. Available since 0.9.1. +
priority (integer)+ 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. +
+ 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. +
+ 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. +
NoRuntime (boolean)+ 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. +
uriX (string)
+ The uri for extra data source
+ X. The only supported uri
+ schemes are http and https. Available since 0.6.13.
+
sizeX (integer)
+ The size for extra data source
+ X. Available since 0.6.13.
+
checksumX (string)
+ The sha256 sum for extra data source
+ X. Available since 0.6.13.
+
+ 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. + +
flatpak-flatpakrepo — Reference to a remote
- Flatpak uses flatpakrepo files to share information about remotes.
- The flatpakrepo file contains enough information
- to add the remote. Use the flatpak remote-add --from
- command to do so.
-
- The filename extension commonly used for flatpakrepo files is .flatpakrepo.
-
- The flatpakrepo file is using the same .ini file format that is used for - systemd unit files or application .desktop files. -
flatpak-remote — Configuration for a remote
+ Flatpak stores information about configured remotes for an installation location in
+ $installation/repo/config. For example, the remotes for the
+ default system-wide installation are in
+ $prefix/var/lib/flatpak/repo/config, and the remotes for the
+ per-user installation are in $HOME/.local/share/flatpak/repo/config.
+
+ Normally, it is not necessary to edit remote config files directly, the + flatpak remote-modify command should be used to change properties of remotes. +
+ System-wide remotes can be statically preconfigured by dropping
+ config fragments into /etc/flatpak/remotes.d/.
+
+ The remote config file format is using the same .ini file format that is used for systemd + unit files or application .desktop files. +
+ All the configuration for the the remote with name NAME is contained in the + [remote "NAME"] group.
- The following keys can be present in this group: -
Url (string)The url for the remote. This key is mandatory.
Title (string)The title of the remote. This should be a user-friendly name that can be displayed e.g. in an app store.
GPGKey (string)The base64-encoded gpg key for the remote.
-[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= -
flatpak-flatpakref — Reference to a remote for an application or runtime
- Flatpak uses flatpakref files to share information about a remote for
- a single application. The flatpakref file contains
- enough information to add the remote and install the application.
- Use the flatpak install --from command to do so.
-
- The filename extension commonly used for flatpakref files is .flatpakref.
-
- A flatpakref file can also refer to a remote for a runtime. -
- The flatpakref file is using the same .ini file format that is used for - systemd unit files or application .desktop files. -
- All the information is contained in the [Flatpak Ref] group. -
- The following keys can be present in this group: -
Name (string)The fully qualified name of the runtime that is used by the application. This key is mandatory.
Url (string)The url for the remote. This key is mandatory.
Branch (string)The name of the branch from which to install the application or runtime. If this key is not specified, the "master" branch is used.
Title (string)The title of the application or runtime. This should be a user-friendly name that can be displayed e.g. in an app store.
IsRuntime (boolean)Whether this file refers to a runtime. If this key is not specified, the file is assumed to refer to an application.
GPGKey (string)The base64-encoded gpg key for the remote.
-[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= -
flatpak-make-current — Make a specific version of an app current
flatpak make-current [OPTION...] APP BRANCH
- 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. -
- When a new branch is installed it will automatically be made current, so this - command is often not needed. -
- Unless overridden with the --user option, this command creates a - system-wide installation. -
The following options are understood:
-h, --help- Show help options and exit. -
--user- Create a per-user installation. -
--system- Create a system-wide installation. -
--arch=ARCH- The architecture to install for. -
-v, --verbose- Print debug information during command processing. -
--version- Print version information and exit. -
url (string)The url for the remote.
gpg-verify (boolean)Whether to use GPG verification for content from this remote.
gpg-verify-summary (boolean)Whether to use GPG verification for the summary of this remote.
+ All flatpak-specific keys have a xa. prefix: +
xa.disable (boolean)Whether the remote is disabled. Defaults to false.
xa.prio (integer)The priority for the remote. This is used when listing remotes. Defaults to 1.
xa.noenumerate (boolean)Whether this remote should be used when presenting available contents. Defaults to true.
xa.nodeps (boolean)Whether this remote should be used when searching for dependencies. Defaults to true.
xa.title (string)An optional title to use when presenting this remote in a UI.
xa.title-is-set (boolean)This key is set to true if xa.title has been explicitly set.
xa.default-branch (string)The default branch to use when installing from this remote.
xa.default-branch-is-set (boolean)This key is set to true if xa.default-branch has been explicitly set.
xa.main-ref (string)The main reference served by this remote. This is used for origin remotes of applications installed via a flatpakref file.
xa.oci (boolean)Whether this is an OCI remote. Defaults to false.
+[remote "gnome-nightly-apps"] +gpg-verify=true +gpg-verify-summary=true + +url=https://sdk.gnome.org/nightly/repo-apps/ +xa.title=GNOME Applications +