X-Git-Url: http://matita.cs.unibo.it/gitweb/?a=blobdiff_plain;f=helm%2Fsoftware%2Fmatita%2Fhelp%2FC%2Fsec_install.xml;h=44e46b7fcfb93f0ffa9dd70378df533606464bac;hb=06a19bec47845ecffe3bf9d9a95d3d4dadf76861;hp=35d7ff900a6d3771b9b1b00825533493603710f6;hpb=e15e22b0bb0723470473e37ccbcd75b90494c614;p=helm.git
diff --git a/helm/software/matita/help/C/sec_install.xml b/helm/software/matita/help/C/sec_install.xml
index 35d7ff900..44e46b7fc 100644
--- a/helm/software/matita/help/C/sec_install.xml
+++ b/helm/software/matita/help/C/sec_install.xml
@@ -1,16 +1,16 @@
-
+
Installation
-
- Installing &appname; from sources
+
+ Installing from sources
Currently, the only intended way to install &appname; is starting
from its source code.
-
+
Getting the source code
You can get the &appname; source code in two ways:
@@ -38,9 +38,9 @@
-
+
-
+
Requirements
In order to build &appname; from sources you will need some
@@ -54,8 +54,8 @@
you can have APT install all the required tools and libraries by
adding the following repository to your
/etc/apt/sources.list:
- deb http://people.debian.org/~zack unstable helm
+ deb http://people.debian.org/~zack unstable helm
and installing the
helm-matita-deps package.
@@ -171,10 +171,7 @@
-
- MySQL
-
+ &MYSQL;
OCaml
@@ -205,7 +202,7 @@
ulex
+ url="http://www.cduce.org/download.html">ulex
@@ -216,7 +213,7 @@
CamlZip
+ url="http://cristal.inria.fr/~xleroy/software.html">CamlZip
@@ -227,36 +224,110 @@
-
+
+
+
+ Database setup
+
+ To fully exploit &appname; indexing and search capabilities you
+ will need a working &MYSQL; database. Detalied instructions on how to do
+ it can be found in the MySQL documentation. Here you
+ can find a quick howto.
+
+ In order to create a database you need administrator permissions on
+ your MySQL installation, usually the root account has them. Once you
+ have the permissions, a new database can be created executing
+ mysqladmin create matita
+ (matita is the default database name, you can
+ change it using the db.user key of the
+ configuration file).
+
+ Then you need to grant the necessary access permissions to the
+ database user of &appname;, typing echo "grant all privileges
+ on matita.* to helm;" | mysql matita should do the trick
+ (helm is the default user name used by &appname; to
+ access the database, you can change it using the
+ db.user key of the configuration file).
+
+
+
+ This way you create a database named matita
+ on which anyone claiming to be the helm user can
+ do everything (like adding dummy data or destroying the contained
+ one). It is strongly suggested to apply more fine grained permissions,
+ how to do it is out of the scope of this manual.
+
+
+
-
- Instructions
+
+ Compiling and installing
Once you get the source code the installations steps should be
quite familiar.
First of all you need to configure the build process executing
./configure. This will check that all needed
- tools and library are installed. You may need to pass on the command
- line some of the parameters riported below:
+ tools and library are installed and prepare the sources for compilation
+ and installation.
+
+ Quite a few (optional) arguments may be passed to the
+ configure command line to change build time
+ parameters. They are listed below, together with their
+ default values:
- configure parameters
+ configure command line
+ arguments
- &TODO;
- &TODO;
+
+ --with-runtime-dir=dir
+
+
+
+ (Default:
+ /usr/local/matita) Runtime base directory
+ where all &appname; stuff (executables, configuration files,
+ standard library, ...) will be installed
+
+
-
+
+
+ --with-dbhost=host
+
+
+
+ (Default: localhost) Default SQL server
+ hostname. Will be used while building the standard library
+ during the installation and to create the default &appname;
+ configuration. May be changed later in configuration file.
+
+
+
-
+
+
+ --enable-debug
+
+
+
+ (Default: disabled) Enable debugging code.
+ Not for the casual user.
+
+
+
+
- Then you will manage the build process using Then you will manage the build and install process using
+ make
as usual. Below are reported the targets you have to invoke in sequence
- to build and install.
+ to build and install:
+
make targets
@@ -265,37 +336,42 @@
world
builds components needed by &appname; and &appname; itself
- (in bytecode only or in both bytecode and native code depending
+ (in bytecode or native code depending
on the availability of the OCaml native code compiler)
-
- library
-
- uses the (just built) matitac
- compiler to build the &appname; standard library.
- For this step you will need a working SQL database (for
- indexing the standard library while you are compiling it). See
- &TODO; for instructions on how to set it up.
-
-
-
install
installs &appname; related tools, standard library and the
- needed runtime stuff in the proper places on the filesystem
+ needed runtime stuff in the proper places on the filesystem.
+
+ As a part of the installation process the &appname;
+ standard library will be compiled, thus testing that the just
+ built matitac compiler works
+ properly.
+ For this step you will need a working SQL database (for
+ indexing the standard library while you are compiling it). See
+ Database setup
+ for instructions on how to set it up.
-
-
-
+
+
+
+
+
+ Configuring Matita
+
+ The file matita.conf.xml...
+ &TODO;
+
+
-
-
+