'\" t .\" Title: flatpak build-export .\" Author: Alexander Larsson .\" Generator: DocBook XSL Stylesheets v1.79.1 .\" Date: 03/10/2021 .\" Manual: flatpak build-export .\" Source: flatpak .\" Language: English .\" .TH "FLATPAK BUILD\-EXPOR" "1" "" "flatpak" "flatpak build-export" .\" ----------------------------------------------------------------- .\" * 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-build-export \- Create a repository from a build directory .SH "SYNOPSIS" .HP \w'\fBflatpak\ build\-export\fR\ 'u \fBflatpak build\-export\fR [OPTION...] LOCATION DIRECTORY [BRANCH] .SH "DESCRIPTION" .PP Creates or updates a repository with an application build\&. LOCATION is the location of the repository\&. DIRECTORY must be a finalized build directory\&. If BRANCH is not specified, it is assumed to be "master"\&. .PP If LOCATION exists, it is assumed to be an OSTree repository, otherwise a new OSTree repository is created at this location\&. The repository can be inspected with the \fBostree\fR tool\&. .PP The contents of DIRECTORY are committed on the branch with name app/APPNAME/ARCH/BRANCH, where ARCH is the architecture of the runtime that the application is using\&. A commit filter is used to enforce that only the contents of the files/ and export/ subdirectories and the metadata file are included in the commit, anything else is ignored\&. .PP When exporting a flatpak to be published to the internet, \fB\-\-collection\-id=COLLECTION\-ID\fR should be specified as a globally unique reverse DNS value to identify the collection of flatpaks this will be added to\&. Setting a globally unique collection ID allows the apps in the repository to be shared over peer to peer systems without needing further configuration\&. .PP The build\-update\-repo command should be used to update repository metadata whenever application builds are added to a repository\&. .SH "OPTIONS" .PP The following options are understood: .PP \fB\-h\fR, \fB\-\-help\fR .RS 4 Show help options and exit\&. .RE .PP \fB\-s\fR, \fB\-\-subject=SUBJECT\fR .RS 4 One line subject for the commit message\&. .RE .PP \fB\-b\fR, \fB\-\-body=BODY\fR .RS 4 Full description for the commit message\&. .RE .PP \fB\-\-collection\-id=COLLECTION\-ID\fR .RS 4 Set as the collection ID of the repository\&. Setting a globally unique collection ID allows the apps in the repository to be shared over peer to peer systems without needing further configuration\&. If exporting to an existing repository, the collection ID must match the existing configured collection ID for that repository\&. .RE .PP \fB\-\-arch=ARCH\fR .RS 4 Specify the architecture component of the branch to export\&. Only host compatible architectures can be specified\&. .RE .PP \fB\-\-exclude=PATTERN\fR .RS 4 Exclude files matching PATTERN from the commit\&. This option can be used multiple times\&. .RE .PP \fB\-\-include=PATTERN\fR .RS 4 Don\*(Aqt exclude files matching PATTERN from the commit, even if they match the \fB\-\-export\fR patterns\&. This option can be used multiple times\&. .RE .PP \fB\-\-metadata=FILENAME\fR .RS 4 Use the specified filename as metadata in the exported app instead of the default file (called metadata)\&. This is useful if you want to commit multiple things from a single build tree, typically used in combination with \fB\-\-files\fR and \fB\-\-exclude\fR\&. .RE .PP \fB\-\-files=SUBDIR\fR .RS 4 Use the files in the specified subdirectory as the file contents, rather than the regular files directory\&. .RE .PP \fB\-\-timestamp=DATE\fR .RS 4 Use the specified ISO 8601 formatted date or NOW, for the current time, in the commit metadata and, if \fB\-\-update\-appstream\fR is used, the appstream data\&. .RE .PP \fB\-\-end\-of\-life=REASON\fR .RS 4 Mark the build as end\-of\-life\&. REASON is a message that may be shown to users installing this build\&. .RE .PP \fB\-\-disable\-fsync\fR .RS 4 Don\*(Aqt fsync when writing to the repository\&. This can result in data loss in exceptional situations, but can improve performance when working with temporary or test repositories\&. .RE .PP \fB\-\-update\-appstream\fR .RS 4 Update the appstream branch after the build\&. .RE .PP \fB\-\-no\-update\-summary\fR .RS 4 Don\*(Aqt update the summary file after the new commit is added\&. This means the repository will not be useful for serving over http until build\-update\-repo has been run\&. This is useful is you want to do multiple repo operations before finally updating the summary\&. .RE .PP \fB\-\-gpg\-sign=KEYID\fR .RS 4 Sign the commit with this GPG key\&. This option can be used multiple times\&. .RE .PP \fB\-\-gpg\-homedir=PATH\fR .RS 4 GPG Homedir to use when looking for keyrings .RE .PP \fB\-r\fR, \fB\-\-runtime\fR .RS 4 Export a runtime instead for an app (this uses the usr subdir as files)\&. .RE .PP \fB\-v\fR, \fB\-\-verbose\fR .RS 4 Print debug information during command processing\&. .RE .PP \fB\-\-ostree\-verbose\fR .RS 4 Print OSTree debug information during command processing\&. .RE .SH "EXAMPLES" .PP \fB$ flatpak build\-export ~/repos/gnome\-calculator/ ~/build/gnome\-calculator/ org\&.gnome\&.Calculator\fR .sp .if n \{\ .RS 4 .\} .nf Commit: 9d0044ea480297114d03aec85c3d7ae3779438f9d2cb69d717fb54237acacb8c Metadata Total: 605 Metadata Written: 5 Content Total: 1174 Content Written: 1 Content Bytes Written: 305 .fi .if n \{\ .RE .\} .SH "SEE ALSO" .PP \fBostree\fR(1), \fBflatpak\fR(1), \fBflatpak-build-init\fR(1), \fBflatpak-build\fR(1), \fBflatpak-build-finish\fR(1), \fBflatpak-build-sign\fR(1), \fBflatpak-build-update-repo\fR(1)