Add a man page for gio-querymodules
authorMatthias Clasen <mclasen@redhat.com>
Sun, 18 Apr 2010 19:54:54 +0000 (15:54 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Sun, 18 Apr 2010 19:54:54 +0000 (15:54 -0400)
docs/reference/gio/Makefile.am
docs/reference/gio/gio-docs.xml
docs/reference/gio/gio-querymodules.xml [new file with mode: 0644]

index 456aa81..83f5676 100644 (file)
@@ -115,12 +115,14 @@ content_files =                   \
        version.xml             \
        overview.xml            \
        migrating.xml           \
+       gio-querymodules.xml    \
        gschema-compile.xml     \
        gsettings-schema-convert.xml
 
 expand_content_files =         \
        overview.xml            \
        migrating.xml           \
+       gio-querymodules.xml    \
        gschema-compile.xml     \
        gsettings-schema-convert.xml
 
@@ -136,6 +138,7 @@ EXTRA_DIST +=                       \
 if ENABLE_MAN
 
 man_MANS =                     \
+       gio-querymodules.1      \
        gschema-compile.1       \
        gsettings-schema-convert.1
 
index c20be29..8394cf1 100644 (file)
     </chapter>
     <chapter id="tools">
         <title>GIO Tools</title>
+        <xi:include href="xml/gio-querymodules.xml"/>
         <xi:include href="xml/gschema-compile.xml"/>
         <xi:include href="xml/gsettings-schema-convert.xml"/>
     </chapter>
     <title>Index of new symbols in 2.24</title>
     <xi:include href="xml/api-index-2.24.xml"><xi:fallback /></xi:include>
   </index>
+  <index id="api-index-2-26" role="2.26">
+    <title>Index of new symbols in 2.26</title>
+    <xi:include href="xml/api-index-2.26.xml"><xi:fallback /></xi:include>
+  </index>
 </book>
diff --git a/docs/reference/gio/gio-querymodules.xml b/docs/reference/gio/gio-querymodules.xml
new file mode 100644 (file)
index 0000000..7fecd3e
--- /dev/null
@@ -0,0 +1,33 @@
+<refentry id="gio-querymodules" lang="en">
+
+<refmeta>
+  <refentrytitle>gio-querymodules</refentrytitle>
+  <manvolnum>1</manvolnum>
+  <refmiscinfo class="manual">User Commands</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+  <refname>gio-querymodules</refname>
+  <refpurpose>GIO module cache creation</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+  <cmdsynopsis>
+    <command>gio-querymodules</command>
+    <arg choice="req" rep="repeat">directory</arg>
+  </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para><command>gio-querymodules</command> creates a
+<filename>giomodule.cache</filename> file in the listed directories.
+This file lists the implemented extension points for each module
+that has been found. It is used by GIO at runtime to avoid opening
+all modules just to find out which extension points they are implementing.
+</para>
+<para>
+GIO modules are usually installed in the <filename>gio/modules</filename>
+subdirectory of libdir.
+</para>
+</refsect1>
+</refentry>