We're DragonFly, not NetBSD.
[dragonfly.git] / sbin / newbtconf / newbtconf.8
CommitLineData
b9fe2208 1.\" $NetBSD: newbtconf.8,v 1.18 2004/08/31 17:08:06 uwe Exp $
eb4d2272 2.\" $DragonFly: src/sbin/newbtconf/newbtconf.8,v 1.2 2005/07/02 20:50:02 swildner Exp $
b9fe2208
RG
3.\"
4.\" Copyright (c) 1999 Darren Reed. All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\" notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\" notice, this list of conditions and the following disclaimer in the
13.\" documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the author nor the names of its contributors
15.\" may be used to endorse or promote products derived from this software
16.\" without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.Dd January 6, 2003
31.Dt NEWBTCONF 8
32.Os
33.Sh NAME
34.Nm newbtconf
35.Nd multiple boot-up configurations
36.Sh SYNOPSIS
37.Nm
38.Ar new-conf-name
39.Op Ar orig-conf-name
40.Nm
41.Cm init
42.Nm
43.Cm revert
44.Sh DESCRIPTION
45.Nm
46is used to set up the system in such a way that the user is offered a
47selection of environments in which to boot the system up into.
48The most obvious application being for laptops to provide a network
49and non-network environment after a successful boot into multi-user mode.
50.Ss Background
51In order to accomplish this task, the files usually associated with
52establishing the current system's running configuration are replaced with
53symbolic links which are adjusted with each boot to point to the appropriate
54file for the desired run-time environment.
55This is accomplished by directing all of the symbolic links through a
56directory which itself is a symbolic link
57.Pq Pa /etc/etc.current ,
58to the destination files.
59At each bootup, the selection made changes which directory
60.Pa /etc/etc.current
61points to.
62.Pp
63Through doing this and reloading
64.Pa /etc/rc.conf
65in
66.Pa /etc/rc
67after the link has
68been established, the resulting run-time configuration is effectively
69controlled without the need to directly edit any files.
70The default boot-up environment is selected by manually directing which
71configuration directory
72.Pa /etc/etc.default
73points to.
74As opposed to
75.Pa /etc/etc.current
76(which is updated
77with every boot),
78.Pa /etc/etc.default
79is not automatically updated.
80.Ss Getting Started
81By default,
eb4d2272 82.Dx
b9fe2208
RG
83only has one boot-up configuration - that set in the
84file
85.Pa /etc/rc.conf .
86In order to initialize the system for operating in a
87manner which supports multiple boot configurations,
88.Nm
89must be run with an argument of
90.Sq init .
91This will create two symbolic links
92.Pa /etc/etc.current
93and
94.Pa /etc/etc.default
95to the directory
96.Pa /etc/etc.network .
97The following files are all moved into
98that directory and symbolic links put in their place, in
99.Pa /etc ,
100pointing to
101.Pa /etc/etc.current/\*[Lt]filename\*[Gt] :
102.Bd -literal -offset indent
103/etc/defaultdomain
104/etc/fstab
105/etc/ifconfig.*
106/etc/inetd.conf
107/etc/mrouted.conf
108/etc/mygate
109/etc/myname
110/etc/netstart
111/etc/nsswitch.conf
112/etc/ntp.conf
113/etc/rc.conf
114/etc/rc.conf.d
115/etc/resolv.conf
116.Ed
117.Pp
118To test that this has been performed correctly, reboot your system into
eb4d2272 119.Dx .
b9fe2208
RG
120After the kernel has autoconfigured and tty flags have been set,
121a prompt should appear, preceded by the following like, looking like this:
122.Bd -literal
123[network]
124Which configuration [network] ?
125.Ed
126.Pp
127The []'s are used to indicate the default configuration, which can be
128selected by just pressing return.
129If there were other configurations available at this stage, you would
130have 30 seconds to enter that name and press
131.Sy RETURN .
132.Ss Multiple Configurations
133Once an initial configuration has been set up, we can proceed to set up further
134run time environments.
135This is done by invoking
136.Nm
137with the name of the new configuration to be created.
138By default, this step
139will use the current configuration files as the basis for this setup unless
140a second parameter is given - that of the configuration to use as the basis
141for the new one.
142Upon completion, a new directory,
143.Pa /etc/etc.\*[Lt]newname\*[Gt] ,
144will have been created,
145priming the directory with the appropriate files for editing.
146For example, if we do
147.Nm
148.Ar nonet network
149it would create a directory named
150.Pa /etc/etc.nonet
151and copy all the files from
152.Pa /etc/etc.network
153into that directory.
154Upon rebooting, we should see:
155.Bd -literal
156[network] nonet
157Which configuration [network] ?
158.Ed
159.Pp
160To set up the system for booting into the
161.Dq nonet
162configuration, the files in
163.Pa /etc/etc.nonet
164need be edited.
165.Pp
166If you wanted to make
167.Dq nonet
168the default configuration when booting, you
169would need delete the symbolic link
170.Pa /etc/etc.default
171and create a new symbolic link (with the same name) to
172.Pa /etc/etc.nonet .
173Booting up after having made such a change would
174result in the following being displayed:
175.Bd -literal
176network [nonet]
177Which configuration [nonet] ?
178.Ed
179.Ss \&No Network
180Assuming that we performed the above command successfully, in order to
181successfully configure
eb4d2272 182.Dx
b9fe2208
RG
183to not configure interfaces (or generate no
184errors from attempting to do so), the following settings (at least) should
185be used in
186.Pa /etc/etc.nonet/rc.conf :
187.Bd -literal
188auto_ifconfig=NO
189net_interfaces=NO
190.Ed
191.Pp
192Of course other networking services, such as NTP, routed, etc, are all
193expected to be
194.Dq NO .
195In general, the only setting that should be
196.Dq YES
197is syslogd, and perhaps cron (if your cron scripts don't
198need the network) or screenblank/wscons (if applicable).
199Other actions such as deleting any NFS mounts from
200.Pa /etc/etc.nonet/fstab
201would also need to be undertaken.
202.Ss Reverting multiple boot configurations
203Multiple boot configurations can be deactivated by running
204.Nm
205with an argument of
206.Cm revert .
207All the symlinks mentioned above are then removed and the files they point to
208are copied to their default place.
209This effectively makes the currently selected
210configuration the only one active.
211The symbolic links
212.Pa /etc/etc.current
213and
214.Pa /etc/etc.default
215are also removed so upon rebooting no configuration selection menu is
216displayed.
217Note that the previously created configurations (in
218.Pa /etc/etc.\*[Lt]name\*[Gt] )
219are not removed.
220.Sh FILES
221.Bl -tag -width /etc/mrouted.current -compact
222.It Pa /etc/etc.current
223Symbolic link to current config directory.
224.It Pa /etc/etc.default
225Symbolic link to default config directory.
226.Pp
227.It Pa /etc/defaultdomain
228These files all become symbolic links.
229.It Pa /etc/fstab
230.It Pa /etc/ifconfig.*
231.It Pa /etc/inetd.conf
232.It Pa /etc/mrouted.conf
233.It Pa /etc/mygate
234.It Pa /etc/myname
235.It Pa /etc/netstart
236.It Pa /etc/nsswitch.conf
237.It Pa /etc/ntp.conf
238.It Pa /etc/rc.conf
239.It Pa /etc/rc.conf.d
240.It Pa /etc/resolv.conf
241.El
242.Sh SEE ALSO
243.Xr rc.conf 5 ,
244.Xr rc 8
245.Sh HISTORY
246The
247.Nm
248program first appeared in
249.Nx 1.5 .
250.Sh AUTHORS
251This shell script was written by
252.An Darren Reed
253.Aq darrenr@NetBSD.org
254with initial input from
255.An Matthew Green
256.Aq mrg@NetBSD.org
257on how to approach this problem.
258.Sh BUGS
259It presently does not display a count down timer whilst waiting for input
260to select which configuration and nor does it abort said timer when a key
261is first pressed.
262.Pp
263The management of the overall collection of multiple configurations is much
264more manual than it ought to be.
265A general system configuration tool needs to be written to ease their
266management.