NAME
chroniton.pl - Interface to the Chroniton backup system
VERSION
This document refers to chroniton.pl version 0.01_2.
CONFIGURATION
Chroniton is configured via a config file (config.yml) stored in a "Chroniton" directory (in your application data directory, as determined by File::HomeDir
.
Options are (as of version 0.01_2):
- backup_locations
-
A list of directories to backup.
- storage_directory
-
Where your backups (and Chroniton state information) is stored. Must be a directory, not a link to one.
OPTIONS
- -q
-
quiet, suppress all messages
- -v
-
verbose, print all messages
- --mode <mode>
-
Specify mode of operation: (full | incremental | archive | auto | config)
- full
-
Performs a full backup, ignoring any option in the configuration file that would cause Chroniton to perform an incremental backup or archive.
- incremental
-
If a full backup exists, creates an incremental backup against the latest full backup. Exits with an error if there is no full backup to increment against.
- archive
-
Archives all full and incrmental backups in the backup storage directory. Exits with an error if there are no backups to archive.
- auto
-
The default action. Reads the configuration file, determines a sequence of full, incremental, or archive operations to execute, and performs these operations.
- restore
-
Restores the file (or directory) specified by the
--file
option. If the file already exists, exits with an error. If--force
is specified, restore will replace pre-existing file. (force is DANGEROUS: entire directory trees may be irrevocably wiped out, RECURSIVELY! Please refer to "COPYRIGHT" before--force
-ing a restore.)
- --file <file>
-
Specifies the file to act upon. (i.e. for restore).
- --config
-
Opens the configuration file in $EDITOR for editing. Other options are ignored.
- --log [<file>]
-
Prints out the most recent log, or the file specified by <file>.
- --force
-
Force chroniton to do something that it shouldn't. DANGEROUS.
- --version
- --usage
- --help
- --man
AUTHOR
Jonathan Rockway jrockway AT cpan.org
BUGS
Report to RT.
COPYRIGHT
Chroniton is Copyright (c) 2006 Jonathan Rockway.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.