diff --git a/doc/xdg-app-add-repo.xml b/doc/xdg-app-add-repo.xml index d5614a42..0d243ad8 100644 --- a/doc/xdg-app-add-repo.xml +++ b/doc/xdg-app-add-repo.xml @@ -41,18 +41,9 @@ Description - Adds a remote repository configuration. NAME - is the name for the new remote, and URL is - the location for the repository. - - - xdg-app can operate in system-wide or per-user mode. The system-wide - repository is located in $prefix/share/xdg-app/repo, - and the per-user repository is in $HOME/.local/share/xdg-app/repo. - - - xdg-app uses OSTree, and the repositories it uses are OSTree repositories - that can be manipulated with the ostree utility. + Adds a remote repository to the xdg-app repository configuration. + NAME is the name for the new remote, and + URL is the location for the repository. @@ -128,9 +119,9 @@ See also - ostree1, - ostree.repo5, - xdg-app-delete-repo1 + xdg-app1, + xdg-app-delete-repo1, + xdg-app-list-repos1 diff --git a/doc/xdg-app-build-export.xml b/doc/xdg-app-build-export.xml index 12598610..d5a86cb3 100644 --- a/doc/xdg-app-build-export.xml +++ b/doc/xdg-app-build-export.xml @@ -52,8 +52,9 @@ If LOCATION exists, it is assumed to - be an OSTree repository, otherwise a new repository is created - at this location. + be an OSTree repository, otherwise a new OSTree repository is + created at this location. The repository can be inspected with + the ostree tool. The contents of DIRECTORY are committed @@ -66,8 +67,8 @@ After this command, LOCATION can be - used as the repository location for xdg-app add-repo, - either by exporting it over http, or directly as a file: url. + used as the repository location for xdg-app add-repo, either by + exporting it over http, or directly with a file: url. @@ -122,4 +123,17 @@ Content Bytes Written: 305 + + See also + + + ostree1, + xdg-app1, + xdg-app-build-init1, + xdg-app-build1, + xdg-app-build-finish1 + + + + diff --git a/doc/xdg-app-build-finish.xml b/doc/xdg-app-build-finish.xml index f5b55698..68a183be 100644 --- a/doc/xdg-app-build-finish.xml +++ b/doc/xdg-app-build-finish.xml @@ -40,7 +40,7 @@ Description - Finalizes a build directory, to prepare it for bundling. + Finalizes a build directory, to prepare it for exporting. DIRECTORY is the name of the directory. @@ -92,7 +92,8 @@ Set the KEY in the [Environment] group to true. KEY must be one of: x11, ipc, pulseaudio, system-dbus, session-dbus, - network, host-fs, homedir. + network, host-fs, homedir. This option can be used multiple + times. @@ -131,4 +132,16 @@ Please review the exported files and the metadata + + See also + + + xdg-app1, + xdg-app-build-init1, + xdg-app-build1, + xdg-app-build-export1 + + + + diff --git a/doc/xdg-app-build-init.xml b/doc/xdg-app-build-init.xml index 29e12614..b9ba3134 100644 --- a/doc/xdg-app-build-init.xml +++ b/doc/xdg-app-build-init.xml @@ -51,7 +51,7 @@ The result of this command is that a metadata - is created inside the given directory. Additionally, empty + file is created inside the given directory. Additionally, empty files and var subdirectories are created. @@ -129,4 +129,16 @@ + + See also + + + xdg-app1, + xdg-app-build1, + xdg-app-build-finish1, + xdg-app-build-export1 + + + + diff --git a/doc/xdg-app-build.xml b/doc/xdg-app-build.xml index 6be5d389..6969d392 100644 --- a/doc/xdg-app-build.xml +++ b/doc/xdg-app-build.xml @@ -45,8 +45,8 @@ must have been initialized with xdg-app build-init. - The sdk that is specfied in the metadata for the - directory is mounted at /usr and the + The sdk that is specfied in the metadata file + in the directory is mounted at /usr and the files and var subdirectories are mounted at /self and /var, respectively. They are writable, and their contents are preserved between @@ -81,4 +81,16 @@ + + See also + + + xdg-app1, + xdg-app-build-init1, + xdg-app-build-finish1, + xdg-app-build-export1 + + + + diff --git a/doc/xdg-app-delete-repo.xml b/doc/xdg-app-delete-repo.xml index b34709cf..3d98e4d6 100644 --- a/doc/xdg-app-delete-repo.xml +++ b/doc/xdg-app-delete-repo.xml @@ -40,18 +40,9 @@ Description - Removes a remote repository configuration. + Removes a remote repository from the xdg-app repository configuration. NAME is the name of an existing remote. - - xdg-app can operate in system-wide or per-user mode. The system-wide - repository is located in $prefix/share/xdg-app/repo, - and the per-user repository is in $HOME/.local/share/xdg-app/repo. - - - xdg-app uses OSTree, and the repositories it uses are OSTree repositories - that can be manipulated with the ostree utility. - @@ -110,9 +101,9 @@ See also - ostree1, - ostree.repo5, - xdg-app-add-repo1 + xdg-app1, + xdg-app-add-repo1, + xdg-app-list-repos1 diff --git a/doc/xdg-app-install-app.xml b/doc/xdg-app-install-app.xml index 447ee9d8..c5e6fa6d 100644 --- a/doc/xdg-app-install-app.xml +++ b/doc/xdg-app-install-app.xml @@ -45,17 +45,10 @@ Installs an application. REPOSITORY must name an existing remote. APP is the name of the application to install. Optionally, - BRANCH can be specified to install a specific - branch. Note that xdg-app allows to have multiple branches of an - application installed at the same time. - - - xdg-app can operate in system-wide or per-user mode. The system-wide - applications are located in $prefix/share/xdg-app/app, - and the per-user runtimes are in $HOME/.local/share/xdg-app/app. - - - xdg-app uses OSTree, and installed applications are OSTree checkouts. + BRANCH can be specified to install a branch + other than the default "master" branch. Note that xdg-app allows to + have multiple branches of an application installed and used at the + same time. @@ -120,4 +113,15 @@ + + See also + + + xdg-app1, + xdg-app-update-app1, + xdg-app-list-apps1 + + + + diff --git a/doc/xdg-app-install-runtime.xml b/doc/xdg-app-install-runtime.xml index ef3f0635..692a7ec9 100644 --- a/doc/xdg-app-install-runtime.xml +++ b/doc/xdg-app-install-runtime.xml @@ -45,17 +45,9 @@ Installs a runtime. REPOSITORY must name an existing remote. RUNTIME is the name of the runtime to install. Optionally, - BRANCH can be specified to install a specific - branch. Note that xdg-app allows having multiple branches of a runtime - installed and used at the same time. - - - xdg-app can operate in system-wide or per-user mode. The system-wide - runtimes are located in $prefix/share/xdg-app/runtime, - and the per-user runtimes are in $HOME/.local/share/xdg-app/runtinme. - - - xdg-app uses OSTree, and installed runtimes are OSTree checkouts. + BRANCH can be specified to install a branch + other than the default "master" branch. Note that xdg-app allows having + multiple branches of a runtime installed and used at the same time. @@ -88,7 +80,8 @@ - The architecture to install for. + The architecture to install, instead of the architecture + of the host system. @@ -120,4 +113,15 @@ + + See also + + + xdg-app1, + xdg-app-update-runtime1, + xdg-app-list-runtimes1 + + + + diff --git a/doc/xdg-app-list-apps.xml b/doc/xdg-app-list-apps.xml index 6b674fa2..fa546e7b 100644 --- a/doc/xdg-app-list-apps.xml +++ b/doc/xdg-app-list-apps.xml @@ -39,15 +39,7 @@ Description - Lists installed applications. - - - xdg-app can operate in system-wide or per-user mode. The system-wide - applications are located in $prefix/share/xdg-app/app, - and the per-user runtimes are in $HOME/.local/share/xdg-app/app. - - - xdg-app uses OSTree, and installed appications are OSTree checkouts. + Lists the names of the installed applications. @@ -118,4 +110,15 @@ org.gnome.GEdit + + See also + + + xdg-app1, + xdg-app-install-app1, + xdg-app-update-app1 + + + + diff --git a/doc/xdg-app-list-repos.xml b/doc/xdg-app-list-repos.xml index ea7c523d..419b6296 100644 --- a/doc/xdg-app-list-repos.xml +++ b/doc/xdg-app-list-repos.xml @@ -41,15 +41,6 @@ Lists the known remote repositories. - - xdg-app can operate in system-wide or per-user mode. The system-wide - repository is located in $prefix/share/xdg-app/repo, - and the per-user repository is in $HOME/.local/share/xdg-app/repo. - - - xdg-app uses OSTree, and the repositories it uses are OSTree repositories - that can be manipulated with the ostree utility. - @@ -119,9 +110,9 @@ testrepo http://209.132.179.91/repo/ See also - ostree1, - ostree.repo5, - xdg-app-add-repo1 + xdg-app1, + xdg-app-add-repo1, + xdg-app-delete-repo1 diff --git a/doc/xdg-app-list-runtimes.xml b/doc/xdg-app-list-runtimes.xml index 243185ff..ebb1bccc 100644 --- a/doc/xdg-app-list-runtimes.xml +++ b/doc/xdg-app-list-runtimes.xml @@ -39,15 +39,7 @@ Description - Lists installed runtimes. - - - xdg-app can operate in system-wide or per-user mode. The system-wide - runtimes are located in $prefix/share/xdg-app/runtime, - and the per-user runtimes are in $HOME/.local/share/xdg-app/runtinme. - - - xdg-app uses OSTree, and installed runtimes are OSTree checkouts. + Lists the names of the installed runtimes. @@ -120,4 +112,16 @@ org.gnome.Platform/x86_64/3.14 + + See also + + + xdg-app1, + xdg-app-install-runtime1, + xdg-app-update-runtime1 + + + + + diff --git a/doc/xdg-app-run.xml b/doc/xdg-app-run.xml index 65b053c5..0fe552c2 100644 --- a/doc/xdg-app-run.xml +++ b/doc/xdg-app-run.xml @@ -41,8 +41,9 @@ Description - Runs an application in a sandboxed environment. APP must - name an installed application. + Runs an application in a sandboxed environment. + APP must name an installed application. + Extra arguments are passed on to the application. xdg-app creates a sandboxed environment for the application to run in @@ -132,4 +133,13 @@ + + See also + + + xdg-app1 + + + + diff --git a/doc/xdg-app-update-app.xml b/doc/xdg-app-update-app.xml index d2e23114..98029cc0 100644 --- a/doc/xdg-app-update-app.xml +++ b/doc/xdg-app-update-app.xml @@ -43,8 +43,15 @@ Updates an application. APP is the name of an installed application. Optionally, - BRANCH can be specified to update a - specific branch. + BRANCH can be specified to update a + branch other than the default "master" branch. + + + Note that updating a runtime is different from installing + a newer branch, and application updates are expected to keep + strict compatibility. If an application update does cause + a problem, it is possible to go back to the previous + version, with the --commit option. @@ -109,4 +116,15 @@ + + See also + + + xdg-app1, + xdg-app-install-app1, + xdg-app-list-apps1 + + + + diff --git a/doc/xdg-app-update-runtime.xml b/doc/xdg-app-update-runtime.xml index 65304847..a8750f6f 100644 --- a/doc/xdg-app-update-runtime.xml +++ b/doc/xdg-app-update-runtime.xml @@ -43,15 +43,17 @@ Updates a runtime. RUNTIME is the name of an installed runtime. Optionally, - BRANCH can be specified to update a - specific branch. + BRANCH can be specified to update a + branch other than the default "master" branch. Note that updating a runtime is different from installing a newer branch, and runtime updates are expected to keep strict compatibility, so that applications can be guaranteed to keep running against an updated version of the runtime - they were built against. + they were built against. If a runtime update does cause + a problem, it is possible to go back to the previous + version, with the --commit option. @@ -84,7 +86,8 @@ - The architecture to update for. + The architecture to update, instead of the architecture + of the host system. @@ -116,4 +119,15 @@ + + See also + + + xdg-app1, + xdg-app-install-runtime1, + xdg-app-list-runtimes1 + + + + diff --git a/doc/xdg-app.xml b/doc/xdg-app.xml index 7558225f..9af618a6 100644 --- a/doc/xdg-app.xml +++ b/doc/xdg-app.xml @@ -41,11 +41,29 @@ xdg-app is a tool for managing applications and the runtimes - the use. In the xdg-app model, applications can be built and - distributed independently from the host system the are used + they use. In the xdg-app model, applications can be built and + distributed independently from the host system they are used on, and they are isolated from the host system ('sandboxed') to some degree, at runtime. + + + xdg-app can operate in system-wide or per-user mode. The system-wide + data (runtimes, applications and configuration) is located in + $prefix/share/xdg-app/, and the per-user + data is in $HOME/.local/share/xdg-app/. + Below these locations, there is a local repository in the + repo/ subdirectory and installed runtimes + and applications are in the corresponding runtime/ + and app/ subdirectories. + + + + xdg-app uses OSTree to distribute and deploy data. The repositories + it uses are OSTree repositories and can be manipulated with the + ostree utility. Installed runtimes and + applications are OSTree checkouts. + @@ -85,7 +103,7 @@ Commands - The following commands are available: + Commands related to repository configuration: @@ -116,6 +134,11 @@ Show available runtimes and applications. + + + Commands for handling installed runtimes: + + xdg-app-install-runtime1 @@ -137,6 +160,11 @@ List installed runtimes. + + + Commands for handling installed applications: + + xdg-app-install-app1 @@ -158,6 +186,11 @@ List installed applications. + + + Commands for running applications: + + xdg-app-run1 @@ -165,6 +198,11 @@ Run an application. + + + Commands for building applications: + + xdg-app-build-init1 @@ -196,4 +234,14 @@ + + See also + + + ostree1, + ostree.repo5, + + + +