[glib/new-gsettings] Add a man page for gschema-compile



commit c850d1333020d5361280eba746eeeeae0e9d81a0
Author: Matthias Clasen <mclasen redhat com>
Date:   Thu Apr 15 01:46:20 2010 -0400

    Add a man page for gschema-compile

 docs/reference/gio/Makefile.am         |   22 ++++++++++-
 docs/reference/gio/gio-docs.xml        |   66 +++++++++++++++++---------------
 docs/reference/gio/gschema-compile.xml |   50 ++++++++++++++++++++++++
 3 files changed, 106 insertions(+), 32 deletions(-)
---
diff --git a/docs/reference/gio/Makefile.am b/docs/reference/gio/Makefile.am
index 2c51c7e..06d90c8 100644
--- a/docs/reference/gio/Makefile.am
+++ b/docs/reference/gio/Makefile.am
@@ -113,7 +113,8 @@ content_files =			\
 
 expand_content_files =		\
 	overview.xml		\
-	migrating.xml
+	migrating.xml		\
+	gschema-compile.xml
 
 extra_files =			\
 	version.xml.in		\
@@ -123,3 +124,22 @@ include $(top_srcdir)/gtk-doc.make
 
 EXTRA_DIST +=			\
 	version.xml.in
+
+man_MANS =			\
+	gschema-compile.1
+
+if ENABLE_MAN
+
+%.1 : xml/%.xml
+	@XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+
+endif
+
+BUILT_EXTRA_DIST = $(man_MANS)
+
+dist-hook-local: $(BUILT_EXTRA_DIST)
+	files='$(BUILT_EXTRA_DIST)';				\
+	for f in $$files; do					\
+	  if test -f $$f; then d=.; else d=$(srcdir); fi;	\
+	  cp $$d/$$f $(distdir) || exit 1; done
+
diff --git a/docs/reference/gio/gio-docs.xml b/docs/reference/gio/gio-docs.xml
index 09ea58c..3bb20c5 100644
--- a/docs/reference/gio/gio-docs.xml
+++ b/docs/reference/gio/gio-docs.xml
@@ -20,24 +20,24 @@
   <part>
   <title>API Reference</title>
     <chapter id="file_ops">
-    	<title>File Operations</title>
-    	<xi:include href="xml/gfile.xml"/>
+        <title>File Operations</title>
+        <xi:include href="xml/gfile.xml"/>
         <xi:include href="xml/gfileattribute.xml"/>
-    	<xi:include href="xml/gfileinfo.xml"/>
-	<xi:include href="xml/gfileenumerator.xml"/>
-	<xi:include href="xml/gioerror.xml"/>
-	<xi:include href="xml/gmountoperation.xml"/>
+        <xi:include href="xml/gfileinfo.xml"/>
+        <xi:include href="xml/gfileenumerator.xml"/>
+        <xi:include href="xml/gioerror.xml"/>
+        <xi:include href="xml/gmountoperation.xml"/>
     </chapter>
     <chapter id="file_mon">
-    	<title>File System Monitoring</title>
+        <title>File System Monitoring</title>
         <xi:include href="xml/gfilemonitor.xml"/>
     </chapter>
     <chapter id="async">
         <title>Asynchronous I/O</title>
-	<xi:include href="xml/gcancellable.xml"/>
-	<xi:include href="xml/gasyncresult.xml"/>
+        <xi:include href="xml/gcancellable.xml"/>
+        <xi:include href="xml/gasyncresult.xml"/>
         <xi:include href="xml/gioscheduler.xml"/>
-	<xi:include href="xml/gsimpleasyncresult.xml"/>
+        <xi:include href="xml/gsimpleasyncresult.xml"/>
     </chapter>
     <chapter id="conversion">
         <title>Data conversion</title>
@@ -48,7 +48,7 @@
     </chapter>
     <chapter id="streaming">
         <title>Streaming I/O</title>
-	<xi:include href="xml/gseekable.xml"/>
+        <xi:include href="xml/gseekable.xml"/>
         <xi:include href="xml/ginputstream.xml"/>
         <xi:include href="xml/goutputstream.xml"/>
         <xi:include href="xml/giostream.xml"/>
@@ -72,30 +72,30 @@
     <chapter id="types">
         <title>File types and applications</title>
         <xi:include href="xml/gcontenttype.xml"/>
-	<xi:include href="xml/gappinfo.xml"/>
-	<xi:include href="xml/gdesktopappinfo.xml"/>
+        <xi:include href="xml/gappinfo.xml"/>
+        <xi:include href="xml/gdesktopappinfo.xml"/>
     </chapter>
     <chapter id="volume_mon">
-    	<title>Volumes and Drives</title>
+        <title>Volumes and Drives</title>
         <xi:include href="xml/gvolumemonitor.xml"/>
-	<xi:include href="xml/gvolume.xml"/>
+        <xi:include href="xml/gvolume.xml"/>
         <xi:include href="xml/gmount.xml"/>
-	<xi:include href="xml/gdrive.xml"/>
-	<xi:include href="xml/gunixmounts.xml"/>
+        <xi:include href="xml/gdrive.xml"/>
+        <xi:include href="xml/gunixmounts.xml"/>
     </chapter>
     <chapter id="icons">
-    	<title>Icons</title>
-    	<xi:include href="xml/gicon.xml"/>
-    	<xi:include href="xml/gfileicon.xml"/>
-    	<xi:include href="xml/gloadableicon.xml"/>
-    	<xi:include href="xml/gthemedicon.xml"/>
-    	<xi:include href="xml/gemblemedicon.xml"/>
-    	<xi:include href="xml/gemblem.xml"/>
+        <title>Icons</title>
+        <xi:include href="xml/gicon.xml"/>
+        <xi:include href="xml/gfileicon.xml"/>
+        <xi:include href="xml/gloadableicon.xml"/>
+        <xi:include href="xml/gthemedicon.xml"/>
+        <xi:include href="xml/gemblemedicon.xml"/>
+        <xi:include href="xml/gemblem.xml"/>
     </chapter>
     <chapter id="failable_initialization">
-    	<title>Failable Initialization</title>
-    	<xi:include href="xml/ginitable.xml"/>
-    	<xi:include href="xml/gasyncinitable.xml"/>
+        <title>Failable Initialization</title>
+        <xi:include href="xml/ginitable.xml"/>
+        <xi:include href="xml/gasyncinitable.xml"/>
     </chapter>
     <chapter id="networking">
       <title>Lowlevel platform-independent network support</title>
@@ -125,7 +125,7 @@
       <xi:include href="xml/gthreadedsocketservice.xml"/>
     </chapter>
     <chapter id="utils">
-    	<title>Utilities</title>
+        <title>Utilities</title>
         <xi:include href="xml/gfilenamecompleter.xml"/>
     </chapter>
     <chapter id="settings">
@@ -134,10 +134,14 @@
         <xi:include href="xml/gsettingsbackend.xml"/>
     </chapter>
     <chapter id="extending">
-    	<title>Extending GIO</title>
+        <title>Extending GIO</title>
         <xi:include href="xml/gvfs.xml"/>
-	<xi:include href="xml/giomodule.xml"/>
-	<xi:include href="xml/extensionpoints.xml"/>
+        <xi:include href="xml/giomodule.xml"/>
+        <xi:include href="xml/extensionpoints.xml"/>
+    </chapter>
+    <chapter id="tools">
+        <title>GIO Tools</title>
+        <xi:include href="xml/gschema-compile.xml"/>
     </chapter>
   </part>
 
diff --git a/docs/reference/gio/gschema-compile.xml b/docs/reference/gio/gschema-compile.xml
new file mode 100644
index 0000000..1dcc643
--- /dev/null
+++ b/docs/reference/gio/gschema-compile.xml
@@ -0,0 +1,50 @@
+<refentry id="gschema-compile">
+
+<refmeta>
+<refentrytitle>gschema-compile</refentrytitle>
+<manvolnum>1</manvolnum>
+</refmeta>
+
+<refnamediv>
+<refname>gschema-compile</refname>
+<refpurpose>GSettings schema compiler</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>gschema-compile</command>
+<arg choice="opt" rep="repeat">option</arg>
+<arg choice="req">directory</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para><command>gschema-compile</command> compiles all the GSettings XML
+schema files in <replaceable>directory</replaceable> into a binary file
+with the name <filename>gschemas.compiled</filename> that can be used
+by #GSettings. The XML schema files must have the filename extension
+<filename>.gschema</filename>. For a detailed description of the XML
+file format, see the #GSettings documentation.
+</para>
+
+<refsect2><title>Options</title>
+<variablelist>
+
+<varlistentry>
+<term><option>-h</option>, <option>--help</option></term>
+<listitem><para>
+Print help and exit
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>--targetdir=<replaceable>TARGETDIR</replaceable></option></term>
+<listitem><para>
+Store <filename>gschemas.compiled</filename> in <replaceable>TARGETDIR</replaceable> instead of <replaceable>directory</replaceable>.
+</para></listitem>
+</varlistentry>
+</variablelist>
+</refsect2>
+</refsect1>
+</refentry>
+



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]