diff --git a/doc/xdg-app-builder.xml b/doc/xdg-app-builder.xml index bf00e0d2..520d6894 100644 --- a/doc/xdg-app-builder.xml +++ b/doc/xdg-app-builder.xml @@ -107,119 +107,119 @@ - + (string) A string defining the application id. - + (string) The branch of the application, defaults to master. - + (string) The name of the runtime that the application uses. - + (string) The version of the runtime that the application uses, defaults to master. - + (string) The name of the development runtime that the application builds with. - + (string) Use this file as the base metadata file when finishing. - + (string) The filename or path to the main binary of the application. - + (boolean) Build a new runtime instead of an application. - - Separate out locale files and translations to an extention runtime. Defaults to true. + (boolean) + Separate out locale files and translations to an extension runtime. Defaults to true. - + (string) When building a runtime sdk, also create a platform based on it with this id. - + (string) The metadata file to use for the platform we create. - + (boolean) If true, use a writable copy of the sdk for /usr. Defaults to true if --build-runtime is specified. - + (boolean) Run appstream-compose during cleanup phase. Defaults to true. - + (array of strings) Install these extra sdk extensions in /usr. - + (array of strings) Install these extra sdk extensions when creating the platform. - + (array of strings) Add these tags to the metadata file. - + (object) Object specifying the build environment. See below for details. - + (array of objects) An array of object specifying the modules to be built in order. See below for details. - + (array of strings) An array of file patterns that should be removed at the end. Patterns starting with / are taken to be full pathnames (without the /app prefix), otherwise they just match the basename. - + (array of strings) An array of commandlines that are run during the cleanup phase. - + (array of strings) Extra files to clean up in the platform. - + (array of strings) An array of arguments passed to the xdg-app build-finish command. - + (string) Any desktop file with this name will be renamed to a name based on id during the cleanup phase. - + (string) Any appdata file with this name will be renamed to a name based on id during the cleanup phase. - + (string) Any icon with this name will be renamed to a name based on id during the cleanup phase. - + (boolean) If rename-icon is set, keep a copy of the old icon file. - + (string) This string will be prefixed to the Name key in the main application desktop file. - + (string) This string will be suffixed to the Name key in the main application desktop file. @@ -236,36 +236,36 @@ - + (string) This is set in the environment variable CFLAGS during the build. - + (string) This is set in the environment variable CXXFLAGS during the build. - + (string) The build prefix for the modules (defaults to /app for applications and /usr for runtimes). - + (object) This is a dictionary defining environment variables to be set during the build. - + (array of strings) This is an array containing extra options to pass to xdg-app build. - + (boolean) If this is true (the default is false) then all ELF files will be stripped after install. - + (boolean) If this is true (the default is false) and strip is not set then all ELF files will have their debug info extracted to a separate file. - + (object) This is a dictionary defining for each arch a separate build options object that override the main one. @@ -281,68 +281,68 @@ - + (string) The name of the module, used in e.g. build logs - + (array of objects) An array of objects defining sources that will be downloaded and extracted in order - + (array of strings) An array of options that will be passed to configure - + (array of strings) An array of arguments that will be passed to make - + (array of strings) An array of arguments that will be passed to make install - + (boolean) If true, remove the configure script before starting build - + (boolean) Ignore the existance of an autogen script - + (boolean) Don't call make with arguments to build in parallel - + (boolean) Use cmake instead of configure - + (string) Use a build directory that is separate from the source directory - + (string) Build inside this subdirectory of the extracted sources - + (object) A build options object that can override global options - + (array of strings) An array of shell command that are run after the install phase. Can for example clean up the install dir, or install extra files. - + (array of strings) An array of file patterns that should be removed at the end. Patterns starting with / are taken to be full pathnames (without the /app prefix), otherwise they just match the basename. Note that any patterns will only match files installed by this module. - + (array of strings) Extra files to clean up in the platform. @@ -361,23 +361,23 @@ "archive" - + (string) The path of the archive - + (string) The url of a remote archive that will be downloaded. This overrides path if both are specified. - + (string) The sha256 checksum of the file, verified after download - + (integer) The number of initial pathname components to strip during extraction. Defaults to 1. - + (string) Directory inside the source dir where the archive will be extracted. @@ -390,15 +390,15 @@ "git" - + (string) URL of the git repostiory - + (string) The branch/tag/commit to use from the git repostiory - + (string) Directory inside the source dir where the repository will be checked out. @@ -411,15 +411,15 @@ "bzr" - + (string) URL of the bzr repostiory - + (string) A specific revision to use in the branch - + (string) Directory inside the source dir where the repository will be checked out. @@ -432,23 +432,23 @@ "file" - + (string) The path of a local file that will be copied into the source dir - + (string) The url of a remote file that will be downloaded and copied into the source dir. This overrides path if both are specified. - + (string) The sha256 checksum of the file, verified after download. This is optional for local files. - + (string) Filename to use inside the source dir, default to the basename of path. - + (string) Directory inside the source dir where the file will be copied. @@ -464,15 +464,15 @@ "script" - + (array of strings) An array of shell commands that will be put in a shellscript file - + (string) Filename to use inside the source dir, default to the basename of path. - + (string) Directory inside the source dir where the file will be copied. @@ -488,7 +488,7 @@ "shell" - + (array of strings) An array of shell commands that will be run during source extraction @@ -501,15 +501,15 @@ "patch" - + (string) The path of a patch file that will be applied in the source dir - + (integer) The value of the -p argument to patch, defaults to 1. - + (string) Directory inside the source dir where the patch will be applied.