2 <!-- ============= Installation ============================== -->
4 <chapter id="sec_install">
5 <title>Installation</title>
8 &appname; is a quite complex piece of software, we thus recommend
9 you to either install al precompiled version or use the LiveCD.
10 If you are running Debian GNU/Linux (or one of its derivatives
11 like Ubuntu), you can install matita typing
12 <programlisting><![CDATA[ aptitude install matita matita-standard-library ]]></programlisting>
13 If you are running MacOSX or Windows, give the LiveCD a try before
14 trying to compile &appname; from its sources.
17 <sect1 id="inst_livecd">
18 <title>Using the LiveCD</title>
21 In the following, we will assume you have installed
22 <ulink type="http" url="http://www.virtualbox.org">virtualbox</ulink>
23 for your platform and downloaded the .iso image of the LiveCD
26 <sect2 id="make_vmachine">
27 <title>Creating the virtual machine</title>
29 Click on the New button, a wizard will popup, you should ask to
30 its questions as follows
33 The name should be something like &appname;, but can
34 be any meaningful string.
37 The OS type should be Debian
40 The base memory size can be 256 mega bytes, but you may
41 want to increase it if you are going to work with huge
45 The boot hard disk should be no hard disk. It may complain
46 that this choice is not common, but it is right, since you
47 will run a LiveCD you do not need to emulate an hard drive.
50 Now that you are done with the creation of the virtual machine,
51 you need to insert the LiveCD in the virtual cd reader unit.
53 <figure><title>The brand new virtual machine</title>
56 <imagedata fileref="figures/vbox1.png" format="PNG" srccredit="Enrico Tassi"/>
58 <textobject><phrase>The breand new virtual machine</phrase></textobject>
62 Click on CD/DVD-ROM (that should display something like: Not mouted).
63 Then click on mount CD/DVD drive and select the ISO image
64 option. The combo-box should display no available image, you need to
65 add the ISO image you downloaded from the &appname; website clicking on
66 the button near the combo-box.
67 to start the virtual machine.
69 <figure><title>Mounting an ISO image</title>
72 <imagedata fileref="figures/vbox2.png" format="PNG" srccredit="Enrico Tassi"/>
74 <textobject><phrase>Mounting an ISO image</phrase></textobject>
78 In the newely opened window click
79 the Add button, choose the file you downloaded
80 (usually matita-version.iso) and select that entry.
82 <figure><title>Choosing the ISO image</title>
85 <imagedata fileref="figures/vbox3.png" format="PNG" srccredit="Enrico Tassi"/>
87 <textobject><phrase>Choosing the ISO image</phrase></textobject>
92 to start the virtual machine.
96 <title>Sharing files with the real PC</title>
98 The virtual machine &appname; will run on, has its own file
99 system, that is completely separated from the one of your
100 real PC (thus your files are not available in the
101 emulated environment) and moreover it is a non-presistem
102 file system (thus you data is lost every time yuo
103 turn off the virtual machine).
106 Virtualbox allows you to share a real folder (beloging
107 to your real PC) with the emulated computer. Since this
108 folder is persistent, you are encouraged to put
109 your work there, so that it is not lost when the virtual
110 machine is powered off.
113 The first step to set up a shared folder is to click
114 on the shared folder configuration entry
115 of the virtual machine.
117 <figure><title>Set up a shared folder</title>
120 <imagedata fileref="figures/vbox4.png"
121 format="PNG" srccredit="Enrico Tassi"/>
123 <textobject><phrase>Shared folder</phrase></textobject>
127 The you shuld add a shared folder clicking on the
128 plus icon on the right
130 <figure><title>Choosing the folder to share</title>
133 <imagedata fileref="figures/vbox5.png"
134 format="PNG" srccredit="Enrico Tassi"/>
136 <textobject><phrase>Shared folder</phrase></textobject>
140 The you have to specify the real PC folder you want to share
141 and name it. A reasonable folder to share is /home on
142 a standard Unix system, while /Users on MaxOSX.
143 The name you give to the share is important, you should
146 <figure><title>Naming the shared folder</title>
149 <imagedata fileref="figures/vbox6.png"
150 format="PNG" srccredit="Enrico Tassi"/>
152 <textobject><phrase>Shared folder</phrase></textobject>
156 Once your virtual machine is up and running, you can
157 mount (that meand have access to) the shared folder
158 by clicking on the Mount VirtualBox share icon, and typing
159 the name of the share.
161 <figure><title>Using it from the virtual machine</title>
164 <imagedata fileref="figures/vbox7.png"
165 format="PNG" srccredit="Enrico Tassi"/>
167 <textobject><phrase>Shared folder at work</phrase></textobject>
171 A window will then pop-up, and its content will be the
172 the content of the real PC folder.
178 <sect1 id="inst_from_src">
179 <title>Installing from sources</title>
181 <para>Install &appname; from the sources is hard, you have been warned!
184 <sect2 id="get_source_code">
185 <title>Getting the source code</title>
187 <para>You can get the &appname; source code in two ways:
190 <listitem> <para> go to the <ulink type="http"
191 url="http://matita.cs.unibo.it/download.shtml">download
192 page</ulink> and get the <ulink type="http"
193 url="http://matita.cs.unibo.it/sources/matita-latest.tar.gz"
194 >latest released source tarball</ulink>;</para> </listitem>
196 <listitem> <para> get the development sources from <ulink type="http"
197 url="http://helm.cs.unibo.it/websvn/listing.php?repname=helm&path=%2F&sc=0">our
198 SVN repository</ulink>. You will need the
199 <application>components/</application> and
200 <application>matita/</application> directories from the
201 <filename>trunk/helm/software/</filename> directory, plus the
202 <filename>configure</filename> and <filename>Makefile*</filename>
203 stuff from the same directory. </para>
205 <para>In this case you will need to run
206 <command>autoconf</command> before proceding with the building
207 instructions below.</para> </listitem>
214 <sect2 id="build_requirements">
215 <title>Requirements</title>
217 <para>In order to build &appname; from sources you will need some
218 tools and libraries. They are listed below.
221 <title>Note for Debian (and derivatives) users</title>
223 <para>If you are running a
225 url="http://www.debian.org">Debian GNU/Linux</ulink>
227 or any of its derivative like <ulink type="http"
228 url="http://ubuntu.com">Ubuntu</ulink>,
229 you can use APT to install all the required tools and
230 libraries since they are all part of the Debian archive.
233 apt-get install ocaml ocaml-findlib libgdome2-ocaml-dev liblablgtk2-ocaml-dev liblablgtkmathview-ocaml-dev liblablgtksourceview-ocaml-dev libsqlite3-ocaml-dev libocamlnet-ocaml-dev libzip-ocaml-dev libhttp-ocaml-dev ocaml-ulex08 libexpat-ocaml-dev libmysql-ocaml-dev camlp5
236 An official debian package is going to be added to the
243 <title>Required tools and libraries</title>
247 <application> <ulink type="http"
248 url="http://caml.inria.fr">OCaml</ulink> </application>
251 <para> the Objective Caml compiler, version 3.09 or above </para>
257 <application> <ulink type="http"
258 url="http://www.ocaml-programming.de/packages/">Findlib</ulink>
262 <para> OCaml package manager, version 1.1.1 or above</para>
268 <application> <ulink type="http"
269 url="http://www.xs4all.nl/~mmzeeman/ocaml/">OCaml
270 Expat</ulink> </application>
273 <para>OCaml bindings for the <application><ulink type="http"
274 url="http://expat.sourceforge.net/">expat</ulink>
275 library</application> </para>
281 <application> <ulink type="http"
282 url="http://gmetadom.sourceforge.net/">GMetaDOM</ulink>
286 <para>OCaml bindings for the <application><ulink type="http"
287 url="http://gdome2.cs.unibo.it/">Gdome 2</ulink>
288 library</application></para>
294 <application> <ulink type="http"
295 url="http://www.bononia.it/~zack/ocaml-http.en.html">OCaml
296 HTTP</ulink> </application>
299 <para> OCaml library to write HTTP daemons (and clients) </para>
305 <application> <ulink type="http"
306 url="http://wwwfun.kurims.kyoto-u.ac.jp/soft/lsl/lablgtk.html">LablGTK</ulink>
310 <para> OCaml bindings for the <application> <ulink type="http"
311 url="http://www.gtk.org"> GTK+</ulink> library
312 </application>, version 2.6.0 or above </para>
318 <application> <ulink type="http"
319 url="http://helm.cs.unibo.it/mml-widget/">GtkMathView</ulink>
323 <application> <ulink type="http"
324 url="http://helm.cs.unibo.it/mml-widget/">LablGtkMathView</ulink>
328 <para> GTK+ widget to render <ulink type="http"
329 url="http://www.w3.org/Math/">MathML</ulink> documents and its
330 OCaml bindings </para>
336 <application> <ulink type="http"
337 url="http://gtksourceview.sourceforge.net/">GtkSourceView</ulink>
341 <application> <ulink type="http"
342 url="http://helm.cs.unibo.it/software/lablgtksourceview/">LablGtkSourceView</ulink>
346 <para> extension for the GTK+ text widget (adding the typical
347 features of source code editors) and its OCaml bindings </para>
352 <term> &MYSQL; </term>
354 <application> <ulink type="http"
355 url="http://raevnos.pennmush.org/code/ocaml-mysql/">OCaml
356 MySQL</ulink> </application>
359 <para> SQL database and OCaml bindings for its client-side library
361 <para> The SQL database itself is not strictly needed to run
362 &appname;, but the client libraries are.</para>
367 <term> &Sqlite; </term>
371 url="http://ocaml.info/home/ocaml_sources.html">
373 </ulink> </application>
376 <para> Sqlite database and OCaml bindings
383 <application> <ulink type="http"
384 url="http://ocamlnet.sourceforge.net/">Ocamlnet</ulink>
388 <para> collection of OCaml libraries to deal with
389 application-level Internet protocols and conventions </para>
395 <application> <ulink type="http"
396 url="http://www.cduce.org/download.html">ulex</ulink>
400 <para> Unicode lexer generator for OCaml </para>
406 <application> <ulink type="http"
407 url="http://cristal.inria.fr/~xleroy/software.html">CamlZip</ulink>
411 <para> OCaml library to access <filename>.gz</filename> files
416 </variablelist> </para>
420 <sect2 id="database_setup">
421 <title>(optional) &MYSQL; setup</title>
423 <para> To fully exploit &appname; indexing and search capabilities
424 on a huge metadata set you may
425 need a working &MYSQL; database. Detalied instructions on how to do
426 it can be found in the <ulink type="http"
427 url="http://dev.mysql.com/doc/">MySQL documentation</ulink>. Here you
428 can find a quick howto. </para>
430 <para> In order to create a database you need administrator permissions on
431 your MySQL installation, usually the root account has them. Once you
432 have the permissions, a new database can be created executing
433 <userinput>mysqladmin create matita</userinput>
434 (<emphasis>matita</emphasis> is the default database name, you can
435 change it using the <parameter>db.user</parameter> key of the
436 configuration file). </para>
438 <para> Then you need to grant the necessary access permissions to the
439 database user of &appname;, typing <userinput>echo "grant all privileges
440 on matita.* to helm;" | mysql matita</userinput> should do the trick
441 (<emphasis>helm</emphasis> is the default user name used by &appname; to
442 access the database, you can change it using the
443 <parameter>db.user</parameter> key of the configuration file).
447 <para> This way you create a database named <emphasis>matita</emphasis>
448 on which anyone claiming to be the <emphasis>helm</emphasis> user can
449 do everything (like adding dummy data or destroying the contained
450 one). It is strongly suggested to apply more fine grained permissions,
451 how to do it is out of the scope of this manual.</para>
456 <sect2 id="build_instructions">
457 <title>Compiling and installing</title>
459 <para> Once you get the source code the installations steps should be
460 quite familiar.</para>
462 <para> First of all you need to configure the build process executing
463 <userinput>./configure</userinput>. This will check that all needed
464 tools and library are installed and prepare the sources for compilation
465 and installation. </para>
467 <para> Quite a few (optional) arguments may be passed to the
468 <application>configure</application> command line to change build time
469 parameters. They are listed below, together with their
470 default values: </para>
473 <title> <application>configure</application> command line
478 <userinput>--with-runtime-dir=<replaceable>dir</replaceable></userinput>
482 (<emphasis>Default:</emphasis>
483 <filename>/usr/local/matita</filename>) Runtime base directory
484 where all &appname; stuff (executables, configuration files,
485 standard library, ...) will be installed
492 <userinput>--with-dbhost=<replaceable>host</replaceable></userinput>
496 (<emphasis>Default:</emphasis> localhost) Default SQL server
497 hostname. Will be used while building the standard library
498 during the installation and to create the default &appname;
499 configuration. May be changed later in configuration file.
506 <userinput>--enable-debug</userinput>
510 (<emphasis>Default:</emphasis> disabled) Enable debugging code.
511 Not for the casual user.
517 <para> Then you will manage the build and install process using
518 <application><ulink type="http"
519 url="http://www.gnu.org/software/make/">make</ulink></application>
520 as usual. Below are reported the targets you have to invoke in sequence
521 to build and install:
525 <title><application>make</application> targets</title>
528 <term><userinput>world</userinput></term>
530 <para>builds components needed by &appname; and &appname; itself
531 (in bytecode or native code depending
532 on the availability of the OCaml native code compiler) </para>
537 <term><userinput>install</userinput></term>
539 <para>installs &appname; related tools, standard library and the
540 needed runtime stuff in the proper places on the filesystem.
542 <para>As a part of the installation process the &appname;
543 standard library will be compiled, thus testing that the just
544 built <application>matitac</application> compiler works
546 <para>For this step you will need a working SQL database (for
547 indexing the standard library while you are compiling it). See
548 <ulink type="http" url="#database_setup">Database setup</ulink>
549 for instructions on how to set it up.
560 <sect1 id="matita.conf.xml">
561 <title>Configuring &appname;</title>
563 The configuration file is divided in four sections. The user and
564 matita ones are self explicative and does not need user
565 intervention. Here we report a sample snippet for these two
566 sections. The remaining db and getter sections will be explained in
570 <section name="user">
571 <key name="home">$(HOME)</key>
572 <key name="name">$(USER)</key>
574 <section name="matita">
575 <key name="basedir">$(user.home)/.matita</key>
576 <key name="rt_base_dir">/usr/share/matita/</key>
577 <key name="owner">$(user.name)</key>
582 &appname; needs to store/fetch data and metadata. Data is essentially
583 composed of XML files, metadata is a set of tuples for a relational
584 model. Data and metadata can produced by the user or be already
585 available. Both kind of data/metadata can be local and/or remote.
588 The db section tells &appname; where to store and retrieve metadata,
589 while the getter section describes where XML files have to be
590 found. The following picture describes the suggested configuration.
591 Dashed arrows are determined by the configuration file.
593 <figure><title>Configuring the Databases</title>
596 <imagedata fileref="figures/database.png" format="PNG" srccredit="Enrico Tassi"/>
598 <textobject><phrase>How to configure the databases.</phrase></textobject>
601 <para>The getter</para>
603 Consider the following snippet and the URI
604 <userinput>cic:/matita/foo/bar.con</userinput>. If &appname;
605 is asked to read that object it will resolve the object trough
606 the getter. Since the first two entries are equally specific
607 (longest match rule applies) first the path
608 <userinput>file://$(matita.rt_base_dir)/xml/standard-library/foo/bar.con</userinput>
609 and then <userinput>file://$(user.home)/.matita/xml/matita/foo/bar.con</userinput>
613 <section name="getter">
614 <key name="cache_dir">$(user.home)/.matita/getter/cache</key>
617 file://$(matita.rt_base_dir)/xml/standard-library/
622 file://$(user.home)/.matita/xml/matita/
626 http://mowgli.cs.unibo.it/xml/
632 if the same URI has to be written, the former prefix is skipped
633 since it is marked as readonly (<userinput>ro</userinput>).
634 Objects resolved using the third prefix are readonly too, and are
635 retrieved using the network. There is no limit to the number of
636 prefixes the user can define. The distinction between prefixes marked
637 as readonly and legacy is that, legacy ones are really read only, while
638 the ones marked with <userinput>ro</userinput> are considered for
639 writing when &appname; is started in system mode (used to publish user
640 developments in the library space).
644 The database subsystem has three fron ends: library, user and
645 legacy. The latter is the only optional one. Every query is done on
646 every frontend, making the duplicate free union of the results.
647 The user front end kepps metadata produced by the user, and is thus
648 heavily accessed in read/write mode, while the library and legacy
649 fron ends are read only. Every front end can be connected to
650 backend, the storage actually.
651 Consider the following snippet.
655 <key name="metadata">mysql://mowgli.cs.unibo.it matita helm none legacy</key>
656 <key name="metadata">file://$(matita.rt_base_dir) metadata.db helm helm library</key>
657 <key name="metadata">file://$(matita.basedir) user.db helm helm user</key>
661 Here the usr database is a file (thus locally accessed trough the
662 Sqlite library) placed in the user's home directory. The library one is
663 placed in the &appname; runtime directory. The legacy fron end is
664 connected to a remote &MYSQL; based storage. Every metadata key
665 takes a path to the storage, the name of the database, the user name,
666 a password (or <userinput>none</userinput>) and the name of the front
667 end to which it is attached.