mirror/restic
1
0
Fork 0
mirror of https://github.com/restic/restic.git synced 2024-12-22 15:57:07 +00:00
Code Issues Releases Wiki Activity

update restic help snippets in documentation

Browse source
This commit is contained in:
Michael Eischer 2022-06-12 13:07:42 +02:00
parent 420ddc03c9
commit 8a44258b6f
2 changed files with 6 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/047_tuning_backup_parameters.rst
View file

@ -58,10 +58,10 @@ In certain instances, such as very large repositories (in the TiB range) or very
upload connections, it is desirable to use larger pack sizes to reduce the number of upload connections, it is desirable to use larger pack sizes to reduce the number of
files in the repository and improve upload performance. Notable examples are OpenStack files in the repository and improve upload performance. Notable examples are OpenStack
Swift and some Google Drive Team accounts, where there are hard limits on the total Swift and some Google Drive Team accounts, where there are hard limits on the total
number of files. Larger pack size can also improve the backup speed for a repository number of files. Larger pack sizes can also improve the backup speed for a repository
stored on a local HDD. This can be achieved by either using the ``--min-packsize`` flag stored on a local HDD. This can be achieved by either using the ``--min-packsize`` option
or defining the ``$RESTIC_MIN_PACKSIZE`` environment variable. Restic currently defaults or defining the ``$RESTIC_MIN_PACKSIZE`` environment variable. Restic currently defaults
to a 16MiB pack size. to a 16 MiB pack size.
The side effect of increasing the pack size is requiring more disk space for temporary pack The side effect of increasing the pack size is requiring more disk space for temporary pack
files created before uploading. The space must be available in the system default temp files created before uploading. The space must be available in the system default temp
@ -69,6 +69,6 @@ directory, unless overwritten by setting the ``$TMPDIR`` environment variable.
depending on the backend the memory usage can also increase by a similar amount. Restic depending on the backend the memory usage can also increase by a similar amount. Restic
requires temporary space according to the pack size, multiplied by the number requires temporary space according to the pack size, multiplied by the number
of backend connections plus one. For example, if the backend uses 5 connections (the default of backend connections plus one. For example, if the backend uses 5 connections (the default
for most backends), with a target pack size of 64MiB, you'll need a *minimum* of 384MiB for most backends), with a target pack size of 64 MiB, you'll need a *minimum* of 384 MiB
of space in the temp directory. A bit of tuning may be required to strike a balance between of space in the temp directory. A bit of tuning may be required to strike a balance between
resource usage at the backup client and the number of pack files in the repository. resource usage at the backup client and the number of pack files in the repository.

5
doc/manual_rest.rst
View file

@ -56,7 +56,7 @@ Usage help is available:
--key-hint key key ID of key to try decrypting first (default: $RESTIC_KEY_HINT) --key-hint key key ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
--limit-download int limits downloads to a maximum rate in KiB/s. (default: unlimited) --limit-download int limits downloads to a maximum rate in KiB/s. (default: unlimited)
--limit-upload int limits uploads to a maximum rate in KiB/s. (default: unlimited) --limit-upload int limits uploads to a maximum rate in KiB/s. (default: unlimited)
--min-packsize uint set min pack size in MiB. (default: $RESTIC_MIN_PACKSIZE or 16) --min-packsize uint set min pack size in MiB. (default: $RESTIC_MIN_PACKSIZE)
--no-cache do not use a local cache --no-cache do not use a local cache
--no-lock do not lock the repository, this allows some operations on read-only repositories --no-lock do not lock the repository, this allows some operations on read-only repositories
-o, --option key=value set extended option (key=value, can be specified multiple times) -o, --option key=value set extended option (key=value, can be specified multiple times)
@ -129,7 +129,7 @@ command:
--key-hint key key ID of key to try decrypting first (default: $RESTIC_KEY_HINT) --key-hint key key ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
--limit-download int limits downloads to a maximum rate in KiB/s. (default: unlimited) --limit-download int limits downloads to a maximum rate in KiB/s. (default: unlimited)
--limit-upload int limits uploads to a maximum rate in KiB/s. (default: unlimited) --limit-upload int limits uploads to a maximum rate in KiB/s. (default: unlimited)
--min-packsize uint set min pack size in MiB. (default: $RESTIC_MIN_PACKSIZE or 16) --min-packsize uint set min pack size in MiB. (default: $RESTIC_MIN_PACKSIZE)
--no-cache do not use a local cache --no-cache do not use a local cache
--no-lock do not lock the repository, this allows some operations on read-only repositories --no-lock do not lock the repository, this allows some operations on read-only repositories
-o, --option key=value set extended option (key=value, can be specified multiple times) -o, --option key=value set extended option (key=value, can be specified multiple times)
@ -442,4 +442,3 @@ time it is used, so by looking at the timestamps of the sub directories of the
cache directory it can decide which sub directories are old and probably not cache directory it can decide which sub directories are old and probably not
needed any more. You can either remove these directories manually, or run a needed any more. You can either remove these directories manually, or run a
restic command with the ``--cleanup-cache`` flag. restic command with the ``--cleanup-cache`` flag.