GNOME.org
 

[gnome-boxes] help: assorted additions and fixes

commit 84dbdfd202ee79fc867b7e6ef4bd72d78b333ec1
Author: Michael Hill <mdhill gnome org>
Date:   Sat Sep 13 16:37:01 2014 -0400

    help: assorted additions and fixes

 help/C/clipboard.page                    |   33 ++++++++++++++++++++++++++++
 help/C/clipboard.page.stub               |   35 ------------------------------
 help/C/continuous.page                   |    7 ++---
 help/C/delete.page                       |   32 +++++++++++++++++++++++++++
 help/C/delete.page.stub                  |   35 ------------------------------
 help/C/disk-images.page                  |   27 +++++++++++++++++++++++
 help/C/disk-images.page.stub             |   35 ------------------------------
 help/C/hardware-virtualization.page.stub |   35 ------------------------------
 help/C/index.page                        |    7 ++++++
 help/C/interface.page                    |    3 +-
 help/C/search.page                       |   11 +++++----
 help/C/shortcuts.page                    |    2 +-
 help/C/shutdown.page                     |   33 ++++++++++++++++++++++++++++
 help/C/supported-protocols.page          |    5 ++-
 help/C/system-requirements.page          |    8 ++++--
 help/C/virtualization.page               |   27 +++++++++++++++++++++++
 help/Makefile.am                         |    5 ++++
 17 files changed, 184 insertions(+), 156 deletions(-)
---
diff --git a/help/C/clipboard.page b/help/C/clipboard.page
new file mode 100644
index 0000000..9236580
--- /dev/null
+++ b/help/C/clipboard.page
@@ -0,0 +1,33 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="clipboard">
+  <info>
+    <revision pkgversion="3.14" date="2014-09-13" status="review"/>
+    <link type="guide" xref="index#use"/>
+
+    <credit type="author copyright">
+      <name>Michael Hill</name>
+      <email>mdhillca gmail com</email>
+      <years>2014</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <desc>Use the clipboard with <app>Boxes</app>.</desc>
+  </info>
+
+  <title>Share the clipboard</title>
+
+  <p>The clipboard of the host machine can be shared with the guest in
+  <app>Boxes</app>.</p>
+
+  <steps>
+    <item><p>Open the <link xref="interface#properties">properties view</link>
+    for the box. If the box is open, click the Properties button in the header
+    bar. The properties view can also be accessed from
+    <link xref="interface#selection">selection mode</link>.</p></item>
+    <item><p>Click <gui>Display</gui> in the sidebar.</p></item>
+    <item><p>Switch <gui>Share clipboard</gui> to <gui>ON</gui>.</p></item>
+  </steps>
+
+</page>
diff --git a/help/C/continuous.page b/help/C/continuous.page
index 07114f4..eae557b 100644
--- a/help/C/continuous.page
+++ b/help/C/continuous.page
@@ -37,10 +37,9 @@
     <item><p>Click <gui style="button">Select a file</gui> and navigate to the
     Continuous qcow2 image. Select the file and click
     <gui style="button">Open</gui>.</p></item>
-    <item><p>Click <gui style="button">Continue</gui>. The <gui>Review</gui>
-    page opens.</p></item>
-    <item><p>Click <gui style="button">Customize</gui> to adjust memory or disk
-    size, or to rename the box.</p></item>
+    <item><p>The <gui>Review</gui> page opens. Click
+    <gui style="button">Customize</gui> to adjust memory or disk size, or to
+    rename the box.</p></item>
     <item><p>Click <gui style="button">Create</gui>. The collection view
     returns, and the installation of the box begins.</p></item>
   </steps>
diff --git a/help/C/delete.page b/help/C/delete.page
new file mode 100644
index 0000000..3159123
--- /dev/null
+++ b/help/C/delete.page
@@ -0,0 +1,32 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="delete">
+  <info>
+    <revision pkgversion="3.14" date="2014-09-13" status="review"/>
+    <link type="guide" xref="index#use"/>
+
+    <credit type="author copyright">
+      <name>Michael Hill</name>
+      <email>mdhillca gmail com</email>
+      <years>2014</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <desc>Remove a box that you no longer need.</desc>
+  </info>
+
+  <title>Delete a box</title>
+
+  <p>When a box is no longer needed, it can be deleted from <app>Boxes</app>.</p>
+
+  <steps>
+    <item><p>Select one or more boxes. In the collection view, right click a
+    box to be deleted.</p></item>
+    <item><p><link xref="interface#selection">Selection mode</link>
+    opens. Click additional boxes to select them for deletion.</p></item>
+    <item><p>Click the <gui style="button">Delete</gui> button.</p></item>
+    <item><p>Click the <key>X</key> to confirm.</p></item>
+  </steps>
+
+</page>
diff --git a/help/C/disk-images.page b/help/C/disk-images.page
new file mode 100644
index 0000000..e12fee0
--- /dev/null
+++ b/help/C/disk-images.page
@@ -0,0 +1,27 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="disk-images">
+  <info>
+    <revision pkgversion="3.14" date="2014-09-13" status="review"/>
+    <link type="guide" xref="index#faq"/>
+
+    <credit type="author copyright">
+      <name>Michael Hill</name>
+      <email>mdhillca gmail com</email>
+      <years>2014</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <desc></desc>
+  </info>
+
+  <title>Where does Boxes store disk images?</title>
+
+  <p>By default, <app>Boxes</app> stores disk images in the folder
+  <file>~/.local/share/gnome-boxes/images/</file>. If you are using other
+  software that interfaces with libvirt, such as <app>virt-manager</app>, then
+  <app>Boxes</app> will also read from the folder that software uses to store
+  its images.</p>
+
+</page>
diff --git a/help/C/index.page b/help/C/index.page
index 3094df5..40cec47 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -10,6 +10,7 @@
     </title>
     <revision pkgversion="3.8.0" date="2013-03-25" status="candidate"/>
     <revision pkgversion="3.12" date="2014-03-10" status="candidate"/>
+    <revision pkgversion="3.14" date="2014-09-13" status="review"/>
 
     <credit type="author copyright">
       <name>Baptiste Mille-Mathias</name>
@@ -59,6 +60,12 @@
   </section>
 -->
 
+<!--
+  <section id="snapshots" style="2column">
+    <title>Snapshots</title>
+  </section>
+-->
+
   <section id="faq" style="2column">
     <title>Questions</title>
   </section>
diff --git a/help/C/interface.page b/help/C/interface.page
index dd241aa..6768aa1 100644
--- a/help/C/interface.page
+++ b/help/C/interface.page
@@ -2,7 +2,8 @@
       type="topic" style="task"
       id="interface">
   <info>
-    <revision pkgversion="3.8.0" version="0.1" date="2013-03-23" status="candidate"/>
+    <revision pkgversion="3.8.0" date="2013-03-23" status="candidate"/>
+    <revision pkgversion="3.14" date="2014-09-13" status="review"/>
     <link type="guide" xref="index#use" group="#first" />
 
     <credit type="author copyright">
diff --git a/help/C/search.page b/help/C/search.page
index cfce11d..4adcb30 100644
--- a/help/C/search.page
+++ b/help/C/search.page
@@ -2,7 +2,8 @@
       type="topic" style="task"
       id="search">
   <info>
-    <revision pkgversion="3.8.0" version="0.1" date="2013-03-25" status="candidate"/>
+    <revision pkgversion="3.8.0" date="2013-03-25" status="candidate"/>
+    <revision pkgversion="3.14" date="2014-09-13" status="review"/>
     <link type="guide" xref="index#start"/>
 
     <credit type="author copyright">
@@ -18,10 +19,10 @@
 
   <title>Search for a box</title>
 
-  <p>If there is more than one box, you can locate a box by name in the
-  <link xref="collection">collection view</link> or
-  <link xref="selection">selection mode</link>. Click the search icon, or just
-  start typing to initiate the search.</p>
+  <p>If there is more than one box, you can locate or filter boxes by name in
+  the <link xref="interface#collection">collection view</link> or
+  <link xref="interface#selection">selection mode</link>. Click the search
+  icon, or just start typing to initiate a search.</p>
 
   <p>Press <key>Esc</key> to dismiss the search.</p>
 
diff --git a/help/C/shortcuts.page b/help/C/shortcuts.page
index 86c2724..91af6e6 100644
--- a/help/C/shortcuts.page
+++ b/help/C/shortcuts.page
@@ -15,7 +15,7 @@
 
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
 
-    <desc>How to operate Boxes with keyboard shortcuts.</desc>
+    <desc>Operate Boxes using keyboard shortcuts.</desc>
   </info>
 
   <title>Keyboard shortcuts</title>
diff --git a/help/C/shutdown.page b/help/C/shutdown.page
new file mode 100644
index 0000000..745fbb8
--- /dev/null
+++ b/help/C/shutdown.page
@@ -0,0 +1,33 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="shutdown">
+  <info>
+    <revision pkgversion="3.14" date="2014-09-13" status="review"/>
+    <link type="guide" xref="index#use"/>
+
+    <credit type="author copyright">
+      <name>Michael Hill</name>
+      <email>mdhill gnome org</email>
+      <years>2014</years>
+    </credit>
+
+    <desc>Shut down a box that has stopped working.</desc>
+  </info>
+
+  <title>Force a box to shut down</title>
+
+  <p>If a box stops responding, you can force it to shut down. This allows you
+  to restart the virtual machine in the hope of returning it to its working
+  state.</p>
+
+  <steps>
+    <item><p>Open the <link xref="interface#properties">properties view</link>
+    for the box. If the box is open, click the Properties button in the header
+    bar. The properties view can also be accessed from
+    <link xref="interface#selection">selection mode</link>.</p></item>
+    <item><p>Click <gui style="button">Force Shutdown</gui> in the lower left
+    corner.</p></item>
+    <item><p>Click to confirm.</p></item>
+  </steps>
+
+</page>
diff --git a/help/C/supported-protocols.page b/help/C/supported-protocols.page
index 62bbd6c..bc52717 100644
--- a/help/C/supported-protocols.page
+++ b/help/C/supported-protocols.page
@@ -2,7 +2,8 @@
       type="topic" style="task"
       id="supported-protocols">
   <info>
-    <revision pkgversion="3.8.0" version="0.1" date="2013-03-25" status="candidate"/>
+    <revision pkgversion="3.8.0" date="2013-03-25" status="candidate"/>
+    <revision pkgversion="3.14.0" date="2014-09-13" status="review"/>
     <link type="guide" xref="index#faq"/>
 
     <credit type="author copyright">
@@ -64,7 +65,7 @@
 </section>
 <section>
 
-<title>Spice</title>
+<title>SPICE</title>
 
   <p><app>SPICE</app>, the Simple Protocol for Independent Computing
    Environments, is a system for accessing and controlling remote desktops
diff --git a/help/C/system-requirements.page b/help/C/system-requirements.page
index 5476e6c..37eec10 100644
--- a/help/C/system-requirements.page
+++ b/help/C/system-requirements.page
@@ -3,7 +3,8 @@
       id="system-requirements">
 
   <info>
-    <revision pkgversion="3.8.0" version="0.1" date="2013-03-25" status="candidate"/>
+    <revision pkgversion="3.8.0" date="2013-03-25" status="candidate"/>
+    <revision pkgversion="3.14" date="2014-09-13" status="review"/>
     <link type="guide" xref="index#start" group="#first" />
 
     <credit type="author copyright">
@@ -27,7 +28,7 @@
       <years>2013</years>
     </credit>
 
-    <desc>Hardware requirements for running a virtual machine using <app>Boxes</app>.</desc>
+    <desc>Hardware required to run a <app>Boxes</app> virtual machine.</desc>
   </info>
 
   <title>Get started with virtual machines</title>
@@ -56,7 +57,8 @@
 
   <note style="advanced">
     <p><app>Boxes</app> performs best if your computer processor supports
-    <em>hardware virtualisation extensions</em> and if these are <link 
href="http://docs.fedoraproject.org/en-US/Fedora/13/html/Virtualization_Guide/sect-Virtualization-Troubleshooting-Enabling_Intel_VT_and_AMD_V_virtualization_hardware_extensions_in_BIOS.html";>enabled
 in the system BIOS</link>.</p>
+    hardware <link xref="virtualization">virtualization extensions</link> and
+    whether these are enabled in the system BIOS.</p>
   </note>
 
 </page>
diff --git a/help/C/virtualization.page b/help/C/virtualization.page
new file mode 100644
index 0000000..6fae0bb
--- /dev/null
+++ b/help/C/virtualization.page
@@ -0,0 +1,27 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="virtualization">
+  <info>
+    <revision pkgversion="3.14" date="2014-09-13" status="review"/>
+    <link type="guide" xref="index#advanced"/>
+
+    <credit type="author copyright">
+      <name>Michael Hill</name>
+      <email>mdhillca gmail com</email>
+      <years>2014</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <desc>Check the resources available to <app>Boxes</app>.</desc>
+  </info>
+
+  <title>Using processor hardware virtualization</title>
+
+  <p>To determine whether your computer supports processor virtualization
+  hardware extensions, and that they have been enabled in the system BIOS, run
+  the following in a terminal window:</p>
+  <p><cmd>gnome-shell --checks</cmd></p>
+  <p>If necessary, switch on the extensions <link 
href="http://docs.fedoraproject.org/en-US/Fedora/18/html/Virtualization_Administration_Guide/sect-Virtualization-Troubleshooting-Enabling_Intel_VT_and_AMD_V_virtualization_hardware_extensions_in_BIOS.html";>in
 the BIOS setup</link></p>
+
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index c79d4ce..41edbb7 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -5,16 +5,21 @@ HELP_ID = gnome-boxes
 HELP_MEDIA = figures/boxes_icon.png
 
 HELP_FILES = index.page                        \
+       clipboard.page                  \
        connect.page                    \
        continuous.page                 \
        create.page                     \
+       delete.page                     \
+       disk-images.page                \
        interface.page                  \
        legal.xml                       \
        search.page                     \
        shortcuts.page                  \
+       shutdown.page                   \
        supported-protocols.page        \
        system-requirements.page        \
        usb-redirection.page            \
+       virtualization.page             \
        what-is-a-virtual-machine.page  \
        why-do-i-need-virtual-machine.page
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]