diff --git a/Readme.md b/Readme.md index e5fb9420209b6f4ccae4123ca7549d52d8d901c5..1f18bf2db7f3af8196c4feadce8a9299397f65d9 100644 --- a/Readme.md +++ b/Readme.md @@ -14,7 +14,7 @@ To install borg, you can go to [borg's installation page](https://borgbackup.rea As gblk is written in rust, you need to install it with: -```bash +```sh curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh ``` @@ -409,7 +409,7 @@ Note that you can also display the differences between images. To be able to do so, [imagemagick](https://imagemagick.org/script/index.php) must be installed. -You you plan to make pdf diff, you might want to change imagemagick `/etc/ImageMagick-[VERSION]/policy.xml` and replacing the line: +If you plan to make pdf diff, you might want to change imagemagick `/etc/ImageMagick-[VERSION]/policy.xml` and replacing the line: ```xml <policy domain="coder" rights="none" pattern="PDF" /> @@ -422,7 +422,7 @@ by ``` Currently the following formats are -available for a nimage diff: PNG, JPEG, BMP, ICO, SVG, PDF +available for an image diff: PNG, JPEG, BMP, ICO, SVG, PDF Let's say, we have one image named im1.png inside the last commit. to compare it with the image im1.png in the result folder, you can type: @@ -489,17 +489,17 @@ Note that this command doesn't actually free disk space. You have to use `gblk c To display the help of gblk delete, run the following command: -``` +```bash gblk delete -h # -h for compact help, --help for a more exhaustive help ``` To see what archive you are about to remove, enter -``` +```sh gblk delete --list --dry-run [OTHER_OPTIONS] ``` -- The `dry-run` option will keep the archive unchanged +- 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 @@ -514,13 +514,13 @@ Note that this command doesn't actually free disk space. You have to use `gblk c To display the help of `gblk prune`, run the following command: -``` +```sh gblk prune -h # -h for compact help, --help for a more exhaustive help ``` To see what archives you are about to remove, enter -``` +```sh gblk prune --list --dry-run [OTHER_OPTIONS] ``` @@ -533,13 +533,13 @@ You can use this command after deleting one or more archives because it will rea To use this command, you can run: -``` +```sh gblk compact # -h for compact help, --help for a more exhaustive help ``` To compact you `.borg` folder, you can run -``` +```sh gblk compact --verbose ``` @@ -603,7 +603,7 @@ keep_monthly = 5 To remove a setting previouly defined in the local configuration file you can enter the following command -``` +```sh gblk config rm <KEY> [--global] ```