[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[f357675] | 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 libcupsfilters-download-http
|
---|
| 8 | "https://github.com/OpenPrinting/libcupsfilters/releases/download/&libcupsfilters-version;/libcupsfilters-&libcupsfilters-version;.tar.xz">
|
---|
| 9 | <!ENTITY libcupsfilters-download-ftp " ">
|
---|
| 10 | <!ENTITY libcupsfilters-md5sum "267e569145bd20615fa18ae65ea6f870">
|
---|
| 11 | <!ENTITY libcupsfilters-size "1.2 MB">
|
---|
| 12 | <!ENTITY libcupsfilters-buildsize "38 MB (with tests)">
|
---|
| 13 | <!ENTITY libcupsfilters-time "0.1 SBU (Using parallelism=4; with tests)">
|
---|
| 14 | ]>
|
---|
| 15 |
|
---|
| 16 | <sect1 id="libcupsfilters" xreflabel="libcupsfilters-&libcupsfilters-version;">
|
---|
| 17 | <?dbhtml filename="libcupsfilters.html"?>
|
---|
| 18 |
|
---|
| 19 |
|
---|
| 20 | <title>libcupsfilters-&libcupsfilters-version;</title>
|
---|
| 21 |
|
---|
| 22 | <indexterm zone="libcupsfilters">
|
---|
| 23 | <primary sortas="a-libcupsfilters">libcupsfilters</primary>
|
---|
| 24 | </indexterm>
|
---|
| 25 |
|
---|
| 26 | <sect2 role="package">
|
---|
| 27 | <title>Introduction to libcupsfilters</title>
|
---|
| 28 |
|
---|
| 29 | <para>
|
---|
| 30 | The <application>libcupsfilters</application> library contains
|
---|
| 31 | filter functions for the data format conversion tasks needed in
|
---|
| 32 | Printer Applications. It also contains several API functions for
|
---|
| 33 | developing printer drivers/Printer Applications.
|
---|
| 34 | </para>
|
---|
| 35 |
|
---|
[3c9b5e9] | 36 | &lfs122_checked;
|
---|
[f357675] | 37 |
|
---|
| 38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 39 | <itemizedlist spacing="compact">
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>
|
---|
| 42 | Download (HTTP): <ulink url="&libcupsfilters-download-http;"/>
|
---|
| 43 | </para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>
|
---|
| 47 | Download (FTP): <ulink url="&libcupsfilters-download-ftp;"/>
|
---|
| 48 | </para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>
|
---|
| 52 | Download MD5 sum: &libcupsfilters-md5sum;
|
---|
| 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
| 57 | Download size: &libcupsfilters-size;
|
---|
| 58 | </para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>
|
---|
| 62 | Estimated disk space required: &libcupsfilters-buildsize;
|
---|
| 63 | </para>
|
---|
| 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
| 66 | <para>
|
---|
| 67 | Estimated build time: &libcupsfilters-time;
|
---|
| 68 | </para>
|
---|
| 69 | </listitem>
|
---|
| 70 | </itemizedlist>
|
---|
[23dd524] | 71 |
|
---|
[f357675] | 72 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 73 | <itemizedlist spacing="compact">
|
---|
| 74 | <listitem>
|
---|
| 75 | <para>
|
---|
| 76 | Required patch:
|
---|
[23dd524] | 77 | <ulink url="&patch-root;/libcupsfilters-&libcupsfilters-version;-upstream_fixes-1.patch"/>
|
---|
[f357675] | 78 | </para>
|
---|
| 79 | </listitem>
|
---|
| 80 | </itemizedlist>
|
---|
[23dd524] | 81 |
|
---|
[f357675] | 82 | <bridgehead renderas="sect3">libcupsfilters Dependencies</bridgehead>
|
---|
| 83 |
|
---|
| 84 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 85 | <para role="required">
|
---|
| 86 | <xref linkend="cups"/>,
|
---|
| 87 | <xref linkend="glib2"/>,
|
---|
| 88 | <xref linkend="gs"/> or <xref linkend="mupdf"/>,
|
---|
| 89 | <xref linkend="lcms2"/>,
|
---|
| 90 | <xref linkend="poppler"/>, and
|
---|
| 91 | <xref linkend="qpdf"/>
|
---|
| 92 | </para>
|
---|
| 93 |
|
---|
| 94 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 95 | <para role="recommended">
|
---|
| 96 | <xref linkend="dejavu-fonts"/> (the build fails if they are not
|
---|
| 97 | installed, although they are only required for the tests),
|
---|
| 98 | <xref linkend="libexif"/>,
|
---|
| 99 | <xref linkend="libjpeg"/>,
|
---|
| 100 | <xref linkend="libpng"/>, and
|
---|
[62ff0f1] | 101 | <xref linkend="libtiff"/>
|
---|
[f357675] | 102 | </para>
|
---|
| 103 | <!--
|
---|
| 104 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 105 | <para role="optional">
|
---|
| 106 | <xref linkend="avahi"/> (required to build the DNSSD backend of the
|
---|
| 107 | <command>cups-browsed</command> daemon, which is needed for operating
|
---|
| 108 | some network printers),
|
---|
| 109 | <xref linkend="openldap"/>,
|
---|
| 110 | <xref linkend="php"/> (use of this might be broken),
|
---|
| 111 | <ulink url="https://liblouis.github.io/downloads/">Liblouis (Braille)</ulink>, and
|
---|
| 112 | <ulink url="https://liblouis.github.io/downloads/">Liblouisutdml (Braille)</ulink>
|
---|
| 113 | </para>
|
---|
| 114 |
|
---|
| 115 | <bridgehead renderas="sect4">Optional printer drivers (runtime)</bridgehead>
|
---|
| 116 | <para role="optional">
|
---|
| 117 | <xref role="runtime" linkend="gutenprint"/> (for supported printers),
|
---|
| 118 | or other printer drivers, such as <ulink role="runtime"
|
---|
| 119 | url="https://sourceforge.net/projects/hplip/files/hplip/">hplip</ulink>
|
---|
| 120 | </para>
|
---|
| 121 | -->
|
---|
| 122 | </sect2>
|
---|
| 123 |
|
---|
| 124 | <sect2 role="installation">
|
---|
| 125 | <title>Installation of libcupsfilters</title>
|
---|
| 126 |
|
---|
| 127 | <para>
|
---|
| 128 | First, fix a security vulnerability that can allow for remote code
|
---|
[23dd524] | 129 | execution:
|
---|
[f357675] | 130 | </para>
|
---|
| 131 |
|
---|
[23dd524] | 132 | <screen><userinput remap="pre">patch -Np1 -i ../libcupsfilters-&libcupsfilters-version;-upstream_fixes-1.patch</userinput></screen>
|
---|
| 133 |
|
---|
[f357675] | 134 | <para>
|
---|
| 135 | Install <application>libcupsfilters</application> by running the
|
---|
| 136 | following commands:
|
---|
| 137 | </para>
|
---|
| 138 |
|
---|
| 139 | <screen><userinput>./configure --prefix=/usr \
|
---|
| 140 | --disable-static \
|
---|
| 141 | --docdir=/usr/share/doc/libcupsfilters-&libcupsfilters-version; &&
|
---|
| 142 | make</userinput></screen>
|
---|
| 143 |
|
---|
| 144 | <para>
|
---|
| 145 | To test the results, issue <command>make check</command>. DejaVu fonts
|
---|
| 146 | are needed for the tests.
|
---|
| 147 | </para>
|
---|
| 148 |
|
---|
| 149 | <para>
|
---|
| 150 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 151 | </para>
|
---|
| 152 |
|
---|
| 153 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 154 |
|
---|
| 155 | </sect2>
|
---|
| 156 |
|
---|
| 157 | <sect2 role="commands">
|
---|
| 158 | <title>Command Explanations</title>
|
---|
| 159 |
|
---|
| 160 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 161 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 162 |
|
---|
| 163 | <para>
|
---|
| 164 | <option>--with-test-font-path=<replaceable>VALUE</replaceable></option>:
|
---|
[06f8ad3] | 165 | If you wish to run the tests, but you do not have the default
|
---|
| 166 | <filename>/usr/share/fonts/dejavu/DejaVuSans.ttf</filename> font
|
---|
| 167 | installed, use this switch to specify where
|
---|
| 168 | <filename>DejaVuSans.ttf</filename> (or perhaps some other text TTF font
|
---|
| 169 | - though this is untested) is located.
|
---|
[f357675] | 170 | </para>
|
---|
| 171 |
|
---|
| 172 |
|
---|
| 173 | </sect2>
|
---|
| 174 |
|
---|
| 175 | <sect2 role="content">
|
---|
| 176 | <title>Contents</title>
|
---|
| 177 |
|
---|
| 178 | <segmentedlist>
|
---|
| 179 | <segtitle>Installed Programs</segtitle>
|
---|
| 180 | <segtitle>Installed Libraries</segtitle>
|
---|
| 181 | <segtitle>Installed Directories</segtitle>
|
---|
| 182 |
|
---|
| 183 | <seglistitem>
|
---|
| 184 | <seg>
|
---|
| 185 | None
|
---|
| 186 | </seg>
|
---|
| 187 | <seg>
|
---|
| 188 | libcupsfilters.so
|
---|
| 189 | </seg>
|
---|
| 190 | <seg>
|
---|
| 191 | /usr/include/cupsfilters,
|
---|
| 192 | /usr/share/cups/{banners,charsets,data}, and
|
---|
| 193 | /usr/share/doc/libcupsfilters-&libcupsfilters-version;
|
---|
| 194 | </seg>
|
---|
| 195 | </seglistitem>
|
---|
| 196 | </segmentedlist>
|
---|
| 197 |
|
---|
| 198 | <variablelist>
|
---|
| 199 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 200 | <?dbfo list-presentation="list"?>
|
---|
| 201 | <?dbhtml list-presentation="table"?>
|
---|
| 202 |
|
---|
| 203 | <varlistentry id="libcupsfilters-lib">
|
---|
| 204 | <term><filename class="libraryfile">libcupsfilters.so</filename></term>
|
---|
| 205 | <listitem>
|
---|
| 206 | <para>
|
---|
| 207 | contains CUPS filters API functions
|
---|
| 208 | </para>
|
---|
| 209 | <indexterm zone="libcupsfilters libcupsfilters-lib">
|
---|
| 210 | <primary sortas="c-libcupsfilters">libcupsfilters.so</primary>
|
---|
| 211 | </indexterm>
|
---|
| 212 | </listitem>
|
---|
| 213 | </varlistentry>
|
---|
| 214 |
|
---|
| 215 | </variablelist>
|
---|
| 216 |
|
---|
| 217 | </sect2>
|
---|
| 218 |
|
---|
| 219 | </sect1>
|
---|