Document exit code in the manpage
Some checks are pending
Build / build-mac (push) Waiting to run
Build / build-linux (push) Waiting to run
Build / build-win (push) Waiting to run
CodeQL Advanced / Analyze (c-cpp) (push) Waiting to run
CodeQL Advanced / Analyze (actions) (push) Waiting to run

This commit is contained in:
Andrea Mazzoleni 2026-03-30 22:44:50 +02:00
parent e0d2a0f08c
commit fa4dd42368
3 changed files with 40 additions and 5 deletions

View file

@ -2030,7 +2030,23 @@ a TrueType font like \`Lucida Console\` as the console font.
This affects only the printed file names; if you
redirect the console output to a file, the resulting file is always
in UTF\-8 format.
.SH EXIT CODE
SnapRAID terminates with the following error codes:
.RS 0
.PD 0
.HP 4
.I 0
Everything OK.
.HP 4
.I 1
The command encountered some errors.
.HP 4
.I 2
The \`diff\` command found everything is OK, but a \`sync\` is
needed.
.PD
.RE
.SH COPYRIGHT
This file is Copyright (C) 2025 Andrea Mazzoleni
This file is Copyright (C) 2026 Andrea Mazzoleni
.SH SEE ALSO
snapraid_log(1), snapraidd(1), rsync(1)

View file

@ -1573,8 +1573,16 @@ Encoding
redirect the console output to a file, the resulting file is always
in UTF-8 format.
Exit Code
SnapRAID terminates with the following error codes:
0 - Everything OK.
1 - The command encountered some errors.
2 - The `diff` command found everything is OK, but a `sync` is
needed.
Copyright
This file is Copyright (C) 2025 Andrea Mazzoleni
This file is Copyright (C) 2026 Andrea Mazzoleni
See Also
snapraid_log(1), snapraidd(1), rsync(1)

View file

@ -1689,13 +1689,24 @@ redirect the console output to a file, the resulting file is always
in UTF-8 format.
13 COPYRIGHT
13 EXIT CODE
============
This file is Copyright (C) 2025 Andrea Mazzoleni
SnapRAID terminates with the following error codes:
0 - Everything OK.
1 - The command encountered some errors.
2 - The `diff` command found everything is OK, but a `sync` is
needed.
14 SEE ALSO
14 COPYRIGHT
============
This file is Copyright (C) 2026 Andrea Mazzoleni
15 SEE ALSO
===========
snapraid_log(1), snapraidd(1), rsync(1)