# WereSync

Making your backup drives into were-drives, transforming them into clones at will.

WereSync incrementally backups up hard drives using rsync. Backups can be run while you use your computer. As icing on the cake, you can boot your clone just like your normal computer.

## Installation

WereSync can easily be installed with pip. Simply use:

    $ pip install weresync

For more in depth information see the installation guide.

## Basic Usage

Important

WereSync requires root permissions to run, because it has to access block devices. Standard linux permissions restrict access to block devices to ordinary users.

First start the daemon with:

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

To start the gui use:

    $ weresync-gui

For help on how the terminal command works, run:

    $ weresync -h

For a basic setup, you could use a version of the following command:

    $ weresync -C --efi-partition <partition_number> /dev/sda /dev/sdb

# Contents:

- Installation
  - Dependencies
  - WereSync Installation
- Graphical User Interface
  - LVM
  - Bootloader Installation
  - Dependencies
  - API Reference
- Command Line Interface
  - Basic Usage
  - In-Depth Parameter Definitions
- API Documentation
  - weresync.interface modules
  - weresync.daemon modules
  - weresync.exception
  - weresync.plugins
- Bootloader Plugins
  - Installing
  - Creating Bootloader Plugins
  - Builtin Bootloaders
- Translating WereSync
- Known Issues

# Contributing

First, take a look at our contribution guidelines.

Then, if you would like to submit a new feature or fix a bug, please submit a Pull Request at the project repository. You can submit a bug report on the issue tracker.

# Indices and tables

- Index

- Module Index

- Search Page