Section 1: user commands and tools
NAME flatpak-ps – Enumerate running instances SYNOPSIS flatpak ps [OPTION…] DESCRIPTION Lists useful information about running Flatpak instances. To see full details of a running instance, you can open the file /run/user/$UID/.flatpak/$INSTANCE/info, where $INSTANCE is the instance ID reported by flatpak ps. OPTIONS The following options are understood: -h, –help Show help options and exit….
NAME flatpak-permissions – List permissions SYNOPSIS flatpak permissions [OPTION…] [TABLE] [ID] DESCRIPTION Lists dynamic permissions which are stored in the Flatpak permission store. When called without arguments, lists all the entries in all permission store tables. When called with one argument, lists all the entries in the named table. When called with two arguments, lists…
NAME flatpak-permission-show – Show permissions SYNOPSIS flatpak permission-show [OPTION…] APP_ID DESCRIPTION Lists dynamic permissions for the given app which are stored in the Flatpak permission store. When called without arguments, lists all the entries in all permission store tables. When called with one argument, lists all the entries in the named table. When called with…
NAME flatpak-permission-set – Set permissions SYNOPSIS flatpak permission-set [OPTION…] TABLE ID APP_ID [PERMISSION…] DESCRIPTION Set the permissions for an application in an entry in the permission store. The entry is identified by TABLE and ID, the application is identified by APP_ID. The PERMISSION strings must be in a format suitable for the table. The permission…
NAME flatpak-permission-reset – Reset permissions SYNOPSIS flatpak permission-reset [OPTION…] APP_ID flatpak permission-reset [OPTION…] –all DESCRIPTION Removes all permissions for the given app from the Flatpak permission store. The permission store is used by portals. Each portal generally has its own table in the permission store, and the format of the table entries is specific to…
NAME flatpak-permission-remove – Remove permissions SYNOPSIS flatpak permission-remove [OPTION…] TABLE ID [APP_ID] DESCRIPTION Removes an entry for the object with id ID to the permission store table TABLE. The ID must be in a suitable format for the table. If APP_ID is specified, only the entry for that application is removed. The permission store is…
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…
NAME flatpak-mask – Mask out updates and automatic installation SYNOPSIS flatpak mask [OPTION…] PATTERN… DESCRIPTION Flatpak maintains a list of patterns that define which refs are masked. A masked ref will never be updated or automatically installed (for example a masked extension marked auto-download will not be downloaded). You can still manually install such refs,…
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…
NAME flatpak-list – List installed applications and/or runtimes SYNOPSIS flatpak list [OPTION…] DESCRIPTION Lists the names of the installed applications and runtimes. By default, both apps and runtimes are shown, but you can change this by using the –app or –runtime options. By default, both per-user and system-wide installations are shown. Use the –user, –installation…
NAME flatpak-kill – Stop a running application SYNOPSIS flatpak kill INSTANCE DESCRIPTION Stop a running Flatpak instance. INSTANCE can be either the numeric instance ID or the application ID of a running Flatpak. You can use flatpak ps to find the instance IDs of running flatpaks. OPTIONS The following options are understood: -h, –help Show…
NAME flatpak-install – Install an application or runtime SYNOPSIS flatpak install [OPTION…] [REMOTE] REF… flatpak install [OPTION…] [–from|–bundle] LOCATION DESCRIPTION Installs an application or runtime. The primary way to install is to specify a REMOTE name as the source and one ore more REFs to specify the application or runtime to install. If REMOTE is…
NAME flatpak-info – Show information about an installed application or runtime SYNOPSIS flatpak info [OPTION…] NAME [BRANCH] DESCRIPTION Show info about an installed application or runtime. By default, the output is formatted in a friendly format. If you specify any of the –show-… or –file-access options, the output is instead formatted in a machine-readable format….
NAME flatpak-history – Show history SYNOPSIS flatpak history [OPTION…] DESCRIPTION Shows changes to the flatpak installations on the system. This includes installs, updates and removals of applications and runtimes. By default, both per-user and system-wide installations are shown. Use the –user, –installation or –system options to change this. The information for the history command is…
NAME flatpak-enter – Enter an application or runtime’s sandbox SYNOPSIS flatpak enter [OPTION…] INSTANCE COMMAND [ARG…] DESCRIPTION Enter a running sandbox. INSTANCE must be either the pid of a process running in a flatpak sandbox, or the ID of a running application, or the instance ID of a running sandbox. You can use flatpak ps…
NAME flatpak-documents – List exported files SYNOPSIS flatpak documents [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…
NAME flatpak-document-unexport – Stop exporting a file SYNOPSIS flatpak document-unexport [OPTION…] FILE DESCRIPTION Removes the document id for the file from the document portal. This will make the document unavailable to all sandboxed applications. OPTIONS The following options are understood: -h, –help Show help options and exit. -v, –verbose Print debug information during command processing….
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…
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….
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…