]> Pileus Git - ~andy/gtk/blob - docs/reference/gdk-pixbuf/compiling.sgml
0.8 - Federico
[~andy/gtk] / docs / reference / gdk-pixbuf / compiling.sgml
1   <appendix id="compiling">
2     <title>Compiling the <application>gdk-pixbuf</application>
3     library</title>
4
5     <para>
6       This appendix describes the special options you can use while
7       compiling the <application>gdk-pixbuf</application> library.
8     </para>
9
10     <sect1 id="building">
11       <title>Building the Library</title>
12       <para>
13         The <application>gdk-pixbuf</application> library uses the
14         standard GNU build system, using
15         <application>autoconf</application> for package configuration
16         and resolving portability issues,
17         <application>automake</application> for building makefiles
18         that comply with the GNU Coding Standards, and
19         <application>libtool</application> for building shared
20         libraries on multiple platforms.  The normal sequence for
21         compiling and installing the
22         <application>gdk-pixbuf</application> library is thus:
23
24         <literallayout>
25           <userinput>./configure</userinput>
26           <userinput>make</userinput>
27           <userinput>make install</userinput>
28         </literallayout>
29       </para>
30
31       <para>
32         The standard options provided by <application>GNU
33         autoconf</application> may be passed to the
34         <command>configure</command> script.  Please see the
35         <application>autoconf</application> documentation or run
36         <command>./configure --help</command> for information about
37         the standard options.
38       </para>
39     </sect1>
40
41     <sect1 id="extra-configuration-options">
42       <title>Extra Configuration Options</title>
43
44       <para>
45         In addition to the normal options, the
46         <command>configure</command> script in the
47         <application>gdk-pixbuf</application> library supports these
48         additional arguments:
49
50         <cmdsynopsis>
51           <command>configure</command>
52
53           <group>
54             <arg>--disable-modules</arg>
55             <arg>--enable-modules</arg>
56           </group>
57
58           <group>
59             <arg>--disable-gtk-doc</arg>
60             <arg>--enable-gtk-doc</arg>
61           </group>
62         </cmdsynopsis>
63       </para>
64
65       <formalpara>
66         <title><systemitem>--disable-modules</systemitem> and
67           <systemitem>--enable-modules</systemitem></title>
68
69         <para>
70           Normally <application>gdk-pixbuf</application> will try to
71           build the image file format loaders as little shared
72           libraries that are loaded on demand.  The
73           <systemitem>--disable-modules</systemitem> argument
74           indicates that they should all be built statically into the
75           <application>gdk-pixbuf</application> library instead.  This
76           is useful for people who need to produce statically-linked
77           binaries.  If neither
78           <systemitem>--disable-modules</systemitem> nor
79           <systemitem>--enable-modules</systemitem> is specified, then
80           the <command>configure</command> script will try to
81           auto-detect whether shared modules work on your system.
82         </para>
83       </formalpara>
84
85       <formalpara>
86         <title><systemitem>--disable-gtk-doc</systemitem> and
87           <systemitem>--enable-gtk-doc</systemitem></title>
88
89         <para>
90           By default the <command>configure</command> script will try
91           to auto-detect whether the
92           <application>gtk-doc</application> package is installed.  If
93           it is, then it will use it to extract and build the
94           documentation for the <application>gdk-pixbuf</application>
95           library.  These options can be used to explicitly control
96           whether gtk-doc should be used or not.  If it is not used,
97           the distributed, pre-generated HTML files will be installed
98           instead of building them on your machine.
99         </para>
100       </formalpara>
101     </sect1>
102   </appendix>
103
104 <!--
105 Local variables:
106 mode: sgml
107 sgml-parent-document: ("gdk-pixbuf.sgml" "book" "book" "")
108 End:
109 -->