source: gnome/platform/gcr4.xml

<?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 gcr4-download-http "&gnome-download-http;/gcr/&gcr4-minor;/gcr-&gcr4-version;.tar.xz">
  <!ENTITY gcr4-download-ftp  " ">
  <!ENTITY gcr4-md5sum        "51ae0448c7c42caf0b7deb2639c9e9b8">
  <!ENTITY gcr4-size          "712 KB">
  <!ENTITY gcr4-buildsize     "30 MB (with tests)">
  <!ENTITY gcr4-time          "0.1 SBU (with tests; both using parallelism=4)">
]>

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


  <title>Gcr-&gcr4-version;</title>

  <indexterm zone="gcr4">
    <primary sortas="a-Gcr">Gcr</primary>
  </indexterm>

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

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

    &lfs121_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="glib2"/> (GObject Introspection recommended),
      <xref linkend="libgcrypt"/>, and
      <xref linkend="p11-kit"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gnupg2"/>,
      <xref linkend="gtk4"/>,
      <xref linkend="libsecret"/>,
      <xref linkend="libxslt"/>,
      <xref linkend="openssh"/>, and
      <xref linkend="vala"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gi-docgen"/>,
      <xref linkend="gnutls"/>, and
      <xref linkend="valgrind"/>
    </para>

  </sect2>

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

    <note>
      <para>Both gcr-3 and gcr-4 are coinstallable. This version of the package is
      used to support GTK-4 applications, such as
      <xref linkend="gnome-shell" role="nodep"/> and
      <xref linkend="epiphany" role="nodep"/>.</para>
    </note>

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

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dgtk_doc=false     \
            ..                  &amp;&amp;
ninja</userinput></screen>

    <para>
      If you have <xref linkend='gi-docgen'/> installed and wish to build
      the API documentation for this package, issue:
    </para>

<screen remap='doc'><userinput>sed -e "/install_dir/s@,\$@ / 'gcr-&gcr4-version;'&amp;@" \
    -i ../docs/*/meson.build                 &amp;&amp;
meson configure -Dgtk_doc=true               &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>.
      The tests must be run from an X Terminal or similar.
    </para>

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

<screen role="root"><userinput>ninja install</userinput></screen>
  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/meson-buildtype-release.xml"/>

    <para>
      <option>-Dgtk4=false</option>: Use this switch if you
      haven't installed <xref linkend="gtk4"/>. Note that
      <application>gcr-viewer</application> will not be installed
      if this is passed to meson.
    </para>

    <para>
      <option>-Dssh_agent=false</option>: Use this switch if you
      haven't installed <xref linkend="openssh"/>, and wish to disable
      ssh compatibility.
    </para>

    <para>
      <option>-Dgtk_doc=true</option>: &gi-doc-disable;
    </para>

    <para>
      <option>-Dcrypto=gnutls</option>: Use this switch if you have
      <xref linkend="gnutls" role="nodep"/> installed and wish to use it
      instead of <xref linkend="libgcrypt" role="nodep"/>.
    </para>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          gcr-viewer-gtk4
        </seg>
        <seg>
          libgck-2.so, libgcr-4.so
        </seg>
        <seg>
          /usr/include/gck-2,
          /usr/include/gcr-4, and
          /usr/share/gtk-doc/html/{gcr,gck}
        </seg>
      </seglistitem>
    </segmentedlist>

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

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

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

      <varlistentry id="libgcr-4">
        <term><filename class="libraryfile">libgcr-4.so</filename></term>
        <listitem>
          <para>
            contains functions for accessing key stores and displaying
            certificates
          </para>
          <indexterm zone="gcr4 libgcr-4">
            <primary sortas="c-libgcr-4">libgcr-4.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>