ia64/xen-unstable

changeset 8244:cb2012e7e01d

Mention udev, clean up xm help section, mention network-nat and network-route
scripts and the fact that network is now called network-bridge.

Signed-off-by: Ewan Mellor <ewan@xensource.com>
author emellor@leeni.uk.xensource.com
date Mon Dec 05 15:30:10 2005 +0000 (2005-12-05)
parents 7729efa06812
children 052e18d41ead 1e6fa31fb780
files docs/src/user.tex
line diff
     1.1 --- a/docs/src/user.tex	Mon Dec 05 14:02:01 2005 +0100
     1.2 +++ b/docs/src/user.tex	Mon Dec 05 15:30:10 2005 +0000
     1.3 @@ -23,8 +23,6 @@
     1.4  \begin{tabular}{l}
     1.5  {\Huge \bf Users' Manual} \\[4mm]
     1.6  {\huge Xen v3.0} \\[80mm]
     1.7 -{\Large Xen is Copyright (c) 2002-2005, The Xen Team} \\[3mm]
     1.8 -{\Large University of Cambridge, UK} \\[20mm]
     1.9  \end{tabular}
    1.10  \end{center}
    1.11  
    1.12 @@ -36,6 +34,24 @@ on-line. Contributions of material, sugg
    1.13  welcome.}
    1.14  
    1.15  \vfill
    1.16 +\clearpage
    1.17 +
    1.18 +
    1.19 +% COPYRIGHT NOTICE
    1.20 +\pagestyle{empty}
    1.21 +
    1.22 +\vspace*{\fill}
    1.23 +
    1.24 +Xen is Copyright \copyright  2002-2005, University of Cambridge, UK, XenSource
    1.25 +Inc., IBM Corp., Hewlett-Packard Co., Intel Corp., AMD Inc., and others.  All
    1.26 +rights reserved.
    1.27 +
    1.28 +Xen is an open-source project.  Most portions of Xen are licensed for copying
    1.29 +under the terms of the GNU General Public License, version 2.  Other portions
    1.30 +are licensed under the terms of the GNU Lesser General Public License, the
    1.31 +Zope Public License 2.0, or under ``BSD-style'' licenses.  Please refer to the
    1.32 +COPYING file for details.
    1.33 +
    1.34  \cleardoublepage
    1.35  
    1.36  
    1.37 @@ -81,8 +97,6 @@ functionality, including:
    1.38    drivers). 
    1.39  \end{itemize}
    1.40  
    1.41 -Xen is licensed under the GNU General Public License (GPL2).
    1.42 -
    1.43  
    1.44  \section{Usage Scenarios}
    1.45  
    1.46 @@ -268,7 +282,9 @@ if you wish to build from source.
    1.47        http://bridge.sourceforge.net}} (e.g., \path{/sbin/brctl})
    1.48  \item [$\dag$] The Linux hotplug system\footnote{Available from {\tt
    1.49        http://linux-hotplug.sourceforge.net/}} (e.g.,
    1.50 -  \path{/sbin/hotplug} and related scripts)
    1.51 +      \path{/sbin/hotplug} and related scripts).  On newer distributions,
    1.52 +      this is included alongside the Linux udev system\footnote{See {\tt
    1.53 +      http://www.kernel.org/pub/linux/utils/kernel/hotplug/udev.html/}}.
    1.54  \item [$*$] Build tools (gcc v3.2.x or v3.3.x, binutils, GNU make).
    1.55  \item [$*$] Development installation of zlib (e.g.,\ zlib-dev).
    1.56  \item [$*$] Development installation of Python v2.2 or later (e.g.,\
    1.57 @@ -920,18 +936,6 @@ syslog files, are useful when troublesho
    1.58  \section{Xm}
    1.59  \label{s:xm}
    1.60  
    1.61 -Command line management tasks are performed using the \path{xm}
    1.62 -tool. For online help for the commands available, type:
    1.63 -
    1.64 -\begin{quote}
    1.65 -\begin{verbatim}
    1.66 -# xm help
    1.67 -\end{verbatim}
    1.68 -\end{quote}
    1.69 -
    1.70 -You can also type \path{xm help $<$command$>$} for more information on a
    1.71 -given command.
    1.72 -
    1.73  The xm tool is the primary tool for managing Xen from the console. The
    1.74  general format of an xm command line is:
    1.75  
    1.76 @@ -947,11 +951,22 @@ used, including the standard variables d
    1.77  variables (for instance, the \path{xmdefconfig} file uses a {\tt vmid}
    1.78  variable).
    1.79  
    1.80 +For online help for the commands available, type:
    1.81 +
    1.82 +\begin{quote}
    1.83 +\begin{verbatim}
    1.84 +# xm help
    1.85 +\end{verbatim}
    1.86 +\end{quote}
    1.87 +
    1.88 +This will list the most commonly used commands.  The full list can be obtained
    1.89 +using \verb_xm help --long_.  You can also type \path{xm help $<$command$>$}
    1.90 +for more information on a given command.
    1.91 +
    1.92  \subsection{Basic Management Commands}
    1.93  
    1.94 -A complete list of \path{xm} commands is obtained by typing \texttt{xm
    1.95 -  help}. One useful command is \verb_# xm list_ which lists all
    1.96 -  domains running in rows of the following format:
    1.97 +One useful command is \verb_# xm list_ which lists all domains running in rows
    1.98 +of the following format:
    1.99  \begin{center} {\tt name domid memory vcpus state cputime}
   1.100  \end{center}
   1.101  
   1.102 @@ -1016,7 +1031,7 @@ for concrete examples.
   1.103  \item[vif] List of MAC addresses (random addresses are assigned if not
   1.104    given) and bridges to use for the domain's network interfaces, e.g.\ 
   1.105  \begin{verbatim}
   1.106 -vif = [ 'mac=aa:00:00:00:00:11, bridge=xen-br0',
   1.107 +vif = [ 'mac=00:16:3E:00:00:11, bridge=xen-br0',
   1.108          'bridge=xen-br1' ]
   1.109  \end{verbatim}
   1.110    to assign a MAC address and bridge to the first interface and assign
   1.111 @@ -1085,7 +1100,7 @@ section.
   1.112  \subsection{Xen networking scripts}
   1.113  
   1.114  Xen's virtual networking is configured by two shell scripts (by
   1.115 -default \path{network} and \path{vif-bridge}).  These are called
   1.116 +default \path{network-bridge} and \path{vif-bridge}).  These are called
   1.117  automatically by \xend\ when certain events occur, with arguments to
   1.118  the scripts providing further contextual information.  These scripts
   1.119  are found by default in \path{/etc/xen/scripts}.  The names and
   1.120 @@ -1093,7 +1108,7 @@ locations of the scripts can be configur
   1.121  \path{/etc/xen/xend-config.sxp}.
   1.122  
   1.123  \begin{description}
   1.124 -\item[network:] This script is called whenever \xend\ is started or
   1.125 +\item[network-bridge:] This script is called whenever \xend\ is started or
   1.126    stopped to respectively initialize or tear down the Xen virtual
   1.127    network. In the default configuration initialization creates the
   1.128    bridge `xen-br0' and moves eth0 onto that bridge, modifying the
   1.129 @@ -1109,6 +1124,8 @@ locations of the scripts can be configur
   1.130    default Xen bridge.
   1.131  \end{description}
   1.132  
   1.133 +Other example scripts are available (\path{network-route} and
   1.134 +\path{vif-route}, \path{network-nat} and \path{vif-nat}).
   1.135  For more complex network setups (e.g.\ where routing is required or
   1.136  integrate with existing bridges) these scripts may be replaced with
   1.137  customized variants for your site's preferred configuration.
   1.138 @@ -1301,7 +1318,7 @@ hope.  In particular, using lots of CoW 
   1.139  dom0 memory, and error conditions such as running out of disk space
   1.140  are not handled well. Hopefully this will improve in future.
   1.141  
   1.142 -To create two copy-on-write clone of the above file system you would
   1.143 +To create two copy-on-write clones of the above file system you would
   1.144  use the following commands:
   1.145  
   1.146  \begin{quote}