[005a7700] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
| 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 qcoro-download-http "https://github.com/danvratil/qcoro/archive/v&qcoro-version;/qcoro-&qcoro-version;.tar.gz">
|
---|
| 8 | <!ENTITY qcoro-download-ftp " ">
|
---|
[ec6c2f74] | 9 | <!ENTITY qcoro-md5sum "085318ce2efd7fc2b4df2b5d9603b763">
|
---|
| 10 | <!ENTITY qcoro-size "156 KB">
|
---|
| 11 | <!ENTITY qcoro-buildsize "9.0 MB (Add 19 MB for tests)">
|
---|
| 12 | <!ENTITY qcoro-time "0.3 SBU (Using parallelism=4; add 0.6 SBU for tests)">
|
---|
[005a7700] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="qcoro" xreflabel="qcoro-&qcoro-version;">
|
---|
| 16 | <?dbhtml filename="qcoro.html"?>
|
---|
| 17 |
|
---|
| 18 | <title>qcoro-&qcoro-version;</title>
|
---|
| 19 |
|
---|
| 20 | <indexterm zone="qcoro">
|
---|
| 21 | <primary sortas="b-qcoro">qcoro</primary>
|
---|
| 22 | </indexterm>
|
---|
| 23 |
|
---|
| 24 | <sect2 role="package">
|
---|
| 25 | <title>Introduction to qcoro</title>
|
---|
| 26 |
|
---|
| 27 | <para>
|
---|
| 28 | This package provides a set of tools to make use of C++20 coroutines with Qt.
|
---|
| 29 | </para>
|
---|
| 30 |
|
---|
[7426e905] | 31 | &lfs122_checked;
|
---|
[005a7700] | 32 |
|
---|
| 33 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 34 | <itemizedlist spacing="compact">
|
---|
| 35 | <listitem>
|
---|
| 36 | <para>
|
---|
| 37 | Download (HTTP): <ulink url="&qcoro-download-http;"/>
|
---|
| 38 | </para>
|
---|
| 39 | </listitem>
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>
|
---|
| 42 | Download (FTP): <ulink url="&qcoro-download-ftp;"/>
|
---|
| 43 | </para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>
|
---|
| 47 | Download MD5 sum: &qcoro-md5sum;
|
---|
| 48 | </para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>
|
---|
| 52 | Download size: &qcoro-size;
|
---|
| 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
| 57 | Estimated disk space required: &qcoro-buildsize;
|
---|
| 58 | </para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>
|
---|
| 62 | Estimated build time: &qcoro-time;
|
---|
| 63 | </para>
|
---|
| 64 | </listitem>
|
---|
| 65 | </itemizedlist>
|
---|
| 66 |
|
---|
| 67 | <bridgehead renderas="sect3">qcoro Dependencies</bridgehead>
|
---|
| 68 |
|
---|
| 69 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 70 | <para role="required">
|
---|
| 71 | <xref linkend="qt6"/>
|
---|
| 72 | </para>
|
---|
| 73 |
|
---|
| 74 | </sect2>
|
---|
| 75 |
|
---|
| 76 | <sect2 role="installation">
|
---|
| 77 | <title>Installation of qcoro</title>
|
---|
| 78 |
|
---|
| 79 | <para>
|
---|
| 80 | Install <application>qcoro</application> by running the following
|
---|
| 81 | commands:
|
---|
| 82 | </para>
|
---|
| 83 |
|
---|
| 84 | <screen><userinput>mkdir build &&
|
---|
| 85 | cd build &&
|
---|
| 86 |
|
---|
| 87 | cmake -D CMAKE_INSTALL_PREFIX=$QT6DIR \
|
---|
| 88 | -D CMAKE_BUILD_TYPE=Release \
|
---|
| 89 | -D BUILD_TESTING=OFF \
|
---|
| 90 | -D QCORO_BUILD_EXAMPLES=OFF \
|
---|
| 91 | -D BUILD_SHARED_LIBS=ON \
|
---|
| 92 | .. &&
|
---|
| 93 | make</userinput></screen>
|
---|
| 94 |
|
---|
| 95 | <para>
|
---|
| 96 | To test this package, remove the 'BUILD_TESTING=OFF' parameter
|
---|
| 97 | above and run:
|
---|
| 98 | </para>
|
---|
| 99 |
|
---|
| 100 | <screen><userinput>make test</userinput></screen>
|
---|
| 101 |
|
---|
| 102 | <para>
|
---|
| 103 | Now, as the &root; user:
|
---|
| 104 | </para>
|
---|
| 105 |
|
---|
| 106 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 107 |
|
---|
| 108 | </sect2>
|
---|
| 109 |
|
---|
| 110 | <sect2 role="commands">
|
---|
| 111 | <title>Command Explanations</title>
|
---|
| 112 |
|
---|
| 113 | <para>
|
---|
[3da547ca] | 114 | <parameter>-D CMAKE_BUILD_TYPE=Release</parameter>: This switch is
|
---|
[005a7700] | 115 | used to apply a higher level of compiler optimizations.
|
---|
| 116 | </para>
|
---|
| 117 |
|
---|
| 118 | </sect2>
|
---|
| 119 |
|
---|
| 120 | <sect2 role="content">
|
---|
| 121 | <title>Contents</title>
|
---|
| 122 |
|
---|
| 123 | <segmentedlist>
|
---|
| 124 | <segtitle>Installed Programs</segtitle>
|
---|
| 125 | <segtitle>Installed Libraries</segtitle>
|
---|
| 126 | <segtitle>Installed Directories</segtitle>
|
---|
| 127 |
|
---|
| 128 | <seglistitem>
|
---|
| 129 | <seg>None</seg>
|
---|
| 130 | <seg>
|
---|
| 131 | libQCoro6Core.so,
|
---|
| 132 | libQCoro6DBus.so,
|
---|
| 133 | libQCoro6Network.so,
|
---|
| 134 | libQCoro6Qml.so,
|
---|
| 135 | libQCoro6Quick.so, and
|
---|
| 136 | libQCoro6WebSockets.so
|
---|
| 137 | </seg>
|
---|
| 138 | <seg>
|
---|
[c9d29e2] | 139 | Nine directories in $QT6DIR/lib/cmake/ and
|
---|
[005a7700] | 140 | $QT6DIR/include/qcoro6
|
---|
| 141 | </seg>
|
---|
| 142 | </seglistitem>
|
---|
| 143 | </segmentedlist>
|
---|
| 144 | <!--
|
---|
| 145 | <variablelist>
|
---|
| 146 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 147 | <?dbfo list-presentation="list"?>
|
---|
| 148 | <?dbhtml list-presentation="table"?>
|
---|
| 149 |
|
---|
| 150 | <varlistentry id="mozcerts">
|
---|
| 151 | <term><command>mozcerts-qt6</command></term>
|
---|
| 152 | <listitem>
|
---|
| 153 | <para>
|
---|
| 154 | is a command line tool for converting certdata.txt into
|
---|
| 155 | outfile.pem files
|
---|
| 156 | </para>
|
---|
| 157 | <indexterm zone="qcoro mozcerts">
|
---|
| 158 | <primary sortas="b-mozcerts">mozcerts-qt6</primary>
|
---|
| 159 | </indexterm>
|
---|
| 160 | </listitem>
|
---|
| 161 | </varlistentry>
|
---|
| 162 |
|
---|
| 163 | <varlistentry id="qcorotool">
|
---|
| 164 | <term><command>qcorotool-qt6</command></term>
|
---|
| 165 | <listitem>
|
---|
| 166 | <para>
|
---|
| 167 | is a command line tool for performing various cryptographic
|
---|
| 168 | operations with qcoro
|
---|
| 169 | </para>
|
---|
| 170 | <indexterm zone="qcoro qcorotool">
|
---|
| 171 | <primary sortas="b-qcorotool">qcorotool-qt6</primary>
|
---|
| 172 | </indexterm>
|
---|
| 173 | </listitem>
|
---|
| 174 | </varlistentry>
|
---|
| 175 |
|
---|
| 176 | <varlistentry id="libqcoro">
|
---|
| 177 | <term><filename class="libraryfile">libqcoro-qt6.so</filename></term>
|
---|
| 178 | <listitem>
|
---|
| 179 | <para>
|
---|
| 180 | is the Qt Cryptography Architecture (qcoro) library
|
---|
| 181 | </para>
|
---|
| 182 | <indexterm zone="qcoro libqcoro">
|
---|
| 183 | <primary sortas="c-libqcoro">libqcoro-qt6.so</primary>
|
---|
| 184 | </indexterm>
|
---|
| 185 | </listitem>
|
---|
| 186 | </varlistentry>
|
---|
| 187 |
|
---|
| 188 | </variablelist>
|
---|
| 189 | -->
|
---|
| 190 | </sect2>
|
---|
| 191 |
|
---|
| 192 | </sect1>
|
---|