source: gnome/platform/libsecret.xml@ 0945dd2d

<?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 libsecret-download-http "&gnome-download-http;/libsecret/0.20/libsecret-&libsecret-version;.tar.xz">
  <!ENTITY libsecret-download-ftp  "&gnome-download-ftp;/libsecret/0.20/libsecret-&libsecret-version;.tar.xz">
  <!ENTITY libsecret-md5sum        "5c9e5a011852c82fa9ed9e61ba91efb5">
  <!ENTITY libsecret-size          "184 KB">
  <!ENTITY libsecret-buildsize     "11 MB (with tests)">
  <!ENTITY libsecret-time          "0.3 SBU (with tests)">
]>

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


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

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

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

    <para>
      The <application>libsecret</application> package contains a
      GObject based library for accessing the Secret Service API.
    </para>

    &lfs113_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="glib2"/>
    </para>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gi-docgen"/> and
      <xref linkend="DocBook"/>,
      <xref linkend="docbook-xsl"/>,
      <xref linkend="libxslt"/> (to build manual pages), and
      <xref linkend="valgrind"/> (can be used in tests)
    </para>

    <bridgehead renderas="sect4">Optional (Required for the test suite)</bridgehead>
    <para role="optional">
      <xref linkend="dbus-python"/>,
      <xref linkend="gjs"/>,
      <xref linkend="pygobject3"/> (Python 3 module), and
      <ulink url="https://github.com/tpm2-software/tpm2-tss">tpm2-tss</ulink>
      <!-- Historically libsecret used to require Python2, but it has been
      fully ported to Python3. -->
    </para>

    <bridgehead renderas="sect4">Runtime Dependency</bridgehead>
    <para role="required">
      <xref role="runtime" linkend="gnome-keyring"/>
    </para>

    <note>
      <para>
        Any package requiring <application>libsecret</application>
        expects <application>GNOME Keyring</application> to be
        present at runtime.
      </para>
    </note>

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

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

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

<screen><userinput>mkdir bld &amp;&amp;
cd bld &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 role='nodump'><userinput>sed "s/api_version_major/'0.20.5'/"            \
    -i ../docs/reference/libsecret/meson.build &amp;&amp;
meson configure -Dgtk_doc=true                 &amp;&amp;
ninja</userinput></screen>

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

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

    <para>
      To test the results, issue: <command>dbus-run-session ninja test</command>.
    </para>

    <para>
      If gi-docgen is installed and the <option>-Dgtk_doc=false</option>
      has been removed, as the &root; user, issue the following command to
      fix the name of the installed documentation directory:
    </para>

<screen role="nodump"><userinput>mv -v /usr/share/doc/libsecret-{1,&libsecret-version;}</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>
      <parameter>-Dgtk_doc=false</parameter>: &gi-doc-disable;
    </para>

    <para>
      <option>-Dmanpage=false</option>: Use this switch if you
      have not installed <xref linkend="libxslt"/> and DocBook
      packages.
    </para>

    <para>
      <option>-Dgcrypt=false</option>: Use this switch if you have
      not installed the recommended dependency of
      <xref linkend="libgcrypt"/>.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          secret-tool
        </seg>
        <seg>
          libsecret-1.so
        </seg>
        <seg>
          /usr/include/libsecret-1 and
          /usr/share/doc/libsecret-&libsecret-version;
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="secret-tool">
        <term><command>secret-tool</command></term>
        <listitem>
          <para>
            is a command line tool that can be used to store
            and retrieve passwords
          </para>
          <indexterm zone="libsecret secret-tool">
            <primary sortas="b-secret-tool">secret-tool</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libsecret-1">
        <term><filename class="libraryfile">libsecret-1.so</filename></term>
        <listitem>
          <para>
            contains the <application>libsecret</application> API functions
          </para>
          <indexterm zone="libsecret libsecret-1">
            <primary sortas="c-libsecret-1">libsecret-1.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>