{
    "mode": "man",
    "parameter": "DUPLICITY",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/man/DUPLICITY/json",
    "generated": "2026-10-22T12:55:57Z",
    "synopsis": "For detailed descriptions for each action see chapter ACTIONS.\nduplicity [backup|full|incremental] [options] sourcedirectory targeturl\nduplicity verify [options] [--compare-data] [--path-to-restore <relpath>] [--time time]\nsourceurl targetdirectory\nduplicity collection-status [options] [--file-changed <relpath>] [--show-changes-in-set\n<index>] [--jsonstat]] targeturl\nduplicity list-current-files [options] [--time time] targeturl\nduplicity [restore] [options] [--path-to-restore <relpath>] [--time time] sourceurl\ntargetdirectory\nduplicity remove-older-than <time> [options] [--force] targeturl\nduplicity remove-all-but-n-full <count> [options] [--force] targeturl\nduplicity remove-all-inc-of-but-n-full <count> [options] [--force] targeturl\nduplicity cleanup [options] [--force] targeturl",
    "sections": {
        "NAME": {
            "content": "duplicity - Encrypted incremental backup to local or remote storage.\n\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "For detailed descriptions for each action see chapter ACTIONS.\n\nduplicity [backup|full|incremental] [options] sourcedirectory targeturl\n\nduplicity verify [options] [--compare-data] [--path-to-restore <relpath>] [--time time]\nsourceurl targetdirectory\n\nduplicity collection-status [options] [--file-changed <relpath>] [--show-changes-in-set\n<index>] [--jsonstat]] targeturl\n\nduplicity list-current-files [options] [--time time] targeturl\n\nduplicity [restore] [options] [--path-to-restore <relpath>] [--time time] sourceurl\ntargetdirectory\n\nduplicity remove-older-than <time> [options] [--force] targeturl\n\nduplicity remove-all-but-n-full <count> [options] [--force] targeturl\n\nduplicity remove-all-inc-of-but-n-full <count> [options] [--force] targeturl\n\nduplicity cleanup [options] [--force] targeturl\n\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "Duplicity incrementally backs up files and folders into tar-format volumes encrypted with\nGnuPG and places them to a remote (or local) storage backend.  See chapter URL FORMAT for a\nlist of all supported backends and how to address them.  Because duplicity uses librsync,\nincremental backups are space efficient and only record the parts of files that have changed\nsince the last backup.  Currently duplicity supports deleted files, full Unix permissions,\nuid/gid, directories, symbolic links, fifos, etc., but not hard links.\n\nIf you are backing up the root directory /, remember to --exclude /proc, or else duplicity\nwill probably crash on the weird stuff in there.\n\n",
            "subsections": []
        },
        "EXAMPLES": {
            "content": "Here is an example of a backup, using sftp to back up /home/me to somedir on the other.host\nmachine:\n\nduplicity /home/me sftp://uid@other.host/somedir\n\nIf the above is run repeatedly, the first will be a full backup, and subsequent ones will be\nincremental. To force a full backup, use the full action:\n\nduplicity full /home/me sftp://uid@other.host/somedir\n\nor enforcing a full every other time via --full-if-older-than <time> , e.g. a full every\nmonth:\n\nduplicity --full-if-older-than 1M /home/me sftp://uid@other.host/somedir\n\nNow suppose we accidentally delete /home/me and want to restore it the way it was at the time\nof last backup:\n\nduplicity sftp://uid@other.host/somedir /home/me\n\nDuplicity enters restore mode because the URL comes before the local directory.  If we wanted\nto restore just the file \"Mail/article\" in /home/me as it was three days ago into\n/home/me/restoredfile:\n\nduplicity -t 3D --path-to-restore Mail/article sftp://uid@other.host/somedir\n/home/me/restoredfile\n\nThe following action compares the latest backup with the current files:\n\nduplicity verify sftp://uid@other.host/somedir /home/me\n\nFinally, duplicity recognizes several include/exclude options.  For instance, the following\nwill backup the root directory, but exclude /mnt, /tmp, and /proc:\n\nduplicity --exclude /mnt --exclude /tmp --exclude /proc / file:///usr/local/backup\n\nNote that in this case the destination is the local directory /usr/local/backup.  The\nfollowing will backup only the /home and /etc directories under root:\n\nduplicity --include /home --include /etc --exclude '' / file:///usr/local/backup\n\nDuplicity can also access a repository via ftp.  If a user name is given, the environment\nvariable FTPPASSWORD is read to determine the password:\n\nFTPPASSWORD=mypassword duplicity /local/dir ftp://user@other.host/somedir\n\n",
            "subsections": []
        },
        "ACTIONS": {
            "content": "Duplicity uses actions, which can be given in long or in short form and finetuned with\noptions.\nThe actions 'backup' or 'restore' can be implied from the order local path and remote url are\ngiven. Other actions need to be given explicitly.  For the rare case that the local path may\nbe a valid duplicity action name you may append a '/' to the local path name so it can no\nlonger be mistaken for an action.\n\n\nNOTE: The following explanations explain some but not all options that can be used in\nconnection with that action.  Consult the OPTIONS section for more detailed descriptions.\n\n\nbackup, bu <folder> <url>\nPerform  a  backup.  Duplicity  automatically  performs  an  incremental backup if old\nsignatures can be found. Else a new backup chain is started.\n\n\nfull, fb <folder> <url>\nPerform a full backup. A new backup chain is started even if signatures are  available\nfor an incremental backup.\n\n\nincremental, ib <folder> <url>\nIf this is requested an incremental backup will be performed.  Duplicity will abort if\nno old signatures can be found.\n\n\nverify, vb [--compare-data] [--time <time>] [--path-to-restore <relpath>] <url> <localpath>\nVerify  tests  the  integrity  of  the  backup  archives  at  the  remote  location by\ndownloading each file and checking both that it can restore the archive and  that  the\nrestored  file  matches the signature of that file stored in the backup, i.e. compares\nthe archived file with its hash value from archival time.  Verify  does  not  actually\nrestore  and  will  not overwrite any local files. Duplicity will exit with a non-zero\nerror level if any files do not match the signature stored in  the  archive  for  that\nfile. On verbosity level 4 or higher, it will log a message for each file that differs\nfrom  the  stored signature. Files must be downloaded to the local machine in order to\ncompare them.  Verify does not compare the  backed-up  version  of  the  file  to  the\ncurrent local copy of the files unless the --compare-data option is used (see below).\nThe  --path-to-restore  option  restricts  verify  to that file or folder.  The --time\noption allows one to select a backup to verify.   The  --compare-data  option  enables\ndata comparison (see below).\n\n\ncollection-status, st [--file-changed <relpath>] [--show-changes-in-set <index>] <url>\nSummarize  the  status of the backup repository by printing the chains and sets found,\nand the number of volumes in each.\nThe --file-changed option summarizes the changes to  the  file  (in  the  most  recent\nbackup  chain).   The  --show-changes-in-set option summarizes all the file changes in\nthe index:th backup set (where index 0 means the latest  set,  1  means  the  next  to\nlatest,  etc.).   --jsonstat prints the changes in json format and statistics from the\njsonstat files if the backups were created with --jsonstat. If <index> is  set  to  -1\nstatistics for the whole backup chain printed\n\n\nlist-current-files, ls [--time <time>] <url>\nLists  the  files  contained  in  the  most  current  backup  or  backup at time.  The\ninformation will be extracted from the signature files, not the archive  data  itself.\nThus  the  whole  archive does not have to be downloaded, but on the other hand if the\narchive has been deleted or corrupted, this action will not detect it.\n\n\nrestore, rb [--path-to-restore <relpath>] [--time <time>] <url> <targetfolder>\nYou can restore the full monty or selected folders/files from a  specific  time.   Use\nthe  relative  path  as  it  is  printed by list-current-files.  Usually not needed as\nduplicity enters restore mode when it detects that the  URL  comes  before  the  local\nfolder.\n\n\nremove-older-than, ro <time> [--force] <url>\nDelete all backup sets older than the given time.  Old backup sets will not be deleted\nif  backup sets newer than time depend on them.  See the TIME FORMATS section for more\ninformation.  Note, this action cannot be combined with backup or other actions,  such\nas cleanup.  Note also that --force will be needed to delete the files instead of just\nlisting them.\n\n\nremove-all-but-n-full, ra <count> [--force] <url>\nDelete  all  backups  sets that are older than the count:th last full backup (in other\nwords, keep the last count full backups and associated incremental sets).  count  must\nbe  larger than zero. A value of 1 means that only the single most recent backup chain\nwill be kept.  Note that --force will be needed to delete the files  instead  of  just\nlisting them.\n\n\nremove-all-inc-of-but-n-full, ri <count> [--force] <url>\nDelete incremental sets of all backups sets that are older than the count:th last full\nbackup  (in  other words, keep only old full backups and not their increments).  count\nmust be larger than zero. A value of 1 means that only the single most  recent  backup\nchain  will  be  kept  intact.   Note  that --force will be needed to delete the files\ninstead of just listing them.\n\n\ncleanup, cl [--force] <url>\nDelete the extraneous duplicity files on the given backend.  Non-duplicity  files,  or\nfiles  in complete data sets will not be deleted.  This should only be necessary after\na duplicity session fails or is aborted prematurely.  Note that --force will be needed\nto delete the files instead of just listing them.\n\n",
            "subsections": []
        },
        "OPTIONS": {
            "content": "",
            "subsections": [
                {
                    "name": "--allow-source-mismatch",
                    "content": "Do not abort on attempts to use the same archive dir or  remote  backend  to  back  up\ndifferent directories. duplicity will tell you if you need this switch.\n\n\n--archive-dir path\nThe archive directory.\n\nNOTE:  This  option changed in 0.6.0.  The archive directory is now necessary in order\nto manage persistence for current and future enhancements.  As such,  this  option  is\nnow  used only to change the location of the archive directory.  The archive directory\nshould not be deleted,  or  duplicity  will  have  to  recreate  it  from  the  remote\nrepository (which may require decrypting the backup contents).\n\nWhen  backing  up or restoring, this option specifies that the local archive directory\nis to be created in path.  If the archive directory is not specified, the default will\nbe to create the archive directory in ~/.cache/duplicity/.\n\nThe archive directory can be shared between backups to  multiple  targets,  because  a\nsubdirectory of the archive dir is used for individual backups (see --name ).\n\nThe  combination  of  archive  directory  and  backup  name must be unique in order to\nseparate the data of different backups.\n\nThe interaction between the --archive-dir and  the  --name  options  allows  for  four\npossible combinations for the location of the archive dir:\n\n\n1.     neither specified (default)\n~/.cache/duplicity/hash-of-url\n\n2.     --archive-dir=/arch, no --name\n/arch/hash-of-url\n\n3.     no --archive-dir, --name=foo\n~/.cache/duplicity/foo\n\n4.     --archive-dir=/arch, --name=foo\n/arch/foo\n\n",
                    "long": "--allow-source-mismatch"
                },
                {
                    "name": "--asynchronous-upload",
                    "content": "(EXPERIMENTAL)  Perform file uploads asynchronously in the background, with respect to\nvolume creation. This means that duplicity can upload a  volume  while,  at  the  same\ntime,  preparing  the  next  volume  for  upload.  The intended end-result is a faster\nbackup, because the local CPU and your bandwidth can be  more  consistently  utilized.\nUse  of  this  option  implies additional need for disk space in the temporary storage\nlocation; rather than needing to store only one volume at a time, enough storage space\nis required to store two volumes.\n\n",
                    "long": "--asynchronous-upload"
                },
                {
                    "name": "--azure-blob-tier",
                    "content": "Standard storage tier used for backup files (Hot|Cool|Archive).\n\n",
                    "long": "--azure-blob-tier"
                },
                {
                    "name": "--azure-max-single-put-size",
                    "content": "Specify the number of the largest supported upload size where the Azure library  makes\nonly one put call. If the content size is known and below this value the Azure library\nwill  only  perform one put request to upload one block.  The number is expected to be\nin bytes.\n\n",
                    "long": "--azure-max-single-put-size"
                },
                {
                    "name": "--azure-max-block-size",
                    "content": "Specify the number for the block size used by the Azure library to upload blobs if  it\nis  split  into  multiple  blocks.   The  maximum  block  size the service supports is\n104857600 (100MiB) and the default is 4194304 (4MiB)\n\n",
                    "long": "--azure-max-block-size"
                },
                {
                    "name": "--azure-max-connections",
                    "content": "Specify the number of maximum connections to transfer one  blob  to  Azure  blob  size\nexceeds 64MB. The default values is 2.\n\n",
                    "long": "--azure-max-connections"
                },
                {
                    "name": "--b2-hide-files",
                    "content": "Causes  Duplicity  to hide files in B2 instead of deleting them. Useful in combination\nwith B2's lifecycle rules.\n\n\n--backend-retry-delay number\nSpecifies the number of seconds that duplicity  waits  after  an  error  has  occurred\nbefore attempting to repeat the operation.\n\n\n--cf-backend backend\nAllows   the   explicit   selection  of  a  cloudfiles  backend.  Defaults  to  pyrax.\nAlternatively you might choose cloudfiles.\n\n\n--config-dir path\nAllows selection of duplicity's configuratin dir.  Defaults to ~/.config/duplicity.\n\n\n--copy-blocksize kilos\nAllows selection of blocksize in kilobytes to use in  copying.   Increasing  this  may\nspeed copying of large files.  Defaults to 128.\n",
                    "long": "--b2-hide-files"
                },
                {
                    "name": "--no-check-remote",
                    "content": "Turn  off  validation  of  the remote manifest.  Checking is the default.  No checking\nwill allow you to backup without the private  key,  but  will  mean  that  the  remote\nmanifest  may exist and be corrupted, leading to the possibility that the backup might\nnot be recoverable.\n\n",
                    "long": "--no-check-remote"
                },
                {
                    "name": "--compare-data",
                    "content": "Enable data comparison of regular files on action verify. This conducts  a  verify  as\ndescribed  above  to  verify  the  integrity  of the backup archives, but additionally\ncompares restored files to those in targetdirectory.  Duplicity will not replace  any\nfiles  in  targetdirectory.  Duplicity  will  exit with a non-zero error level if the\nfiles do not correctly verify or if any files from the archive differ  from  those  in\ntargetdirectory.  On verbosity level 4 or higher, it will log a message for each file\nthat differs from its equivalent in targetdirectory.\n\n",
                    "long": "--compare-data"
                },
                {
                    "name": "--copy-links",
                    "content": "Resolve symlinks during backup.  Enabling this will resolve & back  up  the  symlink's\nfile/folder data instead of the symlink itself, potentially increasing the size of the\nbackup.\n\n",
                    "long": "--copy-links"
                },
                {
                    "name": "--dry-run",
                    "content": "Calculate what would be done, but do not perform any backend actions\n\n\n--encrypt-key key-id\nWhen  backing  up,  encrypt  to  the  given  public  key,  instead  of using symmetric\n(traditional) encryption.  Can be specified multiple times.  The key-id can  be  given\nin  any  of the formats supported by GnuPG; see gpg(1), section \"HOW TO SPECIFY A USER\nID\" for details.\n\n\n--encrypt-secret-keyring filename\nThis option can only be used with --encrypt-key, and changes the path  to  the  secret\nkeyring  for  the  encrypt  key  to  filename This keyring is not used when creating a\nbackup. If not specified, the default secret keyring is used which is usually  located\nat .gnupg/secring.gpg\n\n\n--encrypt-sign-key key-id\nConvenience parameter. Same as --encrypt-key key-id --sign-key key-id.\n\n\n--exclude shellpattern\nExclude  the  file or files matched by shellpattern.  If a directory is matched, then\nfiles under that directory will also be matched.  See the FILE SELECTION  section  for\nmore information.\n\n",
                    "long": "--dry-run"
                },
                {
                    "name": "--exclude-device-files",
                    "content": "Exclude  all  device files.  This can be useful for security/permissions reasons or if\nduplicity is not handling device files correctly.\n\n\n--exclude-filelist filename\nExcludes the files listed in filename, with each  line  of  the  filelist  interpreted\naccording  to  the  same  rules  as  --include  and --exclude.  See the FILE SELECTION\nsection for more information.\n\n\n--exclude-if-present filename\nExclude directories if filename is present. Allows the user to  specify  folders  that\nthey  do  not  wish to backup by adding a specified file (e.g. \".nobackup\") instead of\nmaintaining a comprehensive exclude/include list.\n\n\n--exclude-older-than time\nExclude any files whose modification date is earlier than the  specified  time.   This\ncan be used to produce a partial backup that contains only recently changed files. See\nthe TIME FORMATS section for more information.\n\n",
                    "long": "--exclude-device-files"
                },
                {
                    "name": "--exclude-other-filesystems",
                    "content": "Exclude files on file systems (identified by device number) other than the file system\nthe root of the source directory is on.\n\n\n--exclude-regexp regexp\nExclude  files  matching  the  given regexp.  Unlike the --exclude option, this option\ndoes not match files in a directory it matches.  See the FILE  SELECTION  section  for\nmore information.\n\n\n--files-from filename\nRead  a  list of files to backup from filename rather than searching the entire backup\nsource directory. Operation is otherwise normal, just on the specified subset  of  the\nbackup source directory.\n\nFiles  must be specified one per line and relative to the backup source directory. Any\nabsolute paths will raise an error.  All  characters  per  line  are  significant  and\ntreated  as  part  of  the  path, including leading and trailing whitespace. Lines are\nseparated by newlines or nulls, depending on whether the --null-separator  switch  was\ngiven.\n\nIt  is  not necessary to include the parent directory of listed files, their inclusion\nis implied. However, the content of any explicitly listed directories is not  implied.\nAll required files must be listed when this option is used.\n\n\n--file-prefix prefix\n--file-prefix-manifest prefix\n--file-prefix-archive prefix\n--file-prefix-signature prefix\nAdds  a  prefix  to  either all files or only manifest, archive, signature files.  The\nsame set of prefixes must be passed in on backup and restore.\nIf both global and type-specific prefixes are set, global prefix will go before  type-\nspecific prefixes.\n\nSee also A NOTE ON FILENAME PREFIXES\n\n--path-to-restore path\nThis  option may be given in restore mode, causing only path to be restored instead of\nthe entire contents of the backup archive.  path should be given relative to the  root\nof the directory backed up.\n",
                    "long": "--exclude-other-filesystems"
                },
                {
                    "name": "--filter-globbing",
                    "content": "",
                    "long": "--filter-globbing"
                },
                {
                    "name": "--filter-ignorecase",
                    "content": "",
                    "long": "--filter-ignorecase"
                },
                {
                    "name": "--filter-literal",
                    "content": "",
                    "long": "--filter-literal"
                },
                {
                    "name": "--filter-regexp",
                    "content": "",
                    "long": "--filter-regexp"
                },
                {
                    "name": "--filter-strictcase",
                    "content": "Change  the  interpretation  of patterns passed to the file selection condition option\narguments --exclude and --include (and  variations  thereof,  including  file  lists).\nThese  options  can  appear multiple times to switch between shell globbing (default),\nliteral strings, and  regular  expressions,  case  sensitive  (default)  or  not.  The\nspecified  interpretation applies for all subsequent selection conditions up until the\nnext --filter option.\n\nSee the FILE SELECTION section for more information.\n\n--full-if-older-than time\nPerform a full backup if an incremental backup  is  requested,  but  the  latest  full\nbackup  in  the collection is older than the given time.  See the TIME FORMATS section\nfor more information.\n",
                    "long": "--filter-strictcase"
                },
                {
                    "name": "--force",
                    "content": "Proceed even if data loss might result.  Duplicity will let the user  know  when  this\noption is required.\n",
                    "long": "--force"
                },
                {
                    "name": "--ftp-passive",
                    "content": "Use  passive  (PASV) data connections.  The default is to use passive, but to fallback\nto regular if the passive connection fails or times out.\n",
                    "long": "--ftp-passive"
                },
                {
                    "name": "--ftp-regular",
                    "content": "Use regular (PORT) data connections.\n\n--gio  Use the GIO backend and interpret any URLs as GIO would.\n\n--gpg-binary filepath\nAllows you to force duplicity to use filepath as gpg command line binary. Can  be  an\nabsolute  or  relative  file  path or a file name.  Default value is 'gpg'. The binary\nwill be localized via the PATH environment variable.\n\n--gpg-options options\nAllows you to pass options to gpg encryption.  The options list should be of the  form\n\"--opt1  --opt2=parm\"  where  the  string  is  quoted  and the only spaces allowed are\nbetween options.\n\n--hidden-encrypt-key key-id\nSame as --encrypt-key, but it hides user's key id from encrypted  file.  It  uses  the\ngpg's --hidden-recipient command to obfuscate the owner of the backup. On restore, gpg\nwill  automatically  try all available secret keys in order to decrypt the backup. See\ngpg(1) for more details.\n",
                    "long": "--ftp-regular"
                },
                {
                    "name": "--ignore-errors",
                    "content": "Try to ignore certain errors if they happen. This option is only intended to allow the\nrestoration of a backup in the face of certain problems that would otherwise cause the\nbackup to fail. It is not ever recommended to  use  this  option  unless  you  have  a\nsituation  where you are trying to restore from backup and it is failing because of an\nissue which you want duplicity to ignore. Even then,  depending  on  the  issue,  this\noption may not have an effect.\n\nPlease  note that while ignored errors will be logged, there will be no summary at the\nend of the operation to tell you what was ignored, if anything. If this  is  used  for\nemergency restoration of data, it is recommended that you run the backup in such a way\nthat   you  can  revisit  the  backup  log  (look  for  lines  containing  the  string\nIGNOREDERROR).\n\nIf you ever have to use this option for reasons that are not understood or  understood\nbut not your own responsibility, please contact duplicity maintainers. The need to use\nthis option under production circumstances would normally be considered a bug.\n\n--imap-full-address emailaddress\nThe  full  email  address  of  the user name when logging into an imap server.  If not\nsupplied just the user name part of the email address is used.\n\n--imap-mailbox option\nAllows you to specify a different mailbox.  The default is \"INBOX\".   Other  languages\nmay require a different mailbox than the default.\n",
                    "long": "--ignore-errors"
                },
                {
                    "name": "--idr-fakeroot",
                    "content": "idrived uses the concept of a \"fakeroot\" directory, defined via the --idr-fakeroot=...\nswitch.  This  can be an existing directory, or the directory is created at runtime on\nthe root of the (host) files system. (caveat: you have to have  write  access  to  the\nroot!). Directories created at runtime are auto-removed on exit!\nSo, in the above scheme, we could do:\nduplicity --idr-fakeroot=nicepath idrived://DUPLICITY\nour files end-up at\n<MYBUCKET>/DUPLICITY/nicepath\n",
                    "long": "--idr-fakeroot"
                },
                {
                    "name": "--idr-fakeroot",
                    "content": "idrived uses the concept of a \"fakeroot\" directory, defined via the --idr-fakeroot=...\nswitch.  This  can be an existing directory, or the directory is created at runtime on\nthe root of the (host) files system. (caveat: you have to have  write  access  to  the\nroot!). Directories created at runtime are auto-removed on exit!\nSo, in the above scheme, we could do:\nduplicity --idr-fakeroot=nicepath idrived://DUPLICITY\nour files end-up at\n<MYBUCKET>/DUPLICITY/nicepath\n\n--include shellpattern\nSimilar to --exclude but include matched files instead.  Unlike --exclude, this option\nwill  also  match  parent directories of matched files (although not necessarily their\ncontents).  See the FILE SELECTION section for more information.\n\n--include-filelist filename\nLike --exclude-filelist, but include the listed files instead.  See the FILE SELECTION\nsection for more information.\n\n--include-regexp regexp\nInclude files matching the regular expression regexp.  Only files  explicitly  matched\nby  regexp  will  be included by this option.  See the FILE SELECTION section for more\ninformation.\n",
                    "long": "--idr-fakeroot"
                },
                {
                    "name": "--jsonstat",
                    "content": "Record statistic data similar to the default stats printed at the end of a backup job,\naddtional it includes some meta data about the backup chain e.g. when the full  backup\nwas created and how many incremental backups were made before.  Output format is json.\nIt written to stdout at notice level (as classic stats) and the statistics are kept as\na  separte  file  next  to the manifest but with \"jsonstat\" as extension.  collection-\nstatus --show-changes-in-set <index> --jsonstat adds data collected in the backup  job\nand  switch  the  output  format  to json.  If <index> is set to -1 statistics for the\nwhole backup chain are printed.\n\n\n--log-fd number\nWrite  specially-formatted  versions  of  output  messages  to  the   specified   file\ndescriptor.  The format used is designed to be easily consumable by other programs.\n\n--log-file filename\nWrite  specially-formatted  versions  of  output  messages to the specified file.  The\nformat used is designed to be easily consumable by other programs.\n",
                    "long": "--jsonstat"
                },
                {
                    "name": "--log-timestamp",
                    "content": "Write the log with timestamp and log level before the message, similar to syslog.\n\n--max-blocksize number\ndetermines the number of the blocks examined for changes during the diff process.  For\nfiles < 1MB the blocksize is a constant of 512.  For files over 1MB the size is  given\nby:\nfileblocksize = int((filelen / (2000 * 512)) * 512)\nreturn   min(fileblocksize,   config.maxblocksize)   where  config.maxblocksize\ndefaults to 2048.\n\nIf you specify a larger maxblocksize, your difftar files will  be  larger,  but  your\nsigtar  files  will  be  smaller.  If you specify a smaller maxblocksize, the reverse\noccurs.  The --max-blocksize option should be in multiples of 512.\n",
                    "long": "--log-timestamp"
                },
                {
                    "name": "--mf-purge",
                    "content": "Option for mediafire to purge files on delete instead of sending to trash.\n\n--mp-segment-size megs\nSwift backend segment size in megabytes\n\n--name symbolicname\nSet the symbolic name of the backup being operated on. The intent is to use a separate\nname for each logically distinct backup. For example, someone may use  \"homedailys3\"\nfor the daily backup of a home directory to Amazon S3. The structure of the name is up\nto  the  user,  it  is only important that the names be distinct. The symbolic name is\ncurrently only used to affect the expansion of --archive-dir , but  may  be  used  for\nadditional  features  in  the  future. Users running more than one distinct backup are\nencouraged to use this option.\n\nIf not specified, the default value is a hash of the backend URL.\n",
                    "long": "--mf-purge"
                },
                {
                    "name": "--no-check-remote",
                    "content": "Turn off validation of the remote manifest.  Checking is  the  default.   No  checking\nwill  allow  you  to  backup  without  the  private key, but will mean that the remote\nmanifest may exist and be corrupted, leading to the possibility that the backup  might\nnot be recoverable.\n",
                    "long": "--no-check-remote"
                },
                {
                    "name": "--no-compression",
                    "content": "Do not use GZip to compress files on remote system.\n",
                    "long": "--no-compression"
                },
                {
                    "name": "--no-encryption",
                    "content": "Do not use GnuPG to encrypt files on remote system.\n",
                    "long": "--no-encryption"
                },
                {
                    "name": "--no-print-statistics",
                    "content": "By  default  duplicity  will  print  statistics  about  the  current  session  after a\nsuccessful backup.  This switch disables that behavior.\n",
                    "long": "--no-print-statistics"
                },
                {
                    "name": "--no-files-changed",
                    "content": "By default duplicity will collect file names and change action in  memory  (add,  del,\nchg)  during  backup.   This  can  be  quite  expensive in memory use, especially with\nmillions of small files.  This flag turns off that collection.  This  means  that  the\n--file-changed option for collection-status will return nothing.\n",
                    "long": "--no-files-changed"
                },
                {
                    "name": "--null-separator",
                    "content": "Use  nulls  (\\0)  instead  of  newlines  (\\n)  as line separators, which may help when\ndealing with filenames containing newlines.  This affects the expected format  of  the\nfiles  specified  by  the --{include|exclude}-filelist switches and the --{files-from}\noption, as well as the format of the directory statistics file.\n",
                    "long": "--null-separator"
                },
                {
                    "name": "--numeric-owner",
                    "content": "On restore always use the numeric uid/gid  from  the  archive  and  not  the  archived\nuser/group names, which is the default behaviour.  Recommended for restoring from live\ncds which might have the users with identical names but different uids/gids.\n",
                    "long": "--numeric-owner"
                },
                {
                    "name": "--no-restore-ownership",
                    "content": "Ignores  the  uid/gid  from the archive and keeps the current user's one.  Recommended\nfor restoring data to mounted filesystem which do not support Unix ownership  or  when\nroot privileges are not available.\n\n--num-retries number\nNumber of retries to make on errors before giving up.\n\n--par2-options options\nVerbatim options to pass to par2.\n\n--par2-redundancy percent\nAdjust the level of redundancy in percent for Par2 recovery files (default 10%).\n\n--par2-volumes number\nNumber of Par2 volumes to create (default 1).\n",
                    "long": "--no-restore-ownership"
                },
                {
                    "name": "--progress",
                    "content": "When  selected, duplicity will output the current upload progress and estimated upload\ntime. To annotate  changes,  it  will  perform  a  first  dry-run  before  a  full  or\nincremental, and then runs the real operation estimating the real upload progress.\n\n--progress-rate number\nSets  the  update  rate  at  which  duplicity will output the upload progress messages\n(requires --progress option). Default is to print the status each 3 seconds.\n\n--rename <original path> <new path>\nTreats the path orig in the backup as if it were the path new.  Can be passed multiple\ntimes. An example:\n\nduplicity restore --rename Documents/metal Music/metal  sftp://uid@other.host/somedir\n/home/me\n\n--rsync-options options\nAllows  you  to  pass options to the rsync backend.  The options list should be of the\nform \"opt1=parm1 opt2=parm2\" where the option string is quoted  and  the  only  spaces\nallowed are between options. The option string will be passed verbatim to rsync, after\nany internally generated option designating the remote port to use. Here is a possibly\nuseful example:\n\nduplicity            --rsync-options=\"--partial-dir=.rsync-partial\"           /home/me\nrsync://uid@other.host/somedir\n\n--s3-endpoint-url url\nSpecifies the endpoint URL of the S3 storage.\n",
                    "long": "--progress"
                },
                {
                    "name": "--s3-multipart-chunk-size",
                    "content": "Chunk size (in MB, default is 20MB) used for S3  multipart  uploads.  Adjust  this  to\nmaximize  bandwidth  usage.  For  example, a chunk size of 10MB and a volsize of 100MB\nwould result in 10 chunks per volume upload.\n\nNOTE: This value should optimally be an even multiple of your  --volsize  for  optimal\nperformance.\n\nSee also A NOTE ON AMAZON S3 below.\n",
                    "long": "--s3-multipart-chunk-size"
                },
                {
                    "name": "--s3-multipart-max-procs",
                    "content": "Maximum  number of concurrent uploads when performing a multipart upload.  The default\nis 4. You can adjust this number to maximizing bandwidth and CPU utilization.\n\nNOTE: Too many concurrent uploads may have diminishing returns.\n\nSee also A NOTE ON AMAZON S3 below.\n",
                    "long": "--s3-multipart-max-procs"
                },
                {
                    "name": "--s3-region-name",
                    "content": "Specifies the region of the S3 storage. Usually mandatory if the bucket is created  in\na specific region.\n",
                    "long": "--s3-region-name"
                },
                {
                    "name": "--s3-unencrypted-connection",
                    "content": "Disable  SSL  for  connections  to  S3.  This  may  be  much  faster,  at some cost to\nconfidentiality.\n\nWith this option set, anyone between your computer and S3 can observe the traffic  and\nwill  be  able to tell: that you are using Duplicity, the name of the bucket, your AWS\nAccess Key ID, the increment dates and the amount of data in each increment.\n\nThis option affects only  the  connection,  not  the  GPG  encryption  of  the  backup\nincrement files. Unless that is disabled, an observer will not be able to see the file\nnames or contents.\n\nSee also A NOTE ON AMAZON S3 below.\n",
                    "long": "--s3-unencrypted-connection"
                },
                {
                    "name": "--s3-use-deep-archive",
                    "content": "Store  volumes using Glacier Deep Archive S3 when uploading to Amazon S3. This storage\nclass has a lower cost of storage but a higher per-request cost along with  delays  of\nup  to  48  hours  from the time of retrieval request. This storage cost is calculated\nagainst a 180-day storage minimum. According to Amazon this storage is ideal for  data\narchiving and long-term backup offering 99.999999999% durability.  To restore a backup\nyou  will have to manually migrate all data stored on AWS Glacier Deep Archive back to\nStandard S3 and wait for AWS to complete the migration.\n\nNOTE: Duplicity will store  the  manifest.gpg  and  sigtar.gpg  files  from  full  and\nincremental  backups  on  AWS  S3  standard storage to allow quick retrieval for later\nincremental backups, all other data is stored in S3 Glacier Deep Archive.\n",
                    "long": "--s3-use-deep-archive"
                },
                {
                    "name": "--s3-use-glacier",
                    "content": "Store volumes using Glacier Flexible Storage when uploading to Amazon S3. This storage\nclass has a lower cost of storage but a higher per-request cost along with  delays  of\nup  to  12  hours  from the time of retrieval request. This storage cost is calculated\nagainst a 90-day storage minimum. According to Amazon this storage is ideal  for  data\narchiving and long-term backup offering 99.999999999% durability.  To restore a backup\nyou  will  have to manually migrate all data stored on AWS Glacier back to Standard S3\nand wait for AWS to complete the migration.\n\nNOTE: Duplicity will store  the  manifest.gpg  and  sigtar.gpg  files  from  full  and\nincremental  backups  on  AWS  S3  standard storage to allow quick retrieval for later\nincremental backups, all other data is stored in S3 Glacier.\n",
                    "long": "--s3-use-glacier"
                },
                {
                    "name": "--s3-use-glacier-ir",
                    "content": "Store volumes using Glacier Instant  Retrieval  when  uploading  to  Amazon  S3.  This\nstorage  class  is similar to Glacier Flexible Storage but offers instant retrieval at\nstandard speeds.\n\nNOTE: Duplicity will store  the  manifest.gpg  and  sigtar.gpg  files  from  full  and\nincremental  backups  on  AWS  S3  standard storage to allow quick retrieval for later\nincremental backups, all other data is stored in S3 Glacier.\n",
                    "long": "--s3-use-glacier-ir"
                },
                {
                    "name": "--s3-use-ia",
                    "content": "Store volumes using Standard - Infrequent Access when uploading to  Amazon  S3.   This\nstorage  class has a lower storage cost but a higher per-request cost, and the storage\ncost is calculated against a 30-day storage minimum. According to Amazon, this storage\nis ideal for long-term file storage, backups, and disaster recovery.\n",
                    "long": "--s3-use-ia"
                },
                {
                    "name": "--s3-use-onezone-ia",
                    "content": "Store volumes using One Zone - Infrequent Access when uploading to  Amazon  S3.   This\nstorage is similar to Standard - Infrequent Access, but only stores object data in one\nAvailability Zone.\n",
                    "long": "--s3-use-onezone-ia"
                },
                {
                    "name": "--s3-use-rrs",
                    "content": "Store volumes using Reduced Redundancy Storage when uploading to Amazon S3.  This will\nlower  the  cost  of storage but also lower the durability of stored volumes to 99.99%\ninstead the 99.999999999% durability offered by Standard Storage on S3.\n",
                    "long": "--s3-use-rrs"
                },
                {
                    "name": "--s3-use-server-side-kms-encryption",
                    "content": "--s3-kms-key-id keyid\n--s3-kms-grant grant\nEnable server-side encryption using key management service.\n\n--skip-if-no-change command\nBy default an empty incremental backup is created if no files have  changed.   Setting\nthis  option will skip creating a backup if no data has changed.  Nothing will be sent\nto the target nor information be cached.\n\n--scp-command command\n(only ssh pexpect backend with --use-scp enabled)\nThe command will be used instead of \"scp\" to send  or  receive  files.   To  list  and\ndelete existing files, the sftp command is used.\nSee also A NOTE ON SSH BACKENDS section SSH pexpect backend.\n\n--sftp-command command\n(only ssh pexpect backend)\nThe command will be used instead of \"sftp\".\nSee also A NOTE ON SSH BACKENDS section SSH pexpect backend.\n\n--sign-key key-id\nThis option can be used when backing up, restoring or verifying.  When backing up, all\nbackup  files will be signed with keyid key.  When restoring, duplicity will signal an\nerror if any remote file is not signed with the given key-id. The key-id can be  given\nin  any  of the formats supported by GnuPG; see gpg(1), section \"HOW TO SPECIFY A USER\nID\" for details.  Should be specified only once because currently only one signing key\nis supported. Last entry overrides all other entries.\nSee also A NOTE ON SYMMETRIC ENCRYPTION AND SIGNING\n",
                    "long": "--s3-use-server-side-kms-encryption"
                },
                {
                    "name": "--ssh-askpass",
                    "content": "Tells the ssh backend to prompt the user for the remote system password, if it was not\ndefined in target url and no FTPPASSWORD env var is set.  This password is also  used\nfor passphrase-protected ssh keys.\n\n--ssh-options options\nAllows  you to pass options to the ssh backend.  Can be specified multiple times or as\na  space  separated  options  list.   The  options  list  should  be   of   the   form\n\"-oOpt1='parm1'  -oOpt2='parm2'\" where the option string is quoted and the only spaces\nallowed are between options. The option string will be passed verbatim to both scp and\nsftp, whose command line syntax differs slightly hence the options should therefore be\ngiven in the long option format described in sshconfig(5).\n\n\nexample of a list:\n\nduplicity  --ssh-options=\"-oProtocol=2  -oIdentityFile='/my/backup/id'\"   /home/me\nscp://user@host/somedir\n\n\nexample with multiple parameters:\n\nduplicity                    --ssh-options=\"-oProtocol=2\"                   --ssh-\noptions=\"-oIdentityFile='/my/backup/id'\" /home/me scp://user@host/somedir\n\n\nNOTE: The ssh paramiko backend currently supports only the  -i  or  -oIdentityFile  or\n-oUserKnownHostsFile  or  -oGlobalKnownHostsFile settings. If needed provide more host\nspecific options via sshconfig file.\n\n--ssl-cacert-file file\n(only webdav & lftp backend) Provide a cacert file for ssl certificate verification.\n\nSee also A NOTE ON SSL CERTIFICATE VERIFICATION.\n\n--ssl-cacert-path path/to/certs/\n(only webdav backend and python 2.7.9+ OR lftp+webdavs and a recent  lftp)  Provide  a\npath to a folder containing cacert files for ssl certificate verification.\n\nSee also A NOTE ON SSL CERTIFICATE VERIFICATION.\n",
                    "long": "--ssh-askpass"
                },
                {
                    "name": "--ssl-no-check-certificate",
                    "content": "(only webdav & lftp backend) Disable ssl certificate verification.\n\nSee also A NOTE ON SSL CERTIFICATE VERIFICATION.\n",
                    "long": "--ssl-no-check-certificate"
                },
                {
                    "name": "--swift-storage-policy",
                    "content": "Use this storage policy when operating on Swift containers.\n\nSee also A NOTE ON SWIFT (OPENSTACK OBJECT STORAGE) ACCESS.\n\n--metadata-sync-mode mode\nThis option defaults to 'partial', but you can set it to 'full'\n\nUse  'partial'  to  avoid syncing metadata for backup chains that you are not going to\nuse.  This saves time when restoring for the first time, and lets you restore  an  old\nbackup  that  was  encrypted  with a different passphrase by supplying only the target\npassphrase.\n\nUse 'full' to sync metadata for all backup chains on the remote.\n\n--tempdir directory\nUse this existing directory for  duplicity  temporary  files  instead  of  the  system\ndefault,  which  is usually the /tmp directory. This option supersedes any environment\nvariable.\n\nSee also ENVIRONMENT VARIABLES.\n",
                    "long": "--swift-storage-policy"
                },
                {
                    "name": "-t _",
                    "content": "Specify the time from which to restore or list files.\n\nSee section TIME FORMATS for details.\n\n--time-separator char\nUse char as the time separator in filenames instead of colon (\":\").\n\nNOTE: This option only applies to recovery and status style  actions.   We  no  longer\ncreate  or  write filenames with time separators, but will read older backups that may\nneed this option.\n\n--timeout seconds\nUse seconds as the socket timeout value if duplicity begins to timeout during  network\noperations.  The default is 30 seconds.\n",
                    "flag": "-t"
                },
                {
                    "name": "--use-agent",
                    "content": "If  this  option  is  specified,  then  --use-agent  is passed to the GnuPG encryption\nprocess and it will try to connect to gpg-agent before it asks for  a  passphrase  for\n--encrypt-key or --sign-key if needed.\n\nNOTE:  Contrary to previous versions of duplicity, this option will also be honored by\nGnuPG 2 and newer versions. If  GnuPG  2  is  in  use,  duplicity  passes  the  option\n--pinentry-mode=loopback to the the gpg process unless --use-agent is specified on the\nduplicity command line. This has the effect that GnuPG 2 uses the agent only if --use-\nagent is given, just like GnuPG 1.\n\n--verbosity level, -vlevel\nSpecify output verbosity level (log level).  Named levels and corresponding values are\n0 Error, 2 Warning, 4 Notice (default), 8 Info, 9 Debug (noisiest).\nlevel may also be\na character: e, w, n, i, d\na word: error, warning, notice, info, debug\n\nThe options -v4, -vn and -vnotice are functionally equivalent, as are the mixed/upper-\ncase versions -vN, -vNotice and -vNOTICE.\n",
                    "long": "--use-agent"
                },
                {
                    "name": "--version",
                    "content": "Print duplicity's version and quit.\n\n--volsize number\nChange the volume size to number MB. Default is 200MB.\n\n--webdav-headers csv formatted key,value pairs\nThe input format is comma separated list of key,value pairs. Standard CSV encoding may\nbe used.\n\nFor example to set a Cookie use 'Cookie,name=value', or '\"Cookie\",\"name=value\"'.\n\nYou can set multiple headers, e.g. '\"Cookie\",\"name=value\",\"Authorization\",\"xxx\"'.\n",
                    "long": "--version"
                }
            ]
        },
        "ENVIRONMENT VARIABLES": {
            "content": "",
            "subsections": [
                {
                    "name": "TMPDIR, TEMP, TMP",
                    "content": "In  decreasing order of importance, specifies the directory to use for temporary files\n(inherited from Python's tempfile module).  Eventually the option --tempdir supersedes\nany of these.\n\nFTPPASSWORD\nSupported by most backends which are password capable. More secure than setting it  in\nthe  backend  url (which might be readable in the operating systems process listing to\nother users on the same machine).\n\nPASSPHRASE\nThis passphrase is passed to GnuPG. If this is not set, the user will be prompted  for\nthe passphrase.  GPG uses the AES encryption method for passphrase encryption.\n\nSIGNPASSPHRASE\nThe  passphrase to be used for --sign-key.  If omitted and sign key is also one of the\nkeys to encrypt against PASSPHRASE will be reused instead.  Otherwise,  if  passphrase\nis  needed  but not set the user will be prompted for it.  GPG uses the AES encryption\nmethod for passphrase encryption.\n\nOther environment variables may be used to configure specific backends.  See the notes\nfor the particular backend.\n"
                }
            ]
        },
        "URL FORMAT": {
            "content": "Duplicity uses the URL format (as standard as possible)  to  define  data  locations.   Major\ndifference is that the whole host section is optional for some backends.\nNOTE: If path starts with an extra '/' it usually denotes an absolute path on the backend.\n\nThe generic format for a URL is:\n\nscheme://[[user[:password]@]host[:port]/][/]path\n\nor\n\nscheme://[/]path\n\nIt  is  not recommended to expose the password on the command line since it could be revealed\nto anyone with permissions to do process listings, it is permitted however.  Consider setting\nthe environment variable FTPPASSWORD instead, which is used by most, if  not  all  backends,\nregardless of it's name.\n\nIn  protocols  that  support  it,  the  path  may  be preceded by a single slash, '/path', to\nrepresent a relative path to the target home  directory,  or  preceded  by  a  double  slash,\n'//path', to represent an absolute filesystem path.\n\nNOTE: Scheme (protocol) access may be provided by more than one backend.  In case the default\nbackend  is  buggy  or  simply  not  working  in  a specific case it might be worth trying an\nalternative implementation. Alternative backends can be selected by prefixing the scheme with\nthe name of the alternative backend e.g. ncftp+ftp:// and are mentioned  below  the  scheme's\nsyntax summary.\n\nFormats of each of the URL schemes follow:\n",
            "subsections": [
                {
                    "name": "Amazon Drive Backend",
                    "content": "ad://somedir\n\nSee also A NOTE ON AMAZON DRIVE\n"
                },
                {
                    "name": "Azure",
                    "content": "azure://container-name\n\nSee also A NOTE ON AZURE ACCESS\n\nB2\nb2://accountid[:applicationkey]@bucketname/[folder/]\n"
                },
                {
                    "name": "Box",
                    "content": "box:///somedir[?config=pathtoconfig]\n\nSee also A NOTE ON BOX ACCESS\n\nCloud Files (Rackspace)\ncf+http://containername\n\nSee also A NOTE ON CLOUD FILES ACCESS\n"
                },
                {
                    "name": "Dropbox",
                    "content": "dpbx:///somedir\n\nMake sure to read A NOTE ON DROPBOX ACCESS first!\n\nFile (local file system)\nfile://[relative|/absolute]/local/path\n\nFISH (Files transferred over Shell protocol) over ssh\nfish://user[:pwd]@other.host[:port]/[relative|/absolute]path\n\nFTP\nftp[s]://user[:password]@other.host[:port]/somedir\n\nNOTE:   use  lftp+,  ncftp+  prefixes  to  enforce  a  specific  backend,  default  is\nlftp+ftp://...\n\nGoogle Cloud Storage (GCS via Interoperable Access)\ns3://bucket[/path]\n\nSee A NOTE ON GOOGLE CLOUD STORAGE about needed  endpoint  option  and  env  vars  for\nauthentication.\n"
                },
                {
                    "name": "Google Docs",
                    "content": "gdocs://user[:password]@other.host/somedir\n\nNOTE:  use  pydrive+,  gdata+  prefixes  to  enforce  a  specific  backend, default is\npydrive+gdocs://...\n"
                },
                {
                    "name": "Google Drive",
                    "content": "gdrive://<service account' email address>@developer.gserviceaccount.com/somedir\n\nSee also A NOTE ON GDRIVE BACKEND below.\n\nHSI\nhsi://user[:password]@other.host/somedir\n"
                },
                {
                    "name": "hubiC",
                    "content": "cf+hubic://containername\n\nSee also A NOTE ON HUBIC\n"
                },
                {
                    "name": "IMAP email storage",
                    "content": "imap[s]://user[:password]@host.com[/fromaddressprefix]\n\nSee also A NOTE ON IMAP\n"
                },
                {
                    "name": "MediaFire",
                    "content": "mf://user[:password]@mediafire.com/somedir\n\nSee also A NOTE ON MEDIAFIRE BACKEND below.\n\nMEGA.nz cloud storage (only works for accounts created prior to November 2018, uses\n\"megatools\")\nmega://user[:password]@mega.nz/somedir\n\nNOTE: if not given in the URL, relies on password being  stored  within  $HOME/.megarc\n(as used by the \"megatools\" utilities)\n\nMEGA.nz cloud storage (works for all MEGA accounts, uses \"MEGAcmd\" tools)\nmegav2://user[:password]@mega.nz/somedir\nmegav3://user[:password]@mega.nz/somedir[?nologout=1] (For latest MEGAcmd)\n\nNOTE:  despite  \"MEGAcmd\" no longer uses a configuration file, for convenience storing\nthe user password this backend searches it in the $HOME/.megav2rc file (same syntax as\nthe old $HOME/.megarc)\n[Login]\nUsername = MEGAUSERNAME\nPassword = MEGAPASSWORD\n"
                },
                {
                    "name": "multi",
                    "content": "multi:///path/to/config.json\n\nSee also A NOTE ON MULTI BACKEND below.\n"
                },
                {
                    "name": "OneDrive Backend",
                    "content": "onedrive://somedir See also A NOTE ON ONEDRIVE BACKEND\n"
                },
                {
                    "name": "Par2 Wrapper Backend",
                    "content": "par2+scheme://[user[:password]@]host[:port]/[/]path\n\nSee also A NOTE ON PAR2 WRAPPER BACKEND\n\nPublic Cloud Archive (OVH)\npca://containername[/prefix]\n\nSee also A NOTE ON PCA ACCESS\n"
                },
                {
                    "name": "pydrive",
                    "content": "pydrive://<service account' email address>@developer.gserviceaccount.com/somedir\n\nSee also A NOTE ON PYDRIVE BACKEND below.\n"
                },
                {
                    "name": "Rclone Backend",
                    "content": "rclone://remote:/somedir\n\nSee also A NOTE ON RCLONE BACKEND\n"
                },
                {
                    "name": "Rsync via daemon",
                    "content": "rsync://user[:password]@host.com[:port]::[/]module/somedir\n\nRsync over ssh (only key auth)\nrsync://user@host.com[:port]/[relative|/absolute]path\n\nS3 storage (Amazon)\ns3:///bucketname[/path]\n\nSee also A NOTE ON AMAZON S3 below.\n\nSCP/SFTP Secure Copy Protocol/SSH File Transfer Protocol\nscp://.. or\nsftp://user[:pwd]@other.host[:port]/[relative|/absolute]path\n\ndefaults are paramiko+scp:// and paramiko+sftp://\nalternatively try pexpect+scp://, pexpect+sftp://, lftp+sftp://\nSee also --ssh-askpass, --ssh-options and A NOTE ON SSH BACKENDS.\n"
                },
                {
                    "name": "slate",
                    "content": "slate://[slate-id]\n\nSee also A NOTE ON SLATE BACKEND\n\nSwift (Openstack)\nswift://containername[/prefix]\n\nSee also A NOTE ON SWIFT (OPENSTACK OBJECT STORAGE) ACCESS\n"
                },
                {
                    "name": "Tahoe-LAFS",
                    "content": "tahoe://alias/directory\n"
                },
                {
                    "name": "WebDAV",
                    "content": "webdav[s]://user[:password]@other.host[:port]/somedir\n\nalternatively try lftp+webdav[s]://\n"
                },
                {
                    "name": "Optical media (ISO9660 CD/DVD/Bluray using xorriso)",
                    "content": "xorriso:///dev/byOpticalDrive[:/path/to/directory/on/iso]\nxorriso:///path/to/image.iso[:/path/to/directory/on/iso]\n\n\nSee also A NOTE ON THE XORRISO BACKEND\n"
                }
            ]
        },
        "TIME FORMATS": {
            "content": "duplicity uses time strings in two places.  Firstly, many of the files duplicity creates will\nhave the time in their filenames in the w3 datetime format as  described  in  a  w3  note  at\nhttp://www.w3.org/TR/NOTE-datetime.   Basically  they  look like \"2001-07-15T04:09:38-07:00\",\nwhich means what it looks like.  The \"-07:00\" section means the time zone is 7  hours  behind\nUTC.\nSecondly,  the  -t, --time, and --restore-time options take a time string, which can be given\nin any of several formats:\n1.     the string \"now\" (refers to the current time)\n2.     a sequences of digits, like \"123456890\" (indicating the  time  in  seconds  after  the\nepoch)\n3.     A string like \"2002-01-25T07:00:00+02:00\" in datetime format\n4.     An  interval, which is a number followed by one of the characters s, m, h, D, W, M, or\nY (indicating seconds, minutes, hours, days, weeks, months, or years respectively), or\na series of such pairs.  In this case the string refers to the time that preceded  the\ncurrent  time by the length of the interval.  For instance, \"1h78m\" indicates the time\nthat was one hour and 78 minutes ago.  The calendar here is unsophisticated:  a  month\nis always 30 days, a year is always 365 days, and a day is always 86400 seconds.\n5.     A  date  format  of  the form YYYY/MM/DD, YYYY-MM-DD, MM/DD/YYYY, or MM-DD-YYYY, which\nindicates midnight on the day in question, relative to the current time zone settings.\nFor instance, \"2002/3/5\", \"03-05-2002\", and \"2002-3-05\" all mean March 5th, 2002.\n",
            "subsections": []
        },
        "FILE SELECTION": {
            "content": "When duplicity is run, it searches through the given source directory and backs  up  all  the\nfiles specified by the file selection system, unless --files-from has been specified in which\ncase the passed list of individual files is used instead.\n\nThe  file  selection  system  comprises  a number of file selection conditions, which are set\nusing one of the following command line options:\n\n--exclude\n--exclude-device-files\n--exclude-if-present\n--exclude-filelist\n--exclude-regexp\n--include\n--include-filelist\n--include-regexp\n\nFor each individual file found in the source directory, the  file  selection  conditions  are\nchecked  in  the  order they are specified on the command line.  Should a selection condition\nmatch, the file will be included or excluded accordingly and the file selection  system  will\nproceed to the next file without checking the remaining conditions.\n\nEarlier  arguments  therefore take precedence where multiple conditions match any given file,\nand are thus usually given in order of decreasing specificity.  If  no  selection  conditions\nmatch a given file, then the file is implicitly included.\n\nFor example,\n\nduplicity --include /usr --exclude /usr /usr scp://user@host/backup\n\nis exactly the same as\n\nduplicity /usr scp://user@host/backup\n\nbecause  the  --include directive matches all files in the backup source directory, and takes\nprecedence over the contradicting --exclude option as it comes first.\n\nAs a more meaningful example,\n\nduplicity --include /usr/local/bin --exclude /usr/local /usr scp://user@host/backup\n\nwould backup the /usr/local/bin directory (and its contents), but  not  /usr/local/doc.  Note\nthat  this is not the same as simply specifying /usr/local/bin as the backup source, as other\nfiles and folders under /usr will also be (implicitly) included.\n\nThe order of the --include and --exclude arguments is important. In the previous example,  if\nthe  less  specific  --exclude  directive  had  precedence it would prevent the more specific\n--include from matching any files.\n\nThe patterns passed to the --include, --exclude, --include-filelist,  and  --exclude-filelist\noptions  are  interpretted as extended shell globbing patterns by default. This behaviour can\nbe changed with the following filter mode arguments:\n\n--filter-globbing\n--filter-literal\n--filter-regexp\n\nThese arguments change the interpretation of  the  patterns  used  in  selection  conditions,\naffecting  all  subsequent  file  selection  options  passed on the command line. They may be\nspecified multiple times in order to switch pattern interpretations as needed.\n\nLiteral strings differ from globs in that the pattern must match the filename  exactly.  This\ncan be useful where filenames contain characters which have special meaning in shell globs or\nregular  expressions.  If  passing  dynamically  generated  file lists to duplicity using the\n--include-filelist or  --exclude-filelist  options,  then  the  use  of  --filter-literal  is\nrecommended unless regular expression or globbing is specifically required.\n\nThe regular expression language used for selection conditions specified with --include-regexp\n,  --exclude-regexp  ,  or  when --filter-regexp is in effect is as implemented by the Python\nstandard library.\n\nExtended shell globbing pattenrs may contain: *, , ?, and [...]  (character ranges). As  in\na  normal shell, * can be expanded to any string of characters not containing \"/\", ?  expands\nto any single character except \"/\", and  [...]   expands  to  a  single  character  of  those\ncharacters  specified  (ranges  are  acceptable).   The  pattern   expands to any string of\ncharacters whether or not it contains \"/\".\n\nIn addition to the above filter mode arguments, the following can be used in the same fashion\nto enable (default)  or  disable  case  sensitivity  in  the  evaluation  of  file  sslection\nconditions:\n\n--filter-ignorecase\n--filter-strictcase\n\nAn example of filter mode switching including case insensitivity is\n\n--filter-ignorecase    --include   /usr/bin/*.PY   --filter-literal   --filter-include\n/usr/bin/special?file*name --filter-strictcase --exclude /usr/bin\n\nwhich would backup *.py, *.pY, *.Py, and *.PY  files  under  /usr/bin  and  also  the  single\nliterally specified file with globbing characters in the name. The use of --filter-strictcase\nis  not technically necessary here, but is included as an example which may (depending on the\nbackup source path) cause unexpected interactions between --include  and  --exclude  options,\nshould the directory portion of the path (/usr/bin) contain any uppercase characters.\n\nIf the pattern starts with \"ignorecase:\" (case insensitive), then this prefix will be removed\nand  any  character  in  the  string  can  be replaced with an upper- or lowercase version of\nitself. This prefix is a legacy feature supported for  shell  globbing  selection  conditions\nonly,  but  for  backward  compatability  reasons is otherwise considered part of the pattern\nitself (use --filter-ignorecase instead).\n\nRemember that you may need to quote patterns when typing them into a shell, so the shell does\nnot interpret the globbing patterns or whitespace characters before duplicity sees them.\n\nSelection patterns should generally be thought of as filesystem paths rather  than  arbitrary\nstrings.  For  selection  conditions  using  extended  shell globbing patterns, the --exclude\npattern option matches a file if:\n\n1.  pattern can be expanded into the file's filename, or\n2.  the file is inside a directory matched by the option.\n\nConversely, the --include pattern option matches a file if:\n\n1.  pattern can be expanded into the file's filename, or\n2.  the file is inside a directory matched by the option, or\n3.  the file is a directory which contains a file matched by the option.\n\nFor example,\n\n--exclude /usr/local\n\nmatches e.g. /usr/local, /usr/local/lib, and /usr/local/lib/netscape.   It  is  the  same  as\n--exclude /usr/local --exclude '/usr/local/'.\nOn the other hand\n\n--include /usr/local\n\nspecifies  that  /usr,  /usr/local,  /usr/local/lib,  and  /usr/local/lib/netscape  (but  not\n/usr/doc) all be backed up. Thus you don't have to worry about including  parent  directories\nto make sure that included subdirectories have somewhere to go.\n\nFinally,\n\n--include ignorecase:'/usr/[a-z0-9]foo/*/.py'\n\nwould  match  a file like /usR/5fOO/hello/there/world.py.  If it did match anything, it would\nalso match /usr.  If there is no existing file that the given pattern can be  expanded  into,\nthe option will not match /usr alone.\n\nThis  treatment  of patterns in globbing and literal selection conditions as filesystem paths\nreduces the number of explicit conditions required.  However, it does require that the  paths\ndescribed  by  all variants of the --include or --include option are fully specified relative\nto the backup source directory.\n\nFor selection conditions using literal strings, the same logic applies except that scenario 1\nis for an exact match of the pattern.\n\nFor selection conditions using regular expressions the pattern  is  evaluated  as  a  regular\nexpression  rather  than a filesystem path. Scenario 3 in the above therefore does not apply,\nthe implications of which are discussed at the end of this section.\n\nThe  --include-filelist,  and  --exclude-filelist,  options  also  introduce  file  selection\nconditions.   They direct duplicity to read in a text file (either ASCII or UTF-8), each line\nof which is a file specification, and to include or exclude the matching  files.   Lines  are\nseparated by newlines or nulls, depending on whether the --null-separator switch was given.\n\nEach  line  in  the  filelist  will  be  interpreted  as  a selection pattern in the same way\n--include and --exclude options are interpreted, except that lines starting  with  \"+  \"  are\ninterpreted  as  include  directives,  even  if  found in a filelist referenced by --exclude-\nfilelist.  Similarly, lines starting with \"- \" exclude files even if they are found within an\ninclude filelist.\n\nFor example, if file \"list.txt\" contains the lines:\n\n/usr/local\n- /usr/local/doc\n/usr/local/bin\n+ /var\n- /var\n\nthen --include-filelist list.txt would include  /usr,  /usr/local,  and  /usr/local/bin.   It\nwould   exclude   /usr/local/doc,   /usr/local/doc/python,   etc.    It  would  also  include\n/usr/local/man, as this is included within /usr/local.  Finally, it is undefined what happens\nwith /var.  A single file list should not contain conflicting file specifications.\n\nEach line in the filelist will be interpreted as per the current filter mode in the same  way\n--include  and  --exclude  options  are  interpreted.  For  instance,  if the file \"list.txt\"\ncontains the lines:\n\ndir/foo\n+ dir/bar\n-\n\nThen --include-filelist list.txt would be exactly the same as  specifying  --include  dir/foo\n--include dir/bar --exclude  on the command line.\n\nNote  that  specifying very large numbers numbers of selection rules as filelists can incur a\nsubstantial performance penalty as these rules will (potentially) be checked for  every  file\nin the backup source directory. If you need to backup arbitrary lists of specific files (i.e.\nnot  described  by  regexp  patterns  or  shell globs) then --files-from is likely to be more\nperformant.\n\nFinally, the --include-regexp and --exclude-regexp options allow files  to  be  included  and\nexcluded  if  their  filenames  match a regular expression.  Regular expression syntax is too\ncomplicated to explain here, but is  covered  in  Python's  library  reference.   Unlike  the\n--include  and --exclude options, the regular expression options don't match files containing\nor contained in matched files.  So for instance\n\n--include-regexp '[0-9]{7}(?!foo)'\n\nmatches any files whose full pathnames contain 7 consecutive digits which aren't followed  by\n'foo'.  However, it wouldn't match /home even if /home/ben/1234567 existed.\n",
            "subsections": []
        },
        "A NOTE ON AMAZON DRIVE": {
            "content": "1.     The API Keys used for Amazon Drive have not been granted production limits.  Amazon do\nnot  say  what  the  development  limits  are  and  are not replying to to requests to\nwhitelist duplicity. A related tool, acdcli, was demoted to development  limits,  but\ncontinues  to  work  fine  except  for  cases  of  excessive  usage. If you experience\nthrottling and similar issues with Amazon Drive using this backend, please report them\nto the mailing list.\n2.     If you previously used the acd+acdcli backend, it is strongly recommended to update to\nthe ad backend instead, since it interfaces directly with Amazon Drive. You will  need\nto setup the OAuth once again, but can otherwise keep your backups and config.\n",
            "subsections": []
        },
        "A NOTE ON AMAZON S3": {
            "content": "Backing up to Amazon S3 utilizes the boto3 library.\n\nThe  boto3  backend  does not support bucket creation.  This deliberate choice simplifies the\ncode, and side steps problems related to region selection.  Additionally, it is probably  not\na good practice to give your backup role bucket creation rights.  In most cases the role used\nfor backups should probably be limited to specific buckets.\n\nThe boto3 backend only supports newer domain style buckets. Amazon is moving to deprecate the\nolder bucket style, so migration is recommended.\n\nThe  boto3  backend  does  not currently support initiating restores from the glacier storage\nclass.  When restoring a backup from glacier or glacier deep archive, the backup  files  must\nfirst  be  restored out of band.  There are multiple options when restoring backups from cold\nstorage, which vary in both cost and speed.  See Amazon's documentation for details.\n\nThe following environment variables are required for authentication:",
            "subsections": [
                {
                    "name": "AWS_ACCESS_KEY_ID (required),",
                    "content": ""
                },
                {
                    "name": "AWS_SECRET_ACCESS_KEY (required)",
                    "content": "or"
                },
                {
                    "name": "BOTO_CONFIG (required)",
                    "content": "For simplicity's sake we will document the use  of  the  AWS*  vars  only.   Research  boto3\ndocumentation available in the web if you want to use  the config file.\n\nboto3 backend example backup command line:\n\nAWSACCESSKEYID=<keyid>   AWSSECRETACCESSKEY=<accesskey>  duplicity  /some/path\ns3:///bucket/subfolder\n\nyou may add --s3-endpoint-url (to access non Amazon S3 services or  regional  endpoints)  and\nmay  need  --s3-region-name  (for  buckets  created  in  specific regions) and other --s3-...\noptions documented above.\n"
                }
            ]
        },
        "A NOTE ON AZURE ACCESS": {
            "content": "The Azure backend requires the Microsoft Azure Storage Blobs client library for Python to  be\ninstalled on the system.  See REQUIREMENTS.\n\nIt  uses  the  environment variable AZURECONNECTIONSTRING (required).  This string contains\nall necessary information such as Storage Account name and the key for  authentication.   You\ncan find it under Access Keys for the storage account.\n\nDuplicity  will  take care to create the container when performing the backup.  Do not create\nit manually before.\n\nA container name (as given as the backup url) must be a valid DNS  name,  conforming  to  the\nfollowing naming rules:\n\n1.     Container  names  must  start  with  a  letter  or number, and can contain only\nletters, numbers, and the dash (-) character.\n2.     Every dash (-) character must be immediately preceded and followed by a  letter\nor number; consecutive dashes are not permitted in container names.\n3.     All letters in a container name must be lowercase.\n4.     Container names must be from 3 through 63 characters long.\n\nThese      rules      come      from      Azure;      see      https://docs.microsoft.com/en-\nus/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata\n",
            "subsections": []
        },
        "A NOTE ON BOX ACCESS": {
            "content": "The box backend requires boxsdk with  jwt  support  to  be  installed  on  the  system.   See\nREQUIREMENTS.\n\nIt  uses  the environment variable BOXCONFIGPATH (optional).  This string contains the path\nto box custom app's config.json.  Either  this  environment  variable  or  the  config  query\nparameter  in  the  url  need  to  be specified, if both are specified, query parameter takes\nprecedence.\n",
            "subsections": [
                {
                    "name": "Create a Box custom app",
                    "content": "In order to use box backend, user need to create a  box  custom  app  in  the  box  developer\nconsole (https://app.box.com/developers/console).\n\nAfter create a new custom app, please make sure it is configured as follow:\n\n1.     Choose \"App Access Only\" for \"App Access Level\"\n2.     Check \"Write all files and folders stored in Box\"\n3.     Generate a Public/Private Keypair\n\nThe  user  also  need  to  grant  the  created  custom  app  permission  in the admin console\n(https://app.box.com/master/custom-apps) by clicking the \"+\" button and enter  the  clientid\nwhich can be found on the custom app's configuration page.\n"
                }
            ]
        },
        "A NOTE ON CLOUD FILES ACCESS": {
            "content": "Pyrax is Rackspace's next-generation Cloud management API, including Cloud Files access.  The\ncfpyrax backend requires the pyrax library to be installed on the system.  See REQUIREMENTS.\n\nCloudfiles is Rackspace's now deprecated implementation of OpenStack Object Storage protocol.\nUsers  wishing  to  use  Duplicity with Rackspace Cloud Files should migrate to the new Pyrax\nplugin to ensure support.\n\nThe backend requires python-cloudfiles to be installed on the system.  See REQUIREMENTS.\n\nIt uses three  environment  variables  for  authentication:  CLOUDFILESUSERNAME  (required),",
            "subsections": [
                {
                    "name": "CLOUDFILES_APIKEY (required), CLOUDFILES_AUTHURL (optional)",
                    "content": "If  CLOUDFILESAUTHURL  is  unspecified  it  will  default  to  the value provided by python-\ncloudfiles, which points to rackspace, hence this value must be set in  order  to  use  other\ncloud files providers.\n"
                }
            ]
        },
        "A NOTE ON DROPBOX ACCESS": {
            "content": "1.     First  of all Dropbox backend requires valid authentication token. It should be passed\nvia DPBXACCESSTOKEN environment variable.\nTo    obtain    it     please     create     'Dropbox     API'     application     at:\nhttps://www.dropbox.com/developers/apps/create\nThen visit app settings and just use 'Generated access token' under OAuth2 section.\nAlternatively  you  can  let  duplicity  generate  access  token  itself. In such case\ntemporary export DPBXAPPKEY , DPBXAPPSECRET using values from  app  settings  page\nand run duplicity interactively.\nIt  will print the URL that you need to open in the browser to obtain OAuth2 token for\nthe application. Just follow on-screen instructions and then put  generated  token  to\nDPBXACCESSTOKEN   variable.   Once   done,  feel  free  to  unset  DPBXAPPKEY  and\nDPBXAPPSECRET\n\n2.     \"somedir\" must already exist in the Dropbox folder. Depending on access token kind it\nmay be:\nFull Dropbox: path is absolute and starts from 'Dropbox' root folder.\nApp Folder: path is related to application folder. Dropbox client will show  it\nin ~/Dropbox/Apps/<app-name>\n\n3.     When  using  Dropbox  for  storage, be aware that all files, including the ones in the\nApps folder, will be synced to all connected computers.   You  may  prefer  to  use  a\nseparate  Dropbox  account specially for the backups, and not connect any computers to\nthat account. Alternatively you can configure selective sync on all computers to avoid\nsyncing of backup files\n",
            "subsections": []
        },
        "A NOTE ON FILENAME PREFIXES": {
            "content": "Filename prefixes can be used in multi backend with mirror mode  to  define  affinity  rules.\nThey  can  also be used in conjunction with S3 lifecycle rules to transition archive files to\nGlacier, while keeping metadata (signature and manifest files) on S3.\n\nDuplicity does not require access to archive files except when restoring from backup.\n\nA NOTE ON GOOGLE CLOUD STORAGE (GCS via Interoperable Access)",
            "subsections": [
                {
                    "name": "Overview",
                    "content": "Duplicity access to GCS currently relies on it's Interoperability API (basically S3 for GCS).\nThis needs to actively be enabled before access  is  possible.  For  details  read  the  next\nsection Preparations below.\n"
                },
                {
                    "name": "Preparations",
                    "content": "1.     login on https://console.cloud.google.com/\n2.     go to Cloud Storage->Settings->Interoperability\n3.     create a Service account (if needed)\n4.     create  Service account HMAC access key and secret (!!instantly copy!!  the secret, it\ncan NOT be recovered later)\n5.     go to Cloud Storage->Browser\n6.     create a bucket\n7.     add permissions for Service account that was used to set  up  Interoperability  access\nabove\n\nOnce  set  up  you can use the generated Interoperable Storage Access key and secret and pass\nthem to duplicity as described in the next section.\n"
                },
                {
                    "name": "Usage",
                    "content": "The following examples show accessing GCS via S3 for a collection-status action.   The  shown\nenv vars, options and url format can be applied for all other actions as well of course.\n\nusing boto3 supplying the --s3-endpoint-url manually.\n\nAWSACCESSKEYID=<keyid>  AWSSECRETACCESSKEY=<secret>  duplicity collection-status\ns3:///<bucket>/<folder> --s3-endpoint-url=https://storage.googleapis.com\n"
                }
            ]
        },
        "A NOTE ON GDRIVE BACKEND": {
            "content": "GDrive: is a rewritten PyDrive: backend with less dependencies, and a simpler setup - it uses\nthe JSON keys downloaded directly from Google Cloud Console.\n\nNote Google has 2 drive methods, `Shared(previously Team) Drives` and `My Drive`, both can be\nshared but require different addressing\n",
            "subsections": [
                {
                    "name": "For a Google Shared Drives folder",
                    "content": "Share Drive ID specified as a query parameter, driveID,  in the backend URL.  Example:\ngdrive://developer.gserviceaccount.com/target-folder/?driveID=<SHARED DRIVE ID>\n"
                },
                {
                    "name": "For a Google My Drive based shared folder",
                    "content": "MyDrive folder ID specified as a query parameter, myDriveFolderID, in the backend URL Example\nexport                GOOGLESERVICEACCOUNTURL=<serviceaccount-name>@<serviceaccount-\nname>.iam.gserviceaccount.com\ngdrive://${GOOGLESERVICEACCOUNTURL}/<target-folder-name-in-\nmyDriveFolder>?myDriveFolderID=root\n\n\nThere  are  also  two  ways  to  authenticate to use GDrive: with a regular account or with a\n\"service account\". With a service account, a  separate  account  is  created,  that  is  only\naccessible  with  Google  APIs  and  not  a web login.  With a regular account, you can store\nbackups in your normal Google Drive.\n\nTo   use   a   service   account,    go    to    the    Google    developers    console    at\nhttps://console.developers.google.com.  Create  a project, and make sure Drive API is enabled\nfor the project. In the  \"Credentials\"  section,  click  \"Create  credentials\",  then  select\nService Account with JSON key.\n\nThe  GOOGLESERVICEJSONFILE environment variable needs to contain the path to the JSON file\non duplicity invocation.\n\nexport GOOGLESERVICEJSONFILE=<path-to-serviceaccount-credentials.json>\n\n\nThe alternative is to use a regular account. To do this, start as above, but when creating  a\nnew  Client  ID,  select  \"Create  OAuth  client ID\", with application type of \"Desktop app\".\nDownload   the   clientsecret.json   file   for   the    new    client,    and    set    the\nGOOGLECLIENTSECRETJSONFILE   environment   variable   to  the  path  to  this  file,  and\nGOOGLECREDENTIALSFILE to a path to a file where  duplicity  will  keep  the  authentication\ntoken - this location must be writable.\n\nNOTE:  As  a  sanity check, GDrive checks the host and username from the URL against the JSON\nkey, and refuses to proceed if the addresses do not match. Either the email (for the  service\naccounts)  or  Client  ID  (for  regular  OAuth accounts) must be present in the URL. See URL\nFORMAT above.\n"
                },
                {
                    "name": "First run / OAuth 2.0 authorization",
                    "content": "During the first run, you will be prompted to visit an URL in your browser to grant access to\nyour Google Drive. A temporary HTTP-service will be started on a local network interface  for\nthis  purpose  (by  default  on  http://localhost:8080/).   Ip-address/host  and  port can be\nadjusted if need be by providing the  environment  variables  GOOGLEOAUTHLOCALSERVERHOST,\nGOOGLEOAUTHLOCALSERVERPORT respectively.\n\nIf  you  are running duplicity in a remote location, you will need to make sure that you will\nbe able to access the above HTTP-service with a browser utilizing  e.g.  port  forwarding  or\ntemporary firewall permission.\n\nThe  access credentials will be saved in the JSON file mentioned above for future use after a\nsuccessful authorization.\n"
                }
            ]
        },
        "A NOTE ON HUBIC": {
            "content": "The hubic backend requires the pyrax library to be installed on the system. See REQUIREMENTS.\nYou will need to set your credentials  for  hubiC  in  a  file  called  ~/.hubiccredentials,\nfollowing this pattern:\n[hubic]\nemail = youremail\npassword = yourpassword\nclientid = apiclientid\nclientsecret = apisecretkey\nredirecturi = http://localhost/\n",
            "subsections": []
        },
        "A NOTE ON IMAP": {
            "content": "An  IMAP account can be used as a target for the upload.  The userid may be specified and the\npassword will be requested.\nThe fromaddressprefix may be specified (and probably should be). The text will be  used  as\nthe   \"From\"  address  in  the  IMAP  server.   Then  on  a  restore  (or  list)  action  the\nfromaddressprefix will distinguish between different backups.\n",
            "subsections": []
        },
        "A NOTE ON MEDIAFIRE BACKEND": {
            "content": "This  backend  requires  mediafire  python  library  to  be  installed  on  the  system.  See\nREQUIREMENTS.\n\nUse URL escaping for username (and password, if provided via command line):\n\nmf://duplicity%40example.com@mediafire.com/somefolder\nThe destination folder will be created for you if it does not exist.\n",
            "subsections": []
        },
        "A NOTE ON MULTI BACKEND": {
            "content": "The  multi backend allows duplicity to combine the storage available in more than one backend\nstore (e.g., you can store across a google drive  account  and  a  onedrive  account  to  get\neffectively the combined storage available in both).  The URL path specifies a JSON formatted\nconfig  file  containing a list of the backends it will use. The URL may also specify \"query\"\nparameters to configure overall behavior.  Each  element  of  the  list  must  have  a  \"url\"\nelement,  and  may  also  contain  an  optional  \"description\"  and an optional \"env\" list of\nenvironment variables used to configure that backend.",
            "subsections": [
                {
                    "name": "Query Parameters",
                    "content": "Query parameters come after the file URL in standard HTTP format for example:\nmulti:///path/to/config.json?mode=mirror&onfail=abort\nmulti:///path/to/config.json?mode=stripe&onfail=continue\nmulti:///path/to/config.json?onfail=abort&mode=stripe\nmulti:///path/to/config.json?onfail=abort\nOrder does not matter, however unrecognized parameters are considered an error.\n\nmode=stripe\nThis mode (the default) performs round-robin access to the list of backends.  In  this\nmode,  all  backends  must  be  reliable  as  a loss of one means a loss of one of the\narchive files.\n\nmode=mirror\nThis mode accesses backends as a RAID1-store, storing every file in every backend  and\nreading  files from the first-successful backend.  A loss of any backend should result\nin no failure. Note that backends added later will only get new files and may  require\na manual sync with one of the other operating ones.\n\nonfail=continue\nThis  setting  (the  default)  continues  all  write operations in as best-effort. Any\nfailure results in the next backend tried. Failure is reported only when all  backends\nfail a given operation with the error result from the last failure.\n\nonfail=abort\nThis  setting  considers  any  backend  write  failure  as a terminating condition and\nreports the error.  Data reading and listing operations are independent  of  this  and\nwill try with the next backend on failure."
                },
                {
                    "name": "JSON File Example",
                    "content": "[\n{\n\"description\": \"a comment about the backend\"\n\"url\": \"abackend://myuser@domain.com/backup\",\n\"env\": [\n{\n\"name\" : \"MYENV\",\n\"value\" : \"xyz\"\n},\n{\n\"name\" : \"FOO\",\n\"value\" : \"bar\"\n}\n],\n\"prefixes\": [\"prefix1\", \"prefix2\"]\n},\n{\n\"url\": \"file:///path/to/dir\"\n}\n]\n"
                }
            ]
        },
        "A NOTE ON ONEDRIVE BACKEND": {
            "content": "onedrive://  works with both personal and business onedrive as well as sharepoint drives.  On\nfirst use you be provided with an URL to with a  microsoft  account.  Open  it  in  your  web\nbrowser.\n\nAfter authenticating, copy the redirected URL back to duplicity. Duplicity will fetch a token\nand  store  it  in  ~/.duplicityonedriveoauthtoken.json. This location can be overridden by\nsetting the DUPLICITYONEDRIVETOKEN environment variable.\n\nDuplicity uses a default App ID registered with Microsoft Azure  AD.   It  will  need  to  be\napproved by an administrator of your Office365 Tenant on a business account.\n",
            "subsections": [
                {
                    "name": "Register and set your own microsoft app id",
                    "content": "1.     visit https://portal.azure.com\n\n2.     Choose \"Enterprise Applications\", then \"Create your own Application\"\n\n3.     Input  your  application  name  and  select \"Register an application to integrate with\nAzure AD\".\n\n4.     Continue    to    the    next    page    and    set    the     redirect     uri     to\n\"https://login.microsoftonline.com/common/oauth2/nativeclient\",    choosing    \"Public\nclient/native\" from the dropdown. Click create.\n\n5.     Find the application id in \"Enterprise Applications\" and set the environment  variable\nDUPLICITYONEDRIVECLIENTID to it.\n\nMore information on Microsoft Apps at: https://learn.microsoft.com/en-us/azure/active-\ndirectory/develop/quickstart-register-app\n"
                },
                {
                    "name": "Backup to a sharepoint site instead of onedrive",
                    "content": "to use a sharepoint site you need to find and provide the site's tenant and site id.\n\n1.     Login with your Microsoft Account at https://<o365tenant>.sharepoint.com/\n\n2.     Navigate to https://<o365tenant>.sharepoint.com/sites/<pathtosite>/api/site/id\n\n3.     Copy  the  disyplayed  UUID  (siteid) and set the DUPLICITYONEDRIVEROOT environment\nvariable to \"sites/<o365tenant>.sharepoint.com,<siteid>/drive\"\n"
                }
            ]
        },
        "A NOTE ON PAR2 WRAPPER BACKEND": {
            "content": "Par2 Wrapper Backend can be used in combination with all other backends  to  create  recovery\nfiles.   Just   add   par2+  before  a  regular  scheme  (e.g.   par2+ftp://user@host/dir  or\npar2+s3+http://bucketname ). This will create par2  recovery  files  for  each  archive  and\nupload them all to the wrapped backend.\nBefore  restoring, archives will be verified. Corrupt archives will be repaired on the fly if\nthere are enough recovery blocks available.\nUse --par2-redundancy percent to adjust the  size  (and  redundancy)  of  recovery  files  in\npercent.\n",
            "subsections": []
        },
        "A NOTE ON PCA ACCESS": {
            "content": "PCA  is  a  long-term  data  archival solution by OVH. It runs a slightly modified version of\nOpenstack Swift introducing latency in the data retrieval process.  It is a good pick  for  a\nmulti  backend  configuration  where receiving volumes while another backend is used to store\nmanifests and signatures.\n\nThe backend requires python-switclient to be installed on the system.   python-keystoneclient\nis also needed to interact with OpenStack's Keystone Identity service.  See REQUIREMENTS.\n\nIt   uses  following  environment  variables  for  authentication:  PCAUSERNAME  (required),",
            "subsections": [
                {
                    "name": "PCA_PASSWORD  (required),  PCA_AUTHURL  (required),   PCA_USERID   (optional),",
                    "content": "(optional,  but  either  the  tenant  name  or  tenant  id  must  be supplied) PCAREGIONNAME\n(optional), PCATENANTNAME (optional, but either  the  tenant  name  or  tenant  id  must  be\nsupplied)\n\nIf  the  user  was  previously authenticated, the following environment variables can be used\ninstead: PCAPREAUTHURL (required), PCAPREAUTHTOKEN (required)\n\nIf PCAAUTHVERSION is unspecified, it will default to version 2.\n"
                }
            ]
        },
        "A NOTE ON PYDRIVE BACKEND": {
            "content": "The pydrive backend requires Python PyDrive package  to  be  installed  on  the  system.  See\nREQUIREMENTS.\n\nThere are two ways to use PyDrive: with a regular account or with a \"service account\". With a\nservice  account, a separate account is created, that is only accessible with Google APIs and\nnot a web login.  With a regular account, you can store backups in your normal Google Drive.\n\nTo   use   a   service   account,    go    to    the    Google    developers    console    at\nhttps://console.developers.google.com.  Create  a project, and make sure Drive API is enabled\nfor the project. Under \"APIs and auth\", click Create  New  Client  ID,  then  select  Service\nAccount with P12 key.\n\nDownload the .p12 key file of the account and convert it to the .pem format:\nopenssl pkcs12 -in XXX.p12  -nodes -nocerts > pydriveprivatekey.pem\n\nThe  content  of  .pem file should be passed to GOOGLEDRIVEACCOUNTKEY environment variable\nfor authentication.\n\nThe email address of the account will be used as part of URL. See URL FORMAT above.\n\nThe alternative is to use a regular account. To do this, start as above, but when creating  a\nnew  Client  ID,  select  \"Installed  application\"  of  type  \"Other\". Create a file with the\nfollowing content, and pass its filename in the GOOGLEDRIVESETTINGS environment variable:\nclientconfigbackend: settings\nclientconfig:\nclientid: <Client ID from developers' console>\nclientsecret: <Client secret from developers' console>\nsavecredentials: True\nsavecredentialsbackend: file\nsavecredentialsfile: <filename to cache credentials>\ngetrefreshtoken: True\n\nIn this scenario, the username and host parts of the URL play no role; only the path matters.\nDuring the first run, you will be prompted to visit an URL in your browser to grant access to\nyour drive. Once granted, you will receive a verification code to paste back into  Duplicity.\nThe credentials are then cached in the file references above for future use.\n",
            "subsections": []
        },
        "A NOTE ON RCLONE BACKEND": {
            "content": "Rclone  is  a powerful command line program to sync files and directories to and from various\ncloud storage providers.\n",
            "subsections": [
                {
                    "name": "Usage",
                    "content": "Once you have configured an rclone remote via\n\nrclone config\n\nand successfully set up a remote (e.g. gdrive for Google Drive), assuming you can  list  your\nremote files with\n\nrclone ls gdrive:mydocuments\n\nyou can start your backup with\n\nduplicity /mydocuments rclone://gdrive:/mydocuments\n\nPlease note the slash after the second colon. Some storage provider will work with or without\nslash after colon, but some other will not. Since duplicity will complain about malformed URL\nif  a slash is not present, always put it after the colon, and the backend will handle it for\nyou.\n"
                },
                {
                    "name": "Options",
                    "content": "Note that all rclone options can be set by env vars as well. This is properly documented here\n\nhttps://rclone.org/docs/\n\nbut in a nutshell you need to take the long option name, strip the leading --, change - to ,\nmake upper case and prepend RCLONE. for example\n\nthe equivalent of '--stats 5s' would be the env var RCLONESTATS=5s\n"
                }
            ]
        },
        "A NOTE ON SLATE BACKEND": {
            "content": "Three environment variables are used with the slate backend:\n1.  `SLATEAPIKEY` - Your slate API key\n2.  `SLATESSLVERIFY` - either '1'(True) or '0'(False) for ssl  verification  (optional  -\nTrue by default)\n3.   `PASSPHRASE`  - your gpg passhprase for encryption (optional - will be prompted if not\nset or not used at all if using the `--no-encryption` parameter)\n\nTo use the slate backend, use the following scheme:\nslate://[slate-id]\n\ne.g. Full backup of current directory to slate:\nduplicity full . \"slate://6920df43-5c3w-2x7i-69aw-2390567uav75\"\n\nHere's                                        a                                         demo:\nhttps://gitlab.com/Shr1ftyy/duplicity/uploads/675664ef0eb431d14c8e20045e3fafb6/slatedemo.mp4\n",
            "subsections": []
        },
        "A NOTE ON SSH BACKENDS": {
            "content": "The  ssh  backends  support  sftp  and  scp/ssh  transport  protocols.  This is a known user-\nconfusing issue as these are fundamentally different.  If you plan to access your backend via\none of those please inform yourself about the requirements for a server to  support  sftp  or\nscp/ssh  access.   To  make  it  even  more confusing the user can choose between several ssh\nbackends via a scheme prefix: paramiko+ (default), pexpect+, lftp+... .\nparamiko & pexpect support --use-scp, --ssh-askpass  and  --ssh-options.   Only  the  pexpect\nbackend allows one to define --scp-command and --sftp-command.",
            "subsections": [
                {
                    "name": "SSH  paramiko  backend  (default)",
                    "content": "python. Advantages are speed and maintainability. Minor disadvantage is that  extra  packages\nare needed as listed in REQUIREMENTS.  In sftp (default) mode all operations are done via the\naccording  sftp  commands.  In  scp  mode ( --use-scp ) though scp access is used for put/get\noperations but listing is done via ssh remote shell.\nSSH pexpect backend is the legacy ssh  backend  using  the  command  line  ssh  binaries  via\npexpect.   Older  versions  used  scp for get and put operations and sftp for list and delete\noperations.  The current version uses sftp for all  four  supported  operations,  unless  the\n--use-scp option is used to revert to old behavior.\nSSH  lftp  backend  is simply there because lftp can interact with the ssh cmd line binaries.\nIt is meant as a last resort in case the above options fail for some reason.\n"
                },
                {
                    "name": "Why use sftp instead of scp?",
                    "content": "The change to sftp was made in order to allow the remote system to chroot  the  backup,  thus\nproviding  better security and because it does not suffer from shell quoting issues like scp.\nScp also does not support any kind of file listing, so sftp or  ssh  access  will  always  be\nneeded  in  addition  for  this  backend  mode  to  work  properly.  Sftp does not have these\nlimitations but needs an sftp service running on the backend server, which is  sometimes  not\nan option.\n"
                }
            ]
        },
        "A NOTE ON SSL CERTIFICATE VERIFICATION": {
            "content": "Certificate  verification  as  implemented  right  now  [02.2016] only in the webdav and lftp\nbackends. older pythons 2.7.8- and  older  lftp  binaries  need  a  file  based  database  of\ncertification authority certificates (cacert file).\nNewer  python 2.7.9+ and recent lftp versions however support the system default certificates\n(usually in /etc/ssl/certs) and also giving an alternative ca cert folder  via  --ssl-cacert-\npath.\nThe  cacert  file  has  to  be  a  PEM  formatted text file as currently provided by the CURL\nproject. See\nhttp://curl.haxx.se/docs/caextract.html\nAfter creating/retrieving a valid cacert file you should copy it to either\n~/.duplicity/cacert.pem\n~/duplicitycacert.pem\n/etc/duplicity/cacert.pem\nDuplicity searches it there in the same order and will fail if it can't  find  it.   You  can\nhowever  specify  the  option  --ssl-cacert-file  <file>  to  point  duplicity to a copy in a\ndifferent location.\nFinally there is the --ssl-no-check-certificate option to  disable  certificate  verification\naltogether,  in  case  some ssl library is missing or verification is not wanted. Use it with\ncare, as even with self signed servers manually  providing  the  private  ca  certificate  is\ndefinitely the safer option.\n\nA NOTE ON SWIFT (OPENSTACK OBJECT STORAGE) ACCESS\nSwift is the OpenStack Object Storage service.\nThe  backend requires python-switclient to be installed on the system.  python-keystoneclient\nis also needed to use OpenStack's Keystone Identity service.  See REQUIREMENTS.\n\nIt uses following environment variables for authentication:\n",
            "subsections": [
                {
                    "name": "SWIFT_USERNAME (required),",
                    "content": ""
                },
                {
                    "name": "SWIFT_PASSWORD (required),",
                    "content": ""
                },
                {
                    "name": "SWIFT_AUTHURL (required),",
                    "content": "SWIFTTENANTID   or   SWIFTTENANTNAME   (required   with   SWIFTAUTHVERSION=2,   can\nalternatively       be       defined       in       SWIFTUSERNAME      like      e.g.\nSWIFTUSERNAME=\"tenantname:user\"),\nSWIFTPROJECTID or SWIFTPROJECTNAME (required with SWIFTAUTHVERSION=3),\nSWIFTUSERID (optional, required only for IBM Bluemix ObjectStorage),"
                },
                {
                    "name": "SWIFT_REGIONNAME (optional)",
                    "content": "If the user was previously authenticated, the following environment  variables  can  be  used\ninstead: SWIFTPREAUTHURL (required), SWIFTPREAUTHTOKEN (required)\n\nIf SWIFTAUTHVERSION is unspecified, it will default to version 1.\n"
                }
            ]
        },
        "A NOTE ON SYMMETRIC ENCRYPTION AND SIGNING": {
            "content": "Signing  and  symmetrically encrypt at the same time with the gpg binary on the command line,\nas used within duplicity, is  a  specifically  challenging  issue.   Tests  showed  that  the\nfollowing combinations proved working.\n1. Setup gpg-agent properly. Use the option --use-agent and enter both passphrases (symmetric\nand sign key) in the gpg-agent's dialog.\n2.  Use a PASSPHRASE for symmetric encryption of your choice but the signing key has an empty\npassphrase.\n3. The used PASSPHRASE for symmetric encryption and the passphrase of  the  signing  key  are\nidentical.\n",
            "subsections": []
        },
        "A NOTE ON THE XORRISO BACKEND": {
            "content": "This backend uses the xorriso tool to append backups to optical media or ISO9660 images.\n\nUse the following environment variables for more settings:\nXORRISOPATH, set an alternative path to the xorriso executable\nXORRISOWRITESPEED,  specify  the speed for writing to the optical disc. One of [min,\nmax]\nXORRISOASSERTVOLID, specify the required volume ID  of  the  ISO.  Aborts  when  the\nactual volume ID is different.\nXORRISOARGS,  for  expert  use  only.  Pass  arbitrary arguments to xorriso. Example:\nXORRISOARGS='-md5 all'\n",
            "subsections": []
        },
        "KNOWN ISSUES / BUGS": {
            "content": "Hard links currently unsupported (they will be treated as non-linked regular files).\n\nBad signatures will be treated as empty instead of logging appropriate error message.\n",
            "subsections": []
        },
        "OPERATION AND DATA FORMATS": {
            "content": "This section describes duplicity's basic operation and the format  of  its  data  files.   It\nshould not be necessary to read this section to use duplicity.\n\nThe  files  used  by  duplicity  to  store  backup  data are tarfiles in GNU tar format.  For\nincremental backups, new files are saved normally in the tarfile.  But when a  file  changes,\ninstead  of  storing  a  complete  copy  of  the file, only a diff is stored, as generated by\nrdiff(1).  If a file is deleted, a 0 length file is stored in the tar.   It  is  possible  to\nrestore  a duplicity archive \"manually\" by using tar and then cp, rdiff, and rm as necessary.\nThese duplicity archives have the extension difftar.\n\nBoth full and incremental backup sets have the same format.  In effect, a full backup set  is\nan  incremental  one generated from an empty signature (see below).  The files in full backup\nsets will start with duplicity-full while the  incremental  sets  start  with  duplicity-inc.\nWhen  restoring, duplicity applies patches in order, so deleting, for instance, a full backup\nset may make related incremental backup sets unusable.\n\nIn order to determine which files have been deleted,  and  to  calculate  diffs  for  changed\nfiles,  duplicity  needs  to  process  information  about  previous sessions.  It stores this\ninformation in the form of tarfiles where  each  entry's  data  contains  the  signature  (as\nproduced by rdiff) of the file instead of the file's contents.  These signature sets have the\nextension sigtar.\n\nSignature  files  are  not  required  to  restore  a  backup  set,  but without an up-to-date\nsignature, duplicity cannot append an incremental backup to an existing archive.\n\nTo save bandwidth, duplicity generates full signature sets and incremental signature sets.  A\nfull signature set is generated for each  full  backup,  and  an  incremental  one  for  each\nincremental  backup.  These start with duplicity-full-signatures and duplicity-new-signatures\nrespectively. These signatures  will  be  stored  both  locally  and  remotely.   The  remote\nsignatures  will  be  encrypted  if  encryption is enabled.  The local signatures will not be\nencrypted and stored in the archive dir (see --archive-dir ).\n",
            "subsections": []
        },
        "REQUIREMENTS": {
            "content": "Duplicity requires a POSIX-like operating system  with  a  python  interpreter  version  3.8+\ninstalled.  It is best used under GNU/Linux.\n\nSome  backends  also  require  additional components (probably available as packages for your\nspecific platform):\n",
            "subsections": [
                {
                    "name": "Amazon Drive backend",
                    "content": "python-requests - http://python-requests.org\npython-requests-oauthlib - https://github.com/requests/requests-oauthlib\n\nazure backend (Azure Storage Blob Service)\nMicrosoft    Azure    Storage    Blobs     client     library     for     Python     -\nhttps://pypi.org/project/azure-storage-blob/\n\nboto3 backend (S3 Amazon Web Services, Google Cloud Storage) (default)\nboto3 version 1.x - https://github.com/boto/boto3\n\nbox backend (box.com)\nboxsdk - https://github.com/box/box-python-sdk\n\ncfpyrax backend (Rackspace Cloud) and hubic backend (hubic.com)\nRackspace               CloudFiles               Pyrax              API              -\nhttp://docs.rackspace.com/sdks/guide/content/python.html\n\ndpbx backend (Dropbox)\nDropbox Python SDK - https://www.dropbox.com/developers/reference/sdk\n"
                },
                {
                    "name": "gdocs gdata backend (legacy)",
                    "content": "Google Data APIs Python Client Library - http://code.google.com/p/gdata-python-client/\n"
                },
                {
                    "name": "gdocs pydrive backend(default)",
                    "content": "see pydrive backend\n\ngio backend (Gnome VFS API)\nPyGObject - http://live.gnome.org/PyGObject"
                },
                {
                    "name": "D-Bus (dbus)",
                    "content": "lftp backend (needed for ftp, ftps, fish [over ssh] - also supports sftp, webdav[s])\nLFTP Client - http://lftp.yar.ru/\n\nMEGA backend (only works for accounts created prior to November 2018) (mega.nz)\nmegatools client - https://github.com/megous/megatools\n\nMEGA v2 and v3 backend (works for all MEGA accounts) (mega.nz)\nMEGAcmd client - https://mega.nz/cmd\n"
                },
                {
                    "name": "multi backend",
                    "content": "Multi -- store to more than one backend\n(also see A NOTE ON MULTI BACKEND ) below.\n\nncftp backend (ftp, select via ncftp+ftp://)\nNcFTP - http://www.ncftp.com/\n\nOneDrive backend (Microsoft OneDrive)\npython-requests-oauthlib - https://github.com/requests/requests-oauthlib\n"
                },
                {
                    "name": "Par2 Wrapper Backend",
                    "content": "par2cmdline - http://parchive.sourceforge.net/\n"
                },
                {
                    "name": "pydrive backend",
                    "content": "PyDrive     --     a     wrapper     library     of     google-api-python-client     -\nhttps://pypi.python.org/pypi/PyDrive\n(also see A NOTE ON PYDRIVE BACKEND ) below.\n"
                },
                {
                    "name": "rclone backend",
                    "content": "rclone - https://rclone.org/\n"
                },
                {
                    "name": "rsync backend",
                    "content": "rsync client binary - http://rsync.samba.org/\n"
                },
                {
                    "name": "ssh paramiko backend (default)",
                    "content": "paramiko   (SSH2   for  python)  -  http://pypi.python.org/pypi/paramiko  (downloads);\nhttp://github.com/paramiko/paramiko (project page)\npycrypto (Python Cryptography Toolkit) - http://www.dlitz.net/software/pycrypto/\n"
                },
                {
                    "name": "ssh pexpect backend(legacy)",
                    "content": "sftp/scp client binaries OpenSSH - http://www.openssh.com/\nPython pexpect module - http://pexpect.sourceforge.net/pexpect.html\n"
                },
                {
                    "name": "swift backend (OpenStack Object Storage)",
                    "content": "Python swiftclient module - https://github.com/openstack/python-swiftclient/\nPython keystoneclient module - https://github.com/openstack/python-keystoneclient/\n"
                },
                {
                    "name": "webdav backend",
                    "content": "certificate  authority  database  file  for  ssl  certificate  verification  of  HTTPS\nconnections - http://curl.haxx.se/docs/caextract.html\n(also see A NOTE ON SSL CERTIFICATE VERIFICATION).\nPython       kerberos       module       for       kerberos      authentication      -\nhttps://github.com/02strich/pykerberos\n"
                },
                {
                    "name": "MediaFire backend",
                    "content": "MediaFire Python Open SDK - https://pypi.python.org/pypi/mediafire/\n"
                },
                {
                    "name": "xorriso backend",
                    "content": "xorriso - https://www.gnu.org/software/xorriso/\n"
                }
            ]
        },
        "AUTHOR": {
            "content": "Original Author - Ben Escoto <bescoto@stanford.edu>\n\nCurrent Maintainer - Kenneth Loafman <kenneth@loafman.com>\n",
            "subsections": [
                {
                    "name": "Continuous Contributors",
                    "content": "Edgar Soldin, Mike Terry\nMost backends were contributed individually.  Information about their authorship may be found\nin the according file's header.\nAlso we'd like to thank everybody posting issues to the mailing list or on launchpad, sending\nin patches or contributing otherwise. Duplicity wouldn't  be  as  stable  and  useful  if  it\nweren't for you.\nA  special  thanks  goes  to  rsync.net,  a  Cloud Storage provider with explicit support for\nduplicity, for several monetary donations and for providing  a  special  \"duplicity  friends\"\nrate for their offsite backup service.  Email info@rsync.net for details.\n"
                }
            ]
        },
        "SEE ALSO": {
            "content": "python(1), rdiff(1), rdiff-backup(1).\n\nVersion 2.1.4                              March 31, 2024                               DUPLICITY(1)",
            "subsections": []
        }
    },
    "summary": "duplicity - Encrypted incremental backup to local or remote storage.",
    "flags": [
        {
            "flag": "",
            "long": "--allow-source-mismatch",
            "arg": null,
            "description": "Do not abort on attempts to use the same archive dir or remote backend to back up different directories. duplicity will tell you if you need this switch. --archive-dir path The archive directory. NOTE: This option changed in 0.6.0. The archive directory is now necessary in order to manage persistence for current and future enhancements. As such, this option is now used only to change the location of the archive directory. The archive directory should not be deleted, or duplicity will have to recreate it from the remote repository (which may require decrypting the backup contents). When backing up or restoring, this option specifies that the local archive directory is to be created in path. If the archive directory is not specified, the default will be to create the archive directory in ~/.cache/duplicity/. The archive directory can be shared between backups to multiple targets, because a subdirectory of the archive dir is used for individual backups (see --name ). The combination of archive directory and backup name must be unique in order to separate the data of different backups. The interaction between the --archive-dir and the --name options allows for four possible combinations for the location of the archive dir: 1. neither specified (default) ~/.cache/duplicity/hash-of-url 2. --archive-dir=/arch, no --name /arch/hash-of-url 3. no --archive-dir, --name=foo ~/.cache/duplicity/foo 4. --archive-dir=/arch, --name=foo /arch/foo"
        },
        {
            "flag": "",
            "long": "--asynchronous-upload",
            "arg": null,
            "description": "(EXPERIMENTAL) Perform file uploads asynchronously in the background, with respect to volume creation. This means that duplicity can upload a volume while, at the same time, preparing the next volume for upload. The intended end-result is a faster backup, because the local CPU and your bandwidth can be more consistently utilized. Use of this option implies additional need for disk space in the temporary storage location; rather than needing to store only one volume at a time, enough storage space is required to store two volumes."
        },
        {
            "flag": "",
            "long": "--azure-blob-tier",
            "arg": null,
            "description": "Standard storage tier used for backup files (Hot|Cool|Archive)."
        },
        {
            "flag": "",
            "long": "--azure-max-single-put-size",
            "arg": null,
            "description": "Specify the number of the largest supported upload size where the Azure library makes only one put call. If the content size is known and below this value the Azure library will only perform one put request to upload one block. The number is expected to be in bytes."
        },
        {
            "flag": "",
            "long": "--azure-max-block-size",
            "arg": null,
            "description": "Specify the number for the block size used by the Azure library to upload blobs if it is split into multiple blocks. The maximum block size the service supports is 104857600 (100MiB) and the default is 4194304 (4MiB)"
        },
        {
            "flag": "",
            "long": "--azure-max-connections",
            "arg": null,
            "description": "Specify the number of maximum connections to transfer one blob to Azure blob size exceeds 64MB. The default values is 2."
        },
        {
            "flag": "",
            "long": "--b2-hide-files",
            "arg": null,
            "description": "Causes Duplicity to hide files in B2 instead of deleting them. Useful in combination with B2's lifecycle rules. --backend-retry-delay number Specifies the number of seconds that duplicity waits after an error has occurred before attempting to repeat the operation. --cf-backend backend Allows the explicit selection of a cloudfiles backend. Defaults to pyrax. Alternatively you might choose cloudfiles. --config-dir path Allows selection of duplicity's configuratin dir. Defaults to ~/.config/duplicity. --copy-blocksize kilos Allows selection of blocksize in kilobytes to use in copying. Increasing this may speed copying of large files. Defaults to 128."
        },
        {
            "flag": "",
            "long": "--no-check-remote",
            "arg": null,
            "description": "Turn off validation of the remote manifest. Checking is the default. No checking will allow you to backup without the private key, but will mean that the remote manifest may exist and be corrupted, leading to the possibility that the backup might not be recoverable."
        },
        {
            "flag": "",
            "long": "--compare-data",
            "arg": null,
            "description": "Enable data comparison of regular files on action verify. This conducts a verify as described above to verify the integrity of the backup archives, but additionally compares restored files to those in targetdirectory. Duplicity will not replace any files in targetdirectory. Duplicity will exit with a non-zero error level if the files do not correctly verify or if any files from the archive differ from those in targetdirectory. On verbosity level 4 or higher, it will log a message for each file that differs from its equivalent in targetdirectory."
        },
        {
            "flag": "",
            "long": "--copy-links",
            "arg": null,
            "description": "Resolve symlinks during backup. Enabling this will resolve & back up the symlink's file/folder data instead of the symlink itself, potentially increasing the size of the backup."
        },
        {
            "flag": "",
            "long": "--dry-run",
            "arg": null,
            "description": "Calculate what would be done, but do not perform any backend actions --encrypt-key key-id When backing up, encrypt to the given public key, instead of using symmetric (traditional) encryption. Can be specified multiple times. The key-id can be given in any of the formats supported by GnuPG; see gpg(1), section \"HOW TO SPECIFY A USER ID\" for details. --encrypt-secret-keyring filename This option can only be used with --encrypt-key, and changes the path to the secret keyring for the encrypt key to filename This keyring is not used when creating a backup. If not specified, the default secret keyring is used which is usually located at .gnupg/secring.gpg --encrypt-sign-key key-id Convenience parameter. Same as --encrypt-key key-id --sign-key key-id. --exclude shellpattern Exclude the file or files matched by shellpattern. If a directory is matched, then files under that directory will also be matched. See the FILE SELECTION section for more information."
        },
        {
            "flag": "",
            "long": "--exclude-device-files",
            "arg": null,
            "description": "Exclude all device files. This can be useful for security/permissions reasons or if duplicity is not handling device files correctly. --exclude-filelist filename Excludes the files listed in filename, with each line of the filelist interpreted according to the same rules as --include and --exclude. See the FILE SELECTION section for more information. --exclude-if-present filename Exclude directories if filename is present. Allows the user to specify folders that they do not wish to backup by adding a specified file (e.g. \".nobackup\") instead of maintaining a comprehensive exclude/include list. --exclude-older-than time Exclude any files whose modification date is earlier than the specified time. This can be used to produce a partial backup that contains only recently changed files. See the TIME FORMATS section for more information."
        },
        {
            "flag": "",
            "long": "--exclude-other-filesystems",
            "arg": null,
            "description": "Exclude files on file systems (identified by device number) other than the file system the root of the source directory is on. --exclude-regexp regexp Exclude files matching the given regexp. Unlike the --exclude option, this option does not match files in a directory it matches. See the FILE SELECTION section for more information. --files-from filename Read a list of files to backup from filename rather than searching the entire backup source directory. Operation is otherwise normal, just on the specified subset of the backup source directory. Files must be specified one per line and relative to the backup source directory. Any absolute paths will raise an error. All characters per line are significant and treated as part of the path, including leading and trailing whitespace. Lines are separated by newlines or nulls, depending on whether the --null-separator switch was given. It is not necessary to include the parent directory of listed files, their inclusion is implied. However, the content of any explicitly listed directories is not implied. All required files must be listed when this option is used. --file-prefix prefix --file-prefix-manifest prefix --file-prefix-archive prefix --file-prefix-signature prefix Adds a prefix to either all files or only manifest, archive, signature files. The same set of prefixes must be passed in on backup and restore. If both global and type-specific prefixes are set, global prefix will go before type- specific prefixes. See also A NOTE ON FILENAME PREFIXES --path-to-restore path This option may be given in restore mode, causing only path to be restored instead of the entire contents of the backup archive. path should be given relative to the root of the directory backed up."
        },
        {
            "flag": "",
            "long": "--filter-globbing",
            "arg": null,
            "description": ""
        },
        {
            "flag": "",
            "long": "--filter-ignorecase",
            "arg": null,
            "description": ""
        },
        {
            "flag": "",
            "long": "--filter-literal",
            "arg": null,
            "description": ""
        },
        {
            "flag": "",
            "long": "--filter-regexp",
            "arg": null,
            "description": ""
        },
        {
            "flag": "",
            "long": "--filter-strictcase",
            "arg": null,
            "description": "Change the interpretation of patterns passed to the file selection condition option arguments --exclude and --include (and variations thereof, including file lists). These options can appear multiple times to switch between shell globbing (default), literal strings, and regular expressions, case sensitive (default) or not. The specified interpretation applies for all subsequent selection conditions up until the next --filter option. See the FILE SELECTION section for more information. --full-if-older-than time Perform a full backup if an incremental backup is requested, but the latest full backup in the collection is older than the given time. See the TIME FORMATS section for more information."
        },
        {
            "flag": "",
            "long": "--force",
            "arg": null,
            "description": "Proceed even if data loss might result. Duplicity will let the user know when this option is required."
        },
        {
            "flag": "",
            "long": "--ftp-passive",
            "arg": null,
            "description": "Use passive (PASV) data connections. The default is to use passive, but to fallback to regular if the passive connection fails or times out."
        },
        {
            "flag": "",
            "long": "--ftp-regular",
            "arg": null,
            "description": "Use regular (PORT) data connections. --gio Use the GIO backend and interpret any URLs as GIO would. --gpg-binary filepath Allows you to force duplicity to use filepath as gpg command line binary. Can be an absolute or relative file path or a file name. Default value is 'gpg'. The binary will be localized via the PATH environment variable. --gpg-options options Allows you to pass options to gpg encryption. The options list should be of the form \"--opt1 --opt2=parm\" where the string is quoted and the only spaces allowed are between options. --hidden-encrypt-key key-id Same as --encrypt-key, but it hides user's key id from encrypted file. It uses the gpg's --hidden-recipient command to obfuscate the owner of the backup. On restore, gpg will automatically try all available secret keys in order to decrypt the backup. See gpg(1) for more details."
        },
        {
            "flag": "",
            "long": "--ignore-errors",
            "arg": null,
            "description": "Try to ignore certain errors if they happen. This option is only intended to allow the restoration of a backup in the face of certain problems that would otherwise cause the backup to fail. It is not ever recommended to use this option unless you have a situation where you are trying to restore from backup and it is failing because of an issue which you want duplicity to ignore. Even then, depending on the issue, this option may not have an effect. Please note that while ignored errors will be logged, there will be no summary at the end of the operation to tell you what was ignored, if anything. If this is used for emergency restoration of data, it is recommended that you run the backup in such a way that you can revisit the backup log (look for lines containing the string IGNOREDERROR). If you ever have to use this option for reasons that are not understood or understood but not your own responsibility, please contact duplicity maintainers. The need to use this option under production circumstances would normally be considered a bug. --imap-full-address emailaddress The full email address of the user name when logging into an imap server. If not supplied just the user name part of the email address is used. --imap-mailbox option Allows you to specify a different mailbox. The default is \"INBOX\". Other languages may require a different mailbox than the default."
        },
        {
            "flag": "",
            "long": "--idr-fakeroot",
            "arg": null,
            "description": "idrived uses the concept of a \"fakeroot\" directory, defined via the --idr-fakeroot=... switch. This can be an existing directory, or the directory is created at runtime on the root of the (host) files system. (caveat: you have to have write access to the root!). Directories created at runtime are auto-removed on exit! So, in the above scheme, we could do: duplicity --idr-fakeroot=nicepath idrived://DUPLICITY our files end-up at <MYBUCKET>/DUPLICITY/nicepath"
        },
        {
            "flag": "",
            "long": "--idr-fakeroot",
            "arg": null,
            "description": "idrived uses the concept of a \"fakeroot\" directory, defined via the --idr-fakeroot=... switch. This can be an existing directory, or the directory is created at runtime on the root of the (host) files system. (caveat: you have to have write access to the root!). Directories created at runtime are auto-removed on exit! So, in the above scheme, we could do: duplicity --idr-fakeroot=nicepath idrived://DUPLICITY our files end-up at <MYBUCKET>/DUPLICITY/nicepath --include shellpattern Similar to --exclude but include matched files instead. Unlike --exclude, this option will also match parent directories of matched files (although not necessarily their contents). See the FILE SELECTION section for more information. --include-filelist filename Like --exclude-filelist, but include the listed files instead. See the FILE SELECTION section for more information. --include-regexp regexp Include files matching the regular expression regexp. Only files explicitly matched by regexp will be included by this option. See the FILE SELECTION section for more information."
        },
        {
            "flag": "",
            "long": "--jsonstat",
            "arg": null,
            "description": "Record statistic data similar to the default stats printed at the end of a backup job, addtional it includes some meta data about the backup chain e.g. when the full backup was created and how many incremental backups were made before. Output format is json. It written to stdout at notice level (as classic stats) and the statistics are kept as a separte file next to the manifest but with \"jsonstat\" as extension. collection- status --show-changes-in-set <index> --jsonstat adds data collected in the backup job and switch the output format to json. If <index> is set to -1 statistics for the whole backup chain are printed. --log-fd number Write specially-formatted versions of output messages to the specified file descriptor. The format used is designed to be easily consumable by other programs. --log-file filename Write specially-formatted versions of output messages to the specified file. The format used is designed to be easily consumable by other programs."
        },
        {
            "flag": "",
            "long": "--log-timestamp",
            "arg": null,
            "description": "Write the log with timestamp and log level before the message, similar to syslog. --max-blocksize number determines the number of the blocks examined for changes during the diff process. For files < 1MB the blocksize is a constant of 512. For files over 1MB the size is given by: fileblocksize = int((filelen / (2000 * 512)) * 512) return min(fileblocksize, config.maxblocksize) where config.maxblocksize defaults to 2048. If you specify a larger maxblocksize, your difftar files will be larger, but your sigtar files will be smaller. If you specify a smaller maxblocksize, the reverse occurs. The --max-blocksize option should be in multiples of 512."
        },
        {
            "flag": "",
            "long": "--mf-purge",
            "arg": null,
            "description": "Option for mediafire to purge files on delete instead of sending to trash. --mp-segment-size megs Swift backend segment size in megabytes --name symbolicname Set the symbolic name of the backup being operated on. The intent is to use a separate name for each logically distinct backup. For example, someone may use \"homedailys3\" for the daily backup of a home directory to Amazon S3. The structure of the name is up to the user, it is only important that the names be distinct. The symbolic name is currently only used to affect the expansion of --archive-dir , but may be used for additional features in the future. Users running more than one distinct backup are encouraged to use this option. If not specified, the default value is a hash of the backend URL."
        },
        {
            "flag": "",
            "long": "--no-check-remote",
            "arg": null,
            "description": "Turn off validation of the remote manifest. Checking is the default. No checking will allow you to backup without the private key, but will mean that the remote manifest may exist and be corrupted, leading to the possibility that the backup might not be recoverable."
        },
        {
            "flag": "",
            "long": "--no-compression",
            "arg": null,
            "description": "Do not use GZip to compress files on remote system."
        },
        {
            "flag": "",
            "long": "--no-encryption",
            "arg": null,
            "description": "Do not use GnuPG to encrypt files on remote system."
        },
        {
            "flag": "",
            "long": "--no-print-statistics",
            "arg": null,
            "description": "By default duplicity will print statistics about the current session after a successful backup. This switch disables that behavior."
        },
        {
            "flag": "",
            "long": "--no-files-changed",
            "arg": null,
            "description": "By default duplicity will collect file names and change action in memory (add, del, chg) during backup. This can be quite expensive in memory use, especially with millions of small files. This flag turns off that collection. This means that the --file-changed option for collection-status will return nothing."
        },
        {
            "flag": "",
            "long": "--null-separator",
            "arg": null,
            "description": "Use nulls (\\0) instead of newlines (\\n) as line separators, which may help when dealing with filenames containing newlines. This affects the expected format of the files specified by the --{include|exclude}-filelist switches and the --{files-from} option, as well as the format of the directory statistics file."
        },
        {
            "flag": "",
            "long": "--numeric-owner",
            "arg": null,
            "description": "On restore always use the numeric uid/gid from the archive and not the archived user/group names, which is the default behaviour. Recommended for restoring from live cds which might have the users with identical names but different uids/gids."
        },
        {
            "flag": "",
            "long": "--no-restore-ownership",
            "arg": null,
            "description": "Ignores the uid/gid from the archive and keeps the current user's one. Recommended for restoring data to mounted filesystem which do not support Unix ownership or when root privileges are not available. --num-retries number Number of retries to make on errors before giving up. --par2-options options Verbatim options to pass to par2. --par2-redundancy percent Adjust the level of redundancy in percent for Par2 recovery files (default 10%). --par2-volumes number Number of Par2 volumes to create (default 1)."
        },
        {
            "flag": "",
            "long": "--progress",
            "arg": null,
            "description": "When selected, duplicity will output the current upload progress and estimated upload time. To annotate changes, it will perform a first dry-run before a full or incremental, and then runs the real operation estimating the real upload progress. --progress-rate number Sets the update rate at which duplicity will output the upload progress messages (requires --progress option). Default is to print the status each 3 seconds. --rename <original path> <new path> Treats the path orig in the backup as if it were the path new. Can be passed multiple times. An example: duplicity restore --rename Documents/metal Music/metal sftp://uid@other.host/somedir /home/me --rsync-options options Allows you to pass options to the rsync backend. The options list should be of the form \"opt1=parm1 opt2=parm2\" where the option string is quoted and the only spaces allowed are between options. The option string will be passed verbatim to rsync, after any internally generated option designating the remote port to use. Here is a possibly useful example: duplicity --rsync-options=\"--partial-dir=.rsync-partial\" /home/me rsync://uid@other.host/somedir --s3-endpoint-url url Specifies the endpoint URL of the S3 storage."
        },
        {
            "flag": "",
            "long": "--s3-multipart-chunk-size",
            "arg": null,
            "description": "Chunk size (in MB, default is 20MB) used for S3 multipart uploads. Adjust this to maximize bandwidth usage. For example, a chunk size of 10MB and a volsize of 100MB would result in 10 chunks per volume upload. NOTE: This value should optimally be an even multiple of your --volsize for optimal performance. See also A NOTE ON AMAZON S3 below."
        },
        {
            "flag": "",
            "long": "--s3-multipart-max-procs",
            "arg": null,
            "description": "Maximum number of concurrent uploads when performing a multipart upload. The default is 4. You can adjust this number to maximizing bandwidth and CPU utilization. NOTE: Too many concurrent uploads may have diminishing returns. See also A NOTE ON AMAZON S3 below."
        },
        {
            "flag": "",
            "long": "--s3-region-name",
            "arg": null,
            "description": "Specifies the region of the S3 storage. Usually mandatory if the bucket is created in a specific region."
        },
        {
            "flag": "",
            "long": "--s3-unencrypted-connection",
            "arg": null,
            "description": "Disable SSL for connections to S3. This may be much faster, at some cost to confidentiality. With this option set, anyone between your computer and S3 can observe the traffic and will be able to tell: that you are using Duplicity, the name of the bucket, your AWS Access Key ID, the increment dates and the amount of data in each increment. This option affects only the connection, not the GPG encryption of the backup increment files. Unless that is disabled, an observer will not be able to see the file names or contents. See also A NOTE ON AMAZON S3 below."
        },
        {
            "flag": "",
            "long": "--s3-use-deep-archive",
            "arg": null,
            "description": "Store volumes using Glacier Deep Archive S3 when uploading to Amazon S3. This storage class has a lower cost of storage but a higher per-request cost along with delays of up to 48 hours from the time of retrieval request. This storage cost is calculated against a 180-day storage minimum. According to Amazon this storage is ideal for data archiving and long-term backup offering 99.999999999% durability. To restore a backup you will have to manually migrate all data stored on AWS Glacier Deep Archive back to Standard S3 and wait for AWS to complete the migration. NOTE: Duplicity will store the manifest.gpg and sigtar.gpg files from full and incremental backups on AWS S3 standard storage to allow quick retrieval for later incremental backups, all other data is stored in S3 Glacier Deep Archive."
        },
        {
            "flag": "",
            "long": "--s3-use-glacier",
            "arg": null,
            "description": "Store volumes using Glacier Flexible Storage when uploading to Amazon S3. This storage class has a lower cost of storage but a higher per-request cost along with delays of up to 12 hours from the time of retrieval request. This storage cost is calculated against a 90-day storage minimum. According to Amazon this storage is ideal for data archiving and long-term backup offering 99.999999999% durability. To restore a backup you will have to manually migrate all data stored on AWS Glacier back to Standard S3 and wait for AWS to complete the migration. NOTE: Duplicity will store the manifest.gpg and sigtar.gpg files from full and incremental backups on AWS S3 standard storage to allow quick retrieval for later incremental backups, all other data is stored in S3 Glacier."
        },
        {
            "flag": "",
            "long": "--s3-use-glacier-ir",
            "arg": null,
            "description": "Store volumes using Glacier Instant Retrieval when uploading to Amazon S3. This storage class is similar to Glacier Flexible Storage but offers instant retrieval at standard speeds. NOTE: Duplicity will store the manifest.gpg and sigtar.gpg files from full and incremental backups on AWS S3 standard storage to allow quick retrieval for later incremental backups, all other data is stored in S3 Glacier."
        },
        {
            "flag": "",
            "long": "--s3-use-ia",
            "arg": null,
            "description": "Store volumes using Standard - Infrequent Access when uploading to Amazon S3. This storage class has a lower storage cost but a higher per-request cost, and the storage cost is calculated against a 30-day storage minimum. According to Amazon, this storage is ideal for long-term file storage, backups, and disaster recovery."
        },
        {
            "flag": "",
            "long": "--s3-use-onezone-ia",
            "arg": null,
            "description": "Store volumes using One Zone - Infrequent Access when uploading to Amazon S3. This storage is similar to Standard - Infrequent Access, but only stores object data in one Availability Zone."
        },
        {
            "flag": "",
            "long": "--s3-use-rrs",
            "arg": null,
            "description": "Store volumes using Reduced Redundancy Storage when uploading to Amazon S3. This will lower the cost of storage but also lower the durability of stored volumes to 99.99% instead the 99.999999999% durability offered by Standard Storage on S3."
        },
        {
            "flag": "",
            "long": "--s3-use-server-side-kms-encryption",
            "arg": null,
            "description": "--s3-kms-key-id keyid --s3-kms-grant grant Enable server-side encryption using key management service. --skip-if-no-change command By default an empty incremental backup is created if no files have changed. Setting this option will skip creating a backup if no data has changed. Nothing will be sent to the target nor information be cached. --scp-command command (only ssh pexpect backend with --use-scp enabled) The command will be used instead of \"scp\" to send or receive files. To list and delete existing files, the sftp command is used. See also A NOTE ON SSH BACKENDS section SSH pexpect backend. --sftp-command command (only ssh pexpect backend) The command will be used instead of \"sftp\". See also A NOTE ON SSH BACKENDS section SSH pexpect backend. --sign-key key-id This option can be used when backing up, restoring or verifying. When backing up, all backup files will be signed with keyid key. When restoring, duplicity will signal an error if any remote file is not signed with the given key-id. The key-id can be given in any of the formats supported by GnuPG; see gpg(1), section \"HOW TO SPECIFY A USER ID\" for details. Should be specified only once because currently only one signing key is supported. Last entry overrides all other entries. See also A NOTE ON SYMMETRIC ENCRYPTION AND SIGNING"
        },
        {
            "flag": "",
            "long": "--ssh-askpass",
            "arg": null,
            "description": "Tells the ssh backend to prompt the user for the remote system password, if it was not defined in target url and no FTPPASSWORD env var is set. This password is also used for passphrase-protected ssh keys. --ssh-options options Allows you to pass options to the ssh backend. Can be specified multiple times or as a space separated options list. The options list should be of the form \"-oOpt1='parm1' -oOpt2='parm2'\" where the option string is quoted and the only spaces allowed are between options. The option string will be passed verbatim to both scp and sftp, whose command line syntax differs slightly hence the options should therefore be given in the long option format described in sshconfig(5). example of a list: duplicity --ssh-options=\"-oProtocol=2 -oIdentityFile='/my/backup/id'\" /home/me scp://user@host/somedir example with multiple parameters: duplicity --ssh-options=\"-oProtocol=2\" --ssh- options=\"-oIdentityFile='/my/backup/id'\" /home/me scp://user@host/somedir NOTE: The ssh paramiko backend currently supports only the -i or -oIdentityFile or -oUserKnownHostsFile or -oGlobalKnownHostsFile settings. If needed provide more host specific options via sshconfig file. --ssl-cacert-file file (only webdav & lftp backend) Provide a cacert file for ssl certificate verification. See also A NOTE ON SSL CERTIFICATE VERIFICATION. --ssl-cacert-path path/to/certs/ (only webdav backend and python 2.7.9+ OR lftp+webdavs and a recent lftp) Provide a path to a folder containing cacert files for ssl certificate verification. See also A NOTE ON SSL CERTIFICATE VERIFICATION."
        },
        {
            "flag": "",
            "long": "--ssl-no-check-certificate",
            "arg": null,
            "description": "(only webdav & lftp backend) Disable ssl certificate verification. See also A NOTE ON SSL CERTIFICATE VERIFICATION."
        },
        {
            "flag": "",
            "long": "--swift-storage-policy",
            "arg": null,
            "description": "Use this storage policy when operating on Swift containers. See also A NOTE ON SWIFT (OPENSTACK OBJECT STORAGE) ACCESS. --metadata-sync-mode mode This option defaults to 'partial', but you can set it to 'full' Use 'partial' to avoid syncing metadata for backup chains that you are not going to use. This saves time when restoring for the first time, and lets you restore an old backup that was encrypted with a different passphrase by supplying only the target passphrase. Use 'full' to sync metadata for all backup chains on the remote. --tempdir directory Use this existing directory for duplicity temporary files instead of the system default, which is usually the /tmp directory. This option supersedes any environment variable. See also ENVIRONMENT VARIABLES."
        },
        {
            "flag": "-t",
            "long": null,
            "arg": null,
            "description": "Specify the time from which to restore or list files. See section TIME FORMATS for details. --time-separator char Use char as the time separator in filenames instead of colon (\":\"). NOTE: This option only applies to recovery and status style actions. We no longer create or write filenames with time separators, but will read older backups that may need this option. --timeout seconds Use seconds as the socket timeout value if duplicity begins to timeout during network operations. The default is 30 seconds."
        },
        {
            "flag": "",
            "long": "--use-agent",
            "arg": null,
            "description": "If this option is specified, then --use-agent is passed to the GnuPG encryption process and it will try to connect to gpg-agent before it asks for a passphrase for --encrypt-key or --sign-key if needed. NOTE: Contrary to previous versions of duplicity, this option will also be honored by GnuPG 2 and newer versions. If GnuPG 2 is in use, duplicity passes the option --pinentry-mode=loopback to the the gpg process unless --use-agent is specified on the duplicity command line. This has the effect that GnuPG 2 uses the agent only if --use- agent is given, just like GnuPG 1. --verbosity level, -vlevel Specify output verbosity level (log level). Named levels and corresponding values are 0 Error, 2 Warning, 4 Notice (default), 8 Info, 9 Debug (noisiest). level may also be a character: e, w, n, i, d a word: error, warning, notice, info, debug The options -v4, -vn and -vnotice are functionally equivalent, as are the mixed/upper- case versions -vN, -vNotice and -vNOTICE."
        },
        {
            "flag": "",
            "long": "--version",
            "arg": null,
            "description": "Print duplicity's version and quit. --volsize number Change the volume size to number MB. Default is 200MB. --webdav-headers csv formatted key,value pairs The input format is comma separated list of key,value pairs. Standard CSV encoding may be used. For example to set a Cookie use 'Cookie,name=value', or '\"Cookie\",\"name=value\"'. You can set multiple headers, e.g. '\"Cookie\",\"name=value\",\"Authorization\",\"xxx\"'."
        }
    ],
    "examples": [
        "Here is an example of a backup, using sftp to back up /home/me to somedir on the other.host",
        "machine:",
        "duplicity /home/me sftp://uid@other.host/somedir",
        "If the above is run repeatedly, the first will be a full backup, and subsequent ones will be",
        "incremental. To force a full backup, use the full action:",
        "duplicity full /home/me sftp://uid@other.host/somedir",
        "or enforcing a full every other time via --full-if-older-than <time> , e.g. a full every",
        "month:",
        "duplicity --full-if-older-than 1M /home/me sftp://uid@other.host/somedir",
        "Now suppose we accidentally delete /home/me and want to restore it the way it was at the time",
        "of last backup:",
        "duplicity sftp://uid@other.host/somedir /home/me",
        "Duplicity enters restore mode because the URL comes before the local directory.  If we wanted",
        "to restore just the file \"Mail/article\" in /home/me as it was three days ago into",
        "/home/me/restoredfile:",
        "duplicity -t 3D --path-to-restore Mail/article sftp://uid@other.host/somedir",
        "/home/me/restoredfile",
        "The following action compares the latest backup with the current files:",
        "duplicity verify sftp://uid@other.host/somedir /home/me",
        "Finally, duplicity recognizes several include/exclude options.  For instance, the following",
        "will backup the root directory, but exclude /mnt, /tmp, and /proc:",
        "duplicity --exclude /mnt --exclude /tmp --exclude /proc / file:///usr/local/backup",
        "Note that in this case the destination is the local directory /usr/local/backup.  The",
        "following will backup only the /home and /etc directories under root:",
        "duplicity --include /home --include /etc --exclude '' / file:///usr/local/backup",
        "Duplicity can also access a repository via ftp.  If a user name is given, the environment",
        "variable FTPPASSWORD is read to determine the password:",
        "FTPPASSWORD=mypassword duplicity /local/dir ftp://user@other.host/somedir"
    ],
    "see_also": [
        {
            "name": "python",
            "section": "1",
            "url": "https://www.chedong.com/phpMan.php/man/python/1/json"
        },
        {
            "name": "rdiff",
            "section": "1",
            "url": "https://www.chedong.com/phpMan.php/man/rdiff/1/json"
        },
        {
            "name": "rdiff-backup",
            "section": "1",
            "url": "https://www.chedong.com/phpMan.php/man/rdiff-backup/1/json"
        }
    ],
    "tldr": {
        "source": "official",
        "description": "Create incremental, compressed, encrypted, and versioned backups.",
        "examples": [
            {
                "description": "Back up a directory via FTPS to a remote machine, encrypting it with a password",
                "command": "FTP_PASSWORD={{ftp_login_password}} PASSPHRASE={{encryption_password}} duplicity {{path/to/source_directory}} {{ftps://user@hostname/path/to/target_directory}}/"
            },
            {
                "description": "Back up a directory to Amazon S3, doing a full backup every month",
                "command": "duplicity --full-if-older-than {{1M}} s3://{{bucket_name[/prefix}}"
            },
            {
                "description": "Delete versions older than 1 year from a backup stored on a WebDAV share",
                "command": "FTP_PASSWORD={{webdav_login_password}} duplicity remove-older-than {{1Y}} --force {{webdav[s]://user@hostname[:port]/some_directory}}"
            },
            {
                "description": "List the available backups",
                "command": "duplicity collection-status \"file://{{absolute/path/to/backup_directory}}\""
            },
            {
                "description": "List the files in a backup stored on a remote machine, via SSH",
                "command": "duplicity list-current-files {{-t|--time}} {{YYYY-MM-DD}} scp://{{user@hostname}}/{{path/to/backup_directory}}"
            },
            {
                "description": "Restore a subdirectory from a GnuPG-encrypted local backup to a given location",
                "command": "PASSPHRASE={{gpg_key_password}} duplicity restore --encrypt-key {{gpg_key_id}} --path-to-restore {{path/to/restore_directory}} file://{{absolute/path/to/backup_directory}} {{path/to/directory_to_restore_to}}"
            }
        ]
    }
}