From 2be534e3257ad3495a1bc99acdfbf3ded2b823ed Mon Sep 17 00:00:00 2001 From: Andrea Mazzoleni Date: Thu, 11 Dec 2025 15:26:22 +0100 Subject: [PATCH] More documentation for the log file --- snapraid_log.1 | 1086 ++++++++++++++++++++++++++++++++++++++++++++-- snapraid_log.d | 670 ++++++++++++++++++++++++++-- snapraid_log.txt | 705 ++++++++++++++++++++++++++++-- 3 files changed, 2368 insertions(+), 93 deletions(-) diff --git a/snapraid_log.1 b/snapraid_log.1 index 32bf56a9..e302ecca 100644 --- a/snapraid_log.1 +++ b/snapraid_log.1 @@ -45,8 +45,549 @@ 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. -.SH STATUS -This section describe the tags output with the \`status\` command. +.PP +When a path is output, it is always escaped using a backslash (\\) as +the escape character. +.PP +The following characters are escaped into sequences: +.RS 4 +.PD 0 +.HP 4 +.I The colon +is escaped to \\d. +.HP 4 +.I The newline +is escaped to \\n. +.HP 4 +.I The carriage return +is escaped to \\r. +.HP 4 +.I The backslash +is escaped to \\\\. +.PD +.RE +.PP +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. +.SH CONFIGURATION TAGS +These tags report the memory usage and global configuration after +scanning the disk and reading the list of files. +.TP +.B conf:file: +Configuration file loaded (escaped string). +.TP +.B conf:missing: +Operating without a configuration file. +.TP +.B blocksize: +The configured block size in bytes (uint). +.TP +.B data:: +The data disks as defined in the configuration file. +.RS 4 +.PD 0 +.HP 4 +.I +The assigned name of the disk. +.HP 4 +.I +The directory entry point of the disk. +.PD +.RE +.TP +.B mode: +The RAID mode used. One of \`par1\`, \`par2\`, \`par3\`, \`par4\`, +\`par5\`, \`par6\` or \`parz\`. The number indicates the maximum +number of simultaneous disk failures the array can withstand. +.TP +.B :: +The parity files as defined in the configuration file. +.RS 4 +.PD 0 +.HP 4 +.I +One of \`parity\`, \`2\-parity\`, ..., \`6\-parity\`. +This corresponds to the level of redundancy. +.HP 4 +.I +The split index (uint). If no +multiple split parity is configured, there is only the +index 0. A split parity configuration distributes parity +blocks across multiple files. +.HP 4 +.I +The escaped path. +.PD +.RE +.TP +.B pool: +The configured dir to the pool mount point (escaped string). +This is the optional mount point for the \'pool\' feature. +.TP +.B share: +The configured dir to the pool mount point (escaped string). +This is the optional mount point for the \'share\' feature. +.TP +.B autosave: +If the autosave feature is enabled, and after how many bytes +(uint64). This specifies the interval for content file saving. +.TP +.B filter: +All the active filters with their patterns. These patterns +exclude specific files or directories from the SnapRAID array. +.TP +.B filter:nohidden: +If the no\-hidden filter is enabled, meaning hidden files/directories +(starting with \'.\') are excluded from the array. +.TP +.B content: +The absolute path to a content file being used (escaped string). +Content files store the metadata (like file hashes and timestamps) +for the array. +.TP +.B content::::: +The parity files as stored in the content file. +.RS 4 +.PD 0 +.HP 4 +.I +One of \`parity\`, \`2\-parity\`, ..., \`6\-parity\`. +.HP 4 +.I +The split index (uint). If no +multiple split parity is configured, there is only the +index 0. +.HP 4 +.I +The escaped path. +.HP 4 +.I +The UUID of the partition containing the path. +.HP 4 +.I +The size of the parity file. Size is \-1 if not yet +fixed, meaning it can grow. This happens for the +latest split. +.PD +.RE +.SH DIAGNOSTICS TAGS +.TP +.B version: +The version of SnapRAID run. +.TP +.B unixtime: