Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

glib-compile-schemas (1)

Name

glib-compile-schemas - GSettings schema compiler

Synopsis

glib-compile-schemas [OPTION...] {DIRECTORY}

Description

GLIB-COMPILE-SCHEM(1)            User Commands           GLIB-COMPILE-SCHEM(1)



NAME
       glib-compile-schemas - GSettings schema compiler

SYNOPSIS
       glib-compile-schemas [OPTION...] {DIRECTORY}

DESCRIPTION
       glib-compile-schemas compiles all the GSettings XML schema files in
       DIRECTORY into a binary file with the name gschemas.compiled that can
       be used by GSettings. The XML schema files must have the filename
       extension .gschema.xml. For a detailed description of the XML file
       format, see the GSettings documentation.

       At runtime, GSettings looks for schemas in the glib-2.0/schemas
       subdirectories of all directories specified in the XDG_DATA_DIRS
       environment variable. The usual location to install schema files is
       /usr/share/glib-2.0/schemas.

       In addition to schema files, glib-compile-schemas reads 'vendor
       override' files, which are key files that can override default values
       for keys in the schemas. The group names in the key files are the
       schema id, and the values are written in serialized GVariant form.
       Vendor override files must have the filename extension
       .gschema.override.

       By convention, vendor override files begin with nn_ where nn is a
       number from 00 to 99. Higher numbered files have higher priority (eg:
       if the same override is made in a file numbered 10 and then again in a
       file numbered 20, the override from 20 will take precedence).

OPTIONS
       -h, --help
           Print help and exit

       --version
           Print program version and exit

       --targetdir=TARGET
           Store gschemas.compiled in the TARGET directory instead of
           DIRECTORY.

       --strict
           Abort on any errors in schemas. Without this option, faulty schema
           files are simply omitted from the resulting compiled schema.

       --dry-run
           Don't write gschemas.compiled. This option can be used to check
           .gschema.xml sources for errors.

       --allow-any-name
           Do not enforce restrictions on key names. Note that this option is
           purely to facility the transition from GConf, and will be removed
           at some time in the future.

   SMF Management and IPS Packaging
       In Oracle Solaris, the transient glib-compile-schemas service runs
       glib-compile-schemas when necessary to update the gschemas.compiled
       file with information about the installed GSettings XML schema and
       vendor override files. An example of when the glib-compile-schemas
       service runs is when a package that specifies the
       svc:/application/desktop-cache/glib-compile-schemas service as the
       value of a restart_fmri attribute on is being installed. A package that
       installs a GSettings schema XML file should have such an attribute. See
       the application/desktop-cache/glib-compile-schemas(8s) man page for
       details about the glib-compile-schemas service. See the smf(7) man page
       for information about the Oracle Solaris Service Management Facility.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/glib2    |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       application/desktop-cache/glib-compile-schemas(8s)



NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://download.gnome.org/sources/glib/2.70/glib-2.70.5.tar.xz.

       Further information about this software can be found on the open source
       community website at https://wiki.gnome.org/Projects/GLib/.



GIO                                                      GLIB-COMPILE-SCHEM(1)