freebsd-skq/sbin/growfs/growfs.8

.\" Copyright (c) 2000 Christoph Herrmann, Thomas-Henning von Kamptz
.\" Copyright (c) 1980, 1989, 1993 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Christoph Herrmann and Thomas-Henning von Kamptz, Munich and Frankfurt.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgment:
.\"      This product includes software developed by the University of
.\"      California, Berkeley and its contributors, as well as Christoph
.\"      Herrmann and Thomas-Henning von Kamptz.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $TSHeader: src/sbin/growfs/growfs.8,v 1.3 2000/12/12 19:31:00 tomsoft Exp $
.\" $FreeBSD$
.\"
.Dd December 13, 2017
.Dt GROWFS 8
.Os
.Sh NAME
.Nm growfs
.Nd expand an existing UFS file system
.Sh SYNOPSIS
.Nm
.Op Fl Ny
.Op Fl s Ar size
.Ar special | filesystem
.Sh DESCRIPTION
The
.Nm
utility makes it possible to expand an UFS file system.
Before running
.Nm
the partition or slice containing the file system must be extended using
.Xr gpart 8 .
If you are using volumes you must enlarge them by using
.Xr gvinum 8 .
The
.Nm
utility extends the size of the file system on the specified special file.
The following options are available:
.Bl -tag -width indent
.It Fl N
.Dq Test mode .
Causes the new file system parameters to be printed out without actually
enlarging the file system.
.It Fl y
Causes
.Nm
to assume yes
as the answer to all operator questions.
.It Fl s Ar size
Determines the
.Ar size
of the file system after enlarging in sectors.
.Ar Size
is the number of 512 byte sectors unless suffixed with a
.Cm b , k , m , g ,
or
.Cm t
which
denotes byte, kilobyte, megabyte, gigabyte and terabyte respectively.
This value defaults to the size of the raw partition specified in
.Ar special
(in other words,
.Nm
will enlarge the file system to the size of the entire partition).
.El
.Sh EXAMPLES
Expand root file system to fill up available space:
.Dl growfs /
.Pp
Refresh the LUN size, resize the partition to use all available
capacity, and expand the filesystem accordingly:
.Dl camcontrol reprobe da0
.Dl gpart recover da0
.Dl gpart resize -i 1 da0
.Dl growfs /dev/da0p1
.Sh SEE ALSO
.Xr camcontrol 8 ,
.Xr fsck 8 ,
.Xr gpart 8 ,
.Xr newfs 8 ,
.Xr tunefs 8
.Sh HISTORY
The
.Nm
utility first appeared in
.Fx 4.4 .
The ability to resize mounted file systems was added in
.Fx 10.0 .
.Sh AUTHORS
.An Christoph Herrmann Aq Mt chm@FreeBSD.org
.An Thomas-Henning von Kamptz Aq Mt tomsoft@FreeBSD.org
.An The GROWFS team Aq Mt growfs@Tomsoft.COM
.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
.Sh CAVEATS
When expanding a file system mounted read-write, any writes to that file system
will be temporarily suspended until the expansion is finished.
.Sh BUGS
Normally
.Nm
writes cylinder group summary to disk and reads it again later for doing more
updates.
This read operation will provide unexpected data when using
.Fl N .
Therefore, this part cannot really be simulated and will be skipped in test
mode.
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.\" Copyright (c) 2000 Christoph Herrmann, Thomas-Henning von Kamptz`
			`.\" Copyright (c) 1980, 1989, 1993 The Regents of the University of California.`
			`.\" All rights reserved.`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`.\"`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.\" This code is derived from software contributed to Berkeley by`
			`.\" Christoph Herrmann and Thomas-Henning von Kamptz, Munich and Frankfurt.`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`.\"`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgment:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors, as well as Christoph`
			`.\" Herrmann and Thomas-Henning von Kamptz.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`.\"`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
corrected spelling mistakes in comments check a couple of mallocs usage of errx linebreaks of DBG_ macros, correcting the usage of nroff macros Submitted by: grog, charnier Reviewed by: chm 2000-12-12 20:03:17 +00:00			`.\" $TSHeader: src/sbin/growfs/growfs.8,v 1.3 2000/12/12 19:31:00 tomsoft Exp $`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.\" $FreeBSD$`
			`.\"`
Tone down the description for the growfs "-y" flag. MFC after: 2 weeks 2017-12-13 14:08:33 +00:00			`.Dd December 13, 2017`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.Dt GROWFS 8`
Mdoc(7)ify. 2000-12-13 11:33:19 +00:00			`.Os`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.Sh NAME`
			`.Nm growfs`
Revert the mechanical change from 'file system' to 'filesystem', committed in r223429. As bde@ pointed out, it was mostly backwards. 2011-06-28 19:59:46 +00:00			`.Nd expand an existing UFS file system`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.Sh SYNOPSIS`
Mdoc(7)ify. 2000-12-13 11:33:19 +00:00			`.Nm`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.Op Fl Ny`
			`.Op Fl s Ar size`
Improve growfs(8) in a few ways; unfortunately, it's somewhat hard to untangle them and commit separately. 1. Rewrite the way growfs(8) finds the device and mount point. This makes it possible to use e.g. "growfs /mnt"; it's also used to display more helpful messages. 2. Be more user-friendly, using descriptive messages, like this: OK to grow filesystem on /dev/md0, mounted on /mnt, from 9.8GB to 20GB? [Yes/No]" 3. Allow to specify the size (-s option) just like with mdconfig(8), i.e. with postfixes ("mdconfig -s 10g"). 4. Reload read-only filesystem after growing. Reviewed by: kib, mckusick (earlier version) Sponsored by: The FreeBSD Foundation 2012-04-30 16:08:02 +00:00			`.Ar special \| filesystem`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.Sh DESCRIPTION`
The .Nm utility 2002-07-06 19:34:18 +00:00			`The`
corrected spelling mistakes in comments check a couple of mallocs usage of errx linebreaks of DBG_ macros, correcting the usage of nroff macros Submitted by: grog, charnier Reviewed by: chm 2000-12-12 20:03:17 +00:00			`.Nm`
Improve growfs(8) in a few ways; unfortunately, it's somewhat hard to untangle them and commit separately. 1. Rewrite the way growfs(8) finds the device and mount point. This makes it possible to use e.g. "growfs /mnt"; it's also used to display more helpful messages. 2. Be more user-friendly, using descriptive messages, like this: OK to grow filesystem on /dev/md0, mounted on /mnt, from 9.8GB to 20GB? [Yes/No]" 3. Allow to specify the size (-s option) just like with mdconfig(8), i.e. with postfixes ("mdconfig -s 10g"). 4. Reload read-only filesystem after growing. Reviewed by: kib, mckusick (earlier version) Sponsored by: The FreeBSD Foundation 2012-04-30 16:08:02 +00:00			`utility makes it possible to expand an UFS file system.`
			`Before running`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.Nm`
Improve growfs(8) in a few ways; unfortunately, it's somewhat hard to untangle them and commit separately. 1. Rewrite the way growfs(8) finds the device and mount point. This makes it possible to use e.g. "growfs /mnt"; it's also used to display more helpful messages. 2. Be more user-friendly, using descriptive messages, like this: OK to grow filesystem on /dev/md0, mounted on /mnt, from 9.8GB to 20GB? [Yes/No]" 3. Allow to specify the size (-s option) just like with mdconfig(8), i.e. with postfixes ("mdconfig -s 10g"). 4. Reload read-only filesystem after growing. Reviewed by: kib, mckusick (earlier version) Sponsored by: The FreeBSD Foundation 2012-04-30 16:08:02 +00:00			`the partition or slice containing the file system must be extended using`
			`.Xr gpart 8 .`
fixing a bug in test mode (growfs -N) Submitted by: Chris Boltwood <chris@hiendmedia.com> Reviewed by: tomsoft MFC after: 5 days 2001-08-08 21:45:42 +00:00			`If you are using volumes you must enlarge them by using`
Cosmetic fixes; mostly s/file system/filesystem/g and removing weird indent from messages. 2011-06-22 17:59:53 +00:00			`.Xr gvinum 8 .`
The .Nm utility 2002-07-06 19:34:18 +00:00			`The`
corrected spelling mistakes in comments check a couple of mallocs usage of errx linebreaks of DBG_ macros, correcting the usage of nroff macros Submitted by: grog, charnier Reviewed by: chm 2000-12-12 20:03:17 +00:00			`.Nm`
Revert the mechanical change from 'file system' to 'filesystem', committed in r223429. As bde@ pointed out, it was mostly backwards. 2011-06-28 19:59:46 +00:00			`utility extends the size of the file system on the specified special file.`
corrected spelling mistakes in comments check a couple of mallocs usage of errx linebreaks of DBG_ macros, correcting the usage of nroff macros Submitted by: grog, charnier Reviewed by: chm 2000-12-12 20:03:17 +00:00			`The following options are available:`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.Bl -tag -width indent`
			`.It Fl N`
fixing a bug in test mode (growfs -N) Submitted by: Chris Boltwood <chris@hiendmedia.com> Reviewed by: tomsoft MFC after: 5 days 2001-08-08 21:45:42 +00:00			`.Dq Test mode .`
Revert the mechanical change from 'file system' to 'filesystem', committed in r223429. As bde@ pointed out, it was mostly backwards. 2011-06-28 19:59:46 +00:00			`Causes the new file system parameters to be printed out without actually`
			`enlarging the file system.`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.It Fl y`
Tone down the description for the growfs "-y" flag. MFC after: 2 weeks 2017-12-13 14:08:33 +00:00			`Causes`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`.Nm`
Tone down the description for the growfs "-y" flag. MFC after: 2 weeks 2017-12-13 14:08:33 +00:00			`to assume yes`
			`as the answer to all operator questions.`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.It Fl s Ar size`
fixing a bug in test mode (growfs -N) Submitted by: Chris Boltwood <chris@hiendmedia.com> Reviewed by: tomsoft MFC after: 5 days 2001-08-08 21:45:42 +00:00			`Determines the`
corrected spelling mistakes in comments check a couple of mallocs usage of errx linebreaks of DBG_ macros, correcting the usage of nroff macros Submitted by: grog, charnier Reviewed by: chm 2000-12-12 20:03:17 +00:00			`.Ar size`
Revert the mechanical change from 'file system' to 'filesystem', committed in r223429. As bde@ pointed out, it was mostly backwards. 2011-06-28 19:59:46 +00:00			`of the file system after enlarging in sectors.`
Improve growfs(8) in a few ways; unfortunately, it's somewhat hard to untangle them and commit separately. 1. Rewrite the way growfs(8) finds the device and mount point. This makes it possible to use e.g. "growfs /mnt"; it's also used to display more helpful messages. 2. Be more user-friendly, using descriptive messages, like this: OK to grow filesystem on /dev/md0, mounted on /mnt, from 9.8GB to 20GB? [Yes/No]" 3. Allow to specify the size (-s option) just like with mdconfig(8), i.e. with postfixes ("mdconfig -s 10g"). 4. Reload read-only filesystem after growing. Reviewed by: kib, mckusick (earlier version) Sponsored by: The FreeBSD Foundation 2012-04-30 16:08:02 +00:00			`.Ar Size`
			`is the number of 512 byte sectors unless suffixed with a`
			`.Cm b , k , m , g ,`
			`or`
			`.Cm t`
			`which`
			`denotes byte, kilobyte, megabyte, gigabyte and terabyte respectively.`
corrected spelling mistakes in comments check a couple of mallocs usage of errx linebreaks of DBG_ macros, correcting the usage of nroff macros Submitted by: grog, charnier Reviewed by: chm 2000-12-12 20:03:17 +00:00			`This value defaults to the size of the raw partition specified in`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`.Ar special`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`(in other words,`
			`.Nm`
Revert the mechanical change from 'file system' to 'filesystem', committed in r223429. As bde@ pointed out, it was mostly backwards. 2011-06-28 19:59:46 +00:00			`will enlarge the file system to the size of the entire partition).`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.El`
			`.Sh EXAMPLES`
Uniformly refer to a file system as "file system". MFC after: 1 month Sponsored by: The FreeBSD Foundation 2014-11-20 06:14:40 +00:00			`Expand root file system to fill up available space:`
Add example on how to use gpart before growfs. While here, reorder examples so that the simplest one comes first. MFC after: 1 month Sponsored by: The FreeBSD Foundation 2014-11-20 06:12:11 +00:00			`.Dl growfs /`
			`.Pp`
Update the example growfs(8) manual page to include information on how to make the system "notice" the updated disk size. (Relnotes, since I've forget to set it for "camcontrol reprobe", and it's worth mentioning.) MFC after: 1 month Relnotes: yes Sponsored by: The FreeBSD Foundation 2016-05-10 18:28:38 +00:00			`Refresh the LUN size, resize the partition to use all available`
			`capacity, and expand the filesystem accordingly:`
			`.Dl camcontrol reprobe da0`
			`.Dl gpart recover da0`
			`.Dl gpart resize -i 1 da0`
			`.Dl growfs /dev/da0p1`
Sort sections. 2005-01-18 10:09:38 +00:00			`.Sh SEE ALSO`
Update the example growfs(8) manual page to include information on how to make the system "notice" the updated disk size. (Relnotes, since I've forget to set it for "camcontrol reprobe", and it's worth mentioning.) MFC after: 1 month Relnotes: yes Sponsored by: The FreeBSD Foundation 2016-05-10 18:28:38 +00:00			`.Xr camcontrol 8 ,`
Sort sections. 2005-01-18 10:09:38 +00:00			`.Xr fsck 8 ,`
Cosmetic fixes; mostly s/file system/filesystem/g and removing weird indent from messages. 2011-06-22 17:59:53 +00:00			`.Xr gpart 8 ,`
Sort sections. 2005-01-18 10:09:38 +00:00			`.Xr newfs 8 ,`
Revert the mechanical change from 'file system' to 'filesystem', committed in r223429. As bde@ pointed out, it was mostly backwards. 2011-06-28 19:59:46 +00:00			`.Xr tunefs 8`
Sort sections. 2005-01-18 10:09:38 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`utility first appeared in`
			`.Fx 4.4 .`
Uniformly refer to a file system as "file system". MFC after: 1 month Sponsored by: The FreeBSD Foundation 2014-11-20 06:14:40 +00:00			`The ability to resize mounted file systems was added in`
Somehow stable/10 branch contains correct version, but head doesn't. 2013-12-12 22:33:32 +00:00			`.Fx 10.0 .`
Sort sections. 2005-01-18 10:09:38 +00:00			`.Sh AUTHORS`
use .Mt to mark up email addresses consistently (part1) PR: 191174 Submitted by: Franco Fichtner <franco@lastsummer.de> 2014-06-20 09:40:43 +00:00			`.An Christoph Herrmann Aq Mt chm@FreeBSD.org`
			`.An Thomas-Henning von Kamptz Aq Mt tomsoft@FreeBSD.org`
			`.An The GROWFS team Aq Mt growfs@Tomsoft.COM`
			`.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org`
Make it possible to resize filesystems mounted read-write, using newly introduced UFS write suspension mechanism. Reviewed by: kib, mckusick Sponsored by: FreeBSD Foundation 2012-11-18 19:01:00 +00:00			`.Sh CAVEATS`
			`When expanding a file system mounted read-write, any writes to that file system`
			`will be temporarily suspended until the expansion is finished.`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.Sh BUGS`
mdoc(7) police: spelling, punctuation and markup nits. 2001-08-10 10:15:41 +00:00			`Normally`
fixing a bug in test mode (growfs -N) Submitted by: Chris Boltwood <chris@hiendmedia.com> Reviewed by: tomsoft MFC after: 5 days 2001-08-08 21:45:42 +00:00			`.Nm`
Improve growfs(8) in a few ways; unfortunately, it's somewhat hard to untangle them and commit separately. 1. Rewrite the way growfs(8) finds the device and mount point. This makes it possible to use e.g. "growfs /mnt"; it's also used to display more helpful messages. 2. Be more user-friendly, using descriptive messages, like this: OK to grow filesystem on /dev/md0, mounted on /mnt, from 9.8GB to 20GB? [Yes/No]" 3. Allow to specify the size (-s option) just like with mdconfig(8), i.e. with postfixes ("mdconfig -s 10g"). 4. Reload read-only filesystem after growing. Reviewed by: kib, mckusick (earlier version) Sponsored by: The FreeBSD Foundation 2012-04-30 16:08:02 +00:00			`writes cylinder group summary to disk and reads it again later for doing more`
fixing a bug in test mode (growfs -N) Submitted by: Chris Boltwood <chris@hiendmedia.com> Reviewed by: tomsoft MFC after: 5 days 2001-08-08 21:45:42 +00:00			`updates.`
Minor grammar fixes. 2002-02-06 21:45:48 +00:00			`This read operation will provide unexpected data when using`
fixing a bug in test mode (growfs -N) Submitted by: Chris Boltwood <chris@hiendmedia.com> Reviewed by: tomsoft MFC after: 5 days 2001-08-08 21:45:42 +00:00			`.Fl N .`
can not -> cannot. 2002-08-13 14:10:36 +00:00			`Therefore, this part cannot really be simulated and will be skipped in test`
fixing a bug in test mode (growfs -N) Submitted by: Chris Boltwood <chris@hiendmedia.com> Reviewed by: tomsoft MFC after: 5 days 2001-08-08 21:45:42 +00:00			`mode.`