X-Git-Url: http://matita.cs.unibo.it/gitweb/?a=blobdiff_plain;f=helm%2Fsoftware%2Fmatita%2Fhelp%2FC%2Fsec_install.xml;h=44e46b7fcfb93f0ffa9dd70378df533606464bac;hb=774c8d18f41e71ae7e26a90d726d10a6f95de1fe;hp=84ce6f0d6926d8efc0ac1cbc0605b31a9b0a740a;hpb=9a800d34db8d95ca8737066505deec5d7a4e9496;p=helm.git

diff --git a/helm/software/matita/help/C/sec_install.xml b/helm/software/matita/help/C/sec_install.xml
index 84ce6f0d6..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 ============================== -->
 
-<sect1 id="sec_install">
+<chapter id="sec_install">
   <title>Installation</title>
 
-  <sect2>
-    <title>Installing &appname; from sources</title>
+  <sect1 id="inst_from_src">
+    <title>Installing from sources</title>
 
     <para>Currently, the only intended way to install &appname; is starting
       from its source code.  </para>
 
-    <sect3>
+    <sect2 id="get_source_code">
       <title>Getting the source code</title>
 
       <para>You can get the &appname; source code in two ways:
@@ -38,9 +38,9 @@
 	</orderedlist>
       </para>
       
-    </sect3>
+    </sect2>
 
-    <sect3 id="build_requirements">
+    <sect2 id="build_requirements">
       <title>Requirements</title>
 
       <para>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
 	    <filename>/etc/apt/sources.list</filename>: <programlisting>
-	      deb&nbsp;<ulink type="http"
-		url="http://people.debian.org/~zack">http://people.debian.org/~zack</ulink>&nbsp;unstable&nbsp;helm
+	      deb <ulink type="http"
+		url="http://people.debian.org/~zack">http://people.debian.org/~zack</ulink> unstable helm
 	  </programlisting> and installing the
 	  <application>helm-matita-deps</application> package.</para>
 
@@ -171,10 +171,7 @@
 	  </varlistentry>
 
 	  <varlistentry>
-	    <term>
-	      <application> <ulink type="http"
-		  url="http://www.mysql.com">MySQL</ulink> </application>
-	    </term>
+	    <term> &MYSQL; </term>
 	    <term>
 	      <application> <ulink type="http"
 		  url="http://raevnos.pennmush.org/code/ocaml-mysql/">OCaml
@@ -205,7 +202,7 @@
 	  <varlistentry>
 	    <term>
 	      <application> <ulink type="http"
-		  url="http://www.cduce.org/download.html#side">ulex</ulink>
+		  url="http://www.cduce.org/download.html">ulex</ulink>
 	      </application>
 	    </term>
 	    <listitem>
@@ -216,7 +213,7 @@
 	  <varlistentry>
 	    <term>
 	      <application> <ulink type="http"
-		  url="http://cristal.inria.fr/~xleroy/software.html#camlzip">CamlZip</ulink>
+		  url="http://cristal.inria.fr/~xleroy/software.html">CamlZip</ulink>
 	      </application>
 	    </term>
 	    <listitem>
@@ -227,9 +224,154 @@
 
 	</variablelist> </para>
 
+    </sect2>
+
+    <sect2 id="database_setup">
+      <title>Database setup</title>
+
+      <para> 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 <ulink type="http"
+	  url="http://dev.mysql.com/doc/">MySQL documentation</ulink>. Here you
+	can find a quick howto. </para>
+
+      <para> 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
+	<userinput>mysqladmin create matita</userinput>
+	(<emphasis>matita</emphasis> is the default database name, you can
+	change it using the <parameter>db.user</parameter> key of the
+	configuration file). </para>
+
+      <para> Then you need to grant the necessary access permissions to the
+	database user of &appname;, typing <userinput>echo "grant all privileges
+	  on matita.* to helm;" | mysql matita</userinput> should do the trick
+	(<emphasis>helm</emphasis> is the default user name used by &appname; to
+	access the database, you can change it using the
+	<parameter>db.user</parameter> key of the configuration file).
+      </para>
+
+      <note>
+	<para> This way you create a database named <emphasis>matita</emphasis>
+	  on which anyone claiming to be the <emphasis>helm</emphasis> 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.</para>
+      </note>
+      
+    </sect2>
+
+    <sect2 id="build_instructions">
+      <title>Compiling and installing</title>
+
+      <para> Once you get the source code the installations steps should be
+	quite familiar.</para>
+
+      <para> First of all you need to configure the build process executing
+	<userinput>./configure</userinput>. This will check that all needed
+	tools and library are installed and prepare the sources for compilation
+	and installation. </para>
+	
+      <para> Quite a few (optional) arguments may be passed to the
+	<application>configure</application> command line to change build time
+	parameters. They are listed below, together with their
+	default values: </para>
+
+	<variablelist>
+	  <title> <application>configure</application> command line
+	    arguments</title>
+
+	  <varlistentry>
+	    <term>
+	      <userinput>--with-runtime-dir=<replaceable>dir</replaceable></userinput>
+	    </term>
+	    <listitem>
+	      <para>
+		(<emphasis>Default:</emphasis>
+		<filename>/usr/local/matita</filename>) Runtime base directory
+		where all &appname; stuff (executables, configuration files,
+		standard library, ...) will be installed
+	      </para>
+	    </listitem>
+	  </varlistentry>
+
+	  <varlistentry>
+	    <term>
+	      <userinput>--with-dbhost=<replaceable>host</replaceable></userinput>
+	    </term>
+	    <listitem>
+	      <para>
+		(<emphasis>Default:</emphasis> 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.
+	      </para>
+	    </listitem>
+	  </varlistentry>
+
+	  <varlistentry>
+	    <term>
+	      <userinput>--enable-debug</userinput>
+	    </term>
+	    <listitem>
+	      <para>
+		(<emphasis>Default:</emphasis> disabled) Enable debugging code.
+		Not for the casual user.
+	      </para>
+	    </listitem>
+	  </varlistentry>
+	</variablelist>
+
+      <para> Then you will manage the build and install process using
+	<application><ulink type="http"
+	    url="http://www.gnu.org/software/make/">make</ulink></application>
+	as usual. Below are reported the targets you have to invoke in sequence
+	to build and install:
+      </para>
+
+	<variablelist>
+	  <title><application>make</application> targets</title>
+
+	  <varlistentry>
+	    <term><userinput>world</userinput></term>
+	    <listitem>
+	      <para>builds components needed by &appname; and &appname; itself
+		(in bytecode or native code depending
+		on the availability of the OCaml native code compiler) </para>
+	    </listitem>
+	  </varlistentry>
+
+	  <varlistentry>
+	    <term><userinput>install</userinput></term>
+	    <listitem>
+	      <para>installs &appname; related tools, standard library and the
+		needed runtime stuff in the proper places on the filesystem.
+	      </para>
+	      <para>As a part of the installation process the &appname;
+		standard library will be compiled, thus testing that the just
+		built <application>matitac</application> compiler works
+		properly.</para>
+	      <para>For this step you will need a working SQL database (for
+		indexing the standard library while you are compiling it). See
+		<ulink type="http" url="#database_setup">Database setup</ulink>
+		for instructions on how to set it up.
+	      </para>
+	    </listitem>
+	  </varlistentry>
+
+	</variablelist>
+      
+    </sect2>
+
+  </sect1>
 
-    </sect3>
+  <sect1 id="matita.conf.xml">
+    <title>Configuring Matita</title>
+    <para>
+    The file <emphasis>matita.conf.xml</emphasis>...
+    &TODO;
+    </para>
+  </sect1>
 
-  </sect2>
-</sect1>
+</chapter>