Correct visible height calculation in multicolumn mode
[llpp.git] / BUILDING
blob10d421c2083a89b3bf680d069aaa4f2a96614483
1 MuPDF[1] rendering library is used to do the actual work, so it needs
2 to be built and installed to use llpp, MuPDF's README[2] describes how
3 to build it and lists its dependencies. Snapshots of MuPDF itself can
4 be found here[3], dependencies here[4]
6 Note that MuPDF is a moving target therefore bellow is the commit id
7 of the git version of MuPDF that this version of llpp is known to work
8 with: 
9 e1016a6c646b3b92f23bea1f0aa959f0ae0b3359
11 llpp also depends on OCaml[5], lablGL[6] and GLUT[7], having a C
12 compiler wouldn't hurt either.
14 To build llpp "the easy way" one can invoke `sh buildall.sh' which
15 will first attempt to automatically fetch lablGL, mupdf, mupdf's
16 prerequisites[8] and build them, then, if everything goes fine, it
17 will proceed building llpp itself. Note that OCaml and GLUT still need
18 to be installed separately, also, in addition to the usual suspects
19 (i.e.  GCC, make, binutils, OCaml) you will need `wget' and `unzip'for
20 this script to work.
22 Otherwise, provided that all prereqs are already built, one should
23 invoke `sh build.sh' from the top of llpp's directory, prior to that
24 it's advisable to review build.sh so that it matches local mupdf
25 installation (or lack thereof)
27 If everything goes fine llpp binary will appear, it can be used like so:
29 $ ./llpp /path/to/some.pdf
31 $ ./llpp -p password /path/to/some.password.protected.pdf
33 [1] http://www.mupdf.com
34 [2] http://mupdf.com/repos/mupdf/README
35 [3] http://mupdf.com/download/snapshots/
36 [4] http://mupdf.com/download/source/mupdf-thirdparty.zip
37 [5] http://caml.inria.fr/
38 [6] http://wwwfun.kurims.kyoto-u.ac.jp/soft/lsl/lablgl.html
39 [7] http://www.opengl.org/resources/libraries/glut/
40     http://freeglut.sourceforge.net/
41 [8] mupdf-e1016a6c646b3b92f23bea1f0aa959f0ae0b3359.tgz (4064527 bytes)
42     mupdf-thirdparty.zip (7288384 bytes)
43     lablgl-1.04.tar.gz (410525 bytes)
45 Building on windows is for masochists and left as an exercise to
46 the reader