Flatpak Command Reference

Version 0.11.3

+Flatpak Command Reference

Flatpak Command Reference

Version 1.0.0

Important

+ The command reference is generated from the flatpak repo; see https://github.com/flatpak/flatpak/tree/master/doc +

Flatpak comes with a rich commandline interface. -

Table of Contents

Executables

flatpak — Build, install and run applications and runtimes

Commands

flatpak build-bundle — Create a single-file bundle from a local repository
flatpak build-commit-from — Create new commits based on existing one (possibly from another repository)
flatpak build-export — Create a repository from a build directory
flatpak build-finish — Finalize a build directory
flatpak build-import-bundle — Import a file bundle into a local repository
flatpak build-init — Initialize a build directory
flatpak build-sign — Sign an application or runtime
flatpak build-update-repo — Create a repository from a build directory
flatpak build — Build in a directory
flatpak config — Manage configuration
flatpak document-export — Export a file to a sandboxed application
flatpak document-info — Show information about exported files
flatpak document-list — List exported files
flatpak document-unexport — Stop exporting a file
flatpak enter — Enter an application
flatpak info — Show information about installed application and/or runtime
flatpak install — Install an application or runtime
flatpak list — List installed applications and/or runtimes
flatpak make-current — Make a specific version of an app current
flatpak override — Override application requirements
flatpak remote-add — Add a remote repository
flatpak remote-delete — Delete a remote repository
flatpak remote-info — Show information about an application or runtime in a remote
flatpak remote-ls — Show available runtimes and applications
flatpak remote-modify — Modify a remote repository
flatpak remotes — List remote repositories
flatpak repo — Show information about a local repository
flatpak run — Run an application or open a shell in a runtime
flatpak search — Search for applications and runtimes
flatpak uninstall — Uninstall an application or runtime
flatpak update — Update an application or runtime

File Formats

flatpakrepo — Reference to a remote
flatpakref — Reference to a remote for an application or runtime
flatpak installation — Configuration for an installation location
flatpak metadata — Information about an application or runtime
flatpak remote — Configuration for a remote

Executables

Table of Contents

flatpak — Build, install and run applications and runtimes

Name

flatpak — Build, install and run applications and runtimes

Synopsis

flatpak [OPTION...] {COMMAND}

Description

Table of Contents

Executables

flatpak — Build, install and run applications and runtimes

Commands

flatpak build-bundle — Create a single-file bundle from a local repository
flatpak build-commit-from — Create new commits based on existing one (possibly from another repository)
flatpak build-export — Create a repository from a build directory
flatpak build-finish — Finalize a build directory
flatpak build-import-bundle — Import a file bundle into a local repository
flatpak build-init — Initialize a build directory
flatpak build-sign — Sign an application or runtime
flatpak build-update-repo — Create a repository from a build directory
flatpak build — Build in a directory
flatpak config — Manage configuration
flatpak create-usb — Copy apps and/or runtimes onto removable media.
flatpak document-export — Export a file to a sandboxed application
flatpak document-info — Show information about exported files
flatpak document-list — List exported files
flatpak document-unexport — Stop exporting a file
flatpak permission-remove — List permissions
flatpak permission-list — List permissions
flatpak permission-show — List permissions
flatpak permission-reset — Reset permissions
flatpak enter — Enter an application
flatpak info — Show information about an installed application or runtime
flatpak install — Install an application or runtime
flatpak list — List installed applications and/or runtimes
flatpak make-current — Make a specific version of an app current
flatpak override — Override application requirements
flatpak remote-add — Add a remote repository
flatpak remote-delete — Delete a remote repository
flatpak remote-info — Show information about an application or runtime in a remote
flatpak remote-ls — Show available runtimes and applications
flatpak remote-modify — Modify a remote repository
flatpak remotes — List remote repositories
flatpak repair — Repair a flatpak installation
flatpak repo — Show information about a local repository
flatpak run — Run an application or open a shell in a runtime
flatpak search — Search for applications and runtimes
flatpak uninstall — Uninstall an application or runtime
flatpak update — Update an application or runtime

File Formats

flatpakrepo — Reference to a remote
flatpakref — Reference to a remote for an application or runtime
flatpak installation — Configuration for an installation location
flatpak metadata — Information about an application or runtime
flatpak remote — Configuration for a remote

Executables

Table of Contents

flatpak — Build, install and run applications and runtimes

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 @@ -33,7 +35,7 @@ it uses are OSTree repositories and can be manipulated with the ostree utility. Installed runtimes and applications are OSTree checkouts. -

Options

The following options are understood:

-h, --help: +

Options

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. @@ -47,7 +49,7 @@ Print the supported arches in priority order and exit.
--gl-drivers: Print the list of active gl drivers and exit. -

Commands

Commands for managing installed applications and runtimes:

flatpak-install(1): +

Commands

Commands for managing installed applications and runtimes:

flatpak-install(1): Install an application or a runtime from a remote or bundle.
flatpak-update(1): Update an installed application or runtime. @@ -59,6 +61,10 @@ Show information for an installed application or runtime.
flatpak-config(1): Manage flatpak configuration. +
flatpak-repair(1): + Repair flatpak installation. +
flatpak-create-usb(1): + Copy apps and/or runtimes onto removable media.

Commands for finding applications and runtimes:

flatpak-search(1): Search for applications and runtimes.

Commands for running applications:

flatpak-run(1): @@ -77,6 +83,14 @@ Show information about a specific file.
flatpak-document-list(1): List exported files. +

Commands for managing the dynamic permission store:

flatpak-permission-remove(1): + Remove item from permission store. +
flatpak-permission-list(1): + List permissions. +
flatpak-permission-show(1): + Show app permissions. +
flatpak-permission-reset(1): + Reset app permissions.

Commands for managing remote repositories:

flatpak-remotes(1): List all configured remote repositories.
flatpak-remote-add(1): @@ -107,7 +121,19 @@ Update the summary file in a repository.
flatpak-build-commit-from(1): Create a new commit based on an existing ref. -

Environment

flatpak-repo(1)

+ Print information about a repo. +

File formats

File formats that are used by Flatpak commands:

flatpak-flatpakref(5): + Reference to a remote for an application or runtime +
flatpak-flatpakrepo(5): + Reference to a remote +
flatpak-remote(5): + Configuration for a remote +
flatpak-installation(5): + Configuration for an installation location +
flatpak-metadata(5): + Information about an application or runtime +

Environment

Besides standard environment variables such as XDG_DATA_DIRS and XDG_DATA_HOME, flatpak is consulting some of its own.

FLATPAK_USER_DIR: @@ -121,22 +147,25 @@ The location of flatpak site configuration. If this is not set, /etc/flatpak is used (unless overridden at build time by --sysconfdir). -

Commands

Table of Contents

flatpak build-bundle — Create a single-file bundle from a local repository
flatpak build-commit-from — Create new commits based on existing one (possibly from another repository)
flatpak build-export — Create a repository from a build directory
flatpak build-finish — Finalize a build directory
flatpak build-import-bundle — Import a file bundle into a local repository
flatpak build-init — Initialize a build directory
flatpak build-sign — Sign an application or runtime
flatpak build-update-repo — Create a repository from a build directory
flatpak build — Build in a directory
flatpak config — Manage configuration
flatpak document-export — Export a file to a sandboxed application
flatpak document-info — Show information about exported files
flatpak document-list — List exported files
flatpak document-unexport — Stop exporting a file
flatpak enter — Enter an application
flatpak info — Show information about installed application and/or runtime
flatpak install — Install an application or runtime
flatpak list — List installed applications and/or runtimes
flatpak make-current — Make a specific version of an app current
flatpak override — Override application requirements
flatpak remote-add — Add a remote repository
flatpak remote-delete — Delete a remote repository
flatpak remote-info — Show information about an application or runtime in a remote
flatpak remote-ls — Show available runtimes and applications
flatpak remote-modify — Modify a remote repository
flatpak remotes — List remote repositories
flatpak repo — Show information about a local repository
flatpak run — Run an application or open a shell in a runtime
flatpak search — Search for applications and runtimes
flatpak uninstall — Uninstall an application or runtime
flatpak update — Update an application or runtime

Name

flatpak-build-bundle — Create a single-file bundle from a local repository

Synopsis

flatpak build-bundle [OPTION...] LOCATION FILENAME NAME [BRANCH]

Description

Commands

Table of Contents

flatpak build-bundle — Create a single-file bundle from a local repository
flatpak build-commit-from — Create new commits based on existing one (possibly from another repository)
flatpak build-export — Create a repository from a build directory
flatpak build-finish — Finalize a build directory
flatpak build-import-bundle — Import a file bundle into a local repository
flatpak build-init — Initialize a build directory
flatpak build-sign — Sign an application or runtime
flatpak build-update-repo — Create a repository from a build directory
flatpak build — Build in a directory
flatpak config — Manage configuration
flatpak create-usb — Copy apps and/or runtimes onto removable media.
flatpak document-export — Export a file to a sandboxed application
flatpak document-info — Show information about exported files
flatpak document-list — List exported files
flatpak document-unexport — Stop exporting a file
flatpak permission-remove — List permissions
flatpak permission-list — List permissions
flatpak permission-show — List permissions
flatpak permission-reset — Reset permissions
flatpak enter — Enter an application
flatpak info — Show information about an installed application or runtime
flatpak install — Install an application or runtime
flatpak list — List installed applications and/or runtimes
flatpak make-current — Make a specific version of an app current
flatpak override — Override application requirements
flatpak remote-add — Add a remote repository
flatpak remote-delete — Delete a remote repository
flatpak remote-info — Show information about an application or runtime in a remote
flatpak remote-ls — Show available runtimes and applications
flatpak remote-modify — Modify a remote repository
flatpak remotes — List remote repositories
flatpak repair — Repair a flatpak installation
flatpak repo — Show information about a local repository
flatpak run — Run an application or open a shell in a runtime
flatpak search — Search for applications and runtimes
flatpak uninstall — Uninstall an application or runtime
flatpak update — Update an application or runtime

Name

flatpak-build-bundle — Create a single-file bundle from a local repository

Synopsis

flatpak build-bundle [OPTION...] LOCATION FILENAME NAME [BRANCH]

Description

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 collection ID set on the repository at + LOCATION (if set) will be used for the + bundle.

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. -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help: Show help options and exit.
--runtime: Export a runtime instead of an application. @@ -159,9 +188,11 @@ Export to an OCI image instead of a Flatpak bundle.
-v, --verbose: Print debug information during command processing. -
--version: - Print version information and exit. -

Examples

+ $ flatpak build-bundle /var/lib/flatpak/repo gnome-calculator.flatpak org.gnome.Calculator stable +

Name

flatpak-build-commit-from — Create new commits based on existing one (possibly from another repository)

Synopsis

flatpak build-commit-from [OPTION...] DST-REPO DST-REF...

Description

Name

flatpak-build-commit-from — Create new commits based on existing one (possibly from another repository)

Synopsis

flatpak build-commit-from [OPTION...] DST-REPO DST-REF...

Description

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. - +

+ The collection ID set on + DST-REPO (if set) will be used for the + newly created commits.

This command is very useful when you want to maintain a branch with a clean history that has no unsigned or broken commits. @@ -188,7 +222,7 @@ 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. -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help: Show help options and exit.
--src-repo=SRC-REPO: The (local) repository to pull the source branch from. Defaults to the @@ -213,6 +247,9 @@ finally updating the summary.
--force: Create new commit even if the content didn't change from the existing branch head. +
--disable-fsync: + Don't fsync when writing to the repository. This can result in data loss in exceptional situations, but can improve performance when + working with temporary or test repositories.
--gpg-sign=KEYID: Sign the commit with this GPG key. This option can be used multiple times. @@ -222,18 +259,11 @@ Print debug information during command processing.
--ostree-verbose: Print OSTree debug information during command processing. -
--version: - Print version information and exit. -

Examples

- $ 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
-

Examples

+ To revert a commit to the commit before: +

+ $ flatpak build-commit-from --timestamp=NOW --src-ref=app/org.gnome.gedit/x86_64/master^ repo app/org.gnome.gedit/x86_64/master +

Name

flatpak-build-export — Create a repository from a build directory

Synopsis

flatpak build-export [OPTION...] LOCATION DIRECTORY [BRANCH]

Description

Name

flatpak-build-export — Create a repository from a build directory

Synopsis

flatpak build-export [OPTION...] LOCATION DIRECTORY [BRANCH]

Description

Creates or updates a repository with an application build. LOCATION is the location of the repository. DIRECTORY must be a @@ -260,15 +290,29 @@ Content Bytes Written: 305 of the files/ and export/ subdirectories and the metadata file are included in the commit, anything else is ignored. +

+ When exporting a flatpak to be published to the internet, + --collection-id=COLLECTION-ID should be specified + as a globally unique reverse DNS value to identify the collection of + flatpaks this will be added to. Setting a globally unique collection + ID allows the apps in the repository to be shared over peer to peer + systems without needing further configuration.

The build-update-repo command should be used to update repository metadata whenever application builds are added to a repository. -

Options

The following options are understood:

-h, --help: +

Options

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. +
--collection-id=COLLECTION-ID: + Set as the collection ID of the repository. Setting a globally + unique collection ID allows the apps in the repository to be shared over + peer to peer systems without needing further configuration. + If exporting to an existing repository, the collection ID + must match the existing configured collection ID for that + repository.
--arch=ARCH: Specify the architecture component of the branch to export. Only host compatible architectures can be specified.
--exclude=PATTERN: @@ -287,6 +331,9 @@ Content Bytes Written: 305 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. +
--disable-fsync: + Don't fsync when writing to the repository. This can result in data loss in exceptional situations, but can improve performance when + working with temporary or test repositories.
--update-appstream: Update the appstream branch after the build.
--no-update-summary: @@ -305,9 +352,7 @@ Content Bytes Written: 305 Print debug information during command processing.
--ostree-verbose: Print OSTree debug information during command processing. -
--version: - Print version information and exit. -

Examples

$ flatpak build-export ~/repos/gnome-calculator/ ~/build/gnome-calculator/ org.gnome.Calculator

 Commit: 9d0044ea480297114d03aec85c3d7ae3779438f9d2cb69d717fb54237acacb8c
@@ -316,7 +361,7 @@ Metadata Written: 5
 Content Total: 1174
 Content Written: 1
 Content Bytes Written: 305
-

Name

flatpak-build-finish — Finalize a build directory

Synopsis

flatpak build-finish [OPTION...] DIRECTORY

Description

Name

flatpak-build-finish — Finalize a build directory

Synopsis

flatpak build-finish [OPTION...] DIRECTORY

Description

Finalizes a build directory, to prepare it for exporting. DIRECTORY is the name of the directory.

@@ -340,7 +385,7 @@ Content Bytes Written: 305

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. -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help

Show help options and exit.

--command=COMMAND

The command to use. If this option is not specified, @@ -361,12 +406,12 @@ Content Bytes Written: 305

--socket=SOCKET

Expose a well known socket to the application. This updates the [Context] group in the metadata. - SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus. + SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth. This option can be used multiple times.

--nosocket=SOCKET

Don't expose a well known socket to the application. This updates the [Context] group in the metadata. - SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus. + SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth. This option can be used multiple times.

--device=DEVICE

Expose a device to the application. This updates @@ -381,7 +426,7 @@ Content Bytes Written: 305

--allow=FEATURE

Allow access to a specific feature. This updates the [Context] group in the metadata. - FEATURE must be one of: devel, multiarch. + FEATURE must be one of: devel, multiarch, bluetooth. This option can be used multiple times.

The devel feature allows the application to @@ -393,10 +438,14 @@ Content Bytes Written: 305 natively by the system. For example, for the x86_64 architecture, 32-bit x86 binaries will be allowed as well. +

+ The bluetooth feature allows the application to + use bluetooth (AF_BLUETOOTH) sockets. Note, for bluetooth to + fully work you must also have network access.

--disallow=FEATURE

Disallow access to a specific feature. This updates the [Context] group in the metadata. - FEATURE must be one of: devel, multiarch. + FEATURE must be one of: devel, multiarch, bluetooth. This option can be used multiple times.

--filesystem=FS

Allow the application access to a subset of the filesystem. @@ -466,6 +515,12 @@ key=v1;v2; be set to "true".

--extension=NAME=VARIABLE[=VALUE]

Add extension point info. + See the documentation for + flatpak-metadata(5) + for the possible values of + VARIABLE and VALUE. +

--remove-extension=NAME

+ Remove 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 @@ -481,9 +536,7 @@ key=v1;v2; Print debug information during command processing.

--ostree-verbose

Print OSTree debug information during command processing. -

--version

- Print version information and exit. -

Examples

$ flatpak build-finish /build/my-app --socket=x11 --share=ipc

 Exporting share/applications/gnome-calculator.desktop
@@ -491,17 +544,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
-

Name

flatpak-build-import-bundle — Import a file bundle into a local repository

Synopsis

flatpak build-import-bundle [OPTION...] LOCATION FILENAME

Description

Name

flatpak-build-import-bundle — Import a file bundle into a local repository

Synopsis

flatpak build-import-bundle [OPTION...] LOCATION FILENAME

Description

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. -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help: Show help options and exit.
-v, --verbose: Print debug information during command processing. @@ -523,14 +576,12 @@ Please review the exported files and the metadata This option can be used multiple times.
--gpg-homedir=PATH: GPG Homedir to use when looking for keyrings -
--version: - Print version information and exit. -

Name

flatpak-build-init — Initialize a build directory

Synopsis

flatpak build-init [OPTION...] DIRECTORY APPNAME SDK RUNTIME [BRANCH]

Description

Name

flatpak-build-init — Initialize a build directory

Synopsis

flatpak build-init [OPTION...] DIRECTORY APPNAME SDK RUNTIME [BRANCH]

Description

Initializes a directory for building an application. DIRECTORY is the name of the directory. APPNAME is the application id of the app @@ -546,7 +597,7 @@ Please review the exported files and the metadata

It is an error to run build-init on a directory that has already been initialized as a build directory. -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help: Show help options and exit.
--arch=ARCH: The architecture to use. @@ -563,6 +614,8 @@ Please review the exported files and the metadata
--sdk-extension=EXTENSION: When using --writable-sdk, in addition to the sdk, also install the specified extension. This option can be used multiple times. +
--extension=NAME=VARIABLE[=VALUE]: + Add extension point info.
--sdk-dir: Specify a custom subdirectory to use instead of usr for --writable-sdk.
--update: @@ -580,18 +633,21 @@ Please review the exported files and the metadata 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. +
--extension-tag=EXTENSION_TAG: + If building an extension, the tag to use when searching for + the mount point of the extension.
--verbose: Print debug information during command processing. -
--version: - Print version information and exit. -

Examples

--ostree-verbose

+ Print OSTree debug information during command processing. +

Examples

$ flatpak build-init /build/my-app org.gnome.Sdk org.gnome.Platform 3.16 -

Name

flatpak-build-sign — Sign an application or runtime

Synopsis

flatpak build-sign [OPTION...] LOCATION ID [BRANCH]

Description

Name

flatpak-build-sign — Sign an application or runtime

Synopsis

flatpak build-sign [OPTION...] LOCATION ID [BRANCH]

Description

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 @@ -600,7 +656,7 @@ Please review the exported files and the metadata

Applications can also be signed during build-export, but it is sometimes useful to add additional signatures later. -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help: Show help options and exit.
--gpg-sign=KEYID: Sign the commit with this GPG key. @@ -615,16 +671,14 @@ Please review the exported files and the metadata Print debug information during command processing.
--ostree-verbose: Print OSTree debug information during command processing. -
--version: - Print version information and exit. -

Examples

$ flatpak build-sign --gpg-sign=D8BA6573DDD2418027736F1BC33B315E53C1E9D6 /some/repo org.my.App -

Name

flatpak-build-update-repo — Create a repository from a build directory

Synopsis

flatpak build-update-repo [OPTION...] LOCATION

Description

Name

flatpak-build-update-repo — Create a repository from a build directory

Synopsis

flatpak build-update-repo [OPTION...] LOCATION

Description

Updates repository metadata for the repository at LOCATION . This command generates an OSTree summary file that lists the contents of the repository. @@ -634,7 +688,7 @@ Please review the exported files and the metadata 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. -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help: Show help options and exit.
--redirect-url=URL: Redirect this repo to a new URL. @@ -646,6 +700,20 @@ Please review the exported files and the metadata
--gpg-import=FILE: Import a new default GPG public key from the given file. +
--collection-id=COLLECTION-ID: + The globally unique identifier of the remote repository, to + allow mirrors to be grouped. This must be set to a globally + unique reverse DNS string if the repository is to be made + publicly available. If a collection ID is already set on an + existing repository, this will update it. If not specified, + the existing collection ID will be left unchanged. +
--deploy-collection-id: + Deploy the collection ID (set using --collection-id + in the static remote configuration for all clients. This is + irrevocable once published in a repository. Use it to decide + when to roll out a collection ID to users of an existing repository. + If constructing a new repository which has a collection ID, + you should typically always pass this option.
--gpg-sign=KEYID: Sign the commit with this GPG key. This option can be used multiple times. @@ -662,14 +730,12 @@ Please review the exported files and the metadata Print debug information during command processing.
--ostree-verbose: Print OSTree debug information during command processing. -
--version: - Print version information and exit. -

Name

flatpak-build — Build in a directory

Synopsis

flatpak build [OPTION...] DIRECTORY [COMMAND [ARG...]]

Description

Name

flatpak-build — Build in a directory

Synopsis

flatpak build [OPTION...] DIRECTORY [COMMAND [ARG...]]

Description

Runs a build command in a directory. DIRECTORY must have been initialized with flatpak build-init.

@@ -679,10 +745,12 @@ Please review the exported files and the metadata are mounted at /app and /var, respectively. They are writable, and their contents are preserved between build commands, to allow accumulating build artifacts there. -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help

Show help options and exit.

-v, --verbose

Print debug information during command processing. +

--ostree-verbose

+ Print OSTree 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

@@ -704,12 +772,12 @@ Please review the exported files and the metadata

--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. + SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth. 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. + SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth. This option can be used multiple times.

--device=DEVICE

Expose a device to the application. This overrides to @@ -724,22 +792,15 @@ Please review the exported files and the metadata

--allow=FEATURE

- 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. +

+ See flatpak-build-finish(1) + for the meaning of the various features.

--disallow=FEATURE

--filesystem=FILESYSTEM[:ro|:create]

Allow the application access to a subset of the filesystem. @@ -818,16 +879,16 @@ key=v1;v2;

--log-system-bus

Log system bus traffic. This can be useful to see what access you need to allow in your D-Bus policy. -

Examples

$ flatpak build /build/my-app rpmbuild my-app.src.rpm -

Name

flatpak-config — Manage configuration

Synopsis

flatpak config [OPTION...] KEY VALUE

Description

Name

flatpak-config — Manage configuration

Synopsis

flatpak config [OPTION...] KEY VALUE

Description

Show and modify current configuration -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help: Show help options and exit.
--list: Print all keys and their values @@ -847,11 +908,81 @@ key=v1;v2; /etc/flatpak/installations.d/. Using --installation=default is equivalent to using --system . -

Examples

-v, --verbose

+ Print debug information during command processing. +

--ostree-verbose

+ Print OSTree debug information during command processing. +

Examples

$ flatpak config --set language sv;en;fi -

Name

flatpak-create-usb — Copy apps and/or runtimes onto removable media.

Synopsis

flatpak create-usb [OPTION...] MOUNT-PATH REF...

Description

+ Copies the specified apps and/or runtimes REF s onto the removable + media mounted at MOUNT-PATH , along with all the dependencies and + metadata needed for installing them. This is one way of transferring flatpaks + between computers that doesn't require an Internet connection. After using + this comand, the USB drive can be connected to another computer and + flatpak install will prefer to install from it rather than + the Internet if the refs are the newest available. For this process to work a + collection ID must be configured on the relevant remotes on both the source + and destination computers, and on the remote server. +

+ 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 installed, and if there are multiple matches an error message + will list the alternatives. +

+ By default this looks for both installed apps and runtimes + with the given REF , but you can + limit this by using the --app or --runtime option. +

+ All REF s must be in the same installation (user, system, or other). + Otherwise it's ambiguous which repository metadata refs to put on the USB drive. +

+ By default flatpak create-usb uses .ostree/repo + as the destination directory under MOUNT-PATH but if you + specify another location using --destination-repo + a symbolic link will be created for you in .ostree/repos.d. + This ensures that either way the repository will be found by flatpak (and other + consumers of libostree) for install/update operations. +

+ Unless overridden with the --system, --user, or --installation + options, this command searches both the system-wide installation + and the per-user one for REF and errors + out if it exists in more than one. +

Options

The following options are understood:

-h, --help: + Show help options and exit. +
--user: + Uninstalls from a per-user installation. +
--system: + Uninstalls from the default system-wide installation. +
--installation=NAME: + Copies refs from a system-wide installation specified by + NAME among those defined in + /etc/flatpak/installations.d/. Using + --installation=default is + equivalent to using --system . +
--app: + Assume that all REF s are apps if not explicitly specified. +
--runtime: + Assume that all REF s are runtimes if not explicitly specified. +
--destination-repo=DEST: + Create the repository in DEST under MOUNT-PATH, rather than + the default location. +
-v, --verbose: + Print debug information during command processing. +
--ostree-verbose: + Print OSTree debug information during command processing. +

Examples

+ $ flatpak create-usb /run/media/mwleeds/1a9b4cb2-a7ef-4d9b-91a5-6eaf8fdd2bf6/ com.endlessm.wiki_art.en +

Name

flatpak-document-export — Export a file to a sandboxed application

Synopsis

flatpak document-export [OPTION...] FILE

Description

+ flatpak-install(1), + flatpak-list(1), + ostree-create-usb(1) +

Name

flatpak-document-export — Export a file to a sandboxed application

Synopsis

flatpak document-export [OPTION...] FILE

Description

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 @@ -860,7 +991,7 @@ key=v1;v2; 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. -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help: Show help options and exit.
-u, --unique: Don't reuse an existing document id for the file. This makes it safe to later remove the @@ -894,31 +1025,31 @@ key=v1;v2; 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. -

Examples

--ostree-verbose

+ Print OSTree debug information during command processing. +

Examples

$ flatpak document-export --app=org.gnome.GEdit ~/test.txt

 /run/user/1000/doc/e52f9c6a/test.txt
-

Name

flatpak-document-info — Show information about exported files

Synopsis

flatpak document-info [OPTION...] FILE

Description

Name

flatpak-document-info — Show information about exported files

Synopsis

flatpak document-info [OPTION...] FILE

Description

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. -

Options

The following options are understood:

-h, --help: +

Options

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. -

Examples

--ostree-verbose

+ Print OSTree debug information during command processing. +

Examples

$ flatpak document-info ~/Sources/gtk/gail-3.0.pc

 id: dd32c34a
@@ -926,42 +1057,131 @@ 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
-

Name

flatpak-document-list — List exported files

Synopsis

flatpak document-list [OPTION...] [APPID]

Description

Name

flatpak-document-list — List exported files

Synopsis

flatpak document-list [OPTION...] [APPID]

Description

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. -

Options

The following options are understood:

-h, --help: +

Options

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. -

Name

flatpak-document-unexport — Stop exporting a file

Synopsis

flatpak document-export [OPTION...] FILE

Description

Name

flatpak-document-unexport — Stop exporting a file

Synopsis

flatpak document-unexport [OPTION...] FILE

Description

Removes the document id for the file from the document portal. This will make the document unavailable to all sandboxed applications. -

Options

The following options are understood:

-h, --help: +

Options

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. -

Name

flatpak-enter — Enter an application

Synopsis

flatpak enter [OPTION...] MONITORPID COMMAND [ARG...]

Description

Name

flatpak-permission-remove — List permissions

Synopsis

flatpak permission-remove [OPTION...] TABLE ID

Description

+ Removes an entry for the object with id ID to the permission + store table TABLE. The ID must be in a suitable format + for the table. +

+ The permission store is used by portals. + Each portal generally has its own table in the permission + store, and the format of the table entries is specific to + each portal. +

Options

The following options are understood:

-h, --help: + Show help options and exit. +
-v, --verbose: + Print debug information during command processing. +
--ostree-verbose: + Print OSTree debug information during command processing. +

Name

flatpak-permission-list — List permissions

Synopsis

flatpak permission-list [OPTION...] [TABLE] [ID]

Description

+ Lists dynamic permissions which are stored in the Flatpak + permission store. +

+ When called without arguments, lists all + the entries in all permission store tables. When called + with one argument, lists all the entries in the named + table. When called with two arguments, lists the entry + in the named table for the given object ID. +

+ The permission store is used by portals. + Each portal generally has its own table in the permission + store, and the format of the table entries is specific to + each portal. +

Options

The following options are understood:

-h, --help: + Show help options and exit. +
-v, --verbose: + Print debug information during command processing. +
--ostree-verbose: + Print OSTree debug information during command processing. +

Name

flatpak-permission-show — List permissions

Synopsis

flatpak permission-show [OPTION...] APP_ID

Description

+ Lists dynamic permissions for the given app which are stored + in the Flatpak permission store. +

+ The permission store is used by portals. + Each portal generally has its own table in the permission + store, and the format of the table entries is specific to + each portal. +

Options

The following options are understood:

-h, --help: + Show help options and exit. +
-v, --verbose: + Print debug information during command processing. +
--ostree-verbose: + Print OSTree debug information during command processing. +

Name

flatpak-permission-reset — Reset permissions

Synopsis

flatpak permission-reset [OPTION...] APP_ID

Description

+ Removes all permissions for the given app from the Flatpak + permission store. +

+ The permission store is used by portals. + Each portal generally has its own table in the permission + store, and the format of the table entries is specific to + each portal. +

Options

The following options are understood:

-h, --help: + Show help options and exit. +
-v, --verbose: + Print debug information during command processing. +
--ostree-verbose: + Print OSTree debug information during command processing. +

Name

flatpak-enter — Enter an application

Synopsis

flatpak enter [OPTION...] MONITORPID COMMAND [ARG...]

Description

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. @@ -971,29 +1191,39 @@ permissions: 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. -

Options

The following options are understood:

-h, --help: +

Options

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. -

Examples

--ostree-verbose

+ Print OSTree debug information during command processing. +

Examples

$ flatpak enter 15345 sh -

Name

flatpak-info — Show information about installed application and/or runtime

Synopsis

flatpak info [OPTION...] NAME [BRANCH]

Description

- Show info about and installed application and/or runtime. +

Name

flatpak-info — Show information about an installed application or runtime

Synopsis

flatpak info [OPTION...] NAME [BRANCH]

Description

+ Show info about an installed application 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 + If you specify one of the options + --show-ref, + --show-origin, + --show-commit, + --show-size, + --show-metadata, + --show-permissions, + --file-access, + --show-location, + --show-runtime or + --show-sdk, + 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. -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help: Show help options and exit.
--user: Query per-user installations. @@ -1016,19 +1246,27 @@ permissions: Show the installed size.
-m, --show-metadata: Show the metadata. +
--show-runtime: + Show the runtime. +
--show-sdk: + Show the SDK. +
-M, --show-permissions: + Show the permissions. +
--file-access=PATH: + Show the level of access to the given path.
-e, --show-extensions: Show the matching extensions.
-v, --verbose: Print debug information during command processing. -
--version: - Print version information and exit. -

Examples

--ostree-verbose

+ Print OSTree debug information during command processing. +

Examples

$ flatpak info org.gnome.Builder//master -

Name

flatpak-install — Install an application or runtime

Synopsis

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

Description

Name

flatpak-install — Install an application or runtime

Synopsis

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

Description

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 @@ -1048,22 +1286,28 @@ permissions: 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 . +

+ If the specified REMOTE has a collection ID configured on it, + flatpak will search mounted filesystems such as USB drives as well as Avahi services + advertised on the local network for the needed refs, in order to support + offline updates. See ostree-find-remotes(1) + for more information.

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. + argument has 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, + installed and used at the same time. However, only one version of an application can be current, meaning its exported files (for instance desktop files and icons) are visible to the host. The last installed version is made current by default, but 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. -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help: Show help options and exit.
--bundle: Assume LOCATION is a .flatpak single-bundle file. @@ -1071,6 +1315,8 @@ permissions:
--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. +
--reinstall: + Uninstall first if already installed.
--user: Install the application or runtime in a per-user installation.
--system: @@ -1106,9 +1352,7 @@ permissions: Print debug information during command processing.
--ostree-verbose: Print OSTree debug information during command processing. -
--version: - Print version information and exit. -

Examples

$ flatpak install gnome org.gnome.gedit2

$ flatpak --installation=default install gnome org.gnome.gedit2 @@ -1116,22 +1360,22 @@ permissions: $ flatpak --user install gnome org.gnome.gedit//3.22

$ flatpak --user install https://sdk.gnome.org/gedit.flatpakref -

Name

flatpak-list — List installed applications and/or runtimes

Synopsis

flatpak list [OPTION...]

Description

- Lists the names of the installed applications and/or runtime. +

Name

flatpak-list — List installed applications and/or runtimes

Synopsis

flatpak list [OPTION...]

Description

+ Lists the names of the installed applications and/or runtimes.

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 + By default this lists both installed apps and runtimes, but you can change this by using the --app or --runtime option. -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help: Show help options and exit.
--user: List per-user installations. @@ -1156,20 +1400,18 @@ permissions: Print debug information during command processing.
--ostree-verbose: Print OSTree debug information during command processing. -
--version: - Print version information and exit. -

Examples

$ flatpak --user list

 org.gnome.Builder
 org.freedesktop.glxgears
 org.gnome.MyApp
 org.gnome.GEdit
-

Name

flatpak-make-current — Make a specific version of an app current

Synopsis

flatpak make-current [OPTION...] APP BRANCH

Description

Name

flatpak-make-current — Make a specific version of an app current

Synopsis

flatpak make-current [OPTION...] APP BRANCH

Description

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. @@ -1179,7 +1421,7 @@ org.gnome.GEdit

Unless overridden with the --user or --installation options, this command changes the default system-wide installation. -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help: Show help options and exit.
--user: Update a per-user installation. @@ -1194,15 +1436,15 @@ org.gnome.GEdit The architecture to install for.
-v, --verbose: Print debug information during command processing. -
--version: - Print version information and exit. -

Examples

--ostree-verbose

+ Print OSTree debug information during command processing. +

Examples

$ flatpak --user make-current org.gnome.GEdit 3.14 -

Name

flatpak-override — Override application requirements

Synopsis

flatpak override [OPTION...] [APP]

Description

Name

flatpak-override — Override application requirements

Synopsis

flatpak override [OPTION...] [APP]

Description

Overrides the application specified runtime requirements. This can be used to grant a sandboxed application more or less resources than it requested.

@@ -1216,7 +1458,7 @@ org.gnome.GEdit

Unless overridden with the --user or --installation options, this command changes the default system-wide installation. -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help

Show help options and exit.

--user

Update a per-user installation. @@ -1240,12 +1482,12 @@ org.gnome.GEdit

--socket=SOCKET

--nosocket=SOCKET

--device=DEVICE

Expose a device to the application. This overrides to @@ -1260,22 +1502,15 @@ org.gnome.GEdit

--allow=FEATURE

- The devel feature allows the application to - access certain syscalls such as ptrace(), and - perf_event_open(). -

--disallow=FEATURE

--filesystem=FS

Allow the application access to a subset of the filesystem. @@ -1336,16 +1571,16 @@ key=v1;v2; This option can be used multiple times.

-v, --verbose

Print debug information during command processing. -

--version

- Print version information and exit. -

Examples

--ostree-verbose

+ Print OSTree debug information during command processing. +

Examples

$ flatpak override --nosocket=wayland org.gnome.GEdit

$ flatpak override --filesystem=home org.mozilla.Firefox -

Name

flatpak-remote-add — Add a remote repository

Synopsis

Add from a .flatpakrepo file:

flatpak remote-add [OPTION...] [--from] NAME LOCATION

Manually specify repo uri and options:

flatpak remote-add [OPTION...] NAME LOCATION

Description

Name

flatpak-remote-add — Add a remote repository

Synopsis

Add from a .flatpakrepo file:

flatpak remote-add [OPTION...] [--from] NAME LOCATION

Manually specify repo uri and options:

flatpak remote-add [OPTION...] NAME LOCATION

Description

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 @@ -1356,7 +1591,7 @@ key=v1;v2;

Unless overridden with the --user or --installation options, this command changes the default system-wide installation. -

Options

The following options are understood:

-h, --help: +

Options

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 @@ -1394,26 +1629,21 @@ key=v1;v2; 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. -

Examples

$ 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/ -

Name

flatpak-remote-delete — Delete a remote repository

Synopsis

flatpak remote-delete [OPTION...] NAME

Description

Name

flatpak-remote-delete — Delete a remote repository

Synopsis

flatpak remote-delete [OPTION...] NAME

Description

Removes a remote repository from the flatpak repository configuration. NAME is the name of an existing remote.

@@ -1421,7 +1651,7 @@ key=v1;v2; this command uses either the default system-wide installation or the per-user one, depending on which has the specified REMOTE . -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help: Show help options and exit.
--user: Modify the per-user configuration. @@ -1438,16 +1668,14 @@ key=v1;v2; Print debug information during command processing.
--ostree-verbose: Print OSTree debug information during command processing. -
--version: - Print version information and exit. -

Examples

$ flatpak --user remote-delete dried-raisins -

Name

flatpak-remote-info — Show information about an application or runtime in a remote

Synopsis

flatpak remote-info [OPTION...] REMOTE REF

Description

Name

flatpak-remote-info — Show information about an application or runtime in a remote

Synopsis

flatpak remote-info [OPTION...] REMOTE REF

Description

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. @@ -1461,7 +1689,7 @@ key=v1;v2; this command uses either the default system-wide installation or the per-user one, depending on which has the specified REMOTE . -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help: Show help options and exit.
--user: Use the per-user configuration. @@ -1494,7 +1722,7 @@ key=v1;v2; Print debug information during command processing.
--ostree-verbose: Print OSTree debug information during command processing. -

Examples

$ flatpak --user remote-info flathub org.gnome.gedit

 Ref: app/org.gnome.gedit/x86_64/stable
@@ -1508,21 +1736,24 @@ Parent: -
 Download size: 3,4 MB
 Installed size: 11,1 MB
 Runtime: org.gnome.Platform/x86_64/3.24
-

Name

flatpak-remote-ls — Show available runtimes and applications

Synopsis

flatpak remote-ls [OPTION...] [REMOTE]

Description

Name

flatpak-remote-ls — Show available runtimes and applications

Synopsis

flatpak remote-ls [OPTION...] [REMOTE]

Description

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). +

+ REMOTE can be a file:// URI pointing to a + local repository instead of a remote name.

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 . -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help: Show help options and exit.
--user: Use the per-user configuration. @@ -1541,7 +1772,7 @@ Runtime: org.gnome.Platform/x86_64/3.24 Show only applications, omit runtimes.
--all, -a: Show everything. By default locale and debug extensions as well as secondary arches when the primary - arch in available are hidden. + arch is available are hidden.
--updates: Show only those which have updates available.
--arch=ARCH: @@ -1551,17 +1782,21 @@ Runtime: org.gnome.Platform/x86_64/3.24 Print debug information during command processing.
--ostree-verbose: Print OSTree debug information during command processing. -
--version: - Print version information and exit. -

Examples

$ flatpak --user remote-ls --app testrepo

+Ref
 org.gnome.Builder
 org.freedesktop.glxgears
-

Name

flatpak-remote-modify — Modify a remote repository

Synopsis

flatpak remote-modify [OPTION...] NAME

Description

Name

flatpak-remote-modify — Modify a remote repository

Synopsis

flatpak remote-modify [OPTION...] NAME

Description

Modifies options for an existing remote repository in the flatpak repository configuration. NAME is the name for the remote.

@@ -1569,7 +1804,7 @@ org.freedesktop.glxgears this command uses either the default system-wide installation or the per-user one, depending on which has the specified REMOTE . -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help

Show help options and exit.

--user

Modify the per-user configuration. @@ -1608,12 +1843,15 @@ org.freedesktop.glxgears

--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. + A default branch for the remote, mainly for use in a UI. +

--collection-id=COLLECTION-ID

+ The globally unique identifier of the remote repository, to + allow mirrors to be grouped. This must only be set to the + collection ID provided by the remote, and must not be set if the + remote does not provide a collection ID.

--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

@@ -1624,22 +1862,20 @@ org.freedesktop.glxgears Print debug information during command processing.

--ostree-verbose

Print OSTree debug information during command processing. -

--version

- Print version information and exit. -

Examples

$ flatpak --user remote-modify --no-gpg-verify test-repo -

Name

flatpak-remotes — List remote repositories

Synopsis

flatpak remotes [OPTION...]

Description

Name

flatpak-remotes — List remote repositories

Synopsis

flatpak remotes [OPTION...]

Description

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. -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help: Show help options and exit.
--user: Show the per-user configuration. @@ -1658,19 +1894,51 @@ org.freedesktop.glxgears Print debug information during command processing.
--ostree-verbose: Print OSTree debug information during command processing. -
--version: - Print version information and exit. -

Examples

$ flatpak remotes --user --show-details

 testrepo	Test Repository	 http://209.132.179.91/repo/ no-gpg-verify
-

Name

flatpak-repo — Show information about a local repository

Synopsis

flatpak repo [OPTION...] LOCATION

Description

Name

flatpak-repair — Repair a flatpak installation

Synopsis

flatpak repair [OPTION...]

Description

+ Repair a flatpak installation by pruning and reinstalling invalid objects. The repair command does all of the following: +

+ Scan all locally available refs, removing any that don't correspond to a deployed ref. +
+ Verify each commit they point to, removing any invalid objects and noting any missing objects. +
+ Remove any refs that had an invalid object, and any non-partial refs that had missing objects. +
+ Prune all objects not referenced by a ref, which gets rid of any possibly invalid non-scanned objects. +
+ Enumerate all deployed refs and re-install any that are not in the repo (or are partial for a non-subdir deploy). +

Options

The following options are understood:

-h, --help: + Show help options and exit. +
--user: + Repair per-user installation. +
--system: + Repair system-wide installation. +
--installation=NAME: + Repair the system-wide installation + specified by NAME among those defined in + /etc/flatpak/installations.d/. Using + --installation=default is equivalent to using + --system . +
-v, --verbose: + Print debug information during command processing. +
--ostree-verbose: + Print OSTree debug information during command processing. +

Examples

+ $ sudo flatpak repair +

+ $ flatpak repair --user +

Name

flatpak-repo — Show information about a local repository

Synopsis

flatpak repo [OPTION...] LOCATION

Description

Show information about a local repository. -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help: Show help options and exit.
--info: Print general information about a local repository. @@ -1678,12 +1946,16 @@ testrepo Test Repository http://209.132.179.91/repo/ no-gpg-verify List the branches in a local repository.
--metadata=BRANCH: Print metadata for a branch in the repository. -

Examples

-v, --verbose

+ Print debug information during command processing. +

--ostree-verbose

+ Print OSTree debug information during command processing. +

Examples

$ flatpak repo --info ~/my-repo -

Name

flatpak-run — Run an application or open a shell in a runtime

Synopsis

flatpak run [OPTION...] REF [ARG...]

Description

Name

flatpak-run — Run an application or open a shell in a runtime

Synopsis

flatpak run [OPTION...] REF [ARG...]

Description

If REF names an installed application, flatpak runs the application in a sandboxed environment. Extra arguments are passed on to the application. @@ -1703,12 +1975,12 @@ testrepo Test Repository http://209.132.179.91/repo/ no-gpg-verify

The remaining arguments are passed to the command that gets run in the sandboxed environment. See the --file-forwarding for handling of file arguments. -

Options

The following options are understood:

-h, --help: +

Options

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. +

--ostree-verbose

+ Print OSTree debug information during command processing.

--arch=ARCH

The architecture to install for.

--command=COMMAND

@@ -1738,12 +2010,12 @@ testrepo Test Repository http://209.132.179.91/repo/ no-gpg-verify

--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. + SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth. 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. + SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus, ssh-auth. This option can be used multiple times.

--device=DEVICE

Expose a device to the application. This overrides to @@ -1758,12 +2030,15 @@ testrepo Test Repository http://209.132.179.91/repo/ no-gpg-verify

--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. + FEATURE must be one of: devel, multiarch, bluetooth. This option can be used multiple times. +

+ See flatpak-build-finish(1) + for the meaning of the various features.

--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. + FEATURE must be one of: devel, multiarch, bluetooth. This option can be used multiple times.

--filesystem=FS

Allow the application access to a subset of the filesystem. @@ -1830,6 +2105,8 @@ key=v1;v2;

--log-system-bus

Log system bus traffic. This can be useful to see what access you need to allow in your D-Bus policy. +

-p, --die-with-parent

+ Kill the entire sandbox when the launching process dies.

--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, @@ -1837,22 +2114,22 @@ key=v1;v2; 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. -

Examples

$ flatpak run org.gnome.GEdit

$ flatpak run --devel --command=bash org.gnome.Builder

$ flatpak run --command=bash org.gnome.Sdk -

Name

flatpak-search — Search for applications and runtimes

Synopsis

flatpak search TEXT

Description

Name

flatpak-search — Search for applications and runtimes

Synopsis

flatpak search TEXT

Description

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. -

Options

The following options are understood:

--user: +

Options

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. @@ -1865,23 +2142,25 @@ key=v1;v2; Show help options and exit.
-v, --verbose: Print debug information during command processing. -

Name

flatpak-uninstall — Uninstall an application or runtime

Synopsis

flatpak uninstall [OPTION...] [REF...]

Description

--ostree-verbose

+ Print OSTree debug information during command processing. +

Name

flatpak-uninstall — Uninstall an application or runtime

Synopsis

flatpak uninstall [OPTION...] [REF...]

Description

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 + 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 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. + By default this looks for both installed 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 removes the ref for this application/runtime from the - local OSTree repository and purges and objects that are no longer + local OSTree repository and purges any objects that are no longer needed to free up disk space. If the same application is later reinstalled, the objects will be pulled from the remote repository again. The --keep-ref option can be used to prevent this. @@ -1889,25 +2168,34 @@ key=v1;v2; 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. -

Options

The following options are understood:

-h, --help: + Unless overridden with the --system, --user, or --installation + options, this command searches both the system-wide installation + and the per-user one for REF and errors + out if it exists in more than one. +

Options

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. + Uninstalls from a per-user installation.
--system: - Updates the default system-wide installation. + Uninstalls from 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 . + Uninstalls from 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. +
--all: + Remove all refs on the system. +
--unused: + Remove unused refs on the system. +
-y, --assumeyes: + Automatically answer yes to all questions. This is useful for automation.
--app: Only look for an app with the given name.
--runtime: @@ -1920,16 +2208,14 @@ key=v1;v2; Print debug information during command processing.
--ostree-verbose: Print OSTree debug information during command processing. -
--version: - Print version information and exit. -

Examples

$ flatpak --user uninstall org.gnome.GEdit -

Name

flatpak-update — Update an application or runtime

Synopsis

flatpak update [OPTION...] [REF...]

flatpak update [OPTION...] --appstream [REMOTE]

Description

Name

flatpak-update — Update an application or runtime

Synopsis

flatpak update [OPTION...] [REF...]

flatpak update [OPTION...] --appstream [REMOTE]

Description

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 + 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 @@ -1943,6 +2229,12 @@ key=v1;v2; 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. +

+ If the configured remote for a ref being updated has a collection ID configured on it, + flatpak will search mounted filesystems such as USB drives as well as Avahi services + advertised on the local network for the needed refs, in order to support + offline updates. See ostree-find-remotes(1) + for more information.

Note that updating a runtime is different from installing a different branch, and runtime updates are expected to keep @@ -1952,7 +2244,7 @@ key=v1;v2;

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. -

Options

The following options are understood:

-h, --help: +

Options

The following options are understood:

-h, --help: Show help options and exit.
--user: Update a per-user installation. @@ -1970,7 +2262,8 @@ key=v1;v2; 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. + Update to this commit, instead of the tip of the branch. You can find commits + using flatpak remote-info --log REMOTE REF.
--no-deploy: Download the latest version, but don't deploy it.
--no-pull: @@ -1993,15 +2286,13 @@ key=v1;v2; Print debug information during command processing.
--ostree-verbose: Print OSTree debug information during command processing. -
--version: - Print version information and exit. -

Examples

$ flatpak --user update org.gnome.GEdit -

File Formats

Table of Contents

flatpakrepo — Reference to a remote
flatpakref — Reference to a remote for an application or runtime
flatpak installation — Configuration for an installation location
flatpak metadata — Information about an application or runtime
flatpak remote — Configuration for a remote

Name

flatpak-flatpakrepo — Reference to a remote

Description

File Formats

Table of Contents

flatpakrepo — Reference to a remote
flatpakref — Reference to a remote for an application or runtime
flatpak installation — Configuration for an installation location
flatpak metadata — Information about an application or runtime
flatpak remote — Configuration for a remote

Name

flatpak-flatpakrepo — Reference to a remote

Description

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 @@ -2011,24 +2302,24 @@ key=v1;v2; when displaying a remote to the user, e.g. in an app store.

The filename extension commonly used for flatpakrepo files is .flatpakrepo. -

File format

The flatpakrepo file is using the same .ini file format that is used for systemd unit files or application .desktop files. -

[Flatpak Repo]

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.

Example

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.
CollectionID (string): The collection ID of the remote, if it has one. This uniquely identifies the collection of apps in the remote, to allow peer to peer redistribution.

Example

 [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=
-
-

Name

flatpak-flatpakref — Reference to a remote for an application or runtime

Description

Name

flatpak-flatpakref — Reference to a remote for an application or runtime

Description

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. @@ -2040,14 +2331,14 @@ GPGKey=mQENBFUUCGcBCAC/K9WeV4xCaKr3NKRqPXeY5mpaXAJyasLqCtrDx92WUgbu0voWrhohNAKpq The filename extension commonly used for flatpakref files is .flatpakref.

A flatpakref file can also refer to a remote for a runtime. -

File format

The flatpakref file is using the same .ini file format that is used for systemd unit files or application .desktop files. -

[Flatpak Ref]

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.

Example

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.
CollectionID (string): The collection ID of the remote, if it has one. This uniquely identifies the collection of apps in the remote, to allow peer to peer redistribution.
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.

Example

 [Flatpak Ref]
 Title=GEdit
 Name=org.gnome.gedit
@@ -2055,11 +2346,11 @@ 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=
-

Name

flatpak-installation — Configuration for an installation location

Description

Name

flatpak-installation — Configuration for an installation location

Description

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/. @@ -2067,20 +2358,20 @@ GPGKey=mQENBFUUCGcBCAC/K9WeV4xCaKr3NKRqPXeY5mpaXAJyasLqCtrDx92WUgbu0voWrhohNAKpq 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. -

File format

The installation config file format is using the same .ini file format that is used for systemd unit files or application .desktop files. -

[Installation …]

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.

Examples

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.

Examples

 [Installation "extra"]
 Path=/location/of/sdcard
 DisplayName=Extra Installation
 StorageType=sdcard
-

Name

flatpak-metadata — Information about an application or runtime

Description

Name

flatpak-metadata — Information about an application or runtime

Description

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 @@ -2097,10 +2388,10 @@ StorageType=sdcard For compatibility with older Flatpak versions, /run/user/$UID/flatpak-info is a symbolic link to the same file. -

File format

The metadata file is using the same .ini file format that is used for systemd unit files or application .desktop files. -

[Application] or [Runtime]

Metadata for applications starts with an [Application] group, metadata for runtimes with a [Runtime] group.

@@ -2119,7 +2410,7 @@ StorageType=sdcard Tags to include in AppStream XML. Available since 0.4.12. -

[Context]

This group determines various system resources that may be shared with the application when it is run in a flatpak sandbox.

@@ -2130,7 +2421,7 @@ StorageType=sdcard Available since 0.3.

sockets (list)

List of well-known sockets to make available in the sandbox. - Possible sockets: x11, wayland, fallback-x11, pulseaudio, session-bus, system-bus. + Possible sockets: x11, wayland, fallback-x11, pulseaudio, session-bus, system-bus, ssh-auth. When making a socket available, flatpak also sets well-known environment variables like DISPLAY or DBUS_SYSTEM_BUS_ADDRESS to let the application @@ -2287,12 +2578,16 @@ StorageType=sdcard example i386 binaries in an x86_64 environment. Available since 0.6.12. +

bluetooth

+ Allow the application to use bluetooth (AF_BLUETOOTH) sockets. + Note, for bluetooth to fully work you must also have network access. + Available since 0.11.8.

A feature can be prefixed with ! to indicate the absence of that feature, for example !devel if development and debugging are not allowed. -

[Instance]

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. @@ -2321,7 +2616,7 @@ StorageType=sdcard directly (either it goes via a proxy, or it cannot access the system bus at all). Available since 0.8.0. -

[Session Bus Policy]

If the sockets key is not allowing full access to the D-Bus session bus, then flatpak provides filtered access.

@@ -2359,7 +2654,7 @@ StorageType=sdcard

own

The application can own the bus name or names (as well as all the above). Available since 0.2. -

FlatpakInstallation can list configured remotes as well as installed application and runtime references (in short: refs). It can also run, install, update and -uninstall applications and runtimes.

flatpak_installation_get_priority ()

gint
+gint
 flatpak_installation_get_priority (FlatpakInstallation *self);
 Returns the numeric priority of the system installation for self
 .
@@ -1485,11 +1593,11 @@ flatpak_installation_get_storage_type (
 flatpak_installation_list_installed_refs ()
-GPtrArray *
+GPtrArray *
 flatpak_installation_list_installed_refs
                                (FlatpakInstallation *self,
-                                GCancellable *cancellable,
-                                GError **error);
+                                GCancellable *cancellable,
+                                GError **error);
 Lists the installed references.
 
 Parameters
@@ -1507,12 +1615,12 @@ flatpak_installation_list_installed_refs
 
 
 cancellable
-a GCancellable. 
+a GCancellable. 
 [nullable]
 
 
 error
-return location for a GError
+return location for a GError
  
 
 
@@ -1520,7 +1628,7 @@ flatpak_installation_list_installed_refs
 
 
 Returns
-an GPtrArray of
+
a GPtrArray of
 FlatpakInstalledRef instances. 
 [transfer container][element-type FlatpakInstalledRef]
 
@@ -1528,12 +1636,12 @@ flatpak_installation_list_installed_refs
 
 
 flatpak_installation_list_installed_refs_by_kind ()
-GPtrArray *
+GPtrArray *
 flatpak_installation_list_installed_refs_by_kind
                                (FlatpakInstallation *self,
                                 FlatpakRefKind kind,
-                                GCancellable *cancellable,
-                                GError **error);
+                                GCancellable *cancellable,
+                                GError **error);
 Lists the installed references of a specific kind.
 
 Parameters
@@ -1556,12 +1664,12 @@ flatpak_installation_list_installed_refs_by_kind
 
 
 cancellable
-a GCancellable. 
+a GCancellable. 
 [nullable]
 
 
 error
-return location for a GError
+return location for a GError
  
 
 
@@ -1569,7 +1677,7 @@ flatpak_installation_list_installed_refs_by_kind
 
 
 Returns
-an GPtrArray of
+
a GPtrArray of
 FlatpakInstalledRef instances. 
 [transfer container][element-type FlatpakInstalledRef]
 
@@ -1577,11 +1685,11 @@ flatpak_installation_list_installed_refs_by_kind
 
 
 flatpak_installation_list_installed_refs_for_update ()
-GPtrArray *
+GPtrArray *
 flatpak_installation_list_installed_refs_for_update
                                (FlatpakInstallation *self,
-                                GCancellable *cancellable,
-                                GError **error);
+                                GCancellable *cancellable,
+                                GError **error);
 Lists the installed references that has a remote update that is not
 locally available. However, even though an app is not returned by this
 it can have local updates available that has not been deployed. Look
@@ -1602,12 +1710,12 @@ at commit vs latest_commit on installed apps for this.
 
 
 cancellable
-a GCancellable. 
+a GCancellable. 
 [nullable]
 
 
 error
-return location for a GError
+return location for a GError
  
 
 
@@ -1615,21 +1723,21 @@ at commit vs latest_commit on installed apps for this.
 
 
 Returns
-an GPtrArray of
-FlatpakInstalledRef instances. 
+a GPtrArray of
+FlatpakInstalledRef instances, or NULL on error. 
 [transfer container][element-type FlatpakInstalledRef]
 
 
 
 
 flatpak_installation_list_installed_related_refs_sync ()
-GPtrArray *
+GPtrArray *
 flatpak_installation_list_installed_related_refs_sync
                                (FlatpakInstallation *self,
                                 const char *remote_name,
                                 const char *ref,
-                                GCancellable *cancellable,
-                                GError **error);
+                                GCancellable *cancellable,
+                                GError **error);
 Lists all the locally installed refs from remote_name
  that are
 related to ref
@@ -1668,12 +1776,12 @@ FLATPAK_UPDATE_FLAGS_NO_PULL to install previously pulled refs.
 
 
 cancellable
-a GCancellable. 
+a GCancellable. 
 [nullable]
 
 
 error
-return location for a GError
+return location for a GError
  
 
 
@@ -1681,7 +1789,7 @@ FLATPAK_UPDATE_FLAGS_NO_PULL to install previously pulled refs.
 
 
 Returns
-an GPtrArray of
+
a GPtrArray of
 FlatpakRelatedRef instances. 
 [transfer container][element-type FlatpakRelatedRef]
 
@@ -1690,12 +1798,12 @@ FLATPAK_UPDATE_FLAGS_NO_PULL to install previously pulled refs.
 
 
 flatpak_installation_list_remote_refs_sync ()
-GPtrArray *
+GPtrArray *
 flatpak_installation_list_remote_refs_sync
                                (FlatpakInstallation *self,
-                                const char *remote_name,
-                                GCancellable *cancellable,
-                                GError **error);
+                                const char *remote_or_uri,
+                                GCancellable *cancellable,
+                                GError **error);
 Lists all the applications and runtimes in a remote.
 
 Parameters
@@ -1712,18 +1820,18 @@ flatpak_installation_list_remote_refs_sync
  
 
 
-remote_name
-the name of the remote
+remote_or_uri
+the name or URI of the remote
  
 
 
 cancellable
-a GCancellable. 
+a GCancellable. 
 [nullable]
 
 
 error
-return location for a GError
+return location for a GError
  
 
 
@@ -1731,21 +1839,78 @@ flatpak_installation_list_remote_refs_sync
 
 
 Returns
-an GPtrArray of
+
a GPtrArray of
 FlatpakRemoteRef instances. 
 [transfer container][element-type FlatpakRemoteRef]
 
 
 
 
+flatpak_installation_list_remotes_by_type ()
+GPtrArray *
+flatpak_installation_list_remotes_by_type
+                               (FlatpakInstallation *self,
+                                const FlatpakRemoteType types[],
+                                gsize num_types,
+                                GCancellable *cancellable,
+                                GError **error);
+Lists only the remotes whose type is included in the types
+ argument.
+
+Parameters
+
+++++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+



self a FlatpakInstallation  
types an array of FlatpakRemoteType. [array length=num_types]
num_types the number of types provided in types
+  
cancellable a GCancellable. [nullable]
error return location for a GError  
+
+
+Returns
+a GPtrArray of
+FlatpakRemote instances. 
+[transfer container][element-type FlatpakRemote]
+
+
+
+
 flatpak_installation_list_remote_related_refs_sync ()
-GPtrArray *
+GPtrArray *
 flatpak_installation_list_remote_related_refs_sync
                                (FlatpakInstallation *self,
                                 const char *remote_name,
                                 const char *ref,
-                                GCancellable *cancellable,
-                                GError **error);
+                                GCancellable *cancellable,
+                                GError **error);
 Lists all the available refs on remote_name
  that are related to
 ref
@@ -1759,6 +1924,8 @@ everyone should always be installed. For example,
 reference should be installed/updated with the app, and
 flatpak_related_ref_should_delete() returns TRUE if it
 should be uninstalled with the main ref.
+The commit property of each FlatpakRelatedRef is not guaranteed to be
+non-NULL.
 
 Parameters
 
@@ -1785,12 +1952,12 @@ should be uninstalled with the main ref.
-
+
-
+
@@ -1798,7 +1965,7 @@ should be uninstalled with the main ref.

 Returns
-an GPtrArray of
+
a GPtrArray of
 FlatpakRelatedRef instances. 
 [transfer container][element-type FlatpakRelatedRef]
 
@@ -1807,12 +1974,12 @@ should be uninstalled with the main ref.

 flatpak_installation_list_remotes ()
-GPtrArray *
+GPtrArray *
 flatpak_installation_list_remotes (FlatpakInstallation *self,
-                                   GCancellable *cancellable,
-                                   GError **error);
-Lists the remotes, in priority (highest first) order. For same priority,
-an earlier added remote comes before a later added one.
+                                   GCancellable *cancellable,
+                                   GError **error);
+Lists the static remotes, in priority (highest first) order. For same
+priority, an earlier added remote comes before a later added one.
 
 Parameters
 

 
 
 cancellable a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 
 
 
 
 
@@ -1829,12 +1996,12 @@ an earlier added remote comes before a later added one.
-
+
-
+
@@ -1853,9 +2020,9 @@ an earlier added remote comes before a later added one.
FlatpakRemote *
 flatpak_installation_get_remote_by_name
                                (FlatpakInstallation *self,
-                                const gchar *name,
-                                GCancellable *cancellable,
-                                GError **error);
+                                const gchar *name,
+                                GCancellable *cancellable,
+                                GError **error);Looks up a remote by name.

 Parameters
@@ -1878,12 +2045,12 @@ flatpak_installation_get_remote_by_name
 
 
-
+
-
+
@@ -1891,21 +2058,23 @@ flatpak_installation_get_remote_by_name
 
 Returns
-a FlatpakRemote instances, or NULL error. 
+a FlatpakRemote instances, or NULL error. 
 [transfer full]
 

 flatpak_installation_fetch_remote_metadata_sync ()
-GBytes *
+GBytes *
 flatpak_installation_fetch_remote_metadata_sync
                                (FlatpakInstallation *self,
                                 const char *remote_name,
                                 FlatpakRef *ref,
-                                GCancellable *cancellable,
-                                GError **error);
+                                GCancellable *cancellable,
+                                GError **error);
 Obtains the metadata file from a commit.
+NOTE: Since 0.11.4 this information is accessible in FlatpakRemoteRef, so this
+function is not very useful anymore.
 
 Parameters
 

 
 
 cancellable a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 
 
 
 
 cancellable a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 
 
 
 
 
@@ -1932,12 +2101,12 @@ flatpak_installation_fetch_remote_metadata_sync
 
-
+
-
+
@@ -1945,8 +2114,8 @@ flatpak_installation_fetch_remote_metadata_sync
 
 Returns
-a GBytes containing the flatpak metadata file,
-or NULL if an error occurred. 
+a GBytes containing the flatpak metadata file,
+or NULL if an error occurred. 
 [transfer full]
 
@@ -1961,8 +2130,8 @@ flatpak_installation_fetch_remote_ref_sync
                                 const char *name,
                                 const char *arch,
                                 const char *branch,
-                                GCancellable *cancellable,
-                                GError **error);
+                                GCancellable *cancellable,
+                                GError **error);Gets the current remote branch of a ref in the remote.

 Parameters
@@ -2005,12 +2174,12 @@ flatpak_installation_fetch_remote_ref_sync
 
 
-
+
-
+
@@ -2018,28 +2187,30 @@ flatpak_installation_fetch_remote_ref_sync
 
 Returns
-a FlatpakRemoteRef instance, or NULL. 
+a FlatpakRemoteRef instance, or NULL. 
 [transfer full]
 

 flatpak_installation_fetch_remote_size_sync ()
-gboolean
+gboolean
 flatpak_installation_fetch_remote_size_sync
                                (FlatpakInstallation *self,
                                 const char *remote_name,
                                 FlatpakRef *ref,
-                                guint64 *download_size,
-                                guint64 *installed_size,
-                                GCancellable *cancellable,
-                                GError **error);
+                                guint64 *download_size,
+                                guint64 *installed_size,
+                                GCancellable *cancellable,
+                                GError **error);
 Gets information about the maximum amount of data that needs to be transferred
 to pull the ref from a remote repository, and about the amount of
 local disk space that is required to check out this commit.
 Note that if there are locally available data that are in the ref, which is common
 for instance if you're doing an update then the real download size may be smaller
 than what is returned here.
+NOTE: Since 0.11.4 this information is accessible in FlatpakRemoteRef, so this
+function is not very useful anymore.
 
 Parameters
 

 
 cancellable a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 
 
 
 
 
 cancellable a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 
 
 
 
 
@@ -2076,12 +2247,12 @@ than what is returned here.
-
+
-
+
@@ -2089,7 +2260,7 @@ than what is returned here.

 Returns
- TRUE, unless an error occurred
+ TRUE, unless an error occurred
 

@@ -2099,8 +2270,8 @@ than what is returned here.
 flatpak_installation_load_app_overrides
                                (FlatpakInstallation *self,
                                 const char *app_id,
-                                GCancellable *cancellable,
-                                GError **error);
+                                GCancellable *cancellable,
+                                GError **error);Loads the metadata overrides file for an application.

 Parameters
@@ -2123,12 +2294,12 @@ flatpak_installation_load_app_overrides
 
 
-
+
-
+
@@ -2137,21 +2308,21 @@ flatpak_installation_load_app_overrides
 
 Returns
 the contents of the overrides files,
-or NULL if an error occurred. 
+or NULL if an error occurred. 
 [transfer full]
 

 flatpak_installation_update_appstream_sync ()
-gboolean
+gboolean
 flatpak_installation_update_appstream_sync
                                (FlatpakInstallation *self,
                                 const char *remote_name,
                                 const char *arch,
-                                gboolean *out_changed,
-                                GCancellable *cancellable,
-                                GError **error);
+                                gboolean *out_changed,
+                                GCancellable *cancellable,
+                                GError **error);
 Updates the local copy of appstream for remote_name
  for the specified arch
 .
@@ -2177,22 +2348,22 @@ If you need progress feedback, use 
arch

-

+
-
+
-
+
-
+
@@ -2200,7 +2371,7 @@ If you need progress feedback, use 
 Returns
- TRUE on success, or FALSE on error
+ TRUE on success, or FALSE on error

@@ -2208,11 +2379,11 @@ If you need progress feedback, use flatpak_installation_install_bundle ()
FlatpakInstalledRef *
 flatpak_installation_install_bundle (FlatpakInstallation *self,
-                                     GFile *file,
+                                     GFile *file,
                                      FlatpakProgressCallback progress,
-                                     gpointer progress_data,
-                                     GCancellable *cancellable,
-                                     GError **error);
+                                     gpointer progress_data,
+                                     GCancellable *cancellable,
+                                     GError **error);Install an application or runtime from an flatpak bundle file.
 See flatpak-build-bundle(1) for how to create bundles.

@@ -2231,7 +2402,7 @@ See flatpak-build-bundle(1) for how to create bundles.
 
 
-
+
@@ -2247,12 +2418,12 @@ See flatpak-build-bundle(1) for how to create bundles.
-
+
-
+
@@ -2260,7 +2431,7 @@ See flatpak-build-bundle(1) for how to create bundles.

 Returns
-The ref for the newly installed app or NULL on failure. 
+The ref for the newly installed app or NULL on failure. 
 [transfer full]
 
@@ -2269,14 +2440,14 @@ See flatpak-build-bundle(1) for how to create bundles.
flatpak_installation_install_ref_file ()
FlatpakRemoteRef *
 flatpak_installation_install_ref_file (FlatpakInstallation *self,
-                                       GBytes *ref_file_data,
-                                       GCancellable *cancellable,
-                                       GError **error);
+                                       GBytes *ref_file_data,
+                                       GCancellable *cancellable,
+                                       GError **error);Creates a remote based on the passed in .flatpakref file contents
 in ref_file_data
  and returns the FlatpakRemoteRef that can be used
 to install it.
-Note, the FlatpakRemoteRef will not have the commit field set, to
+
Note, the FlatpakRemoteRef will not have the commit field set, or other details, to
 avoid unnecessary roundtrips. If you need that you have to resolve it
 explicitly with flatpak_installation_fetch_remote_ref_sync().

@@ -2300,12 +2471,12 @@ explicitly with cancellable
-

+
-
+
@@ -2313,7 +2484,7 @@ explicitly with 
 Returns
-a FlatpakRemoteRef if the remote has been added successfully, NULL
+
a FlatpakRemoteRef if the remote has been added successfully, NULL
 on error. 
[transfer full]
@@ -2322,10 +2493,10 @@ on error. 

 flatpak_installation_drop_caches ()
-gboolean
+gboolean
 flatpak_installation_drop_caches (FlatpakInstallation *self,
-                                  GCancellable *cancellable,
-                                  GError **error);
+                                  GCancellable *cancellable,
+                                  GError **error);
 Drops all internal (in-memory) caches. For instance, this may be needed to pick up new or changed
 remotes configured outside this installation instance.
 
@@ -2344,12 +2515,12 @@ remotes configured outside this installation instance.
 
 
-
+
-
+
@@ -2357,17 +2528,17 @@ remotes configured outside this installation instance.

 Returns
- TRUE on success, FALSE on error
+ TRUE on success, FALSE on error
 

 flatpak_installation_modify_remote ()
-gboolean
+gboolean
 flatpak_installation_modify_remote (FlatpakInstallation *self,
                                     FlatpakRemote *remote,
-                                    GCancellable *cancellable,
-                                    GError **error);
+                                    GCancellable *cancellable,
+                                    GError **error);
 Saves changes in the remote
  object.
 
@@ -2391,12 +2562,12 @@ flatpak_installation_modify_remote (
 

-
+
-
+
@@ -2404,17 +2575,17 @@ flatpak_installation_modify_remote (
 
 Returns
- TRUE if the modifications have been committed successfully
+ TRUE if the modifications have been committed successfully
 
 
 
 
 flatpak_installation_remove_remote ()
-gboolean
+gboolean
 flatpak_installation_remove_remote (FlatpakInstallation *self,
                                     const char *name,
-                                    GCancellable *cancellable,
-                                    GError **error);
+                                    GCancellable *cancellable,
+                                    GError **error);
 Removes the remote with the given name from the installation.
 
 Parameters
@@ -2437,12 +2608,12 @@ flatpak_installation_remove_remote (
 
-
+
-
+
@@ -2450,18 +2621,18 @@ flatpak_installation_remove_remote (
 
 Returns
- TRUE if the remote has been removed successfully
+ TRUE if the remote has been removed successfully
 
 
 
 
 flatpak_installation_update_remote_sync ()
-gboolean
+gboolean
 flatpak_installation_update_remote_sync
                                (FlatpakInstallation *self,
                                 const char *name,
-                                GCancellable *cancellable,
-                                GError **error);
+                                GCancellable *cancellable,
+                                GError **error);
 Updates the local configuration of a remote repository by fetching
 the related information from the summary file in the remote OSTree
 repository and committing the changes to the local installation.
@@ -2486,12 +2657,12 @@ repository and committing the changes to the local installation.
 
 
-
+
-
+
@@ -2499,18 +2670,18 @@ repository and committing the changes to the local installation.
 
 
 Returns
- TRUE if the remote has been updated successfully
+ TRUE if the remote has been updated successfully
 
 Since: 0.6.13
 
 
 
 flatpak_installation_cleanup_local_refs_sync ()
-gboolean
+gboolean
 flatpak_installation_cleanup_local_refs_sync
                                (FlatpakInstallation *self,
-                                GCancellable *cancellable,
-                                GError **error);
+                                GCancellable *cancellable,
+                                GError **error);
 Remove all OSTree refs from the local flatpak repository which are not
 in a deployed state. The next time the underlying OSTree repo is pruned,
 objects which were attached to that ref will be removed. This is useful if
@@ -2537,12 +2708,12 @@ referred to by ref
 
 
-
+
-
+
@@ -2550,7 +2721,7 @@ referred to by ref
 
 
 Returns
- TRUE on success
+ TRUE on success
 
 Since: 0.10.0
 
@@ -2560,8 +2731,8 @@ referred to by ref
 char *
 flatpak_installation_get_config (FlatpakInstallation *self,
                                  const char *key,
-                                 GCancellable *cancellable,
-                                 GError **error);
+                                 GCancellable *cancellable,
+                                 GError **error);
 Get a global configuration option for the remote, see
 flatpak_installation_set_config_sync() for supported keys.
 
@@ -2585,12 +2756,12 @@ flatpak_installation_get_config (
 
-
+
-
+
@@ -2598,16 +2769,16 @@ flatpak_installation_get_config (
 
 Returns
- The (newly allocated) value, or NULL on error (G_KEY_FILE_ERROR_KEY_NOT_FOUND error if key is not set)
+ The (newly allocated) value, or NULL on error (G_KEY_FILE_ERROR_KEY_NOT_FOUND error if key is not set)
 
 
 
 
 flatpak_installation_prune_local_repo ()
-gboolean
+gboolean
 flatpak_installation_prune_local_repo (FlatpakInstallation *self,
-                                       GCancellable *cancellable,
-                                       GError **error);
+                                       GCancellable *cancellable,
+                                       GError **error);
 Remove all orphaned OSTree objects from the underlying OSTree repo in
 installation
 .
@@ -2627,12 +2798,12 @@ flatpak_installation_prune_local_repo (cancellable
-
+
-
+
@@ -2640,19 +2811,19 @@ flatpak_installation_prune_local_repo (
 Returns
- TRUE on success
+ TRUE on success
 
 
 
 
 flatpak_installation_remove_local_ref_sync ()
-gboolean
+gboolean
 flatpak_installation_remove_local_ref_sync
                                (FlatpakInstallation *self,
                                 const char *remote_name,
                                 const char *ref,
-                                GCancellable *cancellable,
-                                GError **error);
+                                GCancellable *cancellable,
+                                GError **error);
 Remove the OSTree ref given by remote_name
 :ref
  from the local flatpak
@@ -2691,12 +2862,12 @@ referred to by ref
 
 
-
+
-
+
@@ -2704,18 +2875,18 @@ referred to by ref
 
 
 Returns
- TRUE on success
+ TRUE on success
 
 
 
 
 flatpak_installation_set_config_sync ()
-gboolean
+gboolean
 flatpak_installation_set_config_sync (FlatpakInstallation *self,
                                       const char *key,
                                       const char *value,
-                                      GCancellable *cancellable,
-                                      GError **error);
+                                      GCancellable *cancellable,
+                                      GError **error);
 Set a global configuration option for the installation, currently
 the only supported key is "languages", which is a comman-separated
 list of langue codes like "sv;en;pl", or "" to mean all languages.
@@ -2740,17 +2911,17 @@ list of langue codes like "sv;en;pl", or "" to mean all languages.
 
 
-
+
-
+
-
+
@@ -2758,22 +2929,22 @@ list of langue codes like "sv;en;pl", or "" to mean all languages.
 
 
 Returns
- TRUE if the option was set correctly
+ TRUE if the option was set correctly
 
 
 
 
 flatpak_installation_update_appstream_full_sync ()
-gboolean
+gboolean
 flatpak_installation_update_appstream_full_sync
                                (FlatpakInstallation *self,
                                 const char *remote_name,
                                 const char *arch,
                                 FlatpakProgressCallback progress,
-                                gpointer progress_data,
-                                gboolean *out_changed,
-                                GCancellable *cancellable,
-                                GError **error);
+                                gpointer progress_data,
+                                gboolean *out_changed,
+                                GCancellable *cancellable,
+                                GError **error);
 Updates the local copy of appstream for remote_name
  for the specified arch
 .
@@ -2798,7 +2969,7 @@ flatpak_installation_update_appstream_full_sync
 
 
-
+
@@ -2814,17 +2985,17 @@ flatpak_installation_update_appstream_full_sync
 
-
+
-
+
-
+
@@ -2832,7 +3003,7 @@ flatpak_installation_update_appstream_full_sync
 
 
 Returns
- TRUE on success, or FALSE on error
+ TRUE on success, or FALSE on error
 
 
 
@@ -2861,9 +3032,9 @@ on the current machine, in order of priority (default is first).
 
 
 flatpak_get_system_installations ()
-GPtrArray *
-flatpak_get_system_installations (GCancellable *cancellable,
-                                  GError **error);
+GPtrArray *
+flatpak_get_system_installations (GCancellable *cancellable,
+                                  GError **error);
 Lists the system installations according to the current configuration and current
 availability (e.g. doesn't return a configured installation if not reachable).
 
@@ -2877,12 +3048,12 @@ availability (e.g. doesn't return a configured installation if not reachable).
 
-
+
-
+
@@ -2890,7 +3061,7 @@ availability (e.g. doesn't return a configured installation if not reachable).
 
 Returns
-an GPtrArray of
+
a GPtrArray of
 FlatpakInstallation instances. 
 [transfer container][element-type FlatpakInstallation]
 
@@ -2901,9 +3072,9 @@ availability (e.g. doesn't return a configured installation if not reachable).FlatpakProgressCallback ()
 void
 (*FlatpakProgressCallback) (const char *status,
-                            guint progress,
-                            gboolean estimating,
-                            gpointer user_data);
+                            guint progress,
+                            gboolean estimating,
+                            gpointer user_data);
 The progress callback is called repeatedly during long-running operations
 such as installations or updates, and can be used to update progress information
 in a user interface.
@@ -2985,8 +3156,17 @@ is just an estimate
 
 
-
-
+
+
+
+
+
+
+
 
 
 cancellable a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 
 
 
 
 
 
 
 cancellable a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 
 
 
 Architecture to update, or NULL for the local machine arch Architecture to update, or NULL for the local machine arch
  
 
 
 out_changed Set to TRUE if the contents of the appstream changed, FALSE if nothing changed. Set to TRUE if the contents of the appstream changed, FALSE if nothing changed. 
 [nullable]
 
 
 cancellable a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 
 
 
 
 
 
 
 file a GFile that is an flatpak bundle a GFile that is an flatpak bundle
  
 
 
 
 
 cancellable a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 
 
 
 
 
 
 
 a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 
 
 
 
 
 cancellable a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 
 
 
 
 
 
 cancellable a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 

 cancellable a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 

 cancellable a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 

 cancellable a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 

 cancellable a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 
a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 

 cancellable a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 

 value the new value, or NULL to unset the new value, or NULL to unset
  
 
 
 cancellable a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 

 arch Architecture to update, or NULL for the local machine arch Architecture to update, or NULL for the local machine arch
  
 
 
 
 out_changed Set to TRUE if the contents of the appstream changed, FALSE if nothing changed. Set to TRUE if the contents of the appstream changed, FALSE if nothing changed. 
 [nullable]
 
 
 cancellable a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 

 cancellable a GCancellable. a GCancellable. 
 [nullable]
 
 
 error return location for a GError return location for a GError
  
 
 

 FLATPAK_UPDATE_FLAGS_NO_STATIC_DELTAS     
+Don't use static deltas when pulling
+  
FLATPAK_UPDATE_FLAGS_NO_PRUNE 
+Don't prune the local OSTree repository after updating (Since: 0.11.8)
+  
 
 
 

@@ -3014,22 +3194,60 @@ is just an estimate
 
 
 FLATPAK_INSTALL_FLAGS_NO_STATIC_DELTAS
- 
- 
+
+Don't use static deltas when pulling
+
+ 
 
 
 FLATPAK_INSTALL_FLAGS_NO_DEPLOY
- 
- 
+
+Don't install any new builds that might be fetched
+
+ 
 
 
 FLATPAK_INSTALL_FLAGS_NO_PULL
- 
- 
+
+Don't try to fetch new builds from the remote repo
+
+ 
+
+
+

+

+

+FlatpakBundleRef * +	+flatpak_bundle_ref_new () +
+GFile * +	+flatpak_bundle_ref_get_file () +
+GBytes * +	+flatpak_bundle_ref_get_metadata () +
+GBytes * +	+flatpak_bundle_ref_get_appstream () +
+GBytes * +	+flatpak_bundle_ref_get_icon () +
+char * +	+flatpak_bundle_ref_get_origin () +
+guint64 +	+flatpak_bundle_ref_get_installed_size () +
+char * +	+flatpak_bundle_ref_get_runtime_repo_url () +

FLATPAK_UNINSTALL_FLAGS_NONE	+ Default +
FLATPAK_UNINSTALL_FLAGS_NO_PRUNE	+ Don't prune the local OSTree repository after uninstalling +

+FlatpakRelatedRef * +	+flatpak_related_ref_new () +
const char * const * +	+flatpak_related_ref_get_subpaths () +
+gboolean +	+flatpak_related_ref_should_download () +
+gboolean +	+flatpak_related_ref_should_delete () +
+gboolean +	+flatpak_related_ref_should_autoprune () +

gboolean	should-autoprune	Read / Write / Construct Only
gboolean	should-delete	Read / Write / Construct Only
gboolean	should-download	Read / Write / Construct Only
GStrv	subpaths	Read / Write / Construct Only

FLATPAK_REMOTE_TYPE_STATIC			+ Statically configured remote +
FLATPAK_REMOTE_TYPE_USB			+ Dynamically detected local pathname remote +
FLATPAK_REMOTE_TYPE_LAN			+ Dynamically detected network remote +

self	a FlatpakInstallation
flags	set of FlatpakUninstallFlags flags
kind	what this ref contains (an FlatpakRefKind)
name	name of the app or runtime to uninstall
arch	architecture of the app or runtime to uninstall; if +`NULL`, `flatpak_get_default_arch()` is assumed.	[nullable]
branch	name of the branch of the app or runtime to uninstall; +if `NULL`, `master` is assumed.	[nullable]
progress	the callback.	[scope call][nullable]
progress_data	user data passed to `progress` +.	[closure progress][nullable]
cancellable	a GCancellable.	[nullable]
error	return location for a GError

self	a FlatpakInstallation
types	an array of FlatpakRemoteType.	[array length=num_types]
num_types	the number of types provided in `types` +
cancellable	a GCancellable.	[nullable]
error	return location for a GError

+FlatpakTransaction * +	+flatpak_transaction_new_for_installation () +
+gboolean +	+flatpak_transaction_add_install () +
+gboolean +	+flatpak_transaction_add_install_bundle () +
+gboolean +	+flatpak_transaction_add_install_flatpakref () +
+gboolean +	+flatpak_transaction_add_update () +
+gboolean +	+flatpak_transaction_add_uninstall () +
+void +	+flatpak_transaction_add_default_dependency_sources () +
+void +	+flatpak_transaction_add_dependency_source () +
+gboolean +	+flatpak_transaction_run () +
+FlatpakTransactionOperation * +	+flatpak_transaction_get_current_operation () +
+FlatpakInstallation * +	+flatpak_transaction_get_installation () +
+GList * +	+flatpak_transaction_get_operations () +
+gboolean +	+flatpak_transaction_is_empty () +
+void +	+flatpak_transaction_set_disable_dependencies () +
+void +	+flatpak_transaction_set_disable_prune () +
+void +	+flatpak_transaction_set_disable_related () +
+void +	+flatpak_transaction_set_disable_static_deltas () +
+void +	+flatpak_transaction_set_no_deploy () +
+void +	+flatpak_transaction_set_no_pull () +
+void +	+flatpak_transaction_set_reinstall () +
+void +	+flatpak_transaction_set_force_uninstall () +
+void +	+flatpak_transaction_set_default_arch () +

gboolean	add-new-remote	Run Last
gint	choose-remote-for-ref	Run Last
void	end-of-lifed	Run Last
void	new-operation	Run Last
void	operation-done	Run Last
gboolean	operation-error	Run Last
gboolean	ready	Run Last

	FlatpakTransaction
enum	FlatpakTransactionOperationType
enum	FlatpakTransactionErrorDetails
enum	FlatpakTransactionRemoteReason
enum	FlatpakTransactionResult

installation	a FlatpakInstallation
cancellable	a GCancellable.	[nullable]
error	return location for a GError

self	a FlatpakTransaction
remote	the name of the remote
ref	the ref
subpaths	subpaths to install, or the +empty list or `NULL` to pull all subpaths.	[nullable][array zero-terminated=1]
error	return location for a GError

self	a FlatpakTransaction
file	a GFile that is an flatpak bundle
gpg_data	GPG key with which to check bundle signatures, or +`NULL` to use the key embedded in the bundle (if any).	[nullable]
error	return location for a GError

FLATPAK_TRANSACTION_OPERATION_INSTALL	+ Install a ref from a remote +
FLATPAK_TRANSACTION_OPERATION_UPDATE	+ Update an installed ref +
FLATPAK_TRANSACTION_OPERATION_INSTALL_BUNDLE	+ Install a bundle from a file +
FLATPAK_TRANSACTION_OPERATION_UNINSTALL	+ Uninstall a ref +
FLATPAK_TRANSACTION_OPERATION_LAST_TYPE	+ The (currently) last operation type +

FLATPAK_TRANSACTION_REMOTE_GENERIC_REPO	+ The remote specified in the flatpakref has other apps too +
FLATPAK_TRANSACTION_REMOTE_RUNTIME_DEPS	+ The remote has runtimes needed for the app +

self	a FlatpakBundleRef
size	64 or 128

object	A FlatpakTransaction
reason	A FlatpakTransactionRemoteReason for this suggestion
from_id	The id of the app/runtime
suggested_remote_name	The suggested remote name
url	The repo url
user_data	user data set when the signal handler was connected.

object	A FlatpakTransaction
for_ref	The ref we are installing
runtime_ref	The ref we are looking for
remotes	the remotes that has the ref, sorted in prio order
user_data	user data set when the signal handler was connected.

object	A FlatpakTransaction
operation	The new FlatpakTransactionOperation
progress	A FlatpakTransactionProgress for `operation` +
user_data	user data set when the signal handler was connected.

+GFile * +	+flatpak_transaction_operation_get_bundle_path () +
const char * +	+flatpak_transaction_operation_get_commit () +
+FlatpakTransactionOperationType +	+flatpak_transaction_operation_get_operation_type () +
const char * +	+flatpak_transaction_operation_get_ref () +
const char * +	+flatpak_transaction_operation_get_remote () +
+GKeyFile * +	+flatpak_transaction_operation_get_metadata () +
+GKeyFile * +	+flatpak_transaction_operation_get_old_metadata () +
const char * +	+flatpak_transaction_operation_type_to_string () +

+gboolean +	+flatpak_transaction_progress_get_is_estimating () +
+int +	+flatpak_transaction_progress_get_progress () +
+char * +	+flatpak_transaction_progress_get_status () +
+void +	+flatpak_transaction_progress_set_update_frequency () +

object	A FlatpakTransactionProgress
user_data	user data set when the signal handler was connected.

FLATPAK_PORTAL_ERROR_FAILED	+ General portal failure +
FLATPAK_PORTAL_ERROR_INVALID_ARGUMENT	+ An argument was invalid +
FLATPAK_PORTAL_ERROR_NOT_FOUND	+ The object was not fount +
FLATPAK_PORTAL_ERROR_EXISTS	+ The object already exists +
FLATPAK_PORTAL_ERROR_NOT_ALLOWED	+ The call was not allowed +
FLATPAK_PORTAL_ERROR_CANCELLED	+ The call was cancelled by the user +
FLATPAK_PORTAL_ERROR_WINDOW_DESTROYED	+ The window was destroyed by the user +

-FlatpakBundleRef * -	-flatpak_bundle_ref_new () -
-GFile * -	-flatpak_bundle_ref_get_file () -
-GBytes * -	-flatpak_bundle_ref_get_metadata () -
-GBytes * -	-flatpak_bundle_ref_get_appstream () -
-GBytes * -	-flatpak_bundle_ref_get_icon () -
-char * -	-flatpak_bundle_ref_get_origin () -
-guint64 -	-flatpak_bundle_ref_get_installed_size () -
-char * -	-flatpak_bundle_ref_get_runtime_repo_url () -

Flatpak Command Reference

Flatpak Command Reference

Important

Executables

Name

Synopsis

Description

Executables

Name

Synopsis

Description

Options

Options

Commands

Commands

Environment

File formats

Environment

See also

See also

Commands

Name

Synopsis

Description

Commands

Name

Synopsis

Description

Options

Options

See also

Examples

See also

Name

Synopsis

Description

Name

Synopsis

Description

Options

Options

Examples

See also

Examples

See also

Name

Synopsis

Description

Name

Synopsis

Description

Options

Options

Examples

Examples

See also

See also

Name

Synopsis

Description

Name

Synopsis

Description

Options

Options

Examples

Examples

See also

See also

Name

Synopsis

Description

Name

Synopsis

Description

Options

Options

See also

See also

Name