[47969a6] | 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 |
|
---|
[692b415e] | 7 | <!ENTITY qca-download-http "http://download.kde.org/stable/qca/&qca-version;/src/qca-&qca-version;.tar.xz">
|
---|
[47969a6] | 8 | <!ENTITY qca-download-ftp " ">
|
---|
[5982e67] | 9 | <!ENTITY qca-md5sum "657cc701316600199199a6b6cb2c73c9">
|
---|
| 10 | <!ENTITY qca-size "676 KB">
|
---|
| 11 | <!ENTITY qca-buildsize "28 MB">
|
---|
[615961f] | 12 | <!ENTITY qca-time "1.2 SBU (additional 0.3 SBU for the tests)">
|
---|
[47969a6] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="qca" xreflabel="qca-&qca-version;">
|
---|
| 16 | <?dbhtml filename="qca.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>Qca-&qca-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="qca">
|
---|
[81586492] | 26 | <primary sortas="a-qca">qca</primary>
|
---|
[47969a6] | 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
[ad41452] | 30 | <title>Introduction to Qca</title>
|
---|
[47969a6] | 31 |
|
---|
[0d7900a] | 32 | <para><application>Qca</application> aims to provide a straightforward
|
---|
| 33 | and cross-platform crypto API, using <application>Qt</application> datatypes
|
---|
| 34 | and conventions. <application>Qca</application> separates the API from
|
---|
[47969a6] | 35 | the implementation, using plugins known as Providers.</para>
|
---|
| 36 |
|
---|
[2b2671b] | 37 | &lfs79_checked;
|
---|
[47969a6] | 38 |
|
---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>Download (HTTP): <ulink url="&qca-download-http;"/></para>
|
---|
| 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>Download (FTP): <ulink url="&qca-download-ftp;"/></para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>Download MD5 sum: &qca-md5sum;</para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>Download size: &qca-size;</para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>Estimated disk space required: &qca-buildsize;</para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>Estimated build time: &qca-time;</para>
|
---|
| 58 | </listitem>
|
---|
| 59 | </itemizedlist>
|
---|
| 60 |
|
---|
[ad41452] | 61 | <bridgehead renderas="sect3">Qca Dependencies</bridgehead>
|
---|
[47969a6] | 62 |
|
---|
| 63 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 64 | <para role="required">
|
---|
[615961f] | 65 | <xref linkend="cacerts"/>,
|
---|
| 66 | <xref linkend="cmake"/>,
|
---|
[5982e67] | 67 | <xref linkend="qt4"/> or <xref linkend="qt5"/>, and
|
---|
[e40b79b6] | 68 | <xref linkend="which"/>
|
---|
[47969a6] | 69 | </para>
|
---|
| 70 |
|
---|
[615961f] | 71 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 72 | <para role="Optional">
|
---|
| 73 | <xref linkend="cyrus-sasl"/>,
|
---|
| 74 | <xref linkend="gnupg2"/>,
|
---|
| 75 | <xref linkend="libgcrypt"/>,
|
---|
| 76 | <xref linkend="libgpg-error"/>,
|
---|
| 77 | <xref linkend="nss"/>,
|
---|
| 78 | <xref linkend="nspr"/>,
|
---|
| 79 | <xref linkend="openssl"/>,
|
---|
| 80 | <xref linkend="p11-kit"/>,
|
---|
| 81 | <xref linkend="doxygen"/>, and
|
---|
| 82 | <xref linkend="which"/>
|
---|
| 83 | </para>
|
---|
| 84 |
|
---|
[47969a6] | 85 | <para condition="html" role="usernotes">User Notes:
|
---|
| 86 | <ulink url="&blfs-wiki;/qca"/></para>
|
---|
| 87 |
|
---|
| 88 | </sect2>
|
---|
| 89 |
|
---|
| 90 | <sect2 role="installation">
|
---|
[ad41452] | 91 | <title>Installation of Qca</title>
|
---|
[47969a6] | 92 |
|
---|
[5982e67] | 93 | <para>If desired, remove a lot of irritating warnings when building:</para>
|
---|
| 94 |
|
---|
| 95 | <screen><userinput>sed -i 's/BSD/DEFAULT/' CMakeLists.txt</userinput></screen>
|
---|
| 96 |
|
---|
[37a8539] | 97 | <para>This package can be built against <xref linkend="qt4"/> or <xref linkend="qt5"/>.
|
---|
| 98 | If using qt4, run:</para>
|
---|
| 99 |
|
---|
| 100 | <screen><userinput>QT_DIR=&qt4-dir; &&
|
---|
| 101 | QT4_BUILD=ON</userinput></screen>
|
---|
| 102 |
|
---|
| 103 | <para>If using qt5, run:</para>
|
---|
| 104 |
|
---|
| 105 | <screen><userinput>QT_DIR=&qt5-dir; &&
|
---|
| 106 | QT4_BUILD=OFF</userinput></screen>
|
---|
| 107 |
|
---|
[ad41452] | 108 | <para>Install <application>Qca</application> by running the following
|
---|
[47969a6] | 109 | commands:</para>
|
---|
| 110 |
|
---|
[615961f] | 111 | <screen><userinput>mkdir build &&
|
---|
| 112 | cd build &&
|
---|
| 113 |
|
---|
[37a8539] | 114 | cmake -DCMAKE_INSTALL_PREFIX=$QT_DIR \
|
---|
[cbdad90b] | 115 | -DCMAKE_BUILD_TYPE=Release \
|
---|
[37a8539] | 116 | -DQT4_BUILD=$QT4_BUILD \
|
---|
[cbdad90b] | 117 | -DQCA_MAN_INSTALL_DIR:PATH=/usr/share/man \
|
---|
| 118 | .. &&
|
---|
[37a8539] | 119 | unset QT_DIR QT4_BUILD &&
|
---|
[b6d3d395] | 120 |
|
---|
[47969a6] | 121 | make</userinput></screen>
|
---|
| 122 |
|
---|
[9ca304a] | 123 | <para>To test the results, issue <command>make test</command>.</para>
|
---|
| 124 |
|
---|
[47969a6] | 125 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 126 |
|
---|
| 127 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 128 |
|
---|
| 129 | </sect2>
|
---|
[ad41452] | 130 |
|
---|
[47969a6] | 131 | <sect2 role="commands">
|
---|
| 132 | <title>Command Explanations</title>
|
---|
| 133 |
|
---|
[615961f] | 134 | <para><parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is
|
---|
| 135 | used to apply a higher level of compiler optimizations.</para>
|
---|
[47969a6] | 136 |
|
---|
[8c9a5b9] | 137 | <para><parameter>-DQT4_BUILD=ON</parameter>: This switch is used to force
|
---|
[2b2671b] | 138 | building with Qt4 even if Qt5 is found.</para>
|
---|
[9ca304a] | 139 |
|
---|
[f3429309] | 140 | <para><parameter>-DQCA_MAN_INSTALL_DIR:PATH=/usr/share/man</parameter>:
|
---|
[cbdad90b] | 141 | Install the qca man page in the normal location.</para>
|
---|
| 142 |
|
---|
[47969a6] | 143 | </sect2>
|
---|
[ad41452] | 144 |
|
---|
[47969a6] | 145 | <sect2 role="content">
|
---|
| 146 | <title>Contents</title>
|
---|
| 147 |
|
---|
| 148 | <segmentedlist>
|
---|
[ad41452] | 149 | <segtitle>Installed Programs</segtitle>
|
---|
[47969a6] | 150 | <segtitle>Installed Libraries</segtitle>
|
---|
[ad41452] | 151 | <segtitle>Installed Directories</segtitle>
|
---|
[47969a6] | 152 |
|
---|
| 153 | <seglistitem>
|
---|
[5982e67] | 154 | <seg>mozcerts and qcatool (if building with Qt5, the binaries have a -qt5 suffix)</seg>
|
---|
| 155 | <seg>libqca.so (libqca-qt5.so if building with Qt5) and plugins at &qt4-dir;/lib/qca/crypto</seg>
|
---|
[615961f] | 156 | <seg>
|
---|
[5982e67] | 157 | &qt4-dir;/include/QtCrypto (or &qt5-dir;/include/Qca-qt5),
|
---|
| 158 | &qt4-dir;/lib/cmake/Qca (or &qt5-dir;/lib/cmake/Qca-qt5) and
|
---|
| 159 | &qt4-dir;/lib/qca (or &qt5-dir;/lib/qca-qt5)
|
---|
[615961f] | 160 | </seg>
|
---|
[47969a6] | 161 | </seglistitem>
|
---|
| 162 | </segmentedlist>
|
---|
[a88acf4] | 163 |
|
---|
[47969a6] | 164 | <variablelist>
|
---|
| 165 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 166 | <?dbfo list-presentation="list"?>
|
---|
| 167 | <?dbhtml list-presentation="table"?>
|
---|
| 168 |
|
---|
[615961f] | 169 | <varlistentry id="mozcerts">
|
---|
| 170 | <term><command>mozcerts</command></term>
|
---|
| 171 | <listitem>
|
---|
| 172 | <para>is a command line tool for converting certdata.txt into
|
---|
| 173 | outfile.pem files.</para>
|
---|
| 174 | <indexterm zone="qca mozcerts">
|
---|
| 175 | <primary sortas="b-mozcerts">mozcerts</primary>
|
---|
| 176 | </indexterm>
|
---|
| 177 | </listitem>
|
---|
| 178 | </varlistentry>
|
---|
| 179 |
|
---|
| 180 | <varlistentry id="qcatool">
|
---|
| 181 | <term><command>qcatool</command></term>
|
---|
[a88acf4] | 182 | <listitem>
|
---|
| 183 | <para>is a command line tool for performing various cryptographic
|
---|
[615961f] | 184 | operations with Qca.</para>
|
---|
| 185 | <indexterm zone="qca qcatool">
|
---|
| 186 | <primary sortas="b-qcatool">qcatool</primary>
|
---|
[a88acf4] | 187 | </indexterm>
|
---|
| 188 | </listitem>
|
---|
| 189 | </varlistentry>
|
---|
| 190 |
|
---|
| 191 | <varlistentry id="libqca">
|
---|
| 192 | <term><filename class='libraryfile'>libqca.so</filename></term>
|
---|
[47969a6] | 193 | <listitem>
|
---|
[a88acf4] | 194 | <para>is the Qt Cryptography Architecture (Qca) library.</para>
|
---|
| 195 | <indexterm zone="qca libqca">
|
---|
| 196 | <primary sortas="c-libqca">libqca.so</primary>
|
---|
[47969a6] | 197 | </indexterm>
|
---|
| 198 | </listitem>
|
---|
| 199 | </varlistentry>
|
---|
| 200 |
|
---|
| 201 | </variablelist>
|
---|
[a88acf4] | 202 |
|
---|
[47969a6] | 203 | </sect2>
|
---|
| 204 |
|
---|
| 205 | </sect1>
|
---|