|
+ Example:
+ |
snapraid status --log ">&2"
|
-
-The output tags strictly adhere to the following format:
-
-
+The output tags strictly adhere to the following format:
+
NAME:VALUE:VALUE:VALUE...<EOL>
@@ -110,17 +104,14 @@ values. They are separated by a colon `:`.
Each tag is terminated by an end-of-line character.
-
-This document provides a summary of the tags generated by SnapRAID.
+ 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.
-
-When a path is output, it is always escaped using a backslash (\) as
+ When a path is output, it is always escaped using a backslash (\) as
the escape character.
-
-The following characters are escaped into sequences:
-
+The following characters are escaped into sequences:
+
|
The colon
|
@@ -142,16 +133,15 @@ The backslash
is escaped to \\.
|
-
-Some tags are output only when the `--gui` option is used. They provide
+ Some tags are output only when the `--gui` option is used. They provide
extra verbose state and runtime progress only useful for a GUI
interface.
- 2
+2
Configuration Tags
-These tags report the memory usage and global configuration after
+These tags report the memory usage and global configuration after
scanning the disk and reading the list of files.
-
+
|
conf:file:<path>
|
@@ -400,10 +390,10 @@ Size of the internal `snapraid_dir` structure in bytes (uint64).
4
Scan Tags
-These tags report detected differences between the filesystem and the
+These tags report detected differences between the filesystem and the
content file. They are output for every discovered change, and
`scan:equal` is only output when the `--gui` option is used.
-
+
|
scan:equal:<disk_name>:<path>
| |
@@ -500,9 +490,8 @@ The file won't be re-hashed in `sync` as its precomputed hash
is assumed to be correct.
|
-
-These tags provide a final count of all detected changes.
-
+These tags provide a final count of all detected changes.
+
|
summary:equal:<count>
|
@@ -570,9 +559,9 @@ The array needs a `sync` operation.
5
General Progress and Execution Tags
-These tags are used to report the runtime processing of the commands.
+These tags are used to report the runtime processing of the commands.
Only produced when `--gui` option is used.
-
+
|
run:begin:<blockstart>:<blockend>:<countmax>
|
@@ -731,10 +720,10 @@ Text message exactly as it's printed on screen.
6
Thermal Tags
-The following tags are produced by the thermal monitoring functions
+The following tags are produced by the thermal monitoring functions
when SnapRAID is processing, typically during operations that involve
disk access.
-
+
|
thermal:ambient:device:<hwmon_dir>:<name>:<temp_file>:<label>:<temp>
|
@@ -992,13 +981,13 @@ are being spun back up to resume the operation.
7
Command Status Tags
-This section describes the tags output with the `status` command.
-
+This section describes the tags output with the `status` command.
+
Summary Tags
-These tags provide general information about the array configuration
+These tags provide general information about the array configuration
and overall state.
-
+
|
summary:block_size:<uint>
|
@@ -1153,9 +1142,9 @@ Days ago the newest block was last scrubbed.
Per-Disk Tags
-These tags provide statistics for individual data disks. <name>
+These tags provide statistics for individual data disks. <name>
is the disk name.
-
+
|
summary:disk_file_count:<name>:<uint>
|
@@ -1244,8 +1233,8 @@ Disk use percentage relative to `disk_block_max`.
File Timestamp Tags
-These tags list files with zero sub-second timestamps.
-
+These tags list files with zero sub-second timestamps.
+
|
zerosubsecond:<disk_name>:<file_path>
|
@@ -1256,8 +1245,8 @@ Up to 50 are logged per disk.
Block Information Tags
-These tags are generated when the GUI option is enabled (`state->opt.gui`).
-
+These tags are generated when the GUI option is enabled (`state->opt.gui`).
+
|
block_count:<uint>
|
@@ -1331,8 +1320,8 @@ Block index.
Scrub History Tags
-These tags provide details on the scrub/sync time distribution.
-
+These tags provide details on the scrub/sync time distribution.
+
|
info_count:<uint>
|
@@ -1421,13 +1410,13 @@ Count of newly synced (unscrubbed) blocks in that day range.
8
Command Sync/Scrub Tags
-Tags specific for the `sync` and `scrub` commands.
+Tags specific for the `sync` and `scrub` commands.
Also the error tags are possible.
-
+
Summary Tags
-These tags provide summary statistics at the end of the command.
-
+These tags provide summary statistics at the end of the command.
+
|
hash_summary:error_file:<count>
|
@@ -1513,13 +1502,13 @@ If any errors were found (file, I/O, or data errors).
9
Command Check/Fix Tags
-Tags specific for the `check` and `fix` commands.
+Tags specific for the `check` and `fix` commands.
Also the error tags are possible.
-
+
Fixed/Recovered Tags
-These tags log successful repairs during fix operations.
-
+These tags log successful repairs during fix operations.
+
|
fixed:<block_pos>:<disk_name>:<file_path>:<msg>
|
@@ -1679,8 +1668,8 @@ A descriptive message indicating the nature of the fix
Unrecoverable Error Tags
-These tags log errors that could not be recovered.
-
+These tags log errors that could not be recovered.
+
|
unrecoverable:<block_pos>:<disk_name>:<file_path>:<msg>
|
@@ -1746,8 +1735,8 @@ A descriptive message indicating the nature of the problem
File Status Tags
-These tags log the final status of files after processing.
-
+These tags log the final status of files after processing.
+
|
status:unrecoverable:<disk_name>:<file_path>
|
@@ -1846,8 +1835,8 @@ The file path relative to disk root (escaped).
Summary Tags
-These tags provide summary statistics at the end of the command.
-
+These tags provide summary statistics at the end of the command.
+
|
summary:error:<error_count>
|
@@ -1930,13 +1919,13 @@ Indicates that errors were found (audit-only mode).
10
Command List Tags
-This section describes the tags output with the `list` command.
-
+This section describes the tags output with the `list` command.
+
List Tags
-These tags log details about individual files and links processed during
+These tags log details about individual files and links processed during
the listing operation.
-
+
|
file:<disk_name>:<subpath>:<size>:<mtime_sec>:<mtime_nsec>:<inode>
|
@@ -2014,8 +2003,8 @@ The target path of the link (escaped).
Summary Tags
-These tags log final statistics about the entire listing operation.
-
+These tags log final statistics about the entire listing operation.
+
|
summary:file_count:<count>
|
@@ -2070,14 +2059,14 @@ and you won't get this tag.
11
Command Dup Tags
-This section describes the tags output with the `dup` command.
-
+This section describes the tags output with the `dup` command.
+
Duplicate Tags
-These tags log information about detected duplicate files and provide
+These tags log information about detected duplicate files and provide
a summary of the duplicate finding process. The content hash of the
whole file is used to determine duplicates.
-
+
|
dup:<diskname1>:<file_path1>:<diskname2>:<file_path2>:<size>: dup
|
@@ -2122,8 +2111,8 @@ size corresponds to the file `<file_path2>`.
Summary Tags
-These tags provide a final summary of the duplicate finding process.
-
+These tags provide a final summary of the duplicate finding process.
+
|
summary:dup_count:<count>
|
@@ -2173,8 +2162,8 @@ zero.
12
Command Pool Tags
-This section describes the tags output with the `pool` command.
-
+This section describes the tags output with the `pool` command.
+
|
summary:link_count:<count>
|
@@ -2200,12 +2189,12 @@ and you won't get this tag.
13
Command Rehash Tags
-This section describes the tags output with the `rehash` command.
-
+This section describes the tags output with the `rehash` command.
+
Summary Tags
-These tags provide a final summary of the rehash scheduling process.
-
+These tags provide a final summary of the rehash scheduling process.
+
|
summary:exit:scheduled
|
@@ -2236,18 +2225,17 @@ a fatal error.
14
Command Smart Tags
-This section describes the tags output with the `smart` command.
-
-Note that a `<disk_name>` may be associated with more `<device_file>`,
+ This section describes the tags output with the `smart` command.
+ Note that a `<disk_name>` may be associated with more `<device_file>`,
in case the logical disk uses more physical disks. In such a case,
you'll see multiple tags for the same `<disk_name>` but with different
`<device_file>`.
-
+
SMART Attributes
-Tags logging specific disk identification and raw SMART attribute
+Tags logging specific disk identification and raw SMART attribute
values.
-
+
|
smart:<device_file>:<disk_name>
|
@@ -2420,8 +2408,8 @@ The raw attribute value (uint64, hexadecimal).
Summary
-Tags logging the overall failure probabilities for the array.
-
+Tags logging the overall failure probabilities for the array.
+
|
summary:array_failure:<array_afr>:<array_prob>
| |
@@ -2442,24 +2430,22 @@ The sum of AFRs of all disks in the array (double).
The probability of at least one disk failure in
|
-
|
-the next year (double).
- |
+the next year (double).
+
15
Command Probe Tags
-This section describes the tags output with the `probe` command.
-
-Note that a `<disk_name>` may be associated with more `<device_file>`,
+ This section describes the tags output with the `probe` command.
+ Note that a `<disk_name>` may be associated with more `<device_file>`,
in case the logical disk uses more physical disks. In such a case,
you'll see multiple tags for the same `<disk_name>` but with different
`<device_file>`.
-
+
Device Power State
-Tags used to report the power state of each device.
-
+Tags used to report the power state of each device.
+
|
probe:<device_file>:<disk_name>:<power_state>
|
@@ -2487,9 +2473,9 @@ The numerical power state: 0: Unknown,
16
Error Tags
-These tags report specific errors that occur on data disks during the
+These tags report specific errors that occur on data disks during the
commands that access files and parities.
-
+
|
error:<block>:<disk_name>:<file>:<msg>
| |
diff --git a/manual-de.html b/manual-de.html
index 651313ed..1ad55f4f 100644
--- a/manual-de.html
+++ b/manual-de.html
@@ -83,20 +83,18 @@ snapraid [-c, --conf CONFIG]
status|smart|probe|up|down|diff|sync|scrub|fix|check
|list|dup|pool|devices|touch|rehash
-
snapraid [-V, --version] [-H, --help] [-C, --gen-conf CONTENT]
2
Description
-SnapRAID ist ein Sicherungsprogramm, das für Festplatten-Arrays
+SnapRAID ist ein Sicherungsprogramm, das für Festplatten-Arrays
entwickelt wurde und Paritätsinformationen zur Datenwiederherstellung
bei Ausfall von bis zu sechs Festplatten speichert.
-
-SnapRAID ist hauptsächlich für Home-Media-Center mit großen,
+ SnapRAID ist hauptsächlich für Home-Media-Center mit großen,
selten geänderten Dateien konzipiert und bietet folgende Funktionen:
- | | | | | | | | | | | | | | | | | | | | | | | |