X-Git-Url: http://matita.cs.unibo.it/gitweb/?a=blobdiff_plain;f=matita%2Fhelp%2FC%2Fsec_install.xml;h=70bd903ccaa85edade8f6ac561f02a5e6977f15d;hb=23655c60730b9b433483cd31f78381d6a6d8872c;hp=6b135e81e13e11f5723049118a3f8684ff55f56b;hpb=325729c3635f6693078078aab34f26aa49ae1c62;p=helm.git
diff --git a/matita/help/C/sec_install.xml b/matita/help/C/sec_install.xml
index 6b135e81e..70bd903cc 100644
--- a/matita/help/C/sec_install.xml
+++ b/matita/help/C/sec_install.xml
@@ -5,7 +5,7 @@
Installation
- Installing &appname; from sources
+ Installing from sources
Currently, the only intended way to install &appname; is starting
from its source code.
@@ -171,10 +171,7 @@
-
- MySQL
-
+ &MYSQL;
OCaml
@@ -229,31 +226,102 @@
+
+ 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:
-
-
- configure parameters
-
-
- &TODO;
- &TODO;
-
-
-
+ 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 in the table below, together with their
+ default values.
+
+
+ configure command line
+ arguments
+
+
+
+ Argument
+ Default
+ Description
+
+
+
+
+
+ --with-runtime-dir=dir
+
+ /usr/local/matita/
+ Runtime base directory where all &appname; stuff
+ (executables, configuration files, standard
+ library, ...) will be installed
+
+
+
+ --with-dbhost=host
+
+ 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
+ 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.
@@ -277,7 +345,8 @@
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.
+ Database setup
+ for instructions on how to set it up.