]> matita.cs.unibo.it Git - helm.git/blob - helm/software/matita/help/C/sec_install.xml
Preparing for 0.5.9 release.
[helm.git] / helm / software / matita / help / C / sec_install.xml
1
2 <!-- ============= Installation ============================== -->
3
4 <chapter id="sec_install">
5   <title>Installation</title>
6
7   <para>
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.
15   </para>
16   
17   <sect1 id="inst_livecd">
18     <title>Using the LiveCD</title>
19
20     <para>
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
24     </para>
25
26     <sect2 id="make_vmachine">
27             <title>Creating the virtual machine</title>
28     <para>
29             Click on the New button, a wizard will popup, you should ask to
30             its questions as follows
31       <orderedlist>
32               <listitem><para> 
33                 The name should be something like &appname;, but can
34                 be any meaningful string.
35               </para></listitem>
36               <listitem><para> 
37                 The OS type should be Debian
38               </para></listitem>
39               <listitem><para> 
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
42                 formalizations.
43              </para></listitem>
44           <listitem><para> 
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.
48           </para></listitem>
49       </orderedlist>
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.
52       </para>
53    <figure><title>The brand new virtual machine</title>
54      <mediaobject>
55        <imageobject>
56          <imagedata fileref="figures/vbox1.png" format="PNG" srccredit="Enrico Tassi"/>
57        </imageobject>
58        <textobject><phrase>The breand new virtual machine</phrase></textobject>
59      </mediaobject>
60    </figure>
61    <para>
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. 
68     </para>
69    <figure><title>Mounting an ISO image</title>
70      <mediaobject>
71        <imageobject>
72          <imagedata fileref="figures/vbox2.png" format="PNG" srccredit="Enrico Tassi"/>
73        </imageobject>
74        <textobject><phrase>Mounting an ISO image</phrase></textobject>
75      </mediaobject>
76    </figure>
77    <para>
78       In the newely opened window click 
79       the Add button
80     </para>
81    <figure><title>Choosing the ISO image</title>
82      <mediaobject>
83        <imageobject>
84          <imagedata fileref="figures/vbox3.png" format="PNG" srccredit="Enrico Tassi"/>
85        </imageobject>
86        <textobject><phrase>Choosing the ISO image</phrase></textobject>
87      </mediaobject>
88    </figure>
89    <para>
90       A new windows will pop-up: choose the file you downloaded
91       (usually matita-version.iso) and click open.
92     </para>
93    <figure><title>Choosing the ISO image</title>
94      <mediaobject>
95        <imageobject>
96          <imagedata fileref="figures/vbox35.png" format="PNG" srccredit="Enrico Tassi"/>
97        </imageobject>
98        <textobject><phrase>Choosing the ISO image</phrase></textobject>
99      </mediaobject>
100    </figure>
101    <para>
102            Now select the new entry you just added as the CD image
103            you want to insert in the virtual CD drive.
104            You are now ready to start the virtual machine. 
105     </para>
106     </sect2>
107     <sect2>
108        <title>Sharing files with the real PC</title>
109           <para>
110                   The virtual machine &appname; will run on, has its own file 
111                   system, that is completely separated from the one of your 
112                   real PC (thus your files are not available in the
113                   emulated environment) and moreover it is a non-presistent
114                   file system (thus you data is lost every time you
115                   turn off the virtual machine).
116           </para>
117           <para>
118                   Virtualbox allows you to share a real folder (beloging
119                   to your real PC) with the emulated computer. Since this 
120                   folder is persistent, you are encouraged to put
121                   your work there, so that it is not lost when the virtual 
122                   machine is powered off.
123           </para>
124           <para>
125                   The first step to set up a shared folder is to click
126                   on the shared folder configuration entry
127                   of the virtual machine.
128           </para>
129           <figure><title>Set up a shared folder</title>
130             <mediaobject>
131               <imageobject>
132                       <imagedata fileref="figures/vbox4.png" 
133                               format="PNG" srccredit="Enrico Tassi"/>
134               </imageobject>
135               <textobject><phrase>Shared folder</phrase></textobject>
136             </mediaobject>
137           </figure>
138           <para>
139                   Then you shuld add a shared folder clicking on the 
140                   plus icon on the right
141           </para>
142           <figure><title>Choosing the folder to share</title>
143             <mediaobject>
144               <imageobject>
145                       <imagedata fileref="figures/vbox5.png" 
146                               format="PNG" srccredit="Enrico Tassi"/>
147               </imageobject>
148               <textobject><phrase>Shared folder</phrase></textobject>
149             </mediaobject>
150           </figure>
151           <para>
152                   Then you have to specify the real PC folder you want to share
153                   and name it. A reasonable folder to share is /home on 
154                   a standard Unix system, while /Users on MaxOSX.
155                   The name you give to the share is important, you should
156                   remember it.
157           </para>
158           <figure><title>Naming the shared folder</title>
159             <mediaobject>
160               <imageobject>
161                       <imagedata fileref="figures/vbox6.png" 
162                               format="PNG" srccredit="Enrico Tassi"/>
163               </imageobject>
164               <textobject><phrase>Shared folder</phrase></textobject>
165             </mediaobject>
166           </figure>
167           <para>
168                   Once your virtual machine is up and running, you can
169                   mount (that meand have access to) the shared folder 
170                   by clicking on the Mount VirtualBox share icon, and typing
171                   the name of the share.
172           </para>
173           <figure><title>Using it from the virtual machine</title>
174             <mediaobject>
175               <imageobject>
176                       <imagedata fileref="figures/vbox7.png" 
177                               format="PNG" srccredit="Enrico Tassi"/>
178               </imageobject>
179               <textobject><phrase>Shared folder at work</phrase></textobject>
180             </mediaobject>
181           </figure>
182           <para>
183                   A window will then pop-up, and its content will be the
184                   the content of the real PC folder.
185           </para>
186     </sect2>
187
188   </sect1>
189
190   <sect1 id="inst_from_src">
191     <title>Installing from sources</title>
192
193     <para>Install &appname; from the sources is hard, you have been warned!
194     </para>
195
196     <sect2 id="get_source_code">
197       <title>Getting the source code</title>
198
199       <para>You can get the &appname; source code in two ways:
200         <orderedlist>
201
202           <listitem> <para> go to the <ulink type="http"
203                 url="http://matita.cs.unibo.it/download.shtml">download
204                 page</ulink> and get the <ulink type="http"
205                 url="http://matita.cs.unibo.it/sources/matita-latest.tar.gz"
206                 >latest released source tarball</ulink>;</para> </listitem>
207
208           <listitem> <para> get the development sources from <ulink type="http"
209                 url="http://helm.cs.unibo.it/websvn/listing.php?repname=helm&amp;path=%2F&amp;sc=0">our
210                 SVN repository</ulink>. You will need the
211               <application>components/</application> and
212               <application>matita/</application> directories from the
213               <filename>trunk/helm/software/</filename> directory, plus the
214               <filename>configure</filename> and <filename>Makefile*</filename>
215               stuff from the same directory.  </para>
216
217               <para>In this case you will need to run
218                 <command>autoconf</command> before proceding with the building
219                 instructions below.</para> </listitem>
220
221         </orderedlist>
222       </para>
223       
224     </sect2>
225
226     <sect2 id="build_requirements">
227       <title>Requirements</title>
228
229       <para>In order to build &appname; from sources you will need some
230         tools and libraries. They are listed below.
231
232         <note>
233           <title>Note for Debian (and derivatives) users</title>
234
235           <para>If you are running a 
236                   <ulink type="http"
237                           url="http://www.debian.org">Debian GNU/Linux</ulink>
238                   distribution,
239                   or any of its derivative like <ulink type="http"
240                           url="http://ubuntu.com">Ubuntu</ulink>, 
241                   you can use APT to install all the required tools and
242                   libraries since they are all part of the Debian archive. 
243           </para>         
244           <para>          
245                   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
246           </para>         
247           <para>          
248                   An official debian package is going to be added to the
249                   archive too.
250           </para>
251
252         </note>
253
254         <variablelist>
255           <title>Required tools and libraries</title>
256
257           <varlistentry>
258             <term>
259               <application> <ulink type="http"
260                   url="http://caml.inria.fr">OCaml</ulink> </application>
261             </term>
262             <listitem>
263               <para> the Objective Caml compiler, version 3.09 or above </para>
264             </listitem>
265           </varlistentry>
266
267           <varlistentry>
268             <term>
269               <application> <ulink type="http"
270                   url="http://www.ocaml-programming.de/packages/">Findlib</ulink>
271               </application>
272             </term>
273             <listitem>
274               <para> OCaml package manager, version 1.1.1 or above</para>
275             </listitem>
276           </varlistentry>
277
278           <varlistentry>
279             <term>
280               <application> <ulink type="http"
281                   url="http://www.xs4all.nl/~mmzeeman/ocaml/">OCaml
282                   Expat</ulink> </application>
283             </term>
284             <listitem>
285               <para>OCaml bindings for the <application><ulink type="http"
286                     url="http://expat.sourceforge.net/">expat</ulink>
287                   library</application> </para>
288             </listitem>
289           </varlistentry>
290
291           <varlistentry>
292             <term>
293               <application> <ulink type="http"
294                   url="http://gmetadom.sourceforge.net/">GMetaDOM</ulink>
295               </application>
296             </term>
297             <listitem>
298               <para>OCaml bindings for the <application><ulink type="http"
299                     url="http://gdome2.cs.unibo.it/">Gdome 2</ulink>
300                   library</application></para>
301             </listitem>
302           </varlistentry>
303
304           <varlistentry>
305             <term>
306               <application> <ulink type="http"
307                   url="http://www.bononia.it/~zack/ocaml-http.en.html">OCaml
308                   HTTP</ulink> </application>
309             </term>
310             <listitem>
311               <para> OCaml library to write HTTP daemons (and clients) </para>
312             </listitem>
313           </varlistentry>
314
315           <varlistentry>
316             <term>
317               <application> <ulink type="http"
318                   url="http://wwwfun.kurims.kyoto-u.ac.jp/soft/lsl/lablgtk.html">LablGTK</ulink>
319               </application>
320             </term>
321             <listitem>
322               <para> OCaml bindings for the <application> <ulink type="http"
323                     url="http://www.gtk.org"> GTK+</ulink> library
324               </application>, version 2.6.0 or above </para>
325             </listitem>
326           </varlistentry>
327
328           <varlistentry>
329             <term>
330               <application> <ulink type="http"
331                   url="http://helm.cs.unibo.it/mml-widget/">GtkMathView</ulink>
332               </application>
333             </term>
334             <term>
335               <application> <ulink type="http"
336                   url="http://helm.cs.unibo.it/mml-widget/">LablGtkMathView</ulink>
337               </application>
338             </term>
339             <listitem>
340               <para> GTK+ widget to render <ulink type="http"
341                   url="http://www.w3.org/Math/">MathML</ulink> documents and its
342                 OCaml bindings </para>
343             </listitem>
344           </varlistentry>
345
346           <varlistentry>
347             <term>
348               <application> <ulink type="http"
349                   url="http://gtksourceview.sourceforge.net/">GtkSourceView</ulink>
350               </application>
351             </term>
352             <term>
353               <application> <ulink type="http"
354                   url="http://helm.cs.unibo.it/software/lablgtksourceview/">LablGtkSourceView</ulink>
355               </application>
356             </term>
357             <listitem>
358               <para> extension for the GTK+ text widget (adding the typical
359                 features of source code editors) and its OCaml bindings </para>
360             </listitem>
361           </varlistentry>
362
363           <varlistentry>
364             <term> &MYSQL; </term>
365             <term>
366               <application> <ulink type="http"
367                   url="http://raevnos.pennmush.org/code/ocaml-mysql/">OCaml
368                   MySQL</ulink> </application>
369             </term>
370             <listitem>
371               <para> SQL database and OCaml bindings for its client-side library
372               </para>
373               <para> The SQL database itself is not strictly needed to run
374                 &appname;, but the client libraries are.</para>
375             </listitem>
376           </varlistentry>
377
378           <varlistentry>
379             <term> &Sqlite; </term>
380             <term>
381                     <application> 
382                           <ulink type="http"
383                               url="http://ocaml.info/home/ocaml_sources.html">
384                 OCaml Sqlite3
385               </ulink> </application>
386             </term>
387             <listitem>
388               <para> Sqlite database and OCaml bindings
389               </para>
390             </listitem>
391           </varlistentry>
392
393           <varlistentry>
394             <term>
395               <application> <ulink type="http"
396                   url="http://ocamlnet.sourceforge.net/">Ocamlnet</ulink>
397               </application>
398             </term>
399             <listitem>
400               <para> collection of OCaml libraries to deal with
401                 application-level Internet protocols and conventions </para>
402             </listitem>
403           </varlistentry>
404
405           <varlistentry>
406             <term>
407               <application> <ulink type="http"
408                   url="http://www.cduce.org/download.html">ulex</ulink>
409               </application>
410             </term>
411             <listitem>
412               <para> Unicode lexer generator for OCaml </para>
413             </listitem>
414           </varlistentry>
415
416           <varlistentry>
417             <term>
418               <application> <ulink type="http"
419                   url="http://cristal.inria.fr/~xleroy/software.html">CamlZip</ulink>
420               </application>
421             </term>
422             <listitem>
423               <para> OCaml library to access <filename>.gz</filename> files
424               </para>
425             </listitem>
426           </varlistentry>
427
428         </variablelist> </para>
429
430     </sect2>
431
432     <sect2 id="database_setup">
433       <title>(optional) &MYSQL; setup</title>
434
435       <para> To fully exploit &appname; indexing and search capabilities 
436         on a huge metadata set you may
437         need a working &MYSQL; database. Detalied instructions on how to do
438         it can be found in the <ulink type="http"
439           url="http://dev.mysql.com/doc/">MySQL documentation</ulink>. Here you
440         can find a quick howto. </para>
441
442       <para> In order to create a database you need administrator permissions on
443         your MySQL installation, usually the root account has them. Once you
444         have the permissions, a new database can be created executing
445         <userinput>mysqladmin create matita</userinput>
446         (<emphasis>matita</emphasis> is the default database name, you can
447         change it using the <parameter>db.user</parameter> key of the
448         configuration file). </para>
449
450       <para> Then you need to grant the necessary access permissions to the
451         database user of &appname;, typing <userinput>echo "grant all privileges
452           on matita.* to helm;" | mysql matita</userinput> should do the trick
453         (<emphasis>helm</emphasis> is the default user name used by &appname; to
454         access the database, you can change it using the
455         <parameter>db.user</parameter> key of the configuration file).
456       </para>
457
458       <note>
459         <para> This way you create a database named <emphasis>matita</emphasis>
460           on which anyone claiming to be the <emphasis>helm</emphasis> user can
461           do everything (like adding dummy data or destroying the contained
462           one). It is strongly suggested to apply more fine grained permissions,
463           how to do it is out of the scope of this manual.</para>
464       </note>
465       
466     </sect2>
467
468     <sect2 id="build_instructions">
469       <title>Compiling and installing</title>
470
471       <para> Once you get the source code the installations steps should be
472         quite familiar.</para>
473
474       <para> First of all you need to configure the build process executing
475         <userinput>./configure</userinput>. This will check that all needed
476         tools and library are installed and prepare the sources for compilation
477         and installation. </para>
478         
479       <para> Quite a few (optional) arguments may be passed to the
480         <application>configure</application> command line to change build time
481         parameters. They are listed below, together with their
482         default values: </para>
483
484         <variablelist>
485           <title> <application>configure</application> command line
486             arguments</title>
487
488           <varlistentry>
489             <term>
490               <userinput>--with-runtime-dir=<replaceable>dir</replaceable></userinput>
491             </term>
492             <listitem>
493               <para>
494                 (<emphasis>Default:</emphasis>
495                 <filename>/usr/local/matita</filename>) Runtime base directory
496                 where all &appname; stuff (executables, configuration files,
497                 standard library, ...) will be installed
498               </para>
499             </listitem>
500           </varlistentry>
501
502           <varlistentry>
503             <term>
504               <userinput>--with-dbhost=<replaceable>host</replaceable></userinput>
505             </term>
506             <listitem>
507               <para>
508                 (<emphasis>Default:</emphasis> localhost) Default SQL server
509                 hostname. Will be used while building the standard library
510                 during the installation and to create the default &appname;
511                 configuration. May be changed later in configuration file.
512               </para>
513             </listitem>
514           </varlistentry>
515
516           <varlistentry>
517             <term>
518               <userinput>--enable-debug</userinput>
519             </term>
520             <listitem>
521               <para>
522                 (<emphasis>Default:</emphasis> disabled) Enable debugging code.
523                 Not for the casual user.
524               </para>
525             </listitem>
526           </varlistentry>
527         </variablelist>
528
529       <para> Then you will manage the build and install process using
530         <application><ulink type="http"
531             url="http://www.gnu.org/software/make/">make</ulink></application>
532         as usual. Below are reported the targets you have to invoke in sequence
533         to build and install:
534       </para>
535
536         <variablelist>
537           <title><application>make</application> targets</title>
538
539           <varlistentry>
540             <term><userinput>world</userinput></term>
541             <listitem>
542               <para>builds components needed by &appname; and &appname; itself
543                 (in bytecode or native code depending
544                 on the availability of the OCaml native code compiler) </para>
545             </listitem>
546           </varlistentry>
547
548           <varlistentry>
549             <term><userinput>install</userinput></term>
550             <listitem>
551               <para>installs &appname; related tools, standard library and the
552                 needed runtime stuff in the proper places on the filesystem.
553               </para>
554               <para>As a part of the installation process the &appname;
555                 standard library will be compiled, thus testing that the just
556                 built <application>matitac</application> compiler works
557                 properly.</para>
558               <para>For this step you will need a working SQL database (for
559                 indexing the standard library while you are compiling it). See
560                 <ulink type="http" url="#database_setup">Database setup</ulink>
561                 for instructions on how to set it up.
562               </para>
563             </listitem>
564           </varlistentry>
565
566         </variablelist>
567       
568     </sect2>
569
570   </sect1>
571
572   <sect1 id="matita.conf.xml">
573     <title>Configuring &appname;</title>
574     <para>
575             The configuration file is divided in four sections. The user and
576             matita ones are self explicative and does not need user
577             intervention. Here we report a sample snippet for these two
578             sections. The remaining db and getter sections will be explained in
579             details later.
580            <programlisting>
581 <![CDATA[
582   <section name="user">
583     <key name="home">$(HOME)</key>
584     <key name="name">$(USER)</key>
585   </section>
586   <section name="matita">
587     <key name="basedir">$(user.home)/.matita</key>
588     <key name="rt_base_dir">/usr/share/matita/</key>
589     <key name="owner">$(user.name)</key>
590   </section>
591 ]]></programlisting>
592     </para>
593    <para>
594            &appname; needs to store/fetch data and metadata. Data is essentially
595            composed of XML files, metadata is a set of tuples for a relational
596            model. Data and metadata can produced by the user or be already
597            available. Both kind of data/metadata can be local and/or remote.
598    </para>
599    <para>
600            The db section tells &appname; where to store and retrieve metadata,
601            while the getter section describes where XML files have to be
602            found. The following picture describes the suggested configuration.
603            Dashed arrows are determined by the configuration file.
604    </para>
605    <figure><title>Configuring the Databases</title>
606      <mediaobject>
607        <imageobject>
608          <imagedata fileref="figures/database.png" format="PNG" srccredit="Enrico Tassi"/>
609        </imageobject>
610        <textobject><phrase>How to configure the databases.</phrase></textobject>
611      </mediaobject>
612    </figure>
613    <para>The getter</para>
614    <para>
615            Consider the following snippet and the URI
616            <userinput>cic:/matita/foo/bar.con</userinput>. If &appname;
617            is asked to read that object it will resolve the object trough
618            the getter. Since the first two entries are equally specific
619            (longest match rule applies) first the path
620            <userinput>file://$(matita.rt_base_dir)/xml/standard-library/foo/bar.con</userinput>
621            and then <userinput>file://$(user.home)/.matita/xml/matita/foo/bar.con</userinput>
622            are inspected.
623            <programlisting>
624 <![CDATA[
625   <section name="getter">
626     <key name="cache_dir">$(user.home)/.matita/getter/cache</key>
627     <key name="prefix">
628       cic:/matita/
629       file://$(matita.rt_base_dir)/xml/standard-library/
630       ro
631     </key>
632     <key name="prefix">
633       cic:/matita/
634       file://$(user.home)/.matita/xml/matita/
635     </key>
636     <key name="prefix">
637       cic:/Coq/
638       http://mowgli.cs.unibo.it/xml/
639       legacy
640     </key>
641   </section>
642 ]]>     
643         </programlisting> 
644         if the same URI has to be written, the former prefix is skipped
645         since it is marked as readonly (<userinput>ro</userinput>).
646         Objects resolved using the third prefix are readonly too, and are
647         retrieved using the network. There is no limit to the number of
648         prefixes the user can define. The distinction between prefixes marked
649         as readonly and legacy is that, legacy ones are really read only, while
650         the ones marked with <userinput>ro</userinput> are considered for
651         writing when &appname; is started in system mode (used to publish user
652         developments in the library space).
653    </para>
654           <para>The db</para>
655         <para>
656            The database subsystem has three fron ends: library, user and
657            legacy.  The latter is the only optional one. Every query is done on
658            every frontend, making the duplicate free union of the results.
659            The user front end kepps metadata produced by the user, and is thus
660            heavily accessed in read/write mode, while the library and legacy
661            fron ends are read only. Every front end can be connected to
662            backend, the storage actually. 
663            Consider the following snippet.
664            <programlisting>
665 <![CDATA[
666   <section name="db">
667     <key name="metadata">mysql://mowgli.cs.unibo.it matita helm none legacy</key>
668     <key name="metadata">file://$(matita.rt_base_dir) metadata.db helm helm library</key>
669     <key name="metadata">file://$(matita.basedir) user.db helm helm user</key>
670   </section>
671 ]]>     
672         </programlisting> 
673         Here the usr database is a file (thus locally accessed trough the
674         Sqlite library) placed in the user's home directory. The library one is
675         placed in the &appname; runtime directory. The legacy fron end is
676         connected to a remote &MYSQL; based storage. Every metadata key 
677         takes a path to the storage, the name of the database, the user name,
678         a password (or <userinput>none</userinput>) and the name of the front 
679         end to which it is attached.
680    </para>
681   </sect1>
682
683 </chapter>
684