Initialize the gmime for upstream
[platform/upstream/gmime.git] / docs / reference / compiling.sgml
1 <refentry id="gmime-compiling" revision="23 May 2008">
2 <refmeta>
3 <refentrytitle>Compiling GMime Applications</refentrytitle>
4 <manvolnum>3</manvolnum>
5 <refmiscinfo>GMime Library</refmiscinfo>
6 </refmeta>
7
8 <refnamediv>
9 <refname>Compiling GMime Applications</refname>
10 <refpurpose>
11 How to compile your GMime application
12 </refpurpose>
13 </refnamediv>
14
15 <refsect1>
16 <title>Compiling GMime Applications on UNIX</title>
17
18 <para>
19 To compile a GMime application, you need to tell the compiler where to 
20 find the GMime header files and libraries. This is done with the
21 <literal>pkg-config</literal> utility.
22 </para>
23 <para>
24 The following interactive shell session demonstrates how
25 <literal>pkg-config</literal> is used:
26 <programlisting>
27 $ pkg-config --cflags gmime-2.4
28  -I/usr/include/gmime-2.4 -I/usr/include/glib-2.0 -I/usr/lib/glib-2.0/include 
29 $ pkg-config --libs gmime-2.4
30  -L/opt/gnome2/lib -lgmime-2.4 -lnsl -lgobject-2.0 -lglib-2.0
31 </programlisting>
32 </para>
33 <para>
34 The simplest way to compile a program is to use the "backticks"
35 feature of the shell. If you enclose a command in backticks
36 (<emphasis>not single quotes</emphasis>), then its output will be
37 substituted into the command line before execution. So to compile 
38 a GTK+ Hello, World, you would type the following:
39 <programlisting>
40 $ cc `pkg-config --cflags --libs gmime-2.4` hello.c -o hello
41 </programlisting>
42 </para>
43
44 </refsect1>
45
46 </refentry>