Fix attribute name
[llpp.git] / BUILDING
blob0c6334fbe42eb98a055a22c5b5bdb6e35ff96640
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 50dbc1a356577f3df15a876f6adb716dea29bdc5
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 and build them, then, if everything goes fine, it will
17 proceed building llpp itself. Note that OCaml and GLUT still need to
18 be installed separately, also, in addition to the usual suspects (i.e.
19 GCC, make, binutils, OCaml) you will need `wget' and `git' for this
20 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/
42 Building on windows is for masochists and left as an exercise to
43 the reader