source: pst/ps/mupdf.xml

trunk
Last change on this file was e8b3f50, checked in by Douglas R. Reno <renodr@…>, 10 days ago

Tags

  • Property mode set to 100644
File size: 8.3 KB
Line 
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<!--Using archive URL, because when a new version is released, older and new
8can be found there, no need to change directory -->
9 <!ENTITY mupdf-download-http "https://www.mupdf.com/downloads/archive/mupdf-&mupdf-version;-source.tar.gz">
10 <!ENTITY mupdf-download-ftp " ">
11 <!ENTITY mupdf-md5sum "8ac643af103b4be7b93a57e67fc3aaad">
12 <!ENTITY mupdf-size "53 MB">
13 <!ENTITY mupdf-buildsize "251 MB">
14 <!ENTITY mupdf-time "0.2 SBU (Using parallelism=4)">
15]>
16
17<sect1 id="mupdf" xreflabel="mupdf-&mupdf-version;">
18 <?dbhtml filename="mupdf.html"?>
19
20
21 <title>MuPDF-&mupdf-version;</title>
22
23 <indexterm zone="mupdf">
24 <primary sortas="a-mupdf">mupdf</primary>
25 </indexterm>
26
27 <sect2 role="package">
28 <title>Introduction to MuPDF</title>
29
30 <para>
31 <application>MuPDF</application> is a lightweight PDF and XPS viewer.
32 </para>
33
34 &lfs121_checked;
35
36 <bridgehead renderas="sect3">Package Information</bridgehead>
37 <itemizedlist spacing="compact">
38 <listitem>
39 <para>
40 Download (HTTP): <ulink url="&mupdf-download-http;"/>
41 </para>
42 </listitem>
43 <listitem>
44 <para>
45 Download (FTP): <ulink url="&mupdf-download-ftp;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download MD5 sum: &mupdf-md5sum;
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download size: &mupdf-size;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Estimated disk space required: &mupdf-buildsize;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated build time: &mupdf-time;
66 </para>
67 </listitem>
68 </itemizedlist>
69
70<!--
71 <bridgehead renderas="sect3">Required Additional Downloads</bridgehead>
72 <itemizedlist spacing="compact">
73 <listitem>
74 <para>
75 Required patch: <ulink
76 url="&patch-root;/mupdf-&mupdf-version;-security_fix-1.patch"/>
77 </para>
78 </listitem>
79 </itemizedlist>
80-->
81
82 <bridgehead renderas="sect3">MuPDF Dependencies</bridgehead>
83
84 <bridgehead renderas="sect4">Required</bridgehead>
85 <para role="required">
86 <xref linkend="glu"/> and <!-- previously recommended via system freeglut -->
87 <xref linkend="xorg7-lib"/>
88 </para>
89
90 <bridgehead renderas="sect4">Recommended</bridgehead>
91 <para role="recommended">
92 <!--<xref linkend="freeglut"/>, use of the bundled glut is preferred -->
93 <xref linkend="harfbuzz"/>,
94 <!-- This no-longer gets linked in with our system libs patch
95 <xref linkend="lcms2"/>, -->
96 <xref linkend="libjpeg"/>,
97 <xref linkend="openjpeg2"/>, and
98 <xref linkend="curl"/>
99 </para>
100
101 <bridgehead renderas="sect4">Optional</bridgehead>
102 <para role="optional">
103 <xref role="runtime" linkend="xdg-utils"/> (runtime),
104 <ulink url="https://jbig2dec.com">jbig2dec</ulink>, and
105 <ulink url="https://mujs.com/">MuJS</ulink>
106 </para>
107
108 <bridgehead renderas="sect4">Required (runtime)</bridgehead>
109 <para role="required">
110 <xref role="runtime" linkend="x-window-system"/>
111 </para>
112
113 </sect2>
114
115 <sect2 role="installation">
116 <title>Installation of MuPDF</title>
117
118 <para>First, fix the Makefile to link properly with the shared library:</para>
119
120<screen><userinput>sed -i '/MU.*_EXE. :/{
121 s/\(.(MUPDF_LIB)\)\(.*\)$/\2 | \1/
122 N
123 s/$/ -lmupdf -L$(OUT)/
124 }' Makefile</userinput></screen>
125
126 <para>
127 Install <application>MuPDF</application> by running the following
128 commands:
129 </para>
130
131<screen><userinput>cat &gt; user.make &lt;&lt; EOF &amp;&amp;
132USE_SYSTEM_FREETYPE := yes
133USE_SYSTEM_HARFBUZZ := yes
134USE_SYSTEM_JBIG2DEC := no
135USE_SYSTEM_JPEGXR := no # not used without HAVE_JPEGXR
136USE_SYSTEM_LCMS2 := no # need lcms2-art fork
137USE_SYSTEM_LIBJPEG := yes
138USE_SYSTEM_MUJS := no # build needs source anyway
139USE_SYSTEM_OPENJPEG := yes
140USE_SYSTEM_ZLIB := yes
141USE_SYSTEM_GLUT := no # need freeglut2-art fork
142USE_SYSTEM_CURL := yes
143USE_SYSTEM_GUMBO := no
144EOF
145
146export XCFLAGS=-fPIC &amp;&amp;
147make build=release shared=yes &amp;&amp;
148unset XCFLAGS</userinput></screen>
149
150 <para>
151 This package does not come with a test suite.
152 </para>
153
154 <para>
155 Now, as the <systemitem class="username">root</systemitem> user:
156 </para>
157
158<screen role="root"><userinput>make prefix=/usr \
159 shared=yes \
160 docdir=/usr/share/doc/mupdf-&mupdf-version; \
161 install &amp;&amp;
162
163chmod 755 /usr/lib/libmupdf.so &amp;&amp;
164ln -sfv mupdf-x11 /usr/bin/mupdf</userinput></screen>
165
166 </sect2>
167
168 <sect2 role="commands">
169 <title>Command Explanations</title>
170
171 <para>
172 <command>ln -sfv mupdf-x11 /usr/bin/mupdf </command>:
173 This symbolic link chooses between <command>mupdf-gl</command>
174 and <command>mupdf-x11</command> when running <command>mupdf</command>.
175 </para>
176
177 </sect2>
178
179 <sect2 role="content">
180 <title>Contents</title>
181
182 <segmentedlist>
183 <segtitle>Installed Program</segtitle>
184 <segtitle>Installed Libraries</segtitle>
185 <segtitle>Installed Directories</segtitle>
186
187 <seglistitem>
188 <seg>
189 mupdf (symlink),
190 mupdf-gl,
191 mupdf-x11,
192 mupdf-x11-curl,
193 muraster, and
194 mutool
195 </seg>
196 <seg>
197 libmupdf.so
198 </seg>
199 <seg>
200 /usr/include/mupdf,
201 /usr/share/doc/mupdf-&mupdf-version;
202 </seg>
203 </seglistitem>
204 </segmentedlist>
205
206 <variablelist>
207 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
208 <?dbfo list-presentation="list"?>
209 <?dbhtml list-presentation="table"?>
210
211 <varlistentry id="mupdf-prog">
212 <term><command>mupdf</command></term>
213 <listitem>
214 <para>
215 is a program for viewing PDF, XPS, EPUB, and CBZ documents,
216 and various image formats such as PNG, JPEG, GIFF, and TIFF
217 </para>
218 <indexterm zone="mupdf mupdf-prog">
219 <primary sortas="b-mupdf">mupdf</primary>
220 </indexterm>
221 </listitem>
222 </varlistentry>
223
224 <varlistentry id="mupdf-gl">
225 <term><command>mupdf-gl</command></term>
226 <listitem>
227 <para>
228 same as <command>mupdf</command>, using an opengl renderer
229 </para>
230 <indexterm zone="mupdf mupdf-gl">
231 <primary sortas="b-mupdf-gl">mupdf-gl</primary>
232 </indexterm>
233 </listitem>
234 </varlistentry>
235
236 <varlistentry id="mupdf-x11">
237 <term><command>mupdf-x11</command></term>
238 <listitem>
239 <para>
240 same as <command>mupdf</command>, using an X Window renderer
241 </para>
242 <indexterm zone="mupdf mupdf-x11">
243 <primary sortas="b-mupdf-x11">mupdf-x11</primary>
244 </indexterm>
245 </listitem>
246 </varlistentry>
247
248 <varlistentry id="muraster">
249 <term><command>muraster</command></term>
250 <listitem>
251 <para>
252 is a program used to perform rasterization tasks with PDF
253 documents
254 </para>
255 <indexterm zone="mupdf muraster">
256 <primary sortas="b-muraster">muraster</primary>
257 </indexterm>
258 </listitem>
259 </varlistentry>
260
261 <varlistentry id="mutool">
262 <term><command>mutool</command></term>
263 <listitem>
264 <para>
265 is a program to perform various operations on PDF files, such
266 as merging and cleaning PDF documents
267 </para>
268 <indexterm zone="mupdf mutool">
269 <primary sortas="b-mutool">mutool</primary>
270 </indexterm>
271 </listitem>
272 </varlistentry>
273
274 <varlistentry id="libmupdf">
275 <term><filename class="libraryfile">libmupdf.so</filename></term>
276 <listitem>
277 <para>
278 contains the mupdf API functions
279 </para>
280 <indexterm zone="mupdf libmupdf">
281 <primary sortas="c-libmupdf">libmupdf.so</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 </variablelist>
287
288 </sect2>
289
290</sect1>
Note: See TracBrowser for help on using the repository browser.