'\" t .\" Title: flatpak run .\" Author: Alexander Larsson .\" Generator: DocBook XSL Stylesheets v1.79.1 .\" Date: 03/26/2019 .\" Manual: flatpak run .\" Source: flatpak .\" Language: English .\" .TH "FLATPAK RUN" "1" "" "flatpak" "flatpak run" .\" ----------------------------------------------------------------- .\" * 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-run \- Run an application .SH "SYNOPSIS" .HP \w'\fBflatpak\ run\fR\ 'u \fBflatpak run\fR [OPTION...] APP [ARG...] .SH "DESCRIPTION" .PP Runs an application in a sandboxed environment\&. APP must name an installed application\&. Extra arguments are passed on to the application\&. .PP flatpak creates a sandboxed environment for the application to run in by mounting the right runtime at /usr and a writable directory at /var, whose content is preserved between application runs\&. The application itself is mounted at /app\&. .PP The details of the sandboxed environment are controlled by the application metadata and various options like \-\-share and \-\-socket that are passed to the run command: Access is allowed if it was requested either in the application metadata file or with an option and the user hasn\*(Aqt overridden it\&. .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\-v\fR, \fB\-\-verbose\fR .RS 4 Print debug information during command processing\&. .RE .PP \fB\-\-version\fR .RS 4 Print version information and exit\&. .RE .PP \fB\-\-arch=ARCH\fR .RS 4 The architecture to install for\&. .RE .PP \fB\-\-command=COMMAND\fR .RS 4 The command to run instead of the one listed in the application metadata\&. .RE .PP \fB\-\-branch=BRANCH\fR .RS 4 The branch to use\&. .RE .PP \fB\-d\fR, \fB\-\-devel\fR .RS 4 Use the devel runtime that is specified in the application metadata instead of the regular runtime, and use a seccomp profile that is less likely to break development tools\&. .RE .PP \fB\-\-runtime=RUNTIME\fR .RS 4 Use this runtime instead of the one that is specified in the application metadata\&. This is a full tuple, like for example org\&.freedesktop\&.Sdk/x86_64/1\&.2, but partial tuples are allowed\&. Any empty or missing parts are filled in with the corresponding values specified by the app\&. .RE .PP \fB\-\-runtime\-version=VERSION\fR .RS 4 Use this version of the runtime instead of the one that is specified in the application metadata\&. This overrides any version specified with the \-\-runtime option\&. .RE .PP \fB\-\-share=SUBSYSTEM\fR .RS 4 Share a subsystem with the host session\&. This overrides the Context section from the application metadata\&. SUBSYSTEM must be one of: network, ipc\&. This option can be used multiple times\&. .RE .PP \fB\-\-unshare=SUBSYSTEM\fR .RS 4 Don\*(Aqt share a subsystem with the host session\&. This overrides the Context section from the application metadata\&. SUBSYSTEM must be one of: network, ipc\&. This option can be used multiple times\&. .RE .PP \fB\-\-socket=SOCKET\fR .RS 4 Expose a well known socket to the application\&. This overrides to the Context section from the application metadata\&. SOCKET must be one of: x11, wayland, pulseaudio, system\-bus, session\-bus\&. This option can be used multiple times\&. .RE .PP \fB\-\-nosocket=SOCKET\fR .RS 4 Don\*(Aqt expose a well known socket to the application\&. This overrides to the Context section from the application metadata\&. SOCKET must be one of: x11, wayland, pulseaudio, system\-bus, session\-bus\&. This option can be used multiple times\&. .RE .PP \fB\-\-device=DEVICE\fR .RS 4 Expose a device to the application\&. This overrides to the Context section from the application metadata\&. DEVICE must be one of: dri, kvm, all\&. This option can be used multiple times\&. .RE .PP \fB\-\-nodevice=DEVICE\fR .RS 4 Don\*(Aqt expose a device to the application\&. This overrides to the Context section from the application metadata\&. DEVICE must be one of: dri, kvm, all\&. This option can be used multiple times\&. .RE .PP \fB\-\-allow=FEATURE\fR .RS 4 Allow access to a specific feature\&. This overrides to the Context section from the application metadata\&. FEATURE must be one of: devel, multiarch\&. This option can be used multiple times\&. .RE .PP \fB\-\-disallow=FEATURE\fR .RS 4 Disallow access to a specific feature\&. This overrides to the Context section from the application metadata\&. FEATURE must be one of: devel, multiarch\&. This option can be used multiple times\&. .RE .PP \fB\-\-filesystem=FS\fR .RS 4 Allow the application access to a subset of the filesystem\&. This overrides to the Context section from the application metadata\&. FS can be one of: home, host, xdg\-desktop, xdg\-documents, xdg\-download, xdg\-music, xdg\-pictures, xdg\-public\-share, xdg\-templates, xdg\-videos, xdg\-run, xdg\-config, xdg\-cache, xdg\-data, an absolute path, or a homedir\-relative path like ~/dir or paths relative to the xdg dirs, like xdg\-download/subdir\&. The optional :ro suffix indicates that the location will be read\-only\&. The optional :create suffix indicates that the location will be read\-write and created if it doesn\*(Aqt exist\&. This option can be used multiple times\&. .RE .PP \fB\-\-nofilesystem=FILESYSTEM\fR .RS 4 Remove access to the specified subset of the filesystem from the application\&. This overrides to the Context section from the application metadata\&. FILESYSTEM can be one of: home, host, xdg\-desktop, xdg\-documents, xdg\-download xdg\-music, xdg\-pictures, xdg\-public\-share, xdg\-templates, xdg\-videos, an absolute path, or a homedir\-relative path like ~/dir\&. This option can be used multiple times\&. .RE .PP \fB\-\-env=VAR=VALUE\fR .RS 4 Set an environment variable in the application\&. This overrides to the Context section from the application metadata\&. This option can be used multiple times\&. .RE .PP \fB\-\-own\-name=NAME\fR .RS 4 Allow the application to own the well known name NAME on the session bus\&. If NAME ends with \&.*, it allows the application to own all matching names\&. This overrides to the Context section from the application metadata\&. This option can be used multiple times\&. .RE .PP \fB\-\-talk\-name=NAME\fR .RS 4 Allow the application to talk to the well known name NAME on the session bus\&. If NAME ends with \&.*, it allows the application to talk to all matching names\&. This overrides to the Context section from the application metadata\&. This option can be used multiple times\&. .RE .PP \fB\-\-system\-own\-name=NAME\fR .RS 4 Allow the application to own the well known name NAME on the system bus\&. If NAME ends with \&.*, it allows the application to own all matching names\&. This overrides to the Context section from the application metadata\&. This option can be used multiple times\&. .RE .PP \fB\-\-system\-talk\-name=NAME\fR .RS 4 Allow the application to talk to the well known name NAME on the system bus\&. If NAME ends with \&.*, it allows the application to talk to all matching names\&. This overrides to the Context section from the application metadata\&. This option can be used multiple times\&. .RE .PP \fB\-\-persist=FILENAME\fR .RS 4 If the application doesn\*(Aqt have access to the real homedir, make the (homedir\-relative) path FILENAME a bind mount to the corresponding path in the per\-application directory, allowing that location to be used for persistent data\&. This overrides to the Context section from the application metadata\&. This option can be used multiple times\&. .RE .PP \fB\-\-log\-session\-bus\fR .RS 4 Log session bus traffic\&. This can be useful to see what access you need to allow in your D\-Bus policy\&. .RE .PP \fB\-\-log\-system\-bus\fR .RS 4 Log system bus traffic\&. This can be useful to see what access you need to allow in your D\-Bus policy\&. .RE .SH "EXAMPLES" .PP \fB$ flatpak run org\&.gnome\&.GEdit\fR .PP \fB$ flatpak run \-\-devel \-\-command=bash org\&.gnome\&.Builder\fR .SH "SEE ALSO" .PP \fBflatpak\fR(1), \fBflatpak-override\fR(1), \fBflatpak-enter\fR(1)