.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "DUPLY 1" .TH DUPLY 1 "2020-12-30" "Version 2.3" "duply documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" duply \- a shell frontend to duplicity for simplified backups .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBduply\fR \fIprofile\fR \fBcreate\fR .PP \&\fBduply\fR \fIprofile command [options ...]\fR .PP \&\fBduply\fR \fIprofile command[_command_...] [options ...]\fR .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBDuply\fR deals as a wrapper for the mighty duplicity magic. It simplifies running duplicity with cron or on command line by: .PP .Vb 5 \& \- keeping recurring settings in profiles per backup job \& \- enabling batch operations eg. backup_verify+purge \& \- executing pre/post scripts (different actions possible \& depending on previous or next command or it\*(Aqs exit status) \& \- precondition checking for flawless duplicity operation .Ve .PP For each backup job one configuration profile must be created. The profile folder will be stored under \fI~/.duply/«profile»\fR (where '~' is the current users home directory). .PP \&\fIHint\fR: If the folder \fI/etc/duply\fR exists, the profiles for the superuser root will be searched and created there. .SH "USAGE" .IX Header "USAGE" First time usage (profile creation): .PP .Vb 1 \& duply create .Ve .PP General usage in single mode (see \s-1EXAMPLES\s0): .PP .Vb 1 \& duply [ ...] .Ve .PP General usage in batch mode joining commands with '_' (see \s-1EXAMPLES\s0): .PP .Vb 1 \& duply [[_|+|\-][_|+|\-]...] [ ...] .Ve .PP For batches the conditional separators can also be written as pseudo commands and(+), or(\-). See \s-1SEPARATORS\s0 for details. .PP Non \fBduply\fR options are passed on to duplicity (see \s-1OPTIONS\s0). All config parameters can also be defined in the environment instead. .SH "SEPARATORS" .IX Header "SEPARATORS" .IP "\fB_ (underscore)\fR" 4 .IX Item "_ (underscore)" neutral separator .IP "\fB+ (plus sign), _and_\fR" 4 .IX Item "+ (plus sign), _and_" conditional \s-1AND\s0; the next command will only be executed if the previous succeeded .IP "\fB\- (minus sign), _or_\fR" 4 .IX Item "- (minus sign), _or_" conditional \s-1OR\s0; the next command will only be executed if the previous failed .PP Example: 'pre+bkp\-verify_post' translates to 'pre_and_bkp_or_verify_post' .SH "PROFILE" .IX Header "PROFILE" .SS "location for profiles" .IX Subsection "location for profiles" Indicated by a path or a profile name i.e. \fImyprofile\fR, which is resolved to \fI~/.duply/myprofile\fR ('~' expands to environment variable \f(CW$HOME\fR). .PP Superuser root can place profiles under \fI/etc/duply\fR. Simply create the folder manually before running duply as superuser. .PP \&\s-1ATTENTION:\s0 Already existing profiles in root's home folder will cease to work unless they are moved to the new location manually. .SS "using profiles" .IX Subsection "using profiles" Usually only the profile name (here: 'humbug') will be used: .PP .Vb 1 \& duply humbug backup .Ve .PP Alternatively a \fIpath\fR might be used. This might be useful for quick testing, restoring or exotic locations. Shell expansion should work as usual: .PP .Vb 1 \& duply ~/.duplytest/humbug backup .Ve .PP \&\s-1ATTENTION:\s0 The path must contain at least one '/', e.g \fI./test\fR instead of only \fItest\fR. .SH "COMMANDS" .IX Header "COMMANDS" .IP "\fBusage\fR" 8 .IX Item "usage" Get usage help text. .IP "\fBand/or\fR" 8 .IX Item "and/or" Pseudo commands for better batch cmd readability (see \s-1SEPARATORS\s0). .IP "\fBcreate\fR" 8 .IX Item "create" Creates a configuration profile. .IP "\fBbackup\fR" 8 .IX Item "backup" Backup with pre/post script execution (as batch the same as: pre_bkp_post) .RS 8 .IP "\(bu" 2 as \fIfull\fR backup if parameter full_if_older matches or no earlier backup is found. .IP "\(bu" 2 as \fIincremental\fR backup in all other cases. .RE .RS 8 .RE .IP "\fBbkp\fR" 8 .IX Item "bkp" As above but without executing pre/post scripts. .IP "\fBfull\fR" 8 .IX Item "full" Force full backup. .IP "\fBincr\fR" 8 .IX Item "incr" Force incremental backup. .IP "\fBpre\fR" 8 .IX Item "pre" Execute only script '/pre' (for debugging purposes). .IP "\fBpost\fR" 8 .IX Item "post" Execute only script '/post' (for debugging purposes). .IP "\fBlist\fR \fI[«age»]\fR" 8 .IX Item "list [«age»]" List all files in backup (as it was at \fIage\fR, default: now). .IP "\fBstatus\fR" 8 .IX Item "status" Print backup sets and chains currently in repository. .IP "\fBverify\fR \fI[«age»]\fR \fI[\-\-compare\-data]\fR" 8 .IX Item "verify [«age»] [--compare-data]" List files changed, since \fIage\fR if given. .IP "\fBverifyPath\fR \fI[«rel_path_in_bkp»]\fR \fI[«local_path»]\fR \fI[«age»]\fR \fI[\-\-compare\-data]\fR" 8 .IX Item "verifyPath [«rel_path_in_bkp»] [«local_path»] [«age»] [--compare-data]" List changes of a file or folder path in backup compared to a local path, since \fIage\fR if given. .IP "\fBrestore\fR \fI«target_path»\fR \fI[«age»]\fR" 8 .IX Item "restore «target_path» [«age»]" Restore the complete backup to \fItarget_path\fR (as it was at \fIage\fR). .IP "\fBfetch\fR \fIsrc_path target_path\fR \fI[«age»]\fR" 8 .IX Item "fetch src_path target_path [«age»]" Fetch single file/folder from backup (as it was at \fIage\fR). .IP "\fBpurge\fR \fI[«max_age»]\fR \fI[\-\-force]\fR" 8 .IX Item "purge [«max_age»] [--force]" List outdated backup archives (older than \fImax_age\fR). Use option \fI\-\-force\fR to actually delete these files. .IP "\fBpurgeFull\fR \fI[«max_full_backups»]\fR \fI[\-\-force]\fR" 8 .IX Item "purgeFull [«max_full_backups»] [--force]" List outdated backup files. \fImax_full_backups\fR being the number of full backups and associated incrementals to keep, counting in reverse chronological order. Use option \fI\-\-force\fR to actually delete these files. .IP "\fBpurgeIncr\fR \fI[«max_fulls_with_incrs»]\fR \fI[\-\-force]\fR" 8 .IX Item "purgeIncr [«max_fulls_with_incrs»] [--force]" List outdated incremental backup files. \fImax_fulls_with_incrs\fR being the number of full backups which associated incrementals will be kept, counting in reverse chronological order. Use option \fI\-\-force\fR to actually delete these files. .IP "\fBpurgeAuto\fR \fI[\-\-force]\fR" 8 .IX Item "purgeAuto [--force]" Convenience batch wrapper for all purge commands above. purge, purgeFull, purgeIncr are added if their conf vars were set. E.g. .Sp .Vb 3 \& MAX_AGE=1Y \& MAX_FULL_BACKUPS=6 \& MAX_FULLS_WITH_INCR=3 .Ve .Sp in profile conf file would result in [purge_purgeFull_purgeIncr]. .IP "\fBcleanup\fR \fI[\-\-force]\fR" 8 .IX Item "cleanup [--force]" List broken backup chain files archives (e.g. after unfinished run). Use option \fI\-\-force\fR to actually delete these files. .IP "\fBchangelog\fR" 8 .IX Item "changelog" Print the last changes of duply. .IP "\fBversion\fR" 8 .IX Item "version" Show version information of \fBduply\fR and needed programs. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-\-force\fR" 4 .IX Item "--force" Passed to duplicity (see commands: purge, purge-full, purge-incr, cleanup). .IP "\fB\-\-preview\fR" 4 .IX Item "--preview" Do nothing but print out generated duplicity command lines. .IP "\fB\-\-disable\-encryption\fR" 4 .IX Item "--disable-encryption" Disable encryption, override profile settings. .SH "TIME FORMATS" .IX Header "TIME FORMATS" For all time related parameters like age, max_age etc. refer to the duplicity manpage for all available formats. Here some examples: .PP .Vb 4 \& · 2002\-01\-25T07:00:00+02:00 (full date time format string) \& · 2002/3/5 (date string YYYY/MM/DD) \& · 12D (interval, 12 days ago) \& · 1h78m (interval, 1 hour 78 minutes ago) .Ve .SH "PRE/POST SCRIPTS" .IX Header "PRE/POST SCRIPTS" Some useful internal duply variables are exported to the scripts: .PP .Vb 4 \& PROFILE, CONFDIR, SOURCE, TARGET_URL_, \& GPG_, CMD_ERR, RUN_START, \& CMD_ (previous/next command), \& CND_ (condition before/after) .Ve .PP The CMD_* variables were introduced to allow different actions according to the command the scripts were attached to e.g. 'pre_bkp_post_pre_verify_post' will call the pre script two times, with \s-1CMD_NEXT\s0 variable set to 'bkp' on the first and to 'verify' on the second run. \&\s-1CMD_ERR\s0 holds the exit code of the \s-1CMD_PREV.\s0 .SH "EXAMPLES" .IX Header "EXAMPLES" Create profile 'humbug': .PP .Vb 1 \& duply humbug create .Ve .PP and then edit the resulting \fIconf\fR file of this profile. .PP Backup 'humbug' now: .PP .Vb 1 \& duply humbug backup .Ve .PP List available backup sets of profile 'humbug': .PP .Vb 1 \& duply humbug status .Ve .PP List and delete outdated backups of 'humbug': .PP .Vb 1 \& duply humbug purge \-\-force .Ve .PP Restore latest backup of 'humbug' to /mnt/restore: .PP .Vb 1 \& duply humbug restore /mnt/restore .Ve .PP Restore /etc/passwd of 'humbug' from 4 days ago to /root/pw: .PP .Vb 1 \& duply humbug fetch etc/passwd /root/pw 4D .Ve .PP See \fIman duplicity\fR, section \s-1TIME FORMATS\s0 for the time format. .PP A one line \fIbatch job\fR on 'humbug' for cron execution: .PP .Vb 1 \& duply humbug backup_verify_purge \-\-force .Ve .PP Batch job to run a full backup with pre/post scripts: .PP .Vb 1 \& duply humbug pre_full_post .Ve .SH "FILES" .IX Header "FILES" Files in profile folder '~/.duply/' or '/etc/duply': .PP .Vb 5 \& conf .......... profile configuration file \& pre ........... pre script (see above for details) \& post .......... post script (see above for details) \& gpgkey.*.asc .. exported GnuPG key files \& exclude ....... a globbing list of included or excluded files/folders .Ve .PP The rules for the \fIexclude\fR file can be found in \fIman duplicity\fR, section \s-1FILE SELECTION\s0). .SH "IMPORTANT" .IX Header "IMPORTANT" Copy the \fIwhole\fR profile folder after the first backup to a safe place. It contains everything needed to restore your backups. You will need it if you have to restore the backup from another system (e.g. after a system crash). Keep access to these files restricted as they contain \&\fIall\fR information (gpg data, ftp data) to access and modify your backups. .PP Repeat this step after \fIall\fR configuration changes. Some configuration options are crucial for restoration. .SH "BUGS" .IX Header "BUGS" This program is still in development. If you find bugs write a bug report on: http://duply.net/. .SH "AVAILABILITY" .IX Header "AVAILABILITY" For newer versions see http://sourceforge.net/projects/ftplicity/. .SH "COPYRIGHT and LICENSE" .IX Header "COPYRIGHT and LICENSE" Copyright (C) 2006 Christiane Ruetten, 2008\-2017 Edgar Soldin .PP This package is free software; you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. .PP On Debian systems, the complete text of the \s-1GNU\s0 General Public License version 2 can be found in the file `/usr/share/common\-licenses/GPL\-2'. .SH "AUTHOR" .IX Header "AUTHOR" Duply was written by Christiane Ruetten (initial version, named ftplicity) and Edgar Soldin. .PP This manual page was written by Joachim Wiedorn for the Debian project (and may be used by others). .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBduplicity\fR\|(1)