[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[edf68ad] | 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 qrencode-download-http "https://fukuchi.org/works/qrencode/qrencode-&qrencode-version;.tar.bz2">
|
---|
| 8 | <!ENTITY qrencode-download-ftp " ">
|
---|
| 9 | <!ENTITY qrencode-md5sum "de7185bcab635a34730e1b73d4efa705">
|
---|
| 10 | <!ENTITY qrencode-size "451 KB">
|
---|
| 11 | <!ENTITY qrencode-buildsize "5.0 MB (with documentation, add 5 MB for tests)">
|
---|
| 12 | <!ENTITY qrencode-time "less than 0.1 SBU, add 0.1 SBU for tests">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
[a0232fc3] | 15 | <sect1 id="qrencode" xreflabel="qrencode-&qrencode-version;">
|
---|
[edf68ad] | 16 | <?dbhtml filename="qrencode.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
[a0232fc3] | 19 | <title>qrencode-&qrencode-version;</title>
|
---|
[edf68ad] | 20 |
|
---|
| 21 | <indexterm zone="qrencode">
|
---|
| 22 | <primary sortas="a-libqrencode">libqrencode</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
[a0232fc3] | 26 | <title>Introduction to qrencode</title>
|
---|
[edf68ad] | 27 |
|
---|
| 28 | <para>
|
---|
[a0232fc3] | 29 | <application>Qrencode</application> is a fast and compact library
|
---|
[edf68ad] | 30 | for encoding data in a QR Code symbol, a 2D symbology that can be
|
---|
[206e0be] | 31 | scanned by handheld terminals such as a mobile phone with a CCD sensor.
|
---|
[edf68ad] | 32 | </para>
|
---|
| 33 |
|
---|
[f2574af5] | 34 | &lfs122_checked;
|
---|
[edf68ad] | 35 |
|
---|
| 36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 37 | <itemizedlist spacing="compact">
|
---|
| 38 | <listitem>
|
---|
| 39 | <para>
|
---|
| 40 | Download (HTTP): <ulink url="&qrencode-download-http;"/>
|
---|
| 41 | </para>
|
---|
| 42 | </listitem>
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>
|
---|
| 45 | Download (FTP): <ulink url="&qrencode-download-ftp;"/>
|
---|
| 46 | </para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>
|
---|
| 50 | Download MD5 sum: &qrencode-md5sum;
|
---|
| 51 | </para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>
|
---|
| 55 | Download size: &qrencode-size;
|
---|
| 56 | </para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>
|
---|
| 60 | Estimated disk space required: &qrencode-buildsize;
|
---|
| 61 | </para>
|
---|
| 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>
|
---|
| 65 | Estimated build time: &qrencode-time;
|
---|
| 66 | </para>
|
---|
| 67 | </listitem>
|
---|
| 68 | </itemizedlist>
|
---|
| 69 |
|
---|
[a0232fc3] | 70 | <bridgehead renderas="sect3">Qrencode Dependencies</bridgehead>
|
---|
[edf68ad] | 71 |
|
---|
| 72 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 73 | <para role="recommended">
|
---|
| 74 | <xref linkend="libpng"/>
|
---|
| 75 | </para>
|
---|
| 76 |
|
---|
| 77 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 78 | <para role="optional">
|
---|
| 79 | <xref linkend="doxygen"/> for generating documentation, and
|
---|
| 80 | <xref linkend="sdl2"/> for tests
|
---|
| 81 | </para>
|
---|
| 82 |
|
---|
| 83 | </sect2>
|
---|
| 84 |
|
---|
| 85 | <sect2 role="installation">
|
---|
[a0232fc3] | 86 | <title>Installation of qrencode</title>
|
---|
[edf68ad] | 87 |
|
---|
| 88 | <para>
|
---|
| 89 | Install <application>libqrencode</application> by running the following
|
---|
| 90 | commands:
|
---|
| 91 | </para>
|
---|
| 92 |
|
---|
| 93 | <screen><userinput>./configure --prefix=/usr &&
|
---|
| 94 | make</userinput></screen>
|
---|
| 95 |
|
---|
| 96 | <para>
|
---|
| 97 | If you have installed <xref linkend="doxygen"/>, you can build
|
---|
| 98 | the documentation by issuing:
|
---|
| 99 | </para>
|
---|
| 100 |
|
---|
| 101 | <screen remap="doc"><userinput>doxygen</userinput></screen>
|
---|
| 102 |
|
---|
| 103 | <para>
|
---|
| 104 | The tests must be run after installing the package.
|
---|
| 105 | </para>
|
---|
| 106 |
|
---|
| 107 | <para>
|
---|
| 108 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 109 | </para>
|
---|
| 110 |
|
---|
| 111 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 112 |
|
---|
| 113 | <para>
|
---|
| 114 | If you have built the optional documentation, install it as the
|
---|
| 115 | <systemitem class="username">root</systemitem> user:
|
---|
| 116 | </para>
|
---|
| 117 |
|
---|
| 118 | <screen role="root"
|
---|
| 119 | remap="doc"><userinput>install -vdm 755 /usr/share/doc/qrencode-&qrencode-version; &&
|
---|
| 120 | mv html/* /usr/share/doc/qrencode-&qrencode-version;</userinput></screen>
|
---|
| 121 |
|
---|
| 122 | <para>
|
---|
| 123 | To test the results, if you have passed the <option>--with-tests</option>
|
---|
| 124 | option to <command>configure</command>, issue:
|
---|
| 125 | <command>make check</command>.
|
---|
| 126 | </para>
|
---|
| 127 | </sect2>
|
---|
| 128 |
|
---|
| 129 | <sect2 role="commands">
|
---|
| 130 | <title>Command Explanations</title>
|
---|
| 131 |
|
---|
| 132 | <para>
|
---|
| 133 | <option>--with-tests</option>: This option allows building the test
|
---|
| 134 | programs. It requires <xref linkend="sdl2"/>.
|
---|
| 135 | </para>
|
---|
| 136 |
|
---|
| 137 | <para>
|
---|
| 138 | <option>--without-tools</option>: This option prevents building the
|
---|
| 139 | <command>qrencode</command> executable, removing the need for
|
---|
| 140 | <xref linkend="libpng"/>.
|
---|
| 141 | </para>
|
---|
| 142 | </sect2>
|
---|
| 143 |
|
---|
| 144 | <sect2 role="content">
|
---|
| 145 | <title>Contents</title>
|
---|
| 146 |
|
---|
| 147 | <segmentedlist>
|
---|
| 148 | <segtitle>Installed Program</segtitle>
|
---|
| 149 | <segtitle>Installed Library</segtitle>
|
---|
| 150 | <segtitle>Installed Directory</segtitle>
|
---|
| 151 |
|
---|
| 152 | <seglistitem>
|
---|
| 153 | <seg>
|
---|
[206e0be] | 154 | qrencode
|
---|
[edf68ad] | 155 | </seg>
|
---|
| 156 | <seg>
|
---|
[206e0be] | 157 | libqrencode.so
|
---|
[edf68ad] | 158 | </seg>
|
---|
| 159 | <seg>
|
---|
[206e0be] | 160 | /usr/share/doc/qrencode-&qrencode-version; (optional)
|
---|
[edf68ad] | 161 | </seg>
|
---|
| 162 | </seglistitem>
|
---|
| 163 | </segmentedlist>
|
---|
| 164 |
|
---|
| 165 | <variablelist>
|
---|
| 166 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 167 | <?dbfo list-presentation="list"?>
|
---|
| 168 | <?dbhtml list-presentation="table"?>
|
---|
| 169 |
|
---|
| 170 | <varlistentry id="qrencode-prog">
|
---|
| 171 | <term><command>qrencode</command></term>
|
---|
| 172 | <listitem>
|
---|
| 173 | <para>
|
---|
[4c24eb0a] | 174 | encodes input data in a QR Code and saves it as a PNG or EPS image
|
---|
[edf68ad] | 175 | </para>
|
---|
| 176 | <indexterm zone="qrencode qrencode-prog">
|
---|
| 177 | <primary sortas="b-qrencode">qrencode</primary>
|
---|
| 178 | </indexterm>
|
---|
| 179 | </listitem>
|
---|
| 180 | </varlistentry>
|
---|
| 181 |
|
---|
| 182 | <varlistentry id="libqrencode">
|
---|
| 183 | <term><filename class="libraryfile">libqrencode.so</filename></term>
|
---|
| 184 | <listitem>
|
---|
| 185 | <para>
|
---|
[4c24eb0a] | 186 | contains functions for encoding data in a QR code symbol
|
---|
[edf68ad] | 187 | </para>
|
---|
| 188 | <indexterm zone="qrencode libqrencode">
|
---|
| 189 | <primary sortas="c-libqrencode">libqrencode.so</primary>
|
---|
| 190 | </indexterm>
|
---|
| 191 | </listitem>
|
---|
| 192 | </varlistentry>
|
---|
| 193 | </variablelist>
|
---|
| 194 | </sect2>
|
---|
[4c24eb0a] | 195 |
|
---|
[edf68ad] | 196 | </sect1>
|
---|