\input texinfo   @c -*-texinfo-*-

@c %**start of header
@setfilename sgpem2uman.info
@settitle SGPEMv2 User Manual
@include version.texi
@c %**end of header

@c % --------------------------------------------------

@copying 
This is SGPEMv2 Manual (version @value{VERSION}, 
@value{UPDATED}).

Copyright @copyright{} 2005 University of Padova, dept. of Pure 
and Applied Mathematics

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts.  A copy of the license is included in the section entitled ``GNU
Free Documentation License''.
@end copying

@c % --------------------------------------------------

@titlepage
@title  SGPEMv2 User Manual
@subtitle for version @value{VERSION}, @value{UPDATED}
@author Giovanni Giacobbi (@email{ggiacobb@@studenti.math.unipd.it})
@author Filippo Paparella (@email{ironpipp@@gmail.com})
@author Paolo Santi (@email{psanti@@studenti.math.unipd.it})
@author Matteo Settenvini (@email{matteo@@member.fsf.org})
@author Marco Trevisan (@email{evenjn@@gmail.com})
@author Djina Verbanac (@email{betalgez@@yahoo.com})
@author Luca Vezzaro (@email{lvezzaro@@studenti.math.unipd.it})
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
  
@c Output the table of contents at the beginning.
@contents

@c % --------------------------------------------------

@c SGPEMv2 User Manual

@c % --------------------------------------------------

@ifnottex
@node Top, History, (none), (dir)
@top SGPEM v2 User Manual
  
@insertcopying
@end ifnottex

@menu

* History::       The history of changes to this document.

* What is SGPEM:: Description and objectives of SGPEM v2.

* Installation::  Here we explain how to install SGPEM v2,
		  as well as providing some advice for 
                  believed-to-be useful compilation options.

* License:: A full copy of the GNU Free Documentation License 
            this manual is licensed into.

* Concept index:: Complete index.
@end menu


@c % --------------------------------------------------

@node       History, What is SGPEM, Top, Top
@unnumbered History

@table @strong

@item 2005, December 11th @r{--- Matteo Settenvini}
Added full license text.

@item 2005, November 8th @r{--- Matteo Settenvini}
First draft of this document.

@end table


@c % --------------------------------------------------

@node    What is SGPEM, Installation, History, Top
@chapter What is SGPEM

@menu
* Description and aims::
* Features::
@end menu

@c % --------------------------------------------------

@node    Description and aims, Features, What is SGPEM, What is SGPEM
@section Description and aims
@cindex  SGPEM
@cindex  description

SGPEM is an Italian acronym, standing for ``@emph{Simulatore della Gestione dei Processi in un Elaboratore Multiprogrammato}'' (in English, 
``@emph{Multitasking Computer Process Management Simulator}'').
It was initially developed for use inside the Course in Computer Science
of the Padova University, Italy.

SGPEMv2 is a didactic software aiming...

@c % --------------------------------------------------

@node    Features, (none), Description and aims, What is SGPEM
@section Features
@cindex  features

Main features are:

@itemize 
@item
Graphical display of simulated processes...

@end itemize

@c % --------------------------------------------------

@node    Installation, License, What is SGPEM, Top
@chapter Installation
@cindex  installation

@menu
* Prerequisites:: Programs and libraries needed to 
		  compile and run SGPEM

* Building::      Help for compiling SGPEM on 
		  your platform.

@end menu

@c % --------------------------------------------------

@node    Prerequisites, Building, Installation, Installation
@section Prerequisites
@cindex  requirements

Some software is needed in order to build and install SGPEM on your
personal computer.
This is the list; if you find it misses something / it lists 
the wrong version of a program, please let us know!

@itemize
@item 
@emph{GCC with C++ support}, as well as the other standard 
GNU tools: make, sed, ld... GCC version >=3.4 is highly
recommended. Please don't report compiling-related 
problems with any previous version.

@item
@emph{libXML2 >= 2.6.15} : we need this to parse saved files.
@dots{}
@c cairo? gtkmm? and so on...

@end itemize


@c % --------------------------------------------------

@node    Building, (none), Prerequisites, Installation
@section Building
@cindex  compiling

@noindent To ensure a clean build, follow these steps:

@example 
@code{cd <this directory>}
@code{mkdir =build}
@code{cd =build}
@code{CXXFLAGS="what you want" ../configure --prefix=/usr/local}
@end example
@sp 2

@noindent This will check you have all the needed software installed.

@noindent Choosing good @env{CXXFLAGS} to optimize your build. 
For example, on my machine, I would use: 
@example 
@code{CXXFLAGS="-O3 -pipe -march=pentium4" ../configure --prefix=/usr/local}
@end example
@sp 2

@noindent Being a developer, though, if I had to debug SGPEM, I would type:
@example
@code{CXXFLAGS="-O0 -g -ggdb -pg" ../configure \}
@code{             --prefix=`pwd`/_inst --disable-shared}
@end example
@sp 2

@noindent Once succesfully configured Stradivari, just type:
@example
@command{make}
@end example
@sp 2

@noindent And upon a succesful build, you can install it just by:
@example
@code{su -c "make install"}
@end example
@sp 2

@noindent Root password will be required (of course, if you're 
installing it with a prefix places inside your home directory, 
you won't need administrative rights, and just ``@samp{make install}'' 
will sufficit).

See the ``@file{INSTALL}'' file in this folder for an overview of other 
(less common) autoconf options.

@c % --------------------------------------------------

@c include license text
@node License, Concept index, Installation, Top
@include fdl.texi

@c % --------------------------------------------------

@node   Concept index, (none), License, Top
@unnumbered Index
     
@printindex cp
     
@bye