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 August 13, 2007
  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 o Cm space | time
  49 .Op Fl p
  50 .Op Fl s Ar avgfpdir
  51 .Ar special | filesystem
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 utility is designed to change the dynamic parameters of a file system
  56 which affect the layout policies.
  57 The
  58 .Nm
  59 utility cannot be run on an active file system.
  60 To change an active file system,
  61 it must be downgraded to read-only or unmounted.
  62 .Pp
  63 The parameters which are to be changed are indicated by the flags
  64 given below:
  65 .Bl -tag -width indent
  66 .It Fl A
  67 The file system has several backups of the super-block.
  68 Specifying
  69 this option will cause all backups to be modified as well as the
  70 primary super-block.
  71 This is potentially dangerous - use with caution.
  72 .It Fl a Cm enable | disable
  73 Turn on/off the administrative ACL enable flag.
  74 .It Fl e Ar maxbpg
  75 Indicate the maximum number of blocks any single file can
  76 allocate out of a cylinder group before it is forced to begin
  77 allocating blocks from another cylinder group.
  78 Typically this value is set to about one quarter of the total blocks
  79 in a cylinder group.
  80 The intent is to prevent any single file from using up all the
  81 blocks in a single cylinder group,
  82 thus degrading access times for all files subsequently allocated
  83 in that cylinder group.
  84 The effect of this limit is to cause big files to do long seeks
  85 more frequently than if they were allowed to allocate all the blocks
  86 in a cylinder group before seeking elsewhere.
  87 For file systems with exclusively large files,
  88 this parameter should be set higher.
  89 .It Fl f Ar avgfilesize
  90 Specify the expected average file size.
  91 .It Fl J Cm enable | disable
  92 Turn on/off GJournal flag.
  93 .It Fl L Ar volname
  94 Add/modify an optional file system volume label.
  95 .It Fl l Cm enable | disable
  96 Turn on/off MAC multilabel flag.
  97 .It Fl m Ar minfree
  98 Specify the percentage of space held back
  99 from normal users; the minimum free space threshold.
 100 The default value used is 8%.
 101 Note that lowering the threshold can adversely affect performance:
 102 .Bl -bullet
 103 .It
 104 Settings of 5% and less force space optimization to
 105 always be used which will greatly increase the overhead for file
 106 writes.
 107 .It
 108 The file system's ability to avoid fragmentation will be reduced
 109 when the total free space, including the reserve, drops below 15%.
 110 As free space approaches zero, throughput can degrade by up to a
 111 factor of three over the performance obtained at a 10% threshold.
 112 .El
 113 .Pp
 114 If the value is raised above the current usage level,
 115 users will be unable to allocate files until enough files have
 116 been deleted to get under the higher threshold.
 117 .It Fl n Cm enable | disable
 118 Turn on/off soft updates.
 119 .It Fl o Cm space | time
 120 The file system can either try to minimize the time spent
 121 allocating blocks, or it can attempt to minimize the space
 122 fragmentation on the disk.
 123 Optimization for space has much
 124 higher overhead for file writes.
 125 The kernel normally changes the preference automatically as
 126 the percent fragmentation changes on the file system.
 127 .It Fl p
 128 Show a summary of what the current tunable settings
 129 are on the selected file system.
 130 More detailed information can be
 131 obtained from the
 132 .Xr dumpfs 8
 133 utility.
 134 .It Fl s Ar avgfpdir
 135 Specify the expected number of files per directory.
 136 .El
 137 .Pp
 138 At least one of the above flags is required.
 139 .Sh FILES
 140 .Bl -tag -width ".Pa /etc/fstab"
 141 .It Pa /etc/fstab
 142 read this to determine the device file for a
 143 specified mount point.
 144 .El
 145 .Sh SEE ALSO
 146 .Xr fs 5 ,
 147 .Xr dumpfs 8 ,
 148 .Xr newfs 8
 149 .Rs
 150 .%A M. McKusick
 151 .%A W. Joy
 152 .%A S. Leffler
 153 .%A R. Fabry
 154 .%T "A Fast File System for UNIX"
 155 .%J "ACM Transactions on Computer Systems 2"
 156 .%N 3
 157 .%P pp 181-197
 158 .%D August 1984
 159 .%O "(reprinted in the BSD System Manager's Manual, SMM:5)"
 160 .Re
 161 .Sh HISTORY
 162 The
 163 .Nm
 164 utility appeared in
 165 .Bx 4.2 .
 166 .Sh BUGS
 167 This utility should work on active file systems.
 168 To change the root file system, the system must be rebooted
 169 after the file system is tuned.
 170 .\" Take this out and a Unix Daemon will dog your steps from now until
 171 .\" the time_t's wrap around.
 172 .Pp
 173 You can tune a file system, but you cannot tune a fish.