Files
flatpak/doc/flatpak-remotes.xml
Phaedrus Leeds ff8490a91e app: Add -u alias for --user
Save folks a few keystrokes. There is a command which already has a '-u'
option, document-export, but it doesn't support --user so there should
be no conflict. However '-s' is used by the info command among others,
so we can't use that for --system.
2022-08-16 10:50:29 +02:00

284 lines
8.2 KiB
XML

<?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-remotes">
<refentryinfo>
<title>flatpak remotes</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 remotes</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>flatpak-remotes</refname>
<refpurpose>List remote repositories</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>flatpak remotes</command>
<arg choice="opt" rep="repeat">OPTION</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Lists the known remote repositories, in priority order.
</para>
<para>
By default, both per-user and system-wide installations
are shown. Use the <option>--user</option>, <option>--system</option> or <option>--installation</option>
options to change this.
</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>
Show the per-user configuration.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--system</option></term>
<listitem><para>
Show the default system-wide configuration.
</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>-d</option></term>
<term><option>--show-details</option></term>
<listitem><para>
Show more information for each repository in addition to the name.
Equivalent to <option>--columns=all</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--show-disabled</option></term>
<listitem><para>
Show disabled repos.
</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 ref. 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>name</term>
<listitem><para>
Show the name of the remote
</para></listitem>
</varlistentry>
<varlistentry>
<term>title</term>
<listitem><para>
Show the title of the remote
</para></listitem>
</varlistentry>
<varlistentry>
<term>url</term>
<listitem><para>
Show the URL of the remote
</para></listitem>
</varlistentry>
<varlistentry>
<term>filter</term>
<listitem><para>
Show the path to the client-side filter of the remote.
</para></listitem>
</varlistentry>
<varlistentry>
<term>collection</term>
<listitem><para>
Show the collection ID of the remote
</para></listitem>
</varlistentry>
<varlistentry>
<term>priority</term>
<listitem><para>
Show the priority of the remote
</para></listitem>
</varlistentry>
<varlistentry>
<term>options</term>
<listitem><para>
Show options
</para></listitem>
</varlistentry>
<varlistentry>
<term>comment</term>
<listitem><para>
Show comment
</para></listitem>
</varlistentry>
<varlistentry>
<term>description</term>
<listitem><para>
Show description
</para></listitem>
</varlistentry>
<varlistentry>
<term>homepage</term>
<listitem><para>
Show homepage
</para></listitem>
</varlistentry>
<varlistentry>
<term>icon</term>
<listitem><para>
Show icon
</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>Examples</title>
<para>
<command>$ flatpak remotes --user --show-details</command>
</para>
<programlisting>
testrepo Test Repository http://209.132.179.91/repo/ no-gpg-verify
</programlisting>
</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>
</para>
</refsect1>
</refentry>