summaryrefslogtreecommitdiff
path: root/doc/flatpak-history.xml
blob: 98e8dc3e923ee5326f63fff3418286d47774a017 (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
<?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-history">

    <refentryinfo>
        <title>flatpak history</title>
        <productname>flatpak</productname>

        <authorgroup>
            <author>
                <contrib>Developer</contrib>
                <firstname>Matthias</firstname>
                <surname>Clasen</surname>
                <email>mclasen@redhat.com</email>
            </author>
        </authorgroup>
    </refentryinfo>

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

    <refnamediv>
        <refname>flatpak-history</refname>
        <refpurpose>Show history</refpurpose>
    </refnamediv>

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

    <refsect1>
        <title>Description</title>

        <para>
            Shows changes to the flatpak installations on the system. This includes
            installs, updates and removals of applications and runtimes.
        </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 information for the history command is taken from the systemd journal,
            and can also be accessed using e.g. the journalctl command.
        </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>--user</option></term>

                <listitem><para>
                    Show changes to the user installation.
                </para></listitem>
            </varlistentry>

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

                <listitem><para>
                    Show changes to the default system-wide installation.
                </para></listitem>
            </varlistentry>

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

                <listitem><para>
                    Show changes to the 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>--since=TIME</option></term>

                <listitem><para>
                    Only show changes that are newer than the time specified by
                    <arg choice="plain">TIME</arg>.
                </para><para>
                    <arg choice="plain">TIME</arg> can be either an absolute time
                    in a format like YYYY-MM-DD HH:MM:SS, or a relative time like
                    "2h", "7days", "4days 2hours".
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--until=TIME</option></term>

                <listitem><para>
                    Only show changes that are older than the time specified by
                    <arg choice="plain">TIME</arg>.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--reverse</option></term>

                <listitem><para>
                    Show newest entries first.
                </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>time</term>

                <listitem><para>
                    Show when the change happened
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>change</term>

                <listitem><para>
                    Show the kind of change
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>ref</term>

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

            <varlistentry>
                <term>application</term>

                <listitem><para>
                    Show the application/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>installation</term>

                <listitem><para>
                    Show the affected installation.
                </para><para>
                    This will be either the ID of a Flatpak installation,
                    or the path to a temporary OSTree repository.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>remote</term>

                <listitem><para>
                    Show the remote that is used.
                </para><para>
                    This will be either the name of a configured remote,
                    or the path to a temporary OSTree repository.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>old-commit</term>

                <listitem><para>
                    Show the previous commit. For pulls, this is the previous HEAD of the branch.
                    For deploys, it is the previously active commit
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>commit</term>

                <listitem><para>
                    Show the current commit. For pulls, this is the HEAD of the branch.
                    For deploys, it is the active commit
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>url</term>

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

            <varlistentry>
                <term>user</term>

                <listitem><para>
                    Show the user doing the change.
                </para><para>
                    If this is the system helper operating as root,
                    also show which user triggered the change.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>tool</term>

                <listitem><para>
                    Show the tool that was used.
                </para><para>
                    If this is the system helper, also show
                    which tool was used to triggered the change.
                </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>See also</title>

        <para>
            <citerefentry><refentrytitle>flatpak</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
            <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
        </para>

    </refsect1>

</refentry>