sbin/growfs/growfs.8

   1 .\" Copyright (c) 2000 Christoph Herrmann, Thomas-Henning von Kamptz
   2 .\" Copyright (c) 1980, 1989, 1993 The Regents of the University of California.
   3 .\" All rights reserved.
   4 .\"
   5 .\" This code is derived from software contributed to Berkeley by
   6 .\" Christoph Herrmann and Thomas-Henning von Kamptz, Munich and Frankfurt.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgment:
  18 .\"      This product includes software developed by the University of
  19 .\"      California, Berkeley and its contributors, as well as Christoph
  20 .\"      Herrmann and Thomas-Henning von Kamptz.
  21 .\" 4. Neither the name of the University nor the names of its contributors
  22 .\"    may be used to endorse or promote products derived from this software
  23 .\"    without specific prior written permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  26 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  29 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35 .\" SUCH DAMAGE.
  36 .\"
  37 .\" $TSHeader: src/sbin/growfs/growfs.8,v 1.3 2000/12/12 19:31:00 tomsoft Exp $
  38 .\" $FreeBSD: src/sbin/growfs/growfs.8,v 1.6.2.6 2003/01/26 03:30:25 keramida Exp $
  39 .\"
  40 .Dd September 8, 2000
  41 .Dt GROWFS 8
  42 .Os
  43 .Sh NAME
  44 .Nm growfs
  45 .Nd grow size of an existing ufs file system
  46 .Sh SYNOPSIS
  47 .Nm
  48 .Op Fl Ny
  49 .Op Fl s Ar size
  50 .Ar special
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 utility extends the
  55 .Xr newfs 8
  56 program.
  57 Before starting
  58 .Nm
  59 the disk must be labeled to a bigger size using
  60 .Xr disklabel 8 .
  61 If you wish to grow a file system beyond the boundary of
  62 the slice it resides in, you must re-size the slice using
  63 .Xr fdisk 8
  64 before running
  65 .Nm .
  66 If you are using volumes you must enlarge them by using
  67 .Xr vinum 8 .
  68 The
  69 .Nm
  70 utility extends the size of the file system on the specified special file.
  71 Currently
  72 .Nm
  73 can only enlarge unmounted file systems.
  74 Do not try enlarging a mounted file system, your system may panic and you will
  75 not be able to use the file system any longer.
  76 Most of the
  77 .Xr newfs 8
  78 options cannot be changed by
  79 .Nm .
  80 In fact, you can only increase the size of the file system.
  81 Use
  82 .Xr tunefs 8
  83 for other changes.
  84 .Pp
  85 The following options are available:
  86 .Bl -tag -width indent
  87 .It Fl N
  88 .Dq Test mode .
  89 Causes the new file system parameters to be printed out without actually
  90 enlarging the file system.
  91 .It Fl y
  92 .Dq Expert mode .
  93 Usually
  94 .Nm
  95 will ask you if you took a backup of your data before and will do some tests
  96 whether
  97 .Ar special
  98 is currently mounted or whether there are any active snapshots on the file
  99 system specified.
 100 This will be suppressed.
 101 So use this option with great care!
 102 .It Fl s Ar size
 103 Determines the
 104 .Ar size
 105 of the file system after enlarging in sectors.
 106 This value defaults to the size of the raw partition specified in
 107 .Ar special
 108 (in other words,
 109 .Nm
 110 will enlarge the file system to the size of the entire partition).
 111 .El
 112 .Sh EXAMPLES
 113 .Dl growfs -s 4194304 /dev/vinum/testvol
 114 .Pp
 115 will enlarge
 116 .Pa /dev/vinum/testvol
 117 up to 2GB if there is enough space in
 118 .Pa /dev/vinum/testvol .
 119 .Sh BUGS
 120 The
 121 .Nm
 122 utility works starting with
 123 .Fx
 124 3.x.
 125 There may be cases on
 126 .Fx
 127 3.x only, when
 128 .Nm
 129 does not recognize properly whether or not the file system is mounted and
 130 exits with an error message.
 131 Then please use
 132 .Nm
 133 .Fl y
 134 if you are sure that the file system is not mounted.
 135 It is also recommended to always use
 136 .Xr fsck 8
 137 after enlarging (just to be on the safe side).
 138 .Pp
 139 For enlarging beyond certain limits, it is essential to have some free blocks
 140 available in the first cylinder group.
 141 If that space is not available in the first cylinder group, a critical data
 142 structure has to be relocated into one of the new available cylinder groups.
 143 On
 144 .Fx
 145 3.x this will cause problems with
 146 .Xr fsck 8
 147 afterwards.
 148 So
 149 .Xr fsck 8
 150 needs to be patched if you want to use
 151 .Nm
 152 for
 153 .Fx
 154 3.x.
 155 This patch is already integrated in
 156 .Fx
 157 starting with
 158 .Fx 4.4 .
 159 To avoid an unexpected relocation of that structure it is possible to use
 160 .Nm ffsinfo
 161 .Fl c Ar 0
 162 on the first cylinder group to verify that
 163 .Em nbfree
 164 in the CYLINDER SUMMARY (internal cs) of the CYLINDER GROUP
 165 .Em cgr0
 166 has enough blocks.
 167 As a rule of thumb for default file system parameters one block is needed for
 168 every 2 GB of total file system size.
 169 .Pp
 170 Normally
 171 .Nm
 172 writes this critical structure to disk and reads it again later for doing more
 173 updates.
 174 This read operation will provide unexpected data when using
 175 .Fl N .
 176 Therefore, this part cannot really be simulated and will be skipped in test
 177 mode.
 178 .Sh SEE ALSO
 179 .Xr disklabel 8 ,
 180 .Xr dumpfs 8 ,
 181 .Xr fdisk 8 ,
 182 .Xr ffsinfo 8 ,
 183 .Xr fsck 8 ,
 184 .Xr newfs 8 ,
 185 .Xr tunefs 8 ,
 186 .Xr vinum 8
 187 .Sh AUTHORS
 188 .An Christoph Herrmann Aq chm@FreeBSD.org
 189 .An Thomas-Henning von Kamptz Aq tomsoft@FreeBSD.org
 190 .An The GROWFS team Aq growfs@Tomsoft.COM
 191 .Sh HISTORY
 192 The
 193 .Nm
 194 utility first appeared in
 195 .Fx 4.4 .