flatpakflatpakDeveloperAlexanderLarssonalexl@redhat.comflatpak1flatpakBuild, install and run applications and runtimesflatpakOPTIONCOMMANDDescription
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
config fragments 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.
OptionsThe following options are understood:
Show help options and exit.
Print debug information during command processing.
Print OSTree debug information during command processing.
Print version information and exit.
Print the default arch and exit.
Print the supported arches in priority order and exit.
Print the list of active gl drivers and exit.
CommandsCommands for managing installed applications and runtimes:flatpak-install1
Install an application or a runtime from a remote or bundle.
flatpak-update1
Update an installed application or runtime.
flatpak-uninstall1
Uninstall an installed application or runtime.
flatpak-list1
List installed applications and/or runtimes.
flatpak-info1
Show information for an installed application or runtime.
Commands for running applications:flatpak-run1
Run an application.
flatpak-override1
Override permissions for an application.
flatpak-make-current1
Specify the default version to run.
flatpak-enter1
Enter the namespace of a running application.
Commands for managing file access:flatpak-document-export1
Grant an application access to a specific file.
flatpak-document-unexport1
Revoke access to a specific file.
flatpak-document-info1
Show information about a specific file.
flatpak-document-list1
List exported files.
Commands for managing remote repositories:flatpak-remotes1
List all configured remote repositories.
flatpak-remote-add1
Add a new remote repository.
flatpak-remote-modify1
Modify properties of a configured remote repository.
flatpak-remote-delete1
Delete a configured remote repository.
flatpak-remote-ls1
List contents of a configured remote repository.
Commands for building applications:flatpak-build-init1
Initialize a build directory.
flatpak-build1
Run a build command in a build directory.
flatpak-build-finish1
Finalizes a build directory for export.
flatpak-build-export1
Export a build directory to a repository.
flatpak-build-bundle1
Create a bundle file from a build directory.
flatpak-build-import-bundle1
Import a file bundle into a local repository.
flatpak-build-sign1
Sign an application or runtime after its been exported.
flatpak-build-update-repo1
Update the summary file in a repository.
flatpak-build-commit-from1
Create a new commit based on an existing ref.
Environment
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).
See alsoostree1,
ostree.repo5,
flatpak-remote5,