1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-24 00:37:56 +00:00

add docs for item flags / status output, fixes #402

This commit is contained in:
Thomas Waldmann 2015-11-15 14:31:25 +01:00
parent fd5ccadcac
commit d6b8de943b
2 changed files with 33 additions and 7 deletions

View file

@ -245,13 +245,6 @@ def _process(self, archive, cache, excludes, exclude_caches, exclude_if_present,
self.print_warning('Unknown file type: %s', path) self.print_warning('Unknown file type: %s', path)
return return
# Status output # Status output
# A lowercase character means a file type other than a regular file,
# borg usually just stores them. E.g. (d)irectory.
# Hardlinks to already seen content are indicated by (h).
# A uppercase character means a regular file that was (A)dded,
# (M)odified or was (U)nchanged.
# Note: A/M/U is relative to the "files" cache, not to the repo.
# This would be an issue if the files cache is not used.
if status is None: if status is None:
if not dry_run: if not dry_run:
status = '?' # need to add a status code somewhere status = '?' # need to add a status code somewhere

View file

@ -411,6 +411,39 @@ Additional Notes
Here are misc. notes about topics that are maybe not covered in enough detail in the usage section. Here are misc. notes about topics that are maybe not covered in enough detail in the usage section.
Item flags
~~~~~~~~~~
`borg create -v` outputs a verbose list of all files, directories and other
file system items it considered. For each item, it prefixes a single-letter
flag that indicates type and/or status of the item.
A uppercase character represents the status of a regular file relative to the
"files" cache (not relative to the repo - this is an issue if the files cache
is not used). Metadata is stored in any case and for 'A' and 'M' also new data
chunks are stored. For 'U' all data chunks refer to already existing chunks.
- 'A' = regular file, added
- 'M' = regular file, modified
- 'U' = regular file, unchanged
A lowercase character means a file type other than a regular file,
borg usually just stores their metadata:
- 'd' = directory
- 'b' = block device
- 'c' = char device
- 'h' = regular file, hardlink (to already seen inodes)
- 's' = symlink
- 'f' = fifo
Other flags used include:
- 'i' = backup data was read from standard input (stdin)
- '-' = dry run, item was *not* backed up
- '?' = missing status code (if you see this, please file a bug report!)
--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)