source: general/sysutils/pkgconfig.xml@ 919683dc

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY pkgconfig-download-http "http://pkgconfig.freedesktop.org/releases/pkg-config-&pkgconfig-version;.tar.gz">
  <!ENTITY pkgconfig-download-ftp "">
  <!-- <!ENTITY pkgconfig-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/pkgconfig/&pkgconfig-version;/pkgconfig-&pkgconfig-version;.tar.gz"> -->
  <!ENTITY pkgconfig-md5sum "25f106d2cc82a0013f5bdc89875d5790">
  <!ENTITY pkgconfig-size "947 KB">
  <!ENTITY pkgconfig-buildsize "11 MB">
  <!ENTITY pkgconfig-time "0.21 SBU">
]>

<sect1 id="pkgconfig" xreflabel="pkg-config-&pkgconfig-version;">
  <?dbhtml filename="pkgconfig.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Pkg-config-&pkgconfig-version;</title>

  <indexterm zone="pkgconfig">
    <primary sortas="a-Pkgconfig">Pkg-config</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Pkg-config</title>

    <para>The <application>Pkg-config</application> package contains
    tools for passing the include path and/or library paths to build tools during
    the <command>make</command> file execution.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&pkgconfig-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&pkgconfig-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &pkgconfig-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &pkgconfig-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &pkgconfig-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &pkgconfig-time;</para>
      </listitem>
    </itemizedlist>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Pkg-config</title>

    <note>
      <para>Till version 0.18, this package was called
      <application>Pkgconfig</application>.</para>
    </note>

    <para>Install <application>Pkg-config</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <command>make check</command>.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Pkg-config</title>

    <para>The default setting for <envar>PKG_CONFIG_PATH</envar> is
    <filename>/usr/lib/pkgconfig</filename> because of the prefix used to
    install <application>Pkg-config</application>.  You may add to <envar>PKG_CONFIG_PATH</envar> by exporting
    additional paths on your system where <application>pkgconfig</application>
    files are installed. Note that <envar>PKG_CONFIG_PATH</envar> is only needed
    when compiling packages, not during run-time.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>pkg-config</seg>
        <seg>None</seg>
        <seg>None</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="pkg-config">
        <term><command>pkg-config</command></term>
        <listitem>
          <para>is a function that returns meta information for the specified
          library.</para>
          <indexterm zone="pkgconfig pkg-config">
            <primary sortas="b-pkg-config">pkg-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>