source: general/genlib/keyutils.xml@ dcdde93

<?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 keyutils-download-http "http://people.redhat.com/~dhowells/keyutils/keyutils-&keyutils-version;.tar.bz2">
  <!ENTITY keyutils-download-ftp  " ">
  <!ENTITY keyutils-md5sum        "d759680b2f23c99af95938f5026f25fb">
  <!ENTITY keyutils-size          "68 KB">
  <!ENTITY keyutils-buildsize     "1.9 MB">
  <!ENTITY keyutils-time          "less than 0.1 SBU">
]>

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

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

  <title>keyutils-&keyutils-version;</title>

  <indexterm zone="keyutils">
    <primary sortas="a-keyutils">keyutils</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to keyutils</title>

    <para>Keyutils is a set of utilities for managing the key retention
    facility in the kernel, which can be used by filesystems, block devices and
    more to gain and retain the authorization and encryption keys required to
    perform secure operations.</para>

    &lfs72_checked;

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

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of keyutils</title>

    <para>Install <application>keyutils</application> by running the following
    commands:</para>

<screen><userinput>make</userinput></screen>

    <para>This package does not come with a test suite.</para>

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

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

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>keyctl, key.dns_resolver, and request-key</seg>
        <seg>libkeyutils.so.1</seg>
        <seg>/usr/share/keyutils</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="keyctl">
        <term><command>keyctl</command></term>
        <listitem>
          <para>is to control the key management facility in various ways
          using a variety of subcommands.</para>
          <indexterm zone="keyutils keyctl">
            <primary sortas="b-keyctl">keyctl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libkeyutils">
        <term><filename class='libraryfile'>libkeyutils.so.1</filename></term>
        <listitem>
          <para> contains the keyuils library API instantiation.</para>
          <indexterm zone="keyutils libkeyutils">
            <primary sortas="c-libkeyutils">libkeyutils.so.1</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>