mirror of
https://github.com/amadvance/snapraid.git
synced 2026-11-21 23:46:27 -05:00
Auto update
This commit is contained in:
parent
b53302f090
commit
c8c7ddd3d8
16 changed files with 3051 additions and 3046 deletions
|
|
@ -93,11 +93,11 @@ Description
|
|||
which are designed to be used by tools monitoring the SnapRAID
|
||||
processing state. The tags provide information in an easy-to-parse
|
||||
format, ideal for automation and integration.
|
||||
</p><p>To capture these structured log tags, you must use the `--log` option
|
||||
</p><p>To capture these structured log tags, you must use the <b>--log</b> option
|
||||
with SnapRAID.
|
||||
</p><p>You can direct the output to a specific file, or force the output to
|
||||
the standard output or standard error using the special arguments
|
||||
`>&1` or `>&2`. Note that these arguments often need to be quoted on
|
||||
<b>>&1</b> or <b>>&2</b>. Note that these arguments often need to be quoted on
|
||||
the command line to prevent the shell from interpreting them.
|
||||
</p><p>Example:
|
||||
</p><pre>
|
||||
|
|
@ -113,16 +113,16 @@ NAME:VALUE:VALUE:VALUE...<EOL>
|
|||
NAME
|
||||
</div><div class="manual-option-description">
|
||||
This is the primary tag identifier, always a lowercase string
|
||||
without spaces (e.g., `summary`, `block`).
|
||||
without spaces (e.g., <b>summary</b>, <b>block</b>).
|
||||
</div>
|
||||
</div>
|
||||
<div class="manual-option-entry">
|
||||
<div class="manual-option-name">
|
||||
VALUE
|
||||
</div><div class="manual-option-description">
|
||||
Following the `NAME`, these can be additional sub-identifiers,
|
||||
Following the <b>NAME</b>, these can be additional sub-identifiers,
|
||||
descriptive names (like a disk name), or numeric/string data
|
||||
values. They are separated by a colon `:`.
|
||||
values. They are separated by a colon <b>:</b>.
|
||||
</div>
|
||||
</div>
|
||||
<div class="manual-option-entry">
|
||||
|
|
@ -136,7 +136,7 @@ Each tag is terminated by an end-of-line character.
|
|||
<p>This document provides a summary of the tags generated by SnapRAID.
|
||||
For the most detailed and up-to-date information regarding the meaning
|
||||
and context of the values, it is recommended to check the source
|
||||
code's `log_tag()` statements.
|
||||
code's <b>log_tag()</b> statements.
|
||||
</p><p>When a path is output, it is always escaped using a backslash (\) as
|
||||
the escape character.
|
||||
</p><p>The following characters are escaped into sequences:
|
||||
|
|
@ -170,15 +170,15 @@ is escaped to \\.
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<p>Some tags are output only when the `--gui` or `--gui-verbose` option
|
||||
<p>Some tags are output only when the <b>--gui</b> or <b>--gui-verbose</b> option
|
||||
is used. They provide extra verbose state and runtime progress only
|
||||
useful for a GUI interface.
|
||||
</p><p>Integer values are marked as `uint` when they are unsigned and as `int`
|
||||
</p><p>Integer values are marked as <b>uint</b> when they are unsigned and as <b>int</b>
|
||||
when they are signed. However, for practical purposes you can treat
|
||||
all of them as signed integers.
|
||||
All integer values should be assumed to be 64 bits wide, regardless
|
||||
of the signed/unsigned marker.
|
||||
Floating point values are marked as `float`.
|
||||
Floating point values are marked as <b>float</b>.
|
||||
</p></div>
|
||||
<div class="manual-section-level-1">
|
||||
<h1 id="sec2" class="manual-title-level-1">
|
||||
|
|
@ -249,8 +249,8 @@ The UUID of the filesystem containing the dir.
|
|||
<div class="manual-option-name">
|
||||
mode:<raidname>
|
||||
</div><div class="manual-option-description">
|
||||
The RAID mode used. One of `par1`, `par2`, `par3`, `par4`,
|
||||
`par5`, `par6` or `parz`. The number indicates the maximum
|
||||
The RAID mode used. One of <b>par1</b>, <b>par2</b>, <b>par3</b>, <b>par4</b>,
|
||||
<b>par5</b>, <b>par6</b> or <b>parz</b>. The number indicates the maximum
|
||||
number of simultaneous disk failures the array can withstand.
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -269,11 +269,11 @@ The parity files as defined in the configuration file.
|
|||
<div class="manual-tag-name">
|
||||
<parity_level>[/<split_index>]
|
||||
</div><div class="manual-tag-description">
|
||||
One of `parity`, `2-parity`,
|
||||
..., `6-parity`. This corresponds to the level of redundancy.
|
||||
One of <b>parity</b>, <b>2-parity</b>,
|
||||
..., <b>6-parity</b>. This corresponds to the level of redundancy.
|
||||
In case of split parity, the parity name is followed
|
||||
by `/N` to indicate the split index, where N starts
|
||||
from 0. The `/0` is always omitted.
|
||||
by <b>/N</b> to indicate the split index, where N starts
|
||||
from 0. The <b>/0</b> is always omitted.
|
||||
</div>
|
||||
</div>
|
||||
<div class="manual-tag-entry">
|
||||
|
|
@ -371,7 +371,7 @@ The free size in the data disk (uint).
|
|||
<div class="manual-tag-name">
|
||||
<type>
|
||||
</div><div class="manual-tag-description">
|
||||
The filesystem type. A string like `ext4`, `ntfs`.
|
||||
The filesystem type. A string like <b>ext4</b>, <b>ntfs</b>.
|
||||
</div>
|
||||
</div>
|
||||
<div class="manual-tag-entry">
|
||||
|
|
@ -410,7 +410,7 @@ The free size in the parity disk (uint).
|
|||
<div class="manual-tag-name">
|
||||
<type>
|
||||
</div><div class="manual-tag-description">
|
||||
The filesystem type. A string like `ext4`, `ntfs`.
|
||||
The filesystem type. A string like <b>ext4</b>, <b>ntfs</b>.
|
||||
</div>
|
||||
</div>
|
||||
<div class="manual-tag-entry">
|
||||
|
|
@ -605,11 +605,11 @@ The parity split info as stored in the content file.
|
|||
<div class="manual-tag-name">
|
||||
<parity_level>[/<split_index>]
|
||||
</div><div class="manual-tag-description">
|
||||
One of `parity`, `2-parity`,
|
||||
..., `6-parity`. This corresponds to the level of redundancy.
|
||||
One of <b>parity</b>, <b>2-parity</b>,
|
||||
..., <b>6-parity</b>. This corresponds to the level of redundancy.
|
||||
In case of split parity, the parity name is followed
|
||||
by `/N` to indicate the split index, where N starts
|
||||
from 0. The `/0` is always omitted.
|
||||
by <b>/N</b> to indicate the split index, where N starts
|
||||
from 0. The <b>/0</b> is always omitted.
|
||||
</div>
|
||||
</div>
|
||||
<div class="manual-tag-entry">
|
||||
|
|
@ -639,7 +639,7 @@ The size of the parity file (uint).
|
|||
<div class="manual-option-name">
|
||||
content_info:<kind>:<counter>
|
||||
</div><div class="manual-option-description">
|
||||
The counters in the content file. The `kind` is
|
||||
The counters in the content file. The <b>kind</b> is
|
||||
one of the following:
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -719,7 +719,7 @@ The total counter of blocks.
|
|||
<div class="manual-option-name">
|
||||
bucket_count:<uint>
|
||||
</div><div class="manual-option-description">
|
||||
Total number of info records listed with `bucket`.
|
||||
Total number of info records listed with <b>bucket</b>.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -728,7 +728,7 @@ Total number of info records listed with `bucket`.
|
|||
<div class="manual-option-name">
|
||||
bucket_block_count:<uint>
|
||||
</div><div class="manual-option-description">
|
||||
Total number of info blocks listed with `bucket`. This is the
|
||||
Total number of info blocks listed with <b>bucket</b>. This is the
|
||||
sum of all the counters listed.
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -804,7 +804,7 @@ The current time in human format.
|
|||
<div class="manual-option-name">
|
||||
command:<command>
|
||||
</div><div class="manual-option-description">
|
||||
The command run. One of `sync`, `scrub`, `check`, `fix`, `status`, ...
|
||||
The command run. One of <b>sync</b>, <b>scrub</b>, <b>check</b>, <b>fix</b>, <b>status</b>, ...
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -832,7 +832,7 @@ The total memory currently used by the application in bytes (uint).
|
|||
<div class="manual-option-name">
|
||||
memory:block:<bytes>
|
||||
</div><div class="manual-option-description">
|
||||
Size of the internal `snapraid_block` structure in bytes (uint).
|
||||
Size of the internal <b>snapraid_block</b> structure in bytes (uint).
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -841,7 +841,7 @@ Size of the internal `snapraid_block` structure in bytes (uint).
|
|||
<div class="manual-option-name">
|
||||
memory:extent:<bytes>
|
||||
</div><div class="manual-option-description">
|
||||
Size of the internal `snapraid_extent` structure in bytes (uint).
|
||||
Size of the internal <b>snapraid_extent</b> structure in bytes (uint).
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -850,7 +850,7 @@ Size of the internal `snapraid_extent` structure in bytes (uint).
|
|||
<div class="manual-option-name">
|
||||
memory:file:<bytes>
|
||||
</div><div class="manual-option-description">
|
||||
Size of the internal `snapraid_file` structure in bytes (uint).
|
||||
Size of the internal <b>snapraid_file</b> structure in bytes (uint).
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -859,7 +859,7 @@ Size of the internal `snapraid_file` structure in bytes (uint).
|
|||
<div class="manual-option-name">
|
||||
memory:link:<bytes>
|
||||
</div><div class="manual-option-description">
|
||||
Size of the internal `snapraid_link` structure in bytes (uint).
|
||||
Size of the internal <b>snapraid_link</b> structure in bytes (uint).
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -868,7 +868,7 @@ Size of the internal `snapraid_link` structure in bytes (uint).
|
|||
<div class="manual-option-name">
|
||||
memory:dir:<bytes>
|
||||
</div><div class="manual-option-description">
|
||||
Size of the internal `snapraid_dir` structure in bytes (uint).
|
||||
Size of the internal <b>snapraid_dir</b> structure in bytes (uint).
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -886,7 +886,7 @@ scan:equal:<disk_name>:<path>
|
|||
</div><div class="manual-option-description">
|
||||
A file, link, or directory is equal (unchanged).
|
||||
No action is required for this item.
|
||||
Only produced when `--gui-verbose` option is used.
|
||||
Only produced when <b>--gui-verbose</b> option is used.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -913,7 +913,7 @@ Path to the file/link relative to the disk mount
|
|||
scan:add:<disk_name>:<path>
|
||||
</div><div class="manual-option-description">
|
||||
A new file or link was found that is not in the content file.
|
||||
This item will be added to the array in a `sync`.
|
||||
This item will be added to the array in a <b>sync</b>.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -933,7 +933,7 @@ since the last sync.
|
|||
scan:update:<disk_name>:<path>
|
||||
</div><div class="manual-option-description">
|
||||
A file or link has been updated (size, timestamp, or link target changed).
|
||||
This item will have its content data blocks re-hashed in a `sync`.
|
||||
This item will have its content data blocks re-hashed in a <b>sync</b>.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -997,7 +997,7 @@ scan:restore:<disk_name>:<path>
|
|||
</div><div class="manual-option-description">
|
||||
A file's inode has changed but not its date-time and size,
|
||||
which suggests the file may be restored from backup.
|
||||
The file won't be re-hashed in `sync` as its precomputed hash
|
||||
The file won't be re-hashed in <b>sync</b> as its precomputed hash
|
||||
is assumed to be correct.
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1078,7 +1078,7 @@ name/time/size but with a new inode (uint).
|
|||
<div class="manual-option-name">
|
||||
summary:exit:<status>
|
||||
</div><div class="manual-option-description">
|
||||
Logs the overall exit status of the command. The `status` is
|
||||
Logs the overall exit status of the command. The <b>status</b> is
|
||||
one of the following:
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1097,7 +1097,7 @@ The array is already synchronized.
|
|||
diff
|
||||
</div><div class="manual-tag-description">
|
||||
Indicates that differences were found.
|
||||
The array needs a `sync` operation.
|
||||
The array needs a <b>sync</b> operation.
|
||||
</div>
|
||||
</div>
|
||||
<div class="manual-tag-entry">
|
||||
|
|
@ -1105,7 +1105,7 @@ The array needs a `sync` operation.
|
|||
unsynced
|
||||
</div><div class="manual-tag-description">
|
||||
The array has an interrupted sync.
|
||||
The array needs another `sync` operation.
|
||||
The array needs another <b>sync</b> operation.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1115,8 +1115,8 @@ The array needs another `sync` operation.
|
|||
General Progress and Execution Tags
|
||||
</h1>
|
||||
<p>These tags are used to report the runtime processing of the commands
|
||||
`sync`, `scrub`, `check` and `fix`.
|
||||
Only produced when `--gui` option is used.
|
||||
<b>sync</b>, <b>scrub</b>, <b>check</b> and <b>fix</b>.
|
||||
Only produced when <b>--gui</b> option is used.
|
||||
</p><div class="manual-option-list">
|
||||
<div class="manual-option-entry">
|
||||
<div class="manual-option-name">
|
||||
|
|
@ -1285,8 +1285,8 @@ Messages printed to the screen.
|
|||
<div class="manual-tag-name">
|
||||
<level>
|
||||
</div><div class="manual-tag-description">
|
||||
One of `fatal`, `fatal_hardware`, `error`, `error_hardware`,
|
||||
`expected`, `status`, `progress` or `verbose`.
|
||||
One of <b>fatal</b>, <b>fatal_hardware</b>, <b>error</b>, <b>error_hardware</b>,
|
||||
<b>expected</b>, <b>status</b>, <b>progress</b> or <b>verbose</b>.
|
||||
</div>
|
||||
</div>
|
||||
<div class="manual-tag-entry">
|
||||
|
|
@ -1295,7 +1295,7 @@ fatal, fatal_hardware
|
|||
</div><div class="manual-tag-description">
|
||||
A fatal error occurred. Program will
|
||||
abort after this message.
|
||||
The `hardware` one means that the problem was caused
|
||||
The <b>hardware</b> one means that the problem was caused
|
||||
by a hardware failure, like an Input/Output error
|
||||
or a silent data error.
|
||||
</div>
|
||||
|
|
@ -1306,7 +1306,7 @@ error, error_hardware
|
|||
</div><div class="manual-tag-description">
|
||||
A generic error condition that doesn't
|
||||
prevent the program to continue.
|
||||
The `hardware` one means that the problem was caused
|
||||
The <b>hardware</b> one means that the problem was caused
|
||||
by a hardware failure, like an Input/Output error
|
||||
or a silent data error.
|
||||
</div>
|
||||
|
|
@ -1316,7 +1316,7 @@ or a silent data error.
|
|||
expected
|
||||
</div><div class="manual-tag-description">
|
||||
An expected error condition. At present it
|
||||
happens only when using the `-m` option with files
|
||||
happens only when using the <b>-m</b> option with files
|
||||
expected missing.
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1481,8 +1481,8 @@ device.
|
|||
</div><div class="manual-tag-description">
|
||||
The configured name of the disk.
|
||||
In case of split parity, the parity name is followed
|
||||
by `/N` to indicate the split index, where N starts
|
||||
from 0. The `/0` is always omitted.
|
||||
by <b>/N</b> to indicate the split index, where N starts
|
||||
from 0. The <b>/0</b> is always omitted.
|
||||
</div>
|
||||
</div>
|
||||
<div class="manual-tag-entry">
|
||||
|
|
@ -1682,7 +1682,7 @@ are being spun back up to resume the operation.
|
|||
<h1 id="sec8" class="manual-title-level-1">
|
||||
Command Status Tags
|
||||
</h1>
|
||||
<p>This section describes the tags output with the `status` command.
|
||||
<p>This section describes the tags output with the <b>status</b> command.
|
||||
</p><div class="manual-section-level-3">
|
||||
<h3 class="manual-title-level-3">
|
||||
Summary Tags
|
||||
|
|
@ -1711,7 +1711,7 @@ combined.
|
|||
summary:parity_block_total:<name>:<uint>
|
||||
</div><div class="manual-option-description">
|
||||
Total blocks available for a specific parity level (e.g.,
|
||||
`parity`, `2-parity`).
|
||||
<b>parity</b>, <b>2-parity</b>).
|
||||
</div>
|
||||
</div>
|
||||
<div class="manual-option-entry">
|
||||
|
|
@ -1793,7 +1793,7 @@ This is the effective maximum protection size.
|
|||
<div class="manual-option-name">
|
||||
summary:hash:<name>
|
||||
</div><div class="manual-option-description">
|
||||
The current hash algorithm in use (e.g., `sha256`).
|
||||
The current hash algorithm in use (e.g., <b>sha256</b>).
|
||||
</div>
|
||||
</div>
|
||||
<div class="manual-option-entry">
|
||||
|
|
@ -1866,7 +1866,7 @@ Days ago the newest block was last scrubbed.
|
|||
<div class="manual-option-name">
|
||||
summary:exit:<status>
|
||||
</div><div class="manual-option-description">
|
||||
Logs the overall exit status of the command. The `status` is
|
||||
Logs the overall exit status of the command. The <b>status</b> is
|
||||
one of the following:
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1884,7 +1884,7 @@ No issues. The array is fully synchronized and healthy.
|
|||
bad
|
||||
</div><div class="manual-tag-description">
|
||||
The array has some blocks marked as bad.
|
||||
The array needs a `-e fix` and and a `-p bad scrub`
|
||||
The array needs a <b>-e fix</b> and and a <b>-p bad scrub</b>
|
||||
operation.
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1893,7 +1893,7 @@ operation.
|
|||
unsynced
|
||||
</div><div class="manual-tag-description">
|
||||
The array has an interrupted sync.
|
||||
The array needs another `sync` operation.
|
||||
The array needs another <b>sync</b> operation.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1989,7 +1989,7 @@ This is the logical limit imposed by the parity files.
|
|||
<div class="manual-option-name">
|
||||
summary:disk_block_max:<name>:<uint>
|
||||
</div><div class="manual-option-description">
|
||||
Maximum usable blocks (minimum of `..._by_space` and `..._by_parity`).
|
||||
Maximum usable blocks (minimum of <b>..._by_space</b> and <b>..._by_parity</b>).
|
||||
</div>
|
||||
</div>
|
||||
<div class="manual-option-entry">
|
||||
|
|
@ -2011,14 +2011,14 @@ Used space on the disk in bytes.
|
|||
<div class="manual-option-name">
|
||||
summary:disk_free:<name>:<uint>
|
||||
</div><div class="manual-option-description">
|
||||
Free usable space on the disk in bytes, limited by `disk_block_max`.
|
||||
Free usable space on the disk in bytes, limited by <b>disk_block_max</b>.
|
||||
</div>
|
||||
</div>
|
||||
<div class="manual-option-entry">
|
||||
<div class="manual-option-name">
|
||||
summary:disk_use_percent:<name>:<uint>
|
||||
</div><div class="manual-option-description">
|
||||
Disk use percentage relative to `disk_block_max`.
|
||||
Disk use percentage relative to <b>disk_block_max</b>.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -2051,8 +2051,8 @@ operations.
|
|||
scrub_graph_range:<max_columns>:<max_height>
|
||||
</div><div class="manual-option-description">
|
||||
Dimensions of the scrub history graph obtained from the
|
||||
`content_info:bucket` records. This provides the boundary for the
|
||||
precomputed graph data available in the `scrub_graph_bar` tags.
|
||||
<b>content_info:bucket</b> records. This provides the boundary for the
|
||||
precomputed graph data available in the <b>scrub_graph_bar</b> tags.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -2119,7 +2119,7 @@ Count of newly synced (unscrubbed) blocks in that day range.
|
|||
<h1 id="sec9" class="manual-title-level-1">
|
||||
Command Sync/Scrub Tags
|
||||
</h1>
|
||||
<p>Tags specific for the `sync` and `scrub` commands.
|
||||
<p>Tags specific for the <b>sync</b> and <b>scrub</b> commands.
|
||||
Also the error tags are possible.
|
||||
</p><div class="manual-section-level-3">
|
||||
<h3 class="manual-title-level-3">
|
||||
|
|
@ -2134,7 +2134,7 @@ hash_summary:error_soft:<count>
|
|||
Logs the total count of file-related errors that caused a
|
||||
block to be skipped during the hashing phase. These are often
|
||||
due to file changes (missing, size/time change) during the
|
||||
sync operation. This happens only in `sync`.
|
||||
sync operation. This happens only in <b>sync</b>.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -2190,7 +2190,7 @@ The total number of I/O errors encountered (uint).
|
|||
<div class="manual-option-name">
|
||||
summary:error_data:<count>
|
||||
</div><div class="manual-option-description">
|
||||
Logs the total count of `silent data errors` (data blocks
|
||||
Logs the total count of <b>silent data errors</b> (data blocks
|
||||
not matching their expected hash) encountered during the sync
|
||||
process.
|
||||
</div>
|
||||
|
|
@ -2210,7 +2210,7 @@ The total number of silent data errors encountered (uint).
|
|||
<div class="manual-option-name">
|
||||
summary:exit:<status>
|
||||
</div><div class="manual-option-description">
|
||||
Logs the overall exit status of the command. The `status` is
|
||||
Logs the overall exit status of the command. The <b>status</b> is
|
||||
one of the following:
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -2247,8 +2247,8 @@ or filesystem inspection.
|
|||
<h1 id="sec10" class="manual-title-level-1">
|
||||
Command Check/Fix Tags
|
||||
</h1>
|
||||
<p>Tags specific for the `check` and `fix` commands. For `audit` mode,
|
||||
it's inteded `check` with the `--audit-only` option.
|
||||
<p>Tags specific for the <b>check</b> and <b>fix</b> commands. For <b>audit</b> mode,
|
||||
it's inteded <b>check</b> with the <b>--audit-only</b> option.
|
||||
Also the error tags are possible.
|
||||
</p><div class="manual-section-level-3">
|
||||
<h3 class="manual-title-level-3">
|
||||
|
|
@ -2291,7 +2291,7 @@ The file path relative to disk root (escaped).
|
|||
<msg>
|
||||
</div><div class="manual-tag-description">
|
||||
A descriptive message indicating the nature of the fix
|
||||
(e.g., `Fixed size`, `Fixed data error at position...`).
|
||||
(e.g., <b>Fixed size</b>, <b>Fixed data error at position...</b>).
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -2317,7 +2317,7 @@ The block position being processed (uint).
|
|||
<div class="manual-tag-name">
|
||||
<parity>
|
||||
</div><div class="manual-tag-description">
|
||||
The name of the parity level (e.g., `parity`, `2-parity`).
|
||||
The name of the parity level (e.g., <b>parity</b>, <b>2-parity</b>).
|
||||
</div>
|
||||
</div>
|
||||
<div class="manual-tag-entry">
|
||||
|
|
@ -2325,7 +2325,7 @@ The name of the parity level (e.g., `parity`, `2-parity`).
|
|||
<msg>
|
||||
</div><div class="manual-tag-description">
|
||||
A descriptive message indicating the nature of the fix
|
||||
(e.g., `Fixed data error`).
|
||||
(e.g., <b>Fixed data error</b>).
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -2358,7 +2358,7 @@ The file path relative to disk root (escaped).
|
|||
<msg>
|
||||
</div><div class="manual-tag-description">
|
||||
A descriptive message indicating the nature of the fix
|
||||
(e.g., `Fixed empty file`).
|
||||
(e.g., <b>Fixed empty file</b>).
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -2391,7 +2391,7 @@ The hard link path relative to disk root (escaped).
|
|||
<msg>
|
||||
</div><div class="manual-tag-description">
|
||||
A descriptive message indicating the nature of the fix
|
||||
(e.g., `Fixed hardlink error`).
|
||||
(e.g., <b>Fixed hardlink error</b>).
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -2424,7 +2424,7 @@ The symlink path relative to disk root (escaped).
|
|||
<msg>
|
||||
</div><div class="manual-tag-description">
|
||||
A descriptive message indicating the nature of the fix
|
||||
(e.g., `Fixed symlink error`).
|
||||
(e.g., <b>Fixed symlink error</b>).
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -2458,7 +2458,7 @@ The directory path relative to disk root (escaped).
|
|||
<msg>
|
||||
</div><div class="manual-tag-description">
|
||||
A descriptive message indicating the nature of the fix
|
||||
(e.g., `Fixed dir error`).
|
||||
(e.g., <b>Fixed dir error</b>).
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -2505,8 +2505,8 @@ The file path relative to disk root (escaped).
|
|||
<msg>
|
||||
</div><div class="manual-tag-description">
|
||||
A descriptive message indicating the nature of the problem
|
||||
(e.g., `Unrecoverable error at position <file_pos>`,
|
||||
`Unrecoverable unsynced error at position <file_pos>`).
|
||||
(e.g., <b>Unrecoverable error at position <file_pos></b>,
|
||||
<b>Unrecoverable unsynced error at position <file_pos></b>).
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -2547,7 +2547,7 @@ The path of the colliding file (escaped).
|
|||
<msg>
|
||||
</div><div class="manual-tag-description">
|
||||
A descriptive message indicating the nature of the problem
|
||||
(e.g., `Not setting modification time to avoid inode collision`).
|
||||
(e.g., <b>Not setting modification time to avoid inode collision</b>).
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -2563,7 +2563,7 @@ File Status Tags
|
|||
status:unrecoverable:<disk_name>:<file_path>
|
||||
</div><div class="manual-option-description">
|
||||
Indicates that a file has unrecoverable errors and was renamed to
|
||||
`.unrecoverable` (fix) or cannot be recovered (check).
|
||||
<b>.unrecoverable</b> (fix) or cannot be recovered (check).
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -2614,7 +2614,7 @@ The file path relative to disk root (escaped).
|
|||
status:recoverable:<disk_name>:<file_path>
|
||||
</div><div class="manual-option-description">
|
||||
Logs that a file has errors but could be recovered with a
|
||||
`fix` (check).
|
||||
<b>fix</b> (check).
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -2708,7 +2708,7 @@ The total number of I/O errors encountered (uint).
|
|||
<div class="manual-option-name">
|
||||
summary:error_data:<count>
|
||||
</div><div class="manual-option-description">
|
||||
Logs the total count of `silent data errors` (data blocks
|
||||
Logs the total count of <b>silent data errors</b> (data blocks
|
||||
not matching their expected hash) encountered during the sync
|
||||
process.
|
||||
</div>
|
||||
|
|
@ -2782,7 +2782,7 @@ Number of unrecoverable errors (uint).
|
|||
<div class="manual-option-name">
|
||||
summary:exit:<status>
|
||||
</div><div class="manual-option-description">
|
||||
Logs the overall exit status of the command. The `status` is one of
|
||||
Logs the overall exit status of the command. The <b>status</b> is one of
|
||||
the following:
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -2844,7 +2844,7 @@ found (check/fix).
|
|||
<h1 id="sec11" class="manual-title-level-1">
|
||||
Command List Tags
|
||||
</h1>
|
||||
<p>This section describes the tags output with the `list` command.
|
||||
<p>This section describes the tags output with the <b>list</b> command.
|
||||
</p><div class="manual-section-level-3">
|
||||
<h3 class="manual-title-level-3">
|
||||
List Tags
|
||||
|
|
@ -2912,7 +2912,7 @@ The file's inode number (uint).
|
|||
<div class="manual-option-name">
|
||||
link_<type>:<disk_name>:<subpath>:<linkto>
|
||||
</div><div class="manual-option-description">
|
||||
Logs details for a link found on a disk. The `<type>` component
|
||||
Logs details for a link found on a disk. The <b><type></b> component
|
||||
varies based on the kind of link.
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -2922,8 +2922,8 @@ varies based on the kind of link.
|
|||
<div class="manual-tag-name">
|
||||
<type>
|
||||
</div><div class="manual-tag-description">
|
||||
The type of link, one of: `hardlink`, `symlink`,
|
||||
`symdir` (symlink to a directory), `junction`
|
||||
The type of link, one of: <b>hardlink</b>, <b>symlink</b>,
|
||||
<b>symdir</b> (symlink to a directory), <b>junction</b>
|
||||
(Windows-specific reparse point).
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -3028,7 +3028,7 @@ and you won't get this tag.
|
|||
<h1 id="sec12" class="manual-title-level-1">
|
||||
Command Dup Tags
|
||||
</h1>
|
||||
<p>This section describes the tags output with the `dup` command.
|
||||
<p>This section describes the tags output with the <b>dup</b> command.
|
||||
</p><div class="manual-section-level-3">
|
||||
<h3 class="manual-title-level-3">
|
||||
Duplicate Tags
|
||||
|
|
@ -3070,7 +3070,7 @@ relative to its disk's mount point (escaped).
|
|||
</div><div class="manual-tag-description">
|
||||
The configured name of the disk containing the
|
||||
previously processed file that is the duplicate
|
||||
of `<file_path1>`.
|
||||
of <b><file_path1></b>.
|
||||
</div>
|
||||
</div>
|
||||
<div class="manual-tag-entry">
|
||||
|
|
@ -3086,7 +3086,7 @@ relative to its disk's mount point (escaped).
|
|||
<size>
|
||||
</div><div class="manual-tag-description">
|
||||
The size of the duplicate file in bytes (uint). This
|
||||
size corresponds to the file `<file_path2>`.
|
||||
size corresponds to the file <b><file_path2></b>.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -3139,7 +3139,7 @@ The total size of duplicate files in gigabytes (uint).
|
|||
<div class="manual-option-name">
|
||||
summary:exit:<status>
|
||||
</div><div class="manual-option-description">
|
||||
Logs the overall exit status of the command. The `status` is one of
|
||||
Logs the overall exit status of the command. The <b>status</b> is one of
|
||||
the following:
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -3166,7 +3166,7 @@ Indicates that at least one duplicate file was found.
|
|||
<h1 id="sec13" class="manual-title-level-1">
|
||||
Command Pool Tags
|
||||
</h1>
|
||||
<p>This section describes the tags output with the `pool` command.
|
||||
<p>This section describes the tags output with the <b>pool</b> command.
|
||||
</p><div class="manual-option-list">
|
||||
<div class="manual-option-entry">
|
||||
<div class="manual-option-name">
|
||||
|
|
@ -3201,7 +3201,7 @@ and you won't get this tag.
|
|||
<h1 id="sec14" class="manual-title-level-1">
|
||||
Command Rehash Tags
|
||||
</h1>
|
||||
<p>This section describes the tags output with the `rehash` command.
|
||||
<p>This section describes the tags output with the <b>rehash</b> command.
|
||||
</p><div class="manual-section-level-3">
|
||||
<h3 class="manual-title-level-3">
|
||||
Summary Tags
|
||||
|
|
@ -3212,7 +3212,7 @@ Summary Tags
|
|||
<div class="manual-option-name">
|
||||
summary:exit:<status>
|
||||
</div><div class="manual-option-description">
|
||||
Logs the overall exit status of the command. The `status` is one of
|
||||
Logs the overall exit status of the command. The <b>status</b> is one of
|
||||
the following:
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -3224,7 +3224,7 @@ scheduled
|
|||
</div><div class="manual-tag-description">
|
||||
Indicates that a rehash operation has
|
||||
been successfully scheduled. The rehash will be performed
|
||||
incrementally in future `sync` or `scrub` commands.
|
||||
incrementally in future <b>sync</b> or <b>scrub</b> commands.
|
||||
</div>
|
||||
</div>
|
||||
<div class="manual-tag-entry">
|
||||
|
|
@ -3241,7 +3241,7 @@ program to exit with a fatal error.
|
|||
not_required
|
||||
</div><div class="manual-tag-description">
|
||||
Indicates that the current hash algorithm is
|
||||
already the `best hash` for the platform, and thus
|
||||
already the <b>best hash</b> for the platform, and thus
|
||||
a rehash is not required. This causes the program to
|
||||
exit with a fatal error.
|
||||
</div>
|
||||
|
|
@ -3253,19 +3253,19 @@ exit with a fatal error.
|
|||
<h1 id="sec15" class="manual-title-level-1">
|
||||
Command Smart And Probe Tags
|
||||
</h1>
|
||||
<p>This section describes the tags output by the `smart` and `probe`
|
||||
commands. The main difference between the two is that `probe` doesn't
|
||||
<p>This section describes the tags output by the <b>smart</b> and <b>probe</b>
|
||||
commands. The main difference between the two is that <b>probe</b> doesn't
|
||||
spin up the disk, so it won't be able to get all attributes if the
|
||||
disk is spun down. The `smart` command, instead, will always get all
|
||||
disk is spun down. The <b>smart</b> command, instead, will always get all
|
||||
attributes, but with the risk of spinning up all disks.
|
||||
</p><p>Note that a `<disk_name>` may be associated with more `<device_file>`,
|
||||
</p><p>Note that a <b><disk_name></b> may be associated with more <b><device_file></b>,
|
||||
in case the logical disk uses more physical disks. In such a case,
|
||||
you'll see multiple `<attr>` and `<smart>` tags for the same
|
||||
`<disk_name>` but with different `<device_file>`. The exception is the
|
||||
`stat` attrbute that is cumulative for all the devices part of the
|
||||
you'll see multiple <b><attr></b> and <b><smart></b> tags for the same
|
||||
<b><disk_name></b> but with different <b><device_file></b>. The exception is the
|
||||
<b>stat</b> attrbute that is cumulative for all the devices part of the
|
||||
disk.
|
||||
</p><p>In case of split parity, the parity name is followed by `/N` to indicate
|
||||
the split index, where N starts from 0. The `/0` is always omitted.
|
||||
</p><p>In case of split parity, the parity name is followed by <b>/N</b> to indicate
|
||||
the split index, where N starts from 0. The <b>/0</b> is always omitted.
|
||||
</p><div class="manual-section-level-3">
|
||||
<h3 class="manual-title-level-3">
|
||||
Attributes
|
||||
|
|
@ -3294,8 +3294,8 @@ The file path of the device (e.g., /dev/sdb).
|
|||
</div><div class="manual-tag-description">
|
||||
The configured name of the disk.
|
||||
In case of split parity, the parity name is followed
|
||||
by `/N` to indicate the split index, where N starts
|
||||
from 0. The `/0` is always omitted.
|
||||
by <b>/N</b> to indicate the split index, where N starts
|
||||
from 0. The <b>/0</b> is always omitted.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -3358,7 +3358,7 @@ The disk's model identifier (escaped).
|
|||
<div class="manual-option-name">
|
||||
attr:<device_file>:<disk_name>[/<split_index>]:interface:<interface>
|
||||
</div><div class="manual-option-description">
|
||||
Logs the disk's interface. Something like `USB`, `SATA`, `NVMe`.
|
||||
Logs the disk's interface. Something like <b>USB</b>, <b>SATA</b>, <b>NVMe</b>.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -3516,11 +3516,10 @@ rotational speed in RPM.
|
|||
<div class="manual-option-name">
|
||||
attr:<device_file>:<disk_name>[/<split_index>]:flags:<flags_decimal>:<flags_hex>
|
||||
</div><div class="manual-option-description">
|
||||
Logs the SMART status flags from the `smartctl` utility.
|
||||
Logs the SMART status flags from the <b>smartctl</b> utility.
|
||||
Per the smartctl manpage, these flags are bit-mapped
|
||||
to indicate specific issues like `Command line did not parse`,
|
||||
`Device could not be opened`, or `SMART status check
|
||||
returned 'DISK FAILING'`.
|
||||
to indicate specific issues like <b>Command line did not parse</b>,
|
||||
<b>Device could not be opened</b>, or <b>SMART status check returned 'DISK FAILING'</b>.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -3676,7 +3675,7 @@ the next year (float).
|
|||
Device Status Tags
|
||||
</h1>
|
||||
<p>These tags log the lifecycle of hardware interactions and external
|
||||
command execution with the `smartctl` command.
|
||||
command execution with the <b>smartctl</b> command.
|
||||
</p><div class="manual-option-list">
|
||||
<div class="manual-option-entry">
|
||||
<div class="manual-option-name">
|
||||
|
|
@ -3700,8 +3699,8 @@ The system path to the device node.
|
|||
</div><div class="manual-tag-description">
|
||||
The configured name of the disk.
|
||||
In case of split parity, the parity name is followed
|
||||
by `/N` to indicate the split index, where N starts
|
||||
from 0. The `/0` is always omitted.
|
||||
by <b>/N</b> to indicate the split index, where N starts
|
||||
from 0. The <b>/0</b> is always omitted.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -3789,7 +3788,7 @@ typically signaling a failing sector or cable issue.
|
|||
_data
|
||||
</div><div class="manual-tag-description">
|
||||
Indicates the data was read successfully but failed
|
||||
the checksum/hash verification. This signals `silent`
|
||||
the checksum/hash verification. This signals <b>silent</b>
|
||||
corruption or an unsuccessful parity match.
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -3820,8 +3819,8 @@ file containing the block (escaped).
|
|||
<msg>
|
||||
</div><div class="manual-tag-description">
|
||||
A descriptive message indicating the nature of the
|
||||
error (e.g., `Open/Read/Write error`,
|
||||
`Data error at position <pos>, diff bits <diff>/<bits>`).
|
||||
error (e.g., <b>Open/Read/Write error</b>,
|
||||
<b>Data error at position <pos>, diff bits <diff>/<bits></b>).
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -3849,7 +3848,7 @@ typically signaling a failing sector or cable issue.
|
|||
_data
|
||||
</div><div class="manual-tag-description">
|
||||
Indicates the data was read successfully but failed
|
||||
the checksum/hash verification. This signals `silent`
|
||||
the checksum/hash verification. This signals <b>silent</b>
|
||||
corruption or an unsuccessful parity match.
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -3865,7 +3864,7 @@ The zero-based index of the block where the error occurred (uint).
|
|||
<level>
|
||||
</div><div class="manual-tag-description">
|
||||
The configuration name of the parity level (e.g.,
|
||||
`parity`, `2-parity`).
|
||||
<b>parity</b>, <b>2-parity</b>).
|
||||
</div>
|
||||
</div>
|
||||
<div class="manual-tag-entry">
|
||||
|
|
@ -3873,8 +3872,8 @@ The configuration name of the parity level (e.g.,
|
|||
<msg>
|
||||
</div><div class="manual-tag-description">
|
||||
A descriptive message indicating the nature of the
|
||||
error (e.g., `Read/Write error`,
|
||||
`Data error, diff bits <diff>/<bits>`).
|
||||
error (e.g., <b>Read/Write error</b>,
|
||||
<b>Data error, diff bits <diff>/<bits></b>).
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -3914,10 +3913,10 @@ The target path of the hard link (escaped).
|
|||
<msg>
|
||||
</div><div class="manual-tag-description">
|
||||
A descriptive message indicating the nature of the
|
||||
error (e.g., `Hardlink stat error`,
|
||||
`Hardlink error for not regular file`, `Hardlink to stat error`,
|
||||
`Hardlink-to error for not regular file`,
|
||||
`Hardlink mismatch for different inode`).
|
||||
error (e.g., <b>Hardlink stat error</b>,
|
||||
<b>Hardlink error for not regular file</b>, <b>Hardlink to stat error</b>,
|
||||
<b>Hardlink-to error for not regular file</b>,
|
||||
<b>Hardlink mismatch for different inode</b>).
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -3950,8 +3949,8 @@ The symlink path relative to disk root (escaped).
|
|||
<msg>
|
||||
</div><div class="manual-tag-description">
|
||||
A descriptive message indicating the nature of the
|
||||
error (e.g., `Symlink read error`,
|
||||
`Symlink data error '<actual>' instead of '<expected>'`).
|
||||
error (e.g., <b>Symlink read error</b>,
|
||||
<b>Symlink data error '<actual>' instead of '<expected>'</b>).
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -3984,7 +3983,7 @@ The directory path relative to disk root (escaped).
|
|||
<msg>
|
||||
</div><div class="manual-tag-description">
|
||||
A descriptive message indicating the nature of the
|
||||
error (e.g., `Dir stat error`, `Dir error for not directory`).
|
||||
error (e.g., <b>Dir stat error</b>, <b>Dir error for not directory</b>).
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue