1FLATPAK(1)                          flatpak                         FLATPAK(1)
2
3
4

NAME

6       flatpak - Build, install and run applications and runtimes
7

SYNOPSIS

9       flatpak [OPTION...] {COMMAND}
10

DESCRIPTION

12       flatpak is a tool for managing applications and the runtimes they use.
13       In the flatpak model, applications can be built and distributed
14       independently from the host system they are used on, and they are
15       isolated from the host system ('sandboxed') to some degree, at runtime.
16
17       flatpak can operate in system-wide or per-user mode. The system-wide
18       data (runtimes, applications and configuration) is located in
19       $prefix/var/lib/flatpak/, and the per-user data is in
20       $HOME/.local/share/flatpak/. Below these locations, there is a local
21       repository in the repo/ subdirectory and installed runtimes and
22       applications are in the corresponding runtime/ and app/ subdirectories.
23
24       System-wide remotes can be statically preconfigured by dropping config
25       fragments into /etc/flatpak/remotes.d/.
26
27       In addition to the system-wide installation in
28       $prefix/var/lib/flatpak/, which is always considered the default one
29       unless overridden, more system-wide installations can be defined via
30       configuration files in /etc/flatpak/installations.d/, which must define
31       at least the id of the installation and the absolute path to it. Other
32       optional parameters like DisplayName, Priority or StorageType are also
33       supported.
34
35       flatpak uses OSTree to distribute and deploy data. The repositories it
36       uses are OSTree repositories and can be manipulated with the ostree
37       utility. Installed runtimes and applications are OSTree checkouts.
38

OPTIONS

40       The following options are understood:
41
42       -h, --help
43           Show help options and exit.
44
45       -v, --verbose
46           Print debug information during command processing. Use -vv for more
47           detail.
48
49       --ostree-verbose
50           Print OSTree debug information during command processing.
51
52       --version
53           Print version information and exit.
54
55       --default-arch
56           Print the default arch and exit.
57
58       --supported-arches
59           Print the supported arches in priority order and exit.
60
61       --gl-drivers
62           Print the list of active gl drivers and exit.
63

COMMANDS

65       Commands for managing installed applications and runtimes:
66
67       flatpak-install(1)
68           Install an application or a runtime from a remote or bundle.
69
70       flatpak-update(1)
71           Update an installed application or runtime.
72
73       flatpak-uninstall(1)
74           Uninstall an installed application or runtime.
75
76       flatpak-list(1)
77           List installed applications and/or runtimes.
78
79       flatpak-info(1)
80           Show information for an installed application or runtime.
81
82       flatpak-config(1)
83           Manage flatpak configuration.
84
85       flatpak-repair(1)
86           Repair flatpak installation.
87
88       flatpak-create-usb(1)
89           Copy apps and/or runtimes onto removable media.
90
91       Commands for finding applications and runtimes:
92
93       flatpak-search(1)
94           Search for applications and runtimes.
95
96       Commands for running applications:
97
98       flatpak-run(1)
99           Run an application.
100
101       flatpak-override(1)
102           Override permissions for an application.
103
104       flatpak-make-current(1)
105           Specify the default version to run.
106
107       flatpak-enter(1)
108           Enter the namespace of a running application.
109
110       Commands for managing file access:
111
112       flatpak-document-export(1)
113           Grant an application access to a specific file.
114
115       flatpak-document-unexport(1)
116           Revoke access to a specific file.
117
118       flatpak-document-info(1)
119           Show information about a specific file.
120
121       flatpak-document-list(1)
122           List exported files.
123
124       Commands for managing the dynamic permission store:
125
126       flatpak-permission-remove(1)
127           Remove item from permission store.
128
129       flatpak-permission-list(1)
130           List permissions.
131
132       flatpak-permission-show(1)
133           Show app permissions.
134
135       flatpak-permission-reset(1)
136           Reset app permissions.
137
138       Commands for managing remote repositories:
139
140       flatpak-remotes(1)
141           List all configured remote repositories.
142
143       flatpak-remote-add(1)
144           Add a new remote repository.
145
146       flatpak-remote-modify(1)
147           Modify properties of a configured remote repository.
148
149       flatpak-remote-delete(1)
150           Delete a configured remote repository.
151
152       flatpak-remote-ls(1)
153           List contents of a configured remote repository.
154
155       flatpak-remote-info(1)
156           Show information about a ref in a configured remote repository.
157
158       Commands for building applications:
159
160       flatpak-build-init(1)
161           Initialize a build directory.
162
163       flatpak-build(1)
164           Run a build command in a build directory.
165
166       flatpak-build-finish(1)
167           Finalizes a build directory for export.
168
169       flatpak-build-export(1)
170           Export a build directory to a repository.
171
172       flatpak-build-bundle(1)
173           Create a bundle file from a ref in a local repository.
174
175       flatpak-build-import-bundle(1)
176           Import a file bundle into a local repository.
177
178       flatpak-build-sign(1)
179           Sign an application or runtime after its been exported.
180
181       flatpak-build-update-repo(1)
182           Update the summary file in a repository.
183
184       flatpak-build-commit-from(1)
185           Create a new commit based on an existing ref.
186
187       flatpak-repo(1)
188           Print information about a repo.
189

FILE FORMATS

191       File formats that are used by Flatpak commands:
192
193       flatpak-flatpakref(5)
194           Reference to a remote for an application or runtime
195
196       flatpak-flatpakrepo(5)
197           Reference to a remote
198
199       flatpak-remote(5)
200           Configuration for a remote
201
202       flatpak-installation(5)
203           Configuration for an installation location
204
205       flatpak-metadata(5)
206           Information about an application or runtime
207

ENVIRONMENT

209       Besides standard environment variables such as XDG_DATA_DIRS and
210       XDG_DATA_HOME, flatpak is consulting some of its own.
211
212       FLATPAK_USER_DIR
213           The location of the per-user installation. If this is not set,
214           $XDG_DATA_HOME/flatpak is used.
215
216       FLATPAK_SYSTEM_DIR
217           The location of the default system-wide installation. If this is
218           not set, /var/lib/flatpak is used (unless overridden at build time
219           by --localstatedir or --with-system-install-dir).
220
221       FLATPAK_CONFIG_DIR
222           The location of flatpak site configuration. If this is not set,
223           /etc/flatpak is used (unless overridden at build time by
224           --sysconfdir).
225

SEE ALSO

227       ostree(1), ostree.repo(5), flatpak-remote(5),
228
229
230
231flatpak                                                             FLATPAK(1)
Impressum