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 .\"
  35 .Dd December 11, 1993
  36 .Dt TUNEFS 8
  37 .Os
  38 .Sh NAME
  39 .Nm tunefs
  40 .Nd tune up an existing filesystem
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl A
  44 .Op Fl a Ar maxcontig
  45 .Op Fl d Ar rotdelay
  46 .Op Fl e Ar maxbpg
  47 .Op Fl f Ar avgfilesize
  48 .Op Fl m Ar minfree
  49 .Bk -words
  50 .Op Fl n Ar enable | disable
  51 .Op Fl o Ar space | time
  52 .Op Fl p
  53 .Op Fl s Ar avgfpdir
  54 .Ek
  55 .Op Ar special | Ar 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.  Specifying
  65 this option will cause all backups to be modified as well as the
  66 primary super-block.  This is potentially dangerous - use with caution.
  67 .It Fl a Ar maxcontig
  68 Specify the maximum number of contiguous blocks that will
  69 be laid out before forcing a rotational delay (see
  70 .Fl d
  71 below).
  72 The default value is one, since most device drivers require
  73 an interrupt per disk transfer.
  74 Device drivers that can chain several buffers together in a single
  75 transfer should set this to the maximum chain length.
  76 .It Fl d Ar rotdelay
  77 Specify the expected time (in milliseconds)
  78 to service a transfer completion
  79 interrupt and initiate a new transfer on the same disk.
  80 It is used to decide how much rotational spacing to place between
  81 successive blocks in a file.
  82 .It Fl e Ar maxbpg
  83 Indicate the maximum number of blocks any single file can
  84 allocate out of a cylinder group before it is forced to begin
  85 allocating blocks from another cylinder group.
  86 Typically this value is set to about one quarter of the total blocks
  87 in a cylinder group.
  88 The intent is to prevent any single file from using up all the
  89 blocks in a single cylinder group,
  90 thus degrading access times for all files subsequently allocated
  91 in that cylinder group.
  92 The effect of this limit is to cause big files to do long seeks
  93 more frequently than if they were allowed to allocate all the blocks
  94 in a cylinder group before seeking elsewhere.
  95 For filesystems with exclusively large files,
  96 this parameter should be set higher.
  97 .It Fl f Ar avgfilezsize
  98 Specify the expected average file size.
  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 This value can be set to zero, however up to a factor of three
 104 in throughput will be lost over the performance obtained at a 10%
 105 threshold.
 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 Note that if the value is raised above the current usage level,
 110 users will be unable to allocate files until enough files have
 111 been deleted to get under the higher threshold.
 112 .It Fl n Ar enable | disable
 113 Turn on/off soft updates.
 114 .It Fl o Ar space | time
 115 The filesystem can either try to minimize the time spent
 116 allocating blocks, or it can attempt to minimize the space
 117 fragmentation on the disk.
 118 Optimization for space has much
 119 higher overhead for file writes.
 120 The kernel normally changes the preference automatically as
 121 the percent fragmentation changes on the filesystem.
 122 .It Fl p
 123 Show a summary of what the current tunable settings
 124 are on the selected filesystem.  More detailed information can be
 125 obtained in the
 126 .Xr dumpfs 8
 127 manual page.
 128 .It Fl s Ar avgfpdir
 129 Specify the expected number of files per directory.
 130 .El
 131 .Sh FILES
 132 .Bl -tag -width /etc/fstab -compact
 133 .It Pa /etc/fstab
 134 read this to determine the device file for a
 135 specified mount point.
 136 .El
 137 .Sh SEE ALSO
 138 .Xr fs 5 ,
 139 .Xr dumpfs 8 ,
 140 .Xr newfs 8
 141 .Rs
 142 .%A M. McKusick
 143 .%A W. Joy
 144 .%A S. Leffler
 145 .%A R. Fabry
 146 .%T "A Fast File System for UNIX"
 147 .%J "ACM Transactions on Computer Systems 2"
 148 .%N 3
 149 .%P pp 181-197
 150 .%D August 1984
 151 .%O "(reprinted in the BSD System Manager's Manual, SMM:5)"
 152 .Re
 153 .Sh BUGS
 154 This program should work on mounted and active filesystems.
 155 Because the super-block is not kept in the buffer cache,
 156 the changes will only take effect if the program
 157 is run on dismounted filesystems.
 158 To change the root filesystem, the system must be rebooted
 159 after the filesystem is tuned.
 160 .\" Take this out and a Unix Demon will dog your steps from now until
 161 .\" the time_t's wrap around.
 162 .Pp
 163 You can tune a filesystem, but you can't tune a fish.
 164 .Sh HISTORY
 165 The
 166 .Nm
 167 command appeared in
 168 .Bx 4.2 .