source: trunk/documents/UserDoc/DocBookUsersGuides/ForApplicationDeveloper/xml/GettingStarted/makeFile.xml@ 1213

<!-- ******************************************************** -->
<!--                                                          -->
<!--  [History]                                               -->
<!--    Changed by: Katsuya Amako, 16-Nov-1998                -->
<!--    Changed by: Dennis Wright, 28-Nov-2001                -->
<!--    Proof read by: Joe Chuma,  16-Jun-1999                -->
<!--    Converted to DocBook: Katsuya Amako, Aug-2006         -->
<!--                                                          -->
<!-- ******************************************************** -->


<!-- ******************* Section (Level#1) ****************** -->
<sect1 id="sect.HowToMakeExec">
<title>
How to Make an Executable Program
</title>

<!-- ******************* Section (Level#2) ****************** -->
<sect2 id="sect.HowToMakeExec.UNIX">
<title>
Building ExampleN01 in a UNIX Environment
</title>

<para>
The code for the user examples in Geant4 is placed in the directory
<literal>$G4INSTALL/examples</literal>, where <literal>$G4INSTALL</literal> is the
environment variable set to the place where the Geant4 distribution
is installed (set by default to <literal>$HOME/geant4</literal>). In the
following sections, a quick overview on how the GNUmake mechanism
works in Geant4 will be given, and we will show how to build a
concrete example, "ExampleN01", which is part of the Geant4
distribution.
</para>

<!-- ******************* Section (Level#3) ****************** -->
<sect3 id="sect.HowToMakeExec.UNIX.HowGNUmakeWorks">
<title>
How GNUmake works in Geant4
</title>

<para>
The GNUmake process in Geant4 is mainly controlled by the following
GNUmake script files (<literal>*.gmk</literal> scripts are placed in 
<literal>$G4INSTALL/config</literal>):

<variablelist>
  <varlistentry>
    <term><literal>architecture.gmk</literal></term>
    <listitem>
    invoking and defining all the architecture specific settings
    and paths which are stored in <literal>$G4INSTALL/config/sys</literal>.
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>common.gmk</literal></term>
    <listitem>
    defining all general GNUmake rules for building objects and libraries
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>globlib.gmk</literal></term>
    <listitem>
    defining all general GNUmake rules for building compound libraries
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>binmake.gmk</literal></term>
    <listitem>
    defining the general GNUmake rules for building executables
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>GNUmakefile</literal></term>
    <listitem>
    placed inside each directory in the Geant4 distribution and defining 
    directives specific to build a library, a set of sub-libraries, or 
    an executable.
    </listitem>
  </varlistentry>
</variablelist>
</para>

<para>
Kernel libraries are placed by default in
<literal>$G4INSTALL/lib/$G4SYSTEM</literal>, where <literal>$G4SYSTEM</literal>
specifies the system architecture and compiler in use. Executable
binaries are placed in <literal>$G4WORKDIR/bin/$G4SYSTEM</literal>, and
temporary files (object-files and data products of the compilation
process) in <literal>$G4WORKDIR/tmp/$G4SYSTEM</literal>. <literal>$G4WORKDIR</literal>
(set by default to <literal>$G4INSTALL</literal>) should be set by the user
to specify the place his/her own workdir for Geant4 in the user
area.
</para>

<para>
For more information on how to build Geant4 kernel libraries and
set up the correct environment for Geant4, refer to the
"Installation Guide".
</para>

</sect3>

<!-- ******************* Section (Level#3) ****************** -->
<sect3 id="sect.HowToMakeExec.UNIX.BuildExec">
<title>
Building the executable</title>

<para>
The compilation process to build an executable, such as an example
from <literal>$G4INSTALL/examples</literal>, is started by invoking the
"make" command from the (sub)directory in which you are
interested. To build, for instance, exampleN01 in your
<literal>$G4WORKDIR</literal> area, you should copy the module
<literal>$G4INSTALL/examples</literal> to your <literal>$G4WORKDIR</literal> 
and do the following actions:

<informalexample>
<programlisting>
  &gt; cd $G4WORKDIR/examples/novice/N01
  &gt; gmake
</programlisting>
</informalexample>
</para>

<para>
This will create, in <literal>$G4WORKDIR/bin/$G4SYSTEM</literal>, the
"exampleN01" executable, which you can invoke and run. You should
actually add <literal>$G4WORKDIR/bin/$G4SYSTEM</literal> to
<literal>$PATH</literal> in your environment.
</para>

</sect3>
</sect2>


<!-- ******************* Section (Level#2) ****************** -->
<sect2 id="sect.HowToMakeExec.Windows">
<title>
Building ExampleN01 in a Windows Environment
</title>

<para>
The procedure to build a Geant4 executable on a system based on a
Windows system is similar to what should be done on a UNIX based
system, assuming that your system is equipped with GNUmake,
MS-Visual C++ compiler and the required software to run Geant4 (see
"Installation Guide").
</para>


<!-- ******************* Section (Level#3) ****************** -->
<sect3 id="sect.HowToMakeExec.Windows.BuildExec">
<title>
Building the executable
</title>

<para>
See paragraph <xref linkend="sect.HowToMakeExec.UNIX" />.
</para>



</sect3>
</sect2>
</sect1>