summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFederico Mena Quintero <federico@src.gnome.org>2000-02-22 00:29:00 +0000
committerFederico Mena Quintero <federico@src.gnome.org>2000-02-22 00:29:00 +0000
commit79d63460579c8e867b8709154649c77fc388aded (patch)
tree5d4188dd450b238d0f7f796dd274f0bf6b084406 /docs
parent7ef740e03d628d46772f5ea7e05d4b7797a1986d (diff)
downloadgtk+-79d63460579c8e867b8709154649c77fc388aded.tar.gz
0.6.0 - FedericoGDK_PIXBUF_0_6_0
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/gdk-pixbuf/Makefile.am9
-rw-r--r--docs/reference/gdk-pixbuf/compiling.sgml103
-rw-r--r--docs/reference/gdk-pixbuf/gdk-pixbuf.sgml3
3 files changed, 113 insertions, 2 deletions
diff --git a/docs/reference/gdk-pixbuf/Makefile.am b/docs/reference/gdk-pixbuf/Makefile.am
index eef777148e..d9d18350c7 100644
--- a/docs/reference/gdk-pixbuf/Makefile.am
+++ b/docs/reference/gdk-pixbuf/Makefile.am
@@ -38,7 +38,12 @@ gdk_pixbuf_doc_DATA = \
gdk-pixbuf-decl.txt \
gdk-pixbuf-sections.txt
-EXTRA_DIST = $(gdk_pixbuf_doc_DATA)
+content_files = \
+ compiling.sgml
+
+EXTRA_DIST = \
+ $(gdk_pixbuf_doc_DATA) \
+ $(content_files)
if ENABLE_GTK_DOC
gdk-pixbuf.html: html/book1.html
@@ -47,7 +52,7 @@ else
gdk-pixbuf.html:
endif
-html/book1.html: sgml/gdk-pixbuf-doc.bottom
+html/book1.html: sgml/gdk-pixbuf-doc.bottom $(content_files)
$(MAKE) html
sgml/gdk-pixbuf-doc.bottom: $(tmpl_sources)
diff --git a/docs/reference/gdk-pixbuf/compiling.sgml b/docs/reference/gdk-pixbuf/compiling.sgml
new file mode 100644
index 0000000000..5bc123fef6
--- /dev/null
+++ b/docs/reference/gdk-pixbuf/compiling.sgml
@@ -0,0 +1,103 @@
+ <appendix id="compiling">
+ <title>Compiling the gdk-pixbuf library</title>
+
+ <para>
+ This appendix describes the special options you can use while
+ compiling the gdk-pixbuf library.
+ </para>
+
+ <sect1 id="building">
+ <title>Building the Library</title>
+ <para>
+ The gdk-pixbuf library uses the standard GNU build system,
+ using <productname>autoconf</productname> for package
+ configuration and resolving portability issues,
+ <productname>automake</productname> for building makefiles
+ that comply with the GNU Coding Standards, and
+ <productname>libtool</productname> for building shared
+ libraries on multiple platforms. The normal sequence for
+ compiling and installing the gdk-pixbuf library is thus:
+
+ <literallayout>
+ <userinput>./configure</userinput>
+ <userinput>make</userinput>
+ <userinput>make install</userinput>
+ </literallayout>
+ </para>
+
+ <para>
+ The standard options provided by <productname>GNU
+ autoconf</productname> may be passed to the
+ <command>configure</command> script. Please see the
+ <productname>autoconf</productname> documentation or run
+ <command>./configure --help</command> for information about
+ the standard options.
+ </para>
+ </sect1>
+
+ <sect1 id="extra-configuration-options">
+ <title>Extra Configuration Options</title>
+
+ <para>
+ In addition to the normal options, the
+ <command>configure</command> script in the gdk-pixbuf library
+ supports these additional arguments:
+
+ <cmdsynopsis>
+ <command>configure</command>
+
+ <group>
+ <arg>--disable-modules</arg>
+ <arg>--enable-modules</arg>
+ </group>
+
+ <group>
+ <arg>--disable-gtk-doc</arg>
+ <arg>--enable-gtk-doc</arg>
+ </group>
+ </cmdsynopsis>
+ </para>
+
+ <formalpara>
+ <title><systemitem>--disable-modules</systemitem> and
+ <systemitem>--enable-modules</systemitem></title>
+
+ <para>
+ Normally gdk-pixbuf will try to build the image file format
+ loaders as little shared libraries that are loaded on
+ demand. The <systemitem>--disable-modules</systemitem>
+ argument indicates that they should all be built statically
+ into the gdk-pixbuf library instead. This is useful for
+ people who need to produce statically-linked binaries. If
+ neither <systemitem>--disable-modules</systemitem> nor
+ <systemitem>--enable-modules</systemitem> is specified, then
+ the <command>configure</command> script will try to
+ auto-detect whether shared modules work on your system.
+ </para>
+ </formalpara>
+
+ <formalpara>
+ <title><systemitem>--disable-gtk-doc</systemitem> and
+ <systemitem>--enable-gtk-doc</systemitem></title>
+
+ <para>
+ By default the <command>configure</command> script will try
+ to auto-detect whether the
+ <productname>gtk-doc</productname> package is installed. If
+ it is, then it will use it to extract and build the
+ documentation for the gdk-pixbuf library. These options can
+ be used to explicitly control whether gtk-doc should be used
+ or not. If it is not used, the distributed, pre-generated
+ HTML files will be installed instead of building them on
+ your machine.
+ </para>
+ </formalpara>
+ </sect1>
+ </appendix>
+
+<!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("gdk-pixbuf.sgml" "book" "book" "")
+End:
+-->
diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf.sgml b/docs/reference/gdk-pixbuf/gdk-pixbuf.sgml
index 410a2cc3e7..900f4edb5a 100644
--- a/docs/reference/gdk-pixbuf/gdk-pixbuf.sgml
+++ b/docs/reference/gdk-pixbuf/gdk-pixbuf.sgml
@@ -10,6 +10,7 @@
<!entity gdk-pixbuf-animation SYSTEM "sgml/animation.sgml">
<!entity GdkPixbufLoader SYSTEM "sgml/gdk-pixbuf-loader.sgml">
<!entity GnomeCanvasPixbuf SYSTEM "sgml/gnome-canvas-pixbuf.sgml">
+<!entity Compiling SYSTEM "compiling.sgml">
]>
<book>
@@ -57,4 +58,6 @@
&GdkPixbufLoader;
&GnomeCanvasPixbuf;
</reference>
+
+ &Compiling;
</book>