source: general/graphlib/qrencode.xml@ 730fb6b8

<?xml version="1.0" encoding="ISO-8859-1"?>
<!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 qrencode-download-http "https://fukuchi.org/works/qrencode/qrencode-&qrencode-version;.tar.bz2">
  <!ENTITY qrencode-download-ftp  " ">
  <!ENTITY qrencode-md5sum        "de7185bcab635a34730e1b73d4efa705">
  <!ENTITY qrencode-size          "451 KB">
  <!ENTITY qrencode-buildsize     "5.0 MB (with documentation, add 5 MB for tests)">
  <!ENTITY qrencode-time          "less than 0.1 SBU, add 0.1 SBU for tests">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Libqrencode-&qrencode-version;</title>

  <indexterm zone="qrencode">
    <primary sortas="a-libqrencode">libqrencode</primary>
  </indexterm>

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

    <para>
      <application>Libqrencode</application> is a fast and compact library
      for encoding data in a QR Code symbol, a 2D symbology that can be
      scanned by handheld terminals such as a mobile phone with CCD.
    </para>

    &lfs10_checked;

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

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

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="libpng"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/> for generating documentation, and
      <xref linkend="sdl2"/> for tests
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/qrencode"/>
    </para>
  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>
      If you have installed <xref linkend="doxygen"/>, you can build
      the documentation by issuing:
    </para>

<screen remap="doc"><userinput>doxygen</userinput></screen>

    <para>
      The tests must be run after installing the package.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

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

    <para>
      If you have built the optional documentation, install it as the
      <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"
        remap="doc"><userinput>install -vdm 755 /usr/share/doc/qrencode-&qrencode-version; &amp;&amp;
mv html/* /usr/share/doc/qrencode-&qrencode-version;</userinput></screen>

    <para>
      To test the results, if you have passed the <option>--with-tests</option>
      option to <command>configure</command>, issue:
      <command>make check</command>.
    </para>
  </sect2>

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

    <para>
      <option>--with-tests</option>: This option allows building the test
      programs. It requires <xref linkend="sdl2"/>.
    </para>

    <para>
      <option>--without-tools</option>: This option prevents building the
      <command>qrencode</command> executable, removing the need for
      <xref linkend="libpng"/>.
    </para>
  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          qrencode.
        </seg>
        <seg>
          libqrencode.so.
        </seg>
        <seg>
          /usr/share/doc/qrencode-&qrencode-version; (optional).
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="qrencode-prog">
        <term><command>qrencode</command></term>
        <listitem>
          <para>
            encodes input data in a QR Code and save as a PNG or EPS image.
          </para>
          <indexterm zone="qrencode qrencode-prog">
            <primary sortas="b-qrencode">qrencode</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libqrencode">
        <term><filename class="libraryfile">libqrencode.so</filename></term>
        <listitem>
          <para>
            contains functions for encoding data in a QR code symbol.
          </para>
          <indexterm zone="qrencode libqrencode">
            <primary sortas="c-libqrencode">libqrencode.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>