mirror of https://github.com/borgbackup/borg.git
build_usage
This commit is contained in:
Thomas Waldmann
parent
6561d7b478
commit
e48289e8b7
|
|
@ -14,7 +14,7 @@
|
|||
--umask M set umask to M (local only, default: 0077)
|
||||
--remote-path PATH use PATH as borg executable on the remote (default: "borg")
|
||||
--remote-ratelimit RATE set remote network upload rate limit in kiByte/s (default: 0=unlimited)
|
||||
--remote-buffer UPLOAD_BUFFER set upload buffer size in MiB. (default: 0=no buffer)
|
||||
--remote-buffer UPLOAD_BUFFER set upload buffer size in MiB. (default: 0=no buffer)
|
||||
--consider-part-files treat part files like normal files (e.g. to list/extract them)
|
||||
--debug-profile FILE Write execution profile in Borg format into FILE. For local use a Python-compatible file can be generated by suffixing FILE with ".pyprof".
|
||||
--rsh RSH Use this command to connect to the 'borg serve' process (default: 'ssh')
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ Depending on the amount of segments that need compaction, it may take a while,
|
|||
so consider using the ``--progress`` option.
|
||||
|
||||
A segment is compacted if the amount of saved space is above the percentage value
|
||||
given by the ``--threshold`` option. If ommitted, a threshold of 10% is used.
|
||||
given by the ``--threshold`` option. If omitted, a threshold of 10% is used.
|
||||
When using ``--verbose``, borg will output an estimate of the freed space.
|
||||
|
||||
After upgrading borg (server) to 1.2+, you can use ``borg compact --cleanup-commits``
|
||||
|
|
|
|||
|
|
@ -89,6 +89,8 @@ borg create
|
|||
+-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``--noflags`` | do not read and store flags (e.g. NODUMP, IMMUTABLE) into archive |
|
||||
+-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``--sparse`` | detect sparse holes in input (supported only by fixed chunker) |
|
||||
+-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``--files-cache MODE`` | operate files cache in MODE. default: ctime,size,inode |
|
||||
+-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``--read-special`` | open and read block and char device files as well as FIFOs as if they were regular files. Also follows symlinks pointing to these kinds of files. |
|
||||
|
|
@ -162,6 +164,7 @@ borg create
|
|||
--nobirthtime do not store birthtime (creation date) into archive
|
||||
--nobsdflags deprecated, use ``--noflags`` instead
|
||||
--noflags do not read and store flags (e.g. NODUMP, IMMUTABLE) into archive
|
||||
--sparse detect sparse holes in input (supported only by fixed chunker)
|
||||
--files-cache MODE operate files cache in MODE. default: ctime,size,inode
|
||||
--read-special open and read block and char device files as well as FIFOs as if they were regular files. Also follows symlinks pointing to these kinds of files.
|
||||
|
||||
|
|
|
|||
|
|
@ -23,6 +23,8 @@ borg delete
|
|||
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``-n``, ``--dry-run`` | do not change repository |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``--list`` | output verbose list of archives |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``-s``, ``--stats`` | print statistics for the deleted archive |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``--cache-only`` | delete only the local cache for the given repository |
|
||||
|
|
@ -68,6 +70,7 @@ borg delete
|
|||
|
||||
optional arguments
|
||||
-n, --dry-run do not change repository
|
||||
--list output verbose list of archives
|
||||
-s, --stats print statistics for the deleted archive
|
||||
--cache-only delete only the local cache for the given repository
|
||||
--force force deletion of corrupted archives, use ``--force --force`` in case ``--force`` does not work.
|
||||
|
|
@ -99,6 +102,8 @@ When you delete a complete repository, the security info and local cache for it
|
|||
with the ``--cache-only`` option, or keep the security info with the
|
||||
``--keep-security-info`` option.
|
||||
|
||||
When in doubt, use ``--dry-run --list`` to see what would be deleted.
|
||||
|
||||
When using ``--stats``, you will get some statistics about how much data was
|
||||
deleted - the "Deleted data" deduplicated size there is most interesting as
|
||||
that is how much your repository will shrink.
|
||||
|
|
|
|||
|
|
@ -156,7 +156,7 @@ Examples::
|
|||
|
||||
Via ``--pattern`` or ``--patterns-from`` you can define BOTH inclusion and exclusion
|
||||
of files using pattern prefixes ``+`` and ``-``. With ``--exclude`` and
|
||||
``--exlude-from`` ONLY excludes are defined.
|
||||
``--exclude-from`` ONLY excludes are defined.
|
||||
|
||||
Inclusion patterns are useful to include paths that are contained in an excluded
|
||||
path. The first matching pattern is used so if an include pattern matches before
|
||||
|
|
|
|||
|
|
@ -134,7 +134,11 @@ The rules are applied from secondly to yearly, and backups selected by previous
|
|||
rules do not count towards those of later rules. The time that each backup
|
||||
starts is used for pruning purposes. Dates and times are interpreted in
|
||||
the local timezone, and weeks go from Monday to Sunday. Specifying a
|
||||
negative number of archives to keep means that there is no limit.
|
||||
negative number of archives to keep means that there is no limit. As of borg
|
||||
1.2.0, borg will retain the oldest archive if any of the secondly, minutely,
|
||||
hourly, daily, weekly, monthly, or yearly rules was not otherwise able to meet
|
||||
its retention target. This enables the first chronological archive to continue
|
||||
aging until it is replaced by a newer archive that meets the retention criteria.
|
||||
|
||||
The ``--keep-last N`` option is doing the same as ``--keep-secondly N`` (and it will
|
||||
keep the last N archives under the assumption that you do not create more than one
|
||||
|
|
|
|||
Loading…
Reference in New Issue