summaryrefslogtreecommitdiff
path: root/doc/flatpak-search.xml
blob: 47bc73befa6fecb45893e48ac9024adfd00e02f5 (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
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<refentry id="flatpak-search">

    <refentryinfo>
        <title>flatpak search</title>
        <productname>flatpak</productname>

        <authorgroup>
            <author>
                <contrib>Developer</contrib>
                <firstname>Patrick</firstname>
                <surname>Griffis</surname>
                <email>tingping@tingping.se</email>
            </author>
        </authorgroup>
    </refentryinfo>

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

    <refnamediv>
        <refname>flatpak-search</refname>
        <refpurpose>Search for applications and runtimes</refpurpose>
    </refnamediv>

    <refsynopsisdiv>
            <cmdsynopsis>
                <command>flatpak search</command>
                <arg choice="plain">TEXT</arg>
            </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1>
        <title>Description</title>

        <para>
            Searches for applications and runtimes matching
            <arg choice="plain">TEXT</arg>. Note that this uses appstream data
            that can be updated with the <command>flatpak update</command> command.
            The appstream data is updated automatically only if it's at least a day old.
        </para>
    </refsect1>

    <refsect1>
        <title>Options</title>

        <para>The following options are understood:</para>

        <variablelist>
            <varlistentry>
                <term><option>--user</option></term>

                <listitem><para>
                    Only search through remotes in the per-user installation.
                </para></listitem>
            </varlistentry>

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

                <listitem><para>
                    Only search through remotes in the default system-wide installation.
                </para></listitem>
            </varlistentry>

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

                <listitem><para>
                    Show a system-wide installation 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>-h</option></term>
                <term><option>--help</option></term>

                <listitem><para>
                    Show help options and exit.
                </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 result. 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>description</term>

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

            <varlistentry>
                <term>application</term>

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

            <varlistentry>
                <term>version</term>

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

            <varlistentry>
                <term>version</term>

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

            <varlistentry>
                <term>remotes</term>

                <listitem><para>
                    Show the remotes
                </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>
            </para>
    </refsect1>

</refentry>