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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>glib-compile-schemas</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GIO Reference Manual">
   8 <link rel="up" href="tools.html" title="GIO Tools">
   9 <link rel="prev" href="gsettings-tool.html" title="gsettings">
  10 <link rel="next" href="glib-compile-resources.html" title="glib-compile-resources">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
  16 <td><a accesskey="p" href="gsettings-tool.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  17 <td><a accesskey="u" href="tools.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  18 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  19 <th width="100%" align="center">GIO Reference Manual</th>
  20 <td><a accesskey="n" href="glib-compile-resources.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  21 </tr></table>
  22 <div lang="en" class="refentry">
  23 <a name="glib-compile-schemas"></a><div class="titlepage"></div>
  24 <div class="refnamediv"><table width="100%"><tr>
  25 <td valign="top">
  26 <h2><span class="refentrytitle">glib-compile-schemas</span></h2>
  27 <p>glib-compile-schemas — GSettings schema compiler</p>
  28 </td>
  29 <td valign="top" align="right"></td>
  30 </tr></table></div>
  31 <div class="refsynopsisdiv">
  32 <h2>Synopsis</h2>
  33 <div class="cmdsynopsis"><p><code class="command">glib-compile-schemas</code>  [option...] {directory}</p></div>
  34 </div>
  35 <div class="refsect1">
  36 <a name="id688186"></a><h2>Description</h2>
  37 <p><span class="command"><strong>glib-compile-schemas</strong></span> compiles all the GSettings XML
  38 schema files in <em class="replaceable"><code>directory</code></em> into a binary file
  39 with the name <code class="filename">gschemas.compiled</code> that can be used
  40 by <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a>. The XML schema
  41 files must have the filename extension <code class="filename">.gschema.xml</code>.
  42 For a detailed description of the XML file format, see the
  43 <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> documentation.
  44 </p>
  45 <p>
  46 At runtime, GSettings looks for schemas in the
  47 <code class="filename">glib-2.0/schemas</code> subdirectories of all directories
  48 specified in the <code class="envar">XDG_DATA_DIRS</code> environment variable. The
  49 usual location to install schema files is
  50 <code class="filename">/usr/share/glib-2.0/schemas</code>.
  51 </p>
  52 <p>
  53 In addition to schema files, glib-compile-schemas reads 'vendor override'
  54 files, which are key files that can override default values for keys in
  55 the schemas. The group names in the key files are the schema id, and the
  56 values are written in serialized GVariant form.
  57 Vendor override files must have the filename extension
  58 <code class="filename">.gschema.override</code>.
  59 </p>
  60 <p>
  61 By convention, vendor override files begin with <code class="filename">nn_</code>
  62 where <code class="filename">nn</code> is a number from 00 to 99.  Higher
  63 numbered files have higher priority (eg: if the same override is made in
  64 a file numbered 10 and then again in a file numbered 20, the override
  65 from 20 will take precedence).
  66 </p>
  67 <div class="refsect2">
  68 <a name="id579136"></a><h3>Options</h3>
  69 <div class="variablelist"><table border="0">
  70 <col align="left" valign="top">
  71 <tbody>
  72 <tr>
  73 <td><p><span class="term"><code class="option">-h</code>, <code class="option">--help</code></span></p></td>
  74 <td><p>
  75 Print help and exit
  76 </p></td>
  77 </tr>
  78 <tr>
  79 <td><p><span class="term"><code class="option">--targetdir=<em class="replaceable"><code>TARGETDIR</code></em></code></span></p></td>
  80 <td><p>
  81 Store <code class="filename">gschemas.compiled</code> in <em class="replaceable"><code>TARGETDIR</code></em> instead of <em class="replaceable"><code>directory</code></em>.
  82 </p></td>
  83 </tr>
  84 <tr>
  85 <td><p><span class="term"><code class="option">--dry-run</code></span></p></td>
  86 <td><p>
  87 Don't write <code class="filename">gschemas.compiled</code>. This option can be used
  88 to check <code class="filename">.gschema.xml</code> sources for errors.
  89 </p></td>
  90 </tr>
  91 <tr>
  92 <td><p><span class="term"><code class="option">--allow-any-name</code></span></p></td>
  93 <td><p>
  94 Do not enforce restrictions on key names. Note that this option is purely
  95 to facility the transition from GConf, and will be removed at some time
  96 in the future.
  97 </p></td>
  98 </tr>
  99 </tbody>
 100 </table></div>
 101 </div>
 102 </div>
 103 <div class="refsect1">
 104 <a name="id692631"></a><h2>See also</h2>
 105 </div>
 106 </div>
 107 <div class="footer">
 108 <hr>
 109           Generated by GTK-Doc V1.18</div>
 110 </body>
 111 </html>