rt/snapraid
1
0
Fork 0
mirror of https://github.com/amadvance/snapraid.git synced 2026-10-25 18:40:19 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update documentation
Some checks are pending
Build / build-mac (push) Waiting to run
Details
Build / build-linux (push) Waiting to run
Details
Build / build-win (push) Waiting to run
Details
CodeQL / Analyze (push) Waiting to run
Details

Browse source
This commit is contained in:
Andrea Mazzoleni 2025-12-29 22:49:16 +01:00
parent 6af8894120
commit 45eb2efb60
3 changed files with 51 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

37
doc/snapraid_log.1
View file

@ -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:<blockstart>:<blockend>:<countmax>
.B run:begin:<blockbegin>:<blockend>:<count>
A tag indicating the start of the command execution.
.RS 4
.PD 0
.HP 4
.I <blockstart>
.I <blockbegin>
Starting block index (uint).
.HP 4
.I <blockend>
Ending block index + 1 (uint).
.HP 4
.I <countmax>
.I <count>
Number of blocks to process. It may be less
than <blockend> \- <blockstart> + 1 if some blocks
than <blockend> \- <blockbegin> + 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:<blockpos>:<countpos>:<countsize>:<perc>:<eta>:<size_speed>:<cpu>:<elapsed>
.B run:pos:<blockidx>:<blockdone>:<sizedone>:<perc>:<eta>:<speed_mbs>:<cpu>:<elapsed>
Detailed progress information during command execution.
.RS 4
.PD 0
.HP 4
.I <blockpos>
Current block index position (uint).
.I <blockidx>
Current block index position processed (uint).
.HP 4
.I <countpos>
Current item count position (uint).
.I <blockdone>
Number of blocks processed (uint).
.HP 4
.I <countsize>
.I <sizedone>
Current size processed (uint64).
.HP 4
.I <perc>
Percentage complete (uint).
Completion percentage (uint).
.HP 4
.I <eta>
Estimated time of arrival in minutes (uint).
Estimated time to completion in seconds (uint).
.HP 4
.I <size_speed>
Data processing speed in MiB/s (uint).
.I <speed_mbs>
Data processing speed in MB/s (uint).
.HP 4
.I <cpu>
CPU usage percentage (uint).
.HP 4
.I <elapsed>
Elapsed time in seconds (uint64).
Elapsed time in seconds (uint).
.PD
.RE
.TP
.B sigint:<blockpos>:<msg>
.B sigint:<blockidx>:<msg>
A user interruption (e.g., Ctrl+C) was signaled. The process
is gracefully aborting.
.RS 4
.PD 0
.HP 4
.I <blockpos>
.I <blockidx>
Current block index position (uint).
.HP 4
.I <msg>

31
doc/snapraid_log.d
View file

@ -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:<blockstart>:<blockend>:<countmax>
=run:begin:<blockbegin>:<blockend>:<count>
A tag indicating the start of the command execution.
<blockstart> - Starting block index (uint).
<blockbegin> - Starting block index (uint).
<blockend> - Ending block index + 1 (uint).
<countmax> - Number of blocks to process. It may be less
than <blockend> - <blockstart> + 1 if some blocks
<count> - Number of blocks to process. It may be less
than <blockend> - <blockbegin> + 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:<blockpos>:<countpos>:<countsize>:<perc>:<eta>:<size_speed>:<cpu>:<elapsed>
=run:pos:<blockidx>:<blockdone>:<sizedone>:<perc>:<eta>:<speed_mbs>:<cpu>:<elapsed>
Detailed progress information during command execution.
<blockpos> - Current block index position (uint).
<countpos> - Current item count position (uint).
<countsize> - Current size processed (uint64).
<perc> - Percentage complete (uint).
<eta> - Estimated time of arrival in minutes (uint).
<size_speed> - Data processing speed in MiB/s (uint).
<blockidx> - Current block index position processed (uint).
<blockdone> - Number of blocks processed (uint).
<sizedone> - Current size processed (uint64).
<perc> - Completion percentage (uint).
<eta> - Estimated time to completion in seconds (uint).
<speed_mbs> - Data processing speed in MB/s (uint).
<cpu> - CPU usage percentage (uint).
<elapsed> - Elapsed time in seconds (uint64).
<elapsed> - Elapsed time in seconds (uint).
=sigint:<blockpos>:<msg>
=sigint:<blockidx>:<msg>
A user interruption (e.g., Ctrl+C) was signaled. The process
is gracefully aborting.
<blockpos> - Current block index position (uint).
<blockidx> - Current block index position (uint).
<msg> - Text message exactly as it's printed on screen.
=msg:<level>:<msg>

31
doc/snapraid_log.txt
View file

@ -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:<blockstart>:<blockend>:<countmax>
run:begin:<blockbegin>:<blockend>:<count>
A tag indicating the start of the command execution.
<blockstart> - Starting block index (uint).
<blockbegin> - Starting block index (uint).
<blockend> - Ending block index + 1 (uint).
<countmax> - Number of blocks to process. It may be less
than <blockend> - <blockstart> + 1 if some blocks
<count> - Number of blocks to process. It may be less
than <blockend> - <blockbegin> + 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:<blockpos>:<countpos>:<countsize>:<perc>:<eta>:<size_speed>:<cpu>:<elapsed>
run:pos:<blockidx>:<blockdone>:<sizedone>:<perc>:<eta>:<speed_mbs>:<cpu>:<elapsed>
Detailed progress information during command execution.
<blockpos> - Current block index position (uint).
<countpos> - Current item count position (uint).
<countsize> - Current size processed (uint64).
<perc> - Percentage complete (uint).
<eta> - Estimated time of arrival in minutes (uint).
<size_speed> - Data processing speed in MiB/s (uint).
<blockidx> - Current block index position processed (uint).
<blockdone> - Number of blocks processed (uint).
<sizedone> - Current size processed (uint64).
<perc> - Completion percentage (uint).
<eta> - Estimated time to completion in seconds (uint).
<speed_mbs> - Data processing speed in MB/s (uint).
<cpu> - CPU usage percentage (uint).
<elapsed> - Elapsed time in seconds (uint64).
<elapsed> - Elapsed time in seconds (uint).
sigint:<blockpos>:<msg>
sigint:<blockidx>:<msg>
A user interruption (e.g., Ctrl+C) was signaled. The process
is gracefully aborting.
<blockpos> - Current block index position (uint).
<blockidx> - Current block index position (uint).
<msg> - Text message exactly as it's printed on screen.
msg:<level>:<msg>