f9277c0f0ef1b2053e2b4425ec7c9860786f3568
[charm.git] / doc / install / manual.tex
1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 % RCS INFORMATION:
3 %
4 %       $RCSfile$
5 %       $Author$        $Locker$                $State$
6 %       $Revision$      $Date$
7 %
8 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9 % DESCRIPTION:
10 %
11 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12 % REVISION HISTORY:
13 %
14 % $Log$
15 % Revision 1.9  2000-06-22 22:21:08  milind
16 % Added table of contents to the PDF file, and also cleaned up the clean
17 % target.
18 %
19 % Revision 1.8  2000/06/22 15:04:53  milind
20 % Made compatible with pdflatex as well.
21 %
22 % Revision 1.7  1999/07/09 18:18:40  milind
23 % Updated for new release 5.0.
24 %
25 % Revision 1.6  1998/11/03 19:24:48  milind
26 % Added documentation for the new shell option in nodelist.
27 %
28 % Revision 1.5  1997/07/25 21:20:35  wilmarth
29 % Added IT Charm++ info.
30 %
31 % Revision 1.4  1996/10/01 18:19:51  milind
32 % Added a word , various..
33 %
34 % Revision 1.3  1995/11/17 17:48:18  brunner
35 % New title page, but I can't get rid of page number
36 %
37 % Revision 1.2  1995/11/01  20:02:08  milind
38 % *** empty log message ***
39 %
40 % Revision 1.1  1995/10/31  22:27:53  milind
41 % Initial revision
42 %
43 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
44
45 \documentstyle[11pt,fullpage]{article}
46
47 \newif\ifpdf
48 \ifx\pdfoutput\undefined
49   \pdffalse
50 \else
51   \pdfoutput=1
52   \pdftrue
53 \fi
54
55 \ifpdf
56   \pdfcompresslevel=9
57   \usepackage[pdftex,colorlinks=true,plainpages=false]{hyperref}
58 \else
59 \fi
60
61 \pagestyle{empty}
62 \setlength{\textwidth}{6.5in}
63 \setlength{\textheight}{9in}
64 \setlength{\parindent}{0in}
65 \setlength{\topmargin}{-.5in}
66 \parskip 0.1in
67 \newcommand{\zap}[1]{ }
68 \newcommand{\fcmd}{\bf}                 %%% Font for Charm commands
69 \newcommand{\fparm}{\bf\sf}             %%% Font for parameters to Charm commands
70 \newcommand{\fexec}{\bf}                %%% Font for compile/execute cmds/options
71
72 \begin{document}
73  
74 \begin{titlepage}
75
76 \title{
77 \vspace*{3in}
78 Charm/Charm++/Converse Installation and Usage
79 }
80
81 \author{Parallel Programming Laboratory\\
82         Department of Computer Science\\
83         University of Illinois at Urbana--Champaign}
84 \date{\today}
85
86 \maketitle
87
88 \end{titlepage}
89
90 \newpage
91 \pagestyle{headings}
92
93 \section{Introduction}
94 In this manual, we describe how to install Charm++ and
95 Converse, how to compile and execute programs, and the available
96 command line options.  We also describe various queueing and load balancing
97 strategies, and the various modes of execution of Converse and Charm++
98 programs.
99
100 \include{install}
101 \include{compile}
102 \include{run}
103
104 \end{document}