← Back to branch summary

~ubuntu-branches/ubuntu/precise/util-linux/precise-proposed

« back to all changes in this revision

Viewing changes to sys-utils/fstrim.8

  • Committer: Bazaar Package Importer
  • Author(s): Steve Langasek
  • Date: 2011-06-20 22:31:50 UTC
  • mfrom: (1.6.3 upstream) (4.5.1 sid)
  • Revision ID: james.westby@ubuntu.com-20110620223150-lz8wrv0946ihcz3z
Tags: 2.19.1-2ubuntu1
* Merge from Debian unstable, remaining changes:
  - Build for multiarch.
  - Add pre-depends on multiarch-support.
  - configure.ac: don't try to be clever about extracting a path name from
    $libdir to append to /usr in a way that's not overridable; instead,
    reuse the built-in configurable libexecdir.
  - Fix up the .pc.in files to know about libexecdir, so our substitutions
    don't leave us with unusable pkg-config files.
  - Install custom blkid.conf to use /dev/.blkid.tab since we don't
    expect device names to survive a reboot
  - Mention mountall(8) in fstab(5) manpages, along with its special
    options.
  - Since upstart is required in Ubuntu, the hwclock.sh init script is not
    called on startup and the hwclockfirst.sh init script is removed.
  - Drop depends on initscripts for the above.
  - Replace hwclock udev rule with an Upstart job.
  - For the case where mount is called with a directory to mount, look
    that directory up in mountall's /lib/init/fstab if we couldn't find
    it mentioned anywhere else.  This means "mount /proc", "mount /sys",
    etc. work.
  - mount.8 points to the cifs-utils package, not the obsolete smbfs one. 
* Dropped changes:
  - mount.preinst: lsb_release has been fixed in lucid and above to be
    usable without configuration, so we don't have to diverge from Debian
    here anymore.
* Changes merged upstream:
  - sfdisk support for '+' with '-N'
  - mount/umount.c: fix a segfault on umount with empty mtab entry
  - Fix arbitrary unmount with fuse security issue

Show diffs side-by-side

added added

removed removed

Lines of Context:
sys-utils/fstrim.8
 
1
.\" -*- nroff -*-
 
2
.TH FSTRIM 8 "Nov 2010"
 
3
.SH NAME
 
4
fstrim \- discard unused blocks on a mounted filesystem
 
5
.SH SYNOPSIS
 
6
.B fstrim
 
7
.RB [ \-o
 
8
.IR offset ]
 
9
.RB [ \-l
 
10
.IR length ]
 
11
.RB [ \-m
 
12
.IR minimum-extent ]
 
13
.RB [ \-v ]
 
14
.I mountpoint
 
15
 
 
16
.SH DESCRIPTION
 
17
.B fstrim
 
18
is used on a mounted filesystem to discard (or "trim") blocks which are not in
 
19
use by the filesystem.  This is useful for solid-state drives (SSDs) and
 
20
thinly-provisioned storage.
 
21
.PP
 
22
By default,
 
23
.B fstrim
 
24
will discard all unused blocks in the filesystem.  Options may be used to
 
25
modify this behavior based on range or size, as explained below.
 
26
.PP
 
27
The
 
28
.I mountpoint
 
29
argument is the pathname of the directory where the filesystem
 
30
is mounted.
 
31
 
 
32
.SH OPTIONS
 
33
The \fIoffset\fR, \fIlength\fR, and \fIminimum-free-extent\fR arguments may be
 
34
followed by binary (2^N) suffixes KiB, MiB, GiB, TiB, PiB and EiB (the "iB" is
 
35
optional, e.g. "K" has the same meaning as "KiB") or decimal (10^N) suffixes
 
36
KB, MB, GB, PB and EB.
 
37
.IP "\fB\-h, \-\-help\fP"
 
38
Print help and exit.
 
39
.IP "\fB\-o, \-\-offset\fP \fIoffset\fP"
 
40
Byte offset in filesystem from which to begin searching for free blocks
 
41
to discard.  Default value is zero, starting at the beginning of the
 
42
filesystem.
 
43
.IP "\fB\-l, \-\-length\fP \fIlength\fP"
 
44
Number of bytes after starting point to search for free blocks to discard.
 
45
If the specified value extends past the end of the filesystem,
 
46
.B fstrim
 
47
will stop at the filesystem size boundary. Default value extends to the end
 
48
of the filesystem.
 
49
.IP "\fB\-m, \-\-minimum\fP \fIminimum-free-extent\fP"
 
50
Minimum contiguous free range to discard, in bytes. (This value is internally
 
51
rounded up to a multiple of the filesystem block size).  Free ranges smaller
 
52
than this will be ignored.  By increasing this value, the fstrim operation
 
53
will complete more quickly for filesystems with badly fragmented freespace,
 
54
although not all blocks will be discarded.  Default value is zero, discard
 
55
every free block.
 
56
.IP "\fB\-v, \-\-verbose\fP"
 
57
Verbose execution. When specified 
 
58
.B fstrim
 
59
will output the number of bytes passed from the filesystem
 
60
down the block stack to the device for potential discard. This number is a
 
61
maximum discard amount from the storage device's perspective, because
 
62
.I FITRIM
 
63
ioctl called repeated will keep sending the same sectors for discard repeatedly.
 
64
 
 
65
.B fstrim
 
66
will report the same potential discard bytes each time, but only sectors which
 
67
had been written to between the discards would actually be discarded by the
 
68
storage device.  Further, the kernel block layer reserves the right to adjust
 
69
the discard ranges to fit raid stripe geometry, non-trim capable devices in a
 
70
LVM setup, etc.  These reductions would not be reflected in fstrim_range.len
 
71
(the
 
72
.B --length
 
73
option).
 
74
 
 
75
.SH AUTHOR
 
76
.nf
 
77
Lukas Czerner <lczerner@redhat.com>
 
78
Karel Zak <kzak@redhat.com>
 
79
.fi
 
80
.SH SEE ALSO
 
81
.BR mount (8)
 
82
.SH AVAILABILITY
 
83
The fstrim command is part of the util-linux package and is available from
 
84
ftp://ftp.kernel.org/pub/linux/utils/util-linux/.