<page xmlns="http://projectmallard.org/1.0/"
      xmlns:its="http://www.w3.org/2005/11/its"
      type="topic" style="task"
      id="interface">
  <info>
    <revision pkgversion="3.8.0" date="2013-03-23" status="candidate"/>
    <revision pkgversion="3.14" date="2014-09-13" status="review"/>
    <revision pkgversion="3.24.0" date="2017-05-02" status="review"/>
    <revision pkgversion="3.27.4" date="2018-01-12" status="review"/>
    <link type="guide" xref="index#use" group="#first" />

    <credit type="author copyright">
      <name>Michael Hill</name>
      <email>mdhillca@gmail.com</email>
      <years>2013</years>
    </credit>
    <credit type="editor">
      <name>Felipe Borges</name>
      <email>felipeborges@gnome.org</email>
      <years>2018</years>
    </credit>

    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>

    <desc>Get around the application.</desc>
  </info>

  <title>The Boxes interface</title>

  <section id="collection">
  <title>Collection view</title>

  <p>When you first launch <app>Boxes</app>, the greeting tells you to click the
  <gui style="button">New</gui> button to create your first box. On subsequent
  visits, <app>Boxes</app> opens in the <em>collection view</em>, displaying
  thumbnails of your boxes in a grid. Favourites or frequently-used boxes
  appear at the top of the list. Collection view allows you to:</p>

  <list>
    <item><p>Click <gui style="button">New</gui> to
    <link xref="create">create</link> a box.</p></item>
    <item><p>Click a box to launch a virtual machine session.</p></item>
    <item><p><link xref="search">Search</link> for a box.</p></item>
    <item><p>Click the checkmark button in the header bar to enter selection
    mode.</p></item>
    <item><p>Right click on a box to choose <gui>Open in New Window</gui>,
    <gui>Add to Favorites</gui>, <gui>Force Shutdown</gui>,
    <gui>Clone</gui>, <gui>Delete</gui>, or to open the <gui>Properties</gui>
    view for the box.</p></item>
  </list>

  </section>

  <section id="wizard">
  <title>The wizard</title>

  <p>Clicking <gui style="button">New</gui> launches the <em>wizard</em>, which guides
  you through the process of box creation.</p>

  </section>

  <section id="selection">
  <title>Selection mode</title>

  <p>In collection view, clicking the checkmark button or right-clicking a
  thumbnail puts you in <em>selection mode</em>, where various operations can be
  performed on boxes, individually or in groups. You can:</p>

  <list>
    <item><p><link xref="delete">Delete</link> a box or boxes.</p></item>
    <item><p>Mark a box or boxes as favorites.</p></item>
    <item><p>Pause a box.</p></item>
    <item><p>Open a box in a new window.</p></item>
  </list>

  </section>

  <section id="properties">
  <title>Properties view</title>

  <p>Right clicking a box and selecting <gui style="button">Properties</gui>
  in the collection view opens the <em>properties view</em>, where some of the
  details of a box can be configured. The properties view allows you to display
  or change settings depending on which of the following tabs is selected:</p>

  <list>
    <item><p><gui>General</gui>: displays the box <gui>Name</gui> and
    <gui>Broker</gui> or virtualizer being used (such as <em>QEMU</em>). For a
    remote box, this tab also displays the <gui>Protocol</gui> (such as
    <em>VNC</em>), and the <gui>URL</gui> to be used for remote access. When
    the box is running, the <gui>Share Clipboard</gui> switch appears
    here.</p></item>
    <item><p><gui>System</gui> settings: shows running graphs of CPU, disk I/O
    and network activity. <gui>Memory</gui> and <gui>Maximum Disk Size</gui>
    sliders can be adjusted, and the <gui>Troubleshooting Log</gui> can be
    viewed. The <gui style="button">Force Shutdown</gui> button, which enables
    you to <link xref="shutdown">force a box to shut down</link>, the
    <gui style="button">Restart</gui> button, and the
    <gui>Run in background</gui> switch are on this tab.</p></item>
    <item><p><gui>Devices &amp; Shares</gui>: the <gui style="button">Select</gui> button
    allows you to specify the path to a CD/DVD device or ISO. The
    <gui style="button">Remove</gui> button disconnects it. When the box is
    running, the USB devices connected to the host system are listed, and each
    can be controlled with an <gui>ON | OFF</gui> switch.
    <link xref="shared-folders">Shared Folders</link> between host and guest
    can be set for running machines which support spice-webdavd.</p></item>
    <item><p><gui>Snapshots</gui>: allows you to
    <link xref="snapshot-create">create</link> and manage snapshots of the
    box.</p></item>
  </list>

  <p>The properties view can also be accessed using the wizard's
  <gui style="button">Customize</gui> button during local box setup. If the box
  is running, click the menu (<media its:translate="no" type="image" src="figures/open-menu-symbolic.svg"><span its:translate="yes">settings</span></media>)
  button in the header bar and select <gui>Properties</gui>.</p>

  </section>

</page>
