[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[dabe4b0] | 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 |
|
---|
[e99bb77] | 7 | <!ENTITY libsecret-download-http "&gnome-download-http;/libsecret/0.21/libsecret-&libsecret-version;.tar.xz">
|
---|
[e1e58be] | 8 | <!ENTITY libsecret-download-ftp " ">
|
---|
[3cccdb5] | 9 | <!ENTITY libsecret-md5sum "85f0534c673ccf10daf6fa419728e0d8">
|
---|
[0e9f3a7] | 10 | <!ENTITY libsecret-size "204 KB">
|
---|
[247d1f4] | 11 | <!ENTITY libsecret-buildsize "10 MB (with tests)">
|
---|
[3559c454] | 12 | <!ENTITY libsecret-time "0.3 SBU (with tests)">
|
---|
[dabe4b0] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="libsecret" xreflabel="libsecret-&libsecret-version;">
|
---|
| 16 | <?dbhtml filename="libsecret.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>libsecret-&libsecret-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="libsecret">
|
---|
| 22 | <primary sortas="a-libsecret">libsecret</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to libsecret</title>
|
---|
| 27 |
|
---|
| 28 | <para>
|
---|
| 29 | The <application>libsecret</application> package contains a
|
---|
| 30 | GObject based library for accessing the Secret Service API.
|
---|
| 31 | </para>
|
---|
| 32 |
|
---|
[9e084d2] | 33 | &lfs122_checked;
|
---|
[dabe4b0] | 34 |
|
---|
| 35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 36 | <itemizedlist spacing="compact">
|
---|
| 37 | <listitem>
|
---|
| 38 | <para>
|
---|
| 39 | Download (HTTP): <ulink url="&libsecret-download-http;"/>
|
---|
| 40 | </para>
|
---|
| 41 | </listitem>
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>
|
---|
| 44 | Download (FTP): <ulink url="&libsecret-download-ftp;"/>
|
---|
| 45 | </para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>
|
---|
| 49 | Download MD5 sum: &libsecret-md5sum;
|
---|
| 50 | </para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>
|
---|
| 54 | Download size: &libsecret-size;
|
---|
| 55 | </para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>
|
---|
| 59 | Estimated disk space required: &libsecret-buildsize;
|
---|
| 60 | </para>
|
---|
| 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>
|
---|
| 64 | Estimated build time: &libsecret-time;
|
---|
| 65 | </para>
|
---|
| 66 | </listitem>
|
---|
| 67 | </itemizedlist>
|
---|
| 68 |
|
---|
| 69 | <bridgehead renderas="sect3">libsecret Dependencies</bridgehead>
|
---|
| 70 |
|
---|
| 71 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 72 | <para role="required">
|
---|
[c0bc0a9] | 73 | <xref linkend="glib2"/> (GObject Introspection recommended)
|
---|
[dabe4b0] | 74 | </para>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 77 | <para role="recommended">
|
---|
[c0bc0a9] | 78 | <xref linkend="libgcrypt"/> (or
|
---|
| 79 | <xref role="nodep" linkend="gnutls"/>, for cryptography), and
|
---|
[dabe4b0] | 80 | <xref linkend="vala"/>
|
---|
| 81 | </para>
|
---|
| 82 |
|
---|
| 83 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 84 | <para role="optional">
|
---|
[e2de81fd] | 85 | <xref linkend="gi-docgen"/> and
|
---|
[dabe4b0] | 86 | <xref linkend="DocBook"/>,
|
---|
[4572fb2] | 87 | <xref linkend="docbook-xsl"/>,
|
---|
| 88 | <xref linkend="libxslt"/> (to build manual pages), and
|
---|
| 89 | <xref linkend="valgrind"/> (can be used in tests)
|
---|
[dabe4b0] | 90 | </para>
|
---|
| 91 |
|
---|
[48771ae] | 92 | <bridgehead renderas="sect4">Optional (Required for the test suite)</bridgehead>
|
---|
[dabe4b0] | 93 | <para role="optional">
|
---|
| 94 | <xref linkend="dbus-python"/>,
|
---|
[89efcadc] | 95 | <xref linkend="gjs"/>,
|
---|
| 96 | <xref linkend="pygobject3"/> (Python 3 module), and
|
---|
| 97 | <ulink url="https://github.com/tpm2-software/tpm2-tss">tpm2-tss</ulink>
|
---|
[365d3d1] | 98 | <!-- Historically libsecret used to require Python2, but it has been
|
---|
| 99 | fully ported to Python3. -->
|
---|
[dabe4b0] | 100 | </para>
|
---|
| 101 |
|
---|
[a44de1cd] | 102 | <bridgehead renderas="sect4">Runtime Dependency</bridgehead>
|
---|
[1051f94e] | 103 | <para role="required">
|
---|
| 104 | <xref role="runtime" linkend="gnome-keyring"/>
|
---|
[a44de1cd] | 105 | </para>
|
---|
| 106 |
|
---|
| 107 | <note>
|
---|
| 108 | <para>
|
---|
[9a363500] | 109 | Any package requiring <application>libsecret</application>
|
---|
[5cf89d2] | 110 | expects <application>GNOME Keyring</application> to be
|
---|
[a44de1cd] | 111 | present at runtime.
|
---|
| 112 | </para>
|
---|
| 113 | </note>
|
---|
| 114 |
|
---|
[dabe4b0] | 115 | </sect2>
|
---|
| 116 |
|
---|
| 117 | <sect2 role="installation">
|
---|
| 118 | <title>Installation of libsecret</title>
|
---|
| 119 |
|
---|
| 120 | <para>
|
---|
| 121 | Install <application>libsecret</application> by running the following
|
---|
| 122 | commands:
|
---|
| 123 | </para>
|
---|
| 124 |
|
---|
[4572fb2] | 125 | <screen><userinput>mkdir bld &&
|
---|
[2bf49af8] | 126 | cd bld &&
|
---|
[4572fb2] | 127 |
|
---|
[91318eb] | 128 | meson setup --prefix=/usr \
|
---|
| 129 | --buildtype=release \
|
---|
[6af00bd] | 130 | -D gtk_doc=false \
|
---|
[91318eb] | 131 | .. &&
|
---|
[b266534e] | 132 | ninja</userinput></screen>
|
---|
| 133 |
|
---|
| 134 | <para>
|
---|
| 135 | If you have <xref linkend='gi-docgen'/> installed and wish to build
|
---|
| 136 | the API documentation for this package, issue:
|
---|
| 137 | </para>
|
---|
| 138 |
|
---|
[44892252] | 139 | <screen role='nodump'><userinput>sed "s/api_version_major/'&libsecret-version;'/" \
|
---|
[b266534e] | 140 | -i ../docs/reference/libsecret/meson.build &&
|
---|
[6af00bd] | 141 | meson configure -D gtk_doc=true &&
|
---|
[4572fb2] | 142 | ninja</userinput></screen>
|
---|
[dabe4b0] | 143 |
|
---|
| 144 | <para>
|
---|
[67e58a5] | 145 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
[dabe4b0] | 146 | </para>
|
---|
| 147 |
|
---|
[4572fb2] | 148 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[67e58a5] | 149 |
|
---|
[dabe4b0] | 150 | <para>
|
---|
[e2de81fd] | 151 | To test the results, issue: <command>dbus-run-session ninja test</command>.
|
---|
[dabe4b0] | 152 | </para>
|
---|
| 153 |
|
---|
| 154 | </sect2>
|
---|
| 155 |
|
---|
| 156 | <sect2 role="commands">
|
---|
| 157 | <title>Command Explanations</title>
|
---|
| 158 |
|
---|
[adf17153] | 159 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 160 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 161 |
|
---|
[4572fb2] | 162 | <para>
|
---|
[6af00bd] | 163 | <parameter>-D gtk_doc=false</parameter>: &gi-doc-disable;
|
---|
[4572fb2] | 164 | </para>
|
---|
[dabe4b0] | 165 |
|
---|
| 166 | <para>
|
---|
[6af00bd] | 167 | <option>-D manpage=false</option>: Use this switch if you
|
---|
[dabe4b0] | 168 | have not installed <xref linkend="libxslt"/> and DocBook
|
---|
| 169 | packages.
|
---|
| 170 | </para>
|
---|
| 171 |
|
---|
| 172 | <para>
|
---|
[6af00bd] | 173 | <option>-D crypto=gnutls</option>: Use this switch if you want to use
|
---|
[ca64474] | 174 | <xref linkend="gnutls" role="nodep"/> for cryptography instead of
|
---|
| 175 | <xref linkend="libgcrypt" role="nodep"/>.
|
---|
| 176 | </para>
|
---|
| 177 |
|
---|
| 178 | <para>
|
---|
[6af00bd] | 179 | <option>-D crypto=disabled</option>: Use this switch if you don't have
|
---|
[ca64474] | 180 | <xref linkend="gnutls" role="nodep"/> or
|
---|
| 181 | <xref linkend="libgcrypt" role="nodep"/> installed. Note that disabling
|
---|
| 182 | transport encryption support by doing this is not recommended.
|
---|
[dabe4b0] | 183 | </para>
|
---|
| 184 |
|
---|
| 185 | </sect2>
|
---|
| 186 |
|
---|
| 187 | <sect2 role="content">
|
---|
| 188 | <title>Contents</title>
|
---|
| 189 |
|
---|
| 190 | <segmentedlist>
|
---|
| 191 | <segtitle>Installed Program</segtitle>
|
---|
| 192 | <segtitle>Installed Library</segtitle>
|
---|
| 193 | <segtitle>Installed Directories</segtitle>
|
---|
| 194 |
|
---|
| 195 | <seglistitem>
|
---|
| 196 | <seg>
|
---|
| 197 | secret-tool
|
---|
| 198 | </seg>
|
---|
| 199 | <seg>
|
---|
| 200 | libsecret-1.so
|
---|
| 201 | </seg>
|
---|
| 202 | <seg>
|
---|
| 203 | /usr/include/libsecret-1 and
|
---|
[e2de81fd] | 204 | /usr/share/doc/libsecret-&libsecret-version;
|
---|
[dabe4b0] | 205 | </seg>
|
---|
| 206 | </seglistitem>
|
---|
| 207 | </segmentedlist>
|
---|
| 208 |
|
---|
| 209 | <variablelist>
|
---|
| 210 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 211 | <?dbfo list-presentation="list"?>
|
---|
| 212 | <?dbhtml list-presentation="table"?>
|
---|
| 213 |
|
---|
| 214 | <varlistentry id="secret-tool">
|
---|
| 215 | <term><command>secret-tool</command></term>
|
---|
| 216 | <listitem>
|
---|
| 217 | <para>
|
---|
| 218 | is a command line tool that can be used to store
|
---|
[4c24eb0a] | 219 | and retrieve passwords
|
---|
[dabe4b0] | 220 | </para>
|
---|
| 221 | <indexterm zone="libsecret secret-tool">
|
---|
| 222 | <primary sortas="b-secret-tool">secret-tool</primary>
|
---|
| 223 | </indexterm>
|
---|
| 224 | </listitem>
|
---|
| 225 | </varlistentry>
|
---|
| 226 |
|
---|
| 227 | <varlistentry id="libsecret-1">
|
---|
| 228 | <term><filename class="libraryfile">libsecret-1.so</filename></term>
|
---|
| 229 | <listitem>
|
---|
| 230 | <para>
|
---|
[4c24eb0a] | 231 | contains the <application>libsecret</application> API functions
|
---|
[dabe4b0] | 232 | </para>
|
---|
| 233 | <indexterm zone="libsecret libsecret-1">
|
---|
| 234 | <primary sortas="c-libsecret-1">libsecret-1.so</primary>
|
---|
| 235 | </indexterm>
|
---|
| 236 | </listitem>
|
---|
| 237 | </varlistentry>
|
---|
| 238 |
|
---|
| 239 | </variablelist>
|
---|
| 240 |
|
---|
| 241 | </sect2>
|
---|
| 242 |
|
---|
| 243 | </sect1>
|
---|