ia64/xen-unstable

view docs/src/user.tex @ 7727:d7bcc7bbf981

Fix region0 virtual accesses
Signed-off by: Dan Magenheimer <dan.magenheimer@hp.com>
author djm@kirby.fc.hp.com
date Fri Nov 11 12:51:08 2005 -0600 (2005-11-11)
parents 06d84bf87159
children 79e8991af6b4
line source
1 \documentclass[11pt,twoside,final,openright]{report}
2 \usepackage{a4,graphicx,html,parskip,setspace,times,xspace}
3 \setstretch{1.15}
6 \def\Xend{{Xend}\xspace}
7 \def\xend{{xend}\xspace}
9 \latexhtml{\newcommand{\path}[1]{{\small {\tt #1}}}}{\newcommand{\path}[1]{{\tt #1}}}
13 \begin{document}
15 % TITLE PAGE
16 \pagestyle{empty}
17 \begin{center}
18 \vspace*{\fill}
19 \includegraphics{figs/xenlogo.eps}
20 \vfill
21 \vfill
22 \vfill
23 \begin{tabular}{l}
24 {\Huge \bf Users' manual} \\[4mm]
25 {\huge Xen v2.0 for x86} \\[80mm]
27 {\Large Xen is Copyright (c) 2002-2004, The Xen Team} \\[3mm]
28 {\Large University of Cambridge, UK} \\[20mm]
29 \end{tabular}
30 \end{center}
32 {\bf
33 DISCLAIMER: This documentation is currently under active development
34 and as such there may be mistakes and omissions --- watch out for
35 these and please report any you find to the developer's mailing list.
36 Contributions of material, suggestions and corrections are welcome.
37 }
39 \vfill
40 \cleardoublepage
42 % TABLE OF CONTENTS
43 \pagestyle{plain}
44 \pagenumbering{roman}
45 { \parskip 0pt plus 1pt
46 \tableofcontents }
47 \cleardoublepage
49 % PREPARE FOR MAIN TEXT
50 \pagenumbering{arabic}
51 \raggedbottom
52 \widowpenalty=10000
53 \clubpenalty=10000
54 \parindent=0pt
55 \parskip=5pt
56 \renewcommand{\topfraction}{.8}
57 \renewcommand{\bottomfraction}{.8}
58 \renewcommand{\textfraction}{.2}
59 \renewcommand{\floatpagefraction}{.8}
60 \setstretch{1.1}
63 \part{Introduction and Tutorial}
65 %% Chapter Introduction moved to introduction.tex
66 \include{src/user/introduction}
68 %% Chapter Installation moved to installation.tex
69 \include{src/user/installation}
71 %% Chapter Starting Additional Domains moved to start_addl_dom.tex
72 \include{src/user/start_addl_dom}
74 %% Chapter Domain Management Tools moved to domain_mgmt.tex
75 \include{src/user/domain_mgmt}
77 %% Chapter Domain Filesystem Storage moved to domain_filesystem.tex
78 \include{src/user/domain_filesystem}
82 \part{User Reference Documentation}
84 %% Chapter Control Software moved to control_software.tex
85 \include{src/user/control_software}
87 %% Chapter Domain Configuration moved to domain_configuration.tex
88 \include{src/user/domain_configuration}
90 %% Chapter Build, Boot and Debug Options moved to build.tex
91 \include{src/user/build}
94 \chapter{Further Support}
96 If you have questions that are not answered by this manual, the
97 sources of information listed below may be of interest to you. Note
98 that bug reports, suggestions and contributions related to the
99 software (or the documentation) should be sent to the Xen developers'
100 mailing list (address below).
102 \section{Other Documentation}
104 For developers interested in porting operating systems to Xen, the
105 {\em Xen Interface Manual} is distributed in the \path{docs/}
106 directory of the Xen source distribution.
108 %Various HOWTOs are available in \path{docs/HOWTOS} but this content is
109 %being integrated into this manual.
112 \section{Online References}
114 The official Xen web site is found at:
115 \begin{quote}
116 {\tt http://www.cl.cam.ac.uk/netos/xen/}
117 \end{quote}
119 This contains links to the latest versions of all on-line
120 documentation (including the lateset version of the FAQ).
123 \section{Mailing Lists}
125 There are currently four official Xen mailing lists:
127 \begin{description}
128 \item[xen-devel@lists.xensource.com] Used for development
129 discussions and bug reports. Subscribe at: \\
130 {\small {\tt http://lists.xensource.com/xen-devel}}
131 \item[xen-users@lists.xensource.com] Used for installation and usage
132 discussions and requests for help. Subscribe at: \\
133 {\small {\tt http://lists.xensource.com/xen-users}}
134 \item[xen-announce@lists.xensource.com] Used for announcements only.
135 Subscribe at: \\
136 {\small {\tt http://lists.xensource.com/xen-announce}}
137 \item[xen-changelog@lists.xensource.com] Changelog feed
138 from the unstable and 2.0 trees - developer oriented. Subscribe at: \\
139 {\small {\tt http://lists.xensource.com/xen-changelog}}
140 \end{description}
144 \appendix
146 %% Chapter Installing Xen / XenLinux on Debian moved to debian.tex
147 \include{src/user/debian}
149 %% Chapter Installing Xen on Red Hat moved to redhat.tex
150 \include{src/user/redhat}
153 %% Chapter Glossary of Terms moved to glossary.tex
154 \include{src/user/glossary}
157 \end{document}
160 %% Other stuff without a home
162 %% Instructions Re Python API
164 %% Other Control Tasks using Python
165 %% ================================
167 %% A Python module 'Xc' is installed as part of the tools-install
168 %% process. This can be imported, and an 'xc object' instantiated, to
169 %% provide access to privileged command operations:
171 %% # import Xc
172 %% # xc = Xc.new()
173 %% # dir(xc)
174 %% # help(xc.domain_create)
176 %% In this way you can see that the class 'xc' contains useful
177 %% documentation for you to consult.
179 %% A further package of useful routines (xenctl) is also installed:
181 %% # import xenctl.utils
182 %% # help(xenctl.utils)
184 %% You can use these modules to write your own custom scripts or you can
185 %% customise the scripts supplied in the Xen distribution.
189 % Explain about AGP GART
192 %% If you're not intending to configure the new domain with an IP address
193 %% on your LAN, then you'll probably want to use NAT. The
194 %% 'xen_nat_enable' installs a few useful iptables rules into domain0 to
195 %% enable NAT. [NB: We plan to support RSIP in future]
200 %% Installing the file systems from the CD
201 %% =======================================
203 %% If you haven't got an existing Linux installation onto which you can
204 %% just drop down the Xen and Xenlinux images, then the file systems on
205 %% the CD provide a quick way of doing an install. However, you would be
206 %% better off in the long run doing a proper install of your preferred
207 %% distro and installing Xen onto that, rather than just doing the hack
208 %% described below:
210 %% Choose one or two partitions, depending on whether you want a separate
211 %% /usr or not. Make file systems on it/them e.g.:
212 %% mkfs -t ext3 /dev/hda3
213 %% [or mkfs -t ext2 /dev/hda3 && tune2fs -j /dev/hda3 if using an old
214 %% version of mkfs]
216 %% Next, mount the file system(s) e.g.:
217 %% mkdir /mnt/root && mount /dev/hda3 /mnt/root
218 %% [mkdir /mnt/usr && mount /dev/hda4 /mnt/usr]
220 %% To install the root file system, simply untar /usr/XenDemoCD/root.tar.gz:
221 %% cd /mnt/root && tar -zxpf /usr/XenDemoCD/root.tar.gz
223 %% You'll need to edit /mnt/root/etc/fstab to reflect your file system
224 %% configuration. Changing the password file (etc/shadow) is probably a
225 %% good idea too.
227 %% To install the usr file system, copy the file system from CD on /usr,
228 %% though leaving out the "XenDemoCD" and "boot" directories:
229 %% cd /usr && cp -a X11R6 etc java libexec root src bin dict kerberos local sbin tmp doc include lib man share /mnt/usr
231 %% If you intend to boot off these file systems (i.e. use them for
232 %% domain 0), then you probably want to copy the /usr/boot directory on
233 %% the cd over the top of the current symlink to /boot on your root
234 %% filesystem (after deleting the current symlink) i.e.:
235 %% cd /mnt/root ; rm boot ; cp -a /usr/boot .