direct-io.hg

changeset 7806:97d11e40d8ca

This patch is largely stylistic, and gets rid of StuddlyCaps formatting in
all the param variables, make consistant use of bold and italics in the the
man pages to make it easier to read, and adds a few minor content additions.
It makes actually reading the man page a lot easier.

Signed-off-by: Sean Dague <sean@dague.net>
author emellor@leeni.uk.xensource.com
date Tue Nov 15 15:36:42 2005 +0100 (2005-11-15)
parents 4f56eb7d814a
children 1831da8249ba
files docs/man/xm.pod.1
line diff
     1.1 --- a/docs/man/xm.pod.1	Tue Nov 15 15:27:48 2005 +0100
     1.2 +++ b/docs/man/xm.pod.1	Tue Nov 15 15:36:42 2005 +0100
     1.3 @@ -15,9 +15,9 @@ VCPUs, and attach or detach virtual bloc
     1.4  
     1.5  The basic structure of every xm command is almost always:
     1.6  
     1.7 -  xm <SubCommand> <DomId> [OPTIONS]
     1.8 +  xm <subcommand> <domain-id> [OPTIONS]
     1.9  
    1.10 -Where I<SubCommand> is one of the sub commands listed below, I<DomId>
    1.11 +Where I<subcommand> is one of the sub commands listed below, I<domain-id>
    1.12  is the numeric domain id, or the domain name (which will be internally
    1.13  translated to domain id), and I<OPTIONS> are sub command specific
    1.14  options.  There are a few exceptions to this rule in the cases where
    1.15 @@ -46,13 +46,13 @@ actions has finished you must poll throu
    1.16  =head1 DOMAIN SUBCOMMANDS
    1.17  
    1.18  The following sub commands manipulate domains directly, as stated
    1.19 -previously most commands take DomId as the first parameter.
    1.20 +previously most commands take domain-id as the first parameter.
    1.21  
    1.22  =over 4
    1.23  
    1.24 -=item I<console> <DomId>
    1.25 +=item B<console> I<domain-id>
    1.26  
    1.27 -Attach to domain DomId's console.  If you've set up your Domains to
    1.28 +Attach to domain domain-id's console.  If you've set up your Domains to
    1.29  have a traditional log in console this will look much like a normal
    1.30  text log in screen.
    1.31  
    1.32 @@ -63,15 +63,15 @@ The attached console will perform much l
    1.33  so running curses based interfaces over the console B<is not
    1.34  advised>.  Vi tends to get very odd when using it over this interface.
    1.35  
    1.36 -=item I<create> [-c] <ConfigFile> [Name=Value]..
    1.37 +=item B<create> I<[-c]> I<configfile> I<[name=value]>..
    1.38  
    1.39 -The create sub command requires a ConfigFile and can optional take a
    1.40 +The create sub command requires a configfile and can optional take a
    1.41  series of name value pairs that add to or override variables defined
    1.42  in the config file.  See L<xmdomain.cfg> for full details of that file
    1.43 -format, and possible options used in either the ConfigFile or
    1.44 +format, and possible options used in either the configfile or
    1.45  Name=Value combinations.
    1.46  
    1.47 -ConfigFile can either be an absolute path to a file, or a relative
    1.48 +Configfile can either be an absolute path to a file, or a relative
    1.49  path to a file located in /etc/xen.
    1.50  
    1.51  Create will return B<as soon> as the domain is started.  This B<does
    1.52 @@ -82,7 +82,7 @@ B<OPTIONS>
    1.53  
    1.54  =over 4 
    1.55  
    1.56 -=item I<-c>
    1.57 +=item B<-c>
    1.58  
    1.59  Attache console to the domain as soon as it has started.  This is
    1.60  useful for determining issues with crashing domains.
    1.61 @@ -114,42 +114,42 @@ virtual networking.  (This example comes
    1.62  
    1.63  =back
    1.64  
    1.65 -=item I<destroy> <DomId>
    1.66 +=item B<destroy> I<domain-id>
    1.67  
    1.68 -Immediately terminate the domain DomId.  This doesn't give the domain
    1.69 +Immediately terminate the domain domain-id.  This doesn't give the domain
    1.70  OS any chance to react, and it the equivalent of ripping the power
    1.71  cord out on a physical machine.  In most cases you will want to use
    1.72  the B<shutdown> command instead.
    1.73  
    1.74 -=item I<domid> <DomName>
    1.75 +=item B<domid> I<domain-name>
    1.76  
    1.77  Converts a domain name to a domain id using xend's internal mapping.
    1.78  
    1.79 -=item I<domname> <DomId>
    1.80 +=item B<domname> I<domain-id>
    1.81  
    1.82  Converts a domain id to a domain name using xend's internal mapping.
    1.83  
    1.84 -=item I<help> [--long]
    1.85 +=item B<help> I<[--long]>
    1.86  
    1.87  Displays the short help message (i.e. common commands).
    1.88  
    1.89  The I<--long> option prints out the complete set of B<xm> subcommands,
    1.90  grouped by function.
    1.91  
    1.92 -=item I<list> [--long] [DomId, ...]
    1.93 +=item B<list> I<[--long]> I<[domain-id, ...]>
    1.94  
    1.95  Prints information about one or more domains.  If no domains are
    1.96  specified it prints out information about all domains.
    1.97  
    1.98  An example format for the list is as follows:
    1.99  
   1.100 - Name                              ID Mem(MiB) VCPUs State  Time(s)
   1.101 - Domain-0                           0       98     1 r-----  5068.6
   1.102 - Fedora3                          164      128     1 r-----     7.6
   1.103 - Fedora4                          165      128     1 ------     0.6
   1.104 - Mandrake2006                     166      128     1 -b----     3.6
   1.105 - Mandrake10.2                     167      128     1 ------     2.5
   1.106 - Suse9.2                          168      100     1 ------     1.8
   1.107 +    Name                         ID Mem(MiB) VCPUs State  Time(s)
   1.108 +    Domain-0                      0       98     1 r-----  5068.6
   1.109 +    Fedora3                     164      128     1 r-----     7.6
   1.110 +    Fedora4                     165      128     1 ------     0.6
   1.111 +    Mandrake2006                166      128     1 -b----     3.6
   1.112 +    Mandrake10.2                167      128     1 ------     2.5
   1.113 +    Suse9.2                     168      100     1 ------     1.8
   1.114  
   1.115  Name is the name of the domain.  ID the domain numeric id.  Mem is the
   1.116  size of the memory allocated to the domain.  VCPUS is the number of
   1.117 @@ -163,34 +163,34 @@ B<STATES>
   1.118  The State field lists 6 states for a Xen Domain, and which ones the
   1.119  current Domain is in.
   1.120  
   1.121 -=item I<r - running>
   1.122 +=item B<r - running>
   1.123  
   1.124  The domain is currently running on a CPU
   1.125  
   1.126 -=item I<b - blocked>
   1.127 +=item B<b - blocked>
   1.128  
   1.129  The domain is blocked, and not running or runable.  This can be caused
   1.130  because the domain is waiting on IO (a traditional wait state) or has
   1.131  gone to sleep because there was nothing else for it to do.
   1.132  
   1.133 -=item I<p - paused>
   1.134 +=item B<p - paused>
   1.135  
   1.136  The domain has been paused, usually occurring through the administrator
   1.137  running B<xm pause>.  When in a paused state the domain will still
   1.138  consume allocated resources like memory, but will not be eligible for
   1.139  scheduling by the Xen hypervisor.
   1.140  
   1.141 -=item I<s - shutdown>
   1.142 +=item B<s - shutdown>
   1.143  
   1.144  FIXME: Why would you ever see this state?
   1.145  
   1.146 -=item I<c - crashed>
   1.147 +=item B<c - crashed>
   1.148  
   1.149  The domain has crashed, which is always a violent ending.  Usually
   1.150  this state can only occur if the domain has been configured not to
   1.151  restart on crash.  See L<xmdomain.cfg> for more info.
   1.152  
   1.153 -=item I<d - dying>
   1.154 +=item B<d - dying>
   1.155  
   1.156  The domain is in process of dying, but hasn't completely shutdown or
   1.157  crashed.
   1.158 @@ -226,7 +226,7 @@ less utilized than a high CPU workload. 
   1.159  
   1.160  =back
   1.161  
   1.162 -=item I<mem-max> <DomId> <Mem>
   1.163 +=item B<mem-max> I<domain-id> I<mem>
   1.164  
   1.165  Specify the maximum amount of memory the Domain is able to use.  Mem
   1.166  is specified in megabytes. 
   1.167 @@ -234,7 +234,7 @@ is specified in megabytes.
   1.168  The mem-max value may not correspond to the actual memory used in the
   1.169  Domain, as it may balloon down it's memory to give more back to the OS.
   1.170  
   1.171 -=item I<mem-set> <DomId> <Mem>
   1.172 +=item B<mem-set> I<domain-id> I<mem>
   1.173  
   1.174  Set the domain's used memory using the balloon driver.  Because this
   1.175  operation requires cooperation from the domain operating system, there
   1.176 @@ -244,7 +244,7 @@ B<Warning:> there is no good way to know
   1.177  mem-set will make a domain unstable and cause it to crash.  Be very
   1.178  careful when using this command on running domains.
   1.179  
   1.180 -=item I<migrate> <DomId> <Host> [Options]
   1.181 +=item B<migrate> I<domain-id> I<host> I<[options]>
   1.182  
   1.183  Migrate a domain to another Host machine. B<Xend> must be running on
   1.184  other host machine, it must be running the same version of xen, it
   1.185 @@ -261,13 +261,13 @@ B<OPTIONS>
   1.186  
   1.187  =over 4
   1.188  
   1.189 -=item I<-l, --live>
   1.190 +=item B<-l, --live>
   1.191  
   1.192  Use live migration.  This will migrate the domain between hosts
   1.193  without shutting down the domain.  See the Xen Users Guide for more
   1.194  information.
   1.195  
   1.196 -=item I<-r, --resource> Mbs
   1.197 +=item B<-r, --resource> I<Mbs>
   1.198  
   1.199  Set maximum Mbs allowed for migrating the domain.  This ensures that
   1.200  the network link is not saturated with migration traffic while
   1.201 @@ -275,13 +275,13 @@ attempting to do other useful work.
   1.202  
   1.203  =back
   1.204  
   1.205 -=item I<pause> <DomId>
   1.206 +=item B<pause> I<domain-id>
   1.207  
   1.208  Pause a domain.  When in a paused state the domain will still consume
   1.209  allocated resources such as memory, but will not be eligible for
   1.210  scheduling by the Xen hypervisor.
   1.211  
   1.212 -=item I<reboot> [Options] <DomId>
   1.213 +=item B<reboot> I<[options]> I<domain-id>
   1.214  
   1.215  Reboot a domain.  This acts just as if the domain had the B<reboot>
   1.216  command run from the console.  The command returns as soon as it has
   1.217 @@ -289,29 +289,29 @@ executed the reboot action, which may be
   1.218  domain actually reboots.
   1.219  
   1.220  The behavior of what happens to a domain when it reboots is set by the
   1.221 -B<on_reboot> parameter of the xmdomain.cfg file when the domain was
   1.222 +I<on_reboot> parameter of the xmdomain.cfg file when the domain was
   1.223  created.
   1.224  
   1.225  B<OPTIONS>
   1.226  
   1.227  =over 4
   1.228  
   1.229 -=item I<-a, --all>
   1.230 +=item B<-a, --all>
   1.231  
   1.232  Reboot all domains
   1.233  
   1.234 -=item I<-w, --wait>
   1.235 +=item B<-w, --wait>
   1.236  
   1.237  Wait for reboot to complete before returning.  This may take a while,
   1.238  as all services in the domain will have to be shut down cleanly.
   1.239  
   1.240  =back
   1.241  
   1.242 -=item I<restore> <File>
   1.243 +=item B<restore> I<state-file>
   1.244  
   1.245  Build a domain from an B<xm save> state file.  See I<save> for more info.
   1.246  
   1.247 -=item I<save> <DomId> <File>
   1.248 +=item B<save> I<domain-id> I<state-file>
   1.249  
   1.250  Saves a running domain to a state file so that it can be restored
   1.251  later.  Once saved, the domain will no longer be running on the
   1.252 @@ -322,7 +322,7 @@ This is roughly equivalent to doing a hi
   1.253  with all the same limitations.  Open network connections may be
   1.254  severed upon restore, as TCP timeouts may have expired.
   1.255  
   1.256 -=item I<shutdown> [Options] <DomId>
   1.257 +=item B<shutdown> I<[options]> I<domain-id>
   1.258  
   1.259  Gracefully shuts down a domain.  This coordinates with the domain OS
   1.260  to perform graceful shutdown, so there is no guaruntee that it will
   1.261 @@ -331,55 +331,55 @@ services must be shutdown in the domain.
   1.262  immediately after signally the domain unless that I<-w> flag is used.
   1.263  
   1.264  The behavior of what happens to a domain when it reboots is set by the
   1.265 -B<on_shutdown> parameter of the xmdomain.cfg file when the domain was
   1.266 +I<on_shutdown> parameter of the xmdomain.cfg file when the domain was
   1.267  created.
   1.268  
   1.269  B<OPTIONS>
   1.270  
   1.271  =over 4
   1.272  
   1.273 -=item I<-a> 
   1.274 +=item B<-a> 
   1.275  
   1.276  Shutdown B<all> domains.  Often used when doing a complete shutdown of
   1.277  a Xen system.
   1.278  
   1.279 -=item I<-w>
   1.280 +=item B<-w>
   1.281  
   1.282  Wait for the domain to complete shutdown before returning.
   1.283  
   1.284  =back
   1.285  
   1.286 -=item I<sysrq> <DomId> <letter>
   1.287 +=item B<sysrq> I<domain-id> I<letter>
   1.288  
   1.289  Send a I<Magic System Request> signal to the domain.  For more
   1.290  information on available magic sys req operations, see sysrq.txt in
   1.291  your Linux Kernel sources.
   1.292  
   1.293 -=item I<unpause> <DomId>
   1.294 +=item B<unpause> I<domain-id>
   1.295  
   1.296  Moves a domain out of the paused state.  This will allow a previously
   1.297  paused domain to now be eligible for scheduling by the Xen hypervisor.
   1.298  
   1.299 -=item I<set-vcpus> <DomId> <VCPUCount>
   1.300 +=item B<set-vcpus> I<domain-id> I<vcpu-count>
   1.301  
   1.302 -Enables the I<VCPUcount> virtual CPUs for the domain in question.
   1.303 +Enables the I<vcpu-count> virtual CPUs for the domain in question.
   1.304  Like mem-set, this command can only allocate up to the maximum virtual
   1.305  CPU count configured at boot for the domain.
   1.306  
   1.307 -If the VCPUcount is smaller than the current number of active VCPUs,
   1.308 -the highest number VCPUs will be hotplug removed.  This may be
   1.309 +If the I<vcpu-count> is smaller than the current number of active
   1.310 +VCPUs, the highest number VCPUs will be hotplug removed.  This may be
   1.311  important for pinning purposes.
   1.312  
   1.313  Attempting to set-vcpus to a number larger than the initially
   1.314  configured VCPU count is an error.  Trying to set-vcpus to < 1 will be
   1.315  quietly ignored.
   1.316  
   1.317 -=item I<vpcu-list> [DomID]
   1.318 +=item B<vpcu-list> I<[domain-id]>
   1.319  
   1.320  Lists VCPU information for a specific domain.  If no domain is
   1.321  specified, VCPU information for all domains will be provided.
   1.322  
   1.323 -=item I<vcpu-pin> <DomId> <VCPU> <CPUs>
   1.324 +=item B<vcpu-pin> I<domain-id> I<vcpu> I<cpus>
   1.325  
   1.326  Pins the the VCPU to only run on the specific CPUs.  
   1.327  
   1.328 @@ -394,7 +394,7 @@ CPUs.
   1.329  
   1.330  =over 4
   1.331  
   1.332 -=item I<dmesg> [OPTION]
   1.333 +=item B<dmesg> I<[-c]>
   1.334  
   1.335  Reads the Xen message buffer, similar to dmesg on a Linux system.  The
   1.336  buffer contains informational, warning, and error messages created
   1.337 @@ -405,19 +405,20 @@ B<OPTIONS>
   1.338  
   1.339  =over 4
   1.340  
   1.341 -=item I<-c, --clear>
   1.342 +=item B<-c, --clear>
   1.343  
   1.344  Clears Xen's message buffer.
   1.345  
   1.346  =back
   1.347  
   1.348 -=item I<info>
   1.349 +=item B<info>
   1.350  
   1.351  Print information about the Xen host in I<name : value> format.  When
   1.352  reporting a Xen bug, please provide this information as part of the
   1.353  bug report.
   1.354  
   1.355 -Sample xen domain info looks as follows:
   1.356 +Sample xen domain info looks as follows (lines wrapped manually to
   1.357 +make the man page more readable):
   1.358  
   1.359   system                 : Linux
   1.360   host                   : talon
   1.361 @@ -438,8 +439,10 @@ Sample xen domain info looks as follows:
   1.362   xen_extra              : -devel
   1.363   xen_caps               : xen-3.0-x86_32
   1.364   xen_params             : virt_start=0xfc000000
   1.365 - xen_changeset          : Mon Nov 14 18:13:38 2005 +0100 7793:090e44133d40
   1.366 - cc_compiler            : gcc version 3.4.3 (Mandrakelinux 10.2 3.4.3-7mdk)
   1.367 + xen_changeset          : Mon Nov 14 18:13:38 2005 +0100 
   1.368 +                          7793:090e44133d40
   1.369 + cc_compiler            : gcc version 3.4.3 (Mandrakelinux 
   1.370 +                          10.2 3.4.3-7mdk)
   1.371   cc_compile_by          : sdague
   1.372   cc_compile_domain      : (none)
   1.373   cc_compile_date        : Mon Nov 14 14:16:48 EST 2005
   1.374 @@ -473,16 +476,16 @@ what version of code your Xen system was
   1.375  
   1.376  =back
   1.377  
   1.378 -=item I<log>
   1.379 +=item B<log>
   1.380  
   1.381  Print out the B<xend> log.  This log file can be found in
   1.382  /var/log/xend.log.
   1.383  
   1.384 -=item I<top>
   1.385 +=item B<top>
   1.386  
   1.387  Executes the xentop command, which provides real time monitoring of
   1.388  domains.  Xentop is a curses interface, and reasonably self
   1.389 -explainitory.
   1.390 +explanatory.
   1.391  
   1.392  =back
   1.393  
   1.394 @@ -496,7 +499,7 @@ FIXME: we really need a scheduler expert
   1.395  
   1.396  =over 4
   1.397  
   1.398 -=item I<sched-bvt> <mcuadv> <warpback> <warpvalue> <warpl> <warpu>
   1.399 +=item B<sched-bvt> I<mcuadv> I<warpback> I<warpvalue> I<warpl> I<warpu>
   1.400  
   1.401  Performs runtime adjustments to the default parameters for the
   1.402  Borrowed Virtual Time (BVT) scheduler.  For full information on the
   1.403 @@ -506,37 +509,38 @@ section.
   1.404  Set Borrowed Virtual Time (BVT) scheduler parameters. There are five
   1.405  required parameters, which are given in order below.
   1.406  
   1.407 +FIXME: what units are all the BVT params in?
   1.408 +
   1.409  B<PARAMETERS>
   1.410  
   1.411  =over 4
   1.412  
   1.413 -=item L<mcuadv>
   1.414 +=item I<mcuadv>
   1.415  
   1.416  The MCU (Minimum Charging Unit) advance determines the proportional
   1.417  share of the CPU that a domain receives. It is set inversely
   1.418  proportionally to a domain's sharing weight.
   1.419  
   1.420 -=item L<warpback>
   1.421 +=item I<warpback>
   1.422  
   1.423  The amount of `virtual time' the domain is allowed to warp backwards.
   1.424  
   1.425 -=item L<warpvalue>
   1.426 -
   1.427 +=item I<warpvalue>
   1.428  
   1.429 -Warp value
   1.430 +Warp value (FIXME: what does this really mean?)
   1.431  
   1.432 -=item L<warpl>
   1.433 +=item I<warpl>
   1.434  
   1.435  The warp limit is the maximum time a domain can run warped for.
   1.436  
   1.437 -=item L<warpu>
   1.438 +=item I<warpu>
   1.439  
   1.440  The unwarp requirement is the minimum time a domain must run unwarped
   1.441  for before it can warp again.
   1.442  
   1.443  =back 
   1.444  
   1.445 -=item I<sched-bvt-ctxallow> <Allow>
   1.446 +=item B<sched-bvt-ctxallow> I<allow>
   1.447  
   1.448  Sets the BVT scheduler's context switch allowance. 
   1.449  
   1.450 @@ -544,7 +548,7 @@ The context switch allowance is similar 
   1.451  traditional schedulers. It is the minimum time that a scheduled domain
   1.452  will be allowed to run before being preempted.
   1.453  
   1.454 -=item I<sched-sedf> <period> <slice> <latency-hint> <extratime> <weight>
   1.455 +=item B<sched-sedf> I<period> I<slice> I<latency-hint> I<extratime> I<weight>
   1.456  
   1.457  Set Simple EDF scheduler parameters.  This scheduler provides weighted
   1.458  CPU sharing in an intuitive way and uses realtime-algorithms to ensure
   1.459 @@ -581,27 +585,27 @@ Another way of setting cpu slice.
   1.460  
   1.461  B<EXAMPLES>
   1.462  
   1.463 -normal EDF (20ms/5ms):
   1.464 +I<normal EDF (20ms/5ms):>
   1.465  
   1.466      xm sched-sedf <dom-id> 20000000 5000000 0 0 0
   1.467    
   1.468 -best-effort domains (i.e. non-realtime):
   1.469 +I<best-effort domains (i.e. non-realtime):>
   1.470  
   1.471      xm sched-sedf <dom-id> 20000000 0 0 1 0
   1.472   
   1.473 -normal EDF (20ms/5ms) + share of extra-time:
   1.474 +I<normal EDF (20ms/5ms) + share of extra-time:>
   1.475    
   1.476      xm sched-sedf <dom-id> 20000000 5000000 0 1 0
   1.477  
   1.478 -4 domains with weights 2:3:4:2
   1.479 +I<4 domains with weights 2:3:4:2>
   1.480  
   1.481      xm sched-sedf <d1> 0 0 0 0 2
   1.482      xm sched-sedf <d2> 0 0 0 0 3
   1.483      xm sched-sedf <d3> 0 0 0 0 4
   1.484      xm sched-sedf <d4> 0 0 0 0 2
   1.485    
   1.486 -1 fully-specified (10ms/3ms) domain, 3 other domains share available
   1.487 -rest in 2:7:3 ratio:   
   1.488 +I<1 fully-specified (10ms/3ms) domain, 3 other domains share available
   1.489 +rest in 2:7:3 ratio:>
   1.490  
   1.491      xm sched-sedf <d1> 10000000 3000000 0 0 0   
   1.492      xm sched-sedf <d2> 0 0 0 0 2   
   1.493 @@ -616,46 +620,60 @@ Most virtual devices can be added and re
   1.494  running.  The effect to the guest OS is much the same as any hotplug
   1.495  event.
   1.496  
   1.497 +=head2 BLOCK DEVICES
   1.498 +
   1.499  =over 4
   1.500  
   1.501 -=item I<block-attach> <DomId> <BackDev> <FrontDev> <Mode> [BackDomId]
   1.502 +=item B<block-attach> I<domain-id> I<be-dev> I<fe-dev> I<mode> I<[bedomain-id]>
   1.503  
   1.504  Create a new virtual block device
   1.505  
   1.506 -=item I<block-detach> <DomId> <DevId>
   1.507 +=item B<block-detach> I<domain-id> I<devid>
   1.508  
   1.509  Destroy a domain's virtual block device. DevId may either be a device
   1.510  ID or the device name as mounted in the guest.
   1.511  
   1.512 -=item I<block-list> <DomId>
   1.513 +=item B<block-list> I<domain-id>
   1.514 +
   1.515 +List virtual block devices for a domain.  The returned output is
   1.516 +sexpression formatted.
   1.517 +
   1.518 +=head2 NETWORK DEVICES
   1.519  
   1.520 -List virtual block devices for a domain.
   1.521 +=item B<network-attach> I<domain-id> I<[script=script]> I<[ip=ipaddr]>
   1.522 +I<[mac=macaddr]> I<[bridge=bridge-name]> I<[backend=bedomain-id]>
   1.523  
   1.524 -=item I<network-limit> <DomId> <Vif> <Credit> <Period>
   1.525 +=item B<network-detach> I<domain-id> I<devid>
   1.526 +
   1.527 +=item B<network-limit> I<domain-id> I<vif> I<credit> I<period>
   1.528  
   1.529  Limit the transmission rate of a virtual network interface.
   1.530  
   1.531 -=item I<network-list> <DomId>
   1.532 +=item B<network-list> I<domain-id>
   1.533  
   1.534 -List virtual network interfaces for a domain.
   1.535 +List virtual network interfaces for a domain.  The returned output is
   1.536 +sexpression formatted.
   1.537  
   1.538  =back
   1.539  
   1.540  =head1 VNET COMMANDS
   1.541  
   1.542 -The Virtual Network interfaces for Xen 
   1.543 +The Virtual Network interfaces for Xen.
   1.544 +
   1.545 +FIXME: This needs a lot more explaination, or it needs to be ripped
   1.546 +out entirely.
   1.547  
   1.548  =over 4
   1.549  
   1.550 -=item I<vnet-list> [-l|--long]
   1.551 +=item B<vnet-list> I<[-l|--long]>
   1.552  
   1.553  List vnets.
   1.554  
   1.555 -=item I<vnet-create> <config>
   1.556 +=item B<vnet-create> I<config>
   1.557  
   1.558  Create a vnet from a config file.
   1.559  
   1.560 -=item I<vnet-delete> <vnetid>
   1.561 +=item B<vnet-delete> I<vnetid>
   1.562  
   1.563  Delete a vnet.
   1.564