[dabe4b0] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[43dc7d3] | 7 | <!ENTITY libsecret-download-http "&gnome-download-http;/libsecret/0.20/libsecret-&libsecret-version;.tar.xz">
|
---|
| 8 | <!ENTITY libsecret-download-ftp "&gnome-download-ftp;/libsecret/0.20/libsecret-&libsecret-version;.tar.xz">
|
---|
[f17355f] | 9 | <!ENTITY libsecret-md5sum "bf92f48afab2891f644f311e0f37683f">
|
---|
| 10 | <!ENTITY libsecret-size "520 KB">
|
---|
[2e6472e6] | 11 | <!ENTITY libsecret-buildsize "14 MB (with tests)">
|
---|
[f8359b8] | 12 | <!ENTITY libsecret-time "0.2 SBU (with tests)">
|
---|
[dabe4b0] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="libsecret" xreflabel="libsecret-&libsecret-version;">
|
---|
| 16 | <?dbhtml filename="libsecret.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>libsecret-&libsecret-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="libsecret">
|
---|
| 26 | <primary sortas="a-libsecret">libsecret</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to libsecret</title>
|
---|
| 31 |
|
---|
| 32 | <para>
|
---|
| 33 | The <application>libsecret</application> package contains a
|
---|
| 34 | GObject based library for accessing the Secret Service API.
|
---|
| 35 | </para>
|
---|
| 36 |
|
---|
[2b7420b] | 37 | &lfs101_checked;
|
---|
[dabe4b0] | 38 |
|
---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&libsecret-download-http;"/>
|
---|
| 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&libsecret-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download MD5 sum: &libsecret-md5sum;
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Download size: &libsecret-size;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Estimated disk space required: &libsecret-buildsize;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>
|
---|
| 68 | Estimated build time: &libsecret-time;
|
---|
| 69 | </para>
|
---|
| 70 | </listitem>
|
---|
| 71 | </itemizedlist>
|
---|
| 72 |
|
---|
| 73 | <bridgehead renderas="sect3">libsecret Dependencies</bridgehead>
|
---|
| 74 |
|
---|
| 75 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 76 | <para role="required">
|
---|
| 77 | <xref linkend="glib2"/>
|
---|
| 78 | </para>
|
---|
| 79 |
|
---|
| 80 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 81 | <para role="recommended">
|
---|
| 82 | <xref linkend="gobject-introspection"/>,
|
---|
[ee835cc] | 83 | <xref linkend="libgcrypt"/>, and
|
---|
[dabe4b0] | 84 | <xref linkend="vala"/>
|
---|
| 85 | </para>
|
---|
| 86 |
|
---|
| 87 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 88 | <para role="optional">
|
---|
| 89 | <xref linkend="gtk-doc"/> and
|
---|
| 90 | <xref linkend="DocBook"/>,
|
---|
[4572fb2] | 91 | <xref linkend="docbook-xsl"/>,
|
---|
| 92 | <xref linkend="libxslt"/> (to build manual pages), and
|
---|
| 93 | <xref linkend="valgrind"/> (can be used in tests)
|
---|
[dabe4b0] | 94 | </para>
|
---|
| 95 |
|
---|
| 96 | <bridgehead renderas="sect4">Optional (Required for the testsuite)</bridgehead>
|
---|
| 97 | <para role="optional">
|
---|
| 98 | <xref linkend="dbus-python"/>,
|
---|
[ee835cc] | 99 | <xref linkend="gjs"/>, and
|
---|
[365d3d1] | 100 | <xref linkend="pygobject3"/> (Python 3 module)
|
---|
| 101 | <!-- Historically libsecret used to require Python2, but it has been
|
---|
| 102 | fully ported to Python3. -->
|
---|
[dabe4b0] | 103 | </para>
|
---|
| 104 |
|
---|
[a44de1cd] | 105 | <bridgehead renderas="sect4">Runtime Dependency</bridgehead>
|
---|
[1051f94e] | 106 | <para role="required">
|
---|
| 107 | <xref role="runtime" linkend="gnome-keyring"/>
|
---|
[a44de1cd] | 108 | </para>
|
---|
| 109 |
|
---|
| 110 | <note>
|
---|
| 111 | <para>
|
---|
[9a363500] | 112 | Any package requiring <application>libsecret</application>
|
---|
[5cf89d2] | 113 | expects <application>GNOME Keyring</application> to be
|
---|
[a44de1cd] | 114 | present at runtime.
|
---|
| 115 | </para>
|
---|
| 116 | </note>
|
---|
| 117 |
|
---|
[dabe4b0] | 118 | <para condition="html" role="usernotes">
|
---|
| 119 | User Notes: <ulink url="&blfs-wiki;/libsecret"/>
|
---|
| 120 | </para>
|
---|
| 121 | </sect2>
|
---|
| 122 |
|
---|
| 123 | <sect2 role="installation">
|
---|
| 124 | <title>Installation of libsecret</title>
|
---|
| 125 |
|
---|
| 126 | <para>
|
---|
| 127 | Install <application>libsecret</application> by running the following
|
---|
| 128 | commands:
|
---|
| 129 | </para>
|
---|
| 130 |
|
---|
[4572fb2] | 131 | <screen><userinput>mkdir bld &&
|
---|
| 132 | cd bld &&
|
---|
| 133 |
|
---|
| 134 | meson --prefix=/usr -Dgtk_doc=false .. &&
|
---|
| 135 | ninja</userinput></screen>
|
---|
[dabe4b0] | 136 |
|
---|
| 137 | <para>
|
---|
[67e58a5] | 138 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
[dabe4b0] | 139 | </para>
|
---|
| 140 |
|
---|
[4572fb2] | 141 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[67e58a5] | 142 |
|
---|
[dabe4b0] | 143 | <para>
|
---|
[4572fb2] | 144 | To test the results, issue: <command>ninja test</command>, after the
|
---|
[7fa80579] | 145 | package is installed. The test suite should be run from a local GUI
|
---|
| 146 | session started with dbus-launch.
|
---|
[dabe4b0] | 147 | </para>
|
---|
| 148 |
|
---|
| 149 | </sect2>
|
---|
| 150 |
|
---|
| 151 | <sect2 role="commands">
|
---|
| 152 | <title>Command Explanations</title>
|
---|
| 153 |
|
---|
[4572fb2] | 154 | <para>
|
---|
[aa41434] | 155 | <parameter>-Dgtk_doc=false</parameter>: Remove this if you have <xref linkend="gtk-doc"/> installed
|
---|
[4572fb2] | 156 | and want to rebuild the documentation with it.
|
---|
| 157 | </para>
|
---|
[dabe4b0] | 158 |
|
---|
| 159 | <para>
|
---|
[4572fb2] | 160 | <option>-Dmanpage=false</option>: Use this switch if you
|
---|
[dabe4b0] | 161 | have not installed <xref linkend="libxslt"/> and DocBook
|
---|
| 162 | packages.
|
---|
| 163 | </para>
|
---|
| 164 |
|
---|
| 165 | <para>
|
---|
[4572fb2] | 166 | <option>-Dgcrypt=false</option>: Use this switch if you have
|
---|
[dabe4b0] | 167 | not installed the recommended dependency of
|
---|
| 168 | <xref linkend="libgcrypt"/>.
|
---|
| 169 | </para>
|
---|
| 170 |
|
---|
| 171 | </sect2>
|
---|
| 172 |
|
---|
| 173 | <sect2 role="content">
|
---|
| 174 | <title>Contents</title>
|
---|
| 175 |
|
---|
| 176 | <segmentedlist>
|
---|
| 177 | <segtitle>Installed Program</segtitle>
|
---|
| 178 | <segtitle>Installed Library</segtitle>
|
---|
| 179 | <segtitle>Installed Directories</segtitle>
|
---|
| 180 |
|
---|
| 181 | <seglistitem>
|
---|
| 182 | <seg>
|
---|
| 183 | secret-tool
|
---|
| 184 | </seg>
|
---|
| 185 | <seg>
|
---|
| 186 | libsecret-1.so
|
---|
| 187 | </seg>
|
---|
| 188 | <seg>
|
---|
| 189 | /usr/include/libsecret-1 and
|
---|
| 190 | /usr/share/gtk-doc/html/libsecret-1
|
---|
| 191 | </seg>
|
---|
| 192 | </seglistitem>
|
---|
| 193 | </segmentedlist>
|
---|
| 194 |
|
---|
| 195 | <variablelist>
|
---|
| 196 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 197 | <?dbfo list-presentation="list"?>
|
---|
| 198 | <?dbhtml list-presentation="table"?>
|
---|
| 199 |
|
---|
| 200 | <varlistentry id="secret-tool">
|
---|
| 201 | <term><command>secret-tool</command></term>
|
---|
| 202 | <listitem>
|
---|
| 203 | <para>
|
---|
| 204 | is a command line tool that can be used to store
|
---|
[4c24eb0a] | 205 | and retrieve passwords
|
---|
[dabe4b0] | 206 | </para>
|
---|
| 207 | <indexterm zone="libsecret secret-tool">
|
---|
| 208 | <primary sortas="b-secret-tool">secret-tool</primary>
|
---|
| 209 | </indexterm>
|
---|
| 210 | </listitem>
|
---|
| 211 | </varlistentry>
|
---|
| 212 |
|
---|
| 213 | <varlistentry id="libsecret-1">
|
---|
| 214 | <term><filename class="libraryfile">libsecret-1.so</filename></term>
|
---|
| 215 | <listitem>
|
---|
| 216 | <para>
|
---|
[4c24eb0a] | 217 | contains the <application>libsecret</application> API functions
|
---|
[dabe4b0] | 218 | </para>
|
---|
| 219 | <indexterm zone="libsecret libsecret-1">
|
---|
| 220 | <primary sortas="c-libsecret-1">libsecret-1.so</primary>
|
---|
| 221 | </indexterm>
|
---|
| 222 | </listitem>
|
---|
| 223 | </varlistentry>
|
---|
| 224 |
|
---|
| 225 | </variablelist>
|
---|
| 226 |
|
---|
| 227 | </sect2>
|
---|
| 228 |
|
---|
| 229 | </sect1>
|
---|