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 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)tunefs.8    8.2 (Berkeley) 12/11/93
  33 .\" $FreeBSD: src/sbin/tunefs/tunefs.8,v 1.11.2.6 2003/01/23 11:14:02 maxim Exp $
  34 .\" $DragonFly: src/sbin/tunefs/tunefs.8,v 1.3 2006/02/17 19:33:33 swildner Exp $
  35 .\"
  36 .Dd December 11, 1993
  37 .Dt TUNEFS 8
  38 .Os
  39 .Sh NAME
  40 .Nm tunefs
  41 .Nd tune up an existing UFS filesystem
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl \&Ap
  45 .Op Fl a Ar maxcontig
  46 .Op Fl d Ar rotdelay
  47 .Op Fl e Ar maxbpg
  48 .Op Fl f Ar avgfilesize
  49 .Op Fl m Ar minfree
  50 .Bk -words
  51 .Op Fl n Cm enable | disable
  52 .Op Fl o Cm space | time
  53 .Op Fl s Ar avgfpdir
  54 .Ek
  55 .Brq Ar special | filesystem
  56 .Sh DESCRIPTION
  57 .Nm Tunefs
  58 is designed to change the dynamic parameters of a filesystem
  59 which affect the layout policies.
  60 The parameters which are to be changed are indicated by the flags
  61 given below:
  62 .Bl -tag -width indent
  63 .It Fl A
  64 The filesystem has several backups of the super-block.
  65 Specifying
  66 this option will cause all backups to be modified as well as the
  67 primary super-block.
  68 This is potentially dangerous - use with caution.
  69 .It Fl a Ar maxcontig
  70 Specify the maximum number of contiguous blocks that will
  71 be laid out before forcing a rotational delay (see
  72 .Fl d
  73 below).
  74 The default value is one, since most device drivers require
  75 an interrupt per disk transfer.
  76 Device drivers that can chain several buffers together in a single
  77 transfer should set this to the maximum chain length.
  78 .It Fl d Ar rotdelay
  79 Specify the expected time (in milliseconds)
  80 to service a transfer completion
  81 interrupt and initiate a new transfer on the same disk.
  82 It is used to decide how much rotational spacing to place between
  83 successive blocks in a file.
  84 .It Fl e Ar maxbpg
  85 Indicate the maximum number of blocks any single file can
  86 allocate out of a cylinder group before it is forced to begin
  87 allocating blocks from another cylinder group.
  88 Typically this value is set to about one quarter of the total blocks
  89 in a cylinder group.
  90 The intent is to prevent any single file from using up all the
  91 blocks in a single cylinder group,
  92 thus degrading access times for all files subsequently allocated
  93 in that cylinder group.
  94 The effect of this limit is to cause big files to do long seeks
  95 more frequently than if they were allowed to allocate all the blocks
  96 in a cylinder group before seeking elsewhere.
  97 For filesystems with exclusively large files,
  98 this parameter should be set higher.
  99 .It Fl f Ar avgfilezsize
 100 Specify the expected average file size.
 101 .It Fl m Ar minfree
 102 Specify the percentage of space held back
 103 from normal users; the minimum free space threshold.
 104 The default value used is 8%.
 105 This value can be set to zero, however up to a factor of three
 106 in throughput will be lost over the performance obtained at a 10%
 107 threshold.
 108 Settings of 5% and less force space optimization to
 109 always be used which will greatly increase the overhead for file
 110 writes.
 111 Note that if the value is raised above the current usage level,
 112 users will be unable to allocate files until enough files have
 113 been deleted to get under the higher threshold.
 114 .It Fl n Cm enable | disable
 115 Turn on/off soft updates.
 116 .It Fl o Cm space | time
 117 The filesystem can either try to minimize the time spent
 118 allocating blocks, or it can attempt to minimize the space
 119 fragmentation on the disk.
 120 Optimization for space has much
 121 higher overhead for file writes.
 122 The kernel normally changes the preference automatically as
 123 the percent fragmentation changes on the filesystem.
 124 .It Fl p
 125 Show a summary of what the current tunable settings
 126 are on the selected filesystem.
 127 More detailed information can be
 128 obtained in the
 129 .Xr dumpfs 8
 130 manual page.
 131 .It Fl s Ar avgfpdir
 132 Specify the expected number of files per directory.
 133 .El
 134 .Sh FILES
 135 .Bl -tag -width /etc/fstab -compact
 136 .It Pa /etc/fstab
 137 read this to determine the device file for a
 138 specified mount point.
 139 .El
 140 .Sh SEE ALSO
 141 .Xr fs 5 ,
 142 .Xr UFS 5 ,
 143 .Xr dumpfs 8 ,
 144 .Xr newfs 8
 145 .Rs
 146 .%A M. McKusick
 147 .%A W. Joy
 148 .%A S. Leffler
 149 .%A R. Fabry
 150 .%T "A Fast File System for UNIX"
 151 .%J "ACM Transactions on Computer Systems 2"
 152 .%N 3
 153 .%P pp 181-197
 154 .%D August 1984
 155 .%O "(reprinted in the BSD System Manager's Manual, SMM:5)"
 156 .Re
 157 .Sh HISTORY
 158 The
 159 .Nm
 160 command appeared in
 161 .Bx 4.2 .
 162 .Sh BUGS
 163 This program should work on mounted and active filesystems.
 164 Because the super-block is not kept in the buffer cache,
 165 the changes will only take effect if the program
 166 is run on dismounted filesystems.
 167 To change the root filesystem, the system must be rebooted
 168 after the filesystem is tuned.
 169 .\" Take this out and a Unix Demon will dog your steps from now until
 170 .\" the time_t's wrap around.
 171 .Pp
 172 You can tune a filesystem, but you can't tune a fish.