marko10_000
/
flatpak-builder
forked from Mirrors/flatpak-builder
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs: Update for the new command names

tingping/wmclass
Alexander Larsson 2016-01-13 16:33:43 +01:00
parent 123626b36f
commit 37c6485183
15 changed files with 183 additions and 612 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
doc/Makefile.am
View File

@ -6,12 +6,12 @@ endif
SUBDIRS = $(LIB_DOCS)
XSLTPROC_FLAGS = \
--nonet \
--stringparam man.output.quietly 1 \
--stringparam funcsynopsis.style ansi \
--stringparam man.th.extra1.suppress 1 \
--stringparam man.authors.section.enabled 0 \
--stringparam man.copyright.section.enabled 0 \
--nonet \
--stringparam man.output.quietly 1 \
--stringparam funcsynopsis.style ansi \
--stringparam man.th.extra1.suppress 1 \
--stringparam man.authors.section.enabled 0 \
--stringparam man.copyright.section.enabled 0 \
$(NULL)
.xml.1:
@ -19,30 +19,27 @@ XSLTPROC_FLAGS = \
man_MANS = \
xdg-app.1 \
xdg-app-add-remote.1 \
xdg-app-delete-remote.1 \
xdg-app-list-remotes.1 \
xdg-app-modify-remote.1 \
xdg-app-ls-remote.1 \
xdg-app-install-runtime.1 \
xdg-app-update-runtime.1 \
xdg-app-uninstall-runtime.1 \
xdg-app-list-runtimes.1 \
xdg-app-install-app.1 \
xdg-app-update-app.1 \
xdg-app-make-app-current.1 \
xdg-app-uninstall-app.1 \
xdg-app-list-apps.1 \
xdg-app-run.1 \
xdg-app-remote-add.1 \
xdg-app-remote-delete.1 \
xdg-app-remote-list.1 \
xdg-app-remote-modify.1 \
xdg-app-remote-ls.1 \
xdg-app-install.1 \
xdg-app-update.1 \
xdg-app-uninstall.1 \
xdg-app-list-runtimes.1 \
xdg-app-list-apps.1 \
xdg-app-make-current.1 \
xdg-app-run.1 \
xdg-app-override.1 \
xdg-app-enter.1 \
xdg-app-enter.1 \
xdg-app-export-file.1 \
xdg-app-build-init.1 \
xdg-app-build.1 \
xdg-app-build-finish.1 \
xdg-app-build-export.1 \
xdg-app-repo-update.1 \
xdg-app-builder.1 \
xdg-app-build-init.1 \
xdg-app-build.1 \
xdg-app-build-finish.1 \
xdg-app-build-export.1 \
xdg-app-build-update-repo.1 \
xdg-app-builder.1 \
$(NULL)
xml_files = $(man_MANS:.1=.xml)

10
doc/xdg-app-repo-update.xml → doc/xdg-app-build-update-repo.xml
View File

@ -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-repo-update">
<refentry id="xdg-app-build-update-repo">
<refentryinfo>
<title>xdg-app repo-update</title>
<title>xdg-app build-update-repo</title>
<productname>xdg-app</productname>
<authorgroup>
@ -19,18 +19,18 @@
</refentryinfo>
<refmeta>
<refentrytitle>xdg-app repo-update</refentrytitle>
<refentrytitle>xdg-app build-update-repo</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>xdg-app-repo-update</refname>
<refname>xdg-app-build-update-repo</refname>
<refpurpose>Create a repository from a build directory</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>xdg-app repo-update</command>
<command>xdg-app build-update-repo</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">LOCATION</arg>
</cmdsynopsis>

157
doc/xdg-app-install-runtime.xml
View File

@ -1,157 +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-install-runtime">
<refentryinfo>
<title>xdg-app install-runtime</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 install-runtime</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>xdg-app-install-runtime</refname>
<refpurpose>Install a runtime</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>xdg-app install-runtime</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">REPOSITORY</arg>
<arg choice="plain">RUNTIME</arg>
<arg choice="opt">BRANCH</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Installs a runtime. <arg choice="plain">REPOSITORY</arg> must name an
existing remote and <arg choice="plain">RUNTIME</arg> is the name of
the runtime to install. Optionally, <arg choice="plain">BRANCH</arg>
can be specified to install a branch other than the default "master"
branch.
</para>
<para>
Note that xdg-app allows having multiple branches of a runtime
installed and used at the same time.
</para>
<para>
Unless overridden with the --user option, this command creates a
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>--user</option></term>
<listitem><para>
Create a per-user installation.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--system</option></term>
<listitem><para>
Create a system-wide installation.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--arch=ARCH</option></term>
<listitem><para>
The architecture to install, instead of the architecture
of the host system.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-deploy</option></term>
<listitem><para>
Download the latest version, but don't deploy it.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-pull</option></term>
<listitem><para>
Don't download the latest version, deploy it whatever is locally availiable.
</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 install-runtime test-repo org.gnome.Platform 3.14</command>
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<citerefentry><refentrytitle>xdg-app</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>xdg-app-update-runtime</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>xdg-app-list-runtimes</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>

50
doc/xdg-app-install-app.xml → doc/xdg-app-install.xml
View File

@ -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-install-app">
<refentry id="xdg-app-install">
<refentryinfo>
<title>xdg-app install-app</title>
<title>xdg-app install</title>
<productname>xdg-app</productname>
<authorgroup>
@ -19,21 +19,21 @@
</refentryinfo>
<refmeta>
<refentrytitle>xdg-app install-app</refentrytitle>
<refentrytitle>xdg-app install</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>xdg-app-install-app</refname>
<refpurpose>Install an application</refpurpose>
<refname>xdg-app-install</refname>
<refpurpose>Install an application or runtime</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>xdg-app install-app</command>
<command>xdg-app install</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">REPOSITORY</arg>
<arg choice="plain">APP</arg>
<arg choice="plain">REMOTE</arg>
<arg choice="plain">NAME</arg>
<arg choice="opt">BRANCH</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -42,17 +42,21 @@
<title>Description</title>
<para>
Installs an application. <arg choice="plain">REPOSITORY</arg> must name
an existing remote and <arg choice="plain">APP</arg> is the name of the
application to install. Optionally, <arg choice="plain">BRANCH</arg> can
Installs an application or runtime. <arg choice="plain">REMOTE</arg> must name
an existing remote and <arg choice="plain">NAME</arg> is the name of the
application or runtime to install. Optionally, <arg choice="plain">BRANCH</arg> can
be specified to install a branch other than the default "master" branch.
</para>
<para>
Note that xdg-app allows to have multiple branches of an application
installed and used at the same time. However, only one can be current,
By default this looks for both apps and runtime with the given <arg choice="plain">NAME</arg> in
the specified <arg choice="plain">REMOTE</arg>, but you can limit this by using the --app or --runtime option.
</para>
<para>
Note that xdg-app allows to have multiple branches of an application and runtimes
installed and used at the same time. However, only version of an application one can be current,
meaning its exported files (for instance desktop files and icons) are
visible to the host. The last installed version is made current by
default, but you can manually change with make-app-current.
default, but you can manually change with make-current.
</para>
<para>
Unless overridden with the --user option, this command creates a
@ -116,6 +120,22 @@
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--app</option></term>
<listitem><para>
Only look for an app with the given name.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--runtime</option></term>
<listitem><para>
Only look for an runtime with the given name.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<term><option>--verbose</option></term>
@ -139,7 +159,7 @@
<title>Examples</title>
<para>
<command>$ xdg-app --user install-app test-repo org.gnome.GEdit</command>
<command>$ xdg-app --user install test-repo org.gnome.GEdit</command>
</para>
</refsect1>

12
doc/xdg-app-make-app-current.xml → doc/xdg-app-make-current.xml
View File

@ -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-make-app-current">
<refentry id="xdg-app-make-current">
<refentryinfo>
<title>xdg-app make-app-current</title>
<title>xdg-app make-current</title>
<productname>xdg-app</productname>
<authorgroup>
@ -19,18 +19,18 @@
</refentryinfo>
<refmeta>
<refentrytitle>xdg-app make-app-current</refentrytitle>
<refentrytitle>xdg-app make-current</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>xdg-app-make-app-current</refname>
<refname>xdg-app-make-current</refname>
<refpurpose>Make a specific version of an app current</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>xdg-app make-app-current</command>
<command>xdg-app make-current</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">APP</arg>
<arg choice="plain">BRANCH</arg>
@ -118,7 +118,7 @@
<title>Examples</title>
<para>
<command>$ xdg-app --user make-app-current org.gnome.GEdit 3.14</command>
<command>$ xdg-app --user make-current org.gnome.GEdit 3.14</command>
</para>
</refsect1>

12
doc/xdg-app-add-remote.xml → doc/xdg-app-remote-add.xml
View File

@ -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-add-remote">
<refentry id="xdg-app-remote-add">
<refentryinfo>
<title>xdg-app add-remote</title>
<title>xdg-app remote-add</title>
<productname>xdg-app</productname>
<authorgroup>
@ -19,18 +19,18 @@
</refentryinfo>
<refmeta>
<refentrytitle>xdg-app add-remote</refentrytitle>
<refentrytitle>xdg-app remote-add</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>xdg-app-add-remote</refname>
<refname>xdg-app-remote-add</refname>
<refpurpose>Add a remote repository</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>xdg-app add-remote</command>
<command>xdg-app remote-add</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">NAME</arg>
<arg choice="plain">LOCATION</arg>
@ -169,7 +169,7 @@
<title>Examples</title>
<para>
<command>$ xdg-app --user add-remote --no-gpg-verify test-repo https://people.gnome.org/~alexl/gnome-sdk/repo/</command>
<command>$ xdg-app --user remote-add --no-gpg-verify test-repo https://people.gnome.org/~alexl/gnome-sdk/repo/</command>
</para>
</refsect1>

12
doc/xdg-app-delete-remote.xml → doc/xdg-app-remote-delete.xml
View File

@ -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-delete-remote">
<refentry id="xdg-app-remote-delete">
<refentryinfo>
<title>xdg-app delete-remote</title>
<title>xdg-app remote-delete</title>
<productname>xdg-app</productname>
<authorgroup>
@ -19,18 +19,18 @@
</refentryinfo>
<refmeta>
<refentrytitle>xdg-app delete-remote</refentrytitle>
<refentrytitle>xdg-app remote-delete</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>xdg-app-delete-remote</refname>
<refname>xdg-app-remote-delete</refname>
<refpurpose>Delete a remote repository</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>xdg-app delete-remote</command>
<command>xdg-app remote-delete</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">NAME</arg>
</cmdsynopsis>
@ -104,7 +104,7 @@
<title>Examples</title>
<para>
<command>$ xdg-app --user delete-remote dried-raisins</command>
<command>$ xdg-app --user remote-delete dried-raisins</command>
</para>
</refsect1>

12
doc/xdg-app-list-remotes.xml → doc/xdg-app-remote-list.xml
View File

@ -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-remotes">
<refentry id="xdg-app-remote-list">
<refentryinfo>
<title>xdg-app list-remotes</title>
<title>xdg-app remote-list</title>
<productname>xdg-app</productname>
<authorgroup>
@ -19,18 +19,18 @@
</refentryinfo>
<refmeta>
<refentrytitle>xdg-app list-remotes</refentrytitle>
<refentrytitle>xdg-app remote-list</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>xdg-app-list-remotes</refname>
<refname>xdg-app-remote-list</refname>
<refpurpose>List remote repositories</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>xdg-app list-remotes</command>
<command>xdg-app remote-list</command>
<arg choice="opt" rep="repeat">OPTION</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -111,7 +111,7 @@
<title>Examples</title>
<para>
<command>$ xdg-app list-remotes --user --show-details</command>
<command>$ xdg-app remote-list --user --show-details</command>
</para>
<programlisting>
testrepo Test Repository http://209.132.179.91/repo/ no-gpg-verify

12
doc/xdg-app-ls-remote.xml → doc/xdg-app-remote-ls.xml
View File

@ -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-ls-remote">
<refentry id="xdg-app-remote-ls">
<refentryinfo>
<title>xdg-app ls-remote</title>
<title>xdg-app remote-ls</title>
<productname>xdg-app</productname>
<authorgroup>
@ -19,18 +19,18 @@
</refentryinfo>
<refmeta>
<refentrytitle>xdg-app ls-remote</refentrytitle>
<refentrytitle>xdg-app remote-ls</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>xdg-app-ls-remote</refname>
<refname>xdg-app-remote-ls</refname>
<refpurpose>Show available runtimes and applications</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>xdg-app ls-remote</command>
<command>xdg-app remote-ls</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">REMOTE</arg>
</cmdsynopsis>
@ -138,7 +138,7 @@
<title>Examples</title>
<para>
<command>$ xdg-app --user ls-remote --only-apps testrepo</command>
<command>$ xdg-app --user remote-ls --only-apps testrepo</command>
</para>
<programlisting>
org.gnome.Builder

12
doc/xdg-app-modify-remote.xml → doc/xdg-app-remote-modify.xml
View File

@ -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-modify-remote">
<refentry id="xdg-app-remote-modify">
<refentryinfo>
<title>xdg-app modify-remote</title>
<title>xdg-app remote-modify</title>
<productname>xdg-app</productname>
<authorgroup>
@ -19,18 +19,18 @@
</refentryinfo>
<refmeta>
<refentrytitle>xdg-app modify-remote</refentrytitle>
<refentrytitle>xdg-app remote-modify</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>xdg-app-modify-remote</refname>
<refname>xdg-app-remote-modify</refname>
<refpurpose>Modify a remote repository</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>xdg-app modify-remote</command>
<command>xdg-app remote-modify</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">NAME</arg>
</cmdsynopsis>
@ -177,7 +177,7 @@
<title>Examples</title>
<para>
<command>$ xdg-app --user modify-remote --no-gpg-verify test-repo</command>
<command>$ xdg-app --user remote-modify --no-gpg-verify test-repo</command>
</para>
</refsect1>

137
doc/xdg-app-uninstall-runtime.xml
View File

@ -1,137 +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-uninstall-runtime">
<refentryinfo>
<title>dxg-app uninstall-runtime</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 uninstall-runtime</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>xdg-app-uninstall-runtime</refname>
<refpurpose>Uninstall a runtime</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>xdg-app uninstall-runtime</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">RUNTIME</arg>
<arg choice="opt">BRANCH</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Uninstalls a runtime. The <arg choice="plain">RUNTIME</arg>,
<arg choice="plain">ARCH</arg> and <arg choice="plain">BRANCH</arg>
arguments must specify an installed runtime.
If <arg choice="plain">BRANCH</arg> is not specified, it defaults
to "master".
</para>
<para>
Normally, this command removes the ref for this runtime from the
local OSTree repository and purges and objects that are no longer
needed to free up disk space. If the same runtime is later reinstalled,
the objects will be pulled from the remote repository again. The
--keep-ref option can be used to prevent 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>--keep-ref</option></term>
<listitem><para>
Keep the ref for the runtime and the objects belonging to it
in the local repository.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--user</option></term>
<listitem><para>
Remove a per-user installation.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--system</option></term>
<listitem><para>
Remove a system-wide installation.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--arch=ARCH</option></term>
<listitem><para>
The architecture to uninstall, instead of the architecture of
the host system.
</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 uninstall-runtime --arch x86_64 org.gnome.Platform 3.14</command>
</para>
</refsect1>
</refentry>

47
doc/xdg-app-uninstall-app.xml → doc/xdg-app-uninstall.xml
View File

@ -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-uninstall-app">
<refentry id="xdg-app-uninstall">
<refentryinfo>
<title>dxg-app uninstall-app</title>
<title>dxg-app uninstall</title>
<productname>xdg-app</productname>
<authorgroup>
@ -19,20 +19,20 @@
</refentryinfo>
<refmeta>
<refentrytitle>xdg-app uninstall-app</refentrytitle>
<refentrytitle>xdg-app uninstall</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>xdg-app-uninstall-app</refname>
<refpurpose>Uninstall an application</refpurpose>
<refname>xdg-app-uninstall</refname>
<refpurpose>Uninstall an application or runtime</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>xdg-app uninstall-app</command>
<command>xdg-app uninstall</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">APP</arg>
<arg choice="plain">NAME</arg>
<arg choice="opt">BRANCH</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -41,23 +41,32 @@
<title>Description</title>
<para>
Uninstalls an application. The <arg choice="plain">APP</arg>,
Uninstalls an application or runtime. The <arg choice="plain">NAME</arg>,
<arg choice="plain">ARCH</arg> and <arg choice="plain">BRANCH</arg>
arguments must identify an installed application.
If <arg choice="plain">BRANCH</arg> is not specified, it defaults
to "master".
</para>
<para>
Normally, this command removes the ref for this application from the
By default this looks for both installed apps and runtime
with the given <arg choice="plain">NAME</arg>, but you can
limit this by using the --app or --runtime option.
</para>
<para>
Normally, this command removes the ref for this application/runtime from the
local OSTree repository and purges and objects that are no longer
needed to free up disk space. If the same application is later
reinstalled, the objects will be pulled from the remote repository
again. The --keep-ref option can be used to prevent this.
</para>
<para>
If all branches of the application are removed, this command
If all branches of the application/runtime are removed, this command
also purges the data directory for the application.
</para>
<para>
Unless overridden with the --user option, this command updates
a system-wide installation.
</para>
</refsect1>
@ -110,6 +119,22 @@
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--app</option></term>
<listitem><para>
Only look for an app with the given name.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--runtime</option></term>
<listitem><para>
Only look for an runtime with the given name.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<term><option>--verbose</option></term>
@ -133,7 +158,7 @@
<title>Examples</title>
<para>
<command>$ xdg-app --user uninstall-app org.gnome.GEdit</command>
<command>$ xdg-app --user uninstall org.gnome.GEdit</command>
</para>
</refsect1>

173
doc/xdg-app-update-runtime.xml
View File

@ -1,173 +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-update-runtime">
<refentryinfo>
<title>xdg-app update-runtime</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 update-runtime</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>xdg-app-update-runtime</refname>
<refpurpose>Update a runtime</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>xdg-app update-runtime</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">RUNTIME</arg>
<arg choice="opt">BRANCH</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Updates a runtime. <arg choice="plain">RUNTIME</arg> is the
name of an installed runtime. Optionally,
<arg choice="plain">BRANCH</arg> can be specified to update a
branch other than the default "master" branch.
</para>
<para>
Normally, this command updates the runtime to the tip
of its branch. But it is possible to check out another commit,
with the --commit option.
</para>
<para>
Note that updating a runtime is different from installing
a newer branch, and runtime updates are expected to keep
strict compatibility, so that applications can be guaranteed
to keep running against an updated version of the runtime
they were built against. If a runtime update does cause
a problem, it is possible to go back to the previous
version, with the --commit option.
</para>
<para>
Unless overridden with the --user option, this command updates
a 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>--user</option></term>
<listitem><para>
Update a per-user installation.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--system</option></term>
<listitem><para>
Update a system-wide installation.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--arch=ARCH</option></term>
<listitem><para>
The architecture to update, instead of the architecture
of the host system.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--commit=COMMIT</option></term>
<listitem><para>
Update to this commit, instead of the tip of the branch.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-deploy</option></term>
<listitem><para>
Download the latest version, but don't deploy it.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-pull</option></term>
<listitem><para>
Don't download the latest version, deploy it whatever is locally availiable.
</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 update-runtime org.gnome.Platform</command>
</para>
</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-list-runtimes</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>

43
doc/xdg-app-update-app.xml → doc/xdg-app-update.xml
View File

@ -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-update-app">
<refentry id="xdg-app-update">
<refentryinfo>
<title>xdg-app update-app</title>
<title>xdg-app update</title>
<productname>xdg-app</productname>
<authorgroup>
@ -19,20 +19,20 @@
</refentryinfo>
<refmeta>
<refentrytitle>xdg-app update-app</refentrytitle>
<refentrytitle>xdg-app update</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>xdg-app-update-app</refname>
<refname>xdg-app-update</refname>
<refpurpose>Update a runtime</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>xdg-app update-app</command>
<command>xdg-app update</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">APP</arg>
<arg choice="plain">NAME</arg>
<arg choice="opt">BRANCH</arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -41,19 +41,24 @@
<title>Description</title>
<para>
Updates an application. <arg choice="plain">APP</arg> is the
name of an installed application. Optionally,
Updates an application or runtime. <arg choice="plain">NAME</arg> is the
name of an installed application or runtime. Optionally,
<arg choice="plain">BRANCH</arg> can be specified to update a
branch other than the default "master" branch.
</para>
<para>
By default this looks for both installed apps and runtime
with the given <arg choice="plain">NAME</arg>, but you can
limit this by using the --app or --runtime option.
</para>
<para>
Normally, this command updates the application to the tip
of its branch. But it is possible to check out another commit,
with the --commit option.
</para>
<para>
Note that updating a runtime is different from installing
a newer branch, and application updates are expected to keep
Note that updating a is different from installing
a different branch, and runtime updates are expected to keep
strict compatibility. If an application update does cause
a problem, it is possible to go back to the previous
version, with the --commit option.
@ -128,6 +133,22 @@
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--app</option></term>
<listitem><para>
Only look for an app with the given name.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--runtime</option></term>
<listitem><para>
Only look for an runtime with the given name.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<term><option>--verbose</option></term>
@ -151,7 +172,7 @@
<title>Examples</title>
<para>
<command>$ xdg-app --user update-app org.gnome.GEdit</command>
<command>$ xdg-app --user update org.gnome.GEdit</command>
</para>
</refsect1>

53
doc/xdg-app.xml
View File

@ -107,35 +107,35 @@
<variablelist>
<varlistentry>
<term><citerefentry><refentrytitle>xdg-app-add-remote</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<term><citerefentry><refentrytitle>xdg-app-remote-add</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Add a remote repository.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>xdg-app-modify-remote</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<term><citerefentry><refentrytitle>xdg-app-remote-modify</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Modify remote repository properties.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>xdg-app-delete-remote</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<term><citerefentry><refentrytitle>xdg-app-remote-delete</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Delete a remote repository.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>xdg-app-list-remotes</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<term><citerefentry><refentrytitle>xdg-app-remote-list</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Lists remote repositories.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>xdg-app-ls-remote</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<term><citerefentry><refentrytitle>xdg-app-remote-ls</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Show available runtimes and applications.
@ -143,28 +143,28 @@
</varlistentry>
</variablelist>
<para>Commands for handling installed runtimes:</para>
<para>Commands for handling installed runtimes and applications:</para>
<variablelist>
<varlistentry>
<term><citerefentry><refentrytitle>xdg-app-install-runtime</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<term><citerefentry><refentrytitle>xdg-app-install</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Install a runtime.
Install an application or a runtime.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>xdg-app-update-runtime</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<term><citerefentry><refentrytitle>xdg-app-update</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Update a runtime.
Update an application or a runtime.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>xdg-app-uninstall-runtime</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<term><citerefentry><refentrytitle>xdg-app-uninstall</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Uninstall a runtime.
Uninstall an application or a runtime.
</para></listitem>
</varlistentry>
<varlistentry>
@ -174,32 +174,6 @@
List installed runtimes.
</para></listitem>
</varlistentry>
</variablelist>
<para>Commands for handling installed applications:</para>
<variablelist>
<varlistentry>
<term><citerefentry><refentrytitle>xdg-app-install-app</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Install an application.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>xdg-app-update-app</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Update an application.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>xdg-app-uninstall-app</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Uninstall an application.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>xdg-app-list-apps</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
@ -209,6 +183,7 @@
</varlistentry>
</variablelist>
<para>Commands for running applications:</para>
<variablelist>
@ -267,7 +242,7 @@
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>xdg-app-repo-contents</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<term><citerefentry><refentrytitle>xdg-app-build-update-repo</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Update repository metadata.