source: gnome/core/gcr.xml@ 25639ce3

<?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 gcr-download-http "&gnome-download-http;/gcr/3.4/gcr-&gcr-version;.tar.xz">
  <!ENTITY gcr-download-ftp  "&gnome-download-ftp;/gcr/3.4/gcr-&gcr-version;.tar.xz">
  <!ENTITY gcr-md5sum        "52dd83d8f64654147e720cbd186ee357">
  <!ENTITY gcr-size          "1.3 MB">
  <!ENTITY gcr-buildsize     "83 MB">
  <!ENTITY gcr-time          "0.8 SBU">
]>

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

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

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

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

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

    <para>
      The <application>gcr</application> package contains libraries
      for displaying certificates and accessing key stores. It also
      provides the viewer for crypto files on the GNOME desktop.
    </para>

    &lfs70_checked;

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

    <bridgehead renderas="sect3">gcr Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gtk3"/>,
      <xref linkend="intltool"/>,
      <xref linkend="libgcrypt"/>,
      <xref linkend="libtasn1"/> and
      <xref linkend="p11-kit"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/>
      (Required if building GNOME)
    </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;/gcr"/>
    </para>
  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc \
            --libexecdir=/usr/lib/gnome-keyring \
            --with-pkcs11-modules=/usr/lib/pkcs11 \
            --with-dbus-services=/usr/share/dbus-1/services &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">  -->

    <para>
      <parameter>--with-pkcs11-modules=/usr/lib/pkcs11</parameter>:
      This parameter ensures that <application>p11-kit</application> modules
      are installed in a correct location.
    </para>

    <para>
      <parameter>--with-dbus-services=/usr/share/dbus-1/services</parameter>: 
      This parameter ensures that <application>D-BUS</application> service
      files are installed in a correct location.
    </para>

    <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 Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          gcr-viewer
        </seg>
        <seg>
          libgck-1.so, libgcr-3.so, libgcr-base-3.so and
          libmock-test-module.so
        </seg>
        <seg>
          /usr/include/{gck-1,gcr-3},
          /usr/lib/gnome-keyring,
          /usr/share/gcr-3 and
          /usr/share/gtk-doc/html/{gck,gcr-3}
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gcr-viewer">
        <term><command>gcr-viewer</command></term>
        <listitem>
          <para>
            is used to view certificate and key files.
          </para>
          <indexterm zone="gcr gcr-viewer">
            <primary sortas="b-gcr-viewer">gcr-viewer</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgck-1">
        <term><filename class="libraryfile">libgck-1.so</filename></term>
        <listitem>
          <para>
            contains GObject bindings for PKCS#11.
          </para>
          <indexterm zone="gcr libgck-1">
            <primary sortas="c-libgck-1">libgck-1.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgcr-3">
        <term><filename class="libraryfile">libgcr-3.so</filename></term>
        <listitem>
          <para>
            contains functions for high level crypto parsing.
          </para>
          <indexterm zone="gcr libgcr-3">
            <primary sortas="c-libgcr-3">libgcr-3.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>