Verified Commit f3f73250 authored by nfontrod's avatar nfontrod
Browse files

Readme.md: add help for delete, prune and compact subcommand

parent 0fc33ab2
......@@ -475,4 +475,67 @@ Example: If we have a `test` folder inside the `results` folder containing the f
```sh
- results/test/*.txt
+ results/test/c.txt
```
\ No newline at end of file
```
## Delete command
This command is a wrapper of the borg delete command. If you need information about the `borg delete` command, you can check [borg's documentation](https://borgbackup.readthedocs.io/en/stable/usage/delete.html)
This command can be used to delete specific archive directly by their name or by a prefix or a glob
Note that this command doesn't actually free disk space. You have to use `gblk compact` afterwards to achieve this
### gblk delete usage
To display the help of gblk delete, run the following command:
```
gblk delete -h # -h for compact help, --help for a more exhaustive help
```
To see what archive youére about to remove, enter
```
gblk delete --list --dry-run [OTHER_OPTIONS]
```
- The `dry-run` option will keep the archive unchanged
- The `--list` option will display what was deleted (without `--dry-run` option) or what would be deleted (with the `dry-run` option)
## Prune command
This command is a wrapper of the `borg prune` command. Check [borg's documentation](https://borgbackup.readthedocs.io/en/stable/usage/prune.html) for more details.
This command can be used to keep archives created during a given period of time and remove others.
Note that this command doesn't actually free disk space. You have to use `gblk compact` afterwards to achieve this.
### gblk prune usage
To display the help of `gblk prune`, run the following command:
by compacting segmen for compact help, --help for a more exhaustive help
```
- The `dry-run` option will keep the archive unchanged
- The `--list` option will display what was deleted (without `--dry-run` option) or what would be deleted (with the `dry-run` option)
## gblk compact
This command frees `.borg` repository space.
You can use this command after deleting one or more archives because it will really free repository space.
To use this command, you can run:
```
gblk compact # -h for compact help, --help for a more exhaustive help
```
To compact you `.borg` folder, you can run
```
gblk compact --verbose
```
If the amount of parts that need compaction is big the `.borg folder`, this command may take a while. Consider using the `--progress` option in this case.
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment