From bf8a33cda04da04a72b1083ba3a91cafa155a62e Mon Sep 17 00:00:00 2001 From: Matthew Leeds Date: Sun, 1 Apr 2018 22:45:49 -0700 Subject: [PATCH] Update docs to v0.11.3 --- flatpak-docs.html | 3677 ++++++++++------- reference/html/FlatpakInstallation.html | 1943 +++++++-- reference/html/FlatpakInstalledRef.html | 92 +- reference/html/FlatpakRef.html | 111 +- reference/html/FlatpakRemote.html | 437 +- reference/html/FlatpakRemoteRef.html | 26 +- reference/html/annotation-glossary.html | 13 +- reference/html/ch01.html | 9 +- reference/html/flatpak-Error-codes.html | 24 +- .../html/flatpak-Version-information.html | 32 +- .../html/flatpak-flatpak-bundle-ref.html | 85 +- reference/html/flatpak.devhelp2 | 56 + reference/html/full-api-index.html | 176 +- reference/html/index.html | 11 +- reference/html/object-tree.html | 9 +- 15 files changed, 4628 insertions(+), 2073 deletions(-) diff --git a/flatpak-docs.html b/flatpak-docs.html index b24ad2aa..dcdc02c8 100644 --- a/flatpak-docs.html +++ b/flatpak-docs.html @@ -1,995 +1,330 @@ -Flatpak Command Reference

Flatpak Command Reference

Version 0.6.13

+Flatpak Command Reference

Flatpak Command Reference

Version 0.11.3

Flatpak comes with a rich commandline interface. -

Table of Contents

flatpak install — Install an application or runtime
flatpak update — Update an application or runtime
flatpak uninstall — Uninstall an application or runtime
flatpak list — List installed applications and/or runtimes
flatpak info — Show information about installed application and/or runtime
flatpak run — Run an application
flatpak override — Override application requirements
flatpak enter — Enter an application
flatpak document-export — Export a file to a sandboxed application
flatpak document-unexport — Stop exporting a file
flatpak document-info — Show information about exported files
flatpak document-list — List exported files
flatpak remote-add — Add a remote repository
flatpak remote-modify — Modify a remote repository
flatpak remote-delete — Delete a remote repository
flatpak remote-list — List remote repositories
flatpak remote-ls — Show available runtimes and applications
flatpak build-init — Initialize a build directory
flatpak build — Build in a directory
flatpak build-finish — Finalize a build directory
flatpak build-export — Create a repository from a build directory
flatpak build-bundle — Create a single-file bundle from a local repository
flatpak build-import-bundle — Import a file bundle into a local repository
flatpak build-update-repo — Create a repository from a build directory
flatpak build-sign — Sign an application or runtime
flatpak-builder — Help build application dependencies
flatpak metadata — Information about an application or runtime
flatpakrepo — Reference to a remote
flatpakref — Reference to a remote for an application or runtime
flatpak make-current — Make a specific version of an app current

Name

flatpak-install — Install an application or runtime

Synopsis

flatpak install [OPTION...] REMOTE REF...

flatpak install [OPTION...] [ --bundle | --from ] FILENAME

Description

- Installs an application or runtime. REMOTE must name - an existing remote and REF is a reference to the - application or runtime to install. +

Table of Contents

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

+ flatpak is a tool for managing applications and the runtimes + they use. In the flatpak model, applications can be built and + distributed independently from the host system they are used + on, and they are isolated from the host system ('sandboxed') + to some degree, at runtime.

- Each REF arguments is a full or partial indentifier in the - flatpak ref format, which looks like "(app|runtime)/ID/ARCH/BRANCH". All elements - except ID are optional and can be left out, including the slashes, - so most of the time you need only specify ID. Any part left out will be matched - against what is in the remote, and if there are multiple matches an error message - will list the alternatives. + flatpak can operate in system-wide or per-user mode. The system-wide + data (runtimes, applications and configuration) is located in + $prefix/var/lib/flatpak/, and the per-user + data is in $HOME/.local/share/flatpak/. + Below these locations, there is a local repository in the + repo/ subdirectory and installed runtimes + and applications are in the corresponding runtime/ + and app/ subdirectories.

- By default this looks for both apps and runtime with the given REF in - the specified REMOTE , but you can limit this by using the --app or - --runtime option, or by supplying the initial element in the REF. + System-wide remotes can be statically preconfigured by dropping + config fragments into /etc/flatpak/remotes.d/.

- Note that flatpak allows one to have multiple branches of an application and runtimes - installed and used at the same time. However, only version of an application one can be current, - meaning its exported files (for instance desktop files and icons) are - visible to the host. The last installed version is made current by - default, but you can manually change with make-current. + In addition to the system-wide installation in $prefix/var/lib/flatpak/, + which is always considered the default one unless overridden, more + system-wide installations can be defined via configuration files in + /etc/flatpak/installations.d/, which must define + at least the id of the installation and the absolute path to it. + Other optional parameters like DisplayName , + Priority or StorageType + are also supported.

- Unless overridden with the --user option, this command creates a - system-wide installation. -

- The alternative form of the command installs an application from a - single-file bundle or a flatpakref file instead of a configured remote. - Bundles can be created with the flatpak build-bundle command, flatpakref - files are simple references to a remote repo for an application. -

Options

The following options are understood:

-h, --help

+ flatpak uses OSTree to distribute and deploy data. The repositories + it uses are OSTree repositories and can be manipulated with the + ostree utility. Installed runtimes and + applications are OSTree checkouts. +

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

--ostree-verbose

+ Print OSTree debug information during command processing. +

--version

+ Print version information and exit. +

--default-arch

+ Print the default arch and exit. +

--supported-arches

+ Print the supported arches in priority order and exit. +

--gl-drivers

+ Print the list of active gl drivers and exit. +

Commands

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

flatpak-uninstall(1)

+ Uninstall an installed application or runtime. +

flatpak-list(1)

+ List installed applications and/or runtimes. +

flatpak-info(1)

+ Show information for an installed application or runtime. +

flatpak-config(1)

+ Manage flatpak configuration. +

Commands for finding applications and runtimes:

flatpak-search(1)

+ Search for applications and runtimes. +

Commands for running applications:

flatpak-run(1)

+ Run an application. +

flatpak-override(1)

+ Override permissions for an application. +

flatpak-make-current(1)

+ Specify the default version to run. +

flatpak-enter(1)

+ Enter the namespace of a running application. +

Commands for managing file access:

flatpak-document-export(1)

+ Grant an application access to a specific file. +

flatpak-document-unexport(1)

+ Revoke access to a specific file. +

flatpak-document-info(1)

+ Show information about a specific file. +

flatpak-document-list(1)

+ List exported files. +

Commands for managing remote repositories:

flatpak-remotes(1)

+ List all configured remote repositories. +

flatpak-remote-add(1)

+ Add a new remote repository. +

flatpak-remote-modify(1)

+ Modify properties of a configured remote repository. +

flatpak-remote-delete(1)

+ Delete a configured remote repository. +

flatpak-remote-ls(1)

+ List contents of a configured remote repository. +

flatpak-remote-info(1)

+ Show information about a ref in a configured remote repository. +

Commands for building applications:

flatpak-build-init(1)

+ Initialize a build directory. +

flatpak-build(1)

+ Run a build command in a build directory. +

flatpak-build-finish(1)

+ Finalizes a build directory for export. +

flatpak-build-export(1)

+ Export a build directory to a repository. +

flatpak-build-bundle(1)

+ Create a bundle file from a ref in a local repository. +

flatpak-build-import-bundle(1)

+ Import a file bundle into a local repository. +

flatpak-build-sign(1)

+ Sign an application or runtime after its been exported. +

flatpak-build-update-repo(1)

+ Update the summary file in a repository. +

flatpak-build-commit-from(1)

+ Create a new commit based on an existing ref. +

Environment

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

FLATPAK_USER_DIR

+ The location of the per-user installation. If this is not set, + $XDG_DATA_HOME/flatpak is used. +

FLATPAK_SYSTEM_DIR

+ The location of the default system-wide installation. If this is not set, + /var/lib/flatpak is used (unless overridden at build + time by --localstatedir or --with-system-install-dir). +

FLATPAK_CONFIG_DIR

+ The location of flatpak site configuration. If this is not set, + /etc/flatpak is used (unless overridden at build + time by --sysconfdir). +

See also

+ ostree(1), + ostree.repo(5), + flatpak-remote(5), +

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

+ Creates a single-file named FILENAME + for the application (or runtime) named NAME + in the repository at LOCATION . If + a BRANCH is specified, this branch of + the application is used. + +

+ The format of the bundle file is that of an ostree static delta + (against an empty base) with some flatpak specific metadata for + the application icons and appdata. +

Options

The following options are understood:

-h, --help

Show help options and exit. -

--bundle

- Install from a bundle file instead - of a configured remote. -

--from

- Install from a flatpakref file instead - of a configured remote. -

--user

- Create a per-user installation. -

--system

- Create a system-wide installation. -

--arch=ARCH

- The default architecture to install for, if not given explicitly in the REF . -

--subpath=PATH

- Install only a subpath of the ref. This is mainly used to install a subset of locales. - This can be added multiple times to install multiple subpaths., -

--no-deploy

- Download the latest version, but don't deploy it. -

--no-pull

- Don't download the latest version, deploy whatever is locally available. -

--no-related

- Don't download related extensions, such as the locale data. -

--no-deps

- Don't verify runtime dependencies when installing. -

--app

- Assume that all REF s are apps if not explicitly specified.

--runtime

- Assume that all REF s are runtimes if not explicitly specified. -

-v, --verbose

- Print debug information during command processing. -

--ostree-verbose

- Print OSTree debug information during command processing. -

--version

- Print version information and exit. -

Examples

- $ flatpak --user install test-repo org.gnome.GEdit -

See also

- flatpak(1), - flatpak-update(1), - flatpak-list(1), - flatpak-build-bundle(1), - flatpak-flatpakref(1) -

Name

flatpak-update — Update an application or runtime

Synopsis

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

Description

- Updates applications and runtimes. REF is a reference to the - application or runtime to install. If no REF is given, everything - is updated. -

- Each REF arguments is a full or partial indentifier in the - flatpak ref format, which looks like "(app|runtime)/ID/ARCH/BRANCH". All elements - except ID are optional and can be left out, including the slashes, - so most of the time you need only specify ID. Any part left out will be matched - against what is installed, and if there are multiple matches an error message - will list the alternatives. -

- By default this looks for both apps and runtime with the given REF in - the specified REMOTE , but you can limit this by using the --app or - --runtime option, or by supplying the initial element in the REF. -

- Normally, this command updates the application to the tip - of its branch. But it is possible to check out another commit, - with the --commit option. -

- Note that updating a runtime is different from installing - a different branch, and runtime updates are expected to keep - strict compatibility. If an application update does cause - a problem, it is possible to go back to the previous - version, with the --commit option. -

- Unless overridden with the --user option, this command updates - a system-wide installation. -

Options

The following options are understood:

-h, --help

- Show help options and exit. -

--user

- Update a per-user installation. -

--system

- Update a system-wide installation. + Export a runtime instead of an application.

--arch=ARCH

- The architecture to update for. -

--subpath=PATH

- Install only a subpath of the ref. This is mainly used to install a subset of locales. - This can be added multiple times to install multiple subpaths. - If this is not specified the subpaths specified at install time are reused. -

--commit=COMMIT

- Update to this commit, instead of the tip of the branch. -

--no-deploy

- Download the latest version, but don't deploy it. -

--no-pull

- Don't download the latest version, deploy it whatever is locally available. -

--no-related

- Don't download related extensions, such as the locale data. -

--no-deps

- Don't update or install runtime dependencies when installing. -

--app

- Only look for an app with the given name. -

--appstream

- Update appstream for the remote. -

--runtime

- Only look for an runtime with the given name. -

-v, --verbose

- Print debug information during command processing. -

--ostree-verbose

- Print OSTree debug information during command processing. -

--version

- Print version information and exit. -

Examples

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

See also

- flatpak(1), - flatpak-install(1), - flatpak-list(1) -

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 install. If no REF is given, everything - is updated. -

- Each REF arguments is a full or partial indentifier in the - flatpak ref format, which looks like "(app|runtime)/ID/ARCH/BRANCH". All elements - except ID are optional and can be left out, including the slashes, - so most of the time you need only specify ID. Any part left out will be matched - against what is installed, and if there are multiple matches an error message - will list the alternatives. -

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

- Normally, this command removes the ref for this application/runtime from the - local OSTree repository and purges and objects that are no longer - needed to free up disk space. If the same application is later - reinstalled, the objects will be pulled from the remote repository - again. The --keep-ref option can be used to prevent this. -

- If all branches of the application/runtime are removed, this command - also purges the data directory for the application. -

- Unless overridden with the --user option, this command updates - a system-wide installation. -

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

- Remove a per-user installation. -

--system

- Remove a system-wide installation. -

--arch=ARCH

- The architecture to uninstall, instead of the architecture of - the host system. -

--app

- Only look for an app with the given name. -

--runtime

- Only look for an runtime with the given name. -

--no-related

- Don't uninstall related extensions, such as the locale data. -

-v, --verbose

- Print debug information during command processing. -

--ostree-verbose

- Print OSTree debug information during command processing. -

--version

- Print version information and exit. -

Examples

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

Name

flatpak-list — List installed applications and/or runtimes

Synopsis

flatpak list [OPTION...]

Description

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

- By default, both per-user and system-wide installations - are shown. Use the --user or --system options to change - this. -

- By default this lists the installed apps, but you can - change this by using the --app or --runtime option. -

Options

The following options are understood:

-h, --help

- Show help options and exit. -

--user

- List per-user installations. -

--system

- List system-wide installations. -

--arch=ARCH

- List installations for this architecture. -

--show-details

- Show arches and branches, in addition to the application names. -

--app

- List applications. -

--runtime

- List runtimes. -

-v, --verbose

- Print debug information during command processing. -

--ostree-verbose

- Print OSTree debug information during command processing. -

--version

- Print version information and exit. -

Examples

- $ flatpak --user list - 

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

See also

- flatpak(1), - flatpak-install(1), - flatpak-update(1) -

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

- By default, both per-user and system-wide installations - are queried. Use the --user or --system options to change - this. -

- By default this queries the installed apps and runtimes, but you can - limit this by using the --app or --runtime option. -

Options

The following options are understood:

-h, --help

- Show help options and exit. -

--user

- Query per-user installations. -

--system

- Query system-wide installations. -

--app

- Query for applications. -

--runtime

- Query for runtimes. -

-r, --show-ref

- Show the installed ref. -

-o, --show-origin

- Show the remote the ref is installed from. -

-c, --show-commit

- Show the installed commit id. + The arch to create a bundle for. +

--repo-url=URL

+ The URL for the repository from which the + application can be updated. Installing the + bundle will automatically configure a remote + for this URL. +

--runtime-repo=URL

+ The URL for a .flatpakrepo file that contains + the information about the repository that supplies + the runtimes required by the app. +

--gpg-keys=FILE

+ Add the GPG key from FILE (use - for stdin). +

--gpg-homedir=PATH

+ GPG Homedir to use when looking for keyrings. +

--oci

+ Export to an OCI image instead of a Flatpak bundle.

-v, --verbose

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

See also

- flatpak(1), - flatpak-install(1), - flatpak-update(1) -

Name

flatpak-run — Run an application

Synopsis

flatpak run [OPTION...] APP [ARG...]

Description

- Runs an application in a sandboxed environment. - APP must name an installed application. - Extra arguments are passed on to the application. +

See also

+ ostree(1), + flatpak(1), + flatpak-build-init(1), + flatpak-build(1), + flatpak-build-finish(1), + flatpak-build-import-bundle(1), + flatpak-build-update-repo(1) +

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

- flatpak creates a sandboxed environment for the application to run in - by mounting the right runtime at /usr and a writable - directory at /var, whose content is preserved between - application runs. The application itself is mounted at /app. + This command is very useful when you want to maintain a branch + with a clean history that has no unsigned or broken commits. + For instance, you can import the head from a different repository + from an automatic builder when you've verified that it worked. + The new commit will have no parents or signatures from the + autobuilder, and can be properly signed with the official + key.

- The details of the sandboxed environment are controlled by the application - metadata and various options like --share and --socket that are passed to the run - command: Access is allowed if it was requested either in the application - metadata file or with an option and the user hasn't overridden it. -

Options

The following options are understood:

-h, --help

+ Any deltas that affect the original commit and that match parent + commits in the destination repository are copied and rewritten + for the new commit id. +

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

--arch=ARCH

- The architecture to install for. -

--command=COMMAND

- The command to run instead of the one listed in the application metadata. -

--branch=BRANCH

- The branch to use. -

-d, --devel

- Use the devel runtime that is specified in the application metadata instead of the regular runtime, and use a seccomp profile that is less likely to break development tools. -

--runtime=RUNTIME

- Use this runtime instead of the one that is specified in the application metadata. - This is a full tuple, like for example org.freedesktop.Sdk/x86_64/1.2 , but - partial tuples are allowed. Any empty or missing parts are filled in with the corresponding - values specified by the app. -

--runtime-version=VERSION

- Use this version of the runtime instead of the one that is specified in the application metadata. - This overrides any version specified with the --runtime option. -

--share=SUBSYSTEM

- Share a subsystem with the host session. This overrides - the Context section from the application metadata. - SUBSYSTEM must be one of: network, ipc. - This option can be used multiple times. -

--unshare=SUBSYSTEM

- Don't share a subsystem with the host session. This overrides - the Context section from the application metadata. - SUBSYSTEM must be one of: network, ipc. - This option can be used multiple times. -

--socket=SOCKET

- Expose a well known socket to the application. This overrides to - the Context section from the application metadata. - SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. - This option can be used multiple times. -

--nosocket=SOCKET

- Don't expose a well known socket to the application. This overrides to - the Context section from the application metadata. - SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. - This option can be used multiple times. -

--device=DEVICE

- Expose a device to the application. This overrides to - the Context section from the application metadata. - DEVICE must be one of: dri, kvm, all. - This option can be used multiple times. -

--nodevice=DEVICE

- Don't expose a device to the application. This overrides to - the Context section from the application metadata. - DEVICE must be one of: dri, kvm, all. - This option can be used multiple times. -

--allow=FEATURE

- Allow access to a specific feature. This overrides to - the Context section from the application metadata. - FEATURE must be one of: devel, multiarch. - This option can be used multiple times. -

--disallow=FEATURE

- Disallow access to a specific feature. This overrides to - the Context section from the application metadata. - FEATURE must be one of: devel, multiarch. - This option can be used multiple times. -

--filesystem=FS

- Allow the application access to a subset of the filesystem. - This overrides to the Context section from the application metadata. - FS can be one of: home, host, xdg-desktop, xdg-documents, xdg-download - xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, - an absolute path, or a homedir-relative path like ~/dir or paths - relative to the xdg dirs, like xdg-download/subdir. - This option can be used multiple times. -

--env=VAR=VALUE

- Set an environment variable in the application. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -

--own-name=NAME

- Allow the application to own the well known name NAME on the session bus. - If NAME ends with .*, it allows the application to own all matching names. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -

--talk-name=NAME

- Allow the application to talk to the well known name NAME on the session bus. - If NAME ends with .*, it allows the application to talk to all matching names. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -

--system-own-name=NAME

- Allow the application to own the well known name NAME on the system bus. - If NAME ends with .*, it allows the application to own all matching names. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -

--system-talk-name=NAME

- Allow the application to talk to the well known name NAME on the system bus. - If NAME ends with .*, it allows the application to talk to all matching names. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -

--persist=FILENAME

- If the application doesn't have access to the real homedir, make the (homedir-relative) path - FILENAME a bind mount to the corresponding path in the per-application directory, - allowing that location to be used for persistent data. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -

--log-session-bus

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

--log-system-bus

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

Examples

- $ flatpak run org.gnome.GEdit -

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

See also

- flatpak(1), - flatpak-override(1), - flatpak-enter(1) -

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

- By default the application gets access to the resources it - requested when it is started. But the user can override it - on a particular instance by specifying extra arguments to - flatpak run, or every time by using flatpak override. -

Options

The following options are understood:

-h, --help

- Show help options and exit. -

--share=SUBSYSTEM

- Share a subsystem with the host session. This overrides - the Context section from the application metadata. - SUBSYSTEM must be one of: network, ipc. - This option can be used multiple times. -

--unshare=SUBSYSTEM

- Don't share a subsystem with the host session. This overrides - the Context section from the application metadata. - SUBSYSTEM must be one of: network, ipc. - This option can be used multiple times. -

--socket=SOCKET

- Expose a well-known socket to the application. This overrides to - the Context section from the application metadata. - SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. - This option can be used multiple times. -

--nosocket=SOCKET

- Don't expose a well-known socket to the application. This overrides to - the Context section from the application metadata. - SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. - This option can be used multiple times. -

--device=DEVICE

- Expose a device to the application. This overrides to - the Context section from the application metadata. - DEVICE must be one of: dri, kvm, all. - This option can be used multiple times. -

--nodevice=DEVICE

- Don't expose a device to the application. This overrides to - the Context section from the application metadata. - DEVICE must be one of: dri, kvm, all. - This option can be used multiple times. -

--filesystem=FS

- Allow the application access to a subset of the filesystem. - This overrides to the Context section from the application metadata. - FS can be one of: home, host, xdg-desktop, xdg-documents, xdg-download - xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, - an absolute path, or a homedir-relative path like ~/dir or paths - relative to the xdg dirs, like xdg-download/subdir. - This option can be used multiple times. -

--env=VAR=VALUE

- Set an environment variable in the application. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -

--own-name=NAME

- Allow the application to own the well-known name NAME on the session bus. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -

--talk-name=NAME

- Allow the application to talk to the well-known name NAME on the session bus. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -

--system-own-name=NAME

- Allow the application to own the well known name NAME on the system bus. - If NAME ends with .*, it allows the application to own all matching names. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -

--system-talk-name=NAME

- Allow the application to talk to the well known name NAME on the system bus. - If NAME ends with .*, it allows the application to talk to all matching names. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -

--persist=FILENAME

- If the application doesn't have access to the real homedir, make the (homedir-relative) path - FILENAME a bind mount to the corresponding path in the per-application directory, - allowing that location to be used for persistent data. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -

-v, --verbose

- Print debug information during command processing. -

--version

- Print version information and exit. -

Examples

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

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

See also

- flatpak(1), - flatpak-run(1) -

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. - Extra arguments are passed on to the command. -

- This creates a new process within the running sandbox, with the same environment. This is useful - when you want to debug a problem with a running application. -

- This command requires extra privileges, so must be run as root or via e.g. sudo. -

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

- $ flatpak enter 15345 sh -

See also

- flatpak(1), - flatpak-run(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 - fuse filesystem at /run/user/$UID/doc/. -

- This command also lets you modify the per-application - permissions of the documents, granting or revoking access - to the file on a per-application basis. -

Options

The following options are understood:

-h, --help

- Show help options and exit. -

--unique

Don't reuse an existing document id - for the file. This makes it safe to later remove the - document when you're finished with it. -

--transient

- The document will only exist for the length of - the session. This is useful for temporary grants. -

--app=APPID

- Grant read access to the specified application. The - --allow and --forbid options can be used to grant - or remove additional privileges. - This option can be used multiple times. -

--allow-read

- Grant read access to the applications specified with --app. - This defaults to TRUE. -

--forbid-read

- Revoke read access for the applications specified with --app. -

--allow-write

- Grant write access to the applications specified with --app. -

--forbid-write

- Revoke write access for the applications specified with --app. -

--allow-delete

- Grant the ability to remove the document from the document portal to the applications specified with --app. -

--forbid-delete

- Revoke the ability to remove the document from the document portal from the applications specified with --app. -

--allow-grant-permission

- Grant the ability to grant further permissions to the applications specified with --app. -

--forbid-grant-permission

- Revoke the ability to grant further permissions for the applications specified with --app. -

-v, --verbose

- Print debug information during command processing. -

--version

- Print version information and exit. -

Examples

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

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

See also

- flatpak(1), - flatpak-document-unexport(1), - flatpak-document-info(1), - flatpak-document-list(1) -

Name

flatpak-document-unexport — Stop exporting a file

Synopsis

flatpak document-export [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

- Show help options and exit. -

-v, --verbose

- Print debug information during command processing. -

--version

- Print version information and exit. -

See also

- flatpak(1), - flatpak-document-export(1), - flatpak-document-info(1), - flatpak-document-list(1) -

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

- Show help options and exit. -

-v, --verbose

- Print debug information during command processing. -

--version

- Print version information and exit. -

Examples

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

-id: dd32c34a
-path: /run/user/1000/doc/dd32c34a/gail-3.0.pc
-origin: /home/mclasen/Sources/gtk/gail-3.0.pc
-permissions:
-        org.gnome.gedit read, write
-

See also

- flatpak(1), - flatpak-document-export(1), - flatpak-document-unexport(1), - flatpak-document-list(1) -

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

- Show help options and exit. -

-v, --verbose

- Print debug information during command processing. -

--version

- Print version information and exit. -

See also

- flatpak(1), - flatpak-document-export(1), - flatpak-document-unexport(1), - flatpak-document-info(1) -

Name

flatpak-remote-add — Add a remote repository

Synopsis

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 the url or pathname for the repository. -

- Unless overridden with the --user option, this command changes - the system-wide configuration. -

- The alternative form of the command adds a remote from a flatpakrepo - file. -

Options

The following options are understood:

-h, --help

- Show help options and exit. -

--from

- Add from a flatpakrepo file (local or http uri) instead of from commandline arguments. This means the LOCATION argument specifies the filename/uri of a flatpakref rather than a repo url. -

--user

- Modify the per-user configuration. -

--system

- Modify the system-wide configuration. -

--no-gpg-verify

- Disable GPG verification for the added remote. -

--prio=PRIO

- Set the priority for the remote. Default is 1, higher is more prioritized. This is - mainly used for graphical installation tools. -

--no-enumerate

- Mark the remote as not enumerated. This means the remote will - not be used to list applications, for instance in graphical - installation tools. -

--no-use-for-deps

- Mark the remote as not to be used for automatic runtime - dependency resolution. -

--if-not-exists

- Do nothing if the provided remote already exists. -

--disable

- Disable the added remote. -

--title=TITLE

- A title for the remote, e.g. for display in a UI. -

--default-branch=BRANCH

- A default branch to for the remote, mainly for use in a UI. -

--gpg-import=FILE

- Import gpg keys from the specified keyring file as - trusted for the new remote. If the file is - the - keyring is read from standard input. -

-v, --verbose

- Print debug information during command processing. -

--ostree-verbose

- Print OSTree debug information during command processing. -

--version

- Print version information and exit. -

Examples

- $ flatpak --user remote-add --no-gpg-verify test-repo https://people.gnome.org/~alexl/gnome-sdk/repo/ -

See also

- flatpak(1), - flatpak-modify-remote(1), - flatpak-delete-remote(1), - flatpak-list-remotes(1), - flatpak-flatpakrepo(1) -

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

- Unless overridden with the --user option, this command changes - the system-wide configuration. -

Options

The following options are understood:

-h, --help

- Show help options and exit. -

--user

- Modify the per-user configuration. -

--system

- Modify the system-wide configuration. -

--no-gpg-verify

- Disable GPG verification for the added remote. -

--gpg-verify

- Enable GPG verification for the added remote. -

--prio=PRIO

- Set the priority for the remote. Default is 1, higher is more prioritized. This is - mainly used for graphical installation tools. -

--no-enumerate

- Mark the remote as not enumerated. This means the remote will - not be used to list applications, for instance in graphical - installation tools. -

--no-use-for-deps

- Mark the remote as not to be used for automatic runtime - dependency resolution. -

--disable

- Disable the remote. Disabled remotes will not be automatically updated from. -

--enable

- Enable the remote. -

--enumerate

- Mark the remote as enumerated. This means the remote will - be used to list applications, for instance in graphical - installation tools. -

--use-for-deps

- Mark the remote as to be used for automatic runtime - dependency resolution. -

--title=TITLE

- A title for the remote, e.g. for display in a UI. -

--default-branch=BRANCH

- A default branch to for the remote, mainly for use in a UI. -

--update-metadata

- A default branch to for the remote, mainly for use in a UI. -

- Update the remote's extra metadata from the OSTree repository's summary - file. Only xa.title and xa.default-branch are supported at the moment. -

--gpg-import=FILE

- Import gpg keys from the specified keyring file as - trusted for the new remote. If the file is - the - keyring is read from standard input. -

-v, --verbose

- Print debug information during command processing. -

--ostree-verbose

- Print OSTree debug information during command processing. -

--version

- Print version information and exit. -

Examples

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

See also

- flatpak(1), - flatpak-remote-add(1), - flatpak-remote-delete(1), - flatpak-remote-list(1) -

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

- Unless overridden with the --user option, this command changes - the system-wide configuration. -

Options

The following options are understood:

-h, --help

- Show help options and exit. -

--user

- Modify the per-user configuration. -

--system

- Modify the system-wide configuration. +

--src-repo=SRC-REPO

+ The (local) repository to pull the source branch from. Defaults to the + destination repository. +

--src-ref=SRC-REF

+ The branch to use as the source for the new commit. Defaults to the same + as the destination ref, which is useful only if a different source repo + has been specified. +

--untrusted

+ The source repostory is not trusted, all objects are copied (not hardlinked) and + all checksums are verified. +

-s, --subject=SUBJECT

+ One line subject for the commit message. If not specified, will be taken from the source commit. +

-b, --body=BODY

+ Full description for the commit message. If not specified, will be taken from the source commit. +

--update-appstream

+ Update the appstream branch after the build. +

--no-update-summary

+ Don't update the summary file after the new commit is added. This means + the repository will not be useful for serving over http until build-update-repo + has been run. This is useful is you want to do multiple repo operations before + finally updating the summary.

--force

- Remove remote even if its in use by installed apps or runtimes. + Create new commit even if the content didn't change from the existing branch head. +

--gpg-sign=KEYID

+ Sign the commit with this GPG key. + This option can be used multiple times. +

--gpg-homedir=PATH

+ GPG Homedir to use when looking for keyrings

-v, --verbose

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 -

See also

- flatpak(1), - flatpak-add-remote(1), - flatpak-modify-remote(1), - flatpak-list-remotes(1) -

Name

flatpak-remote-list — List remote repositories

Synopsis

flatpak remote-list [OPTION...]

Description

- Lists the known remote repositories, in priority order. -

- By default, both per-user and system-wide installations - are shown. Use the --user or --system options to change - this. -

Options

The following options are understood:

-h, --help

- Show help options and exit. -

--user

- Show the per-user configuration. -

--system

- Show the system-wide configuration. -

--show-details

- Show more information each repository in addition to the name. -

--show-disabled

- Show disabled repos. -

-v, --verbose

- Print debug information during command processing. -

--ostree-verbose

- Print OSTree debug information during command processing. -

--version

- Print version information and exit. -

Examples

- $ flatpak remote-list --user --show-details +

Examples

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

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

See also

- flatpak(1), - flatpak-add-remote(1), - flatpak-delete-remote(1) -

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 . - You can find all configured remote repositories with flatpak remote-list. +Commit: 9d0044ea480297114d03aec85c3d7ae3779438f9d2cb69d717fb54237acacb8c +Metadata Total: 605 +Metadata Written: 5 +Content Total: 1174 +Content Written: 1 +Content Bytes Written: 305 +

See also

+ ostree(1), + flatpak(1), + flatpak-build-init(1), + flatpak-build(1), + flatpak-build-finish(1), + flatpak-build-sign(1), + flatpak-build-update-repo(1) +

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 + finalized build directory. If BRANCH + is not specified, it is assumed to be "master".

- Unless overridden with the --user option, this command uses - the system-wide configuration. -

Options

The following options are understood:

-h, --help

+ If LOCATION exists, it is assumed to + be an OSTree repository, otherwise a new OSTree repository is + created at this location. The repository can be inspected with + the ostree tool. +

+ The contents of DIRECTORY are committed + on the branch with name app/APPNAME/ARCH/BRANCH, + where ARCH is the architecture of the runtime that the application + is using. A commit filter is used to enforce that only the contents + of the files/ and export/ + subdirectories and the metadata file are included + in the commit, anything else is ignored. +

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

Options

The following options are understood:

-h, --help

Show help options and exit. -

--user

- Use the per-user configuration. -

--system

- Use the system-wide configuration. -

-d, --show-details

- Show arches, branches and commit ids, in addition to the names. -

--runtime

- Show only runtimes, omit applications. -

--app

- Show only applications, omit runtimes. -

--updates

- Show only those which have updates available. +

-s, --subject=SUBJECT

+ One line subject for the commit message. +

-b, --body=BODY

+ Full description for the commit message.

--arch=ARCH

- Show only those matching the specied architecture. By default, only - supported architectures are shown. Use --arch=* to show all archtectures. -

-v, --verbose

- Print debug information during command processing. -

--ostree-verbose

- Print OSTree debug information during command processing. -

--version

- Print version information and exit. -

Examples

- $ flatpak --user remote-ls --only-apps testrepo - 

-org.gnome.Builder
-org.freedesktop.glxgears
-

See also

- flatpak(1), - flatpak-remote-list(1) -

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 - that will be built. - SDK and RUNTIME - specify the sdk and runtime that the application should be built - against and run in. -

- The result of this command is that a metadata - file is created inside the given directory. Additionally, empty - files and var subdirectories - are created. -

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

Options

The following options are understood:

-h, --help

- Show help options and exit. -

--arch=ARCH

- The architecture to use. -

-v, --var=RUNTIME

- Initialize var from the named runtime. -

-w, --writable-sdk

- Initialize /usr with a copy of the sdk, which is writable during flatpak build. This can be used - if you need to install build tools in /usr during the build. This is stored in the - usr subdirectory of the app dir, but will not be part of the final - app. -

--tag=TAG

- Add a tag to the metadata file. + Specify the architecture component of the branch to export. Only host compatible architectures can be specified. +

--exclude=PATTERN

+ Exclude files matching PATTERN from the commit. This option can be used multiple times. -

--sdk-extension=EXTENSION

- When using --writable-sdk, in addition to the sdk, also install the specified extension. +

--include=PATTERN

+ Don't exclude files matching PATTERN from the commit, even if they match the --export patterns. This option can be used multiple times. -

--sdk-dir

- Specify a custom subdirectory to use instead of usr for --writable-sdk. -

--update

- Re-initialize the sdk and var, don't fail if already initialized. -

--base=APP

- Initialize the application with files from another specified application. -

--base-version=VERSION

- Specify the version to use for --base. If not specified, will default to - "master". -

--base-extension=EXTENSION

- When using --base, also install the specified extension from the app. +

--metadata=FILENAME

+ Use the specified filename as metadata in the exported app instead of + the default file (called metadata). This is useful + if you want to commit multiple things from a single build tree, typically + used in combination with --files and --exclude. +

--files=SUBDIR

+ Use the files in the specified subdirectory as the file contents, rather + than the regular files directory. +

--timestamp=DATE

+ Use the specified ISO 8601 formatted date in the commit metadata and, if --update-appstream is used, the appstream data. +

--update-appstream

+ Update the appstream branch after the build. +

--no-update-summary

+ Don't update the summary file after the new commit is added. This means + the repository will not be useful for serving over http until build-update-repo + has been run. This is useful is you want to do multiple repo operations before + finally updating the summary. +

--gpg-sign=KEYID

+ Sign the commit with this GPG key. This option can be used multiple times. -

--verbose

- Print debug information during command processing. -

--version

- Print version information and exit. -

Examples

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

See also

- flatpak(1), - flatpak-build(1), - flatpak-build-finish(1), - flatpak-build-export(1) -

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

- The sdk that is specified in the metadata file - in the directory is mounted at /usr and the - files and var subdirectories - are mounted at /app and /var, - respectively. They are writable, and their contents are preserved between - build commands, to allow accumulating build artifacts there. -

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

--gpg-homedir=PATH

+ GPG Homedir to use when looking for keyrings

-r, --runtime

- Use the non-devel runtime that is specified in the application metadata instead of the devel runtime. -

--bind-mount=DEST=SOURCE

- Add a custom bind mount in the build namespace. Can be specified multiple times. -

--build-dir=PATH

- Start the build in this directory (default is in the current directory). -

--share=SUBSYSTEM

- Share a subsystem with the host session. This overrides - the Context section from the application metadata. - SUBSYSTEM must be one of: network, ipc. - This option can be used multiple times. -

--unshare=SUBSYSTEM

- Don't share a subsystem with the host session. This overrides - the Context section from the application metadata. - SUBSYSTEM must be one of: network, ipc. - This option can be used multiple times. -

--socket=SOCKET

- Expose a well-known socket to the application. This overrides to - the Context section from the application metadata. - SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. - This option can be used multiple times. -

--nosocket=SOCKET

- Don't expose a well-known socket to the application. This overrides to - the Context section from the application metadata. - SOCKET must be one of: x11, wayland, pulseaudio, system-bus, session-bus. - This option can be used multiple times. -

--device=DEVICE

- Expose a device to the application. This overrides to - the Context section from the application metadata. - DEVICE must be one of: dri, kvm, all. - This option can be used multiple times. -

--nodevice=DEVICE

- Don't expose a device to the application. This overrides to - the Context section from the application metadata. - DEVICE must be one of: dri, kvm, all. - This option can be used multiple times. -

--filesystem=FILESYSTEM[:ro]

- Allow the application access to a subset of the filesystem. - This overrides to the Context section from the application metadata. - FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download - xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, - an absolute path, or a homedir-relative path like ~/dir. - The optional :ro suffix indicates that the location will be read-only. - This option can be used multiple times. -

--nofilesystem=FILESYSTEM

- Remove access to the specified subset of the filesystem from - the application. This overrides to the Context section from the - application metadata. - FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download - xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, - an absolute path, or a homedir-relative path like ~/dir. - This option can be used multiple times. -

--env=VAR=VALUE

- Set an environment variable in the application. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -

--own-name=NAME

- Allow the application to own the well-known name NAME on the session bus. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -

--talk-name=NAME

- Allow the application to talk to the well-known name NAME on the session bus. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -

--system-own-name=NAME

- Allow the application to own the well-known name NAME on the system bus. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -

--system-talk-name=NAME

- Allow the application to talk to the well-known name NAME on the system bus. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -

--persist=FILENAME

- If the application doesn't have access to the real homedir, make the (homedir-relative) path - FILENAME a bind mount to the corresponding path in the per-application directory, - allowing that location to be used for persistent data. - This overrides to the Context section from the application metadata. - This option can be used multiple times. -

Examples

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

See also

- flatpak(1), - flatpak-build-init(1), - flatpak-build-finish(1), - flatpak-build-export(1) -

Name

flatpak-build-finish — Finalize a build directory

Synopsis

flatpak build-finish [OPTION...] DIRECTORY

Description

+ Export a runtime instead for an app (this uses the usr subdir as files). +

-v, --verbose

+ Print debug information during command processing. +

--ostree-verbose

+ Print OSTree debug information during command processing. +

--version

+ Print version information and exit. +

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
+

See also

+ ostree(1), + flatpak(1), + flatpak-build-init(1), + flatpak-build(1), + flatpak-build-finish(1), + flatpak-build-sign(1), + flatpak-build-update-repo(1) +

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.

@@ -1005,12 +340,14 @@ org.freedesktop.glxgears

It is an error to run build-finish on a directory that has not been initialized as a build directory, or has already been finalized. -

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, the first executable found in files/bin is used. +

--require-version=MAJOR.MINOR.MICRO

+ Require this version of later of flatpak to install/update to this build.

--share=SUBSYSTEM

Share a subsystem with the host session. This updates the [Context] group in the metadata. @@ -1024,12 +361,12 @@ org.freedesktop.glxgears

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

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

--device=DEVICE

Expose a device to the application. This updates @@ -1066,9 +403,29 @@ org.freedesktop.glxgears This updates the [Context] group in the metadata. FS can be one of: home, host, xdg-desktop, xdg-documents, xdg-download xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, - an absolute path, or a homedir-relative path like ~/dir or paths - relative to the xdg dirs, like xdg-download/subdir. + xdg-config, xdg-cache, xdg-data, an absolute path, or a homedir-relative + path like ~/dir or paths relative to the xdg dirs, like xdg-download/subdir. + The optional :ro suffix indicates that the location will be read-only. + The optional :create suffix indicates that the location will be read-write and created if it doesn't exist. This option can be used multiple times. +

--nofilesystem=FILESYSTEM

+ Remove access to the specified subset of the filesystem from + the application. This overrides to the Context section from the + application metadata. + FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, + an absolute path, or a homedir-relative path like ~/dir. + This option can be used multiple times. +

--add-policy=SUBSYSTEM.KEY=VALUE

+ Add generic policy option. For example, "--add-policy=subsystem.key=v1 --add-policy=subsystem.key=v2" would map to this metadata: +

+[Policy subsystem]
+key=v1;v2;
+

+

+ This option can be used multiple times. +

--remove-policy=SUBSYSTEM.KEY=VALUE

+ Remove generic policy option. This option can be used multiple times.

--env=VAR=VALUE

Set an environment variable in the application. This updates the [Environment] group in the metadata. @@ -1101,6 +458,18 @@ org.freedesktop.glxgears allowing that location to be used for persistent data. This updates the [Context] group in the metadata. This option can be used multiple times. +

--runtime=RUNTIME, --sdk=SDK

+ Change the runtime or sdk used by the app to the specified partial ref. Unspecified parts + of the ref are taken from the old values or defaults. +

--metadata=GROUP=KEY[=VALUE]

+ Set a generic key in the metadata file. If value is left out it will + be set to "true". +

--extension=NAME=VARIABLE[=VALUE]

+ Add extension point info. +

--extension-priority=VALUE

+ Set the priority (library override order) of the extension point. + Only useful for extensions. 0 is the default, and higher value means higher + priority.

--extra-data=NAME:SHA256:DOWNLOAD-SIZE:INSTALL-SIZE:URL

Adds information about extra data uris to the app. These will be downloaded and verified by the client when the app is installed and placed in the @@ -1114,7 +483,7 @@ org.freedesktop.glxgears Print OSTree debug information during command processing.

--version

Print version information and exit. -

Examples

+

Examples

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

 Exporting share/applications/gnome-calculator.desktop
@@ -1122,137 +491,17 @@ Exporting share/dbus-1/services/org.gnome.Calculator.SearchProvider.service
 More than one executable
 Using gcalccmd as command
 Please review the exported files and the metadata
-

See also

- flatpak(1), - flatpak-build-init(1), - flatpak-build(1), - flatpak-build-export(1) -

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 - finalized build directory. If BRANCH - is not specified, it is assumed to be "master". -

- If LOCATION exists, it is assumed to - be an OSTree repository, otherwise a new OSTree repository is - created at this location. The repository can be inspected with - the ostree tool. -

- The contents of DIRECTORY are committed - on the branch with name app/APPNAME/ARCH/BRANCH, - where ARCH is the architecture of the runtime that the application - is using. A commit filter is used to enforce that only the contents - of the files/ and export/ - subdirectories and the metadata file are included - in the commit, anything else is ignored. -

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

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

--arch=ARCH

- Specify the architecture component of the branch to export. Only host compatible architectures can be specified. -

--exclude=PATTERN

- Exclude files matching PATTERN from the commit. - This option can be used multiple times. -

--include=PATTERN

- Don't exclude files matching PATTERN from the commit, even if they match the --export patterns. - This option can be used multiple times. -

--metadata=FILENAME

- Use the specified filename as metadata in the exported app instead of - the default file (called metadata). This is useful - if you want to commit multiple things from a single build tree, typically - used in combination with --files and --exclude. -

--files=SUBDIR

- Use the files in the specified subdirectory as the file contents, rather - than the regular files directory. -

--update-appstream

- Run appstream-builder and to update the appstream branch after build. -

--no-update-summary

- Don't update the summary file after the new commit is added. This means - the repository will not be useful for serving over http until build-repo-update - has been run. This is useful is you want to do multiple repo operations before - finally updating the summary. -

--gpg-sign=KEYID

- Sign the commit with this GPG key. - This option can be used multiple times. -

--gpg-homedir=PATH

- GPG Homedir to use when looking for keyrings -

--runtime

- Export a runtime instead for an app (this uses the usr subdir as files). -

-v, --verbose

- Print debug information during command processing. -

--ostree-verbose

- Print OSTree debug information during command processing. -

--version

- Print version information and exit. -

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
-

See also

- ostree(1), - flatpak(1), - flatpak-build-init(1), - flatpak-build(1), - flatpak-build-finish(1), - flatpak-build-sign(1), - flatpak-repo-update(1) -

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

- Show help options and exit. -

--runtime

- Export a runtime instead of an application. -

--arch=ARCH

- The arch to create a bundle for. -

--repo-url=URL

- The URL for the repository from which the - application can be updated. Installing the - bundle will automatically configure a remote - for this URL. -

--gpg-keys=FILE

- Add the GPG key from FILE (use - for stdin). -

--gpg-homedir=PATH

- GPG Homedir to use when looking for keyrings. -

--oci

- Export to an OCI image instead of a Flatpak bundle. -

-v, --verbose

- Print debug information during command processing. -

--version

- Print version information and exit. -

See also

- ostree(1), - flatpak(1), - flatpak-build-init(1), - flatpak-build(1), - flatpak-build-finish(1), - flatpak-build-import-bundle(1), - flatpak-repo-update(1) -

Name

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

Synopsis

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

Description

+

See also

+ flatpak(1), + flatpak-build-init(1), + flatpak-build(1), + flatpak-build-export(1) +

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. @@ -1263,10 +512,10 @@ Content Bytes Written: 305

--oci

Import an OCI image instead of a Flatpak bundle.

--update-appstream

- Run appstream-builder and to update the appstream branch after build. + Update the appstream branch after the build.

--no-update-summary

Don't update the summary file after the new commit is added. This means - the repository will not be useful for serving over http until build-repo-update + the repository will not be useful for serving over http until build-update-repo has been run. This is useful is you want to do multiple repo operations before finally updating the summary.

--gpg-sign=KEYID

@@ -1276,50 +525,73 @@ Content Bytes Written: 305 GPG Homedir to use when looking for keyrings

--version

Print version information and exit. -

See also

- ostree(1), - flatpak(1), - flatpak-build-bundle(1), - flatpak-repo-update(1) -

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. - The summary is used by flatpak repo-contents and other commands - to display the contents of remote repositories. +

See also

+ ostree(1), + flatpak(1), + flatpak-build-bundle(1), + flatpak-build-update-repo(1) +

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 + that will be built. + SDK and RUNTIME + specify the sdk and runtime that the application should be built + against and run in.

- After this command, LOCATION can be - used as the repository location for flatpak add-repo, either by - exporting it over http, or directly with a file: url. -

Options

The following options are understood:

-h, --help

+ The result of this command is that a metadata + file is created inside the given directory. Additionally, empty + files and var subdirectories + are created. +

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

Options

The following options are understood:

-h, --help

Show help options and exit. -

--title=TITLE

- A title for the repository, e.g. for display in a UI. - The title is stored in the repository summary. -

--gpg-sign=KEYID

- Sign the commit with this GPG key. +

--arch=ARCH

+ The architecture to use. +

-v, --var=RUNTIME

+ Initialize var from the named runtime. +

-w, --writable-sdk

+ Initialize /usr with a copy of the sdk, which is writable during flatpak build. This can be used + if you need to install build tools in /usr during the build. This is stored in the + usr subdirectory of the app dir, but will not be part of the final + app. +

--tag=TAG

+ Add a tag to the metadata file. This option can be used multiple times. -

--gpg-homedir=PATH

- GPG Homedir to use when looking for keyrings -

--generate-static-deltas

- Generate static deltas for all references. This generates from-empty and - delta static files that allow for faster download. -

--prune

- Remove unreferences objects in repo. -

--prune-depth

- Only keep at most this number of old versions for any particular ref. Default is -1 which means infinite. -

-v, --verbose

+

--sdk-extension=EXTENSION

+ When using --writable-sdk, in addition to the sdk, also install the specified extension. + This option can be used multiple times. +

--sdk-dir

+ Specify a custom subdirectory to use instead of usr for --writable-sdk. +

--update

+ Re-initialize the sdk and var, don't fail if already initialized. +

--base=APP

+ Initialize the application with files from another specified application. +

--base-version=VERSION

+ Specify the version to use for --base. If not specified, will default to + "master". +

--base-extension=EXTENSION

+ When using --base, also install the specified extension from the app. + This option can be used multiple times. +

--type=TYPE

+ This can be used to build different types of things. The default + is "app" which is a regular app, but "runtime" creates a runtime + based on an existing runtime, and "extension" creates an extension + for an app or runtime. +

--verbose

Print debug information during command processing. -

--ostree-verbose

- Print OSTree debug information during command processing.

--version

Print version information and exit. -

See also

- ostree(1), - flatpak(1), - flatpak-repo-contents(1), - flatpak-build-export(1) -

Name

flatpak-build-sign — Sign an application or runtime

Synopsis

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

Description

+

Examples

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

See also

+ flatpak(1), + flatpak-build(1), + flatpak-build-finish(1), + flatpak-build-export(1) +

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 @@ -1328,7 +600,7 @@ Content Bytes Written: 305

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

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. @@ -1345,245 +617,1470 @@ Content Bytes Written: 305 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 +

Examples

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

See also

+ ostree(1), + flatpak(1), + flatpak-build-export(1), + flatpak-build(1), +

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. + The summary is used by flatpak remote-ls and other commands + to display the contents of remote repositories. +

+ After this command, LOCATION can be + used as the repository location for flatpak remote-add, either by + exporting it over http, or directly with a file: url. +

Options

The following options are understood:

-h, --help

+ Show help options and exit. +

--redirect-url=URL

+ Redirect this repo to a new URL. +

--title=TITLE

+ A title for the repository, e.g. for display in a UI. + The title is stored in the repository summary. +

--default-branch=BRANCH

+ A default branch for the repository, mainly for use in a UI. +

--gpg-import=FILE

+ Import a new default GPG public key from the + given file. +

--gpg-sign=KEYID

+ Sign the commit with this GPG key. + This option can be used multiple times. +

--gpg-homedir=PATH

+ GPG Homedir to use when looking for keyrings +

--generate-static-deltas

+ Generate static deltas for all references. This generates from-empty and + delta static files that allow for faster download. +

--prune

+ Remove unreferenced objects in repo. +

--prune-depth

+ Only keep at most this number of old versions for any particular ref. Default is -1 which means infinite. +

-v, --verbose

+ Print debug information during command processing. +

--ostree-verbose

+ Print OSTree debug information during command processing. +

--version

+ Print version information and exit. +

See also

+ ostree(1), + flatpak(1), + flatpak-remote-ls(1), + flatpak-build-export(1) +

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

+ The sdk that is specified in the metadata file + in the directory is mounted at /usr and the + files and var subdirectories + are mounted at /app and /var, + respectively. They are writable, and their contents are preserved between + build commands, to allow accumulating build artifacts there. +

Options

The following options are understood:

-h, --help

+ Show help options and exit. +

-v, --verbose

+ Print debug information during command processing. +

-r, --runtime

+ Use the non-devel runtime that is specified in the application metadata instead of the devel runtime. +

-p, --die-with-parent

+ Kill the build process and all children when the launching process dies. +

--bind-mount=DEST=SOURCE

+ Add a custom bind mount in the build namespace. Can be specified multiple times. +

--build-dir=PATH

+ Start the build in this directory (default is in the current directory). +

--share=SUBSYSTEM

+ Share a subsystem with the host session. This overrides + the Context section from the application metadata. + SUBSYSTEM must be one of: network, ipc. + This option can be used multiple times. +

--unshare=SUBSYSTEM

+ Don't share a subsystem with the host session. This overrides + the Context section from the application metadata. + SUBSYSTEM must be one of: network, ipc. + This option can be used multiple times. +

--socket=SOCKET

+ Expose a well-known socket to the application. This overrides to + the Context section from the application metadata. + SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus. + This option can be used multiple times. +

--nosocket=SOCKET

+ Don't expose a well-known socket to the application. This overrides to + the Context section from the application metadata. + SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus. + This option can be used multiple times. +

--device=DEVICE

+ Expose a device to the application. This overrides to + the Context section from the application metadata. + DEVICE must be one of: dri, kvm, all. + This option can be used multiple times. +

--nodevice=DEVICE

+ Don't expose a device to the application. This overrides to + the Context section from the application metadata. + DEVICE must be one of: dri, kvm, all. + This option can be used multiple times. +

--allow=FEATURE

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

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

+ The multiarch feature allows the application to + execute programs compiled for an ABI other than the one supported + natively by the system. For example, for the x86_64 + architecture, 32-bit x86 binaries will be allowed as + well. +

--disallow=FEATURE

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

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

+ Allow the application access to a subset of the filesystem. + This overrides to the Context section from the application metadata. + FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, + xdg-config, xdg-cache, xdg-data, an absolute path, or a homedir-relative + path like ~/dir or paths relative to the xdg dirs, like xdg-download/subdir. + The optional :ro suffix indicates that the location will be read-only. + The optional :create suffix indicates that the location will be read-write and created if it doesn't exist. + This option can be used multiple times. +

--nofilesystem=FILESYSTEM

+ Remove access to the specified subset of the filesystem from + the application. This overrides to the Context section from the + application metadata. + FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, + an absolute path, or a homedir-relative path like ~/dir. + This option can be used multiple times. +

--with-appdir

+ Expose and configure access to the per-app storage directory in $HOME/.var/app. This is + not normally useful when building, but helps when testing built apps. +

--add-policy=SUBSYSTEM.KEY=VALUE

+ Add generic policy option. For example, "--add-policy=subsystem.key=v1 --add-policy=subsystem.key=v2" would map to this metadata: +

+[Policy subsystem]
+key=v1;v2;
+

+

+ This option can be used multiple times. +

--remove-policy=SUBSYSTEM.KEY=VALUE

+ Remove generic policy option. This option can be used multiple times. +

--env=VAR=VALUE

+ Set an environment variable in the application. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +

--own-name=NAME

+ Allow the application to own the well-known name NAME on the session bus. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +

--talk-name=NAME

+ Allow the application to talk to the well-known name NAME on the session bus. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +

--system-own-name=NAME

+ Allow the application to own the well-known name NAME on the system bus. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +

--system-talk-name=NAME

+ Allow the application to talk to the well-known name NAME on the system bus. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +

--persist=FILENAME

+ If the application doesn't have access to the real homedir, make the (homedir-relative) path + FILENAME a bind mount to the corresponding path in the per-application directory, + allowing that location to be used for persistent data. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +

--sdk-dir=DIR

+ Normally if there is a usr directory in the build dir, this is used + for the runtime files (this can be created by --writable-sdk or --type=runtime arguments + to build-init). If you specify --sdk-dir this directoryname will be used instead. + Use this if you passed --sdk-dir to build-init. +

--readonly

+ Mount the normally writable destination directories read-only. This can + be useful if you want to run something in the sandbox but guarantee that + it doesn't affect the build results. For example tests. +

--metadata=FILE

+ Use the specified filename as metadata in the exported app instead of + the default file (called metadata). This is useful + if you build multiple things from a single build tree (such as both a + platform and a sdk). +

--log-session-bus

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

--log-system-bus

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

Examples

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

See also

+ flatpak(1), + flatpak-build-init(1), + flatpak-build-finish(1), + flatpak-build-export(1) +

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

+ Show help options and exit. +

--list

+ Print all keys and their values +

--set

+ Set key KEY to VALUE +

--unset

+ Unset key KEY +

--get

+ Print value of KEY. +

--user

+ Configure per-user installation. +

--system

+ Configure system-wide installation. +

--installation=NAME

+ Configure the system-wide installation + specified by NAME among those defined in + /etc/flatpak/installations.d/. Using + --installation=default is equivalent to using + --system . +

Examples

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

See also

+ flatpak(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 + fuse filesystem at /run/user/$UID/doc/. +

+ This command also lets you modify the per-application + permissions of the documents, granting or revoking access + to the file on a per-application basis. +

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 + document when you're finished with it. +

-t, --transient

+ The document will only exist for the length of + the session. This is useful for temporary grants. +

-n, --noexist

+ Don't require the file to exist already. +

-a, --app=APPID

+ Grant read access to the specified application. The + --allow and --forbid options can be used to grant + or remove additional privileges. + This option can be used multiple times. +

-r, --allow-read

+ Grant read access to the applications specified with --app. + This defaults to TRUE. +

--forbid-read

+ Revoke read access for the applications specified with --app. +

-w, --allow-write

+ Grant write access to the applications specified with --app. +

--forbid-write

+ Revoke write access for the applications specified with --app. +

-d, --allow-delete

+ Grant the ability to remove the document from the document portal to the applications specified with --app. +

--forbid-delete

+ Revoke the ability to remove the document from the document portal from the applications specified with --app. +

-g, --allow-grant-permission

+ Grant the ability to grant further permissions to the applications specified with --app. +

--forbid-grant-permission

+ Revoke the ability to grant further permissions for the applications specified with --app. +

-v, --verbose

+ Print debug information during command processing. +

--version

+ Print version information and exit. +

Examples

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

-Commit: 9d0044ea480297114d03aec85c3d7ae3779438f9d2cb69d717fb54237acacb8c
-Metadata Total: 605
-Metadata Written: 5
-Content Total: 1174
-Content Written: 1
-Content Bytes Written: 305
-

See also

- ostree(1), - flatpak(1), - flatpak-build-export(1), - flatpak-build(1), -

Name

flatpak-builder — Help build application dependencies

Synopsis

flatpak-builder [OPTION...] DIRECTORY MANIFEST

flatpak-builder --run [OPTION...] DIRECTORY MANIFEST COMMAND

flatpak-builder --show-deps [OPTION...] MANIFEST

Description

- flatpak-builder is a wrapper around the flatpak build command - that automates the building of applications and their dependencies. It is one option you can use - to build applications. +/run/user/1000/doc/e52f9c6a/test.txt +

See also

+ flatpak(1), + flatpak-document-unexport(1), + flatpak-document-info(1), + flatpak-document-list(1) +

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.

- The goal of flatpak-builder is to push as much knowledge about how to build modules to - the individual upstream projects. It does this by assuming that the modules adhere to the Build API specified - at https://github.com/cgwalters/build-api. This essentially means that it follows the ./configure - && make && make install scheme with an optional autogen script. If the upstream - does not adhere to the API you can make it do so by adding patches and extra files. + FILE can either be a file in the fuse filesystem at /run/user/$UID/doc/, + or a file anywhere else. +

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

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

+id: dd32c34a
+path: /run/user/1000/doc/dd32c34a/gail-3.0.pc
+origin: /home/mclasen/Sources/gtk/gail-3.0.pc
+permissions:
+        org.gnome.gedit read, write
+

See also

+ flatpak(1), + flatpak-document-export(1), + flatpak-document-unexport(1), + flatpak-document-list(1) +

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

+ Show help options and exit. +

-v, --verbose

+ Print debug information during command processing. +

--version

+ Print version information and exit. +

See also

+ flatpak(1), + flatpak-document-export(1), + flatpak-document-unexport(1), + flatpak-document-info(1) +

Name

flatpak-document-unexport — Stop exporting a file

Synopsis

flatpak document-export [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

+ Show help options and exit. +

-v, --verbose

+ Print debug information during command processing. +

--version

+ Print version information and exit. +

See also

+ flatpak(1), + flatpak-document-export(1), + flatpak-document-info(1), + flatpak-document-list(1) +

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. + Extra arguments are passed on to the command.

- An invocation of flatpak-builder proceeds in these stages, each being specified - in detail in json format in MANIFEST : -

  • Download all sources

  • Initialize the application directory with flatpak build-init

  • Build and install each module with flatpak build

  • Clean up the final build tree by removing unwanted files and e.g. stripping binaries

  • Finish the application directory with flatpak build-finish

- - After this you will end up with a build of the application in DIRECTORY , which you can - export to a repository with the flatpak build-export command. If you use the --repo - option, flatpack-builder will do the export for you at the end of the build process. When flatpak-builder does the - export, it also stores the manifest that was used for the build in /app/manifest.json. The manifest is 'resolved', - i.e. git branch names are replaced by the actual commit IDs that were used in the build. + This creates a new process within the running sandbox, with the same environment. This is useful + when you want to debug a problem with a running application.

- At each of the above steps flatpak caches the result, and if you build the same file again, it will start - of at the first step where something changes. For instance the first version controlled source that had - new commits added, or the first module where some changes to the MANIFEST file caused - the build environment to change. This makes flatpak-builder very efficient for incremental builds. -

Manifest format

Toplevel

- The top level of the json file describes global - attributes of the application, and how it can be - build, and the list of modules that need to be - built. -

- These are the properties that are accepted: -

id or app-id (string)

A string defining the application id.

branch (string)

The branch of the application, defaults to master.

runtime (string)

The name of the runtime that the application uses.

runtime-version (string)

The version of the runtime that the application uses, defaults to master.

sdk (string)

The name of the development runtime that the application builds with.

var (string)

Initialize the (otherwise empty) writable /var in the build with a copy of this runtime.

metadata (string)

Use this file as the base metadata file when finishing.

command (string)

The filename or path to the main binary of the application. Note that this is really just a single file, not a commandline. If you want to pass arguments, install a shell script wrapper and use that as the command.

build-runtime (boolean)

Build a new runtime instead of an application.

separate-locales (boolean)

Separate out locale files and translations to an extension runtime. Defaults to true.

id-platform (string)

When building a runtime sdk, also create a platform based on it with this id.

metadata-platform (string)

The metadata file to use for the platform we create.

writable-sdk (boolean)

If true, use a writable copy of the sdk for /usr. - Defaults to true if --build-runtime is specified.

appstream-compose (boolean)

Run appstream-compose during cleanup phase. Defaults to true.

sdk-extensions (array of strings)

Install these extra sdk extensions in /usr.

platform-extensions (array of strings)

Install these extra sdk extensions when creating the platform.

base (string)

Start with the files from the specified application. This can be - used to create applications that extend another application.

base-version (string)

Use this specific version of the application specified in base. - If unspecified, this uses the value specified in branch

base-extensions (array of strings)

Install these extra extensions from the base application when initializing - the application directory.

tags (array of strings)

Add these tags to the metadata file.

build-options (object)

Object specifying the build environment. See below for details.

modules (array of objects or string)

An array of objects specifying the modules to be built in order. - String members in the array are interpreted as the name of a separate json file that contains a module. - See below for details.

cleanup (array of strings)

An array of file patterns that should be removed at the end. - Patterns starting with / are taken to be full pathnames (without the /app prefix), otherwise they just match - the basename.

cleanup-commands (array of strings)

An array of commandlines that are run during the cleanup phase.

cleanup-platform (array of strings)

Extra files to clean up in the platform.

finish-args (array of strings)

An array of arguments passed to the flatpak build-finish command.

rename-desktop-file (string)

Any desktop file with this name will be renamed to a name based on id during the cleanup phase.

rename-appdata-file (string)

Any appdata file with this name will be renamed to a name based on id during the cleanup phase.

rename-icon (string)

Any icon with this name will be renamed to a name based on id during the cleanup phase.

copy-icon (boolean)

If rename-icon is set, keep a copy of the old icon file.

desktop-file-name-prefix (string)

This string will be prefixed to the Name key in the main application desktop file.

desktop-file-name-suffix (string)

This string will be suffixed to the Name key in the main application desktop file.

Build Options

- Build options specify the build environment of a module, and can be specified globally as - well as per-module. Options can also be specified on a per-architecture basis using the arch property. -

- These are the properties that are accepted: -

cflags (string)

This is set in the environment variable CFLAGS during the build.

cxxflags (string)

This is set in the environment variable CXXFLAGS during the build.

prefix (string)

The build prefix for the modules (defaults to /app for - applications and /usr for runtimes).

env (object)

This is a dictionary defining environment variables to be set during the build.

build-args (array of strings)

This is an array containing extra options to pass to flatpak build.

strip (boolean)

If this is true (the default is false) then all ELF files will be stripped after install.

no-debuginfo (boolean)

By default (if strip is not true) flatpak-builder extracts all debug info in ELF files to a separate files - and puts this in an extension. If you want to disable this, set no-debuginfo to true.

arch (object)

This is a dictionary defining for each arch a separate build options object that override the main one.

Module

- Each module specifies a source that has to be separately built and installed. It contains - the build options and a list of sources to download and extract before building. -

- Modules can be nested, in order to turn related modules on and off with a single key. -

- These are the properties that are accepted: -

name (string)

The name of the module, used in e.g. build logs. The name is also used for constructing filenames and commandline arguments, therefore using spaces or '/' in this string is a bad idea.

disabled (boolean)

If true, skip this module

sources (array of objects)

An array of objects defining sources that will be downloaded and extracted in order

config-opts (array of strings)

An array of options that will be passed to configure

make-args (array of strings)

An array of arguments that will be passed to make

make-install-args (array of strings)

An array of arguments that will be passed to make install

rm-configure (boolean)

If true, remove the configure script before starting build

no-autogen (boolean)

Ignore the existence of an autogen script

no-parallel-make (boolean)

Don't call make with arguments to build in parallel

no-python-timestamp-fix (boolean)

Don't fix up the *.py[oc] header timestamps for ostree use.

cmake (boolean)

Use cmake instead of configure

builddir (boolean)

Use a build directory that is separate from the source directory

subdir (string)

Build inside this subdirectory of the extracted sources

build-options (object)

A build options object that can override global options

post-install (array of strings)

An array of shell commands that are run after the install phase. Can for example - clean up the install dir, or install extra files. -

cleanup (array of strings)

An array of file patterns that should be removed at the end. - Patterns starting with / are taken to be full pathnames (without the /app prefix), otherwise they just match - the basename. Note that any patterns will only match files installed by this module. -

cleanup-platform (array of strings)

Extra files to clean up in the platform.

modules (array of objects or strings)

An array of objects specifying nested modules to be built before this one. - String members in the array are interpreted as names of a separate json file that contains a module.

Sources

- These contain a pointer to the source that will be extracted into the source directory before - the build starts. They can be of several types, distinguished by the type property. -

Archive sources (tar, zip)

type

"archive"

path (string)

The path of the archive

url (string)

The URL of a remote archive that will be downloaded. This overrides path if both are specified.

sha256 (string)

The sha256 checksum of the file, verified after download

strip-components (integer)

The number of initial pathname components to strip during extraction. Defaults to 1.

dest (string)

Directory inside the source dir where the archive will be extracted.

Git sources

type

"git"

path (string)

The path to a local checkout of the git repository. Due to how git-clone works, this will be much faster than specifying a URL of file:///...

url (string)

URL of the git repository. This overrides path if both are specified.

branch (string)

The branch/tag/commit to use from the git repository

dest (string)

Directory inside the source dir where the repository will be checked out.

Bzr sources

type

"bzr"

url (string)

URL of the bzr repository

revision (string)

A specific revision to use in the branch

dest (string)

Directory inside the source dir where the repository will be checked out.

File sources

type

"file"

path (string)

The path of a local file that will be copied into the source dir

url (string)

The URL of a remote file that will be downloaded and copied into the source dir. This overrides path if both are specified.

sha256 (string)

The sha256 checksum of the file, verified after download. This is optional for local files.

dest-filename (string)

Filename to use inside the source dir, default to the basename of path.

dest (string)

Directory inside the source dir where the file will be copied.

Script sources

- This is a way to create a shell (/bin/sh) script from an inline set of commands. -

type

"script"

commands (array of strings)

An array of shell commands that will be put in a shellscript file

dest-filename (string)

Filename to use inside the source dir, default to the basename of path.

dest (string)

Directory inside the source dir where the file will be copied.

Shell sources

- This is a way to create/modify the sources by running shell commands. -

type

"shell"

commands (array of strings)

An array of shell commands that will be run during source extraction

Patch sources

type

"patch"

path (string)

The path of a patch file that will be applied in the source dir

strip-components (integer)

The value of the -p argument to patch, defaults to 1.

dest (string)

Directory inside the source dir where the patch will be applied.

use-git (boolean)

Whether to use "git apply" rather than "patch" to apply the patch, required when the patch file contains binary diffs.

Options

The following options are understood:

-h, --help

+ This command requires extra privileges, so must be run as root or via e.g. sudo. +

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

+ $ flatpak enter 15345 sh +

See also

+ flatpak(1), + flatpak-run(1) +

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

+ By default, the output is formatted in a friendly format. + If you specify one of the options --show-ref, --show-commit, + --show-origin, --show-metadata or --show-size, the output is instead formatted + in a machine-readable format. +

+ By default, both per-user and system-wide installations + are queried. Use the --user, --system or --installation + options to change this. +

Options

The following options are understood:

-h, --help

+ Show help options and exit. +

--user

+ Query per-user installations. +

--system

+ Query the default system-wide installation. +

--installation=NAME

+ Query a system-wide installation by NAME among + those defined in /etc/flatpak/installations.d/. + Using --installation=default is equivalent to using + --system . +

--arch=ARCH

+ Query for this architecture. +

-r, --show-ref

+ Show the installed ref. +

-o, --show-origin

+ Show the remote the ref is installed from. +

-c, --show-commit

+ Show the installed commit id. +

-s, --show-size

+ Show the installed size. +

-m, --show-metadata

+ Show the metadata. +

-e, --show-extensions

+ Show the matching extensions. +

-v, --verbose

+ Print debug information during command processing. +

--version

+ Print version information and exit. +

Examples

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

See also

+ flatpak(1), + flatpak-install(1), + flatpak-update(1) +

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 + application or runtime to install. +

+ Each REF argument is a full or partial indentifier in the + flatpak ref format, which looks like "(app|runtime)/ID/ARCH/BRANCH". All elements + except ID are optional and can be left out, including the slashes, + so most of the time you need only specify ID. Any part left out will be matched + against what is in the remote, and if there are multiple matches an error message + will list the alternatives. +

+ By default this looks for both apps and runtimes with the given REF in + the specified REMOTE , but you can limit this by using the --app or + --runtime option, or by supplying the initial element in the REF. +

+ If REMOTE is a uri or a path (absolute or relative starting with ./) + to a local repository, then that repository will be used as the source, and a temporary remote + will be created for the lifetime of the REF . +

+ The alternative form of the command ([--from] or + [--bundle] allows you to + install directly from a source such as a .flatpak + single-file bundle, a .flatpakref app description. The options are optional if the first + argument have the right extension. +

+ Note that flatpak allows one to have multiple branches of an application and runtimes + installed and used at the same time. However, only version of an application one can be current, + meaning its exported files (for instance desktop files and icons) are + visible to the host. The last installed version is made current by + default, but you can manually change with make-current. +

+ Unless overridden with the --user or the --installation option, this command installs + the application or runtime in the default system-wide installation. +

Options

The following options are understood:

-h, --help

+ Show help options and exit. +

--bundle

+ Assume LOCATION is a .flatpak single-bundle file. + This is optional if the arguments ends with .flatpak. +

--from

+ Assume LOCATION is a .flatpakref file containing the details of the app to be installed. + This is optional if the arguments ends with .flatpakref. +

--user

+ Install the application or runtime in a per-user installation. +

--system

+ Install the application or runtime in the default system-wide installation. +

--installation=NAME

+ Install the application or runtime in a system-wide installation + specified by NAME among those defined in + /etc/flatpak/installations.d/. Using + --installation=default is equivalent to using + --system . +

--arch=ARCH

+ The default architecture to install for, if not given explicitly in the REF . +

--subpath=PATH

+ Install only a subpath of the ref. This is mainly used to install a subset of locales. + This can be added multiple times to install multiple subpaths., +

--gpg-file=FILE

+ Check bundle signatures with GPG key from FILE (- for stdin). +

--no-deploy

+ Download the latest version, but don't deploy it. +

--no-pull

+ Don't download the latest version, deploy whatever is locally available. +

--no-related

+ Don't download related extensions, such as the locale data. +

--no-deps

+ Don't verify runtime dependencies when installing. +

--app

+ Assume that all REF s are apps if not explicitly specified. +

--runtime

+ Assume that all REF s are runtimes if not explicitly specified. +

-y, --assumeyes

+ Automatically answer yes to all questions (or pick the most prioritized answer). This is useful for automation. +

-v, --verbose

+ Print debug information during command processing. +

--ostree-verbose

+ Print OSTree debug information during command processing. +

--version

+ Print version information and exit. +

Examples

+ $ flatpak install gnome org.gnome.gedit2 +

+ $ flatpak --installation=default install gnome org.gnome.gedit2 +

+ $ flatpak --user install gnome org.gnome.gedit//3.22 +

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

See also

+ flatpak(1), + flatpak-update(1), + flatpak-list(1), + flatpak-build-bundle(1), + flatpak-flatpakref(1) +

Name

flatpak-list — List installed applications and/or runtimes

Synopsis

flatpak list [OPTION...]

Description

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

+ By default, both per-user and system-wide installations + are shown. Use the --user, --installation or --system + options to change this. +

+ By default this lists both installed apps and runtime, but you can + change this by using the --app or --runtime option. +

Options

The following options are understood:

-h, --help

+ Show help options and exit. +

--user

+ List per-user installations. +

--system

+ List the default system-wide installations. +

--installation=NAME

+ List a system-wide installation specified by NAME + among those defined in /etc/flatpak/installations.d/. + Using --installation=default is equivalent to using + --system . +

--arch=ARCH

+ List installations for this architecture. +

-d, --show-details

+ Show origin, sizes and other extra information. +

--app

+ List applications. +

--runtime

+ List runtimes. +

--all, -a

+ List all installed runtimes, including locale and debug extensions. These are hidden by default. +

-v, --verbose

+ Print debug information during command processing. +

--ostree-verbose

+ Print OSTree debug information during command processing. +

--version

+ Print version information and exit. +

Examples

+ $ flatpak --user list + 

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

See also

+ flatpak(1), + flatpak-install(1), + flatpak-update(1) +

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

+ When a new branch is installed it will automatically be made current, so this + command is often not needed. +

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

Options

The following options are understood:

-h, --help

+ Show help options and exit. +

--user

+ Update a per-user installation. +

--system

+ Update the default system-wide installation. +

--installation=NAME

+ Updates a system-wide installation specified by NAME + among those defined in /etc/flatpak/installations.d/. + Using --installation=default is equivalent to using + --system . +

--arch=ARCH

+ The architecture to install for. +

-v, --verbose

+ Print debug information during command processing. +

--version

+ Print version information and exit. +

Examples

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

See also

+ flatpak(1), + flatpak-install(1), + flatpak-list(1) +

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

+ By default the application gets access to the resources it + requested when it is started. But the user can override it + on a particular instance by specifying extra arguments to + flatpak run, or every time by using flatpak override. +

+ If the application id is not specified then the overrides affect all applications, + but the per-application overrides can override the global overrides. +

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

Options

The following options are understood:

-h, --help

+ Show help options and exit. +

--user

+ Update a per-user installation. +

--system

+ Update the default system-wide installation. +

--installation=NAME

+ Updates a system-wide installation specified by NAME + among those defined in /etc/flatpak/installations.d/. + Using --installation=default is equivalent to using + --system . +

--share=SUBSYSTEM

+ Share a subsystem with the host session. This overrides + the Context section from the application metadata. + SUBSYSTEM must be one of: network, ipc. + This option can be used multiple times. +

--unshare=SUBSYSTEM

+ Don't share a subsystem with the host session. This overrides + the Context section from the application metadata. + SUBSYSTEM must be one of: network, ipc. + This option can be used multiple times. +

--socket=SOCKET

+ Expose a well-known socket to the application. This overrides to + the Context section from the application metadata. + SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus. + This option can be used multiple times. +

--nosocket=SOCKET

+ Don't expose a well-known socket to the application. This overrides to + the Context section from the application metadata. + SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus. + This option can be used multiple times. +

--device=DEVICE

+ Expose a device to the application. This overrides to + the Context section from the application metadata. + DEVICE must be one of: dri, kvm, all. + This option can be used multiple times. +

--nodevice=DEVICE

+ Don't expose a device to the application. This overrides to + the Context section from the application metadata. + DEVICE must be one of: dri, kvm, all. + This option can be used multiple times. +

--allow=FEATURE

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

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

+ The multiarch feature allows the application to + execute programs compiled for an ABI other than the one supported + natively by the system. For example, for the x86_64 + architecture, 32-bit x86 binaries will be allowed as + well. +

--disallow=FEATURE

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

--filesystem=FS

+ Allow the application access to a subset of the filesystem. + This overrides to the Context section from the application metadata. + FS can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run, + xdg-config, xdg-cache, xdg-data, + an absolute path, or a homedir-relative path like ~/dir or paths + relative to the xdg dirs, like xdg-download/subdir. + The optional :ro suffix indicates that the location will be read-only. + The optional :create suffix indicates that the location will be read-write and created if it doesn't exist. + This option can be used multiple times. +

--nofilesystem=FILESYSTEM

+ Remove access to the specified subset of the filesystem from + the application. This overrides to the Context section from the + application metadata. + FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, + an absolute path, or a homedir-relative path like ~/dir. + This option can be used multiple times. +

--add-policy=SUBSYSTEM.KEY=VALUE

+ Add generic policy option. For example, "--add-policy=subsystem.key=v1 --add-policy=subsystem.key=v2" would map to this metadata: +

+[Policy subsystem]
+key=v1;v2;
+

+

+ This option can be used multiple times. +

--remove-policy=SUBSYSTEM.KEY=VALUE

+ Remove generic policy option. This option can be used multiple times. +

--env=VAR=VALUE

+ Set an environment variable in the application. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +

--own-name=NAME

+ Allow the application to own the well-known name NAME on the session bus. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +

--talk-name=NAME

+ Allow the application to talk to the well-known name NAME on the session bus. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +

--system-own-name=NAME

+ Allow the application to own the well known name NAME on the system bus. + If NAME ends with .*, it allows the application to own all matching names. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +

--system-talk-name=NAME

+ Allow the application to talk to the well known name NAME on the system bus. + If NAME ends with .*, it allows the application to talk to all matching names. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +

--persist=FILENAME

+ If the application doesn't have access to the real homedir, make the (homedir-relative) path + FILENAME a bind mount to the corresponding path in the per-application directory, + allowing that location to be used for persistent data. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +

-v, --verbose

+ Print debug information during command processing. +

--version

+ Print version information and exit. +

Examples

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

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

See also

+ flatpak(1), + flatpak-run(1) +

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 + [LOCATION] is either a flatpak repository, or a + .flatpakrepo file which describes a repository. In the + former case you may also have to specify extra options, + such as the gpg key for the repo. +

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

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 + by default if the extension is .flatpakrepo, so generally you don't need this option. +

--user

+ Modify the per-user configuration. +

--system

+ Modify the default system-wide configuration. +

--installation=NAME

+ Modify a system-wide installation specified by NAME + among those defined in /etc/flatpak/installations.d/. + Using --installation=default is equivalent to using + --system . +

--no-gpg-verify

+ Disable GPG verification for the added remote. +

--prio=PRIO

+ Set the priority for the remote. Default is 1, higher is more prioritized. This is + mainly used for graphical installation tools. +

--no-enumerate

+ Mark the remote as not enumerated. This means the remote will + not be used to list applications, for instance in graphical + installation tools. +

--no-use-for-deps

+ Mark the remote as not to be used for automatic runtime + dependency resolution. +

--if-not-exists

+ Do nothing if the provided remote already exists. +

--disable

+ Disable the added remote. +

--title=TITLE

+ A title for the remote, e.g. for display in a UI. +

--default-branch=BRANCH

+ A default branch for the remote, mainly for use in a UI. +

--gpg-import=FILE

+ Import gpg keys from the specified keyring file as + trusted for the new remote. If the file is - the + keyring is read from standard input. +

--oci

+ This is a OCI format registry rather than a regular + flatpak repository. +

-v, --verbose

+ Print debug information during command processing. +

--ostree-verbose

+ Print OSTree debug information during command processing. +

--version

+ Print version information and exit. +

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

See also

+ flatpak(1), + flatpak-remote-modify(1), + flatpak-remote-delete(1), + flatpak-remotes(1), + flatpak-flatpakrepo(1) +

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

+ 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

+ Show help options and exit. +

--user

+ Modify the per-user configuration. +

--system

+ Modify the default system-wide configuration. +

--installation=NAME

+ Modify a system-wide installation specified by NAME + among those defined in /etc/flatpak/installations.d/. + Using --installation=default is equivalent to using + --system . +

--force

+ Remove remote even if its in use by installed apps or runtimes. +

-v, --verbose

+ Print debug information during command processing. +

--ostree-verbose

+ Print OSTree debug information during command processing. +

--version

+ Print version information and exit. +

Examples

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

See also

+ flatpak(1), + flatpak-remote-add(1), + flatpak-remote-modify(1), + flatpak-remotes(1) +

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

+ By default, the output is formatted in a friendly format. + If you specify one of the options --show-ref, --show-commit, + --show-parent, or --show-metadata, the output is instead formatted + in a machine-readable format. +

+ Unless overridden with the --system, --user, or --installation options, + this command uses either the default system-wide installation or the + per-user one, depending on which has the specified + REMOTE . +

Options

The following options are understood:

-h, --help

+ Show help options and exit. +

--user

+ Use the per-user configuration. +

--system

+ Use the default system-wide configuration. +

--installation=NAME

+ Use a system-wide installation specified by NAME + among those defined in /etc/flatpak/installations.d/. + Using --installation=default is equivalent to using + --system . +

--runtime

+ Assume that REF is a runtime if not explicitly specified. +

--app

+ Assume that REF is an app if not explicitly specified. +

--arch=ARCH

+ The default architecture to look for, if not given explicitly in the REF . +

--commit=COMMIT

+ Show information about the specific commit, rather than the latest version. +

--log

+ Display a log of previous versions. +

-r, --show-ref

+ Show the matched ref. +

-c, --show-commit

+ Show the commit id. +

-p, --show-parent

+ Show the parent commit id. +

-m, --show-metadata

+ Show the metadata. +

-v, --verbose

+ Print debug information during command processing. +

--ostree-verbose

+ Print OSTree debug information during command processing. +

Examples

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

+Ref: app/org.gnome.gedit/x86_64/stable
+ID: org.gnome.gedit
+Arch: x86_64
+Branch: stable
+Date: 2017-07-31 16:05:22 +0000
+Subject: Build org.gnome.gedit at 3ec291fc1ce4d78220527fa79576f4cc1481ebe5
+Commit: 3de7e9dde3bb8382aad9dfbbff20eccd9bf2100bc1887a3619ec0372e8066bf7
+Parent: -
+Download size: 3,4 MB
+Installed size: 11,1 MB
+Runtime: org.gnome.Platform/x86_64/3.24
+

See also

+ flatpak(1), + flatpak-remotes(1) + flatpak-remote-ls(1) +

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

+ 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

+ Show help options and exit. +

--user

+ Use the per-user configuration. +

--system

+ Use the default system-wide configuration. +

--installation=NAME

+ Use a system-wide installation specified by NAME + among those defined in /etc/flatpak/installations.d/. + Using --installation=default is equivalent to using + --system . +

-d, --show-details

+ Show arches, branches and commit ids, in addition to the names. +

--runtime

+ Show only runtimes, omit applications. +

--app

+ Show only applications, omit runtimes. +

--all, -a

Show everything. By default locale and + debug extensions as well as secondary arches when the primary + arch in available are hidden. +

--updates

+ Show only those which have updates available. +

--arch=ARCH

+ Show only those matching the specied architecture. By default, only + supported architectures are shown. Use --arch=* to show all archtectures. +

-v, --verbose

+ Print debug information during command processing. +

--ostree-verbose

+ Print OSTree debug information during command processing. +

--version

+ Print version information and exit. +

Examples

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

+org.gnome.Builder
+org.freedesktop.glxgears
+

See also

+ flatpak(1), + flatpak-remotes(1) +

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

+ 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

+ Show help options and exit. +

--user

+ Modify the per-user configuration. +

--system

+ Modify the default system-wide configuration. +

--installation=NAME

+ Modify a system-wide installation specified by NAME + among those defined in /etc/flatpak/installations.d/. + Using --installation=default is equivalent to using + --system . +

--no-gpg-verify

+ Disable GPG verification for the added remote. +

--gpg-verify

+ Enable GPG verification for the added remote. +

--prio=PRIO

+ Set the priority for the remote. Default is 1, higher is more prioritized. This is + mainly used for graphical installation tools. +

--no-enumerate

+ Mark the remote as not enumerated. This means the remote will + not be used to list applications, for instance in graphical + installation tools. +

--no-use-for-deps

+ Mark the remote as not to be used for automatic runtime + dependency resolution. +

--disable

+ Disable the remote. Disabled remotes will not be automatically updated from. +

--enable

+ Enable the remote. +

--enumerate

+ Mark the remote as enumerated. This means the remote will + be used to list applications, for instance in graphical + installation tools. +

--use-for-deps

+ Mark the remote as to be used for automatic runtime + dependency resolution. +

--title=TITLE

+ A title for the remote, e.g. for display in a UI. +

--default-branch=BRANCH

+ A default branch to for the remote, mainly for use in a UI. +

--url=URL

+ Set a new URL. +

--update-metadata

+ A default branch to for the remote, mainly for use in a UI. +

+ Update the remote's extra metadata from the OSTree repository's summary + file. Only xa.title and xa.default-branch are supported at the moment. +

--gpg-import=FILE

+ Import gpg keys from the specified keyring file as + trusted for the new remote. If the file is - the + keyring is read from standard input. +

-v, --verbose

+ Print debug information during command processing. +

--ostree-verbose

+ Print OSTree debug information during command processing. +

--version

+ Print version information and exit. +

Examples

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

See also

+ flatpak(1), + flatpak-remote-add(1), + flatpak-remote-delete(1), + flatpak-remotes(1) +

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

+ Show help options and exit. +

--user

+ Show the per-user configuration. +

--system

+ Show the default system-wide configuration. +

--installation=NAME

+ Show a system-wide installation by NAME among + those defined in /etc/flatpak/installations.d/. + Using --installation=default is equivalent to using + --system . +

-d, --show-details

+ Show more information for each repository in addition to the name. +

--show-disabled

+ Show disabled repos. +

-v, --verbose

+ Print debug information during command processing. +

--ostree-verbose

+ Print OSTree debug information during command processing. +

--version

+ Print version information and exit. +

Examples

+ $ flatpak remotes --user --show-details + 

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

See also

+ flatpak(1), + flatpak-remote-add(1), + flatpak-remote-delete(1) +

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

+ Show help options and exit. +

--info

+ Print general information about a local repository. +

--branches

+ List the branches in a local repository. +

--metadata=BRANCH

+ Print metadata for a branch in the repository. +

Examples

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

See also

+ flatpak(1), + flatpak-info(1) +

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

+ If REF names a runtime, a shell is opened in the + runtime. This is useful for development and testing. +

+ flatpak creates a sandboxed environment for the application to run in + by mounting the right runtime at /usr and a writable + directory at /var, whose content is preserved between + application runs. The application itself is mounted at /app. +

+ The details of the sandboxed environment are controlled by the application + metadata and various options like --share and --socket that are passed to the run + command: Access is allowed if it was requested either in the application + metadata file or with an option and the user hasn't overridden it. +

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

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.

--arch=ARCH

- Specify the machine architecture to build for. If no architecture is specified, the host architecture will be automatically detected. Only host compatible architectures can be specified. -

--disable-cache

- Don't look at the existing cache for a previous build, instead always rebuild modules. -

--disable-download

- Don't download any sources. This only works if some version of all sources are downloaded - already. This is useful if you want to guarantee that no network i/o is done. However, the - build will fail if some source is not locally available. -

--disable-updates

- Download missing sources, but don't update local mirrors of version control repos. This is useful - to rebuild things but without updating git or bzr repositories from the remote repository. -

--run

- Run a command in a sandbox based on the build dir. This starts flatpak build, with some extra - arguments to give the same environment as the build, and the same permissions the final app - will have. The command to run must be the last argument passed to - flatpak-builder, after the directory and the manifest. -

--show-deps

- List all the (local) files that the manifest depends on. -

--download-only

- Exit successfully after downloading the required sources. -

--build-only

- Don't do the cleanup and finish stages, which is useful if you - want to build more things into the app. -

--finish-only

- Only do the cleanup, finish and export stages, picking up - where a --build-only command left off. -

--require-changes

- Do nothing, leaving a non-existent DIRECTORY if nothing changes since - last cached build. If this is not specified, the latest version from the cache will be put - into DIRECTORY . -

--keep-build-dirs

- Don't remove the sources and build after having built and installed each module. - This also creates a symlink to the build directory with a stable name ("build-modulename"). -

--ccache

- Enable use of ccache in the build (needs ccache in the sdk) -

--stop-at=MODULENAME

- Stop building at the specified module, ignoring all the following ones. - This is useful for debugging and development. For instance, you can - build all the dependencies, but stop at the main application so that - you can then do a build from a pre-existing checkout. - Implies --build-only. -

--repo=DIR

- When build is done, run export the result to this repository. -

-s, --subject=SUBJECT

- One line subject for the commit message. - Used when exporting the build results. -

-b, --body=BODY

- Full description for the commit message. - Used when exporting the build results. -

--gpg-sign=KEYID

- Sign the commit with this GPG key. - Used when exporting the build results. + The architecture to install for. +

--command=COMMAND

+ The command to run instead of the one listed in the application metadata. +

--branch=BRANCH

+ The branch to use. +

-d, --devel

+ Use the devel runtime that is specified in the application metadata instead of the regular runtime, and use a seccomp profile that is less likely to break development tools. +

--runtime=RUNTIME

+ Use this runtime instead of the one that is specified in the application metadata. + This is a full tuple, like for example org.freedesktop.Sdk/x86_64/1.2 , but + partial tuples are allowed. Any empty or missing parts are filled in with the corresponding + values specified by the app. +

--runtime-version=VERSION

+ Use this version of the runtime instead of the one that is specified in the application metadata. + This overrides any version specified with the --runtime option. +

--share=SUBSYSTEM

+ Share a subsystem with the host session. This overrides + the Context section from the application metadata. + SUBSYSTEM must be one of: network, ipc. This option can be used multiple times. -

--gpg-homedir=PATH

- GPG Homedir to use when looking for keyrings. - Used when exporting the build results. -

--force-clean

- Erase the previous contents of DIRECTORY if it is - not empty. -

--sandbox

- Disable the possibility to specify build-args that - are passed to flatpak build. This means the build - process can't break out of its sandbox, and is - useful when building less trusted software. -

--allow-missing-runtimes

- Do not immediately fail if the sdk or platform runtimes - are not installed on this system. Attempting to build any - manifest modules will still fail if the sdk is missing, but - may be useful for apps that install files without a sandbox - build. -

Caching

- flatpak-builder caches sources and partial build results in - the .flatpak-builder subdirectory of the current directory. If you - use --keep-build-dirs, build directories for each - module are also stored here. +

--unshare=SUBSYSTEM

+ Don't share a subsystem with the host session. This overrides + the Context section from the application metadata. + SUBSYSTEM must be one of: network, ipc. + This option can be used multiple times. +

--socket=SOCKET

+ Expose a well known socket to the application. This overrides to + the Context section from the application metadata. + SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus. + This option can be used multiple times. +

--nosocket=SOCKET

+ Don't expose a well known socket to the application. This overrides to + the Context section from the application metadata. + SOCKET must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus. + This option can be used multiple times. +

--device=DEVICE

+ Expose a device to the application. This overrides to + the Context section from the application metadata. + DEVICE must be one of: dri, kvm, all. + This option can be used multiple times. +

--nodevice=DEVICE

+ Don't expose a device to the application. This overrides to + the Context section from the application metadata. + DEVICE must be one of: dri, kvm, all. + This option can be used multiple times. +

--allow=FEATURE

+ Allow access to a specific feature. This overrides to + the Context section from the application metadata. + FEATURE must be one of: devel, multiarch. + This option can be used multiple times. +

--disallow=FEATURE

+ Disallow access to a specific feature. This overrides to + the Context section from the application metadata. + FEATURE must be one of: devel, multiarch. + This option can be used multiple times. +

--filesystem=FS

+ Allow the application access to a subset of the filesystem. + This overrides to the Context section from the application metadata. + FS can be one of: home, host, xdg-desktop, xdg-documents, xdg-download, + xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, + xdg-run, xdg-config, xdg-cache, xdg-data, + an absolute path, or a homedir-relative path like ~/dir or paths + relative to the xdg dirs, like xdg-download/subdir. + The optional :ro suffix indicates that the location will be read-only. + The optional :create suffix indicates that the location will be read-write and created if it doesn't exist. + This option can be used multiple times. +

--nofilesystem=FILESYSTEM

+ Remove access to the specified subset of the filesystem from + the application. This overrides to the Context section from the + application metadata. + FILESYSTEM can be one of: home, host, xdg-desktop, xdg-documents, xdg-download + xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, + an absolute path, or a homedir-relative path like ~/dir. + This option can be used multiple times. +

--add-policy=SUBSYSTEM.KEY=VALUE

+ Add generic policy option. For example, "--add-policy=subsystem.key=v1 --add-policy=subsystem.key=v2" would map to this metadata: +

+[Policy subsystem]
+key=v1;v2;
+

+

+ This option can be used multiple times. +

--remove-policy=SUBSYSTEM.KEY=VALUE

+ Remove generic policy option. This option can be used multiple times. +

--env=VAR=VALUE

+ Set an environment variable in the application. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +

--own-name=NAME

+ Allow the application to own the well known name NAME on the session bus. + If NAME ends with .*, it allows the application to own all matching names. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +

--talk-name=NAME

+ Allow the application to talk to the well known name NAME on the session bus. + If NAME ends with .*, it allows the application to talk to all matching names. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +

--system-own-name=NAME

+ Allow the application to own the well known name NAME on the system bus. + If NAME ends with .*, it allows the application to own all matching names. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +

--system-talk-name=NAME

+ Allow the application to talk to the well known name NAME on the system bus. + If NAME ends with .*, it allows the application to talk to all matching names. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +

--persist=FILENAME

+ If the application doesn't have access to the real homedir, make the (homedir-relative) path + FILENAME a bind mount to the corresponding path in the per-application directory, + allowing that location to be used for persistent data. + This overrides to the Context section from the application metadata. + This option can be used multiple times. +

--log-session-bus

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

--log-system-bus

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

--file-forwarding

+ If this option is specified, the remaining arguments are scanned, and all arguments + that are enclosed between a pair of '@@' arguments are interpreted as file paths, + exported in the document store, and passed to the command in the form of the + resulting document path. Arguments between '@@u' and '@@' are considered uris, + and any file: uris are exported. The exports are non-persistent and with read and write + permissions for the application. +

Examples

+ $ flatpak run org.gnome.GEdit

- It is safe to remove the contents of the .flatpak-builder - directory. This will force a full build the next time you build. -

Examples

- $ flatpak-builder my-app-dir manifest.json + $ flatpak run --devel --command=bash org.gnome.Builder

- Example manifest file: - 

-{
-    "id": "org.test.TestApp",
-    "runtime": "org.freedesktop.Platform",
-    "runtime-version": "1.2",
-    "sdk": "org.freedesktop.Sdk",
-    "command": "test",
-    "clean": [ "/include", "*.la" ],
-    "build-options" : {
-        "cflags": "-O2 -g",
-        "cxxflags": "-O2 -g",
-        "env": {
-            "V": "1"
-        },
-        "arch": {
-            "x86_64": {
-                "cflags": "-O3 -g",
-            }
-        }
-    },
-    "modules": [
-        {
-            "name": "pygobject",
-            "config-opts": [ "--disable-introspection" ],
-            "sources": [
-                {
-                    "type": "archive",
-                    "url": "http://ftp.gnome.org/pub/GNOME/sources/pygobject/2.28/pygobject-2.28.6.tar.xz",
-                    "sha256": "fb8a1d4f665130a125011659bd347c7339c944232163dbb9a34fd0686577adb8"
-                },
-                {
-                    "type": "patch",
-                    "path": "required-pygobject-fix.patch"
-                },
-                {
-                    "type": "file",
-                    "path": "pygobject-extra-file",
-                    "dest-filename": "extra-file"
-                }
-            ]
-        },
-        {
-            "name": "babl",
-            "build-options" : { "cxxflags": "-O2 -g -std=c++11" },
-            "cleanup": [ "/bin" ],
-            "sources": [
-                {
-                    "type": "git",
-                    "url": "git://git.gnome.org/babl"
-                }
-            ]
-        },
-        {
-            "name": "testapp",
-            "sources": [
-                {
-                    "type": "bzr",
-                    "url": "lp:testapp"
-                }
-            ]
-        }
-    ]
-}
-

See also

- flatpak(1), - flatpak-build-init(1), - flatpak-build(1), - flatpak-build-finish(1), - flatpak-build-export(1) -

Name

flatpak-metadata — Information about an application or runtime

Description

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

See also

+ flatpak(1), + flatpak-override(1), + flatpak-enter(1) +

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

+ Only search through remotes in the per-user installation. +

--system

+ Only search through remotes in the default system-wide installation. +

--installation=NAME

+ Show a system-wide installation by NAME among + those defined in /etc/flatpak/installations.d/. + Using --installation=default is equivalent to using + --system . +

-h, --help

+ Show help options and exit. +

-v, --verbose

+ Print debug information during command processing. +

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 + flatpak ref format, which looks like "(app|runtime)/ID/ARCH/BRANCH". All elements + except ID are optional and can be left out, including the slashes, + so most of the time you need only specify ID. Any part left out will be matched + against what is installed, and if there are multiple matches an error message + will list the alternatives. +

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

+ Normally, this command removes the ref for this application/runtime from the + local OSTree repository and purges and objects that are no longer + needed to free up disk space. If the same application is later + reinstalled, the objects will be pulled from the remote repository + again. The --keep-ref option can be used to prevent this. +

+ If all branches of the application/runtime are removed, this command + also purges the data directory for the application. +

+ Unless overridden with the --user or the --installation option, this command updates + the default system-wide installation. +

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

--system

+ Updates the default system-wide installation. +

--installation=NAME

+ Updates a system-wide installation specified by NAME + among those defined in /etc/flatpak/installations.d/. + Using --installation=default is equivalent to using + --system . +

--arch=ARCH

+ The architecture to uninstall, instead of the architecture of + the host system. +

--app

+ Only look for an app with the given name. +

--runtime

+ Only look for a runtime with the given name. +

--no-related

+ Don't uninstall related extensions, such as the locale data. +

--force-remove

+ Remove files even if they're in use by a running application. +

-v, --verbose

+ Print debug information during command processing. +

--ostree-verbose

+ Print OSTree debug information during command processing. +

--version

+ Print version information and exit. +

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

+ Updates applications and runtimes. REF is a reference to the + application or runtime to update. If no REF is given, everything + is updated, as well as appstream info for all remotes. +

+ Each REF arguments is a full or partial indentifier in the + flatpak ref format, which looks like "(app|runtime)/ID/ARCH/BRANCH". All elements + except ID are optional and can be left out, including the slashes, + so most of the time you need only specify ID. Any part left out will be matched + against what is installed, and if there are multiple matches an error message + will list the alternatives. +

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

+ Normally, this command updates the application to the tip + of its branch. But it is possible to check out another commit, + with the --commit option. +

+ Note that updating a runtime is different from installing + a different branch, and runtime updates are expected to keep + strict compatibility. If an application update does cause + a problem, it is possible to go back to the previous + version, with the --commit option. +

+ Unless overridden with the --user, --system or --installation option, this command updates + any matching refs in the standard system-wide installation and the per-user one. +

Options

The following options are understood:

-h, --help

+ Show help options and exit. +

--user

+ Update a per-user installation. +

--system

+ Update the default system-wide installation. +

--installation=NAME

+ Updates a system-wide installation specified by NAME + among those defined in /etc/flatpak/installations.d/. + Using --installation=default is equivalent to using + --system . +

--arch=ARCH

+ The architecture to update for. +

--subpath=PATH

+ Install only a subpath of the ref. This is mainly used to install a subset of locales. + This can be added multiple times to install multiple subpaths. + If this is not specified the subpaths specified at install time are reused. +

--commit=COMMIT

+ Update to this commit, instead of the tip of the branch. +

--no-deploy

+ Download the latest version, but don't deploy it. +

--no-pull

+ Don't download the latest version, deploy whatever is locally available. +

--no-related

+ Don't download related extensions, such as the locale data. +

--no-deps

+ Don't update or install runtime dependencies when installing. +

--app

+ Only look for an app with the given name. +

--appstream

+ Update appstream for REMOTE , or all remotes if no remote is specified. +

--runtime

+ Only look for a runtime with the given name. +

-y, --assumeyes

+ Automatically answer yes to all questions (or pick the most prioritized answer). This is useful for automation. +

--force-remove

+ Remove old files even if they're in use by a running application. +

-v, --verbose

+ Print debug information during command processing. +

--ostree-verbose

+ Print OSTree debug information during command processing. +

--version

+ Print version information and exit. +

Examples

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

See also

+ flatpak(1), + flatpak-install(1), + flatpak-list(1) +

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 + command to do so. +

+ flatpakrepo files may also contain additional information that is useful + when displaying a remote to the user, e.g. in an app store. +

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

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

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

See also

+ flatpak(1), + flatpak-remote-add(1), + flatpak-flatpakref(5) +

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. + Use the flatpak install --from command to do so. +

+ flatpakref files may also contain additional information that is useful + when displaying the application to the user, e.g. in an app store. +

+ The filename extension commonly used for flatpakref files is .flatpakref. +

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

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

+[Flatpak Ref]
+Title=GEdit
+Name=org.gnome.gedit
+Branch=stable
+Url=http://sdk.gnome.org/repo-apps/
+IsRuntime=False
+GPGKey=mQENBFUUCGcBCAC/K9WeV4xCaKr3NKRqPXeY5mpaXAJyasLqCtrDx92WUgbu0voWrhohNAKpqizod2dvzc/XTxm3rHyIxmNfdhz1gaGhynU75Qw4aJVcly2eghTIl++gfDtOvrOZo/VuAq30f32dMIgHQdRwEpgCwz7WyjpqZYltPAEcCNL4MTChAfiHJeeiQ5ibystNBW8W6Ymf7sO4m4g5+/aOxI54oCOzD9TwBAe+yXcJJWtc2rAhMCjtyPJzxd0ZVXqIzCe1xRvJ6Rq7YCiMbiM2DQFWXKnmYQbj4TGNMnwNdAajCdrcBWEMSbzq7EzuThIJRd8Ky4BkEe1St6tuqwFaMZz+F9eXABEBAAG0KEdub21lIFNESyAzLjE2IDxnbm9tZS1vcy1saXN0QGdub21lLm9yZz6JATgEEwECACIFAlUUCGcCGwMGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEArkz6VV0VKBa5cH/0vXa31YgEjNk78gGFXqnQxdD1WYA87OYxDi189l4lA802EFTF4wCBuZyDOqdd5BhS3Ab0cR778DmZXRUP2gwe+1zTJypU2JMnDpkwJ4NK1VP6/tE4SAPrznBtmb76BKaWBqUfZ9Wq1zg3ugvqkZB/Exq+usypIOwQVp1KL58TrjBRda0HvRctzkNhr0qYAtkfLFe0GvksBp4vBm8uGwAx7fw/HbhIjQ9pekTwvB+5GwDPO/tSip/1bQfCS+XJB8Ffa04HYPLGedalnWBrwhYY+G/kn5Zh9L/AC8xeLwTJTHM212rBjPa9CWs9C6a57MSaeGIEHLC1hEyiJJ15w8jmY=
+

See also

+ flatpak(1), + flatpak-install(1) + flatpak-flatpakrepo(5), +

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

+ 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

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

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 @@ -1596,16 +2093,33 @@ Content Bytes Written: 305 run command, or permanently with the flatpak override command.

A metadata file describing the effective configuration is available - inside the running sandbox at /run/user/$UID/flatpak-info. -

File format

+ inside the running sandbox at /.flatpak-info. + For compatibility with older Flatpak versions, + /run/user/$UID/flatpak-info is a symbolic + link to the same file. +

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]

+

[Application] or [Runtime]

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

The following keys can be present in these groups: -

name (string)

The name of the application or runtime. This key is mandatory.

runtime (string)

The fully qualified name of the runtime that is used by the application. This key is mandatory for applications.

sdk (string)

The fully qualified name of the sdk that matches the runtime.

command (string)

The command to run. Only relevant for applications.

[Context]

+

name (string)

The name of the application or runtime. This key is mandatory.

runtime (string)

The fully qualified name of the runtime that is used by the application. This key is mandatory for applications.

sdk (string)

+ The fully qualified name of the sdk that matches the + runtime. Available since 0.1.

command (string)

+ The command to run. Only relevant for applications. + Available since 0.1. +

required-flatpak (string)

+ The required version of Flatpak to run this application + or runtime. For applications, this was available since + 0.8.0. For runtimes, this was available since 0.9.1, + and backported to 0.8.3 for the 0.8.x branch. +

tags (string list)

+ Tags to include in AppStream XML. + Available since 0.4.12. + +

[Context]

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

@@ -1613,28 +2127,143 @@ Content Bytes Written: 305

shared (list)

List of subsystems to share with the host system. Possible subsystems: network, ipc. + Available since 0.3.

sockets (list)

List of well-known sockets to make available in the sandbox. - Possible sockets: x11, wayland, pulseaudio, session-bus, system-bus. + Possible sockets: x11, wayland, fallback-x11, pulseaudio, session-bus, system-bus. When making a socket available, flatpak also sets well-known environment variables like DISPLAY or DBUS_SYSTEM_BUS_ADDRESS to let the application find sockets that are not in a fixed location. + Available since 0.3.

devices (list)

List of devices to make available in the sandbox. - Possible values: dri, kvm, all. + Possible values: +

dri

+ Graphics direct rendering + (/dev/dri). + Available since 0.3. +

kvm

+ Virtualization + (/dev/kvm). + Available since 0.6.12. +

all

+ All device nodes in /dev. + Available since 0.6.6. +

filesystems (list)

List of filesystem subsets to make available to the - application. Possible values: home, host, xdg-desktop, - xdg-documents, xdg-download xdg-music, xdg-pictures, - xdg-public-share, xdg-templates, xdg-videos, xdg-run, - an absolute path, or a homedir-relative path like - ~/dir or paths relative to the xdg dirs, like - xdg-download/subdir. The xdg-* arguments can also - specify a subdirectory, such as xdg-pictures/screenshots. - Each entry can have a suffix of - :ro or :rw to indicate if the path should be shared - read-only or read-write (default is read-write). + application. Possible values: +

home

+ The entire home directory. + Available since 0.3. +

host

+ The entire host file system, except for + directories that are handled specially by + Flatpak. + In particular, this shares + /home, + /media, + /opt, + /run/media and + /srv if they exist. +

+ /dev is not shared: + use devices=all; instead. +

+ Parts of /sys are always + shared. This option does not make additional + files in /sys available. +

+ These other reserved directories are + currently excluded: + /app, + /bin, + /boot, + /etc, + /lib, + /lib32, + /lib64, + /proc, + /root, + /run, + /sbin, + /tmp, + /usr, + /var. +

+ Available since 0.3. +

xdg-desktop, + xdg-documents, + xdg-download, + xdg-music, + xdg-pictures, + xdg-public-share, + xdg-videos, + xdg-templates +

+ freedesktop.org special directories. + Available since 0.3. +

xdg-desktop/path, + xdg-documents/path, + etc. +

+ Subdirectories of freedesktop.org special + directories. Available since 0.4.13. +

+ xdg-cache, + xdg-config, + xdg-data +

+ Directories defined by the + freedesktop.org Base Directory + Specification. + Available since 0.6.14. +

+ xdg-cache/path, + xdg-config/path, + xdg-data/path +

+ Subdirectories of directories defined by the + freedesktop.org Base Directory Specification. + Available since 0.6.14. +

+ xdg-run/path +

+ Subdirectories of the + XDG_RUNTIME_DIR defined by + the + freedesktop.org Base Directory + Specification. Note that + xdg-run on its own is not + supported. Available since 0.4.13. +

+ /path +

+ An arbitrary absolute path. Available since 0.3. +

+ ~/path +

+ An arbitrary path relative to the home + directory. Available since 0.3. +

+ One of the above followed by + :ro +

+ Make the given directory available read-only. +

+ One of the above followed by + :rw +

+ Make the given directory available read/write. + This is the default. +

+ One of the above followed by + :create +

+ Make the given directory available read/write, + and create it if it does not already exist. +

persistent (list)

List of homedir-relative paths to make available at the corresponding path in the per-application home directory, @@ -1643,8 +2272,56 @@ Content Bytes Written: 305 For instance making ".myapp" persistent would make "~/.myapp" in the sandbox a bind mount to "~/.var/app/org.my.App/.myapp", thus allowing an unmodified application to save data in - the per-application location. -

[Session Bus Policy]

+ the per-application location. Available since 0.3. +

features (list)

+ List of features available or unavailable to the + application, currently from the following list: +

devel

+ Allow system calls used by development-oriented + tools such as perf, + strace and + gdb. + Available since 0.6.10. +

multiarch

+ Allow running multilib/multiarch binaries, for + example i386 binaries in an + x86_64 environment. + Available since 0.6.12. +

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

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

app-path (string)

+ The absolute path on the host system of the app's + app files, as mounted at /app + inside the container. Available since 0.6.10. +

branch (string)

+ The branch of the app, for example + stable. Available since + 0.6.10. +

flatpak-version (string)

+ The version number of the Flatpak version that ran + this app. Available since 0.6.11. +

runtime-path (string)

+ The absolute path on the host system of the app's + runtime files, as mounted at /usr + inside the container. Available since 0.6.10. +

session-bus-proxy (boolean)

+ True if this app cannot access the D-Bus session bus + directly (either it goes via a proxy, or it cannot + access the session bus at all). Available since 0.8.0. + +

system-bus-proxy (boolean)

+ True if this app cannot access the D-Bus system bus + directly (either it goes via a proxy, or it cannot + access the system bus at all). Available since 0.8.0. + +

[Session Bus Policy]

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

@@ -1672,56 +2349,140 @@ Content Bytes Written: 305 access:

none

The bus name or names in question is invisible to the application. + Available since 0.2.

see

The bus name or names can be enumerated by the application. + Available since 0.2.

talk

The application can send messages/ and receive replies and signals from the bus name or names. + Available since 0.2.

own

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

[System Bus Policy]

+ Available since 0.2. +

[System Bus Policy]

If the sockets key is not allowing full access to the D-Bus system bus, then flatpak does not make the system bus available unless the [System Bus Policy] group is present - and provides a policy for filtered access. + and provides a policy for filtered access. Available since 0.2.

Entries in this group have the same form as for the [Session Bus Policy] group. However, the app has no permissions by default. -

[Environment]

+

[Environment]

The [Environment] group specifies environment variables to set - when running the application. + when running the application. Available since 0.3.

Entries in this group have the form VAR=VALUE where VAR is the name of an environment variable to set. -

[Extension NAME]

- Runtimes and applications can define extensions, which are optional, - additional runtimes to be mounted at a specified location inside - the sandbox when they are present on the system. Typical uses for - extensions include translations for applications, or debuginfo - for sdks. The name of the extension is specified as part of the +

[Extension NAME]

+ Runtimes and applications can define extension points, which allow + optional, additional runtimes to be mounted at a specified location + inside the sandbox when they are present on the system. Typical uses + for extension points include translations for applications, or debuginfo + for sdks. The name of the extension point is specified as part of the group heading.

directory (string)

The relative path at which the extension will be mounted in - the sandbox. If the extension is for an application, the + the sandbox. If the extension point is for an application, the path is relative to /app, otherwise it is relative to /usr. This key - is mandatory. + is mandatory. Available since 0.1.

version (string)

The branch to use when looking for the extension. If this is not specified, it defaults to the branch of the application or - runtime that the extension is for. + runtime that the extension point is for. + Available since 0.4.1. +

versions (string)

+ The branches to use when looking for the extension. If this is + not specified, it defaults to the branch of the application or + runtime that the extension point is for. Available since + 0.9.1, and backported to the 0.8.x branch in 0.8.4. +

add-ld-path (string)

+ A path relative to the extension point directory that will be appended + to LD_LIBRARY_PATH. Available since 0.9.1, and + backported to the 0.8.x branch in 0.8.3. +

merge-dirs (string)

+ A list of relative paths of directories below the extension point directory + that will be merged. Available since 0.9.1, and + backported to the 0.8.x branch in 0.8.3. +

download-if (string)

+ A condition that must be true for the extension to be auto-downloaded. + The only currently recognized value is active-gl-driver, which is true + if the name of the active GL driver matches the extension point basename. + Available since 0.9.1, and backported to the 0.8.x + branch in 0.8.3. +

enable-if (string)

+ A condition that must be true for the extension to be enabled. + The only currently recognized value is active-gl-driver, which is true + if the name of the active GL driver matches the extension point basename. + Available since 0.9.1, and backported to the 0.8.x + branch in 0.8.3. +

subdirectory-suffix (string)

+ A suffix that gets appended to the directory name. This is very + useful when the extension point naming scheme is "reversed". For example, + an extension point for GTK+ themes would be /usr/share/themes/$NAME/gtk-3.0, + which could be achieved using subdirectory-suffix=gtk-3.0. + Available since 0.9.1, and backported to the 0.8.x + branch in 0.8.3.

subdirectories (boolean)

If this key is set to true, then flatpak will look for - extensions whose name is a prefix of the extension name, and + extensions whose name is a prefix of the extension point name, and mount them at the corresponding name below the subdirectory. + Available since 0.1.

no-autodownload (boolean)

- Whether to automatically download this extension - when updating or installing a 'related' application - or runtime. + Whether to automatically download extensions matching this extension + point when updating or installing a 'related' application or runtime. + Available since 0.6.7. +

locale-subset (boolean)

+ If set, then the extensions are partially downloaded by default, + based on the currently configured locales. This means that the extension + contents should be a set of directories with the language code as name. + Available since 0.9.13 (and 0.6.6 for any extensions called *.Locale)

autodelete (boolean)

- Whether to automatically delete this extension - when deleting a 'related' application or runtime. -

Example

+                        Whether to automatically delete extensions matching this extension
+                        point when deleting a 'related' application or runtime.
+                        Available since 0.6.7.
+

[ExtensionOf]

+ This optional group may be present if the runtime is an extension. +

ref (string)

+ The ref of the runtime or application that this extension + belongs to. Available since 0.9.1. +

priority (integer)

+ The priority to give this extension when looking for the + best match. Default is 0. Available since 0.9.1, and + backported to the 0.8.x branch in 0.8.3. +

[Extra Data]

+ This optional group may be present if the runtime or application uses + extra data that gets downloaded separately. The data in this group + gets merged into the repository summary, with the xa.extra-data-sources + key. +

+ If multiple extra data sources are present, their uri, size and checksum + keys are grouped together by using the same suffix. If only one extra + data source is present, the suffix can be omitted. +

NoRuntime (boolean)

+ Whether to mount the runtime while running the /app/bin/apply_extra + script. Defaults to true, i.e. not mounting the runtime. + Available since 0.9.1, and backported to the 0.8.x + branch in 0.8.4. +

uriX (string)

+ The uri for extra data source + X. The only supported uri + schemes are http and https. Available since 0.6.13. +

sizeX (integer)

+ The size for extra data source + X. Available since 0.6.13. +

checksumX (string)

+ The sha256 sum for extra data source + X. Available since 0.6.13. +

[Policy SUBSYSTEM]

+ Subsystems can define their own policies to be placed in a group + whose name has this form. Their values are treated as lists, + in which items can have their meaning negated by prepending ! + to the value. They are not otherwise parsed by Flatpak. + Available since 0.6.13. + +

Example

 [Application]
 name=org.gnome.Calculator
 runtime=org.gnome.Platform/x86_64/3.20
@@ -1745,87 +2506,39 @@ subdirectories=true
 
 [Extension org.gnome.Calculator.Debug]
 directory=lib/debug
-

See also

- flatpak(1), - flatpak-run(1), - flatpak-override(1) -

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 - command to do so. -

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

See also

+ flatpak(1), + flatpak-run(1), + flatpak-override(1) +

Name

flatpak-remote — Configuration for a remote

Description

+ Flatpak stores information about configured remotes for an installation location in + $installation/repo/config. For example, the remotes for the + default system-wide installation are in + $prefix/var/lib/flatpak/repo/config, and the remotes for the + per-user installation are in $HOME/.local/share/flatpak/repo/config. +

+ Normally, it is not necessary to edit remote config files directly, the + flatpak remote-modify command should be used to change properties of remotes. +

+ System-wide remotes can be statically preconfigured by dropping + config fragments into /etc/flatpak/remotes.d/. +

File format

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

[remote …]

+ All the configuration for the the remote with name NAME is contained in the + [remote "NAME"] group.

- The following keys can be present in this group: -

Url (string)

The url for the remote. This key is mandatory.

Title (string)

The title of the remote. This should be a user-friendly name that can be displayed e.g. in an app store.

GPGKey (string)

The base64-encoded gpg key for the remote.

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

See also

- flatpak(1), - flatpak-remote-add(1), - flatpak-flatpakref(5) -

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. - Use the flatpak install --from command to do so. -

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

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

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

Name (string)

The fully qualified name of the runtime that is used by the application. This key is mandatory.

Url (string)

The url for the remote. This key is mandatory.

Branch (string)

The name of the branch from which to install the application or runtime. If this key is not specified, the "master" branch is used.

Title (string)

The title of the application or runtime. This should be a user-friendly name that can be displayed e.g. in an app store.

IsRuntime (boolean)

Whether this file refers to a runtime. If this key is not specified, the file is assumed to refer to an application.

GPGKey (string)

The base64-encoded gpg key for the remote.

Example

-[Flatpak Ref]
-Title=GEdit
-Name=org.gnome.gedit
-Branch=stable
-Url=http://sdk.gnome.org/repo-apps/
-IsRuntime=False
-GPGKey=mQENBFUUCGcBCAC/K9WeV4xCaKr3NKRqPXeY5mpaXAJyasLqCtrDx92WUgbu0voWrhohNAKpqizod2dvzc/XTxm3rHyIxmNfdhz1gaGhynU75Qw4aJVcly2eghTIl++gfDtOvrOZo/VuAq30f32dMIgHQdRwEpgCwz7WyjpqZYltPAEcCNL4MTChAfiHJeeiQ5ibystNBW8W6Ymf7sO4m4g5+/aOxI54oCOzD9TwBAe+yXcJJWtc2rAhMCjtyPJzxd0ZVXqIzCe1xRvJ6Rq7YCiMbiM2DQFWXKnmYQbj4TGNMnwNdAajCdrcBWEMSbzq7EzuThIJRd8Ky4BkEe1St6tuqwFaMZz+F9eXABEBAAG0KEdub21lIFNESyAzLjE2IDxnbm9tZS1vcy1saXN0QGdub21lLm9yZz6JATgEEwECACIFAlUUCGcCGwMGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEArkz6VV0VKBa5cH/0vXa31YgEjNk78gGFXqnQxdD1WYA87OYxDi189l4lA802EFTF4wCBuZyDOqdd5BhS3Ab0cR778DmZXRUP2gwe+1zTJypU2JMnDpkwJ4NK1VP6/tE4SAPrznBtmb76BKaWBqUfZ9Wq1zg3ugvqkZB/Exq+usypIOwQVp1KL58TrjBRda0HvRctzkNhr0qYAtkfLFe0GvksBp4vBm8uGwAx7fw/HbhIjQ9pekTwvB+5GwDPO/tSip/1bQfCS+XJB8Ffa04HYPLGedalnWBrwhYY+G/kn5Zh9L/AC8xeLwTJTHM212rBjPa9CWs9C6a57MSaeGIEHLC1hEyiJJ15w8jmY=
-

See also

- flatpak(1), - flatpak-install(1) - flatpak-flatpakrepo(5), -

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

- When a new branch is installed it will automatically be made current, so this - command is often not needed. -

- Unless overridden with the --user option, this command creates a - system-wide installation. -

Options

The following options are understood:

-h, --help

- Show help options and exit. -

--user

- Create a per-user installation. -

--system

- Create a system-wide installation. -

--arch=ARCH

- The architecture to install for. -

-v, --verbose

- Print debug information during command processing. -

--version

- Print version information and exit. -

Examples

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

See also

- flatpak(1), - flatpak-install(1), - flatpak-list(1) -

\ No newline at end of file + The following keys are recognized by OSTree, among others: +

url (string)

The url for the remote.

gpg-verify (boolean)

Whether to use GPG verification for content from this remote.

gpg-verify-summary (boolean)

Whether to use GPG verification for the summary of this remote.

+ All flatpak-specific keys have a xa. prefix: +

xa.disable (boolean)

Whether the remote is disabled. Defaults to false.

xa.prio (integer)

The priority for the remote. This is used when listing remotes. Defaults to 1.

xa.noenumerate (boolean)

Whether this remote should be used when presenting available contents. Defaults to true.

xa.nodeps (boolean)

Whether this remote should be used when searching for dependencies. Defaults to true.

xa.title (string)

An optional title to use when presenting this remote in a UI.

xa.title-is-set (boolean)

This key is set to true if xa.title has been explicitly set.

xa.default-branch (string)

The default branch to use when installing from this remote.

xa.default-branch-is-set (boolean)

This key is set to true if xa.default-branch has been explicitly set.

xa.main-ref (string)

The main reference served by this remote. This is used for origin remotes of applications installed via a flatpakref file.

xa.oci (boolean)

Whether this is an OCI remote. Defaults to false.

Examples

+[remote "gnome-nightly-apps"]
+gpg-verify=true
+gpg-verify-summary=true
+
+url=https://sdk.gnome.org/nightly/repo-apps/
+xa.title=GNOME Applications
+

See also

+ flatpak-remote-modify(1) +

\ No newline at end of file diff --git a/reference/html/FlatpakInstallation.html b/reference/html/FlatpakInstallation.html index 7f5623c9..0d1ed6c0 100644 --- a/reference/html/FlatpakInstallation.html +++ b/reference/html/FlatpakInstallation.html @@ -3,12 +3,12 @@ FlatpakInstallation: Flatpak Library Reference Manual - + - + @@ -34,7 +34,7 @@

Functions

-
+
@@ -53,6 +53,14 @@ FlatpakInstallation * + + + + @@ -66,7 +74,7 @@ + + + + + + + + + + + + + + + + @@ -138,7 +176,23 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -284,7 +425,7 @@

Types and Values

-
+flatpak_installation_new_system_with_id () +
+FlatpakInstallation * + flatpak_installation_new_user ()
-gboolean +gboolean flatpak_installation_get_is_user () @@ -74,7 +82,7 @@
-GFile * +GFile * flatpak_installation_get_path () @@ -82,7 +90,7 @@
-GFileMonitor * +GFileMonitor * flatpak_installation_create_monitor () @@ -101,12 +109,28 @@ FlatpakInstalledRef * +flatpak_installation_install_full () +
+FlatpakInstalledRef * + flatpak_installation_update ()
-gboolean +FlatpakInstalledRef * + +flatpak_installation_update_full () +
+gboolean flatpak_installation_uninstall () @@ -114,7 +138,7 @@
-gboolean +gboolean flatpak_installation_launch () @@ -129,6 +153,20 @@
const char * + +flatpak_installation_get_display_name () +
const char * + +flatpak_installation_get_id () +
FlatpakInstalledRef *
-GPtrArray * +gint + +flatpak_installation_get_priority () +
+FlatpakStorageType + +flatpak_installation_get_storage_type () +
+GPtrArray * flatpak_installation_list_installed_refs () @@ -146,7 +200,7 @@
-GPtrArray * +GPtrArray * flatpak_installation_list_installed_refs_by_kind () @@ -154,7 +208,7 @@
-GPtrArray * +GPtrArray * flatpak_installation_list_installed_refs_for_update () @@ -162,7 +216,15 @@
-GPtrArray * +GPtrArray * + +flatpak_installation_list_installed_related_refs_sync () +
+GPtrArray * flatpak_installation_list_remote_refs_sync () @@ -170,7 +232,15 @@
-GPtrArray * +GPtrArray * + +flatpak_installation_list_remote_related_refs_sync () +
+GPtrArray * flatpak_installation_list_remotes () @@ -186,7 +256,7 @@
-GBytes * +GBytes * flatpak_installation_fetch_remote_metadata_sync () @@ -202,7 +272,7 @@
-gboolean +gboolean flatpak_installation_fetch_remote_size_sync () @@ -218,7 +288,7 @@
-gboolean +gboolean flatpak_installation_update_appstream_sync () @@ -234,7 +304,15 @@
-gboolean +FlatpakRemoteRef * + +flatpak_installation_install_ref_file () +
+gboolean flatpak_installation_drop_caches () @@ -242,7 +320,7 @@
-gboolean +gboolean flatpak_installation_modify_remote () @@ -250,7 +328,7 @@
-gboolean +gboolean flatpak_installation_remove_remote () @@ -258,13 +336,61 @@
-gboolean +gboolean flatpak_installation_update_remote_sync ()
+gboolean + +flatpak_installation_cleanup_local_refs_sync () +
+char * + +flatpak_installation_get_config () +
+gboolean + +flatpak_installation_prune_local_repo () +
+gboolean + +flatpak_installation_remove_local_ref_sync () +
+gboolean + +flatpak_installation_set_config_sync () +
+gboolean + +flatpak_installation_update_appstream_full_sync () +
const char * @@ -272,6 +398,21 @@
const char *const * + +flatpak_get_supported_arches () +
+GPtrArray * + +flatpak_get_system_installations () +
void
+
@@ -298,12 +439,20 @@ + + + + + + + +
enum FlatpakUpdateFlags
enumFlatpakInstallFlags
enumFlatpakStorageType

Object Hierarchy

-
    GObject
+
    GObject
     ╰── FlatpakInstallation
@@ -323,12 +472,12 @@ uninstall applications and runtimes.

flatpak_installation_new_system ()

FlatpakInstallation *
-flatpak_installation_new_system (GCancellable *cancellable,
-                                 GError **error);
+flatpak_installation_new_system (GCancellable *cancellable, + GError **error);

Creates a new FlatpakInstallation for the system-wide installation.

Parameters

-
+
@@ -337,12 +486,12 @@ flatpak_installation_new_system (

cancellable

- + - + @@ -350,20 +499,64 @@ flatpak_installation_new_system (

Returns

-

a new FlatpakInstallation.

+

a new FlatpakInstallation.

[transfer full]

+

flatpak_installation_new_system_with_id ()

+
FlatpakInstallation *
+flatpak_installation_new_system_with_id
+                               (const char *id,
+                                GCancellable *cancellable,
+                                GError **error);
+

Creates a new FlatpakInstallation for the system-wide installation id +.

+
+

Parameters

+

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
+++++ + + + + + + + + + + + + + + + + + +

id

the ID of the system-wide installation.

[nullable]

cancellable

a GCancellable.

[nullable]

error

return location for a GError

 
+
+
+

Returns

+

a new FlatpakInstallation.

+

[transfer full]

+
+

Since: 0.8

+
+
+

flatpak_installation_new_user ()

FlatpakInstallation *
-flatpak_installation_new_user (GCancellable *cancellable,
-                               GError **error);
+flatpak_installation_new_user (GCancellable *cancellable, + GError **error);

Creates a new FlatpakInstallation for the per-user installation.

Parameters

-
+
@@ -372,12 +565,12 @@ flatpak_installation_new_user (

cancellable

- + - + @@ -385,7 +578,7 @@ flatpak_installation_new_user (

Returns

-

a new FlatpakInstallation.

+

a new FlatpakInstallation.

[transfer full]

@@ -393,15 +586,15 @@ flatpak_installation_new_user (

flatpak_installation_new_for_path ()

FlatpakInstallation *
-flatpak_installation_new_for_path (GFile *path,
-                                   gboolean user,
-                                   GCancellable *cancellable,
-                                   GError **error);
+flatpak_installation_new_for_path (GFile *path, + gboolean user, + GCancellable *cancellable, + GError **error);

Creates a new FlatpakInstallation for the installation at the given path .

Parameters

-

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
+
@@ -410,7 +603,7 @@ flatpak_installation_new_for_path (

path

- + @@ -420,12 +613,12 @@ flatpak_installation_new_for_path (

cancellable

- + - + @@ -433,19 +626,19 @@ flatpak_installation_new_for_path (

Returns

-

a new FlatpakInstallation.

+

a new FlatpakInstallation.

[transfer full]

flatpak_installation_get_is_user ()

-
gboolean
+
gboolean
 flatpak_installation_get_is_user (FlatpakInstallation *self);

 
Returns whether the installation is for a user-specific location.

 

 
Parameters

-

a GFile

a GFile

  

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
+
@@ -460,20 +653,20 @@ flatpak_installation_get_is_user (

Returns

-

TRUE if self +

TRUE if self is a per-user installation

flatpak_installation_get_path ()

-
GFile *
+
GFile *
 flatpak_installation_get_path (FlatpakInstallation *self);

 
Returns the installation location for self
 .

 

 
Parameters

-
+
@@ -488,23 +681,23 @@ flatpak_installation_get_path (

Returns

-

an GFile.

+

an GFile.

[transfer full]

flatpak_installation_create_monitor ()

-
GFileMonitor *
+
GFileMonitor *
 flatpak_installation_create_monitor (FlatpakInstallation *self,
-                                     GCancellable *cancellable,
-                                     GError **error);

+                                     GCancellable *cancellable,
+                                     GError **error);

Gets monitor object for the installation. The returned file monitor will -emit the “changed” signal whenever an application or runtime +emit the “changed” signal whenever an application or runtime was installed, uninstalled or updated.

Parameters

-
+
@@ -518,12 +711,12 @@ was installed, uninstalled or updated.

 - + - + @@ -531,7 +724,7 @@ was installed, uninstalled or updated.

Returns

-

a new GFileMonitor instance, or NULL on error.

+

a new GFileMonitor instance, or NULL on error.

[transfer full]

@@ -546,13 +739,20 @@ flatpak_installation_install (const char *arch, const char *branch, FlatpakProgressCallback progress, - gpointer progress_data, - GCancellable *cancellable, - GError **error); + gpointer progress_data, + GCancellable *cancellable, + GError **error);

Install a new application or runtime.

+

Note that this function was originally written to always return a +FlatpakInstalledRef. Since 0.9.13, passing +FLATPAK_INSTALL_FLAGS_NO_DEPLOY will only pull refs into the local flatpak +repository without deploying them, however this function will +be unable to provide information on the installed ref, so +FLATPAK_ERROR_ONLY_PULLED will be set and the caller must respond +accordingly.

Parameters

-

cancellable

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
+
@@ -581,33 +781,33 @@ flatpak_installation_install (

arch

- + - + - - + + - +.

+ - + - + @@ -615,7 +815,110 @@ flatpak_installation_install (

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]

+ + +
+
+

flatpak_installation_install_full ()

+
FlatpakInstalledRef *
+flatpak_installation_install_full (FlatpakInstallation *self,
+                                   FlatpakInstallFlags flags,
+                                   const char *remote_name,
+                                   FlatpakRefKind kind,
+                                   const char *name,
+                                   const char *arch,
+                                   const char *branch,
+                                   const char * const *subpaths,
+                                   FlatpakProgressCallback progress,
+                                   gpointer progress_data,
+                                   GCancellable *cancellable,
+                                   GError **error);
+

Install a new application or runtime.

+

Note that this function was originally written to always return a +FlatpakInstalledRef. Since 0.9.13, passing +FLATPAK_INSTALL_FLAGS_NO_DEPLOY will only pull refs into the local flatpak +repository without deploying them, however this function will +be unable to provide information on the installed ref, so +FLATPAK_ERROR_ONLY_PULLED will be set and the caller must respond +accordingly.

+
+

Parameters

+

which architecture to fetch (default: current architecture).

which architecture to fetch (default: current architecture).

[nullable]

branch

which branch to fetch (default: 'master').

which branch to fetch (default: 'master').

[nullable]

progress

progress callback.

[scope call]

progress callback.

[scope call][nullable]

progress_data

user data passed to progress -

 [closure progress][nullable]

cancellable

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

self

a FlatpakInstallation

 

flags

set of FlatpakInstallFlags flag

 

remote_name

name of the remote to use

 

kind

what this ref contains (an FlatpakRefKind)

 

name

name of the app/runtime to fetch

 

arch

which architecture to fetch (default: current architecture).

[nullable]

branch

which branch to fetch (default: 'master').

[nullable]

subpaths

A list of subpaths to fetch, or NULL for everything.

[nullable][array zero-terminated=1]

progress

progress callback.

[scope call][nullable]

progress_data

user data passed to progress +.

[closure progress][nullable]

cancellable

a GCancellable.

[nullable]

error

return location for a GError

 
+
+
+

Returns

+

The ref for the newly installed app or NULL on failure.

[transfer full]

@@ -630,13 +933,17 @@ flatpak_installation_update (const char *arch, const char *branch, FlatpakProgressCallback progress, - gpointer progress_data, - GCancellable *cancellable, - GError **error); + gpointer progress_data, + GCancellable *cancellable, + GError **error);

Update an application or runtime.

+

If the specified package is not installed, then FLATPAK_ERROR_NOT_INSTALLED +will be thrown.

+

If no updates could be found on the remote end and the package is +already up to date, then FLATPAK_ERROR_ALREADY_INSTALLED will be thrown.

Parameters

-
+
@@ -665,33 +972,33 @@ flatpak_installation_update (

arch

- + - + - - + + - +.

+ - + - + @@ -699,27 +1006,121 @@ flatpak_installation_update (

Returns

-

The ref for the newly updated app (or the same if no update) or NULL on failure.

+

The ref for the newly updated app or NULL on failure.

+

[transfer full]

+ + +
+
+

flatpak_installation_update_full ()

+
FlatpakInstalledRef *
+flatpak_installation_update_full (FlatpakInstallation *self,
+                                  FlatpakUpdateFlags flags,
+                                  FlatpakRefKind kind,
+                                  const char *name,
+                                  const char *arch,
+                                  const char *branch,
+                                  const char * const *subpaths,
+                                  FlatpakProgressCallback progress,
+                                  gpointer progress_data,
+                                  GCancellable *cancellable,
+                                  GError **error);
+

Update an application or runtime.

+

If the specified package is not installed, then FLATPAK_ERROR_NOT_INSTALLED +will be thrown.

+

If no updates could be found on the remote end and the package is +already up to date, then FLATPAK_ERROR_ALREADY_INSTALLED will be thrown.

+
+

Parameters

+

architecture of the app or runtime to update (default: current architecture).

architecture of the app or runtime to update (default: current architecture).

[nullable]

branch

name of the branch of the app or runtime to update (default: master).

name of the branch of the app or runtime to update (default: master).

[nullable]

progress

the callback.

[scope call]

the callback.

[scope call][nullable]

progress_data

user data passed to progress -

 [closure progress][nullable]

cancellable

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

self

a FlatpakInstallation

 

flags

set of FlatpakUpdateFlags flag

 

kind

whether this is an app or runtime

 

name

name of the app or runtime to update

 

arch

architecture of the app or runtime to update (default: current architecture).

[nullable]

branch

name of the branch of the app or runtime to update (default: master).

[nullable]

subpaths

A list of subpaths to fetch, or NULL for everything.

[nullable][array zero-terminated=1]

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

 
+
+
+

Returns

+

The ref for the newly updated app or NULL on failure.

[transfer full]

flatpak_installation_uninstall ()

-
gboolean
+
gboolean
 flatpak_installation_uninstall (FlatpakInstallation *self,
                                 FlatpakRefKind kind,
                                 const char *name,
                                 const char *arch,
                                 const char *branch,
                                 FlatpakProgressCallback progress,
-                                gpointer progress_data,
-                                GCancellable *cancellable,
-                                GError **error);

+                                gpointer progress_data,
+                                GCancellable *cancellable,
+                                GError **error);

Uninstall an application or runtime.

Parameters

-
+
@@ -753,23 +1154,23 @@ flatpak_installation_uninstall ( - - + + - +.

+ - + - + @@ -777,20 +1178,20 @@ flatpak_installation_uninstall (

Returns

-

TRUE on success

+

TRUE on success

flatpak_installation_launch ()

-
gboolean
+
gboolean
 flatpak_installation_launch (FlatpakInstallation *self,
                              const char *name,
                              const char *arch,
                              const char *branch,
                              const char *commit,
-                             GCancellable *cancellable,
-                             GError **error);

+                             GCancellable *cancellable,
+                             GError **error);

Launch an installed application.

You can use flatpak_installation_get_installed_ref() or flatpak_installation_get_current_installed_app() to find out what builds @@ -798,7 +1199,7 @@ are available, in order to get a value for commit

Parameters

-

progress

the callback.

[scope call]

the callback.

[scope call][nullable]

progress_data

user data passed to progress -

 [closure progress][nullable]

cancellable

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
+
@@ -817,28 +1218,28 @@ are available, in order to get a value for commit - + - + - - + - + @@ -846,7 +1247,7 @@ to launch.

Returns

-

TRUE, unless an error occurred

+

TRUE, unless an error occurred

@@ -856,15 +1257,15 @@ to launch.

flatpak_installation_get_current_installed_app (FlatpakInstallation *self, const char *name, - GCancellable *cancellable, - GError **error); + GCancellable *cancellable, + GError **error);

Get the last build of reference name that was installed with -flatpak_installation_install(), or NULL if the reference has +flatpak_installation_install(), or NULL if the reference has never been installed locally.

Parameters

-

arch

which architecture to launch (default: current architecture).

which architecture to launch (default: current architecture).

[nullable]

branch

which branch of the application (default: "master").

which branch of the application (default: "master").

[nullable]

commit

the commit of branch +

the commit of branch to launch.

[nullable]

cancellable

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
+
@@ -883,12 +1284,12 @@ never been installed locally.

 - + - + @@ -896,12 +1297,70 @@ never been installed locally.

Returns

-

an FlatpakInstalledRef.

+

an FlatpakInstalledRef.

[transfer full]

+

flatpak_installation_get_display_name ()

+
const char *
+flatpak_installation_get_display_name (FlatpakInstallation *self);
+

Returns the display name of the system installation for self +.

+
+

Parameters

+

cancellable

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
+++++ + + + + + +

self

a FlatpakInstallation

 
+
+
+

Returns

+

a string with the installation's display name.

+

[transfer none]

+
+

Since: 0.8

+
+
+
+

flatpak_installation_get_id ()

+
const char *
+flatpak_installation_get_id (FlatpakInstallation *self);
+

Returns the ID of the system installation for self +.

+
+

Parameters

+
+++++ + + + + + +

self

a FlatpakInstallation

 
+
+
+

Returns

+

a string with the installation's ID.

+

[transfer none]

+
+

Since: 0.8

+
+
+

flatpak_installation_get_installed_ref ()

FlatpakInstalledRef *
 flatpak_installation_get_installed_ref
@@ -910,13 +1369,13 @@ flatpak_installation_get_installed_ref
                                 const char *name,
                                 const char *arch,
                                 const char *branch,
-                                GCancellable *cancellable,
-                                GError **error);
+ GCancellable *cancellable, + GError **error);

Returns information about an installed ref, such as the available builds, its size, location, etc.

Parameters

-
+
@@ -940,22 +1399,22 @@ its size, location, etc.

- + - + - + - + @@ -963,22 +1422,78 @@ its size, location, etc.

Returns

-

an FlatpakInstalledRef, or NULL if an error occurred.

+

an FlatpakInstalledRef, or NULL if an error occurred.

[transfer full]

+

flatpak_installation_get_priority ()

+
gint
+flatpak_installation_get_priority (FlatpakInstallation *self);
+

Returns the numeric priority of the system installation for self +.

+
+

Parameters

+

arch

which architecture to fetch (default: current architecture).

which architecture to fetch (default: current architecture).

[nullable]

branch

which branch to fetch (default: "master").

which branch to fetch (default: "master").

[nullable]

cancellable

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
+++++ + + + + + +

self

a FlatpakInstallation

 
+
+
+

Returns

+

an integer with the configured priority value

+
+

Since: 0.8

+
+
+
+

flatpak_installation_get_storage_type ()

+
FlatpakStorageType
+flatpak_installation_get_storage_type (FlatpakInstallation *self);
+

Returns the type of storage of the system installation for self +.

+
+

Parameters

+
+++++ + + + + + +

self

a FlatpakInstallation

 
+
+
+

Returns

+

a FlatpakStorageType

+
+

Since: 0.8

+
+
+

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

-
+
@@ -992,12 +1507,12 @@ flatpak_installation_list_installed_refs - + - + @@ -1005,7 +1520,7 @@ flatpak_installation_list_installed_refs

Returns

-

an GPtrArray of +

an GPtrArray of FlatpakInstalledRef instances.

[transfer container][element-type FlatpakInstalledRef]

@@ -1013,16 +1528,16 @@ 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

-

cancellable

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
+
@@ -1041,12 +1556,12 @@ flatpak_installation_list_installed_refs_by_kind - + - + @@ -1054,7 +1569,7 @@ flatpak_installation_list_installed_refs_by_kind

Returns

-

an GPtrArray of +

an GPtrArray of FlatpakInstalledRef instances.

[transfer container][element-type FlatpakInstalledRef]

@@ -1062,18 +1577,18 @@ 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 at commit vs latest_commit on installed apps for this.

Parameters

-

cancellable

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
+
@@ -1087,12 +1602,12 @@ at commit vs latest_commit on installed apps for this.

- + - + @@ -1100,165 +1615,36 @@ at commit vs latest_commit on installed apps for this.

Returns

-

an GPtrArray of +

an GPtrArray of FlatpakInstalledRef instances.

[transfer container][element-type FlatpakInstalledRef]

-

flatpak_installation_list_remote_refs_sync ()

-
GPtrArray *
-flatpak_installation_list_remote_refs_sync
+
flatpak_installation_list_installed_related_refs_sync ()

+
GPtrArray *
+flatpak_installation_list_installed_related_refs_sync
                                (FlatpakInstallation *self,
                                 const char *remote_name,
-                                GCancellable *cancellable,
-                                GError **error);

-
Lists all the applications and runtimes in a remote.

+                                const char *ref,
+                                GCancellable *cancellable,
+                                GError **error);
+

Lists all the locally installed refs from remote_name + that are +related to ref +. These are things that are interesting to install, +update, or uninstall together with ref +. For instance, locale data +or debug information.

+

This function is similar to flatpak_installation_list_remote_related_refs_sync, +but instead of looking at what is available on the remote, it only looks +at the locally installed refs. This is useful for instance when you're +looking for related refs to uninstall, or when you're planning to use +FLATPAK_UPDATE_FLAGS_NO_PULL to install previously pulled refs.

-

Parameters

-

cancellable

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
----- - - - - - - - - - - - - - - - - - - - - - - -

self

a FlatpakInstallation

 

remote_name

the name of the remote

 

cancellable

a GCancellable.

[nullable]

error

return location for a GError

 
-
-
-

Returns

-

an GPtrArray of -FlatpakRemoteRef instances.

-

[transfer container][element-type FlatpakRemoteRef]

-
-
-
-
-

flatpak_installation_list_remotes ()

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

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

self

a FlatpakInstallation

 

cancellable

a GCancellable.

[nullable]

error

return location for a GError

 
-
-
-

Returns

-

an GPtrArray of -FlatpakRemote instances.

-

[transfer container][element-type FlatpakRemote]

-
-
-
-
-

flatpak_installation_get_remote_by_name ()

-
FlatpakRemote *
-flatpak_installation_get_remote_by_name
-                               (FlatpakInstallation *self,
-                                const gchar *name,
-                                GCancellable *cancellable,
-                                GError **error);
-

Looks up a remote by name.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

self

a FlatpakInstallation

 

name

a remote name

 

cancellable

a GCancellable.

[nullable]

error

return location for a GError

 
-
-
-

Returns

-

a FlatpakRemote instances, or NULL error.

-

[transfer full]

-
-
-
-
-

flatpak_installation_fetch_remote_metadata_sync ()

-
GBytes *
-flatpak_installation_fetch_remote_metadata_sync
-                               (FlatpakInstallation *self,
-                                const char *remote_name,
-                                FlatpakRef *ref,
-                                GCancellable *cancellable,
-                                GError **error);
-

Obtains the metadata file from a commit.

-
-

Parameters

-
+

Parameters

+
@@ -1282,12 +1668,276 @@ flatpak_installation_fetch_remote_metadata_sync - + - + + + + +

cancellable

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

 
+
+
+

Returns

+

an GPtrArray of +FlatpakRelatedRef instances.

+

[transfer container][element-type FlatpakRelatedRef]

+
+

Since: 0.6.7

+
+
+
+

flatpak_installation_list_remote_refs_sync ()

+
GPtrArray *
+flatpak_installation_list_remote_refs_sync
+                               (FlatpakInstallation *self,
+                                const char *remote_name,
+                                GCancellable *cancellable,
+                                GError **error);
+

Lists all the applications and runtimes in a remote.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

self

a FlatpakInstallation

 

remote_name

the name of the remote

 

cancellable

a GCancellable.

[nullable]

error

return location for a GError

 
+
+
+

Returns

+

an GPtrArray of +FlatpakRemoteRef instances.

+

[transfer container][element-type FlatpakRemoteRef]

+
+
+
+
+

flatpak_installation_list_remote_related_refs_sync ()

+
GPtrArray *
+flatpak_installation_list_remote_related_refs_sync
+                               (FlatpakInstallation *self,
+                                const char *remote_name,
+                                const char *ref,
+                                GCancellable *cancellable,
+                                GError **error);
+

Lists all the available refs on remote_name + that are related to +ref +, and the subpaths to use. These are things that are +interesting to install, update, or uninstall together with +ref +. For instance, locale data or debug information.

+

The returned list contains all available related refs, but not +everyone should always be installed. For example, +flatpak_related_ref_should_download() returns TRUE if the +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.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

self

a FlatpakInstallation

 

remote_name

the name of the remote

 

ref

the ref

 

cancellable

a GCancellable.

[nullable]

error

return location for a GError

 
+
+
+

Returns

+

an GPtrArray of +FlatpakRelatedRef instances.

+

[transfer container][element-type FlatpakRelatedRef]

+
+

Since: 0.6.7

+
+
+
+

flatpak_installation_list_remotes ()

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

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

self

a FlatpakInstallation

 

cancellable

a GCancellable.

[nullable]

error

return location for a GError

 
+
+
+

Returns

+

an GPtrArray of +FlatpakRemote instances.

+

[transfer container][element-type FlatpakRemote]

+
+
+
+
+

flatpak_installation_get_remote_by_name ()

+
FlatpakRemote *
+flatpak_installation_get_remote_by_name
+                               (FlatpakInstallation *self,
+                                const gchar *name,
+                                GCancellable *cancellable,
+                                GError **error);
+

Looks up a remote by name.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

self

a FlatpakInstallation

 

name

a remote name

 

cancellable

a GCancellable.

[nullable]

error

return location for a GError

 
+
+
+

Returns

+

a FlatpakRemote instances, or NULL error.

+

[transfer full]

+
+
+
+
+

flatpak_installation_fetch_remote_metadata_sync ()

+
GBytes *
+flatpak_installation_fetch_remote_metadata_sync
+                               (FlatpakInstallation *self,
+                                const char *remote_name,
+                                FlatpakRef *ref,
+                                GCancellable *cancellable,
+                                GError **error);
+

Obtains the metadata file from a commit.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + @@ -1295,8 +1945,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]

@@ -1311,12 +1961,12 @@ 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

-

self

a FlatpakInstallation

 

remote_name

the name of the remote

 

ref

the ref

 

cancellable

a GCancellable.

[nullable]

error

return location for a GError

  
+
@@ -1345,22 +1995,22 @@ flatpak_installation_fetch_remote_ref_sync - + - + - + - + @@ -1368,22 +2018,22 @@ 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.

@@ -1392,7 +2042,7 @@ for instance if you're doing an update then the real download size may be smalle than what is returned here.

Parameters

-

arch

which architecture to fetch (default: current architecture).

which architecture to fetch (default: current architecture).

[nullable]

branch

which branch to fetch (default: 'master').

which branch to fetch (default: 'master').

[nullable]

cancellable

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
+
@@ -1416,22 +2066,22 @@ than what is returned here.

- + - + - + - + @@ -1439,7 +2089,7 @@ than what is returned here.

Returns

-

TRUE, unless an error occurred

+

TRUE, unless an error occurred

@@ -1449,12 +2099,12 @@ 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

-

download_size

return location for the (maximum) download size.

return location for the (maximum) download size.

[out]

installed_size

return location for the installed size.

return location for the installed size.

[out]

cancellable

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
+
@@ -1473,12 +2123,12 @@ flatpak_installation_load_app_overrides - + - + @@ -1486,28 +2136,29 @@ flatpak_installation_load_app_overrides

Returns

-

the contents of the overrides files, -or NULL if an error occurred.

+

the contents of the overrides files, +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 -.

+. +If you need progress feedback, use flatpak_installation_update_appstream_full_sync().

Parameters

-

cancellable

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
+
@@ -1526,22 +2177,22 @@ flatpak_installation_update_appstream_sync - + - + - + - + @@ -1549,7 +2200,7 @@ flatpak_installation_update_appstream_sync

Returns

-

TRUE on success, or FALSE on error

+

TRUE on success, or FALSE on error

@@ -1557,16 +2208,16 @@ flatpak_installation_update_appstream_sync

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

+See flatpak-build-bundle(1) for how to create bundles.

Parameters

-

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

  
+
@@ -1580,28 +2231,28 @@ See flatpak-build-bundle(1) for how to create brundles.

- + - - + + - +.

+ - + - + @@ -1609,22 +2260,77 @@ See flatpak-build-bundle(1) for how to create brundles.

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]

+

flatpak_installation_install_ref_file ()

+
FlatpakRemoteRef *
+flatpak_installation_install_ref_file (FlatpakInstallation *self,
+                                       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 +avoid unnecessary roundtrips. If you need that you have to resolve it +explicitly with flatpak_installation_fetch_remote_ref_sync().

+
+

Parameters

+

file

a GFile that is an flatpak bundle

a GFile that is an flatpak bundle

  

progress

progress callback.

[scope call]

progress callback.

[scope call][nullable]

progress_data

user data passed to progress -

 [closure progress][nullable]

cancellable

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
+++++ + + + + + + + + + + + + + + + + + + + + + + +

self

a FlatpakInstallation

 

ref_file_data

The ref file contents

 

cancellable

a GCancellable.

[nullable]

error

return location for a GError

 
+
+
+

Returns

+

a FlatpakRemoteRef if the remote has been added successfully, NULL +on error.

+

[transfer full]

+
+

Since: 0.6.10

+
+
+

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.

Parameters

-
+
@@ -1638,12 +2344,12 @@ remotes configured outside this installation instance.

- + - + @@ -1651,22 +2357,22 @@ 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.

Parameters

-

cancellable

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
+
@@ -1685,12 +2391,12 @@ flatpak_installation_modify_remote ( - + - + @@ -1698,21 +2404,21 @@ 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

-

cancellable

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
+
@@ -1731,12 +2437,12 @@ flatpak_installation_remove_remote ( - + - + @@ -1744,24 +2450,24 @@ 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.

Parameters

-

cancellable

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
+
@@ -1780,12 +2486,12 @@ repository and committing the changes to the local installation.

 - + - + @@ -1793,12 +2499,344 @@ 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
+flatpak_installation_cleanup_local_refs_sync
+                               (FlatpakInstallation *self,
+                                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 +you pulled a flatpak refs using flatpak_installation_install_full() and +specified FLATPAK_INSTALL_FLAGS_NO_DEPLOY but then decided not to +deploy the refs later on and want to remove the local refs to prevent them +from taking up disk space. Note that this will not remove the objects +referred to by ref + from the underlying OSTree repo, you should use +flatpak_installation_prune_local_repo() to do that.

+
+

Parameters

+

cancellable

a GCancellable.

a GCancellable.

[nullable]

error

return location for a GError

return location for a GError

  
+++++ + + + + + + + + + + + + + + + + + +

self

a FlatpakInstallation

 

cancellable

a GCancellable.

[nullable]

error

return location for a GError

 
+
+
+

Returns

+

TRUE on success

+
+

Since: 0.10.0

+
+
+
+

flatpak_installation_get_config ()

+
char *
+flatpak_installation_get_config (FlatpakInstallation *self,
+                                 const char *key,
+                                 GCancellable *cancellable,
+                                 GError **error);
+

Get a global configuration option for the remote, see +flatpak_installation_set_config_sync() for supported keys.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

self

a FlatpakInstallation

 

key

the name of the key to get

 

cancellable

a GCancellable.

[nullable]

error

return location for a GError

 
+
+
+

Returns

+

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
+flatpak_installation_prune_local_repo (FlatpakInstallation *self,
+                                       GCancellable *cancellable,
+                                       GError **error);
+

Remove all orphaned OSTree objects from the underlying OSTree repo in +installation +.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

self

a FlatpakInstallation

 

cancellable

a GCancellable.

[nullable]

error

return location for a GError

 
+
+
+

Returns

+

TRUE on success

+
+
+
+
+

flatpak_installation_remove_local_ref_sync ()

+
gboolean
+flatpak_installation_remove_local_ref_sync
+                               (FlatpakInstallation *self,
+                                const char *remote_name,
+                                const char *ref,
+                                GCancellable *cancellable,
+                                GError **error);
+

Remove the OSTree ref given by remote_name +:ref + from the local flatpak +repository. The next time the underlying OSTree repo is pruned, objects +which were attached to that ref will be removed. This is useful if you +pulled a flatpak ref using flatpak_installation_install_full() and +specified FLATPAK_INSTALL_FLAGS_NO_DEPLOY but then decided not to +deploy the ref later on and want to remove the local ref to prevent it +from taking up disk space. Note that this will not remove the objects +referred to by ref + from the underlying OSTree repo, you should use +flatpak_installation_prune_local_repo() to do that.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

self

a FlatpakInstallation

 

remote_name

the name of the remote

 

ref

the ref

 

cancellable

a GCancellable.

[nullable]

error

return location for a GError

 
+
+
+

Returns

+

TRUE on success

+
+
+
+
+

flatpak_installation_set_config_sync ()

+
gboolean
+flatpak_installation_set_config_sync (FlatpakInstallation *self,
+                                      const char *key,
+                                      const char *value,
+                                      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.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

self

a FlatpakInstallation

 

key

the name of the key to set

 

value

the new value, or NULL to unset

 

cancellable

a GCancellable.

[nullable]

error

return location for a GError

 
+
+
+

Returns

+

TRUE if the option was set correctly

+
+
+
+
+

flatpak_installation_update_appstream_full_sync ()

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

Updates the local copy of appstream for remote_name + for the specified arch +.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

self

a FlatpakInstallation

 

remote_name

the name of the remote

 

arch

Architecture to update, or NULL for the local machine arch

 

progress

progress callback.

[scope call][nullable]

progress_data

user data passed to progress +.

[closure progress][nullable]

out_changed

Set to TRUE if the contents of the appstream changed, FALSE if nothing changed.

[nullable]

cancellable

a GCancellable.

[nullable]

error

return location for a GError

 
+
+
+

Returns

+

TRUE on success, or FALSE on error

+
+
+
+

flatpak_get_default_arch ()

const char *
 flatpak_get_default_arch (void);
@@ -1810,19 +2848,69 @@ flatpak_get_default_arch (void
+

flatpak_get_supported_arches ()

+
const char *const *
+flatpak_get_supported_arches (void);
+

Returns the canonical names for the arches that are supported (i.e. can run) +on the current machine, in order of priority (default is first).

+
+

Returns

+

a zero terminated array of arch strings

+
+
+
+
+

flatpak_get_system_installations ()

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

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

cancellable

a GCancellable.

[nullable]

error

return location for a GError

 
+
+
+

Returns

+

an GPtrArray of +FlatpakInstallation instances.

+

[transfer container][element-type FlatpakInstallation]

+
+

Since: 0.8

+
+
+

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.

The callback occurs in the thread-default context of the caller.

Parameters

-
+
@@ -1867,7 +2955,7 @@ is just an estimate

Flags to alter the behavior of flatpak_installation_update().

Members

-
+
@@ -1895,13 +2983,110 @@ is just an estimate

+ + + + +
 

FLATPAK_UPDATE_FLAGS_NO_STATIC_DELTAS

  
+
+
+

enum FlatpakInstallFlags

+

Flags to alter the behavior of flatpak_installation_install_full().

+
+

Members

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

FLATPAK_INSTALL_FLAGS_NONE

 +

Default

+		 

FLATPAK_INSTALL_FLAGS_NO_STATIC_DELTAS

  

FLATPAK_INSTALL_FLAGS_NO_DEPLOY

  

FLATPAK_INSTALL_FLAGS_NO_PULL

  
+
+
+
+
+

enum FlatpakStorageType

+

Flags to alter the behavior of flatpak_installation_install_full().

+
+

Members

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

FLATPAK_STORAGE_TYPE_DEFAULT

 +

default

+		 

FLATPAK_STORAGE_TYPE_HARD_DISK

 +

installation is on a hard disk

+		 

FLATPAK_STORAGE_TYPE_SDCARD

 +

installation is on a SD card

+		 

FLATPAK_STORAGE_TYPE_MMC

 +

installation is on an MMC

+		 

FLATPAK_STORAGE_TYPE_NETWORK

 +

installation is on the network

+		 
+
+

Since: 0.6.15

+
-
Generated by GTK-Doc V1.25.1
+
Generated by GTK-Doc V1.27 \ No newline at end of file diff --git a/reference/html/FlatpakInstalledRef.html b/reference/html/FlatpakInstalledRef.html index 093f76c2..dfe3b8c9 100644 --- a/reference/html/FlatpakInstalledRef.html +++ b/reference/html/FlatpakInstalledRef.html @@ -3,12 +3,12 @@ FlatpakInstalledRef: Flatpak Library Reference Manual - + - - + + @@ -22,7 +22,7 @@ Home Up Prev -Next +Next
@@ -35,7 +35,7 @@

Functions

-
+
@@ -50,7 +50,7 @@
-guint64 +guint64 flatpak_installed_ref_get_installed_size () @@ -58,7 +58,7 @@
-gboolean +gboolean flatpak_installed_ref_get_is_current () @@ -80,7 +80,7 @@
-GBytes * +GBytes * flatpak_installed_ref_load_metadata () @@ -98,7 +98,7 @@

Properties

-
+
@@ -107,34 +107,34 @@ +gchar * - + - + +gchar * +gchar * - + @@ -143,7 +143,7 @@

Types and Values

-
-gchar * deploy-dir Read / Write
guint64guint64 installed-size Read / Write
gbooleangboolean is-current Read / Write
-gchar * latest-commit Read / Write
-gchar * origin Read / Write
GStrvGStrv subpaths Read / Write
+
@@ -156,7 +156,7 @@

Object Hierarchy

-
    GObject
+
    GObject
     ╰── FlatpakRef
         ╰── FlatpakInstalledRef
 

@@ -176,7 +176,7 @@ flatpak_installed_ref_get_deploy_dir (
 
Parameters

-
+
@@ -191,20 +191,20 @@ flatpak_installed_ref_get_deploy_dir (

Returns

-

the deploy dir.

+

the deploy dir.

[transfer none]

flatpak_installed_ref_get_installed_size ()

-
guint64
+
guint64
 flatpak_installed_ref_get_installed_size
                                (FlatpakInstalledRef *self);

 
Returns the installed size of the ref.

 

 
Parameters

-
+
@@ -225,12 +225,12 @@ flatpak_installed_ref_get_installed_size

flatpak_installed_ref_get_is_current ()

-
gboolean
+
gboolean
 flatpak_installed_ref_get_is_current (FlatpakInstalledRef *self);

 
Returns whether the ref is current.

 

 
Parameters

-
+
@@ -245,7 +245,7 @@ flatpak_installed_ref_get_is_current (

Returns

-

TRUE if the ref is current

+

TRUE if the ref is current

@@ -257,7 +257,7 @@ flatpak_installed_ref_get_latest_commit

Gets the latest commit of the ref.

Parameters

-
+
@@ -272,7 +272,7 @@ flatpak_installed_ref_get_latest_commit

Returns

-

the latest commit.

+

the latest commit.

[transfer none]

@@ -284,7 +284,7 @@ flatpak_installed_ref_get_origin (Gets the origin of the ref.

Parameters

-
+
@@ -299,21 +299,21 @@ flatpak_installed_ref_get_origin (

Returns

-

the origin.

+

the origin.

[transfer none]

flatpak_installed_ref_load_metadata ()

-
GBytes *
+
GBytes *
 flatpak_installed_ref_load_metadata (FlatpakInstalledRef *self,
-                                     GCancellable *cancellable,
-                                     GError **error);

+                                     GCancellable *cancellable,
+                                     GError **error);

Loads the metadata file for this ref.

Parameters

-
+
@@ -327,12 +327,12 @@ flatpak_installed_ref_load_metadata ( - + - + @@ -340,8 +340,8 @@ flatpak_installed_ref_load_metadata (

Returns

-

a GBytes containing the metadata file, -or NULL if an error occurred.

+

a GBytes containing the metadata file, +or NULL if an error occurred.

[transfer full]

@@ -350,10 +350,10 @@ or N

flatpak_installed_ref_get_subpaths ()

const char * const *
 flatpak_installed_ref_get_subpaths (FlatpakInstalledRef *self);
-

Returns the subpaths that are installed, or NULL if all files installed.

+

Returns the subpaths that are installed, or NULL if all files installed.

Parameters

-

cancellable

a GCancellable.

a GCancellable.

[nullable]

error

a return location for a GError

a return location for a GError

  
+
@@ -368,7 +368,7 @@ flatpak_installed_ref_get_subpaths (

Returns

-

A strv, or NULL.

+

A strv, or NULL.

[transfer none]

@@ -384,7 +384,7 @@ flatpak_installed_ref_get_subpaths (

Property Details

The “deploy-dir” property

-
  “deploy-dir”               gchar *
+
  “deploy-dir”               gchar *

Where the application is installed.

Flags: Read / Write

Default value: NULL

@@ -392,7 +392,7 @@ flatpak_installed_ref_get_subpaths (

The “installed-size” property

-
  “installed-size”           guint64
+
  “installed-size”           guint64

The installed size of the application.

Flags: Read / Write

Default value: 0

@@ -400,7 +400,7 @@ flatpak_installed_ref_get_subpaths (

The “is-current” property

-
  “is-current”               gboolean
+
  “is-current”               gboolean

Whether the application is current.

Flags: Read / Write

Default value: FALSE

@@ -408,7 +408,7 @@ flatpak_installed_ref_get_subpaths (

The “latest-commit” property

-
  “latest-commit”            gchar *
+
  “latest-commit”            gchar *

The latest commit.

Flags: Read / Write

Default value: NULL

@@ -416,7 +416,7 @@ flatpak_installed_ref_get_subpaths (

The “origin” property

-
  “origin”                   gchar *
+
  “origin”                   gchar *

The origin.

Flags: Read / Write

Default value: NULL

@@ -424,12 +424,12 @@ flatpak_installed_ref_get_subpaths (

The “subpaths” property

-
  “subpaths”                 GStrv
+
  “subpaths”                 GStrv

Flags: Read / Write

-
Generated by GTK-Doc V1.25.1
+
Generated by GTK-Doc V1.27
\ No newline at end of file diff --git a/reference/html/FlatpakRef.html b/reference/html/FlatpakRef.html index 2a0b4fed..00987629 100644 --- a/reference/html/FlatpakRef.html +++ b/reference/html/FlatpakRef.html @@ -3,12 +3,12 @@ FlatpakRef: Flatpak Library Reference Manual - + - + @@ -35,7 +35,7 @@

Functions

-
+
@@ -67,6 +67,13 @@ + + + + @@ -98,7 +105,7 @@

Properties

-
const char * +flatpak_ref_get_collection_id () +
const char * + flatpak_ref_get_commit ()
+
@@ -107,19 +114,25 @@ +gchar * +gchar * +gchar * + + + + + @@ -130,7 +143,7 @@ +gchar * @@ -139,7 +152,7 @@

Types and Values

-
-gchar * arch Read / Write
-gchar * branch Read / Write
-gchar *collection-idRead / Write
+gchar * commit Read / Write
-gchar * name Read / Write
+
@@ -158,10 +171,11 @@

Object Hierarchy

-
    GObject
+
    GObject
     ╰── FlatpakRef
         ├── FlatpakBundleRef
         ├── FlatpakInstalledRef
+        ├── FlatpakRelatedRef
         ╰── FlatpakRemoteRef
@@ -190,7 +204,7 @@ flatpak_ref_format_ref (flatpak_ref_parse().

Parameters

-
+
@@ -205,7 +219,7 @@ can be parsed by

Returns

-

string representation.

+

string representation.

[transfer full]

@@ -217,7 +231,7 @@ flatpak_ref_get_arch (

Parameters

-
+
@@ -232,7 +246,7 @@ flatpak_ref_get_arch (

Returns

-

the arch.

+

the arch.

[transfer none]

@@ -244,7 +258,7 @@ flatpak_ref_get_branch (

Parameters

-
+
@@ -259,7 +273,34 @@ flatpak_ref_get_branch (

Returns

-

the branch.

+

the branch.

+

[transfer none]

+ + +
+
+

flatpak_ref_get_collection_id ()

+
const char *
+flatpak_ref_get_collection_id (FlatpakRef *self);
+

Gets the collection ID of the ref.

+
+

Parameters

+
+++++ + + + + + +

self

a FlatpakRef

 
+
+
+

Returns

+

the collection ID.

[transfer none]

@@ -271,7 +312,7 @@ flatpak_ref_get_commit (

Parameters

-
+
@@ -286,7 +327,7 @@ flatpak_ref_get_commit (

Returns

-

the commit.

+

the commit.

[transfer none]

@@ -298,7 +339,7 @@ flatpak_ref_get_kind (

Parameters

-
+
@@ -324,7 +365,7 @@ flatpak_ref_get_name (

Parameters

-
+
@@ -339,7 +380,7 @@ flatpak_ref_get_name (

Returns

-

the name.

+

the name.

[transfer none]

@@ -348,12 +389,12 @@ flatpak_ref_get_name (

flatpak_ref_parse ()

FlatpakRef *
 flatpak_ref_parse (const char *ref,
-                   GError **error);
+ GError **error);

Tries to parse a full ref name and return a FlatpakRef (without a commit set) or fail if the ref is invalid somehow.

Parameters

-
+
@@ -367,7 +408,7 @@ commit set) or fail if the ref is invalid somehow.

 - + @@ -375,7 +416,7 @@ commit set) or fail if the ref is invalid somehow.

Returns

-

an FlatpakRef, or NULL.

+

an FlatpakRef, or NULL.

[transfer full]

@@ -392,7 +433,7 @@ commit set) or fail if the ref is invalid somehow.

The kind of artifact that a FlatpakRef refers to.

Members

-

error

return location for a GError

return location for a GError

  
+
@@ -422,7 +463,7 @@ commit set) or fail if the ref is invalid somehow.

Property Details

The “arch” property

-
  “arch”                     gchar *
+
  “arch”                     gchar *

The architecture of the application or runtime.

Flags: Read / Write

Default value: NULL

@@ -430,15 +471,23 @@ commit set) or fail if the ref is invalid somehow.

The “branch” property

-
  “branch”                   gchar *
+
  “branch”                   gchar *

The branch of the application or runtime.

Flags: Read / Write

Default value: NULL

+

The “collection-id” property

+
  “collection-id”            gchar *
+

The collection ID.

+

Flags: Read / Write

+

Default value: NULL

+
+
+

The “commit” property

-
  “commit”                   gchar *
+
  “commit”                   gchar *

The commit.

Flags: Read / Write

Default value: NULL

@@ -454,7 +503,7 @@ commit set) or fail if the ref is invalid somehow.

The “name” property

-
  “name”                     gchar *
+
  “name”                     gchar *

The name of the application or runtime.

Flags: Read / Write

Default value: NULL

@@ -462,6 +511,6 @@ commit set) or fail if the ref is invalid somehow.

-
Generated by GTK-Doc V1.25.1
+
Generated by GTK-Doc V1.27
\ No newline at end of file diff --git a/reference/html/FlatpakRemote.html b/reference/html/FlatpakRemote.html index ba5c6bd1..2b787971 100644 --- a/reference/html/FlatpakRemote.html +++ b/reference/html/FlatpakRemote.html @@ -3,12 +3,12 @@ FlatpakRemote: Flatpak Library Reference Manual - + - + @@ -35,7 +35,7 @@

Functions

-
+
@@ -58,7 +58,7 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + - +
-GFile * +GFile * flatpak_remote_get_appstream_dir () @@ -66,7 +66,7 @@
-GFile * +GFile * flatpak_remote_get_appstream_timestamp () @@ -74,7 +74,39 @@
-gboolean +char * + +flatpak_remote_get_collection_id () +
+void + +flatpak_remote_set_collection_id () +
+char * + +flatpak_remote_get_default_branch () +
+void + +flatpak_remote_set_default_branch () +
+gboolean flatpak_remote_get_gpg_verify () @@ -98,7 +130,23 @@
-gboolean +gboolean + +flatpak_remote_get_nodeps () +
+void + +flatpak_remote_set_nodeps () +
+gboolean flatpak_remote_get_noenumerate () @@ -130,6 +178,14 @@
+FlatpakRemoteType + +flatpak_remote_get_remote_type () +
char * @@ -162,7 +218,7 @@
-gboolean +gboolean flatpak_remote_get_disabled () @@ -181,36 +237,49 @@

Properties

-
+
- + + +gchar * - + + + + + + +
-gchar * name Read / Write
FlatpakRemoteTypetypeRead / Write / Construct Only

Types and Values

-
+
- + + - + + + + + +
struct FlatpakRemote
enumFlatpakRemoteType

Object Hierarchy

-
    GObject
+
    GObject
     ╰── FlatpakRemote
@@ -239,7 +308,7 @@ using

Parameters

-
+
@@ -254,7 +323,7 @@ effect.

Returns

-

a new FlatpakRemote.

+

a new FlatpakRemote.

[transfer full]

@@ -266,7 +335,7 @@ flatpak_remote_get_name (

Parameters

-
+
@@ -281,14 +350,14 @@ flatpak_remote_get_name (

Returns

-

the name.

+

the name.

[transfer none]

flatpak_remote_get_appstream_dir ()

-
GFile *
+
GFile *
 flatpak_remote_get_appstream_dir (FlatpakRemote *self,
                                   const char *arch);

 
Returns the directory where this remote will store locally cached
@@ -296,7 +365,7 @@ appstream information for the specified arch<
 .

 

 
Parameters

-
+
@@ -310,7 +379,7 @@ appstream information for the specified arch< - + @@ -318,14 +387,14 @@ appstream information for the specified arch<

Returns

-

a GFile.

+

a GFile.

[transfer full]

flatpak_remote_get_appstream_timestamp ()

-
GFile *
+
GFile *
 flatpak_remote_get_appstream_timestamp
                                (FlatpakRemote *self,
                                 const char *arch);

@@ -334,7 +403,7 @@ has been updated (or tried to update) for the specified 
 

 
Parameters

-

arch

which architecture to fetch (default: current architecture).

which architecture to fetch (default: current architecture).

[nullable]
+
@@ -348,7 +417,7 @@ has been updated (or tried to update) for the specified - + @@ -356,19 +425,141 @@ has been updated (or tried to update) for the specified

Returns

-

a GFile.

+

a GFile.

[transfer full]

+

flatpak_remote_get_collection_id ()

+
char *
+flatpak_remote_get_collection_id (FlatpakRemote *self);
+

Returns the repository collection ID of this remote, if set.

+
+

Parameters

+

arch

which architecture to fetch (default: current architecture).

which architecture to fetch (default: current architecture).

[nullable]
+++++ + + + + + +

self

a FlatpakRemote

 
+ +
+

Returns

+

the collection ID, or NULL if unset.

+

[transfer full][nullable]

+
+ +
+
+

flatpak_remote_set_collection_id ()

+
void
+flatpak_remote_set_collection_id (FlatpakRemote *self,
+                                  const char *collection_id);
+

Sets the repository collection ID of this remote.

+

Note: This is a local modification of this object, you must commit changes +using flatpak_installation_modify_remote() for the changes to take +effect.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

a FlatpakRemote

 

collection_id

The new collection ID, or NULL to unset.

[nullable]
+
+
+
+
+

flatpak_remote_get_default_branch ()

+
char *
+flatpak_remote_get_default_branch (FlatpakRemote *self);
+

Returns the default branch configured for the remote.

+
+

Parameters

+
+++++ + + + + + +

self

a FlatpakRemote

 
+
+
+

Returns

+

the default branch, or NULL.

+

[transfer full]

+
+

Since: 0.6.12

+
+
+
+

flatpak_remote_set_default_branch ()

+
void
+flatpak_remote_set_default_branch (FlatpakRemote *self,
+                                   const char *default_branch);
+

Sets the default branch configured for this remote.

+

Note: This is a local modification of this object, you must commit changes +using flatpak_installation_modify_remote() for the changes to take +effect.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

self

a FlatpakRemote

 

default_branch

The new default_branch

 
+
+

Since: 0.6.12

+
+
+

flatpak_remote_get_gpg_verify ()

-
gboolean
+
gboolean
 flatpak_remote_get_gpg_verify (FlatpakRemote *self);

 
Returns whether GPG verification is enabled for the remote.

 

 
Parameters

-

+
@@ -391,14 +582,14 @@ flatpak_remote_get_gpg_verify (
flatpak_remote_set_gpg_verify ()

 
void
 flatpak_remote_set_gpg_verify (FlatpakRemote *self,
-                               gboolean gpg_verify);

+                               gboolean gpg_verify);
 
Sets the gpg_verify config of this remote. See flatpak_remote_get_gpg_verify().

 
Note: This is a local modification of this object, you must commit changes
 using flatpak_installation_modify_remote() for the changes to take
 effect.

 

 
Parameters

-

 
 
 


+
@@ -424,14 +615,14 @@ effect.

 
flatpak_remote_set_gpg_key ()

 
void
 flatpak_remote_set_gpg_key (FlatpakRemote *self,
-                            GBytes *gpg_key);

+                            GBytes *gpg_key);
 
Sets the trusted gpg key for this remote.

 
Note: This is a local modification of this object, you must commit changes
 using flatpak_installation_modify_remote() for the changes to take
 effect.

 

 
Parameters

-

 
 
 


+
@@ -445,7 +636,66 @@ effect.

 
 
-
+
+
+
+
+

 
 
 


 
gpg_key
a GBytes with gpg binary key data
a GBytes with gpg binary key data
 

+

+
+
+
+

flatpak_remote_get_nodeps ()

+
gboolean
+flatpak_remote_get_nodeps (FlatpakRemote *self);
+

Returns whether this remote should be used to find dependencies.

+
+

Parameters

+
+++++ + + + + + +

self

a FlatpakRemote

 
+
+
+

Returns

+

whether the remote is marked as "don't use for dependencies"

+
+
+
+
+

flatpak_remote_set_nodeps ()

+
void
+flatpak_remote_set_nodeps (FlatpakRemote *self,
+                           gboolean nodeps);
+

Sets the nodeps config of this remote. See flatpak_remote_get_nodeps().

+

Note: This is a local modification of this object, you must commit changes +using flatpak_installation_modify_remote() for the changes to take +effect.

+
+

Parameters

+
+++++ + + + + + + + + + @@ -455,12 +705,12 @@ effect.

flatpak_remote_get_noenumerate ()

-
gboolean
+
gboolean
 flatpak_remote_get_noenumerate (FlatpakRemote *self);

 
Returns whether this remote should be used to list applications.

 

 
Parameters

-

self

a FlatpakRemote

 

nodeps

a bool

  
+
@@ -483,14 +733,14 @@ flatpak_remote_get_noenumerate (

flatpak_remote_set_noenumerate ()

void
 flatpak_remote_set_noenumerate (FlatpakRemote *self,
-                                gboolean noenumerate);
+ gboolean noenumerate);

Sets the noenumeration config of this remote. See flatpak_remote_get_noenumerate().

Note: This is a local modification of this object, you must commit changes using flatpak_installation_modify_remote() for the changes to take effect.

Parameters

-
+
@@ -519,7 +769,7 @@ flatpak_remote_get_prio (

Parameters

-
+
@@ -549,7 +799,7 @@ using

Parameters

-
+
@@ -572,13 +822,40 @@ effect.

+

flatpak_remote_get_remote_type ()

+
FlatpakRemoteType
+flatpak_remote_get_remote_type (FlatpakRemote *self);
+

Get the value of “type”.

+
+

Parameters

+
+++++ + + + + + +

self

a FlatpakRemote

 
+
+
+

Returns

+

the type of remote this is

+
+

Since: 0.9.8

+
+
+

flatpak_remote_get_title ()

char *
 flatpak_remote_get_title (FlatpakRemote *self);

Returns the title of the remote.

Parameters

-
+
@@ -593,7 +870,7 @@ flatpak_remote_get_title (

Returns

-

the title.

+

the title.

[transfer full]

@@ -609,7 +886,7 @@ using

Parameters

-
+
@@ -638,7 +915,7 @@ flatpak_remote_get_url (

Parameters

-
+
@@ -653,7 +930,7 @@ flatpak_remote_get_url (

Returns

-

the URL.

+

the URL.

[transfer full]

@@ -669,7 +946,7 @@ using

Parameters

-
+
@@ -693,12 +970,12 @@ effect.

flatpak_remote_get_disabled ()

-
gboolean
+
gboolean
 flatpak_remote_get_disabled (FlatpakRemote *self);

 
Returns whether this remote is disabled.

 

 
Parameters

-
+
@@ -721,14 +998,14 @@ flatpak_remote_get_disabled (

flatpak_remote_set_disabled ()

void
 flatpak_remote_set_disabled (FlatpakRemote *self,
-                             gboolean disabled);
-

Sets the disabled config of this remote. See flatpak_remote_get_disable().

+ gboolean disabled); +

Sets the disabled config of this remote. See flatpak_remote_get_disabled().

Note: This is a local modification of this object, you must commit changes using flatpak_installation_modify_remote() for the changes to take effect.

Parameters

-
+
@@ -756,19 +1033,69 @@ effect.

struct FlatpakRemote

struct FlatpakRemote;
+
+
+

enum FlatpakRemoteType

+
+

Members

+
+++++ + + + + + + + + + + + + + + + + + +

FLATPAK_REMOTE_TYPE_STATIC

  

FLATPAK_REMOTE_TYPE_USB

  

FLATPAK_REMOTE_TYPE_LAN

  
+
+

Property Details

The “name” property

-
  “name”                     gchar *
-

The name of the remote.

+
  “name”                     gchar *
+

Name of the remote, as used in configuration files and when interfacing +with OSTree. This is typically human readable, but could be generated, and +must conform to ostree_validate_remote_name(). It should typically not be +presented in the UI.

Flags: Read / Write

Default value: NULL

+
+
+

The “type” property

+
  “type”                     FlatpakRemoteType
+

The type of the remote: whether it comes from static configuration files +(FLATPAK_REMOTE_TYPE_STATIC +) or has been dynamically found from the local +network or a mounted USB drive (FLATPAK_REMOTE_TYPE_LAN +, +FLATPAK_REMOTE_TYPE_USB +). Dynamic remotes may be added and removed over +time.

+

Flags: Read / Write / Construct Only

+

Default value: FLATPAK_REMOTE_TYPE_STATIC

+

Since: 0.9.8

+
-
Generated by GTK-Doc V1.25.1
+
Generated by GTK-Doc V1.27 \ No newline at end of file diff --git a/reference/html/FlatpakRemoteRef.html b/reference/html/FlatpakRemoteRef.html index 974e51e6..a955ec49 100644 --- a/reference/html/FlatpakRemoteRef.html +++ b/reference/html/FlatpakRemoteRef.html @@ -3,12 +3,12 @@ FlatpakRemoteRef: Flatpak Library Reference Manual - + - + - + @@ -21,7 +21,7 @@ 		Home UpPrevPrev Next
@@ -35,7 +35,7 @@

Functions

-
+
@@ -51,7 +51,7 @@

Properties

-
+
@@ -59,7 +59,7 @@ +gchar * @@ -67,7 +67,7 @@

Types and Values

-
-gchar * remote-name Read / Write
+
@@ -80,7 +80,7 @@

Object Hierarchy

-
    GObject
+
    GObject
     ╰── FlatpakRef
         ╰── FlatpakRemoteRef
 

@@ -99,7 +99,7 @@ flatpak_remote_ref_get_remote_name (Gets the remote name of the ref.

 

 
Parameters

-
+
@@ -114,7 +114,7 @@ flatpak_remote_ref_get_remote_name (

Returns

-

the remote name.

+

the remote name.

[transfer none]

@@ -130,7 +130,7 @@ flatpak_remote_ref_get_remote_name (

Property Details

The “remote-name” property

-
  “remote-name”              gchar *
+
  “remote-name”              gchar *

The name of the remote.

Flags: Read / Write

Default value: NULL

@@ -138,6 +138,6 @@ flatpak_remote_ref_get_remote_name (
-
Generated by GTK-Doc V1.25.1
+
Generated by GTK-Doc V1.27 \ No newline at end of file diff --git a/reference/html/annotation-glossary.html b/reference/html/annotation-glossary.html index 43dfee49..5da218af 100644 --- a/reference/html/annotation-glossary.html +++ b/reference/html/annotation-glossary.html @@ -3,17 +3,19 @@ Annotation Glossary: Flatpak Library Reference Manual - + - +

Functions

-
+
-GQuark +GQuark flatpak_error_quark () @@ -50,7 +50,7 @@

Types and Values

-
+
@@ -74,7 +74,7 @@

Functions

flatpak_error_quark ()

-
GQuark
+
GQuark
 flatpak_error_quark (void);
@@ -91,7 +91,7 @@ flatpak_error_quark (void<

Error codes for library functions.

Members

-
+
@@ -112,6 +112,14 @@ flatpak_error_quark (void< + + + + +
 

FLATPAK_ERROR_ONLY_PULLED

 +

App/runtime was only pulled into the local + repository but not installed.

+		 
@@ -119,6 +127,6 @@ flatpak_error_quark (void<
-
Generated by GTK-Doc V1.25.1
+
Generated by GTK-Doc V1.27 \ No newline at end of file diff --git a/reference/html/flatpak-Version-information.html b/reference/html/flatpak-Version-information.html index 03bbaede..24b3458b 100644 --- a/reference/html/flatpak-Version-information.html +++ b/reference/html/flatpak-Version-information.html @@ -3,12 +3,12 @@ Version information: Flatpak Library Reference Manual - + - + @@ -32,8 +32,23 @@
+

Functions

+
++++ + + + + +
#define +FLATPAK_CHECK_VERSION() +
+
+

Types and Values

-
+
@@ -63,7 +78,10 @@

Functions

-

+
+

FLATPAK_CHECK_VERSION()

+
#define             FLATPAK_CHECK_VERSION(major,minor,micro)
+

Types and Values

@@ -75,13 +93,13 @@

FLATPAK_MINOR_VERSION

-
#define FLATPAK_MINOR_VERSION (6)
+
#define FLATPAK_MINOR_VERSION (11)

FLATPAK_MICRO_VERSION

-
#define FLATPAK_MICRO_VERSION (13)
+
#define FLATPAK_MICRO_VERSION (3)
@@ -93,6 +111,6 @@
-
Generated by GTK-Doc V1.25.1
+
Generated by GTK-Doc V1.27 \ No newline at end of file diff --git a/reference/html/flatpak-flatpak-bundle-ref.html b/reference/html/flatpak-flatpak-bundle-ref.html index 4ba60519..6c63c5b3 100644 --- a/reference/html/flatpak-flatpak-bundle-ref.html +++ b/reference/html/flatpak-flatpak-bundle-ref.html @@ -3,12 +3,12 @@ flatpak-bundle-ref: Flatpak Library Reference Manual - + - + @@ -35,7 +35,7 @@

Functions

-
+
@@ -51,7 +51,7 @@ + + + +
-GFile * +GFile * flatpak_bundle_ref_get_file () @@ -59,7 +59,7 @@
-GBytes * +GBytes * flatpak_bundle_ref_get_metadata () @@ -67,7 +67,7 @@
-GBytes * +GBytes * flatpak_bundle_ref_get_appstream () @@ -75,7 +75,7 @@
-GBytes * +GBytes * flatpak_bundle_ref_get_icon () @@ -91,18 +91,26 @@
-guint64 +guint64 flatpak_bundle_ref_get_installed_size ()
+char * + +flatpak_bundle_ref_get_runtime_repo_url () +

Properties

-
+
@@ -110,7 +118,7 @@ +GFile * @@ -118,7 +126,7 @@

Types and Values

-
-GFile * file Read / Write
+
@@ -131,7 +139,7 @@

Object Hierarchy

-
    GObject
+
    GObject
     ╰── FlatpakRef
         ╰── FlatpakBundleRef
 

@@ -144,12 +152,12 @@
 

 
flatpak_bundle_ref_new ()

 
FlatpakBundleRef *
-flatpak_bundle_ref_new (GFile *file,
-                        GError **error);

+flatpak_bundle_ref_new (GFile *file,
+                        GError **error);

Creates a new bundle ref for the given file.

Parameters

-
+
@@ -158,12 +166,12 @@ flatpak_bundle_ref_new (

file

- + - + @@ -177,12 +185,12 @@ flatpak_bundle_ref_new (

flatpak_bundle_ref_get_file ()

-
GFile *
+
GFile *
 flatpak_bundle_ref_get_file (FlatpakBundleRef *self);

 
Get the file this bundle is stored in.

 

 
Parameters

-

a GFile

a GFile

  

error

return location for an error.

return location for an error.

[allow-none]
+
@@ -197,18 +205,18 @@ flatpak_bundle_ref_get_file (

Returns

-

(transfer full) : an GFile

+

(transfer full) : an GFile

flatpak_bundle_ref_get_metadata ()

-
GBytes *
+
GBytes *
 flatpak_bundle_ref_get_metadata (FlatpakBundleRef *self);

 
Get the metadata for the app/runtime

 

 
Parameters

-
+
@@ -223,18 +231,18 @@ flatpak_bundle_ref_get_metadata (

Returns

-

(transfer full) : an GBytes with the metadata contents, or NULL

+

(transfer full) : an GBytes with the metadata contents, or NULL

flatpak_bundle_ref_get_appstream ()

-
GBytes *
+
GBytes *
 flatpak_bundle_ref_get_appstream (FlatpakBundleRef *self);

 
Get the compressed appstream for the app/runtime

 

 
Parameters

-
+
@@ -249,19 +257,19 @@ flatpak_bundle_ref_get_appstream (

Returns

-

(transfer full) : an GBytes with the appstream contents, or NULL

+

(transfer full) : an GBytes with the appstream contents, or NULL

flatpak_bundle_ref_get_icon ()

-
GBytes *
+
GBytes *
 flatpak_bundle_ref_get_icon (FlatpakBundleRef *self,
                              int size);

 
Get the icon png data for the app/runtime

 

 
Parameters

-
+
@@ -283,7 +291,7 @@ flatpak_bundle_ref_get_icon (

Returns

-

(transfer full) : an GBytes with png contents

+

(transfer full) : an GBytes with png contents

@@ -294,7 +302,7 @@ flatpak_bundle_ref_get_origin (Get the origin url stored in the bundle

Parameters

-
+
@@ -309,18 +317,18 @@ flatpak_bundle_ref_get_origin (

Returns

-

(transfer full) : an url string, or NULL

+

(transfer full) : an url string, or NULL

flatpak_bundle_ref_get_installed_size ()

-
guint64
+
guint64
 flatpak_bundle_ref_get_installed_size (FlatpakBundleRef *self);

 
Returns the installed size for the bundle.

 

 
Parameters

-
+
@@ -338,6 +346,13 @@ flatpak_bundle_ref_get_installed_size ( +

flatpak_bundle_ref_get_runtime_repo_url ()

+
char *
+flatpak_bundle_ref_get_runtime_repo_url
+                               (FlatpakBundleRef *self);
+

Types and Values

@@ -350,12 +365,12 @@ flatpak_bundle_ref_get_installed_size (

Property Details

The “file” property

-
  “file”                     GFile *
+
  “file”                     GFile *

Flags: Read / Write

-
Generated by GTK-Doc V1.25.1
+
Generated by GTK-Doc V1.27 \ No newline at end of file diff --git a/reference/html/flatpak.devhelp2 b/reference/html/flatpak.devhelp2 index 023c2e18..1122dd00 100644 --- a/reference/html/flatpak.devhelp2 +++ b/reference/html/flatpak.devhelp2 @@ -5,6 +5,7 @@ + @@ -17,21 +18,30 @@ + + + + + + + + + @@ -40,17 +50,29 @@ + + + + + + + + + + + + @@ -59,6 +81,7 @@ + @@ -76,6 +99,14 @@ + + + + + + + + @@ -83,13 +114,20 @@ + + + + + + + @@ -97,7 +135,9 @@ + + @@ -105,11 +145,13 @@ + + @@ -117,9 +159,23 @@ + + + + + + + + + + + + + + diff --git a/reference/html/full-api-index.html b/reference/html/full-api-index.html index 51c3546f..3435320e 100644 --- a/reference/html/full-api-index.html +++ b/reference/html/full-api-index.html @@ -3,18 +3,20 @@ API Index: Flatpak Library Reference Manual - + - +
@@ -70,9 +74,18 @@
+flatpak_bundle_ref_get_runtime_repo_url, function in flatpak-bundle-ref +
+
+
flatpak_bundle_ref_new, function in flatpak-bundle-ref
+

C

+
+FLATPAK_CHECK_VERSION, macro in Version information +
+

E

FLATPAK_ERROR, macro in Error codes @@ -95,12 +108,24 @@ flatpak_get_default_arch, function in FlatpakInstallation
+
+flatpak_get_supported_arches, function in FlatpakInstallation +
+
+
+flatpak_get_system_installations, function in FlatpakInstallation +
+

I

FlatpakInstallation, struct in FlatpakInstallation
+flatpak_installation_cleanup_local_refs_sync, function in FlatpakInstallation +
+
+
flatpak_installation_create_monitor, function in FlatpakInstallation
@@ -121,10 +146,22 @@
+flatpak_installation_get_config, function in FlatpakInstallation +
+
+
flatpak_installation_get_current_installed_app, function in FlatpakInstallation
+flatpak_installation_get_display_name, function in FlatpakInstallation +
+
+
+flatpak_installation_get_id, function in FlatpakInstallation +
+
+
flatpak_installation_get_installed_ref, function in FlatpakInstallation
@@ -137,10 +174,18 @@
+flatpak_installation_get_priority, function in FlatpakInstallation +
+
+
flatpak_installation_get_remote_by_name, function in FlatpakInstallation
+flatpak_installation_get_storage_type, function in FlatpakInstallation +
+
+
flatpak_installation_install, function in FlatpakInstallation
@@ -149,6 +194,14 @@
+flatpak_installation_install_full, function in FlatpakInstallation +
+
+
+flatpak_installation_install_ref_file, function in FlatpakInstallation +
+
+
flatpak_installation_launch, function in FlatpakInstallation
@@ -165,6 +218,10 @@
+flatpak_installation_list_installed_related_refs_sync, function in FlatpakInstallation +
+
+
flatpak_installation_list_remotes, function in FlatpakInstallation
@@ -173,6 +230,10 @@
+flatpak_installation_list_remote_related_refs_sync, function in FlatpakInstallation +
+
+
flatpak_installation_load_app_overrides, function in FlatpakInstallation
@@ -189,14 +250,30 @@
+flatpak_installation_new_system_with_id, function in FlatpakInstallation +
+
+
flatpak_installation_new_user, function in FlatpakInstallation
+flatpak_installation_prune_local_repo, function in FlatpakInstallation +
+
+
+flatpak_installation_remove_local_ref_sync, function in FlatpakInstallation +
+
+
flatpak_installation_remove_remote, function in FlatpakInstallation
+flatpak_installation_set_config_sync, function in FlatpakInstallation +
+
+
flatpak_installation_uninstall, function in FlatpakInstallation
@@ -205,10 +282,18 @@
+flatpak_installation_update_appstream_full_sync, function in FlatpakInstallation +
+
+
flatpak_installation_update_appstream_sync, function in FlatpakInstallation
+flatpak_installation_update_full, function in FlatpakInstallation +
+
+
flatpak_installation_update_remote_sync, function in FlatpakInstallation
@@ -268,6 +353,10 @@ flatpak_installed_ref_load_metadata, function in FlatpakInstalledRef
+
+FlatpakInstallFlags, enum in FlatpakInstallation +
+

M

FLATPAK_MAJOR_VERSION, macro in Version information @@ -300,6 +389,10 @@
+FlatpakRef:collection-id, object property in FlatpakRef +
+
+
FlatpakRef:commit, object property in FlatpakRef
@@ -328,6 +421,10 @@
+flatpak_ref_get_collection_id, function in FlatpakRef +
+
+
flatpak_ref_get_commit, function in FlatpakRef
@@ -344,6 +441,38 @@
+FlatpakRelatedRef, struct in FlatpakRelatedRef +
+
+
+FlatpakRelatedRef:should-delete, object property in FlatpakRelatedRef +
+
+
+FlatpakRelatedRef:should-download, object property in FlatpakRelatedRef +
+
+
+FlatpakRelatedRef:subpaths, object property in FlatpakRelatedRef +
+
+
+flatpak_related_ref_get_subpaths, function in FlatpakRelatedRef +
+
+
+flatpak_related_ref_new, function in FlatpakRelatedRef +
+
+
+flatpak_related_ref_should_delete, function in FlatpakRelatedRef +
+
+
+flatpak_related_ref_should_download, function in FlatpakRelatedRef +
+
+
FlatpakRemote, struct in FlatpakRemote
@@ -352,6 +481,10 @@
+FlatpakRemote:type, object property in FlatpakRemote +
+
+
FlatpakRemoteRef, struct in FlatpakRemoteRef
@@ -360,6 +493,10 @@
+FlatpakRemoteType, enum in FlatpakRemote +
+
+
flatpak_remote_get_appstream_dir, function in FlatpakRemote
@@ -368,6 +505,14 @@
+flatpak_remote_get_collection_id, function in FlatpakRemote +
+
+
+flatpak_remote_get_default_branch, function in FlatpakRemote +
+
+
flatpak_remote_get_disabled, function in FlatpakRemote
@@ -380,6 +525,10 @@
+flatpak_remote_get_nodeps, function in FlatpakRemote +
+
+
flatpak_remote_get_noenumerate, function in FlatpakRemote
@@ -388,6 +537,10 @@
+flatpak_remote_get_remote_type, function in FlatpakRemote +
+
+
flatpak_remote_get_title, function in FlatpakRemote
@@ -404,6 +557,14 @@
+flatpak_remote_set_collection_id, function in FlatpakRemote +
+
+
+flatpak_remote_set_default_branch, function in FlatpakRemote +
+
+
flatpak_remote_set_disabled, function in FlatpakRemote
@@ -416,6 +577,10 @@
+flatpak_remote_set_nodeps, function in FlatpakRemote +
+
+
flatpak_remote_set_noenumerate, function in FlatpakRemote
@@ -431,6 +596,11 @@ flatpak_remote_set_url, function in FlatpakRemote
+

S

+
+FlatpakStorageType, enum in FlatpakInstallation +
+

U

FlatpakUpdateFlags, enum in FlatpakInstallation @@ -438,6 +608,6 @@
-
Generated by GTK-Doc V1.25.1
+
Generated by GTK-Doc V1.27 \ No newline at end of file diff --git a/reference/html/index.html b/reference/html/index.html index e4ffaac5..7bd07ac3 100644 --- a/reference/html/index.html +++ b/reference/html/index.html @@ -3,10 +3,10 @@ Flatpak Library Reference Manual: Flatpak Library Reference Manual - + - + @@ -15,7 +15,7 @@

- For flatpak 0.6.13 + For flatpak 0.11.3

@@ -34,6 +34,9 @@ FlatpakInstalledRef — Installed application reference
+FlatpakRelatedRef — Related application reference +
+
FlatpakRemoteRef — Remote application reference
@@ -55,6 +58,6 @@
-
Generated by GTK-Doc V1.25.1
+
Generated by GTK-Doc V1.27
\ No newline at end of file diff --git a/reference/html/object-tree.html b/reference/html/object-tree.html index 8b123695..0ba5e3d5 100644 --- a/reference/html/object-tree.html +++ b/reference/html/object-tree.html @@ -3,12 +3,12 @@ Object Hierarchy: Flatpak Library Reference Manual - + - + @@ -23,16 +23,17 @@

Object Hierarchy

-    GObject
+    GObject
     ├── FlatpakRef
     │   ├── FlatpakBundleRef
     │   ├── FlatpakInstalledRef
+    │   ├── FlatpakRelatedRef
     │   ╰── FlatpakRemoteRef
     ├── FlatpakInstallation
     ╰── FlatpakRemote
-
Generated by GTK-Doc V1.25.1
+
Generated by GTK-Doc V1.27 \ No newline at end of file