diff options
author | Christophe Fergeau <cfergeau@redhat.com> | 2013-09-24 12:04:24 +0200 |
---|---|---|
committer | Christophe Fergeau <cfergeau@redhat.com> | 2013-09-24 12:04:24 +0200 |
commit | 441933c5d13ee1be3c7df96eb50fd0e2bd68747f (patch) | |
tree | d5c9feb75ecca0d6e6d490f920aae52587fa466c | |
parent | c39448895ca4a9148e89d290d1fd310645c7baff (diff) |
fixup! Fix typos/reformat a few paragraphs
-rw-r--r-- | books/docbook/SpiceUserManual-Basics.xml | 63 | ||||
-rw-r--r-- | books/docbook/SpiceUserManual-Installation.xml | 48 |
2 files changed, 56 insertions, 55 deletions
diff --git a/books/docbook/SpiceUserManual-Basics.xml b/books/docbook/SpiceUserManual-Basics.xml index 5303217..b445ede 100644 --- a/books/docbook/SpiceUserManual-Basics.xml +++ b/books/docbook/SpiceUserManual-Basics.xml @@ -17,34 +17,34 @@ <section xml:id="client"> <title>Client</title> - <para>Client is reffering to a system running spice client (e.g. spicec or spicy).</para> + <para>Client is referring to a system running the spice client (e.g. spicec or spicy).</para> </section> </section> <section xml:id="qemu_basics"> <title>Launching qemu</title> - <para>I'll use qemu-kvm as a name for the executable. If you're using manually built qemu or - qemu without kvm then just replace qemu-kvm with your own binary. I'll use host# client# - guest# shell prompt notation to distinguish wherever should be the command executed. See + <para>I'll use qemu-kvm as a name for the executable. If you're using a manually built qemu or + a qemu without kvm then just replace qemu-kvm with your own binary. I'll use host# client# + guest# shell prompt notations to distinguish where the command should be the command. See section <link xlink:href="definitions">Basic Definitions</link> to be sure that you know - difference between the host, client and guest. You can ignore notation If guest, client - and host are on the same machine.</para> + difference between the host, client and guest. You can ignore the difference between guest, client + and host if they are all running on the same machine.</para> <para> - <emphasis role="bold">First important thing to do is to create a guest - image.</emphasis> You can use any raw device like clean logical volume, or iSCSI - lun. You may also use file as image for guest. I'll use file created by qemu-img as a demonstration. + <emphasis role="bold">The first important thing to do is to create a guest + image.</emphasis> You can use any raw device such as a clean logical volume, or an iSCSI + lun. You may also use a file as the disk image for the guest. I'll use a file created by qemu-img as a demonstration. </para> <para> - Following command will allocate 10GB file. See qemu-img manpage for further information. + The following command will allocate a 10GB file. See qemu-img man page for further information. </para> <screen>host# qemu-img create /path/to/xp.img 10G</screen> <para> - So we already have image created and shall now start with image popullation. I assume that you have - locally stored ISO of your favourite operating system so you can use it for installation. + Now that we created an image, we can now start with image population. I assume that you have + a locally stored ISO of your favourite operating system so you can use it for installation. </para> <screen>host# sudo qemu-kvm -boot order=dc -vga qxl \ @@ -54,14 +54,14 @@ -cdrom /path/to/your.iso /path/to/your.img</screen> <para> - Let's take just briefly look trough used qemu options. Option -boot order=dc specifies that guest system - should try to boot from first cdrom and then fallback to first disk, -vga qxl specifies that qemu should - emulate qxl device adapter. + Let's take a brief look at the qemu options that were used. The option -boot order=dc specifies that the guest system + should try to boot from the first cdrom and then fallback to the first disk, -vga qxl specifies that qemu should + emulate the qxl device adapter. </para> - <para> Spice port option define what port will be used for communication with client. Spice + <para> The Spice port option defines what port will be used for communication with the client. The Spice option disable-ticketing is telling us that ticketing <emphasis role="italic">(simple - authentification method)</emphasis> is not used. Virtio and chardev devices are - required by <link xlink:href="SpiceUserManual-Introduction.xml#vdagent">guest + authentication method)</emphasis> is not used. The virtio and chardev devices are + required by <link xlink:href="SpiceUserManual-Introduction.xml#vdagent">the guest agent</link>. </para> @@ -70,13 +70,14 @@ <title>Connecting to guest</title> <para> - Folliwng section will show you basic usage of spice client. Example connection will be related to qemu - instance executed in <link xlink:href="#qemu_basics">previous section</link>. + The following section will show you basic usage of the spice + client. The example connection will be related to the qemu instance + started in <link xlink:href="#qemu_basics">the previous section</link>. </para> <para> - Be aware that port used for spice communication <emphasis role="italic">(port 3001 in our case)</emphasis> should not be blocked by firewall. - <emphasis role="bold">Host myhost is reffering to machine which is running our qemu instance.</emphasis> + Be aware that the port used for spice communication <emphasis role="italic">(port 3001 in our case)</emphasis> should not be blocked by firewall. + <emphasis role="bold">Host myhost is referring to the machine which is running our qemu instance.</emphasis> </para> <screen>client# spicec -h myhost -p 3001</screen> @@ -90,17 +91,17 @@ </figure> <para> - Spice does not currently suport multiple connections to one qemu instance. - So anybody who will connect to the same host and port can simply take your session. + Spice does not currently support multiple connections to the same qemu instance. + So anybody who will connect to the same host and port can simply take over your session. <emphasis role="bold">You can eliminate this problem by using <link xlink:href="#ticketing">ticketing</link> or SSL.</emphasis> </para> <para xml:id="ticketing"> - Ticketing is simple authentication system which enables you to set simple ticket to a vm. - Client has to authentificate before connection can be established. See spice option password in - following example. + Ticketing is a simple authentication system which enables you to set simple tickets to a vm. + Client has to authentificate before the connection can be established. See the spice option password in + the following example. </para> <screen>host# sudo qemu-kvm -boot order=dc -vga qxl \ @@ -111,12 +112,12 @@ <screen>client# spicec -h myhost -p 3001 -w mysecretpassword</screen> - <para>Spice session won't be established in case that correct ticket wasn't passed to the client.</para> + <para>The Spice session won't be established if an incorrect ticket was passed to the client.</para> <para> - You might have figured out that passing ticket as commandline option isn't very safe way at all. - <emphasis role="bold">It's not safe as everybody with access to host can read it from output of ps(1).</emphasis> - To prevent this ticket can be also set by using qemu-console command spice._set_ticket. + You might have figured out that passing tickets as a commandline option isn't very safe. + <emphasis role="bold">It's not safe as everybody with access to the host can read it from the output of ps(1).</emphasis> + To prevent this, the ticket can be also set by using the qemu console command spice._set_ticket. </para> </section> </chapter> diff --git a/books/docbook/SpiceUserManual-Installation.xml b/books/docbook/SpiceUserManual-Installation.xml index fcd5bf1..9ef89e7 100644 --- a/books/docbook/SpiceUserManual-Installation.xml +++ b/books/docbook/SpiceUserManual-Installation.xml @@ -5,9 +5,9 @@ <title>Installation</title> <section xml:id="rhel_fedora"> - <title>Installing Spice in RHEL or Fedora </title> + <title>Installing Spice on RHEL or Fedora </title> <para> - Be aware that there is no build of spice-server for i386 so you can run only client part on i386. The reason for it is that there is no buld of qemu-kvm for RHEL of Fedora i386 either. + Be aware that there is no build of spice-server for i386 so you can run only the client part on i386. The reason for it is that there is no i386 build of qemu-kvm for RHEL of Fedora either. </para> <section> <title>RHEL >=6 and Fedora >=13</title> @@ -16,7 +16,7 @@ <screen>yum install spice-gtk # Only on Fedora >=14</screen> </para> <para> - Package spice-protocol will be downloaded automatically as a dependency for package kvm. + The package spice-protocol will be downloaded automatically as a dependency of package kvm. </para> </section> <section><title>RHEL 5</title> @@ -24,14 +24,14 @@ <screen>yum install kvm qspice-client</screen> </para> <para> - Similarly as in RHEL6 package kvm has qspice-libs as a dependency. + Similarly as for the RHEL6 package, kvm has qspice-libs as a dependency. </para> </section> <section><title>RHEVM Users</title> <para> <emphasis role="bold"> - RHEVM users could be also interested in spice-xpi package as - it's allow you to execute spice-client directly from the RHEVM + RHEVM users could be also interested in the spice-xpi package as + it allows you to execute spice-client directly from the RHEVM UserPortal. </emphasis> <screen>yum install spice-xpi</screen> @@ -40,11 +40,11 @@ </section> <section xml:id="linux_generic"> - <title>Building Spice in Generic Linux</title> + <title>Generic Build Instructions</title> <para> This section is for distributions that don't have *spice* packages in their repositories. - It will show you step by step how to build required spice components. + It will show you step by step how to build the required spice components. </para> <section xml:id="req_client"> @@ -53,7 +53,7 @@ <orderedlist> <listitem><para><emphasis role="bold">autotools</emphasis></para></listitem> <listitem><para><emphasis role="bold">pixman >= 1.7.1</emphasis></para></listitem> - <listitem><para><emphasis role="bold">celt = 0.5.1.3</emphasis> The exact version is required due no backwards compatibility of celt.</para></listitem> + <listitem><para><emphasis role="bold">celt = 0.5.1.3</emphasis> The exact version is required due to the lack of backwards compatibility in newer celt releases.</para></listitem> <listitem><para><emphasis role="bold">alsa</emphasis></para></listitem> <listitem><para><emphasis role="bold">log4cpp</emphasis></para></listitem> <listitem><para><emphasis role="bold">openssl</emphasis></para></listitem> @@ -82,34 +82,34 @@ <section> <title>Linux Guest</title> <para> - spice-vdagent requires virtio-serial support should to be enabled. This will be described in <link xlink:href="SpiceUserManual-Basics.xml#basics">chapter Spice basics</link>. + spice-vdagent requires virtio-serial support to be enabled. This is described in the <link xlink:href="SpiceUserManual-Basics.xml#basics">chapter Spice basics</link>. Guest should have installed qxl driver (xorg-x11-drv-qxl on Fedora and RHEL). </para> </section> <section> <title>Windows Guest</title> <para> - Drivers for QXL and drivers for virtio-serial assume Win XP SP3 and Win 7. + Drivers for QXL and drivers for virtio-serial require Win XP SP3 and Win 7. </para> </section> <section xml:id="setting_be"> - <title>Setting up build environment</title> + <title>Setting up the build environment</title> <para> - <emphasis role="bold">This is list of prerequisities on RHEL or Fedora. Install - package equivalents for your distrubition in case that you're not using RHEL + <emphasis role="bold">This is a list of prerequisites on RHEL or Fedora. Install + equivalent packages for your distribution in case that you're not using RHEL or Fedora.</emphasis> </para> <para> - <emphasis role="bold">All prerequisities for Windows are available in one big package which is available + <emphasis role="bold">All prerequisites for Windows are available in one big package which is available at <link xlink:href="http://spice-space.org/download.html">http://spice-space.org/download.html</link>.</emphasis> </para> <screen>yum install git pixman-devel celt051-devel cegui-devel libjpeg-devel alsa-lib-devel log4cpp-devel \ openssl-devel libXrandr-devel libgcrypt-devel SDL-devel nss-devel dev86 iasl pyparsing</screen> <para> - <emphasis role="bold">Package prerequisities for Ubuntu</emphasis> + <emphasis role="bold">Package prerequisites for Ubuntu</emphasis> </para> <screen>apt-get install build-essential autoconf git-core libtool liblog4cpp5-dev libavcodec-dev \ libssl-dev xlibmesa-glu-dev libasound-dev libpng12-dev libfreetype6-dev libfontconfig1-dev \ @@ -121,10 +121,10 @@ <title>Building libcacard</title> <para>Fedora >=14 RHEL >=6.1 has libcacard already available. So you can install it directly trough yum.</para> <screen>yum install libcacard</screen> - <para>Otherwise follow these instructions. <emphasis role="bold">Environmental + <para>Otherwise follow these instructions. <emphasis role="bold">The environment variable $BUILD_ROOT will point to a directory with stored sources and will - be used during whole build process. Variable $INST_ROOT will point to a - directory in which will be spice installed.</emphasis></para> + be used during the whole build process. The variable $INST_ROOT will point to a + directory in which Spice will be installed.</emphasis></para> <screen>export BUILD_ROOT=/tmp/spice; mkdir $BUILD_ROOT; cd $BUILD_ROOT; export INST_ROOT="/opt/spice"; mkdir $INST_ROOT git clone git://anongit.freedesktop.org/~alon/libcacard @@ -185,8 +185,8 @@ sudo make install</screen> <section> <title>Building server side tools</title> - <para>These instruction contains flags for minimal working build of qemu with spice support enabled. - You might want to build qemu with --enable-io-thread options</para> + <para>These instructions contain flags for a minimal working build of qemu with Spice support enabled. + You might want to build qemu with the --enable-io-thread option</para> <screen>cd $SRC_ROOT/qemu ./configure --prefix=$INST_ROOT --target-list=x86_64-softmmu --enable-spice make</screen> @@ -196,16 +196,16 @@ make</screen> <section> <title>Setting up PATH</title> - <para>Last steps before starting with spice are to set proper PATH variable. + <para>Last steps before starting with Spice are to set proper PATH variable. For example RHEL is using /usr/libexec as directory for spicec and qemu-kvm binaries. - Following setup should be suitable for qemu and spice build according to instructions in + The following setup should be suitable for qemu and Spice built according to the instructions in this chapter.</para> <screen>echo "export PATH=$PATH:$INST_ROOT/bin:$BUILD_ROOT/x86_64-softmmu >> ~/.bashrc source ~/.bashrc</screen> - <para>You should now be able to access qemu-system-x86_64 and spicec binaries.</para> + <para>You should now be able to access the qemu-system-x86_64 and spicec binaries.</para> </section> </section> |