Documentation

Running pyBitcoinBackup

There are two ways to run application.
1. pyBitcoinBackupUI.pyw - Graphical interface
2. pybitcoinbackup.py - Command line interface

Both of these interfaces are explained further below.

Backups

Note: In order to perform a backup your wallet must be specified. The address book is optional.

Backup Modes

Currently there are only two backup modes: local, and email.

local backup copies an archive of your wallet (and address book if specified)

email sends an email of the backup archive to an address that you specify.

IMPORTANT: Email has ONLY been tested with gmail.

Graphical Interface

The graphical interface is fairly straight forward.

(... but more documentation will be added soon ...)

Command line Interface

The command line interface has two modes. "cli" mode and "backup" mode.

"cli" mode allows you to interactively update your configuration and perform a backup.

"backup" mode reads your configuration file and performs a backup (good for cronjobs).

"backup" mode will also accept a password if none is specified in your config file

Command line usage

Usage: pybitcoinbackup.py {command} {password}
* All commands apply to windows builds as well as the python distribution

Commands
--------
cli       Specify the command-line interface
backup    Specify the backup interface

Password
--------
 - Only used with the backup command
 - Not necessary if your password is specified in your configuration file

Notes:
 - If no command is specified 'cli' will be initiated by default
 - You will be prompted to enter a password when you run a back up with email
   but no password is specified in your config file

Examples
--------
*In these examples we will use .py, however .exe can be substituted

Run pyBitcoinBackup in cli mode:
> pybitcoinbackup.py         OR           > pybitcoinbackup.py cli

Run pyBitcoinBackup in backup mode and specify a password:
> pybitcoinbackup.py backup MyAw350m3p4ss

Run pyBitcoinBackup in backup mode and get prompted for password:
> pybitcoinbackup.py backup
Enter your email password:
Archiving file(s)
...