From b8d0a7bc348a10d0a60b33ad577b6793119aa900 Mon Sep 17 00:00:00 2001 From: Daniel Veillard Date: Tue, 14 Aug 2007 07:02:18 +0000 Subject: [PATCH] * virsh.1 docs/virsh.pod: typo fixes from Atsushi SAKAI Daniel --- ChangeLog | 4 ++++ docs/architecture.html | 2 +- docs/bugs.html | 2 +- docs/libvir.html | 4 ++-- docs/virsh.pod | 26 +++++++++++++------------- virsh.1 | 28 ++++++++++++++-------------- 6 files changed, 35 insertions(+), 31 deletions(-) diff --git a/ChangeLog b/ChangeLog index 1844e65ada..f72833aec0 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +Tue Aug 14 09:04:41 CEST 2007 Daniel Veillard + + * virsh.1 docs/virsh.pod: typo fixes from Atsushi SAKAI + Tue Aug 14 07:59:21 CEST 2007 Daniel Veillard * docs/apibuild.py: fix the API generator to work out of a diff --git a/docs/architecture.html b/docs/architecture.html index c46e0118bc..cbff79a941 100644 --- a/docs/architecture.html +++ b/docs/architecture.html @@ -58,7 +58,7 @@ drivers present in driver.h:

  • xend_internal: implements the driver fun domains.
  • qemu_internal: implement the driver functions for QEmu and KVM virtualization engines. It also uses a qemud/ specific daemon - which interracts with the QEmu process to implement libvirt API.
    • + which interacts with the QEmu process to implement libvirt API.
  • test: this is a test driver useful for regression tests of the front-end part of libvirt.

Note that a given driver may only implement a subset of those functions, diff --git a/docs/bugs.html b/docs/bugs.html index 8c8887e386..09c3d7de9e 100644 --- a/docs/bugs.html +++ b/docs/bugs.html @@ -13,5 +13,5 @@ too, so that everybody working on the project can see it, thanks !

Some of network. Use the settings:

  • server: irc.oftc.net
  • port: 6667 (the usual IRC port)
  • channel: #virt
    • -

But there is no garantee that someone will be watching or able to reply, +

But there is no guarantee that someone will be watching or able to reply, use the mailing-list if you don't get an answer there.

main menu

related links

Graphics and design by Diana Fong

diff --git a/docs/libvir.html b/docs/libvir.html index ec456d2cbc..213af3d2ab 100644 --- a/docs/libvir.html +++ b/docs/libvir.html @@ -565,7 +565,7 @@ drivers present in driver.h:

domains.
  • qemu_internal: implement the driver functions for QEmu and KVM virtualization engines. It also uses a qemud/ specific daemon - which interracts with the QEmu process to implement libvirt API.
    • + which interacts with the QEmu process to implement libvirt API.
  • test: this is a test driver useful for regression tests of the front-end part of libvirt.
    • @@ -1459,7 +1459,7 @@ network. Use the settings:

  • port: 6667 (the usual IRC port)
  • channel: #virt
    • -

    But there is no garantee that someone will be watching or able to reply, +

    But there is no guarantee that someone will be watching or able to reply, use the mailing-list if you don't get an answer there.

    Remote support

    diff --git a/docs/virsh.pod b/docs/virsh.pod index 5b2682d544..aff0e0c96a 100644 --- a/docs/virsh.pod +++ b/docs/virsh.pod @@ -10,7 +10,7 @@ virsh [args] The B program is the main interface for managing virsh guest domains. The program can be used to create, pause, and shutdown -domains. It can also be used to list current domains. Libvirt is a C toolkit to interract with the virtualization capabilities of recent versions of Linux (and other OSes). It is free software available under the GNU Lesser General Public License. Virtualization of the Linux Operating System means the ability to run multiple instances of Operating Systems concurently on a single hardware system where the basic resources are driven by a Linux instance. The library aim at providing long term stable C API initially for the Xen paravirtualization but should be able to integrate other virtualization mechanisms, it currently also support QEmu and KVM. +domains. It can also be used to list current domains. Libvirt is a C toolkit to interact with the virtualization capabilities of recent versions of Linux (and other OSes). It is free software available under the GNU Lesser General Public License. Virtualization of the Linux Operating System means the ability to run multiple instances of Operating Systems concurrently on a single hardware system where the basic resources are driven by a Linux instance. The library aim at providing long term stable C API initially for the Xen paravirtualization but should be able to integrate other virtualization mechanisms, it currently also support QEmu and KVM. The basic structure of most virsh usage is: @@ -33,10 +33,10 @@ the program. =head1 NOTES All B operations rely upon the libvirt library. -For any virsh commands to run xend/qemu, or what ever virtual library that libvirt suports. For this reason you should start xend/qemu as a service when your system first boots using xen/qemu. This can usually be done using the command +For any virsh commands to run xend/qemu, or what ever virtual library that libvirt supports. For this reason you should start xend/qemu as a service when your system first boots using xen/qemu. This can usually be done using the command B . -Most B commands require root privledges to run due to the +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. @@ -55,7 +55,7 @@ The following commands are generic i.e. not specific to a domain. =item B optional I -This prints a small synoposis about all commands available for B +This prints a small synopsis about all commands available for B B I will print out a detailed help message on that command. =item B @@ -105,7 +105,7 @@ allow to connect locally as a normal user to the his own set of QEmu and KVM dom =back -For remote access see the documetnation page on how to make URIs. +For remote access see the documentation page on how to make URIs. The I<--readonly> option allows for read-only connection =item B @@ -155,7 +155,7 @@ The domain is currently running on a CPU =item B -The domain is blocked, and not running or runable. This can be caused +The domain is blocked, and not running or runnable. This can be caused because the domain is waiting on IO (a traditional wait state) or has gone to sleep because there was nothing else for it to do. @@ -249,7 +249,7 @@ Returns state about a running domain. =item B I -Ouput the domain informations as an XML dump to stdout, this format can be used by the B command. +Output the domain informations as an XML dump to stdout, this format can be used by the B command. =item B I @@ -299,7 +299,7 @@ original description of domain. =item B I Gracefully shuts down a domain. This coordinates with the domain OS -to perform graceful shutdown, so there is no guaruntee that it will +to perform graceful shutdown, so there is no guarantee that it will succeed, and may take a variable length of time depending on what services must be shutdown in the domain. @@ -321,7 +321,7 @@ hypervisor. =item B I Output the device used for the TTY console of the domain. If the information -is not available the processus will provide an exit code of 1. +is not available the processes will provide an exit code of 1. =item B I @@ -341,7 +341,7 @@ and I is a comma separated list of physical CPU numbers. =item B I Output the IP address and port number for the VNC display. If the information -is not available the processus will provide an exit code of 1. +is not available the processes will provide an exit code of 1. =back @@ -390,7 +390,7 @@ from the domain. =item B I I optional I<--mac mac> -Detatch a network interface from a domain. +Detach a network interface from a domain. I can be either I to indicate a physical network device or I to indicate a bridge to a device. It is recommended to use the I option to distinguish between the interfaces if more than one are present on the domain. @@ -401,7 +401,7 @@ if more than one are present on the domain. The following commands manipulate networks. Libvirt has the capability to define virtual networks which can then be used by domains and linked to -actual network dvices. For more detailed informations about this feature +actual network devices. For more detailed informations about this feature see the documentation at L . A lot of the command for virtual networks are similar to the one used for domains, but the way to name a virtual network is either by its name or UUID. @@ -421,7 +421,7 @@ a description of the XML network format used by libvirt. =item B I Define a virtual network from an XML I, the network is just defined but -not instanciated. +not instantiated. =item B I diff --git a/virsh.1 b/virsh.1 index 17fa258325..3030e8507b 100644 --- a/virsh.1 +++ b/virsh.1 @@ -129,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "VIRSH 1" -.TH VIRSH 1 "2007-07-26" "perl v5.8.8" "Virtualization Support" +.TH VIRSH 1 "2007-08-14" "perl v5.8.8" "Virtualization Support" .SH "NAME" virsh \- management user interface .SH "SYNOPSIS" @@ -139,7 +139,7 @@ virsh [args] .IX Header "DESCRIPTION" The \fBvirsh\fR program is the main interface for managing virsh guest domains. The program can be used to create, pause, and shutdown -domains. It can also be used to list current domains. Libvirt is a C toolkit to interract with the virtualization capabilities of recent versions of Linux (and other OSes). It is free software available under the \s-1GNU\s0 Lesser General Public License. Virtualization of the Linux Operating System means the ability to run multiple instances of Operating Systems concurently on a single hardware system where the basic resources are driven by a Linux instance. The library aim at providing long term stable C \s-1API\s0 initially for the Xen paravirtualization but should be able to integrate other virtualization mechanisms, it currently also support QEmu and \s-1KVM\s0. +domains. It can also be used to list current domains. Libvirt is a C toolkit to interact with the virtualization capabilities of recent versions of Linux (and other OSes). It is free software available under the \s-1GNU\s0 Lesser General Public License. Virtualization of the Linux Operating System means the ability to run multiple instances of Operating Systems concurrently on a single hardware system where the basic resources are driven by a Linux instance. The library aim at providing long term stable C \s-1API\s0 initially for the Xen paravirtualization but should be able to integrate other virtualization mechanisms, it currently also support QEmu and \s-1KVM\s0. .PP The basic structure of most virsh usage is: .PP @@ -163,10 +163,10 @@ the program. .SH "NOTES" .IX Header "NOTES" All \fBvirsh\fR operations rely upon the libvirt library. -For any virsh commands to run xend/qemu, or what ever virtual library that libvirt suports. For this reason you should start xend/qemu as a service when your system first boots using xen/qemu. This can usually be done using the command +For any virsh commands to run xend/qemu, or what ever virtual library that libvirt supports. For this reason you should start xend/qemu as a service when your system first boots using xen/qemu. This can usually be done using the command \&\fBservice start libvirtd\fR . .PP -Most \fBvirsh\fR commands require root privledges to run due to the +Most \fBvirsh\fR 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. .PP @@ -181,7 +181,7 @@ actions has finished you must poll through virsh list periodically. The following commands are generic i.e. not specific to a domain. .IP "\fBhelp\fR optional \fIcommand\fR" 4 .IX Item "help optional command" -This prints a small synoposis about all commands available for \fBvirsh\fR +This prints a small synopsis about all commands available for \fBvirsh\fR \&\fBhelp\fR \fIcommand\fR will print out a detailed help message on that command. .IP "\fBquit\fR" 4 .IX Item "quit" @@ -226,7 +226,7 @@ allow to connect locally as a normal user to the his own set of QEmu and \s-1KVM .RE .RS 4 .Sp -For remote access see the documetnation page on how to make URIs. +For remote access see the documentation page on how to make URIs. The \fI\-\-readonly\fR option allows for read-only connection .RE .IP "\fBnodeinfo\fR" 4 @@ -273,7 +273,7 @@ current Domain is in. The domain is currently running on a \s-1CPU\s0 .IP "\fBb \- blocked\fR" 4 .IX Item "b - blocked" -The domain is blocked, and not running or runable. This can be caused +The domain is blocked, and not running or runnable. This can be caused because the domain is waiting on \s-1IO\s0 (a traditional wait state) or has gone to sleep because there was nothing else for it to do. .IP "\fBp \- paused\fR" 4 @@ -348,7 +348,7 @@ convert a domain Id to domain name Returns state about a running domain. .IP "\fBdumpxml\fR \fIdomain-id\fR" 4 .IX Item "dumpxml domain-id" -Ouput the domain informations as an \s-1XML\s0 dump to stdout, this format can be used by the \fBcreate\fR command. +Output the domain informations as an \s-1XML\s0 dump to stdout, this format can be used by the \fBcreate\fR command. .IP "\fBreboot\fR \fIdomain-id\fR" 4 .IX Item "reboot domain-id" Reboot a domain. This acts just as if the domain had the \fBreboot\fR @@ -390,7 +390,7 @@ original description of domain. .IP "\fBshutdown\fR \fIdomain-id\fR" 4 .IX Item "shutdown domain-id" Gracefully shuts down a domain. This coordinates with the domain \s-1OS\s0 -to perform graceful shutdown, so there is no guaruntee that it will +to perform graceful shutdown, so there is no guarantee that it will succeed, and may take a variable length of time depending on what services must be shutdown in the domain. .Sp @@ -409,7 +409,7 @@ hypervisor. .IP "\fBttyconsole\fR \fIdomain-id\fR" 4 .IX Item "ttyconsole domain-id" Output the device used for the \s-1TTY\s0 console of the domain. If the information -is not available the processus will provide an exit code of 1. +is not available the processes will provide an exit code of 1. .IP "\fBundefine\fR \fIdomain-id\fR" 4 .IX Item "undefine domain-id" Undefine the configuration for an inactive domain. Since it's not running @@ -425,7 +425,7 @@ and \fIcpulist\fR is a comma separated list of physical \s-1CPU\s0 numbers. .IP "\fBvncdisplay\fR \fIdomain-id\fR" 4 .IX Item "vncdisplay domain-id" Output the \s-1IP\s0 address and port number for the \s-1VNC\s0 display. If the information -is not available the processus will provide an exit code of 1. +is not available the processes will provide an exit code of 1. .RE .RS 4 .SH "DEVICES COMMANDS" @@ -465,7 +465,7 @@ Detach a disk device from a domain. The \fItarget\fR is the device as seen from the domain. .IP "\fBdetach-interface\fR \fIdomain-id\fR \fItype\fR optional \fI\-\-mac mac\fR" 4 .IX Item "detach-interface domain-id type optional --mac mac" -Detatch a network interface from a domain. +Detach a network interface from a domain. \&\fItype\fR can be either \fInetwork\fR to indicate a physical network device or \fIbridge\fR to indicate a bridge to a device. It is recommended to use the \fImac\fR option to distinguish between the interfaces if more than one are present on the domain. @@ -475,7 +475,7 @@ if more than one are present on the domain. .IX Header "VIRTUAL NETWORKS COMMANDS" The following commands manipulate networks. Libvirt has the capability to define virtual networks which can then be used by domains and linked to -actual network dvices. For more detailed informations about this feature +actual network devices. For more detailed informations about this feature see the documentation at . A lot of the command for virtual networks are similar to the one used for domains, but the way to name a virtual network is either by its name or \s-1UUID\s0. @@ -490,7 +490,7 @@ a description of the \s-1XML\s0 network format used by libvirt. .IP "\fBnet-define\fR \fIfile\fR" 4 .IX Item "net-define file" Define a virtual network from an \s-1XML\s0 \fIfile\fR, the network is just defined but -not instanciated. +not instantiated. .IP "\fBnet-destroy\fR \fInetwork\fR" 4 .IX Item "net-destroy network" Destroy a given virtual network specified by its name or \s-1UUID\s0. This takes