2026-03-30 10:01:17 +02:00
<!DOCTYPE html>
2015-09-11 00:06:29 +02:00
< html lang = "en" >
2011-03-01 22:19:30 +01:00
< head >
2026-03-30 10:01:17 +02:00
< meta charset = "UTF-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "description" content = "A backup program for disk arrays. It stores parity information of your data and it recovers from up to six disk failures" >
< meta name = "keywords" content = "snapraid snapshot raid backup disk array redundancy parity" >
< title > SnapRAID CLI Manual< / title >
< link rel = "stylesheet" href = "style.css" >
2026-04-14 09:53:56 +02:00
< link rel = "apple-touch-icon" sizes = "180x180" href = "/apple-touch-icon.png" >
< link rel = "icon" type = "image/png" sizes = "32x32" href = "/favicon-32x32.png" >
< link rel = "icon" type = "image/png" sizes = "16x16" href = "/favicon-16x16.png" >
< link rel = "manifest" href = "/site.webmanifest" >
2026-03-30 10:01:17 +02:00
< script src = "script.js" > < / script >
2023-01-17 18:38:08 +01:00
2023-01-17 18:39:47 +01:00
<!-- Google Analytics 4 -->
2023-01-17 18:38:08 +01:00
<!-- Google tag (gtag.js) -->
< script async src = "https://www.googletagmanager.com/gtag/js?id=G-W1Z5FKHYQ4" > < / script >
< script >
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-W1Z5FKHYQ4');
< / script >
2023-01-17 18:39:47 +01:00
<!-- Google Universal Analytics -->
2011-03-01 22:19:30 +01:00
< script type = "text/javascript" >
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-21967501-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
< / script >
2026-03-30 10:01:17 +02:00
2011-03-01 22:19:30 +01:00
< / head >
< body >
2026-03-30 10:01:17 +02:00
< header >
< div class = "container nav-container" >
< a href = "index" class = "logo" >
< img src = "android-chrome-192x192.png" width = "32" height = "32" / >
SnapRAID
< / a >
< nav >
< input type = "checkbox" id = "menu-toggle" >
< label for = "menu-toggle" class = "menu-icon" > < svg viewBox = "0 0 24 24" width = "24" height = "24" fill = "currentColor" > < path d = "M3 18h18v-2H3v2zm0-5h18v-2H3v2zm0-7v2h18V6H3z" / > < / svg > < / label >
< ul >
< li > < a href = "index" > Home< / a > < / li >
< li > < a href = "ui" > UI & Daemon< / a > < / li >
< li > < a href = "howitworks" > How it Works< / a > < / li >
< li > < a href = "design" > Design< / a > < / li >
< li > < a href = "compare" > Compare< / a > < / li >
< li > < a href = "manual" class = "active" > Manual< / a > < / li >
< li > < a href = "faq" > FAQ< / a > < / li >
< li > < a href = "support" > Support< / a > < / li >
< li > < a href = "download" class = "nav-cta" > Download< / a > < / li >
< li >
< button class = "theme-toggle" aria-label = "Toggle theme" >
< svg class = "sun-icon" viewBox = "0 0 24 24" fill = "none" stroke = "currentColor" stroke-width = "2" stroke-linecap = "round" stroke-linejoin = "round" > < circle cx = "12" cy = "12" r = "5" > < / circle > < line x1 = "12" y1 = "1" x2 = "12" y2 = "3" > < / line > < line x1 = "12" y1 = "21" x2 = "12" y2 = "23" > < / line > < line x1 = "4.22" y1 = "4.22" x2 = "5.64" y2 = "5.64" > < / line > < line x1 = "18.36" y1 = "18.36" x2 = "19.78" y2 = "19.78" > < / line > < line x1 = "1" y1 = "12" x2 = "3" y2 = "12" > < / line > < line x1 = "21" y1 = "12" x2 = "23" y2 = "12" > < / line > < line x1 = "4.22" y1 = "19.78" x2 = "5.64" y2 = "18.36" > < / line > < line x1 = "18.36" y1 = "5.64" x2 = "19.78" y2 = "4.22" > < / line > < / svg >
< svg class = "moon-icon" viewBox = "0 0 24 24" fill = "none" stroke = "currentColor" stroke-width = "2" stroke-linecap = "round" stroke-linejoin = "round" > < path d = "M21 12.79A9 9 0 1 1 11.21 3 7 7 0 0 0 21 12.79z" > < / path > < / svg >
< / button >
< / li >
< / ul >
< / nav >
< / div >
< / header >
< div class = "container manual-layout" >
< aside class = "manual-sidebar" >
< h4 > Components< / h4 >
< select id = "manual-selector" style = "width: 100%; padding: 5px; background: var(--bg-surface); color: var(--text-primary); border: 1px solid var(--border-color); border-radius: 4px; margin-bottom: 2rem;" >
< option value = "manual" > Command Line< / option >
< option value = "manual-daemon" > Daemon< / option >
< option value = "manual-log" > Log< / option >
< / select >
2011-03-01 22:19:30 +01:00
2026-03-30 10:01:17 +02:00
< h4 > Languages< / h4 >
< select id = "language-selector" style = "width: 100%; padding: 5px; background: var(--bg-surface); color: var(--text-primary); border: 1px solid var(--border-color); border-radius: 4px; margin-bottom: 2rem;" >
< option value = "manual" > English< / option >
< option value = "manual-de" > German< / option >
< option value = "manual-es" > Spanish< / option >
< option value = "manual-fr" > French< / option >
< option value = "manual-it" > Italian< / option >
< option value = "manual-ja" > Japanse< / option >
< option value = "manual-ko" > Korean< / option >
< option value = "manual-pl" > Polish< / option >
< option value = "manual-pt" > Portuguese< / option >
< option value = "manual-ro" > Romanian< / option >
< option value = "manual-ru" > Russian< / option >
< option value = "manual-sv" > Swedish< / option >
< option value = "manual-uk" > Ukranian< / option >
< option value = "manual-zh" > Simplified Chinese< / option > .
2011-03-01 22:19:30 +01:00
2026-03-30 10:01:17 +02:00
< / select >
2011-03-01 22:19:30 +01:00
2026-03-30 10:01:17 +02:00
< h4 > Contents< / h4 >
< ul id = "manual-toc-list" >
<!-- Populated by JavaScript -->
< / ul >
< / aside >
2011-03-01 22:19:30 +01:00
2025-12-12 11:57:38 +01:00
2026-03-30 10:01:17 +02:00
< main id = "manual-container" >
< div class = "manual-doc" >
< div class = "manual-section-level-1" >
< h1 id = "sec1" class = "manual-title-level-1" >
2011-03-01 22:19:30 +01:00
Synopsis
2026-03-30 10:01:17 +02:00
< / h1 >
2011-03-01 22:19:30 +01:00
< pre >
snapraid [-c, --conf CONFIG]
[-f, --filter PATTERN] [-d, --filter-disk NAME]
[-m, --filter-missing] [-e, --filter-error]
[-a, --audit-only] [-h, --pre-hash] [-i, --import DIR]
2015-11-13 22:46:09 +01:00
[-p, --plan PERC|bad|new|full]
[-o, --older-than DAYS] [-l, --log FILE]
2025-10-29 15:09:43 +01:00
[-s, --spin-down-on-error] [-w, --bw-limit RATE]
2026-03-30 10:01:17 +02:00
[-t, --tail]
2011-03-01 22:19:30 +01:00
[-Z, --force-zero] [-E, --force-empty]
[-U, --force-uuid] [-D, --force-device]
[-N, --force-nocopy] [-F, --force-full]
2026-03-30 10:01:17 +02:00
[-R, --force-realloc] [-W, --force-realloc-tail]
2011-03-01 22:19:30 +01:00
[-S, --start BLKSTART] [-B, --count BLKCOUNT]
[-L, --error-limit NUMBER]
2025-10-29 15:09:43 +01:00
[-A, --stats]
2011-03-01 22:19:30 +01:00
[-v, --verbose] [-q, --quiet]
2025-10-29 15:09:43 +01:00
status|smart|probe|up|down|diff|sync|scrub|fix|check
2026-03-30 10:01:17 +02:00
|list|dup|pool|devices|touch|rehash|locate
2011-03-01 22:19:30 +01:00
< / pre >
< pre >
snapraid [-V, --version] [-H, --help] [-C, --gen-conf CONTENT]
< / pre >
2026-03-30 10:01:17 +02:00
< / div >
< div class = "manual-section-level-1" >
< h1 id = "sec2" class = "manual-title-level-1" >
2011-03-01 22:19:30 +01:00
Description
2026-03-30 10:01:17 +02:00
< / h1 >
2025-12-14 22:21:44 +01:00
< p > SnapRAID is a backup program designed for disk arrays, storing
2023-12-09 15:49:32 +01:00
parity information for data recovery in the event of up to six
disk failures.
2025-12-14 22:21:44 +01:00
< / p > < p > Primarily intended for home media centers with large,
2023-12-09 15:49:32 +01:00
infrequently changing files, SnapRAID offers several features:
2025-12-14 22:21:44 +01:00
< / p > < ul >
2011-03-01 22:19:30 +01:00
< li >
2023-12-09 15:49:32 +01:00
You can utilize disks already filled with files without the
need to reformat them, accessing them as usual.
2021-05-02 08:22:05 +02:00
< / li >
< li >
2023-12-09 15:49:32 +01:00
All your data is hashed to ensure data integrity and prevent
2011-03-01 22:19:30 +01:00
silent corruption.
< / li >
< li >
2023-12-09 15:49:32 +01:00
When the number of failed disks exceeds the parity count,
data loss is confined to the affected disks; data on
other disks remains accessible.
2011-03-01 22:19:30 +01:00
< / li >
< li >
2023-12-09 15:49:32 +01:00
If you accidentally delete files on a disk, recovery is
possible.
2011-03-01 22:19:30 +01:00
< / li >
< li >
2023-12-09 15:49:32 +01:00
Disks can have different sizes.
2011-03-01 22:19:30 +01:00
< / li >
< li >
You can add disks at any time.
< / li >
< li >
2023-12-09 15:49:32 +01:00
SnapRAID doesn't lock in your data; you can stop using it
anytime without reformatting or moving data.
2011-03-01 22:19:30 +01:00
< / li >
2015-11-13 22:46:09 +01:00
< li >
2023-12-09 15:49:32 +01:00
To access a file, only a single disk needs to spin, saving
power and reducing noise.
2015-11-13 22:46:09 +01:00
< / li >
2011-03-01 22:19:30 +01:00
< / ul >
2025-12-14 22:21:44 +01:00
< p > For more information, please visit the official SnapRAID site:
2026-03-30 10:01:17 +02:00
< / p > < pre >
< a href = "https://www.snapraid.it/" > https://www.snapraid.it/< / a >
2011-03-01 22:19:30 +01:00
< / pre >
2026-03-30 10:01:17 +02:00
< / div >
< div class = "manual-section-level-1" >
< h1 id = "sec3" class = "manual-title-level-1" >
2011-03-01 22:19:30 +01:00
Limitations
2026-03-30 10:01:17 +02:00
< / h1 >
2025-12-14 22:21:44 +01:00
< p > SnapRAID is a hybrid between a RAID and a backup program, aiming to combine
2025-10-29 15:09:43 +01:00
the best benefits of both. However, it has some limitations that you should
2011-03-01 22:19:30 +01:00
consider before using it.
2025-12-14 22:21:44 +01:00
< / p > < p > The main limitation is that if a disk fails and you haven't recently synced,
2025-10-29 15:09:43 +01:00
you may not be able to fully recover.
2024-01-22 21:58:41 +01:00
More specifically, you may be unable to recover up to the size of
2025-10-29 15:09:43 +01:00
the changed or deleted files since the last sync operation.
This occurs even if the changed or deleted files are not on the
2024-01-22 21:58:41 +01:00
failed disk. This is why SnapRAID is better suited for
2025-10-29 15:09:43 +01:00
data that rarely changes.
2025-12-14 22:21:44 +01:00
< / p > < p > On the other hand, newly added files don't prevent recovery of already
2025-10-29 15:09:43 +01:00
existing files. You will only lose the recently added files if they
are on the failed disk.
2025-12-14 22:21:44 +01:00
< / p > < p > Other SnapRAID limitations are:
< / p > < ul >
2011-03-01 22:19:30 +01:00
< li >
2025-10-29 15:09:43 +01:00
With SnapRAID, you still have separate file systems for each disk.
With RAID, you get a single large file system.
2011-03-01 22:19:30 +01:00
< / li >
< li >
2024-01-22 21:58:41 +01:00
SnapRAID doesn't stripe data.
2025-10-29 15:09:43 +01:00
With RAID, you get a speed boost with striping.
2011-03-01 22:19:30 +01:00
< / li >
< li >
2024-01-22 21:58:41 +01:00
SnapRAID doesn't support real-time recovery.
2025-10-29 15:09:43 +01:00
With RAID, you do not have to stop working when a disk fails.
2011-03-01 22:19:30 +01:00
< / li >
< li >
2025-10-29 15:09:43 +01:00
SnapRAID can recover data only from a limited number of disk failures.
With a backup, you can recover from a complete
failure of the entire disk array.
2011-03-01 22:19:30 +01:00
< / li >
< li >
2025-10-29 15:09:43 +01:00
Only file names, timestamps, symlinks, and hardlinks are saved.
Permissions, ownership, and extended attributes are not saved.
2011-03-01 22:19:30 +01:00
< / li >
< / ul >
2026-03-30 10:01:17 +02:00
< / div >
< div class = "manual-section-level-1" >
< h1 id = "sec4" class = "manual-title-level-1" >
2011-03-01 22:19:30 +01:00
Getting Started
2026-03-30 10:01:17 +02:00
< / h1 >
2025-12-14 22:21:44 +01:00
< p > To use SnapRAID, you need to first select one disk in your disk array
2026-03-30 10:01:17 +02:00
to dedicate to < b > parity< / b > information. With one disk for parity, you
2025-10-29 15:09:43 +01:00
will be able to recover from a single disk failure, similar to RAID5.
2025-12-14 22:21:44 +01:00
< / p > < p > If you want to recover from more disk failures, similar to RAID6,
2025-10-29 15:09:43 +01:00
you must reserve additional disks for parity. Each additional parity
disk allows recovery from one more disk failure.
2025-12-14 22:21:44 +01:00
< / p > < p > As parity disks, you must pick the largest disks in the array,
2025-10-29 15:09:43 +01:00
as the parity information may grow to the size of the largest data
2011-03-01 22:19:30 +01:00
disk in the array.
2026-03-30 10:01:17 +02:00
< / p > < p > These disks will be dedicated to storing the < b > parity< / b > files.
2025-10-29 15:09:43 +01:00
You should not store your data on them.
2026-03-30 10:01:17 +02:00
< / p > < p > Then, you must define the < b > data< / b > disks that you want to protect
2011-03-01 22:19:30 +01:00
with SnapRAID. The protection is more effective if these disks
2025-10-29 15:09:43 +01:00
contain data that rarely changes. For this reason, it's better to
NOT include the Windows C:\ disk or the Unix /home, /var, and /tmp
directories.
2026-03-30 10:01:17 +02:00
< / p > < p > The list of files is saved in the < b > content< / b > files, usually
2025-10-29 15:09:43 +01:00
stored on the data, parity, or boot disks.
This file contains the details of your backup, including all the
checksums to verify its integrity.
2026-03-30 10:01:17 +02:00
The < b > content< / b > file is stored in multiple copies, and each copy must
2025-10-29 15:09:43 +01:00
be on a different disk to ensure that, even in case of multiple
disk failures, at least one copy is available.
2025-12-14 22:21:44 +01:00
< / p > < p > For example, suppose you are interested in only one parity level
2025-10-29 15:09:43 +01:00
of protection, and your disks are located at:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2011-03-01 22:19:30 +01:00
/mnt/diskp < - selected disk for parity
/mnt/disk1 < - first disk to protect
/mnt/disk2 < - second disk to protect
/mnt/disk3 < - third disk to protect
< / pre >
2025-12-14 22:21:44 +01:00
< p > You must create the configuration file /etc/snapraid.conf with
2011-03-01 22:19:30 +01:00
the following options:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2011-03-01 22:19:30 +01:00
parity /mnt/diskp/snapraid.parity
content /var/snapraid/snapraid.content
content /mnt/disk1/snapraid.content
content /mnt/disk2/snapraid.content
2016-03-04 20:35:27 +01:00
data d1 /mnt/disk1/
data d2 /mnt/disk2/
data d3 /mnt/disk3/
2011-03-01 22:19:30 +01:00
< / pre >
2025-12-14 22:21:44 +01:00
< p > If you are on Windows, you should use the Windows path format, with drive
2011-03-01 22:19:30 +01:00
letters and backslashes instead of slashes.
2026-03-30 10:01:17 +02:00
< / p > < pre >
2011-03-01 22:19:30 +01:00
parity E:\snapraid.parity
content C:\snapraid\snapraid.content
content F:\array\snapraid.content
content G:\array\snapraid.content
2016-03-04 20:35:27 +01:00
data d1 F:\array\
data d2 G:\array\
data d3 H:\array\
2011-03-01 22:19:30 +01:00
< / pre >
2025-12-14 22:21:44 +01:00
< p > If you have many disks and run out of drive letters, you can mount
2025-10-29 15:09:43 +01:00
disks directly in subfolders. See:
2026-03-30 10:01:17 +02:00
< / p > < pre >
< a href = "https://www.google.com/search?q=Windows+mount+point" > https://www.google.com/search?q=Windows+mount+point< / a >
2011-03-01 22:19:30 +01:00
< / pre >
2026-03-30 10:01:17 +02:00
< p > At this point, you are ready to run the < b > sync< / b > command to build the
2011-03-01 22:19:30 +01:00
parity information.
2026-03-30 10:01:17 +02:00
< / p > < pre >
2011-03-01 22:19:30 +01:00
snapraid sync
< / pre >
2025-12-14 22:21:44 +01:00
< p > This process may take several hours the first time, depending on the size
2025-10-29 15:09:43 +01:00
of the data already present on the disks. If the disks are empty,
2011-03-01 22:19:30 +01:00
the process is immediate.
2025-12-14 22:21:44 +01:00
< / p > < p > You can stop it at any time by pressing Ctrl+C, and at the next run, it
2025-10-29 15:09:43 +01:00
will resume where it was interrupted.
2025-12-14 22:21:44 +01:00
< / p > < p > When this command completes, your data is SAFE.
< / p > < p > Now you can start using your array as you like and periodically
2026-03-30 10:01:17 +02:00
update the parity information by running the < b > sync< / b > command.
< / p > < div class = "manual-section-level-2" >
< h2 id = "sec4-1" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
Scrubbing
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > To periodically check the data and parity for errors, you can
2026-03-30 10:01:17 +02:00
run the < b > scrub< / b > command.
< / p > < pre >
2011-03-01 22:19:30 +01:00
snapraid scrub
< / pre >
2025-12-14 22:21:44 +01:00
< p > This command compares the data in your array with the hash computed
2026-03-30 10:01:17 +02:00
during the < b > sync< / b > command to verify integrity.
2025-12-14 22:21:44 +01:00
< / p > < p > Each run of the command checks approximately 8% of the array, excluding data
2015-11-13 22:46:09 +01:00
already scrubbed in the previous 10 days.
2025-10-29 15:09:43 +01:00
You can use the -p, --plan option to specify a different amount
2011-03-01 22:19:30 +01:00
and the -o, --older-than option to specify a different age in days.
2025-10-29 15:09:43 +01:00
For example, to check 5% of the array for blocks older than 20 days, use:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2011-03-01 22:19:30 +01:00
snapraid -p 5 -o 20 scrub
< / pre >
2025-12-14 22:21:44 +01:00
< p > If silent or input/output errors are found during the process,
2026-03-30 10:01:17 +02:00
the corresponding blocks are marked as bad in the < b > content< / b > file
and listed in the < b > status< / b > command.
< / p > < pre >
2011-03-01 22:19:30 +01:00
snapraid status
< / pre >
2026-03-30 10:01:17 +02:00
< p > To fix them, you can use the < b > fix< / b > command, filtering for bad blocks with
2025-10-29 15:09:43 +01:00
the -e, --filter-error option:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2011-03-01 22:19:30 +01:00
snapraid -e fix
< / pre >
2026-03-30 10:01:17 +02:00
< p > At the next < b > scrub< / b > , the errors will disappear from the < b > status< / b > report
2025-10-29 15:09:43 +01:00
if they are truly fixed. To make it faster, you can use -p bad to scrub
only blocks marked as bad.
2026-03-30 10:01:17 +02:00
< / p > < pre >
2015-11-13 22:46:09 +01:00
snapraid -p bad scrub
2011-03-01 22:19:30 +01:00
< / pre >
2026-03-30 10:01:17 +02:00
< p > Running < b > scrub< / b > on an unsynced array may report errors caused by
removed or modified files. These errors are reported in the < b > scrub< / b >
2025-10-29 15:09:43 +01:00
output, but the related blocks are not marked as bad.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec4-2" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
Pooling
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Note: The pooling feature described below has been superseded by the
2026-03-30 10:01:17 +02:00
mergerfs tool, which is now the recommended option for Linux users in
2025-10-29 15:09:43 +01:00
the SnapRAID community. Mergefs provides a more flexible and efficient
way to pool multiple drives into a single unified mount point,
allowing seamless access to files across your array without relying
on symbolic links. It integrates well with SnapRAID for parity
protection and is commonly used in setups like OpenMediaVault (OMV)
or custom NAS configurations.
2025-12-14 22:21:44 +01:00
< / p > < p > To have all the files in your array shown in the same directory tree,
2026-03-30 10:01:17 +02:00
you can enable the < b > pooling< / b > feature. It creates a read-only virtual
2025-10-29 15:09:43 +01:00
view of all the files in your array using symbolic links.
2026-03-30 10:01:17 +02:00
< / p > < p > You can configure the < b > pooling< / b > directory in the configuration file with:
< / p > < pre >
2011-03-01 22:19:30 +01:00
pool /pool
< / pre >
2025-12-14 22:21:44 +01:00
< p > or, if you are on Windows, with:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2011-03-01 22:19:30 +01:00
pool C:\pool
< / pre >
2026-03-30 10:01:17 +02:00
< p > and then run the < b > pool< / b > command to create or update the virtual view.
< / p > < pre >
2011-03-01 22:19:30 +01:00
snapraid pool
< / pre >
2025-12-14 22:21:44 +01:00
< p > If you are using a Unix platform and want to share this directory
2025-10-29 15:09:43 +01:00
over the network to either Windows or Unix machines, you should add
the following options to your /etc/samba/smb.conf:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2011-03-01 22:19:30 +01:00
# In the global section of smb.conf
unix extensions = no
< / pre >
< pre >
# In the share section of smb.conf
[pool]
comment = Pool
path = /pool
read only = yes
guest ok = yes
wide links = yes
follow symlinks = yes
< / pre >
2025-12-14 22:21:44 +01:00
< p > In Windows, sharing symbolic links over a network requires clients to
2025-10-29 15:09:43 +01:00
resolve them remotely. To enable this, besides sharing the pool directory,
you must also share all the disks independently, using the disk names
defined in the configuration file as share points. You must also specify
2026-03-30 10:01:17 +02:00
in the < b > share< / b > option of the configuration file the Windows UNC path that
2025-10-29 15:09:43 +01:00
remote clients need to use to access these shared disks.
2026-03-30 10:01:17 +02:00
< / p > < p > For example, operating from a server named < b > darkstar< / b > , you can use
2011-03-01 22:19:30 +01:00
the options:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2016-03-04 20:35:27 +01:00
data d1 F:\array\
data d2 G:\array\
data d3 H:\array\
2011-03-01 22:19:30 +01:00
pool C:\pool
share \\darkstar
< / pre >
2025-12-14 22:21:44 +01:00
< p > and share the following directories over the network:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2011-03-01 22:19:30 +01:00
\\darkstar\pool -> C:\pool
\\darkstar\d1 -> F:\array
\\darkstar\d2 -> G:\array
\\darkstar\d3 -> H:\array
< / pre >
2025-12-14 22:21:44 +01:00
< p > to allow remote clients to access all the files at \\darkstar\pool.
< / p > < p > You may also need to configure remote clients to enable access to remote
2015-11-13 22:46:09 +01:00
symlinks with the command:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2011-03-01 22:19:30 +01:00
fsutil behavior set SymlinkEvaluation L2L:1 R2R:1 L2R:1 R2L:1
< / pre >
2026-03-30 10:01:17 +02:00
< / div >
< div class = "manual-section-level-2" >
< h2 id = "sec4-3" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
Undeleting
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > SnapRAID functions more like a backup program than a RAID system, and it
2011-03-01 22:19:30 +01:00
can be used to restore or undelete files to their previous state using
2025-10-29 15:09:43 +01:00
the -f, --filter option:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2011-03-01 22:19:30 +01:00
snapraid fix -f FILE
< / pre >
2025-12-14 22:21:44 +01:00
< p > or for a directory:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2011-03-01 22:19:30 +01:00
snapraid fix -f DIR/
< / pre >
2025-12-14 22:21:44 +01:00
< p > You can also use it to recover only accidentally deleted files inside
2025-10-29 15:09:43 +01:00
a directory using the -m, --filter-missing option, which restores
only missing files, leaving all others untouched.
2026-03-30 10:01:17 +02:00
< / p > < pre >
2011-03-01 22:19:30 +01:00
snapraid fix -m -f DIR/
< / pre >
2025-12-14 22:21:44 +01:00
< p > Or to recover all the deleted files on all drives with:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2011-03-01 22:19:30 +01:00
snapraid fix -m
< / pre >
2026-03-30 10:01:17 +02:00
< / div >
< div class = "manual-section-level-2" >
< h2 id = "sec4-4" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
Recovering
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > The worst has happened, and you have lost one or more disks!
< / p > < p > DO NOT PANIC! You will be able to recover them!
< / p > < p > The first thing you must do is avoid further changes to your disk array.
2025-10-29 15:09:43 +01:00
Disable any remote connections to it and any scheduled processes, including
any scheduled SnapRAID nightly sync or scrub.
2025-12-14 22:21:44 +01:00
< / p > < p > Then proceed with the following steps.
2026-03-30 10:01:17 +02:00
< / p > < div class = "manual-section-level-3" >
< h3 id = "sec4-4-1" class = "manual-title-level-3" >
2011-03-01 22:19:30 +01:00
STEP 1 -> Reconfigure
2026-03-30 10:01:17 +02:00
< / h3 >
2025-12-14 22:21:44 +01:00
< p > You need some space to recover, ideally on additional
2025-10-29 15:09:43 +01:00
spare disks, but an external USB disk or remote disk will suffice.
2026-03-30 10:01:17 +02:00
< / p > < p > Modify the SnapRAID configuration file to make the < b > data< / b > or < b > parity< / b >
2025-10-29 15:09:43 +01:00
option of the failed disk point to a location with enough empty
2011-03-01 22:19:30 +01:00
space to recover the files.
2026-03-30 10:01:17 +02:00
< / p > < p > For example, if disk < b > d1< / b > has failed, change from:
< / p > < pre >
2016-03-04 20:35:27 +01:00
data d1 /mnt/disk1/
2011-03-01 22:19:30 +01:00
< / pre >
2025-12-14 22:21:44 +01:00
< p > to:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2016-03-04 20:35:27 +01:00
data d1 /mnt/new_spare_disk/
2011-03-01 22:19:30 +01:00
< / pre >
2026-03-30 10:01:17 +02:00
< p > If the disk to recover is a parity disk, update the appropriate < b > parity< / b >
2016-12-28 09:39:34 +01:00
option.
2025-10-29 15:09:43 +01:00
If you have multiple failed disks, update all their configuration options.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-3" >
< h3 id = "sec4-4-2" class = "manual-title-level-3" >
2011-03-01 22:19:30 +01:00
STEP 2 -> Fix
2026-03-30 10:01:17 +02:00
< / h3 >
2025-12-14 22:21:44 +01:00
< p > Run the fix command, storing the log in an external file with:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2011-03-01 22:19:30 +01:00
snapraid -d NAME -l fix.log fix
< / pre >
2026-03-30 10:01:17 +02:00
< p > Where NAME is the name of the disk, such as < b > d1< / b > in our previous example.
If the disk to recover is a parity disk, use the names < b > parity< / b > , < b > 2-parity< / b > ,
2025-10-29 15:09:43 +01:00
etc.
If you have multiple failed disks, use multiple -d options to specify all
2016-12-28 09:39:34 +01:00
of them.
2025-12-14 22:21:44 +01:00
< / p > < p > This command will take a long time.
< / p > < p > Ensure you have a few gigabytes free to store the fix.log file.
2025-10-29 15:09:43 +01:00
Run it from a disk with sufficient free space.
2025-12-14 22:21:44 +01:00
< / p > < p > Now you have recovered all that is recoverable. If some files are partially
2026-03-30 10:01:17 +02:00
or totally unrecoverable, they will be renamed by adding the < b > .unrecoverable< / b >
2025-10-29 15:09:43 +01:00
extension.
2025-12-14 22:21:44 +01:00
< / p > < p > You can find a detailed list of all unrecoverable blocks in the fix.log file
2026-03-30 10:01:17 +02:00
by checking all lines starting with < b > unrecoverable:< / b > .
2025-12-14 22:21:44 +01:00
< / p > < p > If you are not satisfied with the recovery, you can retry it as many
2025-10-29 15:09:43 +01:00
times as you wish.
2025-12-14 22:21:44 +01:00
< / p > < p > For example, if you have removed files from the array after the last
2026-03-30 10:01:17 +02:00
< b > sync< / b > , this may result in some files not being recovered.
In this case, you can retry the < b > fix< / b > using the -i, --import option,
2025-10-29 15:09:43 +01:00
specifying where these files are now to include them again in the
recovery process.
2025-12-14 22:21:44 +01:00
< / p > < p > If you are satisfied with the recovery, you can proceed further,
2026-03-30 10:01:17 +02:00
but note that after syncing, you cannot retry the < b > fix< / b > command
2011-03-01 22:19:30 +01:00
anymore!
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-3" >
< h3 id = "sec4-4-3" class = "manual-title-level-3" >
2011-03-01 22:19:30 +01:00
STEP 3 -> Check
2026-03-30 10:01:17 +02:00
< / h3 >
< p > As a cautious check, you can now run a < b > check< / b > command to ensure that
2025-10-29 15:09:43 +01:00
everything is correct on the recovered disk.
2026-03-30 10:01:17 +02:00
< / p > < pre >
2011-03-01 22:19:30 +01:00
snapraid -d NAME -a check
< / pre >
2026-03-30 10:01:17 +02:00
< p > Where NAME is the name of the disk, such as < b > d1< / b > in our previous example.
2025-12-14 22:21:44 +01:00
< / p > < p > The -d and -a options tell SnapRAID to check only the specified disk
2025-10-29 15:09:43 +01:00
and ignore all parity data.
2025-12-14 22:21:44 +01:00
< / p > < p > This command will take a long time, but if you are not overly cautious,
2011-03-01 22:19:30 +01:00
you can skip it.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-3" >
< h3 id = "sec4-4-4" class = "manual-title-level-3" >
2011-03-01 22:19:30 +01:00
STEP 4 -> Sync
2026-03-30 10:01:17 +02:00
< / h3 >
< p > Run the < b > sync< / b > command to resynchronize the array with the new disk.
< / p > < pre >
2011-03-01 22:19:30 +01:00
snapraid sync
< / pre >
2025-12-14 22:21:44 +01:00
< p > If everything is recovered, this command is immediate.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< / div >
< / div >
< div class = "manual-section-level-1" >
< h1 id = "sec5" class = "manual-title-level-1" >
2011-03-01 22:19:30 +01:00
Commands
2026-03-30 10:01:17 +02:00
< / h1 >
2025-12-14 22:21:44 +01:00
< p > SnapRAID provides a few simple commands that allow you to:
< / p > < ul >
2011-03-01 22:19:30 +01:00
< li >
2026-03-30 10:01:17 +02:00
Print the status of the array -> < b > status< / b >
2011-03-01 22:19:30 +01:00
< / li >
< li >
2026-03-30 10:01:17 +02:00
Control the disks -> < b > smart< / b > , < b > probe< / b > , < b > up< / b > , < b > down< / b >
2011-03-01 22:19:30 +01:00
< / li >
< li >
2026-03-30 10:01:17 +02:00
Make a backup/snapshot -> < b > sync< / b >
2011-03-01 22:19:30 +01:00
< / li >
< li >
2026-03-30 10:01:17 +02:00
Periodically check data -> < b > scrub< / b >
2011-03-01 22:19:30 +01:00
< / li >
< li >
2026-03-30 10:01:17 +02:00
Restore the last backup/snapshot -> < b > fix< / b > .
2011-03-01 22:19:30 +01:00
< / li >
< / ul >
2025-12-14 22:21:44 +01:00
< p > Commands must be written in lowercase.
2026-03-30 10:01:17 +02:00
< / p > < div class = "manual-section-level-2" >
< h2 id = "sec5-1" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
status
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Prints a summary of the state of the disk array.
< / p > < p > It includes information about parity fragmentation, how old
2025-10-29 15:09:43 +01:00
the blocks are without checking, and all recorded silent
2011-03-01 22:19:30 +01:00
errors encountered while scrubbing.
2025-12-14 22:21:44 +01:00
< / p > < p > The information presented refers to the latest time you
2026-03-30 10:01:17 +02:00
ran < b > sync< / b > . Later modifications are not taken into account.
2025-12-14 22:21:44 +01:00
< / p > < p > If bad blocks were detected, their block numbers are listed.
2026-03-30 10:01:17 +02:00
To fix them, you can use the < b > fix -e< / b > command.
2025-12-14 22:21:44 +01:00
< / p > < p > It also shows a graph representing the last time each block
2026-03-30 10:01:17 +02:00
was scrubbed or synced. Scrubbed blocks are shown with < b > *< / b > ,
blocks synced but not yet scrubbed with < b > o< / b > .
2025-12-14 22:21:44 +01:00
< / p > < p > Nothing is modified.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec5-2" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
smart
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Prints a SMART report of all the disks in the system.
< / p > < p > It includes an estimation of the probability of failure in the next
2025-10-29 15:09:43 +01:00
year, allowing you to plan maintenance replacements of disks that show
2011-03-01 22:19:30 +01:00
suspicious attributes.
2025-12-14 22:21:44 +01:00
< / p > < p > This probability estimation is obtained by correlating the SMART attributes
2025-10-29 15:09:43 +01:00
of the disks with the Backblaze data available at:
2026-03-30 10:01:17 +02:00
< / p > < pre >
< a href = "https://www.backblaze.com/hard-drive-test-data.html" > https://www.backblaze.com/hard-drive-test-data.html< / a >
2011-03-01 22:19:30 +01:00
< / pre >
2026-03-30 10:01:17 +02:00
< p > If SMART reports that a disk is failing, < b > FAIL< / b > or < b > PREFAIL< / b > is printed
2011-03-01 22:19:30 +01:00
for that disk, and SnapRAID returns with an error.
2025-10-29 15:09:43 +01:00
In this case, immediate replacement of the disk is highly recommended.
2025-12-14 22:21:44 +01:00
< / p > < p > Other possible status strings are:
2026-03-30 10:01:17 +02:00
< / p > < div class = "manual-tag-list" >
< div class = "manual-tag-entry" >
< div class = "manual-tag-name" >
2011-03-01 22:19:30 +01:00
logfail
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-tag-description" >
2025-10-29 15:09:43 +01:00
In the past, some attributes were lower than
2011-03-01 22:19:30 +01:00
the threshold.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< div class = "manual-tag-entry" >
< div class = "manual-tag-name" >
2011-03-01 22:19:30 +01:00
logerr
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-tag-description" >
2011-03-01 22:19:30 +01:00
The device error log contains errors.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< div class = "manual-tag-entry" >
< div class = "manual-tag-name" >
2011-03-01 22:19:30 +01:00
selferr
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-tag-description" >
2011-03-01 22:19:30 +01:00
The device self-test log contains errors.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< / div >
2025-12-14 22:21:44 +01:00
< p > If the -v, --verbose option is specified, a deeper statistical analysis
2025-10-29 15:09:43 +01:00
is provided. This analysis can help you decide if you need more
2011-03-01 22:19:30 +01:00
or less parity.
2026-03-30 10:01:17 +02:00
< / p > < p > This command uses the < b > smartctl< / b > tool and is equivalent to running
< b > smartctl -a< / b > on all devices.
2025-12-14 22:21:44 +01:00
< / p > < p > If your devices are not auto-detected correctly, you can specify
2026-03-30 10:01:17 +02:00
a custom command using the < b > smartctl< / b > option in the configuration
2011-03-01 22:19:30 +01:00
file.
2025-12-14 22:21:44 +01:00
< / p > < p > Nothing is modified.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec5-3" class = "manual-title-level-2" >
2025-10-29 15:09:43 +01:00
probe
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Prints the POWER state of all disks in the system.
2026-03-30 10:01:17 +02:00
< / p > < p > < b > Standby< / b > means the disk is not spinning. < b > Active< / b > means
2025-10-29 15:09:43 +01:00
the disk is spinning.
2026-03-30 10:01:17 +02:00
< / p > < p > This command uses the < b > smartctl< / b > tool and is equivalent to running
< b > smartctl -n standby -i< / b > on all devices.
2025-12-14 22:21:44 +01:00
< / p > < p > If your devices are not auto-detected correctly, you can specify
2026-03-30 10:01:17 +02:00
a custom command using the < b > smartctl< / b > option in the configuration
2025-10-29 15:09:43 +01:00
file.
2025-12-14 22:21:44 +01:00
< / p > < p > Nothing is modified.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec5-4" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
up
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Spins up all the disks of the array.
< / p > < p > You can spin up only specific disks using the -d, --filter-disk option.
< / p > < p > Spinning up all the disks at the same time requires a lot of power.
2025-10-29 15:09:43 +01:00
Ensure that your power supply can sustain it.
2025-12-14 22:21:44 +01:00
< / p > < p > Nothing is modified.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec5-5" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
down
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Spins down all the disks of the array.
2026-03-30 10:01:17 +02:00
< / p > < p > This command uses the < b > smartctl< / b > tool and is equivalent to running
< b > smartctl -s standby,now< / b > on all devices.
2025-12-14 22:21:44 +01:00
< / p > < p > You can spin down only specific disks using the -d, --filter-disk
2025-10-29 15:09:43 +01:00
option.
2025-12-14 22:21:44 +01:00
< / p > < p > To automatically spin down on error, you can use the -s, --spin-down-on-error
2026-03-30 10:01:17 +02:00
option with any other command, which is equivalent to running < b > down< / b > manually
2025-10-29 15:09:43 +01:00
when an error occurs.
2025-12-14 22:21:44 +01:00
< / p > < p > Nothing is modified.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec5-6" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
diff
2026-03-30 10:01:17 +02:00
< / h2 >
< p > Lists all the files modified since the last < b > sync< / b > that need to have
2011-03-01 22:19:30 +01:00
their parity data recomputed.
2025-12-14 22:21:44 +01:00
< / p > < p > This command doesn't check the file data, but only the file timestamp,
2025-10-29 15:09:43 +01:00
size, and inode.
2025-12-14 22:21:44 +01:00
< / p > < p > After listing all changed files, a summary of the changes is
2025-10-29 15:09:43 +01:00
presented, grouped by:
2026-03-30 10:01:17 +02:00
< / p > < div class = "manual-tag-list" >
< div class = "manual-tag-entry" >
< div class = "manual-tag-name" >
2016-03-04 20:35:27 +01:00
equal
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-tag-description" >
2025-10-29 15:09:43 +01:00
Files unchanged from before.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< div class = "manual-tag-entry" >
< div class = "manual-tag-name" >
2016-03-04 20:35:27 +01:00
added
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-tag-description" >
2016-03-04 20:35:27 +01:00
Files added that were not present before.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< div class = "manual-tag-entry" >
< div class = "manual-tag-name" >
2016-03-04 20:35:27 +01:00
removed
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-tag-description" >
2016-03-04 20:35:27 +01:00
Files removed.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< div class = "manual-tag-entry" >
< div class = "manual-tag-name" >
2016-03-04 20:35:27 +01:00
updated
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-tag-description" >
2025-10-29 15:09:43 +01:00
Files with a different size or timestamp, meaning they
were modified.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< div class = "manual-tag-entry" >
< div class = "manual-tag-name" >
2016-03-04 20:35:27 +01:00
moved
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-tag-description" >
2025-10-29 15:09:43 +01:00
Files moved to a different directory on the same disk.
They are identified by having the same name, size, timestamp,
and inode, but a different directory.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< div class = "manual-tag-entry" >
< div class = "manual-tag-name" >
2016-03-04 20:35:27 +01:00
copied
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-tag-description" >
Files copied on the same or a different disk where the
original file still exists. They are identified by having
the same name, size, and timestamp. If the sub-second
timestamp is zero, the full path must match to be
identified, not just the name.
< / div >
< / div >
< div class = "manual-tag-entry" >
< div class = "manual-tag-name" >
relocated
< / div > < div class = "manual-tag-description" >
Files moved on the same or a different disk where
the original has disappeared. They are identified by
having the same name, size, and timestamp. If the
sub-second timestamp is zero, the full path must match
to be identified. Unlike 'moved' files on the same disk,
relocated files have a different inode.
< / div >
< / div >
< div class = "manual-tag-entry" >
< div class = "manual-tag-name" >
2016-03-04 20:35:27 +01:00
restored
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-tag-description" >
Files with a different inode but matching directory,
name, size, and timestamp.
2025-10-29 15:09:43 +01:00
These are usually files restored after being deleted.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< / div >
< p > If a < b > sync< / b > is required, the process return code is 2, instead of the
2025-10-29 15:09:43 +01:00
default 0. The return code 1 is used for a generic error condition.
2025-12-14 22:21:44 +01:00
< / p > < p > Nothing is modified.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec5-7" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
sync
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Updates the parity information. All modified files
2011-03-01 22:19:30 +01:00
in the disk array are read, and the corresponding parity
data is updated.
2025-12-14 22:21:44 +01:00
< / p > < p > You can stop this process at any time by pressing Ctrl+C,
2011-03-01 22:19:30 +01:00
without losing the work already done.
2026-03-30 10:01:17 +02:00
At the next run, the < b > sync< / b > process will resume where
2025-10-29 15:09:43 +01:00
it was interrupted.
2025-12-14 22:21:44 +01:00
< / p > < p > If silent or input/output errors are found during the process,
2011-03-01 22:19:30 +01:00
the corresponding blocks are marked as bad.
2025-12-14 22:21:44 +01:00
< / p > < p > Files are identified by path and/or inode and checked by
2025-10-29 15:09:43 +01:00
size and timestamp.
If the file size or timestamp differs, the parity data
is recomputed for the entire file.
If the file is moved or renamed on the same disk, keeping the
2015-11-13 22:46:09 +01:00
same inode, the parity is not recomputed.
2011-03-01 22:19:30 +01:00
If the file is moved to another disk, the parity is recomputed,
2025-10-29 15:09:43 +01:00
but the previously computed hash information is retained.
2026-03-30 10:01:17 +02:00
< / p > < p > The < b > content< / b > and < b > parity< / b > files are modified if necessary.
2011-03-01 22:19:30 +01:00
The files in the array are NOT modified.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec5-8" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
scrub
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Scrubs the array, checking for silent or input/output errors in data
2011-03-01 22:19:30 +01:00
and parity disks.
2025-12-14 22:21:44 +01:00
< / p > < p > Each invocation checks approximately 8% of the array, excluding
2025-10-29 15:09:43 +01:00
data already scrubbed in the last 10 days.
This means that scrubbing once a week ensures every bit of data is checked
at least once every three months.
2025-12-14 22:21:44 +01:00
< / p > < p > You can define a different scrub plan or amount using the -p, --plan
2025-10-29 15:09:43 +01:00
option, which accepts:
2015-11-13 22:46:09 +01:00
bad - Scrub blocks marked bad.
2025-10-29 15:09:43 +01:00
new - Scrub just-synced blocks not yet scrubbed.
2015-11-13 22:46:09 +01:00
full - Scrub everything.
2025-10-29 15:09:43 +01:00
0-100 - Scrub the specified percentage of blocks.
2025-12-14 22:21:44 +01:00
< / p > < p > If you specify a percentage amount, you can also use the -o, --older-than
2015-11-13 22:46:09 +01:00
option to define how old the block should be.
2025-10-29 15:09:43 +01:00
The oldest blocks are scrubbed first, ensuring an optimal check.
If you want to scrub only the just-synced blocks not yet scrubbed,
2026-03-30 10:01:17 +02:00
use the < b > -p new< / b > option.
< / p > < p > To get details of the scrub status, use the < b > status< / b > command.
2025-12-14 22:21:44 +01:00
< / p > < p > For any silent or input/output error found, the corresponding blocks
2026-03-30 10:01:17 +02:00
are marked as bad in the < b > content< / b > file.
These bad blocks are listed in < b > status< / b > and can be fixed with < b > fix -e< / b > .
2025-10-29 15:09:43 +01:00
After the fix, at the next scrub, they will be rechecked, and if found
2011-03-01 22:19:30 +01:00
corrected, the bad mark will be removed.
2026-03-30 10:01:17 +02:00
To scrub only the bad blocks, you can use the < b > scrub -p bad< / b > command.
< / p > < p > It's recommended to run < b > scrub< / b > only on a synced array to avoid
2025-10-29 15:09:43 +01:00
reported errors caused by unsynced data. These errors are recognized
2011-03-01 22:19:30 +01:00
as not being silent errors, and the blocks are not marked as bad,
but such errors are reported in the output of the command.
2026-03-30 10:01:17 +02:00
< / p > < p > The < b > content< / b > file is modified to update the time of the last check
2025-10-29 15:09:43 +01:00
for each block and to mark bad blocks.
2026-03-30 10:01:17 +02:00
The < b > parity< / b > files are NOT modified.
2011-03-01 22:19:30 +01:00
The files in the array are NOT modified.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec5-9" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
fix
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Fixes all the files and the parity data.
< / p > < p > All files and parity data are compared with the snapshot
2026-03-30 10:01:17 +02:00
state saved in the last < b > sync< / b > .
2025-10-29 15:09:43 +01:00
If a difference is found, it is reverted to the stored snapshot.
2026-03-30 10:01:17 +02:00
< / p > < p > WARNING! The < b > fix< / b > command does not differentiate between errors and
2015-11-13 22:46:09 +01:00
intentional modifications. It unconditionally reverts the file state
2026-03-30 10:01:17 +02:00
to the last < b > sync< / b > .
2025-12-14 22:21:44 +01:00
< / p > < p > If no other option is specified, the entire array is processed.
2011-03-01 22:19:30 +01:00
Use the filter options to select a subset of files or disks to operate on.
2026-03-30 10:01:17 +02:00
< / p > < p > To fix only the blocks marked bad during < b > sync< / b > and < b > scrub< / b > ,
2011-03-01 22:19:30 +01:00
use the -e, --filter-error option.
2025-10-29 15:09:43 +01:00
Unlike other filter options, this one applies fixes only to files that are
2026-03-30 10:01:17 +02:00
unchanged since the latest < b > sync< / b > .
2025-12-14 22:21:44 +01:00
< / p > < p > SnapRAID renames all files that cannot be fixed by adding the
2026-03-30 10:01:17 +02:00
< b > .unrecoverable< / b > extension.
2025-12-14 22:21:44 +01:00
< / p > < p > Before fixing, the entire array is scanned to find any files moved
2026-03-30 10:01:17 +02:00
since the last < b > sync< / b > operation.
2025-10-29 15:09:43 +01:00
These files are identified by their timestamp, ignoring their name
and directory, and are used in the recovery process if necessary.
2015-11-13 22:46:09 +01:00
If you moved some of them outside the array, you can use the -i, --import
option to specify additional directories to scan.
2025-12-14 22:21:44 +01:00
< / p > < p > Files are identified only by path, not by inode.
2026-03-30 10:01:17 +02:00
< / p > < p > The < b > content< / b > file is NOT modified.
The < b > parity< / b > files are modified if necessary.
2011-03-01 22:19:30 +01:00
The files in the array are modified if necessary.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec5-10" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
check
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Verifies all the files and the parity data.
2026-03-30 10:01:17 +02:00
< / p > < p > It works like < b > fix< / b > , but it only simulates a recovery and no changes
2025-10-29 15:09:43 +01:00
are written to the array.
2025-12-14 22:21:44 +01:00
< / p > < p > This command is primarily intended for manual verification,
2025-10-29 15:09:43 +01:00
such as after a recovery process or in other special conditions.
2026-03-30 10:01:17 +02:00
For periodic and scheduled checks, use < b > scrub< / b > .
2025-12-14 22:21:44 +01:00
< / p > < p > If you use the -a, --audit-only option, only the file
2011-03-01 22:19:30 +01:00
data is checked, and the parity data is ignored for a
faster run.
2025-12-14 22:21:44 +01:00
< / p > < p > Files are identified only by path, not by inode.
< / p > < p > Nothing is modified.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec5-11" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
list
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Lists all the files contained in the array at the time of the
2026-03-30 10:01:17 +02:00
last < b > sync< / b > .
2025-12-14 22:21:44 +01:00
< / p > < p > With -v or --verbose, the subsecond time is also shown.
< / p > < p > Nothing is modified.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec5-12" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
dup
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Lists all duplicate files. Two files are assumed equal if their
2025-10-29 15:09:43 +01:00
hashes match. The file data is not read; only the
precomputed hashes are used.
2025-12-14 22:21:44 +01:00
< / p > < p > Nothing is modified.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec5-13" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
pool
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Creates or updates a virtual view of all
2026-03-30 10:01:17 +02:00
the files in your disk array in the < b > pooling< / b > directory.
2025-12-14 22:21:44 +01:00
< / p > < p > The files are not copied but linked using
2011-03-01 22:19:30 +01:00
symbolic links.
2025-12-14 22:21:44 +01:00
< / p > < p > When updating, all existing symbolic links and empty
2025-10-29 15:09:43 +01:00
subdirectories are deleted and replaced with the new
view of the array. Any other regular files are left in place.
2025-12-14 22:21:44 +01:00
< / p > < p > Nothing is modified outside the pool directory.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec5-14" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
devices
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Prints the low-level devices used by the array.
< / p > < p > This command displays the device associations in the array
2025-10-29 15:09:43 +01:00
and is mainly intended as a script interface.
2025-12-14 22:21:44 +01:00
< / p > < p > The first two columns are the low-level device ID and path.
2025-10-29 15:09:43 +01:00
The next two columns are the high-level device ID and path.
The last column is the disk name in the array.
2025-12-14 22:21:44 +01:00
< / p > < p > In most cases, you have one low-level device for each disk in the
2011-03-01 22:19:30 +01:00
array, but in some more complex configurations, you may have multiple
2025-10-29 15:09:43 +01:00
low-level devices used by a single disk in the array.
2025-12-14 22:21:44 +01:00
< / p > < p > Nothing is modified.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec5-15" class = "manual-title-level-2" >
2016-03-04 20:35:27 +01:00
touch
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Sets an arbitrary sub-second timestamp for all files
2025-10-29 15:09:43 +01:00
that have it set to zero.
2025-12-14 22:21:44 +01:00
< / p > < p > This improves SnapRAID's ability to recognize moved
2025-10-29 15:09:43 +01:00
and copied files, as it makes the timestamp almost unique,
reducing possible duplicates.
2025-12-14 22:21:44 +01:00
< / p > < p > More specifically, if the sub-second timestamp is not zero,
2016-03-04 20:35:27 +01:00
a moved or copied file is identified as such if it matches
2025-10-29 15:09:43 +01:00
the name, size, and timestamp. If the sub-second timestamp
is zero, it is considered a copy only if the full path,
size, and timestamp all match.
2025-12-14 22:21:44 +01:00
< / p > < p > The second-precision timestamp is not modified,
2025-10-29 15:09:43 +01:00
so all the dates and times of your files will be preserved.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec5-16" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
rehash
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Schedules a rehash of the entire array.
< / p > < p > This command changes the hash kind used, typically when upgrading
2025-10-29 15:09:43 +01:00
from a 32-bit system to a 64-bit one, to switch from
2011-03-01 22:19:30 +01:00
MurmurHash3 to the faster SpookyHash.
2025-12-14 22:21:44 +01:00
< / p > < p > If you are already using the optimal hash, this command
2025-10-29 15:09:43 +01:00
does nothing and informs you that no action is needed.
2025-12-14 22:21:44 +01:00
< / p > < p > The rehash is not performed immediately but takes place
2026-03-30 10:01:17 +02:00
progressively during < b > sync< / b > and < b > scrub< / b > .
< / p > < p > You can check the rehash state using < b > status< / b > .
2025-12-14 22:21:44 +01:00
< / p > < p > During the rehash, SnapRAID maintains full functionality,
2026-03-30 10:01:17 +02:00
with the only exception that < b > dup< / b > cannot detect duplicated
2011-03-01 22:19:30 +01:00
files using a different hash.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec5-17" class = "manual-title-level-2" >
locate
2011-03-01 22:19:30 +01:00
< / h2 >
2026-03-30 10:01:17 +02:00
< p > Locate files stored in the parity disks. For each matching file, it
prints its location within the parity file and the number of fragments
it occupies.
< / p > < p > You can use the -t, --tail option to restrict the operation to files
occupying the specified tail portion of the parity.
< / p > < p > If you want to reallocate these files, you can then use the
-W, --force-realloc-tail option. Be aware that such files will
not be protected by parity during the reallocation process.
< / p > < / div >
< / div >
< div class = "manual-section-level-1" >
< h1 id = "sec6" class = "manual-title-level-1" >
Options
< / h1 >
2025-12-14 22:21:44 +01:00
< p > SnapRAID provides the following options:
2026-03-30 10:01:17 +02:00
< / p > < div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-c, --conf CONFIG
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2025-10-29 15:09:43 +01:00
Selects the configuration file to use. If not specified, in Unix
2026-03-30 10:01:17 +02:00
it uses the file < b > /usr/local/etc/snapraid.conf< / b > if it exists,
otherwise < b > /etc/snapraid.conf< / b > .
In Windows, it uses the file < b > snapraid.conf< / b > in the same
directory as < b > snapraid.exe< / b > .
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-f, --filter PATTERN
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
Filters the files to process in < b > check< / b > and < b > fix< / b > .
2025-10-29 15:09:43 +01:00
Only the files matching the specified pattern are processed.
This option can be used multiple times.
See the PATTERN section for more details on
2011-03-01 22:19:30 +01:00
pattern specifications.
2025-10-29 15:09:43 +01:00
In Unix, ensure globbing characters are quoted if used.
2026-03-30 10:01:17 +02:00
This option can be used only with < b > check< / b > and < b > fix< / b > .
It cannot be used with < b > sync< / b > and < b > scrub< / b > , as they always
2025-10-29 15:09:43 +01:00
process the entire array.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-d, --filter-disk NAME
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
Filters the disks to process in < b > check< / b > , < b > fix< / b > , < b > up< / b > , and < b > down< / b > .
2025-10-29 15:09:43 +01:00
You must specify a disk name as defined in the configuration
2011-03-01 22:19:30 +01:00
file.
2026-03-30 10:01:17 +02:00
You can also specify parity disks with the names: < b > parity< / b > , < b > 2-parity< / b > ,
< b > 3-parity< / b > , etc., to limit operations to a specific parity disk.
2025-10-29 15:09:43 +01:00
If you combine multiple --filter, --filter-disk, and --filter-missing options,
only files matching all the filters are selected.
This option can be used multiple times.
2026-03-30 10:01:17 +02:00
This option can be used only with < b > check< / b > , < b > fix< / b > , < b > up< / b > , and < b > down< / b > .
It cannot be used with < b > sync< / b > and < b > scrub< / b > , as they always
2025-10-29 15:09:43 +01:00
process the entire array.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-m, --filter-missing
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
Filters the files to process in < b > check< / b > and < b > fix< / b > .
2025-10-29 15:09:43 +01:00
Only the files missing or deleted from the array are processed.
2026-03-30 10:01:17 +02:00
When used with < b > fix< / b > , this acts as an < b > undelete< / b > command.
2025-10-29 15:09:43 +01:00
If you combine multiple --filter, --filter-disk, and --filter-missing options,
only files matching all the filters are selected.
2026-03-30 10:01:17 +02:00
This option can be used only with < b > check< / b > and < b > fix< / b > .
It cannot be used with < b > sync< / b > and < b > scrub< / b > , as they always
2025-10-29 15:09:43 +01:00
process the entire array.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-e, --filter-error
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
Processes the files with errors in < b > check< / b > and < b > fix< / b > .
2023-12-09 15:49:32 +01:00
It processes only files that have blocks marked with silent
2026-03-30 10:01:17 +02:00
or input/output errors during < b > sync< / b > and < b > scrub< / b > , as listed in < b > status< / b > .
This option can be used only with < b > check< / b > and < b > fix< / b > .
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2015-11-13 22:46:09 +01:00
-p, --plan PERC|bad|new|full
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2015-11-13 22:46:09 +01:00
Selects the scrub plan. If PERC is a numeric value from 0 to 100,
2025-10-29 15:09:43 +01:00
it is interpreted as the percentage of blocks to scrub.
Instead of a percentage, you can specify a plan:
2026-03-30 10:01:17 +02:00
< b > bad< / b > scrubs bad blocks, < b > new< / b > scrubs blocks not yet scrubbed,
and < b > full< / b > scrubs everything.
This option can be used only with < b > scrub< / b > .
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-o, --older-than DAYS
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
Selects the oldest part of the array to process in < b > scrub< / b > .
2025-10-29 15:09:43 +01:00
DAYS is the minimum age in days for a block to be scrubbed;
the default is 10.
Blocks marked as bad are always scrubbed regardless of this option.
2026-03-30 10:01:17 +02:00
This option can be used only with < b > scrub< / b > .
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-a, --audit-only
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
In < b > check< / b > , verifies the hash of the files without
2025-10-29 15:09:43 +01:00
checking the parity data.
If you are interested only in checking the file data, this
option can significantly speed up the checking process.
2026-03-30 10:01:17 +02:00
This option can be used only with < b > check< / b > .
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-h, --pre-hash
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
In < b > sync< / b > , runs a preliminary hashing phase of all new data
2025-10-29 15:09:43 +01:00
for additional verification before the parity computation.
2026-03-30 10:01:17 +02:00
Usually, in < b > sync< / b > , no preliminary hashing is done, and the new
2025-10-29 15:09:43 +01:00
data is hashed just before the parity computation when it is read
2015-11-13 22:46:09 +01:00
for the first time.
2025-10-29 15:09:43 +01:00
This process occurs when the system is under
heavy load, with all disks spinning and a busy CPU.
2015-11-13 22:46:09 +01:00
This is an extreme condition for the machine, and if it has a
2025-10-29 15:09:43 +01:00
latent hardware problem, silent errors may go undetected
because the data is not yet hashed.
2026-03-30 10:01:17 +02:00
To avoid this risk, you can enable the < b > pre-hash< / b > mode to have
2025-10-29 15:09:43 +01:00
all the data read twice to ensure its integrity.
This option also verifies files moved within the array
to ensure the move operation was successful and, if necessary,
allows you to run a fix operation before proceeding.
2026-03-30 10:01:17 +02:00
This option can be used only with < b > sync< / b > .
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-i, --import DIR
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2025-10-29 15:09:43 +01:00
Imports from the specified directory any files deleted
2026-03-30 10:01:17 +02:00
from the array after the last < b > sync< / b > .
If you still have such files, they can be used by < b > check< / b >
and < b > fix< / b > to improve the recovery process.
2025-10-29 15:09:43 +01:00
The files are read, including in subdirectories, and are
2011-03-01 22:19:30 +01:00
identified regardless of their name.
2026-03-30 10:01:17 +02:00
This option can be used only with < b > check< / b > and < b > fix< / b > .
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2025-10-29 15:09:43 +01:00
-s, --spin-down-on-error
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2025-10-29 15:09:43 +01:00
On any error, spins down all managed disks before exiting with
a non-zero status code. This prevents the drives from
remaining active and spinning after an aborted operation,
helping to avoid unnecessary heat buildup and power
consumption. Use this option to ensure disks are safely
stopped even when a command fails.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2025-10-29 15:09:43 +01:00
-w, --bw-limit RATE
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2025-10-29 15:09:43 +01:00
Applies a global bandwidth limit for all disks. The RATE is
the number of bytes per second. You can specify a multiplier
2026-03-30 10:01:17 +02:00
such as K, M, G, or T (e.g., --bw-limit 1G).
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
-t, --tail SIZE
< / div > < div class = "manual-option-description" >
Limit file listing to those using no more than the specified
tail size of the parity disks.
You can use multipliers such as K, M, G, or T (e.g. --tail 1G).
This option is only valid when used together with the < b > locate< / b >
command.
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2025-10-29 15:09:43 +01:00
-A, --stats
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2025-10-29 15:09:43 +01:00
Enables an extended status view that shows additional information.
The screen displays two graphs:
The first graph shows the number of buffered stripes for each
disk, along with the file path of the file currently being
accessed on that disk. Typically, the slowest disk will have
no buffer available, which determines the maximum achievable
bandwidth.
The second graph shows the percentage of time spent waiting
over the past 100 seconds. The slowest disk is expected to
cause most of the wait time, while other disks should have
little or no wait time because they can use their buffered stripes.
This graph also shows the time spent waiting for hash
calculations and RAID computations.
All computations run in parallel with disk operations.
Therefore, as long as there is measurable wait time for at
least one disk, it indicates that the CPU is fast enough to
keep up with the workload.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-Z, --force-zero
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2011-03-01 22:19:30 +01:00
Forces the insecure operation of syncing a file with zero
2025-10-29 15:09:43 +01:00
size that was previously non-zero.
If SnapRAID detects such a condition, it stops proceeding
2011-03-01 22:19:30 +01:00
unless you specify this option.
2025-10-29 15:09:43 +01:00
This allows you to easily detect when, after a system crash,
2011-03-01 22:19:30 +01:00
some accessed files were truncated.
This is a possible condition in Linux with the ext3/ext4
2025-10-29 15:09:43 +01:00
file systems.
2026-03-30 10:01:17 +02:00
This option can be used only with < b > sync< / b > .
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-E, --force-empty
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2011-03-01 22:19:30 +01:00
Forces the insecure operation of syncing a disk with all
the original files missing.
If SnapRAID detects that all the files originally present
2025-10-29 15:09:43 +01:00
on the disk are missing or rewritten, it stops proceeding
2011-03-01 22:19:30 +01:00
unless you specify this option.
2025-10-29 15:09:43 +01:00
This allows you to easily detect when a data file system is not
2011-03-01 22:19:30 +01:00
mounted.
2026-03-30 10:01:17 +02:00
This option can be used only with < b > sync< / b > .
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-U, --force-uuid
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2025-10-29 15:09:43 +01:00
Forces the insecure operation of syncing, checking, and fixing
2011-03-01 22:19:30 +01:00
with disks that have changed their UUID.
If SnapRAID detects that some disks have changed UUID,
it stops proceeding unless you specify this option.
2025-10-29 15:09:43 +01:00
This allows you to detect when your disks are mounted at the
2011-03-01 22:19:30 +01:00
wrong mount points.
2025-10-29 15:09:43 +01:00
It is, however, allowed to have a single UUID change with
single parity, and more with multiple parity, because this is
the normal case when replacing disks after a recovery.
2026-03-30 10:01:17 +02:00
This option can be used only with < b > sync< / b > , < b > check< / b > , or
< b > fix< / b > .
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-D, --force-device
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2025-10-29 15:09:43 +01:00
Forces the insecure operation of fixing with inaccessible disks
2015-11-13 22:46:09 +01:00
or with disks on the same physical device.
2025-10-29 15:09:43 +01:00
For example, if you lost two data disks and have a spare disk to recover
only the first one, you can ignore the second inaccessible disk.
Or, if you want to recover a disk in the free space left on an
2015-11-13 22:46:09 +01:00
already used disk, sharing the same physical device.
2026-03-30 10:01:17 +02:00
This option can be used only with < b > fix< / b > .
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-N, --force-nocopy
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
In < b > sync< / b > , < b > check< / b > , and < b > fix< / b > , disables the copy detection heuristic.
2025-10-29 15:09:43 +01:00
Without this option, SnapRAID assumes that files with the same
attributes, such as name, size, and timestamp, are copies with the
2011-03-01 22:19:30 +01:00
same data.
2025-10-29 15:09:43 +01:00
This allows identification of copied or moved files from one disk
to another and reuses the already computed hash information
2011-03-01 22:19:30 +01:00
to detect silent errors or to recover missing files.
2025-10-29 15:09:43 +01:00
In some rare cases, this behavior may result in false positives
or a slow process due to many hash verifications, and this
option allows you to resolve such issues.
2026-03-30 10:01:17 +02:00
This option can be used only with < b > sync< / b > , < b > check< / b > , and < b > fix< / b > .
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-F, --force-full
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
In < b > sync< / b > , forces a full recomputation of the parity.
2025-10-29 15:09:43 +01:00
This option can be used when you add a new parity level or if
you reverted to an old content file using more recent parity data.
2021-05-02 08:22:05 +02:00
Instead of recreating the parity from scratch, this allows
2025-10-29 15:09:43 +01:00
you to reuse the hashes present in the content file to validate data
2026-03-30 10:01:17 +02:00
and maintain data protection during the < b > sync< / b > process using
2025-10-29 15:09:43 +01:00
the existing parity data.
2026-03-30 10:01:17 +02:00
This option can be used only with < b > sync< / b > .
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2016-11-21 19:57:43 +01:00
-R, --force-realloc
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
In < b > sync< / b > , forces a full reallocation of files and rebuild of the parity.
2025-10-29 15:09:43 +01:00
This option can be used to completely reallocate all files,
removing fragmentation, while reusing the hashes present in the content
2016-11-21 19:57:43 +01:00
file to validate data.
2026-03-30 10:01:17 +02:00
This option can be used only with < b > sync< / b > .
WARNING! This option is for experts only, and it is highly
recommended not to use it.
You DO NOT have data protection during the < b > sync< / b > operation.
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
-W, --force-realloc-tail SIZE
< / div > < div class = "manual-option-description" >
Works like -R, --force-realloc, but limited to the specified
tail portion (last SIZE bytes) of each parity file.
It forces reallocation (movement) of any file fragments/blocks
currently stored in that tail section, allowing them to be
placed anywhere in the parity file(s) where free space is
available (including existing holes).
The main purpose of this option is to shrink the on-disk size
of the parity file. If the reallocation successfully clears
the entire tail section (no blocks remain using it), the
parity file is truncated, reclaiming the unused tail space.
You can use multipliers such as K, M, G, or T (e.g.
--force-realloc-tail 1G).
You can use locate -t, --tail to know in advance the affected
files.
2025-10-29 15:09:43 +01:00
WARNING! This option is for experts only, and it is highly
recommended not to use it.
2026-03-30 10:01:17 +02:00
You DO NOT have data protection during the < b > sync< / b > operation
for the affected files.
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-l, --log FILE
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2025-10-29 15:09:43 +01:00
Writes a detailed log to the specified file.
2011-03-01 22:19:30 +01:00
If this option is not specified, unexpected errors are printed
2025-10-29 15:09:43 +01:00
to the screen, potentially resulting in excessive output in case of
many errors. When -l, --log is specified, only
fatal errors that cause SnapRAID to stop are printed
to the screen.
2026-03-30 10:01:17 +02:00
If the path starts with < b > > > < / b > , the file is opened
in append mode. Occurrences of < b > %D< / b > and < b > %T< / b > in the name are
2011-03-01 22:19:30 +01:00
replaced with the date and time in the format YYYYMMDD and
2025-10-29 15:09:43 +01:00
HHMMSS. In Windows batch files, you must double
2026-03-30 10:01:17 +02:00
the < b > %< / b > character, e.g., result-%%D.log. To use < b > > > < / b > , you must
enclose the name in quotes, e.g., < b > "> > result.log"< / b > .
2011-03-01 22:19:30 +01:00
To output the log to standard output or standard error,
2026-03-30 10:01:17 +02:00
you can use < b > "> & 1"< / b > and < b > "> & 2"< / b > , respectively.
2025-12-12 11:57:38 +01:00
See the snapraid_log.txt file or man page for log tag descriptions.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2025-10-29 15:09:43 +01:00
-L, --error-limit NUMBER
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2011-03-01 22:19:30 +01:00
Sets a new error limit before stopping execution.
2025-10-29 15:09:43 +01:00
By default, SnapRAID stops if it encounters more than 100
input/output errors, indicating that a disk is likely failing.
2026-03-30 10:01:17 +02:00
This option affects < b > sync< / b > and < b > scrub< / b > , which are allowed
2025-10-29 15:09:43 +01:00
to continue after the first set of disk errors to try
to complete their operations.
2026-03-30 10:01:17 +02:00
However, < b > check< / b > and < b > fix< / b > always stop at the first error.
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-S, --start BLKSTART
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2025-10-29 15:09:43 +01:00
Starts processing from the specified
block number. This can be useful for retrying to check
or fix specific blocks in case of a damaged disk.
This option is mainly for advanced manual recovery.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-B, --count BLKCOUNT
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2011-03-01 22:19:30 +01:00
Processes only the specified number of blocks.
2025-10-29 15:09:43 +01:00
This option is mainly for advanced manual recovery.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2025-10-29 15:09:43 +01:00
-C, --gen-conf CONTENT
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2011-03-01 22:19:30 +01:00
Generates a dummy configuration file from an existing
content file.
2025-10-29 15:09:43 +01:00
The configuration file is written to standard output
and does not overwrite an existing one.
2011-03-01 22:19:30 +01:00
This configuration file also contains the information
2025-10-29 15:09:43 +01:00
needed to reconstruct the disk mount points in case you
2011-03-01 22:19:30 +01:00
lose the entire system.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-v, --verbose
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2025-10-29 15:09:43 +01:00
Prints more information to the screen.
If specified once, it prints excluded files
and additional statistics.
2011-03-01 22:19:30 +01:00
This option has no effect on the log files.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-q, --quiet
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2025-10-29 15:09:43 +01:00
Prints less information to the screen.
If specified once, it removes the progress bar; twice,
the running operations; three times, the info
messages; four times, the status messages.
Fatal errors are always printed to the screen.
2011-03-01 22:19:30 +01:00
This option has no effect on the log files.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-H, --help
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2011-03-01 22:19:30 +01:00
Prints a short help screen.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
-V, --version
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2011-03-01 22:19:30 +01:00
Prints the program version.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< / div >
< / div >
< div class = "manual-section-level-1" >
< h1 id = "sec7" class = "manual-title-level-1" >
2011-03-01 22:19:30 +01:00
Configuration
2026-03-30 10:01:17 +02:00
< / h1 >
2025-12-14 22:21:44 +01:00
< p > SnapRAID requires a configuration file to know where your disk array
2025-10-29 15:09:43 +01:00
is located and where to store the parity information.
2026-03-30 10:01:17 +02:00
< / p > < p > In Unix, it uses the file < b > /usr/local/etc/snapraid.conf< / b > if it exists,
otherwise < b > /etc/snapraid.conf< / b > .
In Windows, it uses the file < b > snapraid.conf< / b > in the same
directory as < b > snapraid.exe< / b > .
2025-12-14 22:21:44 +01:00
< / p > < p > It must contain the following options (case-sensitive):
2026-03-30 10:01:17 +02:00
< / p > < div class = "manual-section-level-2" >
< h2 id = "sec7-1" class = "manual-title-level-2" >
2016-11-21 19:57:43 +01:00
parity FILE [,FILE] ...
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Defines the files to use to store the parity information.
2025-10-29 15:09:43 +01:00
The parity enables protection from a single disk
failure, similar to RAID5.
2025-12-14 22:21:44 +01:00
< / p > < p > You can specify multiple files, which must be on different disks.
2016-11-21 19:57:43 +01:00
When a file cannot grow anymore, the next one is used.
2025-10-29 15:09:43 +01:00
The total space available must be at least as large as the largest data disk in
2016-11-21 19:57:43 +01:00
the array.
2025-12-14 22:21:44 +01:00
< / p > < p > You can add additional parity files later, but you
2021-05-02 08:22:05 +02:00
cannot reorder or remove them.
2025-12-14 22:21:44 +01:00
< / p > < p > Keeping the parity disks reserved for parity ensures that
2025-10-29 15:09:43 +01:00
they do not become fragmented, improving performance.
2025-12-14 22:21:44 +01:00
< / p > < p > In Windows, 256 MB is left unused on each disk to avoid the
2016-11-21 19:57:43 +01:00
warning about full disks.
2025-12-14 22:21:44 +01:00
< / p > < p > This option is mandatory and can be used only once.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec7-2" class = "manual-title-level-2" >
2016-11-21 19:57:43 +01:00
(2,3,4,5,6)-parity FILE [,FILE] ...
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Defines the files to use to store extra parity information.
< / p > < p > For each parity level specified, one additional level of protection
2011-03-01 22:19:30 +01:00
is enabled:
2025-12-14 22:21:44 +01:00
< / p > < ul >
2011-03-01 22:19:30 +01:00
< li >
2016-11-21 19:57:43 +01:00
2-parity enables RAID6 dual parity.
2011-03-01 22:19:30 +01:00
< / li >
< li >
2025-10-29 15:09:43 +01:00
3-parity enables triple parity.
2011-03-01 22:19:30 +01:00
< / li >
< li >
2025-10-29 15:09:43 +01:00
4-parity enables quad (four) parity.
2011-03-01 22:19:30 +01:00
< / li >
< li >
2025-10-29 15:09:43 +01:00
5-parity enables penta (five) parity.
2011-03-01 22:19:30 +01:00
< / li >
< li >
2025-10-29 15:09:43 +01:00
6-parity enables hexa (six) parity.
2011-03-01 22:19:30 +01:00
< / li >
< / ul >
2025-12-14 22:21:44 +01:00
< p > Each parity level requires the presence of all previous parity
2016-11-21 19:57:43 +01:00
levels.
2026-03-30 10:01:17 +02:00
< / p > < p > The same considerations as for the < b > parity< / b > option apply.
2025-12-14 22:21:44 +01:00
< / p > < p > These options are optional and can be used only once.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec7-3" class = "manual-title-level-2" >
2016-11-21 19:57:43 +01:00
z-parity FILE [,FILE] ...
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Defines an alternate file and format to store triple parity.
2026-03-30 10:01:17 +02:00
< / p > < p > This option is an alternative to < b > 3-parity< / b > , primarily intended for
2025-10-29 15:09:43 +01:00
low-end CPUs like ARM or AMD Phenom, Athlon, and Opteron that do not
support the SSSE3 instruction set. In such cases, it provides
better performance.
2025-12-14 22:21:44 +01:00
< / p > < p > This format is similar to but faster than the one used by ZFS RAIDZ3.
2025-10-29 15:09:43 +01:00
Like ZFS, it does not work beyond triple parity.
2026-03-30 10:01:17 +02:00
< / p > < p > When using < b > 3-parity< / b > , you will be warned if it is recommended to use
the < b > z-parity< / b > format for performance improvement.
2025-12-14 22:21:44 +01:00
< / p > < p > It is possible to convert from one format to another by adjusting
2025-10-29 15:09:43 +01:00
the configuration file with the desired z-parity or 3-parity file
2026-03-30 10:01:17 +02:00
and using < b > fix< / b > to recreate it.
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec7-4" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
content FILE
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Defines the file to use to store the list and checksums of all the
2011-03-01 22:19:30 +01:00
files present in your disk array.
2025-12-14 22:21:44 +01:00
< / p > < p > It can be placed on a disk used for data, parity, or
2011-03-01 22:19:30 +01:00
any other disk available.
If you use a data disk, this file is automatically excluded
2026-03-30 10:01:17 +02:00
from the < b > sync< / b > process.
2025-12-14 22:21:44 +01:00
< / p > < p > This option is mandatory and can be used multiple times to save
2025-10-29 15:09:43 +01:00
multiple copies of the same file.
2025-12-14 22:21:44 +01:00
< / p > < p > You must store at least one copy for each parity disk used
2025-10-29 15:09:43 +01:00
plus one. Using additional copies does not hurt.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec7-5" class = "manual-title-level-2" >
2016-03-04 20:35:27 +01:00
data NAME DIR
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Defines the name and mount point of the data disks in
2025-10-29 15:09:43 +01:00
the array. NAME is used to identify the disk and must
2016-03-04 20:35:27 +01:00
be unique. DIR is the mount point of the disk in the
2025-10-29 15:09:43 +01:00
file system.
2025-12-14 22:21:44 +01:00
< / p > < p > You can change the mount point as needed, as long as
2025-10-29 15:09:43 +01:00
you keep the NAME fixed.
2025-12-14 22:21:44 +01:00
< / p > < p > You should use one option for each data disk in the array.
< / p > < p > You can rename a disk later by changing the NAME directly
2026-03-30 10:01:17 +02:00
in the configuration file and then running a < b > sync< / b > command.
2025-10-29 15:09:43 +01:00
In the case of renaming, the association is done using the stored
2016-03-04 20:35:27 +01:00
UUID of the disks.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec7-6" class = "manual-title-level-2" >
extra NAME DIR
< / h2 >
< p > Defines the name and mount point of additional disks to monitor
with the < b > smart< / b > and < b > probe< / b > commands.
< / p > < p > This is useful for monitoring disks that are not part of the
array but are required for the system to function, such as
the boot disk.
< / p > < p > Note that such disks are not affected by the < b > up< / b > and < b > down< / b > commands
because they are expected to be always spinning.
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec7-7" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
nohidden
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Excludes all hidden files and directories.
2026-03-30 10:01:17 +02:00
In Unix, hidden files are those starting with < b > .< / b > .
2025-10-29 15:09:43 +01:00
In Windows, they are those with the hidden attribute.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec7-8" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
exclude/include PATTERN
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Defines the file or directory patterns to exclude or include
2011-03-01 22:19:30 +01:00
in the sync process.
2025-10-29 15:09:43 +01:00
All patterns are processed in the specified order.
2026-03-30 10:01:17 +02:00
< / p > < p > If the first pattern that matches is an < b > exclude< / b > one, the file
is excluded. If it is an < b > include< / b > one, the file is included.
2011-03-01 22:19:30 +01:00
If no pattern matches, the file is excluded if the last pattern
2026-03-30 10:01:17 +02:00
specified is an < b > include< / b > , or included if the last pattern
specified is an < b > exclude< / b > .
2025-12-14 22:21:44 +01:00
< / p > < p > See the PATTERN section for more details on pattern
2011-03-01 22:19:30 +01:00
specifications.
2025-12-14 22:21:44 +01:00
< / p > < p > This option can be used multiple times.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec7-9" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
blocksize SIZE_IN_KIBIBYTES
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Defines the basic block size in kibibytes for the parity.
2025-10-29 15:09:43 +01:00
One kibibyte is 1024 bytes.
2025-12-14 22:21:44 +01:00
< / p > < p > The default blocksize is 256, which should work for most cases.
< / p > < p > WARNING! This option is for experts only, and it is highly
2025-10-29 15:09:43 +01:00
recommended not to change this value. To change this value in the
future, you will need to recreate the entire parity!
2025-12-14 22:21:44 +01:00
< / p > < p > A reason to use a different blocksize is if you have many small
2025-10-29 15:09:43 +01:00
files, on the order of millions.
2025-12-14 22:21:44 +01:00
< / p > < p > For each file, even if only a few bytes, an entire block of parity is allocated,
2025-10-29 15:09:43 +01:00
and with many files, this may result in significant unused parity space.
When you completely fill the parity disk, you are not
allowed to add more files to the data disks.
However, the wasted parity does not accumulate across data disks. Wasted space
resulting from a high number of files on a data disk limits only
the amount of data on that data disk, not others.
2025-12-14 22:21:44 +01:00
< / p > < p > As an approximation, you can assume that half of the block size is
2025-10-29 15:09:43 +01:00
wasted for each file. For example, with 100,000 files and a 256 KiB
block size, you will waste 12.8 GB of parity, which may result
in 12.8 GB less space available on the data disk.
2026-03-30 10:01:17 +02:00
< / p > < p > You can check the amount of wasted space on each disk using < b > status< / b > .
2025-10-29 15:09:43 +01:00
This is the amount of space you must leave free on the data
disks or use for files not included in the array.
If this value is negative, it means you are close to filling
2011-03-01 22:19:30 +01:00
the parity, and it represents the space you can still waste.
2025-12-14 22:21:44 +01:00
< / p > < p > To avoid this issue, you can use a larger partition for parity.
2025-10-29 15:09:43 +01:00
For example, if the parity partition is 12.8 GB larger than the data disks,
you have enough extra space to handle up to 100,000
files on each data disk without any wasted space.
2025-12-14 22:21:44 +01:00
< / p > < p > A trick to get a larger parity partition in Linux is to format it
2011-03-01 22:19:30 +01:00
with the command:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2011-03-01 22:19:30 +01:00
mkfs.ext4 -m 0 -T largefile4 DEVICE
< / pre >
2025-12-14 22:21:44 +01:00
< p > This results in about 1.5% extra space, approximately 60 GB for
2025-10-29 15:09:43 +01:00
a 4 TB disk, which allows about 460,000 files on each data disk without
2011-03-01 22:19:30 +01:00
any wasted space.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec7-10" class = "manual-title-level-2" >
2016-11-21 19:57:43 +01:00
hashsize SIZE_IN_BYTES
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Defines the hash size in bytes for the saved blocks.
< / p > < p > The default hashsize is 16 bytes (128 bits), which should work
2016-11-21 19:57:43 +01:00
for most cases.
2025-12-14 22:21:44 +01:00
< / p > < p > WARNING! This option is for experts only, and it is highly
2025-10-29 15:09:43 +01:00
recommended not to change this value. To change this value in the
future, you will need to recreate the entire parity!
2025-12-14 22:21:44 +01:00
< / p > < p > A reason to use a different hashsize is if your system has
2025-10-29 15:09:43 +01:00
limited memory. As a rule of thumb, SnapRAID typically requires
1 GiB of RAM for each 16 TB of data in the array.
2025-12-14 22:21:44 +01:00
< / p > < p > Specifically, to store the hashes of the data, SnapRAID requires
2025-10-29 15:09:43 +01:00
approximately TS*(1+HS)/BS bytes of RAM,
where TS is the total size in bytes of your disk array, BS is the
2016-11-21 19:57:43 +01:00
block size in bytes, and HS is the hash size in bytes.
2025-12-14 22:21:44 +01:00
< / p > < p > For example, with 8 disks of 4 TB, a block size of 256 KiB
2025-10-29 15:09:43 +01:00
(1 KiB = 1024 bytes), and a hash size of 16, you get:
2025-12-14 22:21:44 +01:00
< / p > < pre >
2016-11-21 19:57:43 +01:00
RAM = (8 * 4 * 10^12) * (1+16) / (256 * 2^10) = 1.93 GiB
< / pre >
2025-12-14 22:21:44 +01:00
< p > Switching to a hash size of 8, you get:
< / p > < pre >
2016-11-21 19:57:43 +01:00
RAM = (8 * 4 * 10^12) * (1+8) / (256 * 2^10) = 1.02 GiB
< / pre >
2025-12-14 22:21:44 +01:00
< p > Switching to a block size of 512, you get:
< / p > < pre >
2016-11-21 19:57:43 +01:00
RAM = (8 * 4 * 10^12) * (1+16) / (512 * 2^10) = 0.96 GiB
< / pre >
2025-12-14 22:21:44 +01:00
< p > Switching to both a hash size of 8 and a block size of 512, you get:
< / p > < pre >
2016-11-21 19:57:43 +01:00
RAM = (8 * 4 * 10^12) * (1+8) / (512 * 2^10) = 0.51 GiB
< / pre >
2026-03-30 10:01:17 +02:00
< / div >
< div class = "manual-section-level-2" >
< h2 id = "sec7-11" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
autosave SIZE_IN_GIGABYTES
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Automatically saves the state when syncing or scrubbing after the
2025-10-29 15:09:43 +01:00
specified amount of GB processed.
2026-03-30 10:01:17 +02:00
This option is useful to avoid restarting long < b > sync< / b >
2025-10-29 15:09:43 +01:00
commands from scratch if interrupted by a machine crash or any other event.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec7-12" class = "manual-title-level-2" >
2025-10-29 15:09:43 +01:00
temp_limit TEMPERATURE_CELSIUS
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Sets the maximum allowed disk temperature in Celsius. When specified,
2025-10-29 15:09:43 +01:00
SnapRAID periodically checks the temperature of all disks using the
smartctl tool. The current disk temperatures are displayed while
SnapRAID is operating. If any disk exceeds this limit, all operations
stop, and the disks are spun down (put into standby) for the duration
2026-03-30 10:01:17 +02:00
defined by the < b > temp_sleep< / b > option. After the sleep period, operations
2025-10-29 15:09:43 +01:00
resume, potentially pausing again if the temperature limit is reached
once more.
2025-12-14 22:21:44 +01:00
< / p > < p > During operation, SnapRAID also analyzes the heating curve of each
2025-10-29 15:09:43 +01:00
disk and estimates the long-term steady temperature they are expected
to reach if activity continues. The estimation is performed only after
the disk temperature has increased four times, ensuring that enough
data points are available to establish a reliable trend.
This predicted steady temperature is shown in parentheses next to the
current value and helps assess whether the system's cooling is
adequate. This estimated temperature is for informational purposes
only and has no effect on the behavior of SnapRAID. The program's
actions are based solely on the actual measured disk temperatures.
2025-12-14 22:21:44 +01:00
< / p > < p > To perform this analysis, SnapRAID needs a reference for the system
2025-10-29 15:09:43 +01:00
temperature. It first attempts to read it from available hardware
sensors. If no system sensor can be accessed, it uses the lowest disk
temperature measured at the start of the run as a fallback reference.
2025-12-14 22:21:44 +01:00
< / p > < p > Normally, SnapRAID shows only the temperature of the hottest disk.
2025-10-29 15:09:43 +01:00
To display the temperature of all disks, use the -A or --stats option.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec7-13" class = "manual-title-level-2" >
2025-10-29 15:09:43 +01:00
temp_sleep TIME_IN_MINUTES
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Sets the standby time, in minutes, when the temperature limit is
2025-10-29 15:09:43 +01:00
reached. During this period, the disks remain spun down. The default
is 5 minutes.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec7-14" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
pool DIR
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Defines the pooling directory where the virtual view of the disk
2026-03-30 10:01:17 +02:00
array is created using the < b > pool< / b > command.
2025-12-14 22:21:44 +01:00
< / p > < p > The directory must already exist.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec7-15" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
share UNC_DIR
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Defines the Windows UNC path required to access the disks remotely.
< / p > < p > If this option is specified, the symbolic links created in the pool
2011-03-01 22:19:30 +01:00
directory use this UNC path to access the disks.
2025-10-29 15:09:43 +01:00
Without this option, the symbolic links generated use only local paths,
which does not allow sharing the pool directory over the network.
2025-12-14 22:21:44 +01:00
< / p > < p > The symbolic links are formed using the specified UNC path, adding the
2026-03-30 10:01:17 +02:00
disk name as specified in the < b > data< / b > option, and finally adding the
2025-10-29 15:09:43 +01:00
file directory and name.
2025-12-14 22:21:44 +01:00
< / p > < p > This option is required only for Windows.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-2" >
< h2 id = "sec7-16" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
smartctl DISK/PARITY OPTIONS...
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Defines custom smartctl options to obtain the SMART attributes for
2025-10-29 15:09:43 +01:00
each disk. This may be required for RAID controllers and some USB
disks that cannot be auto-detected. The %s placeholder is replaced by
the device name, but it is optional for fixed devices like RAID controllers.
2026-03-30 10:01:17 +02:00
< / p > < p > DISK is the same disk name specified in the < b > data< / b > option.
PARITY is one of the parity names: < b > parity< / b > , < b > 2-parity< / b > , < b > 3-parity< / b > ,
< b > 4-parity< / b > , < b > 5-parity< / b > , < b > 6-parity< / b > , or < b > z-parity< / b > .
< / p > < p > In the specified OPTIONS, the < b > %s< / b > string is replaced by the
2025-10-29 15:09:43 +01:00
device name. For RAID controllers, the device is
2026-03-30 10:01:17 +02:00
likely fixed, and you may not need to use < b > %s< / b > .
2025-12-14 22:21:44 +01:00
< / p > < p > Refer to the smartmontools documentation for possible options:
2026-03-30 10:01:17 +02:00
< / p > < pre >
< a href = "https://www.smartmontools.org/wiki/Supported_RAID-Controllers" > https://www.smartmontools.org/wiki/Supported_RAID-Controllers< / a >
< a href = "https://www.smartmontools.org/wiki/Supported_USB-Devices" > https://www.smartmontools.org/wiki/Supported_USB-Devices< / a >
2011-03-01 22:19:30 +01:00
< / pre >
2025-12-14 22:21:44 +01:00
< p > For example:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2025-10-29 15:09:43 +01:00
smartctl parity -d sat %s
< / pre >
2026-03-30 10:01:17 +02:00
< / div >
< div class = "manual-section-level-2" >
< h2 id = "sec7-17" class = "manual-title-level-2" >
2025-10-29 15:09:43 +01:00
smartignore DISK/PARITY ATTR [ATTR...]
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > Ignores the specified SMART attribute when computing the probability
2025-10-29 15:09:43 +01:00
of disk failure. This option is useful if a disk reports unusual or
misleading values for a particular attribute.
2026-03-30 10:01:17 +02:00
< / p > < p > DISK is the same disk name specified in the < b > data< / b > option.
PARITY is one of the parity names: < b > parity< / b > , < b > 2-parity< / b > , < b > 3-parity< / b > ,
< b > 4-parity< / b > , < b > 5-parity< / b > , < b > 6-parity< / b > , or < b > z-parity< / b > .
2025-10-29 15:09:43 +01:00
The special value * can be used to ignore the attribute on all disks.
2026-03-30 10:01:17 +02:00
< / p > < p > For example, to ignore the < b > Current Pending Sector Count< / b > attribute on
2025-10-29 15:09:43 +01:00
all disks:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2025-10-29 15:09:43 +01:00
smartignore * 197
< / pre >
2025-12-14 22:21:44 +01:00
< p > To ignore it only on the first parity disk:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2025-10-29 15:09:43 +01:00
smartignore parity 197
< / pre >
2026-03-30 10:01:17 +02:00
< / div >
< div class = "manual-section-level-2" >
< h2 id = "sec7-18" class = "manual-title-level-2" >
2011-03-01 22:19:30 +01:00
Examples
2026-03-30 10:01:17 +02:00
< / h2 >
2025-12-14 22:21:44 +01:00
< p > An example of a typical configuration for Unix is:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2011-03-01 22:19:30 +01:00
parity /mnt/diskp/snapraid.parity
content /mnt/diskp/snapraid.content
content /var/snapraid/snapraid.content
2016-03-04 20:35:27 +01:00
data d1 /mnt/disk1/
data d2 /mnt/disk2/
data d3 /mnt/disk3/
2011-03-01 22:19:30 +01:00
exclude /lost+found/
exclude /tmp/
smartctl d1 -d sat %s
smartctl d2 -d usbjmicron %s
smartctl parity -d areca,1/1 /dev/sg0
smartctl 2-parity -d areca,2/1 /dev/sg0
< / pre >
2025-12-14 22:21:44 +01:00
< p > An example of a typical configuration for Windows is:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2011-03-01 22:19:30 +01:00
parity E:\snapraid.parity
content E:\snapraid.content
content C:\snapraid\snapraid.content
2016-03-04 20:35:27 +01:00
data d1 G:\array\
data d2 H:\array\
data d3 I:\array\
2011-03-01 22:19:30 +01:00
exclude Thumbs.db
exclude \$RECYCLE.BIN
exclude \System Volume Information
smartctl d1 -d sat %s
smartctl d2 -d usbjmicron %s
smartctl parity -d areca,1/1 /dev/arcmsr0
smartctl 2-parity -d areca,2/1 /dev/arcmsr0
< / pre >
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< div class = "manual-section-level-1" >
< h1 id = "sec8" class = "manual-title-level-1" >
2011-03-01 22:19:30 +01:00
Pattern
2026-03-30 10:01:17 +02:00
< / h1 >
2025-12-14 22:21:44 +01:00
< p > Patterns are used to select a subset of files to exclude or include in
2026-03-30 10:01:17 +02:00
the process. Globbing characters can be used to match files and paths
in a flexible way.
< / p > < p > The question mark < b > ?< / b > matches any single character except the directory
separator. This makes it useful for matching filenames with variable
characters while keeping the pattern confined to a single directory level.
< / p > < p > The single star < b > *< / b > matches any sequence of characters, but like the
question mark, it never crosses directory boundaries. It stops at the
forward slash, making it suitable for matching within a single path
component. This is the standard wildcard behavior familiar from shell
globbing.
< / p > < p > The double star < b > **< / b > is more powerful, it matches any sequence of
characters including directory separators. This allows patterns to match
across multiple directory levels. When < b > **< / b > appears embedded directly in
a pattern, it can match zero or more characters including slashes between
the surrounding literal text.
< / p > < p > The most important use of < b > **< / b > is in the special form < b > /**/< / b > . This matches
zero or more complete directory levels, making it possible to match files
at any depth in a directory tree without knowing the exact path structure.
For example, the pattern < b > src/**/main.js< / b > matches < b > src/main.js< / b > (skipping
zero directories), < b > src/ui/main.js< / b > (skipping one directory), and
< b > src/ui/components/main.js< / b > (skipping two directories).
< / p > < p > Character classes using square brackets match a single character from a
specified set or range. Like the other single character patterns, they do
not match directory separators. Classes support ranges and negation using
an exclamation mark.
< / p > < p > The fundamental distinction to remember is that < b > *< / b > , < b > ?< / b > , and character
classes all respect directory boundaries and only match within a single path
component, while < b > **< / b > is the only pattern that can match across directory
separators.
2025-12-14 22:21:44 +01:00
< / p > < p > There are four different types of patterns:
2026-03-30 10:01:17 +02:00
< / p > < div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
FILE
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
Selects any file named FILE.
2025-10-29 15:09:43 +01:00
This pattern applies only to files, not directories.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
DIR/
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2011-03-01 22:19:30 +01:00
Selects any directory named DIR and everything inside.
2025-10-29 15:09:43 +01:00
This pattern applies only to directories, not files.
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
/PATH/FILE
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
Selects the exact specified file path. This pattern applies
only to files, not directories.
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
2011-03-01 22:19:30 +01:00
/PATH/DIR/
2026-03-30 10:01:17 +02:00
< / div > < div class = "manual-option-description" >
2011-03-01 22:19:30 +01:00
Selects the exact specified directory path and everything
2026-03-30 10:01:17 +02:00
inside. This pattern applies only to directories, not files.
< / div >
< / div >
< / div >
2025-12-14 22:21:44 +01:00
< p > When you specify an absolute path starting with /, it is applied at
2025-10-29 15:09:43 +01:00
the array root directory, not the local file system root directory.
2025-12-14 22:21:44 +01:00
< / p > < p > In Windows, you can use the backslash \ instead of the forward slash /.
2025-10-29 15:09:43 +01:00
Windows system directories, junctions, mount points, and other Windows
special directories are treated as files, meaning that to exclude
them, you must use a file rule, not a directory one.
2026-03-30 10:01:17 +02:00
< / p > < p > If the file name contains a < b > *< / b > , < b > ?< / b > , < b > [< / b > ,
or < b > ]< / b > character, you must escape it to avoid having it interpreted as a
globbing character. In Unix, the escape character is < b > \< / b > ; in Windows, it is < b > ^< / b > .
2025-10-29 15:09:43 +01:00
When the pattern is on the command line, you must double the escape
character to avoid having it interpreted by the command shell.
2025-12-14 22:21:44 +01:00
< / p > < p > In the configuration file, you can use different strategies to filter
2011-03-01 22:19:30 +01:00
the files to process.
2026-03-30 10:01:17 +02:00
The simplest approach is to use only < b > exclude< / b > rules to remove all the
2011-03-01 22:19:30 +01:00
files and directories you do not want to process. For example:
2026-03-30 10:01:17 +02:00
< / p > < pre >
# Excludes any file named < b > *.unrecoverable< / b >
2011-03-01 22:19:30 +01:00
exclude *.unrecoverable
2026-03-30 10:01:17 +02:00
# Excludes the root directory < b > /lost+found< / b >
2011-03-01 22:19:30 +01:00
exclude /lost+found/
2026-03-30 10:01:17 +02:00
# Excludes any subdirectory named < b > tmp< / b >
2011-03-01 22:19:30 +01:00
exclude tmp/
< / pre >
2025-12-14 22:21:44 +01:00
< p > The opposite approach is to define only the files you want to process, using
2026-03-30 10:01:17 +02:00
only < b > include< / b > rules. For example:
< / p > < pre >
2011-03-01 22:19:30 +01:00
# Includes only some directories
include /movies/
include /musics/
include /pictures/
< / pre >
2026-03-30 10:01:17 +02:00
< p > The final approach is to mix < b > exclude< / b > and < b > include< / b > rules. In this case,
2025-10-29 15:09:43 +01:00
the order of rules is important. Earlier rules take
precedence over later ones.
2026-03-30 10:01:17 +02:00
To simplify, you can list all the < b > exclude< / b > rules first and then
all the < b > include< / b > rules. For example:
< / p > < pre >
# Excludes any file named < b > *.unrecoverable< / b >
2011-03-01 22:19:30 +01:00
exclude *.unrecoverable
2026-03-30 10:01:17 +02:00
# Excludes any subdirectory named < b > tmp< / b >
2011-03-01 22:19:30 +01:00
exclude tmp/
# Includes only some directories
include /movies/
include /musics/
include /pictures/
< / pre >
2026-03-30 10:01:17 +02:00
< p > On the command line, using the -f option, you can only use < b > include< / b >
2011-03-01 22:19:30 +01:00
patterns. For example:
2026-03-30 10:01:17 +02:00
< / p > < pre >
2011-03-01 22:19:30 +01:00
# Checks only the .mp3 files.
2025-10-29 15:09:43 +01:00
# In Unix, use quotes to avoid globbing expansion by the shell.
2011-03-01 22:19:30 +01:00
snapraid -f "*.mp3" check
< / pre >
2025-12-14 22:21:44 +01:00
< p > In Unix, when using globbing characters on the command line, you must
2025-10-29 15:09:43 +01:00
quote them to prevent the shell from expanding them.
2026-03-30 10:01:17 +02:00
< / p > < / div >
< div class = "manual-section-level-1" >
< h1 id = "sec9" class = "manual-title-level-1" >
Ignore File
< / h1 >
< p > In addition to the global rules in the configuration file, you can
place < b > .snapraidignore< / b > files in any directory within the array to
define decentralized exclusion rules.
< / p > < p > Rules defined in < b > .snapraidignore< / b > are applied after the rules in the
configuration file. This means they have a higher priority and can be
used to exclude files that were previously included by the global
configuration. Effectively, if a local rule matches, the file is
excluded regardless of the global include settings.
< / p > < p > The pattern logic in < b > .snapraidignore< / b > mirrors the global configuration
but anchors patterns to the directory where the file is located:
< / p > < div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
FILE
< / div > < div class = "manual-option-description" >
Selects any file named FILE in this directory or below.
This follows the same globbing rules as the global pattern.
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
DIR/
< / div > < div class = "manual-option-description" >
Selects any directory named DIR and everything inside,
residing in this directory or below.
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
/PATH/FILE
< / div > < div class = "manual-option-description" >
Selects the exact specified file relative to the location
of the < b > .snapraidignore< / b > file.
< / div >
< / div >
< / div >
< div class = "manual-option-list" >
< div class = "manual-option-entry" >
< div class = "manual-option-name" >
/PATH/DIR/
< / div > < div class = "manual-option-description" >
Selects the exact specified directory and everything inside,
relative to the location of the < b > .snapraidignore< / b > file.
< / div >
< / div >
< / div >
< p > Unlike the global configuration, < b > .snapraidignore< / b > files only support
exclusion rules; you cannot use < b > include< / b > patterns or negation (!).
< / p > < p > For example, if you have a < b > .snapraidignore< / b > in < b > /mnt/disk1/projects/< / b > :
< / p > < pre >
# Excludes ONLY /mnt/disk1/projects/output.bin
/output.bin
# Excludes any directory named < b > build< / b > inside projects/
build/
# Excludes any .tmp file inside projects/ or its subfolders
*.tmp
< / pre >
< / div >
< div class = "manual-section-level-1" >
< h1 id = "sec10" class = "manual-title-level-1" >
2011-03-01 22:19:30 +01:00
Content
2026-03-30 10:01:17 +02:00
< / h1 >
2025-12-14 22:21:44 +01:00
< p > SnapRAID stores the list and checksums of your files in the content file.
< / p > < p > It is a binary file that lists all the files present in your disk array,
2025-10-29 15:09:43 +01:00
along with all the checksums to verify their integrity.
2026-03-30 10:01:17 +02:00
< / p > < p > This file is read and written by the < b > sync< / b > and < b > scrub< / b > commands and
read by the < b > fix< / b > , < b > check< / b > , and < b > status< / b > commands.
< / p > < / div >
< div class = "manual-section-level-1" >
< h1 id = "sec11" class = "manual-title-level-1" >
2011-03-01 22:19:30 +01:00
Parity
2026-03-30 10:01:17 +02:00
< / h1 >
2025-12-14 22:21:44 +01:00
< p > SnapRAID stores the parity information of your array in the parity
2011-03-01 22:19:30 +01:00
files.
2025-12-14 22:21:44 +01:00
< / p > < p > These are binary files containing the computed parity of all the
2026-03-30 10:01:17 +02:00
blocks defined in the < b > content< / b > file.
< / p > < p > These files are read and written by the < b > sync< / b > and < b > fix< / b > commands and
only read by the < b > scrub< / b > and < b > check< / b > commands.
< / p > < / div >
< div class = "manual-section-level-1" >
< h1 id = "sec12" class = "manual-title-level-1" >
2011-03-01 22:19:30 +01:00
Encoding
2026-03-30 10:01:17 +02:00
< / h1 >
2025-12-14 22:21:44 +01:00
< p > SnapRAID in Unix ignores any encoding. It reads and stores the
2025-10-29 15:09:43 +01:00
file names with the same encoding used by the file system.
2025-12-14 22:21:44 +01:00
< / p > < p > In Windows, all names read from the file system are converted and
2025-10-29 15:09:43 +01:00
processed in UTF-8 format.
2025-12-14 22:21:44 +01:00
< / p > < p > To have file names printed correctly, you must set the Windows
2026-03-30 10:01:17 +02:00
console to UTF-8 mode with the command < b > chcp 65001< / b > and use
a TrueType font like < b > Lucida Console< / b > as the console font.
2025-10-29 15:09:43 +01:00
This affects only the printed file names; if you
2011-03-01 22:19:30 +01:00
redirect the console output to a file, the resulting file is always
2025-10-29 15:09:43 +01:00
in UTF-8 format.
2026-03-30 10:01:17 +02:00
< / p > < / div >
2011-03-01 22:19:30 +01:00
2026-03-30 10:01:17 +02:00
< / div >
< / main >
< / div >
2011-03-01 22:19:30 +01:00
2026-03-30 10:01:17 +02:00
<!-- Footer -->
< footer >
< div class = "container footer-content" >
< div class = "footer-col" >
< div class = "logo" >
< img src = "android-chrome-192x192.png" width = "32" height = "32" / >
SnapRAID
< / div >
< p > Copyright © 2026 Andrea Mazzoleni< / p >
< p class = "license" > Distributed under GPL v3 License< / p >
< / div >
< div class = "footer-col" >
2026-04-14 09:47:17 +02:00
< h4 > Links< / h4 >
2026-04-14 09:56:55 +02:00
< ul class = "footer-list" >
2026-04-14 09:47:17 +02:00
< li > < a href = "https://github.com/amadvance/snapraid/" > GitHub SnapRAID CLI< / a > < / li >
< li > < a href = "https://github.com/amadvance/snapraid-daemon/" > GitHub SnapRAID Daemon< / a > < / li >
< li > < a href = "https://www.reddit.com/r/Snapraid/" > Reddit< / a > < / li >
< li > < a href = "https://sourceforge.net/p/snapraid/" > SourceForge< / a > < / li >
< / ul >
2026-03-30 10:01:17 +02:00
< / div >
< / div >
< / footer >
2011-03-01 22:19:30 +01:00
< / body >
< / html >
