Document list-repos command

tingping/wmclass
Matthias Clasen 2015-01-14 19:12:39 -05:00
parent 3759de6e7f
commit f7ff733071
3 changed files with 136 additions and 0 deletions

View File

@ -16,6 +16,7 @@ man_MANS = \
xdg-app.1 \
xdg-app-add-repo.1 \
xdg-app-delete-repo.1 \
xdg-app-list-repos.1 \
xdg-app-install-runtime.1 \
xdg-app-update-runtime.1 \
xdg-app-install-app.1 \

View File

@ -0,0 +1,128 @@
<?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="xdg-app-list-repos">
<refentryinfo>
<title>dxg-app list-repos</title>
<productname>xdg-app</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Alexander</firstname>
<surname>Larsson</surname>
<email>alexl@redhat.com</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>xdg-app list-repos</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>xdg-app-list-repos</refname>
<refpurpose>List remote repositories</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>xdg-app list-repos</command>
<arg choice="opt" rep="repeat">OPTION</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Lists the known remote repositories.
</para>
<para>
xdg-app can operate in system-wide or per-user mode. The system-wide
repository is located in <filename>$prefix/share/xdg-app/repo</filename>,
and the per-user repository is in <filename>$HOME/.local/share/xdg-app/repo</filename>.
</para>
<para>
xdg-app uses OSTree, and the repositories it uses are OSTree repositories
that can be manipulated with the <command>ostree</command> utility.
</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>
Work on the per-user configuration instead of the system-wide
configuration.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--show-urls</option></term>
<listitem><para>
Show the url for each repository in addition to the name.
</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>$ xdg-app list-repos --user --show-urls</command>
</para>
<programlisting>
testrepo http://209.132.179.91/repo/
</programlisting>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<citerefentry><refentrytitle>ostree</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ostree.repo</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>xdg-app-add-repo</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>

View File

@ -102,6 +102,13 @@
Delete a remote repository.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>xdg-app-list-repos</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Lists remote repositories.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>xdg-app-install-runtime</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>