# HG changeset patch # User kfraser@localhost.localdomain # Date 1183729502 -3600 # Node ID daa07db3ca845c9b08415d19a4d888902abf8321 # Parent d49e6a814d9a4cc8b136b599b77557920abd7921 docs: update xm man page - Fixed description of "Mem" column in "xm list" output. - Added a bit of text for the credit scheduler. - Described the --force option to block-detach. - Made formatting and spelling more consistent. - etc... Signed-off-by: Charles Coffing --- a/docs/man/xm.pod.1 Fri Jul 06 14:43:51 2007 +0100 +++ b/docs/man/xm.pod.1 Fri Jul 06 14:45:02 2007 +0100 @@ -4,7 +4,7 @@ xm - Xen management user interface =head1 SYNOPSIS -xm [args] +B I [I] =head1 DESCRIPTION @@ -13,46 +13,50 @@ domains. It can also be used to list cur domains. It can also be used to list current domains, enable or pin VCPUs, and attach or detach virtual block devices. -The basic structure of every xm command is almost always: - - xm [OPTIONS] - -Where I is one of the sub commands listed below, I +The basic structure of every B command is almost always: + +=over 2 + +B I I [I] + +=back + +Where I is one of the subcommands listed below, I is the numeric domain id, or the domain name (which will be internally -translated to domain id), and I are sub command specific +translated to domain id), and I are subcommand specific options. There are a few exceptions to this rule in the cases where -the sub command in question acts on all domains, the entire machine, -or directly on the xen hypervisor. Those exceptions will be clear for -each of those sub commands. +the subcommand in question acts on all domains, the entire machine, +or directly on the Xen hypervisor. Those exceptions will be clear for +each of those subcommands. =head1 NOTES All B operations rely upon the Xen control daemon, aka B. -For any xm commands to run xend must also be running. For this reason -you should start xend as a service when your system first boots using -xen. +For any B commands to run, xend must also be running. For this +reason you should start xend as a service when your system first boots +using Xen. Most B commands require root privileges to run due to the communications channels used to talk to the hypervisor. Running as non root will return an error. Most B commands act asynchronously, so just because the B -command returned, doesn't mean the action is complete. This is +command returned doesn't mean the action is complete. This is important, as many operations on domains, like create and shutdown, can take considerable time (30 seconds or more) to bring the machine into a fully compliant state. If you want to know when one of these -actions has finished you must poll through xm list periodically. +actions has finished you must poll through B periodically. =head1 DOMAIN SUBCOMMANDS -The following sub commands manipulate domains directly, as stated -previously most commands take domain-id as the first parameter. +The following subcommands manipulate domains directly. As stated +previously, most commands take I as the first parameter. =over 4 =item B I -Attach to domain domain-id's console. If you've set up your Domains to +Attach to domain I's console. If you've set up your domains to have a traditional log in console this will look much like a normal text log in screen. @@ -63,15 +67,15 @@ so running curses based interfaces over so running curses based interfaces over the console B. Vi tends to get very odd when using it over this interface. -=item B I<[-c]> I I<[name=value]>.. - -The create sub command requires a configfile and can optional take a +=item B [B<-c>] 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 in the config file. See L for full details of that file format, and possible options used in either the configfile or -Name=Value combinations. - -Configfile can either be an absolute path to a file, or a relative +I=I combinations. + +I can either be an absolute path to a file, or a relative path to a file located in /etc/xen. Create will return B as the domain is started. This B I -Immediately terminate the domain domain-id. This doesn't give the domain -OS any chance to react, and it the equivalent of ripping the power -cord out on a physical machine. In most cases you will want to use -the B command instead. +Immediately terminate the domain I. This doesn't give the +domain OS any chance to react, and is the equivalent of ripping the +power cord out on a physical machine. In most cases you will want to +use the B command instead. =item B I @@ -129,14 +133,14 @@ Converts a domain name to a domain id us Converts a domain id to a domain name using xend's internal mapping. -=item B I<[--long]> +=item B [B<--long>] Displays the short help message (i.e. common commands). -The I<--long> option prints out the complete set of B subcommands, +The B<--long> option prints out the complete set of B subcommands, grouped by function. -=item B I<[--long | --label]> I<[domain-id, ...]> +=item B [B<--long> | B<--label>] [I ...] Prints information about one or more domains. If no domains are specified it prints out information about all domains. @@ -151,21 +155,23 @@ An example format for the list is as fol Mandrake10.2 167 128 1 ------ 2.5 Suse9.2 168 100 1 ------ 1.8 -Name is the name of the domain. ID the domain numeric id. Mem is the -size of the memory allocated to the domain. VCPUS is the number of -VCPUS allocated to domain. State is the run state (see below). Time -is the total run time of the domain as accounted for by Xen. +Name is the name of the domain. ID the numeric domain id. Mem is the +desired amount of memory to allocate to the domain (although it may +not be the currently allocated amount). VCPUs is the number of +virtual CPUs allocated to the domain. State is the run state (see +below). Time is the total run time of the domain as accounted for by +Xen. B =over 4 -The State field lists 6 states for a Xen Domain, and which ones the -current Domain is in. +The State field lists 6 states for a Xen domain, and which ones the +current domain is in. =item B -The domain is currently running on a CPU +The domain is currently running on a CPU. =item B @@ -203,12 +209,12 @@ B =over 4 -If I<--long> is specified, the output for xm list is not the table +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. +B There is no stable guarantees on the format of this data. Use at your own risk. =back @@ -217,10 +223,10 @@ B