source: general/genlib/qcoro.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY qcoro-download-http "https://github.com/danvratil/qcoro/archive/v&qcoro-version;/qcoro-&qcoro-version;.tar.gz">
  <!ENTITY qcoro-download-ftp  " ">
  <!ENTITY qcoro-md5sum        "2af4e86cd77493cd41ba5ffcac33d5f4">
  <!ENTITY qcoro-size          "148 KB">
  <!ENTITY qcoro-buildsize     "8.4 MB (Add 19 MB for tests)">
  <!ENTITY qcoro-time          "0.4 SBU (Add 0.5 SBU for tests)">
]>

<sect1 id="qcoro" xreflabel="qcoro-&qcoro-version;">
  <?dbhtml filename="qcoro.html"?>

  <title>qcoro-&qcoro-version;</title>

  <indexterm zone="qcoro">
    <primary sortas="b-qcoro">qcoro</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to qcoro</title>

    <para>
      This package provides a set of tools to make use of C++20 coroutines with Qt.
    </para>

    &lfs121_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&qcoro-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&qcoro-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &qcoro-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &qcoro-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &qcoro-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &qcoro-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">qcoro Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="qt6"/>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of qcoro</title>

    <para>
      Install <application>qcoro</application> by running the following
      commands:
    </para>

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -D CMAKE_INSTALL_PREFIX=$QT6DIR \
      -D CMAKE_BUILD_TYPE=Release     \
      -D BUILD_TESTING=OFF            \
      -D QCORO_BUILD_EXAMPLES=OFF     \
      -D BUILD_SHARED_LIBS=ON         \
       ..                             &amp;&amp;
make</userinput></screen>

    <para>
      To test this package, remove the 'BUILD_TESTING=OFF' parameter
      above and run:
    </para>

<screen><userinput>make test</userinput></screen>

    <para>
      Now, as the &root; user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is
      used to apply a higher level of compiler optimizations.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>None</seg>
        <seg>
          libQCoro6Core.so,
          libQCoro6DBus.so,
          libQCoro6Network.so,
          libQCoro6Qml.so,
          libQCoro6Quick.so, and
          libQCoro6WebSockets.so
        </seg>
        <seg>
          Nine directories in $QT6DIR/lib/cmake/ and 
          $QT6DIR/include/qcoro6
        </seg>
      </seglistitem>
    </segmentedlist>
<!--
    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="mozcerts">
        <term><command>mozcerts-qt6</command></term>
        <listitem>
          <para>
            is a command line tool for converting certdata.txt into
            outfile.pem files
          </para>
          <indexterm zone="qcoro mozcerts">
            <primary sortas="b-mozcerts">mozcerts-qt6</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="qcorotool">
        <term><command>qcorotool-qt6</command></term>
        <listitem>
          <para>
            is a command line tool for performing various cryptographic
            operations with qcoro
          </para>
          <indexterm zone="qcoro qcorotool">
            <primary sortas="b-qcorotool">qcorotool-qt6</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libqcoro">
        <term><filename class="libraryfile">libqcoro-qt6.so</filename></term>
        <listitem>
          <para>
            is the Qt Cryptography Architecture (qcoro) library
          </para>
          <indexterm zone="qcoro libqcoro">
            <primary sortas="c-libqcoro">libqcoro-qt6.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>
-->
  </sect2>

</sect1>