1 .\" Copyright (c) 1980, 1986, 1988 The Regents of the University of California.
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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 .\" 3. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by the University of
15 .\" California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" @(#)4.t 8.1 (Berkeley) 7/29/93
34 .ds LH "Installing/Operating \*(4B
39 This section describes procedures used to set up a \*(4B UNIX system.
40 These procedures are used when a system is first installed
41 or when the system configuration changes. Procedures for normal
42 system operation are described in the next section.
43 .Sh 2 "Kernel configuration"
45 This section briefly describes the layout of the kernel code and
46 how files for devices are made.
47 For a full discussion of configuring
48 and building system images, consult the document ``Building
49 4.3BSD UNIX Systems with Config'' (SMM:2).
50 .Sh 3 "Kernel organization"
52 As distributed, the kernel source is in a
53 separate tar image. The source may be physically
54 located anywhere within any filesystem so long as
55 a symbolic link to the location is created for the file
59 are normally symbolic links relative to
61 In further discussions of the system source all path names
62 will be given relative to
65 The kernel is made up of several large generic parts:
68 sys main kernel header files
69 kern kernel functions broken down as follows
70 init system startup, syscall dispatching, entry points
71 kern scheduling, descriptor handling and generic I/O
72 sys process management, signals
73 tty terminal handling and job control
74 vfs filesystem management
75 uipc interprocess communication (sockets)
76 subr miscellaneous support routines
77 vm virtual memory management
78 ufs local filesystems broken down as follows
79 ufs common local filesystem routines
81 lfs log-based filesystem
82 mfs memory based filesystem
83 nfs Sun-compatible network filesystem
84 miscfs miscellaneous filesystems broken down as follows
85 deadfs where rejected vnodes go to die
86 fdesc access to per-process file descriptors
87 fifofs IEEE Std1003.1 FIFOs
88 kernfs filesystem access to kernel data structures
89 lofs loopback filesystem
90 nullfs another loopback filesystem
91 portal associate processes with filesystem locations
92 specfs device special files
93 umapfs provide alternate uid/gid mappings
94 dev generic device drivers (SCSI, vnode, concatenated disk)
97 The networking code is organized by protocol
100 net routing and generic interface drivers
101 netinet Internet protocols (TCP, UDP, IP, etc)
102 netiso ISO protocols (TP-4, CLNP, CLTP, etc)
103 netns Xerox network systems protocols (IDP, SPP, etc)
104 netx25 CCITT X.25 protocols (X.25 Packet Level, HDLC/LAPB)
107 A separate subdirectory is provided for each machine architecture
110 hp300 HP 9000/300 series of Motorola 68000-based machines
111 hp code common to both HP 68k and (non-existent) PA-RISC ports
112 i386 Intel 386/486-based PC machines
113 luna68k Omron 68000-based workstations
114 news3400 Sony News MIPS-based workstations
115 pmax Digital 3100/5000 MIPS-based workstations
116 sparc Sun Microsystems SPARCstation 1, 1+, and 2
117 tahoe (deprecated) CCI Power 6-series machines
118 vax (deprecated) Digital VAX machines
121 Each machine directory is subdivided by function;
122 for example the hp300 directory contains
125 include exported machine-dependent header files
126 hp300 machine-dependent support code and private header files
128 conf configuration files
129 stand machine-dependent standalone code
132 Other kernel related directories
135 compile area to compile kernels
136 conf machine-independent configuration files
137 stand machine-independent standalone code
139 .Sh 3 "Devices and device drivers"
141 Devices supported by UNIX are implemented in the kernel
142 by drivers whose source is kept in
143 .Pn /sys/<architecture>/dev .
144 These drivers are loaded
145 into the system when included in a cpu specific configuration file
146 kept in the conf directory. Devices are accessed through special
147 files in the filesystem, made by the
149 program and normally kept in the
152 For all the devices supported by the distribution system, the
159 Determine the set of devices that you have and create a new
161 directory by running the MAKEDEV script.
162 First create a new directory
164 copy MAKEDEV into it, edit the file MAKEDEV.local
165 to provide an entry for local needs,
166 and run it to generate a
167 .Pn /newdev directory.
171 \fB#\fP \fImkdir newdev\fP
172 \fB#\fP \fIcp dev/MAKEDEV newdev/MAKEDEV\fP
173 \fB#\fP \fIcd newdev\fP
174 \fB#\fP \fIMAKEDEV \*(Dk0 pt0 std LOCAL\fP
176 Note the ``std'' argument causes standard devices such as
178 the machine console, to be created.
183 \fB#\fP \fImv dev olddev ; mv newdev dev\fP
186 to install the new device directory.
187 .Sh 3 "Building new system images"
189 The kernel configuration of each UNIX system is described by
190 a single configuration file, stored in the
191 .Pn /sys/<architecture>/conf
193 To learn about the format of this file and the procedure used
194 to build system images,
195 start by reading ``Building 4.3BSD UNIX Systems with Config'' (SMM:2),
196 look at the manual pages in section 4
197 of the UNIX manual for the devices you have,
198 and look at the sample configuration files in the
199 .Pn /sys/<architecture>/conf
202 The configured system image
204 should be copied to the root, and then booted to try it out.
205 It is best to name it
207 so as not to destroy the working system until you are sure it does work:
209 \fB#\fP \fIcp kernel /newkernel\fP
212 It is also a good idea to keep the previous system around under some other
213 name. In particular, we recommend that you save the generic distribution
214 version of the system permanently as
216 for use in emergencies.
217 To boot the new version of the system you should follow the
218 bootstrap procedures outlined in section 6.1.
219 After having booted and tested the new system, it should be installed as
221 before going into multiuser operation.
222 A systematic scheme for numbering and saving old versions
223 of the system may be useful.
224 .Sh 2 "Configuring terminals"
226 If UNIX is to support simultaneous
227 access from directly-connected terminals other than the console,
234 To add a new terminal device, be sure the device is configured into the system
235 and that the special files for the device have been made by
237 Then, enable the appropriate lines of
239 by setting the ``status''
240 field to \fBon\fP (or add new lines).
243 are one-for-one with entries in the file of current users
246 and therefore it is best to make changes
247 while running in single-user mode
248 and to add all the entries for a new device at once.
252 file is broken into four tab separated
253 fields (comments are shown by a `#' character and extend to
254 the end of the line). For each terminal line the four fields
256 the device (without a leading
260 should startup to service the line
261 (or \fBnone\fP if the line is to be left alone),
262 the terminal type (found in
263 .Pn /usr/share/misc/termcap ),
264 and optional status information describing if the terminal is
265 enabled or not and if it is ``secure'' (i.e. the super user should
266 be allowed to login on the line).
267 If the console is marked as ``insecure'',
268 then the root password is required to bring the machine up single-user.
269 All fields are character strings
270 with entries requiring embedded white space enclosed in double
272 Thus a newly added terminal
276 tty00 "/usr/libexec/getty std.9600" vt100 on secure # mike's office
278 The std.9600 parameter provided to
279 .Pn /usr/libexec/getty
280 is used in searching the file
282 it specifies a terminal's characteristics (such as baud rate).
283 To make custom terminal types, consult
288 Dialup terminals should be wired so that carrier is asserted only when the
289 phone line is dialed up.
290 For non-dialup terminals, from which modem control is not available,
291 you must wire back the signals so that
292 the carrier appears to always be present. For further details,
293 find your terminal driver in section 4 of the manual.
295 For network terminals (i.e. pseudo terminals), no program should
296 be started up on the lines. Thus, the normal entry in
302 (Note, the fourth field is not needed here.)
304 When the system is running multi-user, all terminals that are listed in
306 as \fBon\fP have their line enabled.
307 If, during normal operations, you wish
308 to disable a terminal line, you can edit the file
310 to change the terminal's status to \fBoff\fP and
311 then send a hangup signal to the
315 \fB#\fP \fIkill \-1 1\fP
317 Terminals can similarly be enabled by changing the status field
318 from \fBoff\fP to \fBon\fP and sending a hangup signal to
321 Note that if a special file is inaccessible when
323 tries to create a process for it,
325 will log a message to the
326 system error logging process (see
328 and try to reopen the terminal every minute, reprinting the warning
329 message every 10 minutes. Messages of this sort are normally
330 printed on the console, though other actions may occur depending
331 on the configuration information found in
332 .Pn /etc/syslog.conf .
334 Finally note that you should change the names of any dialup
336 where ? is in [0-9a-zA-Z], as some programs use this property of the
337 names to determine if a terminal is a dialup.
338 Shell commands to do this should be put in the
339 .Pn /dev/MAKEDEV.local
342 While it is possible to use truly arbitrary strings for terminal names,
343 the accounting and noticeably the
345 command make good use of the convention that tty names
346 (by default, and also after dialups are named as suggested above)
347 are distinct in the last 2 characters.
348 Change this and you may be sorry later, as the heuristic
350 uses based on these conventions will then break down and
352 will run MUCH slower.
355 The procedure for adding a new user is described in
357 You should add accounts for the initial user community, giving
358 each a directory and a password, and putting users who will wish
359 to share software in the same groups.
361 Several guest accounts have been provided on the distribution
362 system; these accounts are for people at Berkeley,
363 Bell Laboratories, and others
364 who have done major work on UNIX in the past. You can delete these accounts,
365 or leave them on the system if you expect that these people would have
366 occasion to login as guests on your system.
367 .Sh 2 "Site tailoring"
369 All programs that require the site's name, or some similar
370 characteristic, obtain the information through system calls
371 or from files located in
373 Aside from parts of the
374 system related to the network, to tailor the system to your
375 site you must simply select a site name, then edit the file
381 use a variable to set the hostname,
383 hostname=\fImysitename\fP
384 /bin/hostname $hostname
386 to define the value returned by the
388 system call. If you are running the name server, your site
389 name should be your fully qualified domain name. Programs such as
395 use this system call so that the binary images are site
398 You will also need to edit
400 to do the network interface initialization using
402 If you are not sure how to do this, see sections 5.1, 5.2, and 5.3.
403 If you are not running a routing daemon and have
404 more than one Ethernet in your environment
405 you will need to set up a default route;
406 see section 5.4 for details.
407 Before bringing your system up multiuser,
408 you should ensure that the networking is properly configured.
409 The network is started by running
411 Once started, you should test connectivity using
413 You should first test connectivity to yourself,
414 then another host on your Ethernet,
415 and finally a host on another Ethernet.
418 program can be used to inspect and debug
419 your routes; see section 5.4.
420 .Sh 2 "Setting up the line printer system"
422 The line printer system consists of at least
423 the following files and commands:
427 /usr/bin/lpq spooling queue examination program
428 /usr/bin/lprm program to delete jobs from a queue
429 /usr/bin/lpr program to enter a job in a printer queue
430 /etc/printcap printer configuration and capability database
431 /usr/sbin/lpd line printer daemon, scans spooling queues
432 /usr/sbin/lpc line printer control program
433 /etc/hosts.lpd list of host allowed to use the printers
439 is a master database describing line
440 printers directly attached to a machine and, also, printers
441 accessible across a network. The manual page
443 describes the format of this database and also
444 shows the default values for such things as the directory
445 in which spooling is performed. The line printer system handles
446 multiple printers, multiple spooling queues, local and remote
447 printers, and also printers attached via serial lines that require
448 line initialization such as the baud rate. Raster output devices
449 such as a Varian or Versatec, and laser printers such as an Imagen,
450 are also supported by the line printer system.
452 Remote spooling via the network is handled with two spooling
453 queues, one on the local machine and one on the remote machine.
454 When a remote printer job is started with
456 the job is queued locally and a daemon process created to oversee the
457 transfer of the job to the remote machine. If the destination
458 machine is unreachable, the job will remain queued until it is
459 possible to transfer the files to the spooling queue on the
462 program shows the contents of spool
463 queues on both the local and remote machines.
465 To configure your line printers, consult the printcap manual page
466 and the accompanying document, ``4.3BSD Line Printer Spooler Manual'' (SMM:7).
469 program should be present in
471 .Sh 2 "Setting up the mail system"
473 The mail system consists of the following commands:
477 /usr/bin/mail UCB mail program, described in \fImail\fP\|(1)
478 /usr/sbin/sendmail mail routing program
479 /var/spool/mail mail spooling directory
480 /var/spool/secretmail secure mail directory
481 /usr/bin/xsend secure mail sender
482 /usr/bin/xget secure mail receiver
483 /etc/aliases mail forwarding information
484 /usr/bin/newaliases command to rebuild binary forwarding database
485 /usr/bin/biff mail notification enabler
486 /usr/libexec/comsat mail notification daemon
489 Mail is normally sent and received using the
493 which provides a front-end to edit the messages sent
494 and received, and passes the messages to
497 The routing algorithm uses knowledge of the network name syntax,
498 aliasing and forwarding information, and network topology, as
499 defined in the configuration file
500 .Pn /usr/lib/sendmail.cf ,
501 to process each piece of mail.
502 Local mail is delivered by giving it to the program
503 .Pn /usr/libexec/mail.local
504 that adds it to the mailboxes in the directory
505 .Pn /var/spool/mail/<username> ,
506 using a locking protocol to avoid problems with simultaneous updates.
507 After the mail is delivered, the local mail delivery daemon
508 .Pn /usr/libexec/comsat
509 is notified, which in turn notifies users who have issued a
510 ``\fIbiff\fP y'' command that mail has arrived.
512 Mail queued in the directory
514 is normally readable only by the recipient.
515 To send mail that is secure against perusal
516 (except by a code-breaker) you should use the secret mail facility,
517 which encrypts the mail.
519 To set up the mail facility you should read the instructions in the
520 file READ_ME in the directory
521 .Pn /usr/src/usr.sbin/sendmail
522 and then adjust the necessary configuration files.
523 You should also set up the file
525 for your installation, creating mail groups as appropriate.
526 For more informations see
527 ``Sendmail Installation and Operation Guide'' (SMM:8) and
528 ``Sendmail \- An Internetwork Mail Router'' (SMM:9).
529 .Sh 3 "Setting up a UUCP connection"
533 included in \*(4B has the following features:
535 support for many auto call units and dialers
536 in addition to the DEC DN11,
538 breakup of the spooling area into multiple subdirectories,
542 file to control the set
543 of commands that may be executed by a remote site,
545 enhanced ``expect-send'' sequence capabilities when
546 logging in to a remote site,
548 new commands to be used in polling sites and
549 obtaining snap shots of
553 additional protocols for different communication media.
555 This section gives a brief overview of
557 and points out the most important steps in its installation.
559 To connect two UNIX machines with a
561 network link using modems,
562 one site must have an automatic call unit
563 and the other must have a dialup port.
564 It is better if both sites have both.
566 You should first read the paper in the UNIX System Manager's Manual:
567 ``Uucp Implementation Description'' (SMM:14).
568 It describes in detail the file formats and conventions,
569 and will give you a little context.
571 the document ``setup.tblms'',
572 located in the directory
573 .Pn /usr/src/usr.bin/uucp/UUAIDS ,
574 may be of use in tailoring the software to your needs.
578 support is located in three major directories:
582 .Pn /var/spool/uucp .
583 User commands are kept in
585 operational commands in
589 is used as a spooling area.
596 /usr/bin/uucp file-copy command
597 /usr/bin/uux remote execution command
598 /usr/bin/uusend binary file transfer using mail
599 /usr/bin/uuencode binary file encoder (for \fIuusend\fP)
600 /usr/bin/uudecode binary file decoder (for \fIuusend\fP)
601 /usr/bin/uulog scans session log files
602 /usr/bin/uusnap gives a snap-shot of \fIuucp\fP activity
603 /usr/bin/uupoll polls remote system until an answer is received
604 /usr/bin/uuname prints a list of known uucp hosts
605 /usr/bin/uuq gives information about the queue
608 The important files and commands in
614 /usr/lib/uucp/L-devices list of dialers and hard-wired lines
615 /usr/lib/uucp/L-dialcodes dialcode abbreviations
616 /usr/lib/uucp/L.aliases hostname aliases
617 /usr/lib/uucp/L.cmds commands remote sites may execute
618 /usr/lib/uucp/L.sys systems to communicate with, how to connect, and when
619 /usr/lib/uucp/SEQF sequence numbering control file
620 /usr/lib/uucp/USERFILE remote site pathname access specifications
621 /usr/lib/uucp/uucico \fIuucp\fP protocol daemon
622 /usr/lib/uucp/uuclean cleans up garbage files in spool area
623 /usr/lib/uucp/uuxqt \fIuucp\fP remote execution server
626 while the spooling area contains the following important files and directories:
630 /var/spool/uucp/C. directory for command, ``C.'' files
631 /var/spool/uucp/D. directory for data, ``D.'', files
632 /var/spool/uucp/X. directory for command execution, ``X.'', files
633 /var/spool/uucp/D.\fImachine\fP directory for local ``D.'' files
634 /var/spool/uucp/D.\fImachine\fPX directory for local ``X.'' files
635 /var/spool/uucp/TM. directory for temporary, ``TM.'', files
636 /var/spool/uucp/LOGFILE log file of \fIuucp\fP activity
637 /var/spool/uucp/SYSLOG log file of \fIuucp\fP file transfers
644 start by selecting a site name
645 (shorter than 14 characters).
648 account must be created in the password file and a password set up.
650 create the appropriate spooling directories with mode 755
655 If you have an auto-call unit,
656 the L.sys, L-dialcodes, and L-devices files should be created.
657 The L.sys file should contain
658 the phone numbers and login sequences
659 required to establish a connection with a
661 daemon on another machine.
662 For example, our L.sys file looks something like:
664 adiron Any ACU 1200 out0123456789- ogin-EOT-ogin uucp
665 cbosg Never Slave 300
666 cbosgd Never Slave 300
667 chico Never Slave 1200 out2010123456
669 The first field is the name of a site,
670 the second shows when the machine may be called,
671 the third field specifies how the host is connected
672 (through an ACU, a hard-wired line, etc.),
673 then comes the phone number to use in connecting through an auto-call unit,
674 and finally a login sequence.
676 may contain common abbreviations that are defined in the L-dialcodes file.
677 The device specification should refer to devices
678 specified in the L-devices file.
679 Listing only ACU causes the
683 to search for any available auto-call unit in L-devices.
684 Our L-dialcodes file is of the form:
689 while our L-devices file is:
691 ACU cul0 unused 1200 ventel
693 Refer to the README file in the
695 source directory for more information about installation.
699 operates it creates (and removes) many small
700 files in the directories underneath
701 .Pn /var/spool/uucp .
702 Sometimes files are left undeleted;
703 these are most easily purged with the
706 The log files can grow without bound unless trimmed back;
708 maintains these files.
709 Many useful aids in maintaining your
711 installation are included in a subdirectory UUAIDS beneath
712 .Pn /usr/src/usr.bin/uucp .
713 Peruse this directory and read the ``setup'' instructions also located there.
projects / dragonfly.git / blob