sbin/tunefs/tunefs.8

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)tunefs.8    8.2 (Berkeley) 12/11/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd December 9, 2010
  32 .Dt TUNEFS 8
  33 .Os
  34 .Sh NAME
  35 .Nm tunefs
  36 .Nd tune up an existing file system
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl A
  40 .Op Fl a Cm enable | disable
  41 .Op Fl e Ar maxbpg
  42 .Op Fl f Ar avgfilesize
  43 .Op Fl J Cm enable | disable
  44 .Op Fl L Ar volname
  45 .Op Fl l Cm enable | disable
  46 .Op Fl m Ar minfree
  47 .Op Fl N Cm enable | disable
  48 .Op Fl n Cm enable | disable
  49 .Op Fl o Cm space | time
  50 .Op Fl p
  51 .Op Fl s Ar avgfpdir
  52 .Op Fl t Cm enable | disable
  53 .Ar special | filesystem
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 utility is designed to change the dynamic parameters of a file system
  58 which affect the layout policies.
  59 The
  60 .Nm
  61 utility cannot be run on an active file system.
  62 To change an active file system,
  63 it must be downgraded to read-only or unmounted.
  64 .Pp
  65 The parameters which are to be changed are indicated by the flags
  66 given below:
  67 .Bl -tag -width indent
  68 .It Fl A
  69 The file system has several backups of the super-block.
  70 Specifying
  71 this option will cause all backups to be modified as well as the
  72 primary super-block.
  73 This is potentially dangerous - use with caution.
  74 .It Fl a Cm enable | disable
  75 Turn on/off the administrative POSIX.1e ACL enable flag.
  76 .It Fl e Ar maxbpg
  77 Indicate the maximum number of blocks any single file can
  78 allocate out of a cylinder group before it is forced to begin
  79 allocating blocks from another cylinder group.
  80 Typically this value is set to about one quarter of the total blocks
  81 in a cylinder group.
  82 The intent is to prevent any single file from using up all the
  83 blocks in a single cylinder group,
  84 thus degrading access times for all files subsequently allocated
  85 in that cylinder group.
  86 The effect of this limit is to cause big files to do long seeks
  87 more frequently than if they were allowed to allocate all the blocks
  88 in a cylinder group before seeking elsewhere.
  89 For file systems with exclusively large files,
  90 this parameter should be set higher.
  91 .It Fl f Ar avgfilesize
  92 Specify the expected average file size.
  93 .It Fl J Cm enable | disable
  94 Turn on/off gjournal flag.
  95 .It Fl L Ar volname
  96 Add/modify an optional file system volume label.
  97 .It Fl l Cm enable | disable
  98 Turn on/off MAC multilabel flag.
  99 .It Fl m Ar minfree
 100 Specify the percentage of space held back
 101 from normal users; the minimum free space threshold.
 102 The default value used is 8%.
 103 Note that lowering the threshold can adversely affect performance:
 104 .Bl -bullet
 105 .It
 106 Settings of 5% and less force space optimization to
 107 always be used which will greatly increase the overhead for file
 108 writes.
 109 .It
 110 The file system's ability to avoid fragmentation will be reduced
 111 when the total free space, including the reserve, drops below 15%.
 112 As free space approaches zero, throughput can degrade by up to a
 113 factor of three over the performance obtained at a 10% threshold.
 114 .El
 115 .Pp
 116 If the value is raised above the current usage level,
 117 users will be unable to allocate files until enough files have
 118 been deleted to get under the higher threshold.
 119 .It Fl N Cm enable | disable
 120 Turn on/off the administrative NFSv4 ACL enable flag.
 121 .It Fl n Cm enable | disable
 122 Turn on/off soft updates.
 123 .It Fl o Cm space | time
 124 The file system can either try to minimize the time spent
 125 allocating blocks, or it can attempt to minimize the space
 126 fragmentation on the disk.
 127 Optimization for space has much
 128 higher overhead for file writes.
 129 The kernel normally changes the preference automatically as
 130 the percent fragmentation changes on the file system.
 131 .It Fl p
 132 Show a summary of what the current tunable settings
 133 are on the selected file system.
 134 More detailed information can be
 135 obtained from the
 136 .Xr dumpfs 8
 137 utility.
 138 .It Fl s Ar avgfpdir
 139 Specify the expected number of files per directory.
 140 .It Fl t Cm enable | disable
 141 Turn on/off the TRIM enable flag.
 142 If enabled, and if the underlying device supports the BIO_DELETE
 143 command, the file system will send a delete request to the underlying
 144 device for each freed block.
 145 The trim enable flag is typically set when the underlying device
 146 uses flash-memory as the device can use the delete command to
 147 pre-zero or at least avoid copying blocks that have been deleted.
 148 .El
 149 .Pp
 150 At least one of the above flags is required.
 151 .Sh FILES
 152 .Bl -tag -width ".Pa /etc/fstab"
 153 .It Pa /etc/fstab
 154 read this to determine the device file for a
 155 specified mount point.
 156 .El
 157 .Sh SEE ALSO
 158 .Xr fs 5 ,
 159 .Xr dumpfs 8 ,
 160 .Xr gjournal 8 ,
 161 .Xr newfs 8
 162 .Rs
 163 .%A M. McKusick
 164 .%A W. Joy
 165 .%A S. Leffler
 166 .%A R. Fabry
 167 .%T "A Fast File System for UNIX"
 168 .%J "ACM Transactions on Computer Systems 2"
 169 .%N 3
 170 .%P pp 181-197
 171 .%D August 1984
 172 .%O "(reprinted in the BSD System Manager's Manual, SMM:5)"
 173 .Re
 174 .Sh HISTORY
 175 The
 176 .Nm
 177 utility appeared in
 178 .Bx 4.2 .
 179 .Sh BUGS
 180 This utility should work on active file systems.
 181 To change the root file system, the system must be rebooted
 182 after the file system is tuned.
 183 .\" Take this out and a Unix Daemon will dog your steps from now until
 184 .\" the time_t's wrap around.
 185 .Pp
 186 You can tune a file system, but you cannot tune a fish.