summaryrefslogtreecommitdiff
path: root/doc/flatpak-list.xml
blob: edb9ed4be3cfeb147b7723da15d9b897f4a88b96 (plain)
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
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
    "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">

<refentry id="flatpak-list">

    <refentryinfo>
        <title>flatpak list</title>
        <productname>flatpak</productname>

        <authorgroup>
            <author>
                <contrib>Developer</contrib>
                <firstname>Alexander</firstname>
                <surname>Larsson</surname>
                <email>alexl@redhat.com</email>
            </author>
        </authorgroup>
    </refentryinfo>

    <refmeta>
        <refentrytitle>flatpak list</refentrytitle>
        <manvolnum>1</manvolnum>
    </refmeta>

    <refnamediv>
        <refname>flatpak-list</refname>
        <refpurpose>List installed applications and/or runtimes</refpurpose>
    </refnamediv>

    <refsynopsisdiv>
            <cmdsynopsis>
                <command>flatpak list</command>
                <arg choice="opt" rep="repeat">OPTION</arg>
            </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1>
        <title>Description</title>

        <para>
            Lists the names of the installed applications and runtimes.
        </para>
        <para>
            By default, both apps and runtimes are shown, but you can
            change this by using the <option>--app</option> or
            <option>--runtime</option> options.
        </para>
        <para>
            By default, both per-user and system-wide installations are shown.
            Use the <option>--user</option>, <option>--installation</option> or
            <option>--system</option> options to change this.
        </para>
        <para>
            The list command can also be used to find installed apps that
            use a certain runtime, with the <option>--app-runtime</option> option.
        </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>
                    List per-user installations.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--system</option></term>

                <listitem><para>
                    List the default system-wide installations.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--installation=NAME</option></term>

                <listitem><para>
                    List 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>
                    List apps/runtimes for this architecture. See <command>flatpak --supported-arches</command>
                    for architectures supported by the host.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>-d</option></term>
                <term><option>--show-details</option></term>

                <listitem><para>
                    Show origin, sizes and other extra information.
                    Equivalent to <option>--columns=all</option>.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--app</option></term>

                <listitem><para>
                    List applications.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--runtime</option></term>

                <listitem><para>
                    List runtimes.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--all</option></term>
                <term><option>-a</option></term>

                <listitem><para>
                    List all installed runtimes, including locale and debug extensions. These are hidden by default.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--app-runtime=RUNTIME</option></term>

                <listitem><para>
                    List applications that use the given runtime.
                </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>

            <varlistentry>
                <term><option>--columns=FIELD,…</option></term>

                <listitem><para>
                    Specify what information to show about each ref. You can
                    list multiple fields, or use this option multiple times.
                </para><para>
                    Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column
                    names to change ellipsization.
                </para></listitem>
            </varlistentry>

        </variablelist>
    </refsect1>

   <refsect1>
        <title>Fields</title>

        <para>The following fields are understood by the <option>--columns</option> option:</para>

        <variablelist>
            <varlistentry>
                <term>name</term>

                <listitem><para>
                    Show the name
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>description</term>

                <listitem><para>
                    Show the description
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>application</term>

                <listitem><para>
                    Show the application or runtime ID
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>arch</term>

                <listitem><para>
                    Show the architecture
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>branch</term>

                <listitem><para>
                    Show the branch
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>runtime</term>

                <listitem><para>
                    Show the used runtime
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>version</term>

                <listitem><para>
                    Show the version
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>ref</term>

                <listitem><para>
                    Show the ref
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>origin</term>

                <listitem><para>
                    Show the origin remote
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>installation</term>

                <listitem><para>
                    Show the installation
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>active</term>

                <listitem><para>
                    Show the active commit
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>latest</term>

                <listitem><para>
                    Show the latest commit
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>size</term>

                <listitem><para>
                    Show the installed size
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>options</term>

                <listitem><para>
                    Show options
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>all</term>

                <listitem><para>
                    Show all columns
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>help</term>

                <listitem><para>
                    Show the list of available columns
                </para></listitem>
            </varlistentry>
        </variablelist>

        <para>
          Note that field names can be abbreviated to a unique prefix.
        </para>

    </refsect1>

    <refsect1>
        <title>Examples</title>

        <para>
            <command>$ flatpak --user --columns=app list</command>
        </para>
<programlisting>
<command>Application</command>
org.gnome.Builder
org.freedesktop.glxgears
org.gnome.MyApp
org.gnome.gedit
</programlisting>

    </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-update</refentrytitle><manvolnum>1</manvolnum></citerefentry>
        </para>

    </refsect1>

</refentry>