mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Merge pull request #2818 from takluyver/i2815 

Use code markup for command line option headings
This commit is contained in:
TW 2017-07-15 17:01:05 +02:00 committed by GitHub
parent fafa18b0a9 0fcdb97f5d
commit 26bc80f210
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/usage/notes.rst
View File

@ -5,14 +5,14 @@ Here are misc. notes about topics that are maybe not covered in enough detail in
.. _chunker-params: .. _chunker-params:
--chunker-params ``--chunker-params``
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
The chunker params influence how input files are cut into pieces (chunks) The chunker params influence how input files are cut into pieces (chunks)
which are then considered for deduplication. They also have a big impact on which are then considered for deduplication. They also have a big impact on
resource usage (RAM and disk space) as the amount of resources needed is resource usage (RAM and disk space) as the amount of resources needed is
(also) determined by the total amount of chunks in the repository (see (also) determined by the total amount of chunks in the repository (see
`Indexes / Caches memory usage` for details). :ref:`cache-memory-usage` for details).
``--chunker-params=10,23,16,4095`` results in a fine-grained deduplication| ``--chunker-params=10,23,16,4095`` results in a fine-grained deduplication|
and creates a big amount of chunks and thus uses a lot of resources to manage and creates a big amount of chunks and thus uses a lot of resources to manage
@ -50,8 +50,8 @@ a new repository when changing chunker params.
For more details, see :ref:`chunker_details`. For more details, see :ref:`chunker_details`.
--umask ``--umask``
~~~~~~~ ~~~~~~~~~~~
If you use ``--umask``, make sure that all repository-modifying borg commands If you use ``--umask``, make sure that all repository-modifying borg commands
(create, delete, prune) that access the repository in question use the same (create, delete, prune) that access the repository in question use the same
@ -60,8 +60,8 @@ If you use ``--umask``, make sure that all repository-modifying borg commands
If multiple machines access the same repository, this should hold true for all If multiple machines access the same repository, this should hold true for all
of them. of them.
--read-special ``--read-special``
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
The ``--read-special`` option is special - you do not want to use it for normal The ``--read-special`` option is special - you do not want to use it for normal
full-filesystem backups, but rather after carefully picking some targets for it. full-filesystem backups, but rather after carefully picking some targets for it.