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. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)4.t 8.1 (Berkeley) 7/29/93
31 .ds LH "Installing/Operating \*(4B
36 This section describes procedures used to set up a \*(4B UNIX system.
37 These procedures are used when a system is first installed
38 or when the system configuration changes. Procedures for normal
39 system operation are described in the next section.
40 .Sh 2 "Kernel configuration"
42 This section briefly describes the layout of the kernel code and
43 how files for devices are made.
44 For a full discussion of configuring
45 and building system images, consult the document ``Building
46 4.3BSD UNIX Systems with Config'' (SMM:2).
47 .Sh 3 "Kernel organization"
49 As distributed, the kernel source is in a
50 separate tar image. The source may be physically
51 located anywhere within any filesystem so long as
52 a symbolic link to the location is created for the file
56 are normally symbolic links relative to
58 In further discussions of the system source all path names
59 will be given relative to
62 The kernel is made up of several large generic parts:
65 sys main kernel header files
66 kern kernel functions broken down as follows
67 init system startup, syscall dispatching, entry points
68 kern scheduling, descriptor handling and generic I/O
69 sys process management, signals
70 tty terminal handling and job control
71 vfs filesystem management
72 uipc interprocess communication (sockets)
73 subr miscellaneous support routines
74 vm virtual memory management
75 ufs local filesystems broken down as follows
76 ufs common local filesystem routines
78 lfs log-based filesystem
79 mfs memory based filesystem
80 nfs Sun-compatible network filesystem
81 miscfs miscellaneous filesystems broken down as follows
82 deadfs where rejected vnodes go to die
83 fdesc access to per-process file descriptors
84 fifofs IEEE Std1003.1 FIFOs
85 kernfs filesystem access to kernel data structures
86 lofs loopback filesystem
87 nullfs another loopback filesystem
88 specfs device special files
89 umapfs provide alternate uid/gid mappings
90 dev generic device drivers (SCSI, vnode, concatenated disk)
93 The networking code is organized by protocol
96 net routing and generic interface drivers
97 netinet Internet protocols (TCP, UDP, IP, etc)
98 netiso ISO protocols (TP-4, CLNP, CLTP, etc)
99 netns Xerox network systems protocols (IDP, SPP, etc)
100 netx25 CCITT X.25 protocols (X.25 Packet Level, HDLC/LAPB)
103 A separate subdirectory is provided for each machine architecture
106 hp300 HP 9000/300 series of Motorola 68000-based machines
107 hp code common to both HP 68k and (non-existent) PA-RISC ports
108 i386 Intel 386/486-based PC machines
109 luna68k Omron 68000-based workstations
110 news3400 Sony News MIPS-based workstations
111 pmax Digital 3100/5000 MIPS-based workstations
112 sparc Sun Microsystems SPARCstation 1, 1+, and 2
113 tahoe (deprecated) CCI Power 6-series machines
114 vax (deprecated) Digital VAX machines
117 Each machine directory is subdivided by function;
118 for example the hp300 directory contains
121 include exported machine-dependent header files
122 hp300 machine-dependent support code and private header files
124 conf configuration files
125 stand machine-dependent standalone code
128 Other kernel related directories
131 compile area to compile kernels
132 conf machine-independent configuration files
133 stand machine-independent standalone code
135 .Sh 3 "Devices and device drivers"
137 Devices supported by UNIX are implemented in the kernel
138 by drivers whose source is kept in
139 .Pn /sys/<architecture>/dev .
140 These drivers are loaded
141 into the system when included in a cpu specific configuration file
142 kept in the conf directory. Devices are accessed through special
143 files in the filesystem, made by the
145 program and normally kept in the
148 For all the devices supported by the distribution system, the
151 are created by devfs.
153 Determine the set of devices that you have and create a new
155 directory by mounting devfs.
156 .Sh 3 "Building new system images"
158 The kernel configuration of each UNIX system is described by
159 a single configuration file, stored in the
160 .Pn /sys/<architecture>/conf
162 To learn about the format of this file and the procedure used
163 to build system images,
164 start by reading ``Building 4.3BSD UNIX Systems with Config'' (SMM:2),
165 look at the manual pages in section 4
166 of the UNIX manual for the devices you have,
167 and look at the sample configuration files in the
168 .Pn /sys/<architecture>/conf
171 The configured system image
173 should be copied to the root, and then booted to try it out.
174 It is best to name it
176 so as not to destroy the working system until you are sure it does work:
178 \fB#\fP \fIcp kernel /newkernel\fP
181 It is also a good idea to keep the previous system around under some other
182 name. In particular, we recommend that you save the generic distribution
183 version of the system permanently as
185 for use in emergencies.
186 To boot the new version of the system you should follow the
187 bootstrap procedures outlined in section 6.1.
188 After having booted and tested the new system, it should be installed as
190 before going into multiuser operation.
191 A systematic scheme for numbering and saving old versions
192 of the system may be useful.
193 .Sh 2 "Configuring terminals"
195 If UNIX is to support simultaneous
196 access from directly-connected terminals other than the console,
203 To add a new terminal device, be sure the device is configured into the system
204 and that the special files for the device exist in
206 Then, enable the appropriate lines of
208 by setting the ``status''
209 field to \fBon\fP (or add new lines).
212 are one-for-one with entries in the file of current users
215 and therefore it is best to make changes
216 while running in single-user mode
217 and to add all the entries for a new device at once.
221 file is broken into four tab separated
222 fields (comments are shown by a `#' character and extend to
223 the end of the line). For each terminal line the four fields
225 the device (without a leading
229 should startup to service the line
230 (or \fBnone\fP if the line is to be left alone),
231 the terminal type (found in
232 .Pn /usr/share/misc/termcap ),
233 and optional status information describing if the terminal is
234 enabled or not and if it is ``secure'' (i.e. the super user should
235 be allowed to login on the line).
236 If the console is marked as ``insecure'',
237 then the root password is required to bring the machine up single-user.
238 All fields are character strings
239 with entries requiring embedded white space enclosed in double
241 Thus a newly added terminal
245 tty00 "/usr/libexec/getty std.9600" vt100 on secure # mike's office
247 The std.9600 parameter provided to
248 .Pn /usr/libexec/getty
249 is used in searching the file
251 it specifies a terminal's characteristics (such as baud rate).
252 To make custom terminal types, consult
257 Dialup terminals should be wired so that carrier is asserted only when the
258 phone line is dialed up.
259 For non-dialup terminals, from which modem control is not available,
260 you must wire back the signals so that
261 the carrier appears to always be present. For further details,
262 find your terminal driver in section 4 of the manual.
264 For network terminals (i.e. pseudo terminals), no program should
265 be started up on the lines. Thus, the normal entry in
271 (Note, the fourth field is not needed here.)
273 When the system is running multi-user, all terminals that are listed in
275 as \fBon\fP have their line enabled.
276 If, during normal operations, you wish
277 to disable a terminal line, you can edit the file
279 to change the terminal's status to \fBoff\fP and
280 then send a hangup signal to the
284 \fB#\fP \fIkill \-1 1\fP
286 Terminals can similarly be enabled by changing the status field
287 from \fBoff\fP to \fBon\fP and sending a hangup signal to
290 Note that if a special file is inaccessible when
292 tries to create a process for it,
294 will log a message to the
295 system error logging process (see
297 and try to reopen the terminal every minute, reprinting the warning
298 message every 10 minutes. Messages of this sort are normally
299 printed on the console, though other actions may occur depending
300 on the configuration information found in
301 .Pn /etc/syslog.conf .
303 Finally note that you should change the names of any dialup
305 where ? is in [0-9a-zA-Z], as some programs use this property of the
306 names to determine if a terminal is a dialup.
308 While it is possible to use truly arbitrary strings for terminal names,
309 the accounting and noticeably the
311 command make good use of the convention that tty names
312 (by default, and also after dialups are named as suggested above)
313 are distinct in the last 2 characters.
314 Change this and you may be sorry later, as the heuristic
316 uses based on these conventions will then break down and
318 will run MUCH slower.
321 The procedure for adding a new user is described in
323 You should add accounts for the initial user community, giving
324 each a directory and a password, and putting users who will wish
325 to share software in the same groups.
327 Several guest accounts have been provided on the distribution
328 system; these accounts are for people at Berkeley,
329 Bell Laboratories, and others
330 who have done major work on UNIX in the past. You can delete these accounts,
331 or leave them on the system if you expect that these people would have
332 occasion to login as guests on your system.
333 .Sh 2 "Site tailoring"
335 All programs that require the site's name, or some similar
336 characteristic, obtain the information through system calls
337 or from files located in
339 Aside from parts of the
340 system related to the network, to tailor the system to your
341 site you must simply select a site name, then edit the file
347 use a variable to set the hostname,
349 hostname=\fImysitename\fP
350 /bin/hostname $hostname
352 to define the value returned by the
354 system call. If you are running the name server, your site
355 name should be your fully qualified domain name. Programs such as
361 use this system call so that the binary images are site
364 You will also need to edit
366 to do the network interface initialization using
368 If you are not sure how to do this, see sections 5.1, 5.2, and 5.3.
369 If you are not running a routing daemon and have
370 more than one Ethernet in your environment
371 you will need to set up a default route;
372 see section 5.4 for details.
373 Before bringing your system up multiuser,
374 you should ensure that the networking is properly configured.
375 The network is started by running
377 Once started, you should test connectivity using
379 You should first test connectivity to yourself,
380 then another host on your Ethernet,
381 and finally a host on another Ethernet.
384 program can be used to inspect and debug
385 your routes; see section 5.4.
386 .Sh 2 "Setting up the line printer system"
388 The line printer system consists of at least
389 the following files and commands:
393 /usr/bin/lpq spooling queue examination program
394 /usr/bin/lprm program to delete jobs from a queue
395 /usr/bin/lpr program to enter a job in a printer queue
396 /etc/printcap printer configuration and capability database
397 /usr/sbin/lpd line printer daemon, scans spooling queues
398 /usr/sbin/lpc line printer control program
399 /etc/hosts.lpd list of host allowed to use the printers
405 is a master database describing line
406 printers directly attached to a machine and, also, printers
407 accessible across a network. The manual page
409 describes the format of this database and also
410 shows the default values for such things as the directory
411 in which spooling is performed. The line printer system handles
412 multiple printers, multiple spooling queues, local and remote
413 printers, and also printers attached via serial lines that require
414 line initialization such as the baud rate. Raster output devices
415 such as a Varian or Versatec, and laser printers such as an Imagen,
416 are also supported by the line printer system.
418 Remote spooling via the network is handled with two spooling
419 queues, one on the local machine and one on the remote machine.
420 When a remote printer job is started with
422 the job is queued locally and a daemon process created to oversee the
423 transfer of the job to the remote machine. If the destination
424 machine is unreachable, the job will remain queued until it is
425 possible to transfer the files to the spooling queue on the
428 program shows the contents of spool
429 queues on both the local and remote machines.
431 To configure your line printers, consult the printcap manual page
432 and the accompanying document, ``4.3BSD Line Printer Spooler Manual'' (SMM:7).
435 program should be present in
437 .Sh 2 "Setting up the mail system"
439 The mail system consists of the following commands:
443 /usr/bin/mail UCB mail program, described in \fImail\fP\|(1)
444 /usr/sbin/sendmail mail routing program
445 /var/spool/mail mail spooling directory
446 /var/spool/secretmail secure mail directory
447 /usr/bin/xsend secure mail sender
448 /usr/bin/xget secure mail receiver
449 /etc/aliases mail forwarding information
450 /usr/bin/newaliases command to rebuild binary forwarding database
451 /usr/bin/biff mail notification enabler
452 /usr/libexec/comsat mail notification daemon
455 Mail is normally sent and received using the
459 which provides a front-end to edit the messages sent
460 and received, and passes the messages to
463 The routing algorithm uses knowledge of the network name syntax,
464 aliasing and forwarding information, and network topology, as
465 defined in the configuration file
466 .Pn /usr/lib/sendmail.cf ,
467 to process each piece of mail.
468 Local mail is delivered by giving it to the program
469 .Pn /usr/libexec/mail.local
470 that adds it to the mailboxes in the directory
471 .Pn /var/spool/mail/<username> ,
472 using a locking protocol to avoid problems with simultaneous updates.
473 After the mail is delivered, the local mail delivery daemon
474 .Pn /usr/libexec/comsat
475 is notified, which in turn notifies users who have issued a
476 ``\fIbiff\fP y'' command that mail has arrived.
478 Mail queued in the directory
480 is normally readable only by the recipient.
481 To send mail that is secure against perusal
482 (except by a code-breaker) you should use the secret mail facility,
483 which encrypts the mail.
485 To set up the mail facility you should read the instructions in the
486 file READ_ME in the directory
487 .Pn /usr/src/usr.sbin/sendmail
488 and then adjust the necessary configuration files.
489 You should also set up the file
491 for your installation, creating mail groups as appropriate.
492 For more informations see
493 ``Sendmail Installation and Operation Guide'' (SMM:8) and
494 ``Sendmail \- An Internetwork Mail Router'' (SMM:9).
495 .Sh 3 "Setting up a UUCP connection"
499 included in \*(4B has the following features:
501 support for many auto call units and dialers
502 in addition to the DEC DN11,
504 breakup of the spooling area into multiple subdirectories,
508 file to control the set
509 of commands that may be executed by a remote site,
511 enhanced ``expect-send'' sequence capabilities when
512 logging in to a remote site,
514 new commands to be used in polling sites and
515 obtaining snap shots of
519 additional protocols for different communication media.
521 This section gives a brief overview of
523 and points out the most important steps in its installation.
525 To connect two UNIX machines with a
527 network link using modems,
528 one site must have an automatic call unit
529 and the other must have a dialup port.
530 It is better if both sites have both.
532 You should first read the paper in the UNIX System Manager's Manual:
533 ``Uucp Implementation Description'' (SMM:14).
534 It describes in detail the file formats and conventions,
535 and will give you a little context.
537 the document ``setup.tblms'',
538 located in the directory
539 .Pn /usr/src/usr.bin/uucp/UUAIDS ,
540 may be of use in tailoring the software to your needs.
544 support is located in three major directories:
548 .Pn /var/spool/uucp .
549 User commands are kept in
551 operational commands in
555 is used as a spooling area.
562 /usr/bin/uucp file-copy command
563 /usr/bin/uux remote execution command
564 /usr/bin/uusend binary file transfer using mail
565 /usr/bin/uuencode binary file encoder (for \fIuusend\fP)
566 /usr/bin/uudecode binary file decoder (for \fIuusend\fP)
567 /usr/bin/uulog scans session log files
568 /usr/bin/uusnap gives a snap-shot of \fIuucp\fP activity
569 /usr/bin/uupoll polls remote system until an answer is received
570 /usr/bin/uuname prints a list of known uucp hosts
571 /usr/bin/uuq gives information about the queue
574 The important files and commands in
580 /usr/lib/uucp/L-devices list of dialers and hard-wired lines
581 /usr/lib/uucp/L-dialcodes dialcode abbreviations
582 /usr/lib/uucp/L.aliases hostname aliases
583 /usr/lib/uucp/L.cmds commands remote sites may execute
584 /usr/lib/uucp/L.sys systems to communicate with, how to connect, and when
585 /usr/lib/uucp/SEQF sequence numbering control file
586 /usr/lib/uucp/USERFILE remote site pathname access specifications
587 /usr/lib/uucp/uucico \fIuucp\fP protocol daemon
588 /usr/lib/uucp/uuclean cleans up garbage files in spool area
589 /usr/lib/uucp/uuxqt \fIuucp\fP remote execution server
592 while the spooling area contains the following important files and directories:
596 /var/spool/uucp/C. directory for command, ``C.'' files
597 /var/spool/uucp/D. directory for data, ``D.'', files
598 /var/spool/uucp/X. directory for command execution, ``X.'', files
599 /var/spool/uucp/D.\fImachine\fP directory for local ``D.'' files
600 /var/spool/uucp/D.\fImachine\fPX directory for local ``X.'' files
601 /var/spool/uucp/TM. directory for temporary, ``TM.'', files
602 /var/spool/uucp/LOGFILE log file of \fIuucp\fP activity
603 /var/spool/uucp/SYSLOG log file of \fIuucp\fP file transfers
610 start by selecting a site name
611 (shorter than 14 characters).
614 account must be created in the password file and a password set up.
616 create the appropriate spooling directories with mode 755
621 If you have an auto-call unit,
622 the L.sys, L-dialcodes, and L-devices files should be created.
623 The L.sys file should contain
624 the phone numbers and login sequences
625 required to establish a connection with a
627 daemon on another machine.
628 For example, our L.sys file looks something like:
630 adiron Any ACU 1200 out0123456789- ogin-EOT-ogin uucp
631 cbosg Never Slave 300
632 cbosgd Never Slave 300
633 chico Never Slave 1200 out2010123456
635 The first field is the name of a site,
636 the second shows when the machine may be called,
637 the third field specifies how the host is connected
638 (through an ACU, a hard-wired line, etc.),
639 then comes the phone number to use in connecting through an auto-call unit,
640 and finally a login sequence.
642 may contain common abbreviations that are defined in the L-dialcodes file.
643 The device specification should refer to devices
644 specified in the L-devices file.
645 Listing only ACU causes the
649 to search for any available auto-call unit in L-devices.
650 Our L-dialcodes file is of the form:
655 while our L-devices file is:
657 ACU cul0 unused 1200 ventel
659 Refer to the README file in the
661 source directory for more information about installation.
665 operates it creates (and removes) many small
666 files in the directories underneath
667 .Pn /var/spool/uucp .
668 Sometimes files are left undeleted;
669 these are most easily purged with the
672 The log files can grow without bound unless trimmed back;
674 maintains these files.
675 Many useful aids in maintaining your
677 installation are included in a subdirectory UUAIDS beneath
678 .Pn /usr/src/usr.bin/uucp .
679 Peruse this directory and read the ``setup'' instructions also located there.
projects / FreeBSD / FreeBSD.git / blob