From d994c38aba1f564e63058ce615dbb8bb4ae34e36 Mon Sep 17 00:00:00 2001
From: Matthias Clasen <mclasen@redhat.com>
Date: Mon, 23 Jan 2012 00:23:18 -0500
Subject: [PATCH] Add docs for gresource

---
 docs/reference/gio/Makefile.am   |   2 +
 docs/reference/gio/gio-docs.xml  |   1 +
 docs/reference/gio/gresource.xml | 116 +++++++++++++++++++++++++++++++++++++++
 3 files changed, 119 insertions(+)
 create mode 100644 docs/reference/gio/gresource.xml

diff --git a/docs/reference/gio/Makefile.am b/docs/reference/gio/Makefile.am
index 27f3119..535aa26 100644
--- a/docs/reference/gio/Makefile.am
+++ b/docs/reference/gio/Makefile.am
@@ -112,6 +112,7 @@ content_files =			\
 	gio-querymodules.xml	\
 	glib-compile-schemas.xml\
 	gsettings.xml		\
+	gresource.xml		\
 	gdbus.xml		\
 	gdbus-codegen.xml	\
 	$(NULL)
@@ -142,6 +143,7 @@ man_MANS =			\
 	glib-compile-schemas.1	\
 	glib-compile-resources.1	\
 	gsettings.1		\
+	gresource.1		\
 	gdbus.1			\
 	gdbus-codegen.1
 
diff --git a/docs/reference/gio/gio-docs.xml b/docs/reference/gio/gio-docs.xml
index 1987c30..b2397ed 100644
--- a/docs/reference/gio/gio-docs.xml
+++ b/docs/reference/gio/gio-docs.xml
@@ -226,6 +226,7 @@
         <xi:include href="glib-compile-resources.xml"/>
         <xi:include href="gdbus.xml"/>
         <xi:include href="xml/gdbus-codegen.xml"/>
+        <xi:include href="gresource.xml"/>
     </chapter>
   </part>
 
diff --git a/docs/reference/gio/gresource.xml b/docs/reference/gio/gresource.xml
new file mode 100644
index 0000000..c577d26
--- /dev/null
+++ b/docs/reference/gio/gresource.xml
@@ -0,0 +1,116 @@
+<refentry id="gresource-tool" lang="en">
+
+<refmeta>
+  <refentrytitle>gresource</refentrytitle>
+  <manvolnum>1</manvolnum>
+  <refmiscinfo class="manual">User Commands</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+  <refname>gresource</refname>
+  <refpurpose>GResource tool</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+  <cmdsynopsis>
+    <command>gresource</command>
+    <arg choice="opt">--section <replaceable>SECTION</replaceable></arg>
+    <arg choice="plain">list</arg>
+    <arg choice="plain"><replaceable>FILE</replaceable></arg>
+    <arg choice="opt"><replaceable>PATH</replaceable></arg>
+  </cmdsynopsis>
+  <cmdsynopsis>
+    <command>gresource</command>
+    <arg choice="opt">--section SECTION</arg>
+    <arg choice="plain">details</arg>
+    <arg choice="plain"><replaceable>FILE</replaceable></arg>
+    <arg choice="opt"><replaceable>PATH</replaceable></arg>
+  </cmdsynopsis>
+  <cmdsynopsis>
+    <command>gresource</command>
+    <arg choice="opt">--section SECTION</arg>
+    <arg choice="plain">extract</arg>
+    <arg choice="plain"><replaceable>FILE</replaceable></arg>
+    <arg choice="plain"><replaceable>PATH</replaceable></arg>
+  </cmdsynopsis>
+  <cmdsynopsis>
+    <command>gresource</command>
+    <arg choice="plain">sections</arg>
+    <arg choice="plain"><replaceable>FILE</replaceable></arg>
+  </cmdsynopsis>
+  <cmdsynopsis>
+    <command>gresource</command>
+    <arg choice="plain">help</arg>
+    <arg choice="opt"><replaceable>COMMAND</replaceable></arg>
+  </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para><command>gresource</command> offers a simple commandline
+interface to <link linkend="GResource"><type>GResource</type></link>.
+It lets you list and extract resources that have been compiled
+into a resource file or included in an elf file (a binary or a
+shared library).
+</para>
+<para>
+The file to operate on is specified by the <replaceable>FILE</replaceable>
+argument.
+</para>
+<para>
+If an elf file includes multiple sections with resources, it is
+possible to select which one to operate on with the
+<arg choice="plain">--section</arg> option. Use the
+<arg choice="plain">sections</arg> command to find available sections.
+</para>
+
+<refsect2><title>Commands</title>
+<variablelist>
+
+<varlistentry>
+<term><option>list</option></term>
+<listitem><para>
+Lists resources. If <replaceable>SECTION</replaceable> is given, only
+list resourcs in this section. If <replaceable>PATH</replaceable> is
+given, only list matching resources.
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>details</option></term>
+<listitem><para>
+Lists resources with details. If <replaceable>SECTION</replaceable>
+is given, only list resources in this section. If
+<replaceable>PATH</replaceable> is given, only list matching resources.
+Details include the section, size and compression of each resource.
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>extract</option></term>
+<listitem><para>
+Extracts the resource named by <replaceable>PATH</replaceable> to stdout.
+Note that resources may contain binary data.
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>sections</option></term>
+<listitem><para>
+Lists sections containing resources. This is only interesting if
+<replaceable>FILE</replaceable> is an elf file.
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>help</option></term>
+<listitem><para>
+Prints help and exits.
+</para></listitem>
+</varlistentry>
+
+</variablelist>
+</refsect2>
+
+</refsect1>
+</refentry>
+
-- 
2.7.4