|
95 | 95 | "FromVersion": "",
|
96 | 96 | "RemovedInVersion": ""
|
97 | 97 | },
|
| 98 | + { |
| 99 | + "Name": "group-by", |
| 100 | + "Alias": "g", |
| 101 | + "Default": "host,paths", |
| 102 | + "Description": "group snapshots by host, paths and/or tags, separated by comma (disable grouping with '')", |
| 103 | + "Once": true, |
| 104 | + "FromVersion": "0.16.0", |
| 105 | + "RemovedInVersion": "" |
| 106 | + }, |
98 | 107 | {
|
99 | 108 | "Name": "help",
|
100 | 109 | "Alias": "h",
|
|
171 | 180 | "Name": "parent",
|
172 | 181 | "Alias": "",
|
173 | 182 | "Default": "\"\"",
|
174 |
| - "Description": "use this parent snapshot (default: last snapshot in the repository that has the same target files/directories, and is not newer than the snapshot time)", |
| 183 | + "Description": "use this parent snapshot (default: latest snapshot in the group determined by --group-by and not newer than the timestamp determined by --time)", |
175 | 184 | "Once": true,
|
176 | 185 | "FromVersion": "",
|
177 | 186 | "RemovedInVersion": ""
|
|
339 | 348 | "Name": "with-cache",
|
340 | 349 | "Alias": "",
|
341 | 350 | "Default": "false",
|
342 |
| - "Description": "use the cache", |
| 351 | + "Description": "use existing cache, only read uncached data from repository", |
343 | 352 | "Once": true,
|
344 | 353 | "FromVersion": "",
|
345 | 354 | "RemovedInVersion": ""
|
|
592 | 601 | "FromVersion": "",
|
593 | 602 | "RemovedInVersion": ""
|
594 | 603 | },
|
| 604 | + { |
| 605 | + "Name": "human-readable", |
| 606 | + "Alias": "", |
| 607 | + "Default": "false", |
| 608 | + "Description": "print sizes in human readable format", |
| 609 | + "Once": true, |
| 610 | + "FromVersion": "0.16.0", |
| 611 | + "RemovedInVersion": "" |
| 612 | + }, |
595 | 613 | {
|
596 | 614 | "Name": "ignore-case",
|
597 | 615 | "Alias": "i",
|
|
711 | 729 | {
|
712 | 730 | "Name": "group-by",
|
713 | 731 | "Alias": "g",
|
714 |
| - "Default": "\"host,paths\"", |
| 732 | + "Default": "host,paths", |
715 | 733 | "Description": "group snapshots by host, paths and/or tags, separated by comma (disable grouping with '')",
|
716 | 734 | "Once": true,
|
717 | 735 | "FromVersion": "",
|
|
739 | 757 | "Name": "keep-daily",
|
740 | 758 | "Alias": "d",
|
741 | 759 | "Default": "0",
|
742 |
| - "Description": "keep the last n daily snapshots", |
| 760 | + "Description": "keep the last n daily snapshots (use 'unlimited' to keep all daily snapshots)", |
743 | 761 | "Once": true,
|
744 | 762 | "FromVersion": "",
|
745 | 763 | "RemovedInVersion": ""
|
|
748 | 766 | "Name": "keep-hourly",
|
749 | 767 | "Alias": "H",
|
750 | 768 | "Default": "0",
|
751 |
| - "Description": "keep the last n hourly snapshots", |
| 769 | + "Description": "keep the last n hourly snapshots (use 'unlimited' to keep all hourly snapshots)", |
752 | 770 | "Once": true,
|
753 | 771 | "FromVersion": "",
|
754 | 772 | "RemovedInVersion": ""
|
|
757 | 775 | "Name": "keep-last",
|
758 | 776 | "Alias": "l",
|
759 | 777 | "Default": "0",
|
760 |
| - "Description": "keep the last n snapshots", |
| 778 | + "Description": "keep the last n snapshots (use 'unlimited' to keep all snapshots)", |
761 | 779 | "Once": true,
|
762 | 780 | "FromVersion": "",
|
763 | 781 | "RemovedInVersion": ""
|
|
766 | 784 | "Name": "keep-monthly",
|
767 | 785 | "Alias": "m",
|
768 | 786 | "Default": "0",
|
769 |
| - "Description": "keep the last n monthly snapshots", |
| 787 | + "Description": "keep the last n monthly snapshots (use 'unlimited' to keep all monthly snapshots)", |
770 | 788 | "Once": true,
|
771 | 789 | "FromVersion": "",
|
772 | 790 | "RemovedInVersion": ""
|
|
784 | 802 | "Name": "keep-weekly",
|
785 | 803 | "Alias": "w",
|
786 | 804 | "Default": "0",
|
787 |
| - "Description": "keep the last n weekly snapshots", |
| 805 | + "Description": "keep the last n weekly snapshots (use 'unlimited' to keep all weekly snapshots)", |
788 | 806 | "Once": true,
|
789 | 807 | "FromVersion": "",
|
790 | 808 | "RemovedInVersion": ""
|
|
847 | 865 | "Name": "keep-yearly",
|
848 | 866 | "Alias": "y",
|
849 | 867 | "Default": "0",
|
850 |
| - "Description": "keep the last n yearly snapshots", |
| 868 | + "Description": "keep the last n yearly snapshots (use 'unlimited' to keep all yearly snapshots)", |
851 | 869 | "Once": true,
|
852 | 870 | "FromVersion": "",
|
853 | 871 | "RemovedInVersion": ""
|
|
1198 | 1216 | "FromVersion": "",
|
1199 | 1217 | "RemovedInVersion": ""
|
1200 | 1218 | },
|
| 1219 | + { |
| 1220 | + "Name": "human-readable", |
| 1221 | + "Alias": "", |
| 1222 | + "Default": "false", |
| 1223 | + "Description": "print sizes in human readable format", |
| 1224 | + "Once": true, |
| 1225 | + "FromVersion": "0.16.0", |
| 1226 | + "RemovedInVersion": "" |
| 1227 | + }, |
1201 | 1228 | {
|
1202 | 1229 | "Name": "long",
|
1203 | 1230 | "Alias": "l",
|
|
1453 | 1480 | "Name": "rebuild-index",
|
1454 | 1481 | "Description": "The \"rebuild-index\" command creates a new index based on the pack files in the\nrepository.",
|
1455 | 1482 | "FromVersion": "",
|
1456 |
| - "RemovedInVersion": "", |
| 1483 | + "RemovedInVersion": "0.16.0", |
1457 | 1484 | "Options": [
|
1458 | 1485 | {
|
1459 | 1486 | "Name": "help",
|
|
1492 | 1519 | }
|
1493 | 1520 | ]
|
1494 | 1521 | },
|
| 1522 | + { |
| 1523 | + "Name": "repair", |
| 1524 | + "Description": "Repair the repository", |
| 1525 | + "FromVersion": "0.16.0", |
| 1526 | + "RemovedInVersion": "", |
| 1527 | + "Options": [ |
| 1528 | + { |
| 1529 | + "Name": "help", |
| 1530 | + "Alias": "h", |
| 1531 | + "Default": "false", |
| 1532 | + "Description": "help for repair", |
| 1533 | + "Once": true, |
| 1534 | + "FromVersion": "0.16.0", |
| 1535 | + "RemovedInVersion": "" |
| 1536 | + } |
| 1537 | + ] |
| 1538 | + }, |
| 1539 | + { |
| 1540 | + "Name": "repair-index", |
| 1541 | + "Description": "The \"repair index\" command creates a new index based on the pack files in the\nrepository.", |
| 1542 | + "FromVersion": "0.16.0", |
| 1543 | + "RemovedInVersion": "", |
| 1544 | + "Options": [ |
| 1545 | + { |
| 1546 | + "Name": "help", |
| 1547 | + "Alias": "h", |
| 1548 | + "Default": "false", |
| 1549 | + "Description": "help for index", |
| 1550 | + "Once": true, |
| 1551 | + "FromVersion": "0.16.0", |
| 1552 | + "RemovedInVersion": "" |
| 1553 | + }, |
| 1554 | + { |
| 1555 | + "Name": "read-all-packs", |
| 1556 | + "Alias": "", |
| 1557 | + "Default": "false", |
| 1558 | + "Description": "read all pack files to generate new index from scratch", |
| 1559 | + "Once": true, |
| 1560 | + "FromVersion": "0.16.0", |
| 1561 | + "RemovedInVersion": "" |
| 1562 | + } |
| 1563 | + ] |
| 1564 | + }, |
| 1565 | + { |
| 1566 | + "Name": "repair-snapshots", |
| 1567 | + "Description": "The \"repair snapshots\" command repairs broken snapshots. It scans the given\nsnapshots and generates new ones with damaged directories and file contents\nremoved. If the broken snapshots are deleted, a prune run will be able to\nclean up the repository.\n\nThe command depends on a correct index, thus make sure to run \"repair index\"\nfirst!", |
| 1568 | + "FromVersion": "0.16.0", |
| 1569 | + "RemovedInVersion": "", |
| 1570 | + "Options": [ |
| 1571 | + { |
| 1572 | + "Name": "dry-run", |
| 1573 | + "Alias": "n", |
| 1574 | + "Default": "false", |
| 1575 | + "Description": "do not do anything, just print what would be done", |
| 1576 | + "Once": true, |
| 1577 | + "FromVersion": "0.16.0", |
| 1578 | + "RemovedInVersion": "" |
| 1579 | + }, |
| 1580 | + { |
| 1581 | + "Name": "forget", |
| 1582 | + "Alias": "", |
| 1583 | + "Default": "false", |
| 1584 | + "Description": "remove original snapshots after creating new ones", |
| 1585 | + "Once": true, |
| 1586 | + "FromVersion": "0.16.0", |
| 1587 | + "RemovedInVersion": "" |
| 1588 | + }, |
| 1589 | + { |
| 1590 | + "Name": "help", |
| 1591 | + "Alias": "h", |
| 1592 | + "Default": "false", |
| 1593 | + "Description": "help for snapshots", |
| 1594 | + "Once": true, |
| 1595 | + "FromVersion": "0.16.0", |
| 1596 | + "RemovedInVersion": "" |
| 1597 | + }, |
| 1598 | + { |
| 1599 | + "Name": "host", |
| 1600 | + "Alias": "H", |
| 1601 | + "Default": "", |
| 1602 | + "Description": "only consider snapshots for this host (can be specified multiple times)", |
| 1603 | + "Once": false, |
| 1604 | + "FromVersion": "0.16.0", |
| 1605 | + "RemovedInVersion": "" |
| 1606 | + }, |
| 1607 | + { |
| 1608 | + "Name": "path", |
| 1609 | + "Alias": "", |
| 1610 | + "Default": "", |
| 1611 | + "Description": "only consider snapshots including this (absolute) path (can be specified multiple times)", |
| 1612 | + "Once": false, |
| 1613 | + "FromVersion": "0.16.0", |
| 1614 | + "RemovedInVersion": "" |
| 1615 | + }, |
| 1616 | + { |
| 1617 | + "Name": "tag", |
| 1618 | + "Alias": "", |
| 1619 | + "Default": "", |
| 1620 | + "Description": "only consider snapshots including tag[,tag,...] (can be specified multiple times)", |
| 1621 | + "Once": false, |
| 1622 | + "FromVersion": "0.16.0", |
| 1623 | + "RemovedInVersion": "" |
| 1624 | + } |
| 1625 | + ] |
| 1626 | + }, |
1495 | 1627 | {
|
1496 | 1628 | "Name": "restore",
|
1497 | 1629 | "Description": "The \"restore\" command extracts the data from a snapshot from the repository to\na directory.\n\nThe special snapshot \"latest\" can be used to restore the latest snapshot in the\nrepository.",
|
|
1741 | 1873 | {
|
1742 | 1874 | "Name": "group-by",
|
1743 | 1875 | "Alias": "g",
|
1744 |
| - "Default": "\"\"", |
| 1876 | + "Default": "", |
1745 | 1877 | "Description": "group snapshots by host, paths and/or tags, separated by comma",
|
1746 | 1878 | "Once": true,
|
1747 | 1879 | "FromVersion": "0.10.0",
|
|
1972 | 2104 | },
|
1973 | 2105 | {
|
1974 | 2106 | "Name": "__default",
|
1975 |
| - "Description": "restic is a backup program which allows saving multiple revisions of files and\ndirectories in an encrypted repository stored on different backends.", |
| 2107 | + "Description": "restic is a backup program which allows saving multiple revisions of files and\ndirectories in an encrypted repository stored on different backends.\n\nThe full documentation can be found at https://restic.readthedocs.io/ .", |
1976 | 2108 | "FromVersion": "",
|
1977 | 2109 | "RemovedInVersion": "",
|
1978 | 2110 | "Options": [
|
1979 | 2111 | {
|
1980 | 2112 | "Name": "cacert",
|
1981 | 2113 | "Alias": "",
|
1982 | 2114 | "Default": "",
|
1983 |
| - "Description": "file to load root certificates from (default: use system certificates)", |
| 2115 | + "Description": "file to load root certificates from (default: use system certificates or $RESTIC_CACERT)", |
1984 | 2116 | "Once": false,
|
1985 | 2117 | "FromVersion": "",
|
1986 | 2118 | "RemovedInVersion": ""
|
|
2007 | 2139 | "Name": "compression",
|
2008 | 2140 | "Alias": "",
|
2009 | 2141 | "Default": "auto",
|
2010 |
| - "Description": "compression mode (only available for repository format version 2), one of (auto|off|max)", |
| 2142 | + "Description": "compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION)", |
2011 | 2143 | "Once": true,
|
2012 | 2144 | "FromVersion": "0.14.0",
|
2013 | 2145 | "RemovedInVersion": ""
|
|
2147 | 2279 | "FromVersion": "0.11.0",
|
2148 | 2280 | "RemovedInVersion": ""
|
2149 | 2281 | },
|
| 2282 | + { |
| 2283 | + "Name": "retry-lock", |
| 2284 | + "Alias": "", |
| 2285 | + "Default": "0s", |
| 2286 | + "Description": "retry to lock the repository if it is already locked, takes a value like 5m or 2h (default: no retries)", |
| 2287 | + "Once": true, |
| 2288 | + "FromVersion": "0.16.0", |
| 2289 | + "RemovedInVersion": "" |
| 2290 | + }, |
2150 | 2291 | {
|
2151 | 2292 | "Name": "tls-client-cert",
|
2152 | 2293 | "Alias": "",
|
2153 | 2294 | "Default": "\"\"",
|
2154 |
| - "Description": "path to a file containing PEM encoded TLS client certificate and private key", |
| 2295 | + "Description": "path to a file containing PEM encoded TLS client certificate and private key (default: $RESTIC_TLS_CLIENT_CERT)", |
2155 | 2296 | "Once": true,
|
2156 | 2297 | "FromVersion": "",
|
2157 | 2298 | "RemovedInVersion": ""
|
|
0 commit comments