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

   1 '\" t
   2 .\"     Title: glib-compile-schemas
   3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
   5 .\"      Date: 05/14/2012
   6 .\"    Manual: User Commands
   7 .\"    Source: User Commands
   8 .\"  Language: English
   9 .\"
  10 .TH "GLIB\-COMPILE\-SCHEM" "1" "05/14/2012" "User Commands" "User Commands"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 glib-compile-schemas \- GSettings schema compiler
  32 .SH "SYNOPSIS"
  33 .HP \w'\fBglib\-compile\-schemas\fR\ 'u
  34 \fBglib\-compile\-schemas\fR [option...] {directory}
  35 .SH "DESCRIPTION"
  36 .PP
  37 \fBglib\-compile\-schemas\fR
  38 compiles all the GSettings XML schema files in
  39 \fIdirectory\fR
  40 into a binary file with the name
  41 gschemas\&.compiled
  42 that can be used by
  43 \fBGSettings\fR\&. The XML schema files must have the filename extension
  44 \&.gschema\&.xml\&. For a detailed description of the XML file format, see the
  45 \fBGSettings\fR
  46 documentation\&.
  47 .PP
  48 At runtime, GSettings looks for schemas in the
  49 glib\-2\&.0/schemas
  50 subdirectories of all directories specified in the
  51 \fBXDG_DATA_DIRS\fR
  52 environment variable\&. The usual location to install schema files is
  53 /usr/share/glib\-2\&.0/schemas\&.
  54 .PP
  55 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
  56 \&.gschema\&.override\&.
  57 .PP
  58 By convention, vendor override files begin with
  59 nn_
  60 where
  61 nn
  62 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)\&.
  63 .SS "Options"
  64 .PP
  65 \fB\-h\fR, \fB\-\-help\fR
  66 .RS 4
  67 Print help and exit
  68 .RE
  69 .PP
  70 \fB\-\-targetdir=\fR\fB\fITARGETDIR\fR\fR
  71 .RS 4
  72 Store
  73 gschemas\&.compiled
  74 in
  75 \fITARGETDIR\fR
  76 instead of
  77 \fIdirectory\fR\&.
  78 .RE
  79 .PP
  80 \fB\-\-dry\-run\fR
  81 .RS 4
  82 Don\*(Aqt write
  83 gschemas\&.compiled\&. This option can be used to check
  84 \&.gschema\&.xml
  85 sources for errors\&.
  86 .RE
  87 .PP
  88 \fB\-\-allow\-any\-name\fR
  89 .RS 4
  90 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\&.
  91 .RE
  92 .SH "SEE ALSO"