summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlexander Larsson <alexl@redhat.com>2016-01-13 17:02:15 +0100
committerAlexander Larsson <alexl@redhat.com>2016-01-13 17:02:15 +0100
commit025fa4e4d685a905f8b2e371a0b9d66fd5cdb6c1 (patch)
tree1226fa6719e95114f52a7b231fc8bcdd2aacbd69 /doc
parent37c648518371a43217c9d06f98230249b4813316 (diff)
downloadxdg-app-025fa4e4d685a905f8b2e371a0b9d66fd5cdb6c1.tar.gz
Merge list-apps and list-runtimes into single list command
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am3
-rw-r--r--doc/xdg-app-list-runtimes.xml138
-rw-r--r--doc/xdg-app-list.xml (renamed from doc/xdg-app-list-apps.xml)35
3 files changed, 28 insertions, 148 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index c6d233c..8954f03 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -27,8 +27,7 @@ man_MANS = \
xdg-app-install.1 \
xdg-app-update.1 \
xdg-app-uninstall.1 \
- xdg-app-list-runtimes.1 \
- xdg-app-list-apps.1 \
+ xdg-app-list.1 \
xdg-app-make-current.1 \
xdg-app-run.1 \
xdg-app-override.1 \
diff --git a/doc/xdg-app-list-runtimes.xml b/doc/xdg-app-list-runtimes.xml
deleted file mode 100644
index be4c101..0000000
--- a/doc/xdg-app-list-runtimes.xml
+++ /dev/null
@@ -1,138 +0,0 @@
-<?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-runtimes">
-
- <refentryinfo>
- <title>xdg-app list-runtimes</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-runtimes</refentrytitle>
- <manvolnum>1</manvolnum>
- </refmeta>
-
- <refnamediv>
- <refname>xdg-app-list-runtimes</refname>
- <refpurpose>List installed runtimes</refpurpose>
- </refnamediv>
-
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>xdg-app list-runtimes</command>
- <arg choice="opt" rep="repeat">OPTION</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
-
- <refsect1>
- <title>Description</title>
-
- <para>
- Lists the names of the installed runtimes.
- </para>
- <para>
- By default, both per-user and system-wide installations are shown.
- Use the --user or --system 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>--user</option></term>
-
- <listitem><para>
- Show per-user installations.
- </para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--system</option></term>
-
- <listitem><para>
- Show system-wide installations.
- </para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--show-details</option></term>
-
- <listitem><para>
- Show arches and branches, in addition to the runtime names.
- </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 --user list-runtimes --show-details</command>
- </para>
-<programlisting>
-org.gnome.Platform.Var/x86_64/3.16
-org.gnome.Sdk.Var/x86_64/3.16
-org.gnome.Sdk/x86_64/3.14
-org.gnome.Sdk/x86_64/3.16
-org.gnome.Platform/x86_64/3.16
-org.gnome.Platform/x86_64/3.14
-</programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>See also</title>
-
- <para>
- <citerefentry><refentrytitle>xdg-app</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>xdg-app-install-runtime</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>xdg-app-update-runtime</refentrytitle><manvolnum>1</manvolnum></citerefentry>
- </para>
-
- </refsect1>
-
-
-</refentry>
diff --git a/doc/xdg-app-list-apps.xml b/doc/xdg-app-list.xml
index 071b94a..001b092 100644
--- a/doc/xdg-app-list-apps.xml
+++ b/doc/xdg-app-list.xml
@@ -2,10 +2,10 @@
<!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-apps">
+<refentry id="xdg-app-list">
<refentryinfo>
- <title>xdg-app list-apps</title>
+ <title>xdg-app list</title>
<productname>xdg-app</productname>
<authorgroup>
@@ -19,18 +19,18 @@
</refentryinfo>
<refmeta>
- <refentrytitle>xdg-app list-apps</refentrytitle>
+ <refentrytitle>xdg-app list</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
- <refname>xdg-app-list-apps</refname>
- <refpurpose>List installed applications</refpurpose>
+ <refname>xdg-app-list</refname>
+ <refpurpose>List installed applications and/or runtimes</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- <command>xdg-app list-apps</command>
+ <command>xdg-app list</command>
<arg choice="opt" rep="repeat">OPTION</arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -39,13 +39,17 @@
<title>Description</title>
<para>
- Lists the names of the installed applications.
+ Lists the names of the installed applications and/or runtime.
</para>
<para>
By default, both per-user and system-wide installations
are shown. Use the --user or --system options to change
this.
</para>
+ <para>
+ By default this lists the installed apps, but you can
+ change this by using the --app or --runtime option.
+ </para>
</refsect1>
@@ -89,6 +93,21 @@
</varlistentry>
<varlistentry>
+ <term><option>--app</option></term>
+
+ <listitem><para>
+ List applications.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--runtime</option></term>
+
+ <listitem><para>
+ List runtimes.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
<term><option>-v</option></term>
<term><option>--verbose</option></term>
@@ -111,7 +130,7 @@
<title>Examples</title>
<para>
- <command>$ xdg-app --user list-apps</command>
+ <command>$ xdg-app --user list</command>
</para>
<programlisting>
org.gnome.Builder