xref: /freebsd/sbin/growfs/growfs.8 (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
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$
39.\"
40.Dd November 20, 2014
41.Dt GROWFS 8
42.Os
43.Sh NAME
44.Nm growfs
45.Nd expand an existing UFS file system
46.Sh SYNOPSIS
47.Nm
48.Op Fl Ny
49.Op Fl s Ar size
50.Ar special | filesystem
51.Sh DESCRIPTION
52The
53.Nm
54utility makes it possible to expand an UFS file system.
55Before running
56.Nm
57the partition or slice containing the file system must be extended using
58.Xr gpart 8 .
59If you are using volumes you must enlarge them by using
60.Xr gvinum 8 .
61The
62.Nm
63utility extends the size of the file system on the specified special file.
64The following options are available:
65.Bl -tag -width indent
66.It Fl N
67.Dq Test mode .
68Causes the new file system parameters to be printed out without actually
69enlarging the file system.
70.It Fl y
71.Dq Expert mode .
72Usually
73.Nm
74will ask you if you took a backup of your data before and will do some tests
75whether
76.Ar special
77is currently mounted or whether there are any active snapshots on the file
78system specified.
79This will be suppressed.
80So use this option with great care!
81.It Fl s Ar size
82Determines the
83.Ar size
84of the file system after enlarging in sectors.
85.Ar Size
86is the number of 512 byte sectors unless suffixed with a
87.Cm b , k , m , g ,
88or
89.Cm t
90which
91denotes byte, kilobyte, megabyte, gigabyte and terabyte respectively.
92This value defaults to the size of the raw partition specified in
93.Ar special
94(in other words,
95.Nm
96will enlarge the file system to the size of the entire partition).
97.El
98.Sh EXAMPLES
99Expand root file system to fill up available space:
100.Dl growfs /
101.Pp
102Resize
103.Pa /dev/ada0p1
104partition to 2GB and expand the file system:
105.Dl gpart resize -i 1 -s 2G ada0
106.Dl growfs -s 2G /dev/ada0p1
107.Sh SEE ALSO
108.Xr dumpfs 8 ,
109.Xr ffsinfo 8 ,
110.Xr fsck 8 ,
111.Xr fsdb 8 ,
112.Xr gpart 8 ,
113.Xr newfs 8 ,
114.Xr tunefs 8
115.Sh HISTORY
116The
117.Nm
118utility first appeared in
119.Fx 4.4 .
120The ability to resize mounted file systems was added in
121.Fx 10.0 .
122.Sh AUTHORS
123.An Christoph Herrmann Aq Mt chm@FreeBSD.org
124.An Thomas-Henning von Kamptz Aq Mt tomsoft@FreeBSD.org
125.An The GROWFS team Aq Mt growfs@Tomsoft.COM
126.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
127.Sh CAVEATS
128When expanding a file system mounted read-write, any writes to that file system
129will be temporarily suspended until the expansion is finished.
130.Sh BUGS
131Normally
132.Nm
133writes cylinder group summary to disk and reads it again later for doing more
134updates.
135This read operation will provide unexpected data when using
136.Fl N .
137Therefore, this part cannot really be simulated and will be skipped in test
138mode.
139