source: general/prog/pkgconfig.xml@ 0c83219

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/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-md5sum        "5392b4e3372879c5bf856173b418d6a2">
  <!ENTITY pkgconfig-size          "1.8 MB">
  <!ENTITY pkgconfig-buildsize     "28 MB">
  <!ENTITY pkgconfig-time          "0.3 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-pkg-config">pkg-config</primary>
  </indexterm>

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

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

    &lfs72_checked;

    <note>
      <para>
        Pkg-config is part of LFS, but was omitted from  the 7.0 and 7.1
        releases. If you are using a system which includes it, there is
        nothing more to do. If not, you should follow these instructions.
      </para>
    </note>

    <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>

    <para condition="html" role="usernotes">User Notes:
      <ulink url="&blfs-wiki;/pkgconfig"/>
    </para>
  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr \
            --docdir=/usr/share/doc/pkg-config-&pkgconfig-version; \
            --with-internal-glib &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="commands">
    <title>Command Explanations</title>

    <para>
      <option>--with-internal-glib</option>: This switch causes
      the package to use the shipped version of GLib2.
    </para>

  </sect2>

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

    <para>
      The default setting for <envar>PKG_CONFIG_PATH</envar> is <filename
      class="directory">/usr/lib/pkgconfig:/usr/share/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 <filename class="extension">.pc</filename> 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>

      <seglistitem>
        <seg>
          pkg-config
        </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>
            returns meta information for the specified library or
            package.
          </para>
          <indexterm zone="pkgconfig pkg-config">
            <primary sortas="b-pkg-config">pkg-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>