]> git.ipfire.org Git - thirdparty/util-linux.git/blame - sys-utils/fstrim.8.adoc
fix whitespace issue in ducumentation
[thirdparty/util-linux.git] / sys-utils / fstrim.8.adoc
CommitLineData
295b3979 1//po4a: entry man manual
6d5b6948
MB
2= fstrim(8)
3:doctype: manpage
a09649ca 4:man manual: System Administration
6d5b6948
MB
5:man source: util-linux {release-version}
6:page-layout: base
7:command: fstrim
8
9== NAME
10
11fstrim - discard unused blocks on a mounted filesystem
12
13== SYNOPSIS
14
15*fstrim* [*-Aa*] [*-o* _offset_] [*-l* _length_] [*-m* _minimum-size_] [*-v* _mountpoint_]
16
17== DESCRIPTION
18
19*fstrim* is used on a mounted filesystem to discard (or "trim") blocks which are not in use by the filesystem. This is useful for solid-state drives (SSDs) and thinly-provisioned storage.
20
21By default, *fstrim* will discard all unused blocks in the filesystem. Options may be used to modify this behavior based on range or size, as explained below.
22
23The _mountpoint_ argument is the pathname of the directory where the filesystem is mounted.
24
25Running *fstrim* frequently, or even using *mount -o discard*, might negatively affect the lifetime of poor-quality SSD devices. For most desktop and server systems a sufficient trimming frequency is once a week. Note that not all devices support a queued trim, so each trim command incurs a performance penalty on whatever else might be trying to use the disk at the time.
26
27== OPTIONS
28
29The _offset_, _length_, and _minimum-size_ arguments may be followed by the multiplicative suffixes KiB (=1024), MiB (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB" is optional, e.g., "K" has the same meaning as "KiB") or the suffixes KB (=1000), MB (=1000*1000), and so on for GB, TB, PB, EB, ZB and YB.
30
31*-A, --fstab*::
68860732 32Trim all mounted filesystems mentioned in _/etc/fstab_ on devices that support the discard operation. The root filesystem is determined from kernel command line if missing in the file. The other supplied options, like *--offset*, *--length* and *--minimum*, are applied to all these devices. Errors from filesystems that do not support the discard operation, read-only devices and read-only filesystems are silently ignored.
6d5b6948
MB
33
34*-a, --all*::
68860732 35Trim all mounted filesystems on devices that support the discard operation. The other supplied options, like *--offset*, *--length* and *--minimum*, are applied to all these devices. Errors from filesystems that do not support the discard operation, read-only devices and read-only filesystems are silently ignored.
6d5b6948
MB
36
37*-n, --dry-run*::
68860732 38This option does everything apart from actually call *FITRIM* ioctl.
6d5b6948
MB
39
40*-o, --offset* _offset_::
68860732 41Byte offset in the filesystem from which to begin searching for free blocks to discard. The default value is zero, starting at the beginning of the filesystem.
6d5b6948
MB
42
43*-l, --length* _length_::
68860732 44The number of bytes (after the starting point) to search for free blocks to discard. If the specified value extends past the end of the filesystem, *fstrim* will stop at the filesystem size boundary. The default value extends to the end of the filesystem.
6d5b6948
MB
45
46*-I, --listed-in* _list_::
68860732
MB
47Specifies a colon-separated list of files in fstab or kernel mountinfo format. All missing or empty files are silently ignored. The evaluation of the _list_ stops after first non-empty file. For example:
48+
49*--listed-in /etc/fstab:/proc/self/mountinfo*.
6d5b6948
MB
50
51*-m, --minimum* _minimum-size_::
68860732 52Minimum contiguous free range to discard, in bytes. (This value is internally rounded up to a multiple of the filesystem block size.) Free ranges smaller than this will be ignored and fstrim will adjust the minimum if it's smaller than the device's minimum, and report that (fstrim_range.minlen) back to userspace. By increasing this value, the fstrim operation will complete more quickly for filesystems with badly fragmented freespace, although not all blocks will be discarded. The default value is zero, discarding every free block.
6d5b6948
MB
53
54*-v, --verbose*::
68860732
MB
55Verbose execution. With this option *fstrim* will output the number of bytes passed from the filesystem down the block stack to the device for potential discard. This number is a maximum discard amount from the storage device's perspective, because _FITRIM_ ioctl called repeated will keep sending the same sectors for discard repeatedly.
56+
57*fstrim* will report the same potential discard bytes each time, but only sectors which had been written to between the discards would actually be discarded by the storage device. Further, the kernel block layer reserves the right to adjust the discard ranges to fit raid stripe geometry, non-trim capable devices in a LVM setup, etc. These reductions would not be reflected in fstrim_range.len (the *--length* option).
e08e3d58 58
6d5b6948 59*--quiet-unsupported*::
68860732 60Suppress error messages if trim operation (ioctl) is unsupported. This option is meant to be used in systemd service file or in cron scripts to hide warnings that are result of known problems, such as NTFS driver reporting _Bad file descriptor_ when device is mounted read-only, or lack of file system support for ioctl FITRIM call.
6d5b6948
MB
61
62*-V*, *--version*::
68860732 63Display version information and exit.
6d5b6948
MB
64
65*-h*, *--help*::
68860732 66Display help text and exit.
6d5b6948
MB
67
68== EXIT STATUS
69
700::
68860732 71success
6d5b6948 721::
68860732 73failure
6d5b6948 7432::
68860732 75all failed
6d5b6948 7664::
68860732 77some filesystem discards have succeeded, some failed
6d5b6948
MB
78
79The command *fstrim --all* returns 0 (all succeeded), 32 (all failed) or 64 (some failed, some succeeded).
80
81== AUTHORS
68860732 82mailto:lczerner@redhat.com[Lukas Czerner],
6d5b6948
MB
83mailto:kzak@redhat.com[Karel Zak]
84
85== SEE ALSO
86
87*blkdiscard*(8),
88*mount*(8)
89
625e9c61 90include::man-common/bugreports.adoc[]
6d5b6948 91
625e9c61 92include::man-common/footer.adoc[]
6d5b6948
MB
93
94ifdef::translation[]
625e9c61 95include::man-common/translation.adoc[]
6d5b6948 96endif::[]