KurlesHS/restic
1
0
Fork 0
forked from TrueCloudLab/restic
Code Pull requests Activity

doc: fix tmpdir documentation for windows

Browse source
This commit is contained in:
Michael Eischer 2024-05-20 20:48:29 +02:00
parent 8898f61717
commit 4021e67d97
3 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/040_backup.rst
View file

@ -654,7 +654,8 @@ environment variables. The following lists these environment variables:
RESTIC_PACK_SIZE Target size for pack files RESTIC_PACK_SIZE Target size for pack files
RESTIC_READ_CONCURRENCY Concurrency for file reads RESTIC_READ_CONCURRENCY Concurrency for file reads
TMPDIR Location for temporary files TMPDIR Location for temporary files (except Windows)
TMP Location for temporary files (only Windows)
AWS_ACCESS_KEY_ID Amazon S3 access key ID AWS_ACCESS_KEY_ID Amazon S3 access key ID
AWS_SECRET_ACCESS_KEY Amazon S3 secret access key AWS_SECRET_ACCESS_KEY Amazon S3 secret access key

3
doc/047_tuning_backup_parameters.rst
View file

@ -99,7 +99,8 @@ 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
directory, unless overwritten by setting the ``$TMPDIR`` environment variable. In addition, directory, unless overwritten by setting the ``$TMPDIR`` (except Windows) environment
variable (on Windows use ``$TMP`` or ``$TEMP``). In addition,
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

9
doc/manual_rest.rst
View file

@ -408,9 +408,12 @@ Temporary files
During some operations (e.g. ``backup`` and ``prune``) restic uses During some operations (e.g. ``backup`` and ``prune``) restic uses
temporary files to store data. These files will, by default, be saved to temporary files to store data. These files will, by default, be saved to
the system's temporary directory, on Linux this is usually located in the system's temporary directory, on Linux this is usually located in
``/tmp/``. The environment variable ``TMPDIR`` can be used to specify a ``/tmp/``. To specify a different directory for temporary files, set
different directory, e.g. to use the directory ``/var/tmp/restic-tmp`` the appropriate environment variable. On non-Windows operating systems,
instead of the default, set the environment variable like this: use the ``TMPDIR`` environment variable. On Windows, use either the
``TMP`` or ``TEMP`` environment variable. For example, to use the
directory ``/var/tmp/restic-tmp`` instead of the default, set the
environment variable as follows:
.. code-block:: console .. code-block:: console