From 9741a52283bb5e2d134f6d6b4997d300b8a6768a Mon Sep 17 00:00:00 2001 From: "Hugh O. Brock" Date: Thu, 8 Mar 2007 14:07:00 -0500 Subject: Hooked up the half-finished help document to a new help menu item. More fun to come. --- help/virt-manager/C/Makefile.am | 4 +- help/virt-manager/C/virt-manager-C.omf | 27 ++ help/virt-manager/C/virt-manager-manual-C.omf | 27 -- help/virt-manager/C/virt-manager-manual.xml | 475 ----------------------- help/virt-manager/C/virt-manager.xml | 519 ++++++++++++++++++++++++++ 5 files changed, 548 insertions(+), 504 deletions(-) create mode 100644 help/virt-manager/C/virt-manager-C.omf delete mode 100644 help/virt-manager/C/virt-manager-manual-C.omf delete mode 100644 help/virt-manager/C/virt-manager-manual.xml create mode 100644 help/virt-manager/C/virt-manager.xml (limited to 'help/virt-manager/C') diff --git a/help/virt-manager/C/Makefile.am b/help/virt-manager/C/Makefile.am index fa8fe0c7..f512ca93 100644 --- a/help/virt-manager/C/Makefile.am +++ b/help/virt-manager/C/Makefile.am @@ -1,7 +1,7 @@ figdir = figures -docname = virt-manager-manual +docname = virt-manager lang = C -omffile = virt-manager-manual-C.omf +omffile = virt-manager-C.omf entities = fdl-appendix.xml legal.xml include $(top_srcdir)/xmldocs.make dist-hook: app-dist-hook diff --git a/help/virt-manager/C/virt-manager-C.omf b/help/virt-manager/C/virt-manager-C.omf new file mode 100644 index 00000000..2756999c --- /dev/null +++ b/help/virt-manager/C/virt-manager-C.omf @@ -0,0 +1,27 @@ + + + + + hbrock@redhat.com (Hugh Brock) + + + Virtual Machine Manager Manual + + + 2007-03-01 + + + + + This is the manual for the Virtual Machine Manager application. + + + manual + + + + + + + + diff --git a/help/virt-manager/C/virt-manager-manual-C.omf b/help/virt-manager/C/virt-manager-manual-C.omf deleted file mode 100644 index f27673cc..00000000 --- a/help/virt-manager/C/virt-manager-manual-C.omf +++ /dev/null @@ -1,27 +0,0 @@ - - - - - hbrock@redhat.com (Hugh Brock) - - - Virtual Machine Manager Manual - - - 2007-03-01 - - - - - This is the manual for the Virtual Machine Manager application. - - - manual - - - - - - - - diff --git a/help/virt-manager/C/virt-manager-manual.xml b/help/virt-manager/C/virt-manager-manual.xml deleted file mode 100644 index 86a6e2b2..00000000 --- a/help/virt-manager/C/virt-manager-manual.xml +++ /dev/null @@ -1,475 +0,0 @@ - - - - - - - -]> - - - - - - - - -
- - - - - Virtual Machine Manager Manual - - 2007 - Red Hat Inc., and Hugh Brock - - - - - - Red Hat Inc. - - - &legal; - - - - - Hugh - Brock - - Red Hat Inc. -
hbrock@redhat.com
- - - - Daniel - Berrange - - Red Hat Inc. -
berrange@redhat.com
- - - - - - - - - - - - - - - - - - - This manual describes how to manage virtual machines - with the Virtual Machine Manager program. - - - Feedback - To report a bug or make a suggestion regarding this package or - this manual, follow the directions in the - GNOME Feedback Page. - - - - - - - - - Introduction - - - About <application>&app;</application> - - virt-manager - About - - - &app; is a GUI tool for managing virtual - machines. It helps you create, destroy, edit, monitor, save, restore, - pause, and use the console on virtual machines running on multiple - hypervisors (and, soon, multiple physical hosts). Because - &app; relies entirely on - libvirt (http://libvirt.org), the platform- and - hypervisor-independent virtualization library, it is insulated from - hypervisor API changes and virtualization system changes. - - - &app; is released under the GNU General Public - License. Contributions of source code patches are welcome and encouraged - at virt-manager.org, where you will - also find plans for future development. - - - - About this Document - - This document is released under the GNU Free Documentation - License. Corrections are welcome and encouraged at virt-manager.org. - - - - - - Getting Started - - - This section describes the different ways to start - &app;, the command-line options that are - available, and the various options in the Connection window. - - - Starting virt-manager - You can start - virt-manager from the Applications menu or from the command - line - - - From the Applications menu: - - Choose System - ToolsVirtual Machine Manager. - - - - From the command line: - - Execute the following command: virt-manager - - - - - - - The Connection Window - The connection window - lets you choose the type of hypervisor to connect to, and also - whether to connect locally or to a remote machine. - When you start &app;, the following window is displayed: - -
- Connection Window - - - - - - Shows &app; connection window. - - - -
- - The Connection Window contains the following - elements: - - Hypervisor pull-down - - The Hypervisor pull-down lets you choose a supported hypervisor to - connect to. The hypervisor must be started before you can connect to it. - - - "Host Type" radio buttons - - The "Host Type" radio buttons let you choose whether to connect to - a hypervisor on the local physical host, or (soon) a hypervisor on a - remote physical host. - - - The "Host" box lets you enter the hostname of a remote host to - connect to. - - - Read-only connection - - Checking "Read-only connection" will allow you to - monitor a hypervisor's virtual machines, but not make any changes to - them. If you are running as an unprivileged user, you may only be able - to connect to certain hypervisors read-only. - - - - - - Command-line Options - If you run &app; from the command line, you can specify a hypervisor - URI to connect to, bypassing the Connection Window. You can also make - specific &app; windows appear using the command line, if you have already - established a connection to a hypervisor. The command line options are: - - -h, --help: show command line help and exit - - - --profile=FILE: Generate runtime performance profile stats - - - -c URI, --connect=URI: Connect to hypervisor at - URI - - - --no-dbus: Disable DBus service for controlling - UI - - - --show-domain-creator: Create a new virtual - machine - - - --show-domain-editor=UUID: Edit a domain - configuration - - - --show-domain-performance=UUID: Show a domain - performance - - - --show-domain-console=UUID: Show a domain - console - - - --show-host-summary: Show a host summary - - - - Hypervisor URIs and the test hypervisor To connect to - a local Xen hypervisor, the URI is simply "xen" (the - default). To connect to a local QEMU session, the URI is - "qemu:///session". There is also a test hypervisor that is - handy if you are trying to test a new &app; feature you have added. Its - URI is "test:///default". - - - - - - The Manager Window - The manager window gives you a quick snapshot of the virtual machines - that are available on your physical host, those that are actually running - on your physical host, and the resources those running VMs are - consuming. The manager window is customizable as described below. - -
- Manager Window - - - - - - Shows a typical Manager Window. - - - -
- - - The Virtual Machine List - The manager window is dominated by a list of virtual machines on your - physical host. By default, the list has six columns of information: - - ID - - The arbitrarily assigned ID number for the - virtual machine. Guaranteed unique only while a virtual machine is - running, and only to that particular host. - - - Name - - The name of the virtual machine. Like the ID, guaranteed unique - only among running virtual machines on a particular host. - - - Status - - The virtual machine's status. One of Running, - Paused, Shutdown, - Shutoff, or Crashed. - - - CPU Usage - - The virtual machine's CPU usage, as a percentage of total CPU - time and as a running graph. - - - VCPUs - - The number of VCPUs currently assigned to the guest. This - allocation can be changed on the fly for paravirtualized - guests. - - - Memory Usage - - The amount of memory allocated to the virtual machine, and the percentage - of total physical RAM on the host that the virtual machine is actually - using (the percentage will be zero if the guest is not currently - running). Note: The amount of memory for a virtual machine is the - amount it is currently allocated, not the maximum it could be - allocated. See the help for the Details Window - - - - - - - File Menu Choices - All about the File menu choices - - - Edit Menu Choices - All about the Edit menu choices - - - View Menu Choices - All about the View menu choices - - - - - Foo - - - - - Bar - - - - - Baz - - - - - - - - - The Details Window - You manage the details of a specific virtual machine here - - - - The Console Window - You view the console of a specific virtual machine here - - - - The Create Wizard - You create new virtual machines here - - The System Name screen - Choose a name for your virtual system. The name must be non-blank, - alphanumeric (plus underscores), contain at least one letter, and be less - than 50 characters. - - - - The Virtualization Method screen - Choose a virtualization method for your new system. - - - - The Installation Media screens - Choose installation media for your new system. - - - - The Storage Space screen - Assign storage space for your new system. - - - - The Memory And CPU screen - Choose memory and cpu for your new system - - - - The Validation screen - Verify the setup for your new system. If you need to, back up and - make changes. Clicking "Finish" will begin creating your virtual - machine. - - - - &GFDL; - -
- - diff --git a/help/virt-manager/C/virt-manager.xml b/help/virt-manager/C/virt-manager.xml new file mode 100644 index 00000000..1af21658 --- /dev/null +++ b/help/virt-manager/C/virt-manager.xml @@ -0,0 +1,519 @@ + + + + + + + +]> + + + + + + + + +
+ + + + + Virtual Machine Manager Manual + + 2007 + Red Hat Inc., and Hugh Brock + + + + + + Red Hat Inc. + + + &legal; + + + + + Hugh + Brock + + Red Hat Inc. +
hbrock@redhat.com
+ + + + Daniel + Berrange + + Red Hat Inc. +
berrange@redhat.com
+ + + + + + + + + + + + + + + + + + + This manual describes how to manage virtual machines + with the Virtual Machine Manager program. + + + Feedback + To report a bug or make a suggestion regarding this package or + this manual, follow the directions in the + GNOME Feedback Page. + + + + + + + + + Introduction + + + About <application>&app;</application> + + virt-manager + About + + + &app; is a GUI tool for managing virtual + machines. It helps you create, destroy, edit, monitor, save, restore, + pause, and use the console on virtual machines running on multiple + hypervisors (and, soon, multiple physical hosts). Because + &app; relies entirely on + libvirt (http://libvirt.org), the platform- and + hypervisor-independent virtualization library, it is insulated from + hypervisor API changes and virtualization system changes. + + + &app; is released under the GNU General Public + License. Contributions of source code patches are welcome and encouraged + at virt-manager.org, where you will + also find plans for future development. + + + + About this Document + + This document is released under the GNU Free Documentation + License. Corrections are welcome and encouraged at virt-manager.org. + + + + + + Getting Started + + + This section describes the different ways to start + &app;, the command-line options that are + available, and the various options in the Connection window. + + + Starting virt-manager + You can start + virt-manager from the Applications menu or from the command + line + + + From the Applications menu: + + Choose System + ToolsVirtual Machine Manager. + + + + From the command line: + + Execute the following command: virt-manager + + + + + + + The Connection Window + The connection window + lets you choose the type of hypervisor to connect to, and also + whether to connect locally or to a remote machine. + When you start &app;, the following window is displayed: + +
+ Connection Window + + + + + + Shows &app; connection window. + + + +
+ + The Connection Window contains the following + elements: + + Hypervisor pull-down + + The Hypervisor pull-down lets you choose a supported hypervisor to + connect to. The hypervisor must be started before you can connect to it. + + + "Host Type" radio buttons + + The "Host Type" radio buttons let you choose whether to connect to + a hypervisor on the local physical host, or (soon) a hypervisor on a + remote physical host. + + + The "Host" box lets you enter the hostname of a remote host to + connect to. + + + Read-only connection + + Checking "Read-only connection" will allow you to + monitor a hypervisor's virtual machines, but not make any changes to + them. If you are running as an unprivileged user, you may only be able + to connect to certain hypervisors read-only. + + + + + + Command-line Options + If you run &app; from the command line, you can specify a hypervisor + URI to connect to, bypassing the Connection Window. You can also make + specific &app; windows appear using the command line, if you have already + established a connection to a hypervisor. The command line options are: + + -h, --help: show command line help and exit + + + --profile=FILE: Generate runtime performance profile stats + + + -c URI, --connect=URI: Connect to hypervisor at + URI + + + --no-dbus: Disable DBus service for controlling + UI + + + --show-domain-creator: Create a new virtual + machine + + + --show-domain-editor=UUID: Edit a domain + configuration + + + --show-domain-performance=UUID: Show a domain + performance + + + --show-domain-console=UUID: Show a domain + console + + + --show-host-summary: Show a host summary + + + + Hypervisor URIs and the test hypervisor To connect to + a local Xen hypervisor, the URI is simply "xen" (the + default). To connect to a local QEMU session, the URI is + "qemu:///session". There is also a test hypervisor that is + handy if you are trying to test a new &app; feature you have added. Its + URI is "test:///default". + + + + + + The Manager Window + The manager window gives you a quick snapshot of the virtual machines + that are available on your physical host. It displays both the virtual + machines that are actually running + on your physical host, and also the virtual machines for which it finds + config information even though they are not running. For running virtual + machines, the manager window displays the resources those running VMs are + consuming. The manager window is customizable as described below. + +
+ Manager Window + + + + + + Shows a typical Manager Window. + + + +
+ + + The Virtual Machine List + The manager window is dominated by a list of the virtual machines on your + physical host. By default, the list has six columns of information: + + ID + + The arbitrarily assigned ID number for the + virtual machine. Guaranteed unique only while a virtual machine is + running, and only to that particular host. + + + Name + + The name of the virtual machine. Like the ID, guaranteed unique + only among running virtual machines on a particular host. + + + Status + + The virtual machine's status. One of Running, + Paused, Shutdown, + Shutoff, or Crashed. + + + CPU Usage + + The virtual machine's CPU usage, as a percentage of total CPU + usage and as a running graph. + + + VCPUs + + The number of VCPUs currently assigned to the guest. This + allocation can be changed on the fly for paravirtualized + guests. + + + Memory Usage + + The amount of memory allocated to the virtual machine, and the percentage + of total physical RAM on the host that the virtual machine is actually + using (the percentage will be zero if the guest is not currently + running). Note: The amount of memory for a virtual machine is the + amount it is currently allocated, not the maximum it could be + allocated. See the help for the . + + + + + + + File Menu Choices + The File menu in the Manager window gives you the following + options: + + New machine... + Starts the virtual machine creation wizard. Clicking the + New button at the bottom of the window has the + same effect. + + + Restore saved machine... + Restores a previously saved virtual machine. You must + choose the memory image of a previously saved virtual machine in the + dialog that will follow. + + + Open connection... + Brings up the connection window again. You can connect to + multiple hypervisors at the same time with + &app;. At this writing opening a new + connection brings up a new manager window; soon the manager window will + display multiple connections to multiple machines. + + + Close + Closes the Manager window. Any other + &app; windows you have open will remain open. + + + Quit + Closes the Manager window and any other open windows and + stops the application. Note that any virtual machines running on the + host will continue running regardless of whether + &app; is running or not. + + + + + + + Edit Menu Choices + The choices on the Edit menu are for working with + a specific machine, or for changing &app; + preferences. + + Machine details... + Opens the Details window for the virtual machine you have + highlighted in the list. + + + Delete machine + Deletes the configuration of an inactive virtual machine you have + highlighted in the list. Note that this does not touch the virtual + machine's disk storage. + + + Preferences + Brings up the + + + + + + View Menu Choices + The View Menu choices toggle on and off the virtual machine list + columns that are described above. + + + + + The Details Window + You manage the details of a specific virtual machine here + + + + The Console Window + You view the console of a specific virtual machine here + + + + The Preferences Window + You set application preferences here + + + + The Create Wizard + You create new virtual machines here + + The System Name screen + Choose a name for your virtual system. The name must be non-blank, + alphanumeric (plus underscores), contain at least one letter, and be less + than 50 characters. + + + + The Virtualization Method screen + Choose a virtualization method for your new system. + + + + The Installation Media screens + Choose installation media for your new system. + + + + The Storage Space screen + Assign storage space for your new system. + + + + The Memory And CPU screen + Choose memory and cpu for your new system + + + + The Validation screen + Verify the setup for your new system. If you need to, back up and + make changes. Clicking "Finish" will begin creating your virtual + machine. + + + + &GFDL; + +
+ + -- cgit v1.2.1