table of contents
FLATPAK(1) | flatpak | FLATPAK(1) |
NAME¶
flatpak - Build, install and run applications and runtimes
SYNOPSIS¶
flatpak [OPTION...] {COMMAND}
DESCRIPTION¶
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.
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.
System-wide remotes can be statically preconfigured by dropping flatpakrepo files into /etc/flatpak/remotes.d/.
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.
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.
Basic commands for building flatpaks such as build-init, build and build-finish are included in the flatpak utility. For higher-level build support, see the separate flatpak-builder(1) tool.
Flatpak supports installing from sideload repos. These are partial copies of a repository (generated by flatpak create-usb) that are used as installation source when offline (and online as a performance improvement). Such repositories are configured by creating symlinks to the sideload sources in the sideload-repos subdirectory of the installation directory (i.e. typically /var/lib/flatpak/sideload-repos). Additionally symlinks can be created in /run/flatpak/sideload-repos which is a better location for non-persistent sources (as it is cleared on reboot). These symlinks can point to either the directory given to flatpak create-usb which by default writes to the subpath .ostree/repo, or directly to an ostree repo.
OPTIONS¶
The following global options are understood. Individual commands have their own options.
-h, --help
-v, --verbose
--ostree-verbose
--version
--default-arch
--supported-arches
--gl-drivers
--installations
--print-system-only
--print-updated-env
COMMANDS¶
Commands for managing installed applications and runtimes:
Commands for finding applications and runtimes:
Commands for managing running applications:
Commands for managing file access:
Commands for managing the dynamic permission store:
Commands for managing remote repositories:
Commands for building applications:
flatpak-build-import-bundle(1)
Commands available inside the sandbox:
FILE FORMATS¶
File formats that are used by Flatpak commands:
ENVIRONMENT¶
Besides standard environment variables such as XDG_DATA_DIRS and XDG_DATA_HOME, flatpak is consulting some of its own.
FLATPAK_USER_DIR
FLATPAK_SYSTEM_DIR
FLATPAK_SYSTEM_CACHE_DIR
FLATPAK_CONFIG_DIR
FLATPAK_RUN_DIR
SEE ALSO¶
ostree(1), ostree.repo(5), flatpak-remote(5), flatpak-installation(5), https://www.flatpak.org
flatpak |