summaryrefslogtreecommitdiff
path: root/docs/gdk-pixbuf-query-loaders.xml
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gnome.org>2018-04-29 00:57:56 +0100
committerEmmanuele Bassi <ebassi@gnome.org>2018-04-30 18:11:40 +0100
commitb4acb66c1e026fc3cd8a6d1ac961f68fb6fb91e2 (patch)
tree1cadc17d7fe907fa64b3cbeb8789381d485fe386 /docs/gdk-pixbuf-query-loaders.xml
parente35589112a46c386e8fc919ebd3d6ca0f12bc4e0 (diff)
downloadgdk-pixbuf-b4acb66c1e026fc3cd8a6d1ac961f68fb6fb91e2.tar.gz
Move the API reference down two levels
The `docs` directory is empty, and gdk-pixbuf is not part of GTK any more, so there's no point to have the API reference under a separate directory.
Diffstat (limited to 'docs/gdk-pixbuf-query-loaders.xml')
-rw-r--r--docs/gdk-pixbuf-query-loaders.xml79
1 files changed, 79 insertions, 0 deletions
diff --git a/docs/gdk-pixbuf-query-loaders.xml b/docs/gdk-pixbuf-query-loaders.xml
new file mode 100644
index 000000000..9aecd9613
--- /dev/null
+++ b/docs/gdk-pixbuf-query-loaders.xml
@@ -0,0 +1,79 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+]>
+<refentry id="gdk-pixbuf-query-loaders">
+
+<refentryinfo>
+<title>gdk-pixbuf-query-loaders</title>
+<productname>gdk-pixbuf</productname>
+<authorgroup>
+<author>
+<contrib>Developer</contrib>
+<firstname>Owen</firstname>
+<surname>Taylor</surname>
+</author>
+</authorgroup>
+</refentryinfo>
+
+<refmeta>
+<refentrytitle>gdk-pixbuf-query-loaders</refentrytitle>
+<manvolnum>1</manvolnum>
+<refmiscinfo class="manual">User Commands</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+<refname>gdk-pixbuf-query-loaders</refname>
+<refpurpose>GdkPixbuf loader registration utility</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>gdk-pixbuf-query-loaders</command>
+<arg choice="opt">--update-cache</arg>
+<arg choice="opt" rep="repeat">MODULE</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+<command>gdk-pixbuf-query-loaders</command> collects information about
+loadable modules for <application>gdk-pixbuf</application> and writes it to
+the default cache file location, or to <filename>stdout</filename>.
+</para>
+<para>
+If called without arguments, it looks for modules in the
+<application>gdk-pixbuf</application> loader directory.
+</para>
+<para>
+If called with arguments, it looks for the specified modules. The arguments
+may be absolute or relative paths.
+</para>
+<para>
+Normally, the output of <command>gdk-pixbuf-queryloaders</command> is written
+to <filename><replaceable>libdir</replaceable>/gdk-pixbuf-2.0/2.10.0/loaders.cache</filename>, where <application>gdk-pixbuf</application> looks for it by default. If it is written to some other
+location, the environment variable <envar>GDK_PIXBUF_MODULE_FILE</envar>
+can be set to point <application>gdk-pixbuf</application> at the file.
+</para>
+</refsect1>
+
+<refsect1><title>Options</title>
+<variablelist>
+ <varlistentry>
+ <term>--update-cache</term>
+ <listitem><para>Write the output to the default cache location instead of
+ <filename>stdout</filename></para></listitem>
+ </varlistentry>
+</variablelist>
+</refsect1>
+
+<refsect1><title>Environment</title>
+<para>
+The environment variable <envar>GDK_PIXBUF_MODULEDIR</envar> can be used
+to specify a different loader directory. The default
+<application>gdk-pixbuf</application> loader
+directory is <filename><replaceable>libdir</replaceable>/gdk-pixbuf-2.0/<replaceable>version</replaceable>/loaders</filename>.
+</para>
+</refsect1>
+
+</refentry>