source: gnome/core/libgnome-keyring.xml@ 4c2be438

<?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 libgnome-keyring-download-http 
           "&gnome-download-http;/libgnome-keyring/3.4/libgnome-keyring-&libgnome-keyring-version;.tar.xz">
  <!ENTITY libgnome-keyring-download-ftp  
           "&gnome-download-ftp;/libgnome-keyring/3.4/libgnome-keyring-&libgnome-keyring-version;.tar.xz">
  <!ENTITY libgnome-keyring-md5sum        "b7c5abd89fd92344b15e7adf3079a54a">
  <!ENTITY libgnome-keyring-size          "408 KB">
  <!ENTITY libgnome-keyring-buildsize     "15 MB">
  <!ENTITY libgnome-keyring-time          "0.5 SBU">
]>

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

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

  <title>libgnome-keyring-&libgnome-keyring-version;</title>

  <indexterm zone="libgnome-keyring">
    <primary sortas="a-libgnome-keyring">libgnome-keyring</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to libgnome-keyring</title>

    <para>The <application>libgnome-keyring</application> package is a program
    that keeps password and other secrets for users. The library libgnome-keyring
    is used by applications to integrate with the gnome keyring system.</para>

    &lfs70_checked;

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

    <bridgehead renderas="sect3">libgnome-keyring Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="dbus"/>,
      <xref linkend="intltool"/>,
      <xref linkend="libgcrypt"/> and
      <xref linkend="pkgconfig"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/> and
      <ulink url="http://www.valgrind.org">Valgrind</ulink>
    </para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of libgnome-keyring</title>

    <para>Install <application>libgnome-keyring</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="commands">
    <title>Command Explanations</title>

<!--    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/gnome-prefix.xml"/> -->

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/gtk-doc-rebuild.xml"/>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          libgnome-keyring.so
        </seg>
        <seg>
          /usr/include/gnome-keyring-1 and
          /usr/share/gtk-doc/html/gnome-keyring
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgnome-keyring-lib">
        <term><filename class='libraryfile'>libgnome-keyring.so</filename></term>
        <listitem>
          <para>is used by applications to integrate with the
          <application>GNOME</application> keyring system.</para>
          <indexterm zone="libgnome-keyring libgnome-keyring-lib">
            <primary sortas="c-libgnome-keyring">libgnome-keyring.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>