1BTRFSD(8)                           btrfsd                           BTRFSD(8)
2
3
4

NAME

6       btrfsd - Btrfs maintenance daemon
7

SYNOPSIS

9       btrfsd [COMMAND]
10

DESCRIPTION

12       This manual page documents briefly the btrfsd daemon.
13
14       Btrfsd is a lightweight daemon that takes care of all Btrfs filesystems
15       on a Linux system. It will:
16
17       •   Check stats for errors and broadcast a warning if any were found,
18           or send an email
19
20       •   Perform scrub periodically if system is not on battery
21
22       •   Run balance occasionally if not on battery power
23
24       The daemon is explicitly designed to be run on any system, from a small
25       notebook to a large storage server. Depending on the system, it should
26       make the best possible decision for running maintenance jobs, but may
27       also be tweaked by the user.
28

CONFIGURATION

30       The daemon will run on its own, without any configuration, and monitor
31       all Btrfs filesystems mounted on the system (or do nothing if none were
32       found). However, the user may tweak some settings via its configuration
33       file: /etc/btrfsd/settings.conf
34
35       The configuration file is an Ini-style text file, with one section per
36       Btrfs mount point. If no section for a mountpoint with settings was
37       found, the values from the default section are used.
38
39       Every *_interval maintenance action interval may contain an integer
40       time value with a unit character behind it: h for hours, d for days and
41       M for months. The special value never will prevent the action from
42       being executed. Going below an hour for actions is not recommended, as
43       btrfsd is only woken up hourly by the system to check for pending
44       actions.
45
46       Example:
47
48           [default]
49           mail_address=root
50
51           stats_interval=1h
52           scrub_interval=1M
53           balance_interval=3M
54
55           [/mnt/storage1]
56           scrub_interval=2M
57           balance_interval=never
58

COMMAND-LINE OPTIONS

60       --verbose
61           Display extra debugging information.
62
63       --version
64           Display the version number of btrfsd.
65
66       --status
67           Display the status of the daemon and its various tasks, as well as
68           its configuration.
69

SEE ALSO

71       btrfs(1).
72

AUTHOR

74       This manual page was written by Matthias Klumpp
75       <matthias@tenstral.net>.
76

78       Copyright © 2022-2023 Matthias Klumpp
79
80
81
82Btrfsd                                                               BTRFSD(8)
Impressum