nilfs_cleanerd(8)

1NILFS_CLEANERD(8)           System Manager's Manual          NILFS_CLEANERD(8)
2
3
4

NAME

6       nilfs_cleanerd - NILFS2 garbage collector
7

SYNOPSIS

9       nilfs_cleanerd [-hV]
10
11       nilfs_cleanerd [options] device [directory]
12

DESCRIPTION

14       nilfs_cleanerd is a system daemon which reclaims disk space of a NILFS2
15       file system found in device.
16
17       The optional directory argument specifies the  mount  point  where  the
18       daemon operates.  It must be an r/w-mount.
19
20       This  program can be invoked either automatically by mount.nilfs2(8) or
21       manually by an administrator.  However, users are recommended to invoke
22       nilfs_cleanerd  through  mount.nilfs2(8)  or  mount(8)  and shutdown it
23       through umount.nilfs2(8) or umount(8) in order to avoid state inconsis‐
24       tencies among administration tools.
25
26       nilfs_cleanerd displays its process ID (pid) to standard output when it
27       started.
28

OPTIONS

30       -V, --version
31              Display version and exit.
32
33       -h, --help
34              Display help message and exit.
35
36       -c file, --conf=file
37              Specify configuration file.
38
39       -p interval, --protection-period=interval
40              Override protection period with the specified number of seconds.
41

SIGNALS

43       nilfs_cleanerd reacts to a set of signals.  You may send  a  signal  to
44       nilfs_cleanerd  using  the  PID  shown  by  the  mount  command  (or in
45       /etc/mtab):
46
47              # mount -t nilfs2
48              /dev/sdb1 on /nilfs type nilfs2 (rw,gcpid=PID)
49              # kill -SIGNAL PID
50
51       SIGHUP This lets nilfs_cleanerd perform a re-initialization.  The  con‐
52              figuration  file  (default  is /etc/nilfs_cleanerd.conf) will be
53              reread.
54
55       SIGTERM
56              The nilfs_cleanerd will exit cleanly.
57
58       SIGUSR1, SIGUSR2
59              Reserved for  future  use.   These  let  nilfs_cleanerd  die  at
60              present.
61

FILES

63       /etc/nilfs_cleanerd.conf
64              Configuration   file   for   nilfs_cleanerd.   See  nilfs_clean‐
65              erd.conf(5) for details.
66

AUTHOR

68       Koji Sato
69

AVAILABILITY

71       nilfs_cleanerd is part of the nilfs-utils package  and  available  from
72       https://nilfs.sourceforge.io.
73