From dc5a4513893510b03356a41cda2845fc1769c40e Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sun, 16 Dec 2018 13:01:21 -0500 Subject: [PATCH] Add docs for flatpak-spawn Add a flatpak-spawn(1) man page. While it is not ideal to have the docs live separately from the code, having it here ensures that it will be available everywhere all the other flatpak documentation is. Closes: #2437 Approved by: alexlarsson --- doc/Makefile.am | 1 + doc/flatpak-docs.xml.in | 1 + doc/flatpak-spawn.xml | 192 ++++++++++++++++++++++++++++++++++++++++ doc/flatpak.xml | 13 +++ 4 files changed, 207 insertions(+) create mode 100644 doc/flatpak-spawn.xml diff --git a/doc/Makefile.am b/doc/Makefile.am index c3102b48..ee4fcc3f 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -59,6 +59,7 @@ man1 = \ flatpak-repair.1 \ flatpak-kill.1 \ flatpak-history.1 \ + flatpak-spawn.1 \ $(NULL) man5 = \ diff --git a/doc/flatpak-docs.xml.in b/doc/flatpak-docs.xml.in index c3596a57..f236d0e6 100644 --- a/doc/flatpak-docs.xml.in +++ b/doc/flatpak-docs.xml.in @@ -64,6 +64,7 @@ + File Formats diff --git a/doc/flatpak-spawn.xml b/doc/flatpak-spawn.xml new file mode 100644 index 00000000..57cd1348 --- /dev/null +++ b/doc/flatpak-spawn.xml @@ -0,0 +1,192 @@ + + + + + + + flatpak spawn + flatpak + + + + Developer + Alexander + Larsson + alexl@redhat.com + + + + + + flatpak spawn + 1 + + + + flatpak-spawn + Run commands in a sandbox + + + + + flatpak-spawn + OPTION + COMMAND + ARGUMENT + + + + + Description + + + Unlike other flatpak commands, flatpak-spawn is available + to applications inside the sandbox. It runs COMMAND + outside the sandbox, either in another sandbox, or on the host. + + + + flatpak-spawn uses the Flatpak portal to create a copy + the sandbox it was called from, optionally using tighter permissions and + the latest version of the app and runtime. + + + + + + Options + + The following options are understood: + + + + + + + + Show help options and exit. + + + + + + + + + Print debug information + + + + + + + + Forward a file descriptor + + + + + + + + Run with a clean environment + + + + + + + + Set an environment variable + + + + + + + + Use the latest version of the refs that are used to set up the sandbox + + + + + + + + Run without network access + + + + + + + + Run fully sandboxed. + + See the and + options for selective file access. + + + + + + + + Expose read-write access to a file in the sandbox. + + Note that absolute paths or subdirectories are not allowed. + The files must be in the sandbox subdirectory of + the instance directory (i.e. ~/.var/app/$APP_ID/sandbox). + + This option is useful in combination with (otherwise the + instance diretory is accessible anyway). + + + + + + + + Expose readonly access to a file in the sandbox. + + Note that absolute paths or subdirectories are not allowed. + The files must be in the sandbox subdirectory of + the instance directory (i.e. ~/.var/app/$APP_ID/sandbox). + + This option is useful in combination with (otherwise the + instance diretory is accessible anyway). + + + + + + + + Run the command unsandboxed on the host. This requires access to + the org.freedesktop.Flatpak D-Bus interface + + + + + + + + Examples + + + $ flatpak-spawn ls /var/run + + + + + + See also + + + flatpak1 + + + + + diff --git a/doc/flatpak.xml b/doc/flatpak.xml index ceb1f0c6..47b8150e 100644 --- a/doc/flatpak.xml +++ b/doc/flatpak.xml @@ -468,6 +468,19 @@ + + Commands available inside the sandbox: + + + + flatpak-spawn1 + + + Run a command in another sandbox. + + + +