1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
<?xml version='1.0' encoding='ISO-8859-1'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY date "<date>18 Aug,2023</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY package "btrfsd">
]>
<refentry>
<refentryinfo>
<title>btrfsd</title>
<copyright>
<year>2022-2023</year>
<holder>Matthias Klumpp</holder>
</copyright>
<productname>Btrfsd</productname>
&date;
</refentryinfo>
<refmeta>
<refentrytitle>btrfsd</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>btrfsd</refname>
<refpurpose>Btrfs maintenance daemon</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&package;</command>
<group>
<option>COMMAND</option>
</group>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
This manual page documents briefly the <command>&package;</command> daemon.
</para>
<para>
Btrfsd is a lightweight daemon that takes care of all Btrfs filesystems on a Linux system.
It will:
</para>
<itemizedlist>
<listitem><para>Check <emphasis>stats</emphasis> for errors and broadcast a warning if any were found, or send an email</para></listitem>
<listitem><para>Perform <emphasis>scrub</emphasis> periodically if system is not on battery</para></listitem>
<listitem><para>Run <emphasis>balance</emphasis> occasionally if not on battery power</para></listitem>
</itemizedlist>
<para>
The daemon is explicitly designed to be run on any system, from a small notebook to a large
storage server. Depending on the system, it should make the best possible decision for
running maintenance jobs, but may also be tweaked by the user.
</para>
</refsect1>
<refsect1>
<title>Configuration</title>
<para>
The daemon will run on its own, without any configuration, and monitor all Btrfs filesystems mounted on the system
(or do nothing if none were found).
However, the user may tweak some settings via its configuration file: <filename>/etc/btrfsd/settings.conf</filename>
</para>
<para>
The configuration file is an Ini-style text file, with one section per Btrfs mount point. If no section for a mountpoint
with settings was found, the values from the <literal>default</literal> section are used.
</para>
<para>
Every <code>*_interval</code> maintenance action interval may contain an integer time value with a unit character behind it:
<code>h</code> for hours, <code>d</code> for days and <code>M</code> for months. The special value <code>never</code> will
prevent the action from being executed. Going below an hour for actions is not recommended, as &package; is only woken up hourly
by the system to check for pending actions.
</para>
<para>Example:</para>
<programlisting language="ini"><![CDATA[
[default]
mail_address=root
stats_interval=1h
scrub_interval=1M
balance_interval=3M
[/mnt/storage1]
scrub_interval=2M
balance_interval=never
]]></programlisting>
</refsect1>
<refsect1>
<title>Command-line Options</title>
<variablelist>
<varlistentry>
<term><option>--verbose</option></term>
<listitem>
<para>Display extra debugging information.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--version</option></term>
<listitem>
<para>Display the version number of &package;.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--status</option></term>
<listitem>
<para>Display the status of the daemon and its various tasks, as well as its configuration.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>btrfs</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>
This manual page was written by Matthias Klumpp <email>matthias@tenstral.net</email>.
</para>
</refsect1>
</refentry>
|
