source: gnome/platform/gnome-keyring.xml@ 41a882a

<?xml version="1.0" encoding="UTF-8"?>
<!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 gnome-keyring-download-http
           "&gnome-download-http;/gnome-keyring/&gnome-46;/gnome-keyring-&gnome-keyring-version;.tar.xz">
  <!ENTITY gnome-keyring-download-ftp  " ">
  <!ENTITY gnome-keyring-md5sum        "7a8ab16a87f03ca05fc176925fcce649">
  <!ENTITY gnome-keyring-size          "1.3 MB">
  <!ENTITY gnome-keyring-buildsize     "129 MB">
  <!ENTITY gnome-keyring-time          "0.2 SBU (Using parallelism=4; add 0.2 SBU for tests)">
]>

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


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

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

  <sect2 role="package">
    <title>Introduction to GNOME Keyring</title>

    <para>
      The <application>GNOME Keyring</application> package contains a
      daemon that keeps passwords and other secrets for users.
    </para>

    &lfs122_checked;

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

    <bridgehead renderas="sect3">GNOME Keyring Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="dbus"/> and
      <xref linkend="gcr"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="linux-pam"/>,
      <xref linkend="libxslt"/>, and
      <xref linkend="openssh"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gnupg2"/>,
      <xref linkend="valgrind"/>,
      <ulink url="https://github.com/linux-test-project/lcov">LCOV</ulink>, and
      <ulink url="https://people.redhat.com/sgrubb/libcap-ng/">libcap-ng</ulink>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of GNOME Keyring</title>

<!--
    <para>
      Regenerate the <command>configure</command> script to make it work
      with libgcrypt-1.11 or newer:
    </para>

<screen><userinput>autoreconf</userinput></screen>
-->

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

<screen><userinput>sed -i 's:"/desktop:"/org:' schema/*.xml &amp;&amp;

./configure --prefix=/usr      \
            --sysconfdir=/etc  \
            --enable-ssh-agent &amp;&amp;
make</userinput></screen>

    <para>
      A session bus address is necessary to run the tests. 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>
      <command>sed ... schema/*.xml</command>:  This command fixes a
      deprecated entry in the schema template.
    </para>

    <para>
      <parameter>--enable-ssh-agent</parameter>: This switch enables the SSH
      agent built in to gnome-keyring instead of the one in GCR. This is done
      due to bugs in gcr which cause the agent to not work correctly.
      <!--https://bugzilla.redhat.com/show_bug.cgi?id=2250704-->
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          gnome-keyring (symlink), gnome-keyring-3, and gnome-keyring-daemon
        </seg>
        <seg>
          gnome-keyring-pkcs11.so (PKCS#11 module) and
          pam_gnome_keyring.so (PAM module)
        </seg>
        <seg>
          /usr/lib/gnome-keyring and
          /usr/share/xdg-desktop-portal
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gnome-keyring-daemon">
        <term><command>gnome-keyring-daemon</command></term>
        <listitem>
          <para>
            is a session daemon that keeps passwords for users
          </para>
          <indexterm zone="gnome-keyring gnome-keyring-daemon">
            <primary sortas="b-gnome-keyring-daemon">gnome-keyring-daemon</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>