Blame docs/reference/gio/glib-compile-schemas.1

Packit ae235b
'\" t
Packit ae235b
.\"     Title: glib-compile-schemas
Packit ae235b
.\"    Author: Ryan Lortie
Packit ae235b
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
Packit ae235b
.\"      Date: 04/07/2018
Packit ae235b
.\"    Manual: User Commands
Packit ae235b
.\"    Source: GIO
Packit ae235b
.\"  Language: English
Packit ae235b
.\"
Packit ae235b
.TH "GLIB\-COMPILE\-SCHEM" "1" "" "GIO" "User Commands"
Packit ae235b
.\" -----------------------------------------------------------------
Packit ae235b
.\" * Define some portability stuff
Packit ae235b
.\" -----------------------------------------------------------------
Packit ae235b
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Packit ae235b
.\" http://bugs.debian.org/507673
Packit ae235b
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
Packit ae235b
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Packit ae235b
.ie \n(.g .ds Aq \(aq
Packit ae235b
.el       .ds Aq '
Packit ae235b
.\" -----------------------------------------------------------------
Packit ae235b
.\" * set default formatting
Packit ae235b
.\" -----------------------------------------------------------------
Packit ae235b
.\" disable hyphenation
Packit ae235b
.nh
Packit ae235b
.\" disable justification (adjust text to left margin only)
Packit ae235b
.ad l
Packit ae235b
.\" -----------------------------------------------------------------
Packit ae235b
.\" * MAIN CONTENT STARTS HERE *
Packit ae235b
.\" -----------------------------------------------------------------
Packit ae235b
.SH "NAME"
Packit ae235b
glib-compile-schemas \- GSettings schema compiler
Packit ae235b
.SH "SYNOPSIS"
Packit ae235b
.HP \w'\fBglib\-compile\-schemas\fR\ 'u
Packit ae235b
\fBglib\-compile\-schemas\fR [OPTION...] {DIRECTORY}
Packit ae235b
.SH "DESCRIPTION"
Packit ae235b
.PP
Packit ae235b
\fBglib\-compile\-schemas\fR
Packit ae235b
compiles all the GSettings XML schema files in
Packit ae235b
\fIDIRECTORY\fR
Packit ae235b
into a binary file with the name
Packit ae235b
gschemas\&.compiled
Packit ae235b
that can be used by
Packit ae235b
\fBGSettings\fR\&. The XML schema files must have the filename extension
Packit ae235b
\&.gschema\&.xml\&. For a detailed description of the XML file format, see the
Packit ae235b
\fBGSettings\fR
Packit ae235b
documentation\&.
Packit ae235b
.PP
Packit ae235b
At runtime, GSettings looks for schemas in the
Packit ae235b
glib\-2\&.0/schemas
Packit ae235b
subdirectories of all directories specified in the
Packit ae235b
\fBXDG_DATA_DIRS\fR
Packit ae235b
environment variable\&. The usual location to install schema files is
Packit ae235b
/usr/share/glib\-2\&.0/schemas\&.
Packit ae235b
.PP
Packit ae235b
In addition to schema files, glib\-compile\-schemas reads \*(Aqvendor override\*(Aq 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
Packit ae235b
\&.gschema\&.override\&.
Packit ae235b
.PP
Packit ae235b
By convention, vendor override files begin with
Packit ae235b
nn_
Packit ae235b
where
Packit ae235b
nn
Packit ae235b
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)\&.
Packit ae235b
.SH "OPTIONS"
Packit ae235b
.PP
Packit ae235b
\fB\-h\fR, \fB\-\-help\fR
Packit ae235b
.RS 4
Packit ae235b
Print help and exit
Packit ae235b
.RE
Packit ae235b
.PP
Packit ae235b
\fB\-\-version\fR
Packit ae235b
.RS 4
Packit ae235b
Print program version and exit
Packit ae235b
.RE
Packit ae235b
.PP
Packit ae235b
\fB\-\-targetdir=\fR\fB\fITARGET\fR\fR
Packit ae235b
.RS 4
Packit ae235b
Store
Packit ae235b
gschemas\&.compiled
Packit ae235b
in the
Packit ae235b
\fITARGET\fR
Packit ae235b
directory instead of
Packit ae235b
\fIDIRECTORY\fR\&.
Packit ae235b
.RE
Packit ae235b
.PP
Packit ae235b
\fB\-\-strict\fR
Packit ae235b
.RS 4
Packit ae235b
Abort on any errors in schemas\&. Without this option, faulty schema files are simply omitted from the resulting compiled schema\&.
Packit ae235b
.RE
Packit ae235b
.PP
Packit ae235b
\fB\-\-dry\-run\fR
Packit ae235b
.RS 4
Packit ae235b
Don\*(Aqt write
Packit ae235b
gschemas\&.compiled\&. This option can be used to check
Packit ae235b
\&.gschema\&.xml
Packit ae235b
sources for errors\&.
Packit ae235b
.RE
Packit ae235b
.PP
Packit ae235b
\fB\-\-allow\-any\-name\fR
Packit ae235b
.RS 4
Packit ae235b
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\&.
Packit ae235b
.RE