From e9f1054e9cdd96eecad8782a31f4edea99d876fd Mon Sep 17 00:00:00 2001 From: Alexander Larsson Date: Thu, 17 Sep 2015 16:22:52 +0200 Subject: [PATCH] Update docs for new/changes interface --- app/xdg-app-main.c | 2 +- doc/Makefile.am | 3 + doc/xdg-app-export-file.xml | 153 ++++++++++++++++++++++ doc/xdg-app-modify-remote.xml | 166 ++++++++++++++++++++++++ doc/xdg-app-override.xml | 232 ++++++++++++++++++++++++++++++++++ doc/xdg-app-run.xml | 3 +- doc/xdg-app.xml | 23 +++- 7 files changed, 579 insertions(+), 3 deletions(-) create mode 100644 doc/xdg-app-export-file.xml create mode 100644 doc/xdg-app-modify-remote.xml create mode 100644 doc/xdg-app-override.xml diff --git a/app/xdg-app-main.c b/app/xdg-app-main.c index ef8fb6e9..b9ac78a6 100644 --- a/app/xdg-app-main.c +++ b/app/xdg-app-main.c @@ -52,11 +52,11 @@ static XdgAppCommand commands[] = { { "list-runtimes", xdg_app_builtin_list_runtimes }, { "install-app", xdg_app_builtin_install_app }, { "update-app", xdg_app_builtin_update_app }, - { "override", xdg_app_builtin_override }, { "make-app-current", xdg_app_builtin_make_current_app }, { "uninstall-app", xdg_app_builtin_uninstall_app }, { "list-apps", xdg_app_builtin_list_apps }, { "run", xdg_app_builtin_run }, + { "override", xdg_app_builtin_override }, { "export-file", xdg_app_builtin_export_file }, { "build-init", xdg_app_builtin_build_init }, { "build", xdg_app_builtin_build }, diff --git a/doc/Makefile.am b/doc/Makefile.am index 7346ba34..b7549764 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -17,6 +17,7 @@ man_MANS = \ xdg-app-add-remote.1 \ xdg-app-delete-remote.1 \ xdg-app-list-remotes.1 \ + xdg-app-modify-remote.1 \ xdg-app-ls-remote.1 \ xdg-app-install-runtime.1 \ xdg-app-update-runtime.1 \ @@ -28,6 +29,8 @@ man_MANS = \ xdg-app-uninstall-app.1 \ xdg-app-list-apps.1 \ xdg-app-run.1 \ + xdg-app-override.1 \ + xdg-app-export-file.1 \ xdg-app-build-init.1 \ xdg-app-build.1 \ xdg-app-build-finish.1 \ diff --git a/doc/xdg-app-export-file.xml b/doc/xdg-app-export-file.xml new file mode 100644 index 00000000..0e4946e5 --- /dev/null +++ b/doc/xdg-app-export-file.xml @@ -0,0 +1,153 @@ + + + + + + + xdg-app export-file + xdg-app + + + + Developer + Alexander + Larsson + alexl@redhat.com + + + + + + xdg-app export-file + 1 + + + + xdg-app-export-file + Export a file to a sandboxed application + + + + + xdg-app export-file + OPTION + FILE + + + + + Description + + + Creates a document identifier for a local file that can be + exposed to sandboxed applications, allowing them access to + files that they would not otherwise see. + + + + This command also lets you modify the per-application + permissions of the documents, granting access to the + file on a per-application basis. + + + + + + Options + + The following options are understood: + + + + + + + + Show help options and exit. + + + + + + + Don't reuse an existing document id + for the file. This makes it safe to later remove the + document when you're finished with it. + + + + + + + + Grant read access to the specified application. + + + + + + + + Also grant write access to the applications specified with --app. + + + + + + + + Also grant the ability to delete a document id to the applications specified with --app. + + + + + + + + Also grant the ability further grant permissions to the applications specified with --app. + + + + + + + + + Print debug information during command processing. + + + + + + + + Print version information and exit. + + + + + + + Examples + + + $ xdg-app export-file --app=org.gnome.GEdit ~/test.txt + + +/run/user/1000/doc/e52f9c6a/test.txt + + + + + + See also + + + xdg-app1 + xdg-app-run1 + + + + + diff --git a/doc/xdg-app-modify-remote.xml b/doc/xdg-app-modify-remote.xml new file mode 100644 index 00000000..1b877ab7 --- /dev/null +++ b/doc/xdg-app-modify-remote.xml @@ -0,0 +1,166 @@ + + + + + + + xdg-app modify-remote + xdg-app + + + + Developer + Alexander + Larsson + alexl@redhat.com + + + + + + xdg-app modify-remote + 1 + + + + xdg-app-modify-remote + Modify a remote repository + + + + + xdg-app modify-remote + OPTION + NAME + + + + + Description + + + Modifies options for an existing remote repository in the xdg-app repository configuration. + NAME is the name for the remote. + + + Unless overridden with the --user option, this command changes + the system-wide configuration. + + + + + + Options + + The following options are understood: + + + + + + + + Show help options and exit. + + + + + + + + Modify the per-user configuration. + + + + + + + + Modify the system-wide configuration. + + + + + + + + Disable GPG verification for the added remote. + + + + + + + + Enable GPG verification for the added remote. + + + + + + + + A title for the remote, e.g. for display in a UI. + + + + + + + + Import gpg keys from the specified keyring file as + trusted for the new remote. If the file is - the + keyring is read from standard input. The set of keys + imported from the keyring can optionally be limited by + using --gpg-key. + + + + + + + + Only import the named keys from the specified gpg keyrings. + + + + + + + + + Print debug information during command processing. + + + + + + + + Print version information and exit. + + + + + + + Examples + + + $ xdg-app --user modify-remote --no-gpg-verify test-repo + + + + + See also + + + xdg-app1, + xdg-app-add-remote1, + xdg-app-delete-remote1, + xdg-app-list-remotes1 + + + + diff --git a/doc/xdg-app-override.xml b/doc/xdg-app-override.xml new file mode 100644 index 00000000..ca8e0f1d --- /dev/null +++ b/doc/xdg-app-override.xml @@ -0,0 +1,232 @@ + + + + + + + xdg-app override + xdg-app + + + + Developer + Alexander + Larsson + alexl@redhat.com + + + + + + xdg-app override + 1 + + + + xdg-app-override + Override application requirements + + + + + xdg-app override + OPTION + APP + + + + + Description + + + Overrides the application specified runtime requirements. This can be used + to grant a sandboxed application more or less resources than it requested. + + + By default the application gets access to the resources it + requested when it is started. But the user can override it + on a particular instance by specifying extra arguments to + xdg-app run, or every time by using xdg-app override. + + + + + + Options + + The following options are understood: + + + + + + + + Show help options and exit. + + + + + + + + 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. + + + + + + + + Don't 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. + + + + + + + + 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. + + + + + + + + Don't 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. + + + + + + + + Expose a device to the application. This overrides to + the Context section from the application metadata. + DEVICE must be one of: dri. + This option can be used multiple times. + + + + + + + + Don't expose a device to the application. This overrides to + the Context section from the application metadata. + DEVICE must be one of: dri. + This option can be used multiple times. + + + + + + + + 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, + an absolute path, or a a homedir-relative path like ~/dir. + This option can be used multiple times. + + + + + + + + Set an environment variable in the application. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + + + + + + + + Allow the application to own the well known name NAME on the session bus. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + + + + + + + + Allow the application to talk to the well known name NAME on the session bus. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + + + + + + + + If the application doesn't 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 persistant data. + This overrides to the Context section from the application metadata. + This option can be used multiple times. + + + + + + + + + Print debug information during command processing. + + + + + + + + Print version information and exit. + + + + + + + Examples + + + $ xdg-app override --nosocket=wayland org.gnome.GEdit + + + $ xdg-app override --filesystem=home org.mozilla.Firefox + + + + + + See also + + + xdg-app1 + xdg-app-run1 + + + + + diff --git a/doc/xdg-app-run.xml b/doc/xdg-app-run.xml index 63eaaa47..1d92743f 100644 --- a/doc/xdg-app-run.xml +++ b/doc/xdg-app-run.xml @@ -2,7 +2,7 @@ - + xdg-app run @@ -273,6 +273,7 @@ xdg-app1 + xdg-app-override1 diff --git a/doc/xdg-app.xml b/doc/xdg-app.xml index 0ac35ae9..22e4c70d 100644 --- a/doc/xdg-app.xml +++ b/doc/xdg-app.xml @@ -113,6 +113,13 @@ Add a remote repository. + + xdg-app-modify-remote1 + + + Modify remote repository properties. + + xdg-app-delete-remote1 @@ -128,7 +135,7 @@ - xdg-app-repo-contents1 + xdg-app-ls-remote1 Show available runtimes and applications. @@ -212,6 +219,20 @@ Run an application. + + xdg-app-override1 + + + Override application requirements. + + + + xdg-app-export-file1 + + + Export a file to a sandboxed application. + + Commands for building applications: