diff --git a/doc/snapraid_log.1 b/doc/snapraid_log.1 index 338adf34..ccf306f6 100644 --- a/doc/snapraid_log.1 +++ b/doc/snapraid_log.1 @@ -337,23 +337,24 @@ The array is already synchronized. A zero\-argument tag indicating that differences were found. The array needs a \`sync\` operation. .SH 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 +\`sync\`, \`scrub\`, \`check\` and \`fix\`. Only produced when \`\-\-gui\` option is used. .TP -.B run:begin::: +.B run:begin::: A tag indicating the start of the command execution. .RS 4 .PD 0 .HP 4 -.I +.I Starting block index (uint). .HP 4 .I Ending block index + 1 (uint). .HP 4 -.I +.I Number of blocks to process. It may be less -than \- + 1 if some blocks +than \- + 1 if some blocks are going to be skipped (uint). .PD .RE @@ -361,44 +362,44 @@ are going to be skipped (uint). .B run:end A zero\-argument tag indicating the end of the command execution. .TP -.B run:pos:::::::: +.B run:pos:::::::: Detailed progress information during command execution. .RS 4 .PD 0 .HP 4 -.I -Current block index position (uint). +.I +Current block index position processed (uint). .HP 4 -.I -Current item count position (uint). +.I +Number of blocks processed (uint). .HP 4 -.I +.I Current size processed (uint64). .HP 4 .I -Percentage complete (uint). +Completion percentage (uint). .HP 4 .I -Estimated time of arrival in minutes (uint). +Estimated time to completion in seconds (uint). .HP 4 -.I -Data processing speed in MiB/s (uint). +.I +Data processing speed in MB/s (uint). .HP 4 .I CPU usage percentage (uint). .HP 4 .I -Elapsed time in seconds (uint64). +Elapsed time in seconds (uint). .PD .RE .TP -.B sigint:: +.B sigint:: A user interruption (e.g., Ctrl+C) was signaled. The process is gracefully aborting. .RS 4 .PD 0 .HP 4 -.I +.I Current block index position (uint). .HP 4 .I diff --git a/doc/snapraid_log.d b/doc/snapraid_log.d index 4cd9bc39..1c193f2f 100644 --- a/doc/snapraid_log.d +++ b/doc/snapraid_log.d @@ -255,38 +255,39 @@ Scan Tags The array needs a `sync` operation. 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 + `sync`, `scrub`, `check` and `fix`. Only produced when `--gui` option is used. - =run:begin::: + =run:begin::: A tag indicating the start of the command execution. - - Starting block index (uint). + - Starting block index (uint). - Ending block index + 1 (uint). - - Number of blocks to process. It may be less - than - + 1 if some blocks + - Number of blocks to process. It may be less + than - + 1 if some blocks are going to be skipped (uint). =run:end A zero-argument tag indicating the end of the command execution. - =run:pos:::::::: + =run:pos:::::::: Detailed progress information during command execution. - - Current block index position (uint). - - Current item count position (uint). - - Current size processed (uint64). - - Percentage complete (uint). - - Estimated time of arrival in minutes (uint). - - Data processing speed in MiB/s (uint). + - Current block index position processed (uint). + - Number of blocks processed (uint). + - Current size processed (uint64). + - Completion percentage (uint). + - Estimated time to completion in seconds (uint). + - Data processing speed in MB/s (uint). - CPU usage percentage (uint). - - Elapsed time in seconds (uint64). + - Elapsed time in seconds (uint). - =sigint:: + =sigint:: A user interruption (e.g., Ctrl+C) was signaled. The process is gracefully aborting. - - Current block index position (uint). + - Current block index position (uint). - Text message exactly as it's printed on screen. =msg:: diff --git a/doc/snapraid_log.txt b/doc/snapraid_log.txt index 2c05bc77..6cda44b0 100644 --- a/doc/snapraid_log.txt +++ b/doc/snapraid_log.txt @@ -270,38 +270,39 @@ These tags provide a final count of all detected changes. 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 +`sync`, `scrub`, `check` and `fix`. Only produced when `--gui` option is used. - run:begin::: + run:begin::: A tag indicating the start of the command execution. - - Starting block index (uint). + - Starting block index (uint). - Ending block index + 1 (uint). - - Number of blocks to process. It may be less - than - + 1 if some blocks + - Number of blocks to process. It may be less + than - + 1 if some blocks are going to be skipped (uint). run:end A zero-argument tag indicating the end of the command execution. - run:pos:::::::: + run:pos:::::::: Detailed progress information during command execution. - - Current block index position (uint). - - Current item count position (uint). - - Current size processed (uint64). - - Percentage complete (uint). - - Estimated time of arrival in minutes (uint). - - Data processing speed in MiB/s (uint). + - Current block index position processed (uint). + - Number of blocks processed (uint). + - Current size processed (uint64). + - Completion percentage (uint). + - Estimated time to completion in seconds (uint). + - Data processing speed in MB/s (uint). - CPU usage percentage (uint). - - Elapsed time in seconds (uint64). + - Elapsed time in seconds (uint). - sigint:: + sigint:: A user interruption (e.g., Ctrl+C) was signaled. The process is gracefully aborting. - - Current block index position (uint). + - Current block index position (uint). - Text message exactly as it's printed on screen. msg::