source: gnome/platform/libsecret.xml

trunk
Last change on this file was 7b2fed0f, checked in by Bruce Dubbs <bdubbs@…>, 5 months ago

Tags

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