<?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-modify">

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

    <refnamediv>
        <refname>flatpak-remote-modify</refname>
        <refpurpose>Modify a remote repository</refpurpose>
    </refnamediv>

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

    <refsect1>
        <title>Description</title>

        <para>
            Modifies options for an existing remote repository in the flatpak repository configuration.
            <arg choice="plain">NAME</arg> is the name for the remote.
        </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>
                    Modify the per-user configuration.
                </para></listitem>
            </varlistentry>

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

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

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

                <listitem><para>
                    Modify 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>--no-gpg-verify</option></term>

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

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

                <listitem><para>
                    Enable 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>--subset=SUBSET</option></term>

                <listitem><para>
                  Limit the refs available from the remote to those that are part of the named subset.
                </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. It will also not be used for runtime dependency
                    resolution (as with <option>--no-use-for-deps</option>).
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--no-use-for-deps</option></term>

                <listitem><para>
                    Mark the remote as not to be used for automatic runtime
                    dependency resolution.
                </para></listitem>
            </varlistentry>

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

                <listitem><para>
                    Disable the remote. Disabled remotes will not be automatically updated from.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--enable</option></term>

                <listitem><para>
                    Enable the remote.
                </para></listitem>
            </varlistentry>

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

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

            <varlistentry>
                <term><option>--use-for-deps</option></term>

                <listitem><para>
                    Mark the remote as to be used for automatic runtime
                    dependency resolution.
                </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>--comment=COMMENT</option></term>

                <listitem><para>
                    A single-line comment for the remote, e.g. for display in a UI.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--description=DESCRIPTION</option></term>

                <listitem><para>
                    A full-paragraph description for the remote, e.g. for display in a UI.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--homepage=URL</option></term>

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

            <varlistentry>
                <term><option>--icon=URL</option></term>

                <listitem><para>
                    URL for an icon for the remote, e.g. for display in a UI.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--default-branch=BRANCH</option></term>

                <listitem><para>
                    A default branch for the remote, mainly for use in a UI.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--collection-id=COLLECTION-ID</option></term>

                <listitem><para>
                    The globally unique identifier of the remote repository, to
                    allow mirrors to be grouped. This must only be set to the
                    collection ID provided by the remote, and must not be set if the
                    remote does not provide a collection ID.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--url=URL</option></term>

                <listitem><para>
                    Set a new URL.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--update-metadata</option></term>

                <listitem><para>
                    Update the remote's extra metadata from the OSTree repository's summary
                    file. Only xa.title and xa.default-branch are supported at the moment.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--no-filter</option></term>
                <term><option>--filter=FILE</option></term>

                <listitem><para>
                  Modify the path (or unset) for the local filter used for this remote.
                  See <citerefentry><refentrytitle>flatpak-remote-add</refentrytitle><manvolnum>1</manvolnum></citerefentry> for details about the filter file format.
                </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>--authenticator-name=NAME</option></term>

                <listitem><para>
                    Specify the authenticator to use for the remote.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--authenticator-option=KEY=VALUE</option></term>

                <listitem><para>
                    Specify an authenticator option for the remote.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--authenticator-install</option></term>

                <listitem><para>
                    Enable auto-installation of authenticator.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--no-authenticator-install</option></term>

                <listitem><para>
                    Disable auto-installation of authenticator.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--follow-redirect</option></term>

                <listitem><para>
                    Follow xa.redirect-url defined in the summary file.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--no-follow-redirect</option></term>

                <listitem><para>
                    Do not follow xa.redirect-url defined in the summary file.
                </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-modify --no-gpg-verify test-repo</command>
        </para>
    </refsect1>

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

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

</refentry>
