summaryrefslogtreecommitdiff
path: root/doc/flatpak-remote-info.xml
blob: 394bacadab4cb3290054181b5098584c4d540eaa (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
<?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-remote-info">

    <refentryinfo>
        <title>flatpak remote-info</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 remote-info</refentrytitle>
        <manvolnum>1</manvolnum>
    </refmeta>

    <refnamediv>
        <refname>flatpak-remote-info</refname>
        <refpurpose>Show information about an application or runtime in a remote</refpurpose>
    </refnamediv>

    <refsynopsisdiv>
            <cmdsynopsis>
                <command>flatpak remote-info</command>
                <arg choice="opt" rep="repeat">OPTION</arg>
                <arg choice="plain">REMOTE</arg>
                <arg choice="plain">REF</arg>
            </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1>
        <title>Description</title>

        <para>
            Shows information about the runtime or application <arg choice="plain">REF</arg> from the
            remote repository with the name <arg choice="plain">REMOTE</arg>.
            You can find all configured remote repositories with flatpak remotes.
        </para>
        <para>
            By default, the output is formatted in a friendly format.
            If you specify one of the <option>--show-…</option> options,
            the output is instead formatted in a machine-readable format.
        </para>
        <para>
            Unless overridden with the <option>--system</option>, <option>--user</option>, or <option>--installation</option> options,
            this command uses either the default system-wide installation or the
            per-user one, depending on which has the specified
            <arg choice="plain">REMOTE</arg>.
        </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>
                    Use the per-user configuration.
                </para></listitem>
            </varlistentry>

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

                <listitem><para>
                    Use the default system-wide configuration.
                </para></listitem>
            </varlistentry>

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

                <listitem><para>
                    Use 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>--cached</option></term>

                <listitem><para>
                  Prefer to use locally cached information if possible, even though it
                  may be out of date. This is faster, but risks returning stale information.
                  Also, some information is not cached so will not be available.
                </para></listitem>
            </varlistentry>

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

                <listitem><para>
                    Assume that <arg choice="plain">REF</arg> is a runtime if not explicitly specified.
                </para></listitem>
            </varlistentry>

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

                <listitem><para>
                    Assume that <arg choice="plain">REF</arg> is an app if not explicitly specified.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--arch=ARCH</option></term>

                <listitem><para>
                    The default architecture to look for, if not given explicitly in
                    the <arg choice="plain">REF</arg>. See <command>flatpak --supported-arches</command>
                    for architectures supported by the host.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--commit=COMMIT</option></term>

                <listitem><para>
                    Show information about the specific commit, rather than the latest version.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--log</option></term>

                <listitem><para>
                    Display a log of previous versions.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>-r</option></term>
                <term><option>--show-ref</option></term>

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

            <varlistentry>
                <term><option>-c</option></term>
                <term><option>--show-commit</option></term>

                <listitem><para>
                    Show the commit id.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>-p</option></term>
                <term><option>--show-parent</option></term>

                <listitem><para>
                    Show the parent commit id.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>-m</option></term>
                <term><option>--show-metadata</option></term>

                <listitem><para>
                    Show the metadata.
                </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 remote-info flathub org.gnome.gedit</command>
        </para>
<programlisting>
Ref: app/org.gnome.gedit/x86_64/stable
ID: org.gnome.gedit
Arch: x86_64
Branch: stable
Date: 2017-07-31 16:05:22 +0000
Subject: Build org.gnome.gedit at 3ec291fc1ce4d78220527fa79576f4cc1481ebe5
Commit: 3de7e9dde3bb8382aad9dfbbff20eccd9bf2100bc1887a3619ec0372e8066bf7
Parent: -
Download size: 3,4 MB
Installed size: 11,1 MB
Runtime: org.gnome.Platform/x86_64/3.24
</programlisting>

    </refsect1>

    <refsect1>
        <title>See also</title>

            <para>
                <citerefentry><refentrytitle>flatpak</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                <citerefentry><refentrytitle>flatpak-remotes</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                <citerefentry><refentrytitle>flatpak-remote-ls</refentrytitle><manvolnum>1</manvolnum></citerefentry>
            </para>
    </refsect1>

</refentry>