'\" t
.\"     Title: flatpakref
.\"    Author: Alexander Larsson <alexl@redhat.com>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/06/2024
.\"    Manual: flatpakref
.\"    Source: flatpak
.\"  Language: English
.\"
.TH "FLATPAKREF" "5" "" "flatpak" "flatpakref"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
flatpak-flatpakref \- Reference to a remote for an application or runtime
.SH "DESCRIPTION"
.PP
Flatpak uses flatpakref files to share information about a remote for a single application\&. The
flatpakref
file contains enough information to add the remote and install the application\&. Use the
\fBflatpak install \-\-from\fR
command to do so\&.
.PP
flatpakref files may also contain additional information that is useful when displaying the application to the user, e\&.g\&. in an app store\&.
.PP
The filename extension commonly used for flatpakref files is
\&.flatpakref\&.
.PP
A flatpakref file can also refer to a remote for a runtime\&.
.SH "FILE FORMAT"
.PP
The flatpakref file is using the same \&.ini file format that is used for systemd unit files or application \&.desktop files\&.
.SS "[Flatpak Ref]"
.PP
All the information is contained in the [Flatpak Ref] group\&.
.PP
The following keys can be present in this group:
.PP
\fBVersion\fR (uint64)
.RS 4
The version of the file format, must be 1 if present\&.
.RE
.PP
\fBName\fR (string)
.RS 4
The fully qualified name of the runtime or application\&. This key is mandatory\&.
.RE
.PP
\fBUrl\fR (string)
.RS 4
The url for the remote\&. This key is mandatory\&.
.RE
.PP
\fBBranch\fR (string)
.RS 4
The name of the branch from which to install the application or runtime\&. If this key is not specified, the "master" branch is used\&.
.RE
.PP
\fBTitle\fR (string)
.RS 4
The title of the application or runtime\&. This should be a user\-friendly name that can be displayed e\&.g\&. in an app store\&.
.RE
.PP
\fBComment\fR (string)
.RS 4
A short summary of the application or runtime, for display e\&.g\&. in an app store\&.
.RE
.PP
\fBDescription\fR (string)
.RS 4
A longer description of the application or runtime, for display e\&.g\&. in an app store\&.
.RE
.PP
\fBIcon\fR (string)
.RS 4
The url for an icon that can be used to represent the application or runtime\&.
.RE
.PP
\fBHomepage\fR (string)
.RS 4
The url of a webpage describing the application or runtime\&.
.RE
.PP
\fBDeploySideloadCollectionID\fR (string)
.RS 4
The collection ID of the remote, if it has one\&. This uniquely identifies the collection of apps in the remote, to allow peer to peer redistribution (see
\fBflatpak\fR(1))\&. It is recommended to use this key over DeployCollectionID or CollectionID because only newer clients (Flatpak 1\&.12\&.8 or later) pay attention to it (and older clients don\*(Aqt handle collection IDs properly)\&.
.RE
.PP
\fBDeployCollectionID\fR (string)
.RS 4
This is deprecated but still supported for backwards compatibility\&. Use DeploySideloadCollectionID instead\&.
.RE
.PP
\fBCollectionID\fR (string)
.RS 4
This is deprecated but still supported for backwards compatibility\&. Use DeploySideloadCollectionID instead\&.
.RE
.PP
\fBIsRuntime\fR (boolean)
.RS 4
Whether this file refers to a runtime\&. If this key is not specified, the file is assumed to refer to an application\&.
.RE
.PP
\fBGPGKey\fR (string)
.RS 4
The base64\-encoded gpg key for the remote\&.
.RE
.PP
\fBRuntimeRepo\fR (string)
.RS 4
The url for a \&.flatpakrepo file for the remote where the runtime can be found\&. Note that if the runtime is available in the remote providing the app, that remote may be used instead but the one specified by this option will still be added\&.
.RE
.PP
\fBSuggestRemoteName\fR (string)
.RS 4
A suggested name for the remote\&.
.RE
.SH "EXAMPLE"
.sp
.if n \{\
.RS 4
.\}
.nf
[Flatpak Ref]
Title=gedit
Name=org\&.gnome\&.gedit
Branch=stable
Url=http://sdk\&.gnome\&.org/repo\-apps/
IsRuntime=false
GPGKey=mQENBFUUCGcBCAC/K9WeV4xCaKr3NKRqPXeY5mpaXAJyasLqCtrDx92WUgbu0voWrhohNAKpqizod2dvzc/XTxm3rHyIxmNfdhz1gaGhynU75Qw4aJVcly2eghTIl++gfDtOvrOZo/VuAq30f32dMIgHQdRwEpgCwz7WyjpqZYltPAEcCNL4MTChAfiHJeeiQ5ibystNBW8W6Ymf7sO4m4g5+/aOxI54oCOzD9TwBAe+yXcJJWtc2rAhMCjtyPJzxd0ZVXqIzCe1xRvJ6Rq7YCiMbiM2DQFWXKnmYQbj4TGNMnwNdAajCdrcBWEMSbzq7EzuThIJRd8Ky4BkEe1St6tuqwFaMZz+F9eXABEBAAG0KEdub21lIFNESyAzLjE2IDxnbm9tZS1vcy1saXN0QGdub21lLm9yZz6JATgEEwECACIFAlUUCGcCGwMGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEArkz6VV0VKBa5cH/0vXa31YgEjNk78gGFXqnQxdD1WYA87OYxDi189l4lA802EFTF4wCBuZyDOqdd5BhS3Ab0cR778DmZXRUP2gwe+1zTJypU2JMnDpkwJ4NK1VP6/tE4SAPrznBtmb76BKaWBqUfZ9Wq1zg3ugvqkZB/Exq+usypIOwQVp1KL58TrjBRda0HvRctzkNhr0qYAtkfLFe0GvksBp4vBm8uGwAx7fw/HbhIjQ9pekTwvB+5GwDPO/tSip/1bQfCS+XJB8Ffa04HYPLGedalnWBrwhYY+G/kn5Zh9L/AC8xeLwTJTHM212rBjPa9CWs9C6a57MSaeGIEHLC1hEyiJJ15w8jmY=
DeployCollectionID=org\&.gnome\&.Apps
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\fBflatpak\fR(1),
\fBflatpak-install\fR(1)
\fBflatpak-flatpakrepo\fR(5),