Merge pull request #3531 from SanskritFritz/1.1-maint

Updated zsh completions for borg 1.1.4

scripts/shell_completions/zsh/_borg

@@ -2,8 +2,6 @@
 
 # -------
 #
-# For borg 1.1.1
-#
 # To Install:
 #
 # Copy this file to /usr/share/zsh/site-functions/
@@ -38,10 +36,10 @@
 
 _borg() {
     typeset -A opt_args
-    local -a borg_possible_commands borg_possible_key_commands commands keyCommands borg_standard_options
+    local -a borg_possible_commands borg_possible_key_commands commands keyCommands borg_common_options
     local command keyCommand item subItem
 
-    borg_standard_options=({-h,--help}'[show this help message and exit]'
+    borg_common_options=({-h,--help}'[show this help message and exit]'
                              --critical'[work on log level CRITICAL]'
                              --error'[work on log level ERROR]'
                              --warning'[work on log level WARNING (default)]'
@@ -59,7 +57,7 @@ _borg() {
                              --consider-part-files'[treat part files like normal files (e.g. to list/extract them)]'
                              --debug-profile'[Write execution profile in Borg format into FILE.]:_files')
 
-    borg_possible_commands=(serve init check key change-passphrase create extract export-tar diff rename delete list mount umount info break-lock prune upgrade with-lock benchmark)
+    borg_possible_commands=(init create extract check rename list diff delete prune info mount umount key upgrade recreate export-tar serve config with-lock break-lock benchmark)
     borg_possible_key_commands=(change-passphrase import export)
     command=""
     keyCommand=""
@@ -70,73 +68,13 @@ _borg() {
     done
 
     case $command in
-        (serve)
-            _arguments \
-                --restrict-to-path'[restrict repository access to PATH]:_files'\
-                --restrict-to-repository'[restrict repository access]:_files'\
-                --append-only'[only allow appending to repository segment files]'\
-                --storage-quota'[Override storage quota of the repository]:QUOTA'\
-                $borg_standard_options
-            ;;
         (init)
             _arguments \
                 '2:repo:_files'\
                 {-e,--encryption}'[select encryption key mode]:MODE'\
                 --append-only'[only allow appending to repository segment files]'\
                 --storage-quota'[Override storage quota of the repository]:QUOTA'\
-                $borg_standard_options
-            ;;
-        (check)
-            _arguments \
-                '2:archives:__borg_archive'\
-                --repository-only'[only perform repository checks]'\
-                --archives-only'[only perform archives checks]'\
-                --verify-data'[perform cryptographic archive data integrity verification]'\
-                --repair'[attempt to repair any inconsistencies found]'\
-                --save-space'[work slower, but using less space]'\
-                {-P,--prefix}'[only consider archive names starting with this prefix.]:PREFIX'\
-                {-a,--glob-archives}'[only consider archive names matching the glob]:GLOB'\
-                --sort-keys'[Comma-separated list of sorting keys]:KEYS'\
-                --first'[consider first N archives after other filters were applied]:N'\
-                --last'[consider last N archives after other filters were applied]:N'\
-                $borg_standard_options
-            ;;
-        (key)
-            case $keyCommand in
-                (change-passphrase)
-                    _arguments \
-                        '2:subCommand:(change-passphrase import export)'\
-                        '3:archives:__borg_archive'\
-                        $borg_standard_options
-                    ;;
-                (import)
-                    _arguments \
-                        '2:subCommand:(change-passphrase import export)'\
-                        '3:archives:__borg_archive'\
-                        '4:path:_files'\
-                        --paper'[interactively import from a backup done with --paper]'\
-                        $borg_standard_options
-                    ;;
-                (export)
-                    _arguments \
-                        '2:subCommand:(change-passphrase import export)'\
-                        '3:archives:__borg_archive'\
-                        '4:path:_files'\
-                        --paper'[Create an export suitable for printing and later type-in]'\
-                        --qr-html'[Create an html file suitable for printing and later type-in or qr scan]'\
-                        $borg_standard_options
-                    ;;
-                *)
-                    _arguments \
-                        '2:subCommand:(change-passphrase import export)'\
-                        $borg_standard_options
-                    ;;
-                esac
-            ;;
-        (change-passphrase)
-            _arguments \
-                '2:archives:__borg_archive'\
-                $borg_standard_options
+                $borg_common_options
             ;;
         (create)
             _arguments \
@@ -148,14 +86,6 @@ _borg() {
                 --filter'[only display items with the given status characters]:STATUSCHARS'\
                 --json'[output stats as JSON. Implies --stats.]'\
                 --no-cache-sync'[experimental: do not synchronize the cache. Implies not using the files cache.]'\
-                {-x,--one-file-system}'[stay in the same file system ]'\
-                --numeric-owner'[only store numeric user and group identifiers]'\
-                --noatime'[do not store atime into archive]'\
-                --noctime'[do not store ctime into archive]'\
-                --nobsdflags'[do not read and store bsdflags (e.g. NODUMP, IMMUTABLE) into archive]'\
-                --ignore-inode'[gnore inode data in the file metadata cache used to detect unchanged files.]'\
-                --files-cache'[operate files cache in MODE. default: ctime,size,inode]:MODE'\
-                --read-special'[open and read block and char device files as well as FIFOs as if they were regular files.]'\
                 {-e,--exclude}'[exclude paths matching PATTERN]:PATTERN'\
                 --exclude-from'[read exclude patterns from EXCLUDEFILE, one per line]:_files'\
                 --pattern'[experimental: include/exclude paths matching PATTERN]:PATTERN'\
@@ -163,13 +93,21 @@ _borg() {
                 --exclude-caches'[exclude directories that contain a CACHEDIR.TAG file ]'\
                 --exclude-if-present'[exclude directories that are tagged by containing a filesystem object with the given NAME]:NAME'\
                 {--keep-exclude-tags,--keep-tag-files}'[if tag objects are specified with --exclude-if-present, don’t omit the tag objects themselves]'\
-                --exclude-nodump'[exclude files flagged NODUMP]'\
+                {-x,--one-file-system}'[stay in the same file system ]'\
+                --numeric-owner'[only store numeric user and group identifiers]'\
+                --noatime'[do not store atime into archive]'\
+                --nobirthtime'[do not store birthtime (creation date) into archive]'\
+                --nobsdflags'[do not read and store bsdflags (e.g. NODUMP, IMMUTABLE) into archive]'\
+                --ignore-inode'[ignore inode data in the file metadata cache used to detect unchanged files.]'\
+                --files-cache'[operate files cache in MODE. default: ctime,size,inode]:MODE'\
+                --read-special'[open and read block and char device files as well as FIFOs as if they were regular files.]'\
                 --comment'[add a comment text to the archive]:COMMENT'\
                 --timestamp'[manually specify the archive creation date/time]:TIMESTAMP'\
+                --timestamp'[manually specify the archive creation date/time by a reference file/directory]:_files'\
                 {-c,--checkpoint-interval}'[write checkpoint every SECONDS seconds]:SECONDS'\
-                --chunker-params'[pecify the chunker parameters]:PARAMS'\
+                --chunker-params'[specify the chunker parameters]:PARAMS'\
                 {-C,--compression}'[select compression algorithm]:COMPRESSION'\
-                $borg_standard_options
+                $borg_common_options
             ;;
         (extract)
             _arguments \
@@ -186,21 +124,47 @@ _borg() {
                 --pattern'[experimental: include/exclude paths matching PATTERN]:PATTERN'\
                 --patterns-from'[experimental: read include/exclude patterns from PATTERNFILE, one per line]:_files'\
                 --strip-components'[Remove the specified number of leading path elements. Paths with fewer elements will be silently skipped.]:NUMBER'\
-                $borg_standard_options
+                $borg_common_options
             ;;
-        (export-tar)
+        (check)
             _arguments \
                 '2:archives:__borg_archive'\
-                '3:tar:_files'\
-                '4:path:_files'\
-                --tar-filter'[filter program to pipe data through]'\
-                --list'[output verbose list of items (files, dirs, ...)]'\
+                --repository-only'[only perform repository checks]'\
+                --archives-only'[only perform archives checks]'\
+                --verify-data'[perform cryptographic archive data integrity verification]'\
+                --repair'[attempt to repair any inconsistencies found]'\
+                --save-space'[work slower, but using less space]'\
+                {-P,--prefix}'[only consider archive names starting with this prefix.]:PREFIX'\
+                {-a,--glob-archives}'[only consider archive names matching the glob]:GLOB'\
+                --sort-by'[Comma-separated list of sorting keys]:KEYS'\
+                --first'[consider first N archives after other filters were applied]:N'\
+                --last'[consider last N archives after other filters were applied]:N'\
+                $borg_common_options
+            ;;
+        (rename)
+            _arguments \
+                '2:archives:__borg_archive'\
+                '3:name:NAME'\
+                $borg_common_options
+            ;;
+        (list)
+            _arguments \
+                '2:archives:__borg_archive'\
+                '*:path:_files'\
+                --short'[only print file/directory names, nothing else]'\
+                {--format,--list-format}'[specify format for file listing]:FORMAT'\
+                --json'[Only valid for listing repository contents. Format output as JSON.]'\
+                --json-lines'[Only valid for listing archive contents. Format output as JSON Lines. ]'\
+                {-P,--prefix}'[only consider archive names starting with this prefix.]:PREFIX'\
+                {-a,--glob-archives}'[only consider archive names matching the glob]:GLOB'\
+                --sort-by'[Comma-separated list of sorting keys]:KEYS'\
+                --first'[consider first N archives after other filters were applied]:N'\
+                --last'[consider last N archives after other filters were applied]:N'\
                 {-e,--exclude}'[exclude paths matching PATTERN]:PATTERN'\
                 --exclude-from'[read exclude patterns from EXCLUDEFILE, one per line]:_files'\
                 --pattern'[experimental: include/exclude paths matching PATTERN]:PATTERN'\
                 --patterns-from'[experimental: read include/exclude patterns from PATTERNFILE, one per line]:_files'\
-                --strip-components'[Remove the specified number of leading path elements. Paths with fewer elements will be silently skipped.]:NUMBER'\
-                $borg_standard_options
+               $borg_common_options
             ;;
         (diff)
             _arguments \
@@ -208,24 +172,15 @@ _borg() {
                 '3:archives:__borg_archive'\
                 '*:path:_files'\
                 --numeric-owner'[only obey numeric user and group identifiers]'\
-                --same-chunker-params'[Override check of chunker parameters.]'\
-                --sort'[Sort the output lines by file path.]'\
+                --same-chunker-params'[override check of chunker parameters.]'\
+                --sort'[sort the output lines by file path.]'\
                 {-e,--exclude}'[exclude paths matching PATTERN]:PATTERN'\
                 --exclude-from'[read exclude patterns from EXCLUDEFILE, one per line]:_files'\
                 --pattern'[experimental: include/exclude paths matching PATTERN]:PATTERN'\
                 --patterns-from'[experimental: read include/exclude patterns from PATTERNFILE, one per line]:_files'\
-                --exclude-caches'[exclude directories that contain a CACHEDIR.TAG file ]'\
-                --exclude-if-present'[exclude directories that are tagged by containing a filesystem object with the given NAME]:NAME'\
-                {--keep-exclude-tags,--keep-tag-files}'[if tag objects are specified with --exclude-if-present, don’t omit the tag objects themselves]'\
-                $borg_standard_options
+                $borg_common_options
 
             ;;
-        (rename)
-            _arguments \
-                '2:archives:__borg_archive'\
-                '3:name:NAME'\
-                $borg_standard_options
-            ;;
         (delete)
             _arguments \
                 '2:archives:__borg_archive'\
@@ -236,32 +191,41 @@ _borg() {
                 --save-space'[work slower, but using less space]'\
                 {-P,--prefix}'[only consider archive names starting with this prefix.]:PREFIX'\
                 {-a,--glob-archives}'[only consider archive names matching the glob]:GLOB'\
-                --sort-keys'[Comma-separated list of sorting keys]:KEYS'\
+                --sort-by'[Comma-separated list of sorting keys]:KEYS'\
                 --first'[consider first N archives after other filters were applied]:N'\
                 --last'[consider last N archives after other filters were applied]:N'\
-                $borg_standard_options
+                $borg_common_options
             ;;
-        (list)
+        (prune)
             _arguments \
                 '2:archives:__borg_archive'\
-                '*:path:_files'\
-                --short'[only print file/directory names, nothing else]'\
-                {--format,--list-format}'[specify format for file listing]:FORMAT'\
-                --json'[Only valid for listing repository contents. Format output as JSON.]'\
-                --json-lines'[Only valid for listing archive contents. Format output as JSON Lines. ]'\
+                {-n,--dry-run}'[do not change repository]'\
+                --force'[force pruning of corrupted archives]'\
+                {-s,--stats}'[print statistics for the deleted archive]'\
+                --list'[output verbose list of archives it keeps/prunes]'\
+                --keep-within'[keep all archives within this time interval]:INTERVAL'\
+                {--keep-last,--keep-secondly}'[number of secondly archives to keep]:N'\
+                --keep-minutely'[number of minutely archives to keep]:N'\
+                {-H,--keep-hourly}'[number of hourly archives to keep]:N'\
+                {-d,--keep-daily}'[number of daily archives to keep]:N'\
+                {-w,--keep-weekly}'[number of weekly archives to keep]:N'\
+                {-m,--keep-monthly}'[number of monthly archives to keep]:N'\
+                {-y,--keep-yearly}'[number of yearly archives to keep]:N'\
+                --save-space'[work slower, but using less space]'\
                 {-P,--prefix}'[only consider archive names starting with this prefix.]:PREFIX'\
                 {-a,--glob-archives}'[only consider archive names matching the glob]:GLOB'\
-                --sort-keys'[Comma-separated list of sorting keys]:KEYS'\
+                $borg_common_options
+            ;;
+        (info)
+            _arguments \
+                '2:archives:__borg_archive'\
+                --json'[format output as JSON]'\
+                {-P,--prefix}'[only consider archive names starting with this prefix.]:PREFIX'\
+                {-a,--glob-archives}'[only consider archive names matching the glob]:GLOB'\
+                --sort-by'[Comma-separated list of sorting keys]:KEYS'\
                 --first'[consider first N archives after other filters were applied]:N'\
                 --last'[consider last N archives after other filters were applied]:N'\
-                {-e,--exclude}'[exclude paths matching PATTERN]:PATTERN'\
-                --exclude-from'[read exclude patterns from EXCLUDEFILE, one per line]:_files'\
-                --pattern'[experimental: include/exclude paths matching PATTERN]:PATTERN'\
-                --patterns-from'[experimental: read include/exclude patterns from PATTERNFILE, one per line]:_files'\
-                --exclude-caches'[exclude directories that contain a CACHEDIR.TAG file ]'\
-                --exclude-if-present'[exclude directories that are tagged by containing a filesystem object with the given NAME]:NAME'\
-                {--keep-exclude-tags,--keep-tag-files}'[if tag objects are specified with --exclude-if-present, don’t omit the tag objects themselves]'\
-               $borg_standard_options
+                $borg_common_options
             ;;
         (mount)
             _arguments \
@@ -271,103 +235,161 @@ _borg() {
                 -o'[Extra mount options]:OPTS'\
                 {-P,--prefix}'[only consider archive names starting with this prefix.]:PREFIX'\
                 {-a,--glob-archives}'[only consider archive names matching the glob]:GLOB'\
-                --sort-keys'[Comma-separated list of sorting keys]:KEYS'\
+                --sort-by'[Comma-separated list of sorting keys]:KEYS'\
                 --first'[consider first N archives after other filters were applied]:N'\
                 --last'[consider last N archives after other filters were applied]:N'\
-                $borg_standard_options
+                $borg_common_options
             ;;
         (umount)
             _arguments \
                 '2:mountpoint:_files'\
-                $borg_standard_options
+                $borg_common_options
             ;;
-        (info)
+        (key)
+            case $keyCommand in
+                (change-passphrase)
+                    _arguments \
+                        '2:subCommand:(change-passphrase import export)'\
+                        '3:archives:__borg_archive'\
+                        $borg_common_options
+                    ;;
+                (export)
+                    _arguments \
+                        '2:subCommand:(change-passphrase import export)'\
+                        '3:archives:__borg_archive'\
+                        '4:path:_files'\
+                        --paper'[Create an export suitable for printing and later type-in]'\
+                        --qr-html'[Create an html file suitable for printing and later type-in or qr scan]'\
+                        $borg_common_options
+                    ;;
+                (import)
+                    _arguments \
+                        '2:subCommand:(change-passphrase import export)'\
+                        '3:archives:__borg_archive'\
+                        '4:path:_files'\
+                        --paper'[interactively import from a backup done with --paper]'\
+                        $borg_common_options
+                    ;;
+                *)
+                    _arguments \
+                        '2:subCommand:(change-passphrase import export)'\
+                        $borg_common_options
+                    ;;
+                esac
+            ;;
+        (upgrade)
             _arguments \
                 '2:archives:__borg_archive'\
-                --json'[format output as JSON]'\
-                {-P,--prefix}'[only consider archive names starting with this prefix.]:PREFIX'\
-                {-a,--glob-archives}'[only consider archive names matching the glob]:GLOB'\
-                --sort-keys'[Comma-separated list of sorting keys]:KEYS'\
-                --first'[consider first N archives after other filters were applied]:N'\
-                --last'[consider last N archives after other filters were applied]:N'\
-                {-e,--exclude}'[exclude paths matching PATTERN]:PATTERN'\
-                $borg_standard_options
+                {-n,--dry-run}'[do not change repository]'\
+                --inplace'[rewrite repository in place, with no chance of going back to older versions of the repository.]'\
+                --force'[Force upgrade]'\
+                --tam'[Enable manifest authentication (in key and cache).]'\
+                --disable-tam'[Disable manifest authentication (in key and cache).]'\
+                $borg_common_options
             ;;
-        (break-lock)
+        (recreate)
             _arguments \
                 '2:archives:__borg_archive'\
-                $borg_standard_options
+                '3:path:_files'\
+                --list'[output verbose list of items (files, dirs, ...)]'\
+                --filter'[only display items with the given status characters]:STATUSCHARS'\
+                {-n,--dry-run}'[do not create a backup archive]'\
+                {-s,--stats}'[print statistics at end]'\
+                {-e,--exclude}'[exclude paths matching PATTERN]:PATTERN'\
+                --exclude-from'[read exclude patterns from EXCLUDEFILE, one per line]:_files'\
+                --pattern'[experimental: include/exclude paths matching PATTERN]:PATTERN'\
+                --patterns-from'[experimental: read include/exclude patterns from PATTERNFILE, one per line]:_files'\
+                --exclude-caches'[exclude directories that contain a CACHEDIR.TAG file ]'\
+                --exclude-if-present'[exclude directories that are tagged by containing a filesystem object with the given NAME]:NAME'\
+                {--keep-exclude-tags,--keep-tag-files}'[if tag objects are specified with --exclude-if-present, don’t omit the tag objects themselves]'\
+                --target'[create a new archive with the name ARCHIVE]:ARCHIVE'\
+                {-c,--checkpoint-interval}'[write checkpoint every SECONDS seconds]:SECONDS'\
+                --comment'[add a comment text to the archive]:COMMENT'\
+                --timestamp'[manually specify the archive creation date/time]:TIMESTAMP'\
+                {-C,--compression}'[select compression algorithm]:COMPRESSION'\
+                --recompress'[recompress data chunks according to --compression if if-different]:PARAMS'\
+                --chunker-params'[pecify the chunker parameters]:PARAMS'\
+                $borg_common_options
             ;;
-        (prune)
+        (export-tar)
             _arguments \
                 '2:archives:__borg_archive'\
-                {-n,--dry-run}'[do not change repository]'\
-                --force'[]'\
-                {-s,--stats}'[]'\
-                --list'[]'\
-                --keep-within'[keep all archives within this time interval]:INERVAL'\
-                {--keep-last,--keep-secondly}'[number of secondly archives to keep]:N'\
-                --keep-minutely'[number of minutely archives to keep]:N'\
-                {-H,--keep-hourly}'[number of hourly archives to keep]:N'\
-                {-d,--keep-daily}'[number of daily archives to keep]:N'\
-                {-w,--keep-weekly}'[number of weekly archives to keep]:N'\
-                {-m,--keep-monthly}'[number of monthly archives to keep]:N'\
-                {-y,--keep-yearly}'[number of yearly archives to keep]:N'\
-                --save-space'[work slower, but using less space]'\
-                $borg_standard_options
+                '3:tar:_files'\
+                '4:path:_files'\
+                --tar-filter'[filter program to pipe data through]'\
+                --list'[output verbose list of items (files, dirs, ...)]'\
+                {-e,--exclude}'[exclude paths matching PATTERN]:PATTERN'\
+                --exclude-from'[read exclude patterns from EXCLUDEFILE, one per line]:_files'\
+                --pattern'[experimental: include/exclude paths matching PATTERN]:PATTERN'\
+                --patterns-from'[experimental: read include/exclude patterns from PATTERNFILE, one per line]:_files'\
+                --strip-components'[Remove the specified number of leading path elements. Paths with fewer elements will be silently skipped.]:NUMBER'\
+                $borg_common_options
             ;;
-        (upgrade)
+        (serve)
+            _arguments \
+                --restrict-to-path'[restrict repository access to PATH]:_files'\
+                --restrict-to-repository'[restrict repository access]:_files'\
+                --append-only'[only allow appending to repository segment files]'\
+                --storage-quota'[Override storage quota of the repository]:QUOTA'\
+                $borg_common_options
+            ;;
+        (config)
             _arguments \
                 '2:archives:__borg_archive'\
-                {-n,--dry-run}'[do not change repository]'\
-                --inplace'[rewrite repository in place, with no chance of going back to older versions of the repository.]'\
-                --force'[Force upgrade]'\
-                --tam'[Enable manifest authentication (in key and cache) (Borg 1.0.9 and later).]'\
-                --disable-tam'[Disable manifest authentication (in key and cache).]'\
-                $borg_standard_options
+                '3:name:NAME'\
+                '4:value:VALUE'\
+                {-c,--cache}'[get and set values from the repo cache]'\
+                {-d,--delete}'[delete the key from the config file]'\
+                $borg_common_options
             ;;
         (with-lock)
             _arguments \
                 '(-)2:archives:__borg_archive'\
-                $borg_standard_options
+                $borg_common_options
                 #'3:command:_command_names -e'\
                 #'4:arguments:_normal'
                 #TODO Debug this, getting "_tags:comptags:36: nesting level too deep" error
             ;;
+        (break-lock)
+            _arguments \
+                '2:archives:__borg_archive'\
+                $borg_common_options
+            ;;
         (benchmark)
             _arguments \
                 '2:type:(crud)'\
                 '3:repo:_files'\
                 '4:path:_files'\
-                $borg_standard_options
+                $borg_common_options
             ;;
         *)
             commands=(
-                'serve:start repository server process'
                 'init:initialize empty repository'
-                'check:verify repository'
-                'key:manage repository key'
-                'change-passphrase:change repository passphrase'
                 'create:create backup'
                 'extract:extract archive contents'
-                'export-tar:create tarball from archive'
-                'diff:find differences in archive contents'
+                'check:verify repository'
                 'rename:rename archive'
-                'delete:delete archive'
                 'list:list archive or repository contents'
+                'diff:find differences in archive contents'
+                'delete:delete archive'
+                'prune:prune archives'
+                'info:show repository or archive information'
                 'mount:mount repository'
                 'umount:umount repository'
-                'info:show repository or archive information'
-                'break-lock:break repository and cache locks'
-                'prune:prune archives'
+                'key:manage repository key'
                 'upgrade:upgrade repository format'
+                'recreate:recreate contents of existing archives'
+                'export-tar:create tarball from archive'
+                'serve:start repository server process'
+                'config:get/set options in repo/cache config'
                 'with-lock:run user command with lock held'
+                'break-lock:break repository and cache locks'
                 'benchmark:benchmark command'
             )
 
             _describe 'values' commands
-            _arguments $borg_standard_options
-                
+            _arguments $borg_common_options
+
         ;;
     esac
 }