External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-07-11 04:15:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

* virsh.1 docs/virsh.pod: typo fixes from Atsushi SAKAI

Browse Source 
Daniel
This commit is contained in:
Daniel Veillard 2007-08-14 07:02:18 +00:00
parent 1bd2567773
commit b8d0a7bc34
6 changed files with 35 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ChangeLog
View File

@ -1,3 +1,7 @@
Tue Aug 14 09:04:41 CEST 2007 Daniel Veillard <veillard@redhat.com>
* virsh.1 docs/virsh.pod: typo fixes from Atsushi SAKAI
Tue Aug 14 07:59:21 CEST 2007 Daniel Veillard <veillard@redhat.com>
* docs/apibuild.py: fix the API generator to work out of a

2
docs/architecture.html
View File

@ -58,7 +58,7 @@ drivers present in driver.h:</p><ul><li>xend_internal: implements the driver fun
domains.</li>
<li>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.</li>
which interacts with the QEmu process to implement libvirt API.</li>
<li>test: this is a test driver useful for regression tests of the
front-end part of libvirt.</li>
</ul><p>Note that a given driver may only implement a subset of those functions,

2
docs/bugs.html
View File

@ -13,5 +13,5 @@ too, so that everybody working on the project can see it, thanks !</p><p>Some of
network. Use the settings:</p><ul><li>server: irc.oftc.net</li>
<li>port: 6667 (the usual IRC port)</li>
<li>channel: #virt</li>
</ul><p> But there is no garantee that someone will be watching or able to reply,
</ul><p> 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.</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="remote.html">Remote support</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://et.redhat.com/~rjones/ocaml-libvirt/">OCaml bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>

4
docs/libvir.html
View File

@ -565,7 +565,7 @@ drivers present in driver.h:</p>
domains.</li>
<li>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.</li>
which interacts with the QEmu process to implement libvirt API.</li>
<li>test: this is a test driver useful for regression tests of the
front-end part of libvirt.</li>
</ul>
@ -1459,7 +1459,7 @@ network. Use the settings:</p>
<li>port: 6667 (the usual IRC port)</li>
<li>channel: #virt</li>
</ul>
<p> But there is no garantee that someone will be watching or able to reply,
<p> 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.</p>
<h2><a name="Remote">Remote support</a></h2>

26
docs/virsh.pod
View File

@ -10,7 +10,7 @@ virsh <subcommand> [args]
The B<virsh> 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<virsh> 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<service start libvirtd> .
Most B<virsh> commands require root privledges to run due to the
Most B<virsh> 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<help> optional I<command>
This prints a small synoposis about all commands available for B<virsh>
This prints a small synopsis about all commands available for B<virsh>
B<help> I<command> will print out a detailed help message on that command.
=item B<quit>
@ -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<nodeinfo>
@ -155,7 +155,7 @@ The domain is currently running on a CPU
=item B<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 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<dumpxml> I<domain-id>
Ouput the domain informations as an XML dump to stdout, this format can be used by the B<create> command.
Output the domain informations as an XML dump to stdout, this format can be used by the B<create> command.
=item B<reboot> I<domain-id>
@ -299,7 +299,7 @@ original description of domain.
=item B<shutdown> I<domain-id>
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<ttyconsole> I<domain-id>
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<undefine> I<domain-id>
@ -341,7 +341,7 @@ and I<cpulist> is a comma separated list of physical CPU numbers.
=item B<vncdisplay> I<domain-id>
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<detach-interface> I<domain-id> I<type> optional I<--mac mac>
Detatch a network interface from a domain.
Detach a network interface from a domain.
I<type> can be either I<network> to indicate a physical network device or I<bridge> to indicate a bridge to a device.
It is recommended to use the I<mac> 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<http://libvirt.org/format.html#Net1> . 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<net-define> I<file>
Define a virtual network from an XML I<file>, the network is just defined but
not instanciated.
not instantiated.
=item B<net-destroy> I<network>

28
virsh.1
View File

@ -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 <subcommand> [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 <http://libvirt.org/format.html#Net1> . 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