diff options
| -rw-r--r-- | doc/Makefile.am | 1 | ||||
| -rw-r--r-- | doc/flatpak-flatpakrepo.xml | 102 |
2 files changed, 103 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index ccb30857..c5bf4781 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -51,6 +51,7 @@ man1 = \ man5 = \ flatpak-metadata.5 \ + flatpak-flatpakrepo.5 \ flatpak-flatpakref.5 \ $(NULL) diff --git a/doc/flatpak-flatpakrepo.xml b/doc/flatpak-flatpakrepo.xml new file mode 100644 index 00000000..1edf7eb6 --- /dev/null +++ b/doc/flatpak-flatpakrepo.xml @@ -0,0 +1,102 @@ +<?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-flatpakrepo"> + + <refentryinfo> + <title>flatpakrepo</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>flatpakrepo</refentrytitle> + <manvolnum>5</manvolnum> + </refmeta> + + <refnamediv> + <refname>flatpak-flatpakrepo</refname> + <refpurpose>Reference to a remote</refpurpose> + </refnamediv> + + <refsect1> + <title>Description</title> + + <para> + Flatpak uses flatpakrepo files to share information about remotes. + The <filename>flatpakrepo</filename> file contains enough information + to add the remote. Use the <command>flatpak remote-add --from</command> + command to do so. + </para> + + <para> + The filename extension commonly used for flatpakrepo files is <filename>.flatpakrepo</filename>. + </para> + + </refsect1> + + <refsect1> + <title>File format</title> + + <para> + The flatpakrepo file is using the same .ini file format that is used for + systemd unit files or application .desktop files. + </para> + + <refsect2> + <title>[Flatpak Repo]</title> + + <para> + All the information is contained in the [Flatpak Repo] group. + </para> + <para> + The following keys can be present in this group: + </para> + <variablelist> + <varlistentry> + <term><option>Url</option> (string)</term> + <listitem><para>The url for the remote. This key is mandatory.</para></listitem> + </varlistentry> + <varlistentry> + <term><option>Title</option> (string)</term> + <listitem><para>The title of the remote. This should be a user-friendly name that can be displayed e.g. in an app store.</para></listitem> + </varlistentry> + <varlistentry> + <term><option>GPGKey</option> (string)</term> + <listitem><para>The base64-encoded gpg key for the remote.</para></listitem> + </varlistentry> + </variablelist> + </refsect2> + </refsect1> + + <refsect1> + <title>Example</title> +<programlisting> +[Flatpak Repo] +Title=GEdit +Url=http://sdk.gnome.org/repo-apps/ +GPGKey=mQENBFUUCGcBCAC/K9WeV4xCaKr3NKRqPXeY5mpaXAJyasLqCtrDx92WUgbu0voWrhohNAKpqizod2dvzc/XTxm3rHyIxmNfdhz1gaGhynU75Qw4aJVcly2eghTIl++gfDtOvrOZo/VuAq30f32dMIgHQdRwEpgCwz7WyjpqZYltPAEcCNL4MTChAfiHJeeiQ5ibystNBW8W6Ymf7sO4m4g5+/aOxI54oCOzD9TwBAe+yXcJJWtc2rAhMCjtyPJzxd0ZVXqIzCe1xRvJ6Rq7YCiMbiM2DQFWXKnmYQbj4TGNMnwNdAajCdrcBWEMSbzq7EzuThIJRd8Ky4BkEe1St6tuqwFaMZz+F9eXABEBAAG0KEdub21lIFNESyAzLjE2IDxnbm9tZS1vcy1saXN0QGdub21lLm9yZz6JATgEEwECACIFAlUUCGcCGwMGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEArkz6VV0VKBa5cH/0vXa31YgEjNk78gGFXqnQxdD1WYA87OYxDi189l4lA802EFTF4wCBuZyDOqdd5BhS3Ab0cR778DmZXRUP2gwe+1zTJypU2JMnDpkwJ4NK1VP6/tE4SAPrznBtmb76BKaWBqUfZ9Wq1zg3ugvqkZB/Exq+usypIOwQVp1KL58TrjBRda0HvRctzkNhr0qYAtkfLFe0GvksBp4vBm8uGwAx7fw/HbhIjQ9pekTwvB+5GwDPO/tSip/1bQfCS+XJB8Ffa04HYPLGedalnWBrwhYY+G/kn5Zh9L/AC8xeLwTJTHM212rBjPa9CWs9C6a57MSaeGIEHLC1hEyiJJ15w8jmY= +</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-flatpakref</refentrytitle><manvolnum>5</manvolnum></citerefentry> + </para> + + </refsect1> + +</refentry> |