Sync usage with man page.
[netbsd-mini2440.git] / distrib / notes / common / postinstall
blobb81ade6e63464b0d0696b05512d53e12ac635263
1 .\"     $NetBSD: postinstall,v 1.73 2009/04/25 01:33:12 snj Exp $
2 .\"
3 .\" Copyright (c) 1999-2004 The NetBSD Foundation, Inc.
4 .\" 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 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
16 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
19 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 .\" POSSIBILITY OF SUCH DAMAGE.
26 .\"
27 Once you've got the operating system running, there are a few
28 things you need to do in order to bring the system into a properly
29 configured state.
30 The most important steps are described below.
31 .(enum
32 Configuring
33 .Pa /etc/rc.conf
34 .Pp
35 If you or the installation software haven't done any configuration of
36 .Pa /etc/rc.conf
37 .Ic ( sysinst
38 usually will),
39 the system will drop you into single user mode on first reboot with the
40 message
41 .Pp
42 .Dl /etc/rc.conf is not configured. Multiuser boot aborted.
43 .Pp
44 and with the root file system
45 .Pq Pa /
46 mounted read-only.
47 When the system asks you to choose a shell, simply press
48 .Key RETURN
49 to get to a
50 .Pa /bin/sh
51 prompt.
52 If you are asked for a terminal type, respond with
54 .ds termtype vt220
56 .ie \n[hp300] \{\
57 .ds termtype hp300h
58 .Ic \*[termtype]
59 for a local console, or whatever is appropriate for your serial console.
60 .\}
61 .el \{\
62 .ie \n[macppc] \{\
63 .ds termtype vt100
64 .Ic \*[termtype]
65 (or whatever is appropriate for your terminal type)
66 .\}
67 .el \{\
68 .ie \n[pmax] \{\
69 .ds termtype termtype
70 the correct terminal type as discussed in the
71 .Sx Once you've booted the diskimage
72 section.
73 .\}
74 .el \{\
75 .ie \n[sparc]:\n[sparc64] \{\
76 .ds termtype sun
77 .Ic \*[termtype]
78 for a local console, or whatever is appropriate for your serial
79 console (some systems display garbage with a
80 .Ic \*[termtype]
81 terminal type, you may need to use
82 .Ic sun-ss5 )
83 .ds termtype sun
84 .\}
85 .el \{\
86 .Ic \*[termtype]
87 (or whatever is appropriate for your terminal type)
88 .\}
89 .\}
90 .\}
91 .\}
92 and press
93 .Key RETURN .
94 You may need to type one of the following commands to get your delete key
95 to work properly, depending on your keyboard:
96 .Dl # Ic "stty erase '^h'"
97 .Dl # Ic "stty erase '^?'"
98 At this point, you need to configure at least
99 one file in the
100 .Pa /etc
101 directory.
102 You will need to mount your root file system read/write with:
103 .Dl # Ic "/sbin/mount -u -w /"
104 Change to the
105 .Pa /etc
106 directory and take a look at the
107 .Pa /etc/rc.conf
108 file.
109 Modify it to your tastes, making sure that you set
110 .Li rc_configured=YES
111 so that your changes will be enabled and a multi-user boot can
112 proceed.
113 Default values for the various programs can be found in
114 .Pa /etc/defaults/rc.conf ,
115 where some in-line documentation may be found.
116 More complete documentation can be found in
117 .Xr rc.conf 5 .
119 When you have finished editing
120 .Pa /etc/rc.conf ,
121 type
122 .Ic exit
123 at the prompt to
124 leave the single-user shell and continue with the multi-user boot.
126 Other values that may need to be set in
127 .Pa /etc/rc.conf
128 for a networked environment are
129 .Ar hostname
130 and possibly
131 .Ar defaultroute .
132 You may also need to add an
133 .Ar ifconfig_int
134 for your
135 .Aq int
136 network interface,
137 .ie \n[mac68k] \{\
138 where your on-board, NuBus or PDS interface may be
139 .Li ae0 ,
140 .Li mc0
142 .Li sn0 .
143 For example:
145 .el \{\
146 .ie \n[macppc] \{\
147 where your on-board interfaces may be one of
148 .Li mc0 ,
149 .Li bm0 ,
150 .Li tlp0
152 .Li gem0 .
153 For example:
155 .el along the lines of
159 .ds IFname le0
160 .if \n[acorn26]   .ds IFname ei0
161 .if \n[acorn32]   .ds IFname ei0
162 .if \n[amd64]     .ds IFname wm0
163 .if \n[arc]       .ds IFname sn0
164 .if \n[cats]      .ds IFname tlp0
165 .if \n[evbarm]    .ds IFname fxp0
166 .if \n[hp700]     .ds IFname ie0
167 .if \n[hpcmips]   .ds IFname ne0
168 .if \n[hpcsh]     .ds IFname ne0
169 .if \n[i386]      .ds IFname wm0
170 .if \n[landisk]   .ds IFname re0
171 .if \n[mac68k]    .ds IFname sn0
172 .if \n[macppc]    .ds IFname mc0
173 .if \n[next68k]   .ds IFname xe0
174 .if \n[prep]      .ds IFname pcn0
175 .if \n[sandpoint] .ds IFname tlp0
176 .if \n[sgimips]   .ds IFname sq0
177 .if \n[shark]     .ds IFname cs0
178 .if \n[sparc64]   .ds IFname hme0
179 .if \n[x68k]      .ds IFname ne0
180 .if \n[xen]       .ds IFname xennet0
182 .Dl ifconfig_\*[IFname]="inet 192.0.2.123 netmask 255.255.255.0"
184 or, if you have
185 .Ar myname.my.dom
187 .Pa /etc/hosts :
189 .Dl ifconfig_\*[IFname]="inet myname.my.dom netmask 255.255.255.0"
191 To enable proper hostname resolution, you will also want to add an
192 .Pa /etc/resolv.conf
193 file or (if you are feeling a little more adventurous) run
194 .Xr named 8 .
196 .Xr resolv.conf 5
198 .Xr named 8
199 for more information.
200 Instead of manually configuring network and naming service,
201 DHCP can be used by setting
202 .Li dhclient=YES
204 .Pa /etc/rc.conf .
206 Other files in
207 .Pa /etc
208 that may require modification or setting up include
209 .ie \n[sgimips] \{\
210 .Pa /etc/mailer.conf
212 .Pa /etc/nsswitch.conf .
214 .el \{\
215 .Pa /etc/mailer.conf ,
216 .Pa /etc/nsswitch.conf ,
218 .Pa /etc/wscons.conf .
220 .ie \n[shark] \{\
222 For Digital DNARD machines you will need to edit
223 .Pa /etc/ttys
224 and change the console terminal type from vt100 to pc3.
226 .if \n[atari] \{\
228 Select the proper terminal devices
230 You will have to edit the
231 .Pa /etc/ttys
232 file.
233 If you don't have a Milan, you must disable the
234 .Pa ttyEx
235 devices.
236 For the Milan, you will have to disable the
237 .Pa ttyex
238 devices.
239 This is easy, just change 'on' to 'off' on the corresponding lines.
241 .if \n[cats] \{\
243 For the
244 .Xr savecore 8
245 facility to work with the a.out and elf kernel images supplied with
246 \*M installations you will need to set
247 .Li savecore_flags="-z -N /netbsd"
249 .if \n[sparc]:\n[sparc64] \{\
251 Select the proper terminal devices
253 If you are using a serial console, you will have to edit the
254 .Pa /etc/ttys
255 file and change 
256 .if \n[sparc] sun
257 .if \n[sparc64] sun-ss5
258 to the appropriate terminal type, such as vt220.
261 Logging in
263 After reboot, you can log in as
264 .Li root
265 at the login prompt.
266 Unless you've set a password in
267 .Ic sysinst ,
268 there
269 is no initial password.
270 You should create an account for yourself (see below) and protect it and the
271 .Dq root
272 account with good passwords.
273 By default, root login from the network is disabled (even via
274 .Xr ssh 1 ) .
275 One way to become root over the network is to log in as a different
276 user that belongs to group
277 .Dq wheel
278 (see
279 .Xr group 5 )
280 and use
281 .Xr su 1
282 to become root.
284 Adding accounts
286 Use the
287 .Xr useradd 8
288 command to add accounts to your system.
289 Do not
290 edit
291 .Pa /etc/passwd
292 directly! See
293 .Xr vipw 8
295 .Xr pwd_mkdb 8
296 if you want to edit the password database.
297 .if !\n[sun2] \{\
299 The X Window System
301 If you installed the X Window System, you may want to read the
302 chapter about X in the NetBSD Guide:
303 .Lk http://netbsd.org/docs/guide/en/chap-x.html
304 .if \n[hp300] \{\
305 Also, you may want to read through the
306 .Nx*M
307 FAQ entry on X11.
309 .Lk http://www.NetBSD.org/ports/hp300/faq.html#x11
311 .if \n[mac68k] \{\
312 .(tag [Color_X]
313 .It [Color_X]
314 Some systems are capable of supporting a color X Server in either thousands
315 or millions of colors.
316 The \*M port does not support resolution switching at this time.
317 If your system is capable of running the color X Server it can be
318 installed at this point and the Booter options can be
319 modified to match the resolution depth.
320 .tag)
324 Installing third party packages
326 If you wish to install any of the software freely available for
328 systems you are strongly advised to first check the
330 package system, pkgsrc.
331 pkgsrc automatically handles any changes necessary to make the
332 software run on
333 .Nx .
334 This includes the retrieval and installation of any other
335 packages on which the software may depend.
337 .(bullet
338 More information on the package system is available at
339 .Lk http://www.NetBSD.org/docs/software/packages.html
341 A list of available packages suitable for browsing is at
342 .Lk ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/README.html
344 Precompiled binaries can be found at
345 .Lk ftp://ftp.NetBSD.org/pub/pkgsrc/packages/NetBSD/
346 usually in the
347 .Pa \*M/\*V/All
348 subdir.
349 You can install them with the following commands under
350 .Xr sh 1 :
352 .Bd -unfilled
353 .Ic # PKG_PATH=ftp://ftp.NetBSD.org/pub/pkgsrc/packages/NetBSD/\*M/\*V/All
354 .Ic # export PKG_PATH
355 .Ic # pkg_add -v tcsh
356 .Ic # pkg_add -v bash
357 .Ic # pkg_add -v perl
358 .Ic # pkg_add -v apache
359 .Ic # pkg_add -v kde
360 .Ic # pkg_add -v firefox
361 \&...
364 If you are using
365 .Xr csh 1
366 then replace the first two lines with the following:
368 .Bd -unfilled
369 .Ic # setenv PKG_PATH ftp://ftp.NetBSD.org/pub/pkgsrc/packages/NetBSD/\*M/\*V/All
371 .(Note
372 Some mirror sites don't mirror the
373 .Pa /pub/pkgsrc
374 directory.
375 If you would like to use such mirrors, you could also try the
376 .Pa /pub/NetBSD/packages/current-packages/NetBSD/\*M/\*V/All
377 directory, which may have the same contents.
378 .Note)
380 The above commands will install the Tenex-csh and Bourne Again shells,
381 the Perl programming language, Apache web server, KDE desktop
382 environment and the Firefox web browser 
383 as well as all the packages they depend on.
384 .(Note
385 In some cases the
386 .Xr pkg_add 1
387 command will complain about a version mismatch of packages with a message
388 like the following:
389 .Dl Warning: package `foo' was built for a different version of the OS:
390 .Dl NetBSD/i386 M.N (pkg) vs. NetBSD/i386 \*V (this host) ,
391 This warning is harmless if the formal major release numbers are the same
392 between the pkg and your host.
393 Please refer to the NetBSD release glossary and graphs at
394 .Lk http://www.NetBSD.org/releases/release-map.html
395 for more information about NetBSD's release numbering scheme.
396 .Note)
398 The framework for compiling packages can be obtained by
399 retrieving the file
400 .Lk ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc.tar.gz
401 It is typically extracted into
402 .Pa /usr/pkgsrc
403 (though other locations work fine) with the commands:
405 .Dl # Ic "cd /usr"
406 .Dl # Ic "tar -zxpf pkgsrc.tar.gz"
408 After extracting, see the
409 .Pa doc/pkgsrc.txt
410 file in the extraction directory (e.g.,
411 .Pa /usr/pkgsrc/doc/pkgsrc.txt )
412 for more information.
413 .bullet)
415 Misc
416 .(bullet
417 Edit
418 .Pa /etc/mail/aliases
419 to forward root mail to the right place.
420 Don't forget to run
421 .Xr newaliases 1
422 afterwards.
425 .Pa /etc/postfix/main.cf
426 file will almost definitely need to be adjusted.
427 If you prefer a different MTA, then install it using
428 pkgsrc or by hand and adjust
429 .Pa /etc/mailer.conf .
431 Edit
432 .Pa /etc/rc.local
433 to run any local daemons you use.
435 Many of the
436 .Pa /etc
437 files are documented in section 5 of the manual; so just invoking
439 .Dl # Ic man 5 Ar filename
441 is likely to give you more information on these files.
442 .bullet)
443 .enum)