[0facdac] | 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 gcr4-download-http "&gnome-download-http;/gcr/&gcr4-minor;/gcr-&gcr4-version;.tar.xz">
|
---|
[e1e58be] | 8 | <!ENTITY gcr4-download-ftp " ">
|
---|
[ab7282f] | 9 | <!ENTITY gcr4-md5sum "bb2e957f0ce11a8c527d1d5079ba485f">
|
---|
| 10 | <!ENTITY gcr4-size "708 KB">
|
---|
| 11 | <!ENTITY gcr4-buildsize "22 MB (with tests)">
|
---|
| 12 | <!ENTITY gcr4-time "0.1 SBU (with tests; both using parallelism=4)">
|
---|
[0facdac] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="gcr4" xreflabel="Gcr-&gcr4-version;">
|
---|
| 16 | <?dbhtml filename="gcr4.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>Gcr-&gcr4-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="gcr4">
|
---|
| 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 |
|
---|
[6e45f2f] | 35 | &lfs120_checked;
|
---|
[0facdac] | 36 |
|
---|
| 37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing="compact">
|
---|
| 39 | <listitem>
|
---|
| 40 | <para>
|
---|
| 41 | Download (HTTP): <ulink url="&gcr4-download-http;"/>
|
---|
| 42 | </para>
|
---|
| 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>
|
---|
| 46 | Download (FTP): <ulink url="&gcr4-download-ftp;"/>
|
---|
| 47 | </para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>
|
---|
| 51 | Download MD5 sum: &gcr4-md5sum;
|
---|
| 52 | </para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>
|
---|
| 56 | Download size: &gcr4-size;
|
---|
| 57 | </para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>
|
---|
| 61 | Estimated disk space required: &gcr4-buildsize;
|
---|
| 62 | </para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>
|
---|
| 66 | Estimated build time: &gcr4-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">
|
---|
| 75 | <xref linkend="glib2"/>,
|
---|
| 76 | <xref linkend="libgcrypt"/>, and
|
---|
| 77 | <xref linkend="p11-kit"/>
|
---|
| 78 | </para>
|
---|
| 79 |
|
---|
| 80 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 81 | <para role="recommended">
|
---|
| 82 | <xref linkend="gnupg2"/>,
|
---|
| 83 | <xref linkend="gobject-introspection"/>,
|
---|
| 84 | <xref linkend="gtk4"/>,
|
---|
| 85 | <xref linkend="libsecret"/>,
|
---|
[b269719] | 86 | <xref linkend="libxslt"/>,
|
---|
| 87 | <xref linkend="openssh"/>, and
|
---|
[0facdac] | 88 | <xref linkend="vala"/>
|
---|
| 89 | </para>
|
---|
| 90 |
|
---|
| 91 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 92 | <para role="optional">
|
---|
[f56d2e7] | 93 | <xref linkend="gi-docgen"/> and
|
---|
| 94 | <xref linkend="valgrind"/>
|
---|
[0facdac] | 95 | </para>
|
---|
| 96 |
|
---|
| 97 | </sect2>
|
---|
| 98 |
|
---|
| 99 | <sect2 role="installation">
|
---|
| 100 | <title>Installation of Gcr</title>
|
---|
| 101 |
|
---|
[4a8f53ed] | 102 | <note>
|
---|
| 103 | <para>Both gcr-3 and gcr-4 are coinstallable. This version of the package is
|
---|
| 104 | used to support GTK-4 applications, such as
|
---|
[054cf57b] | 105 | <xref linkend="gnome-shell" role="nodep"/> and
|
---|
| 106 | <xref linkend="epiphany" role="nodep"/>.</para>
|
---|
[4a8f53ed] | 107 | </note>
|
---|
| 108 |
|
---|
[0facdac] | 109 | <para>
|
---|
| 110 | Install <application>Gcr</application> by running the following
|
---|
| 111 | commands:
|
---|
| 112 | </para>
|
---|
| 113 |
|
---|
| 114 | <screen><userinput>mkdir build &&
|
---|
| 115 | cd build &&
|
---|
| 116 |
|
---|
[91318eb] | 117 | meson setup --prefix=/usr \
|
---|
| 118 | --buildtype=release \
|
---|
| 119 | -Dgtk_doc=false \
|
---|
| 120 | .. &&
|
---|
[3a7d81ba] | 121 | ninja</userinput></screen>
|
---|
| 122 |
|
---|
| 123 | <para>
|
---|
| 124 | If you have <xref linkend='gi-docgen'/> installed and wish to build
|
---|
| 125 | the API documentation for this package, issue:
|
---|
| 126 | </para>
|
---|
| 127 |
|
---|
| 128 | <screen role='nodump'><userinput>sed -e "/install_dir/s@,\$@ / 'gcr-&gcr4-version;'&@" \
|
---|
| 129 | -e "/fatal-warnings/d" \
|
---|
| 130 | -i ../docs/*/meson.build &&
|
---|
| 131 | meson configure -Dgtk_doc=true &&
|
---|
[0facdac] | 132 | ninja</userinput></screen>
|
---|
| 133 |
|
---|
| 134 | <para>
|
---|
| 135 | To test the results, issue: <command>ninja test</command>.
|
---|
| 136 | The tests must be run from an X Terminal or similar.
|
---|
| 137 | </para>
|
---|
| 138 |
|
---|
| 139 | <para>
|
---|
| 140 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 141 | </para>
|
---|
| 142 |
|
---|
| 143 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
| 144 | </sect2>
|
---|
| 145 |
|
---|
| 146 | <sect2 role="commands">
|
---|
| 147 | <title>Command Explanations</title>
|
---|
| 148 |
|
---|
| 149 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 150 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 151 |
|
---|
| 152 | <para>
|
---|
| 153 | <option>-Dgtk=false</option>: Use this switch if you
|
---|
| 154 | haven't installed <xref linkend="gtk4"/>. Note that
|
---|
| 155 | <application>gcr-viewer</application> will not be installed
|
---|
| 156 | if this is passed to meson.
|
---|
| 157 | </para>
|
---|
| 158 |
|
---|
| 159 | <para>
|
---|
[b269719] | 160 | <option>-Dssh_agent=false</option>: Use this switch if you
|
---|
| 161 | haven't installed <xref linkend="openssh"/>, and wish to disable
|
---|
| 162 | ssh compatibility.
|
---|
[0facdac] | 163 | </para>
|
---|
| 164 |
|
---|
[b269719] | 165 | <para>
|
---|
| 166 | <option>-Dgtk_doc=true</option>: &gi-doc-disable;
|
---|
| 167 | </para>
|
---|
[0facdac] | 168 | <!--<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 169 | href="../../xincludes/gtk-doc-rebuild.xml"/>-->
|
---|
| 170 |
|
---|
| 171 | </sect2>
|
---|
| 172 |
|
---|
| 173 | <sect2 role="content">
|
---|
| 174 | <title>Contents</title>
|
---|
| 175 |
|
---|
| 176 | <segmentedlist>
|
---|
| 177 | <segtitle>Installed Program</segtitle>
|
---|
| 178 | <segtitle>Installed Libraries</segtitle>
|
---|
| 179 | <segtitle>Installed Directories</segtitle>
|
---|
| 180 |
|
---|
| 181 | <seglistitem>
|
---|
| 182 | <seg>
|
---|
| 183 | gcr-viewer-gtk4
|
---|
| 184 | </seg>
|
---|
| 185 | <seg>
|
---|
| 186 | libgck-2.so, libgcr-4.so
|
---|
| 187 | </seg>
|
---|
| 188 | <seg>
|
---|
| 189 | /usr/include/gck-2,
|
---|
| 190 | /usr/include/gcr-4, and
|
---|
| 191 | /usr/share/gtk-doc/html/{gcr,gck}
|
---|
| 192 | </seg>
|
---|
| 193 | </seglistitem>
|
---|
| 194 | </segmentedlist>
|
---|
| 195 |
|
---|
| 196 | <variablelist>
|
---|
| 197 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 198 | <?dbfo list-presentation="list"?>
|
---|
| 199 | <?dbhtml list-presentation="table"?>
|
---|
| 200 |
|
---|
| 201 | <varlistentry id="gcr-viewer-gtk4">
|
---|
| 202 | <term><command>gcr-viewer-gtk4</command></term>
|
---|
| 203 | <listitem>
|
---|
| 204 | <para>
|
---|
| 205 | is used to view certificates and key files
|
---|
| 206 | </para>
|
---|
| 207 | <indexterm zone="gcr4 gcr-viewer-gtk4">
|
---|
| 208 | <primary sortas="b-gcr-viewer-gtk4">gcr-viewer-gtk4</primary>
|
---|
| 209 | </indexterm>
|
---|
| 210 | </listitem>
|
---|
| 211 | </varlistentry>
|
---|
| 212 |
|
---|
| 213 | <varlistentry id="libgck-2">
|
---|
| 214 | <term><filename class="libraryfile">libgck-2.so</filename></term>
|
---|
| 215 | <listitem>
|
---|
| 216 | <para>
|
---|
| 217 | contains GObject bindings for PKCS#11
|
---|
| 218 | </para>
|
---|
| 219 | <indexterm zone="gcr4 libgck-2">
|
---|
| 220 | <primary sortas="c-libgck-2">libgck-2.so</primary>
|
---|
| 221 | </indexterm>
|
---|
| 222 | </listitem>
|
---|
| 223 | </varlistentry>
|
---|
| 224 |
|
---|
| 225 | <varlistentry id="libgcr-4">
|
---|
| 226 | <term><filename class="libraryfile">libgcr-4.so</filename></term>
|
---|
| 227 | <listitem>
|
---|
| 228 | <para>
|
---|
| 229 | contains functions for accessing key stores and displaying
|
---|
| 230 | certificates
|
---|
| 231 | </para>
|
---|
| 232 | <indexterm zone="gcr4 libgcr-4">
|
---|
| 233 | <primary sortas="c-libgcr-4">libgcr-4.so</primary>
|
---|
| 234 | </indexterm>
|
---|
| 235 | </listitem>
|
---|
| 236 | </varlistentry>
|
---|
| 237 | </variablelist>
|
---|
| 238 |
|
---|
| 239 | </sect2>
|
---|
| 240 |
|
---|
| 241 | </sect1>
|
---|