summaryrefslogtreecommitdiff
path: root/doc/flatpak-remote-add.xml
blob: 302934116aca28d2fe165902a8bc1d0df937d5ad (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
<?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-remote-add">

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

    <refnamediv>
        <refname>flatpak-remote-add</refname>
        <refpurpose>Add a remote repository</refpurpose>
    </refnamediv>

    <refsynopsisdiv>
            <cmdsynopsis>
                <command>flatpak remote-add</command>
                <arg choice="opt" rep="repeat">OPTION</arg>
                <arg choice="plain">NAME</arg>
                <arg choice="plain">LOCATION</arg>
            </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1>
        <title>Description</title>

        <para>
            Adds a remote repository to the flatpak repository configuration.
            <arg choice="plain">NAME</arg> is the name for the new remote, and
            <arg choice="plain">LOCATION</arg> is the url or pathname for the repository.
        </para>
        <para>
            Unless overridden with the --user option, this command changes
            the system-wide configuration.
        </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>
                    Modify the per-user configuration.
                </para></listitem>
            </varlistentry>

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

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

            <varlistentry>
                <term><option>--no-gpg-verify</option></term>

                <listitem><para>
                    Disable GPG verification for the added remote.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--prio=PRIO</option></term>

                <listitem><para>
                    Set the priority for the remote. Default is 1, higher is more prioritized. This is
                    mainly used for graphical installation tools.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--no-enumerate</option></term>

                <listitem><para>
                    Mark the remote as not enumerated. This means the remote will
                    not be used to list applications, for instance in graphical
                    installation tools.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--if-not-exists</option></term>

                <listitem><para>
                    Do nothing if the provided remote already exists.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--disable</option></term>

                <listitem><para>
                    Disable the added remote.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--title=TITLE</option></term>

                <listitem><para>
                    A title for the remote, e.g. for display in a UI.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--gpg-import=FILE</option></term>

                <listitem><para>
                     Import gpg keys from the specified keyring file as
                     trusted for the new remote. If the file is - the
                     keyring is read from standard input.
                </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>--version</option></term>

                <listitem><para>
                    Print version information and exit.
                </para></listitem>
            </varlistentry>
        </variablelist>
    </refsect1>

    <refsect1>
        <title>Examples</title>

        <para>
            <command>$ flatpak --user remote-add --no-gpg-verify test-repo https://people.gnome.org/~alexl/gnome-sdk/repo/</command>
        </para>
    </refsect1>

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

            <para>
                <citerefentry><refentrytitle>flatpak</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                <citerefentry><refentrytitle>flatpak-modify-remote</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                <citerefentry><refentrytitle>flatpak-delete-remote</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                <citerefentry><refentrytitle>flatpak-list-remotes</refentrytitle><manvolnum>1</manvolnum></citerefentry>
            </para>
    </refsect1>

</refentry>