From d2e81c31f896ed173d0003bae52575355b01bab6 Mon Sep 17 00:00:00 2001 From: Keir Fraser Date: Wed, 24 Sep 2008 10:17:18 +0100 Subject: xm docs: Added new,delete,dump-core,resume,suspend,uptime and fixed others Signed-off-by: Bill Rieske --- docs/man/xm.pod.1 | 306 +++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 268 insertions(+), 38 deletions(-) (limited to 'docs/man/xm.pod.1') diff --git a/docs/man/xm.pod.1 b/docs/man/xm.pod.1 index 74b58dbf14..ad36fce6ab 100644 --- a/docs/man/xm.pod.1 +++ b/docs/man/xm.pod.1 @@ -67,13 +67,12 @@ The attached console will perform much like a standard serial console, so running curses based interfaces over the console B. Vi tends to get very odd when using it over this interface. -=item B [B<-c>] I [I=I].. +=item B I [I] [I].. -The create sub command requires a config file and can optionally take a -series of name value pairs that add to or override variables defined +The create subcommand requires a config file and can optionally take a +series of I that add to or override variables defined in the config file. See L for full details of that file -format, and possible options used in either the configfile or -I=I combinations. +format, and possible options used in either the configfile or for I. I can either be an absolute path to a file, or a relative path to a file located in /etc/xen. @@ -86,9 +85,65 @@ B =over 4 -=item B<-c> +=item B<--help_config> -Attache console to the domain as soon as it has started. This is +Print the available configuration variables I. These variables may be +used on the command line or in the configuration file I. + +=item B<-q>, B<--quiet> + +No console output. + +=item B<--path> + +Search path for configuration scripts. The value of PATH is a +colon-separated directory list. + +=item B<-f=FILE>, B<--defconfig=FILE> + +Use the given Python configuration script. The configuration +script is loaded after arguments have been processed. Each +command-line option sets a configuration variable named after +its long option name, and these variables are placed in the +environment of the script before it is loaded. Variables +for options that may be repeated have list values. Other +variables can be set using name=value on the command line. +After the script is loaded, option values that were not set +on the command line are replaced by the values set in the script. + +=item B<-F=FILE>, B<--config=FILE> + +Use the given SXP formated configuration script. +SXP is the underlying configuration format used by Xen. +SXP configuration scripts can be hand-written or generated +from Python configuration scripts, using the -n +(dryrun) option to print the configuration. An SXP formatted +configuration file may also be generated for a given I by +redirecting the output from the the B> +to a file. + +=item B<-n>, B<--dryrun> + +Dry run - prints the resulting configuration in SXP +but does not create the domain. + +=item B<-x>, B<--xmldryrun> + +XML dry run - prints the resulting configuration in +XML but does not create the domain. + +=item B<-s>, B<--skipdtd> + +Skip DTD checking - skips checks on XML before +creating. Experimental. Can decrease create time. + +=item B<-p>, B<--paused> + +Leave the domain paused after it is created. + +=item B<-c>, B<--console_autoconnect> + +Attach console to the domain as soon as it has started. This is useful for determining issues with crashing domains. =back @@ -118,6 +173,11 @@ virtual networking. (This example comes from the xm-test test suite.) =back +=item B + +Remove a domain from Xend domain management. The B command +shows the domain names. + =item B I Immediately terminate the domain I. This doesn't give the @@ -133,6 +193,28 @@ Converts a domain name to a domain id using xend's internal mapping. Converts a domain id to a domain name using xend's internal mapping. +=item B [I] I [I] + +Dumps the virtual machine's memory for the specified domain to the +I specified. The dump file will be written to a distribution +specific directory for dump files. Such as: /var/lib/xen/dump or +/var/xen/dump Defaults to dumping the core without pausing the domain +if no I are specified. + +B + +=over 4 + +=item B<-L>, B<--live> + +Dump core without pausing the domain. + +=item B<-C>, B<--crash> + +Crash domain after dumping core. + +=back + =item B [B<--long>] Displays the short help message (i.e. common commands). @@ -140,11 +222,36 @@ Displays the short help message (i.e. common commands). The B<--long> option prints out the complete set of B subcommands, grouped by function. -=item B [B<--long> | B<--label>] [I ...] +=item B [I] [I ...] Prints information about one or more domains. If no domains are specified it prints out information about all domains. + +B + +=over 4 + +=item B<-l>, B<--long> + +The output for B is not the table view shown below, but +instead presents the data in SXP format. + +=item B<--label> + +Security labels are added to the output of xm list and the lines +are sorted by the labels (ignoring case). +See the ACCESS CONTROL SUBCOMMAND section of this man page for more +information about labels. + +=item B<--state=> + +Output information for VMs in the specified state. + +=back + +B + An example format for the list is as follows: Name ID Mem(MiB) VCPUs State Time(s) @@ -164,11 +271,11 @@ Xen. B -=over 4 - The State field lists 6 states for a Xen domain, and which ones the current domain is in. +=over 4 + =item B The domain is currently running on a CPU. @@ -205,32 +312,6 @@ FIXME: Is this right? =back -B - -=over 4 - -If B<--long> is specified, the output for B is not the table -view shown above, but instead is an S-Expression representing all -information known about all domains asked for. This is mostly only -useful for external programs to parse the data. - -B There is no stable guarantees on the format of this data. -Use at your own risk. - -=back - -B