diff options
Diffstat (limited to 'doc/flatpak-install.xml')
| -rw-r--r-- | doc/flatpak-install.xml | 215 |
1 files changed, 215 insertions, 0 deletions
diff --git a/doc/flatpak-install.xml b/doc/flatpak-install.xml new file mode 100644 index 0000000..bf8ae01 --- /dev/null +++ b/doc/flatpak-install.xml @@ -0,0 +1,215 @@ +<?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-install"> + + <refentryinfo> + <title>flatpak install</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 install</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>flatpak-install</refname> + <refpurpose>Install an application or runtime</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>flatpak install</command> + <arg choice="opt" rep="repeat">OPTION</arg> + <arg choice="plain">REMOTE</arg> + <arg choice="plain">NAME</arg> + <arg choice="opt">BRANCH</arg> + </cmdsynopsis> + <cmdsynopsis> + <command>flatpak install</command> + <arg choice="opt" rep="repeat">OPTION</arg> + <arg choice="plain">--bundle</arg> + <arg choice="plain">FILENAME</arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + 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> + 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 flatpak 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-current. + </para> + <para> + Unless overridden with the --user option, this command creates a + system-wide installation. + </para> + <para> + The alternative form of the command installs an application from a + single-file bundle instead of a configured remote. Such bundles can + be created with the flatpak build-bundle command. + </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>--bundle</option></term> + + <listitem><para> + Install from a bundle file instead + of a configured remote. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--user</option></term> + + <listitem><para> + Create a per-user installation. + </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 for. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--subpath=PATH</option></term> + + <listitem><para> + Install only a subpath of the ref. This is mainly used to install a subset of locales. + This can be added multiple times to install multiple subpaths., + </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>--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> + + <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>$ flatpak --user install test-repo org.gnome.GEdit</command> + </para> + + </refsect1> + + <refsect1> + <title>See also</title> + + <para> + <citerefentry><refentrytitle>flatpak</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>flatpak-update-app</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>flatpak-list-apps</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>flatpak-build-bundle</refentrytitle><manvolnum>1</manvolnum></citerefentry> + </para> + + </refsect1> + +</refentry> |