.. gui information

########################
Graphical User Interface
########################

Provides a simple user interface in order to produce clones. Each field provided by
the GUI has a "What's This?" link which opens a dialog explaining the field.

By default WereSync outputs all log files to ``/var/log/weresync``. If any errors or problems occur, please be sure to include the output of the most recent file in your report.

To start the gui run the command::

    $ weresync-gui

.. IMPORTANT::
   Be sure to start the weresync daemon first, using::

       $ sudo weresync-daemon > /dev/null 2>&1 &

   This requires root permissions

.. image:: img/gui-example.png
   :align: left

LVM
===

WereSync supports cloning logical volume groups as well. Simply check the
"Copy Logical Volume Groups" option and select your source group from the
dropdown.

If the target group name is left as "Default" then WereSync will simply use
the name of the source group with "-copy" appended to it. WereSync will create
the target volume group if it does not already exist.

Bootloader Installation
=======================

WereSync will attempt to install a bootloader onto your drive, based on your
choice in the "Bootloader Plugin" entry. If you are unsure which to pick,
use the default "UUID Copy" plugin. WereSync cannot properly install all
bootloaders. You may have to manually adjust some settings after the clone
finishes.

If you have your /boot directory on another partition, be sure to pass that partition number to the "Boot Partition" field under advanced options.


Dependencies
============

The WereSync GUI runs using GTK and requires the `PyGObject <http://www.pygtk.org/>`_ bindings to be installed. On Ubuntu these can be installed with::

    $ sudo apt install python3-gi

API Reference
=============

The GUI can be started from the ``gui`` module with the method ``start_gui()``::

    >>> import weresync.gui
    >>> weresync.gui.start_gui()
