1NILFS-CLEAN(8)              System Manager's Manual             NILFS-CLEAN(8)
2
3
4

NAME

6       nilfs-clean - run garbage collector on NILFS file system
7

SYNOPSIS

9       nilfs-clean [options] [device]
10

DESCRIPTION

12       The nilfs-clean program communicates with nilfs_cleanerd(8) program and
13       controls execution of garbage collection (GC) on NILFS2  file  systems.
14       It  can  be  used  to  manually run garbage collection of a file system
15       mounted on device to increase the free space.
16
17       If a GC command is specified by one  of  the  following  options  (i.e.
18       ´-c´,´-s´,´-r´, and ´-l´ options), the command is sent to and performed
19       on the nilfs_cleanerd(8) program.  If no commands are specified, nilfs-
20       clean just triggers a one-pass cleaning.
21
22       When  device is omitted, nilfs-clean selects an active NILFS2 file sys‐
23       tem in the system.
24
25       This command is valid only for mounted NILFS2 file  systems,  and  will
26       fail if the device has no active mounts.
27

OPTIONS

29       -b, --break, --stop
30              Stop garbage collection.
31
32       -c, --reload[=conffile]
33              Request  reloading  config  file  to  cleaner  process.   If  an
34              optional configuration file  is  given,  the  file  is  read  by
35              nilfs_cleanerd(8)  program and cleaner configuration is reset to
36              the information.  If no argument is given, a configuration  file
37              selected by nilfs_cleanerd(8) will be reloaded.
38
39       -l, --status
40              Display cleaner status.
41
42       -h, --help
43              Display help message and exit.
44
45       -m, --min-reclaimable-blocks=COUNT[%]
46              Specify  the  minimum  number of reclaimable blocks in a segment
47              before it can be cleaned. If the argument is followed by a  per‐
48              cent  sign, it represents the ratio of blocks in a segment. This
49              argument will only have an effect if the use_set_suinfo flag  is
50              set in the configuration file.
51
52       -p, --protection-period=interval
53              Set protection period for a cleaner run.  The interval parameter
54              is an integer value and specifies the minimum time that  deleted
55              or  overrode data will be preserved in the file system.  Smaller
56              values will increase free  space  made  by  garbage  collection.
57              Optionally, the interval parameter may be suffixed by one of the
58              following units designators: ´s´, ´m´, ´h´, ´d´,´w´,´M´, or ´Y´,
59              for  seconds,  minutes,  hours,  days,  weeks, months, or years,
60              respectively.
61
62       -q, --quit
63              Shutdown cleaner daemon.
64
65       -r, --resume
66              Resume garbage collection.
67
68       -s, --suspend
69              Suspend garbage collection.  Note that if users manually suspend
70              garbage  collection  with this option, it will not restart auto‐
71              matically until user resumes the garbage collection.
72
73       -S, --speed=COUNT[/SECONDS]
74              Set garbage collection speed for a cleaner run.
75
76       -v, --verbose
77              Verbose mode.
78
79       -V, --version
80              Display version and exit.
81

AUTHOR

83       Ryusuke Konishi <konishi.ryusuke@gmail.com>
84

AVAILABILITY

86       nilfs-clean is part of the nilfs-utils package and  is  available  from
87       https://nilfs.sourceforge.io.
88

SEE ALSO

90       nilfs(8), nilfs_cleanerd(8).
91
92
93
94nilfs-utils version 2.2            Apr 2014                     NILFS-CLEAN(8)