[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;
|
---|
[ee9107e] | 6 |
|
---|
[1b99e99] | 7 | <!ENTITY gcr-download-http "&gnome-download-http;/gcr/&gcr-minor;/gcr-&gcr-version;.tar.xz">
|
---|
[e1e58be] | 8 | <!ENTITY gcr-download-ftp " ">
|
---|
[3c1412e] | 9 | <!ENTITY gcr-md5sum "40a754ba44d5e95e4d07656d6302900c">
|
---|
| 10 | <!ENTITY gcr-size "1012 KB">
|
---|
[6ddb21a] | 11 | <!ENTITY gcr-buildsize "33 MB (with tests)">
|
---|
[e43d52d] | 12 | <!ENTITY gcr-time "0.2 SBU (with tests; both using parallelism=4)">
|
---|
[dabe4b0] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="gcr" xreflabel="Gcr-&gcr-version;">
|
---|
| 16 | <?dbhtml filename="gcr.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>Gcr-&gcr-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="gcr">
|
---|
| 22 | <primary sortas="a-Gcr">Gcr</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to Gcr</title>
|
---|
| 27 |
|
---|
| 28 | <para>
|
---|
| 29 | The <application>Gcr</application> package contains libraries used
|
---|
| 30 | for displaying certificates and accessing key stores. It also
|
---|
| 31 | provides the viewer for crypto files on the
|
---|
| 32 | <application>GNOME</application> Desktop.
|
---|
| 33 | </para>
|
---|
| 34 |
|
---|
[9e084d2] | 35 | &lfs122_checked;
|
---|
[dabe4b0] | 36 |
|
---|
| 37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing="compact">
|
---|
| 39 | <listitem>
|
---|
| 40 | <para>
|
---|
| 41 | Download (HTTP): <ulink url="&gcr-download-http;"/>
|
---|
| 42 | </para>
|
---|
| 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>
|
---|
| 46 | Download (FTP): <ulink url="&gcr-download-ftp;"/>
|
---|
| 47 | </para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>
|
---|
| 51 | Download MD5 sum: &gcr-md5sum;
|
---|
| 52 | </para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>
|
---|
| 56 | Download size: &gcr-size;
|
---|
| 57 | </para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>
|
---|
| 61 | Estimated disk space required: &gcr-buildsize;
|
---|
| 62 | </para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>
|
---|
| 66 | Estimated build time: &gcr-time;
|
---|
| 67 | </para>
|
---|
| 68 | </listitem>
|
---|
| 69 | </itemizedlist>
|
---|
| 70 |
|
---|
| 71 | <bridgehead renderas="sect3">Gcr Dependencies</bridgehead>
|
---|
| 72 |
|
---|
| 73 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 74 | <para role="required">
|
---|
[c0bc0a9] | 75 | <xref linkend="glib2"/> (GObject Introspection recommended),
|
---|
[7af46e61] | 76 | <xref linkend="libgcrypt"/>, and
|
---|
[dabe4b0] | 77 | <xref linkend="p11-kit"/>
|
---|
| 78 | </para>
|
---|
| 79 |
|
---|
| 80 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 81 | <para role="recommended">
|
---|
[f6962ed] | 82 | <xref linkend="gnupg2"/>,
|
---|
[2377fb3] | 83 | <xref linkend="gtk3"/>,
|
---|
[bee8bad] | 84 | <xref linkend="libsecret"/>,
|
---|
[2377fb3] | 85 | <xref linkend="libxslt"/>, and
|
---|
| 86 | <xref linkend="vala"/>
|
---|
[dabe4b0] | 87 | </para>
|
---|
| 88 |
|
---|
| 89 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 90 | <para role="optional">
|
---|
[f56d2e7] | 91 | <xref linkend="gi-docgen"/> and
|
---|
| 92 | <xref linkend="valgrind"/>
|
---|
[dabe4b0] | 93 | </para>
|
---|
| 94 |
|
---|
| 95 | </sect2>
|
---|
| 96 |
|
---|
| 97 | <sect2 role="installation">
|
---|
| 98 | <title>Installation of Gcr</title>
|
---|
| 99 |
|
---|
[3b339ddc] | 100 | <!--
|
---|
[7af46e61] | 101 | <caution>
|
---|
| 102 | <para>
|
---|
| 103 | If you are upgrading from a version of gcr prior to 3.36.0, you must
|
---|
| 104 | run the <filename>remove-la-files.sh</filename> script from the
|
---|
| 105 | <xref linkend="la-files"/> after installing gcr.
|
---|
| 106 | </para>
|
---|
| 107 | </caution>
|
---|
[3b339ddc] | 108 | -->
|
---|
[7af46e61] | 109 |
|
---|
[6ddb21a] | 110 | <!--
|
---|
[8f16a204] | 111 | <para>
|
---|
| 112 | First apply a fix for building with newer versions of
|
---|
| 113 | <application>meson</application>:
|
---|
| 114 | </para>
|
---|
| 115 |
|
---|
| 116 | <screen><userinput>find . -name meson.build | xargs sed -i /packages.\*deps/d</userinput></screen>
|
---|
[6ddb21a] | 117 | -->
|
---|
[8f16a204] | 118 |
|
---|
[dabe4b0] | 119 | <para>
|
---|
| 120 | Install <application>Gcr</application> by running the following
|
---|
| 121 | commands:
|
---|
| 122 | </para>
|
---|
| 123 |
|
---|
[51695fd0] | 124 | <screen><userinput>sed -i 's:"/desktop:"/org:' schema/*.xml &&
|
---|
[b0480ef] | 125 |
|
---|
[92f5d53] | 126 | mkdir build &&
|
---|
| 127 | cd build &&
|
---|
[7af46e61] | 128 |
|
---|
[91318eb] | 129 | meson setup --prefix=/usr \
|
---|
| 130 | --buildtype=release \
|
---|
[6af00bd] | 131 | -D gtk_doc=false \
|
---|
| 132 | -D ssh_agent=false \
|
---|
[91318eb] | 133 | .. &&
|
---|
[3a7d81ba] | 134 | ninja</userinput></screen>
|
---|
| 135 |
|
---|
| 136 | <para>
|
---|
| 137 | If you have <xref linkend='gi-docgen'/> installed and wish to build
|
---|
| 138 | the API documentation for this package, issue:
|
---|
| 139 | </para>
|
---|
| 140 |
|
---|
[875b3b57] | 141 | <screen remap='doc'><userinput>sed -e "/install_dir/s@,\$@ / 'gcr-&gcr-version;'&@" \
|
---|
[3a7d81ba] | 142 | -i ../docs/*/meson.build &&
|
---|
[6af00bd] | 143 | meson configure -D gtk_doc=true &&
|
---|
[7af46e61] | 144 | ninja</userinput></screen>
|
---|
[dabe4b0] | 145 |
|
---|
| 146 | <para>
|
---|
[7af46e61] | 147 | To test the results, issue: <command>ninja test</command>.
|
---|
[88d8c967] | 148 | The tests must be run from an X Terminal or similar. <!-- One test,
|
---|
| 149 | "test-openssl 3", is known to fail. -->
|
---|
[dabe4b0] | 150 | </para>
|
---|
| 151 |
|
---|
| 152 | <para>
|
---|
| 153 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 154 | </para>
|
---|
| 155 |
|
---|
[7af46e61] | 156 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[dabe4b0] | 157 | </sect2>
|
---|
| 158 |
|
---|
| 159 | <sect2 role="commands">
|
---|
| 160 | <title>Command Explanations</title>
|
---|
| 161 |
|
---|
[adf17153] | 162 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 163 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 164 |
|
---|
[6ddb21a] | 165 | <!--
|
---|
[b0480ef] | 166 | <para>
|
---|
| 167 | <command>sed ... schema/*.xml</command>: This command fixes a
|
---|
| 168 | deprecated entry in the schema template.
|
---|
| 169 | </para>
|
---|
| 170 |
|
---|
[65d85668] | 171 | <para>
|
---|
| 172 | <command>sed ... ui/meson.build</command>: This command fixes a
|
---|
| 173 | problem when building with meson-0.59.0.
|
---|
| 174 | </para>
|
---|
[6ddb21a] | 175 | -->
|
---|
[65d85668] | 176 |
|
---|
[8252e757] | 177 | <!--
|
---|
[82a9ecf] | 178 | <para>
|
---|
[8252e757] | 179 | <!- - https://gitlab.gnome.org/GNOME/gcr/-/merge_requests/52/ - ->
|
---|
[82a9ecf] | 180 | <command>sed ... gck/gck-slot.c</command>: This command fixes a bug
|
---|
| 181 | (usage of uninitialized value) identified by upstream.
|
---|
| 182 | </para>
|
---|
[8252e757] | 183 | -->
|
---|
[82a9ecf] | 184 |
|
---|
[5b8b9f5] | 185 | <para>
|
---|
[6af00bd] | 186 | <parameter>-D ssh_agent=false</parameter>: Prevent a conflict with
|
---|
[5b8b9f5] | 187 | <xref linkend='gcr4'/>. Omit this switch if you do not plan to
|
---|
| 188 | install <xref linkend='gcr4'/> and you want to use
|
---|
| 189 | <command>gcr-ssh-agent</command>.
|
---|
| 190 | </para>
|
---|
| 191 |
|
---|
[f6962ed] | 192 | <para>
|
---|
[6af00bd] | 193 | <option>-D gtk=false</option>: Use this switch if you
|
---|
[9a363500] | 194 | haven't installed <xref linkend="gtk3"/>. Note that
|
---|
| 195 | <application>gcr-viewer</application> will not be installed
|
---|
[ff40dcf] | 196 | if this is passed to meson.
|
---|
[f6962ed] | 197 | </para>
|
---|
| 198 |
|
---|
[7af46e61] | 199 | <para>
|
---|
[6af00bd] | 200 | <option>-D gtk_doc=true</option>: &gi-doc-disable;
|
---|
[7af46e61] | 201 | </para>
|
---|
| 202 |
|
---|
| 203 | <!--<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 204 | href="../../xincludes/gtk-doc-rebuild.xml"/>-->
|
---|
[dabe4b0] | 205 |
|
---|
| 206 | </sect2>
|
---|
| 207 |
|
---|
| 208 | <sect2 role="content">
|
---|
| 209 | <title>Contents</title>
|
---|
| 210 |
|
---|
| 211 | <segmentedlist>
|
---|
| 212 | <segtitle>Installed Program</segtitle>
|
---|
| 213 | <segtitle>Installed Libraries</segtitle>
|
---|
| 214 | <segtitle>Installed Directories</segtitle>
|
---|
| 215 |
|
---|
| 216 | <seglistitem>
|
---|
| 217 | <seg>
|
---|
[b230e27] | 218 | gcr-viewer
|
---|
[dabe4b0] | 219 | </seg>
|
---|
| 220 | <seg>
|
---|
[8252e757] | 221 | libgck-1.so, libgcr-base-3.so and libgcr-ui-3.so
|
---|
[dabe4b0] | 222 | </seg>
|
---|
| 223 | <seg>
|
---|
| 224 | /usr/include/gck-1,
|
---|
[7af46e61] | 225 | /usr/include/gcr-3, and
|
---|
| 226 | /usr/share/gtk-doc/html/{gcr,gck}
|
---|
[dabe4b0] | 227 | </seg>
|
---|
| 228 | </seglistitem>
|
---|
| 229 | </segmentedlist>
|
---|
| 230 |
|
---|
| 231 | <variablelist>
|
---|
| 232 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 233 | <?dbfo list-presentation="list"?>
|
---|
| 234 | <?dbhtml list-presentation="table"?>
|
---|
| 235 |
|
---|
| 236 | <varlistentry id="gcr-viewer">
|
---|
| 237 | <term><command>gcr-viewer</command></term>
|
---|
| 238 | <listitem>
|
---|
| 239 | <para>
|
---|
[4c24eb0a] | 240 | is used to view certificates and key files
|
---|
[dabe4b0] | 241 | </para>
|
---|
| 242 | <indexterm zone="gcr gcr-viewer">
|
---|
| 243 | <primary sortas="b-gcr-viewer">gcr-viewer</primary>
|
---|
| 244 | </indexterm>
|
---|
| 245 | </listitem>
|
---|
| 246 | </varlistentry>
|
---|
| 247 |
|
---|
| 248 | <varlistentry id="libgck-1">
|
---|
| 249 | <term><filename class="libraryfile">libgck-1.so</filename></term>
|
---|
| 250 | <listitem>
|
---|
| 251 | <para>
|
---|
[4c24eb0a] | 252 | contains GObject bindings for PKCS#11
|
---|
[dabe4b0] | 253 | </para>
|
---|
| 254 | <indexterm zone="gcr libgck-1">
|
---|
| 255 | <primary sortas="c-libgck-1">libgck-1.so</primary>
|
---|
| 256 | </indexterm>
|
---|
| 257 | </listitem>
|
---|
| 258 | </varlistentry>
|
---|
| 259 |
|
---|
| 260 | </variablelist>
|
---|
| 261 |
|
---|
| 262 | </sect2>
|
---|
| 263 |
|
---|
| 264 | </sect1>
|
---|