xref: /freebsd/share/man/man7/growfs.7 (revision cab6a39d7b343596a5823e65c0f7b426551ec22d)
1.\" Copyright 2014 John-Mark Gurney
2.\" 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.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd May 3, 2020
28.Dt GROWFS 7
29.Os
30.Sh NAME
31.Nm growfs
32.Nd start up script to grow the root file-system
33.Sh DESCRIPTION
34The following options in
35.Pa /etc/rc.conf
36control the behavior of
37.Nm :
38.Bl -tag -width ".Va growfs_enable" -offset indent
39.It Va growfs_enable
40.Pq Dq Li NO
41If set to
42.Dq Li YES ,
43the first time the machine boots, the root file-system will be automatically
44expanded, if possible, to fill up all available space after it.
45.El
46.Pp
47To expand the root file-system with-out rebooting, run the following command:
48.Dl % /etc/rc.d/growfs onestart
49.Sh IMPLEMENTATION NOTES
50The script requires that
51.Pa awk
52be present and on the path.
53This usually means that
54.Pa /usr
55should be mounted prior to running the script.
56.Sh FILES
57.Pa /etc/rc.conf
58.Sh EXIT STATUS
59.Ex -std
60.Sh HISTORY
61The
62.Nm
63manual page first appeared in
64.Fx 10.1 .
65.Sh SEE ALSO
66.Xr rc.conf 5
67.Sh AUTHORS
68The man page and script were written by
69.An John-Mark Gurney Aq Mt jmg@FreeBSD.org .
70