source: final-system/x86/linux-libc-headers.xml@ 2ed9444

<?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;
]>

<sect1 id="ch-system-linux-libc-headers" role="wrap">
  <?dbhtml filename="linux-libc-headers.html"?>

  <title>Linux-Libc-Headers-&linux-libc-headers-version;</title>

  <indexterm zone="ch-system-linux-libc-headers">
    <primary sortas="a-Linux-Libc-Headers">Linux-Libc-Headers</primary>
  </indexterm>

  <sect2 role="package">
    <title/>

    <para>The Linux-Libc-Headers package contains the
    <quote>sanitized</quote> kernel headers.</para>

    <segmentedlist>
      <segtitle>&dependencies;</segtitle>

      <seglistitem>
        <seg>Coreutils and Findutils</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Linux-Libc-Headers</title>

    <para os="a">For years it has been common practice to use <quote>raw</quote>
    kernel headers (straight from a kernel tarball) in <filename
    class="directory">/usr/include</filename>, but over the last few
    years, the kernel developers have taken a strong stance that this
    should not be done. This gave birth to the Linux-Libc-Headers Project,
    which was designed to maintain an API stable version of the Linux
    headers.</para>

    <para os="b">Install the header files:</para>

<screen><userinput>install -dv /usr/include/{asm,linux,mtd,scsi}
cp -arv include/asm-i386/* /usr/include/asm
cp -arv include/linux/* /usr/include/linux
cp -arv include/mtd/* /usr/include/mtd
cp -arv include/scsi/* /usr/include/scsi</userinput></screen>

    <para os="c">Ensure that all the headers are owned by
    <systemitem class="username">root</systemitem>:</para>

<screen os="d"><userinput>chown -R root:root /usr/include/{asm,linux,mtd,scsi}</userinput></screen>

    <para os="e">Make sure the users can read the headers:</para>

<screen os="f"><userinput>find /usr/include/{asm,linux,mtd,scsi} -type d -exec chmod 755 {} \;
find /usr/include/{asm,linux,mtd,scsi} -type f -exec chmod 644 {} \;</userinput></screen>

  </sect2>

  <sect2 id="contents-linux-libc-headers" role="content">
    <title>Contents of Linux-Libc-Headers</title>

    <segmentedlist>
      <segtitle>Installed headers</segtitle>

      <seglistitem>
        <seg>/usr/include/{asm,linux}/*.h</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="linux-libc-headers">
        <term><filename
        class="headerfile">/usr/include/{asm,linux}/*.h</filename></term>
        <listitem>
          <para>The Linux API headers</para>
          <indexterm zone="ch-system-linux-libc-headers linux-libc-headers">
            <primary
            sortas="e-/usr/include/{asm,linux}/*.h">/usr/include/{asm,linux}/*.h</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>