Add piplib.h.in file
[candl.git] / doc / candl.texi
blobf6c168b2c042fc8e7efcd79deed566de066578e9
1 \input texinfo
3 @c % /*************************************************************************
4 @c %  *                              PART I: HEADER                           *
5 @c %  *************************************************************************/
6 @setfilename candl.info
7 @settitle CAnDL: the Chunky Analyzer for Dependences in Loops
9 @set EDITION 0.1
10 @set VERSION 0.2.0
11 @set UPDATED July 16th 2008
12 @setchapternewpage odd
15 @c % /*************************************************************************
16 @c %  *                 PART II: SUMMARY DESCRIPTION AND COPYRIGHT            *
17 @c %  *************************************************************************/
19 @copying
20 This manual is dedicated to CAnDL version @value{VERSION}, a library
21 dependence analysis of polyhedral programs.
23 Copyright @copyright{} 2003-2008 Cedric Basoul.
25 @c quotation
26 Permission is granted to copy, distribute and/or modify this document under
27 the terms of the GNU Free Documentation License, Version 1.2
28 published by the Free Software Foundation. To receive a copy of the
29 GNU Free Documentation License, write to the Free Software Foundation, Inc.,
30 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA.
31 @c end quotation
32 @end copying
34 @c % /*************************************************************************
35 @c %  *                 PART III: TITLEPAGE, CONTENTS, COPYRIGHT              *
36 @c %  *************************************************************************/
37 @titlepage
38 @title CAnDL
39 @subtitle The Chunky Analyzer for Dependences in Loops
40 @subtitle Edition @value{EDITION}, for CAnDL @value{VERSION}
41 @subtitle @value{UPDATED}
42 @author Louis-No@"el Pouchet
44 @c The following two commands start the copyright page.
45 @page
47 @vskip 0pt plus 1filll
48 @insertcopying
49 @end titlepage
51 @c Output the table of contents at the beginning.
52 @contents
54 @c % /*************************************************************************
55 @c %  *                     PART IV: TOP NODE AND MASTER MENU                 *
56 @c %  *************************************************************************/
57 @ifnottex
58 @node Top
59 @top CAnDL
61 @insertcopying
62 @end ifnottex
64 @menu
65 * Introduction::
66 * Usage::
67 @c * FM Software::
68 @c * FM Library::
69 @c * Hacking::
70 @c * Installing::
71 @c * Documentation::
72 @c * References::
73 @end menu
77 @c % /*************************************************************************
78 @c %  *                       PART V: BODY OF THE DOCUMENT                    *
79 @c %  *************************************************************************/
81 @node Introduction
82 @chapter Introduction
84 There is a Doxygen documentation of the API available in
85 @code{doc/htmldoc.tar.gz}.
87 @c %%%%%
88 @section Installation of CAnDL
90 The installation of CAnDL follows the classical scheme. You can specify
91 the path of PIPLib to the configure script with @code{--with-piplib}
92 @footnote{The configure script will automatically detect the location of
93 dependencies if @emph{--prefix=path/to/dir} is specified and all
94 dependencies were installed in path/to/dir}.
96 @cartouche
97 @example
98 $> tar xzf candl-@value{VERSION}.tar.gz
99 $> cd candl-@value{VERSION}
100 $> ./configure --prefix=/path/to/be/installed
101 $> make
102 @end example
103 @end cartouche
106 The @code{make check} command can be used to make a test run of
107 CAnDL.
109 @cartouche
110 @example
111 $> make check
112 @end example
113 @end cartouche
116 The @code{make install} command can be used to install the library.
118 @cartouche
119 @example
120 $> make install
121 @end example
122 @end cartouche
124 @c % /*************************************************************************
125 @c % /*************************************************************************
127 @node Usage
128 @chapter Usage
130 This chapter describes briefly the input/output of CAnDL binary.
132 @section Input file design
136 @c % /*************************************************************************
137 @c %  *                       PART VI: END OF THE DOCUMENT                    *
138 @c %  *************************************************************************/
139 @c @unnumbered Index
141 @c @printindex cp
143 @bye