-
-
Notifications
You must be signed in to change notification settings - Fork 389
/
flatpak-update.xml
300 lines (245 loc) · 11.5 KB
/
flatpak-update.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http:https://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<refentry id="flatpak-update">
<refentryinfo>
<title>flatpak update</title>
<productname>flatpak</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Alexander</firstname>
<surname>Larsson</surname>
<email>[email protected]</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>flatpak update</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>flatpak-update</refname>
<refpurpose>Update an application or runtime</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>flatpak update</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="opt" rep="repeat">REF</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>flatpak update</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">--appstream</arg>
<arg choice="opt">REMOTE</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Updates applications and runtimes. <arg choice="plain">REF</arg> is a reference to the
application or runtime to update. If no <arg choice="plain">REF</arg> is given, everything
is updated, as well as appstream info for all remotes.
</para>
<para>
Each <arg choice="plain">REF</arg> argument is a full or partial identifier 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.
</para>
<para>
By default this looks for both apps and runtimes with the given <arg choice="plain">REF</arg>,
but you can limit this by using the <option>--app</option> or <option>--runtime</option> option, or by supplying the initial
element in the <arg choice="plain">REF</arg>.
</para>
<para>
Normally, this command updates the application to the tip
of its branch. But it is possible to check out another commit,
with the <option>--commit</option> option.
</para>
<para>
If the configured remote for a ref being updated has a collection ID configured on it,
Flatpak will search the <filename>sideload-repos</filename> directories configured
either with the <option>--sideload-repo</option> option, or on a per-installation or
system-wide basis (see
<citerefentry><refentrytitle>flatpak</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
</para>
<para>
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 <option>--commit</option> option.
</para>
<para>
In addition to updates, this command will offer to uninstall any unused end-of-life
runtimes. Runtimes that were explicitly installed (not as a dependency) or explicitly
pinned (see <citerefentry><refentrytitle>flatpak-pin</refentrytitle><manvolnum>1</manvolnum></citerefentry>)
are left installed even if unused and end-of-life.
</para>
<para>
Unless overridden with the <option>--user</option>, <option>--system</option> or <option>--installation</option> option, this command updates
any matching refs in the standard system-wide installation and the per-user one.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>-h</option></term>
<term><option>--help</option></term>
<listitem><para>
Show help options and exit.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-u</option></term>
<term><option>--user</option></term>
<listitem><para>
Update a per-user installation.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--system</option></term>
<listitem><para>
Update the default system-wide installation.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--installation=NAME</option></term>
<listitem><para>
Updates a system-wide installation specified by <arg choice="plain">NAME</arg>
among those defined in <filename>/etc/flatpak/installations.d/</filename>.
Using <option>--installation=default</option> is equivalent to using
<option>--system</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--arch=ARCH</option></term>
<listitem><para>
The architecture to update for. See <command>flatpak --supported-arches</command>
for architectures supported by the host.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--subpath=PATH</option></term>
<listitem><para>
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.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--commit=COMMIT</option></term>
<listitem><para>
Update to this commit, instead of the tip of the branch. You can find commits
using <command>flatpak remote-info --log REMOTE REF</command>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-deploy</option></term>
<listitem><para>
Download the latest version, but don't deploy it.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-pull</option></term>
<listitem><para>
Don't download the latest version, deploy whatever is locally available.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-related</option></term>
<listitem><para>
Don't download related extensions, such as the locale data.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-deps</option></term>
<listitem><para>
Don't update or install runtime dependencies when installing.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--app</option></term>
<listitem><para>
Only look for an app with the given name.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--appstream</option></term>
<listitem><para>
Update appstream for <arg choice="plain">REMOTE</arg>, or all remotes if no remote is specified.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--runtime</option></term>
<listitem><para>
Only look for a runtime with the given name.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--sideload-repo=PATH</option></term>
<listitem><para>
Adds an extra local ostree repo as a source for installation. This is equivalent
to using the <filename>sideload-repos</filename> directories (see
<citerefentry><refentrytitle>flatpak</refentrytitle><manvolnum>1</manvolnum></citerefentry>),
but can be done on a per-command basis. Any path added here is used in addition
to ones in those directories.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-y</option></term>
<term><option>--assumeyes</option></term>
<listitem><para>
Automatically answer yes to all questions (or pick the most prioritized answer). This is useful for automation.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--noninteractive</option></term>
<listitem><para>
Produce minimal output and avoid most questions. This is suitable for use in
non-interactive situations, e.g. in a build script.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--force-remove</option></term>
<listitem><para>
Remove old files even if they're in use by a running application.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<term><option>--verbose</option></term>
<listitem><para>
Print debug information during command processing.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--ostree-verbose</option></term>
<listitem><para>
Print OSTree debug information during command processing.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<para>
<command>$ flatpak --user update org.gnome.gedit</command>
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<citerefentry><refentrytitle>flatpak</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-install</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-list</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ostree-find-remotes</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>