flatpak-builder/doc/flatpak-remote-add.xml

257 lines
8.8 KiB
XML

<?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>
<para>Add from a .flatpakrepo file:</para>
<cmdsynopsis>
<command>flatpak remote-add</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="opt">--from</arg>
<arg choice="plain">NAME</arg>
<arg choice="plain">LOCATION</arg>
</cmdsynopsis>
<para>Manually specify repo uri and options:</para>
<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>NAME</arg> is the name for the new
remote, and <arg>LOCATION</arg> is a url or pathname. The
<arg>LOCATION</arg> is either a flatpak repository, or a
.flatpakrepo file which describes a repository. In the
former case you may also have to specify extra options,
such as the gpg key for the repo.
</para>
<para>
Unless overridden with the --user or --installation options, this command
changes the default system-wide installation.
</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>--from</option></term>
<listitem><para>
Assume the URI is a .flatpakrepo file rather than the repository itself. This is enabled
by default if the extension is .flatpakrepo, so generally you don't need this option.
</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 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 <arg choice="plain">--installation=default</arg> is equivalent to using
<arg choice="plain">--system</arg>.
</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>--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>--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>--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>--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>--oci</option></term>
<listitem><para>
This is a OCI format registry rather than a regular
flatpak repository.
</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>--version</option></term>
<listitem><para>
Print version information and exit.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<para>
<command>$ flatpak remote-add gnome https://sdk.gnome.org/gnome.flatpakrepo</command>
</para>
<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>,
<citerefentry><refentrytitle>flatpak-flatpakrepo</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>