duplicity.cli_data module

Data for parse command line, check for consistency, and set config

class duplicity.cli_data.CommandAliases[source]

Bases: object

commands and aliases

__init__() → None
backup = ['back', 'bu']
cleanup = ['clean', 'cl']
collection_status = ['stat', 'st']
full = ['fb']
incremental = ['inc', 'ib']
list_current_files = ['list', 'ls']
remove_all_but_n_full = ['rmfull', 'rf']
remove_all_inc_of_but_n_full = ['rminc', 'ri']
remove_older_than = ['rmolder', 'ro']
restore = ['rest', 'rb']
verify = ['veri', 'vb']
class duplicity.cli_data.CommandOptions[source]

Bases: object

legal options by command

__init__() → None
backup = ['--ftp-passive', '--skip-volume', '--imap-full-address', '--s3-multipart-max-procs', '--exclude-regexp', '--encrypt-secret-keyring', '--file-to-restore', '--no-restore-ownership', '--exclude', '--exclude-filelist', '--idr-fakeroot', '--include-filelist-stdin', '--name', '--file-prefix-archive', '--path-to-restore', '--exclude-globbing-filelist', '--file-prefix-manifest', '--ssh-options', '--mp-segment-size', '--restore-time', '--copy-links', '--filter-regexp', '--webdav-headers', '--filter-literal', '--compare-data', '--azure-max-block-size', '--progress-rate', '--azure-max-single-put-size', '--tempdir', '--num-retries', '--dry-run', '--s3-use-glacier', '--current-time', '--no-print-statistics', '--fail-on-volume', '--swift-storage-policy', '--par2-redundancy', '--files-from', '--par2-volumes', '--ftp-regular', '--gpg-binary', '--timeout', '--s3-use-server-side-kms-encryption', '--ignore-errors', '--s3-endpoint-url', '--null-separator', '--archive-dir', '--s3-kms-grant', '--imap-mailbox', '--s3-use-multiprocessing', '--no-compression', '--s3-use-rrs', '--s3-use-deep-archive', '--ssl-no-check-certificate', '--gio', '--scp-command', '--config-dir', '--pydevd', '--s3-use-ia', '--old-filenames', '--s3-unencrypted-connection', '--filter-globbing', '--show-changes-in-set', '--ssh-askpass', '--azure-blob-tier', '--s3-european-buckets', '--encrypt-key', '--include', '--s3-use-onezone-ia', '--exclude-filelist-stdin', '--s3-kms-key-id', '--do-not-restore-ownership', '--exclude-older-than', '--file-changed', '--numeric-owner', '--filter-strictcase', '--full-if-older-than', '--short-filenames', '--sign-key', '--allow-source-mismatch', '--metadata-sync-mode', '--s3-use-server-side-encryption', '--exclude-if-present', '--include-regexp', '--no-files-changed', '--b2-hide-files', '--asynchronous-upload', '--s3-multipart-max-timeout', '--sftp-command', '--s3-use-new-style', '--max-blocksize', '--force', '--filter-ignorecase', '--backend-retry-delay', '--include-filelist', '--include-globbing-filelist', '--exclude-device-files', '--gpg-options', '--par2-options', '--s3-multipart-chunk-size', '--use-agent', '--no-encryption', '--azure-max-connections', '--mf-purge', '--hidden-encrypt-key', '--verbosity', '--rsync-options', '--rename', '--s3-use-glacier-ir', '--ssl-cacert-file', '--cf-backend', '--s3-region-name', '--file-prefix', '--file-prefix-signature', '--ssl-cacert-path', '--progress', '--exclude-other-filesystems', '--volsize']
cleanup = ['--ftp-passive', '--skip-volume', '--imap-full-address', '--s3-multipart-max-procs', '--encrypt-secret-keyring', '--file-to-restore', '--no-restore-ownership', '--idr-fakeroot', '--include-filelist-stdin', '--name', '--file-prefix-archive', '--path-to-restore', '--exclude-globbing-filelist', '--file-prefix-manifest', '--ssh-options', '--mp-segment-size', '--restore-time', '--copy-links', '--webdav-headers', '--compare-data', '--azure-max-block-size', '--progress-rate', '--azure-max-single-put-size', '--tempdir', '--num-retries', '--s3-use-glacier', '--current-time', '--no-print-statistics', '--fail-on-volume', '--swift-storage-policy', '--par2-redundancy', '--par2-volumes', '--ftp-regular', '--gpg-binary', '--timeout', '--s3-use-server-side-kms-encryption', '--ignore-errors', '--s3-endpoint-url', '--null-separator', '--archive-dir', '--s3-kms-grant', '--imap-mailbox', '--s3-use-multiprocessing', '--no-compression', '--s3-use-rrs', '--s3-use-deep-archive', '--ssl-no-check-certificate', '--gio', '--scp-command', '--config-dir', '--pydevd', '--s3-use-ia', '--old-filenames', '--s3-unencrypted-connection', '--show-changes-in-set', '--ssh-askpass', '--azure-blob-tier', '--s3-european-buckets', '--encrypt-key', '--s3-use-onezone-ia', '--exclude-filelist-stdin', '--s3-kms-key-id', '--do-not-restore-ownership', '--exclude-older-than', '--file-changed', '--numeric-owner', '--full-if-older-than', '--short-filenames', '--sign-key', '--allow-source-mismatch', '--metadata-sync-mode', '--s3-use-server-side-encryption', '--exclude-if-present', '--no-files-changed', '--b2-hide-files', '--s3-multipart-max-timeout', '--sftp-command', '--s3-use-new-style', '--max-blocksize', '--force', '--backend-retry-delay', '--include-globbing-filelist', '--exclude-device-files', '--gpg-options', '--par2-options', '--s3-multipart-chunk-size', '--use-agent', '--no-encryption', '--azure-max-connections', '--mf-purge', '--hidden-encrypt-key', '--verbosity', '--rsync-options', '--rename', '--s3-use-glacier-ir', '--ssl-cacert-file', '--cf-backend', '--s3-region-name', '--file-prefix', '--file-prefix-signature', '--ssl-cacert-path', '--progress', '--exclude-other-filesystems']
collection_status = ['--ftp-passive', '--skip-volume', '--imap-full-address', '--s3-multipart-max-procs', '--encrypt-secret-keyring', '--file-to-restore', '--no-restore-ownership', '--idr-fakeroot', '--include-filelist-stdin', '--name', '--file-prefix-archive', '--path-to-restore', '--exclude-globbing-filelist', '--file-prefix-manifest', '--ssh-options', '--mp-segment-size', '--restore-time', '--copy-links', '--webdav-headers', '--compare-data', '--azure-max-block-size', '--progress-rate', '--azure-max-single-put-size', '--tempdir', '--num-retries', '--s3-use-glacier', '--current-time', '--no-print-statistics', '--fail-on-volume', '--swift-storage-policy', '--par2-redundancy', '--par2-volumes', '--ftp-regular', '--gpg-binary', '--timeout', '--s3-use-server-side-kms-encryption', '--ignore-errors', '--s3-endpoint-url', '--null-separator', '--archive-dir', '--s3-kms-grant', '--imap-mailbox', '--s3-use-multiprocessing', '--no-compression', '--s3-use-rrs', '--s3-use-deep-archive', '--ssl-no-check-certificate', '--gio', '--scp-command', '--config-dir', '--pydevd', '--s3-use-ia', '--old-filenames', '--s3-unencrypted-connection', '--show-changes-in-set', '--ssh-askpass', '--azure-blob-tier', '--s3-european-buckets', '--encrypt-key', '--s3-use-onezone-ia', '--exclude-filelist-stdin', '--s3-kms-key-id', '--do-not-restore-ownership', '--exclude-older-than', '--file-changed', '--numeric-owner', '--full-if-older-than', '--short-filenames', '--sign-key', '--allow-source-mismatch', '--metadata-sync-mode', '--s3-use-server-side-encryption', '--exclude-if-present', '--no-files-changed', '--b2-hide-files', '--s3-multipart-max-timeout', '--sftp-command', '--s3-use-new-style', '--max-blocksize', '--force', '--backend-retry-delay', '--include-globbing-filelist', '--exclude-device-files', '--gpg-options', '--par2-options', '--s3-multipart-chunk-size', '--use-agent', '--no-encryption', '--azure-max-connections', '--mf-purge', '--hidden-encrypt-key', '--verbosity', '--rsync-options', '--rename', '--s3-use-glacier-ir', '--ssl-cacert-file', '--cf-backend', '--s3-region-name', '--file-prefix', '--file-prefix-signature', '--ssl-cacert-path', '--progress', '--exclude-other-filesystems']
full = ['--ftp-passive', '--skip-volume', '--imap-full-address', '--s3-multipart-max-procs', '--exclude-regexp', '--encrypt-secret-keyring', '--file-to-restore', '--no-restore-ownership', '--exclude', '--exclude-filelist', '--idr-fakeroot', '--include-filelist-stdin', '--name', '--file-prefix-archive', '--path-to-restore', '--exclude-globbing-filelist', '--file-prefix-manifest', '--ssh-options', '--mp-segment-size', '--restore-time', '--copy-links', '--filter-regexp', '--webdav-headers', '--filter-literal', '--compare-data', '--azure-max-block-size', '--progress-rate', '--azure-max-single-put-size', '--tempdir', '--num-retries', '--dry-run', '--s3-use-glacier', '--current-time', '--no-print-statistics', '--fail-on-volume', '--swift-storage-policy', '--par2-redundancy', '--files-from', '--par2-volumes', '--ftp-regular', '--gpg-binary', '--timeout', '--s3-use-server-side-kms-encryption', '--ignore-errors', '--s3-endpoint-url', '--null-separator', '--archive-dir', '--s3-kms-grant', '--imap-mailbox', '--s3-use-multiprocessing', '--no-compression', '--s3-use-rrs', '--s3-use-deep-archive', '--ssl-no-check-certificate', '--gio', '--scp-command', '--config-dir', '--pydevd', '--s3-use-ia', '--old-filenames', '--s3-unencrypted-connection', '--filter-globbing', '--show-changes-in-set', '--ssh-askpass', '--azure-blob-tier', '--s3-european-buckets', '--encrypt-key', '--include', '--s3-use-onezone-ia', '--exclude-filelist-stdin', '--s3-kms-key-id', '--do-not-restore-ownership', '--exclude-older-than', '--file-changed', '--numeric-owner', '--filter-strictcase', '--full-if-older-than', '--short-filenames', '--sign-key', '--allow-source-mismatch', '--metadata-sync-mode', '--s3-use-server-side-encryption', '--exclude-if-present', '--include-regexp', '--no-files-changed', '--b2-hide-files', '--asynchronous-upload', '--s3-multipart-max-timeout', '--sftp-command', '--s3-use-new-style', '--max-blocksize', '--force', '--filter-ignorecase', '--backend-retry-delay', '--include-filelist', '--include-globbing-filelist', '--exclude-device-files', '--gpg-options', '--par2-options', '--s3-multipart-chunk-size', '--use-agent', '--no-encryption', '--azure-max-connections', '--mf-purge', '--hidden-encrypt-key', '--verbosity', '--rsync-options', '--rename', '--s3-use-glacier-ir', '--ssl-cacert-file', '--cf-backend', '--s3-region-name', '--file-prefix', '--file-prefix-signature', '--ssl-cacert-path', '--progress', '--exclude-other-filesystems', '--volsize']
incremental = ['--ftp-passive', '--skip-volume', '--imap-full-address', '--s3-multipart-max-procs', '--exclude-regexp', '--encrypt-secret-keyring', '--file-to-restore', '--no-restore-ownership', '--exclude', '--exclude-filelist', '--idr-fakeroot', '--include-filelist-stdin', '--name', '--file-prefix-archive', '--path-to-restore', '--exclude-globbing-filelist', '--file-prefix-manifest', '--ssh-options', '--mp-segment-size', '--restore-time', '--copy-links', '--filter-regexp', '--webdav-headers', '--filter-literal', '--compare-data', '--azure-max-block-size', '--progress-rate', '--azure-max-single-put-size', '--tempdir', '--num-retries', '--dry-run', '--s3-use-glacier', '--current-time', '--no-print-statistics', '--fail-on-volume', '--swift-storage-policy', '--par2-redundancy', '--files-from', '--par2-volumes', '--ftp-regular', '--gpg-binary', '--timeout', '--s3-use-server-side-kms-encryption', '--ignore-errors', '--s3-endpoint-url', '--null-separator', '--archive-dir', '--s3-kms-grant', '--imap-mailbox', '--s3-use-multiprocessing', '--no-compression', '--s3-use-rrs', '--s3-use-deep-archive', '--ssl-no-check-certificate', '--gio', '--scp-command', '--config-dir', '--pydevd', '--s3-use-ia', '--old-filenames', '--s3-unencrypted-connection', '--filter-globbing', '--show-changes-in-set', '--ssh-askpass', '--azure-blob-tier', '--s3-european-buckets', '--encrypt-key', '--include', '--s3-use-onezone-ia', '--exclude-filelist-stdin', '--s3-kms-key-id', '--do-not-restore-ownership', '--exclude-older-than', '--file-changed', '--numeric-owner', '--filter-strictcase', '--full-if-older-than', '--short-filenames', '--sign-key', '--allow-source-mismatch', '--metadata-sync-mode', '--s3-use-server-side-encryption', '--exclude-if-present', '--include-regexp', '--no-files-changed', '--b2-hide-files', '--asynchronous-upload', '--s3-multipart-max-timeout', '--sftp-command', '--s3-use-new-style', '--max-blocksize', '--force', '--filter-ignorecase', '--backend-retry-delay', '--include-filelist', '--include-globbing-filelist', '--exclude-device-files', '--gpg-options', '--par2-options', '--s3-multipart-chunk-size', '--use-agent', '--no-encryption', '--azure-max-connections', '--mf-purge', '--hidden-encrypt-key', '--verbosity', '--rsync-options', '--rename', '--s3-use-glacier-ir', '--ssl-cacert-file', '--cf-backend', '--s3-region-name', '--file-prefix', '--file-prefix-signature', '--ssl-cacert-path', '--progress', '--exclude-other-filesystems', '--volsize']
list_current_files = ['--ftp-passive', '--skip-volume', '--imap-full-address', '--s3-multipart-max-procs', '--encrypt-secret-keyring', '--file-to-restore', '--no-restore-ownership', '--idr-fakeroot', '--include-filelist-stdin', '--name', '--file-prefix-archive', '--path-to-restore', '--exclude-globbing-filelist', '--file-prefix-manifest', '--ssh-options', '--mp-segment-size', '--restore-time', '--copy-links', '--webdav-headers', '--compare-data', '--azure-max-block-size', '--progress-rate', '--azure-max-single-put-size', '--tempdir', '--num-retries', '--s3-use-glacier', '--current-time', '--no-print-statistics', '--fail-on-volume', '--swift-storage-policy', '--par2-redundancy', '--par2-volumes', '--ftp-regular', '--gpg-binary', '--timeout', '--s3-use-server-side-kms-encryption', '--ignore-errors', '--s3-endpoint-url', '--null-separator', '--archive-dir', '--s3-kms-grant', '--imap-mailbox', '--s3-use-multiprocessing', '--no-compression', '--s3-use-rrs', '--s3-use-deep-archive', '--ssl-no-check-certificate', '--gio', '--scp-command', '--config-dir', '--pydevd', '--s3-use-ia', '--old-filenames', '--s3-unencrypted-connection', '--show-changes-in-set', '--ssh-askpass', '--azure-blob-tier', '--s3-european-buckets', '--encrypt-key', '--s3-use-onezone-ia', '--exclude-filelist-stdin', '--s3-kms-key-id', '--do-not-restore-ownership', '--exclude-older-than', '--file-changed', '--numeric-owner', '--full-if-older-than', '--short-filenames', '--sign-key', '--allow-source-mismatch', '--metadata-sync-mode', '--s3-use-server-side-encryption', '--exclude-if-present', '--no-files-changed', '--b2-hide-files', '--s3-multipart-max-timeout', '--sftp-command', '--s3-use-new-style', '--max-blocksize', '--force', '--backend-retry-delay', '--include-globbing-filelist', '--exclude-device-files', '--gpg-options', '--par2-options', '--s3-multipart-chunk-size', '--use-agent', '--no-encryption', '--azure-max-connections', '--mf-purge', '--hidden-encrypt-key', '--verbosity', '--rsync-options', '--rename', '--s3-use-glacier-ir', '--ssl-cacert-file', '--cf-backend', '--s3-region-name', '--file-prefix', '--file-prefix-signature', '--ssl-cacert-path', '--progress', '--exclude-other-filesystems']
remove_all_but_n_full = ['--ftp-passive', '--skip-volume', '--imap-full-address', '--s3-multipart-max-procs', '--encrypt-secret-keyring', '--file-to-restore', '--no-restore-ownership', '--idr-fakeroot', '--include-filelist-stdin', '--name', '--file-prefix-archive', '--path-to-restore', '--exclude-globbing-filelist', '--file-prefix-manifest', '--ssh-options', '--mp-segment-size', '--restore-time', '--copy-links', '--webdav-headers', '--compare-data', '--azure-max-block-size', '--progress-rate', '--azure-max-single-put-size', '--tempdir', '--num-retries', '--s3-use-glacier', '--current-time', '--no-print-statistics', '--fail-on-volume', '--swift-storage-policy', '--par2-redundancy', '--par2-volumes', '--ftp-regular', '--gpg-binary', '--timeout', '--s3-use-server-side-kms-encryption', '--ignore-errors', '--s3-endpoint-url', '--null-separator', '--archive-dir', '--s3-kms-grant', '--imap-mailbox', '--s3-use-multiprocessing', '--no-compression', '--s3-use-rrs', '--s3-use-deep-archive', '--ssl-no-check-certificate', '--gio', '--scp-command', '--config-dir', '--pydevd', '--s3-use-ia', '--old-filenames', '--s3-unencrypted-connection', '--show-changes-in-set', '--ssh-askpass', '--azure-blob-tier', '--s3-european-buckets', '--encrypt-key', '--s3-use-onezone-ia', '--exclude-filelist-stdin', '--s3-kms-key-id', '--do-not-restore-ownership', '--exclude-older-than', '--file-changed', '--numeric-owner', '--full-if-older-than', '--short-filenames', '--sign-key', '--allow-source-mismatch', '--metadata-sync-mode', '--s3-use-server-side-encryption', '--exclude-if-present', '--no-files-changed', '--b2-hide-files', '--s3-multipart-max-timeout', '--sftp-command', '--s3-use-new-style', '--max-blocksize', '--force', '--backend-retry-delay', '--include-globbing-filelist', '--exclude-device-files', '--gpg-options', '--par2-options', '--s3-multipart-chunk-size', '--use-agent', '--no-encryption', '--azure-max-connections', '--mf-purge', '--hidden-encrypt-key', '--verbosity', '--rsync-options', '--rename', '--s3-use-glacier-ir', '--ssl-cacert-file', '--cf-backend', '--s3-region-name', '--file-prefix', '--file-prefix-signature', '--ssl-cacert-path', '--progress', '--exclude-other-filesystems']
remove_all_inc_of_but_n_full = ['--ftp-passive', '--skip-volume', '--imap-full-address', '--s3-multipart-max-procs', '--encrypt-secret-keyring', '--file-to-restore', '--no-restore-ownership', '--idr-fakeroot', '--include-filelist-stdin', '--name', '--file-prefix-archive', '--path-to-restore', '--exclude-globbing-filelist', '--file-prefix-manifest', '--ssh-options', '--mp-segment-size', '--restore-time', '--copy-links', '--webdav-headers', '--compare-data', '--azure-max-block-size', '--progress-rate', '--azure-max-single-put-size', '--tempdir', '--num-retries', '--s3-use-glacier', '--current-time', '--no-print-statistics', '--fail-on-volume', '--swift-storage-policy', '--par2-redundancy', '--par2-volumes', '--ftp-regular', '--gpg-binary', '--timeout', '--s3-use-server-side-kms-encryption', '--ignore-errors', '--s3-endpoint-url', '--null-separator', '--archive-dir', '--s3-kms-grant', '--imap-mailbox', '--s3-use-multiprocessing', '--no-compression', '--s3-use-rrs', '--s3-use-deep-archive', '--ssl-no-check-certificate', '--gio', '--scp-command', '--config-dir', '--pydevd', '--s3-use-ia', '--old-filenames', '--s3-unencrypted-connection', '--show-changes-in-set', '--ssh-askpass', '--azure-blob-tier', '--s3-european-buckets', '--encrypt-key', '--s3-use-onezone-ia', '--exclude-filelist-stdin', '--s3-kms-key-id', '--do-not-restore-ownership', '--exclude-older-than', '--file-changed', '--numeric-owner', '--full-if-older-than', '--short-filenames', '--sign-key', '--allow-source-mismatch', '--metadata-sync-mode', '--s3-use-server-side-encryption', '--exclude-if-present', '--no-files-changed', '--b2-hide-files', '--s3-multipart-max-timeout', '--sftp-command', '--s3-use-new-style', '--max-blocksize', '--force', '--backend-retry-delay', '--include-globbing-filelist', '--exclude-device-files', '--gpg-options', '--par2-options', '--s3-multipart-chunk-size', '--use-agent', '--no-encryption', '--azure-max-connections', '--mf-purge', '--hidden-encrypt-key', '--verbosity', '--rsync-options', '--rename', '--s3-use-glacier-ir', '--ssl-cacert-file', '--cf-backend', '--s3-region-name', '--file-prefix', '--file-prefix-signature', '--ssl-cacert-path', '--progress', '--exclude-other-filesystems']
remove_older_than = ['--ftp-passive', '--skip-volume', '--imap-full-address', '--s3-multipart-max-procs', '--encrypt-secret-keyring', '--file-to-restore', '--no-restore-ownership', '--idr-fakeroot', '--include-filelist-stdin', '--name', '--file-prefix-archive', '--path-to-restore', '--exclude-globbing-filelist', '--file-prefix-manifest', '--ssh-options', '--mp-segment-size', '--restore-time', '--copy-links', '--webdav-headers', '--compare-data', '--azure-max-block-size', '--progress-rate', '--azure-max-single-put-size', '--tempdir', '--num-retries', '--s3-use-glacier', '--current-time', '--no-print-statistics', '--fail-on-volume', '--swift-storage-policy', '--par2-redundancy', '--par2-volumes', '--ftp-regular', '--gpg-binary', '--timeout', '--s3-use-server-side-kms-encryption', '--ignore-errors', '--s3-endpoint-url', '--null-separator', '--archive-dir', '--s3-kms-grant', '--imap-mailbox', '--s3-use-multiprocessing', '--no-compression', '--s3-use-rrs', '--s3-use-deep-archive', '--ssl-no-check-certificate', '--gio', '--scp-command', '--config-dir', '--pydevd', '--s3-use-ia', '--old-filenames', '--s3-unencrypted-connection', '--show-changes-in-set', '--ssh-askpass', '--azure-blob-tier', '--s3-european-buckets', '--encrypt-key', '--s3-use-onezone-ia', '--exclude-filelist-stdin', '--s3-kms-key-id', '--do-not-restore-ownership', '--exclude-older-than', '--file-changed', '--numeric-owner', '--full-if-older-than', '--short-filenames', '--sign-key', '--allow-source-mismatch', '--metadata-sync-mode', '--s3-use-server-side-encryption', '--exclude-if-present', '--no-files-changed', '--b2-hide-files', '--s3-multipart-max-timeout', '--sftp-command', '--s3-use-new-style', '--max-blocksize', '--force', '--backend-retry-delay', '--include-globbing-filelist', '--exclude-device-files', '--gpg-options', '--par2-options', '--s3-multipart-chunk-size', '--use-agent', '--no-encryption', '--azure-max-connections', '--mf-purge', '--hidden-encrypt-key', '--verbosity', '--rsync-options', '--rename', '--s3-use-glacier-ir', '--ssl-cacert-file', '--cf-backend', '--s3-region-name', '--file-prefix', '--file-prefix-signature', '--ssl-cacert-path', '--progress', '--exclude-other-filesystems']
restore = ['--ftp-passive', '--skip-volume', '--imap-full-address', '--s3-multipart-max-procs', '--encrypt-secret-keyring', '--file-to-restore', '--no-restore-ownership', '--idr-fakeroot', '--include-filelist-stdin', '--name', '--file-prefix-archive', '--path-to-restore', '--exclude-globbing-filelist', '--file-prefix-manifest', '--ssh-options', '--mp-segment-size', '--restore-time', '--copy-links', '--webdav-headers', '--compare-data', '--azure-max-block-size', '--progress-rate', '--azure-max-single-put-size', '--tempdir', '--num-retries', '--s3-use-glacier', '--current-time', '--no-print-statistics', '--fail-on-volume', '--swift-storage-policy', '--par2-redundancy', '--par2-volumes', '--ftp-regular', '--gpg-binary', '--timeout', '--s3-use-server-side-kms-encryption', '--ignore-errors', '--s3-endpoint-url', '--null-separator', '--archive-dir', '--s3-kms-grant', '--imap-mailbox', '--s3-use-multiprocessing', '--no-compression', '--s3-use-rrs', '--s3-use-deep-archive', '--ssl-no-check-certificate', '--gio', '--scp-command', '--config-dir', '--pydevd', '--s3-use-ia', '--old-filenames', '--s3-unencrypted-connection', '--show-changes-in-set', '--ssh-askpass', '--azure-blob-tier', '--s3-european-buckets', '--encrypt-key', '--s3-use-onezone-ia', '--exclude-filelist-stdin', '--s3-kms-key-id', '--do-not-restore-ownership', '--exclude-older-than', '--file-changed', '--numeric-owner', '--full-if-older-than', '--short-filenames', '--sign-key', '--allow-source-mismatch', '--metadata-sync-mode', '--s3-use-server-side-encryption', '--exclude-if-present', '--no-files-changed', '--b2-hide-files', '--s3-multipart-max-timeout', '--sftp-command', '--s3-use-new-style', '--max-blocksize', '--force', '--backend-retry-delay', '--include-globbing-filelist', '--exclude-device-files', '--gpg-options', '--par2-options', '--s3-multipart-chunk-size', '--use-agent', '--no-encryption', '--azure-max-connections', '--mf-purge', '--hidden-encrypt-key', '--verbosity', '--rsync-options', '--rename', '--s3-use-glacier-ir', '--ssl-cacert-file', '--cf-backend', '--s3-region-name', '--file-prefix', '--file-prefix-signature', '--ssl-cacert-path', '--progress', '--exclude-other-filesystems']
verify = ['--ftp-passive', '--skip-volume', '--imap-full-address', '--s3-multipart-max-procs', '--encrypt-secret-keyring', '--file-to-restore', '--no-restore-ownership', '--idr-fakeroot', '--include-filelist-stdin', '--name', '--file-prefix-archive', '--path-to-restore', '--exclude-globbing-filelist', '--file-prefix-manifest', '--ssh-options', '--mp-segment-size', '--restore-time', '--copy-links', '--webdav-headers', '--compare-data', '--azure-max-block-size', '--progress-rate', '--azure-max-single-put-size', '--tempdir', '--num-retries', '--s3-use-glacier', '--current-time', '--no-print-statistics', '--fail-on-volume', '--swift-storage-policy', '--par2-redundancy', '--par2-volumes', '--ftp-regular', '--gpg-binary', '--timeout', '--s3-use-server-side-kms-encryption', '--ignore-errors', '--s3-endpoint-url', '--null-separator', '--archive-dir', '--s3-kms-grant', '--imap-mailbox', '--s3-use-multiprocessing', '--no-compression', '--s3-use-rrs', '--s3-use-deep-archive', '--ssl-no-check-certificate', '--gio', '--scp-command', '--config-dir', '--pydevd', '--s3-use-ia', '--old-filenames', '--s3-unencrypted-connection', '--show-changes-in-set', '--ssh-askpass', '--azure-blob-tier', '--s3-european-buckets', '--encrypt-key', '--s3-use-onezone-ia', '--exclude-filelist-stdin', '--s3-kms-key-id', '--do-not-restore-ownership', '--exclude-older-than', '--file-changed', '--numeric-owner', '--full-if-older-than', '--short-filenames', '--sign-key', '--allow-source-mismatch', '--metadata-sync-mode', '--s3-use-server-side-encryption', '--exclude-if-present', '--no-files-changed', '--b2-hide-files', '--s3-multipart-max-timeout', '--sftp-command', '--s3-use-new-style', '--max-blocksize', '--force', '--backend-retry-delay', '--include-globbing-filelist', '--exclude-device-files', '--gpg-options', '--par2-options', '--s3-multipart-chunk-size', '--use-agent', '--no-encryption', '--azure-max-connections', '--mf-purge', '--hidden-encrypt-key', '--verbosity', '--rsync-options', '--rename', '--s3-use-glacier-ir', '--ssl-cacert-file', '--cf-backend', '--s3-region-name', '--file-prefix', '--file-prefix-signature', '--ssl-cacert-path', '--progress', '--exclude-other-filesystems']
class duplicity.cli_data.DuplicityCommands[source]

Bases: object

duplicity commands and positional args expected

NOTE: cli_util must contain a function named check_* for each positional arg,

for example check_source_path() to check for source path validity.

__init__() → None
backup = ['source_path', 'target_url']
cleanup = ['target_url']
collection_status = ['target_url']
full = ['source_path', 'target_url']
incremental = ['source_path', 'target_url']
list_current_files = ['target_url']
remove_all_but_n_full = ['count', 'target_url']
remove_all_inc_of_but_n_full = ['count', 'target_url']
remove_older_than = ['remove_time', 'target_url']
restore = ['source_url', 'target_dir']
verify = ['source_url', 'target_dir']
class duplicity.cli_data.OptionAliases[source]

Bases: object

__init__() → None
path_to_restore = ['-r']
restore_time = ['-t', '--time']
verbosity = ['-v']
version = ['-V']
class duplicity.cli_data.OptionKwargs[source]

Bases: object

Option kwargs for add_argument

__init__() → None
allow_source_mismatch = {'action': 'store_true', 'default': False, 'help': 'Allow different source directories'}
archive_dir = {'default': '/home/docs/.cache/duplicity', 'help': 'Path to store metadata archives', 'metavar': 'path', 'type': <function check_file>}
asynchronous_upload = {'action': 'store_const', 'const': 1, 'default': 0, 'dest': 'async_concurrency', 'help': 'Number of async upload tasks, max of 1'}
azure_blob_tier = {'default': None, 'help': 'Standard storage tier used for storing backup files (Hot|Cool|Archive)', 'metavar': 'Hot|Cool|Archive'}
azure_max_block_size = {'default': None, 'help': 'Number for the block size to upload a blob if the length is unknown\nor is larger than the value set by --azure-max-single-put-size\nThe maximum block size the service supports is 100MiB.', 'metavar': 'number', 'type': <class 'int'>}
azure_max_connections = {'default': None, 'help': 'Number of maximum parallel connections to use when the blob size exceeds 64MB', 'metavar': 'number', 'type': <class 'int'>}
azure_max_single_put_size = {'default': None, 'help': 'Largest supported upload size where the Azure library makes only one put call.\nUsed to upload a single block if the content length is known and is less than this', 'metavar': 'number', 'type': <class 'int'>}
b2_hide_files = {'action': 'store_true', 'default': False, 'help': 'Whether the B2 backend hides files instead of deleting them'}
backend_retry_delay = {'default': 30, 'help': 'Delay time before next try after a failure of a backend operation', 'metavar': 'seconds', 'type': <class 'int'>}
cf_backend = {'default': 'pyrax', 'help': 'Allow the user to switch cloudfiles backend', 'metavar': 'pyrax|cloudfiles'}
compare_data = {'action': 'store_true', 'default': False, 'help': 'Compare data on verify not only signatures'}
config_dir = {'default': '/home/docs/.cache/duplicity', 'help': 'Path to store configuration files', 'metavar': 'path', 'type': <function check_file>}
current_time = {'help': '==SUPPRESS==', 'type': <class 'int'>}
do_not_restore_ownership = {'action': <class 'duplicity.cli_util.DeprecationAction'>, 'help': '==SUPPRESS==', 'nargs': 0}
dry_run = {'action': 'store_true', 'default': False, 'help': 'Perform dry-run with no writes'}
encrypt_key = {'default': None, 'help': 'GNUpg key for encryption/decryption', 'metavar': 'gpg-key-id', 'type': <function set_encrypt_key>}
encrypt_secret_keyring = {'default': None, 'help': 'Path to secret GNUpg keyring', 'metavar': 'path'}
exclude = {'action': <class 'duplicity.cli_util.AddSelectionAction'>, 'default': None, 'help': 'Exclude globbing pattern', 'metavar': 'shell_pattern'}
exclude_device_files = {'action': 'store_true', 'default': False, 'help': 'Exclude device files'}
exclude_filelist = {'action': <class 'duplicity.cli_util.AddFilelistAction'>, 'default': None, 'help': 'File with list of file patters to exclude', 'metavar': 'filename'}
exclude_filelist_stdin = {'action': <class 'duplicity.cli_util.DeprecationAction'>, 'help': '==SUPPRESS==', 'nargs': 0}
exclude_globbing_filelist = {'action': <class 'duplicity.cli_util.DeprecationAction'>, 'help': '==SUPPRESS==', 'nargs': 0}
exclude_if_present = {'action': <class 'duplicity.cli_util.AddSelectionAction'>, 'default': None, 'help': 'Exclude directory if this file is present', 'metavar': 'filename'}
exclude_older_than = {'action': <class 'duplicity.cli_util.AddSelectionAction'>, 'default': None, 'help': 'Exclude files older than time', 'metavar': 'time'}
exclude_other_filesystems = {'action': 'store_true', 'default': False, 'help': 'Exclude other filesystems from backup'}
exclude_regexp = {'action': <class 'duplicity.cli_util.AddSelectionAction'>, 'default': None, 'help': 'Exclude based on regex pattern', 'metavar': 'regex'}
fail_on_volume = {'help': '==SUPPRESS==', 'type': <class 'int'>}
file_changed = {'default': None, 'help': 'Whether to collect only the file status, not the whole root', 'metavar': 'path', 'type': <function check_file>}
file_prefix = {'default': b'', 'help': 'String prefix for all duplicity files', 'metavar': 'string', 'type': <function make_bytes>}
file_prefix_archive = {'default': b'', 'help': 'String prefix for duplicity difftar files', 'metavar': 'string', 'type': <function make_bytes>}
file_prefix_manifest = {'default': b'', 'help': 'String prefix for duplicity manifest files', 'metavar': 'string', 'type': <function make_bytes>}
file_prefix_signature = {'default': b'', 'help': 'String prefix for duplicity signature files', 'metavar': 'string', 'type': <function make_bytes>}
file_to_restore = {'action': <class 'duplicity.cli_util.DeprecationAction'>, 'help': '==SUPPRESS==', 'nargs': 0}
files_from = {'action': <class 'duplicity.cli_util.AddFilelistAction'>, 'default': None, 'help': 'Defines the backup source as a sub-set of the source folder', 'metavar': 'filename', 'type': <function check_file>}
filter_globbing = {'action': <class 'duplicity.cli_util.AddSelectionAction'>, 'default': None, 'help': 'File selection mode switch, changes the interpretation of any subsequent\n--exclude* or --include* options to shell globbing.', 'nargs': 0}
filter_ignorecase = {'action': <class 'duplicity.cli_util.AddSelectionAction'>, 'default': None, 'help': 'File selection mode switch, changes the interpretation of any subsequent\n--exclude* or --include* options to case-insensitive matching.', 'nargs': 0}
filter_literal = {'action': <class 'duplicity.cli_util.AddSelectionAction'>, 'default': None, 'help': 'File selection mode switch, changes the interpretation of any subsequent\n--exclude* or --include* options to literal strings.', 'nargs': 0}
filter_regexp = {'action': <class 'duplicity.cli_util.AddSelectionAction'>, 'default': None, 'help': 'File selection mode switch, changes the interpretation of any subsequent\n--exclude* or --include* options to regular expressions.', 'nargs': 0}
filter_strictcase = {'action': <class 'duplicity.cli_util.AddSelectionAction'>, 'default': None, 'help': 'File selection mode switch, changes the interpretation of any subsequent\n--exclude* or --include* options to case-sensitive matching.', 'nargs': 0}
force = {'action': 'store_true', 'default': None, 'help': 'Force duplicity to actually delete during cleanup'}
ftp_passive = {'action': 'store_const', 'const': 'passive', 'default': 'passive', 'dest': 'ftp_connection', 'help': 'Tell FTP to use passive mode'}
ftp_regular = {'action': 'store_const', 'const': 'regular', 'default': 'passive', 'dest': 'ftp_connection', 'help': 'Tell FTP to use regular mode'}
full_if_older_than = {'default': None, 'help': "Perform full backup if last full is older than 'time'", 'metavar': 'time', 'type': <function check_time>}
gio = {'action': <class 'duplicity.cli_util.DeprecationAction'>, 'help': '==SUPPRESS==', 'nargs': 0}
gpg_binary = {'default': None, 'help': 'Path to GNUpg executable file', 'metavar': 'path', 'type': <function check_file>}
gpg_options = {'action': 'append', 'default': None, 'help': 'Options to append to GNUpg invocation', 'metavar': 'options'}
hidden_encrypt_key = {'default': None, 'help': 'Hidden GNUpg encryption key', 'metavar': 'gpg-key-id', 'type': <function set_hidden_encrypt_key>}
idr_fakeroot = {'default': None, 'help': 'Fake root for idrive backend', 'metavar': 'path', 'type': <function check_file>}
ignore_errors = {'action': 'store_true', 'default': False, 'help': 'Ignore most errors during processing'}
imap_full_address = {'action': 'store_true', 'default': False, 'help': 'Whether to use the full email address as the user name'}
imap_mailbox = {'default': 'INBOX', 'help': 'Name of the imap folder to store backups', 'metavar': 'imap_mailbox'}
include = {'action': <class 'duplicity.cli_util.AddSelectionAction'>, 'default': None, 'help': 'Include globbing pattern', 'metavar': 'shell_pattern'}
include_filelist = {'action': <class 'duplicity.cli_util.AddFilelistAction'>, 'default': None, 'help': 'File with list of file patters to include', 'metavar': 'filename'}
include_filelist_stdin = {'action': <class 'duplicity.cli_util.DeprecationAction'>, 'help': '==SUPPRESS==', 'nargs': 0}
include_globbing_filelist = {'action': <class 'duplicity.cli_util.DeprecationAction'>, 'help': '==SUPPRESS==', 'nargs': 0}
include_regexp = {'action': <class 'duplicity.cli_util.AddSelectionAction'>, 'default': None, 'help': 'Include based on regex pattern', 'metavar': 'regex'}
log_fd = {'default': None, 'help': 'Logging file descripto to use', 'metavar': 'file_descriptor', 'type': <function set_log_fd>}
log_file = {'default': None, 'help': 'Logging filename to use', 'metavar': 'log_filename', 'type': <function set_log_file>}
log_timestamp = {'action': 'store_true', 'default': False, 'help': 'Whether to include timestamp and level in log'}
max_blocksize = {'default': 2048, 'help': 'Maximum block size for large files in MB', 'metavar': 'number', 'type': <class 'int'>}
metadata_sync_mode = {'choices': ('full', 'partial'), 'default': 'partial', 'help': 'Only sync required metadata not all'}
mf_purge = {'action': 'store_true', 'default': False, 'help': 'Option for mediafire to purge files on delete instead of sending to trash'}
mp_segment_size = {'default': 230686720, 'help': 'Swift backend segment size', 'metavar': 'number', 'type': <function set_megs>}
name = {'default': None, 'dest': 'backup_name', 'help': 'Custom backup name instead of hash', 'metavar': 'backup name'}
no_compression = {'action': 'store_false', 'default': True, 'dest': 'compression', 'help': 'If supplied do not perform compression'}
no_encryption = {'action': 'store_false', 'default': True, 'dest': 'encryption', 'help': 'If supplied do not perform encryption'}
no_files_changed = {'action': 'store_false', 'default': True, 'dest': 'files_changed', 'help': 'If supplied do not collect the files_changed list'}
no_print_statistics = {'action': 'store_false', 'default': True, 'dest': 'print_statistics', 'help': 'If supplied do not print statistics'}
no_restore_ownership = {'action': 'store_false', 'default': True, 'dest': 'restore_ownership', 'help': 'If supplied do not restore uid/gid when finished'}
null_separator = {'action': 'store_true', 'default': None, 'help': 'Whether to split on null instead of newline'}
num_retries = {'default': 5, 'help': 'Number of retries on network operations', 'metavar': 'number', 'type': <class 'int'>}
numeric_owner = {'action': 'store_true', 'default': False, 'help': 'Keeps number from tar file. Like same option in GNU tar.'}
old_filenames = {'action': <class 'duplicity.cli_util.DeprecationAction'>, 'help': '==SUPPRESS==', 'nargs': 0}
par2_options = {'action': 'append', 'default': '', 'help': 'Verbatim par2 options.  May be supplied multiple times.', 'metavar': 'options'}
par2_redundancy = {'default': 10, 'help': 'Level of Redundancy in percent for Par2 files', 'metavar': 'number', 'type': <class 'int'>}
par2_volumes = {'default': 1, 'help': 'Number of par2 volumes', 'metavar': 'number', 'type': <class 'int'>}
path_to_restore = {'default': None, 'dest': 'restore_path', 'help': 'File or directory path to restore', 'metavar': 'path', 'type': <function check_file>}
progress = {'action': 'store_true', 'default': False, 'help': 'Display progress for the full and incremental backup operations'}
progress_rate = {'default': 3, 'help': 'Used to control the progress option update rate in seconds', 'metavar': 'number', 'type': <class 'int'>}
pydevd = {'action': 'store_true', 'help': '==SUPPRESS=='}
rename = {'action': <class 'duplicity.cli_util.AddRenameAction'>, 'default': None, 'help': 'Rename files during restore', 'metavar': 'from to', 'nargs': 2}
restore_time = {'default': None, 'help': 'Restores will try to bring back the state as of the following time', 'metavar': 'time', 'type': <function check_time>}
rsync_options = {'action': 'append', 'default': '', 'help': 'User added rsync options', 'metavar': 'options'}
s3_endpoint_url = {'action': 'store', 'default': None, 'help': 'Specity S3 endpoint', 'metavar': 's3_endpoint_url'}
s3_european_buckets = {'action': 'store_true', 'default': False, 'help': 'Whether to create European buckets'}
s3_kms_grant = {'action': 'store', 'default': None, 'help': 'S3 KMS grant value', 'metavar': 's3_kms_grant'}
s3_kms_key_id = {'action': 'store', 'default': None, 'help': 'S3 KMS encryption key id', 'metavar': 's3_kms_key_id'}
s3_multipart_chunk_size = {'default': 20, 'help': 'Chunk size used for S3 multipart uploads.The number of parallel uploads to\nS3 be given by chunk size / volume size. Use this to maximize the use of\nyour bandwidth', 'metavar': 'number', 'type': <function set_megs>}
s3_multipart_max_procs = {'default': 4, 'help': 'Number of processes to set the Processor Pool to when uploading multipart\nuploads to S3. Use this to control the maximum simultaneous uploads to S3', 'metavar': 'number', 'type': <class 'int'>}
s3_multipart_max_timeout = {'default': None, 'help': 'Number of seconds to wait for each part of a multipart upload to S3. Use this\nto prevent hangups when doing a multipart upload to S3', 'metavar': 'number', 'type': <class 'int'>}
s3_region_name = {'action': 'store', 'default': None, 'help': 'Specity S3 region name', 'metavar': 's3_region_name'}
s3_unencrypted_connection = {'action': 'store_true', 'default': False, 'help': 'Whether to use plain HTTP (without SSL) to send data to S3'}
s3_use_deep_archive = {'action': 'store_true', 'default': False, 'help': 'Whether to use S3 Glacier Deep Archive Storage'}
s3_use_glacier = {'action': 'store_true', 'default': False, 'help': 'Whether to use S3 Glacier Storage'}
s3_use_glacier_ir = {'action': 'store_true', 'default': False, 'help': 'Whether to use S3 Glacier IR Storage'}
s3_use_ia = {'action': 'store_true', 'default': False, 'help': 'Whether to use S3 Infrequent Access Storage'}
s3_use_multiprocessing = {'action': 'store_true', 'default': False, 'help': 'Option to allow the s3/boto backend use the multiprocessing version'}
s3_use_new_style = {'action': 'store_true', 'default': False, 'help': 'Whether to use new-style subdomain addressing for S3 buckets. Such\nuse is not backwards-compatible with upper-case buckets, or buckets\nthat are otherwise not expressable in a valid hostname'}
s3_use_onezone_ia = {'action': 'store_true', 'default': False, 'help': 'Whether to use S3 One Zone Infrequent Access Storage'}
s3_use_rrs = {'action': 'store_true', 'default': False, 'help': 'Whether to use S3 Reduced Redundancy Storage'}
s3_use_server_side_encryption = {'action': 'store_true', 'default': False, 'dest': 's3_use_sse', 'help': 'Option to allow use of server side encryption in s3'}
s3_use_server_side_kms_encryption = {'action': 'store_true', 'default': False, 'dest': 's3_use_sse_kms', 'help': 'Allow use of server side KMS encryption'}
scp_command = {'default': None, 'help': 'SCP command to use (ssh pexpect backend)', 'metavar': 'command'}
sftp_command = {'default': None, 'help': 'SFTP command to use (ssh pexpect backend)', 'metavar': 'command'}
short_filenames = {'action': <class 'duplicity.cli_util.DeprecationAction'>, 'help': '==SUPPRESS==', 'nargs': 0}
show_changes_in_set = {'default': None, 'help': 'Show file changes (new, deleted, changed) in the specified backup\nset (0 specifies latest, 1 specifies next latest, etc.)', 'metavar': 'number', 'type': <class 'int'>}
sign_key = {'default': None, 'help': 'Sign key for encryption/decryption', 'metavar': 'gpg-key-id', 'type': <function set_sign_key>}
skip_volume = {'help': '==SUPPRESS==', 'type': <class 'int'>}
ssh_askpass = {'action': 'store_true', 'default': False, 'help': 'Ask the user for the SSH password. Not for batch usage'}
ssh_options = {'action': 'append', 'default': '', 'help': 'SSH options to add', 'metavar': 'options'}
ssl_cacert_file = {'default': None, 'help': 'pem formatted bundle of certificate authorities', 'metavar': 'file'}
ssl_cacert_path = {'default': None, 'help': 'path to a folder with certificate authority files', 'metavar': 'path'}
ssl_no_check_certificate = {'action': 'store_true', 'default': False, 'help': 'Set to not validate SSL certificates'}
swift_storage_policy = {'default': '', 'help': 'Option to specify a Swift container storage policy.', 'metavar': 'policy'}
tempdir = {'default': None, 'dest': 'temproot', 'help': 'Working directory for temp files', 'metavar': 'path', 'type': <function check_file>}
time_separator = {'default': ':', 'help': "Character used like the ':' in time strings like\n2002-08-06T04:22:00-07:00", 'metavar': 'char'}
timeout = {'default': 30, 'help': 'Network timeout in seconds', 'metavar': 'seconds', 'type': <class 'int'>}
use_agent = {'action': 'store_true', 'default': False, 'help': 'Whether to specify --use-agent in GnuPG options'}
verbosity = {'default': 3, 'help': 'Logging verbosity', 'metavar': '[0-9]', 'type': <function check_verbosity>}
version = {'action': 'version', 'help': 'Display version and exit', 'version': '%(prog)s $version'}
volsize = {'default': 200, 'help': 'Volume size to use in MiB', 'metavar': 'number', 'type': <function set_megs>}
webdav_headers = {'default': '', 'help': "extra headers for Webdav, like 'Cookie,name: value'", 'metavar': 'string'}