Release coccinelle-0.2.3rc1

[bpt/coccinelle.git] / docs / manual / main.tex

\documentclass{report}

%******************************************************************************
% Prelude
%******************************************************************************
%------------------------------------------------------------------------------
% Packages
%------------------------------------------------------------------------------

\usepackage{ifthen}
\usepackage{hevea}

\usepackage{times}
\usepackage{fullpage}

\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}

\usepackage{amsmath}
\usepackage{amssymb}

% fancy symbol, but require latex-extra-fonts (huge) package
\usepackage[geometry]{ifsym}



\usepackage{graphics}
\usepackage[pdftex]{graphicx}


\usepackage{epsfig}
\usepackage{subfigure}
\usepackage{wrapfig}

\usepackage[all]{xy}


\usepackage{fancyvrb}
\usepackage{moreverb}
\usepackage{alltt}

\usepackage{boxedminipage}

\usepackage{xspace}
\usepackage{endnotes}

\usepackage{multirow}
%\usepackage{colortbl} % conflict with color package below

\usepackage{listings}
%\usepackage{code/lgrind}

\usepackage[pdfborder={0 0 0}]{hyperref}
%\usepackage{url}

\usepackage[usenames,dvipsnames]{color}

%------------------------------------------------------------------------------
% Shortcuts
%------------------------------------------------------------------------------

\input{macros_common}
%e.g:
%  \newcommand{\mita}[1]{\mbox{\it{{#1}}}}

\input{macros_options}

\input{macros_listing_cocci} % order is important
\input{macros_grammar}


%------------------------------------------------------------------------------
% Globals
%------------------------------------------------------------------------------
\input{macros}
%e.g:
% \newcommand{\avgcorrect}{96\%\xspace} % if consider all files
% \newcommand{\MyTool}{aComment\xspace}
% \newcommand{\bugsfound}{XXX\xspace}


%******************************************************************************
% Title
%******************************************************************************
\begin{document}
%don't want date printed
\date{}

%------------------------------------------------------------------------------
\title{
{\Huge \bf Coccinelle}\\
{User's manual}\\
{release \cocciversion}\\
}
%\title{\spatch and \sgrep manual}

\author{
Julia Lawall and Yoann Padioleau \\
{(with contributions from
Rene Rydhof Hansen,
Nicolas Palix,
Henrik Stuart)
}
}
%src: Xavier Leroy manual

\date{\today}

\maketitle
\tableofcontents

%******************************************************************************
% Body
%******************************************************************************

\chapter*{Foreword}

This manual documents the release \cocciversion of Coccinelle.
It is organized as follows:
\begin{itemize}
  \item Part~\ref{part:usermanual} is an introduction to Coccinelle
  \item Part~\ref{part:refmanual} is the reference description
    of Coccinelle, its language and command line tool.
\end{itemize}

\section*{Conventions}

\section*{Copyright}

%coupling: copyright.txt
Coccinelle copyright is\\
\copyright~2010, University of Copenhagen DIKU and INRIA.\\
\copyright~2005-2009, University of Copenhagen DIKU and Ecole des Mines de Nantes.

Coccinelle is open source and can be freely redistributed under the
terms of the GNU General Public License version 2. See the file
\verb+license.txt+ in the distribution for licensing information.\\

\noindent
Copyright \copyright~2010,  Nicolas Palix, Julia Lawall, and Gilles Muller\\
Copyright \copyright~2008, 2009, Yoann Padioleau, Nicolas Palix, Julia Lawall, and Gilles Muller\\
    Permission is granted to copy, distribute and/or modify this document
    under the terms of the GNU Free Documentation License, Version 1.3;
    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".

\section*{Availability}

Coccinelle can be freely downloaded
from \url{http://coccinelle.lip6.fr}.\\
This website contains also additional information and a wiki website.


\part{User Manual}
\label{part:usermanual}

\input{introduction}

\input{installing}

\input{tutorial}

\chapter{Examples}
\input{examples}
\input{tips}


\input{isomorphisms}

\input{parsing}


\input{workflow}

\input{advanced}




\part{Reference Manual}
\label{part:refmanual}

\chapter{SmPL grammar}

\input{cocci_syntax}

\chapter{\spatch command line options}

%coupling: ../spatch.1
\input{spatch_options}

%******************************************************************************
% Appendix
%******************************************************************************

\part{Appendix}

\chapter*{GNU Free Documentation License}

\input{license.txt}
%index

{\small
\bibliographystyle{acm}
\bibliography{main}
}


%******************************************************************************
% Postlude
%******************************************************************************

\end{document}

%%% Local Variables:
%%% mode: LaTeX
%%% TeX-master: t
%%% coding: utf-8
%%% TeX-PDF-mode: t
%%% ispell-local-dictionary: "american"
%%% End: