From fe79ecbe4d70cad7758daa4c0ebdcea12e3bd317 Mon Sep 17 00:00:00 2001 From: Nik Clayton Date: Thu, 4 Mar 1999 22:42:55 +0000 Subject: [PATCH] Revert one of my previous changes. Sentences now have two spaces after the period. Apologies for the repository bloat. This is entirely a whitespace change. --- en/handbook/advanced-networking/chapter.sgml | 182 +-- en/handbook/backups/chapter.sgml | 222 +-- en/handbook/basics/chapter.sgml | 18 +- en/handbook/bibliography/chapter.sgml | 194 +-- en/handbook/boothelp.sgml | 6 +- en/handbook/contrib/chapter.sgml | 130 +- en/handbook/cutting-edge/chapter.sgml | 442 +++--- en/handbook/disks/chapter.sgml | 78 +- en/handbook/eresources/chapter.sgml | 120 +- en/handbook/handbook.sgml | 12 +- en/handbook/hw/chapter.sgml | 1276 ++++++++--------- en/handbook/install/chapter.sgml | 162 +-- en/handbook/internals/chapter.sgml | 198 +-- en/handbook/introduction/chapter.sgml | 140 +- en/handbook/kernelconfig/chapter.sgml | 322 ++--- en/handbook/kerneldebug/chapter.sgml | 134 +- en/handbook/kernelopts/chapter.sgml | 40 +- en/handbook/l10n/chapter.sgml | 18 +- en/handbook/linuxemu/chapter.sgml | 164 +-- en/handbook/mirrors/chapter.sgml | 20 +- en/handbook/pgpkeys/chapter.sgml | 2 +- en/handbook/policies/chapter.sgml | 66 +- en/handbook/ports/chapter.sgml | 842 +++++------ en/handbook/ppp-and-slip/chapter.sgml | 304 ++-- en/handbook/printing/chapter.sgml | 908 ++++++------ en/handbook/quotas/chapter.sgml | 58 +- en/handbook/security/chapter.sgml | 326 ++--- en/handbook/serialcomms/chapter.sgml | 392 ++--- en/handbook/staff/chapter.sgml | 2 +- .../articles/contributing/article.sgml | 130 +- .../kerneldebug/chapter.sgml | 134 +- .../developers-handbook/policies/chapter.sgml | 66 +- .../handbook/advanced-networking/chapter.sgml | 182 +-- .../books/handbook/backups/chapter.sgml | 222 +-- .../books/handbook/basics/chapter.sgml | 18 +- .../books/handbook/bibliography/chapter.sgml | 194 +-- en_US.ISO8859-1/books/handbook/book.sgml | 12 +- .../books/handbook/contrib/chapter.sgml | 130 +- .../books/handbook/cutting-edge/chapter.sgml | 442 +++--- .../books/handbook/disks/chapter.sgml | 78 +- .../books/handbook/eresources/chapter.sgml | 120 +- .../books/handbook/hw/chapter.sgml | 1276 ++++++++--------- .../books/handbook/install/chapter.sgml | 162 +-- .../books/handbook/introduction/chapter.sgml | 140 +- .../books/handbook/kernelconfig/chapter.sgml | 322 ++--- .../books/handbook/kerneldebug/chapter.sgml | 134 +- .../books/handbook/kernelopts/chapter.sgml | 40 +- .../books/handbook/l10n/chapter.sgml | 18 +- .../books/handbook/linuxemu/chapter.sgml | 164 +-- .../books/handbook/mirrors/chapter.sgml | 20 +- .../books/handbook/pgpkeys/chapter.sgml | 2 +- .../books/handbook/policies/chapter.sgml | 66 +- .../books/handbook/ports/chapter.sgml | 842 +++++------ .../books/handbook/ppp-and-slip/chapter.sgml | 304 ++-- .../books/handbook/printing/chapter.sgml | 908 ++++++------ .../books/handbook/security/chapter.sgml | 326 ++--- .../books/handbook/serialcomms/chapter.sgml | 392 ++--- .../books/handbook/staff/chapter.sgml | 2 +- .../books/porters-handbook/book.sgml | 842 +++++------ .../handbook/advanced-networking/chapter.sgml | 182 +-- .../books/handbook/backups/chapter.sgml | 222 +-- .../books/handbook/basics/chapter.sgml | 18 +- .../books/handbook/bibliography/chapter.sgml | 194 +-- en_US.ISO_8859-1/books/handbook/book.sgml | 12 +- .../books/handbook/contrib/chapter.sgml | 130 +- .../books/handbook/cutting-edge/chapter.sgml | 442 +++--- .../books/handbook/disks/chapter.sgml | 78 +- .../books/handbook/eresources/chapter.sgml | 120 +- .../books/handbook/hw/chapter.sgml | 1276 ++++++++--------- .../books/handbook/install/chapter.sgml | 162 +-- .../books/handbook/internals/chapter.sgml | 198 +-- .../books/handbook/introduction/chapter.sgml | 140 +- .../books/handbook/kernelconfig/chapter.sgml | 322 ++--- .../books/handbook/kerneldebug/chapter.sgml | 134 +- .../books/handbook/kernelopts/chapter.sgml | 40 +- .../books/handbook/l10n/chapter.sgml | 18 +- .../books/handbook/linuxemu/chapter.sgml | 164 +-- .../books/handbook/mirrors/chapter.sgml | 20 +- .../books/handbook/pgpkeys/chapter.sgml | 2 +- .../books/handbook/policies/chapter.sgml | 66 +- .../books/handbook/ports/chapter.sgml | 842 +++++------ .../books/handbook/ppp-and-slip/chapter.sgml | 304 ++-- .../books/handbook/printing/chapter.sgml | 908 ++++++------ .../books/handbook/quotas/chapter.sgml | 58 +- .../books/handbook/security/chapter.sgml | 326 ++--- .../books/handbook/serialcomms/chapter.sgml | 392 ++--- .../books/handbook/staff/chapter.sgml | 2 +- .../books/porters-handbook/book.sgml | 842 +++++------ 88 files changed, 11040 insertions(+), 11040 deletions(-) diff --git a/en/handbook/advanced-networking/chapter.sgml b/en/handbook/advanced-networking/chapter.sgml index 1a2a36d58e..35d5491ae5 100644 --- a/en/handbook/advanced-networking/chapter.sgml +++ b/en/handbook/advanced-networking/chapter.sgml @@ -10,13 +10,13 @@ For one machine to be able to find another, there must be a mechanism in place to describe how to get from one to the other. - This is called Routing. A “route” is a defined pair of addresses: - a “destination” and a “gateway”. The pair indicates that if you are + This is called Routing. A “route” is a defined pair of addresses: + a “destination” and a “gateway”. The pair indicates that if you are trying to get to this destination, send along - through this gateway. There are three types of - destinations: individual hosts, subnets, and “default”. The - “default route” is used if none of the other routes apply. We will - talk a little bit more about default routes later on. There are + through this gateway. There are three types of + destinations: individual hosts, subnets, and “default”. The + “default route” is used if none of the other routes apply. We will + talk a little bit more about default routes later on. There are also three types of gateways: individual hosts, interfaces (also called “links”), and ethernet hardware addresses. @@ -47,20 +47,20 @@ host2.foobar.com link#1 UC 0 0 The interface (Netif column) that it specifies to use for localhost is - lo0, also known as the loopback device. This + lo0, also known as the loopback device. This says to keep all traffic for this destination internal, rather than sending it out over the LAN, since it will only end up back where it started anyway. - The next thing that stands out are the 0:e0:... addresses. These are ethernet - hardware addresses. FreeBSD will automatically identify any hosts + The next thing that stands out are the 0:e0:... addresses. These are ethernet + hardware addresses. FreeBSD will automatically identify any hosts (test0 in the example) on the local ethernet and add a route for that host, directly to it over the - ethernet interface, ed0. There is + ethernet interface, ed0. There is also a timeout (Expire column) associated with this type of route, which is used if we fail to - hear from the host in a specific amount of time. In this case the - route will be automatically deleted. These hosts are identified + hear from the host in a specific amount of time. In this case the + route will be automatically deleted. These hosts are identified using a mechanism known as RIP (Routing Information Protocol), which figures out routes to local hosts based upon a shortest path determination. @@ -69,28 +69,28 @@ host2.foobar.com link#1 UC 0 0 (10.20.30.255 is the broadcast address for the subnet 10.20.30, and foobar.com is the domain name - associated with that subnet). The designation link#1 refers to the first ethernet card in - the machine. You will notice no additional interface is specified + associated with that subnet). The designation link#1 refers to the first ethernet card in + the machine. You will notice no additional interface is specified for those. Both of these groups (local network hosts and local subnets) have their routes automatically configured by a daemon called - routed. If this is not run, then + routed. If this is not run, then only routes which are statically defined (ie. entered explicitly) will exist. The host1 line refers to our - host, which it knows by ethernet address. Since we are the + host, which it knows by ethernet address. Since we are the sending host, FreeBSD knows to use the loopback interface (lo0) rather than sending it out over the ethernet interface. The two host2 lines are an example of what happens when we use an ifconfig alias (see the - section of ethernet for reasons why we would do this). The + section of ethernet for reasons why we would do this). The => symbol after the lo0 interface says that not only are we using the loopback (since this is address also refers to the local - host), but specifically it is an alias. Such routes only show up + host), but specifically it is an alias. Such routes only show up on the host that supports the alias; all other hosts on the local network will simply have a link#1 line for such. @@ -98,8 +98,8 @@ host2.foobar.com link#1 UC 0 0 The final line (destination subnet 224) deals with MultiCasting, which will be covered in a another section. - The other column that we should talk about are the Flags. Each route has different attributes - that are described in the column. Below is a short table of some + The other column that we should talk about are the Flags. Each route has different attributes + that are described in the column. Below is a short table of some of these flags and their meanings: @@ -162,14 +162,14 @@ host2.foobar.com link#1 UC 0 0 When the local system needs to make a connection to remote host, it checks the routing table to determine if a known path - exists. If the remote host falls into a subnet that we know how to + exists. If the remote host falls into a subnet that we know how to reach (Cloned routes), then the system checks to see if it can connect along that interface. If all known paths fail, the system has one last option: the - “default” route. This route is a + “default” route. This route is a special type of gateway route (usually the only one present in the - system), and is always marked with a c in the flags field. For hosts on a + system), and is always marked with a c in the flags field. For hosts on a local area network, this gateway is set to whatever machine has a direct connection to the outside world (whether via PPP link, or your hardware device attached to a dedicated data line). @@ -179,7 +179,7 @@ host2.foobar.com link#1 UC 0 0 the default route will be the gateway machine at your Internet Service Provider's (ISP) site. - Let us look at an example of default routes. This is a common + Let us look at an example of default routes. This is a common configuration: @@ -187,7 +187,7 @@ host2.foobar.com link#1 UC 0 0 The hosts Local1 and Local2 are at your site, with the formed - being your PPP connection to your ISP's Terminal Server. Your ISP + being your PPP connection to your ISP's Terminal Server. Your ISP has a local network at their site, which has, among other things, the server where you connect and a hardware device (T1-GW) attached to the ISP's Internet feed. @@ -227,13 +227,13 @@ host2.foobar.com link#1 UC 0 0 Remember, since the PPP interface is using an address on the ISP's local network for your side of the connection, routes for any other machines on the ISP's local network will be - automatically generated. Hence, you will already know how to reach + automatically generated. Hence, you will already know how to reach the T1-GW machine, so there is no need for the intermediate step of sending traffic to the ISP server. As a final note, it is common to use the address ...1 as the gateway address for your local - network. So (using the same example), if your local class-C + network. So (using the same example), if your local class-C address space was 10.20.30 and your ISP was using 10.9.9 then the default routes would be: @@ -251,20 +251,20 @@ Local1 (10.20.30.1, 10.9.9.30) --> T1-GW (10.9.9.1) There is one other type of configuration that we should cover, and that is a host that sits on two different networks. Technically, any machine functioning as a gateway (in the example - above, using a PPP connection) counts as a dual-homed host. But + above, using a PPP connection) counts as a dual-homed host. But the term is really only used to refer to a machine that sits on two local-area networks. In one case, the machine as two ethernet cards, each having an - address on the separate subnets. Alternately, the machine may only - have one ethernet card, and be using ifconfig aliasing. The former + address on the separate subnets. Alternately, the machine may only + have one ethernet card, and be using ifconfig aliasing. The former is used if two physically separate ethernet networks are in use, the latter if there is one physical network segment, but two logically separate subnets. Either way, routing tables are set up so that each subnet knows that this machine is the defined gateway (inbound route) to - the other subnet. This configuration, with the machine acting as + the other subnet. This configuration, with the machine acting as a Bridge between the two subnets, is often used when we need to implement packet filtering or firewall security in either or both directions. @@ -286,21 +286,21 @@ Local1 (10.20.30.1, 10.9.9.30) --> T1-GW (10.9.9.1) When you get an address space assigned to your site, your service provider will set up their routing tables so that all traffic for your subnet will be sent down your PPP link to your - site. But how do sites across the country know to send to your + site. But how do sites across the country know to send to your ISP? There is a system (much like the distributed DNS information) that keeps track of all assigned address-spaces, and defines their - point of connection to the Internet Backbone. The “Backbone” are + point of connection to the Internet Backbone. The “Backbone” are the main trunk lines that carry Internet traffic across the - country, and around the world. Each backbone machine has a copy of + country, and around the world. Each backbone machine has a copy of a master set of tables, which direct traffic for a particular network to a specific backbone carrier, and from there down the chain of service providers until it reaches your network. It is the task of your service provider to advertise to the backbone sites that they are the point of connection (and thus the - path inward) for your site. This is known as route + path inward) for your site. This is known as route propagation. @@ -309,14 +309,14 @@ Local1 (10.20.30.1, 10.9.9.30) --> T1-GW (10.9.9.1) Troubleshooting Sometimes, there is a problem with routing propagation, and - some sites are unable to connect to you. Perhaps the most useful + some sites are unable to connect to you. Perhaps the most useful command for trying to figure out where a routing is breaking down - is the traceroute8 command. It is equally + is the traceroute8 command. It is equally useful if you cannot seem to make a connection to a remote machine - (ie. ping8 fails). + (ie. ping8 fails). The traceroute8 command is run with the - name of the remote host you are trying to connect to. It will show + name of the remote host you are trying to connect to. It will show the gateway hosts along the path of the attempt, eventually either reaching the target host, or terminating because of a lack of connection. @@ -339,38 +339,38 @@ Local1 (10.20.30.1, 10.9.9.30) --> T1-GW (10.9.9.1) The problem nearly always occurs when (FreeBSD) PC systems are networked with high-performance workstations, such as those made by - Silicon Graphics, Inc., and Sun Microsystems, Inc. The NFS mount + Silicon Graphics, Inc., and Sun Microsystems, Inc. The NFS mount will work fine, and some operations may succeed, but suddenly the server will seem to become unresponsive to the client, even though - requests to and from other systems continue to be processed. This + requests to and from other systems continue to be processed. This happens to the client system, whether the client is the FreeBSD - system or the workstation. On many systems, there is no way to shut + system or the workstation. On many systems, there is no way to shut down the client gracefully once this problem has manifested itself. The only solution is often to reset the client, because the NFS situation cannot be resolved. Though the “correct” solution is to get a higher performance and capacity Ethernet adapter for the FreeBSD system, there is a simple - workaround that will allow satisfactory operation. If the FreeBSD + workaround that will allow satisfactory operation. If the FreeBSD system is the server, include the option on the mount from - the client. If the FreeBSD system is the client, then mount the NFS - file system with the option . These options may be + the client. If the FreeBSD system is the client, then mount the NFS + file system with the option . These options may be specified using the fourth field of the fstab entry on the client for automatic mounts, or by using the parameter of the mount command for manual mounts. It should be noted that there is a different problem, sometimes mistaken for this one, when the NFS servers and clients are on - different networks. If that is the case, make certain that your + different networks. If that is the case, make certain that your routers are routing the necessary UDP information, or you will not get anywhere, no matter what else you are doing. In the following examples, fastws is the host (interface) name of a high-performance workstation, and freebox is the host (interface) name of a FreeBSD system with a lower-performance - Ethernet adapter. Also, /sharedfs will be the exported NFS + Ethernet adapter. Also, /sharedfs will be the exported NFS filesystem (see man exports), and /project will be the mount - point on the client for the exported file system. In all cases, + point on the client for the exported file system. In all cases, note that additional options, such as or and may be desirable in your application. @@ -402,18 +402,18 @@ freebox:/sharedfs /project nfs rw,-w=1024 0 0 the above restrictions on the read or write size. For anyone who cares, here is what happens when the failure - occurs, which also explains why it is unrecoverable. NFS typically + occurs, which also explains why it is unrecoverable. NFS typically works with a “block” size of 8k (though it may do fragments of - smaller sizes). Since the maximum Ethernet packet is around 1500 + smaller sizes). Since the maximum Ethernet packet is around 1500 bytes, the NFS “block” gets split into multiple Ethernet packets, even though it is still a single unit to the upper-level code, and - must be received, assembled, and acknowledged as a unit. The + must be received, assembled, and acknowledged as a unit. The high-performance workstations can pump out the packets which comprise the NFS unit one right after the other, just as close - together as the standard allows. On the smaller, lower capacity + together as the standard allows. On the smaller, lower capacity cards, the later packets overrun the earlier packets of the same unit before they can be transferred to the host and the unit as a - whole cannot be reconstructed or acknowledged. As a result, the + whole cannot be reconstructed or acknowledged. As a result, the workstation will time out and try again, but it will try again with the entire 8K unit, and the process will be repeated, ad infinitum. @@ -425,7 +425,7 @@ freebox:/sharedfs /project nfs rw,-w=1024 0 0 Overruns may still occur when a high-performance workstations is slamming data out to a PC system, but with the better cards, such - overruns are not guaranteed on NFS “units”. When an overrun occurs, + overruns are not guaranteed on NFS “units”. When an overrun occurs, the units affected will be retransmitted, and there will be a fair chance that they will be received, assembled, and acknowledged. @@ -438,8 +438,8 @@ freebox:/sharedfs /project nfs rw,-w=1024 0 0 netboot.com/netboot.rom allow you to boot your FreeBSD machine over the network and run FreeBSD without having - a disk on your client. Under 2.0 it is now possible to have local - swap. Swapping over NFS is also still supported. + a disk on your client. Under 2.0 it is now possible to have local + swap. Swapping over NFS is also still supported. Supported Ethernet cards include: Western Digital/SMC 8003, 8013, 8216 and compatibles; NE1000/NE2000 and compatibles (requires @@ -453,7 +453,7 @@ freebox:/sharedfs /project nfs rw,-w=1024 0 0 - Find a machine that will be your server. This machine + Find a machine that will be your server. This machine will require enough disk space to hold the FreeBSD 2.0 binaries and have bootp, tftp and NFS services available. Tested machines: @@ -466,7 +466,7 @@ freebox:/sharedfs /project nfs rw,-w=1024 0 0 - Sun/Solaris 2.3. (you may need to get + Sun/Solaris 2.3. (you may need to get bootp) @@ -492,12 +492,12 @@ diskless:\ Set up a TFTP server (on same machine as bootp server) - to provide booting information to client. The name of this + to provide booting information to client. The name of this file is cfg.X.X.X.X (or /tftpboot/cfg.X.X.X.X, it will try both) where X.X.X.X is the IP address - of the client. The contents of this file can be any valid - netboot commands. Under 2.0, netboot has the following + of the client. The contents of this file can be any valid + netboot commands. Under 2.0, netboot has the following commands: @@ -611,7 +611,7 @@ hostname myclient.mydomain If you are swapping over NFS (completely diskless configuration) create a swap file for your client using - dd. If your swapfs command has the arguments + dd. If your swapfs command has the arguments /swapfs and the size 20000 as in the example above, the swapfile for myclient will be called /swapfs/swap.X.X.X.X where @@ -650,7 +650,7 @@ hostname myclient.mydomain When extracting /dev in /rootfs/myclient, beware that some systems (HPUX) will not create device files that - FreeBSD is happy with. You may have to go to single + FreeBSD is happy with. You may have to go to single user mode on the first bootup (press control-c during the bootup phase), cd /dev and do a sh ./MAKEDEV all @@ -679,7 +679,7 @@ hostname myclient.mydomain At present there isn't an officially sanctioned way of doing this, although I have been using a shared /usr filesystem and individual - / filesystems for each client. If anyone has + / filesystems for each client. If anyone has any suggestions on how to do this cleanly, please let me and/or the &a.core; know. @@ -690,7 +690,7 @@ hostname myclient.mydomain Netboot can be compiled to support NE1000/2000 cards by changing the configuration in - /sys/i386/boot/netboot/Makefile. See the + /sys/i386/boot/netboot/Makefile. See the comments at the top of this file. @@ -718,7 +718,7 @@ hostname myclient.mydomain If you are planning to use ISDN primarily to connect to the Internet with an Internet Provider on a dialup non-dedicated basis, I suggest you look into Terminal - Adapters. This will give you the most flexibility, with the + Adapters. This will give you the most flexibility, with the fewest problems, if you change providers. @@ -731,7 +731,7 @@ hostname myclient.mydomain Cost is a significant factor in determining what solution you - will choose. The following options are listed from least expensive + will choose. The following options are listed from least expensive to most expensive. @@ -741,10 +741,10 @@ hostname myclient.mydomain Contributed by &a.hm;. This section is really only relevant to ISDN users in countries - where the DSS1/Q.931 ISDN standard is supported. + where the DSS1/Q.931 ISDN standard is supported. Some growing number of PC ISDN cards are supported under FreeBSD - 2.2.x and up by the isdn4bsd driver package. It is still under + 2.2.x and up by the isdn4bsd driver package. It is still under development but the reports show that it is successfully used all over Europe. @@ -753,17 +753,17 @@ hostname myclient.mydomain the main isdn4bsd ftp site (you have to log in as user isdn4bsd , give your mail address as the password and change to the pub - directory. Anonymous ftp as user ftp or + directory. Anonymous ftp as user ftp or anonymous will not give the desired result). Isdn4bsd allows you to connect to other ISDN routers using - either IP over raw HDLC or by using synchronous PPP. A telephone + either IP over raw HDLC or by using synchronous PPP. A telephone answering machine application is also available. Many ISDN PC cards are supported, mostly the ones with a Siemens ISDN chipset (ISAC/HSCX), support for other chipsets (from Motorola, - Cologne Chip Designs) is currently under development. For an + Cologne Chip Designs) is currently under development. For an up-to-date list of supported cards, please have a look at the README file. @@ -773,7 +773,7 @@ hostname myclient.mydomain enhancing isdn4bsd, please get in touch with hm@kts.org. - A majordomo maintained mailing list is available. To join the + A majordomo maintained mailing list is available. To join the list, send mail to majordomo@FreeBSD.ORG and specify: @@ -794,21 +794,21 @@ subscribe freebsd-isdn A TA will operate basically the same as a modem except connection and throughput speeds will be much faster than your old - modem. You will need to configure PPP + modem. You will need to configure PPP exactly the - same as for a modem setup. Make sure you set your serial speed as + same as for a modem setup. Make sure you set your serial speed as high as possible. The main advantage of using a TA to connect to an Internet - Provider is that you can do Dynamic PPP. As IP address space + Provider is that you can do Dynamic PPP. As IP address space becomes more and more scarce, most providers are not willing to - provide you with a static IP anymore. Most standalone routers are + provide you with a static IP anymore. Most standalone routers are not able to accommodate dynamic IP allocation. TA's completely rely on the PPP daemon that you are running - for their features and stability of connection. This allows you + for their features and stability of connection. This allows you to upgrade easily from using a modem to ISDN on a FreeBSD machine, - if you already have PPP setup. However, at the same time any + if you already have PPP setup. However, at the same time any problems you experienced with the PPP program and are going to persist. @@ -850,8 +850,8 @@ subscribe freebsd-isdn the TA to a synchronous serial card. Do not be fooled into buying an internal TA and thinking you - have avoided the synchronous/asynchronous issue. Internal TA's - simply have a standard PC serial port chip built into them. All + have avoided the synchronous/asynchronous issue. Internal TA's + simply have a standard PC serial port chip built into them. All this will do, is save you having to buy another serial cable, and find another empty electrical socket. @@ -860,8 +860,8 @@ subscribe freebsd-isdn probably more flexible. The choice of sync/TA vs standalone router is largely a - religious issue. There has been some discussion of this in the - mailing lists. I suggest you search the archives for the complete discussion. @@ -871,7 +871,7 @@ subscribe freebsd-isdn Standalone ISDN Bridges/Routers ISDN bridges or routers are not at all specific to FreeBSD or - any other operating system. For a more complete description of + any other operating system. For a more complete description of routing and bridging technology, please refer to a Networking reference book. @@ -879,10 +879,10 @@ subscribe freebsd-isdn interchangeably. As the cost of low end ISDN routers/bridges comes down, it - will likely become a more and more popular choice. An ISDN router + will likely become a more and more popular choice. An ISDN router is a small box that plugs directly into your local Ethernet network(or card), and manages its own connection to the other - bridge/router. It has all the software to do PPP and other + bridge/router. It has all the software to do PPP and other protocols built in. A router will allow you much faster throughput that a standard @@ -890,13 +890,13 @@ subscribe freebsd-isdn connection. The main problem with ISDN routers and bridges is that - interoperability between manufacturers can still be a problem. If + interoperability between manufacturers can still be a problem. If you are planning to connect to an Internet provider, I recommend that you discuss your needs with them. If you are planning to connect two lan segments together, ie: home lan to the office lan, this is the simplest lowest - maintenance solution. Since you are buying the equipment for both + maintenance solution. Since you are buying the equipment for both sides of the connection you can be assured that the link will work. @@ -907,7 +907,7 @@ subscribe freebsd-isdn Branch office or Home network - Network is 10 Base T Ethernet. Connect router to network + Network is 10 Base T Ethernet. Connect router to network cable with AUI/10BT transceiver, if necessary. @@ -949,7 +949,7 @@ ISDN BRI line One large advantage of most routers/bridges is that they allow you to have 2 separate independent PPP connections to 2 separate - sites at the same time. This is not supported on most TA's, + sites at the same time. This is not supported on most TA's, except for specific(expensive) models that have two serial ports. Do not confuse this with channel bonding, MPP etc. @@ -958,7 +958,7 @@ ISDN BRI line to tap into it, but don't want to get another ISDN line at work. A router at the office location can manage a dedicated B channel connection (64Kbs) to the internet, as well as a use the other B - channel for a separate data connection. The second B channel can + channel for a separate data connection. The second B channel can be used for dialin, dialout or dynamically bond(MPP etc.) with the first B channel for more bandwidth. diff --git a/en/handbook/backups/chapter.sgml b/en/handbook/backups/chapter.sgml index d0bc0b1d65..58eda9d816 100644 --- a/en/handbook/backups/chapter.sgml +++ b/en/handbook/backups/chapter.sgml @@ -9,7 +9,7 @@ impossible to provide a exhaustive listing of hardware that FreeBSD supports, this section serves as a catalog of the device drivers included with FreeBSD and the hardware each drivers supports. Where possible and - appropriate, notes about specific products are included. You may also want + appropriate, notes about specific products are included. You may also want to refer to the kernel configuration file section in this handbook for a list of supported devices. @@ -41,22 +41,22 @@ Storage) 4mm tapes are replacing QIC as the workstation backup media of - choice. This trend accelerated greatly when Conner purchased Archive, + choice. This trend accelerated greatly when Conner purchased Archive, a leading manufacturer of QIC drives, and then stopped production of - QIC drives. 4mm drives are small and quiet but do not have the - reputation for reliability that is enjoyed by 8mm drives. The + QIC drives. 4mm drives are small and quiet but do not have the + reputation for reliability that is enjoyed by 8mm drives. The cartridges are less expensive and smaller (3 x 2 x 0.5 inches, 76 x 51 - x 12 mm) than 8mm cartridges. 4mm, like 8mm, has comparatively short + x 12 mm) than 8mm cartridges. 4mm, like 8mm, has comparatively short head life for the same reason, both use helical scan. Data thruput on these drives starts ~150kB/s, peaking at ~500kB/s. - Data capacity starts at 1.3 GB and ends at 2.0 GB. Hardware + Data capacity starts at 1.3 GB and ends at 2.0 GB. Hardware compression, available with most of these drives, approximately - doubles the capacity. Multi-drive tape library units can have 6 drives - in a single cabinet with automatic tape changing. Library capacities + doubles the capacity. Multi-drive tape library units can have 6 drives + in a single cabinet with automatic tape changing. Library capacities reach 240 GB. - 4mm drives, like 8mm drives, use helical-scan. All the benefits + 4mm drives, like 8mm drives, use helical-scan. All the benefits and drawbacks of helical-scan apply to both 4mm and 8mm drives. Tapes should be retired from use after 2,000 passes or 100 full @@ -67,23 +67,23 @@ 8mm (Exabyte) 8mm tapes are the most common SCSI tape drives; they are the best - choice of exchanging tapes. Nearly every site has an exabyte 2 GB 8mm - tape drive. 8mm drives are reliable, convenient and quiet. Cartridges + choice of exchanging tapes. Nearly every site has an exabyte 2 GB 8mm + tape drive. 8mm drives are reliable, convenient and quiet. Cartridges are inexpensive and small (4.8 x 3.3 x 0.6 inches; 122 x 84 x 15 mm). One downside of 8mm tape is relatively short head and tape life due to the high rate of relative motion of the tape across the heads. - Data thruput ranges from ~250kB/s to ~500kB/s. Data sizes start at - 300 MB and go up to 7 GB. Hardware compression, available with most of - these drives, approximately doubles the capacity. These drives are + Data thruput ranges from ~250kB/s to ~500kB/s. Data sizes start at + 300 MB and go up to 7 GB. Hardware compression, available with most of + these drives, approximately doubles the capacity. These drives are available as single units or multi-drive tape libraries with 6 drives - and 120 tapes in a single cabinet. Tapes are changed automatically by - the unit. Library capacities reach 840+ GB. + and 120 tapes in a single cabinet. Tapes are changed automatically by + the unit. Library capacities reach 840+ GB. Data is recorded onto the tape using helical-scan, the heads are - positioned at an angle to the media (approximately 6 degrees). The - tape wraps around 270 degrees of the spool that holds the heads. The - spool spins while the tape slides over the spool. The result is a high + positioned at an angle to the media (approximately 6 degrees). The + tape wraps around 270 degrees of the spool that holds the heads. The + spool spins while the tape slides over the spool. The result is a high density of data and closely packed tracks that angle across the tape from one edge to the other. @@ -92,31 +92,31 @@ QIC QIC-150 tapes and drives are, perhaps, the most common tape drive - and media around. QIC tape drives are the least expensive "serious" - backup drives. The downside is the cost of media. QIC tapes are + and media around. QIC tape drives are the least expensive "serious" + backup drives. The downside is the cost of media. QIC tapes are expensive compared to 8mm or 4mm tapes, up to 5 times the price per GB - data storage. But, if your needs can be satisfied with a half-dozen - tapes, QIC may be the correct choice. QIC is the - most common tape drive. Every site has a QIC - drive of some density or another. Therein lies the rub, QIC has a + data storage. But, if your needs can be satisfied with a half-dozen + tapes, QIC may be the correct choice. QIC is the + most common tape drive. Every site has a QIC + drive of some density or another. Therein lies the rub, QIC has a large number of densities on physically similar (sometimes identical) - tapes. QIC drives are not quiet. These drives audibly seek before they + tapes. QIC drives are not quiet. These drives audibly seek before they begin to record data and are clearly audible whenever reading, writing - or seeking. QIC tapes measure (6 x 4 x 0.7 inches; 15.2 x 10.2 x 1.7 - mm). Mini-cartridges, - which also use 1/4" wide tape are discussed separately. Tape libraries + or seeking. QIC tapes measure (6 x 4 x 0.7 inches; 15.2 x 10.2 x 1.7 + mm). Mini-cartridges, + which also use 1/4" wide tape are discussed separately. Tape libraries and changers are not available. - Data thruput ranges from ~150kB/s to ~500kB/s. Data capacity - ranges from 40 MB to 15 GB. Hardware compression is available on many - of the newer QIC drives. QIC drives are less frequently installed; + Data thruput ranges from ~150kB/s to ~500kB/s. Data capacity + ranges from 40 MB to 15 GB. Hardware compression is available on many + of the newer QIC drives. QIC drives are less frequently installed; they are being supplanted by DAT drives. - Data is recorded onto the tape in tracks. The tracks run along the - long axis of the tape media from one end to the other. The number of + Data is recorded onto the tape in tracks. The tracks run along the + long axis of the tape media from one end to the other. The number of tracks, and therefore the width of a track, varies with the tape's - capacity. Most if not all newer drives provide backward-compatibility - at least for reading (but often also for writing). QIC has a good + capacity. Most if not all newer drives provide backward-compatibility + at least for reading (but often also for writing). QIC has a good reputation regarding the safety of the data (the mechanics are simpler and more robust than for helical scan drives). @@ -133,25 +133,25 @@ DLT DLT has the fastest data transfer rate of all the drive types - listed here. The 1/2" (12.5mm) tape is contained in a single spool - cartridge (4 x 4 x 1 inches; 100 x 100 x 25 mm). The cartridge has a - swinging gate along one entire side of the cartridge. The drive - mechanism opens this gate to extract the tape leader. The tape leader - has an oval hole in it which the drive uses to "hook" the tape. The - take-up spool is located inside the tape drive. All the other tape + listed here. The 1/2" (12.5mm) tape is contained in a single spool + cartridge (4 x 4 x 1 inches; 100 x 100 x 25 mm). The cartridge has a + swinging gate along one entire side of the cartridge. The drive + mechanism opens this gate to extract the tape leader. The tape leader + has an oval hole in it which the drive uses to "hook" the tape. The + take-up spool is located inside the tape drive. All the other tape cartridges listed here (9 track tapes are the only exception) have both the supply and take-up spools located inside the tape cartridge itself. Data thruput is approximately 1.5MB/s, three times the thruput of - 4mm, 8mm, or QIC tape drives. Data capacities range from 10GB to 20GB - for a single drive. Drives are available in both multi-tape changers + 4mm, 8mm, or QIC tape drives. Data capacities range from 10GB to 20GB + for a single drive. Drives are available in both multi-tape changers and multi-tape, multi-drive tape libraries containing from 5 to 900 tapes over 1 to 20 drives, providing from 50GB to 9TB of storage. Data is recorded onto the tape in tracks parallel to the direction - of travel (just like QIC tapes). Two tracks are written at once. + of travel (just like QIC tapes). Two tracks are written at once. Read/write head lifetimes are relatively long; once the tape stops moving, there is no relative motion between the heads and the tape. @@ -161,7 +161,7 @@ Using a new tape for the first time The first time that you try to read or write a new, -completely blank tape, the operation will fail. The console +completely blank tape, the operation will fail. The console messages should be similar to: @@ -171,7 +171,7 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready The tape does not contain an Identifier Block (block number 0). All QIC tape drives since the adoption of QIC-525 standard write an - Identifier Block to the tape. There are two solutions: + Identifier Block to the tape. There are two solutions: mt fsf 1 causes the tape drive to write an Identifier Block to the tape. @@ -220,7 +220,7 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready and restore 8 - are the traditional Unix backup programs. They operate + are the traditional Unix backup programs. They operate on the drive as a collection of disk blocks, below the abstractions of files, links and directories that are created by the filesystems. @@ -237,13 +237,13 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready 8 does not write files and directories to tape, but rather writes the data blocks that are the building blocks of files - and directories. + and directories. dump 8 has quirks that remain from its early days in - Version 6 of ATT Unix (circa 1975). The default parameters are + Version 6 of ATT Unix (circa 1975). The default parameters are suitable for 9-track tapes (6250 bpi), not the high-density media - available today (up to 62,182 ftpi). These defaults must be overridden + available today (up to 62,182 ftpi). These defaults must be overridden on the command line to utilize the capacity of current tape drives. @@ -253,28 +253,28 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready and rrestore 8 backup data across the - network to a tape drive attached to another computer. Both programs + network to a tape drive attached to another computer. Both programs rely upon rcmd 3 and ruserok 3 to access the remote tape - drive. Therefore, the user performing the backup must have - rhosts access to the remote computer. The + drive. Therefore, the user performing the backup must have + rhosts access to the remote computer. The arguments to rdump 8 and rrestore 8 - must suitable to use on the remote computer. (e.g. + must suitable to use on the remote computer. (e.g. When rdump'ing from a FreeBSD computer to an Exabyte tape drive connected to a Sun called komodo, use: /sbin/rdump 0dsbfu 54000 13000 126 komodo:/dev/nrst8 /dev/rsd0a 2>&1) Beware: there are security implications to allowing rhosts - commands. Evaluate your situation carefully. + commands. Evaluate your situation carefully. @@ -284,7 +284,7 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready tar 1 also dates back to Version 6 of ATT Unix (circa - 1975). + 1975). tar 1 operates in cooperation with the filesystem; @@ -309,21 +309,21 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready Most versions of tar 1 - do not support backups across the network. The GNU + do not support backups across the network. The GNU version of tar 1, which FreeBSD utilizes, supports remote devices using the same syntax as - rdump. To + rdump. To tar 1 to an Exabyte tape drive connected to a Sun called komodo, use: /usr/bin/tar cf komodo:/dev/nrst8 . - 2>&1. For versions without remote device support, + 2>&1. For versions without remote device support, you can use a pipeline and rsh 1 to send the data to a - remote tape drive. (XXX add an example command) + remote tape drive. (XXX add an example command) @@ -332,15 +332,15 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready cpio 1 is the original Unix - file interchange tape program for magnetic media. + file interchange tape program for magnetic media. cpio 1 has options (among many others) to perform byte-swapping, write a number of different - archives format, and pipe the data to other programs. This last + archives format, and pipe the data to other programs. This last feature makes cpio 1 and excellent choice for - installation media. + installation media. cpio 1 does not know how to walk the directory tree and a list of files must be provided thru @@ -349,10 +349,10 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready cpio 1 does not support backups - across the network. You can use a pipeline and + across the network. You can use a pipeline and rsh 1 to send the data to a - remote tape drive. (XXX add an example command) + remote tape drive. (XXX add an example command) @@ -361,12 +361,12 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready pax 1 is IEEE/POSIX's answer to - tar and cpio. Over the years the + tar and cpio. Over the years the various versions of tar and cpio - have gotten slightly incompatible. So rather than fight it out to + have gotten slightly incompatible. So rather than fight it out to fully standardize them, POSIX created a new archive utility. pax attempts to read and write many of the various - cpio and tar formats, plus new formats of its own. Its command set + cpio and tar formats, plus new formats of its own. Its command set more resembles cpio than tar. @@ -376,23 +376,23 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready Amanda (Advanced Maryland Network Disk Archiver) is a client/server backup - system, rather than a single program. An Amanda server will backup to + system, rather than a single program. An Amanda server will backup to a single tape drive any number of computers that have Amanda clients - and network communications with the Amanda server. A common problem at + and network communications with the Amanda server. A common problem at locations with a number of large disks is the length of time required to backup to data directly to tape exceeds the amount of time - available for the task. Amanda solves this problem. Amanda can use a - "holding disk" to backup several filesystems at the same time. Amanda + available for the task. Amanda solves this problem. Amanda can use a + "holding disk" to backup several filesystems at the same time. Amanda creates "archive sets": a group of tapes used over a period of time to create full backups of all the filesystems listed in Amanda's - configuration file. The "archive set" also contains nightly + configuration file. The "archive set" also contains nightly incremental (or differential) backups of all the filesystems. Restoring a damaged filesystem requires the most recent full backup and the incremental backups. The configuration file provides fine control backups and the - network traffic that Amanda generates. Amanda will use any of the - above backup programs to write the data to tape. Amanda is available + network traffic that Amanda generates. Amanda will use any of the + above backup programs to write the data to tape. Amanda is available as either a port or a package, it is not installed by default. @@ -400,22 +400,22 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready Do nothing “Do nothing” is not a computer program, but it is the - most widely used backup strategy. There are no initial costs. There is - no backup schedule to follow. Just say no. If something happens to + most widely used backup strategy. There are no initial costs. There is + no backup schedule to follow. Just say no. If something happens to your data, grin and bear it! If your time and your data is worth little to nothing, then “Do nothing” is the most suitable backup program for your - computer. But beware, Unix is a useful tool, you may find that within + computer. But beware, Unix is a useful tool, you may find that within six months you have a collection of files that are valuable to you. “Do nothing” is the correct backup method for /usr/obj and other directory trees that can be - exactly recreated by your computer. An example is the files that + exactly recreated by your computer. An example is the files that comprise these handbook pages-they have been generated from - SGML input files. Creating backups of these - HTML files is not necessary. The + SGML input files. Creating backups of these + HTML files is not necessary. The SGML source files are backed up regularly. @@ -426,17 +426,17 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready dump 8 Period. Elizabeth D. Zwicky torture tested all the backup programs discussed - here. The clear choice for preserving all your data and all the + here. The clear choice for preserving all your data and all the peculiarities of Unix filesystems is dump - 8. Elizabeth created + 8. Elizabeth created filesystems containing a large variety of unusual conditions (and some not so unusual ones) and tested each program by do a backup and - restore of that filesystems. The peculiarities included: files with + restore of that filesystems. The peculiarities included: files with holes, files with holes and a block of nulls, files with funny characters in their names, unreadable and unwritable files, devices, files that change size during the backup, files that are - created/deleted during the backup and more. She presented the results + created/deleted during the backup and more. She presented the results at LISA V in Oct. 1991. See torture-testing Backup and Archive Programs. @@ -457,14 +457,14 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready Second, determine that the boot and fixit floppies (boot.flp and fixit.flp) - have all your devices. The easiest way to check is to reboot your + have all your devices. The easiest way to check is to reboot your machine with the boot floppy in the floppy drive and check the boot - messages. If all your devices are listed and functional, skip on to + messages. If all your devices are listed and functional, skip on to step three. Otherwise, you have to create two custom bootable floppies which has a kernel that can mount your all of your disks and - access your tape drive. These floppies must contain: + access your tape drive. These floppies must contain: fdisk 8, @@ -474,7 +474,7 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready 8, mount 8, and whichever backup - program you use. These programs must be statically linked. If you + program you use. These programs must be statically linked. If you use dump 8, the floppy must contain @@ -482,25 +482,25 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready restore 8. - Third, create backup tapes regularly. Any changes that you make - after your last backup may be irretrievably lost. Write-protect the + Third, create backup tapes regularly. Any changes that you make + after your last backup may be irretrievably lost. Write-protect the backup tapes. Fourth, test the floppies (either boot.flp and fixit.flp or the two custom bootable - floppies you made in step two.) and backup tapes. Make notes of the - procedure. Store these notes with the bootable floppy, the printouts - and the backup tapes. You will be so distraught when restoring that + floppies you made in step two.) and backup tapes. Make notes of the + procedure. Store these notes with the bootable floppy, the printouts + and the backup tapes. You will be so distraught when restoring that the notes may prevent you from destroying your backup tapes (How? In place of tar xvf /dev/rst0, you might accidently type tar cvf /dev/rst0 and over-write your backup tape). For an added measure of security, make bootable floppies and two - backup tapes each time. Store one of each at a remote location. A - remote location is NOT the basement of the same office building. A + backup tapes each time. Store one of each at a remote location. A + remote location is NOT the basement of the same office building. A number of firms in the World Trade Center learned this lesson the - hard way. A remote location should be physically separated from your + hard way. A remote location should be physically separated from your computers and disk drives by a significant distance. An example script for creating a bootable floppy: @@ -666,20 +666,20 @@ chmod 644 /mnt/etc/passwd doing regular backups so there is no need to worry about the software. - If the hardware has been damaged. First, replace those parts + If the hardware has been damaged. First, replace those parts that have been damaged. - If your hardware is okay, check your floppies. If you are using + If your hardware is okay, check your floppies. If you are using a custom boot floppy, boot single-user (type -s - at the boot: prompt). Skip the following + at the boot: prompt). Skip the following paragraph. If you are using the boot.flp and - fixit.flp floppies, keep reading. Insert the + fixit.flp floppies, keep reading. Insert the boot.flp floppy in the first floppy drive and - boot the computer. The original install menu will be displayed on - the screen. Select the Fixit--Repair mode with CDROM or - floppy. option. Insert the + boot the computer. The original install menu will be displayed on + the screen. Select the Fixit--Repair mode with CDROM or + floppy. option. Insert the fixit.flp when prompted. restore and the other programs that you need are located in /mnt2/stand. @@ -690,23 +690,23 @@ chmod 644 /mnt/etc/passwd mount 8 (e.g. mount /dev/sd0a - /mnt) the root partition of your first disk. If the + /mnt) the root partition of your first disk. If the disklabel was damaged, use disklabel 8 to re-partition and - label the disk to match the label that your printed and saved. Use + label the disk to match the label that your printed and saved. Use newfs 8 to re-create the - filesystems. Re-mount the root partition of the floppy read-write - (mount -u -o rw /mnt). Use your backup program + filesystems. Re-mount the root partition of the floppy read-write + (mount -u -o rw /mnt). Use your backup program and backup tapes to recover the data for this filesystem (e.g. - restore vrf /dev/st0). Unmount the filesystem + restore vrf /dev/st0). Unmount the filesystem (e.g. umount /mnt) Repeat for each filesystem that was damaged. Once your system is running, backup your data onto new tapes. - Whatever caused the crash or data loss may strike again. An another + Whatever caused the crash or data loss may strike again. An another hour spent now, may save you from further distress later. diff --git a/en/handbook/basics/chapter.sgml b/en/handbook/basics/chapter.sgml index 4fd4f4b9fd..685547733f 100644 --- a/en/handbook/basics/chapter.sgml +++ b/en/handbook/basics/chapter.sgml @@ -6,11 +6,11 @@ The Online Manual The most comprehensive documentation on FreeBSD is in the form - of man pages. Nearly every program on the + of man pages. Nearly every program on the system comes with a short reference manual explaining the basic - operation and various arguments. These manuals can be view with the + operation and various arguments. These manuals can be view with the man - command. Use of the man command is simple: + command. Use of the man command is simple: &prompt.user; man command @@ -18,7 +18,7 @@ command is - the name of the command you wish to learn about. For example, to + the name of the command you wish to learn about. For example, to learn more about ls command type: &prompt.user; man ls @@ -63,9 +63,9 @@ In some cases, the same topic may appear in more than - one section of the on-line manual. For example, there is a + one section of the on-line manual. For example, there is a chmod - user command and a chmod() system call. In + user command and a chmod() system call. In this case, you can tell the man command which one you want by specifying the section: @@ -74,7 +74,7 @@ This will display the manual page for the user - command chmod. References to a + command chmod. References to a particular section of the on-line manual are traditionally placed in parenthesis in written documentation, so chmod1 refers to the chmod @@ -116,7 +116,7 @@ GNU Info Files FreeBSD includes many applications and utilities produced by the - Free Software Foundation (FSF). In addition to man pages, these + Free Software Foundation (FSF). In addition to man pages, these programs come with more extensive hypertext documents called “info” files which can be viewed with the info command or, if you installed @@ -128,7 +128,7 @@ &prompt.user; info - For a brief introduction, type h. For a quick + For a brief introduction, type h. For a quick command reference, type ?. diff --git a/en/handbook/bibliography/chapter.sgml b/en/handbook/bibliography/chapter.sgml index 6f5c05ed25..bd73d8b64e 100644 --- a/en/handbook/bibliography/chapter.sgml +++ b/en/handbook/bibliography/chapter.sgml @@ -4,7 +4,7 @@ While the manual pages provide the definitive reference for individual pieces of the FreeBSD operating system, they are notorious for not illustrating how to put the pieces together to make the whole - operating system run smoothly. For this, there is no substitute for a + operating system run smoothly. For this, there is no substitute for a good book on UNIX system administration and a good users' manual. @@ -26,33 +26,33 @@ FreeBSD for PC 98'ers (in Japanese), published by SHUWA - System Co, LTD. ISBN 4-87966-468-5 C3055 P2900E. + System Co, LTD. ISBN 4-87966-468-5 C3055 P2900E. - FreeBSD (in Japanese), published by CUTT. ISBN + FreeBSD (in Japanese), published by CUTT. ISBN 4-906391-22-2 C3055 P2400E. Complete Introduction to FreeBSD (in Japanese), published by Shoeisha Co., Ltd. ISBN 4-88135-473-6 P3600E. + URL="http://www.shoeisha.co.jp/pc/index/shinkan/97_05_06.htm">Complete Introduction to FreeBSD (in Japanese), published by Shoeisha Co., Ltd. ISBN 4-88135-473-6 P3600E. Personal UNIX Starter Kit FreeBSD (in Japanese), published by ASCII. ISBN 4-7561-1733-3 P3000E. + URL="http://www.ascii.co.jp/pb/book1/shinkan/detail/1322785.html">Personal UNIX Starter Kit FreeBSD (in Japanese), published by ASCII. ISBN 4-7561-1733-3 P3000E. FreeBSD Handbook (Japanese translation), published by - ASCII. ISBN + ASCII. ISBN 4-7561-1580-2 P3800E. FreeBSD mit Methode (in German), published by Computer und - Literatur Verlag/Vertrieb Hanser, 1998. ISBN 3-932311-31-0. + Literatur Verlag/Vertrieb Hanser, 1998. ISBN 3-932311-31-0. @@ -90,27 +90,27 @@ - Computer Systems Research Group, UC Berkeley. 4.4BSD User's Reference Manual. O'Reilly + Computer Systems Research Group, UC Berkeley. 4.4BSD User's Reference Manual. O'Reilly & Associates, Inc., 1994. ISBN 1-56592-075-9 - Computer Systems Research Group, UC Berkeley. 4.4BSD User's Supplementary Documents. + Computer Systems Research Group, UC Berkeley. 4.4BSD User's Supplementary Documents. O'Reilly & Associates, Inc., 1994. ISBN 1-56592-076-7 - UNIX in a Nutshell. O'Reilly + UNIX in a Nutshell. O'Reilly & Associates, Inc., 1990. ISBN 093717520X - Mui, Linda. What You Need To Know When You Can't - Find Your UNIX System Administrator. O'Reilly - & Associates, Inc., 1995. ISBN 1-56592-104-6 + Mui, Linda. What You Need To Know When You Can't + Find Your UNIX System Administrator. O'Reilly + & Associates, Inc., 1995. ISBN 1-56592-104-6 @@ -121,11 +121,11 @@ Jpman Project, - Japan FreeBSD Users Group. . FreeBSD User's Reference Manual (Japanese translation). Mainichi - Communications Inc., 1998. ISBN4-8399-0088-4 + Communications Inc., 1998. ISBN4-8399-0088-4 P3800E. @@ -140,54 +140,54 @@ - Albitz, Paul and Liu, Cricket. DNS and + Albitz, Paul and Liu, Cricket. DNS and BIND, 2nd Ed. O'Reilly & Associates, Inc., - 1997. ISBN 1-56592-236-0 + 1997. ISBN 1-56592-236-0 - Computer Systems Research Group, UC Berkeley. 4.4BSD System Manager's Manual. O'Reilly - & Associates, Inc., 1994. ISBN + Computer Systems Research Group, UC Berkeley. 4.4BSD System Manager's Manual. O'Reilly + & Associates, Inc., 1994. ISBN 1-56592-080-5 - Costales, Brian, et al. Sendmail, 2nd + Costales, Brian, et al. Sendmail, 2nd Ed. O'Reilly & Associates, Inc., 1997. ISBN 1-56592-222-0 - Frisch, Æleen. Essential System + Frisch, Æleen. Essential System Administration, 2nd Ed. O'Reilly & - Associates, Inc., 1995. ISBN 1-56592-127-5 + Associates, Inc., 1995. ISBN 1-56592-127-5 - Hunt, Craig. TCP/IP Network - Administration. O'Reilly & Associates, Inc., - 1992. ISBN 0-937175-82-X + Hunt, Craig. TCP/IP Network + Administration. O'Reilly & Associates, Inc., + 1992. ISBN 0-937175-82-X - Nemeth, Evi. UNIX System Administration - Handbook. 2nd Ed. Prentice Hall, 1995. ISBN 0131510517 Stern, Hal Managing NFS and NIS - O'Reilly & Associates, Inc., 1991. ISBN + O'Reilly & Associates, Inc., 1991. ISBN 0-937175-75-7 Jpman Project, - Japan FreeBSD Users Group. . FreeBSD System Administrator's Manual (Japanese translation). Mainichi - Communications Inc., 1998. ISBN4-8399-0109-0 + Communications Inc., 1998. ISBN4-8399-0109-0 P3300E. @@ -202,61 +202,61 @@ - Asente, Paul. X Window System - Toolkit. Digital Press. ISBN + Asente, Paul. X Window System + Toolkit. Digital Press. ISBN 1-55558-051-3 - Computer Systems Research Group, UC Berkeley. 4.4BSD Programmer's Reference Manual. - O'Reilly & Associates, Inc., 1994. ISBN + Computer Systems Research Group, UC Berkeley. 4.4BSD Programmer's Reference Manual. + O'Reilly & Associates, Inc., 1994. ISBN 1-56592-078-3 - Computer Systems Research Group, UC Berkeley. 4.4BSD Programmer's Supplementary - Documents. O'Reilly & Associates, Inc., 1994. + Computer Systems Research Group, UC Berkeley. 4.4BSD Programmer's Supplementary + Documents. O'Reilly & Associates, Inc., 1994. ISBN 1-56592-079-1 - Harbison, Samuel P. and Steele, Guy L. Jr. C: A - Reference Manual. 4rd ed. Prentice Hall, 1995. + Harbison, Samuel P. and Steele, Guy L. Jr. C: A + Reference Manual. 4rd ed. Prentice Hall, 1995. ISBN 0-13-326224-3 - Kernighan, Brian and Dennis M. Ritchie. The C - Programming Language.. PTR Prentice Hall, 1988. + Kernighan, Brian and Dennis M. Ritchie. The C + Programming Language.. PTR Prentice Hall, 1988. ISBN 0-13-110362-9 - Lehey, Greg. Porting UNIX Software. + Lehey, Greg. Porting UNIX Software. O'Reilly & Associates, Inc., 1995. ISBN 1-56592-126-7 Plauger, P. J. The Standard C - Library. Prentice Hall, 1992. ISBN + Library. Prentice Hall, 1992. ISBN 0-13-131509-9 - Stevens, W. Richard. Advanced Programming in the - UNIX Environment. Reading, Mass. : + Stevens, W. Richard. Advanced Programming in the + UNIX Environment. Reading, Mass. : Addison-Wesley, 1992 ISBN 0-201-56317-7 - Stevens, W. Richard. UNIX Network - Programming. 2nd Ed, PTR Prentice Hall, 1998. ISBN + Stevens, W. Richard. UNIX Network + Programming. 2nd Ed, PTR Prentice Hall, 1998. ISBN 0-13-490012-X - Wells, Bill. “Writing Serial Drivers for UNIX”. + Wells, Bill. “Writing Serial Drivers for UNIX”. Dr. Dobb's Journal. 19(15), December 1994. pp68-71, 97-99. @@ -273,66 +273,66 @@ - Andleigh, Prabhat K. UNIX System - Architecture. Prentice-Hall, Inc., 1990. ISBN 0-13-949843-5 - Jolitz, William. “Porting UNIX to the + Jolitz, William. “Porting UNIX to the 386”. Dr. - Dobb's Journal. January 1991-July 1992. + Dobb's Journal. January 1991-July 1992. Leffler, Samuel J., Marshall Kirk McKusick, Michael J Karels and John Quarterman The Design and Implementation of the 4.3BSD UNIX Operating - System. Reading, Mass. : Addison-Wesley, + System. Reading, Mass. : Addison-Wesley, 1989. ISBN 0-201-06196-1 Leffler, Samuel J., Marshall Kirk McKusick, The Design and Implementation of the 4.3BSD UNIX Operating - System: Answer Book. Reading, Mass. : + System: Answer Book. Reading, Mass. : Addison-Wesley, 1991. ISBN 0-201-54629-9 McKusick, Marshall Kirk, Keith Bostic, Michael J Karels, - and John Quarterman. The Design and Implementation - of the 4.4BSD Operating System. Reading, Mass. : + and John Quarterman. The Design and Implementation + of the 4.4BSD Operating System. Reading, Mass. : Addison-Wesley, 1996. ISBN 0-201-54979-4 - Stevens, W. Richard. TCP/IP Illustrated, Volume - 1: The Protocols. Reading, Mass. : + Stevens, W. Richard. TCP/IP Illustrated, Volume + 1: The Protocols. Reading, Mass. : Addison-Wesley, 1996. ISBN 0-201-63346-9 - Schimmel, Curt. Unix Systems for Modern - Architectures. Reading, Mass. : Addison-Wesley, - 1994. ISBN 0-201-63338-8 + Schimmel, Curt. Unix Systems for Modern + Architectures. Reading, Mass. : Addison-Wesley, + 1994. ISBN 0-201-63338-8 - Stevens, W. Richard. TCP/IP Illustrated, Volume + Stevens, W. Richard. TCP/IP Illustrated, Volume 3: TCP for Transactions, HTTP, NNTP and the UNIX Domain - Protocols. Reading, Mass. : Addison-Wesley, + Protocols. Reading, Mass. : Addison-Wesley, 1996. ISBN 0-201-63495-3 - Vahalia, Uresh. UNIX Internals -- The New - Frontiers. Prentice Hall, 1996. ISBN + Vahalia, Uresh. UNIX Internals -- The New + Frontiers. Prentice Hall, 1996. ISBN 0-13-101908-2 - Wright, Gary R. and W. Richard Stevens. TCP/IP + Wright, Gary R. and W. Richard Stevens. TCP/IP Illustrated, Volume 2: The Implementation. Reading, Mass. : Addison-Wesley, 1995. ISBN 0-201-63354-X @@ -352,18 +352,18 @@ Cheswick, William R. and Steven M. Bellovin. Firewalls and Internet Security: Repelling the Wily - Hacker. Reading, Mass. : Addison-Wesley, + Hacker. Reading, Mass. : Addison-Wesley, 1995. ISBN 0-201-63357-4 - Garfinkel, Simson and Gene Spafford. Practical - UNIX Security. 2nd Ed. O'Reilly & Associates, - Inc., 1996. ISBN 1-56592-148-8 + Garfinkel, Simson and Gene Spafford. Practical + UNIX Security. 2nd Ed. O'Reilly & Associates, + Inc., 1996. ISBN 1-56592-148-8 - Garfinkel, Simson. PGP Pretty Good + Garfinkel, Simson. PGP Pretty Good Privacy O'Reilly & Associates, Inc., 1995. ISBN 1-56592-098-8 @@ -380,14 +380,14 @@ - Anderson, Don and Tom Shanley. Pentium Processor - System Architecture. 2nd Ed. Reading, Mass. : + Anderson, Don and Tom Shanley. Pentium Processor + System Architecture. 2nd Ed. Reading, Mass. : Addison-Wesley, 1995. ISBN 0-201-40992-5 - Ferraro, Richard F. Programmer's Guide to the - EGA, VGA, and Super VGA Cards. 3rd ed. Reading, + Ferraro, Richard F. Programmer's Guide to the + EGA, VGA, and Super VGA Cards. 3rd ed. Reading, Mass. : Addison-Wesley, 1995. ISBN 0-201-62490-7 @@ -400,26 +400,26 @@ - Shanley, Tom. 80486 System - Architecture. 3rd ed. Reading, Mass. : - Addison-Wesley, 1995. ISBN 0-201-40994-1 + Shanley, Tom. 80486 System + Architecture. 3rd ed. Reading, Mass. : + Addison-Wesley, 1995. ISBN 0-201-40994-1 - Shanley, Tom. ISA System - Architecture. 3rd ed. Reading, Mass. : + Shanley, Tom. ISA System + Architecture. 3rd ed. Reading, Mass. : Addison-Wesley, 1995. ISBN 0-201-40996-8 - Shanley, Tom. PCI System - Architecture. 3rd ed. Reading, Mass. : - Addison-Wesley, 1995. ISBN 0-201-40993-3 + Shanley, Tom. PCI System + Architecture. 3rd ed. Reading, Mass. : + Addison-Wesley, 1995. ISBN 0-201-40993-3 - Van Gilluwe, Frank. The Undocumented - PC. Reading, Mass: Addison-Wesley Pub. Co., + Van Gilluwe, Frank. The Undocumented + PC. Reading, Mass: Addison-Wesley Pub. Co., 1994. ISBN 0-201-62277-7 @@ -436,45 +436,45 @@ Lion, John Lion's Commentary on UNIX, 6th Ed. - With Source Code. ITP Media Group, 1996. ISBN 1573980137 - Raymond, Eric s. The New Hacker's Dictonary, 3rd - edition. MIT Press, 1996. ISBN + Raymond, Eric s. The New Hacker's Dictonary, 3rd + edition. MIT Press, 1996. ISBN 0-262-68092-0 Also known as the Jargon File - Salus, Peter H. A quarter century of - UNIX. Addison-Wesley Publishing Company, Inc., + Salus, Peter H. A quarter century of + UNIX. Addison-Wesley Publishing Company, Inc., 1994. ISBN 0-201-54777-5 Simon Garfinkel, Daniel Weise, Steven Strassmann. - The UNIX-HATERS Handbook. IDG Books + The UNIX-HATERS Handbook. IDG Books Worldwide, Inc., 1994. ISBN 1-56884-203-1 Don Libes, Sandy Ressler Life with - UNIX — special edition. Prentice-Hall, Inc., + UNIX — special edition. Prentice-Hall, Inc., 1989. ISBN 0-13-536657-7 - The BSD family tree. 1997. ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/src/share/misc/bsd-family-tree or local on a FreeBSD-current machine. The BSD Release Announcements - collection. 1997. . 1997. http://www.de.FreeBSD.ORG/de/ftp/releases/ @@ -486,8 +486,8 @@ url="ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/src/share/misc/bsd-family Old BSD releases from the Computer Systems Research - group (CSRG). http://www.mckusick.com/csrg/: The 4CD set covers all BSD versions from 1BSD to 4.4BSD and 4.4BSD-Lite2 (but not 2.11BSD, unfortunately). As well, the last disk holds the final sources plus the SCCS files. + group (CSRG). http://www.mckusick.com/csrg/: The 4CD set covers all BSD versions from 1BSD to 4.4BSD and 4.4BSD-Lite2 (but not 2.11BSD, unfortunately). As well, the last disk holds the final sources plus the SCCS files. @@ -501,8 +501,8 @@ url="ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/src/share/misc/bsd-family - The C/C++ Users Journal. R&D - Publications Inc. ISSN 1075-2838 + The C/C++ Users Journal. R&D + Publications Inc. ISSN 1075-2838 diff --git a/en/handbook/boothelp.sgml b/en/handbook/boothelp.sgml index f148c86296..dc1d2781b2 100644 --- a/en/handbook/boothelp.sgml +++ b/en/handbook/boothelp.sgml @@ -15,11 +15,11 @@ Welcome to FreeBSD! This guide describes the FreeBSD installation - process. To navigate through through the section in this guide using + process. To navigate through through the section in this guide using the up and down arrow keys - to select the section you wish to read. THen use the right + to select the section you wish to read. THen use the right arrow or the enter key to view the - section. You can backtract through section you have read by using the + section. You can backtract through section you have read by using the left arrow. diff --git a/en/handbook/contrib/chapter.sgml b/en/handbook/contrib/chapter.sgml index 6d64db5434..d36fd7e6d4 100644 --- a/en/handbook/contrib/chapter.sgml +++ b/en/handbook/contrib/chapter.sgml @@ -6,12 +6,12 @@ So you want to contribute something to FreeBSD? That is great! We can always use the help, and FreeBSD is one of those systems that relies on the contributions of its user base in - order to survive. Your contributions are not only appreciated, they + order to survive. Your contributions are not only appreciated, they are vital to FreeBSD's continued growth! Contrary to what some people might also have you believe, you do not need to be a hot-shot programmer or a close personal friend of the - FreeBSD core team in order to have your contributions accepted. The + FreeBSD core team in order to have your contributions accepted. The FreeBSD Project's development is done by a large and growing number of international contributors whose ages and areas of technical expertise vary greatly, and there is always more work to be done than there are @@ -21,16 +21,16 @@ system environment (and its installation) rather than just a kernel or a few scattered utilities, our TODO list also spans a very wide range of tasks, from documentation, beta testing and presentation to - highly specialized types of kernel development. No matter what your + highly specialized types of kernel development. No matter what your skill level, there is almost certainly something you can do to help the project! Commercial entities engaged in FreeBSD-related enterprises are - also encouraged to contact us. Need a special extension to make your + also encouraged to contact us. Need a special extension to make your product work? You will find us receptive to your requests, given that - they are not too outlandish. Working on a value-added product? + they are not too outlandish. Working on a value-added product? Please let us know! We may be able to work cooperatively on some - aspect of it. The free software world is challenging a lot of + aspect of it. The free software world is challenging a lot of existing assumptions about how software is developed, sold, and maintained throughout its life cycle, and we urge you to at least give it a second look. @@ -41,10 +41,10 @@ The following list of tasks and sub-projects represents something of an amalgam of the various core team TODO lists and user - requests we have collected over the last couple of months. Where - possible, tasks have been ranked by degree of urgency. If you are + requests we have collected over the last couple of months. Where + possible, tasks have been ranked by degree of urgency. If you are interested in working on one of the tasks you see here, send mail to - the coordinator listed by clicking on their names. If no + the coordinator listed by clicking on their names. If no coordinator has been appointed, maybe you would like to volunteer? @@ -59,7 +59,7 @@ - 3-stage boot issues. Overall coordination: + 3-stage boot issues. Overall coordination: &a.hackers; @@ -75,7 +75,7 @@ - Filesystem problems. Overall coordination: &a.fs; + Filesystem problems. Overall coordination: &a.fs; @@ -88,7 +88,7 @@ - Fix the union file system. Coordinator: + Fix the union file system. Coordinator: &a.dg; @@ -97,12 +97,12 @@ - Implement Int13 vm86 disk driver. Coordinator: + Implement Int13 vm86 disk driver. Coordinator: &a.hackers; - New bus architecture. Coordinator: &a.newbus; + New bus architecture. Coordinator: &a.newbus; @@ -116,7 +116,7 @@ - Port PCI subsystem to new architecture. Coordinator: + Port PCI subsystem to new architecture. Coordinator: &a.dfr; @@ -139,7 +139,7 @@ - Kernel issues. Overall coordination: &a.hackers; + Kernel issues. Overall coordination: &a.hackers; @@ -156,7 +156,7 @@ Make the entire kernel use - suser() instead of comparing to 0. It + suser() instead of comparing to 0. It is presently using about half of each. Coordinator: &a.eivind; @@ -164,7 +164,7 @@ Split securelevels into different parts, to allow an administrator to throw away those privileges he can throw - away. Setting the overall securelevel needs to have the + away. Setting the overall securelevel needs to have the same effect as now, obviously. Coordinator: &a.eivind; @@ -196,7 +196,7 @@ Add code to teh NFS layer so that you cannot chdir("..") out of an NFS partition. E.g., /usr is a UFS partition with - /usr/src NFS exported. Now it is + /usr/src NFS exported. Now it is possible to use the NFS filehandle for /usr/src to get access to /usr. @@ -230,7 +230,7 @@ - PCMCIA/PCCARD. Coordinators: &a.msmith; and &a.phk; + PCMCIA/PCCARD. Coordinators: &a.msmith; and &a.phk; @@ -267,7 +267,7 @@ - Advanced Power Management. Coordinators: &a.msmith; and + Advanced Power Management. Coordinators: &a.msmith; and &a.phk; @@ -310,7 +310,7 @@ NetWare Server (protected mode ODI driver) loader and subservices to allow the use of ODI card drivers supplied - with network cards. The same thing for NDIS drivers and + with network cards. The same thing for NDIS drivers and NetWare SCSI drivers. @@ -327,7 +327,7 @@ A concerted effort at support for portable computers. This is somewhat handled by changing PCMCIA bridging rules - and power management event handling. But there are things + and power management event handling. But there are things like detecting internal vs. external display and picking a different screen resolution based on that fact, not spinning down the disk if the machine is in dock, and allowing @@ -343,7 +343,7 @@ Most of the tasks listed in the previous sections require either a considerable investment of time or an in-depth knowledge - of the FreeBSD kernel (or both). However, there are also many + of the FreeBSD kernel (or both). However, there are also many useful tasks which are suitable for "weekend hackers", or people without programming skills. @@ -359,16 +359,16 @@ - Read the freebsd-bugs mailing list. There might be a + Read the freebsd-bugs mailing list. There might be a problem you can comment constructively on or with patches - you can test. Or you could even try to fix one of the + you can test. Or you could even try to fix one of the problems yourself. - Read through the FAQ and Handbook periodically. If + Read through the FAQ and Handbook periodically. If anything is badly explained, out of date or even just - completely wrong, let us know. Even better, send us a fix + completely wrong, let us know. Even better, send us a fix (SGML is not difficult to learn, but there is no objection to ASCII submissions). @@ -376,7 +376,7 @@ Help translate FreeBSD documentation into your native language (if not already available) — just send an email to - &a.doc; asking if anyone is working on it. Note that you + &a.doc; asking if anyone is working on it. Note that you are not committing yourself to translating every single FreeBSD document by doing this — in fact, the documentation most in need of translation is the installation @@ -386,7 +386,7 @@ Read the freebsd-questions mailing list and &ng.misc occasionally (or even - regularly). It can be very satisfying to share your + regularly). It can be very satisfying to share your expertise and help people solve their problems; sometimes you may even learn something new yourself! These forums can also be a source of ideas for things to work on. @@ -450,24 +450,24 @@ Bug reports and general commentary An idea or suggestion of general - technical interest should be mailed to the &a.hackers;. Likewise, + technical interest should be mailed to the &a.hackers;. Likewise, people with an interest in such things (and a tolerance for a high volume of mail!) may subscribe to the - hackers mailing list by sending mail to &a.majordomo;. See + hackers mailing list by sending mail to &a.majordomo;. See mailing lists for more information about this and other mailing lists. If you find a bug or are submitting a specific change, please report it using the send-pr1program or its WEB-based - equivalent. Try to fill-in each field of the bug report. + equivalent. Try to fill-in each field of the bug report. Unless they exceed 65KB, include any patches directly in the - report. Consider compressing them and using - uuencode1 if they exceed 20KB. Upload very large submissions to ftp.freebsd.org:/pub/FreeBSD/incoming/. + report. Consider compressing them and using + uuencode1 if they exceed 20KB. Upload very large submissions to ftp.freebsd.org:/pub/FreeBSD/incoming/. After filing a report, you should receive confirmation along - with a tracking number. Keep this tracking number so that you can - update us with details about the problem by sending mail to bug-followup@FreeBSD.ORG. Use the number as the message subject, e.g. "Re: kern/3377". Additional information for any bug report should be submitted this way. + with a tracking number. Keep this tracking number so that you can + update us with details about the problem by sending mail to bug-followup@FreeBSD.ORG. Use the number as the message subject, e.g. "Re: kern/3377". Additional information for any bug report should be submitted this way. If you do not receive confirmation in a timely fashion (3 days to a week, depending on your email connection) or are, for some @@ -480,7 +480,7 @@ Changes to the documentation - Changes to the documentation are overseen by the &a.doc;. Send + Changes to the documentation are overseen by the &a.doc;. Send submissions and changes (even small ones are welcome!) using send-pr as described in Bug Reports and General @@ -503,16 +503,16 @@ Working from older sources unfortunately means that your changes may sometimes be too obsolete or too divergent for easy - re-integration into FreeBSD. Chances of this can be minimized + re-integration into FreeBSD. Chances of this can be minimized somewhat by subscribing to the &a.announce; and the &a.current; lists, where discussions on the current state of the system take place. Assuming that you can manage to secure fairly up-to-date sources to base your changes on, the next step is to produce a set - of diffs to send to the FreeBSD maintainers. This is done with + of diffs to send to the FreeBSD maintainers. This is done with the diff1 command, with the “context diff” - form being preferred. For example: + form being preferred. For example: &prompt.user; diff -c oldfile newfile @@ -525,15 +525,15 @@ would generate such a set of context diffs for - the given source file or directory hierarchy. See the man page + the given source file or directory hierarchy. See the man page for diff1 for more details. Once you have a set of diffs (which you may test with the patch1 command), you should submit them for - inclusion with FreeBSD. Use the send-pr1 + inclusion with FreeBSD. Use the send-pr1 program as described in Bug Reports and General - Commentary. Do not just send the diffs to + Commentary. Do not just send the diffs to the &a.hackers; or they will get lost! We greatly appreciate your submission (this is a volunteer project!); because we are busy, we may not be able to address it immediately, but it will remain in @@ -541,22 +541,22 @@ If you feel it appropriate (e.g. you have added, deleted, or renamed files), bundle your changes into a tar file and run the - uuencode1 program on it. Shar archives are + uuencode1 program on it. Shar archives are also welcome. If your change is of a potentially sensitive nature, e.g. you are unsure of copyright issues governing its further distribution or you are simply not ready to release it without a tighter review first, then you should send it to &a.core; directly rather than - submitting it with send-pr1. The core + submitting it with send-pr1. The core mailing list reaches a much smaller group of people who do much of - the day-to-day work on FreeBSD. Note that this group is also + the day-to-day work on FreeBSD. Note that this group is also very busy and so you should only send mail to them where it is truly necessary. Please refer to man 9 intro and man 9 style for some information on - coding style. We would appreciate it if you were at least aware + coding style. We would appreciate it if you were at least aware of this information before submitting code. @@ -571,16 +571,16 @@ URL="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming">ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming. When working with large amounts of code, the touchy subject of - copyrights also invariably comes up. Acceptable copyrights for + copyrights also invariably comes up. Acceptable copyrights for code included in FreeBSD are: - The BSD copyright. This copyright is most preferred due + The BSD copyright. This copyright is most preferred due to its “no strings attached” nature and general - attractiveness to commercial enterprises. Far from + attractiveness to commercial enterprises. Far from discouraging such commercial use, the FreeBSD Project actively encourages such participation by commercial interests who might eventually be inclined to invest @@ -588,13 +588,13 @@ - The GNU Public License, or “GPL”. This license is not + The GNU Public License, or “GPL”. This license is not quite as popular with us due to the amount of extra effort demanded of anyone using the code for commercial purposes, but given the sheer quantity of GPL'd code we currently require (compiler, assembler, text formatter, etc) it would be silly to refuse additional contributions under this - license. Code under the GPL also goes into a different part + license. Code under the GPL also goes into a different part of the tree, that being /sys/gnu or /usr/src/gnu, and is therefore easily identifiable to anyone for whom the GPL presents a @@ -606,7 +606,7 @@ Contributions coming under any other type of copyright must be carefully reviewed before their inclusion into FreeBSD will be - considered. Contributions for which particularly restrictive + considered. Contributions for which particularly restrictive commercial copyrights apply are generally rejected, though the authors are always encouraged to make such changes available through their own channels. @@ -670,7 +670,7 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. FreeBSD, Inc. was founded in early 1995 by &a.jkh; and &a.dg; with the goal of furthering the aims of the FreeBSD - Project and giving it a minimal corporate presence. Any and all + Project and giving it a minimal corporate presence. Any and all funds donated (as well as any profits that may eventually be realized by FreeBSD, Inc.) will be used exclusively to further the project's goals. @@ -709,7 +709,7 @@ box can be opened) If you do not wish to be listed in our donors section, please specify this - when making your donation. Thanks! + when making your donation. Thanks! @@ -731,9 +731,9 @@ box can be opened) Hardware for which ongoing compliance testing is - desired. We are currently trying to put together a testing + desired. We are currently trying to put together a testing lab of all components that FreeBSD supports so that proper - regression testing can be done with each new release. We + regression testing can be done with each new release. We are still lacking many important pieces (network cards, motherboards, etc) and if you would like to make such a donation, please contact &a.dg; for information on @@ -742,7 +742,7 @@ box can be opened) Hardware currently unsupported by FreeBSD for which - you would like to see such support added. Please contact + you would like to see such support added. Please contact the &a.core; before sending such items as we will need to find a developer willing to take on the task before we can accept delivery of new hardware. @@ -756,7 +756,7 @@ box can be opened) Donating Internet access - We can always use new mirror sites for FTP, WWW or cvsup. If + We can always use new mirror sites for FTP, WWW or cvsup. If you would like to be such a mirror, please contact the FreeBSD project administrators admin@FreeBSD.ORG for more information. @@ -965,7 +965,7 @@ box can be opened) - Ernst Winter ewinter@lobo.muc.de contributed a 2.88 MB floppy drive to the project. This will hopefully increase the pressure for rewriting the floppy disk driver. ;-) + Ernst Winter ewinter@lobo.muc.de contributed a 2.88 MB floppy drive to the project. This will hopefully increase the pressure for rewriting the floppy disk driver. ;-) @@ -973,7 +973,7 @@ box can be opened) Technologies sent one each of their DC-390, DC-390U and DC-390F FAST and ULTRA SCSI host adapter cards for regression testing of the NCR and AMD drivers - with their cards. They are also to be applauded for + with their cards. They are also to be applauded for making driver sources for free operating systems available from their FTP server ftp://ftp.tekram.com/scsi/FreeBSD. @@ -1011,12 +1011,12 @@ box can be opened) CDROM has donated almost more than we can say (see the history document for - more details). In particular, we would like to thank + more details). In particular, we would like to thank them for the original hardware used for freefall.FreeBSD.ORG, our primary development machine, and for thud.FreeBSD.ORG, a testing and - build box. We are also indebted to them for funding + build box. We are also indebted to them for funding various contributors over the years and providing us with unrestricted use of their T1 connection to the Internet. @@ -1110,7 +1110,7 @@ box can be opened) This software was originally derived from William F. Jolitz's 386BSD release 0.1, though almost none of the original 386BSD - specific code remains. This software has been essentially + specific code remains. This software has been essentially re-implemented from the 4.4BSD-Lite release provided by the Computer Science Research Group (CSRG) at the University of California, Berkeley and associated academic contributors. diff --git a/en/handbook/cutting-edge/chapter.sgml b/en/handbook/cutting-edge/chapter.sgml index a97ada4bd4..ff5c2b368f 100644 --- a/en/handbook/cutting-edge/chapter.sgml +++ b/en/handbook/cutting-edge/chapter.sgml @@ -1,10 +1,10 @@ The Cutting Edge: FreeBSD-current and FreeBSD-stable - FreeBSD is under constant development between releases. For + FreeBSD is under constant development between releases. For people who want to be on the cutting edge, there are several easy mechanisms for keeping your system in sync with the latest - developments. Be warned: the cutting edge is not for everyone! This + developments. Be warned: the cutting edge is not for everyone! This chapter will help you decide if you want to track the development system, or stick with one of the released versions. @@ -19,12 +19,12 @@ What is FreeBSD-current? FreeBSD-current is, quite literally, nothing more than a daily - snapshot of the working sources for FreeBSD. These include work + snapshot of the working sources for FreeBSD. These include work in progress, experimental changes and transitional mechanisms that may or may not be present in the next official release of the - software. While many of us compile almost daily from + software. While many of us compile almost daily from FreeBSD-current sources, there are periods of time when the - sources are literally un-compilable. These problems are generally + sources are literally un-compilable. These problems are generally resolved as expeditiously as possible, but whether or not FreeBSD-current sources bring disaster or greatly desired functionality can literally be a matter of which part of any given @@ -58,7 +58,7 @@ Peripheral members of the FreeBSD (or some other) group who merely wish to keep an eye on things and use the current sources for reference purposes (e.g. for - reading, not running). These people + reading, not running). These people also make the occasional comment or contribute code. @@ -83,7 +83,7 @@ - In any way “officially supported” by us. We do our + In any way “officially supported” by us. We do our best to help people genuinely in one of the 3 “legitimate” FreeBSD-current categories, but we simply do not have the time to provide tech support for it. @@ -108,13 +108,13 @@ - Join the &a.current; and the &a.cvsall; . This is not - just a good idea, it is essential. If + Join the &a.current; and the &a.cvsall; . This is not + just a good idea, it is essential. If you are not on the FreeBSD-current mailing list, you will not see the comments that people are making about the current state of the system and thus will probably end up stumbling over a lot of problems that others - have already found and solved. Even more importantly, you + have already found and solved. Even more importantly, you will miss out on important bulletins which may be critical to your system's continued health. @@ -131,28 +131,28 @@ subscribe freebsd-current subscribe cvs-all in the - body of your message. Optionally, you can also say help + body of your message. Optionally, you can also say help and Majordomo will send you full help on how to subscribe and unsubscribe to the various other mailing lists we support. - Grab the sources from ftp.FreeBSD.ORG. You can do + Grab the sources from ftp.FreeBSD.ORG. You can do this in three ways: Use the CTM - facility. Unless you have a good TCP/IP connection + facility. Unless you have a good TCP/IP connection at a flat rate, this is the way to do it. Use the cvsup program with this supfile. This is the second most recommended method, since it allows you to grab the entire collection once and then only what has changed from then on. Many people run cvsup from cron and keep their sources up-to-date automatically. For a fairly easy interface to this, simply type: + URL="ftp://ftp.FreeBSD.org/pub/FreeBSD/FreeBSD-current/src/share/examples/cvsup/standard-supfile">this supfile. This is the second most recommended method, since it allows you to grab the entire collection once and then only what has changed from then on. Many people run cvsup from cron and keep their sources up-to-date automatically. For a fairly easy interface to this, simply type: &prompt.root; pkg_add -f ftp://ftp.FreeBSD.org/pub/FreeBSD/development/CVSup/cvsupit.tgz @@ -162,9 +162,9 @@ subscribe cvs-all - Use ftp. The source tree for FreeBSD-current is + Use ftp. The source tree for FreeBSD-current is always “exported” on: ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-current We also use wu-ftpd which allows compressed/tar'd grabbing of whole trees. e.g. you see: + URL="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-current">ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-current We also use wu-ftpd which allows compressed/tar'd grabbing of whole trees. e.g. you see: usr.bin/lex @@ -188,20 +188,20 @@ subscribe cvs-all Essentially, if you need rapid on-demand access to the source and communications bandwidth is not a consideration, - use cvsup or ftp. Otherwise, use CTM. + use cvsup or ftp. Otherwise, use CTM. If you are grabbing the sources to run, and not just look at, then grab all of current, not - just selected portions. The reason for this is that various + just selected portions. The reason for this is that various parts of the source depend on updates elsewhere, and trying to compile just a subset is almost guaranteed to get you into trouble. Before compiling current, read the Makefile in - /usr/src carefully. You should at + /usr/src carefully. You should at least run a make world the first time - through as part of the upgrading process. Reading the + through as part of the upgrading process. Reading the &a.current; will keep you up-to-date on other bootstrapping procedures that sometimes become necessary as we move towards the next release. @@ -231,7 +231,7 @@ subscribe cvs-all FreeBSD-stable is our development branch for a more low-key and conservative set of changes intended for our next mainstream - release. Changes of an experimental or untested nature do not go + release. Changes of an experimental or untested nature do not go into this branch (see FreeBSD-current). @@ -241,7 +241,7 @@ subscribe cvs-all If you are a commercial user or someone who puts maximum stability of their FreeBSD system before all other concerns, you - should consider tracking stable. This is + should consider tracking stable. This is especially true if you have installed the most recent release (&rel.current;-RELEASE at the time of this writing) since the stable branch is effectively a bug-fix stream relative to the previous release. @@ -250,10 +250,10 @@ subscribe cvs-all The stable tree endeavors, above all, to be fully compilable and stable at all times, but we do occasionally make mistakes (these are still active sources with - quickly-transmitted updates, after all). We also do our best to + quickly-transmitted updates, after all). We also do our best to thoroughly test fixes in current before bringing them into stable, but sometimes - our tests fail to catch every case. If something breaks for you + our tests fail to catch every case. If something breaks for you in stable, please let us know immediately! (see next section). @@ -266,10 +266,10 @@ subscribe cvs-all - Join the &a.stable; . This will keep you informed of + Join the &a.stable; . This will keep you informed of build-dependencies that may appear in stable or any other issues requiring - special attention. Developers will also make announcements + special attention. Developers will also make announcements in this mailing list when they are contemplating some controversial fix or update, giving the users a chance to respond if they have any issues to raise concerning the @@ -288,7 +288,7 @@ subscribe freebsd-stable subscribe cvs-all in the - body of your message. Optionally, you can also say help + body of your message. Optionally, you can also say help and Majordomo will send you full help on how to subscribe and unsubscribe to the various other mailing lists we support. @@ -302,21 +302,21 @@ subscribe cvs-all If you are already running a previous release of 2.2 and wish to upgrade via sources then you can easily do so from ftp.FreeBSD.ORG. This can be done in one of + role="fqdn">ftp.FreeBSD.ORG. This can be done in one of three ways: Use the CTM - facility. Unless you have a good TCP/IP connection + facility. Unless you have a good TCP/IP connection at a flat rate, this is the way to do it. Use the cvsup program with this supfile. This is the second most recommended method, since it allows you to grab the entire collection once and then only what has changed from then on. Many people run cvsup from cron to keep their sources up-to-date automatically. For a fairly easy interface to this, simply type; + URL="ftp://ftp.FreeBSD.org/pub/FreeBSD/FreeBSD-current/src/share/examples/cvsup/stable-supfile">this supfile. This is the second most recommended method, since it allows you to grab the entire collection once and then only what has changed from then on. Many people run cvsup from cron to keep their sources up-to-date automatically. For a fairly easy interface to this, simply type; &prompt.root; pkg_add -f ftp://ftp.FreeBSD.org/pub/FreeBSD/development/CVSup/cvsupit.tgz @@ -324,12 +324,12 @@ subscribe cvs-all - Use ftp. The source tree for FreeBSD-stable is + Use ftp. The source tree for FreeBSD-stable is always “exported” on: ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-stable We also use wu-ftpd which allows - compressed/tar'd grabbing of whole trees. e.g. you + compressed/tar'd grabbing of whole trees. e.g. you see: @@ -355,15 +355,15 @@ subscribe cvs-all Essentially, if you need rapid on-demand access to the source and communications bandwidth is not a consideration, - use cvsup or ftp. Otherwise, use CTM. + use cvsup or ftp. Otherwise, use CTM. Before compiling stable, read the Makefile in - /usr/src carefully. You should at + /usr/src carefully. You should at least run a make world the first time - through as part of the upgrading process. Reading the + through as part of the upgrading process. Reading the &a.stable; will keep you up-to-date on other bootstrapping procedures that sometimes become necessary as we move towards the next release. @@ -383,46 +383,46 @@ subscribe cvs-all There are various ways of using an Internet (or email) connection to stay up-to-date with any given area of the FreeBSD - project sources, or all areas, depending on what interests you. The + project sources, or all areas, depending on what interests you. The primary services we offer are Anonymous CVS, CVSup, and CTM. Anonymous CVS and CVSup use the - pull model of updating sources. In the case of + pull model of updating sources. In the case of CVSup the user (or a cron script) invokes the cvsup program, and it interacts with a cvsupd server - somewhere to bring your files up to date. The updates you receive + somewhere to bring your files up to date. The updates you receive are up-to-the-minute and you get them when, and only when, you want - them. You can easily restrict your updates to the specific files or - directories that are of interest to you. Updates are generated on + them. You can easily restrict your updates to the specific files or + directories that are of interest to you. Updates are generated on the fly by the server, according to what you have and what you want - to have. Anonymous CVS is quite a bit more simplistic + to have. Anonymous CVS is quite a bit more simplistic than CVSup in that it's just an extension to CVS which allows it to pull changes directly from a remote CVS - repository. CVSup can do this far more + repository. CVSup can do this far more efficiently, but Anonymous CVS is easier to use. CTM, on the other hand, does not interactively compare the sources you have with those on the master - archive or otherwise pull them across.. Instead, a script which identifies changes in files since + archive or otherwise pull them across.. Instead, a script which identifies changes in files since its previous run is executed several times a day on the master CTM machine, any detected changes being compressed, stamped with a sequence-number and encoded for transmission over email (in printable - ASCII only). Once received, these “CTM deltas” can then be handed + ASCII only). Once received, these “CTM deltas” can then be handed to the ctm_rmail1 utility which will automatically decode, verify - and apply the changes to the user's copy of the sources. This + and apply the changes to the user's copy of the sources. This process is far more efficient than CVSup, and places less strain on our server resources since it is a push rather than a pull model. - There are other trade-offs, of course. If you inadvertently + There are other trade-offs, of course. If you inadvertently wipe out portions of your archive, CVSup will detect and rebuild the - damaged portions for you. CTM won't do this, and if you wipe some + damaged portions for you. CTM won't do this, and if you wipe some portion of your source tree out (and don't have it backed up) then you will have to start from scratch (from the most recent CVS “base delta”) and rebuild it all with CTM or, with anoncvs, simply @@ -442,9 +442,9 @@ subscribe cvs-all Anonymous CVS (or, as it is otherwise known, anoncvs) is a feature provided by the CVS utilities bundled with FreeBSD for synchronizing with a remote CVS - repository. Among other things, it allows users of FreeBSD to + repository. Among other things, it allows users of FreeBSD to perform, with no special privileges, read-only CVS operations - against one of the FreeBSD project's official anoncvs servers. To + against one of the FreeBSD project's official anoncvs servers. To use it, one simply sets the CVSROOT environment variable to point at the appropriate anoncvs server and then uses the @@ -457,7 +457,7 @@ subscribe cvs-all linkend="cvsup">CVSup and anoncvs services both perform essentially the same function, there are various trade-offs which can influence the user's choice of - synchronization methods. In a nutshell, + synchronization methods. In a nutshell, CVSup is much more efficient in its usage of network resources and is by far the most technically sophisticated of the two, but at a price. To use @@ -470,7 +470,7 @@ subscribe cvs-all Anoncvs, by contrast, can be used to examine anything from an individual file to a specific program (like ls or grep) by - referencing the CVS module name. Of course, + referencing the CVS module name. Of course, anoncvs is also only good for read-only operations on the CVS repository, so if it's your intention to support local development in one repository shared with the @@ -487,7 +487,7 @@ subscribe cvs-all to use an Anonymous CVS repository is a simple matter of setting the CVSROOT environment variable to point to one of the FreeBSD project's - anoncvs servers. At the time of this writing, + anoncvs servers. At the time of this writing, the following servers are available: @@ -506,11 +506,11 @@ subscribe cvs-all and what some of the permissible values for it in the FreeBSD Project repository are. - There are two kinds of tags, revision tags and branch tags. A - revision tag refers to a specific revision. Its meaning stays the - same from day to day. A branch tag, on the other hand, refers to + There are two kinds of tags, revision tags and branch tags. A + revision tag refers to a specific revision. Its meaning stays the + same from day to day. A branch tag, on the other hand, refers to the latest revision on a given line of development, at any given - time. Because a branch tag does not refer to a specific revision, + time. Because a branch tag does not refer to a specific revision, it may mean something different tomorrow than it means today. @@ -533,7 +533,7 @@ subscribe cvs-all The line of development for FreeBSD-3.x, also known as - FreeBSD-stable. Not valid for the ports collection. + FreeBSD-stable. Not valid for the ports collection. @@ -542,7 +542,7 @@ subscribe cvs-all The line of development for FreeBSD-2.2.x, also known as - 2.2-stable. Not valid for the ports collection. + 2.2-stable. Not valid for the ports collection. @@ -551,7 +551,7 @@ subscribe cvs-all The line of development for FreeBSD-2.1.x - this branch - is largely obsolete. Not valid for the ports + is largely obsolete. Not valid for the ports collection. @@ -574,7 +574,7 @@ subscribe cvs-all RELENG_2_2_5_RELEASE - FreeBSD-2.2.5. Not valid for the ports + FreeBSD-2.2.5. Not valid for the ports collection. @@ -583,7 +583,7 @@ subscribe cvs-all RELENG_2_2_2_RELEASE - FreeBSD-2.2.2. Not valid for the ports + FreeBSD-2.2.2. Not valid for the ports collection. @@ -592,7 +592,7 @@ subscribe cvs-all RELENG_2_2_1_RELEASE - FreeBSD-2.2.1. Not valid for the ports + FreeBSD-2.2.1. Not valid for the ports collection. @@ -601,7 +601,7 @@ subscribe cvs-all RELENG_2_2_0_RELEASE - FreeBSD-2.2.0. Not valid for the ports + FreeBSD-2.2.0. Not valid for the ports collection. @@ -610,7 +610,7 @@ subscribe cvs-all RELENG_2_1_7_RELEASE - FreeBSD-2.1.7. Not valid for the ports + FreeBSD-2.1.7. Not valid for the ports collection. @@ -619,7 +619,7 @@ subscribe cvs-all RELENG_2_1_6_1_RELEASE - FreeBSD-2.1.6.1. Not valid for the ports + FreeBSD-2.1.6.1. Not valid for the ports collection. @@ -628,7 +628,7 @@ subscribe cvs-all RELENG_2_1_6_RELEASE - FreeBSD-2.1.6. Not valid for the ports + FreeBSD-2.1.6. Not valid for the ports collection. @@ -637,7 +637,7 @@ subscribe cvs-all RELENG_2_1_5_RELEASE - FreeBSD-2.1.5. Not valid for the ports + FreeBSD-2.1.5. Not valid for the ports collection. @@ -646,14 +646,14 @@ subscribe cvs-all RELENG_2_1_0_RELEASE - FreeBSD-2.1.0. Not valid for the ports + FreeBSD-2.1.0. Not valid for the ports collection. When you specify a branch tag, you normally receive the latest - versions of the files on that line of development. If you wish to + versions of the files on that line of development. If you wish to receive some past version, you can do so by specifying a date with the flag. See the cvs @@ -744,13 +744,13 @@ subscribe cvs-all <application>CTM</application> - Contributed by &a.phk;. Updated + Contributed by &a.phk;. Updated 19-October-1997. CTM is a method for keeping a remote - directory tree in sync with a central one. It has been developed + directory tree in sync with a central one. It has been developed for usage with FreeBSD's source trees, though other people may - find it useful for other purposes as time goes by. Little, if + find it useful for other purposes as time goes by. Little, if any, documentation currently exists at this time on the process of creating deltas, so talk to &a.phk; for more information should you wish to use CTM for other things. @@ -760,24 +760,24 @@ subscribe cvs-all Why should I use <application>CTM</application>? CTM will give you a local copy of the - FreeBSD source trees. There are a number of “flavors” of the - tree available. Whether you wish to track the entire cvs tree or + FreeBSD source trees. There are a number of “flavors” of the + tree available. Whether you wish to track the entire cvs tree or just one of the branches, CTM can provide you - the information. If you are an active developer on FreeBSD, but + the information. If you are an active developer on FreeBSD, but have lousy or non-existent TCP/IP connectivity, or simply wish to have the changes automatically sent to you, - CTM was made for you. You will need to obtain + CTM was made for you. You will need to obtain up to three deltas per day for the most active branches. However, you should consider having them sent by automatic - email. The sizes of the updates are always kept as small as - possible. This is typically less than 5K, with an occasional + email. The sizes of the updates are always kept as small as + possible. This is typically less than 5K, with an occasional (one in ten) being 10-50K and every now and then a biggie of 100K+ or more coming around. You will also need to make yourself aware of the various caveats related to working directly from the development - sources rather than a pre-packaged release. This is particularly - true if you choose the “current” sources. It is recommended + sources rather than a pre-packaged release. This is particularly + true if you choose the “current” sources. It is recommended that you read Staying current with FreeBSD. @@ -804,7 +804,7 @@ subscribe cvs-all URL="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-current/src/usr.sbin/ctm">ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-current/src/usr.sbin/ctm The “deltas” you feed CTM can be had - two ways, FTP or e-mail. If you have general FTP access to the + two ways, FTP or e-mail. If you have general FTP access to the Internet then the following FTP sites support access to CTM: @@ -819,29 +819,29 @@ subscribe cvs-all If you may wish to get your deltas via email: Send email to &a.majordomo; to subscribe to one of the - CTM distribution lists. “ctm-cvs-cur” - supports the entire cvs tree. “ctm-src-cur” supports the head - of the development branch. “ctm-src-2_2” supports the 2.2 - release branch, etc. (If you do not know how to subscribe + CTM distribution lists. “ctm-cvs-cur” + supports the entire cvs tree. “ctm-src-cur” supports the head + of the development branch. “ctm-src-2_2” supports the 2.2 + release branch, etc. (If you do not know how to subscribe yourself using majordomo, send a message first containing the word help — it will send you back usage instructions.) When you begin receiving your CTM updates in the mail, you may use the ctm_rmail program - to unpack and apply them. You can actually use the + to unpack and apply them. You can actually use the ctm_rmail program directly from a entry in /etc/aliases if you want to have the - process run in a fully automated fashion. Check the + process run in a fully automated fashion. Check the ctm_rmail man page for more details. No matter what method you use to get the CTM deltas, you should subscribe to the - ctm-announce@FreeBSD.ORG mailing list. In the + ctm-announce@FreeBSD.ORG mailing list. In the future, this will be the only place where announcements concerning the operations of the CTM system - will be posted. Send an email to &a.majordomo; with a single + will be posted. Send an email to &a.majordomo; with a single line of subscribe ctm-announce to get added to the list. @@ -855,29 +855,29 @@ subscribe cvs-all you will need to get a to a starting point for the deltas produced subsequently to it. - First you should determine what you already have. Everyone - can start from an “empty” directory. You must use an + First you should determine what you already have. Everyone + can start from an “empty” directory. You must use an initial “Empty&rdquo delta to start off your - CTM supported tree. At some point it is + CTM supported tree. At some point it is intended that one of these “started” deltas be - distributed on the CD for your convenience. This does not + distributed on the CD for your convenience. This does not currently happen however. You can recognize However, since the trees are many tens of megabytes, you should prefer to start from - something already at hand. If you have a RELEASE CD, you can - copy or extract an initial source from it. This will save a + something already at hand. If you have a RELEASE CD, you can + copy or extract an initial source from it. This will save a significant transfer of data. You can recognize these “starter” deltas by the X appended to the number - (src-cur.3210XEmpty.gz for instance). The + (src-cur.3210XEmpty.gz for instance). The designation following the X - corresponds to the origin of your initial “seed”. Empty is - an empty directory. As a rule a base transition from + corresponds to the origin of your initial “seed”. Empty is + an empty directory. As a rule a base transition from Empty is produced - every 100 deltas. By the way, they are large! 25 to 30 + every 100 deltas. By the way, they are large! 25 to 30 Megabytes of gzip'ed data is common for the XEmpty deltas. @@ -901,7 +901,7 @@ However, since the trees need to gunzip them first, this saves disk space. Unless it feels very secure about the entire process, - CTM will not touch your tree. To verify a + CTM will not touch your tree. To verify a delta you can also use the flag and CTM will not actually touch your tree; it will merely verify the integrity of the delta and see if it @@ -916,13 +916,13 @@ However, since the trees make up my mind on what options should do what, how and when... - That's really all there is to it. Every time you get a new + That's really all there is to it. Every time you get a new delta, just run it through CTM to keep your sources up to date. Do not remove the deltas if they are hard to download again. You just might want to keep them around in case something bad - happens. Even if you only have floppy disks, consider using + happens. Even if you only have floppy disks, consider using fdwrite to make a copy. @@ -931,16 +931,16 @@ However, since the trees Keeping your local changes As a developer one would like to experiment with and change - files in the source tree. CTM supports local modifications in a + files in the source tree. CTM supports local modifications in a limited way: before checking for the presence of a file foo, it first looks for - foo.ctm. If this file exists, CTM will + foo.ctm. If this file exists, CTM will operate on it instead of foo. This behaviour gives us a simple way to maintain local changes: simply copy the files you plan to modify to the corresponding file names with a .ctm - suffix. Then you can freely hack the code, while CTM keeps the + suffix. Then you can freely hack the code, while CTM keeps the .ctm file up-to-date. @@ -998,7 +998,7 @@ However, since the trees For every file specified in a CTM delta, the and options - are applied in the order given on the command line. The file + are applied in the order given on the command line. The file is processed by CTM only if it is marked as eligible after all the and options are applied to it. @@ -1026,7 +1026,7 @@ However, since the trees The bad news is that I am very busy, so any help in doing - this will be most welcome. And do not forget to tell me what + this will be most welcome. And do not forget to tell me what you want also... @@ -1035,8 +1035,8 @@ However, since the trees Miscellaneous stuff All the “DES infected” (e.g. export controlled) source is - not included. You will get the “international” version only. - If sufficient interest appears, we will set up a sec-cur sequence too. There is a + not included. You will get the “international” version only. + If sufficient interest appears, we will set up a sec-cur sequence too. There is a sequence of deltas for the ports collection too, but interest has not been all that high yet. Tell me if you want an email list for that too and we will @@ -1106,28 +1106,28 @@ However, since the trees CVSup is a software package for distributing and updating source trees from a master CVS repository on a remote server - host. The FreeBSD sources are maintained in a CVS repository on - a central development machine in California. With CVSup, + host. The FreeBSD sources are maintained in a CVS repository on + a central development machine in California. With CVSup, FreeBSD users can easily keep their own source trees up to date. CVSup uses the so-called pull model of - updating. Under the pull model, each client asks the server for - updates, if and when they are wanted. The server waits - passively for update requests from its clients. Thus all - updates are instigated by the client. The server never sends - unsolicited updates. Users must either run the CVSup client + updating. Under the pull model, each client asks the server for + updates, if and when they are wanted. The server waits + passively for update requests from its clients. Thus all + updates are instigated by the client. The server never sends + unsolicited updates. Users must either run the CVSup client manually to get an update, or they must set up a cron job to run it automatically on a regular basis. The term CVSup, capitalized just so, refers to the entire - software package. Its main components are the client cvsup + software package. Its main components are the client cvsup which runs on each user's machine, and the server cvsupd which runs at each of the FreeBSD mirror sites. As you read the FreeBSD documentation and mailing lists, you - may see references to sup. Sup was the - predecessor of CVSup, and it served a similar purpose. CVSup is + may see references to sup. Sup was the + predecessor of CVSup, and it served a similar purpose. CVSup is in used in much the same way as sup and, in fact, uses configuration files which are backward-compatible with sup's. Sup is no longer used in the FreeBSD project, because CVSup is @@ -1145,15 +1145,15 @@ However, since the trees If you are running FreeBSD-2.1.6 or 2.1.7, you unfortunately cannot use the binary package versions due to the fact that they require a version of the C library that does not yet exist in - FreeBSD-2.1.{6,7}. You can easily use the port, however, just as with FreeBSD 2.2. Simply unpack the tar file, cd to the cvsup subdirectory and type make install. + FreeBSD-2.1.{6,7}. You can easily use the port, however, just as with FreeBSD 2.2. Simply unpack the tar file, cd to the cvsup subdirectory and type make install. Because CVSup is written in Modula-3, both the package and the port require that the Modula-3 runtime libraries be installed. These are available as the lang/modula-3-lib port and the lang/modula-3-lib-3.6 package. If you follow the same directions as for cvsup, these libraries will be compiled and/or installed automatically when you install the CVSup port or package. + URL="http://www.research.digital.com/SRC/modula-3/html/home.html">Modula-3, both the package and the port require that the Modula-3 runtime libraries be installed. These are available as the lang/modula-3-lib port and the lang/modula-3-lib-3.6 package. If you follow the same directions as for cvsup, these libraries will be compiled and/or installed automatically when you install the CVSup port or package. The Modula-3 libraries are rather large, and fetching and - compiling them is not an instantaneous process. For that - reason, a third option is provided. You can get + compiling them is not an instantaneous process. For that + reason, a third option is provided. You can get statically linked FreeBSD executables for CVSup from either the USA distribution site: @@ -1202,7 +1202,7 @@ However, since the trees - Most users will need only the client. These executables are + Most users will need only the client. These executables are entirely self-contained, and they will run on any version of FreeBSD from FreeBSD-2.1.0 to FreeBSD-current. @@ -1234,10 +1234,10 @@ However, since the trees Configuration CVSup's operation is controlled by a configuration file - called the supfile. Beginning with + called the supfile. Beginning with FreeBSD-2.2, there are some sample supfiles in the directory /usr/share/examples/cvsup. These examples are also available from ftp://ftp.FreeBSD.org/pub/FreeBSD/FreeBSD-current/src/share/examples/cvsup/ if you are on a pre-2.2 system. + URL="file:/usr/share/examples/cvsup">/usr/share/examples/cvsup. These examples are also available from ftp://ftp.FreeBSD.org/pub/FreeBSD/FreeBSD-current/src/share/examples/cvsup/ if you are on a pre-2.2 system. The information in a supfile answers the following questions for cvsup: @@ -1275,38 +1275,38 @@ However, since the trees In the following sections, we will construct a typical supfile by answering each of these - questions in turn. First, we describe the overall structure of + questions in turn. First, we describe the overall structure of a supfile. - A supfile is a text file. Comments - begin with # and extend to the end of the line. Lines that + A supfile is a text file. Comments + begin with # and extend to the end of the line. Lines that are blank and lines that contain only comments are ignored. Each remaining line describes a set of files that the user - wishes to receive. The line begins with the name of a + wishes to receive. The line begins with the name of a “collection”, a logical grouping of files defined by the server. The name of the collection tells the server which files you - want. After the collection name come zero or more fields, - separated by white space. These fields answer the questions - listed above. There are two types of fields: flag fields and - value fields. A flag field consists of a keyword standing - alone, e.g., delete or compress. A value field also begins + want. After the collection name come zero or more fields, + separated by white space. These fields answer the questions + listed above. There are two types of fields: flag fields and + value fields. A flag field consists of a keyword standing + alone, e.g., delete or compress. A value field also begins with a keyword, but the keyword is followed without intervening - white space by = and a second word. For example, + white space by = and a second word. For example, release=cvs is a value field. A supfile typically specifies more than - one collection to receive. One way to structure a + one collection to receive. One way to structure a supfile is to specify all of the relevant - fields explicitly for each collection. However, that tends to + fields explicitly for each collection. However, that tends to make the supfile lines quite long, and it is inconvenient because most fields are the same for all of the - collections in a supfile. CVSup provides a - defaulting mechanism to avoid these problems. Lines beginning + collections in a supfile. CVSup provides a + defaulting mechanism to avoid these problems. Lines beginning with the special pseudo-collection name *default can be used to set flags and values which will be used as defaults for the - subsequent collections in the supfile. A + subsequent collections in the supfile. A default value can be overridden for an individual collection, by specifying a different value with the collection itself. Defaults can also be changed or augmented in mid-supfile by @@ -1324,15 +1324,15 @@ However, since the trees Which files do you want to receive? The files available via CVSup are organized into named - groups called “collections”. The collections that are + groups called “collections”. The collections that are available are described here. In this example, we wish to receive the - entire main source tree for the FreeBSD system. There is + linkend="cvsup-collec">here. In this example, we wish to receive the + entire main source tree for the FreeBSD system. There is a single large collection src-all which will give us all of that, except the export-controlled cryptography - support. Let us assume for this example that we are in - the USA or Canada. Then we can get the cryptography code - with one additional collection, cvs-crypto. As a first + support. Let us assume for this example that we are in + the USA or Canada. Then we can get the cryptography code + with one additional collection, cvs-crypto. As a first step toward constructing our supfile, we simply list these collections, one per line: @@ -1345,30 +1345,30 @@ cvs-crypto Which version(s) of them do you want? With CVSup, you can receive virtually any version of - the sources that ever existed. That is possible because + the sources that ever existed. That is possible because the cvsupd server works directly from the CVS repository, - which contains all of the versions. You specify which one + which contains all of the versions. You specify which one of them you want using the tag= and value fields. Be very - careful to specify any tag= fields correctly. Some tags - are valid only for certain collections of files. If you + careful to specify any tag= fields correctly. Some tags + are valid only for certain collections of files. If you specify an incorrect or misspelled tag, CVSup will delete - files which you probably do not want deleted. In + files which you probably do not want deleted. In particular, use only tag=. for the ports-* collections. The tag= field names a symbolic tag in the - repository. There are two kinds of tags, revision tags - and branch tags. A revision tag refers to a specific - revision. Its meaning stays the same from day to day. A + repository. There are two kinds of tags, revision tags + and branch tags. A revision tag refers to a specific + revision. Its meaning stays the same from day to day. A branch tag, on the other hand, refers to the latest revision on a given line of development, at any given - time. Because a branch tag does not refer to a specific + time. Because a branch tag does not refer to a specific revision, it may mean something different tomorrow than it means today. @@ -1384,7 +1384,7 @@ cvs-crypto The . is not punctuation; it is the name - of the tag. Valid for all collections. + of the tag. Valid for all collections. @@ -1394,7 +1394,7 @@ cvs-crypto The line of development for FreeBSD-3.x, also known as - FreeBSD-stable. Not valid for the ports collection. + FreeBSD-stable. Not valid for the ports collection. @@ -1403,7 +1403,7 @@ cvs-crypto The line of development for FreeBSD-2.2.x, also known as - 2.2-stable. Not valid for the ports collection. + 2.2-stable. Not valid for the ports collection. @@ -1411,7 +1411,7 @@ cvs-crypto The line of development for FreeBSD-2.1.x - - this branch is largely obsolete. Not valid for the + this branch is largely obsolete. Not valid for the ports-* collections. @@ -1428,7 +1428,7 @@ cvs-crypto tag=RELENG_3_0_0_RELEASE - FreeBSD-3.0. Not valid for the ports-* + FreeBSD-3.0. Not valid for the ports-* collections. @@ -1437,7 +1437,7 @@ cvs-crypto tag=RELENG_2_2_8_RELEASE - FreeBSD-2.2.8. Not valid for the ports-* + FreeBSD-2.2.8. Not valid for the ports-* collections. @@ -1446,14 +1446,14 @@ cvs-crypto tag=RELENG_2_2_7_RELEASE - FreeBSD-2.2.7. Not valid for the ports-* + FreeBSD-2.2.7. Not valid for the ports-* collections. tag=RELENG_2_2_6_RELEASE - FreeBSD-2.2.6. Not valid for the ports-* + FreeBSD-2.2.6. Not valid for the ports-* collections. @@ -1462,7 +1462,7 @@ cvs-crypto tag=RELENG_2_2_5_RELEASE - FreeBSD-2.2.5. Not valid for the ports-* + FreeBSD-2.2.5. Not valid for the ports-* collections. @@ -1471,7 +1471,7 @@ cvs-crypto tag=RELENG_2_2_2_RELEASE - FreeBSD-2.2.2. Not valid for the ports-* + FreeBSD-2.2.2. Not valid for the ports-* collections. @@ -1480,7 +1480,7 @@ cvs-crypto tag=RELENG_2_2_1_RELEASE - FreeBSD-2.2.1. Not valid for the ports-* + FreeBSD-2.2.1. Not valid for the ports-* collections. @@ -1489,7 +1489,7 @@ cvs-crypto tag=RELENG_2_2_0_RELEASE - FreeBSD-2.2.0. Not valid for the ports-* + FreeBSD-2.2.0. Not valid for the ports-* collections. @@ -1498,7 +1498,7 @@ cvs-crypto tag=RELENG_2_1_7_RELEASE - FreeBSD-2.1.7. Not valid for the ports-* + FreeBSD-2.1.7. Not valid for the ports-* collections. @@ -1507,7 +1507,7 @@ cvs-crypto tag=RELENG_2_1_6_1_RELEASE - FreeBSD-2.1.6.1. Not valid for the ports-* + FreeBSD-2.1.6.1. Not valid for the ports-* collections. @@ -1516,7 +1516,7 @@ cvs-crypto tag=RELENG_2_1_6_RELEASE - FreeBSD-2.1.6. Not valid for the ports-* + FreeBSD-2.1.6. Not valid for the ports-* collections. @@ -1525,7 +1525,7 @@ cvs-crypto tag=RELENG_2_1_5_RELEASE - FreeBSD-2.1.5. Not valid for the ports-* + FreeBSD-2.1.5. Not valid for the ports-* collections. @@ -1534,7 +1534,7 @@ cvs-crypto tag=RELENG_2_1_0_RELEASE - FreeBSD-2.1.0. Not valid for the ports-* + FreeBSD-2.1.0. Not valid for the ports-* collections. @@ -1544,19 +1544,19 @@ cvs-crypto Be very - careful to type the tag name exactly as shown. CVSup - cannot distinguish between valid and invalid tags. If you + careful to type the tag name exactly as shown. CVSup + cannot distinguish between valid and invalid tags. If you misspell the tag, CVSup will behave as though you had specified a valid tag which happens to refer to no files - at all. It will delete your existing sources in that + at all. It will delete your existing sources in that case. When you specify a branch tag, you normally receive the latest versions of the files on that line of - development. If you wish to receive some past version, + development. If you wish to receive some past version, you can do so by specifying a date with the value - field. The cvsup1 manual page explains how to do + field. The cvsup1 manual page explains how to do that. For our example, we wish to receive FreeBSD-current. @@ -1569,13 +1569,13 @@ cvs-crypto There is an important special case that comes into play if you specify neither a tag= field nor a date= - field. In that case, you receive the actual RCS files + field. In that case, you receive the actual RCS files directly from the server's CVS repository, rather than - receiving a particular version. Developers generally - prefer this mode of operation. By maintaining a copy of + receiving a particular version. Developers generally + prefer this mode of operation. By maintaining a copy of the repository itself on their systems, they gain the ability to browse the revision histories and examine past - versions of files. This gain is achieved at a large cost + versions of files. This gain is achieved at a large cost in terms of disk space, however. @@ -1583,17 +1583,17 @@ cvs-crypto Where do you want to get them from? We use the host= field to tell cvsup where to obtain - its updates. Any of the CVSup mirror sites will do, though you should try to select - one that is close to you in cyberspace. In this example we + one that is close to you in cyberspace. In this example we will use a fictional FreeBSD distribution site, cvsup666.FreeBSD.org: *default host=cvsup666.FreeBSD.org You will need to change the host to one that actually -exists before running CVSup. On any particular run of +exists before running CVSup. On any particular run of cvsup, you can override the host setting on the command line, with . @@ -1603,8 +1603,8 @@ exists before running CVSup. On any particular run of machine? The prefix= field tells cvsup where to put the files - it receives. In this example, we will put the source files - directly into our main source tree, /usr/src. The src + it receives. In this example, we will put the source files + directly into our main source tree, /usr/src. The src directory is already implicit in the collections we have chosen to receive, so this is the correct specification: @@ -1617,9 +1617,9 @@ exists before running CVSup. On any particular run of Where should cvsup maintain its status files? The cvsup client maintains certain status files in - what is called the “base” directory. These files help + what is called the “base” directory. These files help CVSup to work more efficiently, by keeping track of which - updates you have already received. We will use the + updates you have already received. We will use the standard base directory, /usr/local/etc/cvsup: @@ -1630,7 +1630,7 @@ exists before running CVSup. On any particular run of need the above line. If your base directory does not already exist, now - would be a good time to create it. The cvsup client will + would be a good time to create it. The cvsup client will refuse to run if the base directory does not exist. @@ -1644,24 +1644,24 @@ exists before running CVSup. On any particular run of *default release=cvs delete use-rel-suffix compress release=cvs indicates that the server should get its - information out of the main FreeBSD CVS repository. This + information out of the main FreeBSD CVS repository. This is virtually always the case, but there are other possibilities which are beyond the scope of this discussion. - delete gives CVSup permission to delete files. You + delete gives CVSup permission to delete files. You should always specify this, so that CVSup can keep your - source tree fully up to date. CVSup is careful to delete - only those files for which it is responsible. Any extra + source tree fully up to date. CVSup is careful to delete + only those files for which it is responsible. Any extra files you happen to have will be left strictly alone. - use-rel-suffix is ... arcane. If you really want to - know about it, see the cvsup1 manual page. Otherwise, + use-rel-suffix is ... arcane. If you really want to + know about it, see the cvsup1 manual page. Otherwise, just specify it and do not worry about it. compress enables the use of gzip-style compression - on the communication channel. If your network link is T1 + on the communication channel. If your network link is T1 speed or faster, you probably should not use compression. Otherwise, it helps substantially. @@ -1691,7 +1691,7 @@ cvs-crypto Running <application>CVSup</application> - You are now ready to try an update. The command line for + You are now ready to try an update. The command line for doing this is quite simple: @@ -1699,17 +1699,17 @@ cvs-crypto where supfile is of course the name of the supfile you - have just created. Assuming you are running under X11, cvsup + have just created. Assuming you are running under X11, cvsup will display a GUI window with some buttons to do the usual - things. Press the “go” button, and watch it run. + things. Press the “go” button, and watch it run. Since you are updating your actual /usr/src tree in this example, you will need to run the program as root so that cvsup - has the permissions it needs to update your files. Having just + has the permissions it needs to update your files. Having just created your configuration file, and having never used this program before, that might understandably make you nervous. There is an easy way to do a trial run without touching your - precious files. Just create an empty directory somewhere + precious files. Just create an empty directory somewhere convenient, and name it as an extra argument on the command line: @@ -1719,13 +1719,13 @@ cvs-crypto The directory you specify will be used as the destination - directory for all file updates. CVSup will examine your usual + directory for all file updates. CVSup will examine your usual files in /usr/src, but it will not modify - or delete any of them. Any file updates will instead land in - /var/tmp/dest/usr/src. CVSup will also + or delete any of them. Any file updates will instead land in + /var/tmp/dest/usr/src. CVSup will also leave its base directory status files untouched when run this - way. The new versions of those files will be written into the - specified directory. As long as you have read access to + way. The new versions of those files will be written into the + specified directory. As long as you have read access to /usr/src, you do not even need to be root to perform this kind of trial run. @@ -1737,21 +1737,21 @@ cvs-crypto &prompt.root; cvsup -g -L 2 supfile - The tells cvsup not to use its GUI. This is automatic + The tells cvsup not to use its GUI. This is automatic if you are not running X11, but otherwise you have to specify it. The tells cvsup to print out the details of all the - file updates it is doing. There are three levels of verbosity, - from to . The default is 0, which means total + file updates it is doing. There are three levels of verbosity, + from to . The default is 0, which means total silence except for error messages. - There are plenty of other options available. For a brief - list of them, type cvsup -H. For more detailed descriptions, + There are plenty of other options available. For a brief + list of them, type cvsup -H. For more detailed descriptions, see the manual page. Once you are satisfied with the way updates are working, you - can arrange for regular runs of cvsup using cron8. Obviously, + can arrange for regular runs of cvsup using cron8. Obviously, you should not let cvsup use its GUI when running it from cron. @@ -1761,14 +1761,14 @@ cvs-crypto <application>CVSup</application> File Collections The file collections available via CVSup are organized - hierarchically. There are a few large collections, and they are - divided into smaller sub-collections. Receiving a large + hierarchically. There are a few large collections, and they are + divided into smaller sub-collections. Receiving a large collection is equivalent to receiving each of its - sub-collections. The hierarchical relationships among + sub-collections. The hierarchical relationships among collections are reflected by the use of indentation in the list below. - The most commonly used collections are src-all, cvs-crypto, and ports-all. The other collections are used + The most commonly used collections are src-all, cvs-crypto, and ports-all. The other collections are used only by small groups of people for specialized purposes, and some mirror sites may not carry all of them. @@ -2451,7 +2451,7 @@ cvs-crypto release=self - The CVSup server's own configuration files. Used by + The CVSup server's own configuration files. Used by CVSup mirror sites. @@ -2479,7 +2479,7 @@ cvs-crypto release=current - The installed World Wide Web data. Used by WWW + The installed World Wide Web data. Used by WWW mirror sites. @@ -2497,7 +2497,7 @@ cvs-crypto Page. Most FreeBSD-related discussion of CVSup takes place on the - &a.hackers;. New versions of the software are announced there, + &a.hackers;. New versions of the software are announced there, as well as on the &a.announce;. Questions and bug reports should be addressed to the author diff --git a/en/handbook/disks/chapter.sgml b/en/handbook/disks/chapter.sgml index 1bfe3b074c..abf4234f94 100644 --- a/en/handbook/disks/chapter.sgml +++ b/en/handbook/disks/chapter.sgml @@ -4,84 +4,84 @@ Contributed by &a.obrien; 26 April 1998 Lets say we want to add a new SCSI disk to a machine that currently - only has a single drive. First turn off the computer and install the + only has a single drive. First turn off the computer and install the drive in the computer following the instructions of the computer, - controller, and drive manufacturer. Due the wide variations of procedures + controller, and drive manufacturer. Due the wide variations of procedures to do this, the details are beyond the scope of this document. - Login as user root. After you've installed the + Login as user root. After you've installed the drive, inspect /var/run/dmesg.boot to ensure the new - disk was found. Continuing with our example, the newly added drive will be + disk was found. Continuing with our example, the newly added drive will be sd1 and we want to mount it on - /1. (if you are adding an IDE drive substitute + /1. (if you are adding an IDE drive substitute wd for sd) Because FreeBSD runs on IBM-PC compatible computers, it must take into - account the PC BIOS partitions. These are different from the traditional - BSD partitions. A PC disk has up to four BIOS partition entries. If the + account the PC BIOS partitions. These are different from the traditional + BSD partitions. A PC disk has up to four BIOS partition entries. If the disk is going to be truly dedicated to FreeBSD, you can use the - dedicated mode. Otherwise, FreeBSD will have to live - with in one of the PC BIOS partitions. FreeBSD calls the PC BIOS + dedicated mode. Otherwise, FreeBSD will have to live + with in one of the PC BIOS partitions. FreeBSD calls the PC BIOS partitions, slices so as not to confuse them with - traditional BSD partitions. You may also use slices on a disk that is + traditional BSD partitions. You may also use slices on a disk that is dedicated to FreeBSD, but used in a computer that also has another - operating system installed. This is to not confuse the + operating system installed. This is to not confuse the fdisk utility of the other operating system. In the slice case the drive will be added as - /dev/sd1s1e. This is read as: SCSI disk, unit number + /dev/sd1s1e. This is read as: SCSI disk, unit number 1 (second SCSI disk), slice 1 (PC BIOS partition 1), and - e BSD partition. In the dedicated case, the drive + e BSD partition. In the dedicated case, the drive will be added simply as /dev/sd1e. Using sysinstall You may use /stand/sysinstall to partition and - label a new disk using its easy to use menus. Either login as user - root or use the su command. Run + label a new disk using its easy to use menus. Either login as user + root or use the su command. Run /stand/sysinstall and enter the - Configure menu. With in the FreeBSD + Configure menu. With in the FreeBSD Configuration Menu, scroll down and select the - Partition item. Next you should be presented with a - list of hard drives installed in your system. If you do not see + Partition item. Next you should be presented with a + list of hard drives installed in your system. If you do not see sd1 listed, you need to recheck your physical installation and dmesg output in the file /var/run/dmesg.boot. Select sd1 to enter the FDISK Partition - Editor. Choose A to use the entire disk - for FreeBSD. When asked if you want to remain cooperative with + Editor. Choose A to use the entire disk + for FreeBSD. When asked if you want to remain cooperative with any future possible operating systems, answer - YES. Write the changes to the disk using - W. Now exit the FDISK editor using - q. Next you will be asked about the Master Boot - Record. Since you are adding a disk to an already running system, choose + YES. Write the changes to the disk using + W. Now exit the FDISK editor using + q. Next you will be asked about the Master Boot + Record. Since you are adding a disk to an already running system, choose None. - Next enter the Disk Label Editor. This is where - you will create the traditional BSD partitions. A disk can have up to - eight partitions, labeled a-h. A few of the partition labels have - special uses. The a partition is used for the root - partition (/). Thus only your system disk (e.g, the - disk you boot from) should have an a partition. The + Next enter the Disk Label Editor. This is where + you will create the traditional BSD partitions. A disk can have up to + eight partitions, labeled a-h. A few of the partition labels have + special uses. The a partition is used for the root + partition (/). Thus only your system disk (e.g, the + disk you boot from) should have an a partition. The b partition is used for swap partitions, and you may - have many disks with swap partitions. The c partition + have many disks with swap partitions. The c partition addresses the entire disk in dedicated mode, or the entire FreeBSD slice - in slice mode. The other partitions are for general use. + in slice mode. The other partitions are for general use. Sysinstall's Label editor favors the e partition - for non-root, non-swap partitions. With in the Label editor, create a - single file system using C. When prompted if this + for non-root, non-swap partitions. With in the Label editor, create a + single file system using C. When prompted if this will be a FS (file system) or swap, choose FS and - give a mount point (e.g, /mnt). When adding a disk + give a mount point (e.g, /mnt). When adding a disk in post-install mode, Sysinstall will not create entries in /etc/fstab for you, so the mount point you specify isn't important. You are now ready to write the new label to the disk and create a - file system on it. Do this by hitting W. Ignore any - errors from Sysinstall that it could not mount the new partition. Exit + file system on it. Do this by hitting W. Ignore any + errors from Sysinstall that it could not mount the new partition. Exit the Label Editor and Sysinstall completely. The last step is to edit /etc/fstab to add an @@ -101,9 +101,9 @@ Dedicated If you will not be sharing the new drive with another operating - system, you may use the dedicated mode. Remember + system, you may use the dedicated mode. Remember this mode can confuse Microsoft operating systems; however, no damage - will be done by them. IBM's OS/2 however, will + will be done by them. IBM's OS/2 however, will “appropriate” any partition it finds which it doesn't understand. diff --git a/en/handbook/eresources/chapter.sgml b/en/handbook/eresources/chapter.sgml index 5346c92816..83b09ef7a0 100644 --- a/en/handbook/eresources/chapter.sgml +++ b/en/handbook/eresources/chapter.sgml @@ -4,15 +4,15 @@ Contributed by &a.jkh;. The rapid pace of FreeBSD progress makes print media impractical - as a means of following the latest developments. Electronic resources + as a means of following the latest developments. Electronic resources are the best, if not often the only, way stay informed of the latest - advances. Since FreeBSD is a volunteer effort, the user community + advances. Since FreeBSD is a volunteer effort, the user community itself also generally serves as a “technical support department” of sorts, with electronic mail and USENET news being the most effective way of reaching that community. The most important points of contact with the FreeBSD user - community are outlined below. If you are aware of other resources not + community are outlined below. If you are aware of other resources not mentioned here, please send them to the &a.doc;so that they may also be included. @@ -23,14 +23,14 @@ Though many of the FreeBSD development members read USENET, we cannot always guarantee that we will get to your questions in a timely fashion (or at all) if you post them only to one of the - comp.unix.bsd.freebsd.* groups. By addressing your questions to the + comp.unix.bsd.freebsd.* groups. By addressing your questions to the appropriate mailing list you will reach both us and a concentrated FreeBSD audience, invariably assuring a better (or at least faster) response. The charters for the various lists are given at the bottom of - this document. Please read the charter before - joining or sending mail to any list. Most of our list + this document. Please read the charter before + joining or sending mail to any list. Most of our list subscribers now receive many hundreds of FreeBSD related messages every day, and by setting down charters and rules for proper use we are striving to keep the signal-to-noise ratio of the lists high. @@ -40,7 +40,7 @@ Archives are kept for all of the mailing lists and can be searched using the FreeBSD World Wide Web - server. The keyword searchable archive offers an + server. The keyword searchable archive offers an excellent way of finding answers to frequently asked questions and should be consulted before posting a question. @@ -121,7 +121,7 @@ Technical lists: The following - lists are for technical discussion. You should read the charter + lists are for technical discussion. You should read the charter for each list carefully before joining or sending mail to one as there are firm guidelines for their use and content. @@ -252,7 +252,7 @@ Limited lists: The following lists require approval from core@FreeBSD.ORG to join, though anyone is free to send messages to them which fall within - the scope of their charters. It is also a good idea establish a + the scope of their charters. It is also a good idea establish a presence in the technical lists before asking to join one of these limited lists. @@ -307,7 +307,7 @@ CVS lists: The following lists are for people interested in seeing the log messages for changes - to various areas of the source tree. They are Read-Only lists and should not have mail + to various areas of the source tree. They are Read-Only lists and should not have mail sent to them. @@ -336,7 +336,7 @@ All mailing lists live on FreeBSD.ORG, so to post to a given list you simply mail to - listname@FreeBSD.ORG. It will + listname@FreeBSD.ORG. It will then be redistributed to mailing list members world-wide. To subscribe to a list, send mail to &a.majordomo; and include @@ -344,7 +344,7 @@ subscribe <listname> [<optional address>] - in the body of your message. For example, to + in the body of your message. For example, to subscribe yourself to freebsd-announce, you'd do: @@ -368,7 +368,7 @@ subscribe freebsd-announce local-announce@somesite.com Finally, it is also possible to unsubscribe yourself from a list, get a list of other list members or see the list of mailing lists again by sending other types of control - messages to majordomo. For a complete list of available commands, + messages to majordomo. For a complete list of available commands, do this: @@ -407,9 +407,9 @@ help The topic of any posting should adhere to the basic charter of the list it is posted to, e.g. if the list is about technical issues then your posting should contain - technical discussion. Ongoing irrelevant chatter or flaming + technical discussion. Ongoing irrelevant chatter or flaming only detracts from the value of the mailing list for - everyone on it and will not be tolerated. For free-form + everyone on it and will not be tolerated. For free-form discussion on no particular topic, the freebsd-chat freebsd-chat@freebsd.org mailing list is freely available and should be used instead. @@ -418,13 +418,13 @@ help No posting should be made to more than 2 mailing lists, and only to 2 when a clear and obvious need to post to both - lists exists. For most lists, there is already a great deal + lists exists. For most lists, there is already a great deal of subscriber overlap and except for the most esoteric mixes (say "-stable & -scsi"), there really is no reason to - post to more than one list at a time. If a message is sent + post to more than one list at a time. If a message is sent to you in such a way that multiple mailing lists appear on the Cc line then the cc line should also be trimmed before - sending it out again. You are still responsible for your own + sending it out again. You are still responsible for your own cross-postings, no matter who the originator might have been. @@ -432,10 +432,10 @@ help Personal attacks and profanity (in the context of an argument) are not allowed, and that includes users and - developers alike. Gross breaches of netiquette, like + developers alike. Gross breaches of netiquette, like excerpting or reposting private mail when permission to do so was not and would not be forthcoming, are frowned upon - but not specifically enforced. However, there are also very few cases + but not specifically enforced. However, there are also very few cases where such content would fit within the charter of a list and it would therefore probably rate a warning (or ban) on that basis alone. @@ -470,7 +470,7 @@ help This list is purely for discussion of freebsd.org related issues and to report problems or abuse of project - resources. It is a closed list, though anyone may report + resources. It is a closed list, though anyone may report a problem (with our systems!) to it. @@ -484,8 +484,8 @@ help This is the mailing list for people interested only in occasional announcements of significant FreeBSD events. This includes announcements about snapshots and other - releases. It contains announcements of new FreeBSD - capabilities. It may contain calls for volunteers etc. + releases. It contains announcements of new FreeBSD + capabilities. It may contain calls for volunteers etc. This is a low volume, strictly moderated mailing list. @@ -498,10 +498,10 @@ help discussions This is a moderated list for discussion of FreeBSD - architecture. Messages will mostly be kept technical in + architecture. Messages will mostly be kept technical in nature, with (rare) exceptions for other messages the moderator deems need to reach all the subscribers of the - list. Examples of suitable topics; + list. Examples of suitable topics; @@ -527,7 +527,7 @@ help The moderator reserves the right to do minor editing (spell-checking, grammar correction, trimming) of messages - that are posted to the list. The volume of the list will be + that are posted to the list. The volume of the list will be kept low, which may involve having to delay topics until an active discussion has been resolved. @@ -555,11 +555,11 @@ help This list contains the overflow from the other lists about non-technical, social - information. It includes discussion about whether Jordan + information. It includes discussion about whether Jordan looks like a toon ferret or not, whether or not to type in capitals, who is drinking too much coffee, where the best beer is brewed, who is brewing beer in their basement, and - so on. Occasional announcements of important events (such + so on. Occasional announcements of important events (such as upcoming parties, weddings, births, new jobs, etc) can be made to the technical lists, but the follow ups should be directed to this -chat list. @@ -572,7 +572,7 @@ help FreeBSD core team This is an internal mailing list for use by the core - members. Messages can be sent to it when a serious + members. Messages can be sent to it when a serious FreeBSD-related matter requires arbitration or high-level scrutiny. @@ -585,11 +585,11 @@ help FreeBSD-current This is the - mailing list for users of freebsd-current. It includes + mailing list for users of freebsd-current. It includes warnings about new features coming out in -current that will affect the users, and instructions on steps that must - be taken to remain -current. Anyone running “current” must - subscribe to this list. This is a technical mailing list + be taken to remain -current. Anyone running “current” must + subscribe to this list. This is a technical mailing list for which strictly technical content is expected. @@ -601,10 +601,10 @@ help FreeBSD-current This is the - digest version of the freebsd-current mailing list. The + digest version of the freebsd-current mailing list. The digest consists of all messages sent to freebsd-current - bundled together and mailed out as a single message. The - average digest size is about 40kB. This list is Read-Only and should not be posted + bundled together and mailed out as a single message. The + average digest size is about 40kB. This list is Read-Only and should not be posted to. @@ -616,9 +616,9 @@ help This mailing list is for the discussion of issues and projects related to the creation of documenation for - FreeBSD. The members of this mailing list are collectively + FreeBSD. The members of this mailing list are collectively referred to as “The FreeBSD Documentation - Project”. It is an open list; feel free to join and + Project”. It is an open list; feel free to join and contribute! @@ -628,7 +628,7 @@ help Filesystems - Discussions concerning FreeBSD filesystems. This is a + Discussions concerning FreeBSD filesystems. This is a technical mailing list for which strictly technical content is expected. @@ -662,11 +662,11 @@ help Technical discussions This is a forum for technical discussions related to - FreeBSD. This is the primary technical mailing list. It + FreeBSD. This is the primary technical mailing list. It is for individuals actively working on FreeBSD, to bring - up problems or discuss alternative solutions. Individuals + up problems or discuss alternative solutions. Individuals interested in following the technical discussion are also - welcome. This is a technical mailing list for which + welcome. This is a technical mailing list for which strictly technical content is expected. @@ -677,9 +677,9 @@ help Technical discussions This is the digest version of the freebsd-hackers - mailing list. The digest consists of all messages sent to + mailing list. The digest consists of all messages sent to freebsd-hackers bundled together and mailed out as a - single message. The average digest size is about 40kB. + single message. The average digest size is about 40kB. This list is Read-Only and should not be posted to. @@ -717,7 +717,7 @@ help This mailing list is for discussing topics relevant to Internet Service - Providers (ISPs) using FreeBSD. This is a technical + Providers (ISPs) using FreeBSD. This is a technical mailing list for which strictly technical content is expected. @@ -735,7 +735,7 @@ help and asking for help elsewhere, how to use mailing lists and which lists to use, general chat, making mistakes, boasting, sharing ideas, stories, moral (but not technical) support, and - taking an active part in the FreeBSD community. We take our + taking an active part in the FreeBSD community. We take our problems and support questions to freebsd-questions, and use freebsd-newbies to meet others who are doing the same things that we do as newbies. @@ -750,7 +750,7 @@ help Cross-platform freebsd issues, general discussion and proposals for non-Intel - FreeBSD ports. This is a technical mailing list for which + FreeBSD ports. This is a technical mailing list for which strictly technical content is expected. @@ -764,7 +764,7 @@ help Discussions concerning FreeBSD's “ports collection” (/usr/ports), proposed ports, modifications to ports collection infrastructure and general coordination - efforts. This is a technical mailing list for which + efforts. This is a technical mailing list for which strictly technical content is expected. @@ -775,7 +775,7 @@ help User questions This - is the mailing list for questions about FreeBSD. You + is the mailing list for questions about FreeBSD. You should not send “how to” questions to the technical lists unless you consider the question to be pretty technical. @@ -789,9 +789,9 @@ help This is the digest version of the freebsd-questions mailing - list. The digest consists of all messages sent to + list. The digest consists of all messages sent to freebsd-questions bundled together and mailed out as a - single message. The average digest size is about + single message. The average digest size is about 40kB. @@ -803,7 +803,7 @@ help This is the mailing list for people working on the scsi - subsystem for FreeBSD. This is a technical mailing list + subsystem for FreeBSD. This is a technical mailing list for which strictly technical content is expected. @@ -814,7 +814,7 @@ help Security issues FreeBSD computer security issues (DES, Kerberos, known - security holes and fixes, etc). This is a technical + security holes and fixes, etc). This is a technical mailing list for which strictly technical content is expected. @@ -825,7 +825,7 @@ help Security Notifications Notifications of FreeBSD security problems and fixes. - This is not a discussion list. The discussion list is + This is not a discussion list. The discussion list is FreeBSD-security. @@ -835,7 +835,7 @@ help This list discusses topics related to unsually small and - embedded FreeBSD installations. This is a technical mailing + embedded FreeBSD installations. This is a technical mailing list for which strictly technical content is expected. @@ -847,11 +847,11 @@ help FreeBSD-stable This is the - mailing list for users of freebsd-stable. It includes + mailing list for users of freebsd-stable. It includes warnings about new features coming out in -stable that will affect the users, and instructions on steps that must - be taken to remain -stable. Anyone running “stable” - should subscribe to this list. This is a technical mailing + be taken to remain -stable. Anyone running “stable” + should subscribe to this list. This is a technical mailing list for which strictly technical content is expected. @@ -866,9 +866,9 @@ help This is the mailing list for the coordinators from each of the local area Users Groups to discuss matters with each other and a designated individual from the Core - Team. This mail list should be limited to meeting + Team. This mail list should be limited to meeting synopsis and coordination of projects that span User - Groups. It is a closed list. + Groups. It is a closed list. @@ -882,7 +882,7 @@ help In addition to two FreeBSD specific newsgroups, there are many others in which FreeBSD is discussed or are otherwise relevant to - FreeBSD users. Keyword searchable archives are available for some of these newsgroups from courtesy of Warren Toomey wkt@cs.adfa.oz.au. diff --git a/en/handbook/handbook.sgml b/en/handbook/handbook.sgml index a16117c8ed..73e1dd73be 100644 --- a/en/handbook/handbook.sgml +++ b/en/handbook/handbook.sgml @@ -4,7 +4,7 @@ %mailing-lists; %newsgroups; - @@ -33,18 +33,18 @@ Welcome to FreeBSD! This handbook covers the installation and day - to day use of FreeBSD Release &rel.current;. This + to day use of FreeBSD Release &rel.current;. This manual is a work in progress and is the work of - many individuals. Many sections do not yet exist and some of those - that do exist need to be updated. If you are interested in helping - with this project, send email to the &a.doc;. The latest version of + many individuals. Many sections do not yet exist and some of those + that do exist need to be updated. If you are interested in helping + with this project, send email to the &a.doc;. The latest version of this document is always available from the FreeBSD World Wide Web server. It may also be downloaded in plain text, postscript or HTML with HTTP or gzip'd from the FreeBSD FTP server or one of the numerous mirror sites. You may also want to + linkend="mirrors-ftp">mirror sites. You may also want to Search the Handbook. diff --git a/en/handbook/hw/chapter.sgml b/en/handbook/hw/chapter.sgml index 9397bbcfee..2a12526c35 100644 --- a/en/handbook/hw/chapter.sgml +++ b/en/handbook/hw/chapter.sgml @@ -3,26 +3,26 @@ Issues of hardware compatibility are among the most troublesome in the computer industry today and FreeBSD is by no means immune to - trouble. In this respect, FreeBSD's advantage of being able to run on + trouble. In this respect, FreeBSD's advantage of being able to run on inexpensive commodity PC hardware is also its liability when it comes - to support for the amazing variety of components on the market. While + to support for the amazing variety of components on the market. While it would be impossible to provide a exhaustive listing of hardware that FreeBSD supports, this section serves as a catalog of the device drivers included with FreeBSD and the hardware each drivers supports. Where possible and appropriate, notes about specific products are - included. You may also want to refer to the kernel configuration file section in this handbook for a list of supported devices. As FreeBSD is a volunteer project without a funded testing department, we depend on you, the user, for much of the information - contained in this catalog. If you have direct experience of hardware + contained in this catalog. If you have direct experience of hardware that does or does not work with FreeBSD, please let us know by sending - e-mail to the &a.doc;. Questions about supported hardware should be + e-mail to the &a.doc;. Questions about supported hardware should be directed to the &a.questions; (see Mailing Lists for more - information). When submitting information or asking a question, + information). When submitting information or asking a question, please remember to specify exactly what version of FreeBSD you are using and include as many details of your hardware as possible. @@ -33,7 +33,7 @@ The following links have proven useful in selecting hardware. Though some of what you see won't necessarily be specific (or even applicable) to FreeBSD, most of the hardware information out there - is OS independent. Please check with the FreeBSD hardware guide to + is OS independent. Please check with the FreeBSD hardware guide to make sure that your chosen configuration is supported before making any purchases. @@ -55,10 +55,10 @@ The following list of sample hardware configurations by no means constitutes an endorsement of a given hardware vendor or product by - The FreeBSD Project. This information is + The FreeBSD Project. This information is provided only as a public service and merely catalogs some of the experiences that various individuals have had with different - hardware combinations. Your mileage may vary. Slippery when wet. + hardware combinations. Your mileage may vary. Slippery when wet. Beware of dog. @@ -66,9 +66,9 @@ Jordan's Picks I have had fairly good luck building workstation and server - configurations with the following components. I can't guarantee + configurations with the following components. I can't guarantee that you will too, nor that any of the companies here will remain - “best buys” forever. I will try, when I can, to keep this list + “best buys” forever. I will try, when I can, to keep this list up-to-date but cannot obviously guarantee that it will be at any given time. @@ -80,7 +80,7 @@ URL="http://www.tyan.com/html/products.html">Tyan S1668 dual-processor motherboard as well as the Intel PR440FX motherboard with on-board SCSI WIDE and 100/10MB Intel - Etherexpress NIC. You can build a dandy little single or dual + Etherexpress NIC. You can build a dandy little single or dual processor system (which is supported in FreeBSD 3.0) for very little cost now that the Pentium Pro 180/256K chips have fallen so greatly in price, but no telling how much longer this will @@ -131,7 +131,7 @@ There are two types of 3940 on the market—the older model with AIC 7880 chips on it, and hte newer one with AIC 7895 - chips. The newer model requires CAM support which is not yet part of FreeBSD—you have to add it, or install from one of the CAM binary snapshot release. @@ -145,7 +145,7 @@ you can afford it.” Even in small desktop configurations, SCSI often makes more sense since it allows you to easily migrate drives from server to desktop as falling drive prices make it - economical to do so. If you have more than one machine to + economical to do so. If you have more than one machine to administer then think of it not simply as storage, think of it as a food chain! For a serious server configuration, there's not even any argument—use SCSI equipment and good cables. @@ -159,16 +159,16 @@ while the Toshiba drives have always been favourites of mine (in whatever speed is hot that week), I'm still fond of my good old Plextor PX-12CS drive. It's + url="http://www.plextor.com">Plextor PX-12CS drive. It's only a 12 speed, but it's offered excellent performance and reliability. Generally speaking, most SCSI CDROM drives I've seen have been of pretty solid construction and you probably won't go - wrong with an HP or NEC SCSI CDROM drive either. SCSI CDROM + wrong with an HP or NEC SCSI CDROM drive either. SCSI CDROM prices also appear to have dropped considerably in the last few months and are now quite competitive with IDE CDROMs while - remaining a technically superior solution. I now see no reason + remaining a technically superior solution. I now see no reason whatsoever to settle for an IDE CDROM drive if given a choice between the two. @@ -180,9 +180,9 @@ At the time of this writing, FreeBSD supports 3 types of CDR drives (though I believe they all ultimately come from Phillips anyway): The Phillips CDD 522 (Acts like a Plasmon), the PLASMON - RF4100 and the HP 6020i. I myself use the HP 6020i for burning + RF4100 and the HP 6020i. I myself use the HP 6020i for burning CDROMs (in 2.2 and alter releases—it does not work with - earlier releases of the SCSI code) and it works very well. See + earlier releases of the SCSI code) and it works very well. See /usr/share/examples/worm on your 2.2 system for example scripts used to created ISO9660 filesystem images (with RockRidge extensions) and burn them onto an HP6020i CDR. @@ -208,12 +208,12 @@ Inc. (formerly X Inside, Inc) then I can heartily recommend the Matrox Millenium II card. Note that support for this card is also excellent with the XFree86 server, which is now at version 3.3.2. + URL="http://www.matrox.com/mgaweb/brochure.htm">Millenium II card. Note that support for this card is also excellent with the XFree86 server, which is now at version 3.3.2. You also certainly can't go wrong with one of Number 9's cards — their S3 Vision 868 and 968 based cards (the 9FX series) also being quite - fast and very well supported by XFree86's S3 server. You can + fast and very well supported by XFree86's S3 server. You can also pick up their Revolution 3D cards very cheaply these days, especially if you require a lot of video memory. @@ -223,7 +223,7 @@ Monitors I have had very good luck with the Sony Multiscan 17seII monitors, as have I with the Viewsonic offering in the same (Trinitron) tube. For larger than 17", all I can recommend at the time of this writing is to not spend any less than U.S. $2,000 for a 21" monitor or $1,700 for a 20" monitor if that's what you really need. There are good monitors available in the >=20" range and there are also cheap monitors in the >=20" range. Unfortunately, very few are both cheap and good! + URL="http://cons3.sel.sony.com/SEL/ccpg/display/ms17se2.html">Sony Multiscan 17seII monitors, as have I with the Viewsonic offering in the same (Trinitron) tube. For larger than 17", all I can recommend at the time of this writing is to not spend any less than U.S. $2,000 for a 21" monitor or $1,700 for a 20" monitor if that's what you really need. There are good monitors available in the >=20" range and there are also cheap monitors in the >=20" range. Unfortunately, very few are both cheap and good! @@ -234,7 +234,7 @@ ande foremost, followed by the SMC Ultra 16 controller for any ISA application and the SMC EtherPower or Compex ENET32 - cards for slightly cheaper PCI based networking. In general, any + cards for slightly cheaper PCI based networking. In general, any PCI NIC based around DEC's DC21041 Ethernet controller chip, such as the Zynx ZX342 or DEC DE435, will generally work quite well and can frequently be found in 2-port and 4-port version @@ -254,16 +254,16 @@ If you're looking for high-speed serial networking solutions, then Digi International makes the SYNC/570 series, with drivers now in FreeBSD-current. Emerging Technologies also manufactures a board with T1/E1 capabilities, using software they provide. I have no direct experience using either product, however. + URL="http://www.dgii.com/prodprofiles/profiles-prices/digiprofiles/digispecs/sync570.html">SYNC/570 series, with drivers now in FreeBSD-current. Emerging Technologies also manufactures a board with T1/E1 capabilities, using software they provide. I have no direct experience using either product, however. Multiport card options are somewhat more numerous, though it has to be said that FreeBSD's support for Cyclades's products is probably the tightest, primarily as a result of that company's commitment to making sure that we are adequately supplied with - evaluation boards and technical specs. I've heard that the + evaluation boards and technical specs. I've heard that the Cyclom-16Ye offers the best price/performance, though I've not - checked the prices lately. Other multiport cards I've heard good + checked the prices lately. Other multiport cards I've heard good things about are the BOCA and AST cards, and Stallion Technologies apparently offers an unofficial driver @@ -278,7 +278,7 @@ I currently use a Creative Labs AWE32 though just about anything from Creative Labs will generally work these - days. This is not to say that other types of sound cards don't + days. This is not to say that other types of sound cards don't also work, simply that I have little experience with them (I was a former GUS fan, but Gravis's soundcard situation has been dire for some time). @@ -290,17 +290,17 @@ For video capture, there are two good choices — any card based on the Brooktree BT848 chip, such as the Hauppage or WinTV - boards, will work very nicely with FreeBSD. Another board which + boards, will work very nicely with FreeBSD. Another board which works for me is the Matrox Meteor - card. FreeBSD also supports the older video spigot card from + card. FreeBSD also supports the older video spigot card from Creative Labs, but those are getting somewhat difficult to find. Note that the Meteor frame grabber card will not work with motherboards based on the 440FX chipset! See the motherboard reference section for - details. In such cases, it's better to go with a BT848 based + details. In such cases, it's better to go with a BT848 based board. @@ -361,9 +361,9 @@ 1 or 2): - Write back cache coherency problems. Hardware flaw, + Write back cache coherency problems. Hardware flaw, only known work around is to set the external cache to - write-through mode. Upgrade to Saturn-II. + write-through mode. Upgrade to Saturn-II. @@ -374,7 +374,7 @@ Works fine, but many MB manufactures leave out the external dirty bit SRAM needed for write back operation. Work arounds are either run it in write through mode, or - get the dirty bit SRAM installed. (I have these for the + get the dirty bit SRAM installed. (I have these for the ASUS PCI/I-486SP3G rev 1.6 and later boards). @@ -383,10 +383,10 @@ Can not run more than 2 bus master devices. - Admitted Intel design flaw. Workarounds include do not + Admitted Intel design flaw. Workarounds include do not run more than 2 bus masters, special hardware design to replace the PCI bus arbiter (appears on Intel Altair - board and several other Intel server group MB's). And + board and several other Intel server group MB's). And of course Intel's official answer, move to the Triton chip set, we “fixed it there”. @@ -397,8 +397,8 @@ No known cache coherency or bus master problems, - chip set does not implement parity checking. Workaround - for parity issue. Use Triton-II based motherboards if + chip set does not implement parity checking. Workaround + for parity issue. Use Triton-II based motherboards if you have the choice. @@ -408,7 +408,7 @@ All reports on motherboards using this chipset have - been favorable so far. No known problems. + been favorable so far. No known problems. @@ -418,7 +418,7 @@ Early versions of this chipset suffered from a PCI write-posting bug which can cause noticeable performance degradation in applications where large amounts of PCI - bus traffic is involved. B0 stepping or later revisions + bus traffic is involved. B0 stepping or later revisions of the chipset fixed this problem. @@ -428,7 +428,7 @@ This Pentium Pro support chipset seems to work well, and does not suffer from any of the early Orion chipset problems. It also supports a wider variety of memory, including ECC and parity. The only known problem with it is that the Matrox Meteor frame grabber card doesn't like it. + URL="http://www.intel.com/procs/ppro/index.htm">Pentium Pro support chipset seems to work well, and does not suffer from any of the early Orion chipset problems. It also supports a wider variety of memory, including ECC and parity. The only known problem with it is that the Matrox Meteor frame grabber card doesn't like it. @@ -452,7 +452,7 @@ In fact, our main ftp site ftp.freebsd.org (also known as "ftp.cdrom.com", world's largest - ftp site) runs FreeBSD on a Pentium Pro. Configurations details are available for interested parties. @@ -462,16 +462,16 @@ The Intel Pentium (P54C), Pentium MMX (P55C), AMD K6 and Cyrix/IBM 6x86MX processors are all reported to work with - FreeBSD. I will not go into details of which processor is + FreeBSD. I will not go into details of which processor is faster than what, there are zillions of web sites on the - Internet that tells you one way or another. :) + Internet that tells you one way or another. :) Various CPUs have different voltage/cooling requirements. Make sure your motherboard can supply the exact voltage needed - by the CPU. For instance, many recent MMX chips require split - voltage (e.g., 2.9V core, 3.3V I/O). Also, some AMD and - Cyrix/IBM chips run hotter than Intel chips. In that case, + by the CPU. For instance, many recent MMX chips require split + voltage (e.g., 2.9V core, 3.3V I/O). Also, some AMD and + Cyrix/IBM chips run hotter than Intel chips. In that case, make sure you have good heatsink/fans (you can get the list of certified parts from their web pages). @@ -486,10 +486,10 @@ 1997. Pentium class machines use different clock speeds for the - various parts of the system. These being the speed of the - CPU, external memory bus, and the PCI bus. It is not always + various parts of the system. These being the speed of the + CPU, external memory bus, and the PCI bus. It is not always true that a “faster” processor will make a system faster than - a “slower” one, due to the various clock speeds used. Below is + a “slower” one, due to the various clock speeds used. Below is a table showing the differences: @@ -623,8 +623,8 @@ The AMD K6 Bug In 1997, there have been reports of the AMD K6 seg - faulting during heavy compilation. That problem has been - fixed in 3Q '97. According to reports, K6 chips with date mark + faulting during heavy compilation. That problem has been + fixed in 3Q '97. According to reports, K6 chips with date mark “9733” or larger (i.e., manufactured in the 33rd week of '97 or later) do not have this bug. @@ -646,7 +646,7 @@ 286 class - Sorry, FreeBSD does not run on 80286 machines. It is nearly + Sorry, FreeBSD does not run on 80286 machines. It is nearly impossible to run today's large full-featured UNIXes on such hardware. @@ -657,9 +657,9 @@ * Memory The minimum amount of memory you must have to install FreeBSD - is 5 MB. Once your system is up and running you can build a custom kernel - that will use less memory. If you use the boot4.flp you can get + that will use less memory. If you use the boot4.flp you can get away with having only 4 MB. @@ -699,8 +699,8 @@ The Universal Asynchronous Receiver/Transmitter (UART) controller is the key component of the serial communications - subsystem of a computer. The UART takes bytes of data and - transmits the individual bits in a sequential fashion. At the + subsystem of a computer. The UART takes bytes of data and + transmits the individual bits in a sequential fashion. At the destination, a second UART re-assembles the bits into complete bytes. @@ -709,11 +709,11 @@ other devices. There are two primary forms of serial transmission: - Synchronous and Asynchronous. Depending on the modes that are + Synchronous and Asynchronous. Depending on the modes that are supported by the hardware, the name of the communication sub-system will usually include a A if it supports Asynchronous communications, and a S if it supports - Synchronous communications. Both forms are described + Synchronous communications. Both forms are described below. Some common acronyms are: @@ -734,11 +734,11 @@ Synchronous serial transmission requires that the sender and receiver share a clock with one another, or that the sender provide a strobe or other timing signal so that the - receiver knows when to “read” the next bit of the data. In + receiver knows when to “read” the next bit of the data. In most forms of serial Synchronous communication, if there is no data available at a given instant to transmit, a fill character must be sent instead so that data is always being - transmitted. Synchronous communication is usually more + transmitted. Synchronous communication is usually more efficient because only data bits are transmitted between sender and receiver, and synchronous communication can be more more costly if extra wiring and circuits are required to share @@ -750,11 +750,11 @@ Printers and fixed disk devices are not normally serial devices because most fixed disk interface standards send an entire word of data for each clock or strobe signal by using a - separate wire for each bit of the word. In the PC industry, + separate wire for each bit of the word. In the PC industry, these are known as Parallel devices. The standard serial communications hardware in the PC does - not support Synchronous operations. This mode is described + not support Synchronous operations. This mode is described here for comparison purposes only. @@ -764,59 +764,59 @@ Asynchronous transmission allows data to be transmitted without the sender having to send a clock signal to the - receiver. Instead, the sender and receiver must agree on + receiver. Instead, the sender and receiver must agree on timing parameters in advance and special bits are added to each word which are used to synchronize the sending and receiving units. When a word is given to the UART for Asynchronous transmissions, a bit called the "Start Bit" is added to the - beginning of each word that is to be transmitted. The Start + beginning of each word that is to be transmitted. The Start Bit is used to alert the receiver that a word of data is about to be sent, and to force the clock in the receiver into - synchronization with the clock in the transmitter. These two + synchronization with the clock in the transmitter. These two clocks must be accurate enough to not have the frequency drift by more than 10% during the transmission of the - remaining bits in the word. (This requirement was set in the + remaining bits in the word. (This requirement was set in the days of mechanical teleprinters and is easily met by modern electronic equipment.) After the Start Bit, the individual bits of the word of data are sent, with the Least Significant Bit (LSB) being sent - first. Each bit in the transmission is transmitted for + first. Each bit in the transmission is transmitted for exactly the same amount of time as all of the other bits, and the receiver “looks” at the wire at approximately halfway through the period assigned to each bit to determine if the - bit is a 1 or a 0. For example, if it takes two seconds + bit is a 1 or a 0. For example, if it takes two seconds to send each bit, the receiver will examine the signal to determine if it is a 1 or a 0 after one second has passed, then it will wait two seconds and then examine the value of the next bit, and so on. The sender does not know when the receiver has “looked” at - the value of the bit. The sender only knows when the clock + the value of the bit. The sender only knows when the clock says to begin transmitting the next bit of the word. When the entire data word has been sent, the transmitter - may add a Parity Bit that the transmitter generates. The + may add a Parity Bit that the transmitter generates. The Parity Bit may be used by the receiver to perform simple error - checking. Then at least one Stop Bit is sent by the + checking. Then at least one Stop Bit is sent by the transmitter. When the receiver has received all of the bits in the data word, it may check for the Parity Bits (both sender and receiver must agree on whether a Parity Bit is to be used), - and then the receiver looks for a Stop Bit. If the Stop Bit + and then the receiver looks for a Stop Bit. If the Stop Bit does not appear when it is supposed to, the UART considers the entire word to be garbled and will report a Framing Error to - the host processor when the data word is read. The usual + the host processor when the data word is read. The usual cause of a Framing Error is that the sender and receiver clocks were not running at the same speed, or that the signal was interrupted. Regardless of whether the data was received correctly or not, the UART automatically discards the Start, Parity and - Stop bits. If the sender and receiver are configured + Stop bits. If the sender and receiver are configured identically, these bits are not passed to the host. If another word is ready for transmission, the Start Bit @@ -838,7 +838,7 @@ circuits for signals that can be used to indicate the state of the transmission media, and to regulate the flow of data in the event that the remote device is not prepared to accept - more data. For example, when the device connected to the + more data. For example, when the device connected to the UART is a modem, the modem may report the presence of a carrier on the phone line while the computer may be able to instruct the modem to reset itself or to not take calls by @@ -853,7 +853,7 @@ In most computer systems, the UART is connected to circuitry that generates signals that comply with the EIA - RS232-C specification. There is also a CCITT standard named + RS232-C specification. There is also a CCITT standard named V.24 that mirrors the specifications included in RS232-C. @@ -862,15 +862,15 @@ RS232-C Bit Assignments (Marks and Spaces) In RS232-C, a value of 1 is called a Mark and a - value of 0 is called a Space. When a communication line + value of 0 is called a Space. When a communication line is idle, the line is said to be “Marking”, or transmitting continuous 1 values. - The Start bit always has a value of 0 (a Space). The - Stop Bit always has a value of 1 (a Mark). This means + The Start bit always has a value of 0 (a Space). The + Stop Bit always has a value of 1 (a Mark). This means that there will always be a Mark (1) to Space (0) transition on the line at the start of every word, even when multiple - word are transmitted back to back. This guarantees that + word are transmitted back to back. This guarantees that sender and receiver can resynchronize their clocks regardless of the content of the data bits that are being transmitted. @@ -883,9 +883,9 @@ In RS232-C, the "Marking" signal (a 1) is represented by a voltage between -2 VDC and -12 VDC, and a "Spacing" signal (a 0) is represented by a voltage between 0 and +12 - VDC. The transmitter is supposed to send +12 VDC or -12 + VDC. The transmitter is supposed to send +12 VDC or -12 VDC, and the receiver is supposed to allow for some voltage - loss in long cables. Some transmitters in low power devices + loss in long cables. Some transmitters in low power devices (like portable computers) sometimes use only +5 VDC and -5 VDC, but these values are still acceptable to a RS232-C receiver, provided that the cable lengths are short. @@ -897,12 +897,12 @@ RS232-C also specifies a signal called a Break, which is caused by sending continuous Spacing values (no Start or - Stop bits). When there is no electricity present on the + Stop bits). When there is no electricity present on the data circuit, the line is considered to be sending Break. The Break signal must be of a duration longer than the time it takes to send a complete byte plus Start, Stop and - Parity bits. Most UARTs can distinguish between a Framing + Parity bits. Most UARTs can distinguish between a Framing Error and a Break, but if the UART cannot do this, the Framing Error detection can be used to identify Breaks. @@ -910,7 +910,7 @@ In the days of teleprinters, when numerous printers around the country were wired in series (such as news services), any unit could cause a Break by temporarily - opening the entire circuit so that no current flowed. This + opening the entire circuit so that no current flowed. This was used to allow a location with urgent news to interrupt some other location that was currently sending information. @@ -919,10 +919,10 @@ If the Break is longer than 1.6 seconds, it is considered a "Modem Break", and some modems can be programmed to terminate the conversation and go on-hook or enter the - modems' command mode when the modem detects this signal. If + modems' command mode when the modem detects this signal. If the Break is smaller than 1.6 seconds, it signifies a Data Break and it is up to the remote computer to respond to this - signal. Sometimes this form of Break is used as an + signal. Sometimes this form of Break is used as an Attention or Interrupt signal and sometimes is accepted as a substitute for the ASCII CONTROL-C character. @@ -932,7 +932,7 @@ Breaks cannot be generated from paper tape or from any other byte value, since bytes are always sent with Start - and Stop bit. The UART is usually capable of generating + and Stop bit. The UART is usually capable of generating the continuous Spacing signal in response to a special command from the host processor. @@ -944,26 +944,26 @@ The RS232-C specification defines two types of equipment: the Data Terminal Equipment (DTE) and the Data - Carrier Equipment (DCE). Usually, the DTE device is the - terminal (or computer), and the DCE is a modem. Across the + Carrier Equipment (DCE). Usually, the DTE device is the + terminal (or computer), and the DCE is a modem. Across the phone line at the other end of a conversation, the receiving modem is also a DCE device and the computer that is - connected to that modem is a DTE device. The DCE device + connected to that modem is a DTE device. The DCE device receives signals on the pins that the DTE device transmits on, and vice versa. When two devices that are both DTE or both DCE must be connected together without a modem or a similar media - translater between them, a NULL modem must be used. The + translater between them, a NULL modem must be used. The NULL modem electrically re-arranges the cabling so that the transmitter output is connected to the receiver input on the - other device, and vice versa. Similar translations are + other device, and vice versa. Similar translations are performed on all of the control signals so that each device will see what it thinks are DCE (or DTE) signals from the other device. The number of signals generated by the DTE and DCE - devices are not symmetrical. The DTE device generates fewer + devices are not symmetrical. The DTE device generates fewer signals for the DCE device than the DTE device receives from the DCE. @@ -979,14 +979,14 @@ In the IBM Personal Computer and similar systems, a subset of RS232-C signals are provided via nine pin - connectors (DB9). The signals that are not included on the + connectors (DB9). The signals that are not included on the PC connector deal mainly with synchronous operation, and this transmission mode is not supported by the UART that IBM selected for use in the IBM PC. Depending on the computer manufacturer, a DB25, a DB9, or both types of connector may be used for RS232-C - communications. (The IBM PC also uses a DB25 connector for + communications. (The IBM PC also uses a DB25 connector for the parallel printer interface which causes some confusion.) @@ -1267,7 +1267,7 @@ Bits, Baud and Symbols Baud is a measurement of transmission speed in - asynchronous communication. Because of advances in modem + asynchronous communication. Because of advances in modem communication technology, this term is frequently misused when describing the data rates in newer devices. @@ -1276,8 +1276,8 @@ data that is actually moved from one DTE device to the other. The Baud count includes the overhead bits Start, Stop and Parity that are generated by the sending UART and removed by - the receiving UART. This means that seven-bit words of data - actually take 10 bits to be completely transmitted. Therefore, + the receiving UART. This means that seven-bit words of data + actually take 10 bits to be completely transmitted. Therefore, a modem capable of moving 300 bits per second from one place to another can normally only move 30 7-bit words if Parity is used and one Start and Stop bit are present. @@ -1289,12 +1289,12 @@ The formula for converting bytes per second into a baud rate and vice versa was simple until error-correcting modems - came along. These modems receive the serial stream of bits + came along. These modems receive the serial stream of bits from the UART in the host computer (even when internal modems are used the data is still frequently serialized) and converts - the bits back into bytes. These bytes are then combined into + the bits back into bytes. These bytes are then combined into packets and sent over the phone line using a Synchronous - transmission method. This means that the Stop, Start, and + transmission method. This means that the Stop, Start, and Parity bits added by the UART in the DTE (the computer) were removed by the modem before transmission by the sending modem. When these bytes are received by the remote modem, the remote @@ -1307,7 +1307,7 @@ the two modems can perform error correction, which means that the receiving modem is able to ask the sending modem to resend a block of data that was not received with the correct - checksum. This checking is handled by the modems, and the DTE + checksum. This checking is handled by the modems, and the DTE devices are usually unaware that the process is occurring. @@ -1315,7 +1315,7 @@ additional bits of data that the two modems must share between themselves to perform error-correction are mostly concealed from the effective transmission rate seen by the sending and - receiving DTE equipment. For example, if a modem sends ten + receiving DTE equipment. For example, if a modem sends ten 7-bit words to another modem without including the Start, Stop and Parity bits, the sending modem will be able to add 30 bits of its own information that the receiving modem can use to do @@ -1323,16 +1323,16 @@ the real data. The use of the term Baud is further confused by modems - that perform compression. A single 8-bit word passed over the + that perform compression. A single 8-bit word passed over the telephone line might represent a dozen words that were - transmitted to the sending modem. The receiving modem will + transmitted to the sending modem. The receiving modem will expand the data back to its original content and pass that data to the receiving DTE. Modern modems also include buffers that allow the rate that bits move across the phone line (DCE to DCE) to be a different speed than the speed that the bits move between the - DTE and DCE on both ends of the conversation. Normally the + DTE and DCE on both ends of the conversation. Normally the speed between the DTE and DCE is higher than the DCE to DCE speed because of the use of compression by the modems. @@ -1341,7 +1341,7 @@ differing bits-per-seconds speeds that are used present on the DTE-DCE and DCE-DCE links, the usage of the term Baud to describe the overall communication speed causes problems and - can misrepresent the true transmission speed. So Bits Per + can misrepresent the true transmission speed. So Bits Per Second (bps) is the correct term to use to describe the transmission rate seen at the DCE to DCE interface and Baud or Bits Per Second are acceptable terms to use when a connection @@ -1351,12 +1351,12 @@ Modern high speed modems (2400, 9600, 14,400, and 19,200bps) in reality still operate at or below 2400 baud, or - more accurately, 2400 Symbols per second. High speed modem + more accurately, 2400 Symbols per second. High speed modem are able to encode more bits of data into each Symbol using a technique called Constellation Stuffing, which is why the effective bits per second rate of the modem is higher, but the modem continues to operate within the limited audio bandwidth - that the telephone system provides. Modems operating at 28,800 + that the telephone system provides. Modems operating at 28,800 and higher speeds have variable Symbol rates, but the technique is the same. @@ -1367,7 +1367,7 @@ Starting with the original IBM Personal Computer, IBM selected the National Semiconductor INS8250 UART for use in - the IBM PC Parallel/Serial Adapter. Subsequent generations of + the IBM PC Parallel/Serial Adapter. Subsequent generations of compatible computers from IBM and other vendors continued to use the INS8250 or improved versions of the National Semiconductor UART family. @@ -1377,7 +1377,7 @@ National Semiconductor UART Family Tree There have been several versions and subsequent - generations of the INS8250 UART. Each major version is + generations of the INS8250 UART. Each major version is described below. @@ -1398,12 +1398,12 @@ INS8250 -> INS8250B INS8250 This part was used in the original IBM PC and - IBM PC/XT. The original name for this part was the + IBM PC/XT. The original name for this part was the INS8250 ACE (Asynchronous Communications Element) and it is made from NMOS technology. The 8250 uses eight I/O ports and has a one-byte - send and a one-byte receive buffer. This original + send and a one-byte receive buffer. This original UART has several race conditions and other flaws. The original IBM BIOS includes code to work around these flaws, but this made the BIOS dependent on the @@ -1417,7 +1417,7 @@ INS8250 -> INS8250B This is the slower speed of the INS8250 made - from NMOS technology. It contains the same problems + from NMOS technology. It contains the same problems as the original INS8250. @@ -1448,7 +1448,7 @@ INS8250 -> INS8250B Same as NS8250A with improvements so it can be - used with faster CPU bus designs. IBM used this + used with faster CPU bus designs. IBM used this part in the IBM AT and updated the IBM BIOS to no longer rely on the bugs in the INS8250. @@ -1513,14 +1513,14 @@ INS8250 -> INS8250B years ago, and the NS16550AFN no longer exists by that name. (If you have a NS16550AFN, look at the date code on the part, which is a four digit number that usually starts with - a nine. The first two digits of the number are the year, + a nine. The first two digits of the number are the year, and the last two digits are the week in that year when the - part was packaged. If you have a NS16550AFN, it is probably + part was packaged. If you have a NS16550AFN, it is probably a few years old.) The new numbers are like PC16550DV, with minor differences in the suffix letters depending on the package - material and its shape. (A description of the numbering + material and its shape. (A description of the numbering system can be found below.) It is important to understand that in some stores, you @@ -1545,7 +1545,7 @@ INS8250 -> INS8250B are now of the format PCnnnnnrgp. - The r is the revision field. The + The r is the revision field. The current revision of the 16550 from National Semiconductor is D. @@ -1581,7 +1581,7 @@ INS8250 -> INS8250B If an I precedes the package-type letter, it indicates an “industrial” grade part, which has higher specs than a standard part but not as high as Military Specification - (Milspec) component. This is an optional field. + (Milspec) component. This is an optional field. So what we used to call a NS16550AFN (DIP Package) is now called a PC16550DN or PC16550DIN. @@ -1593,7 +1593,7 @@ INS8250 -> INS8250B Other Vendors and Similar UARTs Over the years, the 8250, 8250A, 16450 and 16550 have been - licensed or copied by other chip vendors. In the case of the + licensed or copied by other chip vendors. In the case of the 8250, 8250A and 16450, the exact circuit (the “megacell”) was licensed to many vendors, including Western Digital and Intel. Other vendors reverse-engineered the part or produced @@ -1602,9 +1602,9 @@ INS8250 -> INS8250B In internal modems, the modem designer will frequently emulate the 8250A/16450 with the modem microprocessor, and the emulated UART will frequently have a hidden buffer consisting - of several hundred bytes. Because of the size of the buffer, + of several hundred bytes. Because of the size of the buffer, these emulations can be as reliable as a 16550A in their - ability to handle high speed data. However, most operating + ability to handle high speed data. However, most operating systems will still report that the UART is only a 8250A or 16450, and may not make effective use of the extra buffering present in the emulated UART unless special drivers are @@ -1617,16 +1617,16 @@ INS8250 -> INS8250B be lowered by this action. A common misconception is that all parts with “16550A” - written on them are identical in performance. There are + written on them are identical in performance. There are differences, and in some cases, outright flaws in most of these 16550A clones. When the NS16550 was developed, the National Semiconductor obtained several patents on the design and they also limited licensing, making it harder for other vendors to provide a - chip with similar features. Because of the patents, + chip with similar features. Because of the patents, reverse-engineered designs and emulations had to avoid - infringing the claims covered by the patents. Subsequently, + infringing the claims covered by the patents. Subsequently, these copies almost never perform exactly the same as the NS16550A or PC16550D, which are the parts most computer and modem makers want to buy but are sometimes unwilling to pay @@ -1634,21 +1634,21 @@ INS8250 -> INS8250B Some of the differences in the clone 16550A parts are unimportant, while others can prevent the device from being - used at all with a given operating system or driver. These + used at all with a given operating system or driver. These differences may show up when using other drivers, or when particular combinations of events occur that were not well - tested or considered in the Windows driver. This is because + tested or considered in the Windows driver. This is because most modem vendors and 16550-clone makers use the Microsoft drivers from Windows for Workgroups 3.11 and the Microsoft MSD utility as the primary tests for compatibility with the - NS16550A. This over-simplistic criteria means that if a + NS16550A. This over-simplistic criteria means that if a different operating system is used, problems could appear due to subtle differences between the clones and genuine components. National Semiconductor has made available a program named COMTEST that performs compatibility tests independent of any - OS drivers. It should be remembered that the purpose of this + OS drivers. It should be remembered that the purpose of this type of program is to demonstrate the flaws in the products of the competition, so the program will report major as well as extremely subtle differences in behavior in the part being @@ -1657,7 +1657,7 @@ INS8250 -> INS8250B In a series of tests performed by the author of this document in 1994, components made by National Semiconductor, TI, StarTech, and CMD as well as megacells and emulations - embedded in internal modems were tested with COMTEST. A + embedded in internal modems were tested with COMTEST. A difference count for some of these components is listed below. Because these tests were performed in 1994, they may not reflect the current performance of the given product from a @@ -1665,7 +1665,7 @@ INS8250 -> INS8250B It should be noted that COMTEST normally aborts when an excessive number or certain types of problems have been - detected. As part of this testing, COMTEST was modified so + detected. As part of this testing, COMTEST was modified so that it would not abort no matter how many differences were encountered. @@ -1736,12 +1736,12 @@ INS8250 -> INS8250B To date, the author of this document has not found any non-National parts that report zero - differences using the COMTEST program. It should + differences using the COMTEST program. It should also be noted that National has had five versions of the 16550 over the years and the newest parts behave a bit differently than the classic NS16550AFN that is considered the benchmark for - functionality. COMTEST appears to turn a blind eye + functionality. COMTEST appears to turn a blind eye to the differences within the National product line and reports no errors on the National parts (except for the original 16550) even when there @@ -1752,24 +1752,24 @@ INS8250 -> INS8250B It is important to understand that a simple count of differences from COMTEST does not reveal a lot about what - differences are important and which are not. For example, + differences are important and which are not. For example, about half of the differences reported in the two modems listed above that have internal UARTs were caused by the clone - UARTs not supporting five- and six-bit character modes. The + UARTs not supporting five- and six-bit character modes. The real 16550, 16450, and 8250 UARTs all support these modes and COMTEST checks the functionality of these modes so over fifty - differences are reported. However, almost no modern modem + differences are reported. However, almost no modern modem supports five- or six-bit characters, particularly those with - error-correction and compression capabilities. This means + error-correction and compression capabilities. This means that the differences related to five- and six-bit character modes can be discounted. Many of the differences COMTEST reports have to do with - timing. In many of the clone designs, when the host reads + timing. In many of the clone designs, when the host reads from one port, the status bits in some other port may not update in the same amount of time (some faster, some slower) as a real NS16550AFN and COMTEST looks - for these differences. This means that the number of + for these differences. This means that the number of differences can be misleading in that one device may only have one or two differences but they are extremely serious, and some other device that updates the status registers faster or @@ -1785,7 +1785,7 @@ INS8250 -> INS8250B If you run COMTEST on a 16550 that is in a modem or a modem is attached to the serial port, you need to first issue a ATE0&W command to the modem so that the modem will not - echo any of the test characters. If you forget to do this, + echo any of the test characters. If you forget to do this, COMTEST will report at least this one difference: @@ -1798,12 +1798,12 @@ INS8250 -> INS8250B 8250/16450/16550 Registers The 8250/16450/16550 UART occupies eight contiguous I/O - port addresses. In the IBM PC, there are two defined + port addresses. In the IBM PC, there are two defined locations for these eight ports and they are known - collectively as COM1 and COM2. The makers of PC-clones and + collectively as COM1 and COM2. The makers of PC-clones and add-on cards have created two additional areas known as COM3 and COM4, but these extra COM ports conflict with other - hardware on some systems. The most common conflict is with + hardware on some systems. The most common conflict is with video adapters that provide IBM 8514 emulation. COM1 is located from 0x3f8 to 0x3ff and normally uses IRQ @@ -1849,7 +1849,7 @@ INS8250 -> INS8250B value will be divided from the master input clock (in the IBM PC, the master clock is 1.8432MHz) and the resulting clock will determine the baud rate of - the UART. This register holds bits 0 thru 7 of the + the UART. This register holds bits 0 thru 7 of the divisor. @@ -1860,7 +1860,7 @@ INS8250 -> INS8250B value will be divided from the master input clock (in the IBM PC, the master clock is 1.8432MHz) and the resulting clock will determine the baud rate of - the UART. This register holds bits 8 thru 15 of the + the UART. This register holds bits 8 thru 15 of the divisor. @@ -1875,13 +1875,13 @@ INS8250 -> INS8250B Interrupt Enable Register (IER)The 8250/16450/16550 UART classifies - events into one of four categories. Each + events into one of four categories. Each category can be configured to generate an - interrupt when any of the events occurs. The + interrupt when any of the events occurs. The 8250/16450/16550 UART generates a single external interrupt signal regardless of how many events in the enabled categories have - occurred. It is up to the host processor to + occurred. It is up to the host processor to respond to the interrupt and then poll the enabled interrupt categories (usually all categories have interrupts enabled) to @@ -2026,7 +2026,7 @@ INS8250 -> INS8250B Bit 3 - DMA Mode Select. If Bit 0 + DMA Mode Select. If Bit 0 is set to "1" (FIFOs enabled), setting this bit changes the operation of the -RXRDY and -TXRDY signals from Mode 0 to Mode 1. @@ -2034,27 +2034,27 @@ INS8250 -> INS8250B Bit 2 - Transmit FIFO Reset. When a + Transmit FIFO Reset. When a "1" is written to this bit, the contents of the - FIFO are discarded. Any word currently being - transmitted will be sent intact. This function + FIFO are discarded. Any word currently being + transmitted will be sent intact. This function is useful in aborting transfers. Bit 1 - Receiver FIFO Reset. When a + Receiver FIFO Reset. When a "1" is written to this bit, the contents of the - FIFO are discarded. Any word currently being + FIFO are discarded. Any word currently being assembled in the shift register will be received intact. Bit 0 - 16550 FIFO Enable. When + 16550 FIFO Enable. When set, both the transmit and receive FIFOs are - enabled. Any contents in the holding register, + enabled. Any contents in the holding register, shift registers or FIFOs are lost when FIFOs are enabled or disabled. @@ -2082,13 +2082,13 @@ INS8250 -> INS8250B Bit 7 - FIFOs enabled. On the + FIFOs enabled. On the 8250/16450 UART, this bit is zero. Bit 6 - FIFOs enabled. On the + FIFOs enabled. On the 8250/16450 UART, this bit is zero. @@ -2104,7 +2104,7 @@ INS8250 -> INS8250B Bit 3 - Interrupt ID Bit #2. On the + Interrupt ID Bit #2. On the 8250/16450 UART, this bit is zero. @@ -2118,14 +2118,14 @@ INS8250 -> INS8250B Interrupt ID Bit #0.These three bits combine to report the category of event that caused the interrupt that is in - progress. These categories have priorities, so + progress. These categories have priorities, so if multiple categories of events occur at the same time, the UART will report the more important events first and the host must resolve - the events in the order they are reported. All + the events in the order they are reported. All events that caused the current interrupt must be resolved before any new interrupts will be - generated. (This is a limitation of the PC + generated. (This is a limitation of the PC architecture.) @@ -2181,7 +2181,7 @@ INS8250 -> INS8250B Bit 0 - Interrupt Pending Bit. If + Interrupt Pending Bit. If this bit is set to "0", then at least one interrupt is pending. @@ -2210,27 +2210,27 @@ INS8250 -> INS8250B Bit 7 Divisor Latch Access Bit - (DLAB). When set, access to the data + (DLAB). When set, access to the data transmit/receive register (THR/RBR) and the - Interrupt Enable Register (IER) is disabled. Any + Interrupt Enable Register (IER) is disabled. Any access to these ports is now redirected to the - Divisor Latch Registers. Setting this bit, + Divisor Latch Registers. Setting this bit, loading the Divisor Registers, and clearing DLAB should be done with interrupts disabled. Bit 6 - Set Break. When set to "1", + Set Break. When set to "1", the transmitter begins to transmit continuous - Spacing until this bit is set to "0". This + Spacing until this bit is set to "0". This overrides any bits of characters that are being transmitted. Bit 5 - Stick Parity. When parity + Stick Parity. When parity is enabled, setting this bit causes parity to always be "1" or "0", based on the value of Bit 4. @@ -2241,15 +2241,15 @@ INS8250 -> INS8250B Even Parity Select (EPS). When parity is enabled and Bit 5 is "0", setting this bit causes even parity to be transmitted - and expected. Otherwise, odd parity is + and expected. Otherwise, odd parity is used. Bit 3 - Parity Enable (PEN). When + Parity Enable (PEN). When set to "1", a parity bit is inserted between the - last bit of the data and the Stop Bit. The UART + last bit of the data and the Stop Bit. The UART will also expect parity to be present in the received data. @@ -2259,8 +2259,8 @@ INS8250 -> INS8250B Number of Stop Bits (STB). If set to "1" and using 5-bit data words, 1.5 Stop Bits are transmitted and expected in each - data word. For 6, 7 and 8-bit data words, 2 - Stop Bits are transmitted and expected. When + data word. For 6, 7 and 8-bit data words, 2 + Stop Bits are transmitted and expected. When this bit is set to "0", one Stop Bit is used on each data word. @@ -2351,20 +2351,20 @@ INS8250 -> INS8250B Bit 4 - Loop-Back Enable. When set to "1", the UART + Loop-Back Enable. When set to "1", the UART transmitter and receiver are internally connected together to allow diagnostic - operations. In addition, the UART modem control + operations. In addition, the UART modem control outputs are connected to the UART modem control - inputs. CTS is connected to RTS, DTR is + inputs. CTS is connected to RTS, DTR is connected to DSR, OUT1 is connected to RI, and OUT 2 is connected to DCD. Bit 3 - OUT 2. An auxiliary output that the host - processor may set high or low. In the IBM PC + OUT 2. An auxiliary output that the host + processor may set high or low. In the IBM PC serial adapter (and most clones), OUT 2 is used to tri-state (disable) the interrupt signal from the 8250/16450/16550 UART. @@ -2372,21 +2372,21 @@ INS8250 -> INS8250B Bit 2 - OUT 1. An auxiliary output that the host - processor may set high or low. This output is + OUT 1. An auxiliary output that the host + processor may set high or low. This output is not used on the IBM PC serial adapter. Bit 1 - Request to Send (RTS). When set to "1", the + Request to Send (RTS). When set to "1", the output of the UART -RTS line is Low (Active). Bit 0 - Data Terminal Ready (DTR). When set to "1", + Data Terminal Ready (DTR). When set to "1", the output of the UART -DTR line is Low (Active). @@ -2409,8 +2409,8 @@ INS8250 -> INS8250B Bit 7 - Error in Receiver FIFO. On the 8250/16450 - UART, this bit is zero. This bit is set to "1" + Error in Receiver FIFO. On the 8250/16450 + UART, this bit is zero. This bit is set to "1" when any of the bytes in the FIFO have one or more of the following error conditions: PE, FE, or BI. @@ -2418,48 +2418,48 @@ INS8250 -> INS8250B Bit 6 - Transmitter Empty (TEMT). When set to "1", + Transmitter Empty (TEMT). When set to "1", there are no words remaining in the transmit - FIFO or the transmit shift register. The + FIFO or the transmit shift register. The transmitter is completely idle. Bit 5 Transmitter Holding Register Empty - (THRE). When set to "1", the FIFO (or holding + (THRE). When set to "1", the FIFO (or holding register) now has room for at least one - additional word to transmit. The transmitter may + additional word to transmit. The transmitter may still be transmitting when this bit is set to "1". Bit 4 - Break Interrupt (BI). The receiver has + Break Interrupt (BI). The receiver has detected a Break signal. Bit 3 - Framing Error (FE). A Start Bit was + Framing Error (FE). A Start Bit was detected but the Stop Bit did not appear at the - expected time. The received word is probably + expected time. The received word is probably garbled. Bit 2 - Parity Error (PE). The parity bit was + Parity Error (PE). The parity bit was incorrect for the word received. Bit 1 - Overrun Error (OE). A new word was received - and therewas no room in the receive buffer. The + Overrun Error (OE). A new word was received + and therewas no room in the receive buffer. The newly-arrived word in the shift register is - discarded. On 8250/16450 UARTs, the word in the + discarded. On 8250/16450 UARTs, the word in the holding register is discarded and the newly- arrived word is put in the holding register. @@ -2468,7 +2468,7 @@ INS8250 -> INS8250B Bit 0 Data Ready (DR) One or more words are in - the receive FIFO that the host may read. A word + the receive FIFO that the host may read. A word must be completely received and moved from the shift register into the FIFO (or holding register for 8250/16450 designs) before this bit @@ -2493,31 +2493,31 @@ INS8250 -> INS8250B Bit 7 - Data Carrier Detect (DCD). Reflects the + Data Carrier Detect (DCD). Reflects the state of the DCD line on the UART. Bit 6 - Ring Indicator (RI). Reflects the state of + Ring Indicator (RI). Reflects the state of the RI line on the UART. Bit 5 - Data Set Ready (DSR). Reflects the state of + Data Set Ready (DSR). Reflects the state of the DSR line on the UART. Bit 4 - Clear To Send (CTS). Reflects the state of + Clear To Send (CTS). Reflects the state of the CTS line on the UART. Bit 3 - Delta Data Carrier Detect (DDCD). Set to + Delta Data Carrier Detect (DDCD). Set to "1" if the -DCD line has changed state one more more times since the last time the MSR was read by the host. @@ -2525,7 +2525,7 @@ INS8250 -> INS8250B Bit 2 - Trailing Edge Ring Indicator (TERI). Set to + Trailing Edge Ring Indicator (TERI). Set to "1" if the -RI line has had a low to high transition since the last time the MSR was read by the host. @@ -2533,7 +2533,7 @@ INS8250 -> INS8250B Bit 1 - Delta Data Set Ready (DDSR). Set to "1" if + Delta Data Set Ready (DDSR). Set to "1" if the -DSR line has changed state one more more times since the last time the MSR was read by the host. @@ -2541,7 +2541,7 @@ INS8250 -> INS8250B Bit 0 - Delta Clear To Send (DCTS). Set to "1" if + Delta Clear To Send (DCTS). Set to "1" if the -CTS line has changed state one more more times since the last time the MSR was read by the host. @@ -2553,8 +2553,8 @@ INS8250 -> INS8250B +0x07 write/read - Scratch Register (SCR). This register performs no - function in the UART. Any value can be written by the + Scratch Register (SCR). This register performs no + function in the UART. Any value can be written by the host to this location and read by the host later on. @@ -2568,8 +2568,8 @@ INS8250 -> INS8250B Although National Semiconductor has not offered any components compatible with the 16550 that provide additional - features, various other vendors have. Some of these - components are described below. It should be understood that + features, various other vendors have. Some of these + components are described below. It should be understood that to effectively utilize these improvements, drivers may have to be provided by the chip vendor since most of the popular operating systems do not support features beyond those @@ -2581,7 +2581,7 @@ INS8250 -> INS8250B By default this part is similar to the NS16550A, but an extended 32-byte send and receive buffer can be - optionally enabled. Made by Startech. + optionally enabled. Made by Startech. @@ -2590,7 +2590,7 @@ INS8250 -> INS8250B By default this part behaves similar to the NS16550A, but an extended 64-byte send and receive - buffer can be optionally enabled. Made by Texas + buffer can be optionally enabled. Made by Texas Instruments. @@ -2600,7 +2600,7 @@ INS8250 -> INS8250B This proprietary plug-in card contains a 2048-byte send and receive buffer, and supports data rates to - 230.4Kbit/sec. Made by Hayes. + 230.4Kbit/sec. Made by Hayes. @@ -2608,14 +2608,14 @@ INS8250 -> INS8250B In addition to these “dumb” UARTs, many vendors produce - intelligent serial communication boards. This type of design + intelligent serial communication boards. This type of design usually provides a microprocessor that interfaces with several UARTs, processes and buffers the data, and then alerts the - main PC processor when necessary. Because the UARTs are not + main PC processor when necessary. Because the UARTs are not directly accessed by the PC processor in this type of communication system, it is not necessary for the vendor to use UARTs that are compatible with the 8250, 16450, or the - 16550 UART. This leaves the designer free to components that + 16550 UART. This leaves the designer free to components that may have better performance characteristics. @@ -2627,8 +2627,8 @@ INS8250 -> INS8250B The sio driver provides support for NS8250-, NS16450-, NS16550 and NS16550A-based EIA - RS-232C (CCITT V.24) communications interfaces. Several - multiport cards are supported as well. See the sio4 manual page for detailed technical + RS-232C (CCITT V.24) communications interfaces. Several + multiport cards are supported as well. See the sio4 manual page for detailed technical documentation. @@ -2639,8 +2639,8 @@ INS8250 -> INS8250B August 1995. Here is a config snippet from a machine with a Digi - International PC/8 with 16550. It has 8 modems connected to - these 8 lines, and they work just great. Do not forget to add + International PC/8 with 16550. It has 8 modems connected to + these 8 lines, and they work just great. Do not forget to add options COM_MULTIPORT or it will not work very well! @@ -2676,7 +2676,7 @@ device sio11 at isa? port 0x138 tty flags 0xb05 irq 9 vector siointr< You either need the kernel sources installed so you can recompile the necessary options or you will need - someone else to compile it for you. The 2.0.5 default + someone else to compile it for you. The 2.0.5 default kernel does not come with multiport support enabled and you will need to add a device entry for each port anyways. @@ -2692,15 +2692,15 @@ device sio11 at isa? port 0x138 tty flags 0xb05 irq 9 vector siointr< One important note — the actual UART chips for the Boca 16 - are in the connector box, not on the internal board itself. So - if you have it unplugged, probes of those ports will fail. I + are in the connector box, not on the internal board itself. So + if you have it unplugged, probes of those ports will fail. I have never tested booting with the box unplugged and plugging it back in, and I suggest you do not either. If you do not already have a custom kernel configuration file set up, refer to Kernel Configuration for - general procedures. The following are the specifics for the + general procedures. The following are the specifics for the Boca 16 board and assume you are using the kernel name MYKERNEL and editing with vi. @@ -2717,13 +2717,13 @@ options COM_MULTIPORT Where the current device sion lines are, - you will need to add 16 more devices. Only + you will need to add 16 more devices. Only the last device includes the interrupt vector for the - board. (See the sio4 manual page for detail as + board. (See the sio4 manual page for detail as to why.) The following example is for a Boca Board with - an interrupt of 3, and a base IO address 100h. The IO + an interrupt of 3, and a base IO address 100h. The IO address for Each port is +8 hexadecimal from the - previous port, thus the 100h, 108h, 110h... addresses. + previous port, thus the 100h, 108h, 110h... addresses. device sio1 at isa? port 0x100 tty flags 0x1005 @@ -2742,21 +2742,21 @@ device sio16 at isa? port 0x178 tty flags 0x1005 irq 3 vector siointrYY indicates if FIFO is enabled or disabled(enabled), IRQ sharing is used(yes) and if there - is an AST/4 compatible IRQ control register(no). In this + is an AST/4 compatible IRQ control register(no). In this example, flags 0x1005 indicates that the master port is - sio16. If I added another board and assigned sio17 + sio16. If I added another board and assigned sio17 through sio28, the flags for all 16 ports on that board would be 0x1C05, where - 1C indicates the minor number of the master port. Do not + 1C indicates the minor number of the master port. Do not change the 05 setting. Save and complete the kernel configuration, - recompile, install and reboot. Presuming you have + recompile, install and reboot. Presuming you have successfully installed the recompiled kernel and have it set to the correct address and IRQ, your boot message should indicate the successful probe of the Boca ports @@ -2834,7 +2834,7 @@ sio16: type 16550A (multiport master) &prompt.root; echo at > ttyd* - for each device you have made. You + for each device you have made. You should see the RX lights flash for each working port. @@ -2852,7 +2852,7 @@ sio16: type 16550A (multiport master) The Cyclades multiport cards are based on the cy driver instead of the usual sio driver used by other multiport - cards. Configuration is a simple matter of: + cards. Configuration is a simple matter of: @@ -2884,7 +2884,7 @@ device cy0 at isa? tty irq 10 iomem 0xd4000 iosiz 0x2000 vector cyintr If appropriate, add dialup entries to /etc/ttys - by duplicating serial device (ttyd) entries and using ttyc in place of ttyd. For example: + by duplicating serial device (ttyd) entries and using ttyc in place of ttyd. For example: ttyc0 "/usr/libexec/getty std.38400" unknown on insecure @@ -2953,16 +2953,16 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure devised by Seagate Technology, the makers of the first affordable 5.25" winchester disk. - The acronym says Enhanced, and rightly so. In the first place + The acronym says Enhanced, and rightly so. In the first place the speed of the interface is higher, 10 or 15 Mbits/second - instead of the 5 Mbits/second of ST412 interfaced drives. Secondly + instead of the 5 Mbits/second of ST412 interfaced drives. Secondly some higher level commands are added, making the ESDI interface - somewhat 'smarter' to the operating system driver writers. It is - by no means as smart as SCSI by the way. ESDI is standardized by + somewhat 'smarter' to the operating system driver writers. It is + by no means as smart as SCSI by the way. ESDI is standardized by ANSI. Capacities of the drives are boosted by putting more sectors - on each track. Typical is 35 sectors per track, high capacity + on each track. Typical is 35 sectors per track, high capacity drives I have seen were up to 54 sectors/track. Although ESDI has been largely obsoleted by IDE and SCSI @@ -2978,19 +2978,19 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Physical connections The ESDI interface uses two cables connected to each - drive. One cable is a 34 pin flat cable edge connector that + drive. One cable is a 34 pin flat cable edge connector that carries the command and status signals from the controller to - the drive and vice-versa. The command cable is daisy chained - between all the drives. So, it forms a bus onto which all + the drive and vice-versa. The command cable is daisy chained + between all the drives. So, it forms a bus onto which all drives are connected. The second cable is a 20 pin flat cable edge connector - that carries the data to and from the drive. This cable is + that carries the data to and from the drive. This cable is radially connected, so each drive has its own direct connection to the controller. To the best of my knowledge PC ESDI controllers are - limited to using a maximum of 2 drives per controller. This is + limited to using a maximum of 2 drives per controller. This is compatibility feature(?) left over from the WD1003 standard that reserves only a single bit for device addressing. @@ -3000,13 +3000,13 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Device addressing On each command cable a maximum of 7 devices and 1 - controller can be present. To enable the controller to + controller can be present. To enable the controller to uniquely identify which drive it addresses, each ESDI device is equipped with jumpers or switches to select the devices address. On PC type controllers the first drive is set to address - 0, the second disk to address 1. Always + 0, the second disk to address 1. Always make sure you set each disk to an unique address! So, on a PC with its two drives/controller maximum the first drive is drive 0, the second is drive 1. @@ -3018,14 +3018,14 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure The daisy chained command cable (the 34 pin cable remember?) needs to be terminated at the last drive on the - chain. For this purpose ESDI drives come with a termination + chain. For this purpose ESDI drives come with a termination resistor network that can be removed or disabled by a jumper when it is not used. So, one and only one drive, the one at the farthest end of the command cable has its - terminator installed/enabled. The controller automatically - terminates the other end of the cable. Please note that this + terminator installed/enabled. The controller automatically + terminates the other end of the cable. Please note that this implies that the controller must be at one end of the cable and not in the middle. @@ -3039,12 +3039,12 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure place? People who tried ESDI disks with FreeBSD are known to have - developed a profound sense of frustration. A combination of + developed a profound sense of frustration. A combination of factors works against you to produce effects that are hard to understand when you have never seen them before. This has also led to the popular legend ESDI and FreeBSD is - a plain NO-GO. The following sections try to list all the + a plain NO-GO. The following sections try to list all the pitfalls and solutions. @@ -3052,12 +3052,12 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure ESDI speed variants As briefly mentioned before, ESDI comes in two speed - flavors. The older drives and controllers use a 10 - Mbits/second data transfer rate. Newer stuff uses 15 + flavors. The older drives and controllers use a 10 + Mbits/second data transfer rate. Newer stuff uses 15 Mbits/second. It is not hard to imagine that 15 Mbits/second drive cause - problems on controllers laid out for 10 Mbits/second. As + problems on controllers laid out for 10 Mbits/second. As always, consult your controller and drive documentation to see if things match. @@ -3068,18 +3068,18 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Mainstream ESDI drives use 34 to 36 sectors per track. Most (older) controllers cannot handle more than this number - of sectors. Newer, higher capacity, drives use higher numbers - of sectors per track. For instance, I own a 670 Mb drive that + of sectors. Newer, higher capacity, drives use higher numbers + of sectors per track. For instance, I own a 670 Mb drive that has 54 sectors per track. In my case, the controller could not handle this number of - sectors. It proved to work well except that it only used 35 - sectors on each track. This meant losing a lot of disk + sectors. It proved to work well except that it only used 35 + sectors on each track. This meant losing a lot of disk space. Once again, check the documentation of your hardware for - more info. Going out-of-spec like in the example might or - might not work. Give it a try or get another more capable + more info. Going out-of-spec like in the example might or + might not work. Give it a try or get another more capable controller. @@ -3088,26 +3088,26 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Hard or soft sectoring Most ESDI drives allow hard or soft sectoring to be - selected using a jumper. Hard sectoring means that the drive + selected using a jumper. Hard sectoring means that the drive will produce a sector pulse on the start of each new sector. The controller uses this pulse to tell when it should start to write or read. Hard sectoring allows a selection of sector size (normally - 256, 512 or 1024 bytes per formatted sector). FreeBSD uses - 512 byte sectors. The number of sectors per track also varies + 256, 512 or 1024 bytes per formatted sector). FreeBSD uses + 512 byte sectors. The number of sectors per track also varies while still using the same number of bytes per formatted - sector. The number of unformatted bytes + sector. The number of unformatted bytes per sector varies, dependent on your controller it needs more - or less overhead bytes to work correctly. Pushing more + or less overhead bytes to work correctly. Pushing more sectors on a track of course gives you more usable space, but might give problems if your controller needs more bytes than the drive offers. In case of soft sectoring, the controller itself - determines where to start/stop reading or writing. For ESDI + determines where to start/stop reading or writing. For ESDI hard sectoring is the default (at least on everything I came - across). I never felt the urge to try soft sectoring. + across). I never felt the urge to try soft sectoring. In general, experiment with sector settings before you install FreeBSD because you need to re-run the low-level @@ -3119,21 +3119,21 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Low level formatting ESDI drives need to be low level formatted before they are - usable. A reformat is needed whenever you figgle with the + usable. A reformat is needed whenever you figgle with the number of sectors/track jumpers or the physical orientation of - the drive (horizontal, vertical). So, first think, then - format. The format time must not be underestimated, for big + the drive (horizontal, vertical). So, first think, then + format. The format time must not be underestimated, for big disks it can take hours. After a low level format, a surface scan is done to find - and flag bad sectors. Most disks have a manufacturer bad block - list listed on a piece of paper or adhesive sticker. In + and flag bad sectors. Most disks have a manufacturer bad block + list listed on a piece of paper or adhesive sticker. In addition, on most disks the list is also written onto the - disk. Please use the manufacturer's list. It is much easier to + disk. Please use the manufacturer's list. It is much easier to remap a defect now than after FreeBSD is installed. Stay away from low-level formatters that mark all sectors - of a track as bad as soon as they find one bad sector. Not + of a track as bad as soon as they find one bad sector. Not only does this waste space, it also and more importantly causes you grief with bad144 (see the section on bad144). @@ -3144,8 +3144,8 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Translations Translations, although not exclusively a ESDI-only - problem, might give you real trouble. Translations come in - multiple flavors. Most of them have in common that they + problem, might give you real trouble. Translations come in + multiple flavors. Most of them have in common that they attempt to work around the limitations posed upon disk geometries by the original IBM PC/AT design (thanks IBM!). @@ -3153,27 +3153,27 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure First of all there is the (in)famous 1024 cylinder limit. For a system to be able to boot, the stuff (whatever operating system) must be in the first 1024 cylinders of a - disk. Only 10 bits are available to encode the cylinder - number. For the number of sectors the limit is 64 (0-63). When + disk. Only 10 bits are available to encode the cylinder + number. For the number of sectors the limit is 64 (0-63). When you combine the 1024 cylinder limit with the 16 head limit (also a design feature) you max out at fairly limited disk sizes. To work around this problem, the manufacturers of ESDI PC - controllers added a BIOS prom extension on their boards. This + controllers added a BIOS prom extension on their boards. This BIOS extension handles disk I/O for booting (and for some operating systems all disk I/O) - by using translation. For instance, a big drive might be + by using translation. For instance, a big drive might be presented to the system as having 32 heads and 64 - sectors/track. The result is that the number of cylinders is + sectors/track. The result is that the number of cylinders is reduced to something below 1024 and is therefore usable by the - system without problems. It is noteworthy to know that FreeBSD - does not use the BIOS after its kernel has started. More on + system without problems. It is noteworthy to know that FreeBSD + does not use the BIOS after its kernel has started. More on this later. A second reason for translations is the fact that most older system BIOSes could only handle drives with 17 sectors - per track (the old ST412 standard). Newer system BIOSes + per track (the old ST412 standard). Newer system BIOSes usually have a user-defined drive type (in most cases this is drive type 47). @@ -3187,8 +3187,8 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure While on the subject of translations, I have seen one controller type (but there are probably more like this) offer the option to logically split a drive in multiple partitions - as a BIOS option. I had select 1 drive == 1 partition because - this controller wrote this info onto the disk. On power-up it + as a BIOS option. I had select 1 drive == 1 partition because + this controller wrote this info onto the disk. On power-up it read the info and presented itself to the system based on the info from the disk. @@ -3198,19 +3198,19 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Spare sectoring Most ESDI controllers offer the possibility to remap bad - sectors. During/after the low-level format of the disk bad + sectors. During/after the low-level format of the disk bad sectors are marked as such, and a replacement sector is put in place (logically of course) of the bad one. In most cases the remapping is done by using N-1 sectors on each track for actual data storage, and sector N itself is - the spare sector. N is the total number of sectors physically - available on the track. The idea behind this is that the - operating system sees a 'perfect' disk without bad sectors. In + the spare sector. N is the total number of sectors physically + available on the track. The idea behind this is that the + operating system sees a 'perfect' disk without bad sectors. In the case of FreeBSD this concept is not usable. The problem is that the translation from bad to good is performed by the BIOS of the - ESDI controller. FreeBSD, being a true 32 bit operating + ESDI controller. FreeBSD, being a true 32 bit operating system, does not use the BIOS after it has been booted. Instead, it has device drivers that talk directly to the hardware. @@ -3225,35 +3225,35 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Bad block handling - The preceding section leaves us with a problem. The + The preceding section leaves us with a problem. The controller's bad block handling is not usable and still FreeBSD's filesystems assume perfect media without any flaws. - To solve this problem, FreeBSD use the bad144 tool. Bad144 (named after a + To solve this problem, FreeBSD use the bad144 tool. Bad144 (named after a Digital Equipment standard for bad block handling) scans a - FreeBSD slice for bad blocks. Having found these bad blocks, + FreeBSD slice for bad blocks. Having found these bad blocks, it writes a table with the offending block numbers to the end of the FreeBSD slice. When the disk is in operation, the disk accesses are - checked against the table read from the disk. Whenever a + checked against the table read from the disk. Whenever a block number is requested that is in the bad144 list, a replacement block (also from the end of the FreeBSD slice) is - used. In this way, the bad144 replacement scheme presents + used. In this way, the bad144 replacement scheme presents 'perfect' media to the FreeBSD filesystems. There are a number of potential pitfalls associated with - the use of bad144. First of all, the slice cannot have more - than 126 bad sectors. If your drive has a high number of bad + the use of bad144. First of all, the slice cannot have more + than 126 bad sectors. If your drive has a high number of bad sectors, you might need to divide it into multiple FreeBSD - slices each containing less than 126 bad sectors. Stay away + slices each containing less than 126 bad sectors. Stay away from low-level format programs that mark every sector of a track as bad when they - find a flaw on the track. As you can imagine, the 126 limit + find a flaw on the track. As you can imagine, the 126 limit is quickly reached when the low-level format is done this way. Second, if the slice contains the root filesystem, the - slice should be within the 1024 cylinder BIOS limit. During + slice should be within the 1024 cylinder BIOS limit. During the boot process the bad144 list is read using the BIOS and this only succeeds when the list is within the 1024 cylinder limit. @@ -3270,17 +3270,17 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Kernel configuration - ESDI disks are handled by the same wddriver as IDE and ST412 MFM disks. The + ESDI disks are handled by the same wddriver as IDE and ST412 MFM disks. The wd driver should work for all WD1003 compatible interfaces. Most hardware is jumperable for one of two different I/O - address ranges and IRQ lines. This allows you to have two wd + address ranges and IRQ lines. This allows you to have two wd type controllers in one system. When your hardware allows non-standard strappings, you can use these with FreeBSD as long as you enter the correct info - into the kernel config file. An example from the kernel config + into the kernel config file. An example from the kernel config file (they live in /sys/i386/conf BTW). @@ -3305,36 +3305,36 @@ disk wd3 at wdc1 drive 1 Adaptec 2320 controllers I successfully installed FreeBSD onto a ESDI disk - controlled by a ACB-2320. No other operating system was + controlled by a ACB-2320. No other operating system was present on the disk. To do so I low level formatted the disk using NEFMT.EXE (ftpable from www.adaptec.com) and answered NO to the question whether the disk should be formatted with a spare - sector on each track. The BIOS on the ACD-2320 was disabled. I + sector on each track. The BIOS on the ACD-2320 was disabled. I used the free configurable option in the system BIOS to allow the BIOS to boot it. Before using NEFMT.EXE I tried to format the disk using - the ACB-2320 BIOS builtin formatter. This proved to be a show + the ACB-2320 BIOS builtin formatter. This proved to be a show stopper, because it did not give me an option to disable spare - sectoring. With spare sectoring enabled the FreeBSD + sectoring. With spare sectoring enabled the FreeBSD installation process broke down on the bad144 run. Please check carefully which ACB-232xy variant you have. The x is either 0 or 2, indicating a controller without or with a floppy controller on board. - The y is more interesting. It can either be a blank, a - A-8 or a D. A blank indicates a plain 10 Mbits/second - controller. An A-8 indicates a 15 Mbits/second controller - capable of handling 52 sectors/track. A D means a 15 + The y is more interesting. It can either be a blank, a + A-8 or a D. A blank indicates a plain 10 Mbits/second + controller. An A-8 indicates a 15 Mbits/second controller + capable of handling 52 sectors/track. A D means a 15 Mbits/second controller that can also handle drives with > 36 sectors/track (also 52 ?). All variations should be capable of using 1:1 - interleaving. Use 1:1, FreeBSD is fast enough to handle + interleaving. Use 1:1, FreeBSD is fast enough to handle it. @@ -3343,12 +3343,12 @@ disk wd3 at wdc1 drive 1 Western Digital WD1007 controllers I successfully installed FreeBSD onto a ESDI disk - controlled by a WD1007 controller. To be precise, it was a - WD1007-WA2. Other variations of the WD1007 do exist. + controlled by a WD1007 controller. To be precise, it was a + WD1007-WA2. Other variations of the WD1007 do exist. To get it to work, I had to disable the sector translation - and the WD1007's onboard BIOS. This implied I could not use - the low-level formatter built into this BIOS. Instead, I + and the WD1007's onboard BIOS. This implied I could not use + the low-level formatter built into this BIOS. Instead, I grabbed WDFMT.EXE from www.wdc.com Running this formatted my drive just fine. @@ -3358,7 +3358,7 @@ disk wd3 at wdc1 drive 1 Ultrastor U14F controllers According to multiple reports from the net, Ultrastor ESDI - boards work OK with FreeBSD. I lack any further info on + boards work OK with FreeBSD. I lack any further info on particular settings. @@ -3405,88 +3405,88 @@ disk wd3 at wdc1 drive 1 Copyright © 1995, &a.wilko;.July 6, 1996. - SCSI is an acronym for Small Computer Systems Interface. It + SCSI is an acronym for Small Computer Systems Interface. It is an ANSI standard that has become one of the leading I/O buses - in the computer industry. The foundation of the SCSI standard was + in the computer industry. The foundation of the SCSI standard was laid by Shugart Associates (the same guys that gave the world the first mini floppy disks) when they introduced the SASI bus (Shugart Associates Standard Interface). After some time an industry effort was started to come to a more strict standard allowing devices from different vendors to - work together. This effort was recognized in the ANSI SCSI-1 - standard. The SCSI-1 standard (approx 1985) is rapidly becoming - obsolete. The current standard is SCSI-2 (see Further reading), with SCSI-3 on the drawing boards. In addition to a physical interconnection standard, SCSI defines a logical (command set) standard to which disk devices - must adhere. This standard is called the Common Command Set (CCS) + must adhere. This standard is called the Common Command Set (CCS) and was developed more or less in parallel with ANSI SCSI-1. SCSI-2 includes the (revised) CCS as part of the standard itself. - The commands are dependent on the type of device at hand. It does + The commands are dependent on the type of device at hand. It does not make much sense of course to define a Write command for a scanner. The SCSI bus is a parallel bus, which comes in a number of - variants. The oldest and most used is an 8 bit wide bus, with - single-ended signals, carried on 50 wires. (If you do not know + variants. The oldest and most used is an 8 bit wide bus, with + single-ended signals, carried on 50 wires. (If you do not know what single-ended means, do not worry, that is what this document is all about.) Modern designs also use 16 bit wide buses, with - differential signals. This allows transfer speeds of - 20Mbytes/second, on cables lengths of up to 25 meters. SCSI-2 + differential signals. This allows transfer speeds of + 20Mbytes/second, on cables lengths of up to 25 meters. SCSI-2 allows a maximum bus width of 32 bits, using an additional cable. Quickly emerging are Ultra SCSI (also called Fast-20) and Ultra2 - (also called Fast-40). Fast-20 is 20 million transfers per second + (also called Fast-40). Fast-20 is 20 million transfers per second (20 Mbytes/sec on a 8 bit bus), Fast-40 is 40 million transfers - per second (40 Mbytes/sec on a 8 bit bus). Most hard drives sold + per second (40 Mbytes/sec on a 8 bit bus). Most hard drives sold today are single-ended Ultra SCSI (8 or 16 bits). Of course the SCSI bus not only has data lines, but also a - number of control signals. A very elaborate protocol is part of + number of control signals. A very elaborate protocol is part of the standard to allow multiple devices to share the bus in an - efficient manner. In SCSI-2, the data is always checked using a - separate parity line. In pre-SCSI-2 designs parity was + efficient manner. In SCSI-2, the data is always checked using a + separate parity line. In pre-SCSI-2 designs parity was optional. In SCSI-3 even faster bus types are introduced, along with a serial SCSI busses that reduces the cabling overhead and allows a - higher maximum bus length. You might see names like SSA and - Fiberchannel in this context. None of the serial buses are + higher maximum bus length. You might see names like SSA and + Fiberchannel in this context. None of the serial buses are currently in widespread use (especially not in the typical FreeBSD - environment). For this reason the serial bus types are not + environment). For this reason the serial bus types are not discussed any further. As you could have guessed from the description above, SCSI - devices are intelligent. They have to be to adhere to the SCSI - standard (which is over 2 inches thick BTW). So, for a hard disk + devices are intelligent. They have to be to adhere to the SCSI + standard (which is over 2 inches thick BTW). So, for a hard disk drive for instance you do not specify a head/cylinder/sector to address a particular block, but simply the number of the block you - want. Elaborate caching schemes, automatic bad block replacement + want. Elaborate caching schemes, automatic bad block replacement etc are all made possible by this 'intelligent device' approach. On a SCSI bus, each possible pair of devices can communicate. Whether their function allows this is another matter, but the - standard does not restrict it. To avoid signal contention, the 2 + standard does not restrict it. To avoid signal contention, the 2 devices have to arbitrate for the bus before using it. The philosophy of SCSI is to have a standard that allows - older-standard devices to work with newer-standard ones. So, an - old SCSI-1 device should normally work on a SCSI-2 bus. I say + older-standard devices to work with newer-standard ones. So, an + old SCSI-1 device should normally work on a SCSI-2 bus. I say Normally, because it is not absolutely sure that the implementation of an old device follows the (old) standard closely - enough to be acceptable on a new bus. Modern devices are usually + enough to be acceptable on a new bus. Modern devices are usually more well-behaved, because the standardization has become more strict and is better adhered to by the device manufacturers. Generally speaking, the chances of getting a working set of devices on a single bus is better when all the devices are SCSI-2 - or newer. This implies that you do not have to dump all your old + or newer. This implies that you do not have to dump all your old stuff when you get that shiny 2GB disk: I own a system on which a pre-SCSI-1 disk, a SCSI-2 QIC tape unit, a SCSI-1 helical scan - tape unit and 2 SCSI-1 disks work together quite happily. From a + tape unit and 2 SCSI-1 disks work together quite happily. From a performance standpoint you might want to separate your older and newer (=faster) devices however. @@ -3494,13 +3494,13 @@ disk wd3 at wdc1 drive 1 Components of SCSI - As said before, SCSI devices are smart. The idea is to put + As said before, SCSI devices are smart. The idea is to put the knowledge about intimate hardware details onto the SCSI - device itself. In this way, the host system does not have to + device itself. In this way, the host system does not have to worry about things like how many heads are hard disks has, or - how many tracks there are on a specific tape device. If you are + how many tracks there are on a specific tape device. If you are curious, the standard specifies commands with which you can - query your devices on their hardware particulars. FreeBSD uses + query your devices on their hardware particulars. FreeBSD uses this capability during boot to check out what devices are connected and whether they need any special treatment. @@ -3510,15 +3510,15 @@ disk wd3 at wdc1 drive 1 every odd new device that is introduced. For cabling and connectors there is a golden rule: get good - stuff. With bus speeds going up all the time you will save + stuff. With bus speeds going up all the time you will save yourself a lot of grief by using good material. So, gold plated connectors, shielded cabling, sturdy connector hoods with strain reliefs etc are the way to go. - Second golden rule: do no use cables longer than necessary. I + Second golden rule: do no use cables longer than necessary. I once spent 3 days hunting down a problem with a flaky machine only to discover that shortening the SCSI bus by 1 meter solved - the problem. And the original bus length was well within the + the problem. And the original bus length was well within the SCSI specification. @@ -3527,15 +3527,15 @@ disk wd3 at wdc1 drive 1 SCSI bus types From an electrical point of view, there are two incompatible - bus types: single-ended and differential. This means that there + bus types: single-ended and differential. This means that there are two different main groups of SCSI devices and controllers, - which cannot be mixed on the same bus. It is possible however + which cannot be mixed on the same bus. It is possible however to use special converter hardware to transform a single-ended - bus into a differential one (and vice versa). The differences + bus into a differential one (and vice versa). The differences between the bus types are explained in the next sections. In lots of SCSI related documentation there is a sort of - jargon in use to abbreviate the different bus types. A small + jargon in use to abbreviate the different bus types. A small list: @@ -3573,16 +3573,16 @@ disk wd3 at wdc1 drive 1 Fast means that the timing on the bus is somewhat different, so that on a narrow (8 bit) bus 10 Mbytes/sec are possible - instead of 5 Mbytes/sec for 'slow' SCSI. As discussed before, + instead of 5 Mbytes/sec for 'slow' SCSI. As discussed before, bus speeds of 20 and 40 million transfers/second are also emerging (Fast-20 == Ultra SCSI and Fast-40 == Ultra2 SCSI). The data lines > 8 are only used for data transfers and - device addressing. The transfers of commands and status + device addressing. The transfers of commands and status messages etc are only performed on the lowest 8 data lines. The standard allows narrow devices to operate on a wide bus. - The usable bus width is negotiated between the devices. You + The usable bus width is negotiated between the devices. You have to watch your device addressing closely when mixing wide and narrow. @@ -3592,19 +3592,19 @@ disk wd3 at wdc1 drive 1 A single-ended SCSI bus uses signals that are either 5 Volts or 0 Volts (indeed, TTL levels) and are relative to a - COMMON ground reference. A singled ended 8 bit SCSI bus has + COMMON ground reference. A singled ended 8 bit SCSI bus has approximately 25 ground lines, who are all tied to a single - `rail' on all devices. A standard single ended bus has a - maximum length of 6 meters. If the same bus is used with + `rail' on all devices. A standard single ended bus has a + maximum length of 6 meters. If the same bus is used with fast-SCSI devices, the maximum length allowed drops to 3 - meters. Fast-SCSI means that instead of 5Mbytes/sec the bus + meters. Fast-SCSI means that instead of 5Mbytes/sec the bus allows 10Mbytes/sec transfers. Fast-20 (Ultra SCSI) and Fast-40 allow for 20 and 40 - million transfers/second respectively. So, F20 is 20 + million transfers/second respectively. So, F20 is 20 Mbytes/second on a 8 bit bus, 40 Mbytes/second on a 16 bit bus - etc. For F20 the max bus length is 1.5 meters, for F40 it - becomes 0.75 meters. Be aware that F20 is pushing the limits + etc. For F20 the max bus length is 1.5 meters, for F40 it + becomes 0.75 meters. Be aware that F20 is pushing the limits quite a bit, so you will quickly find out if your SCSI bus is electrically sound. @@ -3615,7 +3615,7 @@ disk wd3 at wdc1 drive 1 It is obvious that with the newer fast-SCSI devices the - bus length can become a real bottleneck. This is why the + bus length can become a real bottleneck. This is why the differential SCSI bus was introduced in the SCSI-2 standard. @@ -3624,14 +3624,14 @@ disk wd3 at wdc1 drive 1 linkend="scsi-further-reading">Further reading) itself, connectors etc are listed there in painstaking detail. - Beware of devices using non-standard cabling. For instance + Beware of devices using non-standard cabling. For instance Apple uses a 25pin D-type connecter (like the one on serial - ports and parallel printers). Considering that the official + ports and parallel printers). Considering that the official SCSI bus needs 50 pins you can imagine the use of this - connector needs some 'creative cabling'. The reduction of the + connector needs some 'creative cabling'. The reduction of the number of ground wires they used is a bad idea, you better stick to 50 pins cabling in accordance with the SCSI - standard. For Fast-20 and 40 do not even think about buses + standard. For Fast-20 and 40 do not even think about buses like this. @@ -3641,27 +3641,27 @@ disk wd3 at wdc1 drive 1 A differential SCSI bus has a maximum length of 25 meters. Quite a difference from the 3 meters for a single-ended - fast-SCSI bus. The idea behind differential signals is that - each bus signal has its own return wire. So, each signal is - carried on a (preferably twisted) pair of wires. The voltage + fast-SCSI bus. The idea behind differential signals is that + each bus signal has its own return wire. So, each signal is + carried on a (preferably twisted) pair of wires. The voltage difference between these two wires determines whether the - signal is asserted or de-asserted. To a certain extent the + signal is asserted or de-asserted. To a certain extent the voltage difference between ground and the signal wire pair is not relevant (do not try 10 kVolts though). It is beyond the scope of this document to explain why - this differential idea is so much better. Just accept that + this differential idea is so much better. Just accept that electrically seen the use of differential signals gives a much - better noise margin. You will normally find differential buses - in use for inter-cabinet connections. Because of the lower + better noise margin. You will normally find differential buses + in use for inter-cabinet connections. Because of the lower cost single ended is mostly used for shorter buses like inside cabinets. There is nothing that stops you from using differential stuff with FreeBSD, as long as you use a controller that has - device driver support in FreeBSD. As an example, Adaptec + device driver support in FreeBSD. As an example, Adaptec marketed the AHA1740 as a single ended board, whereas the - AHA1744 was differential. The software interface to the host + AHA1744 was differential. The software interface to the host is identical for both. @@ -3670,62 +3670,62 @@ disk wd3 at wdc1 drive 1 Terminators Terminators in SCSI terminology are resistor networks that - are used to get a correct impedance matching. Impedance + are used to get a correct impedance matching. Impedance matching is important to get clean signals on the bus, without - reflections or ringing. If you once made a long distance + reflections or ringing. If you once made a long distance telephone call on a bad line you probably know what - reflections are. With 20Mbytes/sec traveling over your SCSI + reflections are. With 20Mbytes/sec traveling over your SCSI bus, you do not want signals echoing back. Terminators come in various incarnations, with more or - less sophisticated designs. Of course, there are internal and - external variants. Many SCSI devices come with a number of + less sophisticated designs. Of course, there are internal and + external variants. Many SCSI devices come with a number of sockets in which a number of resistor networks can (must be!) - installed. If you remove terminators from a device, carefully - store them. You will need them when you ever decide to - reconfigure your SCSI bus. There is enough variation in even + installed. If you remove terminators from a device, carefully + store them. You will need them when you ever decide to + reconfigure your SCSI bus. There is enough variation in even these simple tiny things to make finding the exact replacement - a frustrating business. There are also SCSI devices that have + a frustrating business. There are also SCSI devices that have a single jumper to enable or disable a built-in terminator. There are special terminators you can stick onto a flat cable - bus. Others look like external connectors, or a connector - hood without a cable. So, lots of choice as you can + bus. Others look like external connectors, or a connector + hood without a cable. So, lots of choice as you can see. There is much debate going on if and when you should switch from simple resistor (passive) terminators to active - terminators. Active terminators contain slightly more - elaborate circuit to give cleaner bus signals. The general + terminators. Active terminators contain slightly more + elaborate circuit to give cleaner bus signals. The general consensus seems to be that the usefulness of active termination increases when you have long buses and/or fast - devices. If you ever have problems with your SCSI buses you - might consider trying an active terminator. Try to borrow one + devices. If you ever have problems with your SCSI buses you + might consider trying an active terminator. Try to borrow one first, they reputedly are quite expensive. Please keep in mind that terminators for differential and - single-ended buses are not identical. You should not mix the two variants. + single-ended buses are not identical. You should not mix the two variants. OK, and now where should you install your terminators? - This is by far the most misunderstood part of SCSI. And it is - by far the simplest. The rule is: every + This is by far the most misunderstood part of SCSI. And it is + by far the simplest. The rule is: every single line on the SCSI bus has 2 (two) terminators, one at each end of the bus. So, two and not one or three - or whatever. Do yourself a favor and stick to this rule. It + or whatever. Do yourself a favor and stick to this rule. It will save you endless grief, because wrong termination has the - potential to introduce highly mysterious bugs. (Note the + potential to introduce highly mysterious bugs. (Note the “potential” here; the nastiest part is that it may or may not work.) A common pitfall is to have an internal (flat) cable in a machine and also an external cable attached to the controller. It seems almost everybody forgets to remove the terminators - from the controller. The terminator must now be on the last + from the controller. The terminator must now be on the last external device, and not on the controller! In general, every reconfiguration of a SCSI bus must pay attention to this. - Termination is to be done on a per-line basis. This + Termination is to be done on a per-line basis. This means if you have both narrow and wide buses connected to the same host adapter, you need to enable termination on the higher 8 bits of the bus on the adapter (as well as the last @@ -3733,19 +3733,19 @@ disk wd3 at wdc1 drive 1 What I did myself is remove all terminators from my SCSI - devices and controllers. I own a couple of external + devices and controllers. I own a couple of external terminators, for both the Centronics-type external cabling and - for the internal flat cable connectors. This makes + for the internal flat cable connectors. This makes reconfiguration much easier. On modern devices, sometimes integrated terminators are - used. These things are special purpose integrated circuits - that can be dis/en-abled with a control pin. It is not - necessary to physically remove them from a device. You may + used. These things are special purpose integrated circuits + that can be dis/en-abled with a control pin. It is not + necessary to physically remove them from a device. You may find them on newer host adapters, sometimes they are software - configurable, using some sort of setup tool. Some will even + configurable, using some sort of setup tool. Some will even auto-detect the cables attached to the connectors and - automatically set up the termination as necessary. At any + automatically set up the termination as necessary. At any rate, consult your documentation! @@ -3754,30 +3754,30 @@ disk wd3 at wdc1 drive 1 Terminator power The terminators discussed in the previous chapter need - power to operate properly. On the SCSI bus, a line is - dedicated to this purpose. So, simple huh? + power to operate properly. On the SCSI bus, a line is + dedicated to this purpose. So, simple huh? - Not so. Each device can provide its own terminator power - to the terminator sockets it has on-device. But if you have + Not so. Each device can provide its own terminator power + to the terminator sockets it has on-device. But if you have external terminators, or when the device supplying the terminator power to the SCSI bus line is switched off you are in trouble. The idea is that initiators (these are devices that initiate actions on the bus, a discussion follows) must supply - terminator power. All SCSI devices are allowed (but not + terminator power. All SCSI devices are allowed (but not required) to supply terminator power. To allow for un-powered devices on a bus, the terminator - power must be supplied to the bus via a diode. This prevents + power must be supplied to the bus via a diode. This prevents the backflow of current to un-powered devices. To prevent all kinds of nastiness, the terminator power is - usually fused. As you can imagine, fuses might blow. This - can, but does not have to, lead to a non functional bus. If + usually fused. As you can imagine, fuses might blow. This + can, but does not have to, lead to a non functional bus. If multiple devices supply terminator power, a single blown fuse - will not put you out of business. A single supplier with a - blown fuse certainly will. Clever external terminators + will not put you out of business. A single supplier with a + blown fuse certainly will. Clever external terminators sometimes have a LED indication that shows whether terminator power is present. @@ -3793,47 +3793,47 @@ disk wd3 at wdc1 drive 1 distinguish or address the different devices connected to it. - This is done by means of the SCSI or target ID. Each - device has a unique target ID. You can select the ID to which + This is done by means of the SCSI or target ID. Each + device has a unique target ID. You can select the ID to which a device must respond using a set of jumpers, or a dip switch, - or something similar. Some SCSI host adapters let you change - the target ID from the boot menu. (Yet some others will not + or something similar. Some SCSI host adapters let you change + the target ID from the boot menu. (Yet some others will not let you change the ID from 7.) Consult the documentation of your device for more information. Beware of multiple devices configured to use the same ID. - Chaos normally reigns in this case. A pitfall is that one of + Chaos normally reigns in this case. A pitfall is that one of the devices sharing the same ID sometimes even manages to answer to I/O requests! - For an 8 bit bus, a maximum of 8 targets is possible. The + For an 8 bit bus, a maximum of 8 targets is possible. The maximum is 8 because the selection is done bitwise using the 8 - data lines on the bus. For wide buses this increases to the + data lines on the bus. For wide buses this increases to the number of data lines (usually 16). A narrow SCSI device can not communicate with a SCSI - device with a target ID larger than 7. This means it is + device with a target ID larger than 7. This means it is generally not a good idea to move your SCSI host adapter's target ID to something higher than 7 (or your CD-ROM will stop working). The higher the SCSI target ID, the higher the priority the - devices has. When it comes to arbitration between devices + devices has. When it comes to arbitration between devices that want to use the bus at the same time, the device that has - the highest SCSI ID will win. This also means that the SCSI - host adapter usually uses target ID 7. Note however that the + the highest SCSI ID will win. This also means that the SCSI + host adapter usually uses target ID 7. Note however that the lower 8 IDs have higher priorities than the higher 8 IDs on a - wide-SCSI bus. Thus, the order of target IDs is: [7 6 .. 1 0 15 14 .. 9 8] on a wide-SCSI - system. (If you you are wondering why the lower 8 have higher + wide-SCSI bus. Thus, the order of target IDs is: [7 6 .. 1 0 15 14 .. 9 8] on a wide-SCSI + system. (If you you are wondering why the lower 8 have higher priority, read the previous paragraph for a hint.) For a further subdivision, the standard allows for Logical - Units or LUNs for short. A single target ID may have multiple - LUNs. For example, a tape device including a tape changer may + Units or LUNs for short. A single target ID may have multiple + LUNs. For example, a tape device including a tape changer may have LUN 0 for the tape device itself, and LUN 1 for the tape - changer. In this way, the host system can address each of the + changer. In this way, the host system can address each of the functional units of the tape changer as desired. @@ -3841,22 +3841,22 @@ disk wd3 at wdc1 drive 1 Bus layout - SCSI buses are linear. So, not shaped like Y-junctions, + SCSI buses are linear. So, not shaped like Y-junctions, star topologies, rings, cobwebs or whatever else people might - want to invent. One of the most common mistakes is for people + want to invent. One of the most common mistakes is for people with wide-SCSI host adapters to connect devices on all three connecters (external connector, internal wide connector, - internal narrow connector). Don't do that. It may appear to + internal narrow connector). Don't do that. It may appear to work if you are really lucky, but I can almost guarantee that your system will stop functioning at the most unfortunate moment (this is also known as “Murphy's law”). You might notice that the terminator issue discussed - earlier becomes rather hairy if your bus is not linear. Also, + earlier becomes rather hairy if your bus is not linear. Also, if you have more connectors than devices on your internal SCSI cable, make sure you attach devices on connectors on both ends instead of using the connectors in the middle and let one or - both ends dangle. This will screw up the termination of the + both ends dangle. This will screw up the termination of the bus. The electrical characteristics, its noise margins and @@ -3880,76 +3880,76 @@ disk wd3 at wdc1 drive 1 a electrically sound bus. When you want to use a SCSI disk on your PC as boot disk, - you must aware of some quirks related to PC BIOSes. The PC + you must aware of some quirks related to PC BIOSes. The PC BIOS in its first incarnation used a low level physical - interface to the hard disk. So, you had to tell the BIOS + interface to the hard disk. So, you had to tell the BIOS (using a setup tool or a BIOS built-in setup) how your disk - physically looked like. This involved stating number of heads, + physically looked like. This involved stating number of heads, number of cylinders, number of sectors per track, obscure things like precompensation and reduced write current cylinder etc. One might be inclined to think that since SCSI disks are - smart you can forget about this. Alas, the arcane setup issue - is still present today. The system BIOS needs to know how to + smart you can forget about this. Alas, the arcane setup issue + is still present today. The system BIOS needs to know how to access your SCSI disk with the head/cyl/sector method in order to load the FreeBSD kernel during boot. The SCSI host adapter or SCSI controller you have put in your AT/EISA/PCI/whatever bus to connect your disk therefore - has its own on-board BIOS. During system startup, the SCSI + has its own on-board BIOS. During system startup, the SCSI BIOS takes over the hard disk interface routines from the - system BIOS. To fool the system BIOS, the system setup is - normally set to No hard disk present. Obvious, isn't + system BIOS. To fool the system BIOS, the system setup is + normally set to No hard disk present. Obvious, isn't it? The SCSI BIOS itself presents to the system a so called - translated drive. This means + translated drive. This means that a fake drive table is constructed that allows the PC to - boot the drive. This translation is often (but not always) + boot the drive. This translation is often (but not always) done using a pseudo drive with 64 heads and 32 sectors per - track. By varying the number of cylinders, the SCSI BIOS - adapts to the actual drive size. It is useful to note that 32 - * 64 / 2 = the size of your drive in megabytes. The division + track. By varying the number of cylinders, the SCSI BIOS + adapts to the actual drive size. It is useful to note that 32 + * 64 / 2 = the size of your drive in megabytes. The division by 2 is to get from disk blocks that are normally 512 bytes in size to Kbytes. - Right. All is well now?! No, it is not. The system BIOS - has another quirk you might run into. The number of cylinders - of a bootable hard disk cannot be greater than 1024. Using the + Right. All is well now?! No, it is not. The system BIOS + has another quirk you might run into. The number of cylinders + of a bootable hard disk cannot be greater than 1024. Using the translation above, this is a show-stopper for disks greater - than 1 GB. With disk capacities going up all the time this is + than 1 GB. With disk capacities going up all the time this is causing problems. Fortunately, the solution is simple: just use another - translation, e.g. with 128 heads instead of 32. In most cases + translation, e.g. with 128 heads instead of 32. In most cases new SCSI BIOS versions are available to upgrade older SCSI - host adapters. Some newer adapters have an option, in the form + host adapters. Some newer adapters have an option, in the form of a jumper or software setup selection, to switch the translation the SCSI BIOS uses. It is very important that all operating systems on the disk use the same translation to get the - right idea about where to find the relevant partitions. So, + right idea about where to find the relevant partitions. So, when installing FreeBSD you must answer any questions about heads/cylinders etc using the translated values your host adapter uses. Failing to observe the translation issue might lead to un-bootable systems or operating systems overwriting each - others partitions. Using fdisk you should be able to see all + others partitions. Using fdisk you should be able to see all partitions. You might have heard some talk of “lying” devices? Older FreeBSD kernels used to report the geometry of SCSI disks when - booting. An example from one of my systems: + booting. An example from one of my systems: aha0 targ 0 lun 0: <MICROP 1588-15MB1057404HSP4> sd0: 636MB (1303250 total sec), 1632 cyl, 15 head, 53 sec, bytes/sec 512 - Newer kernels usually do not report this information. e.g. + Newer kernels usually do not report this information. e.g. (bt0:0:0): "SEAGATE ST41651 7574" type 0 fixed SCSI 2 @@ -3958,15 +3958,15 @@ sd0(bt0:0:0): Direct-Access 1350MB (2766300 512 byte sectors) Why has this changed? - This info is retrieved from the SCSI disk itself. Newer - disks often use a technique called zone bit recording. The + This info is retrieved from the SCSI disk itself. Newer + disks often use a technique called zone bit recording. The idea is that on the outer cylinders of the drive there is more - space so more sectors per track can be put on them. This + space so more sectors per track can be put on them. This results in disks that have more tracks on outer cylinders than on the inner cylinders and, last but not least, have more - capacity. You can imagine that the value reported by the drive + capacity. You can imagine that the value reported by the drive when inquiring about the geometry now becomes suspect at best, - and nearly always misleading. When asked for a geometry , it + and nearly always misleading. When asked for a geometry , it is nearly always better to supply the geometry used by the BIOS, or if the BIOS is never going to know about this disk, (e.g. it is not a booting disk) to @@ -3977,23 +3977,23 @@ sd0(bt0:0:0): Direct-Access 1350MB (2766300 512 byte sectors) SCSI subsystem design - FreeBSD uses a layered SCSI subsystem. For each different - controller card a device driver is written. This driver knows - all the intimate details about the hardware it controls. The + FreeBSD uses a layered SCSI subsystem. For each different + controller card a device driver is written. This driver knows + all the intimate details about the hardware it controls. The driver has a interface to the upper layers of the SCSI subsystem through which it receives its commands and reports back any status. On top of the card drivers there are a number of more - generic drivers for a class of devices. More specific: a + generic drivers for a class of devices. More specific: a driver for tape devices (abbreviation: st), magnetic disks - (sd), CD-ROMs (cd) etc. In case you are wondering where you + (sd), CD-ROMs (cd) etc. In case you are wondering where you can find this stuff, it all lives in - /sys/scsi. See the man pages in section 4 + /sys/scsi. See the man pages in section 4 for more details. The multi level design allows a decoupling of low-level - bit banging and more high level stuff. Adding support for + bit banging and more high level stuff. Adding support for another piece of hardware is a much more manageable problem. @@ -4004,19 +4004,19 @@ sd0(bt0:0:0): Direct-Access 1350MB (2766300 512 byte sectors) Dependent on your hardware, the kernel configuration file must contain one or more lines describing your host - adapter(s). This includes I/O addresses, interrupts etc. + adapter(s). This includes I/O addresses, interrupts etc. Consult the man page for your adapter driver to get more info. Apart from that, check out /sys/i386/conf/LINT for an overview of a - kernel config file. LINT contains every - possible option you can dream of. It does + kernel config file. LINT contains every + possible option you can dream of. It does not imply LINT will actually get you to a working kernel at all. Although it is probably stating the obvious: the kernel - config file should reflect your actual hardware setup. So, + config file should reflect your actual hardware setup. So, interrupts, I/O addresses etc must match the kernel config - file. During system boot messages will be displayed to + file. During system boot messages will be displayed to indicate whether the configured hardware was actually found. @@ -4074,7 +4074,7 @@ device cd0 at scbus? [the first ever CD-ROM found, no wiring] The example above tells the kernel to look for a ahc (Adaptec 274x) controller, then for an NCR/Symbios board, and - so on. The lines following the controller specifications tell + so on. The lines following the controller specifications tell the kernel to configure specific devices but only attach them when they match the target ID and LUN specified on the corresponding bus. @@ -4082,37 +4082,37 @@ device cd0 at scbus? [the first ever CD-ROM found, no wiring] Wired down devices get “first shot” at the unit numbers so the first non “wired down” device, is allocated the unit number one greater than the highest “wired down” unit number - for that kind of device. So, if you had a SCSI tape at target + for that kind of device. So, if you had a SCSI tape at target ID 2 it would be configured as st2, as the tape at target ID 6 is wired down to unit number 1. Wired down devices need not be found to get their unit - number. The unit number for a wired down device is reserved - for that device, even if it is turned off at boot time. This + number. The unit number for a wired down device is reserved + for that device, even if it is turned off at boot time. This allows the device to be turned on and brought on-line at a - later time, without rebooting. Notice that a device's unit + later time, without rebooting. Notice that a device's unit number has no relationship with its target ID on the SCSI bus. Below is another example of a kernel config file as used - by FreeBSD version < 2.0.5. The difference with the first - example is that devices are not “wired down”. “Wired down” + by FreeBSD version < 2.0.5. The difference with the first + example is that devices are not “wired down”. “Wired down” means that you specify which SCSI target belongs to which device. A kernel built to the config file below will attach the first SCSI disk it finds to sd0, the second disk to sd1 etc. If you ever removed or added a disk, all other devices of the - same type (disk in this case) would 'move around'. This + same type (disk in this case) would 'move around'. This implies you have to change /etc/fstab each time. Although the old style still works, you are strongly recommended to use this new - feature. It will save you a lot of grief whenever you shift - your hardware around on the SCSI buses. So, when you re-use + feature. It will save you a lot of grief whenever you shift + your hardware around on the SCSI buses. So, when you re-use your old trusty config file after upgrading from a pre-FreeBSD2.0.5.R system check this out. @@ -4134,15 +4134,15 @@ device st0 [support for 2 SCSI tapes] [for the CD-ROM] device cd0 #Only need one of these, the code dynamically grows - Both examples support SCSI disks. If during boot more + Both examples support SCSI disks. If during boot more devices of a specific type (e.g. sd disks) are found than are configured in the booting kernel, the system will simply allocate more devices, incrementing the unit number starting - at the last number “wired down”. If there are no “wired down” + at the last number “wired down”. If there are no “wired down” devices then counting starts at unit 0. Use man 4 scsi to check for - the latest info on the SCSI subsystem. For more detailed info + the latest info on the SCSI subsystem. For more detailed info on host adapter drivers use eg man 4 ahc for info on the Adaptec 294x driver. @@ -4153,24 +4153,24 @@ device cd0 #Only need one of these, the code dynamically growsExperience has shown that some devices are slow to respond to INQUIRY commands after a SCSI bus reset (which happens at - boot time). An INQUIRY command is sent by the kernel on boot + boot time). An INQUIRY command is sent by the kernel on boot to see what kind of device (disk, tape, CD-ROM etc) is - connected to a specific target ID. This process is called + connected to a specific target ID. This process is called device probing by the way. To work around the 'slow response' problem, FreeBSD allows a tunable delay time before the SCSI devices are probed - following a SCSI bus reset. You can set this delay time in + following a SCSI bus reset. You can set this delay time in your kernel configuration file using a line like: options SCSI_DELAY=15 #Be pessimistic about Joe SCSI device - This line sets the delay time to 15 seconds. On my own + This line sets the delay time to 15 seconds. On my own system I had to use 3 seconds minimum to get my trusty old - CD-ROM drive to be recognized. Start with a high value (say 30 + CD-ROM drive to be recognized. Start with a high value (say 30 seconds or so) when you have problems with device - recognition. If this helps, tune it back until it just stays + recognition. If this helps, tune it back until it just stays working. @@ -4180,13 +4180,13 @@ options SCSI_DELAY=15 #Be pessimistic about Joe SCSI deviceAlthough the SCSI standard tries to be complete and concise, it is a complex standard and implementing things - correctly is no easy task. Some vendors do a better job then + correctly is no easy task. Some vendors do a better job then others. This is exactly where the “rogue” devices come into view. Rogues are devices that are recognized by the FreeBSD kernel - as behaving slightly (...) non-standard. Rogue devices are - reported by the kernel when booting. An example for two of my + as behaving slightly (...) non-standard. Rogue devices are + reported by the kernel when booting. An example for two of my cartridge tape units: @@ -4199,14 +4199,14 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue For instance, there are devices that respond to all LUNs on a certain target ID, even if they are actually only one - device. It is easy to see that the kernel might be fooled into + device. It is easy to see that the kernel might be fooled into believing that there are 8 LUNs at that particular target ID. The confusion this causes is left as an exercise to the reader. The SCSI subsystem of FreeBSD recognizes devices with bad habits by looking at the INQUIRY response they send when - probed. Because the INQUIRY response also includes the version + probed. Because the INQUIRY response also includes the version number of the device firmware, it is even possible that for different firmware versions different workarounds are used. See e.g. /sys/scsi/st.c and @@ -4214,14 +4214,14 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue this is done. This scheme works fine, but keep in mind that it of course - only works for devices that are known to be weird. If you are + only works for devices that are known to be weird. If you are the first to connect your bogus Mumbletech SCSI CD-ROM you might be the one that has to define which workaround is needed. After you got your Mumbletech working, please send the required workaround to the FreeBSD development team for - inclusion in the next release of FreeBSD. Other Mumbletech + inclusion in the next release of FreeBSD. Other Mumbletech owners will be grateful to you. @@ -4230,14 +4230,14 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue Multiple LUN devices In some cases you come across devices that use multiple - logical units (LUNs) on a single SCSI ID. In most cases - FreeBSD only probes devices for LUN 0. An example are so + logical units (LUNs) on a single SCSI ID. In most cases + FreeBSD only probes devices for LUN 0. An example are so called bridge boards that connect 2 non-SCSI harddisks to a SCSI bus (e.g. an Emulex MD21 found in old Sun systems). This means that any devices with LUNs != 0 are not - normally found during device probe on system boot. To work + normally found during device probe on system boot. To work around this problem you must add an appropriate entry in /sys/scsi/scsiconf.c and rebuild your kernel. @@ -4260,7 +4260,7 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue } The kernel on boot scans the inquiry data it receives - against the table and acts accordingly. See the source for + against the table and acts accordingly. See the source for more info. @@ -4272,9 +4272,9 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue support what is called tagged command queuing (TCQ). In a nutshell, TCQ allows the device to have multiple I/O - requests outstanding at the same time. Because the device is + requests outstanding at the same time. Because the device is intelligent, it can optimise its operations (like head - positioning) based on its own request queue. On SCSI devices + positioning) based on its own request queue. On SCSI devices like RAID (Redundant Array of Independent Disks) arrays the TCQ function is indispensable to take advantage of the device's inherent parallelism. @@ -4286,8 +4286,8 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue It should be noted however that TCQ requires device driver support and that some devices implemented it “not quite right” - in their firmware. This problem bit me once, and it leads to - highly mysterious problems. In such cases, try to disable + in their firmware. This problem bit me once, and it leads to + highly mysterious problems. In such cases, try to disable TCQ. @@ -4296,18 +4296,18 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue Busmaster host adapters Most, but not all, SCSI host adapters are bus mastering - controllers. This means that they can do I/O on their own + controllers. This means that they can do I/O on their own without putting load onto the host CPU for data movement. This is of course an advantage for a multitasking - operating system like FreeBSD. It must be noted however that + operating system like FreeBSD. It must be noted however that there might be some rough edges. For instance an Adaptec 1542 controller can be set to use different transfer speeds on the host bus (ISA or AT in this - case). The controller is settable to different rates because - not all motherboards can handle the higher speeds. Problems + case). The controller is settable to different rates because + not all motherboards can handle the higher speeds. Problems like hangups, bad data etc might be the result of using a higher data transfer rate then your motherboard can stomach. @@ -4318,12 +4318,12 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue In the case of a Adaptec 1542, there is an option that can be put into the kernel config file to allow dynamic determination of the right, read: fastest feasible, transfer - rate. This option is disabled by default: + rate. This option is disabled by default: options "TUNE_1542" #dynamic tune of bus DMA speed - Check the man pages for the host adapter that you use. Or + Check the man pages for the host adapter that you use. Or better still, use the ultimate documentation (read: driver source). @@ -4334,7 +4334,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speedTracking down problems The following list is an attempt to give a guideline for the - most common SCSI problems and their solutions. It is by no means + most common SCSI problems and their solutions. It is by no means complete. @@ -4382,16 +4382,16 @@ options "TUNE_1542" #dynamic tune of bus DMA speed If you can compile a kernel, make one with the SCSIDEBUG option, and try accessing the device with - debugging turned on for that device. If your device does + debugging turned on for that device. If your device does not even probe at startup, you may have to define the address of the device that is failing, and the desired debug level in /sys/scsi/scsidebug.h. If it probes but just does not work, you can use the scsi8 command to dynamically set a debug level to it in a running kernel (if SCSIDEBUG is - defined). This will give you copious debugging output with - which to confuse the gurus. see man 4 - scsi for more exact information. Also look at + defined). This will give you copious debugging output with + which to confuse the gurus. See man 4 + scsi for more exact information. Also look at man 8 scsi. @@ -4474,7 +4474,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speed “SCSI: Understanding the Small Computer System - Interface”, written by NCR Corporation. Available from: + Interface”, written by NCR Corporation. Available from: Prentice Hall, Englewood Cliffs, NJ, 07632 Phone: (201) 767-5937 ISBN 0-13-796855-8 @@ -4488,13 +4488,13 @@ options "TUNE_1542" #dynamic tune of bus DMA speed “SCSI Interconnection Guide Book”, an AMP publication (dated 4/93, Catalog 65237) that lists the various SCSI - connectors and suggests cabling schemes. Available from + connectors and suggests cabling schemes. Available from AMP at (800) 522-6752 or (717) 564-0100 “Fast Track to SCSI”, A Product Guide written by - Fujitsu. Available from: Prentice Hall, Englewood Cliffs, + Fujitsu. Available from: Prentice Hall, Englewood Cliffs, NJ, 07632 Phone: (201) 767-5937 ISBN 0-13-307000-X @@ -4517,11 +4517,11 @@ options "TUNE_1542" #dynamic tune of bus DMA speedOn Usenet the newsgroups comp.periphs.scsi and comp.periphs are - noteworthy places to look for more info. You can also find the + noteworthy places to look for more info. You can also find the SCSI-Faq there, which is posted periodically. Most major SCSI device and host adapter suppliers operate - ftp sites and/or BBS systems. They may be valuable sources of + ftp sites and/or BBS systems. They may be valuable sources of information about the devices you own. @@ -4563,11 +4563,11 @@ options "TUNE_1542" #dynamic tune of bus DMA speedAs mentioned in the SCSI section, virtually all SCSI hard drives sold today are SCSI-2 compliant and thus will work fine as long as you connect them to - a supported SCSI host adapter. Most problems people encounter + a supported SCSI host adapter. Most problems people encounter are either due to badly designed cabling (cable too long, star topology, etc.), insufficient termination, or defective parts. Please refer to the SCSI - section first if your SCSI hard drive is not working. However, + section first if your SCSI hard drive is not working. However, there are a couple of things you may want to take into account before you purchase SCSI hard drives for your system. @@ -4576,62 +4576,62 @@ options "TUNE_1542" #dynamic tune of bus DMA speedRotational speed Rotational speeds of SCSI drives sold today range from - around 4,500RPM to 10,000RPM. Most of them are either 5,400RPM - or 7,200RPM. Even though the 7,200RPM drives can generally + around 4,500RPM to 10,000RPM. Most of them are either 5,400RPM + or 7,200RPM. Even though the 7,200RPM drives can generally transfer data faster, they run considerably hotter than their - 5,400RPM counterparts. A large fraction of today's disk drive - malfunctions are heat-related. If you do not have very good + 5,400RPM counterparts. A large fraction of today's disk drive + malfunctions are heat-related. If you do not have very good cooling in your PC case, you may want to stick with 5,400RPM or slower drives. Note that newer drives, with higher areal recording densities, can deliver much more bits per rotation than older - ones. Today's top-of-line 5,400RPM drives can sustain a + ones. Today's top-of-line 5,400RPM drives can sustain a throughput comparable to 7,200RPM drives of one or two model - generations ago. The number to find on the spec sheet for - bandwidth is “internal data (or transfer) rate”. It is + generations ago. The number to find on the spec sheet for + bandwidth is “internal data (or transfer) rate”. It is usually in megabits/sec so divide it by 8 and you'll get the rough approximation of how much megabytes/sec you can get out of the drive. (If you are a speed maniac and want a 10,000RPM drive for your cute little peecee, be my guest; however, those drives - become extremely hot. Don't even think about it if you don't + become extremely hot. Don't even think about it if you don't have a fan blowing air directly at the drive or a properly ventilated disk enclosure.) Obviously, the latest 10,000RPM drives and 7,200RPM drives can deliver more data than the latest 5,400RPM drives, so if absolute bandwidth is the necessity for your applications, you - have little choice but to get the faster drives. Also, if you + have little choice but to get the faster drives. Also, if you need low latency, faster drives are better; not only do they usually have lower average seek times, but also the rotational delay is one place where slow-spinning drives can never beat a - faster one. (The average rotational latency is half the time + faster one. (The average rotational latency is half the time it takes to rotate the drive once; thus, it's 3 milliseconds for 10,000RPM drives, 4.2ms for 7,200RPM drives and 5.6ms for 5,400RPM drives.) Latency is seek time plus rotational delay. Make sure you understand whether you need low latency or more accesses per second, though; in the latter case (e.g., news servers), it may not be optimal to purchase one big fast - drive. You can achieve similar or even better results by + drive. You can achieve similar or even better results by using the ccd (concatenated disk) driver to create a striped disk array out of multiple slower drives for comparable overall cost. Make sure you have adequate air flow around the drive, - especially if you are going to use a fast-spinning drive. You + especially if you are going to use a fast-spinning drive. You generally need at least 1/2" (1.25cm) of spacing above and - below a drive. Understand how the air flows through your PC - case. Most cases have the power supply suck the air out of - the back. See where the air flows in, and put the drive where + below a drive. Understand how the air flows through your PC + case. Most cases have the power supply suck the air out of + the back. See where the air flows in, and put the drive where it will have the largest volume of cool air flowing around it. You may need to seal some unwanted holes or add a new fan for effective cooling. - Another consideration is noise. Many 7,200 or faster + Another consideration is noise. Many 7,200 or faster drives generate a high-pitched whine which is quite unpleasant - to most people. That, plus the extra fans often required for + to most people. That, plus the extra fans often required for cooling, may make 7,200 or faster drives unsuitable for some office and home environments. @@ -4640,11 +4640,11 @@ options "TUNE_1542" #dynamic tune of bus DMA speed Form factor - Most SCSI drives sold today are of 3.5" form factor. They + Most SCSI drives sold today are of 3.5" form factor. They come in two different heights; 1.6" (“half-height”) or 1" - (“low-profile”). The half-height drive is the same height as a - CD-ROM drive. However, don't forget the spacing rule - mentioned in the previous section. If you have three standard + (“low-profile”). The half-height drive is the same height as a + CD-ROM drive. However, don't forget the spacing rule + mentioned in the previous section. If you have three standard 3.5" drive bays, you will not be able to put three half-height drives in there (without frying them, that is). @@ -4654,32 +4654,32 @@ options "TUNE_1542" #dynamic tune of bus DMA speedInterface The majority of SCSI hard drives sold today are Ultra or - Ultra-wide SCSI. The maximum bandwidth of Ultra SCSI is - 20MB/sec, and Ultra-wide SCSI is 40MB/sec. There is no + Ultra-wide SCSI. The maximum bandwidth of Ultra SCSI is + 20MB/sec, and Ultra-wide SCSI is 40MB/sec. There is no difference in max cable length between Ultra and Ultra-wide; however, the more devices you have on the same bus, the sooner - you will start having bus integrity problems. Unless you have + you will start having bus integrity problems. Unless you have a well-designed disk enclosure, it is not easy to make more than 5 or 6 Ultra SCSI drives work on a single bus. On the other hand, if you need to connect many drives, - going for Fast-wide SCSI may not be a bad idea. That will + going for Fast-wide SCSI may not be a bad idea. That will have the same max bandwidth as Ultra (narrow) SCSI, while - electronically it's much easier to get it “right”. My advice + electronically it's much easier to get it “right”. My advice would be: if you want to connect many disks, get wide SCSI drives; they usually cost a little more but it may save you - down the road. (Besides, if you can't afford the cost + down the road. (Besides, if you can't afford the cost difference, you shouldn't be building a disk array.) There are two variant of wide SCSI drives; 68-pin and - 80-pin SCA (Single Connector Attach). The SCA drives don't + 80-pin SCA (Single Connector Attach). The SCA drives don't have a separate 4-pin power connector, and also read the SCSI - ID settings through the 80-pin connector. If you are really + ID settings through the 80-pin connector. If you are really serious about building a large storage system, get SCA drives and a good SCA enclosure (dual power supply with at least one - extra fan). They are more electronically sound than 68-pin + extra fan). They are more electronically sound than 68-pin counterparts because there is no “stub” of the SCSI bus inside - the disk canister as in arrays built from 68-pin drives. They + the disk canister as in arrays built from 68-pin drives. They are easier to install too (you just need to screw the drive in the canister, instead of trying to squeeze in your fingers in a tight place to hook up all the little cables (like the SCSI @@ -4706,9 +4706,9 @@ options "TUNE_1542" #dynamic tune of bus DMA speedGeneral tape access commands mt1 provides generic access to the tape - drives. Some of the more common commands are + drives. Some of the more common commands are rewind, erase, and - status. See the mt1 + status. See the mt1 manual page for a detailed description. @@ -4717,9 +4717,9 @@ options "TUNE_1542" #dynamic tune of bus DMA speedController Interfaces There are several different interfaces that support tape - drives. The interfaces are SCSI, IDE, Floppy and Parallel Port. + drives. The interfaces are SCSI, IDE, Floppy and Parallel Port. A wide variety of tape drives are available for these - interfaces. Controllers are discussed in + interfaces. Controllers are discussed in Disk/tape controllers. @@ -4732,13 +4732,13 @@ options "TUNE_1542" #dynamic tune of bus DMA speedst4 manual page for a detailed description. The drives listed below are currently being used by members - of the FreeBSD community. They are not the only drives that - will work with FreeBSD. They just happen to be the ones that we + of the FreeBSD community. They are not the only drives that + will work with FreeBSD. They just happen to be the ones that we use. @@ -4871,19 +4871,19 @@ options "TUNE_1542" #dynamic tune of bus DMA speedThis is a QIC tape drive. - Native capacity is 1.35GB when using QIC-1350 tapes. This + Native capacity is 1.35GB when using QIC-1350 tapes. This drive will read and write QIC-150 (DC6150), QIC-250 (DC6250), and QIC-525 (DC6525) tapes as well. Data transfer rate is 350kB/s using - dump8. Rates of 530kB/s have been + dump8. Rates of 530kB/s have been reported when using Amanda Production of this drive has been discontinued. The SCSI bus connector on this tape drive is reversed from - that on most other SCSI devices. Make sure that you have + that on most other SCSI devices. Make sure that you have enough SCSI cable to twist the cable one-half turn before and after the Archive Anaconda tape drive, or turn your other SCSI devices upside-down. @@ -4892,7 +4892,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speed If you have a SCSI-2 controller, short jumper 6. - Otherwise, the drive behaves are a SCSI-1 device. When + Otherwise, the drive behaves are a SCSI-1 device. When operating as a SCSI-1 device, this drive, “locks” the SCSI bus during some tape operations, including: fsf, rewind, and rewoffl. @@ -4964,16 +4964,16 @@ options "TUNE_1542" #dynamic tune of bus DMA speedThe boot message identifier for this drive is ARCHIVE VIPER 150 21531 -004 Archive Viper 150 is a known rogue - type 1 removable SCSI 1. A multitude of firmware revisions - exist for this drive. Your drive may report different numbers + type 1 removable SCSI 1. A multitude of firmware revisions + exist for this drive. Your drive may report different numbers (e.g 21247 -005. This is a QIC tape drive. - Native capacity is 150/250MB. Both 150MB (DC6150) and - 250MB (DC6250) tapes have the recording format. The 250MB - tapes are approximately 67% longer than the 150MB tapes. This - drive can read 120MB tapes as well. It can not write 120MB + Native capacity is 150/250MB. Both 150MB (DC6150) and + 250MB (DC6250) tapes have the recording format. The 250MB + tapes are approximately 67% longer than the 150MB tapes. This + drive can read 120MB tapes as well. It can not write 120MB tapes. Data transfer rate is 100kB/s @@ -4985,8 +4985,8 @@ options "TUNE_1542" #dynamic tune of bus DMA speedst4). Under FreeBSD 2.2-current, use mt - blocksize 512 to set the blocksize. (The - particular drive had firmware revision 21247 -005. Other + blocksize 512 to set the blocksize. (The + particular drive had firmware revision 21247 -005. Other firmware revisions may behave differently) Previous versions of FreeBSD did not have this problem. @@ -5013,7 +5013,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speedData transfer rate is 180kB/s at 90 inches/sec. The drive reads QIC-525, QIC-150, QIC-120 and QIC-24 - tapes. Writes QIC-525, QIC-150, and QIC-120. + tapes. Writes QIC-525, QIC-150, and QIC-120. Firmware revisions prior to 25462 -011 are bug ridden and will not function properly. @@ -5075,7 +5075,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speedData transfer rate is 1.2MB/s. - This drive is identical to the Quantum DLT2000. The drive + This drive is identical to the Quantum DLT2000. The drive firmware can be set to emulate several well-known drives, including an Exabyte 8mm drive. @@ -5102,9 +5102,9 @@ options "TUNE_1542" #dynamic tune of bus DMA speed WARNING: This drive does not meet the SCSI-2 - specifications. The drive locks up completely in response to + specifications. The drive locks up completely in response to a SCSI MODE_SELECT command unless there is a formatted tape in - the drive. Before using this drive, set the tape blocksize + the drive. Before using this drive, set the tape blocksize with @@ -5112,7 +5112,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speedBefore using a minicartridge for the first time, the - minicartridge must be formated. FreeBSD 2.1.0-RELEASE and + minicartridge must be formated. FreeBSD 2.1.0-RELEASE and earlier: @@ -5146,12 +5146,12 @@ options "TUNE_1542" #dynamic tune of bus DMA speedData transfer rate is 270kB/s. This drive is fairly slow in responding to the SCSI bus - during boot. A custom kernel may be required (set SCSI_DELAY + during boot. A custom kernel may be required (set SCSI_DELAY to 10 seconds). There are a large number of firmware configurations for this drive, some have been customized to a particular vendor's - hardware. The firmware can be changed via EPROM + hardware. The firmware can be changed via EPROM replacement. Production of this drive has been discontinued. @@ -5203,11 +5203,11 @@ options "TUNE_1542" #dynamic tune of bus DMA speedThe boot message identifier for this drive is HP C1533A 9503 type 1 removable SCSI 2. - This is a DDS-2 tape drive. DDS-2 means hardware data + This is a DDS-2 tape drive. DDS-2 means hardware data compression and narrower tracks for increased data capacity. - Native capacity is 4GB when using 120m tapes. This drive + Native capacity is 4GB when using 120m tapes. This drive supports hardware data compression. Data transfer rate is 510kB/s. @@ -5215,7 +5215,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speedThis drive is used in Hewlett-Packard's SureStore 6000eU and 6000i tape drives and C1533A DDS-2 DAT drive. - The drive has a block of 8 dip switches. The proper + The drive has a block of 8 dip switches. The proper settings for FreeBSD are: 1 ON; 2 ON; 3 OFF; 4 ON; 5 ON; 6 ON; 7 ON; 8 ON. @@ -5261,11 +5261,11 @@ options "TUNE_1542" #dynamic tune of bus DMA speed - Switch 3 controls MRS (Media Recognition System). MRS - tapes have stripes on the transparent leader. These identify - the tape as DDS (Digital Data Storage) grade media. Tapes + Switch 3 controls MRS (Media Recognition System). MRS + tapes have stripes on the transparent leader. These identify + the tape as DDS (Digital Data Storage) grade media. Tapes that do not have the stripes will be treated as - write-protected. Switch 3 OFF enables MRS. Switch 3 ON + write-protected. Switch 3 OFF enables MRS. Switch 3 ON disables MRS. See HP @@ -5273,8 +5273,8 @@ options "TUNE_1542" #dynamic tune of bus DMA speedHewlett-Packard Disk and Tape Technical Information for more information on configuring this drive. Warning: Quality control on these - drives varies greatly. One FreeBSD core-team member has - returned 2 of these drives. Neither lasted more than 5 + drives varies greatly. One FreeBSD core-team member has + returned 2 of these drives. Neither lasted more than 5 months. Reported by: &a.se; @@ -5288,7 +5288,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speed type 1 removable SCSI 2 Sequential-Access density code 0x13, variable blocks. - This is a DDS-1 tape drive. DDS-1 is the original DAT + This is a DDS-1 tape drive. DDS-1 is the original DAT tape format. Native capacity is 2GB when using 90m tapes. @@ -5302,12 +5302,12 @@ options "TUNE_1542" #dynamic tune of bus DMA speed The HP C1534A DDS format DAT drive has two indicator - lights, one green and one amber. The green one indicates tape + lights, one green and one amber. The green one indicates tape action: slow flash during load, steady when loaded, fast flash - during read/write operations. The amber one indicates + during read/write operations. The amber one indicates warnings: slow flash when cleaning is required or tape is nearing the end of its useful life, steady indicates an hard - fault. (factory service required?) + fault. (factory service required?) Reported by Gary Crutcher gcrutchr@nightflight.com @@ -5318,11 +5318,11 @@ options "TUNE_1542" #dynamic tune of bus DMA speedThe boot message identifier for this drive is "". - This is a DDS-2 tape drive with a tape changer. DDS-2 + This is a DDS-2 tape drive with a tape changer. DDS-2 means hardware data compression and narrower tracks for increased data capacity. - Native capacity is 24GB when using 120m tapes. This drive + Native capacity is 24GB when using 120m tapes. This drive supports hardware data compression. Data transfer rate is 510kB/s (native). @@ -5331,15 +5331,15 @@ options "TUNE_1542" #dynamic tune of bus DMA speed12000e tape drive. - The drive has two selectors on the rear panel. The - selector closer to the fan is SCSI id. The other selector + The drive has two selectors on the rear panel. The + selector closer to the fan is SCSI id. The other selector should be set to 7. - There are four internal switches. These should be set: 1 + There are four internal switches. These should be set: 1 ON; 2 ON; 3 ON; 4 OFF. At present the kernel drivers do not automatically change - tapes at the end of a volume. This shell script can be used + tapes at the end of a volume. This shell script can be used to change tapes: @@ -5389,7 +5389,7 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" -A C620 type 1 removable SCSI 2 Sequential-Access density code 0x13 - This is a DDS-1 tape drive. DDS-1 is the original DAT + This is a DDS-1 tape drive. DDS-1 is the original DAT tape format. Native capacity is 1.2GB. @@ -5407,7 +5407,7 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" The boot message identifier for this drive is HP HP35470A 9 09 type 1 removable SCSI 2 - This is a DDS-1 tape drive. DDS-1 is the original DAT + This is a DDS-1 tape drive. DDS-1 is the original DAT tape format. Native capacity is 2GB when using 90m tapes. @@ -5421,8 +5421,8 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" DAT drive, and HP C1536A DDS format DAT drive. Warning: Quality control on these - drives varies greatly. One FreeBSD core-team member has - returned 5 of these drives. None lasted more than 9 + drives varies greatly. One FreeBSD core-team member has + returned 5 of these drives. None lasted more than 9 months. Reported by: David Dawes dawes@rf900.physics.usyd.edu.au @@ -5437,13 +5437,13 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" 1009 type 1 removable SCSI 2 Sequential-Access density code 0x13. - This is a DDS-DC tape drive. DDS-DC is DDS-1 with - hardware data compression. DDS-1 is the original DAT tape + This is a DDS-DC tape drive. DDS-DC is DDS-1 with + hardware data compression. DDS-1 is the original DAT tape format. - Native capacity is 2GB when using 90m tapes. It cannot - handle 120m tapes. This drive supports hardware data - compression. Please refer to the section on Native capacity is 2GB when using 90m tapes. It cannot + handle 120m tapes. This drive supports hardware data + compression. Please refer to the section on HP C1533A for the proper switch settings. @@ -5460,10 +5460,10 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" Pressing the front panel button will eject the tape and bring the tape drive back to life. - WARNING: HP 35480-03110 only. On at least two occasions + WARNING: HP 35480-03110 only. On at least two occasions this tape drive when used with FreeBSD 2.1.0, an IBM Server 320 and an 2940W SCSI controller resulted in all SCSI disk - partitions being lost. The problem has not be analyzed or + partitions being lost. The problem has not be analyzed or resolved at this time. @@ -5473,21 +5473,21 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" URL="http://www.sel.sony.com/SEL/ccpg/storage/tape/t5000.html">Sony SDT-5000 There are at least two significantly different models: one - is a DDS-1 and the other DDS-2. The DDS-1 version is - SDT-5000 3.02. The DDS-2 version is SONY SDT-5000 327M. - The DDS-2 version has a 1MB cache. This cache is able to keep + is a DDS-1 and the other DDS-2. The DDS-1 version is + SDT-5000 3.02. The DDS-2 version is SONY SDT-5000 327M. + The DDS-2 version has a 1MB cache. This cache is able to keep the tape streaming in almost any circumstances. The boot message identifier for this drive is SONY SDT-5000 3.02 type 1 removable SCSI 2 Sequential-Access density code 0x13 - Native capacity is 4GB when using 120m tapes. This drive + Native capacity is 4GB when using 120m tapes. This drive supports hardware data compression. Data transfer rate is depends upon the model or the drive. The rate is 630kB/s for the SONY SDT-5000 327M while - compressing the data. For the SONY SDT-5000 3.02, the data + compressing the data. For the SONY SDT-5000 3.02, the data transfer rate is 225kB/s. In order to get this drive to stream, set the blocksize to @@ -5513,13 +5513,13 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" Native capacity is 150/250MB. This drive has quirks which are known and work around code - is present in the scsi tape device driver (st4). Upgrading the firmware to XXX + is present in the scsi tape device driver (st4). Upgrading the firmware to XXX version will fix the quirks and provide SCSI 2 capabilities. Data transfer rate is 80kB/s. - IBM and Emerald units will not work. Replacing the + IBM and Emerald units will not work. Replacing the firmware EPROM of these units will solve the problem. Reported by: Michael Smith @@ -5546,14 +5546,14 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" This is a QIC tape drive. - Native capacity is 2.5GB. The drive will read all + Native capacity is 2.5GB. The drive will read all cartridges from the 60 MB (DC600A) upwards, and write 150 MB - (DC6150) upwards. Hardware compression is optionally + (DC6150) upwards. Hardware compression is optionally supported for the 2.5 GB cartridges. This drives quirks are known and pre-compiled into the scsi tape device driver (st4) - beginning with FreeBSD 2.2-current. For previous versions of + beginning with FreeBSD 2.2-current. For previous versions of FreeBSD, use mt to read one block from the tape, rewind the tape, and then execute the backup program (mt fsr 1; mt rewind; dump @@ -5580,9 +5580,9 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" Data transfer rate is 180kB/s. - The drive reads 60, 120, 150, and 525MB tapes. The drive - will not write 60MB (DC600 cartridge) tapes. In order to - overwrite 120 and 150 tapes reliably, first erase (mt erase) the tape. 120 and 150 tapes + The drive reads 60, 120, 150, and 525MB tapes. The drive + will not write 60MB (DC600 cartridge) tapes. In order to + overwrite 120 and 150 tapes reliably, first erase (mt erase) the tape. 120 and 150 tapes used a wider track (fewer tracks per tape) than 525MB tapes. The “extra” width of the previous tracks is not overwritten, as a result the new data lies in a band surrounded on both @@ -5635,9 +5635,9 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" Jordan's Picks Generally speaking those in The FreeBSD Project prefer SCSI CDROM drives over IDE CDROM - drives. However not all SCSI CDROM drives are equal. Some feel + drives. However not all SCSI CDROM drives are equal. Some feel the quality of some SCSI CDROM drives have been deteriorating to - that of IDE CDROM drives. Toshiba used to be the favored + that of IDE CDROM drives. Toshiba used to be the favored stand-by, but many on the SCSI mailing list have found displeasure with the 12x speed XM-5701TA as its volume (when playing audio CDROMs) is not controllable by the various audio player @@ -5648,7 +5648,7 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" SCSI specification. Many SCSI CDROMs will respond to multiple LUNs for its - target address. Known violators include the 6x Teac CD-56S + target address. Known violators include the 6x Teac CD-56S 1.0D. diff --git a/en/handbook/install/chapter.sgml b/en/handbook/install/chapter.sgml index e26e9dcf6e..1541acfb01 100644 --- a/en/handbook/install/chapter.sgml +++ b/en/handbook/install/chapter.sgml @@ -2,18 +2,18 @@ Installing FreeBSD So, you would like to try out FreeBSD on your system? This section - is a quick-start guide for what you need to do. FreeBSD can be + is a quick-start guide for what you need to do. FreeBSD can be installed from a variety of media including CD-ROM, floppy disk, magnetic tape, an MS-DOS partition and, if you have a network connection, via anonymous ftp or NFS. Regardless of the installation media you choose, you can get started by creating the installation - disks as described below. Booting your computer into the + disks as described below. Booting your computer into the FreeBSD installer, even if you aren't planning on installing FreeBSD right away, will provide important information about compatibility between FreeBSD and your hardware which may, in turn, dictate which - installation options are even possible. It can also provide early + installation options are even possible. It can also provide early clues to any compatibility problems which could prevent FreeBSD running on your system at all. @@ -35,9 +35,9 @@ Review the supported configurations section of this installation guide to be sure - that your hardware is supported by FreeBSD. It may be helpful + that your hardware is supported by FreeBSD. It may be helpful to make a list of any special cards you have installed, such as - SCSI controllers, Ethernet adapters or sound cards. This list + SCSI controllers, Ethernet adapters or sound cards. This list should include relevant configuration parameters such as interrupts (IRQ) and IO port addresses. @@ -58,7 +58,7 @@ If you're running DOS and have the proper drivers to access your CD, run the install.bat script provided on the - CD. This will attempt to boot into the FreeBSD + CD. This will attempt to boot into the FreeBSD installation straight from DOS. @@ -130,16 +130,16 @@ With the kern.flp in the A: drive, reboot your - computer. The next request you should get is for the + computer. The next request you should get is for the mfsroot.flp floppy, after which the installation will proceed normally. If you do not type anything at the boot prompt which appears during this process, FreeBSD will automatically boot with its default - configuration after a delay of about five seconds. As FreeBSD + configuration after a delay of about five seconds. As FreeBSD boots, it probes your computer to determine what hardware is - installed. The results of this probing is displayed on the + installed. The results of this probing is displayed on the screen. @@ -153,7 +153,7 @@ If something goes wrong… Due to limitations of the PC architecture, it is impossible for - probing to be 100 percent reliable. In the event that your hardware + probing to be 100 percent reliable. In the event that your hardware is incorrectly identified, or that the probing causes your computer to lock up, first check the supported configurations @@ -163,24 +163,24 @@ If your hardware is supported, reset the computer and when the visual kernel configuration choice is presented, take it. This puts FreeBSD into a configuration mode - where you can supply hints about your hardware. The FreeBSD kernel on + where you can supply hints about your hardware. The FreeBSD kernel on the installation disk is configured assuming that most hardware devices are in their factory default configuration in terms of IRQs, - IO addresses and DMA channels. If your hardware has been + IO addresses and DMA channels. If your hardware has been reconfigured, you will most likely need to use the configuration editor to tell FreeBSD where things are. It is also possible that a probe for a device not present will - cause a later probe for another device that is present to fail. In + cause a later probe for another device that is present to fail. In that case, the probes for the conflicting driver(s) should be disabled. Do not disable any device you will need during installation, such - as your screen (sc0). If the installation + as your screen (sc0). If the installation wedges or fails mysteriously after leaving the configuration editor, you have probably removed or changed something that you should not - have. Simply reboot and try again. + have. Simply reboot and try again. In the configuration mode, you can: @@ -211,8 +211,8 @@ After FreeBSD has been installed, changes made in the configuration mode will be permanent so you do not have to reconfigure - every time you boot. Even so, it is likely that you will want to - build a custom kernel to optimize the performance of your system. See + every time you boot. Even so, it is likely that you will want to + build a custom kernel to optimize the performance of your system. See Kernel configuration for more information on creating custom kernels. @@ -223,7 +223,7 @@ FreeBSD currently runs on a wide variety of ISA, VLB, EISA and PCI bus based PC's, ranging from 386sx to Pentium class machines - (though the 386sx is not recommended). Support for generic IDE or + (though the 386sx is not recommended). Support for generic IDE or ESDI drive configurations, various SCSI controller, network and serial cards is also provided. @@ -232,7 +232,7 @@ recommended minimum. Following is a list of all disk controllers and Ethernet cards - currently known to work with FreeBSD. Other configurations may very + currently known to work with FreeBSD. Other configurations may very well work, and we have simply not received any indication of this. @@ -298,11 +298,11 @@ You cannot boot from the SoundBlaster cards as they have no on-board BIOS, which is necessary for mapping the boot device into the system BIOS - I/O vectors. They are perfectly usable for external tapes, - CDROMs, etc, however. The same goes for any other AIC-6x60 - based card without a boot ROM. Some systems DO have a boot + I/O vectors. They are perfectly usable for external tapes, + CDROMs, etc, however. The same goes for any other AIC-6x60 + based card without a boot ROM. Some systems DO have a boot ROM, which is generally indicated by some sort of message - when the system is first powered up or reset. Check your + when the system is first powered up or reset. Check your system/board documentation for more details. @@ -414,7 +414,7 @@ SMC Elite 16 WD8013 Ethernet interface, and most other WD8003E, WD8003EBT, WD8003W, WD8013W, WD8003S, WD8003SBT and - WD8013EBT based clones. SMC Elite Ultra and 9432TX based + WD8013EBT based clones. SMC Elite Ultra and 9432TX based cards are also supported. @@ -581,7 +581,7 @@ FreeBSD does not currently support - PnP (plug-n-play) features present on some ethernet cards. If + PnP (plug-n-play) features present on some ethernet cards. If your card has PnP and is giving you problems, try disabling its PnP features. @@ -678,7 +678,7 @@ Preparing for the Installation There are a number of different methods by which FreeBSD can be - installed. The following describes what preparation needs to be + installed. The following describes what preparation needs to be done for each type. @@ -703,11 +703,11 @@ If you are creating the boot floppies from a UNIX machine, see the beginning of this - guide for examples. of how to create the boot floppies. + guide for examples. of how to create the boot floppies. Once you have booted from DOS or floppy, you should then be able to select CDROM as the media type in the Media menu and load - the entire distribution from CDROM. No other types of + the entire distribution from CDROM. No other types of installation media should be required. After your system is fully installed and you have rebooted @@ -715,12 +715,12 @@ mount /cdrom Before removing the CD again, also note that it is necessary - to first type: umount /cdrom. Do not just + to first type: umount /cdrom. Do not just remove it from the drive! Before invoking the installation, be sure that the CDROM is - in the drive so that the install probe can find it. This is + in the drive so that the install probe can find it. This is also true if you wish the CDROM to be added to the default system configuration automatically during the install (whether or not you actually use it as the installation media). @@ -728,7 +728,7 @@ Finally, if you would like people to be able to FTP install FreeBSD directly from the CDROM in your machine, you will find it - quite easy. After the machine is fully installed, you simply need + quite easy. After the machine is fully installed, you simply need to add the following line to the password file (using the vipw command): @@ -753,20 +753,20 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent You will need, at minimum, as many 1.44MB or 1.2MB floppies as it takes to hold all files in the bin (binary distribution) - directory. If you are preparing these floppies under DOS, then + directory. If you are preparing these floppies under DOS, then THESE floppies must be formatted using the MS-DOS FORMAT - command. If you are using Windows, use the Windows File Manager + command. If you are using Windows, use the Windows File Manager format command. Do not trust Factory Preformatted - floppies! Format them again yourself, just to make sure. Many + floppies! Format them again yourself, just to make sure. Many problems reported by our users in the past have resulted from the use of improperly formatted media, which is why I am taking such special care to mention it here! If you are creating the floppies from another FreeBSD machine, a format is still not a bad idea though you do not need to put a - DOS filesystem on each floppy. You can use the disklabel and + DOS filesystem on each floppy. You can use the disklabel and newfs commands to put a UFS filesystem on them instead, as the following sequence of commands (for a 3.5" 1.44MB floppy disk) illustrates: @@ -789,11 +789,11 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent system. After you have formatted the floppies, you will need to copy - the files onto them. The distribution files are split into chunks + the files onto them. The distribution files are split into chunks conveniently sized so that 5 of them will fit on a conventional - 1.44MB floppy. Go through all your floppies, packing as many + 1.44MB floppy. Go through all your floppies, packing as many files as will fit on each one, until you have got all the - distributions you want packed up in this fashion. Each + distributions you want packed up in this fashion. Each distribution should go into a subdirectory on the floppy, e.g.: a:\bin\bin.aa, a:\bin\bin.ab, and so on. @@ -808,7 +808,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent To prepare for installation from an MS-DOS partition, copy the files from the distribution into a directory called - C:\FREEBSD. The directory tree structure of + C:\FREEBSD. The directory tree structure of the CDROM must be partially reproduced within this directory so we suggest using the DOS xcopy command. For example, to prepare for a minimal installation of FreeBSD: @@ -834,7 +834,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent Before installing from QIC/SCSI Tape Installing from tape is probably the easiest method, short of - an on-line install using FTP or a CDROM install. The installation + an on-line install using FTP or a CDROM install. The installation program expects the files to be simply tar'ed onto the tape, so after getting all of the files for distribution you are interested in, simply tar them onto the tape with a command like: @@ -849,7 +849,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent that you leave enough room in some temporary directory (which you will be allowed to choose) to accommodate the full contents of the tape you have created. Due to the non-random access nature of tapes, this method of - installation requires quite a bit of temporary storage. You + installation requires quite a bit of temporary storage. You should expect to require as much temporary storage as you have stuff written on tape. @@ -895,28 +895,28 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent SLIP support is rather primitive, and limited primarily to hard-wired links, such as a serial cable running between a laptop - computer and another computer. The link should be hard-wired as + computer and another computer. The link should be hard-wired as the SLIP installation does not currently offer a dialing capability; that facility is provided with the PPP utility, which should be used in preference to SLIP whenever possible. If you are using a modem, then PPP is almost certainly your - only choice. Make sure that you have your service provider's + only choice. Make sure that you have your service provider's information handy as you will need to know it fairly soon in the - installation process. You will need to know how to dial your ISP + installation process. You will need to know how to dial your ISP using the “AT commands” specific to your modem, as the PPP - dialer provides only a very simple terminal emulator. If you're + dialer provides only a very simple terminal emulator. If you're using PAP or CHAP, you'll need to type the necessary set authname and set authkey commands before typing term. Refer to the user-ppp handbook and FAQ entries for - further information. If you have problems, logging can be + further information. If you have problems, logging can be directed to the screen using the command set log local .... If a hard-wired connection to another FreeBSD (2.0R or later) machine is available, you might also consider installing over a - “laplink” parallel port cable. The data rate over the parallel + “laplink” parallel port cable. The data rate over the parallel port is much higher than what is typically possible over a serial line (up to 50k/sec), thus resulting in a quicker installation. @@ -926,7 +926,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent common PC ethernet cards, a table of supported cards (and their required settings) is provided in Supported - Hardware. If you are using one of the supported PCMCIA + Hardware. If you are using one of the supported PCMCIA ethernet cards, also be sure that it is plugged in before the laptop is powered on! FreeBSD does not, unfortunately, currently support hot insertion of PCMCIA @@ -934,12 +934,12 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent You will also need to know your IP address on the network, the netmask value for your address class, and the name of your - machine. Your system administrator can tell you which values to - use for your particular network setup. If you will be referring + machine. Your system administrator can tell you which values to + use for your particular network setup. If you will be referring to other hosts by name rather than IP address, you will also need a name server and possibly the address of a gateway (if you are using PPP, it is your provider's IP address) to use in talking to - it. If you do not know the answers to all or most of these + it. If you do not know the answers to all or most of these questions, then you should really probably talk to your system administrator first before trying this type of installation. @@ -974,8 +974,8 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent /usr/archive/stuff. In FreeBSD's /etc/exports file, this is - controlled by the option. Other - NFS servers may have different conventions. If you are getting + controlled by the option. Other + NFS servers may have different conventions. If you are getting Permission Denied messages from the server then it is likely that you do not have this enabled properly. @@ -985,14 +985,14 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent Preparing for FTP Installation FTP installation may be done from any mirror site containing - a reasonably up-to-date version of FreeBSD &rel.current;. A + a reasonably up-to-date version of FreeBSD &rel.current;. A full menu of reasonable choices from almost anywhere in the world is provided by the FTP site menu. If you are installing from some other FTP site not listed in this menu, or you are having troubles getting your name server configured properly, you can also specify your own URL by - selecting the “Other” choice in that menu. A URL can also be + selecting the “Other” choice in that menu. A URL can also be a direct IP address, so the following would work in the absence of a name server: @@ -1008,7 +1008,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent FTP Active - For all FTP transfers, use “Active” mode. This + For all FTP transfers, use “Active” mode. This will not work through firewalls, but will often work with older ftp servers that do not support passive mode. If your connection hangs with passive mode (the @@ -1019,7 +1019,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent FTP Passive - For all FTP transfers, use “Passive” mode. This + For all FTP transfers, use “Passive” mode. This allows the user to pass through firewalls that do not allow incoming connections on random port addresses. @@ -1036,13 +1036,13 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent For a proxy FTP server, you should usually give name of the server you really want as a part of the username, after an - @-sign. The proxy server then 'fakes' the real server. An + @-sign. The proxy server then 'fakes' the real server. An example: Say you want to install from ftp.freebsd.org, using the proxy FTP server foo.bar.com, listening on port 1234. In this case, you go to the options menu, set the FTP username to ftp@ftp.freebsd.org, and the password to your e-mail - address. As your installation media, you specify FTP (or + address. As your installation media, you specify FTP (or passive FTP, if the proxy support it), and the URL @@ -1076,10 +1076,10 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent The FreeBSD boot floppies contain all the on-line documentation you should need to be able to navigate through an installation and if it does not then we would like to know what you found most - confusing. Send your comments to the &a.doc;. It is the objective + confusing. Send your comments to the &a.doc;. It is the objective of the FreeBSD installation program (sysinstall) to be self-documenting enough that painful “step-by-step” guides are no - longer necessary. It may take us a little while to reach that + longer necessary. It may take us a little while to reach that objective, but that is the objective! Meanwhile, you may also find the following “typical @@ -1091,17 +1091,17 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent Boot the kern.flp floppy and, when asked, remove it and insert the - mfsroot.flp floppy and hit return.. After a boot sequence which can + mfsroot.flp floppy and hit return. After a boot sequence which can take anywhere from 30 seconds to 3 minutes, depending on your hardware, you should be presented with a menu of initial - choices. If the kern.flp floppy does not boot at all, or the boot + choices. If the kern.flp floppy does not boot at all, or the boot hangs at some stage, go read the Q&A section of the Hardware Guide for possible causes. - Press F1. You should see some basic usage instructions on - the menu system and general navigation. If you have not used + Press F1. You should see some basic usage instructions on + the menu system and general navigation. If you have not used this menu system before then please read this thoroughly! @@ -1116,17 +1116,17 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent through a typical installation, give you a high degree of control over each step of the installation or simply whizz through it (using reasonable defaults when possible) as fast - as possible. If you have never used FreeBSD before then the + as possible. If you have never used FreeBSD before then the Novice installation method is most recommended. The final configuration menu choice allows you to further configure your FreeBSD installation by giving you menu-driven - access to various system defaults. Some items, like + access to various system defaults. Some items, like networking, may be especially important if you did a CDROM/Tape/Floppy installation and have not yet configured - your network interfaces (assuming you have any). Properly + your network interfaces (assuming you have any). Properly configuring such interfaces here will allow FreeBSD to come up on the network when you first reboot from the hard disk. @@ -1141,7 +1141,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent MS-DOS User's Questions and Answers Many FreeBSD users wish to install FreeBSD on PCs inhabited by - MS-DOS. Here are some commonly asked questions about installing + MS-DOS. Here are some commonly asked questions about installing FreeBSD on such systems. Help! I have no space! Do I need to delete @@ -1154,11 +1154,11 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent FIPS allows you to split an existing MS-DOS partition into two pieces, preserving the original partition and allowing you to - install onto the second free piece. You first defragment your + install onto the second free piece. You first defragment your MS-DOS partition, using the DOS 6.xx DEFRAG utility or the Norton - Disk tools, then run FIPS. It will prompt you for the rest of the - information it needs. Afterwards, you can reboot and install - FreeBSD on the new free slice. See the + Disk tools, then run FIPS. It will prompt you for the rest of the + information it needs. Afterwards, you can reboot and install + FreeBSD on the new free slice. See the Distributions menu for an estimation of how much free space you will need for the kind of installation you want. @@ -1166,11 +1166,11 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent Can I use compressed MS-DOS filesystems from FreeBSD? - No. If you are using a utility such as Stacker(tm) or + No. If you are using a utility such as Stacker(tm) or DoubleSpace(tm), FreeBSD will only be able to use whatever portion - of the filesystem you leave uncompressed. The rest of the + of the filesystem you leave uncompressed. The rest of the filesystem will show up as one large file (the stacked/dblspaced - file!). Do not remove that file! You + file!). Do not remove that file! You will probably regret it greatly! It is probably better to create another uncompressed MS-DOS @@ -1180,11 +1180,11 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent Can I mount my MS-DOS extended partitions? - Yes. DOS extended partitions are mapped in at the end of the - other “slices” in FreeBSD, e.g. your D: drive might be /dev/sd0s5, - your E: drive /dev/sd0s6, and so on. This example assumes, of - course, that your extended partition is on SCSI drive 0. For IDE - drives, substitute wd for sd appropriately. You otherwise + Yes. DOS extended partitions are mapped in at the end of the + other “slices” in FreeBSD, e.g. your D: drive might be /dev/sd0s5, + your E: drive /dev/sd0s6, and so on. This example assumes, of + course, that your extended partition is on SCSI drive 0. For IDE + drives, substitute wd for sd appropriately. You otherwise mount extended partitions exactly like you would mount any other DOS drive, e.g.: diff --git a/en/handbook/internals/chapter.sgml b/en/handbook/internals/chapter.sgml index c16680a0b3..d02a3473df 100644 --- a/en/handbook/internals/chapter.sgml +++ b/en/handbook/internals/chapter.sgml @@ -11,7 +11,7 @@ Booting FreeBSD is essentially a three step process: load the kernel, determine the root filesystem and initialize user-land - things. This leads to some interesting possibilities shown + things. This leads to some interesting possibilities shown below. @@ -26,7 +26,7 @@ Biosboot - Biosboot is our “bootblocks”. It consists of two + Biosboot is our “bootblocks”. It consists of two files which will be installed in the first 8Kbytes of the floppy or hard-disk slice to be booted from. @@ -38,13 +38,13 @@ Dosboot - Dosboot was written by DI. Christian Gusenbauer, and + Dosboot was written by DI. Christian Gusenbauer, and is unfortunately at this time one of the few pieces of code that will not compile under FreeBSD itself because it is written for Microsoft compilers. Dosboot will boot the kernel from a MS-DOS file or - from a FreeBSD filesystem partition on the disk. It + from a FreeBSD filesystem partition on the disk. It attempts to negotiate with the various and strange kinds of memory manglers that lurk in high memory on MS/DOS systems and usually wins them for its case. @@ -80,7 +80,7 @@ UFS - This is the most normal type of root filesystem. It + This is the most normal type of root filesystem. It can reside on a floppy or on hard disk. @@ -99,7 +99,7 @@ This is actually a UFS filesystem which has been - compiled into the kernel. That means that the kernel does + compiled into the kernel. That means that the kernel does not really need any hard disks, floppies or other hardware to function. @@ -137,8 +137,8 @@ /sbin/init, as long as you keep in mind that: - there is no stdin/out/err unless you open it yourself. If you - exit, the machine panics. Signal handling is special for + there is no stdin/out/err unless you open it yourself. If you + exit, the machine panics. Signal handling is special for pid == 1. An example of this is the @@ -259,16 +259,16 @@ It then loads the first 15 sectors at 0x10000 (segment BOOTSEG in the biosboot Makefile), and sets up the stack to - work below 0x1fff0. After this, it jumps to the - entry of boot2 within that code. I.e., it jumps over itself and the + work below 0x1fff0. After this, it jumps to the + entry of boot2 within that code. I.e., it jumps over itself and the (dummy) partition table, and it is going to adjust the %cs selector—we are still in 16-bit mode there. boot2 asks for the boot file, and examines the - a.out header. It masks the file entry point + a.out header. It masks the file entry point (usually 0xf0100000) by - 0x00ffffff, and loads the file there. Hence the - usual load point is 1 MB (0x00100000). During + 0x00ffffff, and loads the file there. Hence the + usual load point is 1 MB (0x00100000). During load, the boot code toggles back and forth between real and protected mode, to use the BIOS in real mode. @@ -276,11 +276,11 @@ 0x18 and 0x20 for %cs and %ds/%es in protected mode, and 0x28 to jump back into real - mode. The kernel is finally started with %cs 0x08 and + mode. The kernel is finally started with %cs 0x08 and %ds/%es/%ss 0x10, which refer to dummy descriptors covering the entire address space. - The kernel will be started at its load point. Since it has been + The kernel will be started at its load point. Since it has been linked for another (high) address, it will have to execute PIC until the page table and page directory stuff is setup properly, at which point paging will be enabled and the kernel will finally run at the @@ -290,7 +290,7 @@ 1995. The physical pages immediately following the kernel BSS contain - proc0's page directory, page tables, and upages. Some time later + proc0's page directory, page tables, and upages. Some time later when the VM system is initialized, the physical memory between 0x1000-0x9ffff and the physical memory after the kernel (text+data+bss+proc0 stuff+other misc) is made available in @@ -303,7 +303,7 @@ DMA: What it Is and How it Works Copyright © 1995,1997 &a.uhclem;, All Rights - Reserved. 10 December 1996. Last Update 8 October + Reserved. 10 December 1996. Last Update 8 October 1997. Direct Memory Access (DMA) is a method of allowing data to be @@ -319,25 +319,25 @@ The PC DMA subsystem is based on the Intel 8237 DMA controller. The 8237 contains four DMA channels that can be programmed independently and any one of the channels may be active at any - moment. These channels are numbered 0, 1, 2 and 3. Starting with + moment. These channels are numbered 0, 1, 2 and 3. Starting with the PC/AT, IBM added a second 8237 chip, and numbered those channels 4, 5, 6 and 7. The original DMA controller (0, 1, 2 and 3) moves one byte in - each transfer. The second DMA controller (4, 5, 6, and 7) moves + each transfer. The second DMA controller (4, 5, 6, and 7) moves 16-bits from two adjacent memory locations in each transfer, with - the first byte always coming from an even-numbered address. The two + the first byte always coming from an even-numbered address. The two controllers are identical components and the difference in transfer size is caused by the way the second controller is wired into the system. The 8237 has two electrical signals for each channel, named DRQ - and -DACK. There are additional signals with the names HRQ (Hold + and -DACK. There are additional signals with the names HRQ (Hold Request), HLDA (Hold Acknowledge), -EOP (End of Process), and the bus control signals -MEMR (Memory Read), -MEMW (Memory Write), -IOR (I/O Read), and -IOW (I/O Write). - The 8237 DMA is known as a “fly-by” DMA controller. This + The 8237 DMA is known as a “fly-by” DMA controller. This means that the data being moved from one location to another does not pass through the DMA chip and is not stored in the DMA chip. Subsequently, the DMA can only transfer data between an I/O port and @@ -361,24 +361,24 @@ A Sample DMA transfer Here is an example of the steps that occur to cause and - perform a DMA transfer. In this example, the floppy disk + perform a DMA transfer. In this example, the floppy disk controller (FDC) has just read a byte from a diskette and wants - the DMA to place it in memory at location 0x00123456. The process + the DMA to place it in memory at location 0x00123456. The process begins by the FDC asserting the DRQ2 signal (the DRQ line for DMA channel 2) to alert the DMA controller. The DMA controller will note that the DRQ2 signal is asserted. The DMA controller will then make sure that DMA channel 2 has been - programmed and is unmasked (enabled). The DMA controller also + programmed and is unmasked (enabled). The DMA controller also makes sure that none of the other DMA channels are active or want - to be active and have a higher priority. Once these checks are + to be active and have a higher priority. Once these checks are complete, the DMA asks the CPU to release the bus so that the DMA - may use the bus. The DMA requests the bus by asserting the HRQ + may use the bus. The DMA requests the bus by asserting the HRQ signal which goes to the CPU. The CPU detects the HRQ signal, and will complete executing - the current instruction. Once the processor has reached a state - where it can release the bus, it will. Now all of the signals + the current instruction. Once the processor has reached a state + where it can release the bus, it will. Now all of the signals normally generated by the CPU (-MEMR, -MEMW, -IOR, -IOW and a few others) are placed in a tri-stated condition (neither high or low) and then the CPU asserts the HLDA signal which tells the DMA @@ -397,12 +397,12 @@ location. The DMA will then let the device that requested the DMA - transfer know that the transfer is commencing. This is done by + transfer know that the transfer is commencing. This is done by asserting the -DACK signal, or in the case of the floppy disk controller, -DACK2 is asserted. The floppy disk controller is now responsible for placing the - byte to be transferred on the bus Data lines. Unless the floppy + byte to be transferred on the bus Data lines. Unless the floppy controller needs more time to get the data byte on the bus (and if the peripheral does need more time it alerts the DMA via the READY signal), the DMA will wait one DMA clock, and then de-assert the @@ -412,22 +412,22 @@ Since the DMA cycle only transfers a single byte at a time, the FDC now drops the DRQ2 signal, so the DMA knows that it is no - longer needed. The DMA will de-assert the -DACK2 signal, so that + longer needed. The DMA will de-assert the -DACK2 signal, so that the FDC knows it must stop placing data on the bus. The DMA will now check to see if any of the other DMA channels - have any work to do. If none of the channels have their DRQ lines + have any work to do. If none of the channels have their DRQ lines asserted, the DMA controller has completed its work and will now tri-state the -MEMR, -MEMW, -IOR, -IOW and address signals. - Finally, the DMA will de-assert the HRQ signal. The CPU sees - this, and de-asserts the HOLDA signal. Now the CPU activates its + Finally, the DMA will de-assert the HRQ signal. The CPU sees + this, and de-asserts the HOLDA signal. Now the CPU activates its -MEMR, -MEMW, -IOR, -IOW and address lines, and it resumes executing instructions and accessing main memory and the peripherals. For a typical floppy disk sector, the above process is - repeated 512 times, once for each byte. Each time a byte is + repeated 512 times, once for each byte. Each time a byte is transferred, the address register in the DMA is incremented and the counter in the DMA that shows how many bytes are to be transferred is decremented. @@ -435,7 +435,7 @@ When the counter reaches zero, the DMA asserts the EOP signal, which indicates that the counter has reached zero and no more data will be transferred until the DMA controller is reprogrammed by - the CPU. This event is also called the Terminal Count (TC). + the CPU. This event is also called the Terminal Count (TC). There is only one EOP signal, and since only DMA channel can be active at any instant, the DMA channel that is currently active must be the DMA channel that just completed its task. @@ -446,10 +446,10 @@ When that happens, it means the DMA will not transfer any more information for that peripheral without intervention by the CPU. The peripheral can then assert one of the interrupt signals to get - the processors' attention. In the PC architecture, the DMA chip - itself is not capable of generating an interrupt. The peripheral + the processors' attention. In the PC architecture, the DMA chip + itself is not capable of generating an interrupt. The peripheral and its associated hardware is responsible for generating any - interrupt that occurs. Subsequently, it is possible to have a + interrupt that occurs. Subsequently, it is possible to have a peripheral that uses DMA but does not use interrupts. It is important to understand that although the CPU always @@ -470,53 +470,53 @@ You may have noticed earlier that instead of the DMA setting the address lines to 0x00123456 as we said earlier, the DMA only - set 0x3456. The reason for this takes a bit of explaining. + set 0x3456. The reason for this takes a bit of explaining. When the original IBM PC was designed, IBM elected to use both DMA and interrupt controller chips that were designed for use with the 8085, an 8-bit processor with an address space of 16 bits - (64K). Since the IBM PC supported more than 64K of memory, + (64K). Since the IBM PC supported more than 64K of memory, something had to be done to allow the DMA to read or write memory - locations above the 64K mark. What IBM did to solve this problem + locations above the 64K mark. What IBM did to solve this problem was to add an external data latch for each DMA channel that holds the upper bits of the address to be read to or written from. Whenever a DMA channel is active, the contents of that latch are written to the address bus and kept there until the DMA operation - for the channel ends. IBM called these latches “Page + for the channel ends. IBM called these latches “Page Registers”. So for our example above, the DMA would put the 0x3456 part of the address on the bus, and the Page Register for DMA channel 2 - would put 0x0012xxxx on the bus. Together, these two values form + would put 0x0012xxxx on the bus. Together, these two values form the complete address in memory that is to be accessed. Because the Page Register latch is independent of the DMA chip, the area of memory to be read or written must not span a 64K - physical boundary. For example, if the DMA accesses memory + physical boundary. For example, if the DMA accesses memory location 0xffff, after that transfer the DMA will then increment the address register and the DMA will access the next byte at - location 0x0000, not 0x10000. The results of letting this happen + location 0x0000, not 0x10000. The results of letting this happen are probably not intended. “Physical” 64K boundaries should not be confused with 8086-mode 64K “Segments”, which are created by mathematically adding a segment register with an - offset register. Page Registers have no address overlap and are + offset register. Page Registers have no address overlap and are mathematically OR-ed together. To further complicate matters, the external DMA address latches on the PC/AT hold only eight bits, so that gives us 8+16=24 bits, which means that the DMA can only point at memory - locations between 0 and 16Meg. For newer computers that allow + locations between 0 and 16Meg. For newer computers that allow more than 16Meg of memory, the standard PC-compatible DMA cannot access memory locations above 16Meg. To get around this restriction, operating systems will reserve a RAM buffer in an area below 16Meg that also does not span a - physical 64K boundary. Then the DMA will be programmed to - transfer data from the peripheral and into that buffer. Once the + physical 64K boundary. Then the DMA will be programmed to + transfer data from the peripheral and into that buffer. Once the DMA has moved the data into this buffer, the operating system will then copy the data from the buffer to the address where the data is really supposed to be stored. @@ -524,8 +524,8 @@ When writing data from an address above 16Meg to a DMA-based peripheral, the data must be first copied from where it resides into a buffer located below 16Meg, and then the DMA can copy the - data from the buffer to the hardware. In FreeBSD, these reserved - buffers are called “Bounce Buffers”. In the MS-DOS world, they + data from the buffer to the hardware. In FreeBSD, these reserved + buffers are called “Bounce Buffers”. In the MS-DOS world, they are sometimes called “Smart Buffers”. @@ -539,17 +539,17 @@ DMA Operational Modes and Settings - The 8237 DMA can be operated in several modes. The main ones + The 8237 DMA can be operated in several modes. The main ones are: Single - A single byte (or word) is transferred. The DMA must + A single byte (or word) is transferred. The DMA must release and re-acquire the bus for each additional byte. This is commonly-used by devices that cannot transfer the - entire block of data immediately. The peripheral will + entire block of data immediately. The peripheral will request the DMA each time it is ready for another transfer. @@ -563,19 +563,19 @@ Once the DMA acquires the system bus, an entire block - of data is transferred, up to a maximum of 64K. If the + of data is transferred, up to a maximum of 64K. If the peripheral needs additional time, it can assert the READY - signal to suspend the transfer briefly. READY should not + signal to suspend the transfer briefly. READY should not be used excessively, and for slow peripheral transfers, the Single Transfer Mode should be used instead. The difference between Block and Demand is that once a Block transfer is started, it runs until the transfer - count reaches zero. DRQ only needs to be asserted until - -DACK is asserted. Demand Mode will transfer one more + count reaches zero. DRQ only needs to be asserted until + -DACK is asserted. Demand Mode will transfer one more bytes until DRQ is de-asserted, at which point the DMA suspends the transfer and releases the bus back to the - CPU. When DRQ is asserted later, the transfer resumes + CPU. When DRQ is asserted later, the transfer resumes where it was suspended. Older hard disk controllers used Demand Mode until CPU @@ -592,36 +592,36 @@ This mechanism allows a DMA channel to request the bus, but then the attached peripheral device is responsible for placing the addressing information on the - bus instead of the DMA. This is also used to implement a + bus instead of the DMA. This is also used to implement a technique known as “Bus Mastering”. When a DMA channel in Cascade Mode receives control of the bus, the DMA does not place addresses and I/O control signals on the bus like the DMA normally does when it is - active. Instead, the DMA only asserts the -DACK signal + active. Instead, the DMA only asserts the -DACK signal for the active DMA channel. At this point it is up to the peripheral connected to that DMA channel to provide address and bus control - signals. The peripheral has complete control over the + signals. The peripheral has complete control over the system bus, and can do reads and/or writes to any address - below 16Meg. When the peripheral is finished with the + below 16Meg. When the peripheral is finished with the bus, it de-asserts the DRQ line, and the DMA controller can then return control to the CPU or to some other DMA channel. Cascade Mode can be used to chain multiple DMA controllers together, and this is exactly what DMA Channel - 4 is used for in the PC architecture. When a peripheral + 4 is used for in the PC architecture. When a peripheral requests the bus on DMA channels 0, 1, 2 or 3, the slave DMA controller asserts HLDREQ, but this wire is actually connected to DRQ4 on the primary DMA controller instead of - to the CPU. The primary DMA controller, thinking it has + to the CPU. The primary DMA controller, thinking it has work to do on Channel 4, requests the bus from the CPU - using HLDREQ signal. Once the CPU grants the bus to the + using HLDREQ signal. Once the CPU grants the bus to the primary DMA controller, -DACK4 is asserted, and that wire is actually connected to the HLDA signal on the slave DMA - controller. The slave DMA controller then transfers data + controller. The slave DMA controller then transfers data for the DMA channel that requested it (0, 1, 2 or 3), or the slave DMA may grant the bus to a peripheral that wants to perform its own bus-mastering, such as a SCSI @@ -639,24 +639,24 @@ When a peripheral is performing Bus Mastering, it is important that the peripheral transmit data to or from - memory constantly while it holds the system bus. If the + memory constantly while it holds the system bus. If the peripheral cannot do this, it must release the bus frequently so that the system can perform refresh operations on main memory. The Dynamic RAM used in all PCs for main memory must be accessed frequently to keep the bits stored in the - components “charged”. Dynamic RAM essentially consists of + components “charged”. Dynamic RAM essentially consists of millions of capacitors with each one holding one bit of - data. These capacitors are charged with power to - represent a 1 or drained to represent a 0. Because + data. These capacitors are charged with power to + represent a 1 or drained to represent a 0. Because all capacitors leak, power must be added at regular - intervals to keep the 1 values intact. The RAM chips + intervals to keep the 1 values intact. The RAM chips actually handle the task of pumping power back into all of the appropriate locations in RAM, but they must be told when to do it by the rest of the computer so that the refresh activity won't interfere with the computer wanting - to access RAM normally. If the computer is unable to + to access RAM normally. If the computer is unable to refresh memory, the contents of memory will become corrupted in just a few milliseconds. @@ -679,8 +679,8 @@ Demand transfers, but when the DMA transfer counter reaches zero, the counter and address are set back to where they were when the DMA channel was originally - programmed. This means that as long as the peripheral - requests transfers, they will be granted. It is up to the + programmed. This means that as long as the peripheral + requests transfers, they will be granted. It is up to the CPU to move new data into the fixed buffer ahead of where the DMA is about to transfer it when doing output operations, and read new data out of the buffer behind @@ -688,7 +688,7 @@ operations. This technique is frequently used on audio devices - that have small or no hardware “sample” buffers. There + that have small or no hardware “sample” buffers. There is additional CPU overhead to manage this “circular” buffer, but in some cases this may be the only way to eliminate the latency that occurs when the DMA counter @@ -706,7 +706,7 @@ Programming the DMA The DMA channel that is to be programmed should always be - “masked” before loading any settings. This is because the + “masked” before loading any settings. This is because the hardware might unexpectedly assert the DRQ for that channel, and the DMA might respond, even though not all of the parameters have been loaded or updated. @@ -715,8 +715,8 @@ transfer (memory-to-I/O or I/O-to-memory), what mode of DMA operation is to be used for the transfer (Single, Block, Demand, Cascade, etc), and finally the address and length of the transfer - are loaded. The length that is loaded is one less than the amount - you expect the DMA to transfer. The LSB and MSB of the address + are loaded. The length that is loaded is one less than the amount + you expect the DMA to transfer. The LSB and MSB of the address and length are written to the same 8-bit I/O port, so another port must be written to first to guarantee that the DMA accepts the first byte as the LSB and the second byte as the MSB of the length @@ -727,14 +727,14 @@ ports. Once all the settings are ready, the DMA channel can be - un-masked. That DMA channel is now considered to be “armed”, + un-masked. That DMA channel is now considered to be “armed”, and will respond when the DRQ line for that channel is asserted. Refer to a hardware data book for precise programming details - for the 8237. You will also need to refer to the I/O port map for + for the 8237. You will also need to refer to the I/O port map for the PC system, which describes where the DMA and Page Register - ports are located. A complete port map table is located + ports are located. A complete port map table is located below. @@ -743,8 +743,8 @@ DMA Port Map All systems based on the IBM-PC and PC/AT have the DMA - hardware located at the same I/O ports. The complete list is - provided below. Ports assigned to DMA Controller #2 are undefined + hardware located at the same I/O ports. The complete list is + provided below. Ports assigned to DMA Controller #2 are undefined on non-AT designs. @@ -1241,14 +1241,14 @@ The Intel 82374 EISA System Component (ESC) was introduced in early 1996 and includes a DMA controller that provides a superset of 8237 functionality as well as other PC-compatible - core peripheral components in a single package. This chip is + core peripheral components in a single package. This chip is targeted at both EISA and PCI platforms, and provides modern DMA features like scatter-gather, ring buffers as well as direct access by the system DMA to all 32 bits of address space. If these features are used, code should also be included to provide similar functionality in the previous 16 years worth of - PC-compatible computers. For compatibility reasons, some of the + PC-compatible computers. For compatibility reasons, some of the 82374 registers must be programmed after programming the traditional 8237 registers for each transfer. Writing to a traditional 8237 register forces the contents of @@ -1653,7 +1653,7 @@ The FreeBSD VM System - Contributed by &a.dillon;. 6 Feb 1999 + Contributed by &a.dillon;. 6 Feb 1999 Management of physical @@ -1666,7 +1666,7 @@ queues.</para> <para>A page can be in a wired, active, inactive, cache, or free - state. Except for the wired state, the page is typically placed in a + state. Except for the wired state, the page is typically placed in a doubly link list queue representing the state that it is in. Wired pages are not placed on any queue.</para> @@ -1684,9 +1684,9 @@ in the page's flags.</para> <para>In general terms, each of the paging queues operates in a LRU - fashion. A page is typicaly placed in a wired or active state + fashion. A page is typicaly placed in a wired or active state initially. When wired, the page is usually associated with a page - table somewhere. The VM system ages the page by scanning pages in a + table somewhere. The VM system ages the page by scanning pages in a more active paging queue (LRU) in order to move them to a less-active paging queue. Pages that get moved into the cache are still associated with a VM object but are candidates for immediate @@ -1707,12 +1707,12 @@ maintain reasonable ratios of pages in the various queues as well as attempts to maintain a reasonable breakdown of clean vs dirty pages. The amount of rebalancing that occurs depends on the system's memory - load. This rebalancing is implemented by the pageout daemon and + load. This rebalancing is implemented by the pageout daemon and involves laundering dirty pages (syncing them with their backing store), noticing when pages are activity referenced (resetting their position in the LRU queues or moving them between queues), migrating pages between queues when the queues are out of balance, and so - forth. FreeBSD's VM system is willing to take a reasonable number of + forth. FreeBSD's VM system is willing to take a reasonable number of reactivation page faults to determine how active or how idle a page actually is. This leads to better decisions being made as to when to launder or swap-out a page.</para> @@ -1725,7 +1725,7 @@ <para>FreeBSD implements the idea of a generic “VM object”. VM objects can be associated with backing store of various types—unbacked, swap-backed, physical device-backed, - or file-backed storage. Since the filesystem uses the same VM + or file-backed storage. Since the filesystem uses the same VM objects to manage in-core data relating to files, the result is a unified buffer cache.</para> @@ -1762,7 +1762,7 @@ the same manner, disk I/O is typically issued by mapping portions of objects into buffer structures and then issuing the I/O on the buffer structures. The underlying vm_page_t's are typically busied - for the duration of the I/O. Filesystem buffers also have their own + for the duration of the I/O. Filesystem buffers also have their own notion of being busy, which is useful to filesystem driver code which would rather operate on filesystem buffers instead of hard VM pages.</para> @@ -1812,7 +1812,7 @@ mappings relating to <literal>struct buf</literal> entities.</para> <para>Unlike Linux, FreeBSD does NOT map all of physical memory into - KVM. This means that FreeBSD can handle memory configurations up to + KVM. This means that FreeBSD can handle memory configurations up to 4G on 32 bit platforms. In fact, if the mmu were capable of it, FreeBSD could theoretically handle memory configurations up to 8TB on a 32 bit platform. However, since most 32 bit platforms are only @@ -1837,7 +1837,7 @@ <filename>/usr/src/sys/i386/conf/<replaceable>CONFIG_FILE</replaceable></filename>. A description of all available kernel configuration options can be found in <filename>/usr/src/sys/i386/conf/LINT</filename>.</para> <para>In a large system configuration you may wish to increase - <literal>maxusers</literal>. Values typically range from 10 to 128. + <literal>maxusers</literal>. Values typically range from 10 to 128. Note that raising <literal>maxusers</literal> too high can cause the system to overflow available KVM resulting in unpredictable operation. It is better to leave maxusers at some reasonable number @@ -1849,7 +1849,7 @@ from 1024 to 4096.</para> <para>The <literal>NBUF</literal> parameter is also traditionally used - to scale the system. This parameter determines the amount of KVA the + to scale the system. This parameter determines the amount of KVA the system can use to map filesystem buffers for I/O. Note that this parameter has nothing whatsoever to do with the unified buffer cache! This parameter is dynamically tuned in 3.0-CURRENT and diff --git a/en/handbook/introduction/chapter.sgml b/en/handbook/introduction/chapter.sgml index 77510aa99d..234b91a5a2 100644 --- a/en/handbook/introduction/chapter.sgml +++ b/en/handbook/introduction/chapter.sgml @@ -2,12 +2,12 @@ <title>Introduction FreeBSD is a 4.4BSD-Lite based operating system for Intel - architecture (x86) based PCs. For an overview of FreeBSD, see - FreeBSD in a nutshell. For a + architecture (x86) based PCs. For an overview of FreeBSD, see + FreeBSD in a nutshell. For a history of the project, read a brief - history of FreeBSD. To see a description of the latest release, + history of FreeBSD. To see a description of the latest release, read about the current - release. If you're interested in contributing something to the + release. If you're interested in contributing something to the FreeBSD project (code, equipment, sacks of unmarked bills), please see about contributing to FreeBSD. @@ -17,10 +17,10 @@ FreeBSD is a state of the art operating system for personal computers based on the Intel CPU architecture, which includes the - 386, 486 and Pentium processors (both SX and DX versions). Intel - compatible CPUs from AMD and Cyrix are supported as well. FreeBSD + 386, 486 and Pentium processors (both SX and DX versions). Intel + compatible CPUs from AMD and Cyrix are supported as well. FreeBSD provides you with many advanced features previously available only - on much more expensive computers. These features include: + on much more expensive computers. These features include: @@ -34,14 +34,14 @@ Multiuser access means that many people can use a FreeBSD system simultaneously for a - variety of things. System peripherals such as printers and + variety of things. System peripherals such as printers and tape drives are also properly SHARED BETWEEN ALL users on the system. Complete TCP/IP networking - including SLIP, PPP, NFS and NIS support. This means that + including SLIP, PPP, NFS and NIS support. This means that your FreeBSD machine can inter-operate easily with other systems as well act as an enterprise server, providing vital functions such as NFS (remote file access) and e-mail services @@ -77,13 +77,13 @@ Hundreds of ready-to-run - applications are available from the FreeBSD ports and packages collection. Why search the net + applications are available from the FreeBSD ports and packages collection. Why search the net when you can find it all right here? Thousands of additional and easy-to-port applications available on - the Internet. FreeBSD is source code compatible with most + the Internet. FreeBSD is source code compatible with most popular commercial Unix systems and thus most applications require few, if any, changes to compile. @@ -103,7 +103,7 @@ A full complement of C, - C++ and Fortran development tools. Many + C++ and Fortran development tools. Many additional languages for advanced research and development are also available in the ports and packages collection. @@ -111,7 +111,7 @@ Source code for the entire system means you have the greatest degree of control over your - environment. Why be locked into a proprietary solution and at + environment. Why be locked into a proprietary solution and at the mercy of your vendor when you can have a truly Open System? @@ -131,15 +131,15 @@ FreeBSD is based on the 4.4BSD-Lite release from Computer Systems Research Group (CSRG) at the University of California at Berkeley, and carries on the distinguished tradition of BSD systems - development. In addition to the fine work provided by CSRG, the + development. In addition to the fine work provided by CSRG, the FreeBSD Project has put in many thousands of hours in fine tuning the system for maximum performance and reliability in real-life load - situations. As many of the commercial giants struggle to field PC + situations. As many of the commercial giants struggle to field PC operating systems with such features, performance and reliability, FreeBSD can offer them now! The applications to which FreeBSD can be put are truly limited - only by your own imagination. From software development to factory + only by your own imagination. From software development to factory automation, inventory control to azimuth correction of remote satellite antennae; if it can be done with a commercial UNIX product then it is more than likely that you can do it with FreeBSD, too! @@ -153,7 +153,7 @@ available, the system can also be customized to an almost unheard of degree for special applications or projects, and in ways not generally possible with operating systems from most major commercial - vendors. Here is just a sampling of some of the applications in + vendors. Here is just a sampling of some of the applications in which people are currently using FreeBSD: @@ -205,7 +205,7 @@ of computer science or a related engineering field? There is no better way of learning about operating systems, computer architecture and networking than the hands on, under the hood - experience that FreeBSD can provide. A number of freely + experience that FreeBSD can provide. A number of freely available CAD, mathematical and graphic design packages also make it highly useful to those whose primary interest in a computer is to get other work @@ -216,7 +216,7 @@ Research: With source code for the entire system available, FreeBSD is an excellent platform for research in operating systems as well as other - branches of computer science. FreeBSD's freely available + branches of computer science. FreeBSD's freely available nature also makes it possible for remote groups to collaborate on ideas or shared development without having to worry about special licensing agreements or limitations on what may be @@ -238,7 +238,7 @@ one of the excellent commercial servers provided by X Inside. Unlike an X terminal, FreeBSD allows many applications to be run locally, if desired, thus relieving the burden on a - central server. FreeBSD can even boot “diskless”, making + central server. FreeBSD can even boot “diskless”, making individual workstations even cheaper and easier to administer. @@ -254,7 +254,7 @@ FreeBSD is available in both source and binary form on CDROM and - via anonymous ftp. See Obtaining + via anonymous ftp. See Obtaining FreeBSD for more details. @@ -271,89 +271,89 @@ Our original goal was to produce an intermediate snapshot of 386BSD in order to fix a number of problems with it that the - patchkit mechanism just was not capable of solving. Some of you may + patchkit mechanism just was not capable of solving. Some of you may remember the early working title for the project being “386BSD 0.5” or “386BSD Interim” in reference to that fact. 386BSD was Bill Jolitz's operating system, which had been up to that point suffering rather severely from almost a year's worth of - neglect. As the patchkit swelled ever more uncomfortably with each + neglect. As the patchkit swelled ever more uncomfortably with each passing day, we were in unanimous agreement that something had to be done and decided to try and assist Bill by providing this interim - “cleanup” snapshot. Those plans came to a rude halt when Bill + “cleanup” snapshot. Those plans came to a rude halt when Bill Jolitz suddenly decided to withdraw his sanction from the project and without any clear indication of what would be done instead. It did not take us long to decide that the goal remained worthwhile, even without Bill's support, and so we adopted the name - “FreeBSD”, coined by David Greenman. Our initial objectives were + “FreeBSD”, coined by David Greenman. Our initial objectives were set after consulting with the system's current users and, once it became clear that the project was on the road to perhaps even becoming a reality, I contacted Walnut Creek CDROM with an eye towards improving FreeBSD's distribution channels for those many - unfortunates without easy access to the Internet. Walnut Creek + unfortunates without easy access to the Internet. Walnut Creek CDROM not only supported the idea of distributing FreeBSD on CD but went so far as to provide the project with a machine to work on and - a fast Internet connection. Without Walnut Creek CDROM's almost + a fast Internet connection. Without Walnut Creek CDROM's almost unprecedented degree of faith in what was, at the time, a completely unknown project, it is quite unlikely that FreeBSD would have gotten as far, as fast, as it has today. The first CDROM (and general net-wide) distribution was FreeBSD - 1.0, released in December of 1993. This was based on the + 1.0, released in December of 1993. This was based on the 4.3BSD-Lite (“Net/2”) tape from U.C. Berkeley, with many components - also provided by 386BSD and the Free Software Foundation. It was a + also provided by 386BSD and the Free Software Foundation. It was a fairly reasonable success for a first offering, and we followed it with the highly successful FreeBSD 1.1 release in May of 1994. Around this time, some rather unexpected storm clouds formed on the horizon as Novell and U.C. Berkeley settled their long-running - lawsuit over the legal status of the Berkeley Net/2 tape. A + lawsuit over the legal status of the Berkeley Net/2 tape. A condition of that settlement was U.C. Berkeley's concession that large parts of Net/2 were “encumbered” code and the property of Novell, who had in turn acquired it from AT&T some time - previously. What Berkeley got in return was Novell's “blessing” + previously. What Berkeley got in return was Novell's “blessing” that the 4.4BSD-Lite release, when it was finally released, would be declared unencumbered and all existing Net/2 users would be strongly - encouraged to switch. This included FreeBSD, and the project was + encouraged to switch. This included FreeBSD, and the project was given until the end of July 1994 to stop shipping its own Net/2 - based product. Under the terms of that agreement, the project was + based product. Under the terms of that agreement, the project was allowed one last release before the deadline, that release being FreeBSD 1.1.5.1. FreeBSD then set about the arduous task of literally re-inventing itself from a completely new and rather incomplete set - of 4.4BSD-Lite bits. The “Lite” releases were light in part because + of 4.4BSD-Lite bits. The “Lite” releases were light in part because Berkeley's CSRG had removed large chunks of code required for actually constructing a bootable running system (due to various legal requirements) and the fact that the Intel port of 4.4 was - highly incomplete. It took the project until December of 1994 to + highly incomplete. It took the project until December of 1994 to make this transition, and in January of 1995 it released FreeBSD 2.0 - to the net and on CDROM. Despite being still more than a little + to the net and on CDROM. Despite being still more than a little rough around the edges, the release was a significant success and was followed by the more robust and easier to install FreeBSD 2.0.5 release in June of 1995. We released FreeBSD 2.1.5 in August of 1996, and it appeared to be popular enough among the ISP and commercial communities that - another release along the 2.1-stable branch was merited. This was + another release along the 2.1-stable branch was merited. This was FreeBSD 2.1.7.1, released in February 1997 and capping the end of - mainstream development on 2.1-stable. Now in maintenance mode, only + mainstream development on 2.1-stable. Now in maintenance mode, only security enhancements and other critical bug fixes will be done on this branch (RELENG_2_1_0). FreeBSD 2.2 was branched from the development mainline (“-current”) in November 1996 as the RELENG_2_2 branch, and the - first full release (2.2.1) was released in April, 1997. Further + first full release (2.2.1) was released in April, 1997. Further releases along the 2.2 branch were done in the Summer and Fall of '97, the latest being 2.2.7 which appeared in late July of '98. The first official 3.0 release appeared in October, 1998 and the last release on the 2.2 branch, 2.2.8, appeared in November, 1998. - The tree branched again on Jan 20, 1999. This led to + The tree branched again on Jan 20, 1999. This led to 4.0-current and a 3.x-stable branch, from which 3.1 will be released on February 15th, 1999. @@ -368,20 +368,20 @@ Contributed by &a.jkh;. The goals of the FreeBSD Project are to provide software that - may be used for any purpose and without strings attached. Many of + may be used for any purpose and without strings attached. Many of us have a significant investment in the code (and project) and would certainly not mind a little financial compensation now and then, but - we're definitely not prepared to insist on it. We believe that our + we're definitely not prepared to insist on it. We believe that our first and foremost “mission” is to provide code to any and all comers, and for whatever purpose, so that the code gets the widest - possible use and provides the widest possible benefit. This is, I + possible use and provides the widest possible benefit. This is, I believe, one of the most fundamental goals of Free Software and one that we enthusiastically support. That code in our source tree which falls under the GNU Public License (GPL) or GNU Library Public License (GLPL) comes with slightly more strings attached, though at least on the side of - enforced access rather than the usual opposite. Due to the + enforced access rather than the usual opposite. Due to the additional complexities that can evolve in the commercial use of GPL software, we do, however, endeavor to replace such software with submissions under the more relaxed BSD copyright whenever possible. @@ -396,13 +396,13 @@ The development of FreeBSD is a very open and flexible process, FreeBSD being literally built from the contributions of hundreds of people around the world, as can be seen from our list of contributors. We are constantly + linkend="staff">list of contributors. We are constantly on the lookout for new developers and ideas, and those interested in becoming more closely involved with the project need simply contact - us at the &a.hackers;. Those who prefer to work more independently + us at the &a.hackers;. Those who prefer to work more independently are also accommodated, and they are free to use our FTP facilities at ftp.freebsd.org to distribute their own patches or work-in-progress sources. The &a.announce; is also available to those wishing to make other FreeBSD users aware of major areas of work. + URL="ftp://ftp.freebsd.org/pub/FreeBSD/incoming">ftp.freebsd.org to distribute their own patches or work-in-progress sources. The &a.announce; is also available to those wishing to make other FreeBSD users aware of major areas of work. Useful things to know about the FreeBSD project and its development process, whether working independently or in close @@ -415,10 +415,10 @@ The central source tree for FreeBSD is maintained by CVS (Concurrent Version System), a freely available source code control tool which comes bundled with FreeBSD. The primary CVS repository resides on a machine in Concord CA, USA from where it is replicated to numerous mirror machines throughout the world. The CVS tree, as well as the -current and CVS (Concurrent Version System), a freely available source code control tool which comes bundled with FreeBSD. The primary CVS repository resides on a machine in Concord CA, USA from where it is replicated to numerous mirror machines throughout the world. The CVS tree, as well as the -current and -stable trees which are checked out of it, can be easily replicated to your own machine as - well. Please refer to the + well. Please refer to the Synchronizing your source tree section for more information on doing this. @@ -433,7 +433,7 @@ the CVS tree, and are thus authorized to make modifications to the FreeBSD source (the term “committer” comes from the cvs1 commit command, which is used to - bring new changes into the CVS repository). The best way of + bring new changes into the CVS repository). The best way of making submissions for review by the committers list is to use the send-pr1 command, though if something appears to be jammed in the system then you may also reach them by sending mail to committers@freebsd.org. @@ -445,9 +445,9 @@ The FreeBSD core team would be equivalent to the board of directors if - the FreeBSD Project were a company. The primary task of the + the FreeBSD Project were a company. The primary task of the core team is to make sure the project, as a whole, is in - good shape and is heading in the right directions. Inviting + good shape and is heading in the right directions. Inviting dedicated and responsible developers to join our group of committers is one of the functions of the core team, as is the recruitment of new core team members as others move on. @@ -479,7 +479,7 @@ Last, but definitely not least, the largest group of developers are the users themselves who provide feedback and - bug-fixes to us on an almost constant basis. The primary + bug-fixes to us on an almost constant basis. The primary way of keeping in touch with FreeBSD's more non-centralized development is to subscribe to the &a.hackers; (see mailing list @@ -501,7 +501,7 @@ In summary, our development model is organized as a loose set of - concentric circles. The centralized model is designed for the + concentric circles. The centralized model is designed for the convenience of the users of FreeBSD, who are thereby provided with an easy way of tracking one central code base, not to keep potential contributors out! Our desire is to present a @@ -521,16 +521,16 @@ FreeBSD is a freely available, full source 4.4BSD-Lite based release for Intel i386/i486/Pentium/PentiumPro/Pentium II (or - compatible) based PC's. It is based primarily on software from U.C. + compatible) based PC's. It is based primarily on software from U.C. Berkeley's CSRG group, with some enhancements from NetBSD, OpenBSD, 386BSD, and the Free Software Foundation. Since our release of FreeBSD 2.0 in January of 95, the performance, feature set, and stability of FreeBSD has improved - dramatically. The largest change is a revamped virtual memory + dramatically. The largest change is a revamped virtual memory system with a merged VM/file buffer cache that not only increases performance, but reduces FreeBSD's memory footprint, making a 5MB - configuration a more acceptable minimum. Other enhancements include + configuration a more acceptable minimum. Other enhancements include full NIS client and server support, transaction TCP support, dial-on-demand PPP, an improved SCSI subsystem, early ISDN support, support for FDDI and Fast Ethernet (100Mbit) adapters, improved @@ -539,24 +539,24 @@ We have also taken the comments and suggestions of many of our users to heart and have attempted to provide what we hope is a more - sane and easily understood installation process. Your feedback on + sane and easily understood installation process. Your feedback on this (constantly evolving) process is especially welcome! In addition to the base distributions, FreeBSD offers a new ported software collection with hundreds of commonly sought-after - programs. At the end of August 1998 there were more than 1700 ports! + programs. At the end of August 1998 there were more than 1700 ports! The list of ports ranges from http (WWW) servers, to games, - languages, editors and almost everything in between. The entire + languages, editors and almost everything in between. The entire ports collection requires approximately 26MB of storage, all ports - being expressed as “deltas” to their original sources. This + being expressed as “deltas” to their original sources. This makes it much easier for us to update ports, and greatly reduces - the disk space demands made by the older 1.0 ports collection. To + the disk space demands made by the older 1.0 ports collection. To compile a port, you simply change to the directory of the program you wish to install, type make all followed by make install - after successful compilation and let the system do the rest. The + after successful compilation and let the system do the rest. The full original distribution for each port you build is retrieved dynamically off the CDROM or a local ftp site, so you need only - enough disk space to build the ports you want. (Almost) every port + enough disk space to build the ports you want. (Almost) every port is also provided as a pre-compiled “package” which can be installed with a simple command (pkg_add) by those who do not wish to compile their own ports from source. @@ -564,7 +564,7 @@ A number of additional documents which you may find very helpful in the process of installing and using FreeBSD may now also be found in the /usr/share/doc directory on any machine - running FreeBSD 2.1 or later. You may view the locally installed + running FreeBSD 2.1 or later. You may view the locally installed manuals with any HTML capable browser using the following URLs: @@ -593,12 +593,12 @@ URL="http://www.freebsd.org">http://www.freebsd.org. The core of FreeBSD does not contain DES code which would - inhibit its being exported outside the United States. There is an + inhibit its being exported outside the United States. There is an add-on package to the core distribution, for use only in the United - States, that contains the programs that normally use DES. The - auxiliary packages provided separately can be used by anyone. A + States, that contains the programs that normally use DES. The + auxiliary packages provided separately can be used by anyone. A freely (from outside the U.S.) exportable European distribution of - DES for our non-U.S. users also exists and is described in the + DES for our non-U.S. users also exists and is described in the FreeBSD FAQ. If password security for FreeBSD is all you need, and you have @@ -606,7 +606,7 @@ (Suns, DEC machines, etc) into FreeBSD password entries, then FreeBSD's MD5 based security may be all you require! We feel that our default security model is more than a match for DES, and without - any messy export issues to deal with. If you are outside (or even + any messy export issues to deal with. If you are outside (or even inside) the U.S., give it a try! diff --git a/en/handbook/kernelconfig/chapter.sgml b/en/handbook/kernelconfig/chapter.sgml index bfdf8592c9..30c999f236 100644 --- a/en/handbook/kernelconfig/chapter.sgml +++ b/en/handbook/kernelconfig/chapter.sgml @@ -5,7 +5,7 @@ 1995. This large section of the handbook discusses the basics of - building your own custom kernel for FreeBSD. This section is + building your own custom kernel for FreeBSD. This section is appropriate for both novice system administrators and those with advanced Unix experience. @@ -14,12 +14,12 @@ Why Build a Custom Kernel? Building a custom kernel is one of the most important rites of - passage every Unix system administrator must endure. This process, + passage every Unix system administrator must endure. This process, while time-consuming, will provide many benefits to your FreeBSD - system. Unlike the GENERIC kernel, which must support every + system. Unlike the GENERIC kernel, which must support every possible SCSI and network card, along with tons of other rarely used hardware support, a custom kernel only contains support for - your PC's hardware. This has a number of + your PC's hardware. This has a number of benefits: @@ -35,7 +35,7 @@ because the kernel is the one process which must always be present in memory, and so all of that unused code ties up pages of RAM that your programs would otherwise be able to - use. Therefore, on a system with limited RAM, building a + use. Therefore, on a system with limited RAM, building a custom kernel is of critical importance. @@ -57,14 +57,14 @@ First, let us take a quick tour of the kernel build directory. All directories mentioned will be relative to the main /usr/src/sys directory, which is also - accessible through /sys. There are a number of + accessible through /sys. There are a number of subdirectories here representing different parts of the kernel, but the most important, for our purposes, are i386/conf, where you will edit your custom kernel configuration, and compile, - which is the staging area where your kernel will be built. Notice + which is the staging area where your kernel will be built. Notice the logical organization of the directory tree, with each supported - device, filesystem, and option in its own subdirectory. Also, + device, filesystem, and option in its own subdirectory. Also, anything inside the i386 directory deals with PC hardware only, while everything outside the i386 directory is common to all platforms which @@ -73,7 +73,7 @@ If there is not a /usr/src/sys directory on your system, then - the kernel source has not been been installed. The easiest way + the kernel source has not been been installed. The easiest way to do this is by running /stand/sysinstall as root, choosing Configure, then Distributions, then src, @@ -82,7 +82,7 @@ Next, move to the i386/conf directory and copy the GENERIC configuration file to the name - you want to give your kernel. For example: + you want to give your kernel. For example: &prompt.root; cd /usr/src/sys/i386/conf @@ -92,7 +92,7 @@ Traditionally, this name is in all capital letters and, if you are maintaining multiple FreeBSD machines with different hardware, it is a good idea to name it after your - machine's hostname. We will call it MYKERNEL + machine's hostname. We will call it MYKERNEL for the purpose of this example. @@ -102,17 +102,17 @@ Now, edit MYKERNEL with your favorite text - editor. If you are just starting out, the only editor available + editor. If you are just starting out, the only editor available will probably be vi, which is too complex to explain here, but is covered well in many books in the bibliography. Feel free to change + linkend="bibliography">bibliography. Feel free to change the comment lines at the top to reflect your configuration or the changes you have made to differentiate it from GENERIC. If you have build a kernel under SunOS or some other BSD - operating system, much of this file will be very familiar to you. If + operating system, much of this file will be very familiar to you. If you are coming from some other operating system such as DOS, on the other hand, the GENERIC configuration file might seem overwhelming to you, so follow the descriptions in the @@ -123,9 +123,9 @@ If you are trying to upgrade your kernel from an older version of FreeBSD, you will probably have to get a new version of config8 from the same place you got the new - kernel sources. It is located in + kernel sources. It is located in /usr/src/usr.sbin, so you will need to - download those sources as well. Re-build and install it before + download those sources as well. Re-build and install it before running the next commands. @@ -142,8 +142,8 @@ The new kernel will be copied to the root directory as /kernel and the old kernel will be - moved to /kernel.old. Now, shutdown the system - and reboot to use your kernel. In case something goes wrong, there + moved to /kernel.old. Now, shutdown the system + and reboot to use your kernel. In case something goes wrong, there are some troubleshooting instructions at the end of this document. Be sure to read the section which explains how to recover in case your new kernel The Configuration File - The general format of a configuration file is quite simple. Each - line contains a keyword and one or more arguments. For simplicity, - most lines only contain one argument. Anything following a + The general format of a configuration file is quite simple. Each + line contains a keyword and one or more arguments. For simplicity, + most lines only contain one argument. Anything following a # is considered a comment and ignored. The following sections describe each keyword, generally in the order they are listed in GENERIC, although some @@ -174,21 +174,21 @@ An exhaustive list of options and more detailed explanations of the device lines is present in the LINT configuration file, located in the same - directory as GENERIC. If you are in doubt as to + directory as GENERIC. If you are in doubt as to the purpose or necessity of a line, check first in LINT. The kernel is currently being moved to a better organization of - the option handling. Traditionally, each option in the config file + the option handling. Traditionally, each option in the config file was simply converted into a switch for the - CFLAGS line of the kernel Makefile. Naturally, + CFLAGS line of the kernel Makefile. Naturally, this caused a creeping optionism, with nobody really knowing which option has been referenced in what files. In the new scheme, every #ifdef that is intended to be dependent upon an option gets this option out of an opt_foo.h - declaration file created in the compile directory by config. The list of valid options for + declaration file created in the compile directory by config. The list of valid options for config lives in two files: options that do not depend on the architecture are listed in /sys/conf/options, architecture-dependent ones @@ -248,7 +248,7 @@ different values of cpu_type as are present in the GENERIC kernel. For a custom kernel, it is best to specify only the cpu - you have. If, for example, you have an Intel Pentium, use + you have. If, for example, you have an Intel Pentium, use I586_CPU for cpu_type. @@ -257,15 +257,15 @@ Next, we have ident, - which is the identification of the kernel. You should + which is the identification of the kernel. You should change this from GENERIC to whatever you named your kernel, in this example, - MYKERNEL. The value you put in + MYKERNEL. The value you put in ident will print when you boot up the kernel, so it is useful to give a kernel a different name if you want to keep it separate from your usual kernel (if you want to build an experimental kernel, - for example). Note that, as with machine and + for example). Note that, as with machine and cpu, enclose your kernel's name in quotation marks if it contains any numbers. @@ -280,13 +280,13 @@ This file sets the size of a number of important - system tables. This number is supposed to be roughly + system tables. This number is supposed to be roughly equal to the number of simultaneous users you expect to - have on your machine. However, under normal + have on your machine. However, under normal circumstances, you will want to set maxusers to at least 4, especially if you are using the X Window System or - compiling software. The reason is that the most important + compiling software. The reason is that the most important table set by maxusers is the maximum number of processes, which is set to 20 + 16 * maxusers, so if you set @@ -294,11 +294,11 @@ can only have 36 simultaneous processes, including the 18 or so that the system starts up at boot time, and the 15 or so you will probably create when you start the X Window - System. Even a simple task like reading a man page will start up nine - processes to filter, decompress, and view it. Setting + System. Even a simple task like reading a man page will start up nine + processes to filter, decompress, and view it. Setting maxusers to 4 will allow you to have up to 84 simultaneous processes, which should be - enough for anyone. If, however, you see the dreaded + enough for anyone. If, however, you see the dreaded proc table full error when trying to start another program, or are running a server with a large number of simultaneous users (like Walnut Creek CDROM's FTP site), @@ -307,10 +307,10 @@ maxuser does not limit the number of users which - can log into your machine. It simply sets various table + can log into your machine. It simply sets various table sizes to reasonable values considering the maximum number of users you will likely have on your system and - how many processes each of them will be running. One + how many processes each of them will be running. One keyword which does limit the number of simultaneous remote logins is This line specifies the location and name of the - kernel. Traditionally the kernel is called + kernel. Traditionally the kernel is called vmunix but in FreeBSD, it is aptly - named kernel. You should always use + named kernel. You should always use kernel for kernel_name because changing it will - render numerous system utilities inoperative. The second + render numerous system utilities inoperative. The second part of the line specifies the disk and partition where - the root filesystem and kernel can be found. Typically + the root filesystem and kernel can be found. Typically this will be wd0 for systems with non-SCSI drives, or sd0 for systems with SCSI drives. @@ -355,14 +355,14 @@ This line allows the kernel to simulate a math co-processor if your computer does not have one (386 or - 486SX). If you have a Pentium, a 486DX, or a 386 or 486SX + 486SX). If you have a Pentium, a 486DX, or a 386 or 486SX with a separate 387 or 487 chip, you can comment this line out. The normal math co-processor emulation routines that come with FreeBSD are not very - accurate. If you do not have a math co-processor, and + accurate. If you do not have a math co-processor, and you need the best accuracy, I recommend that you change this option to GPL_MATH_EMULATE to use the superior GNU math support, which is not included by @@ -374,7 +374,7 @@ options "COMPAT_43" - Compatibility with 4.3BSD. Leave this in; some + Compatibility with 4.3BSD. Leave this in; some programs will act strangely if you comment this out. @@ -385,7 +385,7 @@ ISA devices and EISA devices operating in an ISA compatibility mode can only perform DMA (Direct Memory - Access) to memory below 16 megabytes. This option enables + Access) to memory below 16 megabytes. This option enables such devices to work in systems with more than 16 megabytes of memory. @@ -405,11 +405,11 @@ options SYSVSHM - This option provides for System V shared memory. The + This option provides for System V shared memory. The most common use of this is the XSHM extension in X Windows, which many graphics-intensive programs (such as the movie player XAnim, and Linux DOOM) will automatically - take advantage of for extra speed. If you use the X + take advantage of for extra speed. If you use the X Window System, you will definitely want to include this. @@ -418,7 +418,7 @@ options SYSVSEM - Support for System V semaphores. Less commonly used + Support for System V semaphores. Less commonly used but only adds a few hundred bytes to the kernel. @@ -426,7 +426,7 @@ options SYSVMSG - Support for System V messages. Again, only adds a few + Support for System V messages. Again, only adds a few hundred bytes to the kernel. @@ -444,7 +444,7 @@ Filesystem Options - These options add support for various filesystems. You must + These options add support for various filesystems. You must include at least one of these to support the device you boot from; typically this will be FFS if you boot from a hard drive, or NFS if you are booting a @@ -467,7 +467,7 @@ options NFS - Network Filesystem. Unless you plan to mount + Network Filesystem. Unless you plan to mount partitions from a Unix file server over Ethernet, you can comment this out. @@ -476,11 +476,11 @@ options MSDOSFS - MS-DOS Filesystem. Unless you plan to mount a DOS + MS-DOS Filesystem. Unless you plan to mount a DOS formatted hard drive partition at boot time, you can - safely comment this out. It will be automatically loaded + safely comment this out. It will be automatically loaded the first time you mount a DOS partition, as described - above. Also, the excellent mtools software (in the ports + above. Also, the excellent mtools software (in the ports collection) allows you to access DOS floppies without having to mount and unmount them (and does not require MSDOSFS at all). @@ -490,10 +490,10 @@ options "CD9660" - ISO 9660 filesystem for CD-ROMs. Comment it out if + ISO 9660 filesystem for CD-ROMs. Comment it out if you do not have a CD-ROM drive or only mount data CD's occasionally (since it will be dynamically loaded the - first time you mount a data CD). Audio CD's do not need + first time you mount a data CD). Audio CD's do not need this filesystem. @@ -501,7 +501,7 @@ options PROCFS - Process filesystem. This is a pretend filesystem + Process filesystem. This is a pretend filesystem mounted on /proc which allows programs like ps1 to give you more information on what processes are running. @@ -511,12 +511,12 @@ options MFS - Memory-mapped file system. This is basically a RAM + Memory-mapped file system. This is basically a RAM disk for fast storage of temporary files, useful if you have a lot of swap space that you want to take advantage - of. A perfect place to mount an MFS partition is on the + of. A perfect place to mount an MFS partition is on the /tmp directory, since many programs - store temporary data here. To mount an MFS RAM disk on + store temporary data here. To mount an MFS RAM disk on /tmp, add the following line to /etc/fstab and then reboot or type mount /tmp: @@ -547,8 +547,8 @@ options "EXT2FS" - Linux's native file system. With ext2fs support you - are able to read and write to Linux partitions. This is + Linux's native file system. With ext2fs support you + are able to read and write to Linux partitions. This is useful if you dual-boot FreeBSD and Linux and want to share data between the two systems. @@ -557,10 +557,10 @@ options QUOTA - Enable disk quotas. If you have a public access + Enable disk quotas. If you have a public access system, and do not want users to be able to overflow the /home partition, you can establish - disk quotas for each user. Refer to the + disk quotas for each user. Refer to the Disk Quotas section for more information. @@ -574,7 +574,7 @@ Basic Controllers and Devices These sections describe the basic disk, tape, and CD-ROM - controllers supported by FreeBSD. There are separate sections for + controllers supported by FreeBSD. There are separate sections for SCSI controllers and network cards. @@ -582,7 +582,7 @@ controller isa0 - All PC's supported by FreeBSD have one of these. If + All PC's supported by FreeBSD have one of these. If you have an IBM PS/2 (Micro Channel Architecture), then you cannot run FreeBSD at this time. @@ -591,7 +591,7 @@ controller pci0 - Include this if you have a PCI motherboard. This + Include this if you have a PCI motherboard. This enables auto-detection of PCI cards and gatewaying from the PCI to the ISA bus. @@ -604,7 +604,7 @@ A: floppy drive, and fd1 is the B: drive. ft0 is a QIC-80 tape drive - attached to the floppy controller. Comment out any lines + attached to the floppy controller. Comment out any lines corresponding to devices you do not have. @@ -618,10 +618,10 @@ controller wdc0 - This is the primary IDE controller. wd0 and wd1 are the master and slave hard - drive, respectively. wdc1 is + This is the primary IDE controller. wd0 and wd1 are the master and slave hard + drive, respectively. wdc1 is a secondary IDE controller where you might have a third or - fourth hard drive, or an IDE CD-ROM. Comment out the + fourth hard drive, or an IDE CD-ROM. Comment out the lines which do not apply (if you have a SCSI hard drive, you will probably want to comment out all six lines, for example). @@ -631,11 +631,11 @@ device wcd0 - This device provides IDE CD-ROM support. Be sure to + This device provides IDE CD-ROM support. Be sure to leave wdc0 uncommented, and wdc1 if you have more than one IDE controller and your CD-ROM is on the second one - card. To use this, you must also include the line + card. To use this, you must also include the line options ATAPI. @@ -646,7 +646,7 @@ npx0 is the interface to the floating point math unit in FreeBSD, either the - hardware co-processor or the software math emulator. It + hardware co-processor or the software math emulator. It is not optional. @@ -664,10 +664,10 @@ The following drivers are for the so-called - proprietary CD-ROM drives. These + proprietary CD-ROM drives. These drives have their own controller card or might plug into a - sound card such as the SoundBlaster 16. They are - not IDE or SCSI. Most older + sound card such as the SoundBlaster 16. They are + not IDE or SCSI. Most older single-speed and double-speed CD-ROMs use these interfaces, while newer quad-speeds are likely to be IDE or SCSI Controllers The next ten or so lines include support for different - kinds of SCSI controllers. Comment out all except for the + kinds of SCSI controllers. Comment out all except for the one(s) you have: @@ -812,10 +812,10 @@ This causes the kernel to pause 15 seconds before - probing each SCSI device in your system. If you only have + probing each SCSI device in your system. If you only have IDE hard drives, you can ignore this, otherwise you will probably want to lower this number, perhaps to 5 seconds, - to speed up booting. Of course if you do this, and + to speed up booting. Of course if you do this, and FreeBSD has trouble recognizing your SCSI devices, you will have to raise it back up. @@ -825,7 +825,7 @@ If you have any SCSI controllers, this line provides - generic SCSI support. If you do not have SCSI, you can + generic SCSI support. If you do not have SCSI, you can comment this, and the following three lines, out. @@ -879,11 +879,11 @@ vector scintr sc0 is the default - console driver, which resembles an SCO console. Since most + console driver, which resembles an SCO console. Since most full-screen programs access the console through a terminal database library like termcap, it should not matter much whether you use this or vt0, the VT220 compatible console - driver. When you log in, set your TERM variable to + driver. When you log in, set your TERM variable to “scoansi” if full-screen programs have trouble running under this console. @@ -894,9 +894,9 @@ This is a VT220-compatible console driver, backwards - compatible to VT100/102. It works well on some laptops - which have hardware incompatibilities with sc0. Also, set your TERM variable - to vt100 or vt220 when you log in. This driver + compatible to VT100/102. It works well on some laptops + which have hardware incompatibilities with sc0. Also, set your TERM variable + to vt100 or vt220 when you log in. This driver might also prove useful when connecting to a large number of different machines over the network, where the termcap or @@ -915,7 +915,7 @@ options XSERVER - Only applicable with the vt0 console driver. This + Only applicable with the vt0 console driver. This includes code required to run the XFree86 X Window Server under the vt0 console driver. @@ -958,8 +958,8 @@ Serial and Parallel Ports - Nearly all systems have these. If you are attaching a printer - to one of these ports, the Printing section of the handbook is very useful. If + Nearly all systems have these. If you are attaching a printer + to one of these ports, the Printing section of the handbook is very useful. If you are using modem, Dialup access provides extensive detail on serial port configuration for use with such devices. @@ -973,10 +973,10 @@ Note that if you have an internal modem on COM4 and a serial port at COM2 you will have to change the IRQ of the modem to 2 (for obscure technical reasons IRQ 2 = IRQ 9) - in order to access it from FreeBSD. If you have a + in order to access it from FreeBSD. If you have a multiport serial card, check the manual page for sio4 for more information on the - proper values for these lines. Some video cards (notably + proper values for these lines. Some video cards (notably those based on S3 chips) use IO addresses of the form 0x*2e8, and since many cheap serial cards do not fully decode the 16-bit IO address space, @@ -995,7 +995,7 @@ lpt0 through lpt2 are the three printer ports you - could conceivably have. Most people just have one, + could conceivably have. Most people just have one, though, so feel free to comment out the other two lines if you do not have them. @@ -1009,7 +1009,7 @@ Networking FreeBSD, as with Unix in general, places a - big emphasis on networking. Therefore, even + big emphasis on networking. Therefore, even if you do not have an Ethernet card, pay attention to the mandatory options and the dial-up networking support. @@ -1017,9 +1017,9 @@ options INET - Networking support. Leave it in even if you do not - plan to be connected to a network. Most programs require - at least loopback networking (i.e. making network + Networking support. Leave it in even if you do not + plan to be connected to a network. Most programs require + at least loopback networking (i.e. making network connections within your PC) so this is essentially mandatory. @@ -1029,8 +1029,8 @@ The next lines enable support for various Ethernet - cards. If you do not have a network card, you can comment - out all of these lines. Otherwise, you will want to leave + cards. If you do not have a network card, you can comment + out all of these lines. Otherwise, you will want to leave in support for your particular Ethernet card(s): @@ -1181,9 +1181,9 @@ loop is the generic - loopback device for TCP/IP. If you telnet or FTP to - localhost (a.k.a. 127.0.0.1) it will come back at you - through this pseudo-device. Mandatory. + loopback device for TCP/IP. If you telnet or FTP to + localhost (a.k.a. 127.0.0.1) it will come back at you + through this pseudo-device. Mandatory. @@ -1201,12 +1201,12 @@ sl is for SLIP (Serial - Line Internet Protocol) support. This has been almost + Line Internet Protocol) support. This has been almost entirely supplanted by PPP, which is easier to set up, better suited for modem-to-modem connections, as well as - more powerful. The number after + more powerful. The number after sl specifies how many - simultaneous SLIP sessions to support. This handbook has + simultaneous SLIP sessions to support. This handbook has more information on setting up a SLIP client or server. @@ -1218,11 +1218,11 @@ ppp is for kernel-mode PPP (Point-to-Point Protocol) support for dial-up Internet - connections. There is also version of PPP implemented as a + connections. There is also version of PPP implemented as a user application that uses the tun and offers more flexibility and - features such as demand dialing. If you still want to use + features such as demand dialing. If you still want to use this PPP driver, read the kernel-mode PPP - section of the handbook. As with the sl device, + section of the handbook. As with the sl device, number specifies how many simultaneous PPP connections to support. @@ -1233,10 +1233,10 @@ tun is used by the - user-mode PPP software. This program is easy to set up and - very fast. It also has special features such as automatic - dial-on-demand. The number after tun specifies the number of - simultaneous PPP sessions to support. See the tun specifies the number of + simultaneous PPP sessions to support. See the user-mode PPP section of the handbook for more information. @@ -1246,17 +1246,17 @@ number - Berkeley packet filter. This pseudo-device allows + Berkeley packet filter. This pseudo-device allows network interfaces to be placed in promiscuous mode, - capturing every packet on a broadcast network (e.g. an - ethernet). These packets can be captured to disk and/or + capturing every packet on a broadcast network (e.g. an + ethernet). These packets can be captured to disk and/or examined with the tcpdump1 program. Note that implementation of this capability can seriously - compromise your overall network security. The + compromise your overall network security. The number after bpfilter is the number of interfaces that can be examined simultaneously. Optional, not recommended except for those who are fully - aware of the potential pitfalls. Not all network cards + aware of the potential pitfalls. Not all network cards support this capability. @@ -1269,7 +1269,7 @@ Sound cards This is the first section containing lines that are not in the - GENERIC kernel. To include sound card support, you will have to + GENERIC kernel. To include sound card support, you will have to copy the appropriate lines from the LINT kernel (which contains support for every device) as follows: @@ -1277,7 +1277,7 @@ controller snd0 - Generic sound driver code. Required for all of the + Generic sound driver code. Required for all of the following sound cards except pca. @@ -1324,7 +1324,7 @@ device sbmidi0 at isa? port 0x330 - SoundBlaster 16 MIDI interface. If you have a + SoundBlaster 16 MIDI interface. If you have a SoundBlaster 16, you must include this line, or the kernel will not compile. @@ -1350,7 +1350,7 @@ conflicts - AdLib FM-synthesis audio. Include this line for + AdLib FM-synthesis audio. Include this line for AdLib, SoundBlaster, and ProAudioSpectrum users, if you want to play MIDI songs with a program such as playmidi (in the ports collection). @@ -1377,7 +1377,7 @@ tty - Digital audio through PC speaker. This is going to be + Digital audio through PC speaker. This is going to be very poor sound quality and quite CPU-intensive, so you have been warned (but it does not require a sound card). @@ -1400,7 +1400,7 @@ Pseudo-device drivers are parts of the kernel that act like device drivers but do not correspond to any actual hardware in the - machine. The network-related pseudo-devices are in that section, + machine. The network-related pseudo-devices are in that section, while the remainder are here. @@ -1408,7 +1408,7 @@ pseudo-device gzip gzip allows you to run - FreeBSD programs that have been compressed with gzip. The programs in + FreeBSD programs that have been compressed with gzip. The programs in /stand are compressed so it is a good idea to have this option in your kernel. @@ -1418,7 +1418,7 @@ log is used for logging - of kernel error messages. Mandatory. + of kernel error messages. Mandatory. @@ -1427,12 +1427,12 @@ pty is a - “pseudo-terminal” or simulated login port. It is used + “pseudo-terminal” or simulated login port. It is used by incoming telnet and rlogin sessions, xterm, and - some other applications such as emacs. The + some other applications such as emacs. The number indicates the number of - ptys to create. If you need + ptys to create. If you need more than GENERIC default of 16 simultaneous xterm windows and/or remote logins, be sure to increase this number accordingly, up to a maximum of 256. @@ -1443,24 +1443,24 @@ number - Snoop device. This pseudo-device allows one terminal + Snoop device. This pseudo-device allows one terminal session to watch another using the - watch8 command. Note that + watch8 command. Note that implementation of this capability has important security - and privacy implications. The number + and privacy implications. The number after snp is the total number of simultaneous snoop - sessions. Optional. + sessions. Optional. pseudo-device vn - Vnode driver. Allows a file to be treated as a device + Vnode driver. Allows a file to be treated as a device after being set up with the vnconfig8 - command. This driver can be useful for manipulating + command. This driver can be useful for manipulating floppy disk images and using a file as a swap device (e.g. - an MS Windows swap file). Optional. + an MS Windows swap file). Optional. @@ -1468,12 +1468,12 @@ number - Concatenated disks. This pseudo-device allows you to + Concatenated disks. This pseudo-device allows you to concatenate multiple disk partitions into one large - “meta”-disk. The number after ccd + “meta”-disk. The number after ccd is the total number of concatenated disks (not total number of disks that can be concatenated) that can be - created. (See ccd4 and + created. (See ccd4 and ccdconfig8 man pages for more details.) Optional. @@ -1487,7 +1487,7 @@ Joystick, PC Speaker, Miscellaneous This section describes some miscellaneous hardware devices - supported by FreeBSD. Note that none of these lines are included + supported by FreeBSD. Note that none of these lines are included in the GENERIC kernel, you will have to copy them from this handbook or the LINT kernel (which contains support for every device): @@ -1504,13 +1504,13 @@ Supports IBM BASIC-style noises through the PC - speaker. Some fun programs which use this are + speaker. Some fun programs which use this are /usr/sbin/spkrtest, which is a shell script that plays some simple songs, and /usr/games/piano which lets you play songs using the keyboard as a simple piano (this file only exists if you have installed the - games package). Also, the excellent + games package). Also, the excellent text role-playing game NetHack (in the ports collection) can be configured to use this device to play songs when you play musical instruments in the game. @@ -1528,17 +1528,17 @@ Making Device Nodes Almost every device in the kernel has a corresponding “node” - entry in the /dev directory. These nodes look + entry in the /dev directory. These nodes look like regular files, but are actually special entries into the kernel - which programs use to access the device. The shell script + which programs use to access the device. The shell script /dev/MAKEDEV, which is executed when you first install the operating system, creates nearly all of the device nodes - supported. However, it does not create all of + supported. However, it does not create all of them, so when you add support for a new device, it pays to make sure that the appropriate entries are in this directory, and if not, add - them. Here is a simple example: + them. Here is a simple example: - Suppose you add the IDE CD-ROM support to the kernel. The line + Suppose you add the IDE CD-ROM support to the kernel. The line to add is: @@ -1548,7 +1548,7 @@ controller wcd0 that start with wcd0 in the /dev directory, possibly followed by a letter, such as c, or preceded by the letter r, which means a “raw” - device. It turns out that those files are not there, so I must + device. It turns out that those files are not there, so I must change to the /dev directory and type: @@ -1569,7 +1569,7 @@ controller wcd0 When creating device nodes for devices such as sound cards, if other people have access to your machine, it may be desirable to protect the devices from outside access by adding them to the - /etc/fbtab file. See man + /etc/fbtab file. See man fbtab for more information. @@ -1579,7 +1579,7 @@ controller wcd0 All SCSI controllers use the same set of /dev entries, so you do not need to create - these. Also, network cards and SLIP/PPP pseudo-devices do not + these. Also, network cards and SLIP/PPP pseudo-devices do not have entries in /dev at all, so you do not have to worry about these either. @@ -1590,7 +1590,7 @@ controller wcd0 If Something Goes Wrong There are four categories of trouble that can occur when - building a custom kernel. They are: + building a custom kernel. They are: @@ -1598,10 +1598,10 @@ controller wcd0 If the config command fails when you give it your kernel description, you have - probably made a simple error somewhere. Fortunately, + probably made a simple error somewhere. Fortunately, config will print the line number that it had trouble with, so you can quickly skip to - it with vi. For example, if + it with vi. For example, if you see: @@ -1618,7 +1618,7 @@ controller wcd0 If the make command fails, it usually signals an error in your kernel description, but not severe enough for config - to catch it. Again, look over your configuration, and if + to catch it. Again, look over your configuration, and if you still cannot resolve the problem, send mail to the &a.questions; with your kernel configuration, and it should be diagnosed very quickly. @@ -1631,17 +1631,17 @@ controller wcd0 If your new kernel does not boot, or fails to recognize your devices, do not panic! Fortunately, BSD has an excellent mechanism for recovering from incompatible - kernels. Simply type the name of the kernel you want to boot + kernels. Simply type the name of the kernel you want to boot from (i.e. kernel.old) at the FreeBSD boot prompt - instead of pressing return. When reconfiguring a kernel, it + instead of pressing return. When reconfiguring a kernel, it is always a good idea to keep a kernel that is known to work on hand. After booting with a good kernel you can check over your - configuration file and try to build it again. One helpful + configuration file and try to build it again. One helpful resource is the /var/log/messages file which records, among other things, all of the kernel - messages from every successful boot. Also, the + messages from every successful boot. Also, the dmesg8 command will print the kernel messages from the current boot. @@ -1649,14 +1649,14 @@ controller wcd0 If you are having trouble building a kernel, make sure to keep a GENERIC, or some other kernel that is known to work on hand as a different name that will not get erased - on the next build. You cannot rely on + on the next build. You cannot rely on kernel.old because when installing a new kernel, kernel.old is overwritten with the last installed kernel which may be - non-functional. Also, as soon as possible, move the + non-functional. Also, as soon as possible, move the working kernel to the proper kernel location or commands such as ps1 will not work - properly. The proper command to “unlock” the + properly. The proper command to “unlock” the kernel file that make installs (in order to move another kernel back permanently) is: @@ -1684,8 +1684,8 @@ controller wcd0 for example, an experimental “2.2.0” kernel on a 2.1.0-RELEASE system, many system-status commands like ps1 and vmstat8 - will not work any more. You must recompile the libkvm library as well as these - utilities. This is one reason it is not normally a good + will not work any more. You must recompile the libkvm library as well as these + utilities. This is one reason it is not normally a good idea to use a different version of the kernel from the rest of the operating system. diff --git a/en/handbook/kerneldebug/chapter.sgml b/en/handbook/kerneldebug/chapter.sgml index 2507290ae1..c7e43305ab 100644 --- a/en/handbook/kerneldebug/chapter.sgml +++ b/en/handbook/kerneldebug/chapter.sgml @@ -8,48 +8,48 @@ Debugging a Kernel Crash Dump with <command>kgdb</command> Here are some instructions for getting kernel debugging working - on a crash dump. They assume that you have enough swap space for a - crash dump. If you have multiple swap partitions and the first one + on a crash dump. They assume that you have enough swap space for a + crash dump. If you have multiple swap partitions and the first one is too small to hold the dump, you can configure your kernel to use an alternate dump device (in the config kernel line), or you can specify an alternate using the - dumpon8 command. The best way to use + dumpon8 command. The best way to use dumpon 8 is to set the dumpdev variable in - /etc/rc.conf. Typically you want to specify one of + /etc/rc.conf. Typically you want to specify one of the swap devices specified in /etc/fstab. Dumps to non-swap devices, tapes for example, - are currently not supported. Config your kernel using - config -g. See Kernel + are currently not supported. Config your kernel using + config -g. See Kernel Configuration for details on configuring the FreeBSD kernel. Use the dumpon8 command to tell the kernel where to dump to (note that this will have to be done after configuring the partition in question as swap space via - swapon8). This is normally arranged via + swapon8). This is normally arranged via /etc/rc.conf and /etc/rc. Alternatively, you can hard-code the dump device via the dump - clause in the config line of your kernel config file. This is + clause in the config line of your kernel config file. This is deprecated and should be used only if you want a crash dump from a kernel that crashes during booting. In the following, the term kgdb refers to - gdb run in “kernel debug mode”. This can be + gdb run in “kernel debug mode”. This can be accomplished by either starting the gdb with the option , or by linking and starting it - under the name kgdb. This is not being done by + under the name kgdb. This is not being done by default, however, and the idea is basically deprecated since the GNU folks do not like their tools to behave differently when - called by another name. This feature may well be discontinued in + called by another name. This feature may well be discontinued in further releases. When the kernel has been built make a copy of it, say kernel.debug, and then run strip - -d on the original. Install the original as normal. You + -d on the original. Install the original as normal. You may also install the unstripped kernel, but symbol table lookup time for some programs will drastically increase, and since the whole kernel is loaded entirely at boot time and cannot be swapped out @@ -69,13 +69,13 @@ Dumps to non-swap devices, tapes for example, This instructs savecore8 to - use another kernel for symbol name extraction. It would otherwise + use another kernel for symbol name extraction. It would otherwise default to the currently running kernel and most likely not do anything at all since the crash dump and the kernel symbols differ. Now, after a crash dump, go to - /sys/compile/WHATEVER and run kgdb. From kgdb + /sys/compile/WHATEVER and run kgdb. From kgdb do: @@ -88,7 +88,7 @@ Dumps to non-swap devices, tapes for example, kernel sources just like you can for any other program. Here is a script log of a kgdb - session illustrating the procedure. Long lines have been folded to + session illustrating the procedure. Long lines have been folded to improve readability, and the lines are numbered for reference. Despite this, it is a real-world error trace taken during the development of the pcvt console driver. @@ -203,8 +203,8 @@ Dumps to non-swap devices, tapes for example, Force usage of a new stack frame; this is no longer - necessary now. The stack frames are supposed to point to - the right locations now, even in case of a trap. (I do not + necessary now. The stack frames are supposed to point to + the right locations now, even in case of a trap. (I do not have a new core dump handy <g>, my kernel has not panicked for a rather long time.) From looking at the code in source line 403, there is a high probability that either @@ -243,9 +243,9 @@ Dumps to non-swap devices, tapes for example, Debugging a crash dump with DDD Examining a kernel crash dump with a graphical debugger like - ddd is also possible. Add the + ddd is also possible. Add the option to the ddd command line you would use - normally. For example; + normally. For example; &prompt.root; ddd -k /var/crash/kernel.0 /var/crash/vmcore.0 @@ -260,32 +260,32 @@ Dumps to non-swap devices, tapes for example, What do you do if a kernel dumped core but you did not expect it, and it is therefore not compiled using config - -g? Not everything is lost here. Do not panic! + -g? Not everything is lost here. Do not panic! - Of course, you still need to enable crash dumps. See above on + Of course, you still need to enable crash dumps. See above on the options you have to specify in order to do this. Go to your kernel compile directory, and edit the line - containing COPTFLAGS?=-O. Add the + containing COPTFLAGS?=-O. Add the option there (but do not - change anything on the level of optimization). If you do already + change anything on the level of optimization). If you do already know roughly the probable location of the failing piece of code (e.g., the pcvt driver in the example - above), remove all the object files for this code. Rebuild the - kernel. Due to the time stamp change on the Makefile, there will be + above), remove all the object files for this code. Rebuild the + kernel. Due to the time stamp change on the Makefile, there will be some other object files rebuild, for example - trap.o. With a bit of luck, the added + trap.o. With a bit of luck, the added option will not change anything for the generated code, so you will finally get a new kernel with similar - code to the faulting one but some debugging symbols. You should at + code to the faulting one but some debugging symbols. You should at least verify the old and new sizes with the - size1 command. If there is a mismatch, you + size1 command. If there is a mismatch, you probably need to give up here. - Go and examine the dump as described above. The debugging + Go and examine the dump as described above. The debugging symbols might be incomplete for some places, as can be seen in the stack trace in the example above where some functions are displayed - without line numbers and argument lists. If you need more debugging + without line numbers and argument lists. If you need more debugging symbols, remove the appropriate object files and repeat the kgdb session until you know enough. @@ -300,52 +300,52 @@ Dumps to non-swap devices, tapes for example, While kgdb as an offline debugger provides a very high level of user interface, there are some things - it cannot do. The most important ones being breakpointing and + it cannot do. The most important ones being breakpointing and single-stepping kernel code. If you need to do low-level debugging on your kernel, there is - an on-line debugger available called DDB. It allows to setting + an on-line debugger available called DDB. It allows to setting breakpoints, single-steping kernel functions, examining and changing - kernel variables, etc. However, it cannot access kernel source + kernel variables, etc. However, it cannot access kernel source files, and only has access to the global and static symbols, not to the full debug information like kgdb. To configure your kernel to include DDB, add the option line -options DDB to your config file, and rebuild. (See to your config file, and rebuild. (See Kernel Configuration for details on configuring the FreeBSD kernel. Note that if you have an older version of the boot blocks, - your debugger symbols might not be loaded at all. Update the boot + your debugger symbols might not be loaded at all. Update the boot blocks; the recent ones load the DDB symbols automagically.) Once your DDB kernel is running, there are several ways to enter - DDB. The first, and earliest way is to type the boot flag - right at the boot prompt. The kernel will start - up in debug mode and enter DDB prior to any device probing. Hence + DDB. The first, and earliest way is to type the boot flag + right at the boot prompt. The kernel will start + up in debug mode and enter DDB prior to any device probing. Hence you can even debug the device probe/attach functions. The second scenario is a hot-key on the keyboard, usually - Ctrl-Alt-ESC. For syscons, this can be remapped; some of the - distributed maps do this, so watch out. There is an option available + Ctrl-Alt-ESC. For syscons, this can be remapped; some of the + distributed maps do this, so watch out. There is an option available for serial consoles that allows the use of a serial line BREAK on the console line to enter DDB (options - BREAK_TO_DEBUGGER in the kernel config file). It is + BREAK_TO_DEBUGGER in the kernel config file). It is not the default since there are a lot of crappy serial adapters around that gratuitously generate a BREAK condition, for example when pulling the cable. The third way is that any panic condition will branch to DDB if - the kernel is configured to use it. For this reason, it is not + the kernel is configured to use it. For this reason, it is not wise to configure a kernel with DDB for a machine running unattended. - The DDB commands roughly resemble some gdb commands. The first thing you probably + The DDB commands roughly resemble some gdb commands. The first thing you probably need to do is to set a breakpoint: @@ -356,7 +356,7 @@ options DDB to your config file, and rebuild. (See Numbers are taken hexadecimal by default, but to make them distinct from symbol names; hexadecimal numbers starting with the letters a-f need to be preceded with - 0x (this is optional for other numbers). Simple + 0x (this is optional for other numbers). Simple expressions are allowed, for example: function-name + 0x103. @@ -386,7 +386,7 @@ options DDB to your config file, and rebuild. (See The first form will be accepted immediately after - a breakpoint hit, and deletes the current breakpoint. The second + a breakpoint hit, and deletes the current breakpoint. The second form can remove any breakpoint, but you need to specify the exact address; this can be obtained from: @@ -422,8 +422,8 @@ options DDB to your config file, and rebuild. (See @@ -487,9 +487,9 @@ options DDB to your config file, and rebuild. (See Now you have now examined why your kernel failed, and you wish - to reboot. Remember that, depending on the severity of previous + to reboot. Remember that, depending on the severity of previous malfunctioning, not all parts of the kernel might still be working - as expected. Perform one of the following actions to shut down and + as expected. Perform one of the following actions to shut down and reboot your system: @@ -497,8 +497,8 @@ options DDB to your config file, and rebuild. (See This will cause your kernel to dump core and reboot, so you can - later analyze the core on a higher level with kgdb. This command - usually must be followed by another continue statement. There is now an alias for + later analyze the core on a higher level with kgdb. This command + usually must be followed by another continue statement. There is now an alias for this: panic. @@ -507,7 +507,7 @@ options DDB to your config file, and rebuild. (See Which might be a good way to cleanly shut down the running system, sync() all disks, and finally - reboot. As long as the disk and file system interfaces of the + reboot. As long as the disk and file system interfaces of the kernel are not damaged, this might be a good way for an almost clean shutdown. @@ -526,7 +526,7 @@ options DDB to your config file, and rebuild. (See However, it is highly recommended to have a printed copy of the ddb4 manual page - ready for a debugging session. Remember that it is hard to read the + ready for a debugging session. Remember that it is hard to read the on-line manual while single-stepping the kernel. @@ -538,9 +538,9 @@ options DDB to your config file, and rebuild. (See GDB has already supported remote debugging - for a long time. This is done using a very simple protocol along a - serial line. Unlike the other methods described above, you will - need two machines for doing this. One is the host providing the + for a long time. This is done using a very simple protocol along a + serial line. Unlike the other methods described above, you will + need two machines for doing this. One is the host providing the debugging environment, including all the sources, and a copy of the kernel binary with all the symbols in it, and the other one is the target machine that simply runs a similar copy of the very same @@ -548,12 +548,12 @@ options DDB to your config file, and rebuild. (See You should configure the kernel in question with config -g, include into the - configuration, and compile it as usual. This gives a large blurb of - a binary, due to the debugging information. Copy this kernel to the + configuration, and compile it as usual. This gives a large blurb of + a binary, due to the debugging information. Copy this kernel to the target machine, strip the debugging symbols off with strip -x, and boot it using the boot - option. Connect the first serial line of the target machine to any - serial line of the debugging host. Now, on the debugging machine, + option. Connect the first serial line of the target machine to any + serial line of the debugging host. Now, on the debugging machine, go to the compile directory of the target kernel, and start gdb: @@ -589,8 +589,8 @@ Stopped at Debugger+0x35: movb $0, edata+0x51bc Every time you type gdb, the mode will be toggled between - remote GDB and local DDB. In order to force a next trap - immediately, simply type s (step). Your hosting GDB will now + remote GDB and local DDB. In order to force a next trap + immediately, simply type s (step). Your hosting GDB will now gain control over the target kernel: @@ -605,7 +605,7 @@ Debugger (msg=0xf01b0383 "Boot flags requested debugger") an Emacs window (which gives you an automatic source code display in another Emacs window) etc. - Remote GDB can also be used to debug LKMs. First build the LKM + Remote GDB can also be used to debug LKMs. First build the LKM with debugging symbols: @@ -625,8 +625,8 @@ EXEC 0 4 f5109000 001c f510f010 1 linux_mod Take the load address of the module and add 0x20 (probably to - account for the a.out header). This is the address that the module - code was relocated to. Use the add-symbol-file command in GDB to tell the + account for the a.out header). This is the address that the module + code was relocated to. Use the add-symbol-file command in GDB to tell the debugger about the module: @@ -644,10 +644,10 @@ text_addr = 0xf5109020? (y or n) y Debugging a Console Driver Since you need a console driver to run DDB on, things are more - complicated if the console driver itself is failing. You might + complicated if the console driver itself is failing. You might remember the use of a serial console (either with modified boot blocks, or by specifying at the Boot: prompt), and hook up a standard terminal - onto your first serial port. DDB works on any configured console + onto your first serial port. DDB works on any configured console driver, of course also on a serial console. diff --git a/en/handbook/kernelopts/chapter.sgml b/en/handbook/kernelopts/chapter.sgml index 4b494b6c43..bb648cd468 100644 --- a/en/handbook/kernelopts/chapter.sgml +++ b/en/handbook/kernelopts/chapter.sgml @@ -14,23 +14,23 @@ The use of kernel options is basically described in the kernel configuration - section. There's also an explanation of “historic” and - “new-style” options. The ultimate goal is to eventually turn all + section. There's also an explanation of “historic” and + “new-style” options. The ultimate goal is to eventually turn all the supported options in the kernel into new-style ones, so for people who correctly did a make depend in their kernel compile directory after running config8, the build process will automatically pick up modified options, and only recompile those files where it is - necessary. Wiping out the old compile directory on each run of + necessary. Wiping out the old compile directory on each run of config8 as it is still done now can then be eliminated again. Basically, a kernel option is nothing else than the definition - of a C preprocessor macro for the kernel compilation process. To + of a C preprocessor macro for the kernel compilation process. To make the build truly optional, the corresponding part of the kernel source (or kernel .h file) must be written with the option concept in mind, i.e. the default must have been made - overridable by the config option. This is usually done with + overridable by the config option. This is usually done with something like: @@ -40,7 +40,7 @@ This way, an administrator mentioning another value for the option in his config file will take the default out of effect, and - replace it with his new value. Clearly, the new value will be + replace it with his new value. Clearly, the new value will be substituted into the source code during the preprocessor run, so it must be a valid C expression in whatever context the default value would have been used. @@ -63,32 +63,32 @@ People familiar with the C language will immediately recognize that everything could be counted as a “config option” where there is at least a single #ifdef - referencing it... However, it's unlikely that many people would + referencing it... However, it's unlikely that many people would put options notyet,notdef in their config file, and then wonder why the kernel compilation - falls over. :-) + falls over. :-) Clearly, using arbitrary names for the options makes it very - hard to track their usage throughout the kernel source tree. That + hard to track their usage throughout the kernel source tree. That is the rationale behind the new-style option scheme, where each option goes into a separate .h file in the kernel compile directory, which is by convention named - opt_foo.h. This way, + opt_foo.h. This way, the usual Makefile dependencies could be applied, and make can determine what needs to be recompiled once an option has been changed. The old-style option mechanism still has one advantage for local options or maybe experimental options that have a short anticipated lifetime: since it is easy to add a new #ifdef to the kernel source, this has already - made it a kernel config option. In this case, the administrator + made it a kernel config option. In this case, the administrator using such an option is responsible himself for knowing about its implications (and maybe manually forcing the recompilation of parts - of his kernel). Once the transition of all supported options has + of his kernel). Once the transition of all supported options has been done, config8 will warn whenever an unsupported option appears in the config file, but it will nevertheless include it into the kernel Makefile. @@ -102,19 +102,19 @@ options notyet,notdef sys/i386/conf/options.<arch>, e. g. sys/i386/conf/options.i386), and select an opt_foo.h file where your new option would best go into. If there is already something that comes close to the purpose of - the new option, pick this. For example, options modifying the + the new option, pick this. For example, options modifying the overall behaviour of the SCSI subsystem can go into - opt_scsi.h. By default, simply mentioning an + opt_scsi.h. By default, simply mentioning an option in the appropriate option file, say FOO, implies its value will go into the corresponding file - opt_foo.h. This can be overridden on the + opt_foo.h. This can be overridden on the right-hand side of a rule by specifying another filename. If there is no opt_foo.h already - available for the intended new option, invent a new name. Make it + available for the intended new option, invent a new name. Make it meaningful, and comment the new section in the - options[.<arch>] file. config8 will automagically pick up the change, and create that file next time it is run. Most options should go in a header file by themselves.. + options[.<arch>] file. config8 will automagically pick up the change, and create that file next time it is run. Most options should go in a header file by themselves.. Packing too many options into a single opt_foo.h will cause @@ -129,13 +129,13 @@ options notyet,notdef &prompt.user; find /usr/src/sys -name type f | xargs fgrep NEW_OPTION - is your friend in finding them. Go and edit all those files, + is your friend in finding them. Go and edit all those files, and add #include "opt_foo.h" - on top, before all the #include <xxx.h> stuff. This sequence + on top, before all the #include <xxx.h> stuff. This sequence is most important as the options could override defaults from the regular include files, if the defaults are of the form @@ -152,7 +152,7 @@ options notyet,notdef opt_foo.h cannot be included into those files since it would break the headers more seriously, but if it is not included, then places that include it - may get an inconsistent value for the option. Yes, there are + may get an inconsistent value for the option. Yes, there are precedents for this right now, but that does not make them more correct. diff --git a/en/handbook/l10n/chapter.sgml b/en/handbook/l10n/chapter.sgml index b37df3d188..e9444cd3d6 100644 --- a/en/handbook/l10n/chapter.sgml +++ b/en/handbook/l10n/chapter.sgml @@ -52,7 +52,7 @@ font8x8=cp866-8x8 key remapped to match Russian termcap5 entry for FreeBSD console. - RUS/LAT switch will be CapsLock. Old CapsLock function still + RUS/LAT switch will be CapsLock. Old CapsLock function still available via Shift+CapsLock. CapsLock LED will indicate RUS mode, not CapsLock mode. @@ -96,7 +96,7 @@ ttyv0 "/usr/libexec/getty Pc" cons25r on secure The best way is using /etc/login.conf russian user's login class in passwd5 entry login class - position. See login.conf5 for + position. See login.conf5 for details. @@ -235,8 +235,8 @@ setenv MM_CHARSET KOI8-R Since most printers with Russian characters comes with hardware code page CP866, special output filter needed for KOI8-R - -> CP866 conversion. Such filter installed by default as - /usr/libexec/lpr/ru/koi2alt. So, Russian + -> CP866 conversion. Such filter installed by default as + /usr/libexec/lpr/ru/koi2alt. So, Russian printer /etc/printcap entry should looks like: @@ -282,7 +282,7 @@ lp|Russian local line printer:\ XFree86 port from /usr/ports/x11/XFree86 already have most recent XFree86 version, so it will work, if you - install XFree86 from this port. XFree86 version shipped + install XFree86 from this port. XFree86 version shipped with the latest FreeBSD distribution should work too (check XFree86 version number not less than 3.3 first). @@ -295,8 +295,8 @@ lp|Russian local line printer:\ &prompt.root; make all install - there. This port install latest - version of KOI8-R fonts. XFree86 3.3 already have some + there. This port install latest + version of KOI8-R fonts. XFree86 3.3 already have some KOI8-R fonts, but this ones scaled better. Check find "Files" section @@ -323,7 +323,7 @@ XkbKeymap "xfree86(ru)" line into XkbDisable is turned off (commented out) there. - RUS/LAT switch will be CapsLock. Old CapsLock function still + RUS/LAT switch will be CapsLock. Old CapsLock function still available via Shift+CapsLock (in LAT mode only). @@ -346,7 +346,7 @@ XkbKeymap "xfree86(ru)" line into German Language (ISO 8859-1) - Slaven Rezic eserte@cs.tu-berlin.de wrote a tutorial how to use umlauts on a FreeBSD machine. The tutorial is written in German and available at http://www.de.freebsd.org/de/umlaute/. + Slaven Rezic eserte@cs.tu-berlin.de wrote a tutorial how to use umlauts on a FreeBSD machine. The tutorial is written in German and available at http://www.de.freebsd.org/de/umlaute/. diff --git a/en/handbook/linuxemu/chapter.sgml b/en/handbook/linuxemu/chapter.sgml index adf9e71a9e..a90d279f6d 100644 --- a/en/handbook/linuxemu/chapter.sgml +++ b/en/handbook/linuxemu/chapter.sgml @@ -9,14 +9,14 @@ Linux emulation in FreeBSD has reached a point where it is possible to run a large fraction of Linux binaries in both a.out and - ELF format. The linux emulation in the 2.1-STABLE branch is capable + ELF format. The linux emulation in the 2.1-STABLE branch is capable of running Linux DOOM and Mathematica; the version present in &rel.current;-RELEASE is vastly more capable and runs all these as well as Quake, Abuse, IDL, netrek for Linux and a whole host of other programs. There are some Linux-specific operating system features that are - not supported on FreeBSD. Linux binaries will not work on FreeBSD + not supported on FreeBSD. Linux binaries will not work on FreeBSD if they use the Linux /proc filesystem (which is different from the optional FreeBSD /proc filesystem) or i386-specific calls, such as enabling virtual 8086 @@ -31,8 +31,8 @@ The GENERIC kernel in 2.1-STABLE is not configured for linux compatibility so you must reconfigure your - kernel for it. There are two ways to do this: 1. linking the - emulator statically in the kernel itself and 2. configuring your + kernel for it. There are two ways to do this: 1. linking the + emulator statically in the kernel itself and 2. configuring your kernel to dynamically load the linux loadable kernel module (LKM). @@ -50,7 +50,7 @@ options COMPAT_LINUX options SYSVSHM The linux system calls require 4.3BSD system - call compatibility. So make sure you have the following. + call compatibility. So make sure you have the following. options "COMPAT_43" @@ -67,7 +67,7 @@ options LINUX section. If you decide to use the LKM you must also install the - loadable module. A mismatch of versions between the kernel and + loadable module. A mismatch of versions between the kernel and loadable module can cause the kernel to crash, so the safest thing to do is to reinstall the LKM when you install the kernel. @@ -95,11 +95,11 @@ Module Name EXEC 0 3 f0baf000 0018 f0bb4000 1 linux_emulator You can cause the LKM to be loaded when the - system boots in either of two ways. In FreeBSD 2.2.1-RELEASE and + system boots in either of two ways. In FreeBSD 2.2.1-RELEASE and 2.1-STABLE enable it in /etc/sysconfig -linux=YES by changing it from NO to YES. FreeBSD 2.1 +linux=YES by changing it from NO to YES. FreeBSD 2.1 RELEASE and earlier do not have such a line and on those you will need to edit /etc/rc.local to add the following line. @@ -112,9 +112,9 @@ linux Installing Linux Emulation in 2.2.2-RELEASE and later It is no longer necessary to specify options LINUX or - options COMPAT_LINUX. Linux emulation is done with an LKM + options COMPAT_LINUX. Linux emulation is done with an LKM (“Loadable Kernel Module”) so it can be installed on the fly - without having to reboot. You will need the following things in + without having to reboot. You will need the following things in your startup files, however: @@ -149,14 +149,14 @@ EXEC 0 4 f09e6000 001c f09ec010 1 linux_mod However, there have been reports that this - fails on some 2.2-RELEASE and later systems. If for some reason + fails on some 2.2-RELEASE and later systems. If for some reason you cannot load the linux LKM, then statically link the emulator in the kernel by adding options LINUX - to your kernel config file. Then run config + to your kernel config file. Then run config and install the new kernel as described in the kernel configuration section. @@ -170,7 +170,7 @@ options LINUX Installing using the linux_lib port Most linux applications use shared libraries, so you are - still not done until you install the shared libraries. It is + still not done until you install the shared libraries. It is possible to do this by hand, however, it is vastly simpler to just grab the linux_lib port: @@ -179,12 +179,12 @@ options LINUX &prompt.root; make all install - and you should have a working linux emulator. Legend (and + and you should have a working linux emulator. Legend (and the mail archives :-) seems to hold that Linux emulation works best with linux binaries linked against the ZMAGIC libraries; QMAGIC libraries (such as those used in Slackware V2.0) may tend - to give the Linuxulator heartburn. Also, expect some programs to complain - about incorrect minor versions of the system libraries. In + to give the Linuxulator heartburn. Also, expect some programs to complain + about incorrect minor versions of the system libraries. In general, however, this does not seem to be a problem. @@ -194,17 +194,17 @@ options LINUX Installing libraries manually If you do not have the “ports” distribution, you can - install the libraries by hand instead. You will need the Linux + install the libraries by hand instead. You will need the Linux shared libraries that the program depends on and the runtime - linker. Also, you will need to create a "shadow root" + linker. Also, you will need to create a "shadow root" directory, /compat/linux, for Linux - libraries on your FreeBSD system. Any shared libraries opened + libraries on your FreeBSD system. Any shared libraries opened by Linux programs run under FreeBSD will look in this tree - first. So, if a Linux program loads, for example, + first. So, if a Linux program loads, for example, /lib/libc.so, FreeBSD will first try to open /compat/linux/lib/libc.so, and if that does not exist then it will try - /lib/libc.so. Shared libraries should be + /lib/libc.so. Shared libraries should be installed in the shadow tree /compat/linux/lib rather than the paths that the Linux ld.so reports. @@ -216,7 +216,7 @@ options LINUX Generally, you will need to look for the shared libraries that Linux binaries depend on only the first few times that you - install a Linux program on your FreeBSD system. After a while, + install a Linux program on your FreeBSD system. After a while, you will have a sufficient set of Linux shared libraries on your system to be able to run newly imported Linux binaries without any extra work. @@ -235,7 +235,7 @@ options LINUX If you have access to a Linux system, see what shared libraries the application needs, and copy them to your FreeBSD system. - Example: you have just ftp'ed the Linux binary of Doom. Put it + Example: you have just ftp'ed the Linux binary of Doom. Put it on the Linux system you have access to, and check which shared libraries it needs by running ldd linuxxdoom: @@ -266,9 +266,9 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 a matching major revision number to the first column of the ldd output, you will not need to copy the file named in the last column to your system, the one you already have should - work. It is advisable to copy the shared library anyway if it - is a newer version, though. You can remove the old one, as - long as you make the symbolic link point to the new one. So, + work. It is advisable to copy the shared library anyway if it + is a newer version, though. You can remove the old one, as + long as you make the symbolic link point to the new one. So, if you have these libraries on your system: @@ -299,7 +299,7 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 The symbolic link mechanism is only - needed for Linux binaries. The FreeBSD runtime linker takes + needed for Linux binaries. The FreeBSD runtime linker takes care of looking for matching major revision numbers itself and you do not need to worry about it. @@ -314,7 +314,7 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 Finally, if you run FreeBSD 2.2-RELEASE you must make sure that you have the Linux runtime linker and its config files on - your system. You should copy these files from the Linux system + your system. You should copy these files from the Linux system to their appropriate place on your FreeBSD system (to the /compat/linux tree): @@ -324,8 +324,8 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 If you do not have access to a Linux system, you should get - the extra files you need from various ftp sites. Information on - where to look for the various files is appended below. For now, + the extra files you need from various ftp sites. Information on + where to look for the various files is appended below. For now, let us assume you know where to get the files. Retrieve the following files (all from the same ftp site to @@ -343,16 +343,16 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 ldconfig and ldd do not necessarily need to be under /compat/linux; you can install them - elsewhere in the system too. Just make sure they do not conflict - with their FreeBSD counterparts. A good idea would be to install + elsewhere in the system too. Just make sure they do not conflict + with their FreeBSD counterparts. A good idea would be to install them in /usr/local/bin as ldconfig-linux and ldd-linux. Create the file /compat/linux/etc/ld.so.conf, containing the directories in which the Linux runtime linker should look - for shared libs. It is a plain text file, containing a directory - name on each line. /lib and + for shared libs. It is a plain text file, containing a directory + name on each line. /lib and /usr/lib are standard, you could add the following: @@ -362,7 +362,7 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 When a linux binary opens a library such as /lib/libc.so the emulator maps the name to - /compat/linux/lib/libc.so internally. All + /compat/linux/lib/libc.so internally. All linux libraries should be installed under /compat/linux (e.g. /compat/linux/lib/libc.so, /compat/linux/usr/X11/lib/libX11.so, etc.) @@ -378,7 +378,7 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 ldconfig is statically linked, so it does not need any - shared libraries to run. It creates the file + shared libraries to run. It creates the file /compat/linux/etc/ld.so.cache which contains the names of all the shared libraries and should be rerun to recreate this file whenever you install additional @@ -390,8 +390,8 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 and ldconfig is not needed or used. You should now be set up for Linux binaries which only need - a shared libc. You can test this by running the Linux ldd on - itself. Supposing that you have it installed as ldd-linux, it + a shared libc. You can test this by running the Linux ldd on + itself. Supposing that you have it installed as ldd-linux, it should produce something like: @@ -400,19 +400,19 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 This being done, you are ready to install new Linux - binaries. Whenever you install a new Linux program, you should + binaries. Whenever you install a new Linux program, you should check if it needs shared libraries, and if so, whether you have them installed in the /compat/linux tree. To do this, you run the Linux version ldd on the new program, - and watch its output. ldd (see also the manual page for ldd1) + and watch its output. ldd (see also the manual page for ldd1) will print a list of shared libraries that the program depends on, in the form majorname (jumpversion) => fullname. If it prints not found instead of fullname it means that - you need an extra library. The library needed is shown in - majorname and will be of the form libXXXX.so.N. You will need to + you need an extra library. The library needed is shown in + majorname and will be of the form libXXXX.so.N. You will need to find a libXXXX.so.N.mm on a Linux ftp site, and install it on - your system. The XXXX (name) and N (major revision number) + your system. The XXXX (name) and N (major revision number) should match; the minor number(s) mm are less important, though it is advised to take the most recent version. @@ -423,7 +423,7 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 Installing Linux ELF binaries ELF binaries sometimes require an extra step of - “branding”. If you attempt to run an unbranded ELF binary, + “branding”. If you attempt to run an unbranded ELF binary, you will get an error message like the following; @@ -466,18 +466,18 @@ multi on where the order here specifies that /etc/hosts is searched first and DNS is - searched second. When + searched second. When /compat/linux/etc/host.conf is not installed linux applications find FreeBSD's /etc/host.conf and complain about the - incompatible FreeBSD syntax. You should remove bind if you + incompatible FreeBSD syntax. You should remove bind if you have not configured a name-server using the /etc/resolv.conf file. Lastly, those who run 2.1-STABLE need to set an the RESOLV_HOST_CONF environment variable so that applications will - know how to search the host tables. If you run FreeBSD - 2.2-RELEASE or later, you can skip this. For the + know how to search the host tables. If you run FreeBSD + 2.2-RELEASE or later, you can skip this. For the /bin/csh shell use: @@ -503,12 +503,12 @@ multi on Linux is distributed by several groups that make their own set - of binaries that they distribute. Each distribution has its own - name, like “Slackware” or “Yggdrasil”. The distributions are - available on a lot of ftp sites. Sometimes the files are unpacked, + of binaries that they distribute. Each distribution has its own + name, like “Slackware” or “Yggdrasil”. The distributions are + available on a lot of ftp sites. Sometimes the files are unpacked, and you can get the individual files you need, but mostly they are stored in distribution sets, usually consisting of subdirectories - with gzipped tar files in them. The primary ftp sites for the + with gzipped tar files in them. The primary ftp sites for the distributions are: @@ -538,15 +538,15 @@ multi on - For simplicity, let us concentrate on Slackware here. This + For simplicity, let us concentrate on Slackware here. This distribution consists of a number of subdirectories, containing - separate packages. Normally, they are controlled by an install - program, but you can retrieve files “by hand” too. First of all, + separate packages. Normally, they are controlled by an install + program, but you can retrieve files “by hand” too. First of all, you will need to look in the contents subdir of the - distribution. You will find a lot of small text files here - describing the contents of the separate packages. The fastest way + distribution. You will find a lot of small text files here + describing the contents of the separate packages. The fastest way to look something up is to retrieve all the files in the contents - subdirectory, and grep through them for the file you need. Here is + subdirectory, and grep through them for the file you need. Here is an example of a list of files that you might need, and in which contents-file you will find it by grepping through them: @@ -585,10 +585,10 @@ multi on So, in this case, you will need the packages ldso, shlibs, - xf_lib and oldlibs. In each of the contents-files for these + xf_lib and oldlibs. In each of the contents-files for these packages, look for a line saying PACKAGE LOCATION, it will tell you on which “disk” the package is, in our case it will tell - us in which subdirectory we need to look. For our example, we + us in which subdirectory we need to look. For our example, we would find the following locations: @@ -611,7 +611,7 @@ multi on The locations called “diskXX” refer to the slakware/XX subdirectories of the distribution, others may be found in the - contrib subdirectory. In this case, we + contrib subdirectory. In this case, we could now retrieve the packages we need by retrieving the following files (relative to the root of the Slackware distribution tree): @@ -655,13 +655,13 @@ multi on This document shows how to install the Linux binary distribution of Mathematica 2.2 on FreeBSD 2.1. - Mathematica supports Linux but not FreeBSD as it stands. So + Mathematica supports Linux but not FreeBSD as it stands. So once you have configured your system for Linux compatibility you have most of what you need to run Mathematica. For those who already have the student edition of Mathematica for DOS the cost of upgrading to the Linux version at the time this - was written, March 1996, was $45.00. It can be ordered directly + was written, March 1996, was $45.00. It can be ordered directly from Wolfram at (217) 398-6500 and paid for by credit card. @@ -670,8 +670,8 @@ multi on The binaries are currently distributed by Wolfram on CDROM. The CDROM has about a dozen tar files, each of which is a binary - distribution for one of the supported architectures. The one for - Linux is named LINUX.TAR. You can, for + distribution for one of the supported architectures. The one for + Linux is named LINUX.TAR. You can, for example, unpack this into /usr/local/Mathematica: @@ -703,14 +703,14 @@ richc.isdn.bcm.tmc.edu 9845-03452-90255 So, for example, the “machine ID” of richc is - 9845-03452-90255. You can ignore the message about the ioctl - that is not implemented. It will not prevent Mathematica from + 9845-03452-90255. You can ignore the message about the ioctl + that is not implemented. It will not prevent Mathematica from running in any way and you can safely ignore it, though you will see the message every time you run Mathematica. When you register with Wolfram, either by email, phone or fax, you will give them the “machine ID” and they will respond with a - corresponding password consisting of groups of numbers. You need + corresponding password consisting of groups of numbers. You need to add them both along with the machine name and license number in your mathpass file. @@ -722,21 +722,21 @@ richc.isdn.bcm.tmc.edu 9845-03452-90255 It will ask you to enter your license number - and the Wolfram supplied password. If you get them mixed up or + and the Wolfram supplied password. If you get them mixed up or for some reason the math.install fails, that is OK; you can simply edit the file mathpass in this same directory to correct the info manually. After getting past the password, math.install will ask you if you accept the install defaults provided, or if you want to use - your own. If you are like us and distrust all install programs, - you probably want to specify the actual directories. Beware. + your own. If you are like us and distrust all install programs, + you probably want to specify the actual directories. Beware. Although the math.install program asks you to specify directories, it will not create them for you, so you should perhaps have a second window open with another shell so that you can create them - before you give them to the install program. Or, if it fails, you + before you give them to the install program. Or, if it fails, you can create the directories and then restart the math.install - program. The directories we chose to create beforehand and + program. The directories we chose to create beforehand and specify to math.install were: @@ -762,23 +762,23 @@ richc.isdn.bcm.tmc.edu 9845-03452-90255 You can also tell it to use /tmp/math.record for the system record file, - where it puts logs of sessions. After this math.install will + where it puts logs of sessions. After this math.install will continue on to unpacking things and placing everything where it should go. The Mathematica Notebook feature is included separately, as - the X Front End, and you have to install it separately. To get the + the X Front End, and you have to install it separately. To get the X Front End stuff correctly installed, cd into the /usr/local/Mathematica/FrontEnd directory and - execute the xfe.install shell script. You will have to tell it + execute the xfe.install shell script. You will have to tell it where to put things, but you do not have to create any directories because it will use the same directories that had been created for - math.install. When it finishes, there should be a new shell script + math.install. When it finishes, there should be a new shell script in /usr/local/Mathematica/bin called mathematica. Lastly, you need to modify each of the shell scripts that - Mathematica has installed. At the beginning of every shell script + Mathematica has installed. At the beginning of every shell script in /usr/local/Mathematica/bin add the following line: @@ -798,7 +798,7 @@ richc.isdn.bcm.tmc.edu 9845-03452-90255 This tells Mathematica to use the linux version - of host.conf. This file has a different syntax from FreeBSD's + of host.conf. This file has a different syntax from FreeBSD's host.conf, so you will get an error message about /etc/host.conf if you leave this out. @@ -809,11 +809,11 @@ richc.isdn.bcm.tmc.edu 9845-03452-90255 /usr/local/Mathematica/bin to your path. - That is about all it takes. With this you should be able to + That is about all it takes. With this you should be able to type mathematica and get a really slick looking Mathematica - Notebook screen up. Mathematica has included the Motif user + Notebook screen up. Mathematica has included the Motif user interfaces, but it is compiled in statically, so you do not need - the Motif libraries. Good luck doing this yourself! + the Motif libraries. Good luck doing this yourself! diff --git a/en/handbook/mirrors/chapter.sgml b/en/handbook/mirrors/chapter.sgml index d47e578e4e..fc41eedd55 100644 --- a/en/handbook/mirrors/chapter.sgml +++ b/en/handbook/mirrors/chapter.sgml @@ -37,7 +37,7 @@ on static lists of hosts. Additionally, FreeBSD is available via anonymous FTP from the - following mirror sites. If you choose to obtain FreeBSD via + following mirror sites. If you choose to obtain FreeBSD via anonymous FTP, please try to use a site near you. Argentina, @@ -831,7 +831,7 @@ The latest versions of export-restricted code for FreeBSD (2.0C or later) (eBones and secure) are being made available at the - following locations. If you are outside the U.S. or Canada, please + following locations. If you are outside the U.S. or Canada, please get secure (DES) and eBones (Kerberos) from one of the following foreign distribution sites: @@ -902,7 +902,7 @@ CTM Sites CTM/FreeBSD is available via - anonymous FTP from the following mirror sites. If you choose to + anonymous FTP from the following mirror sites. If you choose to obtain CTM via anonymous FTP, please try to use a site near you. @@ -989,7 +989,7 @@ If you did not find a mirror near to you or the mirror is incomplete, try FTP search at http://ftpsearch.ntnu.no/ftpsearch. FTP search is a great free archie server in Trondheim, Norway. + URL="http://ftpsearch.ntnu.no/ftpsearch/">http://ftpsearch.ntnu.no/ftpsearch. FTP search is a great free archie server in Trondheim, Norway. @@ -1379,18 +1379,18 @@ The following CVSup site is especially designed for CTM users. Unlike the other CVSup mirrors, - it is kept up-to-date by CTM. That means if you CVSup cvs-all with release=cvs + linkend="ctm">CTM users. Unlike the other CVSup mirrors, + it is kept up-to-date by CTM. That means if you CVSup cvs-all with release=cvs from this site, you get a version of the repository (including the inevitable .ctm_status file) which is - suitable for being updated using the CTM cvs-cur deltas. This allows users who track + suitable for being updated using the CTM cvs-cur deltas. This allows users who track the entire cvs-all tree to go from CVSup to CTM without having to rebuild their repository from scratch using a fresh CTM base delta. This special feature only works for the cvs-all distribution with - cvs as the release tag. CVSupping any other + cvs as the release tag. CVSupping any other distribution and/or release will get you the specified distribution, but it will not be suitable for CTM updating. @@ -1398,8 +1398,8 @@ Because the current version of CTM does not preserve the timestamps of files, the timestamps at this mirror site are not - the same as those at other mirror sites. Switching between this - site and other sites is not recommended. It will work correctly, + the same as those at other mirror sites. Switching between this + site and other sites is not recommended. It will work correctly, but will be somewhat inefficient. diff --git a/en/handbook/pgpkeys/chapter.sgml b/en/handbook/pgpkeys/chapter.sgml index 4323cc68e1..e22fe1c300 100644 --- a/en/handbook/pgpkeys/chapter.sgml +++ b/en/handbook/pgpkeys/chapter.sgml @@ -2,7 +2,7 @@ PGP keys In case you need to verify a signature or send encrypted email to - one of the officers or core team members a number of keys are + one of the officers or core team members a number of keys are provided here for your convenience. diff --git a/en/handbook/policies/chapter.sgml b/en/handbook/policies/chapter.sgml index 500b2b1d46..6ea699c051 100644 --- a/en/handbook/policies/chapter.sgml +++ b/en/handbook/policies/chapter.sgml @@ -24,22 +24,22 @@ MAINTAINER= email-addresses The semantics of this are as follows: - The maintainer owns and is responsible for that code. This + The maintainer owns and is responsible for that code. This means that he is responsible for fixing bugs and answer problem reports pertaining to that piece of the code, and in the case of contributed software, for tracking new versions, as appropriate. Changes to directories which have a maintainer defined shall be - sent to the maintainer for review before being committed. Only if + sent to the maintainer for review before being committed. Only if the maintainer does not respond for an unacceptable period of time, to several emails, will it be acceptable to commit changes without - review by the maintainer. However, it is suggested that you try and + review by the maintainer. However, it is suggested that you try and have the changes reviewed by someone else if at all possible. It is of course not acceptable to add a person or group as - maintainer unless they agree to assume this duty. On the other hand + maintainer unless they agree to assume this duty. On the other hand it doesn't have to be a committer and it can easily be a group of people. @@ -48,44 +48,44 @@ MAINTAINER= email-addresses Contributed Software - Contributed by &a.phk; and &a.obrien;. + Contributed by &a.phk; and &a.obrien;. June 1996. Some parts of the FreeBSD distribution consist of software that - is actively being maintained outside the FreeBSD project. For + is actively being maintained outside the FreeBSD project. For historical reasons, we call this contributed - software. Some examples are perl, gcc and patch. + software. Some examples are perl, gcc and patch. Over the last couple of years, various methods have been used in dealing with this type of software and all have some number of - advantages and drawbacks. No clear winner has emerged. + advantages and drawbacks. No clear winner has emerged. Since this is the case, after some debate one of these methods has been selected as the “official” method and will be required for - future imports of software of this kind. Furthermore, it is + future imports of software of this kind. Furthermore, it is strongly suggested that existing contributed software converge on this model over time, as it has significant advantages over the old method, including the ability to easily obtain diffs relative to the “official” versions of the source by everyone (even without cvs - access). This will make it significantly easier to return changes + access). This will make it significantly easier to return changes to the primary developers of the contributed software. Ultimately, however, it comes down to the people actually doing - the work. If using this model is particularly unsuited to the + the work. If using this model is particularly unsuited to the package being dealt with, exceptions to these rules may be granted only with the approval of the core team and with the general - consensus of the other developers. The ability to maintain the + consensus of the other developers. The ability to maintain the package in the future will be a key issue in the decisions. Because of some unfortunate design limitations with the RCS file format and CVS's use of vendor branches, minor, trivial and/or cosmetic changes are strongly discouraged on - files that are still tracking the vendor branch. “Spelling + files that are still tracking the vendor branch. “Spelling fixes” are explicitly included here under the “cosmetic” category and are to be avoided for files with - revision 1.1.x.x. The repository bloat impact from a single character + revision 1.1.x.x. The repository bloat impact from a single character change can be rather dramatic. @@ -93,8 +93,8 @@ MAINTAINER= email-addresses language will be used as example of how this model works: src/contrib/tcl contains the source as - distributed by the maintainers of this package. Parts that are - entirely not applicable for FreeBSD can be removed. In the case of + distributed by the maintainers of this package. Parts that are + entirely not applicable for FreeBSD can be removed. In the case of Tcl, the mac, win and compat subdirectories were eliminated before the import @@ -111,23 +111,23 @@ MAINTAINER= email-addresses src/tools/tools/tcl_bmake contains a couple of shell-scripts that can be of help when the tcl software needs - updating. These are not part of the built or installed + updating. These are not part of the built or installed software. The important thing here is that the src/contrib/tcl directory is created according to the rules: It is supposed to contain the sources as distributed (on a proper CVS vendor-branch and without RCS keyword expansion) with as few FreeBSD-specific changes - as possible. The 'easy-import' tool on freefall will assist in + as possible. The 'easy-import' tool on freefall will assist in doing the import, but if there are any doubts on how to go about it, it is imperative that you ask first and not blunder ahead and hope - it “works out”. CVS is not forgiving of import accidents and a fair + it “works out”. CVS is not forgiving of import accidents and a fair amount of effort is required to back out major mistakes. Because of the previously mentioned design limitations with CVS's vendor branches, it is required that “official” patches from the vendor be applied to the original distributed sources and the result - re-imported onto the vendor branch again. Official patches should + re-imported onto the vendor branch again. Official patches should never be patched into the FreeBSD checked out version and "committed", as this destroys the vendor branch coherency and makes importing future versions rather difficult as there will be @@ -136,7 +136,7 @@ MAINTAINER= email-addresses Since many packages contain files that are meant for compatibility with other architectures and environments that FreeBSD, it is permissible to remove parts of the distribution tree - that are of no interest to FreeBSD in order to save space. Files + that are of no interest to FreeBSD in order to save space. Files containing copyright notices and release-note kind of information applicable to the remaining files shall not be removed. @@ -144,7 +144,7 @@ MAINTAINER= email-addresses If it seems easier, the bmake Makefiles can be produced from the dist tree automatically by some utility, something which would hopefully make it even easier to upgrade to a - new version. If this is done, be sure to check in such utilities + new version. If this is done, be sure to check in such utilities (as necessary) in the src/tools directory along with the port itself so that it is available to future maintainers. @@ -180,14 +180,14 @@ MAINTAINER= email-addresses However, please do not import FREEBSD-upgrade with the contributed source. Rather you should cvs add FREEBSD-upgrade ; cvs ci after the - initial import. Example wording from + initial import. Example wording from src/contrib/cpio is below: This directory contains virgin sources of the original distribution files -on a "vendor" branch. Do not, under any circumstances, attempt to upgrade -the files in this directory via patches and a cvs commit. New versions or -official-patch versions must be imported. Please remember to import with +on a "vendor" branch. Do not, under any circumstances, attempt to upgrade +the files in this directory via patches and a cvs commit. New versions or +official-patch versions must be imported. Please remember to import with "-ko" to prevent CVS from corrupting any vendor RCS Ids. For the import of GNU cpio 2.4.2, the following files were removed: @@ -233,7 +233,7 @@ obrien@freebsd.org - 30 March 1997 If you are adding shared library support to a port or other piece of software that doesn't have one, the version numbers should - follow these rules. Generally, the resulting numbers will have + follow these rules. Generally, the resulting numbers will have nothing to do with the release version of the software. The three principles of shared library building are: @@ -260,14 +260,14 @@ obrien@freebsd.org - 30 March 1997 For instance, added functions and bugfixes result in the minor version number being bumped, while deleted functions, changed - function call syntax etc. will force the major version number to + function call syntax etc. will force the major version number to change. - Stick to version numbers of the form major.minor (x.y). Our + Stick to version numbers of the form major.minor (x.y). Our dynamic linker does not handle version numbers of the form x.y.z - well. Any version number after the y (ie. the third digit) is + well. Any version number after the y (ie. the third digit) is totally ignored when comparing shared lib version numbers to decide - which library to link with. Given two shared libraries that differ + which library to link with. Given two shared libraries that differ only in the “micro” revision, ld.so will link with the higher one. Ie: if you link with libfoo.so.3.3.3, the linker only records 3.3 in the headers, and will link with anything @@ -276,14 +276,14 @@ obrien@freebsd.org - 30 March 1997 ld.so will always use the highest - “minor” revision. Ie: it will use libc.so.2.2 + “minor” revision. Ie: it will use libc.so.2.2 in preference to libc.so.2.0, even if the program was initially linked with libc.so.2.0. For non-port libraries, it is also our policy to change the - shared library version number only once between releases. When you + shared library version number only once between releases. When you make a change to a system library that requires the version number to be bumped, check the Makefile's commit logs. It is the responsibility of the committer to ensure that the first diff --git a/en/handbook/ports/chapter.sgml b/en/handbook/ports/chapter.sgml index 35e532e05b..0eb95aa909 100644 --- a/en/handbook/ports/chapter.sgml +++ b/en/handbook/ports/chapter.sgml @@ -8,16 +8,16 @@ For all the hype about open standards, getting a program to work on different versions of Unix in the real world can be a tedious and - tricky business, as anyone who has tried it will know. You may be + tricky business, as anyone who has tried it will know. You may be lucky enough to find that the program you want will compile cleanly on your system, install itself in all the right places and run flawlessly - “out of the box”, but this is unfortunately rather rare. With most + “out of the box”, but this is unfortunately rather rare. With most programs, you will find yourself doing a fair bit of head-scratching, and there are quite a few programs that will result in premature greying, or even chronic alopecia... Some software distributions have attacked this problem by - providing configuration scripts. Some of these are very clever, but + providing configuration scripts. Some of these are very clever, but they have an unfortunate tendency to triumphantly announce that your system is something you have never heard of and then ask you lots of questions that sound like a final exam in system-level Unix @@ -102,7 +102,7 @@ FreeBSD ports still use the tarball mechanism, but use a skeleton to hold the "knowledge" of how to get the program working on FreeBSD, - rather than expecting the user to be able to work it out. They also + rather than expecting the user to be able to work it out. They also supply their own customised Makefile, so that almost every port can be built in the same way. @@ -110,14 +110,14 @@ If you look at a port skeleton (either on your FreeBSD system or the FTP site) and expect to find all sorts of pointy-headed rocket science lurking there, you may be disappointed by the one or two rather unexciting-looking files and directories you find there. (We will discuss in a minute how to go about the FTP site) and expect to find all sorts of pointy-headed rocket science lurking there, you may be disappointed by the one or two rather unexciting-looking files and directories you find there. (We will discuss in a minute how to go about Getting a port). - “How on earth can this do anything?” I hear you cry. “There + “How on earth can this do anything?” I hear you cry. “There is no source code there!” Fear not, gentle reader, all will become clear (hopefully). - Let's see what happens if we try and install a port. I have chosen + Let's see what happens if we try and install a port. I have chosen ElectricFence, a useful tool for developers, as the skeleton is more straightforward than most. @@ -160,7 +160,7 @@ install -c -o bin -g bin -m 444 /usr/ports/devel/ElectricFence/work/ElectricFenc The make program has noticed that you did not have a local copy of the source code and tried to FTP it down so it could get the - job done. I already had the source handy in my example, so it did + job done. I already had the source handy in my example, so it did not need to fetch it. Let's go through this and see what the make program was @@ -203,13 +203,13 @@ install -c -o bin -g bin -m 444 /usr/ports/devel/ElectricFence/work/ElectricFenc Install the program executable and other supporting files, man pages, etc. under the /usr/local hierarchy, where they will not - get mixed up with system programs. This also makes sure that + get mixed up with system programs. This also makes sure that all the ports you install will go in the same place, instead of being flung all over your system. - Register the installation in a database. This means that, + Register the installation in a database. This means that, if you do not like the program, you can cleanly remove all traces of it from your system. @@ -219,7 +219,7 @@ install -c -o bin -g bin -m 444 /usr/ports/devel/ElectricFence/work/ElectricFenc Scroll up to the make output and see if you can match these - steps to it. And if you were not impressed before, you should be by + steps to it. And if you were not impressed before, you should be by now! @@ -228,7 +228,7 @@ install -c -o bin -g bin -m 444 /usr/ports/devel/ElectricFence/work/ElectricFenc Getting a FreeBSD Port There are two ways of getting hold of the FreeBSD port for a - program. One requires a FreeBSD + program. One requires a FreeBSD CDROM, the other involves using an Internet Connection. @@ -253,17 +253,17 @@ DISTDIR= /tmp/distfiles WRKDIRPREFIX= /tmp Substitute /tmp for any place you have enough - free space. Then, just cd to the appropriate + free space. Then, just cd to the appropriate subdirectory under /cdrom/ports and type make install as - usual. WRKDIRPREFIX will cause the port to be + usual. WRKDIRPREFIX will cause the port to be build under /tmp/cdrom/ports; for instance, games/oneko will be built under /tmp/cdrom/ports/games/oneko. There are some ports for which we cannot provide the - original source in the CDROM due to licensing limitations. In + original source in the CDROM due to licensing limitations. In that case, you will need to look at the section on Compiling ports using an Internet connection. @@ -275,22 +275,22 @@ WRKDIRPREFIX= /tmp If you do not have a CDROM, or you want to make sure you get the very latest version of the port you want, you will need to download the - skeleton for the port. Now + skeleton for the port. Now this might sound like rather a fiddly job full of pitfalls, but it is actually very easy. First, if you are running a release version of FreeBSD, make sure you get the appropriate “upgradekiet” for your replease from the ports - web page. These packages include files that have been + web page. These packages include files that have been updated since the release that you may need to compile new ports. The key to the skeletons is that the FreeBSD FTP server can create on-the-fly - tarballs for you. Here is + tarballs for you. Here is how it works, with the gnats program in the databases directory as - an example (the bits in square brackets are comments. Do not type + an example (the bits in square brackets are comments. Do not type them in if you are trying this yourself!):- @@ -312,19 +312,19 @@ password. Remember to use binary (also known as image) mode!] What happened here? We connected to the FTP server in the - usual way and went to its databases sub-directory. When we gave it + usual way and went to its databases sub-directory. When we gave it the command get gnats.tar, the FTP server tarred up the gnats directory for us. We then extracted the gnats skeleton and went into the gnats - directory to build the port. As we explained earlier, the make process noticed we did not have a copy of the source locally, so it fetched one before extracting, patching and building it. - Let's try something more ambitious now. Instead of getting a + Let's try something more ambitious now. Instead of getting a single port skeleton, let's get a whole sub-directory, for example - all the database skeletons in the ports collection. It looks + all the database skeletons in the ports collection. It looks almost the same:- @@ -347,7 +347,7 @@ password. Remember to use binary (also known as image) mode!] set of database programs on our FreeBSD machine! All we did that was different from getting a single port skeleton and building it was that we got a whole directory at once, and compiled everything - in it at once. Pretty impressive, no? + in it at once. Pretty impressive, no? If you expect to be installing many ports, it is probably worth downloading all the ports directories. @@ -369,7 +369,7 @@ password. Remember to use binary (also known as image) mode!] The most important component of a skeleton is the Makefile. This contains various statements that specify how the port should - be compiled and installed. Here is the Makefile for + be compiled and installed. Here is the Makefile for ElectricFence:- @@ -404,8 +404,8 @@ do-install: linkend="ports-tarball">tarball, but without the extension. - CATEGORIES states what kind of program this is. In - this case, a utility for developers. See the CATEGORIES states what kind of program this is. In + this case, a utility for developers. See the categories section of this handbook for a complete list. @@ -423,7 +423,7 @@ do-install: Skipping over the next few lines for a minute, the line .include <bsd.port.mk> says that the other statements and commands needed for this port are - in a standard file called bsd.port.mk. As + in a standard file called bsd.port.mk. As these are the same for all ports, there is no point in duplicating them all over the place, so they are kept in a single standard file. @@ -432,7 +432,7 @@ do-install: examination of how Makefiles work; suffice it to say that the line starting with MAN3 ensures that the ElectricFence man page is compressed after installation, to help conserve your precious disk - space. The original port did not provide an install target, + space. The original port did not provide an install target, so the three lines from do-install ensure that the files produced by this port are placed in the correct destination. @@ -444,7 +444,7 @@ do-install: The file containing the checksum for the port is called md5, after the MD5 algorithm used for ports - checksums. It lives in a directory with the slightly confusing + checksums. It lives in a directory with the slightly confusing name of files. This directory can also contain other miscellaneous files that @@ -491,31 +491,31 @@ do-install: What to do when a port does not work. - Oh. You can do one of four (4) things : + Oh. You can do one of four (4) things : - Fix it yourself. Technical details on how ports work can + Fix it yourself. Technical details on how ports work can be found in Porting applications. - Gripe. This is done by e-mail only! Send such e-mail to + Gripe. This is done by e-mail only! Send such e-mail to the &a.ports; and please include the name/version of the port, where you got both the port source & distfile(s) from, and what the text of the error was. - Forget it. This is the easiest for most — very few of the + Forget it. This is the easiest for most — very few of the programs in ports can be classified as essential! - Grab the pre-compiled package from a ftp server. The + Grab the pre-compiled package from a ftp server. The “master” package collection is on FreeBSD's FTP server in the packages @@ -538,29 +538,29 @@ do-install: - Q. I thought this was going to be a discussion about + Q. I thought this was going to be a discussion about modems??! - A. Ah. You must be thinking of the serial ports on the - back of your computer. We are using “port” here to mean the + A. Ah. You must be thinking of the serial ports on the + back of your computer. We are using “port” here to mean the result of “porting” a program from one version of Unix to - another. (It is an unfortunate bad habit of computer people to + another. (It is an unfortunate bad habit of computer people to use the same word to refer to several completely different things). - Q. I thought you were supposed to use packages to install + Q. I thought you were supposed to use packages to install extra programs? - A. Yes, that is usually the quickest and easiest way of + A. Yes, that is usually the quickest and easiest way of doing it. - Q. So why bother with ports then? + Q. So why bother with ports then? - A. Several reasons:- + A. Several reasons:- @@ -572,7 +572,7 @@ do-install: - Some people do not trust binary distributions. At + Some people do not trust binary distributions. At least with source code you can (in theory) read through it and look for potential problems yourself. @@ -607,21 +607,21 @@ do-install: - Q. What is a patch? + Q. What is a patch? - A. A patch is a small (usually) file that specifies how to - go from one version of a file to another. It contains text + A. A patch is a small (usually) file that specifies how to + go from one version of a file to another. It contains text that says, in effect, things like “delete line 23”, “add these two lines after line 468” or “change line 197 to - this”. Also known as a “diff”, since it is generated by a + this”. Also known as a “diff”, since it is generated by a program of that name. - Q. What is all this about + Q. What is all this about tarballs? - A. It is a file ending in .tar or + A. It is a file ending in .tar or .tar.gz (with variations like .tar.Z, or even .tgz if you are trying to squeeze the names into a DOS @@ -629,7 +629,7 @@ do-install: Basically, it is a directory tree that has been archived into a single file (.tar) and optionally - compressed (.gz). This technique was + compressed (.gz). This technique was originally used for Tape ARchives (hence the name tar), but it is a widely used way of distributing program source code around @@ -649,19 +649,19 @@ do-install: - Q. And a checksum? + Q. And a checksum? - A. It is a number generated by adding up all the data in - the file you want to check. If any of the characters change, + A. It is a number generated by adding up all the data in + the file you want to check. If any of the characters change, the checksum will no longer be equal to the total, so a simple - comparison will allow you to spot the difference. (In + comparison will allow you to spot the difference. (In practice, it is done in a more complicated way to spot problems like position-swapping, which will not show up with a simplistic addition). - Q. I did what you said for compiling ports from a CDROM and it worked great + Q. I did what you said for compiling ports from a CDROM and it worked great until I tried to install the kermit port:- @@ -671,25 +671,25 @@ do-install: Why can it not be found? Have I got a dud CDROM? - A. The licensing terms for kermit do not allow us to put + A. The licensing terms for kermit do not allow us to put the tarball for it on the CDROM, so you will have to fetch it by hand — sorry! The reason why you got all those error messages was because you were not connected to the Internet at - the time. Once you have downloaded it from any of the sites + the time. Once you have downloaded it from any of the sites above, you can re-start the process (try and choose the nearest site to you, though, to save your time and the Internet's bandwidth). - Q. I did that, but when I tried to put it into + Q. I did that, but when I tried to put it into /usr/ports/distfiles I got some error about not having permission. - A. The ports mechanism looks for the tarball in + A. The ports mechanism looks for the tarball in /usr/ports/distfiles, but you will not be able to copy anything there because it is sym-linked to the - CDROM, which is read-only. You can tell it to look somewhere + CDROM, which is read-only. You can tell it to look somewhere else by doing @@ -698,14 +698,14 @@ do-install: - Q. Does the ports scheme only work if you have everything + Q. Does the ports scheme only work if you have everything in /usr/ports? My system administrator says I must put everything under /u/people/guests/wurzburger, but it does not seem to work. - A. You can use the PORTSDIR and PREFIX variables to tell - the ports mechanism to use different directories. For + A. You can use the PORTSDIR and PREFIX variables to tell + the ports mechanism to use different directories. For instance, @@ -739,12 +739,12 @@ do-install: - Q. I do not have a FreeBSD CDROM, but I would like to have + Q. I do not have a FreeBSD CDROM, but I would like to have all the tarballs handy on my system so I do not have to wait - for a download every time I install a port. Is there an easy + for a download every time I install a port. Is there an easy way to get them all at once? - A. To get every single tarball for the ports collection, + A. To get every single tarball for the ports collection, do @@ -765,12 +765,12 @@ do-install: - Q. I know it is probably faster to fetch the tarballs from - one of the FreeBSD mirror sites close by. Is there any way to + Q. I know it is probably faster to fetch the tarballs from + one of the FreeBSD mirror sites close by. Is there any way to tell the port to fetch them from servers other than ones listed in the MASTER_SITES? - A. Yes. If you know, for example, ftp.FreeBSD.ORG is much + A. Yes. If you know, for example, ftp.FreeBSD.ORG is much closer than sites listed in MASTER_SITES, do as following example. @@ -781,43 +781,43 @@ do-install: - Q. I want to know what files make is going to need before + Q. I want to know what files make is going to need before it tries to pull them down. - A. make fetch-list will display a list of the files + A. make fetch-list will display a list of the files needed for a port. - Q. Is there any way to stop the port from compiling? I + Q. Is there any way to stop the port from compiling? I want to do some hacking on the source before I install it, but it is a bit tiresome having to watch it and hit control-C every time. - A. Doing make extract will stop it after it has fetched + A. Doing make extract will stop it after it has fetched and extracted the source code. - Q. I am trying to make my own port and I want to be able + Q. I am trying to make my own port and I want to be able to stop it compiling until I have had a chance to see if my - patches worked properly. Is there something like make + patches worked properly. Is there something like make extract, but for patches? - A. Yep, make patch is what you want. You will probably - find the PATCH_DEBUG option useful as well. And by the way, + A. Yep, make patch is what you want. You will probably + find the PATCH_DEBUG option useful as well. And by the way, thank you for your efforts! - Q. I have heard that some compiler options can cause bugs. + Q. I have heard that some compiler options can cause bugs. Is this true? How can I make sure that I compile ports with the right settings? - A. Yes, with version 2.6.3 of gcc (the version shipped + A. Yes, with version 2.6.3 of gcc (the version shipped with FreeBSD 2.1.0 and 2.1.5), the option could result in buggy code unless you used the option as - well. (Most of the ports don't use ). You + well. (Most of the ports don't use ). You should be able to specify the compiler options used by something like @@ -826,7 +826,7 @@ do-install: or by editing /etc/make.conf, but - unfortunately not all ports respect this. The surest way is to + unfortunately not all ports respect this. The surest way is to do make configure, then go into the source directory and inspect the Makefiles by hand, but this can get tedious if the source has lots of sub-directories, each with their own @@ -834,12 +834,12 @@ do-install: - Q. There are so many ports it is hard to find the one I - want. Is there a list anywhere of what ports are available? + Q. There are so many ports it is hard to find the one I + want. Is there a list anywhere of what ports are available? - A. Look in the INDEX file in - /usr/ports. If you would like to search the - ports collection for a keyword, you can do that too. For example, + A. Look in the INDEX file in + /usr/ports. If you would like to search the + ports collection for a keyword, you can do that too. For example, you can find ports relevant to the LISP programming language using: @@ -850,25 +850,25 @@ do-install: - Q. I went to install the foo port but the system + Q. I went to install the foo port but the system suddenly stopped compiling it and starting compiling the bar - port. What's going on? + port. What's going on? - A. The foo port needs something that is supplied with + A. The foo port needs something that is supplied with bar — for instance, if foo uses graphics, bar might have - a library with useful graphics processing routines. Or bar + a library with useful graphics processing routines. Or bar might be a tool that is needed to compile the foo port. - Q. I installed the grizzle + Q. I installed the grizzle program from the ports and frankly it is a complete waste of - disk space. I want to delete it but I do not know where it put - all the files. Any clues? + disk space. I want to delete it but I do not know where it put + all the files. Any clues? - A. No problem, just do + A. No problem, just do &prompt.root; pkg_delete grizzle-6.5 @@ -877,11 +877,11 @@ do-install: - Q. Hang on a minute, you have to know the version number to - use that command. You do not seriously expect me to remember + Q. Hang on a minute, you have to know the version number to + use that command. You do not seriously expect me to remember that, do you?? - A. Not at all, you can find it out by doing + A. Not at all, you can find it out by doing &prompt.root; pkg_info -a | grep grizzle @@ -891,13 +891,13 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. Talking of disk space, the ports directory seems to be - taking up an awful lot of room. Is it safe to go in there and + Q. Talking of disk space, the ports directory seems to be + taking up an awful lot of room. Is it safe to go in there and delete things? - A. Yes, if you have installed the program and are fairly + A. Yes, if you have installed the program and are fairly certain you will not need the source again, there is no point - in keeping it hanging around. The best way to do this + in keeping it hanging around. The best way to do this is @@ -910,19 +910,19 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. I tried that and it still left all those tarballs or + Q. I tried that and it still left all those tarballs or whatever you called them in the distfiles - directory. Can I delete those as well? + directory. Can I delete those as well? - A. Yes, if you are sure you have finished with them, those + A. Yes, if you are sure you have finished with them, those can go as well. - Q. I like having lots and lots of programs to play with. + Q. I like having lots and lots of programs to play with. Is there any way of installing all the ports in one go? - A. Just do + A. Just do &prompt.root; cd /usr/ports @@ -931,22 +931,22 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. OK, I tried that, but I thought it would take a very - long time so I went to bed and left it to get on with it. When + Q. OK, I tried that, but I thought it would take a very + long time so I went to bed and left it to get on with it. When I looked at the computer this morning, it had only done three - and a half ports. Did something go wrong? + and a half ports. Did something go wrong? - A. No, the problem is that some of the ports need to ask + A. No, the problem is that some of the ports need to ask you questions that we cannot answer for you (eg “Do you want to print on A4 or US letter sized paper?”) and they need to have someone on hand to answer them. - Q. I really do not want to spend all day staring at the - monitor. Any better ideas? + Q. I really do not want to spend all day staring at the + monitor. Any better ideas? - A. OK, do this before you go to bed/work/the local + A. OK, do this before you go to bed/work/the local park:- @@ -955,7 +955,7 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc This will install every port that does - not require user input. Then, when you + not require user input. Then, when you come back, do @@ -967,12 +967,12 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. At work, we are using frobble, which is in your ports + Q. At work, we are using frobble, which is in your ports collection, but we have altered it quite a bit to get it to do - what we need. Is there any way of making our own packages, so + what we need. Is there any way of making our own packages, so we can distribute it more easily around our sites? - A. No problem, assuming you know how to make patches for + A. No problem, assuming you know how to make patches for your changes:- @@ -986,10 +986,10 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. This ports stuff is really clever. I am desperate to - find out how you did it. What is the secret? + Q. This ports stuff is really clever. I am desperate to + find out how you did it. What is the secret? - A. Nothing secret about it at all, just look at the + A. Nothing secret about it at all, just look at the bsd.ports.mk and bsd.ports.subdir.mk files in your makefiles @@ -1011,27 +1011,27 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc Making a port yourself Contributed by &a.jkh;, &a.gpalmer;, &a.asami; - &a.obrien; and &a.hoek;. 28 August 1996. + &a.obrien; and &a.hoek;. 28 August 1996. So, now you are interested in making your own port? Great! What follows are some guidelines for creating a new port for - FreeBSD. The bulk of the work is done by + FreeBSD. The bulk of the work is done by /usr/share/mk/bsd.port.mk, which all port - Makefiles include. Please refer to that file for more details on - the inner workings of the ports collection. Even if you don't + Makefiles include. Please refer to that file for more details on + the inner workings of the ports collection. Even if you don't hack Makefiles daily, it is well commented, and you will still gain much knowledge from it. Only a fraction of the overridable variables (VAR) are mentioned - in this document. Most (if not all) are documented at the start of - bsd.port.mk. This file users a non-standard - tab setting. Emacs and + in this document. Most (if not all) are documented at the start of + bsd.port.mk. This file users a non-standard + tab setting. Emacs and Vim should recognise the setting on - loading the file. vi or ex + loading the file. vi or ex can be set to use the correct value by typing :set tabstop=4 once the file has been loaded. @@ -1039,7 +1039,7 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc Quick Porting - This section tells you how to do a quick port. In many + This section tells you how to do a quick port. In many cases, it is not enough, but we will see. First, get the original tarball and put it into DISTDIR, which defaults to @@ -1048,7 +1048,7 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc The following assumes that the software compiled out-of-the-box, i.e., there was absolutely no change required - for the port to work on your FreeBSD box. If you needed to + for the port to work on your FreeBSD box. If you needed to change something, you will have to refer to the next section too. @@ -1080,10 +1080,10 @@ USE_IMAKE= yes .include <bsd.port.mk> - See if you can figure it out. Do not worry about the + See if you can figure it out. Do not worry about the contents of the $Id$ line, it will be filled in automatically by CVS when the port - is imported to our main ports tree. You can find a more + is imported to our main ports tree. You can find a more detailed example in the sample Makefile section. @@ -1106,7 +1106,7 @@ USE_IMAKE= yes This is the one-line description of the port. Please do not include the package name (or version - number of the software) in the comment. Here is + number of the software) in the comment. Here is an example: @@ -1117,7 +1117,7 @@ A cat chasing a mouse all over the screen. <filename>DESCR</filename> - This is a longer description of the port. One to a few + This is a longer description of the port. One to a few paragraphs concisely explaining what the port does is sufficient. @@ -1127,7 +1127,7 @@ A cat chasing a mouse all over the screen. Please be careful if you are copying from the README or manpage; too often they are not a concise description of the port or are in an - awkward format (e.g., manpages have justified spacing). If the + awkward format (e.g., manpages have justified spacing). If the ported software has an official WWW homepage, you should list it here. @@ -1151,12 +1151,12 @@ asami@cs.berkeley.edu <filename>PLIST</filename> - This file lists all the files installed by the port. It + This file lists all the files installed by the port. It is also called the “packing list” because the package is - generated by packing the files listed here. The pathnames + generated by packing the files listed here. The pathnames are relative to the installation prefix (usually /usr/local or - /usr/X11R6). If you are using the + /usr/X11R6). If you are using the MANn variables (as you should be), do not list any manpages here. @@ -1175,13 +1175,13 @@ lib/X11/oneko/mouse.xpm You should list all the files, but not the name - directories, in the list. Also, if the port creates + directories, in the list. Also, if the port creates directories for itself during installtion, make sure to add @dirrm lines as necessary to remove them when the port is deleted. It is recommended that you keep all the filenames in - this file sorted alphabetically. It will make verifying the + this file sorted alphabetically. It will make verifying the changes when you upgrade the port much easier. @@ -1200,7 +1200,7 @@ lib/X11/oneko/mouse.xpm Testing the port You should make sure that the port rules do exactly what - you want it to do, including packaging up the port. These are + you want it to do, including packaging up the port. These are the important points you need to verify. @@ -1260,7 +1260,7 @@ lib/X11/oneko/mouse.xpm Make sure that there aren't any warnings issued in any of the package and deinstall stages, After step 3, check - to see if all the new directories are correctly deleted. Also, + to see if all the new directories are correctly deleted. Also, try using the software after step 4, to ensure that is works correctly when installed from a package. @@ -1269,8 +1269,8 @@ lib/X11/oneko/mouse.xpm Checking your port with <command>portlint</command> Please use portlint to see if your port - conforms to our guidelines. The portlint - program is part of the ports collection. In particular, your may + conforms to our guidelines. The portlint + program is part of the ports collection. In particular, your may want to check if the Makefile is in the right shape and the package is @@ -1285,10 +1285,10 @@ lib/X11/oneko/mouse.xpm Now that you are happy with your port, the only thing remaining is to put it in the main FreeBSD ports tree and make - everybody else happy about it too. We do not need your + everybody else happy about it too. We do not need your work directory or the pkgname.tgz package, so delete them - now. Next, simply include the output of shar `find + now. Next, simply include the output of shar `find port_dir` in a bug report and send it with the send-pr @@ -1298,15 +1298,15 @@ lib/X11/oneko/mouse.xpm about send-pr 1 - . If the uncompressed port is larger than + . If the uncompressed port is larger than 20KB, you should compress it into a tarfile and use uuencode 1 before including it in the bug report (uuencoded tarfiles are acceptable even if the bug report is smaller than - 20KB but are not preferred). Be sure to classify the bug report as + 20KB but are not preferred). Be sure to classify the bug report as category ports and class - change-request. (Do not mark the report + change-request. (Do not mark the report confidential!) One more time, do not include the original source @@ -1317,7 +1317,7 @@ lib/X11/oneko/mouse.xpm In the past, we asked you to upload new port submissions in our ftp site (ftp.freebsd.org). This is no longer + role="fqdn">ftp.freebsd.org). This is no longer recommended as read access is turned off on that incoming/ directory of that site due to the large amount of pirated software showing up there. @@ -1325,7 +1325,7 @@ lib/X11/oneko/mouse.xpm We will look at your port, get back to you if necessary, and put it in the - tree. Your name will also appear in the list of “Additional + tree. Your name will also appear in the list of “Additional FreeBSD contributors” on the FreeBSD Handbook and other files. Isn't that great?!? :) @@ -1336,7 +1336,7 @@ lib/X11/oneko/mouse.xpm Slow Porting Ok, so it was not that simple, and the port required some - modifications to get it to work. In this section, we will + modifications to get it to work. In this section, we will explain, step by step, how to modify it to get it to work with the ports paradigm. @@ -1352,39 +1352,39 @@ lib/X11/oneko/mouse.xpm But do not worry if you do not really understand what bsd.port.mk is doing, not many people - do... :> + do... :> - The fetch target is run. The fetch target is + The fetch target is run. The fetch target is responsible for making sure that the tarball exists locally in DISTDIR. If fetch cannot find the required files in DISTDIR it will look up the URL MASTER_SITES, which is set in the Makefile, as well as our main ftp site at ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/, where we put sanctioned distfiles as backup. It will then attempt to fetch the named distribution file with FETCH, assuming that the requesting site has direct access to the Internet. If that succeeds, it will save the file in DISTDIR for future use and proceed. + URL="ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/">ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/, where we put sanctioned distfiles as backup. It will then attempt to fetch the named distribution file with FETCH, assuming that the requesting site has direct access to the Internet. If that succeeds, it will save the file in DISTDIR for future use and proceed. - The extract target is run. It looks for your port's + The extract target is run. It looks for your port's distribution file (typically a gzip'd tarball) in DISTDIR and unpacks it into a temporary subdirectory specified by WRKDIR (defaults to work). - The patch target is run. First, any patches defined + The patch target is run. First, any patches defined in PATCHFILES are - applied. Second, if any patches are found in PATCHDIR (defaults to the + applied. Second, if any patches are found in PATCHDIR (defaults to the patches subdirectory), they are applied at this time in alphabetical order. - The configure target is run. This can do any one of + The configure target is run. This can do any one of many different things. @@ -1414,10 +1414,10 @@ lib/X11/oneko/mouse.xpm - The build target is run. This is responsible for + The build target is run. This is responsible for descending into the port's private working directory (WRKSRC) and - building it. If USE_GMAKE is set, GNU + building it. If USE_GMAKE is set, GNU make will be used, otherwise the system make will be used. @@ -1426,7 +1426,7 @@ lib/X11/oneko/mouse.xpm - The above are the default actions. In addition, you can + The above are the default actions. In addition, you can define targets pre-something or post-something, or put scripts with those names, in the scripts subdirectory, and they will be run before or after the default @@ -1438,14 +1438,14 @@ lib/X11/oneko/mouse.xpm post-extract target will be called after the regular extraction actions, and the pre-build script will be executed before - the default build rules are done. It is recommended that you + the default build rules are done. It is recommended that you use Makefile targets if the actions are simple enough, because it will be easier for someone to figure out what kind of non-default action the port requires. The default actions are done by the - bsd.port.mk targets do-something. For example, the - commands to extract a port are in the target do-extract. If you are not happy with + bsd.port.mk targets do-something. For example, the + commands to extract a port are in the target do-extract. If you are not happy with the default target, you can fix it by redefining the do-something target in your Makefile. @@ -1454,7 +1454,7 @@ lib/X11/oneko/mouse.xpm The “main” targets (e.g., extract, configure, etc.) do nothing more than make sure all the stages up to that one are completed and call the real targets or scripts, and they are not intended - to be changed. If you want to fix the extraction, fix + to be changed. If you want to fix the extraction, fix do-extract, but never ever touch extract! @@ -1471,7 +1471,7 @@ lib/X11/oneko/mouse.xpm Get the original sources (normally) as a compressed tarball (foo.tar.gz or foo.tar.Z) and copy it into - DISTDIR. Always use + DISTDIR. Always use mainstream sources when and where you can. @@ -1479,7 +1479,7 @@ lib/X11/oneko/mouse.xpm to the net, or can only find sites that have irritatingly non-standard formats, you might want to put a copy on a reliable ftp or http server that you control (e.g., your home - page). Make sure you set MASTER_SITES to + page). Make sure you set MASTER_SITES to reflect your choice. If you @@ -1488,23 +1488,23 @@ lib/X11/oneko/mouse.xpm public_html/ directory on freefall), we can “house” it ourselves by putting - it on ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/LOCAL_PORTS/ as the last resort. Please refer to this - location as MASTER_SITE_LOCAL. Send mail to + it on ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/LOCAL_PORTS/ as the last resort. Please refer to this + location as MASTER_SITE_LOCAL. Send mail to the &a.ports;if you are not sure what to do. If your port's distfile changes all the time for no good reason, consider putting the distfile in your home page and - listing it as the first MASTER_SITES. This + listing it as the first MASTER_SITES. This will prevent users from getting checksum mismatch errors, and also reduce the workload of - maintainers of our ftp site. Also, if there isonly one master + maintainers of our ftp site. Also, if there isonly one master site for the port, it is recommended that you house a backup at your site and list it as the second MASTER_SITES. If your port requires some additional `patches' that are available on the Internet, fetch them too and put them in - DISTDIR. Do not worry if + DISTDIR. Do not worry if they come from a site other than where you got the main source tarball, we have a way to handle these situations (see the description of Unpack a copy of the tarball in a private directory and make whatever changes are necessary to get the port to compile - properly under the current version of FreeBSD. Keep + properly under the current version of FreeBSD. Keep careful track of everything you do, as - you will be automating the process shortly. Everything, + you will be automating the process shortly. Everything, including the deletion, addition or modification of files should be doable using an automated script or patch file when your port is finished. @@ -1527,7 +1527,7 @@ lib/X11/oneko/mouse.xpm If your port requires significant user interaction/customization to compile or install, you should take a look at one of Larry Wall's classic Configure scripts - and perhaps do something similar yourself. The goal of the + and perhaps do something similar yourself. The goal of the new ports collection is to make each port as “plug-and-play” as possible for the end-user while using a minimum of disk space. @@ -1545,18 +1545,18 @@ lib/X11/oneko/mouse.xpm In the preparation of the port, files that have been added or changed can be picked up with a recursive diff for later - feeding to patch. Each set of patches you wish to apply + feeding to patch. Each set of patches you wish to apply should be collected into a file named patch-xx where xx denotes the sequence in which the patches will be applied — these are done in alphabetical order, thus - aa first, ab second and so on. These files + aa first, ab second and so on. These files should be stored in PATCHDIR, from where they will be - automatically applied. All patches should be relative to + automatically applied. All patches should be relative to WRKSRC (generally the directory your port's tarball unpacks itself into, that being - where the build is done). To make fixes and upgrades easier, + where the build is done). To make fixes and upgrades easier, you should avoid having more than one patch fix the same file (e.g., patch-aa and patch-ab both changing WRKSRC/foobar.c). @@ -1567,7 +1567,7 @@ lib/X11/oneko/mouse.xpm Include any additional customization commands to your configure script and save it in the - scripts subdirectory. As mentioned + scripts subdirectory. As mentioned above, you can also do this as Makefile targets and/or scripts with the name pre-configure or @@ -1580,7 +1580,7 @@ lib/X11/oneko/mouse.xpm If your port requires user input to build, configure or install, then set IS_INTERACTIVE in your - Makefile. This will allow “overnight builds” to skip your port + Makefile. This will allow “overnight builds” to skip your port if the user sets the variable BATCH in his environment (and if the user sets the variable INTERACTIVE, then only @@ -1589,7 +1589,7 @@ lib/X11/oneko/mouse.xpm It is also recommended that if there are reasonable default answers to the questions, you check the PACKAGE_BUILDING variable and turn off the - interactive script when it is set. This will allow us to build + interactive script when it is set. This will allow us to build the packages for CD-ROMs and ftp. @@ -1612,9 +1612,9 @@ lib/X11/oneko/mouse.xpm The original source Does it live in DISTDIR as a standard gzip'd - tarball? If so, you can go on to the next step. If not, you + tarball? If so, you can go on to the next step. If not, you should look at overriding any of the EXTRACT_CMD, EXTRACT_BEFORE_ARGS, EXTRACT_AFTER_ARGS, EXTRACT_SUFX, or DISTFILES variables, depending on - how alien a format your port's distribution file is. (The + how alien a format your port's distribution file is. (The most common case is EXTRACT_SUFX=.tar.Z, when the tarball is condensed by regular compress, not gzip.) @@ -1630,7 +1630,7 @@ lib/X11/oneko/mouse.xpm <makevar>DISTNAME</makevar> You should set DISTNAME to be the base name of - your port. The default rules expect the distribution file + your port. The default rules expect the distribution file list (DISTFILES) to be named DISTNAMEEXTRACT_SUFX which, if it is a normal tarball, is going to be something like foozolix-1.0.tar.gz for a setting of DISTNAME=foozolix-1.0. @@ -1640,8 +1640,8 @@ lib/X11/oneko/mouse.xpm work/DISTNAME, e.g. work/foozolix-1.0/. All this behavior can be overridden, of course; it simply - represents the most common time-saving defaults. For a port - requiring multiple distribution files, simply set DISTFILES explicitly. If only a + represents the most common time-saving defaults. For a port + requiring multiple distribution files, simply set DISTFILES explicitly. If only a subset of DISTFILES are actual extractable archives, then set them up in EXTRACT_ONLY, which will override the DISTFILES list when @@ -1657,7 +1657,7 @@ lib/X11/oneko/mouse.xpm If DISTNAME does not conform to our guidelines for a good package name, you should set the PKGNAME - variable to something better. See the abovementioned guidelines + variable to something better. See the abovementioned guidelines for more details. @@ -1667,29 +1667,29 @@ lib/X11/oneko/mouse.xpm When a package is created, it is put under /usr/ports/packages/All and links are made from one or more subdirectories of - /usr/ports/packages. The names of these - subdirectories are specified by the variable CATEGORIES. It is intended to + /usr/ports/packages. The names of these + subdirectories are specified by the variable CATEGORIES. It is intended to make life easier for the user when he is wading through the - pile of packages on the ftp site or the CD-ROM. Please take a + pile of packages on the ftp site or the CD-ROM. Please take a look at the existing categories and pick the ones that are suitable for your port. This list also determines where in the ports tree the port - is imported. If you put more than one category here, it is + is imported. If you put more than one category here, it is assumed that the port files will be put in the subdirectory with - the name in the first category. See the categories section for more discussion about how to pick the right categories. If you port truly belongs to something that is different from all the existing ones, you can even create a new category - name. In that case, please send mail to the &a.ports; to propose + name. In that case, please send mail to the &a.ports; to propose a new category. There is no error checking for category - names. make package will happily create a + names. make package will happily create a new directory if you mustype the category name, so be careful! @@ -1699,7 +1699,7 @@ lib/X11/oneko/mouse.xpm <makevar>MASTER_SITES</makevar> Record the directory part of the ftp/http-URL pointing at - the original tarball in MASTER_SITES. Do not forget the + the original tarball in MASTER_SITES. Do not forget the trailing slash (/)! The make macros will try to use this specification for @@ -1707,7 +1707,7 @@ lib/X11/oneko/mouse.xpm already on the system. It is recommended that you put multiple sites on this - list, preferably from different continents. This will + list, preferably from different continents. This will safeguard against wide-area network problems, and we are even planning to add support for automatically determining the closest master site and fetching from there! @@ -1717,8 +1717,8 @@ lib/X11/oneko/mouse.xpm Linux Sunsite, you refer to those sites in an easy compact form using MASTER_SITE_XCONTRIB, MASTER_SITE_GNU, MASTER_SITE_PERL_CPAN, MASTER_SITE_TEX_CTAN, and - MASTER_SITE_SUNSITE. Simply set MASTER_SITE_SUBDIR to the - path with in the archive. Here is an example: + MASTER_SITE_SUNSITE. Simply set MASTER_SITE_SUBDIR to the + path with in the archive. Here is an example: MASTER_SITES= ${MASTER_SITE_XCONTRIB} @@ -1755,10 +1755,10 @@ MASTER_SITE_SUBDIR= applications If the patch is distributed with some other files, such as documentation, in a gzip'd tarball, you can't just use - PATCHFILES. If that is + PATCHFILES. If that is the case, add the name and the location of the patch tarball to DISTFILES and - MASTER_SITES. Then, from + MASTER_SITES. Then, from the pre-patch target, apply the patch either by running the patch command from there, or copying the patch file into the PATCHDIR directory and calling it @@ -1769,7 +1769,7 @@ MASTER_SITE_SUBDIR= applications regular source by then, so there is no need to explicitly extract it if it is a regular gzip'd or compress'd tarball. If you do the latter, take extra care not to overwrite - something that already exists in that directory. Also do + something that already exists in that directory. Also do not forget to add a command to remove the copied patch in the pre-clean target. @@ -1779,7 +1779,7 @@ MASTER_SITE_SUBDIR= applications <makevar>MAINTAINER</makevar> - Set your mail-address here. Please. :) + Set your mail-address here. Please. :) For detailed description of the responsibility of maintainers, refer to Dependencies - Many ports depend on other ports. There are five + Many ports depend on other ports. There are five variables that you can use to ensure that all the required - bits will be on the user's machine. There are also some + bits will be on the user's machine. There are also some pre-supported dependency variables for common cases, plus a few more to control the behaviour of dependencies. @@ -1802,12 +1802,12 @@ MASTER_SITE_SUBDIR= applications <makevar>LIB_DEPENDS</makevar> This variable specifies the shared libraries this port - depends on. It is a list of lib:dir:target tuples where + depends on. It is a list of lib:dir:target tuples where lib is the name of the shared library, and dir is the directory in which to find it in case it is not available, and target is the target to call in - that directory. For example, + that directory. For example, LIB_DEPENDS= jpeg\\.9\\.:${PORTSDIR}/graphics/jpeg:install @@ -1816,19 +1816,19 @@ LIB_DEPENDS= jpeg\\.9\\.:${PORTSDIR}/graphics/jpeg:install major version 9, and descend into the graphics/jpeg subdirectory of your ports tree to build and install it if it is not - found. The target part can be + found. The target part can be omitted if it is equal to DEPENDS_TARGET (which defaults to install). The lib part is an argument - given to ldconfig -r | grep -wF. There + given to ldconfig -r | grep -wF. There shall be no reqular expressions in this variable. The dependency is checked twice, once from within the extract target and then from within - the install target. Also, the name of the + the install target. Also, the name of the dependency is put in to the package so that pkg_add will automatically install it if it is not on the user's system. @@ -1839,12 +1839,12 @@ LIB_DEPENDS= jpeg\\.9\\.:${PORTSDIR}/graphics/jpeg:install <makevar>RUN_DEPENDS</makevar> This variable specifies executables or files this port - depends on during run-time. It is a list of path:dir:target tuples where + depends on during run-time. It is a list of path:dir:target tuples where path is the name of the executable or file, and dir is the directory in which to find it in case it is not available, and target is the target to call in - that directory. If + that directory. If path starts with a slash (/), it is treated as a file and its existence is tested with test -e; @@ -1861,7 +1861,7 @@ RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \ will check if the file or directory /usr/local/etc/innd exists, and build and install it from the news/inn - subdirectory of the ports tree if it is not found. It will + subdirectory of the ports tree if it is not found. It will also see if an executable called wish8.0 is in your search path, and descend into the x11-toolkits/tk80 subdirectory of your ports tree to build and install it if it is not @@ -1874,10 +1874,10 @@ RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \ use the full pathname. - The dependency is checked from within the install target. Also, the name of the + The dependency is checked from within the install target. Also, the name of the dependency is put in to the package so that pkg_add will automatically install it if it - is not on the user's system. The + is not on the user's system. The target part can be omitted if it is the same DEPENDS_TARGET. @@ -1887,7 +1887,7 @@ RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \ <makevar>BUILD_DEPENDS</makevar> This variable specifies executables or files this port - requires to build. Like RUN_DEPENDS, it is + requires to build. Like RUN_DEPENDS, it is a list of path:dir:target tuples. For example, @@ -1902,8 +1902,8 @@ BUILD_DEPENDS= unzip:${PORTSDIR}/archivers/unzip “build” here means everything from extracting to - compilation. The dependency is checked from within the - extract target. The + compilation. The dependency is checked from within the + extract target. The target part can be omitted if it is the same as DEPENDS_TARGET @@ -1913,8 +1913,8 @@ BUILD_DEPENDS= unzip:${PORTSDIR}/archivers/unzip <makevar>FETCH_DEPENDS</makevar> This variable specifies executables or files this port - requires to fetch. Like the previous two, it is a list of - path:dir:target tuples. For + requires to fetch. Like the previous two, it is a list of + path:dir:target tuples. For example, @@ -1926,7 +1926,7 @@ FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2 tree to build and install it if it is not found. The dependency is checked from within the - fetch target. The + fetch target. The target part can be omitted if it is the same as DEPENDS_TARGET. @@ -1938,8 +1938,8 @@ FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2 If there is a dependency that does not fall into either of the above four categories, or your port requires to have the source of the other port extracted in addition to having - them installed, then use this variable. This is a list of - dir:target, as there is nothing to check, unlike the previous four. The target part can be omitted if it is the same as DEPENDS_TARGET. + them installed, then use this variable. This is a list of + dir:target, as there is nothing to check, unlike the previous four. The target part can be omitted if it is the same as DEPENDS_TARGET. @@ -1947,15 +1947,15 @@ FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2 Define USE_XLIB=yes if your port requires the X Window System to be installed (it is implied by - USE_IMAKE). Define + USE_IMAKE). Define USE_GMAKE=yes if your port requires GNU make instead of BSD - make. Define + make. Define USE_AUTOCONF=yes if your port requires GNU - autoconf to be run. Define USE_QT=yes if - your port uses the latest qt toolkit. Use + autoconf to be run. Define USE_QT=yes if + your port uses the latest qt toolkit. Use USE_PERL5=yes if your port requires version - 5 of the perl language. (The last is especially important since + 5 of the perl language. (The last is especially important since some versions of FreeBSD has perl5 as part of the base system while others don't.) @@ -1965,25 +1965,25 @@ FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2 As mentioned above, the default target to call when a dependency is required is - DEPENDS_TARGET. It defaults to - install. This is a user variable; is is - never defined in a port's Makefile. If + DEPENDS_TARGET. It defaults to + install. This is a user variable; is is + never defined in a port's Makefile. If your port needs a special way to handle a dependency, use the :target part of the *_DEPENDS variables instead of redefining DEPENDS_TARGET. When you type make clean, its - dependencies are automatically cleaned too. If you do not wish + dependencies are automatically cleaned too. If you do not wish this to happen, define the variable NOCLEANDEPENDS in your environment. To depend on another port unconditionally, it is customary to use the string nonexistent as the first field of BUILD_DEPENDS or - RUN_DEPENDS. Use this only when you need to - the to get to the source of the other port. You can often save - compilation time by specifying the target too. For + RUN_DEPENDS. Use this only when you need to + the to get to the source of the other port. You can often save + compilation time by specifying the target too. For instance @@ -1992,10 +1992,10 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract will always descend to the JPEG port and extract it. Do not use DEPENDS unless there is no - other way the behaviour you want can be accomplished. It will + other way the behaviour you want can be accomplished. It will cause the other port to be always build (and installed, by default), and the dependency will go into the packages as - well. If this is really what you need, I recommend you + well. If this is really what you need, I recommend you write it as BUILD_DEPENDS and RUN_DEPENDS instead—at least the intention will be clear. @@ -2006,19 +2006,19 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract Building mechanisms If your package uses GNU make, set - USE_GMAKE=yes. If your package uses + USE_GMAKE=yes. If your package uses configure, set - HAS_CONFIGURE=yes. If your package uses GNU + HAS_CONFIGURE=yes. If your package uses GNU configure, set GNU_CONFIGURE=yes (this implies - HAS_CONFIGURE). If you want to give some + HAS_CONFIGURE). If you want to give some extra arguments to configure (the default argument list --prefix=${PREFIX} for GNU configure and empty for non-GNU configure), set those extra arguments in - CONFIGURE_ARGS. If your package uses GNU + CONFIGURE_ARGS. If your package uses GNU autoconf, set - USE_AUTOCONF=yes. This implies + USE_AUTOCONF=yes. This implies GNU_CONFIGURE, and will cause autoconf to be run before configure. @@ -2026,9 +2026,9 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract If your package is an X application that creates Makefiles from Imakefiles using imake, then set - USE_IMAKE=yes. This will cause the + USE_IMAKE=yes. This will cause the configure stage to automatically do an xmkmf - -a. If the flag is a + -a. If the flag is a problem for your port, set XMKMF=xmkmf. If the port uses imake but does not understand the @@ -2040,7 +2040,7 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract If your port's source Makefile has something else than all as the main build target, set ALL_TARGET - accordingly. Same goes for install and + accordingly. Same goes for install and INSTALL_TARGET. @@ -2049,7 +2049,7 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract Special considerations There are some more things you have to take into account when - you create a port. This section explains the most common of + you create a port. This section explains the most common of those. @@ -2068,7 +2068,7 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract pair to your pkg/PLIST file so that a user who installed the package can start using teh shared libraru immediately and deinstallation will not cause the system to - still believe the library is there. These lines should + still believe the library is there. These lines should immediately follow the line for the shared library itself, as in: @@ -2080,10 +2080,10 @@ lib/libtvl80.so.1 Never, ever, ever add a line that says ldconfig without any arguments to your Makefile or - pkg/PLIST. This will reset the shared + pkg/PLIST. This will reset the shared libraru cache to the contents of /usr/lib only, and will royally screw up the user's machine ("Help, xinit - does not run anymore after I install this port!"). Anybody who + does not run anymore after I install this port!"). Anybody who does this will be shot and cut in 65,536 pieces by a rusty knife and have is liver chopped out by a bunch of crows and will eternally rot to death in the deepest bowels of hell (not @@ -2096,7 +2096,7 @@ lib/libtvl80.so.1 Since FreeBSD is moving to ELF shortly after 3.0-RELEASE, we need to convert many ports that build shared libraries - to support ELF. Complicating this task is that a 3.0 + to support ELF. Complicating this task is that a 3.0 system can run as both ELF and a.out, and we wish to unofficially support the 2.2 as long as possible. Below are the guidelines on how to convert a.out only ports to @@ -2112,7 +2112,7 @@ lib/libtvl80.so.1 A.out libraries should be moved out of /usr/local/lib and similar to an - aout subdirectory. (If you don't move them + aout subdirectory. (If you don't move them out of the way, ELF ports will happily overwrite a.out libraries.) The move-aout-libs target in the 3.0-CURRENT src/Makefile (called from @@ -2125,16 +2125,16 @@ lib/libtvl80.so.1 Format The ports tree will build packages in the format the machine - is in. This means a.out for 2.2 and a.out or ELF for 3.0 depending - on what `objformat` returns. Also, once users + is in. This means a.out for 2.2 and a.out or ELF for 3.0 depending + on what `objformat` returns. Also, once users move a.out libraries to a subdirectory, building a.out libraries - will be unsupported. (I.e., it may still work if you know what you + will be unsupported. (I.e., it may still work if you know what you are doing, but you are on your own.) If a port only works for a.out, set BROKEN_ELF to a string describing the reason - why. Such ports will be skipped during a build on an ELF + why. Such ports will be skipped during a build on an ELF system. @@ -2146,10 +2146,10 @@ lib/libtvl80.so.1 PORTOBJFORMAT to aout or elf and export it in the environments CONFIGURE_ENV, SCRIPTS_ENV and - MAKE_ENV. (It's always going to be + MAKE_ENV. (It's always going to be aout in 2.2-STABLE). It is also passed to PLIST_SUB as - PORTOBJFORMAT=${PORTOBJFORMAT}. (See comment + PORTOBJFORMAT=${PORTOBJFORMAT}. (See comment on ldconfig lines below.) The variable is set using this line in @@ -2159,7 +2159,7 @@ lib/libtvl80.so.1 PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout Ports' make processes should use this variable to decide what - to do. However, if the port's configure + to do. However, if the port's configure script already automatically detects an ELF system, it is not necessary to refer to PORTOBJFORMAT. @@ -2178,7 +2178,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

libfoo.so.M where M is the single version number, and an a.out library should be called - libfoo.so.M.N where M is the major version and N is the the minor version number. Do not mix those; never install an ELF shared library called libfoo.so.N.M or an a.out shared library (or symlink) called libfoo.so.N. + libfoo.so.M.N where M is the major version and N is the the minor version number. Do not mix those; never install an ELF shared library called libfoo.so.N.M or an a.out shared library (or symlink) called libfoo.so.N. @@ -2194,7 +2194,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

You need to install a symlink from libfoo.so to libfoo.so.N to - make ELF linkers happy. Since it should be listed in + make ELF linkers happy. Since it should be listed in PLIST too, and it won't hurt in the a.out case (some ports even require the link for dynamic loading), you should just make this link regardless of the setting of @@ -2206,7 +2206,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

All port Makefiles are edited to remove minor numbers from LIB_DEPENDS, and also to have the regexp - support removed. (E.g., foo\\.1\\.\\(33|40\\) + support removed. (E.g., foo\\.1\\.\\(33|40\\) becomes foo.2.) They will be matched using grep -wF. @@ -2216,7 +2216,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

PLIST should contain the short (ELF) shlib names if the a.out minor number is zero, and the long - (a.out) names otherwise. bsd.port.mk will + (a.out) names otherwise. bsd.port.mk will automatically add .0 to the end of short shlib lines if PORTOBJFORMAT equals aout, and will delete the minor number from @@ -2227,7 +2227,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

NO_FILTER_SHLIBS. This will turn off the + NO_FILTER_SHLIBS. This will turn off the editing of PLIST mentioned in the previous paragraph. @@ -2259,16 +2259,16 @@ ${SETENV} OBJFORMAT=${PORTOBJFORMAT} ${LDCONFIG} -m .... packages by having a variable (for instance, resolution, or paper size) take different values, create one subdirectory per package to make it easier forusers to see what to do, but try to share as - many files as possible between ports. Typically you only need a + many files as possible between ports. Typically you only need a very short Makefile in all but one of the - directories if you use variables cleverly. In the sole + directories if you use variables cleverly. In the sole Makefiles, you can use MASTERDIR to specify the directory where the - rest of the files are. Also, use a variable as part of + rest of the files are. Also, use a variable as part of PKGNAME so the packages will have different names. - This will be best demonstrated by an example. This is part of + This will be best demonstrated by an example. This is part of japanese/xdvi300/Makefile; @@ -2284,7 +2284,7 @@ RESOLUTION?= 300 .endif japanese/xdvi300 also has all the regular - patches, package files, etc. If you type make + patches, package files, etc. If you type make there, it will take the default value for the resolution (300) and build the port normally. @@ -2299,12 +2299,12 @@ MASTERDIR= ${.CURDIR}/../xdvi300 .include ${MASTERDIR}/Makefile (xdvi240/Makefile and - xdvi400/Makefile are similar). The + xdvi400/Makefile are similar). The MASTERDIR definition tells bsd.port.mk that the refulat set of subdirectories like PATCHDIR and PKGDIR are to be found under - xdvi300. The + xdvi300. The RESOLUTION=118 line will override the RESOLUTION=300 line in xdvi300/Makefile and the port will be built @@ -2316,31 +2316,31 @@ MASTERDIR= ${.CURDIR}/../xdvi300 First, please read our policy on shared library versioning to understand - what to do with shared library versions in general. Do + what to do with shared library versions in general. Do not blindly assume software authors know what they are - doing; many of them do not. It is very important that + doing; many of them do not. It is very important that these details are carefully considered, as we have quite a unique situation where we are trying to have dozens of potentially incompatible software pairs co-exist. Careless port imports have caused great trouble regarding shared libraries in the past (ever wondered why the port jpeg-6b has a shared library version of 9.0?). - If in doubt, send a message to the &a.ports;. Most of the + If in doubt, send a message to the &a.ports;. Most of the time, your job ends by determining the right shared library version and making appropriate patches to implement it. However, if there is a port which is a different version of the same software already in the tree, the situation is - much more complex. In short, the FreeBSD implementation + much more complex. In short, the FreeBSD implementation does not allow the user to specify to the linker which version of shared library to link against (the linker will - always pick the highest numbered version). This means, if + always pick the highest numbered version). This means, if there is a libfoo.so.3.2 and libfoo.so.4.0 in the system, there is no way to tell the linker to link a - particular application to libfoo.so.3.2. It is + particular application to libfoo.so.3.2. It is essentially completely overshadowed in terms of - compilation-time linkage. In this case, the only solution + compilation-time linkage. In this case, the only solution is to rename the base part of the shared library. For instance, change libfoo.so.4.0 to libfoo4.so.1.0 so both version 3.2 and 4.0 can be @@ -2354,7 +2354,7 @@ MASTERDIR= ${.CURDIR}/../xdvi300 add any manpages to pkg/PLIST (this means you must not list manpages in the PLIST—see generating PLIST for more). It + linkend="porting-plist">generating PLIST for more). It also makes the install stage automatically compress or uncompress manpages depending on the setting of NOMANCOMPRESS in @@ -2418,7 +2418,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz There are many programs that require a Motif library (available from several commercial vendors, while there is a free clone reported to be able to run many applications in - x11-toolkits/lesstif) to compile. Since + x11-toolkits/lesstif) to compile. Since it is a popular toolkit and their licenses usually permit redistribution of statically linked binaries, we have made special provisions for handling ports that require Motif in a @@ -2430,7 +2430,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz <makevar>REQUIRES_MOTIF</makevar> If your port requires Motif, define this variable in the - Makefile. This will prevent people who don't own a copy of + Makefile. This will prevent people who don't own a copy of Motif from even attempting to build it. @@ -2439,7 +2439,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz This variable will be set by bsd.port.mk to be the appropriate reference - to the Motif library. Please patch the source to use this + to the Motif library. Please patch the source to use this wherever the Motif library is referenced in the Makefile or Imakefile. @@ -2473,7 +2473,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz If your port installs fonts for the X Window system, put them in X11BASE/lib/X11/fonts/local. - This directory is new to XFree86 release 3.3.3. If it does not + This directory is new to XFree86 release 3.3.3. If it does not exist, please create it, and print out a message urging the user to update their XFree86 to 3.3.3 or newer, or at least add this directory to the font path in @@ -2485,12 +2485,12 @@ ${PREFIX}/man/ja/man4/baz.4.gz The new version of texinfo (included in 2.2.2-RELEASE and onwards) contains a utility called install-info - to add and delete entries to the dir file. If + to add and delete entries to the dir file. If your port installs any info documents, please follow this instructions so your port/package will correctly update the user's PREFIX/info/dir - file. (Sorry for the length of this section, but is it imperative - to weave all the info files together. If done correctly, it will + file. (Sorry for the length of this section, but is it imperative + to weave all the info files together. If done correctly, it will produce a beautiful listing, so please bear with me! @@ -2517,14 +2517,14 @@ Options: Here's a seven-step procedure to convert ports to use - install-info. I will use + install-info. I will use editors/emacs as an example. Look at the texinfo sources and make a patch to insert @dircategory and @direntry - statements to files that don't have them. This is part of + statements to files that don't have them. This is part of my patch: @@ -2543,10 +2543,10 @@ Options: @finalout : - The format should be self-explanatory. Many authors + The format should be self-explanatory. Many authors leave a dir file in the source tree that contains all the entries you need, so look around - before you try to write your own. Also, make sure you + before you try to write your own. Also, make sure you look into related ports and make the section names and entry indentations consistent (we recommend that all entry text start at the 4th tab stop). @@ -2563,15 +2563,15 @@ Options: entries to install-info as arguments ( and ) instead of patching the texinfo - sources. I do not think this is a good idea for ports + sources. I do not think this is a good idea for ports because you need to duplicate the same information in three places (Makefile and @exec/@unexec of - PLIST; see below). However, if you + PLIST; see below). However, if you have a Japanese (or other multibyte encoding) info files, you will have to use the extra arguments to install-info because makeinfo can't handle those texinfo - sources. (See Makefile and + sources. (See Makefile and PLIST of japanese/skk for examples on how to do this). @@ -2583,7 +2583,7 @@ Options: Since the texinfo sources are newer than the info files, they should be rebuilt when you type make; but many Makefiles don't include correct - dependencies for info files. In emacs' case, I had to + dependencies for info files. In emacs' case, I had to patch the main Makefile.in so it will descend into the man subdirectory to rebuild the info pages. @@ -2614,7 +2614,7 @@ Options: The second hunk was necessary because the default target in the man subdir is called info, while the main - Makefile wants to call all. I also deleted the installation + Makefile wants to call all. I also deleted the installation of the info info file because we already have one with the same name in /usr/share/info (that patch is not @@ -2624,8 +2624,8 @@ Options: If there is a place in the Makefile that is installing the - dir file, delete it. Your - port may not be doing it. Also, remove any commands that + dir file, delete it. Your + port may not be doing it. Also, remove any commands that are otherwise mucking around with the dir file. @@ -2653,7 +2653,7 @@ Options: (This step is only necessary if you are modifying an existing port.) Take a look at pkg/PLIST and delete anything that is - trying to patch up info/dir. They + trying to patch up info/dir. They may be in pkg/INSTALL or some other file, so search extensively. @@ -2680,7 +2680,7 @@ diff -u -r1.15 PLIST Add a post-install target to the Makefile to create a - dir file if it is not there. Also, + dir file if it is not there. Also, call install-info with the installed info files. @@ -2708,7 +2708,7 @@ diff -u -r1.26 Makefile Do not use anything other than /usr/share/info/dir and the above - command to create a new info file. In fact, I'd add the + command to create a new info file. In fact, I'd add the first three lines of the above patch to bsd.port.mk if you (the porter) wouldn't have to do it in PLIST by @@ -2760,7 +2760,7 @@ diff -u -r1.15 PLIST - Test and admire your work. :). Check the dir file before and after each + Test and admire your work. :). Check the dir file before and after each step. @@ -2778,14 +2778,14 @@ diff -u -r1.15 PLIST <filename>MESSAGE</filename> If you need to display a message to the installer, you may - place the message in pkg/MESSAGE. This + place the message in pkg/MESSAGE. This capability is often useful to display additional installation steps to be taken after a pkg_add or to display licensing information. The pkg/MESSAGE file does not need to - be added to pkg/PLIST. Also, it will not get + be added to pkg/PLIST. Also, it will not get automatically printed if the user is using the port, not the package, so you should probably display it from the post-install target yourself. @@ -2797,13 +2797,13 @@ diff -u -r1.15 PLIST If your port needs to execute commands when the binary package is installed with pkg_add you can do this via the - pkg/INSTALL script. This script will + pkg/INSTALL script. This script will automatically be added to the package, and will be run twice by - pkg_add. The first time will as + pkg_add. The first time will as INSTALL ${PKGNAME} PRE-INSTALL and the second time as INSTALL ${PKGNAME} - POST-INSTALL. $2 can be - tested to determine which mode the script is being run in. The + POST-INSTALL. $2 can be + tested to determine which mode the script is being run in. The PKG_PREFIX environmental variable will be set to the package installation directory. See pkg_add @@ -2823,7 +2823,7 @@ diff -u -r1.15 PLIST If your port needs to determine if it should install or not, you can create a pkg/REQ - “requirements” script. It will be invoked + “requirements” script. It will be invoked automatically at installation/deinstallation time to determine whether or not installation/deinstallation should proceed. @@ -2833,13 +2833,13 @@ diff -u -r1.15 PLIST Some ports, particularly the p5- ports, need to change their PLIST depending on what options they are - configured with (or version of perl, in the case of p5- ports). To + configured with (or version of perl, in the case of p5- ports). To make this easy, any instances in the PLIST of %%OSREL%%, %%PERL_VER%%, and %%PERL_VERSION%% will be substituted for - appropriately. The value of %%OSREL%% is the + appropriately. The value of %%OSREL%% is the numeric revision of the operating system (e.g., - 2.2.7). %%PERL_VERSION%% is + 2.2.7). %%PERL_VERSION%% is the full version number of perl (e.g., 5.00502) and %%PERL_VER%% is the perl version number minus the patchlevel (e.g., 5.005). @@ -2886,7 +2886,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} All the filenames in the pkg subdirectory are defined using variables so you can change them in your - Makefile if need be. This is especially useful when you + Makefile if need be. This is especially useful when you are sharing the same pkg subdirectory among several ports or have to write to one of the above files (see writing to places other than @@ -2946,7 +2946,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} Please change these variables rather than overriding - PKG_ARGS. If you change + PKG_ARGS. If you change PKG_ARGS, those files will not correctly be installed in /var/db/pkg upon install from a port. @@ -2958,7 +2958,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} Some software packages have restrictive licenses or can be in violation to the law (PKP's patent on public key crypto, ITAR - (export of crypto software) to name just two of them). What we + (export of crypto software) to name just two of them). What we can do with them varies a lot, depending on the exact wordings of the respective licenses. @@ -2967,7 +2967,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} licensing terms of the software and make sure that the FreeBSD project will not be held accountable of violating them by redistributing the source or compiled binaries either via ftp - or CD-ROM. If in doubt, please contact the &a.ports;. + or CD-ROM. If in doubt, please contact the &a.ports;. There are two variables you can set in the Makefile to @@ -2979,9 +2979,9 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} If the port has a “do not sell for profit” type of license, set the variable NO_CDROM to a - string describing the reason why. We + string describing the reason why. We will make sure such ports won't go into the CD-ROM come - release time. The distfile and package will still be + release time. The distfile and package will still be available via ftp. @@ -2990,9 +2990,9 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} for each site, or the resulting binary package can't be distributed due to licensing; set the variable NO_PACKAGE to a string describing the - reason why. We will make sure such + reason why. We will make sure such packages won't go on the ftp site, nor into the CD-ROM - come release time. The distfile will still be included on + come release time. The distfile will still be included on both however. @@ -3000,7 +3000,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} If the port has legal restrictions on who can use it (e.g., crypto stuff) or has a “no commercial use” license, set the variable RESTRICTED to be the - string describing the reason why. For such ports, the + string describing the reason why. For such ports, the distfiles/packages will not be available even from our ftp sites. @@ -3024,12 +3024,12 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} When you notice that a port is out of date compared to the latest version from the original authors, first make sure you - have the latest port. You can find them in the + have the latest port. You can find them in the ports/ports-current directory of the ftp mirror sites. The next step is to send a mail to the maintainer, if one is - listed in the port's Makefile. That person may already be + listed in the port's Makefile. That person may already be working on an upgrade, or have a reason to not upgrade the port right now (because of, for example, stability problems of the new version). @@ -3043,12 +3043,12 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} and the original as in our tree is superedit.bak, then send us the result of diff -ruN superedit.bak - superedit). Please examine the output to make - sure all the changes make sense. The best way to send us the + superedit). Please examine the output to make + sure all the changes make sense. The best way to send us the diff is by including it to send-pr1 - (category ports). Please mention any added or deleted files + (category ports). Please mention any added or deleted files in the message, as they have to be explicitly specified to CVS - when doing a commit. If the diff is more than about 20KB, please + when doing a commit. If the diff is more than about 20KB, please compress and uuencode it; otherwise, just include it in as is in the PR. @@ -3062,18 +3062,18 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} Here is a list of common do's and dont's that you encounter during the porting process.You should check your own port against this list, but you can also check ports in the PR - database that others have submitted. Submit any comments on + database that others have submitted. Submit any comments on ports you check as described in Bug - Reports and General Commentary. Checking ports in + Reports and General Commentary. Checking ports in the PR database will both make it faster for us to commit them, and prove that you know what you are doing. Strip Binaries - Do strip binaries. If the original source already strips the + Do strip binaries. If the original source already strips the binaries, fine; otherwise you should add a - post-install rule to to it yourself. Here is an + post-install rule to to it yourself. Here is an example; @@ -3084,7 +3084,7 @@ post-install: file 1 command on the installed executable to check - whether the binary is stripped or not. If it does not say + whether the binary is stripped or not. If it does not say not stripped, it is stripped. @@ -3127,10 +3127,10 @@ post-install: <makevar>WRKDIR</makevar> Do not write anything to files outside - WRKDIR. WRKDIR is the only + WRKDIR. WRKDIR is the only place that is guaranteed to be writable during the port build (see compiling ports from CDROM for an - example of building ports from a read-only tree). If you need to + example of building ports from a read-only tree). If you need to modigy some file in PKGDIR, do so by redefining a variable, not by writing over it. @@ -3140,8 +3140,8 @@ post-install: <makevar>WRKDIRPREFIX</makevar> Make sure your port honors - WRKDIRPREFIX. Most ports don't have to worry - about this. In particular, if you are referring to a + WRKDIRPREFIX. Most ports don't have to worry + about this. In particular, if you are referring to a WRKDIR of another port, note that the correct location is WRKDIRPREFIXPORTSDIR/subdir/name/work not PORTSDIR/subdir/name/work or .CURDIR/../../subdir/name/work or some such. @@ -3157,7 +3157,7 @@ post-install: You may come across code that needs modifications or conditional compilation based upon what version of UNIX it is - running under. If you need to make such changes to the code for + running under. If you need to make such changes to the code for conditional compilation, make sure you make the changes as general as possible so that we can back-port code to FreeBSD 1.x systems and cross-port to other BSD systems such as 4.4BSD from CSRG, @@ -3166,7 +3166,7 @@ post-install: The preferred way to tell 4.3BSD/Reno (1990) and newer versions of the BSD code apart is by using the BSD macro defined in - <sys/param.h>. Hopefully that file is + <sys/param.h>. Hopefully that file is already included; if not, add the code: @@ -3174,10 +3174,10 @@ post-install: #include <sys/param.h> #endif - to the proper place in the .c file. We + to the proper place in the .c file. We believe that every system that defines these two symbols has - sys/param.h. If you find a system that - doesn't, we would like to know. Please send mail to the + sys/param.h. If you find a system that + doesn't, we would like to know. Please send mail to the &a.ports;. Another way is to use the GNU Autoconf style of doing @@ -3212,10 +3212,10 @@ post-install: above). The value of the BSD macro is - 199506 for the 4.4BSD-Lite2 code base. This is - stated for informational purposes only. It should not be used to + 199506 for the 4.4BSD-Lite2 code base. This is + stated for informational purposes only. It should not be used to distinguish between versions of FreeBSD based only on 4.4-Lite vs. - versions that have merged in changes from 4.4-Lite2. The + versions that have merged in changes from 4.4-Lite2. The __FreeBSD__ macro should be used instead. @@ -3226,8 +3226,8 @@ post-install: __FreeBSD__ is defined in all - versions of FreeBSD. Use it if the change you are making - only affects FreeBSD. Porting gotchas like the use of + versions of FreeBSD. Use it if the change you are making + only affects FreeBSD. Porting gotchas like the use of sys_errlist[] vs strerror() are Berkeleyisms, not FreeBSD changes. @@ -3235,8 +3235,8 @@ post-install: In FreeBSD 2.x, __FreeBSD__ is - defined to be 2. In earlier - versions, it is 1. Later + defined to be 2. In earlier + versions, it is 1. Later versions will bump it to match their major version number. @@ -3244,12 +3244,12 @@ post-install: If you need to tell the difference between a FreeBSD 1.x system and a FreeBSD 2.x or 3.x system, usually the right answer is to use the BSD macros - described above. If there actually is a FreeBSD specific + described above. If there actually is a FreeBSD specific change (such as special shared library options when using ld) then it is OK to use __FreeBSD__ and #if __FreeBSD__ > 1 to detect a FreeBSD 2.x - and later system. If you need more granularity in + and later system. If you need more granularity in detecting FreeBSD systems since 2.0-RELEASE you can use the following: @@ -3463,12 +3463,12 @@ post-install: Note that 2.2-STABLE sometimes identifies itself as - “2.2.5-STABLE” after the 2.2.5-RELEASE. The pattern used to + “2.2.5-STABLE” after the 2.2.5-RELEASE. The pattern used to be year followed by the month, but we decided to change it to a more straightforward major/minor system starting from - 2.2. This is because the parallel development on several + 2.2. This is because the parallel development on several branches made it infeasible to classify the releases simply - by their real release dates. If you are making a port now, + by their real release dates. If you are making a port now, you don't have to worry about old -CURRENTs; they are listed here just for your reference. @@ -3476,7 +3476,7 @@ post-install: In the hundreds of ports that have been done, there have only been one or two cases where __FreeBSD__ - should have been used. Just because an earlier port screwed up + should have been used. Just because an earlier port screwed up and used it in the wrong place does not mean you should do so too. @@ -3486,7 +3486,7 @@ post-install: bsd.port.mk Do not write anything after the .include - <bsd.port.mk> line. it usually can be avoided by + <bsd.port.mk> line. it usually can be avoided by including bsd.port.pre.mk somewhere in the middle of your Makefile and bsd.port.post.mk at the end. @@ -3609,11 +3609,11 @@ post-install: If your software has some documentation other than the standard man and info pages that you think is useful for the user, install it under - PREFIX/share/doc. This can be + PREFIX/share/doc. This can be done, like the previous item, in the post-install target. - Create a new directory for your port. The directory name - should reflect what the port is. This usually means PKGNAME minus the version part. + Create a new directory for your port. The directory name + should reflect what the port is. This usually means PKGNAME minus the version part. However, if you think the user might want different versions of the port to be installed at the same time, you can use the whole PKGNAME. @@ -3636,7 +3636,7 @@ post-install: /etc/make.conf.) Also you can use the pkg/MESSAGE file to - display messages upon installation. See the using pkg/MESSAGE section for details. @@ -3651,12 +3651,12 @@ post-install: <makevar>DIST_SUBDIR</makevar> Do not let your port clutter - /usr/ports/distfiles. If your port + /usr/ports/distfiles. If your port requires a lot of files to be fetched, or contains a file that has a name that might conflict with other ports (e.g., Makefile), set DIST_SUBDIR to the name of the port (PKGNAME without the - version part should work fine). This will change DISTDIR from the default + version part should work fine). This will change DISTDIR from the default /usr/ports/distfiles to /usr/ports/distfiles/DIST_SUBDIR, and in effect puts everything that is required for your port @@ -3664,7 +3664,7 @@ post-install: It will also look at the subdirectory with the same name on the backup master site at - ftp.freebsd.org. (Setting DISTDIR explicitly in your + ftp.freebsd.org. (Setting DISTDIR explicitly in your Makefile will not accomplish this, so please use DIST_SUBDIR.) @@ -3691,10 +3691,10 @@ post-install: RCS strings - Do not put RCS strings in patches. CVS will mangle them + Do not put RCS strings in patches. CVS will mangle them when we put the files into the ports tree, and when we check them out again, they will come out different and the patch - will fail. RCS strings are surrounded by dollar ($) signs, and typically start with + will fail. RCS strings are surrounded by dollar ($) signs, and typically start with $Id or $RCS. @@ -3705,10 +3705,10 @@ post-install: Using the recurse () option to diff to generate patches is fine, but please take a look at the resulting patches to make - sure you don't have any unnecessary junk in there. In + sure you don't have any unnecessary junk in there. In particular, diffs between two backup files, Makefiles when the port uses Imake or GNU configure, etc., are unnecessary and - should be deleted. If you had to edit + should be deleted. If you had to edit configure.in and run autoconf to regenerate configure, do not take the diffs of @@ -3718,7 +3718,7 @@ post-install: Also, if you had to delete a file, then you can do it in the post-extract - target rather than as part of the patch. Once you are happy + target rather than as part of the patch. Once you are happy with the resulting diff, please split it up into one source file per patch file. @@ -3727,7 +3727,7 @@ post-install: <makevar>PREFIX</makevar> - Do try to make your port install relative to PREFIX. (The value of this + Do try to make your port install relative to PREFIX. (The value of this variable will be set to LOCALBASE (default /usr/local), unless USE_X_PREFIX or USE_IMAKE is set, in which case it will be X11BASE (default @@ -3736,7 +3736,7 @@ post-install: Not hard-coding /usr/local or /usr/X11R6 anywhere in the source will make the port much more flexible and able to cater to the - needs of other sites. For X ports that use imake, this is + needs of other sites. For X ports that use imake, this is automatic; otherwise, this can often be done by simply replacing the occurrences of /usr/local (or /usr/X11R6 for X ports that do not @@ -3751,12 +3751,12 @@ post-install: The variable PREFIX can be reassigned in your Makefile or in the user's - environment. However, it is strongly discouraged for + environment. However, it is strongly discouraged for individual ports to set this variable explicitly in the Makefiles. Also, refer to programs/files from other ports with the - variables mentioned above, not explicit pathnames. For + variables mentioned above, not explicit pathnames. For instance, if your port requires a macro PAGER to be the full pathname of less, use the compiler flag: @@ -3776,22 +3776,22 @@ post-install: Subdirectories Try to let the port put things in the right subdirectories - of PREFIX. Some ports + of PREFIX. Some ports lump everything and put it in the subdirectory with the port's - name, which is incorrect. Also, many ports put everything + name, which is incorrect. Also, many ports put everything except binaries, header files and manual pages in the a subdirectory of lib, which does not - bode well with the BSD paradigm. Many of the files should be + bode well with the BSD paradigm. Many of the files should be moved to one of the following: etc (setup/configuration files), libexec (executables started internally), sbin (executables for superusers/managers), info (documentation for info browser) or share (architecture independent - files). See man hier7 for + files). See man hier7 for details, the rules governing /usr pretty - much apply to /usr/local too. The - exception are ports dealing with USENET “news”. They may use + much apply to /usr/local too. The + exception are ports dealing with USENET “news”. They may use PREFIX/news as a destination for their files. @@ -3801,9 +3801,9 @@ post-install: Cleaning up empty directories Do make your ports clean up after themselves when they are - deinstalled. This is usually accomplished by adding + deinstalled. This is usually accomplished by adding @dirrm lines for all directories that are - specifically created by the port. You need to delete + specifically created by the port. You need to delete subdirectories before you can delete parent directories. @@ -3816,7 +3816,7 @@ lib/X11/oneko/sounds/cat.au @dirrm lib/X11/oneko However, sometimes @dirrm will give you - errors because other ports also share the same subdirectory. You + errors because other ports also share the same subdirectory. You can call rmdir from @unexec to remove only empty directories without warning. @@ -3836,16 +3836,16 @@ lib/X11/oneko/sounds/cat.au If your port requires a certain user to be on the installed system, let the pkg/INSTALL script call pw to create it - automatically. Look at net/cvsup-mirror + automatically. Look at net/cvsup-mirror for an example. If your port must use the same user/group ID number when it is installed a binarypackage as when it was compiled, then you mus - choose a free UID from 50 to 99 and register it below. Look at + choose a free UID from 50 to 99 and register it below. Look at japanese/Wnn for an example. Make sure you don't use a UID already used by the system - or other ports. This is the current list of UIDs between 50 + or other ports. This is the current list of UIDs between 50 and 99. @@ -3869,7 +3869,7 @@ qmailr:*:86:82:QMail user:/var/qmail:/nonexistent msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh Please include a notice when you submit a port (or an - upgrade) that reserves a new UID or GID in this range. This allows + upgrade) that reserves a new UID or GID in this range. This allows us to keep the list of reserved IDs up to date. @@ -3893,7 +3893,7 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh Respect <makevar>CFLAGS</makevar> The port should respect the CFLAGS - variable. If it doesn't, please add NO_PACKAGE=ignores + variable. If it doesn't, please add NO_PACKAGE=ignores cflags to the Makefile. @@ -3903,7 +3903,7 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh If your port requires some configuration files in PREFIX/etc, do not just install them and list them in - pkg/PLIST. That will cause + pkg/PLIST. That will cause pkg_delete to delete files carefully edited by the user and a new installation to wipe them out. @@ -3927,7 +3927,7 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh Feedback Do send applicable changes/patches to the original - author/maintainer for inclusion in next release of the code. This + author/maintainer for inclusion in next release of the code. This will only make your job that much easier for the next release. @@ -3937,7 +3937,7 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh The files pkg/DESCR, pkg/COMMENT, and - pkg/PLIST should each be double-checked. If + pkg/PLIST should each be double-checked. If you are reviewing a port and feel they can be worded better, do so. @@ -3965,13 +3965,13 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh A Sample <filename>Makefile</filename> Here is a sample Makefile that you can - use to create a new port. Make sure you remove all the extra + use to create a new port. Make sure you remove all the extra comments (ones between brackets)! It is recommended that you follow this format (ordering of - variables, empty lines between sections, etc.). This format is + variables, empty lines between sections, etc.). This format is designed so that the most important information is easy to - locate. We recommend that you use portlint to check the Makefile. @@ -4060,7 +4060,7 @@ pre-install: Package Names The following are the conventions you should follow in - naming your packages. This is to have our package directory + naming your packages. This is to have our package directory easy to scan, as there are already lots and lots of packages and users are going to turn away if they hurt their eyes! @@ -4075,9 +4075,9 @@ pre-install: FreeBSD strives to support the native language of its - users. The language- part should be a two letter + users. The language- part should be a two letter abbreviation of the natural language defined by ISO-639 if - the port is specific to a certain language. Examples are + the port is specific to a certain language. Examples are ja for Japanese, ru for Russian, vi for Vietnamese, zh for Chinese, ko for Korean and de for German. @@ -4085,17 +4085,17 @@ pre-install: The name part should be all lowercases, except for a really large - package (with lots of programs in it). Things like + package (with lots of programs in it). Things like XFree86 (yes there really is a port of it, check it - out) and ImageMagick fall into this category. Otherwise, + out) and ImageMagick fall into this category. Otherwise, convert the name (or at least the first letter) to - lowercase. If the capital letters are + lowercase. If the capital letters are important to the name (for example, with one-letter names like R or V) you may use capital letters at your discretion. There is a tradition of naming Perl 5 modules by prepending p5- and converting the double-colon separator to a hyphen; for example, the Data::Dumper module becomes - p5-Data-Dumper. If the software in question has numbers, + p5-Data-Dumper. If the software in question has numbers, hyphens, or underscores in its name, you may include them as well (like kinput2). @@ -4105,13 +4105,13 @@ pre-install: defaults (usually part of the directory name in a family of ports), the -compiled.specifics part should state the - compiled-in defaults (the hyphen is optional). Examples + compiled-in defaults (the hyphen is optional). Examples are papersize and font units. The version string should be a period-separated list - of integers and single lowercase alphabetics. The only + of integers and single lowercase alphabetics. The only exception is the string pl (meaning `patchlevel'), which can be used only when there are no major and minor version numbers in the software. @@ -4226,7 +4226,7 @@ pre-install: If there is absolutely no trace of version information in the original source and it is unlikely that the original author will ever release another version, just set the version string - to 1.0 (like the piewm example above). Otherwise, ask the + to 1.0 (like the piewm example above). Otherwise, ask the original author or use the date string (yy.mm.dd) as the version. @@ -4236,14 +4236,14 @@ pre-install: Categories As you already know, ports are classified in several - categories. But for this to wor, it is important that porters and + categories. But for this to wor, it is important that porters and users understand what each category and how we deicde what to put in each category. Current list of categories - First, this is the current list of port categories. Those + First, this is the current list of port categories. Those marked with an asterisk (*) are virtual categories—those that do not have a corresponding subdirectory in the ports tree. @@ -4307,7 +4307,7 @@ pre-install: comms - Communication software. Mostly software to talk to + Communication software. Mostly software to talk to your serial port. @@ -4329,7 +4329,7 @@ pre-install: devel - Development utilities. Do not put libraries here just + Development utilities. Do not put libraries here just because they are libraries—unless they truly don't belong to anywhere else, they shouldn't be in this category. @@ -4337,7 +4337,7 @@ pre-install: editors - General editors. Specialized editors go in the + General editors. Specialized editors go in the section for those tools (e.g., a mathematical-formula editor will go in math). @@ -4349,7 +4349,7 @@ pre-install: emulators - Emulators for other operating systems. Terminal + Emulators for other operating systems. Terminal emulators do not belong here—X-based ones should go to x11 and text-based ones to either @@ -4412,9 +4412,9 @@ pre-install: misc Miscellaneous utilities—basically things that - doesn't belong to anywhere else. This is the only category + doesn't belong to anywhere else. This is the only category that should not appear with any other non-virtual - category. If you have misc with + category. If you have misc with something else in your CATEGORIES line, that means you can safely delete misc and just put the port in that other subdirectory! @@ -4452,7 +4452,7 @@ pre-install: print - Printing software. Desktop publishing tools + Printing software. Desktop publishing tools (previewers, etc.) belong here too. @@ -4503,7 +4503,7 @@ pre-install: textproc - Text processing utilities. It does not include + Text processing utilities. It does not include desktop publishing tools, which go to print/. @@ -4540,7 +4540,7 @@ pre-install: www - Software related to the World Wide Web. HTML language + Software related to the World Wide Web. HTML language support belong here too. @@ -4551,7 +4551,7 @@ pre-install: Do not put regular X applications here. If your port is an X application, define USE_XLIB (implied by USE_IMAKE) and put it in - appropriate categories. Also, many of them go into other + appropriate categories. Also, many of them go into other x11-* categories (see below). @@ -4589,21 +4589,21 @@ pre-install: As many of the categories overlap, you often have to choose which of the categories should be the primary category of your - port. There are several rules that govern this usse. Here is the + port. There are several rules that govern this usse. Here is the list of priorities, in decreasing order of precedence. - Language specific categories alwasys come first. For + Language specific categories alwasys come first. For example, if your port installs Japanese X11 fonts, then your CATEGORIES line would read japanese x11. - Specific categories win over less-specific ones. For + Specific categories win over less-specific ones. For instance, an HTML editor should be listed as www - editors, not the other way around. Also, you don't + editors, not the other way around. Also, you don't need to list net when the port belongs to either of mail, mbone, news, security, or @@ -4612,7 +4612,7 @@ pre-install: x11 is used as a secondary category - only when the primary category is a natural language. In + only when the primary category is a natural language. In particular, you should not put x11 in the category line for X applications. @@ -4625,7 +4625,7 @@ pre-install: If you are not sure about the category, please put a comment to that effect in your send-pr submission so we - can discuss it before import it. (If you are a committer, send a + can discuss it before import it. (If you are a committer, send a note &a.ports; so we can discuss it first—too often new ports are imported to a wrong category only to be moved right away.) @@ -4636,8 +4636,8 @@ pre-install: Changes to this document and the ports system If you maintain a lot of ports, you should consider following - the &a.ports;. Important changes to - the way ports work will be announced there. You can always + the &a.ports;. Important changes to + the way ports work will be announced there. You can always find more detailed information on the latest changes by looking at diff --git a/en/handbook/ppp-and-slip/chapter.sgml b/en/handbook/ppp-and-slip/chapter.sgml index fa8199e611..fd9fa545d1 100644 --- a/en/handbook/ppp-and-slip/chapter.sgml +++ b/en/handbook/ppp-and-slip/chapter.sgml @@ -3,9 +3,9 @@ If your connection to the Internet is through a modem, or you wish to provide other people with dialup connections to the Internet using - FreeBSD, you have the option of using PPP or SLIP. Furthermore, two + FreeBSD, you have the option of using PPP or SLIP. Furthermore, two varieties of PPP are provided: user (sometimes - referred to as iijppp) and kernel. The + referred to as iijppp) and kernel. The procedures for configuring both types of PPP, and for setting up SLIP are described in this chapter. @@ -14,33 +14,33 @@ Setting up User PPP User PPP was introduced to FreeBSD in release 2.0.5 as an - addition to the existing kernel implementation of PPP. So, what is + addition to the existing kernel implementation of PPP. So, what is different about this new PPP that warrants its addition? To quote from the manual page:
- This is a user process PPP software package. Normally, PPP + This is a user process PPP software package. Normally, PPP is implemented as a part of the kernel (e.g. as managed by pppd) and it is thus somewhat hard to debug and/or modify its - behavior. However, in this implementation PPP is done as a user + behavior. However, in this implementation PPP is done as a user process with the help of the tunnel device driver (tun).
In essence, this means that rather than running a PPP daemon, - the ppp program can be run as and when desired. No PPP interface + the ppp program can be run as and when desired. No PPP interface needs to be compiled into the kernel, as the program can use the generic tunnel device to get data into and out of the kernel. From here on out, user ppp will be referred to simply as ppp unless a distinction needs to be made between it and any other PPP - client/server software such as pppd. Unless otherwise stated, all + client/server software such as pppd. Unless otherwise stated, all commands in this section should be executed as root. - There are a large number of enhancements in version 2 of ppp. You + There are a large number of enhancements in version 2 of ppp. You can discover what version you have by running ppp with no arguments - and typing show version at the prompt. It is a + and typing show version at the prompt. It is a simple matter to upgrade to the latest version of ppp (under any version of FreeBSD) by downloading the latest archive via www.Awfulhak.org. @@ -51,7 +51,7 @@ This document assumes you are in roughly this position: You have an account with an Internet Service Provider (ISP) - which lets you use PPP. Further, you have a modem (or other + which lets you use PPP. Further, you have a modem (or other device) connected and configured correctly which allows you to connect to your ISP. @@ -66,19 +66,19 @@ - Your login name and password. This can be either a + Your login name and password. This can be either a regular unix style login/password pair, or a PPP PAP or CHAP login/password pair. - The IP addresses of one or more nameservers. Normally, - you will be given two IP numbers. You + The IP addresses of one or more nameservers. Normally, + you will be given two IP numbers. You must have this information for PPP version 1.x unless you run - your own nameserver. From version 2 onwards, + your own nameserver. From version 2 onwards, PPP supports nameserver address - negotiation. If your ISP supports this, then using the command + negotiation. If your ISP supports this, then using the command enable dns in your config file will tell PPP to set the nameservers for you. @@ -92,7 +92,7 @@ The IP address of your ISP's gateway. The gateway is the machine to which you will connect and will be set up as your - default route. If your ISP hasn't given + default route. If your ISP hasn't given you this number, we can make one up and your ISP's PPP server will tell us the correct value when we connect. @@ -101,12 +101,12 @@ - Your ISP's netmask. If your ISP hasn't given you this + Your ISP's netmask. If your ISP hasn't given you this information, you can safely use a netmask of 255.255.255.0. If your ISP allocates you a static IP address and hostname - then you can enter this information. Otherwise, we simply let the + then you can enter this information. Otherwise, we simply let the peer assign whatever IP number it sees fit. @@ -120,18 +120,18 @@ Building a ppp ready kernel As the description states, ppp uses the kernel tun - device. It is necessary to make sure that your kernel has support + device. It is necessary to make sure that your kernel has support for this device compiled in. To check this, go to your kernel compile directory (/sys/i386/conf or /sys/pc98/conf) and examine your kernel - configuration file. It needs to have the line + configuration file. It needs to have the line pseudo-device tun 1 - in it somewhere. The stock GENERIC kernel + in it somewhere. The stock GENERIC kernel has this as standard, so if you have not installed a custom kernel or you do not have a /sys directory, you do not have to change anything. @@ -141,7 +141,7 @@ pseudo-device tun 1 example, if you are setting up a server and could have 16 dialup ppp connections at any one time then you will need to use 16 instead of 1), then you should add the line, re-compile, - re-install and boot the new kernel. Please refer to the + re-install and boot the new kernel. Please refer to the Configuring the FreeBSD Kernel section for more information on kernel configuration. @@ -161,32 +161,32 @@ tun3: flags=8010<POINTOPOINT,MULTICAST> mtu 1500 This case shows four tunnel devices, two of which are - currently configured and being used. It should be noted that the + currently configured and being used. It should be noted that the RUNNING flag above indicates that the interface has been used at some point—it is not an error if your interface does not show up as RUNNING. If you have a kernel without the tun device, and you can not - rebuild it for some reason, all is not lost. You should be able - to dynamically load the code. Refer to the appropriate modload8 + rebuild it for some reason, all is not lost. You should be able + to dynamically load the code. Refer to the appropriate modload8 and lkm4 pages for further details. You may also wish to take this opportunity to configure a - firewall. Details can be found in the Firewalls section. + firewall. Details can be found in the Firewalls section. Check the tun device - Most users will only require one tun device (/dev/tun0). If you + Most users will only require one tun device (/dev/tun0). If you have used more (i.e., a number other than 1 in the pseudo-device line in the kernel configuration file) then alter all references to tun0 below to reflect whichever device number you are using. The easiest way to make sure that the tun0 device is - configured correctly is to re-make it. To do this, execute the + configured correctly is to re-make it. To do this, execute the following commands: @@ -226,10 +226,10 @@ tun0: flags=8010<POINTOPOINT,MULTICAST> mtu 1500 Name Resolution Configuration The resolver is the part of the system that turns IP addresses - into hostnames and vice versa. It can be configured to look for + into hostnames and vice versa. It can be configured to look for maps that describe IP to hostname mappings in one of two places. The first is a file called /etc/hosts - (man 5 hosts). The second is the + (man 5 hosts). The second is the Internet Domain Name Service (DNS), a distributed data base, the discussion of which is beyond the scope of this document. @@ -238,8 +238,8 @@ tun0: flags=8010<POINTOPOINT,MULTICAST> mtu 1500 The resolver is a set of system calls that do the name mappings, but you have to tell them where to find their - information. You do this by first editing the file - /etc/host.conf. Do not call this file + information. You do this by first editing the file + /etc/host.conf. Do not call this file /etc/hosts.conf (note the extra s) as the results can be confusing. @@ -265,8 +265,8 @@ bind Edit the <filename>/etc/hosts</filename>(5) file This file should contain the IP addresses and names of - machines on your network. At a bare minimum it should contain - entries for the machine which will be running ppp. Assuming that + machines on your network. At a bare minimum it should contain + entries for the machine which will be running ppp. Assuming that your machine is called foo.bar.com with the IP address 10.0.0.1, /etc/hosts should contain: @@ -276,8 +276,8 @@ bind 10.0.0.1 foo.bar.com foo The first line defines the alias localhost as a synonym - for the current machine. Regardless of your own IP address, the - IP address for this line should always be 127.0.0.1. The second + for the current machine. Regardless of your own IP address, the + IP address for this line should always be 127.0.0.1. The second line maps the name foo.bar.com (and the shorthand foo) to the IP address 10.0.0.1. @@ -290,8 +290,8 @@ bind Edit the <filename>/etc/resolv.conf</filename> file /etc/resolv.conf tells the resolver how - to behave. If you are running your own DNS, you may leave this - file empty. Normally, you will need to enter the following + to behave. If you are running your own DNS, you may leave this + file empty. Normally, you will need to enter the following line(s): @@ -302,15 +302,15 @@ domain bar.com The x.x.x.x and y.y.y.y addresses are those given to you - by your ISP. Add as many nameserver lines as your ISP - provides. The domain line defaults to your hostname's - domain, and is probably unnecessary. Refer to the resolv.conf + by your ISP. Add as many nameserver lines as your ISP + provides. The domain line defaults to your hostname's + domain, and is probably unnecessary. Refer to the resolv.conf manual page for details of other possible entries in this file. If you are running PPP version 2 or greater, the enable dns command will tell PPP to request that your ISP - confirms the nameserver values. If your ISP supplies different + confirms the nameserver values. If your ISP supplies different addresses (or if there are no nameserver lines in /etc/resolv.conf), PPP will rewrite the file with the ISP-supplied values. @@ -322,12 +322,12 @@ domain bar.com Both user ppp and pppd (the kernel level implementation of PPP) use configuration files located in the - /etc/ppp directory. The sample configuration + /etc/ppp directory. The sample configuration files provided are a good reference for user ppp, so don't delete them. Configuring ppp requires that you edit a number of files, - depending on your requirements. What you put in them depends to + depending on your requirements. What you put in them depends to some extent on whether your ISP allocates IP addresses statically (i.e., you get given one IP address, and always use that one) or dynamically (i.e., your IP address can be different for each PPP @@ -338,7 +338,7 @@ domain bar.com PPP and Static IP addresses You will need to create a configuration file called - /etc/ppp/ppp.conf. It should look similar + /etc/ppp/ppp.conf. It should look similar to the example below. @@ -368,7 +368,7 @@ domain bar.com Line 1: - Identifies the default entry. Commands in this + Identifies the default entry. Commands in this entry are executed automatically when ppp is run. @@ -377,7 +377,7 @@ domain bar.com Identifies the device to which the modem is - connected. COM1: is /dev/cuaa0 and + connected. COM1: is /dev/cuaa0 and COM2: is /dev/cuaa1. @@ -385,7 +385,7 @@ domain bar.com Line 3: - Sets the speed you want to connect at. If 115200 + Sets the speed you want to connect at. If 115200 doesn't work (it should with any reasonably new modem), try 38400 instead. @@ -394,9 +394,9 @@ domain bar.com Line 4: - The dial string. User PPP uses an expect-send + The dial string. User PPP uses an expect-send syntax similar to the chat8 - program. Refer to the manual page for information on + program. Refer to the manual page for information on the features of this language. @@ -412,15 +412,15 @@ domain bar.com Line 6: - Sets the phone number for this provider. Multiple + Sets the phone number for this provider. Multiple phone numbers may be specified using the : or | - character as a separator. The difference between these - spearators is described in the ppp manual page. To + character as a separator. The difference between these + spearators is described in the ppp manual page. To summarize, if you want to rotate through the numbers, - use the :. If you want to always attempt to dial + use the :. If you want to always attempt to dial the first number first and only use the other numbers if - the first number fails, use the |. Always quote the + the first number fails, use the |. Always quote the entire set of phone numbers as shown. @@ -429,7 +429,7 @@ domain bar.com The login string is of the same chat-like syntax as - the dial string. In this example, the string works for + the dial string. In this example, the string works for a service whose login session looks like this: @@ -441,13 +441,13 @@ protocol: ppp You will need to alter this script to suit your own - needs. When you write this script for the first time, + needs. When you write this script for the first time, you should enable “chat” logging to ensure that the conversation is going as expected. If you're using PAP or CHAP, there will be no login at this point, so your login string can be left - blank. See + blank. See PAP and CHAP authentication for further details. @@ -457,8 +457,8 @@ protocol: ppp Sets the default timeout (in seconds) for the - connection. Here, the connection will be closed - automatically after 300 seconds of inactivity. If you + connection. Here, the connection will be closed + automatically after 300 seconds of inactivity. If you never want to timeout, set this value to zero. @@ -466,18 +466,18 @@ protocol: ppp Line 9: - Sets the interface addresses. The string x.x.x.x + Sets the interface addresses. The string x.x.x.x should be replaced by the IP address that your provider - has allocated to you. The string y.y.y.y should be + has allocated to you. The string y.y.y.y should be replaced by the IP address that your ISP indicated for - their gateway (the machine to which you connect). If + their gateway (the machine to which you connect). If your ISP hasn't given you a gateway address, use - 10.0.0.2/0. If you need + 10.0.0.2/0. If you need to use a “guessed” address, make sure that you create an entry in /etc/ppp/ppp.linkup as per the instructions for PPP and Dynamic - IP addresses. If this line is omitted, ppp cannot + IP addresses. If this line is omitted, ppp cannot run in or mode. @@ -486,9 +486,9 @@ protocol: ppp Line 10: - Adds a default route to your ISPs gateway. The + Adds a default route to your ISPs gateway. The special word HISADDR is replaced with - the gateway address specified on line 9. It is + the gateway address specified on line 9. It is important that this line appears after line 9, otherwise HISADDR will not yet be initialized. @@ -501,7 +501,7 @@ protocol: ppp This line tells PPP to ask your ISP to confirm that your - nameserver addresses are correct. If your ISP supports this + nameserver addresses are correct. If your ISP supports this facility, PPP can then update /etc/resolv.conf with the correct nameserver entries. @@ -512,8 +512,8 @@ protocol: ppp It is not necessary to add an entry to ppp.linkup when you have a static IP address as your routing table entries are already correct before - you connect. You may however wish to create an entry to invoke - programs after connection. This is explained later with the + you connect. You may however wish to create an entry to invoke + programs after connection. This is explained later with the sendmail example. Example configuration files can be found in the @@ -526,9 +526,9 @@ protocol: ppp If your service provider does not assign static IP numbers, ppp can be configured to negotiate - the local and remote addresses. This is done by “guessing” an + the local and remote addresses. This is done by “guessing” an IP number and allowing ppp to set it up correctly using the IP - Configuration Protocol (IPCP) after connecting. The + Configuration Protocol (IPCP) after connecting. The ppp.conf configuration is the same as PPP and Static IP addresses, with the following change: @@ -537,7 +537,7 @@ protocol: ppp 9 set ifaddr 10.0.0.1/0 10.0.0.2/0 255.255.255.0 Again, do not include the line numbers, they are just for - reference in this discussion. Indentation of at least one space + reference in this discussion. Indentation of at least one space is required. @@ -545,7 +545,7 @@ protocol: ppp Line 9: The number after the / character is the number - of bits of the address that ppp will insist on. You may + of bits of the address that ppp will insist on. You may wish to use IP numbers more appropriate to your circumstances, but the above example will always work. @@ -553,7 +553,7 @@ protocol: ppp The last argument (0.0.0.0) tells PPP to negotiate using address 0.0.0.0 rather than 10.0.0.1. Do not use + role="ipaddr">10.0.0.1. Do not use 0.0.0.0 as the first argument to set ifaddr as it prevents PPP from setting up an intial route in mode. @@ -566,7 +566,7 @@ protocol: ppp If you are running version 1.x of PPP, uou will also need to create an entry in /etc/ppp/ppp.linkup. ppp.linkup is used after a connection has - been established. At this point, ppp will know what IP + been established. At this point, ppp will know what IP addresses should really be used. The following entry will delete the existing bogus routes, and create correct ones: @@ -583,9 +583,9 @@ protocol: ppp On establishing a connection, ppp will look for an entry in ppp.linkup according to the following rules: First, try to match the same label - as we used in ppp.conf. If that + as we used in ppp.conf. If that fails, look for an entry for the IP number of our - gateway. This entry is a four-octet IP style label. If + gateway. This entry is a four-octet IP style label. If we still haven't found an entry, look for the MYADDR entry. @@ -618,12 +618,12 @@ protocol: ppp /etc/ppp/ppp.linkup.sample for a detailed example. - Version 2 of PPP introduces “sticky routes”. Any + Version 2 of PPP introduces “sticky routes”. Any add or delete lines that contain MYADDR or HISADDR will be remembered, and any time the actual values of MYADDR or HISADDR change, the - routes will be re-applied. This removes the necessity of repeating + routes will be re-applied. This removes the necessity of repeating these lines in ppp.linkup. @@ -635,13 +635,13 @@ protocol: ppp When you configure ppp to receive incoming calls on a machine connected to a LAN, you must decide if you wish to - forward packets to the LAN. If you do, you should allocate the + forward packets to the LAN. If you do, you should allocate the peer an IP number from your LAN's subet, and use the command enable proxy - in your ppp.conf file. You should also + in your ppp.conf file. You should also confirm that the /etc/rc.conf file (this file used to be called /etc/sysconfig) contains the following: @@ -676,7 +676,7 @@ gateway=YES PPP permissions - ppp must normally be run as user id 0. If however you + ppp must normally be run as user id 0. If however you wish to allow ppp to run in server mode as a normal user by executing ppp as described below, that user must be given permission to run ppp by adding them to the @@ -716,7 +716,7 @@ echo "Starting PPP for $IDENT" exec /usr/sbin/ppp -direct $IDENT - This script should be executable. Now make a symbolic + This script should be executable. Now make a symbolic link called ppp-dialup to this script using the following commands: @@ -727,7 +727,7 @@ exec /usr/sbin/ppp -direct $IDENT You should use this script as the shell for all your dialup ppp users. This is an example from /etc/password for - a dialup PPP user with username pchilds. (remember don't + a dialup PPP user with username pchilds. (remember don't directly edit the password file, use vipw) @@ -766,7 +766,7 @@ pchilds:*:1011:300:Peter Childs PPP:/home/ppp:/etc/ppp/ppp-dialupEach of these users dialup accounts should have their - shell set to the symbolic link created above. (ie. mary's + shell set to the symbolic link created above. (ie. mary's shell should be /etc/ppp/ppp-mary). @@ -796,9 +796,9 @@ ttyd1: The default: section is - loaded for each session. For each dialup line enabled in + loaded for each session. For each dialup line enabled in /etc/ttys create an entry similar to the - one for ttyd0: above. Each line + one for ttyd0: above. Each line should get a unique IP address from your pool of IP addresses for dynamic users. @@ -809,7 +809,7 @@ ttyd1: Along with the contents of the sample /etc/ppp/ppp.conf above you should add a - section for each of the statically assigned dialup users. We + section for each of the statically assigned dialup users. We will continue with our fred, sam, and mary example. @@ -824,7 +824,7 @@ mary: The file /etc/ppp/ppp.linkup should also contain routing information for each static IP user if - required. The line below would add a route for the 203.14.101.0 class C via the client's ppp link. @@ -878,7 +878,7 @@ exec /usr/sbin/ppp -direct pap$IDENT For each dialup line enabled in /etc/ttys create a corresponding entry - in /etc/ppp/ppp.conf. This will + in /etc/ppp/ppp.conf. This will happily co-exist with the definitions we created above. @@ -901,7 +901,7 @@ enable passwdauth If you wish to assign some users a static IP number, you can specify the number as the third argument in - /etc/ppp/ppp.secret. See + /etc/ppp/ppp.secret. See /etc/ppp/ppp.secret.sample for examples. @@ -943,7 +943,7 @@ set nbns 203.14.100.5 Some ISPs set their system up so that the authentication part of your connection is done using either of the PAP or CHAP - authentication mechanisms. If this is the case, your ISP will + authentication mechanisms. If this is the case, your ISP will not give a login: prompt when you connect, but will start talking PPP immediately. @@ -964,7 +964,7 @@ set nbns 203.14.100.5 13 set authkey MyPassword As always, do not include the line numbers, they are just - for reference in this discussion. Indentation of at least one + for reference in this discussion. Indentation of at least one space is required. @@ -972,7 +972,7 @@ set nbns 203.14.100.5 Line 7: Your ISP will not normally require that you log into - the server if you're using PAP or CHAP. You must + the server if you're using PAP or CHAP. You must therefore disable your "set login" string. @@ -980,7 +980,7 @@ set nbns 203.14.100.5 Line 12: - This line specifies your PAP/CHAP user name. You + This line specifies your PAP/CHAP user name. You will need to insert the correct value for MyUserName. @@ -989,8 +989,8 @@ set nbns 203.14.100.5 Line 13: - This line specifies your PAP/CHAP password. You - will need to insert the correct value for MyPassword. You may want to add an + This line specifies your PAP/CHAP password. You + will need to insert the correct value for MyPassword. You may want to add an additional line @@ -1011,7 +1011,7 @@ set nbns 203.14.100.5 It is possible to talk to the ppp program while it is running in the background, but only if a suitable diagnostic port has - been set up. To do this, add the following line to your + been set up. To do this, add the following line to your configuration: @@ -1019,7 +1019,7 @@ set server /var/run/ppp-tun%d DiagnosticPassword 0177 This will tell PPP to listen to the specified unix-domain socket, asking clients for the specified password before allowing - access. The %d in the name is replaced with teh + access. The %d in the name is replaced with teh tun device number that is in use. Once a socket has been set up, the @@ -1033,7 +1033,7 @@ set server /var/run/ppp-tun%d DiagnosticPassword 0177 Final system configuration You now have ppp configured, but there are a few more things - to do before it is ready to work. They all involve editing the + to do before it is ready to work. They all involve editing the /etc/rc.conf file (was /etc/sysconfig). @@ -1047,7 +1047,7 @@ hostname=foo.bar.com name, it's probably best that you use this name as your host name. - Look for the network_interfaces variable. If you want to + Look for the network_interfaces variable. If you want to configure your system to dial your ISP on demand, make sure the tun0 device is added to the list, otherwise remove it. @@ -1057,15 +1057,15 @@ network_interfaces="lo0 tun0" ifconfig_tun0= The ifconfig_tun0 variable should be empty, and a file called /etc/start_if.tun0 should - be created. This file should contain the line + be created. This file should contain the line ppp -auto mysystem This script is executed at network configuration time, - starting your ppp daemon in automatic mode. If you have a LAN + starting your ppp daemon in automatic mode. If you have a LAN for which this machine is a gateway, you may also wish to use - the switch. Refer to the manual page + the switch. Refer to the manual page for further details. @@ -1082,7 +1082,7 @@ router=NO (/etc/sysconfig) It is probably worth your while ensuring that the sendmail_flags line does not include the option, otherwise sendmail will attempt to do a network lookup every now - and then, possibly causing your machine to dial out. You may + and then, possibly causing your machine to dial out. You may try: @@ -1107,7 +1107,7 @@ sendmail_flags="-bd" 4 !bg sendmail -bd -q30m If you don't like this, it is possible to set up a “dfilter” - to block SMTP traffic. Refer to the sample files for further + to block SMTP traffic. Refer to the sample files for further details. All that is left is to reboot the machine. @@ -1152,7 +1152,7 @@ sendmail_flags="-bd" Create an entry in - /etc/ppp/ppp.conf. The pmdemand example should suffice for + /etc/ppp/ppp.conf. The pmdemand example should suffice for most ISPs. @@ -1200,7 +1200,7 @@ sendmail_flags="-bd" Create an entry in - /etc/ppp/ppp.conf. The direct-server example should + /etc/ppp/ppp.conf. The direct-server example should suffice. @@ -1320,7 +1320,7 @@ defaultroute # put this if you want that PPP server will be your - Now your computer is connected with PPP. If the connection + Now your computer is connected with PPP. If the connection fails for some reasons you can add the option to the /etc/ppp/options file and check messages on the console to track the problem @@ -1351,7 +1351,7 @@ pppd /dev/tty01 19200 /etc/ppp/kermit.dial is kermit script that dials and makes all necessary authorization on the remote - host. (Example of such script is attached to the end of this + host. (Example of such script is attached to the end of this document) Use the following /etc/ppp/pppdown script @@ -1564,8 +1564,8 @@ echo \13 exit This /etc/ppp/kermit.dial script is used - for dialing and authorizing on remote host. You will need to - customize it for your needs. Put your login and password in this + for dialing and authorizing on remote host. You will need to + customize it for your needs. Put your login and password in this script, also you will need to change input statement depending on responses from your modem and remote host. @@ -1695,14 +1695,14 @@ exit 1 1995. The following is one way to set up a FreeBSD machine for SLIP on - a static host network. For dynamic hostname assignments (i.e., your + a static host network. For dynamic hostname assignments (i.e., your address changes each time you dial up), you probably need to do something much fancier. - First, determine which serial port your modem is connected to. I + First, determine which serial port your modem is connected to. I have a symbolic link to /dev/modem from /dev/cuaa1, and only use the modem name in my configuration - files. It can become quite cumbersome when you need to fix a bunch + files. It can become quite cumbersome when you need to fix a bunch of files in /etc and .kermrc's all over the system! @@ -1714,7 +1714,7 @@ exit 1 Make sure you have -pseudo-device sl 1 in your kernel's config file. It is included in +pseudo-device sl 1 in your kernel's config file. It is included in the GENERIC kernel, so this will not be a problem unless you deleted it. @@ -1727,7 +1727,7 @@ pseudo-device sl 1 in your kernel's config file. It is i Add your home machine, the gateway and nameservers to - your /etc/hosts file. Mine looks like + your /etc/hosts file. Mine looks like this: @@ -1744,12 +1744,12 @@ pseudo-device sl 1 in your kernel's config file. It is i Make sure you have before in your - /etc/host.conf. Otherwise, funny things + /etc/host.conf. Otherwise, funny things may happen. - Edit the file /etc/rc.conf. Note + Edit the file /etc/rc.conf. Note that you should edit the file /etc/sysconfig instead if you are running FreeBSD previous to version 2.2.2. @@ -1805,14 +1805,14 @@ domain HIP.Berkeley.EDU nameserver 128.32.136.9 nameserver 128.32.136.12 - As you can see, these set up the nameserver hosts. Of + As you can see, these set up the nameserver hosts. Of course, the actual domain names and addresses depend on your environment. Set the password for root and toor (and any other - accounts that does not have a password). Use passwd, do not + accounts that does not have a password). Use passwd, do not edit the /etc/passwd or /etc/master.passwd files! @@ -1835,8 +1835,8 @@ nameserver 128.32.136.12 Dial up, type slip at the prompt, enter your machine - name and password. The things you need to enter depends on - your environment. I use kermit, with a script like this: + name and password. The things you need to enter depends on + your environment. I use kermit, with a script like this: # kermit setup @@ -1854,13 +1854,13 @@ output silvia\x0d, input 10 Password:, if failure stop, - output ***\x0d, echo \x0aCONNECTED\x0a (of course, you have to change the hostname and password to fit - yours). Then you can just type slip from the kermit + yours). Then you can just type slip from the kermit prompt to get connected. Leaving your password in plain text anywhere in the - filesystem is generally a BAD idea. Do it at your own - risk. I am just too lazy. + filesystem is generally a BAD idea. Do it at your own + risk. I am just too lazy. @@ -1891,16 +1891,16 @@ output ***\x0d, echo \x0aCONNECTED\x0a &prompt.root; kill -INT `cat /var/run/slattach.modem.pid` (as root) - to kill slattach. Then go back to kermit (fg if you suspended + to kill slattach. Then go back to kermit (fg if you suspended it) and exit from it (q). The slattach man page says you have to use ifconfig sl0 down to mark the interface down, but this does not seem to make any - difference for me. (ifconfig sl0 reports the same + difference for me. (ifconfig sl0 reports the same thing.) Some times, your modem might refuse to drop the carrier (mine - often does). In that case, simply start kermit and quit it again. + often does). In that case, simply start kermit and quit it again. It usually goes out on the second try. @@ -1908,7 +1908,7 @@ output ***\x0d, echo \x0aCONNECTED\x0a Troubleshooting - If it does not work, feel free to ask me. The things that + If it does not work, feel free to ask me. The things that people tripped over so far: @@ -1926,7 +1926,7 @@ output ***\x0d, echo \x0aCONNECTED\x0a Try ifconfig sl0 to see your - interface status. I get: + interface status. I get: &prompt.root; ifconfig sl0 @@ -1938,7 +1938,7 @@ sl0: flags=10<POINTOPOINT> Also, netstat -r will give the routing table, in case you get the "no route to host" - messages from ping. Mine looks like: + messages from ping. Mine looks like: &prompt.root; netstat -r @@ -1974,17 +1974,17 @@ silvia.HIP.Berke localhost.Berkeley UGH 34 47641234 lo0 - 0.438 This document provides suggestions for setting up SLIP Server services on a FreeBSD system, which typically means configuring your system to automatically startup connections upon login for remote - SLIP clients. The author has written this document based on his + SLIP clients. The author has written this document based on his experience; however, as your system and needs may be different, this document may not answer all of your questions, and the author cannot be responsible if you damage your system or lose data due to attempting to follow the suggestions here. This guide was originally written for SLIP Server services on a - FreeBSD 1.x system. It has been modified to reflect changes in the + FreeBSD 1.x system. It has been modified to reflect changes in the pathnames and the removal of the SLIP interface compression flags in early versions of FreeBSD 2.X, which appear to be the only major - changes between FreeBSD versions. If you do encounter mistakes in + changes between FreeBSD versions. If you do encounter mistakes in this document, please email the author with enough information to help correct the problem. @@ -1993,10 +1993,10 @@ silvia.HIP.Berke localhost.Berkeley UGH 34 47641234 lo0 - 0.438 Prerequisites This document is very technical in nature, so background - knowledge is required. It is assumed that you are familiar with + knowledge is required. It is assumed that you are familiar with the TCP/IP network protocol, and in particular, network and node addressing, network address masks, subnetting, routing, and - routing protocols, such as RIP. Configuring SLIP services on a + routing protocols, such as RIP. Configuring SLIP services on a dial-up server requires a knowledge of these concepts, and if you are not familiar with them, please read a copy of either Craig Hunt's TCP/IP Network Administration @@ -2006,14 +2006,14 @@ silvia.HIP.Berke localhost.Berkeley UGH 34 47641234 lo0 - 0.438 It is further assumed that you have already setup your modem(s) and configured the appropriate system files to allow - logins through your modems. If you have not prepared your system + logins through your modems. If you have not prepared your system for this yet, please see the tutorial for configuring dialup services; if you have a World-Wide Web browser available, browse the list of tutorials at http://www.freebsd.org/; otherwise, check the place where you found this document for a document named dialup.txt or something - similar. You may also want to check the manual pages for + similar. You may also want to check the manual pages for sio4 for information on the serial port device driver and ttys5, gettytab5, @@ -2032,7 +2032,7 @@ silvia.HIP.Berke localhost.Berkeley UGH 34 47641234 lo0 - 0.438 works as follows: a SLIP user dials up your FreeBSD SLIP Server system and logs in with a special SLIP login ID that uses /usr/sbin/sliplogin as the special user's - shell. The sliplogin program + shell. The sliplogin program browses the file /etc/sliphome/slip.hosts to find a matching line for the special user, and if it finds a match, connects the serial line to an available SLIP interface and @@ -2078,7 +2078,7 @@ Shelmerg dc-slip sl-helmer 0xfffffc00 autocomp to set the local IP address (dc-slip), remote IP address (sl-helmer), network mask for the SLIP interface (0xfffffc00), and any additional - flags (autocomp). If something + flags (autocomp). If something goes wrong, sliplogin usually logs good informational messages via the daemon syslog facility, which usually goes into /var/log/messages @@ -2115,7 +2115,7 @@ sl1* 296 <Link> 0 0 0 0 The sl0 and sl1 interfaces shown in netstat -i's output indicate that there are - two SLIP interfaces built into the kernel. (The asterisks after + two SLIP interfaces built into the kernel. (The asterisks after the sl0 and sl1 indicate that the interfaces are “down”.) @@ -2207,7 +2207,7 @@ pseudo-device sl 2 domain name service, depending on your specifications in /etc/host.conf), and I believe the network mask may be a name that can be resolved by a lookup into - /etc/networks. On a sample system, + /etc/networks. On a sample system, /etc/sliphome/slip.hosts looks like this: @@ -2260,7 +2260,7 @@ Shelmerg dc-slip sl-helmerg 0xfffffc00 autocompslips-prereqs section @@ -2269,7 +2269,7 @@ Shelmerg dc-slip sl-helmerg 0xfffffc00 autocompIf you are going to use a separate subnet for your SLIP clients, you will need to allocate the subnet number out of your assigned IP network number and assign each of your SLIP client's - IP numbers out of that subnet. Then, you will probably either + IP numbers out of that subnet. Then, you will probably either need to configure a static route to the SLIP subnet via your SLIP server on your nearest IP router, or install gated on your FreeBSD SLIP server and configure it to talk the appropriate routing protocols to your @@ -2331,7 +2331,7 @@ Shelmerg dc-slip sl-helmerg 0xfffffc00 autocompThe additional line in this slip.login, arp -s $5 00:11:22:33:44:55 pub, creates - an ARP entry in the SLIP server's ARP table. This ARP entry + an ARP entry in the SLIP server's ARP table. This ARP entry causes the SLIP server to respond with the SLIP server's Ethernet MAC address whenever a another IP node on the Ethernet asks to speak to the SLIP client's IP address. @@ -2441,7 +2441,7 @@ Shelmerg dc-slip sl-helmerg 0xfffffc00 autocompAdding static routes to your nearest default routers can be troublesome (or impossible, if you do not have authority to do - so...). If you have a multiple-router network in your + so...). If you have a multiple-router network in your organization, some routers, such as Cisco and Proteon, may not only need to be configured with the static route to the SLIP subnet, but also need to be told which static routes to tell @@ -2461,7 +2461,7 @@ Shelmerg dc-slip sl-helmerg 0xfffffc00 autocompgated from the ports collection or retrieve and build it yourself from the GateD anonymous ftp site; I believe the current version as of this writing is gated-R3_5Alpha_8.tar.Z, which includes support for FreeBSD “out-of-the-box”. Complete information and documentation on gated is available on the Web starting at the Merit GateD Consortium. Compile and install it, and then write a /etc/gated.conf file to configure your gated; here is a sample, similar to what the author used on a FreeBSD SLIP server: + URL="ftp://ftp.gated.merit.edu/research.and.development/gated/">the GateD anonymous ftp site; I believe the current version as of this writing is gated-R3_5Alpha_8.tar.Z, which includes support for FreeBSD “out-of-the-box”. Complete information and documentation on gated is available on the Web starting at the Merit GateD Consortium. Compile and install it, and then write a /etc/gated.conf file to configure your gated; here is a sample, similar to what the author used on a FreeBSD SLIP server: # @@ -2508,10 +2508,10 @@ import proto rip interface ed { Ethernet; if you are using a different Ethernet driver than the ed driver, you will need to change the references to the ed interface - appropriately. This sample file also sets up tracing to + appropriately. This sample file also sets up tracing to /var/tmp/gated.output for debugging gated's activity; you can - certainly turn off the tracing options if gated works OK for you. You will need to + certainly turn off the tracing options if gated works OK for you. You will need to change the xxx.xxx.yy's into the network address of your own SLIP subnet (be sure to change the net mask in the proto direct @@ -2522,7 +2522,7 @@ import proto rip interface ed { to run gated in place of routed on your FreeBSD system; change the routed/gated startup parameters in /etc/netstart as appropriate for your - system. Please see the manual page for gated for information on gated's command-line parameters. + system. Please see the manual page for gated for information on gated's command-line parameters. diff --git a/en/handbook/printing/chapter.sgml b/en/handbook/printing/chapter.sgml index 7756117e3a..94d1196547 100644 --- a/en/handbook/printing/chapter.sgml +++ b/en/handbook/printing/chapter.sgml @@ -6,8 +6,8 @@ In order to use printers with FreeBSD, you will need to set them up to work with the Berkeley line printer spooling system, also known - as the LPD spooling system. It is the standard printer control system - in FreeBSD. This section introduces the LPD spooling system, often + as the LPD spooling system. It is the standard printer control system + in FreeBSD. This section introduces the LPD spooling system, often simply called LPD. If you are already familiar with LPD or another printer spooling @@ -19,7 +19,7 @@ What the Spooler Does - LPD controls everything about a host's printers. It is + LPD controls everything about a host's printers. It is responsible for a number of things: @@ -81,7 +81,7 @@ If you are the sole user of your system, you may be wondering why you should bother with the spooler when you do not need access - control, header pages, or printer accounting. While it is possible + control, header pages, or printer accounting. While it is possible to enable direct access to a printer, you should use the spooler anyway since @@ -97,7 +97,7 @@ LPD can conveniently run a job to be printed through filters to add date/time headers or convert a special file format (such as a TeX DVI file) into a format the printer will - understand. You will not have to do these steps manually. + understand. You will not have to do these steps manually. @@ -117,7 +117,7 @@ Setting Up the Spooling System To use printers with the LPD spooling system, you will need to - set up both your printer hardware and the LPD software. This + set up both your printer hardware and the LPD software. This document describes two levels of setup: @@ -146,7 +146,7 @@ Simple Printer Setup This section tells how to configure printer hardware and the - LPD software to use the printer. It teaches the basics: + LPD software to use the printer. It teaches the basics: @@ -172,8 +172,8 @@ With Networked Data Stream Interaces. Although this section is called “Simple Printer Setup,” it is - actually fairly complex. Getting the printer to work with your - computer and the LPD spooler is the hardest part. The advanced + actually fairly complex. Getting the printer to work with your + computer and the LPD spooler is the hardest part. The advanced options like header pages and accounting are fairly easy once you get the printer working. @@ -182,7 +182,7 @@ Hardware Setup This section tells about the various ways you can connect a - printer to your PC. It talks about the kinds of ports and cables, + printer to your PC. It talks about the kinds of ports and cables, and also the kernel configuration you may need to enable FreeBSD to speak to the printer. @@ -202,9 +202,9 @@ Serial interfaces use a serial - port on your computer to send data to the printer. Serial + port on your computer to send data to the printer. Serial interfaces are common in the computer industry and cables - are readily available and also easy to construct. Serial + are readily available and also easy to construct. Serial interfaces sometimes need special cables and might require you to configure somewhat complex communications options. @@ -212,9 +212,9 @@ Parallel interfaces use a parallel port on your computer to send data to the - printer. Parallel interfaces are common in the PC market. + printer. Parallel interfaces are common in the PC market. Cables are readily available but more difficult to - construct by hand. There are usually no communications + construct by hand. There are usually no communications options with parallel interfaces, making their configuration exceedingly simple. @@ -227,26 +227,26 @@ In general, serial interfaces are slower than parallel - interfaces. Parallel interfaces usually offer just one-way + interfaces. Parallel interfaces usually offer just one-way communication (computer to printer) while serial gives you - two-way. Many newer parallel ports can also receive data from + two-way. Many newer parallel ports can also receive data from the printer, but only few printers need to send data back to the - computer. And FreeBSD does not support two-way parallel + computer. And FreeBSD does not support two-way parallel communication yet. Usually, the only time you need two-way communication with - the printer is if the printer speaks PostScript. PostScript - printers can be very verbose. In fact, PostScript jobs are + the printer is if the printer speaks PostScript. PostScript + printers can be very verbose. In fact, PostScript jobs are actually programs sent to the printer; they need not produce paper at all and may return results directly to the computer. PostScript also uses two-way communication to tell the computer about problems, such as errors in the PostScript program or - paper jams. Your users may be appreciative of such information. + paper jams. Your users may be appreciative of such information. Furthermore, the best way to do effective accounting with a PostScript printer requires two-way communication: you ask the printer for its page count (how many pages it has printed in its lifetime), then send the user's job, then ask again for its page - count. Subtract the two values and you know how much paper to + count. Subtract the two values and you know how much paper to charge the user. So, which interface should you use? @@ -262,9 +262,9 @@ If you do not need two-way communication and can pick - parallel or serial, prefer the parallel interface. It + parallel or serial, prefer the parallel interface. It keeps a serial port free for other peripherals—such as a - terminal or a modem—and is faster most of the time. It + terminal or a modem—and is faster most of the time. It is also easier to configure. @@ -281,11 +281,11 @@ Parallel Ports To hook up a printer using a parallel interface, connect - the Centronics cable between the printer and the computer. The + the Centronics cable between the printer and the computer. The instructions that came with the printer, the computer, or both should give you complete guidance. - Remember which parallel port you used on the computer. The + Remember which parallel port you used on the computer. The first parallel port is /dev/lpt0 to FreeBSD; the second is /dev/lpt1, and so on. @@ -295,7 +295,7 @@ Serial Ports To hook up a printer using a serial interface, connect the - proper serial cable between the printer and the computer. The + proper serial cable between the printer and the computer. The instructions that came with the printer, the computer, or both should give you complete guidance. @@ -307,7 +307,7 @@ A modem cable connects each pin of the connector on one end of the cable straight through to its corresponding pin of the connector on the other - end. This type of cable is also known as a “DTE-to-DCE” + end. This type of cable is also known as a “DTE-to-DCE” cable. @@ -315,7 +315,7 @@ A null-modem cable connects some pins straight through, swaps others (send data to receive data, for example), and shorts some internally in each - connector hood. This type of cable is also known as a + connector hood. This type of cable is also known as a “DTE-to-DTE” cable. @@ -330,13 +330,13 @@ You should also set up the communications parameters for the printer, usually through front-panel controls or DIP switches on - the printer. Choose the highest bps (bits per second, sometimes + the printer. Choose the highest bps (bits per second, sometimes baud rate) rate that both your computer and - the printer can support. Choose 7 or 8 data bits; none, even, - or odd parity; and 1 or 2 stop bits. Also choose a flow control + the printer can support. Choose 7 or 8 data bits; none, even, + or odd parity; and 1 or 2 stop bits. Also choose a flow control protocol: either none, or XON/XOFF (also known as “in-band” or “software”) - flow control. Remember these settings for the software + flow control. Remember these settings for the software configuration that follows. @@ -368,13 +368,13 @@ Test if the operating system can send data to the - printer. Section Checking Printer Communications gives some + printer. Section Checking Printer Communications gives some suggestions on how to do this. Set up LPD for the printer by modifying the file - /etc/printcap. Section /etc/printcap. Section The /etc/printcap File shows you how. @@ -385,8 +385,8 @@ Kernel Configuration The operating system kernel is compiled to work with a - specific set of devices. The serial or parallel interface for - your printer is a part of that set. Therefore, it might be + specific set of devices. The serial or parallel interface for + your printer is a part of that set. Therefore, it might be necessary to add support for an additional serial or parallel port if your kernel is not already configured for one. @@ -398,7 +398,7 @@ Where N is the - number of the serial port, starting from zero. If you see + number of the serial port, starting from zero. If you see output similar to the following: @@ -416,7 +416,7 @@ sio2: type 16550A Where N is the - number of the parallel port, starting from zero. If you see + number of the parallel port, starting from zero. If you see output similar to the following @@ -428,7 +428,7 @@ sio2: type 16550A port you are using for the printer. To add support for a serial port, see the section on kernel - configuration. To add support for a parallel port, see that + configuration. To add support for a parallel port, see that section and the section that follows. @@ -439,7 +439,7 @@ sio2: type 16550A Even though the kernel may support communication along a serial or parallel port, you will still need a software interface through which programs running on the system can - send and receive data. That is what entries in the + send and receive data. That is what entries in the /dev directory are for. To add a /dev @@ -450,7 +450,7 @@ sio2: type 16550A Become root with the su - command. Enter the root password when prompted. + command. Enter the root password when prompted. @@ -469,7 +469,7 @@ sio2: type 16550A Where port is the device entry for the - port you want to make. Use lpt0 for the first parallel port, + port you want to make. Use lpt0 for the first parallel port, lpt1 for the second, and so on; use ttyd0 for the first serial port, ttyd1 @@ -503,7 +503,7 @@ sio2: type 16550A The interrupt-driven method is - the default with the GENERIC kernel. With this method, + the default with the GENERIC kernel. With this method, the operating system uses an IRQ line to determine when the printer is ready for data. @@ -511,7 +511,7 @@ sio2: type 16550A The polled method directs the operating system to repeatedly ask the printer if it is - ready for more data. When it responds ready, the kernel + ready for more data. When it responds ready, the kernel sends more data. @@ -519,7 +519,7 @@ sio2: type 16550A The interrupt-driven method is somewhat faster but uses up - a precious IRQ line. You should use whichever one + a precious IRQ line. You should use whichever one works. You can set the communications mode in two ways: by @@ -532,9 +532,9 @@ sio2: type 16550A - Edit your kernel configuration file. Look for or - add an lpt0 entry. If you - are setting up the second parallel port, use lpt1 instead. Use lpt2 for the third port, and so + Edit your kernel configuration file. Look for or + add an lpt0 entry. If you + are setting up the second parallel port, use lpt1 instead. Use lpt2 for the third port, and so on. @@ -562,8 +562,8 @@ device lpt0 at isa? port? tty vector lptintr - Save the file. Then configure, build, and install - the kernel, then reboot. See Save the file. Then configure, build, and install + the kernel, then reboot. See kernel configuration for more details. @@ -601,7 +601,7 @@ device lpt0 at isa? port? tty vector lptintr You could put these commands in your /etc/rc.local file to set the mode each - time your system boots. See lptcontrol8 for more information. + time your system boots. See lptcontrol8 for more information. @@ -610,16 +610,16 @@ device lpt0 at isa? port? tty vector lptintr Before proceeding to configure the spooling system, you should make sure the operating system can successfully send - data to your printer. It is a lot easier to debug printer + data to your printer. It is a lot easier to debug printer communication and the spooling system separately. - To test the printer, we will send some text to it. For + To test the printer, we will send some text to it. For printers that can immediately print characters sent to them, the program lptest is perfect: it generates all 96 printable ASCII characters in 96 lines. For a PostScript (or other language-based) printer, we - will need a more sophisticated test. A small PostScript + will need a more sophisticated test. A small PostScript program, such as the following, will suffice: @@ -633,7 +633,7 @@ showpage When this document refers to a printer language, I am assuming a language like PostScript, and not Hewlett - Packard's PCL. Although PCL has great functionality, you can + Packard's PCL. Although PCL has great functionality, you can intermingle plain text with its escape sequences. PostScript cannot directly print plain text, and that is the kind of printer language for which we must make special @@ -664,7 +664,7 @@ showpage If the printer can print plain text, then use - lptest. Type: + lptest. Type: &prompt.root; lptest > /dev/lptN @@ -677,7 +677,7 @@ showpage If the printer understands PostScript or other printer language, then send a small - program to the printer. Type: + program to the printer. Type: &prompt.root; cat > /dev/lptN @@ -686,7 +686,7 @@ showpage Then, line by line, type the program carefully as you cannot edit a line once you have pressed RETURN - or ENTER. When you have finished entering the + or ENTER. When you have finished entering the program, press CONTROL+D, or whatever your end of file key is. @@ -708,7 +708,7 @@ showpage - You should see something print. Do not worry if the + You should see something print. Do not worry if the text does not look right; we will fix such things later. @@ -754,7 +754,7 @@ printer:dv=/dev/ttyd2:br#19200:pa=none Connect to the printer with - tip. Type: + tip. Type: &prompt.root; tip printer @@ -772,7 +772,7 @@ printer:dv=/dev/ttyd2:br#19200:pa=none If the printer can print plain text, then use - lptest. Type: + lptest. Type: ~$lptest @@ -782,12 +782,12 @@ printer:dv=/dev/ttyd2:br#19200:pa=none If the printer understands PostScript or other printer language, then send a small - program to the printer. Type the program, line + program to the printer. Type the program, line by line, very carefully as backspacing or other editing keys may be - significant to the printer. You may also need to + significant to the printer. You may also need to type a special end-of-file key for the printer - so it knows it received the whole program. For + so it knows it received the whole program. For PostScript printers, press CONTROL+D. Alternatively, you can put the program in a @@ -798,7 +798,7 @@ printer:dv=/dev/ttyd2:br#19200:pa=none Where file is the name of the - file containing the program. After + file containing the program. After tip sends the file, press any required end-of-file key. @@ -809,7 +809,7 @@ printer:dv=/dev/ttyd2:br#19200:pa=none - You should see something print. Do not worry if the + You should see something print. Do not worry if the text does not look right; we will fix that later. @@ -822,17 +822,17 @@ printer:dv=/dev/ttyd2:br#19200:pa=none At this point, your printer should be hooked up, your kernel configured to communicate with it (if necessary), and you - have been able to send some simple data to the printer. Now, we + have been able to send some simple data to the printer. Now, we are ready to configure LPD to control access to your printer. You configure LPD by editing the file - /etc/printcap. The LPD spooling system + /etc/printcap. The LPD spooling system reads this file each time the spooler is used, so updates to the file take immediate effect. The format of the - printcap file is straightforward. Use your favorite text editor to make changes to /etc/printcap. The format is identical to other capability files like /usr/share/misc/termcap and /etc/remote. For complete information about the format, see the cgetent3. + printcap file is straightforward. Use your favorite text editor to make changes to /etc/printcap. The format is identical to other capability files like /usr/share/misc/termcap and /etc/remote. For complete information about the format, see the cgetent3. The simple spooler configuration consists of the following steps: @@ -864,7 +864,7 @@ printer:dv=/dev/ttyd2:br#19200:pa=none with the lp capability; see Identifying the Printer - Device. Also, if the printer is on a serial port, set + Device. Also, if the printer is on a serial port, set up the communication parameters with the fs, fc, xs, and xc capabilities; see Language-based printers, such as PostScript printers, - cannot directly print plain text. The simple setup outlined + cannot directly print plain text. The simple setup outlined above and described in the following sections assumes that if you are installing such a printer you will print only files that the printer can understand. Users often expect that they can print plain text to any of - the printers installed on your system. Programs that interface + the printers installed on your system. Programs that interface to LPD to do their printing usually make the same assumption. If you are installing such a printer and want to be able to print jobs in the printer language and print plain text jobs, you are strongly urged to add an additional step to the simple setup outlined above: install an automatic plain-text-to-PostScript (or other printer language) - conversion program. Section Accommodating Plain Text Jobs on PostScript Printers tells how to do this. @@ -920,8 +920,8 @@ printer:dv=/dev/ttyd2:br#19200:pa=none At least one of the printers specified in the /etc/printcap should have the alias - lp. This is the default - printer's name. If users do not have the PRINTER environment + lp. This is the default + printer's name. If users do not have the PRINTER environment variable nor specify a printer name on the command line of any of the LPD commands, then lp will be the default printer they get to use. @@ -931,8 +931,8 @@ printer:dv=/dev/ttyd2:br#19200:pa=none and model. Once you have picked a name and some common aliases, put - them in the /etc/printcap file. The name - of the printer should start in the leftmost column. Separate + them in the /etc/printcap file. The name + of the printer should start in the leftmost column. Separate each alias with a vertical bar and put a colon after the last alias. @@ -953,7 +953,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4: rattan and has as aliases line, diablo, lp, and Diablo 630 - Line Printer. Since it has the alias lp, it is also the default printer. The + Line Printer. Since it has the alias lp, it is also the default printer. The second is named bamboo, and has as aliases ps, PS, S, @@ -966,15 +966,15 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4: Suppressing Header Pages The LPD spooling system will by default print a - header page for each job. The header + header page for each job. The header page contains the user name who requested the job, the host from which the job came, and the name of the job, in nice - large letters. Unfortunately, all this extra text gets in the + large letters. Unfortunately, all this extra text gets in the way of debugging the simple printer setup, so we will suppress header pages. To suppress header pages, add the sh capability to the entry for the - printer in /etc/printcap. Here is the + printer in /etc/printcap. Here is the example /etc/printcap with sh added: @@ -989,7 +989,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Note how we used the correct format: the first line starts in the leftmost column, and subsequent lines - are indented with a single TAB. Every line in an entry except + are indented with a single TAB. Every line in an entry except the last ends in a backslash character. @@ -1004,7 +1004,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Because of the variable nature of spooling directories, it is customary to put these directories under - /var/spool. It is not necessary to + /var/spool. It is not necessary to backup the contents of spooling directories, either. Recreating them is as simple as running mkdir. @@ -1019,7 +1019,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ However, if you have a lot of printers on your network, you might want to put the spooling directories under a single directory that you reserve just for printing - with LPD. We will do this for our two example printers + with LPD. We will do this for our two example printers rattan and bamboo: @@ -1031,7 +1031,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ If you are concerned about the privacy of jobs that users print, you might want to protect the spooling - directory so it is not publicly accessible. Spooling + directory so it is not publicly accessible. Spooling directories should be owned and be readable, writable, and searchable by user daemon and group daemon, and no one else. We will do this for our example printers: @@ -1046,7 +1046,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Finally, you need to tell LPD about these directories - using the /etc/printcap file. You + using the /etc/printcap file. You specify the pathname of the spooling directory with the sd capability: @@ -1075,8 +1075,8 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ In section Adding /dev Entries for the Ports, we identified which entry in the /dev directory FreeBSD - will use to communicate with the printer. Now, we tell LPD - that information. When the spooling system has a job to + will use to communicate with the printer. Now, we tell LPD + that information. When the spooling system has a job to print, it will open the specified device on behalf of the filter program (which is responsible for passing data to the printer). @@ -1111,7 +1111,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ If the printer you are installing is connected to a parallel port, skip to the section Installing the - Text Filter. Otherwise, be sure to follow the + Text Filter. Otherwise, be sure to follow the instructions in the next section. @@ -1203,11 +1203,11 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ the sgttyb structure; it clears any bits in the fc capability, then sets bits in the fs - capability, then applies the resultant setting. It does the + capability, then applies the resultant setting. It does the same for the local mode bits as well. Let us add to our example printer on the sixth serial - port. We will set the bps rate to 38400. For the flag bits, + port. We will set the bps rate to 38400. For the flag bits, we will set the TANDEM, ANYP, LITOUT, FLUSHO, and PASS8 flags. For the local mode bits, we will set the LITOUT and PASS8 flags: @@ -1223,15 +1223,15 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Installing the Text Filter We are now ready to tell LPD what text filter to use to - send jobs to the printer. A text filter, + send jobs to the printer. A text filter, also known as an input filter, is a - program that LPD runs when it has a job to print. When LPD + program that LPD runs when it has a job to print. When LPD runs the text filter for a printer, it sets the filter's standard input to the job to print, and its standard output to - the printer device specified with the lp capability. The filter is expected + the printer device specified with the lp capability. The filter is expected to read the job from standard input, perform any necessary translation for the printer, and write the results to standard - output, which will get printed. For more information on the + output, which will get printed. For more information on the text filter, see section Filters. @@ -1240,14 +1240,14 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ /bin/cat to send the job to the printer. FreeBSD comes with another filter called lpf that handles backspacing and underlining for printers that might not deal with such - character streams well. And, of course, you can use any other - filter program you want. The filter lpf is described in detail in section + character streams well. And, of course, you can use any other + filter program you want. The filter lpf is described in detail in section lpf: a Text Filter. First, let us make the shell script /usr/local/libexec/if-simple be a simple - text filter. Put the following text into that file with your + text filter. Put the following text into that file with your favorite text editor: @@ -1268,7 +1268,7 @@ exit 2 And then tell LPD to use it by specifying it with the if capability in - /etc/printcap. We will add it to the two + /etc/printcap. We will add it to the two printers we have so far in the example /etc/printcap: @@ -1293,7 +1293,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ You have reached the end of the simple LPD setup. Unfortunately, congratulations are not quite yet in order, since we still have to test the setup and correct any - problems. To test the setup, try printing something. To + problems. To test the setup, try printing something. To print with the LPD system, you use the command lpr, which submits a job for printing. @@ -1317,14 +1317,14 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ (or an alias) specified in /etc/printcap. To test the default printer, type lpr - without any argument. Again, if you are + without any argument. Again, if you are testing a printer that expects PostScript, send a PostScript program in that language instead of using - lptest. You + lptest. You can do so by putting the program in a file and typing lpr file. For a PostScript printer, you should get the results of - the program. If you are using + the program. If you are using lptest, then your results should look like the following: @@ -1336,7 +1336,7 @@ $%&'()*+,-./01234567 To further test the printer, try downloading larger programs (for language-based printers) or running - lptest with different arguments. For example, lptest 80 60 will produce 60 lines of 80 characters each. + lptest with different arguments. For example, lptest 80 60 will produce 60 lines of 80 characters each. If the printer did not work, see the next section, Troubleshooting. @@ -1356,17 +1356,17 @@ $%&'()*+,-./01234567 eject a full sheet. The printer printed the above, but it sat for - awhile and did nothing. In fact, you might have + awhile and did nothing. In fact, you might have needed to press a PRINT REMAINING or FORM FEED button on the printer to get any results to appear. If this is the case, the printer was probably waiting to see if there was any more data for your job - before it printed anything. To fix this problem, you + before it printed anything. To fix this problem, you can have the text filter send a FORM FEED character - (or whatever is necessary) to the printer. This is + (or whatever is necessary) to the printer. This is usually sufficient to have the printer immediately - print any text remaining in its internal buffer. It + print any text remaining in its internal buffer. It is also useful to make sure each print job ends on a full sheet, so the next job does not start somewhere on the middle of the last page of the previous @@ -1404,18 +1404,18 @@ exit 2 You have become another victim of the staircase effect, caused by conflicting interpretations of what characters should - indicate a new-line. UNIX-style operating systems use + indicate a new-line. UNIX-style operating systems use a single character: ASCII code 10, the line feed (LF). MS-DOS, OS/2, and others uses a pair of characters, ASCII code 10 and ASCII code 13 - (the carriage return or CR). Many printers use the + (the carriage return or CR). Many printers use the MS-DOS convention for representing new-lines. When you print with FreeBSD, your text used just - the line feed character. The printer, upon seeing a + the line feed character. The printer, upon seeing a line feed character, advanced the paper one line, but maintained the same horizontal position on the page - for the next character to print. That is what the + for the next character to print. That is what the carriage return is for: to move the location of the next character to print to the left edge of the paper. @@ -1446,7 +1446,7 @@ exit 2 Use the printer's configuration switches or control panel to alter its interpretation of - these characters. Check your printer's manual + these characters. Check your printer's manual to find out how to do this. @@ -1455,16 +1455,16 @@ exit 2 have to reconfigure the printer to use a an interpretation for CR and LF characters that those other operating - systems use. You might prefer one of the + systems use. You might prefer one of the other solutions, below. Have FreeBSD's serial line driver - automatically convert LF to CR+LF. Of course, + automatically convert LF to CR+LF. Of course, this works with printers on serial ports - only. To enable this + only. To enable this feature, set the CRMOD bit in fs capability in the /etc/printcap file for the printer. @@ -1473,18 +1473,18 @@ exit 2 Send an escape code to the printer to have it temporarily treat LF - characters differently. Consult your printer's + characters differently. Consult your printer's manual for escape codes that your printer might - support. When you find the proper escape code, + support. When you find the proper escape code, modify the text filter to send the code first, then send the print job. Here is an example text filter for printers that understand the Hewlett-Packard PCL escape - codes. This filter makes the printer treat LF + codes. This filter makes the printer treat LF characters as a LF and CR; then it sends the job; then it sends a form feed to eject the last - page of the job. It should work with nearly all + page of the job. It should work with nearly all Hewlett Packard printers. @@ -1502,9 +1502,9 @@ exit 2 Here is an example /etc/printcap from a host - called orchid. It has a single printer attached + called orchid. It has a single printer attached to its first parallel port, a Hewlett Packard - LaserJet 3Si named teak. It is using the + LaserJet 3Si named teak. It is using the above script as its text filter: @@ -1524,12 +1524,12 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ It overprinted each line. - The printer never advanced a line. All of the + The printer never advanced a line. All of the lines of text were printed on top of each other on one line. This problem is the “opposite” of the staircase - effect, described above, and is much rarer. Somewhere, + effect, described above, and is much rarer. Somewhere, the LF characters that FreeBSD uses to end a line are being treated as CR characters to return the print location to the left edge of the paper, but not also @@ -1568,13 +1568,13 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ While printing, the printer did not print a few - characters in each line. The problem might have + characters in each line. The problem might have gotten worse as the printer ran, losing more and more characters. The problem is that the printer cannot keep up with the speed at which the computer sends data over a - serial line. (This problem should not occur with + serial line. (This problem should not occur with printers on parallel ports.) There are two ways to overcome the problem: @@ -1587,7 +1587,7 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ If the printer supports carrier flow - control, specify the MDMBUF bit in the fs capability. Make sure + control, specify the MDMBUF bit in the fs capability. Make sure the cable connecting the printer to the computer is correctly wired for carrier flow control. @@ -1627,10 +1627,10 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ If nothing happened, the problem is probably - within FreeBSD and not the hardware. Add the log file + within FreeBSD and not the hardware. Add the log file (lf) capability to the entry for the printer you are debugging in the - /etc/printcap file. For example, + /etc/printcap file. For example, here is the entry for rattan, with the lf capability: @@ -1640,10 +1640,10 @@ rattan|line|diablo|lp|Diablo 630 Line Printer:\ :lp=/dev/lpt0:\ :if=/usr/local/libexec/if-simple:\ :lf=/var/log/rattan.log - Then, try printing again. Check + Then, try printing again. Check the log file (in our example, /var/log/rattan.log) to see any - error messages that might appear. Based on the + error messages that might appear. Based on the messages you see, try to correct the problem. If you do not specify a lf capability, LPD uses @@ -1662,7 +1662,7 @@ rattan|line|diablo|lp|Diablo 630 Line Printer:\ Using Printers This section tells you how to use printers you have setup with - FreeBSD. Here is an overview of the user-level commands: + FreeBSD. Here is an overview of the user-level commands: @@ -1701,10 +1701,10 @@ rattan|line|diablo|lp|Diablo 630 Line Printer:\ lpq accept an option to specify on which printer/queue to operate, as listed in the - /etc/printcap file. This enables you to - submit, remove, and check on jobs for various printers. If you do + /etc/printcap file. This enables you to + submit, remove, and check on jobs for various printers. If you do not use the option, then these commands use the - printer specified in the PRINTER environment variable. Finally, if + printer specified in the PRINTER environment variable. Finally, if you do not have a PRINTER environment variable, these commands default to the printer named lp. @@ -1724,9 +1724,9 @@ rattan|line|diablo|lp|Diablo 630 Line Printer:\ This prints each of the listed files to the - default printer. If you list no files, + default printer. If you list no files, lpr reads - data to print from standard input. For example, this command + data to print from standard input. For example, this command prints some important system files: @@ -1769,20 +1769,20 @@ rattan|line|diablo|lp|Diablo 630 Line Printer:\ lpr, the data you wish to print is put together in a package called a “print job”, which is sent to the LPD spooling - system. Each printer has a queue of jobs, and your job waits in + system. Each printer has a queue of jobs, and your job waits in that queue along with other jobs from yourself and from other - users. The printer prints those jobs in a first-come, first-served + users. The printer prints those jobs in a first-come, first-served order. To display the queue for the default printer, type - lpq. For a - specific printer, use the option. For + lpq. For a + specific printer, use the option. For example, the command &prompt.user; lpq -P bamboo - shows the queue for the printer named bamboo. Here is an example of the output of + shows the queue for the printer named bamboo. Here is an example of the output of the lpq command: @@ -1794,9 +1794,9 @@ active kelly 9 /etc/host.conf, /etc/hosts.equiv 88 bytes This shows three jobs in the queue for - bamboo. The first job, submitted by - user kelly, got assigned “job number” 9. Every - job for a printer gets a unique job number. Most of the time you + bamboo. The first job, submitted by + user kelly, got assigned “job number” 9. Every + job for a printer gets a unique job number. Most of the time you can ignore the job number, but you will need it if you want to cancel the job; see section Removing Jobs for @@ -1805,16 +1805,16 @@ active kelly 9 /etc/host.conf, /etc/hosts.equiv 88 bytes Job number nine consists of two files; multiple files given on the lpr command - line are treated as part of a single job. It is the currently + line are treated as part of a single job. It is the currently active job (note the word active under the “Rank” column), which means the printer should be - currently printing that job. The second job consists of data + currently printing that job. The second job consists of data passed as the standard input to the lpr - command. The third job came from user mary; it is a much larger - job. The pathname of the files she's trying to print is too long + command. The third job came from user mary; it is a much larger + job. The pathname of the files she's trying to print is too long to fit, so the lpq command just shows three dots. @@ -1827,7 +1827,7 @@ active kelly 9 /etc/host.conf, /etc/hosts.equiv 88 bytes The lpq command also support a option to generate a detailed - long listing. Here is an example of lpq -l: + long listing. Here is an example of lpq -l: waiting for bamboo to become ready (offline ?) @@ -1850,7 +1850,7 @@ mary: 3rd [job 011rose] If you change your mind about printing a job, you can remove the job from the queue with the lprm - command. Often, you can even use + command. Often, you can even use lprm to remove an active job, but some or all of the job might still get printed. @@ -1858,14 +1858,14 @@ mary: 3rd [job 011rose] To remove a job from the default printer, first use lpq to find - the job number. Then type: + the job number. Then type: &prompt.user; lprm job-number To remove the job from a specific printer, add - the option. The following command removes job + the option. The following command removes job number 10 from the queue for the printer bamboo: @@ -1889,7 +1889,7 @@ mary: 3rd [job 011rose] Removes all jobs (for the default printer) belonging - to user. The superuser can + to user. The superuser can remove other users' jobs; you can remove only your own jobs. @@ -1901,7 +1901,7 @@ mary: 3rd [job 011rose] With no job number, user name, or appearing on the command line, - lprm removes the currently active job on the default printer, if it belongs to you. The superuser can remove any active job. + lprm removes the currently active job on the default printer, if it belongs to you. The superuser can remove any active job. @@ -1922,7 +1922,7 @@ mary: 3rd [job 011rose] lprm will let you remove jobs only from the host from which the jobs were submitted, even if the same printer is available from other - hosts. The following command sequence demonstrates this: + hosts. The following command sequence demonstrates this: &prompt.user; lpr -P rattan myfile @@ -1949,7 +1949,7 @@ cfA013rose dequeued lpr command supports a number of options that control formatting text, converting graphic and other file formats, producing multiple - copies, handling of the job, and more. This section describes the + copies, handling of the job, and more. This section describes the options. @@ -1958,7 +1958,7 @@ cfA013rose dequeued The following lpr - options control formatting of the files in the job. Use these + options control formatting of the files in the job. Use these options if the job does not contain plain text or if you want plain text formatted through the pr @@ -1980,8 +1980,8 @@ cfA013rose dequeued All of these options except and require conversion filters installed for - the destination printer. For example, the - option requires the DVI conversion filter. Section -d + option requires the DVI conversion filter. Section Conversion Filters gives details. @@ -2021,7 +2021,7 @@ cfA013rose dequeued Indent the output by number columns; if you omit number, indent by 8 - columns. This option works only with certain conversion + columns. This option works only with certain conversion filters. @@ -2052,7 +2052,7 @@ cfA013rose dequeued Format plain text with pr - before printing. See pr1 for more information. + before printing. See pr1 for more information. @@ -2063,7 +2063,7 @@ cfA013rose dequeued Use title on the pr - header instead of the file name. This option has effect + header instead of the file name. This option has effect only when used with the option. @@ -2105,7 +2105,7 @@ cfA013rose dequeued command, which formats that source and makes GNU troff output and passes it to lpr, - which submits the job to the LPD spooler. Because we used the + which submits the job to the LPD spooler. Because we used the option to @@ -2127,9 +2127,9 @@ cfA013rose dequeued -# copies Produce a number of copies of each file in the job - instead of just one copy. An administrator may disable + instead of just one copy. An administrator may disable this option to reduce printer wear-and-tear and - encourage photocopier usage. See section Restricting Multiple Copies. This example prints three copies of @@ -2146,9 +2146,9 @@ cfA013rose dequeued -m - Send mail after completing the print job. With this + Send mail after completing the print job. With this option, the LPD system will send mail to your account - when it finishes handling your job. In its message, it + when it finishes handling your job. In its message, it will tell you if the job completed successfully or if there was an error, and (often) what the error was. @@ -2162,9 +2162,9 @@ cfA013rose dequeued make symbolic links to them instead. If you are printing a large job, you probably want - to use this option. It saves space in the spooling + to use this option. It saves space in the spooling directory (your job might overflow the free space on the - filesystem where the spooling directory resides). It + filesystem where the spooling directory resides). It saves time as well since LPD will not have to copy each and every byte of your job to the spooling directory. @@ -2178,7 +2178,7 @@ cfA013rose dequeued eventually have to copy files from the local host to the remote host, so the option will save space only on the local spooling directory, - not the remote. It is still useful, though. + not the remote. It is still useful, though. @@ -2188,7 +2188,7 @@ cfA013rose dequeued Remove the files in the job after copying them to the spooling directory, or after printing them with the - option. Be careful with this + option. Be careful with this option! @@ -2204,7 +2204,7 @@ cfA013rose dequeued lpr adjust the text that normally appears on a job's header page. If header pages are suppressed for the destination printer, - these options have no effect. See section Header Pages for information about setting up header pages. @@ -2213,7 +2213,7 @@ cfA013rose dequeued -C text Replace the hostname on the header page with - text. The hostname is + text. The hostname is normally the name of the host from which the job was submitted. @@ -2223,7 +2223,7 @@ cfA013rose dequeued Replace the job name on the header page with - text. The job name is + text. The job name is normally the name of the first file of the job, or stdin if you are printing standard input. @@ -2236,7 +2236,7 @@ cfA013rose dequeued At some sites, this option may have no effect due - to the way header pages are generated. See Header Pages for details. @@ -2252,7 +2252,7 @@ cfA013rose dequeued Administrating Printers As an administrator for your printers, you have had to - install, set up, and test them. Using the + install, set up, and test them. Using the lpc command, you can interact with your printers in yet more ways. With @@ -2279,27 +2279,27 @@ cfA013rose dequeued First, a note about terminology: if a printer is stopped, it will not print anything in its - queue. Users can still submit jobs, which will wait in the queue + queue. Users can still submit jobs, which will wait in the queue until the printer is started or the queue is cleared. If a queue is disabled, no user (except - root) can submit jobs for the printer. An - enabled queue allows jobs to be submitted. A + root) can submit jobs for the printer. An + enabled queue allows jobs to be submitted. A printer can be started for a disabled queue, in which case it will continue to print jobs in the queue until the queue is empty. In general, you have to have root privileges to use the lpc - command. Ordinary users can use the + command. Ordinary users can use the lpc command to get printer status and to restart a hung printer only. Here is a summary of the lpc - commands. Most of the commands takes a printer-name argument to tell on which - printer to operate. You can use all + commands. Most of the commands takes a printer-name argument to tell on which + printer to operate. You can use all for the printer-name to mean all printers listed in /etc/printcap. @@ -2308,7 +2308,7 @@ cfA013rose dequeued abort printer-name - Cancel the current job and stop the printer. Users + Cancel the current job and stop the printer. Users can still submit jobs if the queue's enabled. @@ -2318,10 +2318,10 @@ cfA013rose dequeued Remove old files from the printer's spooling - directory. Occasionally, the files that make up a job are + directory. Occasionally, the files that make up a job are not properly removed by LPD, particularly if there have been errors during printing or a lot of administrative - activity. This command finds files that do not belong in + activity. This command finds files that do not belong in the spooling directory and removes them. @@ -2330,14 +2330,14 @@ cfA013rose dequeued printer-name - Disable queuing of new jobs. If the printer's + Disable queuing of new jobs. If the printer's started, it will continue to print any jobs remaining in - the queue. The superuser (root) can always submit jobs, + the queue. The superuser (root) can always submit jobs, even to a disabled queue. This command is useful while you are testing a new printer or filter installation: disable the queue and - submit jobs as root. Other users will not be able to + submit jobs as root. Other users will not be able to submit jobs until you complete your testing and re-enable the queue with the enable command. @@ -2349,9 +2349,9 @@ cfA013rose dequeued message - Take a printer down. Equivalent to + Take a printer down. Equivalent to disable followed by - stop. The message appears as the printer's + stop. The message appears as the printer's status whenever a user checks the printer's queue with lpq @@ -2364,7 +2364,7 @@ cfA013rose dequeued printer-name - Enable the queue for a printer. Users can submit jobs + Enable the queue for a printer. Users can submit jobs but the printer will not print anything until it is started. @@ -2375,7 +2375,7 @@ cfA013rose dequeued Print help on the command - command-name. With no + command-name. With no command-name, print a summary of the commands available. @@ -2385,10 +2385,10 @@ cfA013rose dequeued printer-name - Start the printer. Ordinary users can use this + Start the printer. Ordinary users can use this command if some extraordinary circumstance hangs LPD, but they cannot start a printer stopped with either the - stop or down commands. The restart command is equivalent to + stop or down commands. The restart command is equivalent to abort followed by start. @@ -2397,7 +2397,7 @@ cfA013rose dequeued printer-name - Start the printer. The printer will print jobs in its + Start the printer. The printer will print jobs in its queue. @@ -2406,8 +2406,8 @@ cfA013rose dequeued printer-name - Stop the printer. The printer will finish the current - job and will not print anything else in its queue. Even + Stop the printer. The printer will finish the current + job and will not print anything else in its queue. Even though the printer is stopped, users can still submit jobs to an enabled queue. @@ -2430,7 +2430,7 @@ cfA013rose dequeued printer-name - Bring a printer up; the opposite of the down command. Equivalent to + Bring a printer up; the opposite of the down command. Equivalent to start followed by enable. @@ -2439,7 +2439,7 @@ cfA013rose dequeued lpc accepts - the above commands on the command line. If you do not enter any + the above commands on the command line. If you do not enter any commands, lpc enters an interactive mode, where you can enter commands until you type @@ -2462,9 +2462,9 @@ cfA013rose dequeued Although LPD handles network protocols, queuing, access control, and other aspects of printing, most of the real work happens in the - filters. Filters are programs that + filters. Filters are programs that communicate with the printer and handle its device dependencies - and special requirements. In the simple printer setup, we + and special requirements. In the simple printer setup, we installed a plain text filter—an extremely simple one that should work with most printers (section Installing the @@ -2472,15 +2472,15 @@ cfA013rose dequeued However, in order to take advantage of format conversion, printer accounting, specific printer quirks, and so on, you should - understand how filters work. It will ultimately be the filter's - responsibility to handle these aspects. And the bad news is that + understand how filters work. It will ultimately be the filter's + responsibility to handle these aspects. And the bad news is that most of the time you have to provide filters - yourself. The good news is that many are generally available; + yourself. The good news is that many are generally available; when they are not, they are usually easy to write. Also, FreeBSD comes with one, /usr/libexec/lpr/lpf, that works with many - printers that can print plain text. (It handles backspacing and + printers that can print plain text. (It handles backspacing and tabs in the file, and does accounting, but that is about all it does.) There are also several filters and filter components in the FreeBSD ports collection. @@ -2492,32 +2492,32 @@ cfA013rose dequeued Section How Filters Work, tries to give an overview of a - filter's role in the printing process. You should read this + filter's role in the printing process. You should read this section to get an understanding of what is happening “under - the hood” when LPD uses filters. This knowledge could help + the hood” when LPD uses filters. This knowledge could help you anticipate and debug problems you might encounter as you install more and more filters on each of your printers. LPD expects every printer to be able to print plain text - by default. This presents a problem for PostScript (or + by default. This presents a problem for PostScript (or other language-based printers) which cannot directly print - plain text. Section Accommodating Plain Text Jobs on PostScript Printers tells you what you should do to overcome this - problem. I recommend reading this section if you have a + problem. I recommend reading this section if you have a PostScript printer. PostScript is a popular output format for many programs. Even some people (myself included) write PostScript code - directly. But PostScript printers are expensive. Section + directly. But PostScript printers are expensive. Section Simulating PostScript on Non-PostScript Printers tells how you can further modify a printer's text filter to accept and print PostScript data on a - non-PostScript printer. I recommend + non-PostScript printer. I recommend reading this section if you do not have a PostScript printer. @@ -2526,17 +2526,17 @@ cfA013rose dequeued Section Conversion Filters tells about a way you can automate the conversion of specific file formats, such as graphic or typesetting data, into formats your printer can - understand. After reading this section, you should be able + understand. After reading this section, you should be able to set up your printers such that users can type lpr -t to print troff data, or lpr -d to print TeX DVI data, or lpr -v to print raster image data, and so - forth. I recommend reading this section. + forth. I recommend reading this section. Section Output Filters tells all about a not often used - feature of LPD: output filters. Unless you are printing + feature of LPD: output filters. Unless you are printing header pages (see Header Pages), you can probably skip that section altogether. @@ -2545,7 +2545,7 @@ cfA013rose dequeued Section lpf: a Text Filter describes lpf, a fairly complete if simple text filter for line printers (and laser printers that act like - line printers) that comes with FreeBSD. If you need a quick + line printers) that comes with FreeBSD. If you need a quick way to get printer accounting working for plain text, or if you have a printer which emits smoke when it sees backspace characters, you should definitely consider lpf. @@ -2562,7 +2562,7 @@ cfA013rose dequeued communicating with the printer. When LPD wants to print a file in a job, it starts a filter - program. It sets the filter's standard input to the file to + program. It sets the filter's standard input to the file to print, its standard output to the printer, and its standard error to the error logging file (specified in the lf capability in /etc/printcap, or @@ -2574,10 +2574,10 @@ cfA013rose dequeued lpr - command line. For example, if the user typed lpr + command line. For example, if the user typed lpr -t, LPD would start the troff filter, listed in the tf capability for the destination - printer. If the user wanted to print plain text, it would start + printer. If the user wanted to print plain text, it would start the if filter (this is mostly true: see Output Filters @@ -2591,16 +2591,16 @@ cfA013rose dequeued The text filter, confusingly called the input filter in LPD - documentation, handles regular text printing. Think of it - as the default filter. LPD expects every printer to be + documentation, handles regular text printing. Think of it + as the default filter. LPD expects every printer to be able to print plain text by default, and it is the text filter's job to make sure backspaces, tabs, or other - special characters do not confuse the printer. If you are + special characters do not confuse the printer. If you are in an environment where you have to account for printer usage, the text filter must also account for pages printed, usually by counting the number of lines printed and comparing that to the number of lines per page the - printer supports. The text filter is started with the + printer supports. The text filter is started with the following argument list: @@ -2679,13 +2679,13 @@ cfA013rose dequeued A conversion filter converts a specific file format into one the printer can render onto - paper. For example, ditroff typesetting data cannot be + paper. For example, ditroff typesetting data cannot be directly printed, but you can install a conversion filter for ditroff files to convert the ditroff data into a form - the printer can digest and print. Section + the printer can digest and print. Section Conversion Filters tells all about them. Conversion filters also need to do accounting, if you need - printer accounting. Conversion filters are started with + printer accounting. Conversion filters are started with the following arguments: @@ -2706,9 +2706,9 @@ cfA013rose dequeued The output filter is used only if there is no text filter, or if header pages are enabled. - In my experience, output filters are rarely used. Section + In my experience, output filters are rarely used. Section Output - Filters describe them. There are only two arguments + Filters describe them. There are only two arguments to an output filter: @@ -2737,7 +2737,7 @@ cfA013rose dequeued If the filter failed to print the file but wants LPD - to try to print the file again. LPD will restart a + to try to print the file again. LPD will restart a filter if it exits with this status. @@ -2746,7 +2746,7 @@ cfA013rose dequeued If the filter failed to print the file and does not - want LPD to try again. LPD will throw out the + want LPD to try again. LPD will throw out the file. @@ -2756,13 +2756,13 @@ cfA013rose dequeued The text filter that comes with the FreeBSD release, /usr/libexec/lpr/lpf, takes advantage of the page width and length arguments to determine when to send a - form feed and how to account for printer usage. It uses the + form feed and how to account for printer usage. It uses the login, host, and accounting file arguments to make the accounting entries. If you are shopping for filters, see if they are - LPD-compatible. If they are, they must support the argument - lists described above. If you plan on writing filters for + LPD-compatible. If they are, they must support the argument + lists described above. If you plan on writing filters for general use, then have them support the same argument lists and exit codes. @@ -2779,36 +2779,36 @@ cfA013rose dequeued But, if you would like to send both PostScript and plain text jobs to the printer, then you are urged to augment your - printer setup. To do so, we have the text filter detect if the - arriving job is plain text or PostScript. All PostScript jobs + printer setup. To do so, we have the text filter detect if the + arriving job is plain text or PostScript. All PostScript jobs must start with %! (for other - printer languages, see your printer documentation). If those are + printer languages, see your printer documentation). If those are the first two characters in the job, we have PostScript, and can - pass the rest of the job directly. If those are not the first + pass the rest of the job directly. If those are not the first two characters in the file, then the filter will convert the text into PostScript and print the result. How do we do this? If you have got a serial printer, a great way to do it is to - install lprps. lprps is a PostScript printer filter which - performs two-way communication with the printer. It updates the + install lprps. lprps is a PostScript printer filter which + performs two-way communication with the printer. It updates the printer's status file with verbose information from the printer, so users and administrators can see exactly what the state of - the printer is (such as toner low or paper jam). But + the printer is (such as toner low or paper jam). But more importantly, it includes a program called psif which detects whether the incoming job is plain text and calls textps - (another program that comes with lprps) to convert it to PostScript. It + (another program that comes with lprps) to convert it to PostScript. It then uses lprps to send the job to the printer. lprps is part of the FreeBSD ports collection (see The Ports - Collection). You - can fetch, build and install it yourself, of course. After + Collection). You + can fetch, build and install it yourself, of course. After installing lprps, just specify the pathname to the psif program that - is part of lprps. If you + is part of lprps. If you installed lprps from the ports collection, use the following in the serial PostScript printer's entry in /etc/printcap: @@ -2850,8 +2850,8 @@ else fi In the above script, textps is a program we installed - separately to convert plain text to PostScript. You can use any - text-to-PostScript program you wish. The FreeBSD ports + separately to convert plain text to PostScript. You can use any + text-to-PostScript program you wish. The FreeBSD ports collection (see The Ports Collection) includes a full featured text-to-PostScript program called @@ -2863,33 +2863,33 @@ fi Simulating PostScript on Non-PostScript Printers PostScript is the de facto - standard for high quality typesetting and printing. PostScript + standard for high quality typesetting and printing. PostScript is, however, an expensive standard. Thankfully, Alladin Enterprises has a free PostScript work-alike called Ghostscript that runs with - FreeBSD. Ghostscript can read most PostScript files and can + FreeBSD. Ghostscript can read most PostScript files and can render their pages onto a variety of devices, including many - brands of non-PostScript printers. By installing Ghostscript + brands of non-PostScript printers. By installing Ghostscript and using a special text filter for your printer, you can make your non-PostScript printer act like a real PostScript printer. Ghostscript should be in the FreeBSD ports collection, if - you would like to install it from there. You can fetch, build, + you would like to install it from there. You can fetch, build, and install it quite easily yourself, as well. To simulate PostScript, we have the text filter detect if it - is printing a PostScript file. If it is not, then the filter + is printing a PostScript file. If it is not, then the filter will pass the file directly to the printer; otherwise, it will use Ghostscript to first convert the file into a format the printer will understand. Here is an example: the following script is a text filter - for Hewlett Packard DeskJet 500 printers. For other printers, + for Hewlett Packard DeskJet 500 printers. For other printers, substitute the argument to the - gs (Ghostscript) command. (Type gs -h to get a list of devices the current installation of Ghostscript supports.) + gs (Ghostscript) command. (Type gs -h to get a list of devices the current installation of Ghostscript supports.) #!/bin/sh @@ -2930,7 +2930,7 @@ exit 2 :if=/usr/local/libexec/hpif: - That is it. You can type lpr plain.text and lpr + That is it. You can type lpr plain.text and lpr whatever.ps and both should print successfully. @@ -2950,10 +2950,10 @@ exit 2 Why Install Conversion Filters? Conversion filters make printing various kinds of files - easy. As an example, suppose we do a lot of work with the TeX - typesetting system, and we have a PostScript printer. Every + easy. As an example, suppose we do a lot of work with the TeX + typesetting system, and we have a PostScript printer. Every time we generate a DVI file from TeX, we cannot print it - directly until we convert the DVI file into PostScript. The + directly until we convert the DVI file into PostScript. The command sequence goes like this: @@ -2963,7 +2963,7 @@ exit 2 By installing a conversion filter for DVI files, we can skip the hand conversion step each time by - having LPD do it for us. Now, each time we get a DVI file, we + having LPD do it for us. Now, each time we get a DVI file, we are just one step away from printing it: @@ -2971,14 +2971,14 @@ exit 2 We got LPD to do the DVI file conversion - for us by specifying the option. Section + for us by specifying the option. Section Formatting and Conversion Options lists the conversion options. For each of the conversion options you want a printer to support, install a conversion filter and - specify its pathname in /etc/printcap. A + specify its pathname in /etc/printcap. A conversion filter is like the text filter for the simple printer setup (see section Installing the Text Filter) except that instead of printing plain text, the filter converts the file into a @@ -2990,8 +2990,8 @@ exit 2 Which Conversions Filters Should I Install? You should install the conversion filters you expect to - use. If you print a lot of DVI data, then a DVI conversion - filter is in order. If you have got plenty of troff to print + use. If you print a lot of DVI data, then a DVI conversion + filter is in order. If you have got plenty of troff to print out, then you probably want a troff filter. The following table summarizes the filters that LPD works @@ -3066,12 +3066,12 @@ exit 2 its entry in /etc/printcap. Despite what others might contend, formats like FORTRAN - text and plot are probably obsolete. At your site, you can + text and plot are probably obsolete. At your site, you can give new meanings to these or any of the formatting options - just by installing custom filters. For example, suppose you + just by installing custom filters. For example, suppose you would like to directly print Printerleaf files (files from the Interleaf desktop publishing program), but will never print - plot files. You could install a Printerleaf conversion filter + plot files. You could install a Printerleaf conversion filter under the gf capability and then educate your users that lpr -g mean “print Printerleaf files.” @@ -3083,7 +3083,7 @@ exit 2 Since conversion filters are programs you install outside of the base FreeBSD installation, they should probably go - under /usr/local. The directory + under /usr/local. The directory /usr/local/libexec is a popular location, since they are specialized programs that only LPD will run; regular users should not ever need to run them. @@ -3093,7 +3093,7 @@ exit 2 /etc/printcap. In our example, we will add the DVI conversion filter to - the entry for the printer named bamboo. Here is the example + the entry for the printer named bamboo. Here is the example /etc/printcap file again, with the new df capability for the printer bamboo. @@ -3114,7 +3114,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ :df=/usr/local/libexec/psdf: The DVI filter is a shell script named - /usr/local/libexec/psdf. Here is that + /usr/local/libexec/psdf. Here is that script: @@ -3128,7 +3128,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ exec /usr/local/bin/dvips -f | /usr/local/libexec/lprps "$@" This script runs - dvips in filter mode (the argument) on standard input, which is the job to print. It then starts the PostScript printer filter lprps (see section Accommodating Plain Text Jobs on PostScript + dvips in filter mode (the argument) on standard input, which is the job to print. It then starts the PostScript printer filter lprps (see section Accommodating Plain Text Jobs on PostScript Printers) with the arguments LPD passed to this script. lprps will use those arguments to account for the pages printed. @@ -3139,8 +3139,8 @@ exec /usr/local/bin/dvips -f | /usr/local/libexec/lprps "$@" More Conversion Filter Examples Since there is no fixed set of steps to install - conversion filters, let me instead provide more examples. Use - these as guidance to making your own filters. Use them + conversion filters, let me instead provide more examples. Use + these as guidance to making your own filters. Use them directly, if appropriate. This example script is a raster (well, GIF file, actually) @@ -3187,7 +3187,7 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ exec grops | /usr/local/libexec/lprps "$@" The above script makes use of lprps again to handle the communication - with the printer. If the printer were on a parallel port, we + with the printer. If the printer were on a parallel port, we would use this script instead: @@ -3198,7 +3198,7 @@ exec grops | /usr/local/libexec/lprps "$@" # exec grops - That is it. Here is the entry we need to + That is it. Here is the entry we need to add to /etc/printcap to enable the filter: @@ -3206,8 +3206,8 @@ exec grops :tf=/usr/local/libexec/pstf: Here is an example that might make old hands at FORTRAN - blush. It is a FORTRAN-text filter for any printer that can - directly print plain text. We will install it for the printer + blush. It is a FORTRAN-text filter for any printer that can + directly print plain text. We will install it for the printer teak: @@ -3227,20 +3227,20 @@ exit 2 :rf=/usr/local/libexec/hprf: - Here is one final, somewhat complex example. We will add - a DVI filter to the LaserJet printer teak introduced earlier. First, the + Here is one final, somewhat complex example. We will add + a DVI filter to the LaserJet printer teak introduced earlier. First, the easy part: updating /etc/printcap with the location of the DVI filter: :df=/usr/local/libexec/hpdf: - Now, for the hard part: making the filter. For that, we - need a DVI-to-LaserJet/PCL conversion program. The FreeBSD + Now, for the hard part: making the filter. For that, we + need a DVI-to-LaserJet/PCL conversion program. The FreeBSD ports collection (see The Ports Collection) has one: dvi2xx is the - name of the package. Installing this package gives us the + name of the package. Installing this package gives us the program we need, dvilj2p, which converts DVI into LaserJet IIp, LaserJet III, and LaserJet 2000 compatible codes. @@ -3249,11 +3249,11 @@ exit 2 the filter hpdf quite complex since dvilj2p cannot - read from standard input. It wants to work with a filename. + read from standard input. It wants to work with a filename. What is worse, the filename has to end in .dvi so using /dev/fd/0 for standard input is - problematic. We can get around that problem by linking + problematic. We can get around that problem by linking (symbolically) a temporary file name (one that ends in .dvi) to /dev/fd/0, thereby forcing @@ -3262,7 +3262,7 @@ exit 2 The only other fly in the ointment is the fact that we cannot use /tmp for the temporary link. Symbolic links are owned by user and group - bin. The filter runs as user daemon. And the + bin. The filter runs as user daemon. And the /tmp directory has the sticky bit set. The filter can create the link, but it will not be able clean up when done and remove it since the link will belong to a @@ -3271,7 +3271,7 @@ exit 2 Instead, the filter will make the symbolic link in the current working directory, which is the spooling directory (specified by the sd capability - in /etc/printcap). This is a perfect + in /etc/printcap). This is a perfect place for filters to do their work, especially since there is (sometimes) more free disk space in the spooling directory than under /tmp. @@ -3349,9 +3349,9 @@ exit 0 printing environment, but at the cost forcing the user to specify (on the lpr - command line) which one to use. If your users are not + command line) which one to use. If your users are not particularly computer literate, having to specify a filter - option will become annoying. What is worse, though, is that + option will become annoying. What is worse, though, is that an incorrectly specified filter option may run a filter on the wrong type of file and cause your printer to spew out hundreds of sheets of paper. @@ -3359,15 +3359,15 @@ exit 0 Rather than install conversion filters at all, you might want to try having the text filter (since it is the default filter) detect the type of file it has been asked to print and - then automatically run the right conversion filter. Tools + then automatically run the right conversion filter. Tools such as file can be of help - here. Of course, it will be hard to determine the differences + here. Of course, it will be hard to determine the differences between some file types—and, of course, you can still provide conversion filters just for them. The FreeBSD ports collection has a text filter that performs automatic conversion called - apsfilter. It can detect plain text, PostScript, and DVI files, run the proper conversions, and print. + apsfilter. It can detect plain text, PostScript, and DVI files, run the proper conversions, and print. @@ -3376,9 +3376,9 @@ exit 0 Output Filters The LPD spooling system supports one other type of filter - that we have not yet explored: an output filter. An output + that we have not yet explored: an output filter. An output filter is intended for printing plain text only, like the text - filter, but with many simplifications. If you are using an + filter, but with many simplifications. If you are using an output filter but no text filter, then: @@ -3394,7 +3394,7 @@ exit 0 LPD does not pass the user's login or host to the - filter, so it is not intended to do accounting. In fact, + filter, so it is not intended to do accounting. In fact, it gets only two arguments: @@ -3412,12 +3412,12 @@ exit 0 - Do not be seduced by an output filter's simplicity. If you + Do not be seduced by an output filter's simplicity. If you would like each file in a job to start on a different page an - output filter will not work. Use a text + output filter will not work. Use a text filter (also known as an input filter); see section Installing the Text - Filter. Furthermore, an output filter is actually + Filter. Furthermore, an output filter is actually more complex in that it has to examine the byte stream being sent to it for special flag characters and must send signals to itself on behalf of LPD. @@ -3425,35 +3425,35 @@ exit 0 However, an output filter is necessary if you want header pages and need to send escape sequences or other initialization strings to be able to print the header - page. (But it is also futile if you want + page. (But it is also futile if you want to charge header pages to the requesting user's account, since LPD does not give any user or host information to the output filter.) On a single printer, LPD allows both an output filter and - text or other filters. In such cases, LPD will start the output + text or other filters. In such cases, LPD will start the output filter to print the header page (see section Header - Pages) only. LPD then expects the output filter to + Pages) only. LPD then expects the output filter to stop itself by sending two bytes to the - filter: ASCII 031 followed by ASCII 001. When an output filter + filter: ASCII 031 followed by ASCII 001. When an output filter sees these two bytes (031, 001), it should stop by sending - SIGSTOP to itself. When LPD's done running other filters, it + SIGSTOP to itself. When LPD's done running other filters, it will restart the output filter by sending SIGCONT to it. If there is an output filter but no text filter and LPD is working on a plain text job, LPD uses the - output filter to do the job. As stated before, the output + output filter to do the job. As stated before, the output filter will print each file of the job in sequence with no intervening form feeds or other paper advancement, and this is - probably not what you want. In almost all + probably not what you want. In almost all cases, you need a text filter. The program lpf, which we introduced earlier as a text filter, can also run as an output - filter. If you need a quick-and-dirty output filter but do not + filter. If you need a quick-and-dirty output filter but do not want to write the byte detection and signal sending code, try - lpf. You can also wrap lpf in a shell script to handle any + lpf. You can also wrap lpf in a shell script to handle any initialization codes the printer might require. @@ -3466,11 +3466,11 @@ exit 0 filter) that can indent output (job submitted with lpr -i), allow literal characters to pass (job submitted with lpr -l), adjust the printing position for backspaces and tabs in the job, and - account for pages printed. It can also act like an output + account for pages printed. It can also act like an output filter. lpf is suitable for many - printing environments. And although it has no capability to + printing environments. And although it has no capability to send initialization sequences to a printer, it is easy to write a shell script to do the needed initialization and then execute lpf. @@ -3478,9 +3478,9 @@ exit 0 In order for lpf to do page accounting correctly, it needs correct values filled in for the pw and pl capabilities in the - /etc/printcap file. It uses these values + /etc/printcap file. It uses these values to determine how much text can fit on a page and how many pages - were in a user's job. For more information on printer + were in a user's job. For more information on printer accounting, see Accounting for Printer Usage. @@ -3497,20 +3497,20 @@ exit 0 Header pages, also known as banner or burst pages identify to whom jobs belong - after they are printed. They are usually printed in large, bold + after they are printed. They are usually printed in large, bold letters, perhaps with decorative borders, so that in a stack of printouts they stand out from the real documents that comprise - users' jobs. They enable users to locate their jobs quickly. The + users' jobs. They enable users to locate their jobs quickly. The obvious drawback to a header page is that it is yet one more sheet that has to be printed for every job, their ephemeral usefulness lasting not more than a few minutes, ultimately finding themselves - in a recycling bin or rubbish heap. (Note that header pages go + in a recycling bin or rubbish heap. (Note that header pages go with each job, not each file in a job, so the paper waste might not be that bad.) The LPD system can provide header pages automatically for your printouts if your printer can directly print - plain text. If you have a PostScript printer, you will need an + plain text. If you have a PostScript printer, you will need an external program to generate the header page; see Header Pages on PostScript Printers. @@ -3522,14 +3522,14 @@ exit 0 In the Simple Printer Setup, we turned off header pages by specifying sh (meaning “suppress - header”) in the /etc/printcap file. To + header”) in the /etc/printcap file. To enable header pages for a printer, just remove the sh capability. Sounds too easy, right? - You are right. You might have to + You are right. You might have to provide an output filter to send initialization strings to the - printer. Here is an example output filter for Hewlett Packard + printer. Here is an example output filter for Hewlett Packard PCL-compatible printers: @@ -3542,7 +3542,7 @@ printf "\033&k2G" || exit 2 exec /usr/libexec/lpr/lpf Specify the path to the output filter in the - of capability. See of capability. See Output Filters for more information. Here is an example /etc/printcap file @@ -3561,7 +3561,7 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ :of=/usr/local/libexec/hpof: Now, when users print jobs to teak, they get a header page with each - job. If users want to spend time searching for their printouts, + job. If users want to spend time searching for their printouts, they can suppress header pages by submitting the job with lpr -h; see Header Page @@ -3583,7 +3583,7 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ By enabling header pages, LPD will produce a long header, a full page of large letters identifying - the user, host, and job. Here is an example (kelly printed the + the user, host, and job. Here is an example (kelly printed the job named outline from host rose): @@ -3649,7 +3649,7 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ rose:kelly Job: outline Date: Sun Sep 17 11:07:51 1995 Also by default, LPD prints the header page - first, then the job. To reverse that, specify hl (header last) in + first, then the job. To reverse that, specify hl (header last) in /etc/printcap. @@ -3667,18 +3667,18 @@ rose:kelly Job: outline Date: Sun Sep 17 11:07:51 1995 will have control when the header page is printed that could do accounting, and it is not provided with any user or host information or an accounting file, so it has - no idea whom to charge for printer use. It is also not enough + no idea whom to charge for printer use. It is also not enough to just “add one page” to the text filter or any of the conversion filters (which do have user and host information) since users can suppress header pages with lpr - -h. They could still be charged for header pages - they did not print. Basically, lpr -h will + -h. They could still be charged for header pages + they did not print. Basically, lpr -h will be the preferred option of environmentally-minded users, but you cannot offer any incentive to use it. It is still not enough to have each of the filters generate their own header pages (thereby being able - to charge for them). If users wanted the option of suppressing + to charge for them). If users wanted the option of suppressing the header pages with lpr -h, they will still get them and be charged for them since LPD does not pass any knowledge of the option to any of the @@ -3704,20 +3704,20 @@ rose:kelly Job: outline Date: Sun Sep 17 11:07:51 1995 Write a smart output filter. Normally, an output filter is not meant to do anything more than initialize a printer or do some simple character - conversion. It is suited for header pages and plain text - jobs (when there is no text (input) filter). But, if there + conversion. It is suited for header pages and plain text + jobs (when there is no text (input) filter). But, if there is a text filter for the plain text jobs, then LPD will - start the output filter only for the header pages. And + start the output filter only for the header pages. And the output filter can parse the header page text that LPD generates to determine what user and host to charge for - the header page. The only other problem with this method + the header page. The only other problem with this method is that the output filter still does not know what accounting file to use (it is not passed the name of the file from the af capability), but if you have a well-known accounting file, - you can hard-code that into the output filter. To + you can hard-code that into the output filter. To facilitate the parsing step, use the sh (short header) capability in - /etc/printcap. Then again, all that + /etc/printcap. Then again, all that might be too much trouble, and users will certainly appreciate the more generous system administrator who makes header pages free. @@ -3732,18 +3732,18 @@ rose:kelly Job: outline Date: Sun Sep 17 11:07:51 1995 Header Pages on PostScript Printers As described above, LPD can generate a plain text header - page suitable for many printers. Of course, PostScript cannot + page suitable for many printers. Of course, PostScript cannot directly print plain text, so the header page feature of LPD is useless—or mostly so. One obvious way to get header pages is to have every conversion filter and the text filter generate the header page. The filters should should use the user and host arguments to - generate a suitable header page. The drawback of this method is + generate a suitable header page. The drawback of this method is that users will always get a header page, even if they submit jobs with lpr -h. - Let us explore this method. The following script takes + Let us explore this method. The following script takes three arguments (user login name, host name, and job name) and makes a simple PostScript header page: @@ -3830,7 +3830,7 @@ EOF Now, each of the conversion filters and the text filter can call this script to first generate the header - page, and then print the user's job. Here is the DVI conversion + page, and then print the user's job. Here is the DVI conversion filter from earlier in this document, modified to make a header page: @@ -3868,14 +3868,14 @@ done /usr/local/bin/dvips -f ) | eval /usr/local/libexec/lprps $orig_args Notice how the filter has to parse the - argument list in order to determine the user and host name. The - parsing for the other conversion filters is identical. The text + argument list in order to determine the user and host name. The + parsing for the other conversion filters is identical. The text filter takes a slightly different set of arguments, though (see section How Filters Work). As we have mentioned before, the above scheme, though fairly simple, disables the “suppress header page” option (the - option) to lpr. If users wanted to save a tree (or a + option) to lpr. If users wanted to save a tree (or a few pennies, if you charge for header pages), they would not be able to do so, since every filter's going to print a header page with every job. @@ -3884,16 +3884,16 @@ done you will need to use the trick introduced in section Accounting for Header Pages: write an output filter that parses the LPD-generated header page and produces a - PostScript version. If the user submits the job with + PostScript version. If the user submits the job with lpr -h, then LPD will not generate a header - page, and neither will your output filter. Otherwise, your + page, and neither will your output filter. Otherwise, your output filter will read the text from LPD and send the appropriate header page PostScript code to the printer. If you have a PostScript printer on a serial line, you can make use of lprps, which comes with an output filter, psof, which - does the above. Note that psof + does the above. Note that psof does not charge for header pages. @@ -3903,14 +3903,14 @@ done Networked Printing FreeBSD supports networked printing: sending jobs to remote - printers. Networked printing generally refers to two different + printers. Networked printing generally refers to two different things: - Accessing a printer attached to a remote host. You + Accessing a printer attached to a remote host. You install a printer that has a conventional serial or parallel - interface on one host. Then, you set up LPD to enable + interface on one host. Then, you set up LPD to enable access to the printer from other hosts on the network. Section Printers @@ -3918,17 +3918,17 @@ done - Accessing a printer attached directly to a network. The + Accessing a printer attached directly to a network. The printer has a network interface in addition (or in place of) - a more conventional serial or parallel interface. Such a + a more conventional serial or parallel interface. Such a printer might work as follows: It might understand the LPD protocol and can even - queue jobs from remote hosts. In this case, it acts - just like a regular host running LPD. Follow the same + queue jobs from remote hosts. In this case, it acts + just like a regular host running LPD. Follow the same procedure in section Printers Installed on Remote Hosts to set up such a printer. @@ -3958,18 +3958,18 @@ done The LPD spooling system has built-in support for sending jobs to other hosts also running LPD (or are compatible with - LPD). This feature enables you to install a printer on one host - and make it accessible from other hosts. It also works with + LPD). This feature enables you to install a printer on one host + and make it accessible from other hosts. It also works with printers that have network interfaces that understand the LPD protocol. To enable this kind of remote printing, first install a printer on one host, the printer host, using the simple printer setup described in Simple Printer Setup. Do - any advanced setup in Advanced Printer Setup that you need. Make sure to + linkend="printing-simple">Simple Printer Setup. Do + any advanced setup in Advanced Printer Setup that you need. Make sure to test the printer and see if it works with the features of LPD - you have enabled. Also ensure that the local + you have enabled. Also ensure that the local host has authorization to use the LPD service in the remote host (see Restricting Jobs @@ -3979,7 +3979,7 @@ done compatible with LPD, then the printer host in the discussion below is the printer itself, and the printer name is the name you configured for - the printer. See the documentation that accompanied your + the printer. See the documentation that accompanied your printer and/or printer-network interface. Then, on the other hosts you want to have access to the @@ -3988,7 +3988,7 @@ done - Name the entry anything you want. For simplicity, + Name the entry anything you want. For simplicity, though, you probably want to use the same name and aliases as on the printer host. @@ -4000,7 +4000,7 @@ done Make a spooling directory and specify its location in - the sd capability. LPD will + the sd capability. LPD will store jobs here before they get sent to the printer host. @@ -4016,16 +4016,16 @@ done - That is it. You do not need to list conversion + That is it. You do not need to list conversion filters, page dimensions, or anything else in the /etc/printcap file. - Here is an example. The host rose has two printers, - bamboo and rattan. We will enable users on the host - orchid to print to those printers. Here is the + Here is an example. The host rose has two printers, + bamboo and rattan. We will enable users on the host + orchid to print to those printers. Here is the /etc/printcap file for orchid (back from section - Enabling Header Pages). It already had the entry for + Enabling Header Pages). It already had the entry for the printer teak; we have added entries for the two printers on the host rose: @@ -4065,7 +4065,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Now, users on orchid can print to - rattan and bamboo. If, for example, a user on orchid + rattan and bamboo. If, for example, a user on orchid typed @@ -4073,9 +4073,9 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ the LPD system on orchid would copy the job to the spooling directory /var/spool/lpd/bamboo and note that it was - a DVI job. As soon as the host rose has room in its bamboo spooling directory, the two LPDs - would transfer the file to rose. The file would wait in rose's - queue until it was finally printed. It would be converted from + a DVI job. As soon as the host rose has room in its bamboo spooling directory, the two LPDs + would transfer the file to rose. The file would wait in rose's + queue until it was finally printed. It would be converted from DVI to PostScript (since bamboo is a PostScript printer) on rose. @@ -4088,7 +4088,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ you can get two versions: one which emulates a spooler (the more expensive version), or one which just lets you send data to it as if you were using a serial or parallel port (the cheaper - version). This section tells how to use the cheaper version. + version). This section tells how to use the cheaper version. For the more expensive one, see the previous section Printers Installed on Remote Hosts. @@ -4097,18 +4097,18 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ lets you specify what serial or parallel interface to use, and (if you are using a serial interface), what baud rate, whether to use flow control, delays for tabs, conversion of newlines, - and more. But there is no way to specify a connection to a + and more. But there is no way to specify a connection to a printer that is listening on a TCP/IP or other network port. To send data to a networked printer, you need to develop a communications program that can be called by the text and - conversion filters. Here is one such example: the script + conversion filters. Here is one such example: the script netprint takes all data on - standard input and sends it to a network-attached printer. We + standard input and sends it to a network-attached printer. We specify the hostname of the printer as the first argument and the port number to which to connect as the second argument to - netprint. Note that this supports + netprint. Note that this supports one-way communication only (FreeBSD to printer); many network printers support two-way communication, and you might want to take advantage of that (to get printer status, perform @@ -4140,9 +4140,9 @@ while (<STDIN>) { print PRINTER; } exit 0; We can then use this script in various - filters. Suppose we had a Diablo 750-N line printer connected - to the network. The printer accepts data to print on port - number 5100. The host name of the printer is scrivener. Here + filters. Suppose we had a Diablo 750-N line printer connected + to the network. The printer accepts data to print on port + number 5100. The host name of the printer is scrivener. Here is the text filter for the printer: @@ -4169,16 +4169,16 @@ exit 0; Restricting Multiple Copies The LPD system makes it easy for users to print multiple - copies of a file. Users can print jobs with lpr + copies of a file. Users can print jobs with lpr -#5 (for example) and get five copies of each file - in the job. Whether this is a good thing is up to you. + in the job. Whether this is a good thing is up to you. If you feel multiple copies cause unnecessary wear and tear on your printers, you can disable the option to lpr by adding the sc capability to the - /etc/printcap file. When users submit jobs + /etc/printcap file. When users submit jobs with the option, they will see: @@ -4192,8 +4192,8 @@ exit 0; will still be able to submit multiple-copy jobs by using another host. - Here is an example. This is the - /etc/printcap file for the host rose. The + Here is an example. This is the + /etc/printcap file for the host rose. The printer rattan is quite hearty, so we will allow multiple copies, but the laser printer bamboo's a bit more delicate, so we will disable multiple copies by adding the sc capability: @@ -4254,7 +4254,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ You can control who can print to what printers by using the UNIX group mechanism and the rg - capability in /etc/printcap. Just place + capability in /etc/printcap. Just place the users you want to have access to a printer in a certain group, and then name that group in the rg capability. @@ -4275,7 +4275,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ For example, we will let anyone access the printer rattan, but only those in group - artists can use bamboo. Here is the familiar + artists can use bamboo. Here is the familiar /etc/printcap for host rose: @@ -4295,10 +4295,10 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Let us leave the other example /etc/printcap file (for the host orchid) - alone. Of course, anyone on orchid can print to - bamboo. It might be the case that we only + alone. Of course, anyone on orchid can print to + bamboo. It might be the case that we only allow certain logins on orchid anyway, and want them to have - access to the printer. Or not. + access to the printer. Or not. There can be only one restricted group per printer. @@ -4310,14 +4310,14 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ If you have many users accessing the printers, you probably need to put an upper limit on the sizes of the files users can - submit to print. After all, there is only so much free space on + submit to print. After all, there is only so much free space on the filesystem that houses the spooling directories, and you also need to make sure there is room for the jobs of other users. LPD enables you to limit the maximum byte size a file in a job can be with the mx capability. - The units are in BUFSIZ blocks, which are 1024 bytes. If you + The units are in BUFSIZ blocks, which are 1024 bytes. If you put a zero for this capability, there will be no limit on file size. @@ -4327,13 +4327,13 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ LPD will not refuse a file that is larger than the limit you - place on a printer. Instead, it will queue as much of the file - up to the limit, which will then get printed. The rest will be - discarded. Whether this is correct behavior is up for + place on a printer. Instead, it will queue as much of the file + up to the limit, which will then get printed. The rest will be + discarded. Whether this is correct behavior is up for debate. Let us add limits to our example printers - rattan and bamboo. Since those artists' PostScript + rattan and bamboo. Since those artists' PostScript files tend to be large, we will limit them to five megabytes. We will put no limit on the plain text line printer: @@ -4360,10 +4360,10 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ :df=/usr/local/libexec/psdf: Again, the limits apply to the local users - only. If you have set up access to your printers remotely, - remote users will not get those limits. You will need to + only. If you have set up access to your printers remotely, + remote users will not get those limits. You will need to specify the mx capability in the - remote /etc/printcap files as well. See + remote /etc/printcap files as well. See section Printers Installed on Remote Hosts for more information on @@ -4388,13 +4388,13 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ You can control from which remote hosts a local LPD accepts requests with the files /etc/hosts.equiv and - /etc/hosts.lpd. LPD checks to see + /etc/hosts.lpd. LPD checks to see if an incoming request is from a host listed in either - one of these files. If not, LPD refuses the + one of these files. If not, LPD refuses the request. The format of these files is simple: one host name - per line. Note that the file + per line. Note that the file /etc/hosts.equiv is also used by the ruserok3 protocol, and affects programs like @@ -4424,15 +4424,15 @@ madrigal.fishbaum.de You can control how much free space there needs to remain on the filesystem where a spooling directory - resides. Make a file called + resides. Make a file called minfree in the spooling directory - for the local printer. Insert in that file a number + for the local printer. Insert in that file a number representing how many disk blocks (512 bytes) of free space there has to be for a remote job to be accepted. This lets you insure that remote users will not fill - your filesystem. You can also use it to give a certain + your filesystem. You can also use it to give a certain priority to local users: they will be able to queue jobs long after the free disk space has fallen below the amount specified in the minfree @@ -4440,7 +4440,7 @@ madrigal.fishbaum.de For example, let us add a minfree file for the printer - bamboo. We examine + bamboo. We examine /etc/printcap to find the spooling directory for this printer; here is bamboo's entry: @@ -4453,7 +4453,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ :df=/usr/local/libexec/psdf: The spooling directory is the given - in the sd capability. We + in the sd capability. We will make three megabytes (which is 6144 disk blocks) the amount of free disk space that must exist on the filesystem for LPD to accept remote jobs: @@ -4470,18 +4470,18 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ You can control which remote users can print to local printers by specifying the rs capability in - /etc/printcap. When rs appears in the entry for a + /etc/printcap. When rs appears in the entry for a locally-attached printer, LPD will accept jobs from remote hosts if the user submitting the job also has an account of the same login name on - the local host. Otherwise, LPD refuses the job. + the local host. Otherwise, LPD refuses the job. This capability is particularly useful in an environment where there are (for example) different departments sharing a network, and some users transcend - departmental boundaries. By giving them accounts on + departmental boundaries. By giving them accounts on your systems, they can use your printers from their own - departmental systems. If you would rather allow them to + departmental systems. If you would rather allow them to use only your printers and not your compute resources, you can give them “token” accounts, with no home directory and a useless shell like @@ -4498,16 +4498,16 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Accounting for Printer Usage - So, you need to charge for printouts. And why not? Paper - and ink cost money. And then there are maintenance + So, you need to charge for printouts. And why not? Paper + and ink cost money. And then there are maintenance costs—printers are loaded with moving parts and tend to break - down. You have examined your printers, usage patterns, and + down. You have examined your printers, usage patterns, and maintenance fees and have come up with a per-page (or per-foot, - per-meter, or per-whatever) cost. Now, how do you actually start + per-meter, or per-whatever) cost. Now, how do you actually start accounting for printouts? Well, the bad news is the LPD spooling system does not provide - much help in this department. Accounting is highly dependent on + much help in this department. Accounting is highly dependent on the kind of printer in use, the formats being printed, and your requirements in charging for printer usage. @@ -4515,8 +4515,8 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ To implement accounting, you have to modify a printer's text filter (to charge for plain text jobs) and the conversion filters (to charge for other file formats), to count pages or query the - printer for pages printed. You cannot get away with using the - simple output filter, since it cannot do accounting. See section + printer for pages printed. You cannot get away with using the + simple output filter, since it cannot do accounting. See section Filters. @@ -4525,21 +4525,21 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Periodic accounting is the more - common way, possibly because it is easier. Whenever someone + common way, possibly because it is easier. Whenever someone prints a job, the filter logs the user, host, and number of - pages to an accounting file. Every month, semester, year, + pages to an accounting file. Every month, semester, year, or whatever time period you prefer, you collect the accounting files for the various printers, tally up the - pages printed by users, and charge for usage. Then you + pages printed by users, and charge for usage. Then you truncate all the logging files, starting with a clean slate for the next period. Timely accounting is less common, - probably because it is more difficult. This method has the + probably because it is more difficult. This method has the filters charge users for printouts as soon as they use the - printers. Like disk quotas, the accounting is immediate. + printers. Like disk quotas, the accounting is immediate. You can prevent users from printing when their account goes in the red, and might provide a way for users to check and adjust their “print quotas.” But this method requires some @@ -4551,12 +4551,12 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ The LPD spooling system supports both methods easily: since you have to provide the filters (well, most of the time), you also - have to provide the accounting code. But there is a bright side: - you have enormous flexibility in your accounting methods. For + have to provide the accounting code. But there is a bright side: + you have enormous flexibility in your accounting methods. For example, you choose whether to use periodic or timely accounting. You choose what information to log: user names, host names, job types, pages printed, square footage of paper used, how long the - job took to print, and so forth. And you do so by modifying the + job took to print, and so forth. And you do so by modifying the filters to save this information. @@ -4564,7 +4564,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Quick and Dirty Printer Accounting FreeBSD comes with two programs that can get you set up - with simple periodic accounting right away. They are the text + with simple periodic accounting right away. They are the text filter lpf, described in section lpf: a Text Filter, and @@ -4575,17 +4575,17 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ As mentioned in the section on filters (Filters), LPD starts the text and the conversion filters with the name of the - accounting file to use on the filter command line. The filters + accounting file to use on the filter command line. The filters can use this argument to know where to write an accounting file - entry. The name of this file comes from the af capability in + entry. The name of this file comes from the af capability in /etc/printcap, and if not specified as an absolute path, is relative to the spooling directory. LPD starts lpf with page width and length arguments (from the pw - and pl capabilities). lpf uses these arguments to determine how - much paper will be used. After sending the file to the printer, - it then writes an accounting entry in the accounting file. The + and pl capabilities). lpf uses these arguments to determine how + much paper will be used. After sending the file to the printer, + it then writes an accounting entry in the accounting file. The entries look like this: @@ -4598,19 +4598,19 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ You should use a separate accounting file for each printer, as lpf has no file locking logic built into it, and two lpfs might corrupt each other's entries if - they were to write to the same file at the same time. A easy way + they were to write to the same file at the same time. A easy way to insure a separate accounting file for each printer is to use af=acct in - /etc/printcap. Then, each accounting file + /etc/printcap. Then, each accounting file will be in the spooling directory for a printer, in a file named acct. When you are ready to charge users for printouts, run the pac - program. Just change to the spooling directory for the printer + program. Just change to the spooling directory for the printer you want to collect on and type - pac. You + pac. You will get a dollar-centric summary like the following: @@ -4634,7 +4634,7 @@ total 337.00 154 $ 6.74 Which printer to - summarize. This option works only if there is an + summarize. This option works only if there is an absolute path in the af capability in /etc/printcap. @@ -4651,9 +4651,9 @@ total 337.00 154 $ 6.74 - Ignore host name in the accounting files. With this + Ignore host name in the accounting files. With this option, user smith on host alpha is the same user smith - on host gamma. Without, they are different + on host gamma. Without, they are different users. @@ -4664,7 +4664,7 @@ total 337.00 154 $ 6.74 Compute charges with price dollars per page or per foot instead of the price from the pc capability in /etc/printcap, or two cents (the - default). You can specify price as a floating point + default). You can specify price as a floating point number. @@ -4697,7 +4697,7 @@ total 337.00 154 $ 6.74 In the default summary that pac produces, you see the number of pages printed by each user from - various hosts. If, at your site, host does not matter (because + various hosts. If, at your site, host does not matter (because users can use any host), run pac -m, to produce the following summary: @@ -4717,28 +4717,28 @@ total 337.00 154 $ 6.74 pac uses the pc capability in the /etc/printcap file (default of 200, or 2 - cents per page). Specify, in hundredths of cents, the price per + cents per page). Specify, in hundredths of cents, the price per page or per foot you want to charge for printouts in this - capability. You can override this value when you run + capability. You can override this value when you run pac with - the option. The units for the + the option. The units for the option are in dollars, though, not - hundredths of cents. For example, + hundredths of cents. For example, &prompt.root; pac -p1.50 makes each page cost one dollar and fifty - cents. You can really rake in the profits by using this + cents. You can really rake in the profits by using this option. Finally, running pac -s will save the summary information in a summary accounting file, which is named the same as the printer's accounting file, but with - _sum appended to the name. It then truncates - the accounting file. When you run + _sum appended to the name. It then truncates + the accounting file. When you run pac again, it rereads the summary file to get starting totals, then adds information from the regular accounting file. @@ -4749,12 +4749,12 @@ total 337.00 154 $ 6.74 How Can You Count Pages Printed? In order to perform even remotely accurate accounting, you - need to be able to determine how much paper a job uses. This is + need to be able to determine how much paper a job uses. This is the essential problem of printer accounting. For plain text jobs, the problem's not that hard to solve: you count how many lines are in a job and compare it to how many - lines per page your printer supports. Do not forget to take + lines per page your printer supports. Do not forget to take into account backspaces in the file which overprint lines, or long logical lines that wrap onto one or more additional physical lines. @@ -4762,7 +4762,7 @@ total 337.00 154 $ 6.74 The text filter lpf (introduced in lpf: a Text Filter) takes into account these things when it does - accounting. If you are writing a text filter which needs to do + accounting. If you are writing a text filter which needs to do accounting, you might want to examine lpf's source code. How do you handle other file formats, though? @@ -4771,24 +4771,24 @@ total 337.00 154 $ 6.74 you can have your filter parse the diagnostic output of dvilj or - dvips and look to see how many pages were converted. You might be able to do similar things with other file formats and conversion programs. + dvips and look to see how many pages were converted. You might be able to do similar things with other file formats and conversion programs. But these methods suffer from the fact that the printer may - not actually print all those pages. For example, it could jam, + not actually print all those pages. For example, it could jam, run out of toner, or explode—and the user would still get charged. So, what can you do? There is only one sure way to do - accurate accounting. Get a printer that + accurate accounting. Get a printer that can tell you how much paper it uses, and attach it via a serial - line or a network connection. Nearly all PostScript printers - support this notion. Other makes and models do as well - (networked Imagen laser printers, for example). Modify the + line or a network connection. Nearly all PostScript printers + support this notion. Other makes and models do as well + (networked Imagen laser printers, for example). Modify the filters for these printers to get the page usage after they print each job and have them log accounting information based on - that value only. There is no line counting + that value only. There is no line counting nor error-prone file examination required. Of course, you can always be generous and make all printouts @@ -4803,7 +4803,7 @@ total 337.00 154 $ 6.74 If you have been reading straight through this manual, by now you have learned just about everything there is to know about the - LPD spooling system that comes with FreeBSD. You can probably + LPD spooling system that comes with FreeBSD. You can probably appreciate many of its shortcomings, which naturally leads to the question: “What other spooling systems are out there (and work with FreeBSD)?” @@ -4819,7 +4819,7 @@ total 337.00 154 $ 6.74 PLP was based on software developed by Patrick Powell and then maintained by an Internet-wide group of developers. The main site for the software is at ftp://ftp.iona.ie/pub/plp. There is also a web page. + URL="ftp://ftp.iona.ie/pub/plp">ftp://ftp.iona.ie/pub/plp. There is also a web page. It is quite similar to the BSD LPD spooler, but boasts a host of features, including: @@ -4858,9 +4858,9 @@ total 337.00 154 $ 6.74 LPRng, which purportedly means “LPR: the Next - Generation” is a complete rewrite of PLP. Patrick Powell + Generation” is a complete rewrite of PLP. Patrick Powell and Justin Mason (the principal maintainer of PLP) - collaborated to make LPRng. The main site for LPRng is + collaborated to make LPRng. The main site for LPRng is ftp://dickory.sdsu.edu/pub/LPRng. diff --git a/en/handbook/quotas/chapter.sgml b/en/handbook/quotas/chapter.sgml index d594296cc4..1aa60cdb11 100644 --- a/en/handbook/quotas/chapter.sgml +++ b/en/handbook/quotas/chapter.sgml @@ -9,7 +9,7 @@ user, or members of a group, may allocate on a per-file system basis. This is used most often on timesharing systems where it is desirable to limit the amount of resources any one user or group of users may - allocate. This will prevent one user from consuming all of the + allocate. This will prevent one user from consuming all of the available disk space. @@ -17,7 +17,7 @@ Configuring Your System to Enable Disk Quotas Before attempting to use disk quotas it is necessary to make - sure that quotas are configured in your kernel. This is done by + sure that quotas are configured in your kernel. This is done by adding the following line to your kernel configuration file: @@ -26,12 +26,12 @@ options QUOTA The stock GENERIC kernel does not have this enabled by default, so you will have to configure, build and install a - custom kernel in order to use disk quotas. Please refer to the + custom kernel in order to use disk quotas. Please refer to the Configuring the FreeBSD Kernel section for more information on kernel configuration. Next you will need to enable disk quotas in - /etc/sysconfig. This is done by changing the + /etc/sysconfig. This is done by changing the line: @@ -50,19 +50,19 @@ quotas=YES check_quotas=YES Finally you will need to edit /etc/fstab to - enable disk quotas on a per-file system basis. This is where you + enable disk quotas on a per-file system basis. This is where you can either enable user or group quotas or both for all of your file systems. To enable per-user quotas on a file system, add the userquota option to the options field in the /etc/fstab entry for the file system you want - to to enable quotas on. For example: + to to enable quotas on. For example: /dev/sd1s2g /home ufs rw,userquota 1 2 Similarly, to enable group quotas, use the - groupquota option instead of the userquota keyword. To enable both user and + groupquota option instead of the userquota keyword. To enable both user and group quotas, change the entry as follows: @@ -71,20 +71,20 @@ check_quotas=YES By default the quota files are stored in the root directory of the file system with the names quota.user and quota.group for user and group quotas - respectively. See man fstab for more - information. Even though that man page says that you can specify an + respectively. See man fstab for more + information. Even though that man page says that you can specify an alternate location for the quota files, this is not recommended since all of the various quota utilities do not seem to handle this properly. At this point you should reboot your system with your new - kernel. /etc/rc will automatically run the + kernel. /etc/rc will automatically run the appropriate commands to create the initial quota files for all of the quotas you enabled in /etc/fstab, so there is no need to manually create any zero length quota files. In the normal course of operations you should not be required to - run the quotacheck, quotaon, or quotaoff commands manually. However, you may + run the quotacheck, quotaon, or quotaoff commands manually. However, you may want to read their man pages just to be familiar with their operation. @@ -94,7 +94,7 @@ check_quotas=YES Setting Quota Limits Once you have configured your system to enable quotas, verify - that they really are enabled. An easy way to do this is to run + that they really are enabled. An easy way to do this is to run &prompt.root; quota -v @@ -109,28 +109,28 @@ check_quotas=YES You have several options on how to enforce limits on the amount of disk space a user or group may allocate, and how many files they - may create. You may limit allocations based on disk space (block + may create. You may limit allocations based on disk space (block quotas) or number of files (inode quotas) or a combination of both. Each of these limits are further broken down into two categories: hard and soft limits. - A hard limit may not be exceeded. Once a user reaches their + A hard limit may not be exceeded. Once a user reaches their hard limit they may not make any further allocations on the file - system in question. For example, if the user has a hard limit of + system in question. For example, if the user has a hard limit of 500 blocks on a file system and is currently using 490 blocks, the - user can only allocate an additional 10 blocks. Attempting to + user can only allocate an additional 10 blocks. Attempting to allocate an additional 11 blocks will fail. Soft limits on the other hand can be exceeded for a limited - amount of time. This period of time is known as the grace period, - which is one week by default. If a user stays over his or her soft + amount of time. This period of time is known as the grace period, + which is one week by default. If a user stays over his or her soft limit longer than their grace period, the soft limit will turn into - a hard limit and no further allocations will be allowed. When the + a hard limit and no further allocations will be allowed. When the user drops back below the soft limit, the grace period will be reset. The following is an example of what you might see when you run - then edquota command. When the + then edquota command. When the edquota command is invoked, you are placed into the editor specified by the EDITOR environment variable, or in the vi @@ -166,10 +166,10 @@ Quotas for user test: quota limits will be in place when you exit the editor. Sometimes it is desirable to set quota limits on a range of - uids. This can be done by use of the option on - the edquota command. First, assign + uids. This can be done by use of the option on + the edquota command. First, assign the desired quota limit to a user, and then run edquota -p - protouser startuid-enduid. For example, if user + protouser startuid-enduid. For example, if user test has the desired quota limits, the following command can be used to duplicate those quota limits for uids 10,000 through 19,999: @@ -179,7 +179,7 @@ Quotas for user test: The ability to specify uid ranges was added to the system after - 2.1 was released. If you need this feature on a 2.1 system, you + 2.1 was released. If you need this feature on a 2.1 system, you will need to obtain a newer copy of edquota. See man edquota for more detailed @@ -192,10 +192,10 @@ Quotas for user test: You can use either the quota or the repquota commands to check quota - limits and disk usage. The quota + limits and disk usage. The quota command can be used to check individual user and group quotas and - disk usage. Only the super-user may examine quotas and usage for - other users, or for groups that they are not a member of. The + disk usage. Only the super-user may examine quotas and usage for + other users, or for groups that they are not a member of. The repquota command can be used to get a summary of all quotas and disk usage for file systems with quotas enabled. @@ -213,12 +213,12 @@ Disk quotas for user test (uid 1002): On the /usr file system in the above example this user is currently 15 blocks over their soft limit of 50 blocks and - has 5 days of their grace period left. Note the asterisk * which + has 5 days of their grace period left. Note the asterisk * which indicates that the user is currently over their quota limit. Normally file systems that the user is not using any disk space on will not show up in the output from the quota command, even if they have a quota limit - assigned for that file system. The option will + assigned for that file system. The option will display those file systems, such as the /usr/var file system in the above example. diff --git a/en/handbook/security/chapter.sgml b/en/handbook/security/chapter.sgml index 2bc0726f7a..45fd5953d2 100644 --- a/en/handbook/security/chapter.sgml +++ b/en/handbook/security/chapter.sgml @@ -10,14 +10,14 @@ In order to protect the security of passwords on UN*X systems from being easily exposed, passwords have traditionally been - scrambled in some way. Starting with Bell Labs' Seventh Edition + scrambled in some way. Starting with Bell Labs' Seventh Edition Unix, passwords were encrypted using what the security people call a - “one-way hash function”. That is to say, the password is + “one-way hash function”. That is to say, the password is transformed in such a way that the original password cannot be regained except by brute-force searching the space of possible - passwords. Unfortunately, the only secure method that was available + passwords. Unfortunately, the only secure method that was available to the AT&T researchers at the time was based on DES, the Data - Encryption Standard. This causes only minimal difficulty for + Encryption Standard. This causes only minimal difficulty for commercial vendors, but is a serious problem for an operating system like FreeBSD where all the source code is freely available, because national governments in many places like to place restrictions on @@ -28,23 +28,23 @@ still not running afoul of the law? We decided to take a dual-track approach: we would make distributions which contained only a non-regulated password scrambler, and then provide as a separate - add-on library the DES-based password hash. The password-scrambling + add-on library the DES-based password hash. The password-scrambling function was moved out of the C library to a separate library, called libcrypt because the name of - the C function to implement it is crypt. In FreeBSD 1.x and some pre-release + the C function to implement it is crypt. In FreeBSD 1.x and some pre-release 2.0 snapshots, the non-regulated scrambler uses an insecure function written by Nate Williams; in subsequent releases this was replaced by a mechanism using the RSA Data Security, Inc., MD5 one-way hash - function. Because neither of these functions involve encryption, + function. Because neither of these functions involve encryption, they are believed to be exportable from the US and importable into many other countries. Meanwhile, work was also underway on the DES-based password hash - function. First, a version of the crypt function which was written outside the - US was imported, thus synchronizing the US and non-US code. Then, + function. First, a version of the crypt function which was written outside the + US was imported, thus synchronizing the US and non-US code. Then, the library was modified and split into two; the DES libcrypt contains only the code involved in performing the one-way password hash, and a separate libcipher was created with the entry points - to actually perform encryption. The code was partitioned in this + to actually perform encryption. The code was partitioned in this way to make it easier to get an export license for the compiled library. @@ -54,8 +54,8 @@ mechanism It is fairly easy to recognize whether a particular password - string was created using the DES- or MD5-based hash function. MD5 - password strings always begin with the characters $1$. DES password strings do not + string was created using the DES- or MD5-based hash function. MD5 + password strings always begin with the characters $1$. DES password strings do not have any particular identifying characteristics, but they are shorter than MD5 passwords, and are coded in a 64-character alphabet which does not include the $ character, so a relatively short @@ -63,10 +63,10 @@ password. Determining which library is being used on your system is - fairly easy for most programs, except for those like init which are statically linked. (For + fairly easy for most programs, except for those like init which are statically linked. (For those programs, the only way is to try them on a known password and see if it works.) Programs which use crypt are linked against libcrypt, which for each type of library is - a symbolic link to the appropriate implementation. For example, + a symbolic link to the appropriate implementation. For example, on a system using the DES versions: @@ -94,69 +94,69 @@ lrwxr-xr-x 1 bin bin 15 Sep 5 12:50 libcrypt_p.a -> libdescrypt_p.aS/Key is a one-time password scheme based on a one-way hash function (in our version, this is MD4 for compatibility; other - versions have used MD5 and DES-MAC). S/Key has been a standard part + versions have used MD5 and DES-MAC). S/Key has been a standard part of all FreeBSD distributions since version 1.1.5, and is also - implemented on a large and growing number of other systems. S/Key + implemented on a large and growing number of other systems. S/Key is a registered trademark of Bell Communications Research, Inc. There are three different sorts of passwords which we will talk - about in the discussion below. The first is your usual UNIX-style - or Kerberos password; we will call this a “UNIX password”. The + about in the discussion below. The first is your usual UNIX-style + or Kerberos password; we will call this a “UNIX password”. The second sort is the one-time password which is generated by the S/Key key program and accepted by the keyinit program and the login - prompt; we will call this a “one-time password”. The final sort + prompt; we will call this a “one-time password”. The final sort of password is the secret password which you give to the key program (and sometimes the keyinit program) which it uses to generate one-time passwords; we will call it a “secret password” or just unqualified “password”. The secret password does not necessarily have anything to do with your UNIX password (while they can be the same, this is not - recommended). While UNIX passwords are limited to eight characters + recommended). While UNIX passwords are limited to eight characters in length, your S/Key secret password can be as long as you like; I - use seven-word phrases. In general, the S/Key system operates + use seven-word phrases. In general, the S/Key system operates completely independently of the UNIX password system. There are in addition two other sorts of data involved in the S/Key system; one is called the “seed” or (confusingly) “key”, and consists of two letters and five digits, and the other is the - “iteration count” and is a number between 100 and 1. S/Key + “iteration count” and is a number between 100 and 1. S/Key constructs a one-time password from these components by concatenating the seed and the secret password, then applying a one-way hash (the RSA Data Security, Inc., MD4 secure hash function) iteration-count times, and turning the result into six short English - words. The login and su programs keep track of the last one-time + words. The login and su programs keep track of the last one-time password used, and the user is authenticated if the hash of the - user-provided password is equal to the previous password. Because a + user-provided password is equal to the previous password. Because a one-way hash function is used, it is not possible to generate future one-time passwords having overheard one which was successfully used; the iteration count is decremented after each successful login to - keep the user and login program in sync. (When you get the + keep the user and login program in sync. (When you get the iteration count down to 1, it is time to reinitialize S/Key.) There are four programs involved in the S/Key system which we - will discuss below. The key program + will discuss below. The key program accepts an iteration count, a seed, and a secret password, and - generates a one-time password. The keyinit program is used to initialized S/Key, + generates a one-time password. The keyinit program is used to initialized S/Key, and to change passwords, iteration counts, or seeds; it takes either a secret password, or an iteration count, seed, and one-time - password. The keyinfo program + password. The keyinfo program examines the /etc/skeykeys file and prints out - the invoking user's current iteration count and seed. Finally, the + the invoking user's current iteration count and seed. Finally, the login and su programs contain the necessary logic to - accept S/Key one-time passwords for authentication. The login program is also capable of disallowing + accept S/Key one-time passwords for authentication. The login program is also capable of disallowing the use of UNIX passwords on connections coming from specified addresses. - There are four different sorts of operations we will cover. The + There are four different sorts of operations we will cover. The first is using the keyinit program over a secure connection to set up S/Key for the first time, or to - change your password or seed. The second operation is using the + change your password or seed. The second operation is using the keyinit program over an insecure connection, in conjunction with the key program over a secure connection, to do - the same. The third is using the key program to log in over an insecure - connection. The fourth is using the key program to generate a number of keys + the same. The third is using the key program to log in over an insecure + connection. The fourth is using the key program to generate a number of keys which can be written down or printed out to carry with you when going to some location without secure connections to anywhere (like at a conference). @@ -185,14 +185,14 @@ HAS FONT GOUT FATE BOOM ) - There is a lot of information here. At theEnter secret + There is a lot of information here. At theEnter secret password: prompt, you should enter some password or phrase (I use phrases of minimum seven words) which will be needed to generate - login keys. The line starting `ID' gives the parameters of your + login keys. The line starting `ID' gives the parameters of your particular S/Key instance: your login name, the iteration count, - and seed. When logging in with S/Key, the system will remember + and seed. When logging in with S/Key, the system will remember these parameters and present them back to you so you do not have - to remember them. The last line gives the particular one-time + to remember them. The last line gives the particular one-time password which corresponds to those parameters and your secret password; if you were to re-login immediately, this one-time password is the one you would use. @@ -206,9 +206,9 @@ HAS FONT GOUT FATE BOOM ) insecure connection, you will need to already have a secure connection to some place where you can run the key program; this might be in the form of a desk accessory on a Macintosh, or a shell prompt on a machine you - trust (we will show the latter). You will also need to make up an + trust (we will show the latter). You will also need to make up an iteration count (100 is probably a good value), and you may make - up your own seed or use a randomly-generated one. Over on the + up your own seed or use a randomly-generated one. Over on the insecure connection (to the machine you are initializing), use the keyinit -s command: @@ -224,7 +224,7 @@ s/key 100 kh94742 To accept the default seed (which the keyinit program - confusingly calls a key), press return. Then move over to your + confusingly calls a key), press return. Then move over to your secure connection or S/Key desk accessory, and give it the same parameters: @@ -274,10 +274,10 @@ s/key 92 hi52030 Note that, before prompting for a password, the login program prints out the iteration number and seed which you will need in - order to generate the appropriate key. You will also find a + order to generate the appropriate key. You will also find a useful feature (not shown here): if you press return at the password prompt, the login program will turn echo on, so you can - see what you are typing. This can be extremely useful if you are + see what you are typing. This can be extremely useful if you are attempting to type in an S/Key by hand, such as from a printout. @@ -293,13 +293,13 @@ s/key 92 hi52030 Generating a single one-time password Now, to generate the one-time password needed to answer this - login prompt, we use a trusted machine and the key program. (There are versions of the + login prompt, we use a trusted machine and the key program. (There are versions of the key program from DOS and Windows machines, and there is an S/Key desk accessory for Macintosh computers as well.) The command-line key program takes as its parameters the iteration count and seed; you can cut-and-paste right from the login prompt starting at key to - the end of the line. Thus: + the end of the line. Thus: @@ -324,7 +324,7 @@ Last login: Wed Jun 28 15:31:00 from halloran-eldar.l This is the easiest mechanism if you have - a trusted machine. There is a Java S/Key key applet, key applet, The Java OTP Calculator, that you can download and run locally on any Java supporting brower. @@ -335,10 +335,10 @@ Last login: Wed Jun 28 15:31:00 from halloran-eldar.l Generating multiple one-time passwords Sometimes we have to go places where no trusted machines or - connections are available. In this case, it is possible to use + connections are available. In this case, it is possible to use the key command to generate a number of one-time passwords in the same command; these can then - be printed out. For example: + be printed out. For example: @@ -356,10 +356,10 @@ Reminder - Do not use this program while logged in via telnet or rlogin. The requests twenty-five keys in sequence; the indicates the ending iteration number; and the rest is as - before. Note that these are printed out in - reverse order of eventual use. If you are + before. Note that these are printed out in + reverse order of eventual use. If you are really paranoid, you might want to write the results down by hand; - otherwise you can cut-and-paste into lpr. Note that each line shows both the + otherwise you can cut-and-paste into lpr. Note that each line shows both the iteration count and the one-time password; you may still find it handy to scratch off passwords as you use them. @@ -371,17 +371,17 @@ Reminder - Do not use this program while logged in via telnet or rlogin. The configuration file /etc/skey.access can be used to configure restrictions on the use of UNIX passwords based on the host name, user name, terminal port, or IP address of - a login session. The complete format of the file is documented in + a login session. The complete format of the file is documented in the skey.access5 manual page; there are also some security cautions there which should be read before depending on this file for security. If there is no /etc/skey.access file (which is the default state as FreeBSD is shipped), then all users - will be allowed to use UNIX passwords. If the file exists, + will be allowed to use UNIX passwords. If the file exists, however, then all users will be required to use S/Key unless explicitly permitted to do otherwise by configuration statements - in the skey.access file. In all cases, UNIX + in the skey.access file. In all cases, UNIX passwords are permitted on the console. Here is a sample configuration file which illustrates the @@ -395,7 +395,7 @@ permit port ttyd0 The first line (permit internet) allows users whose IP source address (which is vulnerable to spoofing) matches the specified value and - mask, to use UNIX passwords. This should not be considered a + mask, to use UNIX passwords. This should not be considered a security mechanism, but rather, a means to remind authorized users that they are using an insecure network and need to use S/Key for authentication. @@ -427,7 +427,7 @@ permit port ttyd0 more controllable. The following instructions can be used as a guide on how to set - up Kerberos as distributed for FreeBSD. However, you should refer to + up Kerberos as distributed for FreeBSD. However, you should refer to the relevant manual pages for a complete description. In FreeBSD, the Kerberos is not that from the original @@ -438,7 +438,7 @@ permit port ttyd0 For those needing to get a legal foreign distribution of this software, please do not get it from a USA or - Canada site. You will get that site in big + Canada site. You will get that site in big trouble! A legal copy of this is available from ftp.internat.freebsd.org, which is in South Africa and an official FreeBSD mirror site. @@ -447,8 +447,8 @@ permit port ttyd0 Creating the initial database - This is done on the Kerberos server only. First make sure that - you do not have any old Kerberos databases around. You should + This is done on the Kerberos server only. First make sure that + you do not have any old Kerberos databases around. You should change to the directory /etc/kerberosIV and check that only the following files are present: @@ -468,9 +468,9 @@ README krb.conf krb.realms You should now edit the krb.conf and krb.realms files to define your Kerberos - realm. In this case the realm will be + realm. In this case the realm will be GRONDAR.ZA and the server is - grunt.grondar.za. We edit or create the + grunt.grondar.za. We edit or create the krb.conf file: @@ -487,23 +487,23 @@ TELECOM.MIT.EDU bitsy.mit.edu ARC.NASA.GOV trident.arc.nasa.gov - In this case, the other realms do not need to be there. They + In this case, the other realms do not need to be there. They are here as an example of how a machine may be made aware of - multiple realms. You may wish to not include them for + multiple realms. You may wish to not include them for simplicity. - The first line names the realm in which this system works. The - other lines contain realm/host entries. The first item on a line + The first line names the realm in which this system works. The + other lines contain realm/host entries. The first item on a line is a realm, and the second is a host in that realm that is acting - as a “key distribution centre”. The words admin server + as a “key distribution centre”. The words admin server following a hosts name means that host also provides an - administrative database server. For further explanation of these + administrative database server. For further explanation of these terms, please consult the Kerberos man pages. Now we have to add grunt.grondar.za to the GRONDAR.ZA realm and also add an entry to put all hosts in the .grondar.za domain in - the GRONDAR.ZA realm. The + the GRONDAR.ZA realm. The krb.realms file would be updated as follows: @@ -516,16 +516,16 @@ grunt.grondar.za GRONDAR.ZA .mit.edu ATHENA.MIT.EDU - Again, the other realms do not need to be there. They are here + Again, the other realms do not need to be there. They are here as an example of how a machine may be made aware of multiple - realms. You may wish to remove them to simplify things. + realms. You may wish to remove them to simplify things. The first line puts the specific - system into the named realm. The rest of the lines show how to + system into the named realm. The rest of the lines show how to default systems of a particular subdomain to a named realm. - Now we are ready to create the database. This only needs to - run on the Kerberos server (or Key Distribution Centre). Issue the + Now we are ready to create the database. This only needs to + run on the Kerberos server (or Key Distribution Centre). Issue the kdb_init command to do this: @@ -538,7 +538,7 @@ It is important that you NOT FORGET this password. Now we have to save the key so that servers on the local - machine can pick it up. Use the kstash command to do this. + machine can pick it up. Use the kstash command to do this. &prompt.root; kstash @@ -559,7 +559,7 @@ Master key entered. BEWARE! Making it all run Two principals need to be added to the database for each system that will be secured with - Kerberos. Their names are kpasswd + Kerberos. Their names are kpasswd and rcmd These two principals are made for each system, with the instance being the name of the individual system. @@ -630,11 +630,11 @@ Edit O.K. Creating the server file We now have to extract all the instances which define the - services on each machine. For this we use the - ext_srvtab command. This will create a file which + services on each machine. For this we use the + ext_srvtab command. This will create a file which must be copied or moved by secure means to each Kerberos client's /etc/kerberosIV - directory. This file must be present on each server and client, + directory. This file must be present on each server and client, and is crucial to the operation of Kerberos. @@ -649,7 +649,7 @@ Generating 'grunt-new-srvtab'.... Now, this command only generates a temporary file which must be renamed to srvtab so that all the - server can pick it up. Use the mv + server can pick it up. Use the mv command to move it into place on the original system: @@ -658,7 +658,7 @@ Generating 'grunt-new-srvtab'.... If the file is for a client system, and the network is not deemed safe, then copy the client-new-srvtab to removable media - and transport it by secure physical means. Be sure to rename it to + and transport it by secure physical means. Be sure to rename it to srvtab in the client's /etc/kerberosIV directory, and make sure it is mode 600: @@ -672,8 +672,8 @@ Generating 'grunt-new-srvtab'.... Populating the database - We now have to add some user entries into the database. First - let's create an entry for the user jane. Use + We now have to add some user entries into the database. First + let's create an entry for the user jane. Use the kdb_edit command to do this: @@ -710,10 +710,10 @@ Edit O.K. Testing it all out - First we have to start the Kerberos daemons. NOTE that if you + First we have to start the Kerberos daemons. NOTE that if you have correctly edited your /etc/rc.conf then - this will happen automatically when you reboot. This is only - necessary on the Kerberos server. Kerberos clients will + this will happen automatically when you reboot. This is only + necessary on the Kerberos server. Kerberos clients will automagically get what they need from the /etc/kerberosIV directory. @@ -777,10 +777,10 @@ Password changed. Adding <command>su</command> privileges Kerberos allows us to give each - user who needs root privileges their own separate supassword. We could now add an id which is - authorized to su to root. This is controlled by having an + user who needs root privileges their own separate supassword. We could now add an id which is + authorized to su to root. This is controlled by having an instance of root associated with a - principal. Using kdb_edit we can create the + principal. Using kdb_edit we can create the entry jane.root in the Kerberos database: @@ -855,7 +855,7 @@ May 2 20:43:12 May 3 04:43:12 krbtgt.GRONDAR.ZA@GRONDAR.ZA Using other commands In an earlier example, we created a principal called - jane with an instance root. This was based on a user with the same + jane with an instance root. This was based on a user with the same name as the principal, and this is a Kerberos default; that a <principal>.<instance> of the form <username>.root will allow that @@ -926,7 +926,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Firewalls are an area of increasing interest for people who are connected to the Internet, and are even finding applications on - private networks to provide enhanced security. This section will + private networks to provide enhanced security. This section will hopefully explain what firewalls are, how to use them, and how to use the facilities provided in the FreeBSD kernel to implement them. @@ -937,10 +937,10 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 will solve all your security problems. It may help, but a poorly setup firewall system is more of a - security risk than not having one at all. A firewall can only add + security risk than not having one at all. A firewall can only add another layer of security to your systems, but they will not be able to stop a really determined cracker from penetrating your - internal network. If you let internal security lapse because you + internal network. If you let internal security lapse because you believe your firewall to be impenetrable, you have just made the crackers job that bit easier. @@ -950,10 +950,10 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 What is a firewall? There are currently two distinct types of firewalls in common - use on the Internet today. The first type is more properly called + use on the Internet today. The first type is more properly called a packet filtering router, where the kernel on a multi-homed machine chooses whether to forward or - block packets based on a set of rules. The second type, known as + block packets based on a set of rules. The second type, known as proxy servers, rely on daemons to provide authentication and to forward packets, possibly on a multi-homed machine which has kernel packet forwarding @@ -962,13 +962,13 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Sometimes sites combine the two types of firewalls, so that only a certain machine (known as a bastion host) is allowed to send packets through a packet - filtering router onto an internal network. Proxy services are run + filtering router onto an internal network. Proxy services are run on the bastion host, which are generally more secure than normal authentication mechanisms. FreeBSD comes with a kernel packet filter (known as IPFW), which is what the rest of this section - will concentrate on. Proxy servers can be built on FreeBSD from + will concentrate on. Proxy servers can be built on FreeBSD from third party software, but there is such a variety of proxy servers available that it would be impossible to cover them in this document. @@ -978,22 +978,22 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Packet filtering routers A router is a machine which forwards packets between two or - more networks. A packet filtering router has an extra piece of + more networks. A packet filtering router has an extra piece of code in its kernel, which compares each packet to a list of - rules before deciding if it should be forwarded or not. Most + rules before deciding if it should be forwarded or not. Most modern IP routing software has packet filtering code in it, - which defaults to forwarding all packets. To enable the filters, + which defaults to forwarding all packets. To enable the filters, you need to define a set of rules for the filtering code, so that it can decide if the packet should be allowed to pass or not. To decide if a packet should be passed on or not, the code looks through its set of rules for a rule which matches the - contents of this packets headers. Once a match is found, the - rule action is obeyed. The rule action could be to drop the + contents of this packets headers. Once a match is found, the + rule action is obeyed. The rule action could be to drop the packet, to forward the packet, or even to send an ICMP message - back to the originator. Only the first match counts, as the - rules are searched in order. Hence, the list of rules can be + back to the originator. Only the first match counts, as the + rules are searched in order. Hence, the list of rules can be referred to as a “rule chain”. The packet matching criteria varies depending on the @@ -1012,7 +1012,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 daemons (telnetd, ftpd, etc) replaced with special servers. These servers are called proxy servers as they normally only allow onward - connections to be made. This enables you to run (for example) a + connections to be made. This enables you to run (for example) a proxy telnet server on your firewall host, and people can telnet in to your firewall from the outside, go through some authentication mechanism, and then gain access to the internal @@ -1024,14 +1024,14 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 available, including “one-shot” password systems so that even if someone manages to discover what password you used, they will not be able to use it to gain access to your systems as the - password instantly expires. As they do not actually give users + password instantly expires. As they do not actually give users access to the host machine, it becomes a lot more difficult for someone to install backdoors around your security system. Proxy servers often have ways of restricting access further, so that only certain hosts can gain access to the servers, and often they can be set up so that you can limit which users can - talk to which destination machine. Again, what facilities are + talk to which destination machine. Again, what facilities are available depends largely on what proxy software you choose. @@ -1044,14 +1044,14 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 IPFW, the software supplied with FreeBSD, is a packet filtering and accounting system which resides in the kernel, and has a user-land control utility, - ipfw8. Together, they allow you to define and + ipfw8. Together, they allow you to define and query the rules currently used by the kernel in its routing decisions. There are two related parts to IPFW. The - firewall section allows you to perform packet filtering. There is + firewall section allows you to perform packet filtering. There is also an IP accounting section which allows you to track usage of - your router, based on similar rules to the firewall section. This + your router, based on similar rules to the firewall section. This allows you to see (for example) how much traffic your router is getting from a certain machine, or how much WWW (World Wide Web) traffic it is forwarding. @@ -1059,7 +1059,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 As a result of the way that IPFW is designed, you can use IPFW on non-router machines to perform packet filtering on incoming and outgoing - connections. This is a special case of the more general use of + connections. This is a special case of the more general use of IPFW, and the same commands and techniques should be used in this situation. @@ -1071,7 +1071,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 As the main part of the IPFW system lives in the kernel, you will need to add one or more options to your kernel configuration file, depending on what facilities you want, - and recompile your kernel. See + and recompile your kernel. See reconfiguring the kernel for more details on how to recompile your kernel. @@ -1091,7 +1091,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Enables code to allow logging of packets through - syslogd8. Without this option, even + syslogd8. Without this option, even if you specify that packets should be logged in the filter rules, nothing will happen. @@ -1101,14 +1101,14 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Limits the number of packets logged through - syslogd8 on a per entry basis. You + syslogd8 on a per entry basis. You may wish to use this option in hostile environments in which you want to log firewall activity, but do not want to be open to a denial of service attack via syslog flooding. When a chain entry reaches the packet limit specified, - logging is turned off for that particular entry. To + logging is turned off for that particular entry. To resume logging, you will need to reset the associated counter using the ipfw8 utility: @@ -1125,7 +1125,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Previous versions of FreeBSD contained an - IPFIREWALL_ACCT option. This is now obsolete as + IPFIREWALL_ACCT option. This is now obsolete as the firewall code automatically includes accounting facilities. @@ -1135,17 +1135,17 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Configuring IPFW The configuration of the IPFW software is - done through the ipfw8 utility. The syntax + done through the ipfw8 utility. The syntax for this command looks quite complicated, but it is relatively simple once you understand its structure. There are currently four different command categories used by the utility: addition/deletion, listing, flushing, and clearing. Addition/deletion is used to build the rules that control how - packets are accepted, rejected, and logged. Listing is used to + packets are accepted, rejected, and logged. Listing is used to examine the contents of your rule set (otherwise known as the - chain) and packet counters (accounting). Flushing is used to - remove all entries from the chain. Clearing is used to zero out + chain) and packet counters (accounting). Flushing is used to + remove all entries from the chain. Clearing is used to zero out one or more accounting entries. @@ -1181,7 +1181,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 The command given can be shortened to - the shortest unique form. The valid + the shortest unique form. The valid commands are: @@ -1204,7 +1204,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Previous versions of IPFW used separate - firewall and accounting entries. The present version provides + firewall and accounting entries. The present version provides packet accounting with each firewall entry. If an index value is supplied, @@ -1232,7 +1232,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 allow - Pass the packet on as normal. (aliases: + Pass the packet on as normal. (aliases: pass and accept) @@ -1240,7 +1240,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 deny - Drop the packet. The source is not notified via an + Drop the packet. The source is not notified via an ICMP message (thus it appears that the packet never arrived at the destination). @@ -1250,7 +1250,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Update packet counters but do not allow/deny the - packet based on this rule. The search continues with + packet based on this rule. The search continues with the next chain entry. @@ -1310,9 +1310,9 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 The is optional and may specify the IP address or domain name of a local IP interface, - or an interface name (e.g. ed0) to - match only packets coming through this interface. Interface unit - numbers can be specified with an optional wildcard. For example, + or an interface name (e.g. ed0) to + match only packets coming through this interface. Interface unit + numbers can be specified with an optional wildcard. For example, ppp* would match all kernel PPP interfaces. @@ -1336,11 +1336,11 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 A valid hostname may be specified in place of the IP - address. is a decimal + address. is a decimal number representing how many bits in the address mask should be - set. e.g. specifying 192.216.222.1/24 will create a mask which will allow any + set. e.g. specifying 192.216.222.1/24 will create a mask which will allow any address in a class C subnet (in this case, 192.216.222) to be - matched. is an IP + matched. is an IP address which will be logically AND'ed with the address given. The keyword any may be used to specify “any IP address”. @@ -1354,7 +1354,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 port-port - to specify a range of ports. You may also + to specify a range of ports. You may also combine a single range with a list, but the range must always be specified first. @@ -1388,12 +1388,12 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Matches if the IP header contains the comma separated list of options specified in - spec. The supported list of IP + spec. The supported list of IP options are: ssrr (strict source route), lsrr (loose source route), rr (record packet route), and ts - (timestamp). The absence of a particular option may be + (timestamp). The absence of a particular option may be denoted with a leading !. @@ -1403,7 +1403,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Matches if the packet is part of an already established TCP connection (i.e. it has the RST or ACK - bits set). You can optimize the performance of the + bits set). You can optimize the performance of the firewall by placing established rules early in the chain. @@ -1422,11 +1422,11 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Matches if the TCP header contains the comma - separated list of flags. The + separated list of flags. The supported flags are fin, syn, rst, psh, ack, and - urg. The absence of a particular + urg. The absence of a particular flag may be indicated by a leading !. @@ -1435,9 +1435,9 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Matches if the ICMP type is present in the list - types. The list may be specified + types. The list may be specified as any combination of ranges and/or individual types - separated by commas. Commonly used ICMP types are: + separated by commas. Commonly used ICMP types are: 0 echo reply (ping reply), 3 destination unreachable, 5 redirect, 8 echo request (ping request), and @@ -1470,7 +1470,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 -a - While listing, show counter values. This option is + While listing, show counter values. This option is the only way to see accounting counters. @@ -1507,7 +1507,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 This causes all entries in the firewall chain to be removed except the fixed default policy enforced by the kernel (index - 65535). Use caution when flushing rules, the default deny + 65535). Use caution when flushing rules, the default deny policy will leave your system cut off from the network until allow entries are added to the chain. @@ -1524,7 +1524,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 When used without an index argument, - all packet counters are cleared. If an + all packet counters are cleared. If an index is supplied, the clearing operation only affects a specific chain entry. @@ -1582,7 +1582,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Building a packet filtering firewall - The following suggestions are just that: suggestions. The + The following suggestions are just that: suggestions. The requirements of each firewall are different and I cannot tell you how to build a firewall to meet your particular requirements. @@ -1591,9 +1591,9 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 When initially setting up your firewall, unless you have a test bench setup where you can configure your firewall host in a controlled environment, I strongly recommend you use the logging - version of the commands and enable logging in the kernel. This + version of the commands and enable logging in the kernel. This will allow you to quickly identify problem areas and cure them - without too much disruption. Even after the initial setup phase is + without too much disruption. Even after the initial setup phase is complete, I recommend using the logging for of `deny' as it allows tracing of possible attacks and also modification of the firewall rules if your requirements alter. @@ -1603,25 +1603,25 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 large amounts of log data as one log line will be generated for every packet that passes through the firewall, so large ftp/http transfers, etc, will really slow the - system down. It also increases the latencies on those packets as + system down. It also increases the latencies on those packets as it requires more work to be done by the kernel before the packet - can be passed on. syslogd with also start using up a lot more + can be passed on. syslogd with also start using up a lot more processor time as it logs all the extra data to disk, and it could quite easily fill the partition /var/log is located on. As currently supplied, FreeBSD does not have the ability to - load firewall rules at boot time. My suggestion is to put a call + load firewall rules at boot time. My suggestion is to put a call to a shell script in the /etc/netstart - script. Put the call early enough in the netstart file so that the + script. Put the call early enough in the netstart file so that the firewall is configured before any of the IP interfaces are - configured. This means that there is no window during which time + configured. This means that there is no window during which time your network is open. The actual script used to load the rules is entirely up to - you. There is currently no support in the ipfw utility for loading multiple rules in - the one command. The system I use is to use the command: + you. There is currently no support in the ipfw utility for loading multiple rules in + the one command. The system I use is to use the command: &prompt.root; ipfw list @@ -1629,8 +1629,8 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 to write a list of the current rules out to a file, and then use a text editor to prepend ipfw - before all the lines. This will allow the script to - be fed into /bin/sh and reload the rules into the kernel. Perhaps + before all the lines. This will allow the script to + be fed into /bin/sh and reload the rules into the kernel. Perhaps not the most efficient way, but it works. The next problem is what your firewall should actually @@ -1650,33 +1650,33 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Block all incoming UDP - traffic. There are very few useful services that travel over + traffic. There are very few useful services that travel over UDP, and what useful traffic there is is normally a security - threat (e.g. Suns RPC and NFS protocols). This has its + threat (e.g. Suns RPC and NFS protocols). This has its disadvantages also, since UDP is a connectionless protocol, denying incoming UDP traffic also blocks the replies to - outgoing UDP traffic. This can cause a problem for people + outgoing UDP traffic. This can cause a problem for people (on the inside) using external archie (prospero) servers. If you want to allow access to archie, you'll have to allow packets coming from ports 191 and 1525 to any internal UDP - port through the firewall. ntp is another service you may + port through the firewall. ntp is another service you may consider allowing through, which comes from port 123. - Block traffic to port 6000 from the outside. Port 6000 + Block traffic to port 6000 from the outside. Port 6000 is the port used for access to X11 servers, and can be a security threat (especially if people are in the habit of doing xhost + on their - workstations). X11 can actually use a range of ports + workstations). X11 can actually use a range of ports starting at 6000, the upper limit being how many X displays - you can run on the machine. The upper limit as defined by + you can run on the machine. The upper limit as defined by RFC 1700 (Assigned Numbers) is 6063. Check what ports any internal servers use (e.g. SQL - servers, etc). It is probably a good idea to block those as + servers, etc). It is probably a good idea to block those as well, as they normally fall outside the 1-1024 range specified above. @@ -1689,8 +1689,8 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 URL="ftp://ftp.cert.org/pub/tech_tips/packet_filtering">ftp://ftp.cert.org/pub/tech_tips/packet_filtering As I said above, these are only - guidelines. You will have to decide what - filter rules you want to use on your firewall yourself. I cannot + guidelines. You will have to decide what + filter rules you want to use on your firewall yourself. I cannot accept ANY responsibility if someone breaks into your network, even if you follow the advice given above. diff --git a/en/handbook/serialcomms/chapter.sgml b/en/handbook/serialcomms/chapter.sgml index d6b6a4415c..e6b2d5de47 100644 --- a/en/handbook/serialcomms/chapter.sgml +++ b/en/handbook/serialcomms/chapter.sgml @@ -8,13 +8,13 @@ Assembled from FAQ. This section should give you some general information about - serial ports. If you do not find what you want here, check into the + serial ports. If you do not find what you want here, check into the Terminal and Dialup sections of the handbook. The ttydX (or cuaaX) device is the regular device you will want to open for your - applications. When a process opens the device, it will have a - default set of terminal I/O settings. You can see these settings + applications. When a process opens the device, it will have a + default set of terminal I/O settings. You can see these settings with the command @@ -22,8 +22,8 @@ When you change the settings to this device, the settings are in - effect until the device is closed. When it is reopened, it goes - back to the default set. To make changes to the default set, you + effect until the device is closed. When it is reopened, it goes + back to the default set. To make changes to the default set, you can open and adjust the settings of the “initial state” device. For example, to turn on CLOCAL mode, 8 bits, and XON/XOFF flow control by default for ttyd5, do: @@ -33,12 +33,12 @@ A good place to do this is in - /etc/rc.serial. Now, an application will have + /etc/rc.serial. Now, an application will have these settings by default when it opens ttyd5. It can still change these settings to its liking, though. You can also prevent certain settings from being changed by an - application by making adjustments to the “lock state” device. For + application by making adjustments to the “lock state” device. For example, to lock the speed of ttyd5 to 57600 bps, do @@ -51,7 +51,7 @@ bps. Naturally, you should make the initial state and lock state - devices writable only by root. The + devices writable only by root. The MAKEDEV script does not do this when it creates the device entries. @@ -65,31 +65,31 @@ Terminals provide a convenient and low-cost way to access the power of your FreeBSD system when you are not at the computer's - console or on a connected network. This section describes how to + console or on a connected network. This section describes how to use terminals with FreeBSD. Uses and Types of Terminals - The original Unix systems did not have consoles. Instead, + The original Unix systems did not have consoles. Instead, people logged in and ran programs through terminals that were - connected to the computer's serial ports. It is quite similar to + connected to the computer's serial ports. It is quite similar to using a modem and some terminal software to dial into a remote system to do text-only work. Today's PCs have consoles capable of high quality graphics, but the ability to establish a login session on a serial port still exists in nearly every Unix-style operating system today; - FreeBSD is no exception. By using a terminal attached to a unused + FreeBSD is no exception. By using a terminal attached to a unused serial port, you can log in and run any text program that you would normally run on the console or in an xterm window in the X Window System. For the business user, you can attach many terminals to a - FreeBSD system and place them on your employees' desktops. For a + FreeBSD system and place them on your employees' desktops. For a home user, a spare computer such as an older IBM PC or a Macintosh can be a terminal wired into a more powerful computer running - FreeBSD. You can turn what might otherwise be a single-user + FreeBSD. You can turn what might otherwise be a single-user computer into a powerful multiple user system. For FreeBSD, there are three kinds of terminals: @@ -120,16 +120,16 @@ Dumb Terminals Dumb terminals are specialized pieces of hardware that let - you connect to computers over serial lines. They are called + you connect to computers over serial lines. They are called “dumb” because they have only enough computational power to - display, send, and receive text. You cannot run any programs on - them. It is the computer to which you connect them that has all + display, send, and receive text. You cannot run any programs on + them. It is the computer to which you connect them that has all the power to run text editors, compilers, email, games, and so forth. There are hundreds of kinds of dumb terminals made by many manufacturers, including Digital Equipment Corporation's VT-100 - and Wyse's WY-75. Just about any kind will work with FreeBSD. + and Wyse's WY-75. Just about any kind will work with FreeBSD. Some high-end terminals can even display graphics, but only certain software packages can take advantage of these advanced features. @@ -149,7 +149,7 @@ All you need is the proper cable and some terminal emulation software to run on the computer. - Such a configuration is popular in homes. For example, if + Such a configuration is popular in homes. For example, if your spouse is busy working on your FreeBSD system's console, you can do some text-only work at the same time from a less powerful personal computer hooked up as a terminal to the @@ -161,8 +161,8 @@ X Terminals X terminals are the most sophisticated kind of terminal - available. Instead of connecting to a serial port, they usually - connect to a network like Ethernet. Instead of being relegated + available. Instead of connecting to a serial port, they usually + connect to a network like Ethernet. Instead of being relegated to text-only applications, they can display any X application. @@ -177,8 +177,8 @@ Cables and Ports To connect a terminal to your FreeBSD system, you need the - right kind of cable and a serial port to which to connect it. This - section tells you what to do. If you are already familiar with + right kind of cable and a serial port to which to connect it. This + section tells you what to do. If you are already familiar with your terminal and the cable it requires, skip to Configuration. @@ -190,7 +190,7 @@ serial—also known as RS-232C—cables to connect the terminal to the FreeBSD system. - There are a couple of kinds of serial cables. Which one + There are a couple of kinds of serial cables. Which one you'll use depends on the terminal you want to connect: @@ -198,15 +198,15 @@ If you are connecting a personal computer to act as a - terminal, use a null-modem cable. A null-modem cable connects + terminal, use a null-modem cable. A null-modem cable connects two computers or terminals together. If you have an actual terminal, your best source of information on what cable to use is the documentation that - accompanied the terminal. If you do not have the - documentation, then try a null-modem cable. If that does not work, then + accompanied the terminal. If you do not have the + documentation, then try a null-modem cable. If that does not work, then try a standard cable. @@ -223,13 +223,13 @@ Null-modem cables A null-modem cable passes some signals straight through, - like “signal ground,” but switches other signals. For + like “signal ground,” but switches other signals. For example, the “send data” pin on one end goes to the “receive data” pin on the other end. If you like making your own cables, here is a table showing a recommended way to construct a null-modem cable for - use with terminals. This table shows the RS-232C signal names + use with terminals. This table shows the RS-232C signal names and the pin numbers on a DB-25 connector. @@ -324,7 +324,7 @@ Standard RS-232C Cables A standard serial cable passes all the RS-232C signals - straight-through. That is, the “send data” pin on one end + straight-through. That is, the “send data” pin on one end of the cable goes to the “send data” pin on the other end. This is the type of cable to connect a modem to your FreeBSD system, and the type of cable needed for some @@ -345,17 +345,17 @@ Kinds of Ports - Several kinds of serial ports exist. Before you purchase + Several kinds of serial ports exist. Before you purchase or construct a cable, you need to make sure it will fit the ports on your terminal and on the FreeBSD system. - Most terminals will have DB25 ports. Personal computers, + Most terminals will have DB25 ports. Personal computers, including PCs running FreeBSD, will have DB25 or DB9 ports. If you have a multiport serial card for your PC, you may have RJ-12 or RJ-45 ports. See the documentation that accompanied the hardware for - specifications on the kind of port in use. A visual + specifications on the kind of port in use. A visual inspection of the port often works, too. @@ -364,19 +364,19 @@ Port Names In FreeBSD, you access each serial port through an entry - in the /dev directory. There are two + in the /dev directory. There are two different kinds of entries: Callin ports are named - /dev/ttydX where X is the port number, starting from zero. Generally, you use the callin port for terminals. Callin ports require that the serial line assert the data carrier detect (DCD) signal to work. + /dev/ttydX where X is the port number, starting from zero. Generally, you use the callin port for terminals. Callin ports require that the serial line assert the data carrier detect (DCD) signal to work. Callout ports are named - /dev/cuaaX. You usually do not use the callout port for terminals, just for modems. You may use the callout port if the serial cable or the terminal does not support the carrier detect signal. + /dev/cuaaX. You usually do not use the callout port for terminals, just for modems. You may use the callout port if the serial cable or the terminal does not support the carrier detect signal. @@ -385,13 +385,13 @@ If you have connected a terminal to the first serial port (COM1 in DOS parlance), then you want to use - /dev/ttyd0 to refer to the terminal. If + /dev/ttyd0 to refer to the terminal. If it is on the second serial port (also known as COM2), it is /dev/ttyd1, and so forth. Note that you may have to configure your kernel to support each serial port, especially if you have a multiport serial - card. See Configuring the FreeBSD Kernel for more + card. See Configuring the FreeBSD Kernel for more information. @@ -402,7 +402,7 @@ Configuration This section describes what you need to configure on your - FreeBSD system to enable a login session on a terminal. It + FreeBSD system to enable a login session on a terminal. It assumes you have already configured your kernel to support the serial port to which the terminal is connected—and that you have connected it. @@ -412,8 +412,8 @@ reading a login name and starting the login program. To do so, you have to edit the /etc/ttys - file. First, use the su command to - become root. Then, make the following changes to + file. First, use the su command to + become root. Then, make the following changes to /etc/ttys: @@ -449,16 +449,16 @@ As an optional step, you may wish to create a custom getty type for use in step 2 by making an - entry in /etc/gettytab. This document does + entry in /etc/gettytab. This document does not explain how to do so; you are encouraged to see the gettytab5 and the getty8 manual pages for more information. - The remaining sections detail how to do these steps. We will + The remaining sections detail how to do these steps. We will use a running example throughout these sections to illustrate what - we need to do. In our example, we will connect two terminals to + we need to do. In our example, we will connect two terminals to the system: a Wyse-50 and a old 286 IBM PC running Procomm - terminal software emulating a VT-100 terminal. We connect the Wyse + terminal software emulating a VT-100 terminal. We connect the Wyse to the second serial port and the 286 to the sixth serial port (a port on a multiport serial card). @@ -474,24 +474,24 @@ there. The /etc/ttys file lists all of the - ports on your FreeBSD system where you want to allow logins. For + ports on your FreeBSD system where you want to allow logins. For example, the first virtual console ttyv0 - has an entry in this file. You can log in on the console using - this entry. This file contains entries for the other virtual - consoles, serial ports, and pseudo-ttys. For a hardwired + has an entry in this file. You can log in on the console using + this entry. This file contains entries for the other virtual + consoles, serial ports, and pseudo-ttys. For a hardwired terminal, just list the serial port's /dev entry without the /dev part. When you installed your FreeBSD system, the /etc/ttys file included entries for the first four serial ports: ttyd0 through - ttyd3. If you are attaching a terminal on + ttyd3. If you are attaching a terminal on one of those ports, you do not need to add an entry. In our example, we attached a Wyse-50 to the second serial port, ttyd1, which is already in - the file. We need to add an entry for the 286 PC connected to - the sixth serial port. Here is an excerpt of the + the file. We need to add an entry for the 286 PC connected to + the sixth serial port. Here is an excerpt of the /etc/ttys file after we add the new entry: @@ -505,8 +505,8 @@ ttyd5 Type Next, we need to specify what program will be run to handle - the logins on a terminal. For FreeBSD, the standard program to - do that is /usr/libexec/getty. It is what + the logins on a terminal. For FreeBSD, the standard program to + do that is /usr/libexec/getty. It is what provides the login: prompt. The program getty takes one @@ -519,10 +519,10 @@ ttyd5 /etc/gettytab. The file /etc/gettytab contains lots of - entries for terminal lines both old and new. In almost all + entries for terminal lines both old and new. In almost all cases, the entries that start with the text std will work for hardwired terminals. - These entries ignore parity. There is a std entry for each bps rate from 110 to - 115200. Of course, you can add your own entries to this file. + These entries ignore parity. There is a std entry for each bps rate from 110 to + 115200. Of course, you can add your own entries to this file. The manual page gettytab5 provides more information. When setting the getty type in @@ -530,7 +530,7 @@ ttyd5 communications settings on the terminal match. For our example, the Wyse-50 uses no parity and connects at - 38400 bps. The 286 PC uses no parity and connects at 19200 bps. + 38400 bps. The 286 PC uses no parity and connects at 19200 bps. Here is the /etc/ttys file so far (showing just the two terminals in which we are interested): @@ -539,7 +539,7 @@ ttyd1 "/usr/libexec/getty std.38400" unknown off secure ttyd5 "/usr/libexec/getty std.19200" Note that the second field—where we specify - what program to run—appears in quotes. This is important, + what program to run—appears in quotes. This is important, otherwise the type argument to getty might be interpreted as the next field. @@ -549,7 +549,7 @@ ttyd5 "/usr/libexec/getty std.19200" Specifying the Default Terminal Type The third field in the /etc/ttys file - lists the default terminal type for the port. For dialup ports, + lists the default terminal type for the port. For dialup ports, you typically put unknown or dialup in this field because users may dial up with practically any kind of terminal or software. @@ -559,19 +559,19 @@ ttyd5 "/usr/libexec/getty std.19200" Users will usually use the tset program in their .login or .profile files to check the terminal type and prompt for one if - necessary. By setting a terminal type in the + necessary. By setting a terminal type in the /etc/ttys file, users can forego such prompting. To find out what terminal types FreeBSD supports, see the - file /usr/share/misc/termcap. It lists - about 600 terminal types. You can add more if you wish. See + file /usr/share/misc/termcap. It lists + about 600 terminal types. You can add more if you wish. See the termcap5 manual page for information. In our example, the Wyse-50 is a Wyse-50 type of terminal (although it can emulate others, we will leave it in Wyse-50 - mode). The 286 PC is running Procomm which will be set to - emulate a VT-100. Here are the pertinent yet unfinished entries + mode). The 286 PC is running Procomm which will be set to + emulate a VT-100. Here are the pertinent yet unfinished entries from the /etc/ttys file: @@ -584,15 +584,15 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 Enabling the Port The next field in /etc/ttys, the fourth - field, tells whether to enable the port. Putting on here will have the init process start the program in the + field, tells whether to enable the port. Putting on here will have the init process start the program in the second field, getty, which will - prompt for a login. If you put off in the fourth field, there will be no + prompt for a login. If you put off in the fourth field, there will be no getty, and hence no logins on the port. So, naturally, you want an on - in this field. Here again is the /etc/ttys - file. We have turned each port on. + in this field. Here again is the /etc/ttys + file. We have turned each port on. ttyd1 "/usr/libexec/getty std.38400" wy50 on secure @@ -605,21 +605,21 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on We have arrived at the last field (well, almost: there is an optional window specifier, but we - will ignore that). The last field tells whether the port is + will ignore that). The last field tells whether the port is secure. What does “secure” mean? It means that the root account (or any account with a user - ID of 0) may login on the port. Insecure ports do not allow + ID of 0) may login on the port. Insecure ports do not allow root to login. How do you use secure and insecure ports? By marking a port as insecure, the terminal to which it is - connected will not allow root to login. People who know the + connected will not allow root to login. People who know the root password to your FreeBSD system will first have to login - using a regular user account. To gain superuser privileges, + using a regular user account. To gain superuser privileges, they will then have to use the su command. @@ -629,14 +629,14 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on system log (and logins are also recorded in the wtmp file). By marking a port as secure, the terminal will allow root - in. People who know the root password will just login as root. + in. People who know the root password will just login as root. You will not have the potentially useful login and su command records. Which should you use? Just use “insecure.” Use “insecure” even for terminals not - in public user areas or behind locked doors. It is quite easy + in public user areas or behind locked doors. It is quite easy to login and use su if you need superuser privileges. @@ -659,7 +659,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroom After you edit /etc/ttys, you do not - want to have to reboot your system to get init to see the changes. So, init will reread + want to have to reboot your system to get init to see the changes. So, init will reread /etc/ttys if it receives a SIGHUP (hangup) signal. @@ -683,7 +683,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomDebugging your connection Even with the most meticulous attention to detail, something - could still go wrong while setting up a terminal. Here is a list + could still go wrong while setting up a terminal. Here is a list of symptoms and some suggested fixes. @@ -696,22 +696,22 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroom Make sure the cable is connected firmly to both the - terminal and the FreeBSD computer. Make sure it is the + terminal and the FreeBSD computer. Make sure it is the right kind of cable. Make sure the terminal and FreeBSD agree on the bps - rate and parity settings. If you have a video display + rate and parity settings. If you have a video display terminal, make sure the contrast and brightness controls - are turned up. If it is a printing terminal, make sure + are turned up. If it is a printing terminal, make sure paper and ink are in good supply. Make sure that a getty - process is running and serving the terminal. Type + process is running and serving the terminal. Type &prompt.root; ps -axww|grep getty - to get a list of running getty processes. You should see an - entry for the terminal. For example, the display + to get a list of running getty processes. You should see an + entry for the terminal. For example, the display 22189 d1 Is+ 0:00.03 /usr/libexec/getty std.38400 ttyd1 @@ -722,7 +722,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomIf no getty process is running, make sure you have enabled the port in - /etc/ttys. Make sure you have run + /etc/ttys. Make sure you have run kill -HUP 1. @@ -732,9 +732,9 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroom Make sure the terminal and FreeBSD agree on the bps - rate and parity settings. Check the getty processes to + rate and parity settings. Check the getty processes to make sure the correct getty - type is in use. If not, edit + type is in use. If not, edit /etc/ttys and run kill -HUP 1. @@ -761,7 +761,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomContributed by &a.ghelmer;. This document provides suggestions for configuring a FreeBSD - system to handle dialup modems. This document is written based on + system to handle dialup modems. This document is written based on the author's experience with FreeBSD versions 1.0, 1.1, and 1.1.5.1 (and experience with dialup modems on other UNIX-like operating systems); however, this document may not answer all of your @@ -774,9 +774,9 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomPrerequisites To begin with, the author assumes you have some basic - knowledge of FreeBSD. You need to have FreeBSD installed, know + knowledge of FreeBSD. You need to have FreeBSD installed, know how to edit files in a UNIX-like environment, and how to look up - manual pages on the system. As discussed below, you will need + manual pages on the system. As discussed below, you will need certain versions of FreeBSD, and knowledge of some terminology & modem and cabling. @@ -785,9 +785,9 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomFreeBSD Version First, it is assumed that you are using FreeBSD version 1.1 - or higher (including versions 2.x). FreeBSD version 1.0 + or higher (including versions 2.x). FreeBSD version 1.0 included two different serial drivers, which complicates the - situation. Also, the serial device driver (sio) has improved in every release of + situation. Also, the serial device driver (sio) has improved in every release of FreeBSD, so more recent versions of FreeBSD are assumed to have better and more efficient drivers than earlier versions. @@ -838,7 +838,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroom When talking about communications data rates, the author - does not use the term “baud”. Baud + does not use the term “baud”. Baud refers to the number of electrical state transitions that may be made in a period of time, while “bps” (bits per second) is the “correct” term to use (at least it does not seem to bother the curmudgeons @@ -853,12 +853,12 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroom Internal modems usually lack non-volatile RAM, so their - configuration may be limited only to setting DIP switches. If + configuration may be limited only to setting DIP switches. If your internal modem has any signal indicator lights, it is probably difficult to view the lights when the system's cover is in place. @@ -894,7 +894,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomThe first, connecting your modem, is usually simple — most - straight-through serial cables work without any problems. You + straight-through serial cables work without any problems. You need to have a cable with appropriate connectors (DB-25 or DB-9, male or female) on each end, and the cable must be a DCE-to-DTE cable with these signals wired: @@ -942,12 +942,12 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomCD signal to detect when a call has been answered or the line has been hung up, and the DTR signal to reset the modem after a session - is complete. Some cables are wired without all of the needed + is complete. Some cables are wired without all of the needed signals, so if you have problems, such as a login session not going away when the line hangs up, you may have a problem with your cable. - The second prerequisite depends on the modem(s) you use. If + The second prerequisite depends on the modem(s) you use. If you do not know your modem's command set by heart, you will need to have the modem's reference book or user's guide handy. Sample commands for USR Sportster 14,400 external modems will be @@ -955,12 +955,12 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroom Lastly, you will need to know how to setup your modem so - that it will work well with FreeBSD. Like other UNIX-like + that it will work well with FreeBSD. Like other UNIX-like operating systems, FreeBSD uses the hardware signals to find out when a call has been answered or a line has been hung up and to - hangup and reset the modem after a call. FreeBSD avoids sending + hangup and reset the modem after a call. FreeBSD avoids sending commands to the modem or watching for status reports from the - modem. If you are familiar with connecting modems to PC-based + modem. If you are familiar with connecting modems to PC-based bulletin board systems, this may seem awkward. @@ -970,11 +970,11 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomFreeBSD supports NS8250-, NS16450-, NS16550-, and NS16550A-based EIA RS-232C (CCITT V.24) communications - interfaces. The 8250 and 16450 devices have single-character - buffers. The 16550 device provides a 16-character buffer, which - allows for better system performance. (Bugs in plain 16550's + interfaces. The 8250 and 16450 devices have single-character + buffers. The 16550 device provides a 16-character buffer, which + allows for better system performance. (Bugs in plain 16550's prevent the use of the 16-character buffer, so use 16550A's if - possible). Because single-character-buffer devices require more + possible). Because single-character-buffer devices require more work by the operating system than the 16-character-buffer devices, 16550A-based serial interface cards are much prefered. If the system has many active serial ports or will have a heavy @@ -988,10 +988,10 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomQuick Overview Here is the process that FreeBSD follows to accept dialup - logins. A getty process, spawned by + logins. A getty process, spawned by init, patiently waits to open the assigned serial port (/dev/ttyd0, for our - example). The command ps ax might + example). The command ps ax might show this: @@ -1000,11 +1000,11 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomWhen a user dials the modem's line and the modems connect, the - CD line is asserted by the modem. The kernel + CD line is asserted by the modem. The kernel notices that carrier has been detected and completes getty's open of the - port. getty sends a login: prompt at the specified initial line - speed. getty watches to see if + port. getty sends a login: prompt at the specified initial line + speed. getty watches to see if legitimate characters are received, and, in a typical configuration, if it finds junk (probably due to the modem's connection speed being different than getty's speed), getty tries adjusting the line speeds until @@ -1012,7 +1012,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomWe hope getty finds the correct speed and the user sees a login: - prompt. After the user enters his/her login name, getty executes + prompt. After the user enters his/her login name, getty executes /usr/bin/login, which completes the login by asking for the user's password and then starting the user's shell. @@ -1030,14 +1030,14 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomCOM3:, and COM4:. FreeBSD can presently also handle “dumb” multiport serial interface cards, such as the Boca Board 1008 and 2016 (please see the manual page sio4 for kernel configuration information - if you have a multiport serial card). The default kernel only + if you have a multiport serial card). The default kernel only looks for the standard COM ports, though. To see if your kernel recognizes any of your serial ports, watch for messages while the kernel is booting, or use the /sbin/dmesg command to replay the - kernel's boot messages. In particular, look for messages that - start with the characters sio. Hint: + kernel's boot messages. In particular, look for messages that + start with the characters sio. Hint: to view just the messages that have the word sio, use the command: @@ -1069,16 +1069,16 @@ sio3: type 16550A in /usr/src/share/doc/smm] and “FreeBSD Configuration Options” [in /sys/conf/options and in - /sys/arch/conf/options.arch, with arch for example being i386] for more information on configuring and building kernels. You may have to unpack the kernel source distribution if have not installed the system sources already (srcdist/srcsys.?? in FreeBSD 1.1, srcdist/sys.?? in FreeBSD 1.1.5.1, or the entire source distribution in FreeBSD 2.0) to be able to configure and build kernels. + /sys/arch/conf/options.arch, with arch for example being i386] for more information on configuring and building kernels. You may have to unpack the kernel source distribution if have not installed the system sources already (srcdist/srcsys.?? in FreeBSD 1.1, srcdist/sys.?? in FreeBSD 1.1.5.1, or the entire source distribution in FreeBSD 2.0) to be able to configure and build kernels. Create a kernel configuration file for your system (if you have not already) by cding to - /sys/i386/conf. Then, if you are creating a + /sys/i386/conf. Then, if you are creating a new custom configuration file, copy the file GENERICAH (or GENERICBT, if you have a BusTek SCSI controller on FreeBSD 1.x) to YOURSYS, where YOURSYS - is the name of your system, but in upper-case letters. Edit the + is the name of your system, but in upper-case letters. Edit the file, and change the device lines: @@ -1088,9 +1088,9 @@ device sio2 at isa? port "IO_COM3" tty irq 5 vector siointr device sio3 at isa? port "IO_COM4" tty irq 9 vector siointr You can comment-out or completely remove lines for devices you - do not have. If you have a multiport serial board, such as the + do not have. If you have a multiport serial board, such as the Boca Board BB2016, please see the sio4 man page for complete information on - how to write configuration lines for multiport boards. Be careful + how to write configuration lines for multiport boards. Be careful if you are using a configuration file that was previously used for a different version of FreeBSD because the device flags have changed between versions. @@ -1103,7 +1103,7 @@ device sio3 at isa? port "IO_COM4" tty irq 9 vector siointr IO_COM4 is 0x2e8, which are fairly common port addresses for their respective serial ports; interrupts 4, 3, 5, and 9 are fairly common interrupt request - lines. Also note that regular serial ports cannot share interrupts on ISA-bus PCs + lines. Also note that regular serial ports cannot share interrupts on ISA-bus PCs (multiport boards have on-board electronics that allow all the 16550A's on the board to share one or two interrupt request lines). @@ -1123,18 +1123,18 @@ device sio3 at isa? port "IO_COM4" tty irq 9 vector siointr Most devices in the kernel are accessed through “device special files”, which are located in the - /dev directory. The sio devices are accessed through the + /dev directory. The sio devices are accessed through the /dev/ttyd? (dial-in) and - /dev/cua0? (call-out) devices. On FreeBSD + /dev/cua0? (call-out) devices. On FreeBSD version 1.1.5 and higher, there are also initialization devices (/dev/ttyid? and /dev/cuai0?) and locking devices (/dev/ttyld? and - /dev/cual0?). The initialization devices are + /dev/cual0?). The initialization devices are used to initialize communications port parameters each time a port is opened, such as crtscts for modems which use CTS/RTS signaling for flow - control. The locking devices are used to lock flags on ports to + control. The locking devices are used to lock flags on ports to prevent users or programs changing certain parameters; see the manual pages termios4, sio4, and stty1 for information on the terminal settings, locking & initializing @@ -1146,7 +1146,7 @@ device sio3 at isa? port "IO_COM4" tty irq 9 vector siointr A shell script called MAKEDEV in the /dev directory manages the device special - files. (The manual page for MAKEDEV8 on + files. (The manual page for MAKEDEV8 on FreeBSD 1.1.5 is fairly bogus in its discussion of COM ports, so ignore it.) To use MAKEDEV to make dialup device special files @@ -1167,7 +1167,7 @@ device sio3 at isa? port "IO_COM4" tty irq 9 vector siointr /dev/cua* files) to make sure that only users who should have access to those device special files can read & write on them — you probably do not want to allow - your average user to use your modems to dialout. The default + your average user to use your modems to dialout. The default permissions on the /dev/cua* files should be sufficient: @@ -1188,43 +1188,43 @@ crw-rw---- 1 uucp dialer 28, 193 Feb 15 14:38 /dev/cual01 There are three system configuration files in the /etc directory that you will probably need to - edit to allow dialup access to your FreeBSD system. The first, + edit to allow dialup access to your FreeBSD system. The first, /etc/gettytab, contains configuration information for the /usr/libexec/getty - daemon. Second, /etc/ttys holds information + daemon. Second, /etc/ttys holds information that tells /sbin/init what - tty devices should have getty processes running on them. Lastly, + tty devices should have getty processes running on them. Lastly, you can place port initialization commands in the /etc/rc.serial script if you have FreeBSD 1.1.5.1 or higher; otherwise, you can initialize ports in the /etc/rc.local script. There are two schools of thought regarding dialup modems on - UNIX. One group likes to configure their modems and system so + UNIX. One group likes to configure their modems and system so that no matter at what speed a remote user dials in, the local - computer-to-modem RS-232 interface runs at a locked speed. The + computer-to-modem RS-232 interface runs at a locked speed. The benefit of this configuration is that the remote user always sees - a system login prompt immediately. The downside is that the system + a system login prompt immediately. The downside is that the system does not know what a user's true data rate is, so full-screen programs like Emacs will not adjust their screen-painting methods to make their response better for slower connections. The other school configures their modems' RS-232 interface to - vary its speed based on the remote user's connection speed. For + vary its speed based on the remote user's connection speed. For example, V.32bis (14.4 Kbps) connections to the modem might make the modem run its RS-232 interface at 19.2 Kbps, while 2400 bps connections make the modem's RS-232 interface run at 2400 bps. Because getty does not understand any particular modem's connection speed reporting, getty gives a login: message at an initial speed and - watches the characters that come back in response. If the user + watches the characters that come back in response. If the user sees junk, it is assumed that they know they should press the <Enter> key until they see a - recognizable prompt. If the data rates do not match, getty sees anything the user types as + recognizable prompt. If the data rates do not match, getty sees anything the user types as “junk”, tries going to the next speed and gives the - login: prompt again. This procedure can + login: prompt again. This procedure can continue ad nauseum, but normally only takes a keystroke or two - before the user sees a good prompt. Obviously, this login sequence + before the user sees a good prompt. Obviously, this login sequence does not look as clean as the former “locked-speed” method, but a user on a low-speed connection should receive better interactive response from full-screen programs. @@ -1238,7 +1238,7 @@ crw-rw---- 1 uucp dialer 28, 193 Feb 15 14:38 /dev/cual01 <filename>/etc/gettytab</filename> /etc/gettytab is a termcap5-style file of configuration - information for getty8. Please see the + information for getty8. Please see the gettytab5 manual page for complete information on the format of the file and the list of capabilities. @@ -1258,8 +1258,8 @@ crw-rw---- 1 uucp dialer 28, 193 Feb 15 14:38 /dev/cual01 You will need to setup an entry in /etc/gettytab to give getty information about the speeds you - wish to use for your modem. If you have a 2400 bps modem, you - can probably use the existing D2400 entry. This entry already exists + wish to use for your modem. If you have a 2400 bps modem, you + can probably use the existing D2400 entry. This entry already exists in the FreeBSD 1.1.5.1 gettytab file, so you do not need to add it unless it is missing under your version of FreeBSD: @@ -1296,7 +1296,7 @@ uq|V19200|High Speed Modem at 19200,8-bit:\ :nx=V9600:tc=std.19200: On FreeBSD 1.1.5 and later, this will result in 8-bit, no - parity connections. Under FreeBSD 1.1, add + parity connections. Under FreeBSD 1.1, add :np: parameters to the std.xxx entries at the top of the file for 8 bits, no parity; otherwise, the default is 7 bits, even parity. @@ -1304,16 +1304,16 @@ uq|V19200|High Speed Modem at 19200,8-bit:\ The example above starts the communications rate at 19.2 Kbps (for a V.32bis connection), then cycles through 9600 bps (for V.32), 2400 bps, 1200 bps, 300 bps, and back to 19.2 - Kbps. Communications rate cycling is implemented with the + Kbps. Communications rate cycling is implemented with the nx= (“next - table”) capability. Each of the lines uses a + table”) capability. Each of the lines uses a tc= (“table continuation”) entry to pick up the rest of the “standard” settings for a particular data rate. If you have a 28.8 Kbps modem and/or you want to take advantage of compression on a 14.4 Kbps modem, you need to use - a higher communications rate than 19.2 Kbps. Here is an + a higher communications rate than 19.2 Kbps. Here is an example of a gettytab entry starting a 57.6 Kbps: @@ -1347,14 +1347,14 @@ vq|VH57600|Very High Speed Modem at 57600,8-bit:\ /etc/ttys also provides security information to login (user root may only login on ttys marked - secure). See the manual page for + secure). See the manual page for ttys5 for more information. You will need to either modify existing lines in /etc/ttys or add new lines to make init run getty processes automatically on your new - dialup ports. The general format of the line will be the same, + dialup ports. The general format of the line will be the same, whether you are using a locked-speed or matching-speed configuration: @@ -1363,38 +1363,38 @@ ttyd0 "/usr/libexec/getty xxx" dialup on The first item in the above line is the device special file for this entry — ttyd0 means - /dev/ttyd0 is the file that this getty will be watching. The second item, + /dev/ttyd0 is the file that this getty will be watching. The second item, "/usr/libexec/getty xxx" (xxx will be replaced by the initial gettytab capability) is the process init will run on the - device. The third item, dialup, - is the default terminal type. The fourth parameter, - on, indicates to init that the line is operational. There + device. The third item, dialup, + is the default terminal type. The fourth parameter, + on, indicates to init that the line is operational. There can be a fifth parameter, secure, but it should only be used for terminals which are physically secure (such as the system console). The default terminal type (dialup in the example above) may depend on - local preferences. dialup is the + local preferences. dialup is the traditional default terminal type on dialup lines so that users may customize their login scripts to notice when the terminal is dialup and automatically adjust - their terminal type. However, the author finds it easier at his + their terminal type. However, the author finds it easier at his site to specify vt102 as the default terminal type, since the users just use VT102 emulation on their remote systems. After you have made changes to /etc/ttys, you may send the init process a HUP - signal to re-read the file. You can use the command + signal to re-read the file. You can use the command &prompt.root; kill -1 1 - to send the signal. If this is your first time setting up + to send the signal. If this is your first time setting up the system, though, you may want to wait until your modem(s) are properly configured and connected before signaling init. @@ -1403,7 +1403,7 @@ ttyd0 "/usr/libexec/getty xxx" dialup on Locked-Speed Config For a locked-speed configuration, your ttys entry needs to have a fixed-speed - entry provided to getty. For a + entry provided to getty. For a modem whose port speed is locked at 19.2 Kbps, the ttys entry might look like this: @@ -1422,7 +1422,7 @@ ttyd0 "/usr/libexec/getty std.19200" dialup on In a matching-speed configuration, your ttys entry needs to reference the appropriate beginning “auto-baud” (sic) entry in - /etc/gettytab. For example, if you added + /etc/gettytab. For example, if you added the above suggested entry for a matching-speed modem that starts at 19.2 Kbps (the gettytab entry containing the V19200 starting point), your @@ -1485,7 +1485,7 @@ stty -f /dev/ttyd3 crtscts If you have a modem whose parameters may be permanently set in non-volatile RAM, you will need to use a terminal program (such as Telix under PC-DOS or tip under - FreeBSD) to set the parameters. Connect to the modem using the + FreeBSD) to set the parameters. Connect to the modem using the same communications speed as the initial speed getty will use and configure the modem's non-volatile RAM to match these requirements: @@ -1586,7 +1586,7 @@ AT&C1&D2&H1&I0&R2&W Result codes should be disabled/suppressed for dialup modems to avoid problems that can occur if getty mistakenly gives a login: prompt to a modem that is in command - mode and the modem echoes the command or returns a result code. I + mode and the modem echoes the command or returns a result code. I have heard this sequence can result in a extended, silly conversation between getty and the modem. @@ -1597,7 +1597,7 @@ AT&C1&D2&H1&I0&R2&W For a locked-speed configuration, you will need to configure the modem to maintain a constant modem-to-computer data rate - independent of the communications rate. On a USR Sportster + independent of the communications rate. On a USR Sportster 14,400 external modem, these commands will lock the modem-to-computer data rate at the speed used to issue the commands: @@ -1612,7 +1612,7 @@ AT&B1&W For a variable-speed configuration, you will need to configure your modem to adjust its serial port data rate to - match the incoming call rate. On a USR Sportster 14,400 + match the incoming call rate. On a USR Sportster 14,400 external modem, these commands will lock the modem's error-corrected data rate to the speed used to issue the commands, but allow the serial port rate to vary for @@ -1628,9 +1628,9 @@ AT&B2&W Most high-speed modems provide commands to view the modem's current operating parameters in a somewhat human-readable - fashion. On the USR Sportster 14,400 external modems, the + fashion. On the USR Sportster 14,400 external modems, the command ATI5 displays the settings - that are stored in the non-volatile RAM. To see the true + that are stored in the non-volatile RAM. To see the true operating parameters of the modem (as influenced by the USR's DIP switch settings), use the commands ATZ and then ATI4. @@ -1680,7 +1680,7 @@ AT&B2&W and the modem has not accepted a call yet, this means that getty has completed its open on - the communications port. This could indicate a problem with the + the communications port. This could indicate a problem with the cabling or a mis-configured modem, because getty should not be able to open the communications port until CD (carrier detect) has been asserted by the modem. @@ -1689,10 +1689,10 @@ AT&B2&W processes waiting to open the desired ttyd? port, double-check your entries in /etc/ttys to see if there are any mistakes - there. Also, check the log file + there. Also, check the log file /var/log/messages to see if there are any log messages from init or - getty regarding any problems. If + getty regarding any problems. If there are any messages, triple-check the configuration files /etc/ttys and /etc/gettytab, as well as the appropriate @@ -1706,8 +1706,8 @@ AT&B2&W Try Dialing In Try dialing into the system; be sure to use 8 bits, no - parity, 1 stop bit on the remote system. If you do not get a - prompt right away, or get garbage, try pressing <Enter> about once per second. If + parity, 1 stop bit on the remote system. If you do not get a + prompt right away, or get garbage, try pressing <Enter> about once per second. If you still do not see a login: prompt after a while, try sending a BREAK. If you are using a high-speed modem to do the dialing, try @@ -1743,13 +1743,13 @@ AT&B2&W If you dial but the modem on the FreeBSD system will not answer, make sure that the modem is configured to answer the - phone when DTR is asserted. If the modem + phone when DTR is asserted. If the modem seems to be configured correctly, verify that the DTR line is asserted by checking the modem's indicator lights (if it has any). If you have gone over everything several times and it still - does not work, take a break and come back to it later. If it + does not work, take a break and come back to it later. If it still does not work, perhaps you can send an electronic mail message to the &a.questions;describing your modem and your problem, and the good folks on the list will try to help. @@ -1781,13 +1781,13 @@ AT&B2&W Information integrated from FAQ. The following are tips to getting your host to be able to - connect over the modem to another computer. This is appropriate for + connect over the modem to another computer. This is appropriate for establishing a terminal session with a remote host. This is useful to log onto a BBS. This kind of connection can be extremely helpful to get a file - on the Internet if you have problems with PPP. If you need to ftp + on the Internet if you have problems with PPP. If you need to ftp something and PPP is broken, use the terminal session to ftp it. Then use zmodem to transfer it to your machine. @@ -1799,8 +1799,8 @@ AT&B2&W On your system, the programs tip and cu are probably executable only by uucp and group - dialer. You can use the group dialer to control who has access to your - modem or remote systems. Just add yourself to group + dialer. You can use the group dialer to control who has access to your + modem or remote systems. Just add yourself to group dialer. Alternatively, you can let everyone on your system run @@ -1819,7 +1819,7 @@ AT&B2&W My stock Hayes modem is not supported, what can I do? Actually, the man page for tip - is out of date. There is a generic Hayes dialer already built in. + is out of date. There is a generic Hayes dialer already built in. Just use at=hayes in your /etc/remote file. @@ -1827,25 +1827,25 @@ AT&B2&W advanced features of newer modems—messages like BUSY, NO DIALTONE, or CONNECT - 115200 will just confuse it. You should turn those + 115200 will just confuse it. You should turn those messages off when you use tip (using ATX0&W). Also, the dial timeout for tip - is 60 seconds. Your modem should use something less, or else tip - will think there is a communication problem. Try + is 60 seconds. Your modem should use something less, or else tip + will think there is a communication problem. Try ATS7=45&W. Actually, as shipped tip does - not yet support it fully. The solution is to edit the file + not yet support it fully. The solution is to edit the file tipconf.h in the directory /usr/src/usr.bin/tip/tip Obviously you need the source distribution to do this. Edit the line #define HAYES 0 to #define HAYES - 1. Then make and - make install. Everything works + 1. Then make and + make install. Everything works nicely after that. @@ -1854,7 +1854,7 @@ AT&B2&W How am I expected to enter these AT commands? Make what is called a “direct” - entry in your /etc/remote file. For example, + entry in your /etc/remote file. For example, if your modem is hooked up to the first serial port, /dev/cuaa0, then put in the following line: @@ -1862,7 +1862,7 @@ AT&B2&W cuaa0:dv=/dev/cuaa0:br#19200:pa=none Use the highest bps rate your modem supports in - the br capability. Then, type tip + the br capability. Then, type tip cuaa0 and you will be connected to your modem. @@ -1882,7 +1882,7 @@ cuaa0:dv=/dev/cuaa0:br#19200:pa=none line is the serial port (e.g./dev/cuaa0) and speed is - the speed (e.g.57600). When you are + the speed (e.g.57600). When you are done entering the AT commands hit ~. to exit. @@ -1894,8 +1894,8 @@ cuaa0:dv=/dev/cuaa0:br#19200:pa=none The @ sign in the phone number capability tells tip to look in /etc/phones for a phone - number. But the @ sign is also a special character - in capability files like /etc/remote. Escape + number. But the @ sign is also a special character + in capability files like /etc/remote. Escape it with a backslash: @@ -1907,7 +1907,7 @@ pn=\@ How can I dial a phone number on the command line? Put what is called a “generic” - entry in your /etc/remote file. For example: + entry in your /etc/remote file. For example: tip115200|Dial any phone number at 115200 bps:\ @@ -1940,9 +1940,9 @@ cu115200|Use cu to dial any number at 115200bps:\ Put in an entry for tip1200 or cu1200, but go ahead and use - whatever bps rate is appropriate with the br capability. tip thinks a good default is 1200 bps which + whatever bps rate is appropriate with the br capability. tip thinks a good default is 1200 bps which is why it looks for a tip1200 - entry. You do not have to use 1200 bps, though. + entry. You do not have to use 1200 bps, though. @@ -1951,7 +1951,7 @@ cu115200|Use cu to dial any number at 115200bps:\ Rather than waiting until you are connected and typing CONNECT <host> each time, - use tip's cm capability. For + use tip's cm capability. For example, these entries in /etc/remote: @@ -1995,7 +1995,7 @@ big-university 5551113 big-university 5551114 tip will try each one in the - listed order, then give up. If you want to keep retrying, run + listed order, then give up. If you want to keep retrying, run tip in a while loop. @@ -2006,15 +2006,15 @@ big-university 5551114 CTRL+P is the default “force” character, used to tell tip that the next character is - literal data. You can set the force character to any other + literal data. You can set the force character to any other character with the ~s escape, which means “set a variable.” Type ~sforce=single-char - followed by a newline. single-char is any single character. + followed by a newline. single-char is any single character. If you leave out single-char, then the force character is the nul character, which you can get by typing CTRL+2 - or CTRL+SPACE. A pretty good value for single-char is SHIFT+CTRL+6, which I + or CTRL+SPACE. A pretty good value for single-char is SHIFT+CTRL+6, which I have seen only used on some terminal servers. You can have the force character be whatever you want by @@ -2030,8 +2030,8 @@ force=<single-char> Suddenly everything I type is in UPPER CASE?? You must have pressed CTRL+A, tip's “raise character,” specially - designed for people with broken caps-lock keys. Use ~s as above and set the variable - raisechar to something reasonable. In fact, you can set it to + designed for people with broken caps-lock keys. Use ~s as above and set the variable + raisechar to something reasonable. In fact, you can set it to the same as the force character, if you never expect to use either of these features. @@ -2051,9 +2051,9 @@ raisechar=^^ If you are talking to another UNIX system, you can send and receive files with ~p (put) and - ~t (take). These commands run + ~t (take). These commands run cat and echo on the remote system to accept and - send files. The syntax is: + send files. The syntax is: ~p diff --git a/en/handbook/staff/chapter.sgml b/en/handbook/staff/chapter.sgml index 9f530dabbb..fa045523bd 100644 --- a/en/handbook/staff/chapter.sgml +++ b/en/handbook/staff/chapter.sgml @@ -87,7 +87,7 @@ The FreeBSD Developers These are the people who have commit privileges and do the - engineering work on the FreeBSD source tree. All core team members + engineering work on the FreeBSD source tree. All core team members are also developers. diff --git a/en_US.ISO8859-1/articles/contributing/article.sgml b/en_US.ISO8859-1/articles/contributing/article.sgml index 6d64db5434..d36fd7e6d4 100644 --- a/en_US.ISO8859-1/articles/contributing/article.sgml +++ b/en_US.ISO8859-1/articles/contributing/article.sgml @@ -6,12 +6,12 @@ So you want to contribute something to FreeBSD? That is great! We can always use the help, and FreeBSD is one of those systems that relies on the contributions of its user base in - order to survive. Your contributions are not only appreciated, they + order to survive. Your contributions are not only appreciated, they are vital to FreeBSD's continued growth! Contrary to what some people might also have you believe, you do not need to be a hot-shot programmer or a close personal friend of the - FreeBSD core team in order to have your contributions accepted. The + FreeBSD core team in order to have your contributions accepted. The FreeBSD Project's development is done by a large and growing number of international contributors whose ages and areas of technical expertise vary greatly, and there is always more work to be done than there are @@ -21,16 +21,16 @@ system environment (and its installation) rather than just a kernel or a few scattered utilities, our TODO list also spans a very wide range of tasks, from documentation, beta testing and presentation to - highly specialized types of kernel development. No matter what your + highly specialized types of kernel development. No matter what your skill level, there is almost certainly something you can do to help the project! Commercial entities engaged in FreeBSD-related enterprises are - also encouraged to contact us. Need a special extension to make your + also encouraged to contact us. Need a special extension to make your product work? You will find us receptive to your requests, given that - they are not too outlandish. Working on a value-added product? + they are not too outlandish. Working on a value-added product? Please let us know! We may be able to work cooperatively on some - aspect of it. The free software world is challenging a lot of + aspect of it. The free software world is challenging a lot of existing assumptions about how software is developed, sold, and maintained throughout its life cycle, and we urge you to at least give it a second look. @@ -41,10 +41,10 @@ The following list of tasks and sub-projects represents something of an amalgam of the various core team TODO lists and user - requests we have collected over the last couple of months. Where - possible, tasks have been ranked by degree of urgency. If you are + requests we have collected over the last couple of months. Where + possible, tasks have been ranked by degree of urgency. If you are interested in working on one of the tasks you see here, send mail to - the coordinator listed by clicking on their names. If no + the coordinator listed by clicking on their names. If no coordinator has been appointed, maybe you would like to volunteer? @@ -59,7 +59,7 @@ - 3-stage boot issues. Overall coordination: + 3-stage boot issues. Overall coordination: &a.hackers; @@ -75,7 +75,7 @@ - Filesystem problems. Overall coordination: &a.fs; + Filesystem problems. Overall coordination: &a.fs; @@ -88,7 +88,7 @@ - Fix the union file system. Coordinator: + Fix the union file system. Coordinator: &a.dg; @@ -97,12 +97,12 @@ - Implement Int13 vm86 disk driver. Coordinator: + Implement Int13 vm86 disk driver. Coordinator: &a.hackers; - New bus architecture. Coordinator: &a.newbus; + New bus architecture. Coordinator: &a.newbus; @@ -116,7 +116,7 @@ - Port PCI subsystem to new architecture. Coordinator: + Port PCI subsystem to new architecture. Coordinator: &a.dfr; @@ -139,7 +139,7 @@ - Kernel issues. Overall coordination: &a.hackers; + Kernel issues. Overall coordination: &a.hackers; @@ -156,7 +156,7 @@ Make the entire kernel use - suser() instead of comparing to 0. It + suser() instead of comparing to 0. It is presently using about half of each. Coordinator: &a.eivind; @@ -164,7 +164,7 @@ Split securelevels into different parts, to allow an administrator to throw away those privileges he can throw - away. Setting the overall securelevel needs to have the + away. Setting the overall securelevel needs to have the same effect as now, obviously. Coordinator: &a.eivind; @@ -196,7 +196,7 @@ Add code to teh NFS layer so that you cannot chdir("..") out of an NFS partition. E.g., /usr is a UFS partition with - /usr/src NFS exported. Now it is + /usr/src NFS exported. Now it is possible to use the NFS filehandle for /usr/src to get access to /usr. @@ -230,7 +230,7 @@ - PCMCIA/PCCARD. Coordinators: &a.msmith; and &a.phk; + PCMCIA/PCCARD. Coordinators: &a.msmith; and &a.phk; @@ -267,7 +267,7 @@ - Advanced Power Management. Coordinators: &a.msmith; and + Advanced Power Management. Coordinators: &a.msmith; and &a.phk; @@ -310,7 +310,7 @@ NetWare Server (protected mode ODI driver) loader and subservices to allow the use of ODI card drivers supplied - with network cards. The same thing for NDIS drivers and + with network cards. The same thing for NDIS drivers and NetWare SCSI drivers. @@ -327,7 +327,7 @@ A concerted effort at support for portable computers. This is somewhat handled by changing PCMCIA bridging rules - and power management event handling. But there are things + and power management event handling. But there are things like detecting internal vs. external display and picking a different screen resolution based on that fact, not spinning down the disk if the machine is in dock, and allowing @@ -343,7 +343,7 @@ Most of the tasks listed in the previous sections require either a considerable investment of time or an in-depth knowledge - of the FreeBSD kernel (or both). However, there are also many + of the FreeBSD kernel (or both). However, there are also many useful tasks which are suitable for "weekend hackers", or people without programming skills. @@ -359,16 +359,16 @@ - Read the freebsd-bugs mailing list. There might be a + Read the freebsd-bugs mailing list. There might be a problem you can comment constructively on or with patches - you can test. Or you could even try to fix one of the + you can test. Or you could even try to fix one of the problems yourself. - Read through the FAQ and Handbook periodically. If + Read through the FAQ and Handbook periodically. If anything is badly explained, out of date or even just - completely wrong, let us know. Even better, send us a fix + completely wrong, let us know. Even better, send us a fix (SGML is not difficult to learn, but there is no objection to ASCII submissions). @@ -376,7 +376,7 @@ Help translate FreeBSD documentation into your native language (if not already available) — just send an email to - &a.doc; asking if anyone is working on it. Note that you + &a.doc; asking if anyone is working on it. Note that you are not committing yourself to translating every single FreeBSD document by doing this — in fact, the documentation most in need of translation is the installation @@ -386,7 +386,7 @@ Read the freebsd-questions mailing list and &ng.misc occasionally (or even - regularly). It can be very satisfying to share your + regularly). It can be very satisfying to share your expertise and help people solve their problems; sometimes you may even learn something new yourself! These forums can also be a source of ideas for things to work on. @@ -450,24 +450,24 @@ Bug reports and general commentary An idea or suggestion of general - technical interest should be mailed to the &a.hackers;. Likewise, + technical interest should be mailed to the &a.hackers;. Likewise, people with an interest in such things (and a tolerance for a high volume of mail!) may subscribe to the - hackers mailing list by sending mail to &a.majordomo;. See + hackers mailing list by sending mail to &a.majordomo;. See mailing lists for more information about this and other mailing lists. If you find a bug or are submitting a specific change, please report it using the send-pr1program or its WEB-based - equivalent. Try to fill-in each field of the bug report. + equivalent. Try to fill-in each field of the bug report. Unless they exceed 65KB, include any patches directly in the - report. Consider compressing them and using - uuencode1 if they exceed 20KB. Upload very large submissions to ftp.freebsd.org:/pub/FreeBSD/incoming/. + report. Consider compressing them and using + uuencode1 if they exceed 20KB. Upload very large submissions to ftp.freebsd.org:/pub/FreeBSD/incoming/. After filing a report, you should receive confirmation along - with a tracking number. Keep this tracking number so that you can - update us with details about the problem by sending mail to bug-followup@FreeBSD.ORG. Use the number as the message subject, e.g. "Re: kern/3377". Additional information for any bug report should be submitted this way. + with a tracking number. Keep this tracking number so that you can + update us with details about the problem by sending mail to bug-followup@FreeBSD.ORG. Use the number as the message subject, e.g. "Re: kern/3377". Additional information for any bug report should be submitted this way. If you do not receive confirmation in a timely fashion (3 days to a week, depending on your email connection) or are, for some @@ -480,7 +480,7 @@ Changes to the documentation - Changes to the documentation are overseen by the &a.doc;. Send + Changes to the documentation are overseen by the &a.doc;. Send submissions and changes (even small ones are welcome!) using send-pr as described in Bug Reports and General @@ -503,16 +503,16 @@ Working from older sources unfortunately means that your changes may sometimes be too obsolete or too divergent for easy - re-integration into FreeBSD. Chances of this can be minimized + re-integration into FreeBSD. Chances of this can be minimized somewhat by subscribing to the &a.announce; and the &a.current; lists, where discussions on the current state of the system take place. Assuming that you can manage to secure fairly up-to-date sources to base your changes on, the next step is to produce a set - of diffs to send to the FreeBSD maintainers. This is done with + of diffs to send to the FreeBSD maintainers. This is done with the diff1 command, with the “context diff” - form being preferred. For example: + form being preferred. For example: &prompt.user; diff -c oldfile newfile @@ -525,15 +525,15 @@ would generate such a set of context diffs for - the given source file or directory hierarchy. See the man page + the given source file or directory hierarchy. See the man page for diff1 for more details. Once you have a set of diffs (which you may test with the patch1 command), you should submit them for - inclusion with FreeBSD. Use the send-pr1 + inclusion with FreeBSD. Use the send-pr1 program as described in Bug Reports and General - Commentary. Do not just send the diffs to + Commentary. Do not just send the diffs to the &a.hackers; or they will get lost! We greatly appreciate your submission (this is a volunteer project!); because we are busy, we may not be able to address it immediately, but it will remain in @@ -541,22 +541,22 @@ If you feel it appropriate (e.g. you have added, deleted, or renamed files), bundle your changes into a tar file and run the - uuencode1 program on it. Shar archives are + uuencode1 program on it. Shar archives are also welcome. If your change is of a potentially sensitive nature, e.g. you are unsure of copyright issues governing its further distribution or you are simply not ready to release it without a tighter review first, then you should send it to &a.core; directly rather than - submitting it with send-pr1. The core + submitting it with send-pr1. The core mailing list reaches a much smaller group of people who do much of - the day-to-day work on FreeBSD. Note that this group is also + the day-to-day work on FreeBSD. Note that this group is also very busy and so you should only send mail to them where it is truly necessary. Please refer to man 9 intro and man 9 style for some information on - coding style. We would appreciate it if you were at least aware + coding style. We would appreciate it if you were at least aware of this information before submitting code. @@ -571,16 +571,16 @@ URL="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming">ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming. When working with large amounts of code, the touchy subject of - copyrights also invariably comes up. Acceptable copyrights for + copyrights also invariably comes up. Acceptable copyrights for code included in FreeBSD are: - The BSD copyright. This copyright is most preferred due + The BSD copyright. This copyright is most preferred due to its “no strings attached” nature and general - attractiveness to commercial enterprises. Far from + attractiveness to commercial enterprises. Far from discouraging such commercial use, the FreeBSD Project actively encourages such participation by commercial interests who might eventually be inclined to invest @@ -588,13 +588,13 @@ - The GNU Public License, or “GPL”. This license is not + The GNU Public License, or “GPL”. This license is not quite as popular with us due to the amount of extra effort demanded of anyone using the code for commercial purposes, but given the sheer quantity of GPL'd code we currently require (compiler, assembler, text formatter, etc) it would be silly to refuse additional contributions under this - license. Code under the GPL also goes into a different part + license. Code under the GPL also goes into a different part of the tree, that being /sys/gnu or /usr/src/gnu, and is therefore easily identifiable to anyone for whom the GPL presents a @@ -606,7 +606,7 @@ Contributions coming under any other type of copyright must be carefully reviewed before their inclusion into FreeBSD will be - considered. Contributions for which particularly restrictive + considered. Contributions for which particularly restrictive commercial copyrights apply are generally rejected, though the authors are always encouraged to make such changes available through their own channels. @@ -670,7 +670,7 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. FreeBSD, Inc. was founded in early 1995 by &a.jkh; and &a.dg; with the goal of furthering the aims of the FreeBSD - Project and giving it a minimal corporate presence. Any and all + Project and giving it a minimal corporate presence. Any and all funds donated (as well as any profits that may eventually be realized by FreeBSD, Inc.) will be used exclusively to further the project's goals. @@ -709,7 +709,7 @@ box can be opened) If you do not wish to be listed in our donors section, please specify this - when making your donation. Thanks! + when making your donation. Thanks! @@ -731,9 +731,9 @@ box can be opened) Hardware for which ongoing compliance testing is - desired. We are currently trying to put together a testing + desired. We are currently trying to put together a testing lab of all components that FreeBSD supports so that proper - regression testing can be done with each new release. We + regression testing can be done with each new release. We are still lacking many important pieces (network cards, motherboards, etc) and if you would like to make such a donation, please contact &a.dg; for information on @@ -742,7 +742,7 @@ box can be opened) Hardware currently unsupported by FreeBSD for which - you would like to see such support added. Please contact + you would like to see such support added. Please contact the &a.core; before sending such items as we will need to find a developer willing to take on the task before we can accept delivery of new hardware. @@ -756,7 +756,7 @@ box can be opened) Donating Internet access - We can always use new mirror sites for FTP, WWW or cvsup. If + We can always use new mirror sites for FTP, WWW or cvsup. If you would like to be such a mirror, please contact the FreeBSD project administrators admin@FreeBSD.ORG for more information. @@ -965,7 +965,7 @@ box can be opened) - Ernst Winter ewinter@lobo.muc.de contributed a 2.88 MB floppy drive to the project. This will hopefully increase the pressure for rewriting the floppy disk driver. ;-) + Ernst Winter ewinter@lobo.muc.de contributed a 2.88 MB floppy drive to the project. This will hopefully increase the pressure for rewriting the floppy disk driver. ;-) @@ -973,7 +973,7 @@ box can be opened) Technologies sent one each of their DC-390, DC-390U and DC-390F FAST and ULTRA SCSI host adapter cards for regression testing of the NCR and AMD drivers - with their cards. They are also to be applauded for + with their cards. They are also to be applauded for making driver sources for free operating systems available from their FTP server ftp://ftp.tekram.com/scsi/FreeBSD. @@ -1011,12 +1011,12 @@ box can be opened) CDROM has donated almost more than we can say (see the history document for - more details). In particular, we would like to thank + more details). In particular, we would like to thank them for the original hardware used for freefall.FreeBSD.ORG, our primary development machine, and for thud.FreeBSD.ORG, a testing and - build box. We are also indebted to them for funding + build box. We are also indebted to them for funding various contributors over the years and providing us with unrestricted use of their T1 connection to the Internet. @@ -1110,7 +1110,7 @@ box can be opened) This software was originally derived from William F. Jolitz's 386BSD release 0.1, though almost none of the original 386BSD - specific code remains. This software has been essentially + specific code remains. This software has been essentially re-implemented from the 4.4BSD-Lite release provided by the Computer Science Research Group (CSRG) at the University of California, Berkeley and associated academic contributors. diff --git a/en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.sgml b/en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.sgml index 2507290ae1..c7e43305ab 100644 --- a/en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.sgml +++ b/en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.sgml @@ -8,48 +8,48 @@ Debugging a Kernel Crash Dump with <command>kgdb</command> Here are some instructions for getting kernel debugging working - on a crash dump. They assume that you have enough swap space for a - crash dump. If you have multiple swap partitions and the first one + on a crash dump. They assume that you have enough swap space for a + crash dump. If you have multiple swap partitions and the first one is too small to hold the dump, you can configure your kernel to use an alternate dump device (in the config kernel line), or you can specify an alternate using the - dumpon8 command. The best way to use + dumpon8 command. The best way to use dumpon 8 is to set the dumpdev variable in - /etc/rc.conf. Typically you want to specify one of + /etc/rc.conf. Typically you want to specify one of the swap devices specified in /etc/fstab. Dumps to non-swap devices, tapes for example, - are currently not supported. Config your kernel using - config -g. See Kernel + are currently not supported. Config your kernel using + config -g. See Kernel Configuration for details on configuring the FreeBSD kernel. Use the dumpon8 command to tell the kernel where to dump to (note that this will have to be done after configuring the partition in question as swap space via - swapon8). This is normally arranged via + swapon8). This is normally arranged via /etc/rc.conf and /etc/rc. Alternatively, you can hard-code the dump device via the dump - clause in the config line of your kernel config file. This is + clause in the config line of your kernel config file. This is deprecated and should be used only if you want a crash dump from a kernel that crashes during booting. In the following, the term kgdb refers to - gdb run in “kernel debug mode”. This can be + gdb run in “kernel debug mode”. This can be accomplished by either starting the gdb with the option , or by linking and starting it - under the name kgdb. This is not being done by + under the name kgdb. This is not being done by default, however, and the idea is basically deprecated since the GNU folks do not like their tools to behave differently when - called by another name. This feature may well be discontinued in + called by another name. This feature may well be discontinued in further releases. When the kernel has been built make a copy of it, say kernel.debug, and then run strip - -d on the original. Install the original as normal. You + -d on the original. Install the original as normal. You may also install the unstripped kernel, but symbol table lookup time for some programs will drastically increase, and since the whole kernel is loaded entirely at boot time and cannot be swapped out @@ -69,13 +69,13 @@ Dumps to non-swap devices, tapes for example, This instructs savecore8 to - use another kernel for symbol name extraction. It would otherwise + use another kernel for symbol name extraction. It would otherwise default to the currently running kernel and most likely not do anything at all since the crash dump and the kernel symbols differ. Now, after a crash dump, go to - /sys/compile/WHATEVER and run kgdb. From kgdb + /sys/compile/WHATEVER and run kgdb. From kgdb do: @@ -88,7 +88,7 @@ Dumps to non-swap devices, tapes for example, kernel sources just like you can for any other program. Here is a script log of a kgdb - session illustrating the procedure. Long lines have been folded to + session illustrating the procedure. Long lines have been folded to improve readability, and the lines are numbered for reference. Despite this, it is a real-world error trace taken during the development of the pcvt console driver. @@ -203,8 +203,8 @@ Dumps to non-swap devices, tapes for example, Force usage of a new stack frame; this is no longer - necessary now. The stack frames are supposed to point to - the right locations now, even in case of a trap. (I do not + necessary now. The stack frames are supposed to point to + the right locations now, even in case of a trap. (I do not have a new core dump handy <g>, my kernel has not panicked for a rather long time.) From looking at the code in source line 403, there is a high probability that either @@ -243,9 +243,9 @@ Dumps to non-swap devices, tapes for example, Debugging a crash dump with DDD Examining a kernel crash dump with a graphical debugger like - ddd is also possible. Add the + ddd is also possible. Add the option to the ddd command line you would use - normally. For example; + normally. For example; &prompt.root; ddd -k /var/crash/kernel.0 /var/crash/vmcore.0 @@ -260,32 +260,32 @@ Dumps to non-swap devices, tapes for example, What do you do if a kernel dumped core but you did not expect it, and it is therefore not compiled using config - -g? Not everything is lost here. Do not panic! + -g? Not everything is lost here. Do not panic! - Of course, you still need to enable crash dumps. See above on + Of course, you still need to enable crash dumps. See above on the options you have to specify in order to do this. Go to your kernel compile directory, and edit the line - containing COPTFLAGS?=-O. Add the + containing COPTFLAGS?=-O. Add the option there (but do not - change anything on the level of optimization). If you do already + change anything on the level of optimization). If you do already know roughly the probable location of the failing piece of code (e.g., the pcvt driver in the example - above), remove all the object files for this code. Rebuild the - kernel. Due to the time stamp change on the Makefile, there will be + above), remove all the object files for this code. Rebuild the + kernel. Due to the time stamp change on the Makefile, there will be some other object files rebuild, for example - trap.o. With a bit of luck, the added + trap.o. With a bit of luck, the added option will not change anything for the generated code, so you will finally get a new kernel with similar - code to the faulting one but some debugging symbols. You should at + code to the faulting one but some debugging symbols. You should at least verify the old and new sizes with the - size1 command. If there is a mismatch, you + size1 command. If there is a mismatch, you probably need to give up here. - Go and examine the dump as described above. The debugging + Go and examine the dump as described above. The debugging symbols might be incomplete for some places, as can be seen in the stack trace in the example above where some functions are displayed - without line numbers and argument lists. If you need more debugging + without line numbers and argument lists. If you need more debugging symbols, remove the appropriate object files and repeat the kgdb session until you know enough. @@ -300,52 +300,52 @@ Dumps to non-swap devices, tapes for example, While kgdb as an offline debugger provides a very high level of user interface, there are some things - it cannot do. The most important ones being breakpointing and + it cannot do. The most important ones being breakpointing and single-stepping kernel code. If you need to do low-level debugging on your kernel, there is - an on-line debugger available called DDB. It allows to setting + an on-line debugger available called DDB. It allows to setting breakpoints, single-steping kernel functions, examining and changing - kernel variables, etc. However, it cannot access kernel source + kernel variables, etc. However, it cannot access kernel source files, and only has access to the global and static symbols, not to the full debug information like kgdb. To configure your kernel to include DDB, add the option line -options DDB to your config file, and rebuild. (See to your config file, and rebuild. (See Kernel Configuration for details on configuring the FreeBSD kernel. Note that if you have an older version of the boot blocks, - your debugger symbols might not be loaded at all. Update the boot + your debugger symbols might not be loaded at all. Update the boot blocks; the recent ones load the DDB symbols automagically.) Once your DDB kernel is running, there are several ways to enter - DDB. The first, and earliest way is to type the boot flag - right at the boot prompt. The kernel will start - up in debug mode and enter DDB prior to any device probing. Hence + DDB. The first, and earliest way is to type the boot flag + right at the boot prompt. The kernel will start + up in debug mode and enter DDB prior to any device probing. Hence you can even debug the device probe/attach functions. The second scenario is a hot-key on the keyboard, usually - Ctrl-Alt-ESC. For syscons, this can be remapped; some of the - distributed maps do this, so watch out. There is an option available + Ctrl-Alt-ESC. For syscons, this can be remapped; some of the + distributed maps do this, so watch out. There is an option available for serial consoles that allows the use of a serial line BREAK on the console line to enter DDB (options - BREAK_TO_DEBUGGER in the kernel config file). It is + BREAK_TO_DEBUGGER in the kernel config file). It is not the default since there are a lot of crappy serial adapters around that gratuitously generate a BREAK condition, for example when pulling the cable. The third way is that any panic condition will branch to DDB if - the kernel is configured to use it. For this reason, it is not + the kernel is configured to use it. For this reason, it is not wise to configure a kernel with DDB for a machine running unattended. - The DDB commands roughly resemble some gdb commands. The first thing you probably + The DDB commands roughly resemble some gdb commands. The first thing you probably need to do is to set a breakpoint: @@ -356,7 +356,7 @@ options DDB to your config file, and rebuild. (See Numbers are taken hexadecimal by default, but to make them distinct from symbol names; hexadecimal numbers starting with the letters a-f need to be preceded with - 0x (this is optional for other numbers). Simple + 0x (this is optional for other numbers). Simple expressions are allowed, for example: function-name + 0x103. @@ -386,7 +386,7 @@ options DDB to your config file, and rebuild. (See The first form will be accepted immediately after - a breakpoint hit, and deletes the current breakpoint. The second + a breakpoint hit, and deletes the current breakpoint. The second form can remove any breakpoint, but you need to specify the exact address; this can be obtained from: @@ -422,8 +422,8 @@ options DDB to your config file, and rebuild. (See @@ -487,9 +487,9 @@ options DDB to your config file, and rebuild. (See Now you have now examined why your kernel failed, and you wish - to reboot. Remember that, depending on the severity of previous + to reboot. Remember that, depending on the severity of previous malfunctioning, not all parts of the kernel might still be working - as expected. Perform one of the following actions to shut down and + as expected. Perform one of the following actions to shut down and reboot your system: @@ -497,8 +497,8 @@ options DDB to your config file, and rebuild. (See This will cause your kernel to dump core and reboot, so you can - later analyze the core on a higher level with kgdb. This command - usually must be followed by another continue statement. There is now an alias for + later analyze the core on a higher level with kgdb. This command + usually must be followed by another continue statement. There is now an alias for this: panic. @@ -507,7 +507,7 @@ options DDB to your config file, and rebuild. (See Which might be a good way to cleanly shut down the running system, sync() all disks, and finally - reboot. As long as the disk and file system interfaces of the + reboot. As long as the disk and file system interfaces of the kernel are not damaged, this might be a good way for an almost clean shutdown. @@ -526,7 +526,7 @@ options DDB to your config file, and rebuild. (See However, it is highly recommended to have a printed copy of the ddb4 manual page - ready for a debugging session. Remember that it is hard to read the + ready for a debugging session. Remember that it is hard to read the on-line manual while single-stepping the kernel. @@ -538,9 +538,9 @@ options DDB to your config file, and rebuild. (See GDB has already supported remote debugging - for a long time. This is done using a very simple protocol along a - serial line. Unlike the other methods described above, you will - need two machines for doing this. One is the host providing the + for a long time. This is done using a very simple protocol along a + serial line. Unlike the other methods described above, you will + need two machines for doing this. One is the host providing the debugging environment, including all the sources, and a copy of the kernel binary with all the symbols in it, and the other one is the target machine that simply runs a similar copy of the very same @@ -548,12 +548,12 @@ options DDB to your config file, and rebuild. (See You should configure the kernel in question with config -g, include into the - configuration, and compile it as usual. This gives a large blurb of - a binary, due to the debugging information. Copy this kernel to the + configuration, and compile it as usual. This gives a large blurb of + a binary, due to the debugging information. Copy this kernel to the target machine, strip the debugging symbols off with strip -x, and boot it using the boot - option. Connect the first serial line of the target machine to any - serial line of the debugging host. Now, on the debugging machine, + option. Connect the first serial line of the target machine to any + serial line of the debugging host. Now, on the debugging machine, go to the compile directory of the target kernel, and start gdb: @@ -589,8 +589,8 @@ Stopped at Debugger+0x35: movb $0, edata+0x51bc Every time you type gdb, the mode will be toggled between - remote GDB and local DDB. In order to force a next trap - immediately, simply type s (step). Your hosting GDB will now + remote GDB and local DDB. In order to force a next trap + immediately, simply type s (step). Your hosting GDB will now gain control over the target kernel: @@ -605,7 +605,7 @@ Debugger (msg=0xf01b0383 "Boot flags requested debugger") an Emacs window (which gives you an automatic source code display in another Emacs window) etc. - Remote GDB can also be used to debug LKMs. First build the LKM + Remote GDB can also be used to debug LKMs. First build the LKM with debugging symbols: @@ -625,8 +625,8 @@ EXEC 0 4 f5109000 001c f510f010 1 linux_mod Take the load address of the module and add 0x20 (probably to - account for the a.out header). This is the address that the module - code was relocated to. Use the add-symbol-file command in GDB to tell the + account for the a.out header). This is the address that the module + code was relocated to. Use the add-symbol-file command in GDB to tell the debugger about the module: @@ -644,10 +644,10 @@ text_addr = 0xf5109020? (y or n) y Debugging a Console Driver Since you need a console driver to run DDB on, things are more - complicated if the console driver itself is failing. You might + complicated if the console driver itself is failing. You might remember the use of a serial console (either with modified boot blocks, or by specifying at the Boot: prompt), and hook up a standard terminal - onto your first serial port. DDB works on any configured console + onto your first serial port. DDB works on any configured console driver, of course also on a serial console. diff --git a/en_US.ISO8859-1/books/developers-handbook/policies/chapter.sgml b/en_US.ISO8859-1/books/developers-handbook/policies/chapter.sgml index 500b2b1d46..6ea699c051 100644 --- a/en_US.ISO8859-1/books/developers-handbook/policies/chapter.sgml +++ b/en_US.ISO8859-1/books/developers-handbook/policies/chapter.sgml @@ -24,22 +24,22 @@ MAINTAINER= email-addresses The semantics of this are as follows: - The maintainer owns and is responsible for that code. This + The maintainer owns and is responsible for that code. This means that he is responsible for fixing bugs and answer problem reports pertaining to that piece of the code, and in the case of contributed software, for tracking new versions, as appropriate. Changes to directories which have a maintainer defined shall be - sent to the maintainer for review before being committed. Only if + sent to the maintainer for review before being committed. Only if the maintainer does not respond for an unacceptable period of time, to several emails, will it be acceptable to commit changes without - review by the maintainer. However, it is suggested that you try and + review by the maintainer. However, it is suggested that you try and have the changes reviewed by someone else if at all possible. It is of course not acceptable to add a person or group as - maintainer unless they agree to assume this duty. On the other hand + maintainer unless they agree to assume this duty. On the other hand it doesn't have to be a committer and it can easily be a group of people. @@ -48,44 +48,44 @@ MAINTAINER= email-addresses Contributed Software - Contributed by &a.phk; and &a.obrien;. + Contributed by &a.phk; and &a.obrien;. June 1996. Some parts of the FreeBSD distribution consist of software that - is actively being maintained outside the FreeBSD project. For + is actively being maintained outside the FreeBSD project. For historical reasons, we call this contributed - software. Some examples are perl, gcc and patch. + software. Some examples are perl, gcc and patch. Over the last couple of years, various methods have been used in dealing with this type of software and all have some number of - advantages and drawbacks. No clear winner has emerged. + advantages and drawbacks. No clear winner has emerged. Since this is the case, after some debate one of these methods has been selected as the “official” method and will be required for - future imports of software of this kind. Furthermore, it is + future imports of software of this kind. Furthermore, it is strongly suggested that existing contributed software converge on this model over time, as it has significant advantages over the old method, including the ability to easily obtain diffs relative to the “official” versions of the source by everyone (even without cvs - access). This will make it significantly easier to return changes + access). This will make it significantly easier to return changes to the primary developers of the contributed software. Ultimately, however, it comes down to the people actually doing - the work. If using this model is particularly unsuited to the + the work. If using this model is particularly unsuited to the package being dealt with, exceptions to these rules may be granted only with the approval of the core team and with the general - consensus of the other developers. The ability to maintain the + consensus of the other developers. The ability to maintain the package in the future will be a key issue in the decisions. Because of some unfortunate design limitations with the RCS file format and CVS's use of vendor branches, minor, trivial and/or cosmetic changes are strongly discouraged on - files that are still tracking the vendor branch. “Spelling + files that are still tracking the vendor branch. “Spelling fixes” are explicitly included here under the “cosmetic” category and are to be avoided for files with - revision 1.1.x.x. The repository bloat impact from a single character + revision 1.1.x.x. The repository bloat impact from a single character change can be rather dramatic. @@ -93,8 +93,8 @@ MAINTAINER= email-addresses language will be used as example of how this model works: src/contrib/tcl contains the source as - distributed by the maintainers of this package. Parts that are - entirely not applicable for FreeBSD can be removed. In the case of + distributed by the maintainers of this package. Parts that are + entirely not applicable for FreeBSD can be removed. In the case of Tcl, the mac, win and compat subdirectories were eliminated before the import @@ -111,23 +111,23 @@ MAINTAINER= email-addresses src/tools/tools/tcl_bmake contains a couple of shell-scripts that can be of help when the tcl software needs - updating. These are not part of the built or installed + updating. These are not part of the built or installed software. The important thing here is that the src/contrib/tcl directory is created according to the rules: It is supposed to contain the sources as distributed (on a proper CVS vendor-branch and without RCS keyword expansion) with as few FreeBSD-specific changes - as possible. The 'easy-import' tool on freefall will assist in + as possible. The 'easy-import' tool on freefall will assist in doing the import, but if there are any doubts on how to go about it, it is imperative that you ask first and not blunder ahead and hope - it “works out”. CVS is not forgiving of import accidents and a fair + it “works out”. CVS is not forgiving of import accidents and a fair amount of effort is required to back out major mistakes. Because of the previously mentioned design limitations with CVS's vendor branches, it is required that “official” patches from the vendor be applied to the original distributed sources and the result - re-imported onto the vendor branch again. Official patches should + re-imported onto the vendor branch again. Official patches should never be patched into the FreeBSD checked out version and "committed", as this destroys the vendor branch coherency and makes importing future versions rather difficult as there will be @@ -136,7 +136,7 @@ MAINTAINER= email-addresses Since many packages contain files that are meant for compatibility with other architectures and environments that FreeBSD, it is permissible to remove parts of the distribution tree - that are of no interest to FreeBSD in order to save space. Files + that are of no interest to FreeBSD in order to save space. Files containing copyright notices and release-note kind of information applicable to the remaining files shall not be removed. @@ -144,7 +144,7 @@ MAINTAINER= email-addresses If it seems easier, the bmake Makefiles can be produced from the dist tree automatically by some utility, something which would hopefully make it even easier to upgrade to a - new version. If this is done, be sure to check in such utilities + new version. If this is done, be sure to check in such utilities (as necessary) in the src/tools directory along with the port itself so that it is available to future maintainers. @@ -180,14 +180,14 @@ MAINTAINER= email-addresses However, please do not import FREEBSD-upgrade with the contributed source. Rather you should cvs add FREEBSD-upgrade ; cvs ci after the - initial import. Example wording from + initial import. Example wording from src/contrib/cpio is below: This directory contains virgin sources of the original distribution files -on a "vendor" branch. Do not, under any circumstances, attempt to upgrade -the files in this directory via patches and a cvs commit. New versions or -official-patch versions must be imported. Please remember to import with +on a "vendor" branch. Do not, under any circumstances, attempt to upgrade +the files in this directory via patches and a cvs commit. New versions or +official-patch versions must be imported. Please remember to import with "-ko" to prevent CVS from corrupting any vendor RCS Ids. For the import of GNU cpio 2.4.2, the following files were removed: @@ -233,7 +233,7 @@ obrien@freebsd.org - 30 March 1997 If you are adding shared library support to a port or other piece of software that doesn't have one, the version numbers should - follow these rules. Generally, the resulting numbers will have + follow these rules. Generally, the resulting numbers will have nothing to do with the release version of the software. The three principles of shared library building are: @@ -260,14 +260,14 @@ obrien@freebsd.org - 30 March 1997 For instance, added functions and bugfixes result in the minor version number being bumped, while deleted functions, changed - function call syntax etc. will force the major version number to + function call syntax etc. will force the major version number to change. - Stick to version numbers of the form major.minor (x.y). Our + Stick to version numbers of the form major.minor (x.y). Our dynamic linker does not handle version numbers of the form x.y.z - well. Any version number after the y (ie. the third digit) is + well. Any version number after the y (ie. the third digit) is totally ignored when comparing shared lib version numbers to decide - which library to link with. Given two shared libraries that differ + which library to link with. Given two shared libraries that differ only in the “micro” revision, ld.so will link with the higher one. Ie: if you link with libfoo.so.3.3.3, the linker only records 3.3 in the headers, and will link with anything @@ -276,14 +276,14 @@ obrien@freebsd.org - 30 March 1997 ld.so will always use the highest - “minor” revision. Ie: it will use libc.so.2.2 + “minor” revision. Ie: it will use libc.so.2.2 in preference to libc.so.2.0, even if the program was initially linked with libc.so.2.0. For non-port libraries, it is also our policy to change the - shared library version number only once between releases. When you + shared library version number only once between releases. When you make a change to a system library that requires the version number to be bumped, check the Makefile's commit logs. It is the responsibility of the committer to ensure that the first diff --git a/en_US.ISO8859-1/books/handbook/advanced-networking/chapter.sgml b/en_US.ISO8859-1/books/handbook/advanced-networking/chapter.sgml index 1a2a36d58e..35d5491ae5 100644 --- a/en_US.ISO8859-1/books/handbook/advanced-networking/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/advanced-networking/chapter.sgml @@ -10,13 +10,13 @@ For one machine to be able to find another, there must be a mechanism in place to describe how to get from one to the other. - This is called Routing. A “route” is a defined pair of addresses: - a “destination” and a “gateway”. The pair indicates that if you are + This is called Routing. A “route” is a defined pair of addresses: + a “destination” and a “gateway”. The pair indicates that if you are trying to get to this destination, send along - through this gateway. There are three types of - destinations: individual hosts, subnets, and “default”. The - “default route” is used if none of the other routes apply. We will - talk a little bit more about default routes later on. There are + through this gateway. There are three types of + destinations: individual hosts, subnets, and “default”. The + “default route” is used if none of the other routes apply. We will + talk a little bit more about default routes later on. There are also three types of gateways: individual hosts, interfaces (also called “links”), and ethernet hardware addresses. @@ -47,20 +47,20 @@ host2.foobar.com link#1 UC 0 0 The interface (Netif column) that it specifies to use for localhost is - lo0, also known as the loopback device. This + lo0, also known as the loopback device. This says to keep all traffic for this destination internal, rather than sending it out over the LAN, since it will only end up back where it started anyway. - The next thing that stands out are the 0:e0:... addresses. These are ethernet - hardware addresses. FreeBSD will automatically identify any hosts + The next thing that stands out are the 0:e0:... addresses. These are ethernet + hardware addresses. FreeBSD will automatically identify any hosts (test0 in the example) on the local ethernet and add a route for that host, directly to it over the - ethernet interface, ed0. There is + ethernet interface, ed0. There is also a timeout (Expire column) associated with this type of route, which is used if we fail to - hear from the host in a specific amount of time. In this case the - route will be automatically deleted. These hosts are identified + hear from the host in a specific amount of time. In this case the + route will be automatically deleted. These hosts are identified using a mechanism known as RIP (Routing Information Protocol), which figures out routes to local hosts based upon a shortest path determination. @@ -69,28 +69,28 @@ host2.foobar.com link#1 UC 0 0 (10.20.30.255 is the broadcast address for the subnet 10.20.30, and foobar.com is the domain name - associated with that subnet). The designation link#1 refers to the first ethernet card in - the machine. You will notice no additional interface is specified + associated with that subnet). The designation link#1 refers to the first ethernet card in + the machine. You will notice no additional interface is specified for those. Both of these groups (local network hosts and local subnets) have their routes automatically configured by a daemon called - routed. If this is not run, then + routed. If this is not run, then only routes which are statically defined (ie. entered explicitly) will exist. The host1 line refers to our - host, which it knows by ethernet address. Since we are the + host, which it knows by ethernet address. Since we are the sending host, FreeBSD knows to use the loopback interface (lo0) rather than sending it out over the ethernet interface. The two host2 lines are an example of what happens when we use an ifconfig alias (see the - section of ethernet for reasons why we would do this). The + section of ethernet for reasons why we would do this). The => symbol after the lo0 interface says that not only are we using the loopback (since this is address also refers to the local - host), but specifically it is an alias. Such routes only show up + host), but specifically it is an alias. Such routes only show up on the host that supports the alias; all other hosts on the local network will simply have a link#1 line for such. @@ -98,8 +98,8 @@ host2.foobar.com link#1 UC 0 0 The final line (destination subnet 224) deals with MultiCasting, which will be covered in a another section. - The other column that we should talk about are the Flags. Each route has different attributes - that are described in the column. Below is a short table of some + The other column that we should talk about are the Flags. Each route has different attributes + that are described in the column. Below is a short table of some of these flags and their meanings: @@ -162,14 +162,14 @@ host2.foobar.com link#1 UC 0 0 When the local system needs to make a connection to remote host, it checks the routing table to determine if a known path - exists. If the remote host falls into a subnet that we know how to + exists. If the remote host falls into a subnet that we know how to reach (Cloned routes), then the system checks to see if it can connect along that interface. If all known paths fail, the system has one last option: the - “default” route. This route is a + “default” route. This route is a special type of gateway route (usually the only one present in the - system), and is always marked with a c in the flags field. For hosts on a + system), and is always marked with a c in the flags field. For hosts on a local area network, this gateway is set to whatever machine has a direct connection to the outside world (whether via PPP link, or your hardware device attached to a dedicated data line). @@ -179,7 +179,7 @@ host2.foobar.com link#1 UC 0 0 the default route will be the gateway machine at your Internet Service Provider's (ISP) site. - Let us look at an example of default routes. This is a common + Let us look at an example of default routes. This is a common configuration: @@ -187,7 +187,7 @@ host2.foobar.com link#1 UC 0 0 The hosts Local1 and Local2 are at your site, with the formed - being your PPP connection to your ISP's Terminal Server. Your ISP + being your PPP connection to your ISP's Terminal Server. Your ISP has a local network at their site, which has, among other things, the server where you connect and a hardware device (T1-GW) attached to the ISP's Internet feed. @@ -227,13 +227,13 @@ host2.foobar.com link#1 UC 0 0 Remember, since the PPP interface is using an address on the ISP's local network for your side of the connection, routes for any other machines on the ISP's local network will be - automatically generated. Hence, you will already know how to reach + automatically generated. Hence, you will already know how to reach the T1-GW machine, so there is no need for the intermediate step of sending traffic to the ISP server. As a final note, it is common to use the address ...1 as the gateway address for your local - network. So (using the same example), if your local class-C + network. So (using the same example), if your local class-C address space was 10.20.30 and your ISP was using 10.9.9 then the default routes would be: @@ -251,20 +251,20 @@ Local1 (10.20.30.1, 10.9.9.30) --> T1-GW (10.9.9.1) There is one other type of configuration that we should cover, and that is a host that sits on two different networks. Technically, any machine functioning as a gateway (in the example - above, using a PPP connection) counts as a dual-homed host. But + above, using a PPP connection) counts as a dual-homed host. But the term is really only used to refer to a machine that sits on two local-area networks. In one case, the machine as two ethernet cards, each having an - address on the separate subnets. Alternately, the machine may only - have one ethernet card, and be using ifconfig aliasing. The former + address on the separate subnets. Alternately, the machine may only + have one ethernet card, and be using ifconfig aliasing. The former is used if two physically separate ethernet networks are in use, the latter if there is one physical network segment, but two logically separate subnets. Either way, routing tables are set up so that each subnet knows that this machine is the defined gateway (inbound route) to - the other subnet. This configuration, with the machine acting as + the other subnet. This configuration, with the machine acting as a Bridge between the two subnets, is often used when we need to implement packet filtering or firewall security in either or both directions. @@ -286,21 +286,21 @@ Local1 (10.20.30.1, 10.9.9.30) --> T1-GW (10.9.9.1) When you get an address space assigned to your site, your service provider will set up their routing tables so that all traffic for your subnet will be sent down your PPP link to your - site. But how do sites across the country know to send to your + site. But how do sites across the country know to send to your ISP? There is a system (much like the distributed DNS information) that keeps track of all assigned address-spaces, and defines their - point of connection to the Internet Backbone. The “Backbone” are + point of connection to the Internet Backbone. The “Backbone” are the main trunk lines that carry Internet traffic across the - country, and around the world. Each backbone machine has a copy of + country, and around the world. Each backbone machine has a copy of a master set of tables, which direct traffic for a particular network to a specific backbone carrier, and from there down the chain of service providers until it reaches your network. It is the task of your service provider to advertise to the backbone sites that they are the point of connection (and thus the - path inward) for your site. This is known as route + path inward) for your site. This is known as route propagation. @@ -309,14 +309,14 @@ Local1 (10.20.30.1, 10.9.9.30) --> T1-GW (10.9.9.1) Troubleshooting Sometimes, there is a problem with routing propagation, and - some sites are unable to connect to you. Perhaps the most useful + some sites are unable to connect to you. Perhaps the most useful command for trying to figure out where a routing is breaking down - is the traceroute8 command. It is equally + is the traceroute8 command. It is equally useful if you cannot seem to make a connection to a remote machine - (ie. ping8 fails). + (ie. ping8 fails). The traceroute8 command is run with the - name of the remote host you are trying to connect to. It will show + name of the remote host you are trying to connect to. It will show the gateway hosts along the path of the attempt, eventually either reaching the target host, or terminating because of a lack of connection. @@ -339,38 +339,38 @@ Local1 (10.20.30.1, 10.9.9.30) --> T1-GW (10.9.9.1) The problem nearly always occurs when (FreeBSD) PC systems are networked with high-performance workstations, such as those made by - Silicon Graphics, Inc., and Sun Microsystems, Inc. The NFS mount + Silicon Graphics, Inc., and Sun Microsystems, Inc. The NFS mount will work fine, and some operations may succeed, but suddenly the server will seem to become unresponsive to the client, even though - requests to and from other systems continue to be processed. This + requests to and from other systems continue to be processed. This happens to the client system, whether the client is the FreeBSD - system or the workstation. On many systems, there is no way to shut + system or the workstation. On many systems, there is no way to shut down the client gracefully once this problem has manifested itself. The only solution is often to reset the client, because the NFS situation cannot be resolved. Though the “correct” solution is to get a higher performance and capacity Ethernet adapter for the FreeBSD system, there is a simple - workaround that will allow satisfactory operation. If the FreeBSD + workaround that will allow satisfactory operation. If the FreeBSD system is the server, include the option on the mount from - the client. If the FreeBSD system is the client, then mount the NFS - file system with the option . These options may be + the client. If the FreeBSD system is the client, then mount the NFS + file system with the option . These options may be specified using the fourth field of the fstab entry on the client for automatic mounts, or by using the parameter of the mount command for manual mounts. It should be noted that there is a different problem, sometimes mistaken for this one, when the NFS servers and clients are on - different networks. If that is the case, make certain that your + different networks. If that is the case, make certain that your routers are routing the necessary UDP information, or you will not get anywhere, no matter what else you are doing. In the following examples, fastws is the host (interface) name of a high-performance workstation, and freebox is the host (interface) name of a FreeBSD system with a lower-performance - Ethernet adapter. Also, /sharedfs will be the exported NFS + Ethernet adapter. Also, /sharedfs will be the exported NFS filesystem (see man exports), and /project will be the mount - point on the client for the exported file system. In all cases, + point on the client for the exported file system. In all cases, note that additional options, such as or and may be desirable in your application. @@ -402,18 +402,18 @@ freebox:/sharedfs /project nfs rw,-w=1024 0 0 the above restrictions on the read or write size. For anyone who cares, here is what happens when the failure - occurs, which also explains why it is unrecoverable. NFS typically + occurs, which also explains why it is unrecoverable. NFS typically works with a “block” size of 8k (though it may do fragments of - smaller sizes). Since the maximum Ethernet packet is around 1500 + smaller sizes). Since the maximum Ethernet packet is around 1500 bytes, the NFS “block” gets split into multiple Ethernet packets, even though it is still a single unit to the upper-level code, and - must be received, assembled, and acknowledged as a unit. The + must be received, assembled, and acknowledged as a unit. The high-performance workstations can pump out the packets which comprise the NFS unit one right after the other, just as close - together as the standard allows. On the smaller, lower capacity + together as the standard allows. On the smaller, lower capacity cards, the later packets overrun the earlier packets of the same unit before they can be transferred to the host and the unit as a - whole cannot be reconstructed or acknowledged. As a result, the + whole cannot be reconstructed or acknowledged. As a result, the workstation will time out and try again, but it will try again with the entire 8K unit, and the process will be repeated, ad infinitum. @@ -425,7 +425,7 @@ freebox:/sharedfs /project nfs rw,-w=1024 0 0 Overruns may still occur when a high-performance workstations is slamming data out to a PC system, but with the better cards, such - overruns are not guaranteed on NFS “units”. When an overrun occurs, + overruns are not guaranteed on NFS “units”. When an overrun occurs, the units affected will be retransmitted, and there will be a fair chance that they will be received, assembled, and acknowledged. @@ -438,8 +438,8 @@ freebox:/sharedfs /project nfs rw,-w=1024 0 0 netboot.com/netboot.rom allow you to boot your FreeBSD machine over the network and run FreeBSD without having - a disk on your client. Under 2.0 it is now possible to have local - swap. Swapping over NFS is also still supported. + a disk on your client. Under 2.0 it is now possible to have local + swap. Swapping over NFS is also still supported. Supported Ethernet cards include: Western Digital/SMC 8003, 8013, 8216 and compatibles; NE1000/NE2000 and compatibles (requires @@ -453,7 +453,7 @@ freebox:/sharedfs /project nfs rw,-w=1024 0 0 - Find a machine that will be your server. This machine + Find a machine that will be your server. This machine will require enough disk space to hold the FreeBSD 2.0 binaries and have bootp, tftp and NFS services available. Tested machines: @@ -466,7 +466,7 @@ freebox:/sharedfs /project nfs rw,-w=1024 0 0 - Sun/Solaris 2.3. (you may need to get + Sun/Solaris 2.3. (you may need to get bootp) @@ -492,12 +492,12 @@ diskless:\ Set up a TFTP server (on same machine as bootp server) - to provide booting information to client. The name of this + to provide booting information to client. The name of this file is cfg.X.X.X.X (or /tftpboot/cfg.X.X.X.X, it will try both) where X.X.X.X is the IP address - of the client. The contents of this file can be any valid - netboot commands. Under 2.0, netboot has the following + of the client. The contents of this file can be any valid + netboot commands. Under 2.0, netboot has the following commands: @@ -611,7 +611,7 @@ hostname myclient.mydomain If you are swapping over NFS (completely diskless configuration) create a swap file for your client using - dd. If your swapfs command has the arguments + dd. If your swapfs command has the arguments /swapfs and the size 20000 as in the example above, the swapfile for myclient will be called /swapfs/swap.X.X.X.X where @@ -650,7 +650,7 @@ hostname myclient.mydomain When extracting /dev in /rootfs/myclient, beware that some systems (HPUX) will not create device files that - FreeBSD is happy with. You may have to go to single + FreeBSD is happy with. You may have to go to single user mode on the first bootup (press control-c during the bootup phase), cd /dev and do a sh ./MAKEDEV all @@ -679,7 +679,7 @@ hostname myclient.mydomain At present there isn't an officially sanctioned way of doing this, although I have been using a shared /usr filesystem and individual - / filesystems for each client. If anyone has + / filesystems for each client. If anyone has any suggestions on how to do this cleanly, please let me and/or the &a.core; know. @@ -690,7 +690,7 @@ hostname myclient.mydomain Netboot can be compiled to support NE1000/2000 cards by changing the configuration in - /sys/i386/boot/netboot/Makefile. See the + /sys/i386/boot/netboot/Makefile. See the comments at the top of this file. @@ -718,7 +718,7 @@ hostname myclient.mydomain If you are planning to use ISDN primarily to connect to the Internet with an Internet Provider on a dialup non-dedicated basis, I suggest you look into Terminal - Adapters. This will give you the most flexibility, with the + Adapters. This will give you the most flexibility, with the fewest problems, if you change providers. @@ -731,7 +731,7 @@ hostname myclient.mydomain Cost is a significant factor in determining what solution you - will choose. The following options are listed from least expensive + will choose. The following options are listed from least expensive to most expensive. @@ -741,10 +741,10 @@ hostname myclient.mydomain Contributed by &a.hm;. This section is really only relevant to ISDN users in countries - where the DSS1/Q.931 ISDN standard is supported. + where the DSS1/Q.931 ISDN standard is supported. Some growing number of PC ISDN cards are supported under FreeBSD - 2.2.x and up by the isdn4bsd driver package. It is still under + 2.2.x and up by the isdn4bsd driver package. It is still under development but the reports show that it is successfully used all over Europe. @@ -753,17 +753,17 @@ hostname myclient.mydomain the main isdn4bsd ftp site (you have to log in as user isdn4bsd , give your mail address as the password and change to the pub - directory. Anonymous ftp as user ftp or + directory. Anonymous ftp as user ftp or anonymous will not give the desired result). Isdn4bsd allows you to connect to other ISDN routers using - either IP over raw HDLC or by using synchronous PPP. A telephone + either IP over raw HDLC or by using synchronous PPP. A telephone answering machine application is also available. Many ISDN PC cards are supported, mostly the ones with a Siemens ISDN chipset (ISAC/HSCX), support for other chipsets (from Motorola, - Cologne Chip Designs) is currently under development. For an + Cologne Chip Designs) is currently under development. For an up-to-date list of supported cards, please have a look at the README file. @@ -773,7 +773,7 @@ hostname myclient.mydomain enhancing isdn4bsd, please get in touch with hm@kts.org. - A majordomo maintained mailing list is available. To join the + A majordomo maintained mailing list is available. To join the list, send mail to majordomo@FreeBSD.ORG and specify: @@ -794,21 +794,21 @@ subscribe freebsd-isdn A TA will operate basically the same as a modem except connection and throughput speeds will be much faster than your old - modem. You will need to configure PPP + modem. You will need to configure PPP exactly the - same as for a modem setup. Make sure you set your serial speed as + same as for a modem setup. Make sure you set your serial speed as high as possible. The main advantage of using a TA to connect to an Internet - Provider is that you can do Dynamic PPP. As IP address space + Provider is that you can do Dynamic PPP. As IP address space becomes more and more scarce, most providers are not willing to - provide you with a static IP anymore. Most standalone routers are + provide you with a static IP anymore. Most standalone routers are not able to accommodate dynamic IP allocation. TA's completely rely on the PPP daemon that you are running - for their features and stability of connection. This allows you + for their features and stability of connection. This allows you to upgrade easily from using a modem to ISDN on a FreeBSD machine, - if you already have PPP setup. However, at the same time any + if you already have PPP setup. However, at the same time any problems you experienced with the PPP program and are going to persist. @@ -850,8 +850,8 @@ subscribe freebsd-isdn the TA to a synchronous serial card. Do not be fooled into buying an internal TA and thinking you - have avoided the synchronous/asynchronous issue. Internal TA's - simply have a standard PC serial port chip built into them. All + have avoided the synchronous/asynchronous issue. Internal TA's + simply have a standard PC serial port chip built into them. All this will do, is save you having to buy another serial cable, and find another empty electrical socket. @@ -860,8 +860,8 @@ subscribe freebsd-isdn probably more flexible. The choice of sync/TA vs standalone router is largely a - religious issue. There has been some discussion of this in the - mailing lists. I suggest you search the archives for the complete discussion. @@ -871,7 +871,7 @@ subscribe freebsd-isdn Standalone ISDN Bridges/Routers ISDN bridges or routers are not at all specific to FreeBSD or - any other operating system. For a more complete description of + any other operating system. For a more complete description of routing and bridging technology, please refer to a Networking reference book. @@ -879,10 +879,10 @@ subscribe freebsd-isdn interchangeably. As the cost of low end ISDN routers/bridges comes down, it - will likely become a more and more popular choice. An ISDN router + will likely become a more and more popular choice. An ISDN router is a small box that plugs directly into your local Ethernet network(or card), and manages its own connection to the other - bridge/router. It has all the software to do PPP and other + bridge/router. It has all the software to do PPP and other protocols built in. A router will allow you much faster throughput that a standard @@ -890,13 +890,13 @@ subscribe freebsd-isdn connection. The main problem with ISDN routers and bridges is that - interoperability between manufacturers can still be a problem. If + interoperability between manufacturers can still be a problem. If you are planning to connect to an Internet provider, I recommend that you discuss your needs with them. If you are planning to connect two lan segments together, ie: home lan to the office lan, this is the simplest lowest - maintenance solution. Since you are buying the equipment for both + maintenance solution. Since you are buying the equipment for both sides of the connection you can be assured that the link will work. @@ -907,7 +907,7 @@ subscribe freebsd-isdn Branch office or Home network - Network is 10 Base T Ethernet. Connect router to network + Network is 10 Base T Ethernet. Connect router to network cable with AUI/10BT transceiver, if necessary. @@ -949,7 +949,7 @@ ISDN BRI line One large advantage of most routers/bridges is that they allow you to have 2 separate independent PPP connections to 2 separate - sites at the same time. This is not supported on most TA's, + sites at the same time. This is not supported on most TA's, except for specific(expensive) models that have two serial ports. Do not confuse this with channel bonding, MPP etc. @@ -958,7 +958,7 @@ ISDN BRI line to tap into it, but don't want to get another ISDN line at work. A router at the office location can manage a dedicated B channel connection (64Kbs) to the internet, as well as a use the other B - channel for a separate data connection. The second B channel can + channel for a separate data connection. The second B channel can be used for dialin, dialout or dynamically bond(MPP etc.) with the first B channel for more bandwidth. diff --git a/en_US.ISO8859-1/books/handbook/backups/chapter.sgml b/en_US.ISO8859-1/books/handbook/backups/chapter.sgml index d0bc0b1d65..58eda9d816 100644 --- a/en_US.ISO8859-1/books/handbook/backups/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/backups/chapter.sgml @@ -9,7 +9,7 @@ impossible to provide a exhaustive listing of hardware that FreeBSD supports, this section serves as a catalog of the device drivers included with FreeBSD and the hardware each drivers supports. Where possible and - appropriate, notes about specific products are included. You may also want + appropriate, notes about specific products are included. You may also want to refer to the kernel configuration file section in this handbook for a list of supported devices. @@ -41,22 +41,22 @@ Storage) 4mm tapes are replacing QIC as the workstation backup media of - choice. This trend accelerated greatly when Conner purchased Archive, + choice. This trend accelerated greatly when Conner purchased Archive, a leading manufacturer of QIC drives, and then stopped production of - QIC drives. 4mm drives are small and quiet but do not have the - reputation for reliability that is enjoyed by 8mm drives. The + QIC drives. 4mm drives are small and quiet but do not have the + reputation for reliability that is enjoyed by 8mm drives. The cartridges are less expensive and smaller (3 x 2 x 0.5 inches, 76 x 51 - x 12 mm) than 8mm cartridges. 4mm, like 8mm, has comparatively short + x 12 mm) than 8mm cartridges. 4mm, like 8mm, has comparatively short head life for the same reason, both use helical scan. Data thruput on these drives starts ~150kB/s, peaking at ~500kB/s. - Data capacity starts at 1.3 GB and ends at 2.0 GB. Hardware + Data capacity starts at 1.3 GB and ends at 2.0 GB. Hardware compression, available with most of these drives, approximately - doubles the capacity. Multi-drive tape library units can have 6 drives - in a single cabinet with automatic tape changing. Library capacities + doubles the capacity. Multi-drive tape library units can have 6 drives + in a single cabinet with automatic tape changing. Library capacities reach 240 GB. - 4mm drives, like 8mm drives, use helical-scan. All the benefits + 4mm drives, like 8mm drives, use helical-scan. All the benefits and drawbacks of helical-scan apply to both 4mm and 8mm drives. Tapes should be retired from use after 2,000 passes or 100 full @@ -67,23 +67,23 @@ 8mm (Exabyte) 8mm tapes are the most common SCSI tape drives; they are the best - choice of exchanging tapes. Nearly every site has an exabyte 2 GB 8mm - tape drive. 8mm drives are reliable, convenient and quiet. Cartridges + choice of exchanging tapes. Nearly every site has an exabyte 2 GB 8mm + tape drive. 8mm drives are reliable, convenient and quiet. Cartridges are inexpensive and small (4.8 x 3.3 x 0.6 inches; 122 x 84 x 15 mm). One downside of 8mm tape is relatively short head and tape life due to the high rate of relative motion of the tape across the heads. - Data thruput ranges from ~250kB/s to ~500kB/s. Data sizes start at - 300 MB and go up to 7 GB. Hardware compression, available with most of - these drives, approximately doubles the capacity. These drives are + Data thruput ranges from ~250kB/s to ~500kB/s. Data sizes start at + 300 MB and go up to 7 GB. Hardware compression, available with most of + these drives, approximately doubles the capacity. These drives are available as single units or multi-drive tape libraries with 6 drives - and 120 tapes in a single cabinet. Tapes are changed automatically by - the unit. Library capacities reach 840+ GB. + and 120 tapes in a single cabinet. Tapes are changed automatically by + the unit. Library capacities reach 840+ GB. Data is recorded onto the tape using helical-scan, the heads are - positioned at an angle to the media (approximately 6 degrees). The - tape wraps around 270 degrees of the spool that holds the heads. The - spool spins while the tape slides over the spool. The result is a high + positioned at an angle to the media (approximately 6 degrees). The + tape wraps around 270 degrees of the spool that holds the heads. The + spool spins while the tape slides over the spool. The result is a high density of data and closely packed tracks that angle across the tape from one edge to the other. @@ -92,31 +92,31 @@ QIC QIC-150 tapes and drives are, perhaps, the most common tape drive - and media around. QIC tape drives are the least expensive "serious" - backup drives. The downside is the cost of media. QIC tapes are + and media around. QIC tape drives are the least expensive "serious" + backup drives. The downside is the cost of media. QIC tapes are expensive compared to 8mm or 4mm tapes, up to 5 times the price per GB - data storage. But, if your needs can be satisfied with a half-dozen - tapes, QIC may be the correct choice. QIC is the - most common tape drive. Every site has a QIC - drive of some density or another. Therein lies the rub, QIC has a + data storage. But, if your needs can be satisfied with a half-dozen + tapes, QIC may be the correct choice. QIC is the + most common tape drive. Every site has a QIC + drive of some density or another. Therein lies the rub, QIC has a large number of densities on physically similar (sometimes identical) - tapes. QIC drives are not quiet. These drives audibly seek before they + tapes. QIC drives are not quiet. These drives audibly seek before they begin to record data and are clearly audible whenever reading, writing - or seeking. QIC tapes measure (6 x 4 x 0.7 inches; 15.2 x 10.2 x 1.7 - mm). Mini-cartridges, - which also use 1/4" wide tape are discussed separately. Tape libraries + or seeking. QIC tapes measure (6 x 4 x 0.7 inches; 15.2 x 10.2 x 1.7 + mm). Mini-cartridges, + which also use 1/4" wide tape are discussed separately. Tape libraries and changers are not available. - Data thruput ranges from ~150kB/s to ~500kB/s. Data capacity - ranges from 40 MB to 15 GB. Hardware compression is available on many - of the newer QIC drives. QIC drives are less frequently installed; + Data thruput ranges from ~150kB/s to ~500kB/s. Data capacity + ranges from 40 MB to 15 GB. Hardware compression is available on many + of the newer QIC drives. QIC drives are less frequently installed; they are being supplanted by DAT drives. - Data is recorded onto the tape in tracks. The tracks run along the - long axis of the tape media from one end to the other. The number of + Data is recorded onto the tape in tracks. The tracks run along the + long axis of the tape media from one end to the other. The number of tracks, and therefore the width of a track, varies with the tape's - capacity. Most if not all newer drives provide backward-compatibility - at least for reading (but often also for writing). QIC has a good + capacity. Most if not all newer drives provide backward-compatibility + at least for reading (but often also for writing). QIC has a good reputation regarding the safety of the data (the mechanics are simpler and more robust than for helical scan drives). @@ -133,25 +133,25 @@ DLT DLT has the fastest data transfer rate of all the drive types - listed here. The 1/2" (12.5mm) tape is contained in a single spool - cartridge (4 x 4 x 1 inches; 100 x 100 x 25 mm). The cartridge has a - swinging gate along one entire side of the cartridge. The drive - mechanism opens this gate to extract the tape leader. The tape leader - has an oval hole in it which the drive uses to "hook" the tape. The - take-up spool is located inside the tape drive. All the other tape + listed here. The 1/2" (12.5mm) tape is contained in a single spool + cartridge (4 x 4 x 1 inches; 100 x 100 x 25 mm). The cartridge has a + swinging gate along one entire side of the cartridge. The drive + mechanism opens this gate to extract the tape leader. The tape leader + has an oval hole in it which the drive uses to "hook" the tape. The + take-up spool is located inside the tape drive. All the other tape cartridges listed here (9 track tapes are the only exception) have both the supply and take-up spools located inside the tape cartridge itself. Data thruput is approximately 1.5MB/s, three times the thruput of - 4mm, 8mm, or QIC tape drives. Data capacities range from 10GB to 20GB - for a single drive. Drives are available in both multi-tape changers + 4mm, 8mm, or QIC tape drives. Data capacities range from 10GB to 20GB + for a single drive. Drives are available in both multi-tape changers and multi-tape, multi-drive tape libraries containing from 5 to 900 tapes over 1 to 20 drives, providing from 50GB to 9TB of storage. Data is recorded onto the tape in tracks parallel to the direction - of travel (just like QIC tapes). Two tracks are written at once. + of travel (just like QIC tapes). Two tracks are written at once. Read/write head lifetimes are relatively long; once the tape stops moving, there is no relative motion between the heads and the tape. @@ -161,7 +161,7 @@ Using a new tape for the first time The first time that you try to read or write a new, -completely blank tape, the operation will fail. The console +completely blank tape, the operation will fail. The console messages should be similar to: @@ -171,7 +171,7 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready The tape does not contain an Identifier Block (block number 0). All QIC tape drives since the adoption of QIC-525 standard write an - Identifier Block to the tape. There are two solutions: + Identifier Block to the tape. There are two solutions: mt fsf 1 causes the tape drive to write an Identifier Block to the tape. @@ -220,7 +220,7 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready and restore 8 - are the traditional Unix backup programs. They operate + are the traditional Unix backup programs. They operate on the drive as a collection of disk blocks, below the abstractions of files, links and directories that are created by the filesystems. @@ -237,13 +237,13 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready 8 does not write files and directories to tape, but rather writes the data blocks that are the building blocks of files - and directories. + and directories. dump 8 has quirks that remain from its early days in - Version 6 of ATT Unix (circa 1975). The default parameters are + Version 6 of ATT Unix (circa 1975). The default parameters are suitable for 9-track tapes (6250 bpi), not the high-density media - available today (up to 62,182 ftpi). These defaults must be overridden + available today (up to 62,182 ftpi). These defaults must be overridden on the command line to utilize the capacity of current tape drives. @@ -253,28 +253,28 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready and rrestore 8 backup data across the - network to a tape drive attached to another computer. Both programs + network to a tape drive attached to another computer. Both programs rely upon rcmd 3 and ruserok 3 to access the remote tape - drive. Therefore, the user performing the backup must have - rhosts access to the remote computer. The + drive. Therefore, the user performing the backup must have + rhosts access to the remote computer. The arguments to rdump 8 and rrestore 8 - must suitable to use on the remote computer. (e.g. + must suitable to use on the remote computer. (e.g. When rdump'ing from a FreeBSD computer to an Exabyte tape drive connected to a Sun called komodo, use: /sbin/rdump 0dsbfu 54000 13000 126 komodo:/dev/nrst8 /dev/rsd0a 2>&1) Beware: there are security implications to allowing rhosts - commands. Evaluate your situation carefully. + commands. Evaluate your situation carefully. @@ -284,7 +284,7 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready tar 1 also dates back to Version 6 of ATT Unix (circa - 1975). + 1975). tar 1 operates in cooperation with the filesystem; @@ -309,21 +309,21 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready Most versions of tar 1 - do not support backups across the network. The GNU + do not support backups across the network. The GNU version of tar 1, which FreeBSD utilizes, supports remote devices using the same syntax as - rdump. To + rdump. To tar 1 to an Exabyte tape drive connected to a Sun called komodo, use: /usr/bin/tar cf komodo:/dev/nrst8 . - 2>&1. For versions without remote device support, + 2>&1. For versions without remote device support, you can use a pipeline and rsh 1 to send the data to a - remote tape drive. (XXX add an example command) + remote tape drive. (XXX add an example command) @@ -332,15 +332,15 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready cpio 1 is the original Unix - file interchange tape program for magnetic media. + file interchange tape program for magnetic media. cpio 1 has options (among many others) to perform byte-swapping, write a number of different - archives format, and pipe the data to other programs. This last + archives format, and pipe the data to other programs. This last feature makes cpio 1 and excellent choice for - installation media. + installation media. cpio 1 does not know how to walk the directory tree and a list of files must be provided thru @@ -349,10 +349,10 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready cpio 1 does not support backups - across the network. You can use a pipeline and + across the network. You can use a pipeline and rsh 1 to send the data to a - remote tape drive. (XXX add an example command) + remote tape drive. (XXX add an example command) @@ -361,12 +361,12 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready pax 1 is IEEE/POSIX's answer to - tar and cpio. Over the years the + tar and cpio. Over the years the various versions of tar and cpio - have gotten slightly incompatible. So rather than fight it out to + have gotten slightly incompatible. So rather than fight it out to fully standardize them, POSIX created a new archive utility. pax attempts to read and write many of the various - cpio and tar formats, plus new formats of its own. Its command set + cpio and tar formats, plus new formats of its own. Its command set more resembles cpio than tar. @@ -376,23 +376,23 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready Amanda (Advanced Maryland Network Disk Archiver) is a client/server backup - system, rather than a single program. An Amanda server will backup to + system, rather than a single program. An Amanda server will backup to a single tape drive any number of computers that have Amanda clients - and network communications with the Amanda server. A common problem at + and network communications with the Amanda server. A common problem at locations with a number of large disks is the length of time required to backup to data directly to tape exceeds the amount of time - available for the task. Amanda solves this problem. Amanda can use a - "holding disk" to backup several filesystems at the same time. Amanda + available for the task. Amanda solves this problem. Amanda can use a + "holding disk" to backup several filesystems at the same time. Amanda creates "archive sets": a group of tapes used over a period of time to create full backups of all the filesystems listed in Amanda's - configuration file. The "archive set" also contains nightly + configuration file. The "archive set" also contains nightly incremental (or differential) backups of all the filesystems. Restoring a damaged filesystem requires the most recent full backup and the incremental backups. The configuration file provides fine control backups and the - network traffic that Amanda generates. Amanda will use any of the - above backup programs to write the data to tape. Amanda is available + network traffic that Amanda generates. Amanda will use any of the + above backup programs to write the data to tape. Amanda is available as either a port or a package, it is not installed by default. @@ -400,22 +400,22 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready Do nothing “Do nothing” is not a computer program, but it is the - most widely used backup strategy. There are no initial costs. There is - no backup schedule to follow. Just say no. If something happens to + most widely used backup strategy. There are no initial costs. There is + no backup schedule to follow. Just say no. If something happens to your data, grin and bear it! If your time and your data is worth little to nothing, then “Do nothing” is the most suitable backup program for your - computer. But beware, Unix is a useful tool, you may find that within + computer. But beware, Unix is a useful tool, you may find that within six months you have a collection of files that are valuable to you. “Do nothing” is the correct backup method for /usr/obj and other directory trees that can be - exactly recreated by your computer. An example is the files that + exactly recreated by your computer. An example is the files that comprise these handbook pages-they have been generated from - SGML input files. Creating backups of these - HTML files is not necessary. The + SGML input files. Creating backups of these + HTML files is not necessary. The SGML source files are backed up regularly. @@ -426,17 +426,17 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready dump 8 Period. Elizabeth D. Zwicky torture tested all the backup programs discussed - here. The clear choice for preserving all your data and all the + here. The clear choice for preserving all your data and all the peculiarities of Unix filesystems is dump - 8. Elizabeth created + 8. Elizabeth created filesystems containing a large variety of unusual conditions (and some not so unusual ones) and tested each program by do a backup and - restore of that filesystems. The peculiarities included: files with + restore of that filesystems. The peculiarities included: files with holes, files with holes and a block of nulls, files with funny characters in their names, unreadable and unwritable files, devices, files that change size during the backup, files that are - created/deleted during the backup and more. She presented the results + created/deleted during the backup and more. She presented the results at LISA V in Oct. 1991. See torture-testing Backup and Archive Programs. @@ -457,14 +457,14 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready Second, determine that the boot and fixit floppies (boot.flp and fixit.flp) - have all your devices. The easiest way to check is to reboot your + have all your devices. The easiest way to check is to reboot your machine with the boot floppy in the floppy drive and check the boot - messages. If all your devices are listed and functional, skip on to + messages. If all your devices are listed and functional, skip on to step three. Otherwise, you have to create two custom bootable floppies which has a kernel that can mount your all of your disks and - access your tape drive. These floppies must contain: + access your tape drive. These floppies must contain: fdisk 8, @@ -474,7 +474,7 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready 8, mount 8, and whichever backup - program you use. These programs must be statically linked. If you + program you use. These programs must be statically linked. If you use dump 8, the floppy must contain @@ -482,25 +482,25 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready restore 8. - Third, create backup tapes regularly. Any changes that you make - after your last backup may be irretrievably lost. Write-protect the + Third, create backup tapes regularly. Any changes that you make + after your last backup may be irretrievably lost. Write-protect the backup tapes. Fourth, test the floppies (either boot.flp and fixit.flp or the two custom bootable - floppies you made in step two.) and backup tapes. Make notes of the - procedure. Store these notes with the bootable floppy, the printouts - and the backup tapes. You will be so distraught when restoring that + floppies you made in step two.) and backup tapes. Make notes of the + procedure. Store these notes with the bootable floppy, the printouts + and the backup tapes. You will be so distraught when restoring that the notes may prevent you from destroying your backup tapes (How? In place of tar xvf /dev/rst0, you might accidently type tar cvf /dev/rst0 and over-write your backup tape). For an added measure of security, make bootable floppies and two - backup tapes each time. Store one of each at a remote location. A - remote location is NOT the basement of the same office building. A + backup tapes each time. Store one of each at a remote location. A + remote location is NOT the basement of the same office building. A number of firms in the World Trade Center learned this lesson the - hard way. A remote location should be physically separated from your + hard way. A remote location should be physically separated from your computers and disk drives by a significant distance. An example script for creating a bootable floppy: @@ -666,20 +666,20 @@ chmod 644 /mnt/etc/passwd doing regular backups so there is no need to worry about the software. - If the hardware has been damaged. First, replace those parts + If the hardware has been damaged. First, replace those parts that have been damaged. - If your hardware is okay, check your floppies. If you are using + If your hardware is okay, check your floppies. If you are using a custom boot floppy, boot single-user (type -s - at the boot: prompt). Skip the following + at the boot: prompt). Skip the following paragraph. If you are using the boot.flp and - fixit.flp floppies, keep reading. Insert the + fixit.flp floppies, keep reading. Insert the boot.flp floppy in the first floppy drive and - boot the computer. The original install menu will be displayed on - the screen. Select the Fixit--Repair mode with CDROM or - floppy. option. Insert the + boot the computer. The original install menu will be displayed on + the screen. Select the Fixit--Repair mode with CDROM or + floppy. option. Insert the fixit.flp when prompted. restore and the other programs that you need are located in /mnt2/stand. @@ -690,23 +690,23 @@ chmod 644 /mnt/etc/passwd mount 8 (e.g. mount /dev/sd0a - /mnt) the root partition of your first disk. If the + /mnt) the root partition of your first disk. If the disklabel was damaged, use disklabel 8 to re-partition and - label the disk to match the label that your printed and saved. Use + label the disk to match the label that your printed and saved. Use newfs 8 to re-create the - filesystems. Re-mount the root partition of the floppy read-write - (mount -u -o rw /mnt). Use your backup program + filesystems. Re-mount the root partition of the floppy read-write + (mount -u -o rw /mnt). Use your backup program and backup tapes to recover the data for this filesystem (e.g. - restore vrf /dev/st0). Unmount the filesystem + restore vrf /dev/st0). Unmount the filesystem (e.g. umount /mnt) Repeat for each filesystem that was damaged. Once your system is running, backup your data onto new tapes. - Whatever caused the crash or data loss may strike again. An another + Whatever caused the crash or data loss may strike again. An another hour spent now, may save you from further distress later. diff --git a/en_US.ISO8859-1/books/handbook/basics/chapter.sgml b/en_US.ISO8859-1/books/handbook/basics/chapter.sgml index 4fd4f4b9fd..685547733f 100644 --- a/en_US.ISO8859-1/books/handbook/basics/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/basics/chapter.sgml @@ -6,11 +6,11 @@ The Online Manual The most comprehensive documentation on FreeBSD is in the form - of man pages. Nearly every program on the + of man pages. Nearly every program on the system comes with a short reference manual explaining the basic - operation and various arguments. These manuals can be view with the + operation and various arguments. These manuals can be view with the man - command. Use of the man command is simple: + command. Use of the man command is simple: &prompt.user; man command @@ -18,7 +18,7 @@ command is - the name of the command you wish to learn about. For example, to + the name of the command you wish to learn about. For example, to learn more about ls command type: &prompt.user; man ls @@ -63,9 +63,9 @@ In some cases, the same topic may appear in more than - one section of the on-line manual. For example, there is a + one section of the on-line manual. For example, there is a chmod - user command and a chmod() system call. In + user command and a chmod() system call. In this case, you can tell the man command which one you want by specifying the section: @@ -74,7 +74,7 @@ This will display the manual page for the user - command chmod. References to a + command chmod. References to a particular section of the on-line manual are traditionally placed in parenthesis in written documentation, so chmod1 refers to the chmod @@ -116,7 +116,7 @@ GNU Info Files FreeBSD includes many applications and utilities produced by the - Free Software Foundation (FSF). In addition to man pages, these + Free Software Foundation (FSF). In addition to man pages, these programs come with more extensive hypertext documents called “info” files which can be viewed with the info command or, if you installed @@ -128,7 +128,7 @@ &prompt.user; info - For a brief introduction, type h. For a quick + For a brief introduction, type h. For a quick command reference, type ?. diff --git a/en_US.ISO8859-1/books/handbook/bibliography/chapter.sgml b/en_US.ISO8859-1/books/handbook/bibliography/chapter.sgml index 6f5c05ed25..bd73d8b64e 100644 --- a/en_US.ISO8859-1/books/handbook/bibliography/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/bibliography/chapter.sgml @@ -4,7 +4,7 @@ While the manual pages provide the definitive reference for individual pieces of the FreeBSD operating system, they are notorious for not illustrating how to put the pieces together to make the whole - operating system run smoothly. For this, there is no substitute for a + operating system run smoothly. For this, there is no substitute for a good book on UNIX system administration and a good users' manual. @@ -26,33 +26,33 @@ FreeBSD for PC 98'ers (in Japanese), published by SHUWA - System Co, LTD. ISBN 4-87966-468-5 C3055 P2900E. + System Co, LTD. ISBN 4-87966-468-5 C3055 P2900E. - FreeBSD (in Japanese), published by CUTT. ISBN + FreeBSD (in Japanese), published by CUTT. ISBN 4-906391-22-2 C3055 P2400E. Complete Introduction to FreeBSD (in Japanese), published by Shoeisha Co., Ltd. ISBN 4-88135-473-6 P3600E. + URL="http://www.shoeisha.co.jp/pc/index/shinkan/97_05_06.htm">Complete Introduction to FreeBSD (in Japanese), published by Shoeisha Co., Ltd. ISBN 4-88135-473-6 P3600E. Personal UNIX Starter Kit FreeBSD (in Japanese), published by ASCII. ISBN 4-7561-1733-3 P3000E. + URL="http://www.ascii.co.jp/pb/book1/shinkan/detail/1322785.html">Personal UNIX Starter Kit FreeBSD (in Japanese), published by ASCII. ISBN 4-7561-1733-3 P3000E. FreeBSD Handbook (Japanese translation), published by - ASCII. ISBN + ASCII. ISBN 4-7561-1580-2 P3800E. FreeBSD mit Methode (in German), published by Computer und - Literatur Verlag/Vertrieb Hanser, 1998. ISBN 3-932311-31-0. + Literatur Verlag/Vertrieb Hanser, 1998. ISBN 3-932311-31-0. @@ -90,27 +90,27 @@ - Computer Systems Research Group, UC Berkeley. 4.4BSD User's Reference Manual. O'Reilly + Computer Systems Research Group, UC Berkeley. 4.4BSD User's Reference Manual. O'Reilly & Associates, Inc., 1994. ISBN 1-56592-075-9 - Computer Systems Research Group, UC Berkeley. 4.4BSD User's Supplementary Documents. + Computer Systems Research Group, UC Berkeley. 4.4BSD User's Supplementary Documents. O'Reilly & Associates, Inc., 1994. ISBN 1-56592-076-7 - UNIX in a Nutshell. O'Reilly + UNIX in a Nutshell. O'Reilly & Associates, Inc., 1990. ISBN 093717520X - Mui, Linda. What You Need To Know When You Can't - Find Your UNIX System Administrator. O'Reilly - & Associates, Inc., 1995. ISBN 1-56592-104-6 + Mui, Linda. What You Need To Know When You Can't + Find Your UNIX System Administrator. O'Reilly + & Associates, Inc., 1995. ISBN 1-56592-104-6 @@ -121,11 +121,11 @@ Jpman Project, - Japan FreeBSD Users Group. . FreeBSD User's Reference Manual (Japanese translation). Mainichi - Communications Inc., 1998. ISBN4-8399-0088-4 + Communications Inc., 1998. ISBN4-8399-0088-4 P3800E. @@ -140,54 +140,54 @@ - Albitz, Paul and Liu, Cricket. DNS and + Albitz, Paul and Liu, Cricket. DNS and BIND, 2nd Ed. O'Reilly & Associates, Inc., - 1997. ISBN 1-56592-236-0 + 1997. ISBN 1-56592-236-0 - Computer Systems Research Group, UC Berkeley. 4.4BSD System Manager's Manual. O'Reilly - & Associates, Inc., 1994. ISBN + Computer Systems Research Group, UC Berkeley. 4.4BSD System Manager's Manual. O'Reilly + & Associates, Inc., 1994. ISBN 1-56592-080-5 - Costales, Brian, et al. Sendmail, 2nd + Costales, Brian, et al. Sendmail, 2nd Ed. O'Reilly & Associates, Inc., 1997. ISBN 1-56592-222-0 - Frisch, Æleen. Essential System + Frisch, Æleen. Essential System Administration, 2nd Ed. O'Reilly & - Associates, Inc., 1995. ISBN 1-56592-127-5 + Associates, Inc., 1995. ISBN 1-56592-127-5 - Hunt, Craig. TCP/IP Network - Administration. O'Reilly & Associates, Inc., - 1992. ISBN 0-937175-82-X + Hunt, Craig. TCP/IP Network + Administration. O'Reilly & Associates, Inc., + 1992. ISBN 0-937175-82-X - Nemeth, Evi. UNIX System Administration - Handbook. 2nd Ed. Prentice Hall, 1995. ISBN 0131510517 Stern, Hal Managing NFS and NIS - O'Reilly & Associates, Inc., 1991. ISBN + O'Reilly & Associates, Inc., 1991. ISBN 0-937175-75-7 Jpman Project, - Japan FreeBSD Users Group. . FreeBSD System Administrator's Manual (Japanese translation). Mainichi - Communications Inc., 1998. ISBN4-8399-0109-0 + Communications Inc., 1998. ISBN4-8399-0109-0 P3300E. @@ -202,61 +202,61 @@ - Asente, Paul. X Window System - Toolkit. Digital Press. ISBN + Asente, Paul. X Window System + Toolkit. Digital Press. ISBN 1-55558-051-3 - Computer Systems Research Group, UC Berkeley. 4.4BSD Programmer's Reference Manual. - O'Reilly & Associates, Inc., 1994. ISBN + Computer Systems Research Group, UC Berkeley. 4.4BSD Programmer's Reference Manual. + O'Reilly & Associates, Inc., 1994. ISBN 1-56592-078-3 - Computer Systems Research Group, UC Berkeley. 4.4BSD Programmer's Supplementary - Documents. O'Reilly & Associates, Inc., 1994. + Computer Systems Research Group, UC Berkeley. 4.4BSD Programmer's Supplementary + Documents. O'Reilly & Associates, Inc., 1994. ISBN 1-56592-079-1 - Harbison, Samuel P. and Steele, Guy L. Jr. C: A - Reference Manual. 4rd ed. Prentice Hall, 1995. + Harbison, Samuel P. and Steele, Guy L. Jr. C: A + Reference Manual. 4rd ed. Prentice Hall, 1995. ISBN 0-13-326224-3 - Kernighan, Brian and Dennis M. Ritchie. The C - Programming Language.. PTR Prentice Hall, 1988. + Kernighan, Brian and Dennis M. Ritchie. The C + Programming Language.. PTR Prentice Hall, 1988. ISBN 0-13-110362-9 - Lehey, Greg. Porting UNIX Software. + Lehey, Greg. Porting UNIX Software. O'Reilly & Associates, Inc., 1995. ISBN 1-56592-126-7 Plauger, P. J. The Standard C - Library. Prentice Hall, 1992. ISBN + Library. Prentice Hall, 1992. ISBN 0-13-131509-9 - Stevens, W. Richard. Advanced Programming in the - UNIX Environment. Reading, Mass. : + Stevens, W. Richard. Advanced Programming in the + UNIX Environment. Reading, Mass. : Addison-Wesley, 1992 ISBN 0-201-56317-7 - Stevens, W. Richard. UNIX Network - Programming. 2nd Ed, PTR Prentice Hall, 1998. ISBN + Stevens, W. Richard. UNIX Network + Programming. 2nd Ed, PTR Prentice Hall, 1998. ISBN 0-13-490012-X - Wells, Bill. “Writing Serial Drivers for UNIX”. + Wells, Bill. “Writing Serial Drivers for UNIX”. Dr. Dobb's Journal. 19(15), December 1994. pp68-71, 97-99. @@ -273,66 +273,66 @@ - Andleigh, Prabhat K. UNIX System - Architecture. Prentice-Hall, Inc., 1990. ISBN 0-13-949843-5 - Jolitz, William. “Porting UNIX to the + Jolitz, William. “Porting UNIX to the 386”. Dr. - Dobb's Journal. January 1991-July 1992. + Dobb's Journal. January 1991-July 1992. Leffler, Samuel J., Marshall Kirk McKusick, Michael J Karels and John Quarterman The Design and Implementation of the 4.3BSD UNIX Operating - System. Reading, Mass. : Addison-Wesley, + System. Reading, Mass. : Addison-Wesley, 1989. ISBN 0-201-06196-1 Leffler, Samuel J., Marshall Kirk McKusick, The Design and Implementation of the 4.3BSD UNIX Operating - System: Answer Book. Reading, Mass. : + System: Answer Book. Reading, Mass. : Addison-Wesley, 1991. ISBN 0-201-54629-9 McKusick, Marshall Kirk, Keith Bostic, Michael J Karels, - and John Quarterman. The Design and Implementation - of the 4.4BSD Operating System. Reading, Mass. : + and John Quarterman. The Design and Implementation + of the 4.4BSD Operating System. Reading, Mass. : Addison-Wesley, 1996. ISBN 0-201-54979-4 - Stevens, W. Richard. TCP/IP Illustrated, Volume - 1: The Protocols. Reading, Mass. : + Stevens, W. Richard. TCP/IP Illustrated, Volume + 1: The Protocols. Reading, Mass. : Addison-Wesley, 1996. ISBN 0-201-63346-9 - Schimmel, Curt. Unix Systems for Modern - Architectures. Reading, Mass. : Addison-Wesley, - 1994. ISBN 0-201-63338-8 + Schimmel, Curt. Unix Systems for Modern + Architectures. Reading, Mass. : Addison-Wesley, + 1994. ISBN 0-201-63338-8 - Stevens, W. Richard. TCP/IP Illustrated, Volume + Stevens, W. Richard. TCP/IP Illustrated, Volume 3: TCP for Transactions, HTTP, NNTP and the UNIX Domain - Protocols. Reading, Mass. : Addison-Wesley, + Protocols. Reading, Mass. : Addison-Wesley, 1996. ISBN 0-201-63495-3 - Vahalia, Uresh. UNIX Internals -- The New - Frontiers. Prentice Hall, 1996. ISBN + Vahalia, Uresh. UNIX Internals -- The New + Frontiers. Prentice Hall, 1996. ISBN 0-13-101908-2 - Wright, Gary R. and W. Richard Stevens. TCP/IP + Wright, Gary R. and W. Richard Stevens. TCP/IP Illustrated, Volume 2: The Implementation. Reading, Mass. : Addison-Wesley, 1995. ISBN 0-201-63354-X @@ -352,18 +352,18 @@ Cheswick, William R. and Steven M. Bellovin. Firewalls and Internet Security: Repelling the Wily - Hacker. Reading, Mass. : Addison-Wesley, + Hacker. Reading, Mass. : Addison-Wesley, 1995. ISBN 0-201-63357-4 - Garfinkel, Simson and Gene Spafford. Practical - UNIX Security. 2nd Ed. O'Reilly & Associates, - Inc., 1996. ISBN 1-56592-148-8 + Garfinkel, Simson and Gene Spafford. Practical + UNIX Security. 2nd Ed. O'Reilly & Associates, + Inc., 1996. ISBN 1-56592-148-8 - Garfinkel, Simson. PGP Pretty Good + Garfinkel, Simson. PGP Pretty Good Privacy O'Reilly & Associates, Inc., 1995. ISBN 1-56592-098-8 @@ -380,14 +380,14 @@ - Anderson, Don and Tom Shanley. Pentium Processor - System Architecture. 2nd Ed. Reading, Mass. : + Anderson, Don and Tom Shanley. Pentium Processor + System Architecture. 2nd Ed. Reading, Mass. : Addison-Wesley, 1995. ISBN 0-201-40992-5 - Ferraro, Richard F. Programmer's Guide to the - EGA, VGA, and Super VGA Cards. 3rd ed. Reading, + Ferraro, Richard F. Programmer's Guide to the + EGA, VGA, and Super VGA Cards. 3rd ed. Reading, Mass. : Addison-Wesley, 1995. ISBN 0-201-62490-7 @@ -400,26 +400,26 @@ - Shanley, Tom. 80486 System - Architecture. 3rd ed. Reading, Mass. : - Addison-Wesley, 1995. ISBN 0-201-40994-1 + Shanley, Tom. 80486 System + Architecture. 3rd ed. Reading, Mass. : + Addison-Wesley, 1995. ISBN 0-201-40994-1 - Shanley, Tom. ISA System - Architecture. 3rd ed. Reading, Mass. : + Shanley, Tom. ISA System + Architecture. 3rd ed. Reading, Mass. : Addison-Wesley, 1995. ISBN 0-201-40996-8 - Shanley, Tom. PCI System - Architecture. 3rd ed. Reading, Mass. : - Addison-Wesley, 1995. ISBN 0-201-40993-3 + Shanley, Tom. PCI System + Architecture. 3rd ed. Reading, Mass. : + Addison-Wesley, 1995. ISBN 0-201-40993-3 - Van Gilluwe, Frank. The Undocumented - PC. Reading, Mass: Addison-Wesley Pub. Co., + Van Gilluwe, Frank. The Undocumented + PC. Reading, Mass: Addison-Wesley Pub. Co., 1994. ISBN 0-201-62277-7 @@ -436,45 +436,45 @@ Lion, John Lion's Commentary on UNIX, 6th Ed. - With Source Code. ITP Media Group, 1996. ISBN 1573980137 - Raymond, Eric s. The New Hacker's Dictonary, 3rd - edition. MIT Press, 1996. ISBN + Raymond, Eric s. The New Hacker's Dictonary, 3rd + edition. MIT Press, 1996. ISBN 0-262-68092-0 Also known as the Jargon File - Salus, Peter H. A quarter century of - UNIX. Addison-Wesley Publishing Company, Inc., + Salus, Peter H. A quarter century of + UNIX. Addison-Wesley Publishing Company, Inc., 1994. ISBN 0-201-54777-5 Simon Garfinkel, Daniel Weise, Steven Strassmann. - The UNIX-HATERS Handbook. IDG Books + The UNIX-HATERS Handbook. IDG Books Worldwide, Inc., 1994. ISBN 1-56884-203-1 Don Libes, Sandy Ressler Life with - UNIX — special edition. Prentice-Hall, Inc., + UNIX — special edition. Prentice-Hall, Inc., 1989. ISBN 0-13-536657-7 - The BSD family tree. 1997. ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/src/share/misc/bsd-family-tree or local on a FreeBSD-current machine. The BSD Release Announcements - collection. 1997. . 1997. http://www.de.FreeBSD.ORG/de/ftp/releases/ @@ -486,8 +486,8 @@ url="ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/src/share/misc/bsd-family Old BSD releases from the Computer Systems Research - group (CSRG). http://www.mckusick.com/csrg/: The 4CD set covers all BSD versions from 1BSD to 4.4BSD and 4.4BSD-Lite2 (but not 2.11BSD, unfortunately). As well, the last disk holds the final sources plus the SCCS files. + group (CSRG). http://www.mckusick.com/csrg/: The 4CD set covers all BSD versions from 1BSD to 4.4BSD and 4.4BSD-Lite2 (but not 2.11BSD, unfortunately). As well, the last disk holds the final sources plus the SCCS files. @@ -501,8 +501,8 @@ url="ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/src/share/misc/bsd-family - The C/C++ Users Journal. R&D - Publications Inc. ISSN 1075-2838 + The C/C++ Users Journal. R&D + Publications Inc. ISSN 1075-2838 diff --git a/en_US.ISO8859-1/books/handbook/book.sgml b/en_US.ISO8859-1/books/handbook/book.sgml index a16117c8ed..73e1dd73be 100644 --- a/en_US.ISO8859-1/books/handbook/book.sgml +++ b/en_US.ISO8859-1/books/handbook/book.sgml @@ -4,7 +4,7 @@ %mailing-lists; %newsgroups; - @@ -33,18 +33,18 @@ Welcome to FreeBSD! This handbook covers the installation and day - to day use of FreeBSD Release &rel.current;. This + to day use of FreeBSD Release &rel.current;. This manual is a work in progress and is the work of - many individuals. Many sections do not yet exist and some of those - that do exist need to be updated. If you are interested in helping - with this project, send email to the &a.doc;. The latest version of + many individuals. Many sections do not yet exist and some of those + that do exist need to be updated. If you are interested in helping + with this project, send email to the &a.doc;. The latest version of this document is always available from the FreeBSD World Wide Web server. It may also be downloaded in plain text, postscript or HTML with HTTP or gzip'd from the FreeBSD FTP server or one of the numerous mirror sites. You may also want to + linkend="mirrors-ftp">mirror sites. You may also want to Search the Handbook. diff --git a/en_US.ISO8859-1/books/handbook/contrib/chapter.sgml b/en_US.ISO8859-1/books/handbook/contrib/chapter.sgml index 6d64db5434..d36fd7e6d4 100644 --- a/en_US.ISO8859-1/books/handbook/contrib/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/contrib/chapter.sgml @@ -6,12 +6,12 @@ So you want to contribute something to FreeBSD? That is great! We can always use the help, and FreeBSD is one of those systems that relies on the contributions of its user base in - order to survive. Your contributions are not only appreciated, they + order to survive. Your contributions are not only appreciated, they are vital to FreeBSD's continued growth! Contrary to what some people might also have you believe, you do not need to be a hot-shot programmer or a close personal friend of the - FreeBSD core team in order to have your contributions accepted. The + FreeBSD core team in order to have your contributions accepted. The FreeBSD Project's development is done by a large and growing number of international contributors whose ages and areas of technical expertise vary greatly, and there is always more work to be done than there are @@ -21,16 +21,16 @@ system environment (and its installation) rather than just a kernel or a few scattered utilities, our TODO list also spans a very wide range of tasks, from documentation, beta testing and presentation to - highly specialized types of kernel development. No matter what your + highly specialized types of kernel development. No matter what your skill level, there is almost certainly something you can do to help the project! Commercial entities engaged in FreeBSD-related enterprises are - also encouraged to contact us. Need a special extension to make your + also encouraged to contact us. Need a special extension to make your product work? You will find us receptive to your requests, given that - they are not too outlandish. Working on a value-added product? + they are not too outlandish. Working on a value-added product? Please let us know! We may be able to work cooperatively on some - aspect of it. The free software world is challenging a lot of + aspect of it. The free software world is challenging a lot of existing assumptions about how software is developed, sold, and maintained throughout its life cycle, and we urge you to at least give it a second look. @@ -41,10 +41,10 @@ The following list of tasks and sub-projects represents something of an amalgam of the various core team TODO lists and user - requests we have collected over the last couple of months. Where - possible, tasks have been ranked by degree of urgency. If you are + requests we have collected over the last couple of months. Where + possible, tasks have been ranked by degree of urgency. If you are interested in working on one of the tasks you see here, send mail to - the coordinator listed by clicking on their names. If no + the coordinator listed by clicking on their names. If no coordinator has been appointed, maybe you would like to volunteer? @@ -59,7 +59,7 @@ - 3-stage boot issues. Overall coordination: + 3-stage boot issues. Overall coordination: &a.hackers; @@ -75,7 +75,7 @@ - Filesystem problems. Overall coordination: &a.fs; + Filesystem problems. Overall coordination: &a.fs; @@ -88,7 +88,7 @@ - Fix the union file system. Coordinator: + Fix the union file system. Coordinator: &a.dg; @@ -97,12 +97,12 @@ - Implement Int13 vm86 disk driver. Coordinator: + Implement Int13 vm86 disk driver. Coordinator: &a.hackers; - New bus architecture. Coordinator: &a.newbus; + New bus architecture. Coordinator: &a.newbus; @@ -116,7 +116,7 @@ - Port PCI subsystem to new architecture. Coordinator: + Port PCI subsystem to new architecture. Coordinator: &a.dfr; @@ -139,7 +139,7 @@ - Kernel issues. Overall coordination: &a.hackers; + Kernel issues. Overall coordination: &a.hackers; @@ -156,7 +156,7 @@ Make the entire kernel use - suser() instead of comparing to 0. It + suser() instead of comparing to 0. It is presently using about half of each. Coordinator: &a.eivind; @@ -164,7 +164,7 @@ Split securelevels into different parts, to allow an administrator to throw away those privileges he can throw - away. Setting the overall securelevel needs to have the + away. Setting the overall securelevel needs to have the same effect as now, obviously. Coordinator: &a.eivind; @@ -196,7 +196,7 @@ Add code to teh NFS layer so that you cannot chdir("..") out of an NFS partition. E.g., /usr is a UFS partition with - /usr/src NFS exported. Now it is + /usr/src NFS exported. Now it is possible to use the NFS filehandle for /usr/src to get access to /usr. @@ -230,7 +230,7 @@ - PCMCIA/PCCARD. Coordinators: &a.msmith; and &a.phk; + PCMCIA/PCCARD. Coordinators: &a.msmith; and &a.phk; @@ -267,7 +267,7 @@ - Advanced Power Management. Coordinators: &a.msmith; and + Advanced Power Management. Coordinators: &a.msmith; and &a.phk; @@ -310,7 +310,7 @@ NetWare Server (protected mode ODI driver) loader and subservices to allow the use of ODI card drivers supplied - with network cards. The same thing for NDIS drivers and + with network cards. The same thing for NDIS drivers and NetWare SCSI drivers. @@ -327,7 +327,7 @@ A concerted effort at support for portable computers. This is somewhat handled by changing PCMCIA bridging rules - and power management event handling. But there are things + and power management event handling. But there are things like detecting internal vs. external display and picking a different screen resolution based on that fact, not spinning down the disk if the machine is in dock, and allowing @@ -343,7 +343,7 @@ Most of the tasks listed in the previous sections require either a considerable investment of time or an in-depth knowledge - of the FreeBSD kernel (or both). However, there are also many + of the FreeBSD kernel (or both). However, there are also many useful tasks which are suitable for "weekend hackers", or people without programming skills. @@ -359,16 +359,16 @@ - Read the freebsd-bugs mailing list. There might be a + Read the freebsd-bugs mailing list. There might be a problem you can comment constructively on or with patches - you can test. Or you could even try to fix one of the + you can test. Or you could even try to fix one of the problems yourself. - Read through the FAQ and Handbook periodically. If + Read through the FAQ and Handbook periodically. If anything is badly explained, out of date or even just - completely wrong, let us know. Even better, send us a fix + completely wrong, let us know. Even better, send us a fix (SGML is not difficult to learn, but there is no objection to ASCII submissions). @@ -376,7 +376,7 @@ Help translate FreeBSD documentation into your native language (if not already available) — just send an email to - &a.doc; asking if anyone is working on it. Note that you + &a.doc; asking if anyone is working on it. Note that you are not committing yourself to translating every single FreeBSD document by doing this — in fact, the documentation most in need of translation is the installation @@ -386,7 +386,7 @@ Read the freebsd-questions mailing list and &ng.misc occasionally (or even - regularly). It can be very satisfying to share your + regularly). It can be very satisfying to share your expertise and help people solve their problems; sometimes you may even learn something new yourself! These forums can also be a source of ideas for things to work on. @@ -450,24 +450,24 @@ Bug reports and general commentary An idea or suggestion of general - technical interest should be mailed to the &a.hackers;. Likewise, + technical interest should be mailed to the &a.hackers;. Likewise, people with an interest in such things (and a tolerance for a high volume of mail!) may subscribe to the - hackers mailing list by sending mail to &a.majordomo;. See + hackers mailing list by sending mail to &a.majordomo;. See mailing lists for more information about this and other mailing lists. If you find a bug or are submitting a specific change, please report it using the send-pr1program or its WEB-based - equivalent. Try to fill-in each field of the bug report. + equivalent. Try to fill-in each field of the bug report. Unless they exceed 65KB, include any patches directly in the - report. Consider compressing them and using - uuencode1 if they exceed 20KB. Upload very large submissions to ftp.freebsd.org:/pub/FreeBSD/incoming/. + report. Consider compressing them and using + uuencode1 if they exceed 20KB. Upload very large submissions to ftp.freebsd.org:/pub/FreeBSD/incoming/. After filing a report, you should receive confirmation along - with a tracking number. Keep this tracking number so that you can - update us with details about the problem by sending mail to bug-followup@FreeBSD.ORG. Use the number as the message subject, e.g. "Re: kern/3377". Additional information for any bug report should be submitted this way. + with a tracking number. Keep this tracking number so that you can + update us with details about the problem by sending mail to bug-followup@FreeBSD.ORG. Use the number as the message subject, e.g. "Re: kern/3377". Additional information for any bug report should be submitted this way. If you do not receive confirmation in a timely fashion (3 days to a week, depending on your email connection) or are, for some @@ -480,7 +480,7 @@ Changes to the documentation - Changes to the documentation are overseen by the &a.doc;. Send + Changes to the documentation are overseen by the &a.doc;. Send submissions and changes (even small ones are welcome!) using send-pr as described in Bug Reports and General @@ -503,16 +503,16 @@ Working from older sources unfortunately means that your changes may sometimes be too obsolete or too divergent for easy - re-integration into FreeBSD. Chances of this can be minimized + re-integration into FreeBSD. Chances of this can be minimized somewhat by subscribing to the &a.announce; and the &a.current; lists, where discussions on the current state of the system take place. Assuming that you can manage to secure fairly up-to-date sources to base your changes on, the next step is to produce a set - of diffs to send to the FreeBSD maintainers. This is done with + of diffs to send to the FreeBSD maintainers. This is done with the diff1 command, with the “context diff” - form being preferred. For example: + form being preferred. For example: &prompt.user; diff -c oldfile newfile @@ -525,15 +525,15 @@ would generate such a set of context diffs for - the given source file or directory hierarchy. See the man page + the given source file or directory hierarchy. See the man page for diff1 for more details. Once you have a set of diffs (which you may test with the patch1 command), you should submit them for - inclusion with FreeBSD. Use the send-pr1 + inclusion with FreeBSD. Use the send-pr1 program as described in Bug Reports and General - Commentary. Do not just send the diffs to + Commentary. Do not just send the diffs to the &a.hackers; or they will get lost! We greatly appreciate your submission (this is a volunteer project!); because we are busy, we may not be able to address it immediately, but it will remain in @@ -541,22 +541,22 @@ If you feel it appropriate (e.g. you have added, deleted, or renamed files), bundle your changes into a tar file and run the - uuencode1 program on it. Shar archives are + uuencode1 program on it. Shar archives are also welcome. If your change is of a potentially sensitive nature, e.g. you are unsure of copyright issues governing its further distribution or you are simply not ready to release it without a tighter review first, then you should send it to &a.core; directly rather than - submitting it with send-pr1. The core + submitting it with send-pr1. The core mailing list reaches a much smaller group of people who do much of - the day-to-day work on FreeBSD. Note that this group is also + the day-to-day work on FreeBSD. Note that this group is also very busy and so you should only send mail to them where it is truly necessary. Please refer to man 9 intro and man 9 style for some information on - coding style. We would appreciate it if you were at least aware + coding style. We would appreciate it if you were at least aware of this information before submitting code. @@ -571,16 +571,16 @@ URL="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming">ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming. When working with large amounts of code, the touchy subject of - copyrights also invariably comes up. Acceptable copyrights for + copyrights also invariably comes up. Acceptable copyrights for code included in FreeBSD are: - The BSD copyright. This copyright is most preferred due + The BSD copyright. This copyright is most preferred due to its “no strings attached” nature and general - attractiveness to commercial enterprises. Far from + attractiveness to commercial enterprises. Far from discouraging such commercial use, the FreeBSD Project actively encourages such participation by commercial interests who might eventually be inclined to invest @@ -588,13 +588,13 @@ - The GNU Public License, or “GPL”. This license is not + The GNU Public License, or “GPL”. This license is not quite as popular with us due to the amount of extra effort demanded of anyone using the code for commercial purposes, but given the sheer quantity of GPL'd code we currently require (compiler, assembler, text formatter, etc) it would be silly to refuse additional contributions under this - license. Code under the GPL also goes into a different part + license. Code under the GPL also goes into a different part of the tree, that being /sys/gnu or /usr/src/gnu, and is therefore easily identifiable to anyone for whom the GPL presents a @@ -606,7 +606,7 @@ Contributions coming under any other type of copyright must be carefully reviewed before their inclusion into FreeBSD will be - considered. Contributions for which particularly restrictive + considered. Contributions for which particularly restrictive commercial copyrights apply are generally rejected, though the authors are always encouraged to make such changes available through their own channels. @@ -670,7 +670,7 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. FreeBSD, Inc. was founded in early 1995 by &a.jkh; and &a.dg; with the goal of furthering the aims of the FreeBSD - Project and giving it a minimal corporate presence. Any and all + Project and giving it a minimal corporate presence. Any and all funds donated (as well as any profits that may eventually be realized by FreeBSD, Inc.) will be used exclusively to further the project's goals. @@ -709,7 +709,7 @@ box can be opened) If you do not wish to be listed in our donors section, please specify this - when making your donation. Thanks! + when making your donation. Thanks! @@ -731,9 +731,9 @@ box can be opened) Hardware for which ongoing compliance testing is - desired. We are currently trying to put together a testing + desired. We are currently trying to put together a testing lab of all components that FreeBSD supports so that proper - regression testing can be done with each new release. We + regression testing can be done with each new release. We are still lacking many important pieces (network cards, motherboards, etc) and if you would like to make such a donation, please contact &a.dg; for information on @@ -742,7 +742,7 @@ box can be opened) Hardware currently unsupported by FreeBSD for which - you would like to see such support added. Please contact + you would like to see such support added. Please contact the &a.core; before sending such items as we will need to find a developer willing to take on the task before we can accept delivery of new hardware. @@ -756,7 +756,7 @@ box can be opened) Donating Internet access - We can always use new mirror sites for FTP, WWW or cvsup. If + We can always use new mirror sites for FTP, WWW or cvsup. If you would like to be such a mirror, please contact the FreeBSD project administrators admin@FreeBSD.ORG for more information. @@ -965,7 +965,7 @@ box can be opened) - Ernst Winter ewinter@lobo.muc.de contributed a 2.88 MB floppy drive to the project. This will hopefully increase the pressure for rewriting the floppy disk driver. ;-) + Ernst Winter ewinter@lobo.muc.de contributed a 2.88 MB floppy drive to the project. This will hopefully increase the pressure for rewriting the floppy disk driver. ;-) @@ -973,7 +973,7 @@ box can be opened) Technologies sent one each of their DC-390, DC-390U and DC-390F FAST and ULTRA SCSI host adapter cards for regression testing of the NCR and AMD drivers - with their cards. They are also to be applauded for + with their cards. They are also to be applauded for making driver sources for free operating systems available from their FTP server ftp://ftp.tekram.com/scsi/FreeBSD. @@ -1011,12 +1011,12 @@ box can be opened) CDROM has donated almost more than we can say (see the history document for - more details). In particular, we would like to thank + more details). In particular, we would like to thank them for the original hardware used for freefall.FreeBSD.ORG, our primary development machine, and for thud.FreeBSD.ORG, a testing and - build box. We are also indebted to them for funding + build box. We are also indebted to them for funding various contributors over the years and providing us with unrestricted use of their T1 connection to the Internet. @@ -1110,7 +1110,7 @@ box can be opened) This software was originally derived from William F. Jolitz's 386BSD release 0.1, though almost none of the original 386BSD - specific code remains. This software has been essentially + specific code remains. This software has been essentially re-implemented from the 4.4BSD-Lite release provided by the Computer Science Research Group (CSRG) at the University of California, Berkeley and associated academic contributors. diff --git a/en_US.ISO8859-1/books/handbook/cutting-edge/chapter.sgml b/en_US.ISO8859-1/books/handbook/cutting-edge/chapter.sgml index a97ada4bd4..ff5c2b368f 100644 --- a/en_US.ISO8859-1/books/handbook/cutting-edge/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/cutting-edge/chapter.sgml @@ -1,10 +1,10 @@ The Cutting Edge: FreeBSD-current and FreeBSD-stable - FreeBSD is under constant development between releases. For + FreeBSD is under constant development between releases. For people who want to be on the cutting edge, there are several easy mechanisms for keeping your system in sync with the latest - developments. Be warned: the cutting edge is not for everyone! This + developments. Be warned: the cutting edge is not for everyone! This chapter will help you decide if you want to track the development system, or stick with one of the released versions. @@ -19,12 +19,12 @@ What is FreeBSD-current? FreeBSD-current is, quite literally, nothing more than a daily - snapshot of the working sources for FreeBSD. These include work + snapshot of the working sources for FreeBSD. These include work in progress, experimental changes and transitional mechanisms that may or may not be present in the next official release of the - software. While many of us compile almost daily from + software. While many of us compile almost daily from FreeBSD-current sources, there are periods of time when the - sources are literally un-compilable. These problems are generally + sources are literally un-compilable. These problems are generally resolved as expeditiously as possible, but whether or not FreeBSD-current sources bring disaster or greatly desired functionality can literally be a matter of which part of any given @@ -58,7 +58,7 @@ Peripheral members of the FreeBSD (or some other) group who merely wish to keep an eye on things and use the current sources for reference purposes (e.g. for - reading, not running). These people + reading, not running). These people also make the occasional comment or contribute code. @@ -83,7 +83,7 @@ - In any way “officially supported” by us. We do our + In any way “officially supported” by us. We do our best to help people genuinely in one of the 3 “legitimate” FreeBSD-current categories, but we simply do not have the time to provide tech support for it. @@ -108,13 +108,13 @@ - Join the &a.current; and the &a.cvsall; . This is not - just a good idea, it is essential. If + Join the &a.current; and the &a.cvsall; . This is not + just a good idea, it is essential. If you are not on the FreeBSD-current mailing list, you will not see the comments that people are making about the current state of the system and thus will probably end up stumbling over a lot of problems that others - have already found and solved. Even more importantly, you + have already found and solved. Even more importantly, you will miss out on important bulletins which may be critical to your system's continued health. @@ -131,28 +131,28 @@ subscribe freebsd-current subscribe cvs-all in the - body of your message. Optionally, you can also say help + body of your message. Optionally, you can also say help and Majordomo will send you full help on how to subscribe and unsubscribe to the various other mailing lists we support. - Grab the sources from ftp.FreeBSD.ORG. You can do + Grab the sources from ftp.FreeBSD.ORG. You can do this in three ways: Use the CTM - facility. Unless you have a good TCP/IP connection + facility. Unless you have a good TCP/IP connection at a flat rate, this is the way to do it. Use the cvsup program with this supfile. This is the second most recommended method, since it allows you to grab the entire collection once and then only what has changed from then on. Many people run cvsup from cron and keep their sources up-to-date automatically. For a fairly easy interface to this, simply type: + URL="ftp://ftp.FreeBSD.org/pub/FreeBSD/FreeBSD-current/src/share/examples/cvsup/standard-supfile">this supfile. This is the second most recommended method, since it allows you to grab the entire collection once and then only what has changed from then on. Many people run cvsup from cron and keep their sources up-to-date automatically. For a fairly easy interface to this, simply type: &prompt.root; pkg_add -f ftp://ftp.FreeBSD.org/pub/FreeBSD/development/CVSup/cvsupit.tgz @@ -162,9 +162,9 @@ subscribe cvs-all - Use ftp. The source tree for FreeBSD-current is + Use ftp. The source tree for FreeBSD-current is always “exported” on: ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-current We also use wu-ftpd which allows compressed/tar'd grabbing of whole trees. e.g. you see: + URL="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-current">ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-current We also use wu-ftpd which allows compressed/tar'd grabbing of whole trees. e.g. you see: usr.bin/lex @@ -188,20 +188,20 @@ subscribe cvs-all Essentially, if you need rapid on-demand access to the source and communications bandwidth is not a consideration, - use cvsup or ftp. Otherwise, use CTM. + use cvsup or ftp. Otherwise, use CTM. If you are grabbing the sources to run, and not just look at, then grab all of current, not - just selected portions. The reason for this is that various + just selected portions. The reason for this is that various parts of the source depend on updates elsewhere, and trying to compile just a subset is almost guaranteed to get you into trouble. Before compiling current, read the Makefile in - /usr/src carefully. You should at + /usr/src carefully. You should at least run a make world the first time - through as part of the upgrading process. Reading the + through as part of the upgrading process. Reading the &a.current; will keep you up-to-date on other bootstrapping procedures that sometimes become necessary as we move towards the next release. @@ -231,7 +231,7 @@ subscribe cvs-all FreeBSD-stable is our development branch for a more low-key and conservative set of changes intended for our next mainstream - release. Changes of an experimental or untested nature do not go + release. Changes of an experimental or untested nature do not go into this branch (see FreeBSD-current). @@ -241,7 +241,7 @@ subscribe cvs-all If you are a commercial user or someone who puts maximum stability of their FreeBSD system before all other concerns, you - should consider tracking stable. This is + should consider tracking stable. This is especially true if you have installed the most recent release (&rel.current;-RELEASE at the time of this writing) since the stable branch is effectively a bug-fix stream relative to the previous release. @@ -250,10 +250,10 @@ subscribe cvs-all The stable tree endeavors, above all, to be fully compilable and stable at all times, but we do occasionally make mistakes (these are still active sources with - quickly-transmitted updates, after all). We also do our best to + quickly-transmitted updates, after all). We also do our best to thoroughly test fixes in current before bringing them into stable, but sometimes - our tests fail to catch every case. If something breaks for you + our tests fail to catch every case. If something breaks for you in stable, please let us know immediately! (see next section). @@ -266,10 +266,10 @@ subscribe cvs-all - Join the &a.stable; . This will keep you informed of + Join the &a.stable; . This will keep you informed of build-dependencies that may appear in stable or any other issues requiring - special attention. Developers will also make announcements + special attention. Developers will also make announcements in this mailing list when they are contemplating some controversial fix or update, giving the users a chance to respond if they have any issues to raise concerning the @@ -288,7 +288,7 @@ subscribe freebsd-stable subscribe cvs-all in the - body of your message. Optionally, you can also say help + body of your message. Optionally, you can also say help and Majordomo will send you full help on how to subscribe and unsubscribe to the various other mailing lists we support. @@ -302,21 +302,21 @@ subscribe cvs-all If you are already running a previous release of 2.2 and wish to upgrade via sources then you can easily do so from ftp.FreeBSD.ORG. This can be done in one of + role="fqdn">ftp.FreeBSD.ORG. This can be done in one of three ways: Use the CTM - facility. Unless you have a good TCP/IP connection + facility. Unless you have a good TCP/IP connection at a flat rate, this is the way to do it. Use the cvsup program with this supfile. This is the second most recommended method, since it allows you to grab the entire collection once and then only what has changed from then on. Many people run cvsup from cron to keep their sources up-to-date automatically. For a fairly easy interface to this, simply type; + URL="ftp://ftp.FreeBSD.org/pub/FreeBSD/FreeBSD-current/src/share/examples/cvsup/stable-supfile">this supfile. This is the second most recommended method, since it allows you to grab the entire collection once and then only what has changed from then on. Many people run cvsup from cron to keep their sources up-to-date automatically. For a fairly easy interface to this, simply type; &prompt.root; pkg_add -f ftp://ftp.FreeBSD.org/pub/FreeBSD/development/CVSup/cvsupit.tgz @@ -324,12 +324,12 @@ subscribe cvs-all - Use ftp. The source tree for FreeBSD-stable is + Use ftp. The source tree for FreeBSD-stable is always “exported” on: ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-stable We also use wu-ftpd which allows - compressed/tar'd grabbing of whole trees. e.g. you + compressed/tar'd grabbing of whole trees. e.g. you see: @@ -355,15 +355,15 @@ subscribe cvs-all Essentially, if you need rapid on-demand access to the source and communications bandwidth is not a consideration, - use cvsup or ftp. Otherwise, use CTM. + use cvsup or ftp. Otherwise, use CTM. Before compiling stable, read the Makefile in - /usr/src carefully. You should at + /usr/src carefully. You should at least run a make world the first time - through as part of the upgrading process. Reading the + through as part of the upgrading process. Reading the &a.stable; will keep you up-to-date on other bootstrapping procedures that sometimes become necessary as we move towards the next release. @@ -383,46 +383,46 @@ subscribe cvs-all There are various ways of using an Internet (or email) connection to stay up-to-date with any given area of the FreeBSD - project sources, or all areas, depending on what interests you. The + project sources, or all areas, depending on what interests you. The primary services we offer are Anonymous CVS, CVSup, and CTM. Anonymous CVS and CVSup use the - pull model of updating sources. In the case of + pull model of updating sources. In the case of CVSup the user (or a cron script) invokes the cvsup program, and it interacts with a cvsupd server - somewhere to bring your files up to date. The updates you receive + somewhere to bring your files up to date. The updates you receive are up-to-the-minute and you get them when, and only when, you want - them. You can easily restrict your updates to the specific files or - directories that are of interest to you. Updates are generated on + them. You can easily restrict your updates to the specific files or + directories that are of interest to you. Updates are generated on the fly by the server, according to what you have and what you want - to have. Anonymous CVS is quite a bit more simplistic + to have. Anonymous CVS is quite a bit more simplistic than CVSup in that it's just an extension to CVS which allows it to pull changes directly from a remote CVS - repository. CVSup can do this far more + repository. CVSup can do this far more efficiently, but Anonymous CVS is easier to use. CTM, on the other hand, does not interactively compare the sources you have with those on the master - archive or otherwise pull them across.. Instead, a script which identifies changes in files since + archive or otherwise pull them across.. Instead, a script which identifies changes in files since its previous run is executed several times a day on the master CTM machine, any detected changes being compressed, stamped with a sequence-number and encoded for transmission over email (in printable - ASCII only). Once received, these “CTM deltas” can then be handed + ASCII only). Once received, these “CTM deltas” can then be handed to the ctm_rmail1 utility which will automatically decode, verify - and apply the changes to the user's copy of the sources. This + and apply the changes to the user's copy of the sources. This process is far more efficient than CVSup, and places less strain on our server resources since it is a push rather than a pull model. - There are other trade-offs, of course. If you inadvertently + There are other trade-offs, of course. If you inadvertently wipe out portions of your archive, CVSup will detect and rebuild the - damaged portions for you. CTM won't do this, and if you wipe some + damaged portions for you. CTM won't do this, and if you wipe some portion of your source tree out (and don't have it backed up) then you will have to start from scratch (from the most recent CVS “base delta”) and rebuild it all with CTM or, with anoncvs, simply @@ -442,9 +442,9 @@ subscribe cvs-all Anonymous CVS (or, as it is otherwise known, anoncvs) is a feature provided by the CVS utilities bundled with FreeBSD for synchronizing with a remote CVS - repository. Among other things, it allows users of FreeBSD to + repository. Among other things, it allows users of FreeBSD to perform, with no special privileges, read-only CVS operations - against one of the FreeBSD project's official anoncvs servers. To + against one of the FreeBSD project's official anoncvs servers. To use it, one simply sets the CVSROOT environment variable to point at the appropriate anoncvs server and then uses the @@ -457,7 +457,7 @@ subscribe cvs-all linkend="cvsup">CVSup and anoncvs services both perform essentially the same function, there are various trade-offs which can influence the user's choice of - synchronization methods. In a nutshell, + synchronization methods. In a nutshell, CVSup is much more efficient in its usage of network resources and is by far the most technically sophisticated of the two, but at a price. To use @@ -470,7 +470,7 @@ subscribe cvs-all Anoncvs, by contrast, can be used to examine anything from an individual file to a specific program (like ls or grep) by - referencing the CVS module name. Of course, + referencing the CVS module name. Of course, anoncvs is also only good for read-only operations on the CVS repository, so if it's your intention to support local development in one repository shared with the @@ -487,7 +487,7 @@ subscribe cvs-all to use an Anonymous CVS repository is a simple matter of setting the CVSROOT environment variable to point to one of the FreeBSD project's - anoncvs servers. At the time of this writing, + anoncvs servers. At the time of this writing, the following servers are available: @@ -506,11 +506,11 @@ subscribe cvs-all and what some of the permissible values for it in the FreeBSD Project repository are. - There are two kinds of tags, revision tags and branch tags. A - revision tag refers to a specific revision. Its meaning stays the - same from day to day. A branch tag, on the other hand, refers to + There are two kinds of tags, revision tags and branch tags. A + revision tag refers to a specific revision. Its meaning stays the + same from day to day. A branch tag, on the other hand, refers to the latest revision on a given line of development, at any given - time. Because a branch tag does not refer to a specific revision, + time. Because a branch tag does not refer to a specific revision, it may mean something different tomorrow than it means today. @@ -533,7 +533,7 @@ subscribe cvs-all The line of development for FreeBSD-3.x, also known as - FreeBSD-stable. Not valid for the ports collection. + FreeBSD-stable. Not valid for the ports collection. @@ -542,7 +542,7 @@ subscribe cvs-all The line of development for FreeBSD-2.2.x, also known as - 2.2-stable. Not valid for the ports collection. + 2.2-stable. Not valid for the ports collection. @@ -551,7 +551,7 @@ subscribe cvs-all The line of development for FreeBSD-2.1.x - this branch - is largely obsolete. Not valid for the ports + is largely obsolete. Not valid for the ports collection. @@ -574,7 +574,7 @@ subscribe cvs-all RELENG_2_2_5_RELEASE - FreeBSD-2.2.5. Not valid for the ports + FreeBSD-2.2.5. Not valid for the ports collection. @@ -583,7 +583,7 @@ subscribe cvs-all RELENG_2_2_2_RELEASE - FreeBSD-2.2.2. Not valid for the ports + FreeBSD-2.2.2. Not valid for the ports collection. @@ -592,7 +592,7 @@ subscribe cvs-all RELENG_2_2_1_RELEASE - FreeBSD-2.2.1. Not valid for the ports + FreeBSD-2.2.1. Not valid for the ports collection. @@ -601,7 +601,7 @@ subscribe cvs-all RELENG_2_2_0_RELEASE - FreeBSD-2.2.0. Not valid for the ports + FreeBSD-2.2.0. Not valid for the ports collection. @@ -610,7 +610,7 @@ subscribe cvs-all RELENG_2_1_7_RELEASE - FreeBSD-2.1.7. Not valid for the ports + FreeBSD-2.1.7. Not valid for the ports collection. @@ -619,7 +619,7 @@ subscribe cvs-all RELENG_2_1_6_1_RELEASE - FreeBSD-2.1.6.1. Not valid for the ports + FreeBSD-2.1.6.1. Not valid for the ports collection. @@ -628,7 +628,7 @@ subscribe cvs-all RELENG_2_1_6_RELEASE - FreeBSD-2.1.6. Not valid for the ports + FreeBSD-2.1.6. Not valid for the ports collection. @@ -637,7 +637,7 @@ subscribe cvs-all RELENG_2_1_5_RELEASE - FreeBSD-2.1.5. Not valid for the ports + FreeBSD-2.1.5. Not valid for the ports collection. @@ -646,14 +646,14 @@ subscribe cvs-all RELENG_2_1_0_RELEASE - FreeBSD-2.1.0. Not valid for the ports + FreeBSD-2.1.0. Not valid for the ports collection. When you specify a branch tag, you normally receive the latest - versions of the files on that line of development. If you wish to + versions of the files on that line of development. If you wish to receive some past version, you can do so by specifying a date with the flag. See the cvs @@ -744,13 +744,13 @@ subscribe cvs-all <application>CTM</application> - Contributed by &a.phk;. Updated + Contributed by &a.phk;. Updated 19-October-1997. CTM is a method for keeping a remote - directory tree in sync with a central one. It has been developed + directory tree in sync with a central one. It has been developed for usage with FreeBSD's source trees, though other people may - find it useful for other purposes as time goes by. Little, if + find it useful for other purposes as time goes by. Little, if any, documentation currently exists at this time on the process of creating deltas, so talk to &a.phk; for more information should you wish to use CTM for other things. @@ -760,24 +760,24 @@ subscribe cvs-all Why should I use <application>CTM</application>? CTM will give you a local copy of the - FreeBSD source trees. There are a number of “flavors” of the - tree available. Whether you wish to track the entire cvs tree or + FreeBSD source trees. There are a number of “flavors” of the + tree available. Whether you wish to track the entire cvs tree or just one of the branches, CTM can provide you - the information. If you are an active developer on FreeBSD, but + the information. If you are an active developer on FreeBSD, but have lousy or non-existent TCP/IP connectivity, or simply wish to have the changes automatically sent to you, - CTM was made for you. You will need to obtain + CTM was made for you. You will need to obtain up to three deltas per day for the most active branches. However, you should consider having them sent by automatic - email. The sizes of the updates are always kept as small as - possible. This is typically less than 5K, with an occasional + email. The sizes of the updates are always kept as small as + possible. This is typically less than 5K, with an occasional (one in ten) being 10-50K and every now and then a biggie of 100K+ or more coming around. You will also need to make yourself aware of the various caveats related to working directly from the development - sources rather than a pre-packaged release. This is particularly - true if you choose the “current” sources. It is recommended + sources rather than a pre-packaged release. This is particularly + true if you choose the “current” sources. It is recommended that you read Staying current with FreeBSD. @@ -804,7 +804,7 @@ subscribe cvs-all URL="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-current/src/usr.sbin/ctm">ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-current/src/usr.sbin/ctm The “deltas” you feed CTM can be had - two ways, FTP or e-mail. If you have general FTP access to the + two ways, FTP or e-mail. If you have general FTP access to the Internet then the following FTP sites support access to CTM: @@ -819,29 +819,29 @@ subscribe cvs-all If you may wish to get your deltas via email: Send email to &a.majordomo; to subscribe to one of the - CTM distribution lists. “ctm-cvs-cur” - supports the entire cvs tree. “ctm-src-cur” supports the head - of the development branch. “ctm-src-2_2” supports the 2.2 - release branch, etc. (If you do not know how to subscribe + CTM distribution lists. “ctm-cvs-cur” + supports the entire cvs tree. “ctm-src-cur” supports the head + of the development branch. “ctm-src-2_2” supports the 2.2 + release branch, etc. (If you do not know how to subscribe yourself using majordomo, send a message first containing the word help — it will send you back usage instructions.) When you begin receiving your CTM updates in the mail, you may use the ctm_rmail program - to unpack and apply them. You can actually use the + to unpack and apply them. You can actually use the ctm_rmail program directly from a entry in /etc/aliases if you want to have the - process run in a fully automated fashion. Check the + process run in a fully automated fashion. Check the ctm_rmail man page for more details. No matter what method you use to get the CTM deltas, you should subscribe to the - ctm-announce@FreeBSD.ORG mailing list. In the + ctm-announce@FreeBSD.ORG mailing list. In the future, this will be the only place where announcements concerning the operations of the CTM system - will be posted. Send an email to &a.majordomo; with a single + will be posted. Send an email to &a.majordomo; with a single line of subscribe ctm-announce to get added to the list. @@ -855,29 +855,29 @@ subscribe cvs-all you will need to get a to a starting point for the deltas produced subsequently to it. - First you should determine what you already have. Everyone - can start from an “empty” directory. You must use an + First you should determine what you already have. Everyone + can start from an “empty” directory. You must use an initial “Empty&rdquo delta to start off your - CTM supported tree. At some point it is + CTM supported tree. At some point it is intended that one of these “started” deltas be - distributed on the CD for your convenience. This does not + distributed on the CD for your convenience. This does not currently happen however. You can recognize However, since the trees are many tens of megabytes, you should prefer to start from - something already at hand. If you have a RELEASE CD, you can - copy or extract an initial source from it. This will save a + something already at hand. If you have a RELEASE CD, you can + copy or extract an initial source from it. This will save a significant transfer of data. You can recognize these “starter” deltas by the X appended to the number - (src-cur.3210XEmpty.gz for instance). The + (src-cur.3210XEmpty.gz for instance). The designation following the X - corresponds to the origin of your initial “seed”. Empty is - an empty directory. As a rule a base transition from + corresponds to the origin of your initial “seed”. Empty is + an empty directory. As a rule a base transition from Empty is produced - every 100 deltas. By the way, they are large! 25 to 30 + every 100 deltas. By the way, they are large! 25 to 30 Megabytes of gzip'ed data is common for the XEmpty deltas. @@ -901,7 +901,7 @@ However, since the trees need to gunzip them first, this saves disk space. Unless it feels very secure about the entire process, - CTM will not touch your tree. To verify a + CTM will not touch your tree. To verify a delta you can also use the flag and CTM will not actually touch your tree; it will merely verify the integrity of the delta and see if it @@ -916,13 +916,13 @@ However, since the trees make up my mind on what options should do what, how and when... - That's really all there is to it. Every time you get a new + That's really all there is to it. Every time you get a new delta, just run it through CTM to keep your sources up to date. Do not remove the deltas if they are hard to download again. You just might want to keep them around in case something bad - happens. Even if you only have floppy disks, consider using + happens. Even if you only have floppy disks, consider using fdwrite to make a copy. @@ -931,16 +931,16 @@ However, since the trees Keeping your local changes As a developer one would like to experiment with and change - files in the source tree. CTM supports local modifications in a + files in the source tree. CTM supports local modifications in a limited way: before checking for the presence of a file foo, it first looks for - foo.ctm. If this file exists, CTM will + foo.ctm. If this file exists, CTM will operate on it instead of foo. This behaviour gives us a simple way to maintain local changes: simply copy the files you plan to modify to the corresponding file names with a .ctm - suffix. Then you can freely hack the code, while CTM keeps the + suffix. Then you can freely hack the code, while CTM keeps the .ctm file up-to-date. @@ -998,7 +998,7 @@ However, since the trees For every file specified in a CTM delta, the and options - are applied in the order given on the command line. The file + are applied in the order given on the command line. The file is processed by CTM only if it is marked as eligible after all the and options are applied to it. @@ -1026,7 +1026,7 @@ However, since the trees The bad news is that I am very busy, so any help in doing - this will be most welcome. And do not forget to tell me what + this will be most welcome. And do not forget to tell me what you want also... @@ -1035,8 +1035,8 @@ However, since the trees Miscellaneous stuff All the “DES infected” (e.g. export controlled) source is - not included. You will get the “international” version only. - If sufficient interest appears, we will set up a sec-cur sequence too. There is a + not included. You will get the “international” version only. + If sufficient interest appears, we will set up a sec-cur sequence too. There is a sequence of deltas for the ports collection too, but interest has not been all that high yet. Tell me if you want an email list for that too and we will @@ -1106,28 +1106,28 @@ However, since the trees CVSup is a software package for distributing and updating source trees from a master CVS repository on a remote server - host. The FreeBSD sources are maintained in a CVS repository on - a central development machine in California. With CVSup, + host. The FreeBSD sources are maintained in a CVS repository on + a central development machine in California. With CVSup, FreeBSD users can easily keep their own source trees up to date. CVSup uses the so-called pull model of - updating. Under the pull model, each client asks the server for - updates, if and when they are wanted. The server waits - passively for update requests from its clients. Thus all - updates are instigated by the client. The server never sends - unsolicited updates. Users must either run the CVSup client + updating. Under the pull model, each client asks the server for + updates, if and when they are wanted. The server waits + passively for update requests from its clients. Thus all + updates are instigated by the client. The server never sends + unsolicited updates. Users must either run the CVSup client manually to get an update, or they must set up a cron job to run it automatically on a regular basis. The term CVSup, capitalized just so, refers to the entire - software package. Its main components are the client cvsup + software package. Its main components are the client cvsup which runs on each user's machine, and the server cvsupd which runs at each of the FreeBSD mirror sites. As you read the FreeBSD documentation and mailing lists, you - may see references to sup. Sup was the - predecessor of CVSup, and it served a similar purpose. CVSup is + may see references to sup. Sup was the + predecessor of CVSup, and it served a similar purpose. CVSup is in used in much the same way as sup and, in fact, uses configuration files which are backward-compatible with sup's. Sup is no longer used in the FreeBSD project, because CVSup is @@ -1145,15 +1145,15 @@ However, since the trees If you are running FreeBSD-2.1.6 or 2.1.7, you unfortunately cannot use the binary package versions due to the fact that they require a version of the C library that does not yet exist in - FreeBSD-2.1.{6,7}. You can easily use the port, however, just as with FreeBSD 2.2. Simply unpack the tar file, cd to the cvsup subdirectory and type make install. + FreeBSD-2.1.{6,7}. You can easily use the port, however, just as with FreeBSD 2.2. Simply unpack the tar file, cd to the cvsup subdirectory and type make install. Because CVSup is written in Modula-3, both the package and the port require that the Modula-3 runtime libraries be installed. These are available as the lang/modula-3-lib port and the lang/modula-3-lib-3.6 package. If you follow the same directions as for cvsup, these libraries will be compiled and/or installed automatically when you install the CVSup port or package. + URL="http://www.research.digital.com/SRC/modula-3/html/home.html">Modula-3, both the package and the port require that the Modula-3 runtime libraries be installed. These are available as the lang/modula-3-lib port and the lang/modula-3-lib-3.6 package. If you follow the same directions as for cvsup, these libraries will be compiled and/or installed automatically when you install the CVSup port or package. The Modula-3 libraries are rather large, and fetching and - compiling them is not an instantaneous process. For that - reason, a third option is provided. You can get + compiling them is not an instantaneous process. For that + reason, a third option is provided. You can get statically linked FreeBSD executables for CVSup from either the USA distribution site: @@ -1202,7 +1202,7 @@ However, since the trees - Most users will need only the client. These executables are + Most users will need only the client. These executables are entirely self-contained, and they will run on any version of FreeBSD from FreeBSD-2.1.0 to FreeBSD-current. @@ -1234,10 +1234,10 @@ However, since the trees Configuration CVSup's operation is controlled by a configuration file - called the supfile. Beginning with + called the supfile. Beginning with FreeBSD-2.2, there are some sample supfiles in the directory /usr/share/examples/cvsup. These examples are also available from ftp://ftp.FreeBSD.org/pub/FreeBSD/FreeBSD-current/src/share/examples/cvsup/ if you are on a pre-2.2 system. + URL="file:/usr/share/examples/cvsup">/usr/share/examples/cvsup. These examples are also available from ftp://ftp.FreeBSD.org/pub/FreeBSD/FreeBSD-current/src/share/examples/cvsup/ if you are on a pre-2.2 system. The information in a supfile answers the following questions for cvsup: @@ -1275,38 +1275,38 @@ However, since the trees In the following sections, we will construct a typical supfile by answering each of these - questions in turn. First, we describe the overall structure of + questions in turn. First, we describe the overall structure of a supfile. - A supfile is a text file. Comments - begin with # and extend to the end of the line. Lines that + A supfile is a text file. Comments + begin with # and extend to the end of the line. Lines that are blank and lines that contain only comments are ignored. Each remaining line describes a set of files that the user - wishes to receive. The line begins with the name of a + wishes to receive. The line begins with the name of a “collection”, a logical grouping of files defined by the server. The name of the collection tells the server which files you - want. After the collection name come zero or more fields, - separated by white space. These fields answer the questions - listed above. There are two types of fields: flag fields and - value fields. A flag field consists of a keyword standing - alone, e.g., delete or compress. A value field also begins + want. After the collection name come zero or more fields, + separated by white space. These fields answer the questions + listed above. There are two types of fields: flag fields and + value fields. A flag field consists of a keyword standing + alone, e.g., delete or compress. A value field also begins with a keyword, but the keyword is followed without intervening - white space by = and a second word. For example, + white space by = and a second word. For example, release=cvs is a value field. A supfile typically specifies more than - one collection to receive. One way to structure a + one collection to receive. One way to structure a supfile is to specify all of the relevant - fields explicitly for each collection. However, that tends to + fields explicitly for each collection. However, that tends to make the supfile lines quite long, and it is inconvenient because most fields are the same for all of the - collections in a supfile. CVSup provides a - defaulting mechanism to avoid these problems. Lines beginning + collections in a supfile. CVSup provides a + defaulting mechanism to avoid these problems. Lines beginning with the special pseudo-collection name *default can be used to set flags and values which will be used as defaults for the - subsequent collections in the supfile. A + subsequent collections in the supfile. A default value can be overridden for an individual collection, by specifying a different value with the collection itself. Defaults can also be changed or augmented in mid-supfile by @@ -1324,15 +1324,15 @@ However, since the trees Which files do you want to receive? The files available via CVSup are organized into named - groups called “collections”. The collections that are + groups called “collections”. The collections that are available are described here. In this example, we wish to receive the - entire main source tree for the FreeBSD system. There is + linkend="cvsup-collec">here. In this example, we wish to receive the + entire main source tree for the FreeBSD system. There is a single large collection src-all which will give us all of that, except the export-controlled cryptography - support. Let us assume for this example that we are in - the USA or Canada. Then we can get the cryptography code - with one additional collection, cvs-crypto. As a first + support. Let us assume for this example that we are in + the USA or Canada. Then we can get the cryptography code + with one additional collection, cvs-crypto. As a first step toward constructing our supfile, we simply list these collections, one per line: @@ -1345,30 +1345,30 @@ cvs-crypto Which version(s) of them do you want? With CVSup, you can receive virtually any version of - the sources that ever existed. That is possible because + the sources that ever existed. That is possible because the cvsupd server works directly from the CVS repository, - which contains all of the versions. You specify which one + which contains all of the versions. You specify which one of them you want using the tag= and value fields. Be very - careful to specify any tag= fields correctly. Some tags - are valid only for certain collections of files. If you + careful to specify any tag= fields correctly. Some tags + are valid only for certain collections of files. If you specify an incorrect or misspelled tag, CVSup will delete - files which you probably do not want deleted. In + files which you probably do not want deleted. In particular, use only tag=. for the ports-* collections. The tag= field names a symbolic tag in the - repository. There are two kinds of tags, revision tags - and branch tags. A revision tag refers to a specific - revision. Its meaning stays the same from day to day. A + repository. There are two kinds of tags, revision tags + and branch tags. A revision tag refers to a specific + revision. Its meaning stays the same from day to day. A branch tag, on the other hand, refers to the latest revision on a given line of development, at any given - time. Because a branch tag does not refer to a specific + time. Because a branch tag does not refer to a specific revision, it may mean something different tomorrow than it means today. @@ -1384,7 +1384,7 @@ cvs-crypto The . is not punctuation; it is the name - of the tag. Valid for all collections. + of the tag. Valid for all collections. @@ -1394,7 +1394,7 @@ cvs-crypto The line of development for FreeBSD-3.x, also known as - FreeBSD-stable. Not valid for the ports collection. + FreeBSD-stable. Not valid for the ports collection. @@ -1403,7 +1403,7 @@ cvs-crypto The line of development for FreeBSD-2.2.x, also known as - 2.2-stable. Not valid for the ports collection. + 2.2-stable. Not valid for the ports collection. @@ -1411,7 +1411,7 @@ cvs-crypto The line of development for FreeBSD-2.1.x - - this branch is largely obsolete. Not valid for the + this branch is largely obsolete. Not valid for the ports-* collections. @@ -1428,7 +1428,7 @@ cvs-crypto tag=RELENG_3_0_0_RELEASE - FreeBSD-3.0. Not valid for the ports-* + FreeBSD-3.0. Not valid for the ports-* collections. @@ -1437,7 +1437,7 @@ cvs-crypto tag=RELENG_2_2_8_RELEASE - FreeBSD-2.2.8. Not valid for the ports-* + FreeBSD-2.2.8. Not valid for the ports-* collections. @@ -1446,14 +1446,14 @@ cvs-crypto tag=RELENG_2_2_7_RELEASE - FreeBSD-2.2.7. Not valid for the ports-* + FreeBSD-2.2.7. Not valid for the ports-* collections. tag=RELENG_2_2_6_RELEASE - FreeBSD-2.2.6. Not valid for the ports-* + FreeBSD-2.2.6. Not valid for the ports-* collections. @@ -1462,7 +1462,7 @@ cvs-crypto tag=RELENG_2_2_5_RELEASE - FreeBSD-2.2.5. Not valid for the ports-* + FreeBSD-2.2.5. Not valid for the ports-* collections. @@ -1471,7 +1471,7 @@ cvs-crypto tag=RELENG_2_2_2_RELEASE - FreeBSD-2.2.2. Not valid for the ports-* + FreeBSD-2.2.2. Not valid for the ports-* collections. @@ -1480,7 +1480,7 @@ cvs-crypto tag=RELENG_2_2_1_RELEASE - FreeBSD-2.2.1. Not valid for the ports-* + FreeBSD-2.2.1. Not valid for the ports-* collections. @@ -1489,7 +1489,7 @@ cvs-crypto tag=RELENG_2_2_0_RELEASE - FreeBSD-2.2.0. Not valid for the ports-* + FreeBSD-2.2.0. Not valid for the ports-* collections. @@ -1498,7 +1498,7 @@ cvs-crypto tag=RELENG_2_1_7_RELEASE - FreeBSD-2.1.7. Not valid for the ports-* + FreeBSD-2.1.7. Not valid for the ports-* collections. @@ -1507,7 +1507,7 @@ cvs-crypto tag=RELENG_2_1_6_1_RELEASE - FreeBSD-2.1.6.1. Not valid for the ports-* + FreeBSD-2.1.6.1. Not valid for the ports-* collections. @@ -1516,7 +1516,7 @@ cvs-crypto tag=RELENG_2_1_6_RELEASE - FreeBSD-2.1.6. Not valid for the ports-* + FreeBSD-2.1.6. Not valid for the ports-* collections. @@ -1525,7 +1525,7 @@ cvs-crypto tag=RELENG_2_1_5_RELEASE - FreeBSD-2.1.5. Not valid for the ports-* + FreeBSD-2.1.5. Not valid for the ports-* collections. @@ -1534,7 +1534,7 @@ cvs-crypto tag=RELENG_2_1_0_RELEASE - FreeBSD-2.1.0. Not valid for the ports-* + FreeBSD-2.1.0. Not valid for the ports-* collections. @@ -1544,19 +1544,19 @@ cvs-crypto Be very - careful to type the tag name exactly as shown. CVSup - cannot distinguish between valid and invalid tags. If you + careful to type the tag name exactly as shown. CVSup + cannot distinguish between valid and invalid tags. If you misspell the tag, CVSup will behave as though you had specified a valid tag which happens to refer to no files - at all. It will delete your existing sources in that + at all. It will delete your existing sources in that case. When you specify a branch tag, you normally receive the latest versions of the files on that line of - development. If you wish to receive some past version, + development. If you wish to receive some past version, you can do so by specifying a date with the value - field. The cvsup1 manual page explains how to do + field. The cvsup1 manual page explains how to do that. For our example, we wish to receive FreeBSD-current. @@ -1569,13 +1569,13 @@ cvs-crypto There is an important special case that comes into play if you specify neither a tag= field nor a date= - field. In that case, you receive the actual RCS files + field. In that case, you receive the actual RCS files directly from the server's CVS repository, rather than - receiving a particular version. Developers generally - prefer this mode of operation. By maintaining a copy of + receiving a particular version. Developers generally + prefer this mode of operation. By maintaining a copy of the repository itself on their systems, they gain the ability to browse the revision histories and examine past - versions of files. This gain is achieved at a large cost + versions of files. This gain is achieved at a large cost in terms of disk space, however. @@ -1583,17 +1583,17 @@ cvs-crypto Where do you want to get them from? We use the host= field to tell cvsup where to obtain - its updates. Any of the CVSup mirror sites will do, though you should try to select - one that is close to you in cyberspace. In this example we + one that is close to you in cyberspace. In this example we will use a fictional FreeBSD distribution site, cvsup666.FreeBSD.org: *default host=cvsup666.FreeBSD.org You will need to change the host to one that actually -exists before running CVSup. On any particular run of +exists before running CVSup. On any particular run of cvsup, you can override the host setting on the command line, with . @@ -1603,8 +1603,8 @@ exists before running CVSup. On any particular run of machine? The prefix= field tells cvsup where to put the files - it receives. In this example, we will put the source files - directly into our main source tree, /usr/src. The src + it receives. In this example, we will put the source files + directly into our main source tree, /usr/src. The src directory is already implicit in the collections we have chosen to receive, so this is the correct specification: @@ -1617,9 +1617,9 @@ exists before running CVSup. On any particular run of Where should cvsup maintain its status files? The cvsup client maintains certain status files in - what is called the “base” directory. These files help + what is called the “base” directory. These files help CVSup to work more efficiently, by keeping track of which - updates you have already received. We will use the + updates you have already received. We will use the standard base directory, /usr/local/etc/cvsup: @@ -1630,7 +1630,7 @@ exists before running CVSup. On any particular run of need the above line. If your base directory does not already exist, now - would be a good time to create it. The cvsup client will + would be a good time to create it. The cvsup client will refuse to run if the base directory does not exist. @@ -1644,24 +1644,24 @@ exists before running CVSup. On any particular run of *default release=cvs delete use-rel-suffix compress release=cvs indicates that the server should get its - information out of the main FreeBSD CVS repository. This + information out of the main FreeBSD CVS repository. This is virtually always the case, but there are other possibilities which are beyond the scope of this discussion. - delete gives CVSup permission to delete files. You + delete gives CVSup permission to delete files. You should always specify this, so that CVSup can keep your - source tree fully up to date. CVSup is careful to delete - only those files for which it is responsible. Any extra + source tree fully up to date. CVSup is careful to delete + only those files for which it is responsible. Any extra files you happen to have will be left strictly alone. - use-rel-suffix is ... arcane. If you really want to - know about it, see the cvsup1 manual page. Otherwise, + use-rel-suffix is ... arcane. If you really want to + know about it, see the cvsup1 manual page. Otherwise, just specify it and do not worry about it. compress enables the use of gzip-style compression - on the communication channel. If your network link is T1 + on the communication channel. If your network link is T1 speed or faster, you probably should not use compression. Otherwise, it helps substantially. @@ -1691,7 +1691,7 @@ cvs-crypto Running <application>CVSup</application> - You are now ready to try an update. The command line for + You are now ready to try an update. The command line for doing this is quite simple: @@ -1699,17 +1699,17 @@ cvs-crypto where supfile is of course the name of the supfile you - have just created. Assuming you are running under X11, cvsup + have just created. Assuming you are running under X11, cvsup will display a GUI window with some buttons to do the usual - things. Press the “go” button, and watch it run. + things. Press the “go” button, and watch it run. Since you are updating your actual /usr/src tree in this example, you will need to run the program as root so that cvsup - has the permissions it needs to update your files. Having just + has the permissions it needs to update your files. Having just created your configuration file, and having never used this program before, that might understandably make you nervous. There is an easy way to do a trial run without touching your - precious files. Just create an empty directory somewhere + precious files. Just create an empty directory somewhere convenient, and name it as an extra argument on the command line: @@ -1719,13 +1719,13 @@ cvs-crypto The directory you specify will be used as the destination - directory for all file updates. CVSup will examine your usual + directory for all file updates. CVSup will examine your usual files in /usr/src, but it will not modify - or delete any of them. Any file updates will instead land in - /var/tmp/dest/usr/src. CVSup will also + or delete any of them. Any file updates will instead land in + /var/tmp/dest/usr/src. CVSup will also leave its base directory status files untouched when run this - way. The new versions of those files will be written into the - specified directory. As long as you have read access to + way. The new versions of those files will be written into the + specified directory. As long as you have read access to /usr/src, you do not even need to be root to perform this kind of trial run. @@ -1737,21 +1737,21 @@ cvs-crypto &prompt.root; cvsup -g -L 2 supfile - The tells cvsup not to use its GUI. This is automatic + The tells cvsup not to use its GUI. This is automatic if you are not running X11, but otherwise you have to specify it. The tells cvsup to print out the details of all the - file updates it is doing. There are three levels of verbosity, - from to . The default is 0, which means total + file updates it is doing. There are three levels of verbosity, + from to . The default is 0, which means total silence except for error messages. - There are plenty of other options available. For a brief - list of them, type cvsup -H. For more detailed descriptions, + There are plenty of other options available. For a brief + list of them, type cvsup -H. For more detailed descriptions, see the manual page. Once you are satisfied with the way updates are working, you - can arrange for regular runs of cvsup using cron8. Obviously, + can arrange for regular runs of cvsup using cron8. Obviously, you should not let cvsup use its GUI when running it from cron. @@ -1761,14 +1761,14 @@ cvs-crypto <application>CVSup</application> File Collections The file collections available via CVSup are organized - hierarchically. There are a few large collections, and they are - divided into smaller sub-collections. Receiving a large + hierarchically. There are a few large collections, and they are + divided into smaller sub-collections. Receiving a large collection is equivalent to receiving each of its - sub-collections. The hierarchical relationships among + sub-collections. The hierarchical relationships among collections are reflected by the use of indentation in the list below. - The most commonly used collections are src-all, cvs-crypto, and ports-all. The other collections are used + The most commonly used collections are src-all, cvs-crypto, and ports-all. The other collections are used only by small groups of people for specialized purposes, and some mirror sites may not carry all of them. @@ -2451,7 +2451,7 @@ cvs-crypto release=self - The CVSup server's own configuration files. Used by + The CVSup server's own configuration files. Used by CVSup mirror sites. @@ -2479,7 +2479,7 @@ cvs-crypto release=current - The installed World Wide Web data. Used by WWW + The installed World Wide Web data. Used by WWW mirror sites. @@ -2497,7 +2497,7 @@ cvs-crypto Page. Most FreeBSD-related discussion of CVSup takes place on the - &a.hackers;. New versions of the software are announced there, + &a.hackers;. New versions of the software are announced there, as well as on the &a.announce;. Questions and bug reports should be addressed to the author diff --git a/en_US.ISO8859-1/books/handbook/disks/chapter.sgml b/en_US.ISO8859-1/books/handbook/disks/chapter.sgml index 1bfe3b074c..abf4234f94 100644 --- a/en_US.ISO8859-1/books/handbook/disks/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/disks/chapter.sgml @@ -4,84 +4,84 @@ Contributed by &a.obrien; 26 April 1998 Lets say we want to add a new SCSI disk to a machine that currently - only has a single drive. First turn off the computer and install the + only has a single drive. First turn off the computer and install the drive in the computer following the instructions of the computer, - controller, and drive manufacturer. Due the wide variations of procedures + controller, and drive manufacturer. Due the wide variations of procedures to do this, the details are beyond the scope of this document. - Login as user root. After you've installed the + Login as user root. After you've installed the drive, inspect /var/run/dmesg.boot to ensure the new - disk was found. Continuing with our example, the newly added drive will be + disk was found. Continuing with our example, the newly added drive will be sd1 and we want to mount it on - /1. (if you are adding an IDE drive substitute + /1. (if you are adding an IDE drive substitute wd for sd) Because FreeBSD runs on IBM-PC compatible computers, it must take into - account the PC BIOS partitions. These are different from the traditional - BSD partitions. A PC disk has up to four BIOS partition entries. If the + account the PC BIOS partitions. These are different from the traditional + BSD partitions. A PC disk has up to four BIOS partition entries. If the disk is going to be truly dedicated to FreeBSD, you can use the - dedicated mode. Otherwise, FreeBSD will have to live - with in one of the PC BIOS partitions. FreeBSD calls the PC BIOS + dedicated mode. Otherwise, FreeBSD will have to live + with in one of the PC BIOS partitions. FreeBSD calls the PC BIOS partitions, slices so as not to confuse them with - traditional BSD partitions. You may also use slices on a disk that is + traditional BSD partitions. You may also use slices on a disk that is dedicated to FreeBSD, but used in a computer that also has another - operating system installed. This is to not confuse the + operating system installed. This is to not confuse the fdisk utility of the other operating system. In the slice case the drive will be added as - /dev/sd1s1e. This is read as: SCSI disk, unit number + /dev/sd1s1e. This is read as: SCSI disk, unit number 1 (second SCSI disk), slice 1 (PC BIOS partition 1), and - e BSD partition. In the dedicated case, the drive + e BSD partition. In the dedicated case, the drive will be added simply as /dev/sd1e. Using sysinstall You may use /stand/sysinstall to partition and - label a new disk using its easy to use menus. Either login as user - root or use the su command. Run + label a new disk using its easy to use menus. Either login as user + root or use the su command. Run /stand/sysinstall and enter the - Configure menu. With in the FreeBSD + Configure menu. With in the FreeBSD Configuration Menu, scroll down and select the - Partition item. Next you should be presented with a - list of hard drives installed in your system. If you do not see + Partition item. Next you should be presented with a + list of hard drives installed in your system. If you do not see sd1 listed, you need to recheck your physical installation and dmesg output in the file /var/run/dmesg.boot. Select sd1 to enter the FDISK Partition - Editor. Choose A to use the entire disk - for FreeBSD. When asked if you want to remain cooperative with + Editor. Choose A to use the entire disk + for FreeBSD. When asked if you want to remain cooperative with any future possible operating systems, answer - YES. Write the changes to the disk using - W. Now exit the FDISK editor using - q. Next you will be asked about the Master Boot - Record. Since you are adding a disk to an already running system, choose + YES. Write the changes to the disk using + W. Now exit the FDISK editor using + q. Next you will be asked about the Master Boot + Record. Since you are adding a disk to an already running system, choose None. - Next enter the Disk Label Editor. This is where - you will create the traditional BSD partitions. A disk can have up to - eight partitions, labeled a-h. A few of the partition labels have - special uses. The a partition is used for the root - partition (/). Thus only your system disk (e.g, the - disk you boot from) should have an a partition. The + Next enter the Disk Label Editor. This is where + you will create the traditional BSD partitions. A disk can have up to + eight partitions, labeled a-h. A few of the partition labels have + special uses. The a partition is used for the root + partition (/). Thus only your system disk (e.g, the + disk you boot from) should have an a partition. The b partition is used for swap partitions, and you may - have many disks with swap partitions. The c partition + have many disks with swap partitions. The c partition addresses the entire disk in dedicated mode, or the entire FreeBSD slice - in slice mode. The other partitions are for general use. + in slice mode. The other partitions are for general use. Sysinstall's Label editor favors the e partition - for non-root, non-swap partitions. With in the Label editor, create a - single file system using C. When prompted if this + for non-root, non-swap partitions. With in the Label editor, create a + single file system using C. When prompted if this will be a FS (file system) or swap, choose FS and - give a mount point (e.g, /mnt). When adding a disk + give a mount point (e.g, /mnt). When adding a disk in post-install mode, Sysinstall will not create entries in /etc/fstab for you, so the mount point you specify isn't important. You are now ready to write the new label to the disk and create a - file system on it. Do this by hitting W. Ignore any - errors from Sysinstall that it could not mount the new partition. Exit + file system on it. Do this by hitting W. Ignore any + errors from Sysinstall that it could not mount the new partition. Exit the Label Editor and Sysinstall completely. The last step is to edit /etc/fstab to add an @@ -101,9 +101,9 @@ Dedicated If you will not be sharing the new drive with another operating - system, you may use the dedicated mode. Remember + system, you may use the dedicated mode. Remember this mode can confuse Microsoft operating systems; however, no damage - will be done by them. IBM's OS/2 however, will + will be done by them. IBM's OS/2 however, will “appropriate” any partition it finds which it doesn't understand. diff --git a/en_US.ISO8859-1/books/handbook/eresources/chapter.sgml b/en_US.ISO8859-1/books/handbook/eresources/chapter.sgml index 5346c92816..83b09ef7a0 100644 --- a/en_US.ISO8859-1/books/handbook/eresources/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/eresources/chapter.sgml @@ -4,15 +4,15 @@ Contributed by &a.jkh;. The rapid pace of FreeBSD progress makes print media impractical - as a means of following the latest developments. Electronic resources + as a means of following the latest developments. Electronic resources are the best, if not often the only, way stay informed of the latest - advances. Since FreeBSD is a volunteer effort, the user community + advances. Since FreeBSD is a volunteer effort, the user community itself also generally serves as a “technical support department” of sorts, with electronic mail and USENET news being the most effective way of reaching that community. The most important points of contact with the FreeBSD user - community are outlined below. If you are aware of other resources not + community are outlined below. If you are aware of other resources not mentioned here, please send them to the &a.doc;so that they may also be included. @@ -23,14 +23,14 @@ Though many of the FreeBSD development members read USENET, we cannot always guarantee that we will get to your questions in a timely fashion (or at all) if you post them only to one of the - comp.unix.bsd.freebsd.* groups. By addressing your questions to the + comp.unix.bsd.freebsd.* groups. By addressing your questions to the appropriate mailing list you will reach both us and a concentrated FreeBSD audience, invariably assuring a better (or at least faster) response. The charters for the various lists are given at the bottom of - this document. Please read the charter before - joining or sending mail to any list. Most of our list + this document. Please read the charter before + joining or sending mail to any list. Most of our list subscribers now receive many hundreds of FreeBSD related messages every day, and by setting down charters and rules for proper use we are striving to keep the signal-to-noise ratio of the lists high. @@ -40,7 +40,7 @@ Archives are kept for all of the mailing lists and can be searched using the FreeBSD World Wide Web - server. The keyword searchable archive offers an + server. The keyword searchable archive offers an excellent way of finding answers to frequently asked questions and should be consulted before posting a question. @@ -121,7 +121,7 @@ Technical lists: The following - lists are for technical discussion. You should read the charter + lists are for technical discussion. You should read the charter for each list carefully before joining or sending mail to one as there are firm guidelines for their use and content. @@ -252,7 +252,7 @@ Limited lists: The following lists require approval from core@FreeBSD.ORG to join, though anyone is free to send messages to them which fall within - the scope of their charters. It is also a good idea establish a + the scope of their charters. It is also a good idea establish a presence in the technical lists before asking to join one of these limited lists. @@ -307,7 +307,7 @@ CVS lists: The following lists are for people interested in seeing the log messages for changes - to various areas of the source tree. They are Read-Only lists and should not have mail + to various areas of the source tree. They are Read-Only lists and should not have mail sent to them. @@ -336,7 +336,7 @@ All mailing lists live on FreeBSD.ORG, so to post to a given list you simply mail to - listname@FreeBSD.ORG. It will + listname@FreeBSD.ORG. It will then be redistributed to mailing list members world-wide. To subscribe to a list, send mail to &a.majordomo; and include @@ -344,7 +344,7 @@ subscribe <listname> [<optional address>] - in the body of your message. For example, to + in the body of your message. For example, to subscribe yourself to freebsd-announce, you'd do: @@ -368,7 +368,7 @@ subscribe freebsd-announce local-announce@somesite.com Finally, it is also possible to unsubscribe yourself from a list, get a list of other list members or see the list of mailing lists again by sending other types of control - messages to majordomo. For a complete list of available commands, + messages to majordomo. For a complete list of available commands, do this: @@ -407,9 +407,9 @@ help The topic of any posting should adhere to the basic charter of the list it is posted to, e.g. if the list is about technical issues then your posting should contain - technical discussion. Ongoing irrelevant chatter or flaming + technical discussion. Ongoing irrelevant chatter or flaming only detracts from the value of the mailing list for - everyone on it and will not be tolerated. For free-form + everyone on it and will not be tolerated. For free-form discussion on no particular topic, the freebsd-chat freebsd-chat@freebsd.org mailing list is freely available and should be used instead. @@ -418,13 +418,13 @@ help No posting should be made to more than 2 mailing lists, and only to 2 when a clear and obvious need to post to both - lists exists. For most lists, there is already a great deal + lists exists. For most lists, there is already a great deal of subscriber overlap and except for the most esoteric mixes (say "-stable & -scsi"), there really is no reason to - post to more than one list at a time. If a message is sent + post to more than one list at a time. If a message is sent to you in such a way that multiple mailing lists appear on the Cc line then the cc line should also be trimmed before - sending it out again. You are still responsible for your own + sending it out again. You are still responsible for your own cross-postings, no matter who the originator might have been. @@ -432,10 +432,10 @@ help Personal attacks and profanity (in the context of an argument) are not allowed, and that includes users and - developers alike. Gross breaches of netiquette, like + developers alike. Gross breaches of netiquette, like excerpting or reposting private mail when permission to do so was not and would not be forthcoming, are frowned upon - but not specifically enforced. However, there are also very few cases + but not specifically enforced. However, there are also very few cases where such content would fit within the charter of a list and it would therefore probably rate a warning (or ban) on that basis alone. @@ -470,7 +470,7 @@ help This list is purely for discussion of freebsd.org related issues and to report problems or abuse of project - resources. It is a closed list, though anyone may report + resources. It is a closed list, though anyone may report a problem (with our systems!) to it. @@ -484,8 +484,8 @@ help This is the mailing list for people interested only in occasional announcements of significant FreeBSD events. This includes announcements about snapshots and other - releases. It contains announcements of new FreeBSD - capabilities. It may contain calls for volunteers etc. + releases. It contains announcements of new FreeBSD + capabilities. It may contain calls for volunteers etc. This is a low volume, strictly moderated mailing list. @@ -498,10 +498,10 @@ help discussions This is a moderated list for discussion of FreeBSD - architecture. Messages will mostly be kept technical in + architecture. Messages will mostly be kept technical in nature, with (rare) exceptions for other messages the moderator deems need to reach all the subscribers of the - list. Examples of suitable topics; + list. Examples of suitable topics; @@ -527,7 +527,7 @@ help The moderator reserves the right to do minor editing (spell-checking, grammar correction, trimming) of messages - that are posted to the list. The volume of the list will be + that are posted to the list. The volume of the list will be kept low, which may involve having to delay topics until an active discussion has been resolved. @@ -555,11 +555,11 @@ help This list contains the overflow from the other lists about non-technical, social - information. It includes discussion about whether Jordan + information. It includes discussion about whether Jordan looks like a toon ferret or not, whether or not to type in capitals, who is drinking too much coffee, where the best beer is brewed, who is brewing beer in their basement, and - so on. Occasional announcements of important events (such + so on. Occasional announcements of important events (such as upcoming parties, weddings, births, new jobs, etc) can be made to the technical lists, but the follow ups should be directed to this -chat list. @@ -572,7 +572,7 @@ help FreeBSD core team This is an internal mailing list for use by the core - members. Messages can be sent to it when a serious + members. Messages can be sent to it when a serious FreeBSD-related matter requires arbitration or high-level scrutiny. @@ -585,11 +585,11 @@ help FreeBSD-current This is the - mailing list for users of freebsd-current. It includes + mailing list for users of freebsd-current. It includes warnings about new features coming out in -current that will affect the users, and instructions on steps that must - be taken to remain -current. Anyone running “current” must - subscribe to this list. This is a technical mailing list + be taken to remain -current. Anyone running “current” must + subscribe to this list. This is a technical mailing list for which strictly technical content is expected. @@ -601,10 +601,10 @@ help FreeBSD-current This is the - digest version of the freebsd-current mailing list. The + digest version of the freebsd-current mailing list. The digest consists of all messages sent to freebsd-current - bundled together and mailed out as a single message. The - average digest size is about 40kB. This list is Read-Only and should not be posted + bundled together and mailed out as a single message. The + average digest size is about 40kB. This list is Read-Only and should not be posted to. @@ -616,9 +616,9 @@ help This mailing list is for the discussion of issues and projects related to the creation of documenation for - FreeBSD. The members of this mailing list are collectively + FreeBSD. The members of this mailing list are collectively referred to as “The FreeBSD Documentation - Project”. It is an open list; feel free to join and + Project”. It is an open list; feel free to join and contribute! @@ -628,7 +628,7 @@ help Filesystems - Discussions concerning FreeBSD filesystems. This is a + Discussions concerning FreeBSD filesystems. This is a technical mailing list for which strictly technical content is expected. @@ -662,11 +662,11 @@ help Technical discussions This is a forum for technical discussions related to - FreeBSD. This is the primary technical mailing list. It + FreeBSD. This is the primary technical mailing list. It is for individuals actively working on FreeBSD, to bring - up problems or discuss alternative solutions. Individuals + up problems or discuss alternative solutions. Individuals interested in following the technical discussion are also - welcome. This is a technical mailing list for which + welcome. This is a technical mailing list for which strictly technical content is expected. @@ -677,9 +677,9 @@ help Technical discussions This is the digest version of the freebsd-hackers - mailing list. The digest consists of all messages sent to + mailing list. The digest consists of all messages sent to freebsd-hackers bundled together and mailed out as a - single message. The average digest size is about 40kB. + single message. The average digest size is about 40kB. This list is Read-Only and should not be posted to. @@ -717,7 +717,7 @@ help This mailing list is for discussing topics relevant to Internet Service - Providers (ISPs) using FreeBSD. This is a technical + Providers (ISPs) using FreeBSD. This is a technical mailing list for which strictly technical content is expected. @@ -735,7 +735,7 @@ help and asking for help elsewhere, how to use mailing lists and which lists to use, general chat, making mistakes, boasting, sharing ideas, stories, moral (but not technical) support, and - taking an active part in the FreeBSD community. We take our + taking an active part in the FreeBSD community. We take our problems and support questions to freebsd-questions, and use freebsd-newbies to meet others who are doing the same things that we do as newbies. @@ -750,7 +750,7 @@ help Cross-platform freebsd issues, general discussion and proposals for non-Intel - FreeBSD ports. This is a technical mailing list for which + FreeBSD ports. This is a technical mailing list for which strictly technical content is expected. @@ -764,7 +764,7 @@ help Discussions concerning FreeBSD's “ports collection” (/usr/ports), proposed ports, modifications to ports collection infrastructure and general coordination - efforts. This is a technical mailing list for which + efforts. This is a technical mailing list for which strictly technical content is expected. @@ -775,7 +775,7 @@ help User questions This - is the mailing list for questions about FreeBSD. You + is the mailing list for questions about FreeBSD. You should not send “how to” questions to the technical lists unless you consider the question to be pretty technical. @@ -789,9 +789,9 @@ help This is the digest version of the freebsd-questions mailing - list. The digest consists of all messages sent to + list. The digest consists of all messages sent to freebsd-questions bundled together and mailed out as a - single message. The average digest size is about + single message. The average digest size is about 40kB. @@ -803,7 +803,7 @@ help This is the mailing list for people working on the scsi - subsystem for FreeBSD. This is a technical mailing list + subsystem for FreeBSD. This is a technical mailing list for which strictly technical content is expected. @@ -814,7 +814,7 @@ help Security issues FreeBSD computer security issues (DES, Kerberos, known - security holes and fixes, etc). This is a technical + security holes and fixes, etc). This is a technical mailing list for which strictly technical content is expected. @@ -825,7 +825,7 @@ help Security Notifications Notifications of FreeBSD security problems and fixes. - This is not a discussion list. The discussion list is + This is not a discussion list. The discussion list is FreeBSD-security. @@ -835,7 +835,7 @@ help This list discusses topics related to unsually small and - embedded FreeBSD installations. This is a technical mailing + embedded FreeBSD installations. This is a technical mailing list for which strictly technical content is expected. @@ -847,11 +847,11 @@ help FreeBSD-stable This is the - mailing list for users of freebsd-stable. It includes + mailing list for users of freebsd-stable. It includes warnings about new features coming out in -stable that will affect the users, and instructions on steps that must - be taken to remain -stable. Anyone running “stable” - should subscribe to this list. This is a technical mailing + be taken to remain -stable. Anyone running “stable” + should subscribe to this list. This is a technical mailing list for which strictly technical content is expected. @@ -866,9 +866,9 @@ help This is the mailing list for the coordinators from each of the local area Users Groups to discuss matters with each other and a designated individual from the Core - Team. This mail list should be limited to meeting + Team. This mail list should be limited to meeting synopsis and coordination of projects that span User - Groups. It is a closed list. + Groups. It is a closed list. @@ -882,7 +882,7 @@ help In addition to two FreeBSD specific newsgroups, there are many others in which FreeBSD is discussed or are otherwise relevant to - FreeBSD users. Keyword searchable archives are available for some of these newsgroups from courtesy of Warren Toomey wkt@cs.adfa.oz.au. diff --git a/en_US.ISO8859-1/books/handbook/hw/chapter.sgml b/en_US.ISO8859-1/books/handbook/hw/chapter.sgml index 9397bbcfee..2a12526c35 100644 --- a/en_US.ISO8859-1/books/handbook/hw/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/hw/chapter.sgml @@ -3,26 +3,26 @@ Issues of hardware compatibility are among the most troublesome in the computer industry today and FreeBSD is by no means immune to - trouble. In this respect, FreeBSD's advantage of being able to run on + trouble. In this respect, FreeBSD's advantage of being able to run on inexpensive commodity PC hardware is also its liability when it comes - to support for the amazing variety of components on the market. While + to support for the amazing variety of components on the market. While it would be impossible to provide a exhaustive listing of hardware that FreeBSD supports, this section serves as a catalog of the device drivers included with FreeBSD and the hardware each drivers supports. Where possible and appropriate, notes about specific products are - included. You may also want to refer to the kernel configuration file section in this handbook for a list of supported devices. As FreeBSD is a volunteer project without a funded testing department, we depend on you, the user, for much of the information - contained in this catalog. If you have direct experience of hardware + contained in this catalog. If you have direct experience of hardware that does or does not work with FreeBSD, please let us know by sending - e-mail to the &a.doc;. Questions about supported hardware should be + e-mail to the &a.doc;. Questions about supported hardware should be directed to the &a.questions; (see Mailing Lists for more - information). When submitting information or asking a question, + information). When submitting information or asking a question, please remember to specify exactly what version of FreeBSD you are using and include as many details of your hardware as possible. @@ -33,7 +33,7 @@ The following links have proven useful in selecting hardware. Though some of what you see won't necessarily be specific (or even applicable) to FreeBSD, most of the hardware information out there - is OS independent. Please check with the FreeBSD hardware guide to + is OS independent. Please check with the FreeBSD hardware guide to make sure that your chosen configuration is supported before making any purchases. @@ -55,10 +55,10 @@ The following list of sample hardware configurations by no means constitutes an endorsement of a given hardware vendor or product by - The FreeBSD Project. This information is + The FreeBSD Project. This information is provided only as a public service and merely catalogs some of the experiences that various individuals have had with different - hardware combinations. Your mileage may vary. Slippery when wet. + hardware combinations. Your mileage may vary. Slippery when wet. Beware of dog. @@ -66,9 +66,9 @@ Jordan's Picks I have had fairly good luck building workstation and server - configurations with the following components. I can't guarantee + configurations with the following components. I can't guarantee that you will too, nor that any of the companies here will remain - “best buys” forever. I will try, when I can, to keep this list + “best buys” forever. I will try, when I can, to keep this list up-to-date but cannot obviously guarantee that it will be at any given time. @@ -80,7 +80,7 @@ URL="http://www.tyan.com/html/products.html">Tyan S1668 dual-processor motherboard as well as the Intel PR440FX motherboard with on-board SCSI WIDE and 100/10MB Intel - Etherexpress NIC. You can build a dandy little single or dual + Etherexpress NIC. You can build a dandy little single or dual processor system (which is supported in FreeBSD 3.0) for very little cost now that the Pentium Pro 180/256K chips have fallen so greatly in price, but no telling how much longer this will @@ -131,7 +131,7 @@ There are two types of 3940 on the market—the older model with AIC 7880 chips on it, and hte newer one with AIC 7895 - chips. The newer model requires CAM support which is not yet part of FreeBSD—you have to add it, or install from one of the CAM binary snapshot release. @@ -145,7 +145,7 @@ you can afford it.” Even in small desktop configurations, SCSI often makes more sense since it allows you to easily migrate drives from server to desktop as falling drive prices make it - economical to do so. If you have more than one machine to + economical to do so. If you have more than one machine to administer then think of it not simply as storage, think of it as a food chain! For a serious server configuration, there's not even any argument—use SCSI equipment and good cables. @@ -159,16 +159,16 @@ while the Toshiba drives have always been favourites of mine (in whatever speed is hot that week), I'm still fond of my good old Plextor PX-12CS drive. It's + url="http://www.plextor.com">Plextor PX-12CS drive. It's only a 12 speed, but it's offered excellent performance and reliability. Generally speaking, most SCSI CDROM drives I've seen have been of pretty solid construction and you probably won't go - wrong with an HP or NEC SCSI CDROM drive either. SCSI CDROM + wrong with an HP or NEC SCSI CDROM drive either. SCSI CDROM prices also appear to have dropped considerably in the last few months and are now quite competitive with IDE CDROMs while - remaining a technically superior solution. I now see no reason + remaining a technically superior solution. I now see no reason whatsoever to settle for an IDE CDROM drive if given a choice between the two. @@ -180,9 +180,9 @@ At the time of this writing, FreeBSD supports 3 types of CDR drives (though I believe they all ultimately come from Phillips anyway): The Phillips CDD 522 (Acts like a Plasmon), the PLASMON - RF4100 and the HP 6020i. I myself use the HP 6020i for burning + RF4100 and the HP 6020i. I myself use the HP 6020i for burning CDROMs (in 2.2 and alter releases—it does not work with - earlier releases of the SCSI code) and it works very well. See + earlier releases of the SCSI code) and it works very well. See /usr/share/examples/worm on your 2.2 system for example scripts used to created ISO9660 filesystem images (with RockRidge extensions) and burn them onto an HP6020i CDR. @@ -208,12 +208,12 @@ Inc. (formerly X Inside, Inc) then I can heartily recommend the Matrox Millenium II card. Note that support for this card is also excellent with the XFree86 server, which is now at version 3.3.2. + URL="http://www.matrox.com/mgaweb/brochure.htm">Millenium II card. Note that support for this card is also excellent with the XFree86 server, which is now at version 3.3.2. You also certainly can't go wrong with one of Number 9's cards — their S3 Vision 868 and 968 based cards (the 9FX series) also being quite - fast and very well supported by XFree86's S3 server. You can + fast and very well supported by XFree86's S3 server. You can also pick up their Revolution 3D cards very cheaply these days, especially if you require a lot of video memory. @@ -223,7 +223,7 @@ Monitors I have had very good luck with the Sony Multiscan 17seII monitors, as have I with the Viewsonic offering in the same (Trinitron) tube. For larger than 17", all I can recommend at the time of this writing is to not spend any less than U.S. $2,000 for a 21" monitor or $1,700 for a 20" monitor if that's what you really need. There are good monitors available in the >=20" range and there are also cheap monitors in the >=20" range. Unfortunately, very few are both cheap and good! + URL="http://cons3.sel.sony.com/SEL/ccpg/display/ms17se2.html">Sony Multiscan 17seII monitors, as have I with the Viewsonic offering in the same (Trinitron) tube. For larger than 17", all I can recommend at the time of this writing is to not spend any less than U.S. $2,000 for a 21" monitor or $1,700 for a 20" monitor if that's what you really need. There are good monitors available in the >=20" range and there are also cheap monitors in the >=20" range. Unfortunately, very few are both cheap and good! @@ -234,7 +234,7 @@ ande foremost, followed by the SMC Ultra 16 controller for any ISA application and the SMC EtherPower or Compex ENET32 - cards for slightly cheaper PCI based networking. In general, any + cards for slightly cheaper PCI based networking. In general, any PCI NIC based around DEC's DC21041 Ethernet controller chip, such as the Zynx ZX342 or DEC DE435, will generally work quite well and can frequently be found in 2-port and 4-port version @@ -254,16 +254,16 @@ If you're looking for high-speed serial networking solutions, then Digi International makes the SYNC/570 series, with drivers now in FreeBSD-current. Emerging Technologies also manufactures a board with T1/E1 capabilities, using software they provide. I have no direct experience using either product, however. + URL="http://www.dgii.com/prodprofiles/profiles-prices/digiprofiles/digispecs/sync570.html">SYNC/570 series, with drivers now in FreeBSD-current. Emerging Technologies also manufactures a board with T1/E1 capabilities, using software they provide. I have no direct experience using either product, however. Multiport card options are somewhat more numerous, though it has to be said that FreeBSD's support for Cyclades's products is probably the tightest, primarily as a result of that company's commitment to making sure that we are adequately supplied with - evaluation boards and technical specs. I've heard that the + evaluation boards and technical specs. I've heard that the Cyclom-16Ye offers the best price/performance, though I've not - checked the prices lately. Other multiport cards I've heard good + checked the prices lately. Other multiport cards I've heard good things about are the BOCA and AST cards, and Stallion Technologies apparently offers an unofficial driver @@ -278,7 +278,7 @@ I currently use a Creative Labs AWE32 though just about anything from Creative Labs will generally work these - days. This is not to say that other types of sound cards don't + days. This is not to say that other types of sound cards don't also work, simply that I have little experience with them (I was a former GUS fan, but Gravis's soundcard situation has been dire for some time). @@ -290,17 +290,17 @@ For video capture, there are two good choices — any card based on the Brooktree BT848 chip, such as the Hauppage or WinTV - boards, will work very nicely with FreeBSD. Another board which + boards, will work very nicely with FreeBSD. Another board which works for me is the Matrox Meteor - card. FreeBSD also supports the older video spigot card from + card. FreeBSD also supports the older video spigot card from Creative Labs, but those are getting somewhat difficult to find. Note that the Meteor frame grabber card will not work with motherboards based on the 440FX chipset! See the motherboard reference section for - details. In such cases, it's better to go with a BT848 based + details. In such cases, it's better to go with a BT848 based board. @@ -361,9 +361,9 @@ 1 or 2): - Write back cache coherency problems. Hardware flaw, + Write back cache coherency problems. Hardware flaw, only known work around is to set the external cache to - write-through mode. Upgrade to Saturn-II. + write-through mode. Upgrade to Saturn-II. @@ -374,7 +374,7 @@ Works fine, but many MB manufactures leave out the external dirty bit SRAM needed for write back operation. Work arounds are either run it in write through mode, or - get the dirty bit SRAM installed. (I have these for the + get the dirty bit SRAM installed. (I have these for the ASUS PCI/I-486SP3G rev 1.6 and later boards). @@ -383,10 +383,10 @@ Can not run more than 2 bus master devices. - Admitted Intel design flaw. Workarounds include do not + Admitted Intel design flaw. Workarounds include do not run more than 2 bus masters, special hardware design to replace the PCI bus arbiter (appears on Intel Altair - board and several other Intel server group MB's). And + board and several other Intel server group MB's). And of course Intel's official answer, move to the Triton chip set, we “fixed it there”. @@ -397,8 +397,8 @@ No known cache coherency or bus master problems, - chip set does not implement parity checking. Workaround - for parity issue. Use Triton-II based motherboards if + chip set does not implement parity checking. Workaround + for parity issue. Use Triton-II based motherboards if you have the choice. @@ -408,7 +408,7 @@ All reports on motherboards using this chipset have - been favorable so far. No known problems. + been favorable so far. No known problems. @@ -418,7 +418,7 @@ Early versions of this chipset suffered from a PCI write-posting bug which can cause noticeable performance degradation in applications where large amounts of PCI - bus traffic is involved. B0 stepping or later revisions + bus traffic is involved. B0 stepping or later revisions of the chipset fixed this problem. @@ -428,7 +428,7 @@ This Pentium Pro support chipset seems to work well, and does not suffer from any of the early Orion chipset problems. It also supports a wider variety of memory, including ECC and parity. The only known problem with it is that the Matrox Meteor frame grabber card doesn't like it. + URL="http://www.intel.com/procs/ppro/index.htm">Pentium Pro support chipset seems to work well, and does not suffer from any of the early Orion chipset problems. It also supports a wider variety of memory, including ECC and parity. The only known problem with it is that the Matrox Meteor frame grabber card doesn't like it. @@ -452,7 +452,7 @@ In fact, our main ftp site ftp.freebsd.org (also known as "ftp.cdrom.com", world's largest - ftp site) runs FreeBSD on a Pentium Pro. Configurations details are available for interested parties. @@ -462,16 +462,16 @@ The Intel Pentium (P54C), Pentium MMX (P55C), AMD K6 and Cyrix/IBM 6x86MX processors are all reported to work with - FreeBSD. I will not go into details of which processor is + FreeBSD. I will not go into details of which processor is faster than what, there are zillions of web sites on the - Internet that tells you one way or another. :) + Internet that tells you one way or another. :) Various CPUs have different voltage/cooling requirements. Make sure your motherboard can supply the exact voltage needed - by the CPU. For instance, many recent MMX chips require split - voltage (e.g., 2.9V core, 3.3V I/O). Also, some AMD and - Cyrix/IBM chips run hotter than Intel chips. In that case, + by the CPU. For instance, many recent MMX chips require split + voltage (e.g., 2.9V core, 3.3V I/O). Also, some AMD and + Cyrix/IBM chips run hotter than Intel chips. In that case, make sure you have good heatsink/fans (you can get the list of certified parts from their web pages). @@ -486,10 +486,10 @@ 1997. Pentium class machines use different clock speeds for the - various parts of the system. These being the speed of the - CPU, external memory bus, and the PCI bus. It is not always + various parts of the system. These being the speed of the + CPU, external memory bus, and the PCI bus. It is not always true that a “faster” processor will make a system faster than - a “slower” one, due to the various clock speeds used. Below is + a “slower” one, due to the various clock speeds used. Below is a table showing the differences: @@ -623,8 +623,8 @@ The AMD K6 Bug In 1997, there have been reports of the AMD K6 seg - faulting during heavy compilation. That problem has been - fixed in 3Q '97. According to reports, K6 chips with date mark + faulting during heavy compilation. That problem has been + fixed in 3Q '97. According to reports, K6 chips with date mark “9733” or larger (i.e., manufactured in the 33rd week of '97 or later) do not have this bug. @@ -646,7 +646,7 @@ 286 class - Sorry, FreeBSD does not run on 80286 machines. It is nearly + Sorry, FreeBSD does not run on 80286 machines. It is nearly impossible to run today's large full-featured UNIXes on such hardware. @@ -657,9 +657,9 @@ * Memory The minimum amount of memory you must have to install FreeBSD - is 5 MB. Once your system is up and running you can build a custom kernel - that will use less memory. If you use the boot4.flp you can get + that will use less memory. If you use the boot4.flp you can get away with having only 4 MB. @@ -699,8 +699,8 @@ The Universal Asynchronous Receiver/Transmitter (UART) controller is the key component of the serial communications - subsystem of a computer. The UART takes bytes of data and - transmits the individual bits in a sequential fashion. At the + subsystem of a computer. The UART takes bytes of data and + transmits the individual bits in a sequential fashion. At the destination, a second UART re-assembles the bits into complete bytes. @@ -709,11 +709,11 @@ other devices. There are two primary forms of serial transmission: - Synchronous and Asynchronous. Depending on the modes that are + Synchronous and Asynchronous. Depending on the modes that are supported by the hardware, the name of the communication sub-system will usually include a A if it supports Asynchronous communications, and a S if it supports - Synchronous communications. Both forms are described + Synchronous communications. Both forms are described below. Some common acronyms are: @@ -734,11 +734,11 @@ Synchronous serial transmission requires that the sender and receiver share a clock with one another, or that the sender provide a strobe or other timing signal so that the - receiver knows when to “read” the next bit of the data. In + receiver knows when to “read” the next bit of the data. In most forms of serial Synchronous communication, if there is no data available at a given instant to transmit, a fill character must be sent instead so that data is always being - transmitted. Synchronous communication is usually more + transmitted. Synchronous communication is usually more efficient because only data bits are transmitted between sender and receiver, and synchronous communication can be more more costly if extra wiring and circuits are required to share @@ -750,11 +750,11 @@ Printers and fixed disk devices are not normally serial devices because most fixed disk interface standards send an entire word of data for each clock or strobe signal by using a - separate wire for each bit of the word. In the PC industry, + separate wire for each bit of the word. In the PC industry, these are known as Parallel devices. The standard serial communications hardware in the PC does - not support Synchronous operations. This mode is described + not support Synchronous operations. This mode is described here for comparison purposes only. @@ -764,59 +764,59 @@ Asynchronous transmission allows data to be transmitted without the sender having to send a clock signal to the - receiver. Instead, the sender and receiver must agree on + receiver. Instead, the sender and receiver must agree on timing parameters in advance and special bits are added to each word which are used to synchronize the sending and receiving units. When a word is given to the UART for Asynchronous transmissions, a bit called the "Start Bit" is added to the - beginning of each word that is to be transmitted. The Start + beginning of each word that is to be transmitted. The Start Bit is used to alert the receiver that a word of data is about to be sent, and to force the clock in the receiver into - synchronization with the clock in the transmitter. These two + synchronization with the clock in the transmitter. These two clocks must be accurate enough to not have the frequency drift by more than 10% during the transmission of the - remaining bits in the word. (This requirement was set in the + remaining bits in the word. (This requirement was set in the days of mechanical teleprinters and is easily met by modern electronic equipment.) After the Start Bit, the individual bits of the word of data are sent, with the Least Significant Bit (LSB) being sent - first. Each bit in the transmission is transmitted for + first. Each bit in the transmission is transmitted for exactly the same amount of time as all of the other bits, and the receiver “looks” at the wire at approximately halfway through the period assigned to each bit to determine if the - bit is a 1 or a 0. For example, if it takes two seconds + bit is a 1 or a 0. For example, if it takes two seconds to send each bit, the receiver will examine the signal to determine if it is a 1 or a 0 after one second has passed, then it will wait two seconds and then examine the value of the next bit, and so on. The sender does not know when the receiver has “looked” at - the value of the bit. The sender only knows when the clock + the value of the bit. The sender only knows when the clock says to begin transmitting the next bit of the word. When the entire data word has been sent, the transmitter - may add a Parity Bit that the transmitter generates. The + may add a Parity Bit that the transmitter generates. The Parity Bit may be used by the receiver to perform simple error - checking. Then at least one Stop Bit is sent by the + checking. Then at least one Stop Bit is sent by the transmitter. When the receiver has received all of the bits in the data word, it may check for the Parity Bits (both sender and receiver must agree on whether a Parity Bit is to be used), - and then the receiver looks for a Stop Bit. If the Stop Bit + and then the receiver looks for a Stop Bit. If the Stop Bit does not appear when it is supposed to, the UART considers the entire word to be garbled and will report a Framing Error to - the host processor when the data word is read. The usual + the host processor when the data word is read. The usual cause of a Framing Error is that the sender and receiver clocks were not running at the same speed, or that the signal was interrupted. Regardless of whether the data was received correctly or not, the UART automatically discards the Start, Parity and - Stop bits. If the sender and receiver are configured + Stop bits. If the sender and receiver are configured identically, these bits are not passed to the host. If another word is ready for transmission, the Start Bit @@ -838,7 +838,7 @@ circuits for signals that can be used to indicate the state of the transmission media, and to regulate the flow of data in the event that the remote device is not prepared to accept - more data. For example, when the device connected to the + more data. For example, when the device connected to the UART is a modem, the modem may report the presence of a carrier on the phone line while the computer may be able to instruct the modem to reset itself or to not take calls by @@ -853,7 +853,7 @@ In most computer systems, the UART is connected to circuitry that generates signals that comply with the EIA - RS232-C specification. There is also a CCITT standard named + RS232-C specification. There is also a CCITT standard named V.24 that mirrors the specifications included in RS232-C. @@ -862,15 +862,15 @@ RS232-C Bit Assignments (Marks and Spaces) In RS232-C, a value of 1 is called a Mark and a - value of 0 is called a Space. When a communication line + value of 0 is called a Space. When a communication line is idle, the line is said to be “Marking”, or transmitting continuous 1 values. - The Start bit always has a value of 0 (a Space). The - Stop Bit always has a value of 1 (a Mark). This means + The Start bit always has a value of 0 (a Space). The + Stop Bit always has a value of 1 (a Mark). This means that there will always be a Mark (1) to Space (0) transition on the line at the start of every word, even when multiple - word are transmitted back to back. This guarantees that + word are transmitted back to back. This guarantees that sender and receiver can resynchronize their clocks regardless of the content of the data bits that are being transmitted. @@ -883,9 +883,9 @@ In RS232-C, the "Marking" signal (a 1) is represented by a voltage between -2 VDC and -12 VDC, and a "Spacing" signal (a 0) is represented by a voltage between 0 and +12 - VDC. The transmitter is supposed to send +12 VDC or -12 + VDC. The transmitter is supposed to send +12 VDC or -12 VDC, and the receiver is supposed to allow for some voltage - loss in long cables. Some transmitters in low power devices + loss in long cables. Some transmitters in low power devices (like portable computers) sometimes use only +5 VDC and -5 VDC, but these values are still acceptable to a RS232-C receiver, provided that the cable lengths are short. @@ -897,12 +897,12 @@ RS232-C also specifies a signal called a Break, which is caused by sending continuous Spacing values (no Start or - Stop bits). When there is no electricity present on the + Stop bits). When there is no electricity present on the data circuit, the line is considered to be sending Break. The Break signal must be of a duration longer than the time it takes to send a complete byte plus Start, Stop and - Parity bits. Most UARTs can distinguish between a Framing + Parity bits. Most UARTs can distinguish between a Framing Error and a Break, but if the UART cannot do this, the Framing Error detection can be used to identify Breaks. @@ -910,7 +910,7 @@ In the days of teleprinters, when numerous printers around the country were wired in series (such as news services), any unit could cause a Break by temporarily - opening the entire circuit so that no current flowed. This + opening the entire circuit so that no current flowed. This was used to allow a location with urgent news to interrupt some other location that was currently sending information. @@ -919,10 +919,10 @@ If the Break is longer than 1.6 seconds, it is considered a "Modem Break", and some modems can be programmed to terminate the conversation and go on-hook or enter the - modems' command mode when the modem detects this signal. If + modems' command mode when the modem detects this signal. If the Break is smaller than 1.6 seconds, it signifies a Data Break and it is up to the remote computer to respond to this - signal. Sometimes this form of Break is used as an + signal. Sometimes this form of Break is used as an Attention or Interrupt signal and sometimes is accepted as a substitute for the ASCII CONTROL-C character. @@ -932,7 +932,7 @@ Breaks cannot be generated from paper tape or from any other byte value, since bytes are always sent with Start - and Stop bit. The UART is usually capable of generating + and Stop bit. The UART is usually capable of generating the continuous Spacing signal in response to a special command from the host processor. @@ -944,26 +944,26 @@ The RS232-C specification defines two types of equipment: the Data Terminal Equipment (DTE) and the Data - Carrier Equipment (DCE). Usually, the DTE device is the - terminal (or computer), and the DCE is a modem. Across the + Carrier Equipment (DCE). Usually, the DTE device is the + terminal (or computer), and the DCE is a modem. Across the phone line at the other end of a conversation, the receiving modem is also a DCE device and the computer that is - connected to that modem is a DTE device. The DCE device + connected to that modem is a DTE device. The DCE device receives signals on the pins that the DTE device transmits on, and vice versa. When two devices that are both DTE or both DCE must be connected together without a modem or a similar media - translater between them, a NULL modem must be used. The + translater between them, a NULL modem must be used. The NULL modem electrically re-arranges the cabling so that the transmitter output is connected to the receiver input on the - other device, and vice versa. Similar translations are + other device, and vice versa. Similar translations are performed on all of the control signals so that each device will see what it thinks are DCE (or DTE) signals from the other device. The number of signals generated by the DTE and DCE - devices are not symmetrical. The DTE device generates fewer + devices are not symmetrical. The DTE device generates fewer signals for the DCE device than the DTE device receives from the DCE. @@ -979,14 +979,14 @@ In the IBM Personal Computer and similar systems, a subset of RS232-C signals are provided via nine pin - connectors (DB9). The signals that are not included on the + connectors (DB9). The signals that are not included on the PC connector deal mainly with synchronous operation, and this transmission mode is not supported by the UART that IBM selected for use in the IBM PC. Depending on the computer manufacturer, a DB25, a DB9, or both types of connector may be used for RS232-C - communications. (The IBM PC also uses a DB25 connector for + communications. (The IBM PC also uses a DB25 connector for the parallel printer interface which causes some confusion.) @@ -1267,7 +1267,7 @@ Bits, Baud and Symbols Baud is a measurement of transmission speed in - asynchronous communication. Because of advances in modem + asynchronous communication. Because of advances in modem communication technology, this term is frequently misused when describing the data rates in newer devices. @@ -1276,8 +1276,8 @@ data that is actually moved from one DTE device to the other. The Baud count includes the overhead bits Start, Stop and Parity that are generated by the sending UART and removed by - the receiving UART. This means that seven-bit words of data - actually take 10 bits to be completely transmitted. Therefore, + the receiving UART. This means that seven-bit words of data + actually take 10 bits to be completely transmitted. Therefore, a modem capable of moving 300 bits per second from one place to another can normally only move 30 7-bit words if Parity is used and one Start and Stop bit are present. @@ -1289,12 +1289,12 @@ The formula for converting bytes per second into a baud rate and vice versa was simple until error-correcting modems - came along. These modems receive the serial stream of bits + came along. These modems receive the serial stream of bits from the UART in the host computer (even when internal modems are used the data is still frequently serialized) and converts - the bits back into bytes. These bytes are then combined into + the bits back into bytes. These bytes are then combined into packets and sent over the phone line using a Synchronous - transmission method. This means that the Stop, Start, and + transmission method. This means that the Stop, Start, and Parity bits added by the UART in the DTE (the computer) were removed by the modem before transmission by the sending modem. When these bytes are received by the remote modem, the remote @@ -1307,7 +1307,7 @@ the two modems can perform error correction, which means that the receiving modem is able to ask the sending modem to resend a block of data that was not received with the correct - checksum. This checking is handled by the modems, and the DTE + checksum. This checking is handled by the modems, and the DTE devices are usually unaware that the process is occurring. @@ -1315,7 +1315,7 @@ additional bits of data that the two modems must share between themselves to perform error-correction are mostly concealed from the effective transmission rate seen by the sending and - receiving DTE equipment. For example, if a modem sends ten + receiving DTE equipment. For example, if a modem sends ten 7-bit words to another modem without including the Start, Stop and Parity bits, the sending modem will be able to add 30 bits of its own information that the receiving modem can use to do @@ -1323,16 +1323,16 @@ the real data. The use of the term Baud is further confused by modems - that perform compression. A single 8-bit word passed over the + that perform compression. A single 8-bit word passed over the telephone line might represent a dozen words that were - transmitted to the sending modem. The receiving modem will + transmitted to the sending modem. The receiving modem will expand the data back to its original content and pass that data to the receiving DTE. Modern modems also include buffers that allow the rate that bits move across the phone line (DCE to DCE) to be a different speed than the speed that the bits move between the - DTE and DCE on both ends of the conversation. Normally the + DTE and DCE on both ends of the conversation. Normally the speed between the DTE and DCE is higher than the DCE to DCE speed because of the use of compression by the modems. @@ -1341,7 +1341,7 @@ differing bits-per-seconds speeds that are used present on the DTE-DCE and DCE-DCE links, the usage of the term Baud to describe the overall communication speed causes problems and - can misrepresent the true transmission speed. So Bits Per + can misrepresent the true transmission speed. So Bits Per Second (bps) is the correct term to use to describe the transmission rate seen at the DCE to DCE interface and Baud or Bits Per Second are acceptable terms to use when a connection @@ -1351,12 +1351,12 @@ Modern high speed modems (2400, 9600, 14,400, and 19,200bps) in reality still operate at or below 2400 baud, or - more accurately, 2400 Symbols per second. High speed modem + more accurately, 2400 Symbols per second. High speed modem are able to encode more bits of data into each Symbol using a technique called Constellation Stuffing, which is why the effective bits per second rate of the modem is higher, but the modem continues to operate within the limited audio bandwidth - that the telephone system provides. Modems operating at 28,800 + that the telephone system provides. Modems operating at 28,800 and higher speeds have variable Symbol rates, but the technique is the same. @@ -1367,7 +1367,7 @@ Starting with the original IBM Personal Computer, IBM selected the National Semiconductor INS8250 UART for use in - the IBM PC Parallel/Serial Adapter. Subsequent generations of + the IBM PC Parallel/Serial Adapter. Subsequent generations of compatible computers from IBM and other vendors continued to use the INS8250 or improved versions of the National Semiconductor UART family. @@ -1377,7 +1377,7 @@ National Semiconductor UART Family Tree There have been several versions and subsequent - generations of the INS8250 UART. Each major version is + generations of the INS8250 UART. Each major version is described below. @@ -1398,12 +1398,12 @@ INS8250 -> INS8250B INS8250 This part was used in the original IBM PC and - IBM PC/XT. The original name for this part was the + IBM PC/XT. The original name for this part was the INS8250 ACE (Asynchronous Communications Element) and it is made from NMOS technology. The 8250 uses eight I/O ports and has a one-byte - send and a one-byte receive buffer. This original + send and a one-byte receive buffer. This original UART has several race conditions and other flaws. The original IBM BIOS includes code to work around these flaws, but this made the BIOS dependent on the @@ -1417,7 +1417,7 @@ INS8250 -> INS8250B This is the slower speed of the INS8250 made - from NMOS technology. It contains the same problems + from NMOS technology. It contains the same problems as the original INS8250. @@ -1448,7 +1448,7 @@ INS8250 -> INS8250B Same as NS8250A with improvements so it can be - used with faster CPU bus designs. IBM used this + used with faster CPU bus designs. IBM used this part in the IBM AT and updated the IBM BIOS to no longer rely on the bugs in the INS8250. @@ -1513,14 +1513,14 @@ INS8250 -> INS8250B years ago, and the NS16550AFN no longer exists by that name. (If you have a NS16550AFN, look at the date code on the part, which is a four digit number that usually starts with - a nine. The first two digits of the number are the year, + a nine. The first two digits of the number are the year, and the last two digits are the week in that year when the - part was packaged. If you have a NS16550AFN, it is probably + part was packaged. If you have a NS16550AFN, it is probably a few years old.) The new numbers are like PC16550DV, with minor differences in the suffix letters depending on the package - material and its shape. (A description of the numbering + material and its shape. (A description of the numbering system can be found below.) It is important to understand that in some stores, you @@ -1545,7 +1545,7 @@ INS8250 -> INS8250B are now of the format PCnnnnnrgp. - The r is the revision field. The + The r is the revision field. The current revision of the 16550 from National Semiconductor is D. @@ -1581,7 +1581,7 @@ INS8250 -> INS8250B If an I precedes the package-type letter, it indicates an “industrial” grade part, which has higher specs than a standard part but not as high as Military Specification - (Milspec) component. This is an optional field. + (Milspec) component. This is an optional field. So what we used to call a NS16550AFN (DIP Package) is now called a PC16550DN or PC16550DIN. @@ -1593,7 +1593,7 @@ INS8250 -> INS8250B Other Vendors and Similar UARTs Over the years, the 8250, 8250A, 16450 and 16550 have been - licensed or copied by other chip vendors. In the case of the + licensed or copied by other chip vendors. In the case of the 8250, 8250A and 16450, the exact circuit (the “megacell”) was licensed to many vendors, including Western Digital and Intel. Other vendors reverse-engineered the part or produced @@ -1602,9 +1602,9 @@ INS8250 -> INS8250B In internal modems, the modem designer will frequently emulate the 8250A/16450 with the modem microprocessor, and the emulated UART will frequently have a hidden buffer consisting - of several hundred bytes. Because of the size of the buffer, + of several hundred bytes. Because of the size of the buffer, these emulations can be as reliable as a 16550A in their - ability to handle high speed data. However, most operating + ability to handle high speed data. However, most operating systems will still report that the UART is only a 8250A or 16450, and may not make effective use of the extra buffering present in the emulated UART unless special drivers are @@ -1617,16 +1617,16 @@ INS8250 -> INS8250B be lowered by this action. A common misconception is that all parts with “16550A” - written on them are identical in performance. There are + written on them are identical in performance. There are differences, and in some cases, outright flaws in most of these 16550A clones. When the NS16550 was developed, the National Semiconductor obtained several patents on the design and they also limited licensing, making it harder for other vendors to provide a - chip with similar features. Because of the patents, + chip with similar features. Because of the patents, reverse-engineered designs and emulations had to avoid - infringing the claims covered by the patents. Subsequently, + infringing the claims covered by the patents. Subsequently, these copies almost never perform exactly the same as the NS16550A or PC16550D, which are the parts most computer and modem makers want to buy but are sometimes unwilling to pay @@ -1634,21 +1634,21 @@ INS8250 -> INS8250B Some of the differences in the clone 16550A parts are unimportant, while others can prevent the device from being - used at all with a given operating system or driver. These + used at all with a given operating system or driver. These differences may show up when using other drivers, or when particular combinations of events occur that were not well - tested or considered in the Windows driver. This is because + tested or considered in the Windows driver. This is because most modem vendors and 16550-clone makers use the Microsoft drivers from Windows for Workgroups 3.11 and the Microsoft MSD utility as the primary tests for compatibility with the - NS16550A. This over-simplistic criteria means that if a + NS16550A. This over-simplistic criteria means that if a different operating system is used, problems could appear due to subtle differences between the clones and genuine components. National Semiconductor has made available a program named COMTEST that performs compatibility tests independent of any - OS drivers. It should be remembered that the purpose of this + OS drivers. It should be remembered that the purpose of this type of program is to demonstrate the flaws in the products of the competition, so the program will report major as well as extremely subtle differences in behavior in the part being @@ -1657,7 +1657,7 @@ INS8250 -> INS8250B In a series of tests performed by the author of this document in 1994, components made by National Semiconductor, TI, StarTech, and CMD as well as megacells and emulations - embedded in internal modems were tested with COMTEST. A + embedded in internal modems were tested with COMTEST. A difference count for some of these components is listed below. Because these tests were performed in 1994, they may not reflect the current performance of the given product from a @@ -1665,7 +1665,7 @@ INS8250 -> INS8250B It should be noted that COMTEST normally aborts when an excessive number or certain types of problems have been - detected. As part of this testing, COMTEST was modified so + detected. As part of this testing, COMTEST was modified so that it would not abort no matter how many differences were encountered. @@ -1736,12 +1736,12 @@ INS8250 -> INS8250B To date, the author of this document has not found any non-National parts that report zero - differences using the COMTEST program. It should + differences using the COMTEST program. It should also be noted that National has had five versions of the 16550 over the years and the newest parts behave a bit differently than the classic NS16550AFN that is considered the benchmark for - functionality. COMTEST appears to turn a blind eye + functionality. COMTEST appears to turn a blind eye to the differences within the National product line and reports no errors on the National parts (except for the original 16550) even when there @@ -1752,24 +1752,24 @@ INS8250 -> INS8250B It is important to understand that a simple count of differences from COMTEST does not reveal a lot about what - differences are important and which are not. For example, + differences are important and which are not. For example, about half of the differences reported in the two modems listed above that have internal UARTs were caused by the clone - UARTs not supporting five- and six-bit character modes. The + UARTs not supporting five- and six-bit character modes. The real 16550, 16450, and 8250 UARTs all support these modes and COMTEST checks the functionality of these modes so over fifty - differences are reported. However, almost no modern modem + differences are reported. However, almost no modern modem supports five- or six-bit characters, particularly those with - error-correction and compression capabilities. This means + error-correction and compression capabilities. This means that the differences related to five- and six-bit character modes can be discounted. Many of the differences COMTEST reports have to do with - timing. In many of the clone designs, when the host reads + timing. In many of the clone designs, when the host reads from one port, the status bits in some other port may not update in the same amount of time (some faster, some slower) as a real NS16550AFN and COMTEST looks - for these differences. This means that the number of + for these differences. This means that the number of differences can be misleading in that one device may only have one or two differences but they are extremely serious, and some other device that updates the status registers faster or @@ -1785,7 +1785,7 @@ INS8250 -> INS8250B If you run COMTEST on a 16550 that is in a modem or a modem is attached to the serial port, you need to first issue a ATE0&W command to the modem so that the modem will not - echo any of the test characters. If you forget to do this, + echo any of the test characters. If you forget to do this, COMTEST will report at least this one difference: @@ -1798,12 +1798,12 @@ INS8250 -> INS8250B 8250/16450/16550 Registers The 8250/16450/16550 UART occupies eight contiguous I/O - port addresses. In the IBM PC, there are two defined + port addresses. In the IBM PC, there are two defined locations for these eight ports and they are known - collectively as COM1 and COM2. The makers of PC-clones and + collectively as COM1 and COM2. The makers of PC-clones and add-on cards have created two additional areas known as COM3 and COM4, but these extra COM ports conflict with other - hardware on some systems. The most common conflict is with + hardware on some systems. The most common conflict is with video adapters that provide IBM 8514 emulation. COM1 is located from 0x3f8 to 0x3ff and normally uses IRQ @@ -1849,7 +1849,7 @@ INS8250 -> INS8250B value will be divided from the master input clock (in the IBM PC, the master clock is 1.8432MHz) and the resulting clock will determine the baud rate of - the UART. This register holds bits 0 thru 7 of the + the UART. This register holds bits 0 thru 7 of the divisor. @@ -1860,7 +1860,7 @@ INS8250 -> INS8250B value will be divided from the master input clock (in the IBM PC, the master clock is 1.8432MHz) and the resulting clock will determine the baud rate of - the UART. This register holds bits 8 thru 15 of the + the UART. This register holds bits 8 thru 15 of the divisor. @@ -1875,13 +1875,13 @@ INS8250 -> INS8250B Interrupt Enable Register (IER)The 8250/16450/16550 UART classifies - events into one of four categories. Each + events into one of four categories. Each category can be configured to generate an - interrupt when any of the events occurs. The + interrupt when any of the events occurs. The 8250/16450/16550 UART generates a single external interrupt signal regardless of how many events in the enabled categories have - occurred. It is up to the host processor to + occurred. It is up to the host processor to respond to the interrupt and then poll the enabled interrupt categories (usually all categories have interrupts enabled) to @@ -2026,7 +2026,7 @@ INS8250 -> INS8250B Bit 3 - DMA Mode Select. If Bit 0 + DMA Mode Select. If Bit 0 is set to "1" (FIFOs enabled), setting this bit changes the operation of the -RXRDY and -TXRDY signals from Mode 0 to Mode 1. @@ -2034,27 +2034,27 @@ INS8250 -> INS8250B Bit 2 - Transmit FIFO Reset. When a + Transmit FIFO Reset. When a "1" is written to this bit, the contents of the - FIFO are discarded. Any word currently being - transmitted will be sent intact. This function + FIFO are discarded. Any word currently being + transmitted will be sent intact. This function is useful in aborting transfers. Bit 1 - Receiver FIFO Reset. When a + Receiver FIFO Reset. When a "1" is written to this bit, the contents of the - FIFO are discarded. Any word currently being + FIFO are discarded. Any word currently being assembled in the shift register will be received intact. Bit 0 - 16550 FIFO Enable. When + 16550 FIFO Enable. When set, both the transmit and receive FIFOs are - enabled. Any contents in the holding register, + enabled. Any contents in the holding register, shift registers or FIFOs are lost when FIFOs are enabled or disabled. @@ -2082,13 +2082,13 @@ INS8250 -> INS8250B Bit 7 - FIFOs enabled. On the + FIFOs enabled. On the 8250/16450 UART, this bit is zero. Bit 6 - FIFOs enabled. On the + FIFOs enabled. On the 8250/16450 UART, this bit is zero. @@ -2104,7 +2104,7 @@ INS8250 -> INS8250B Bit 3 - Interrupt ID Bit #2. On the + Interrupt ID Bit #2. On the 8250/16450 UART, this bit is zero. @@ -2118,14 +2118,14 @@ INS8250 -> INS8250B Interrupt ID Bit #0.These three bits combine to report the category of event that caused the interrupt that is in - progress. These categories have priorities, so + progress. These categories have priorities, so if multiple categories of events occur at the same time, the UART will report the more important events first and the host must resolve - the events in the order they are reported. All + the events in the order they are reported. All events that caused the current interrupt must be resolved before any new interrupts will be - generated. (This is a limitation of the PC + generated. (This is a limitation of the PC architecture.) @@ -2181,7 +2181,7 @@ INS8250 -> INS8250B Bit 0 - Interrupt Pending Bit. If + Interrupt Pending Bit. If this bit is set to "0", then at least one interrupt is pending. @@ -2210,27 +2210,27 @@ INS8250 -> INS8250B Bit 7 Divisor Latch Access Bit - (DLAB). When set, access to the data + (DLAB). When set, access to the data transmit/receive register (THR/RBR) and the - Interrupt Enable Register (IER) is disabled. Any + Interrupt Enable Register (IER) is disabled. Any access to these ports is now redirected to the - Divisor Latch Registers. Setting this bit, + Divisor Latch Registers. Setting this bit, loading the Divisor Registers, and clearing DLAB should be done with interrupts disabled. Bit 6 - Set Break. When set to "1", + Set Break. When set to "1", the transmitter begins to transmit continuous - Spacing until this bit is set to "0". This + Spacing until this bit is set to "0". This overrides any bits of characters that are being transmitted. Bit 5 - Stick Parity. When parity + Stick Parity. When parity is enabled, setting this bit causes parity to always be "1" or "0", based on the value of Bit 4. @@ -2241,15 +2241,15 @@ INS8250 -> INS8250B Even Parity Select (EPS). When parity is enabled and Bit 5 is "0", setting this bit causes even parity to be transmitted - and expected. Otherwise, odd parity is + and expected. Otherwise, odd parity is used. Bit 3 - Parity Enable (PEN). When + Parity Enable (PEN). When set to "1", a parity bit is inserted between the - last bit of the data and the Stop Bit. The UART + last bit of the data and the Stop Bit. The UART will also expect parity to be present in the received data. @@ -2259,8 +2259,8 @@ INS8250 -> INS8250B Number of Stop Bits (STB). If set to "1" and using 5-bit data words, 1.5 Stop Bits are transmitted and expected in each - data word. For 6, 7 and 8-bit data words, 2 - Stop Bits are transmitted and expected. When + data word. For 6, 7 and 8-bit data words, 2 + Stop Bits are transmitted and expected. When this bit is set to "0", one Stop Bit is used on each data word. @@ -2351,20 +2351,20 @@ INS8250 -> INS8250B Bit 4 - Loop-Back Enable. When set to "1", the UART + Loop-Back Enable. When set to "1", the UART transmitter and receiver are internally connected together to allow diagnostic - operations. In addition, the UART modem control + operations. In addition, the UART modem control outputs are connected to the UART modem control - inputs. CTS is connected to RTS, DTR is + inputs. CTS is connected to RTS, DTR is connected to DSR, OUT1 is connected to RI, and OUT 2 is connected to DCD. Bit 3 - OUT 2. An auxiliary output that the host - processor may set high or low. In the IBM PC + OUT 2. An auxiliary output that the host + processor may set high or low. In the IBM PC serial adapter (and most clones), OUT 2 is used to tri-state (disable) the interrupt signal from the 8250/16450/16550 UART. @@ -2372,21 +2372,21 @@ INS8250 -> INS8250B Bit 2 - OUT 1. An auxiliary output that the host - processor may set high or low. This output is + OUT 1. An auxiliary output that the host + processor may set high or low. This output is not used on the IBM PC serial adapter. Bit 1 - Request to Send (RTS). When set to "1", the + Request to Send (RTS). When set to "1", the output of the UART -RTS line is Low (Active). Bit 0 - Data Terminal Ready (DTR). When set to "1", + Data Terminal Ready (DTR). When set to "1", the output of the UART -DTR line is Low (Active). @@ -2409,8 +2409,8 @@ INS8250 -> INS8250B Bit 7 - Error in Receiver FIFO. On the 8250/16450 - UART, this bit is zero. This bit is set to "1" + Error in Receiver FIFO. On the 8250/16450 + UART, this bit is zero. This bit is set to "1" when any of the bytes in the FIFO have one or more of the following error conditions: PE, FE, or BI. @@ -2418,48 +2418,48 @@ INS8250 -> INS8250B Bit 6 - Transmitter Empty (TEMT). When set to "1", + Transmitter Empty (TEMT). When set to "1", there are no words remaining in the transmit - FIFO or the transmit shift register. The + FIFO or the transmit shift register. The transmitter is completely idle. Bit 5 Transmitter Holding Register Empty - (THRE). When set to "1", the FIFO (or holding + (THRE). When set to "1", the FIFO (or holding register) now has room for at least one - additional word to transmit. The transmitter may + additional word to transmit. The transmitter may still be transmitting when this bit is set to "1". Bit 4 - Break Interrupt (BI). The receiver has + Break Interrupt (BI). The receiver has detected a Break signal. Bit 3 - Framing Error (FE). A Start Bit was + Framing Error (FE). A Start Bit was detected but the Stop Bit did not appear at the - expected time. The received word is probably + expected time. The received word is probably garbled. Bit 2 - Parity Error (PE). The parity bit was + Parity Error (PE). The parity bit was incorrect for the word received. Bit 1 - Overrun Error (OE). A new word was received - and therewas no room in the receive buffer. The + Overrun Error (OE). A new word was received + and therewas no room in the receive buffer. The newly-arrived word in the shift register is - discarded. On 8250/16450 UARTs, the word in the + discarded. On 8250/16450 UARTs, the word in the holding register is discarded and the newly- arrived word is put in the holding register. @@ -2468,7 +2468,7 @@ INS8250 -> INS8250B Bit 0 Data Ready (DR) One or more words are in - the receive FIFO that the host may read. A word + the receive FIFO that the host may read. A word must be completely received and moved from the shift register into the FIFO (or holding register for 8250/16450 designs) before this bit @@ -2493,31 +2493,31 @@ INS8250 -> INS8250B Bit 7 - Data Carrier Detect (DCD). Reflects the + Data Carrier Detect (DCD). Reflects the state of the DCD line on the UART. Bit 6 - Ring Indicator (RI). Reflects the state of + Ring Indicator (RI). Reflects the state of the RI line on the UART. Bit 5 - Data Set Ready (DSR). Reflects the state of + Data Set Ready (DSR). Reflects the state of the DSR line on the UART. Bit 4 - Clear To Send (CTS). Reflects the state of + Clear To Send (CTS). Reflects the state of the CTS line on the UART. Bit 3 - Delta Data Carrier Detect (DDCD). Set to + Delta Data Carrier Detect (DDCD). Set to "1" if the -DCD line has changed state one more more times since the last time the MSR was read by the host. @@ -2525,7 +2525,7 @@ INS8250 -> INS8250B Bit 2 - Trailing Edge Ring Indicator (TERI). Set to + Trailing Edge Ring Indicator (TERI). Set to "1" if the -RI line has had a low to high transition since the last time the MSR was read by the host. @@ -2533,7 +2533,7 @@ INS8250 -> INS8250B Bit 1 - Delta Data Set Ready (DDSR). Set to "1" if + Delta Data Set Ready (DDSR). Set to "1" if the -DSR line has changed state one more more times since the last time the MSR was read by the host. @@ -2541,7 +2541,7 @@ INS8250 -> INS8250B Bit 0 - Delta Clear To Send (DCTS). Set to "1" if + Delta Clear To Send (DCTS). Set to "1" if the -CTS line has changed state one more more times since the last time the MSR was read by the host. @@ -2553,8 +2553,8 @@ INS8250 -> INS8250B +0x07 write/read - Scratch Register (SCR). This register performs no - function in the UART. Any value can be written by the + Scratch Register (SCR). This register performs no + function in the UART. Any value can be written by the host to this location and read by the host later on. @@ -2568,8 +2568,8 @@ INS8250 -> INS8250B Although National Semiconductor has not offered any components compatible with the 16550 that provide additional - features, various other vendors have. Some of these - components are described below. It should be understood that + features, various other vendors have. Some of these + components are described below. It should be understood that to effectively utilize these improvements, drivers may have to be provided by the chip vendor since most of the popular operating systems do not support features beyond those @@ -2581,7 +2581,7 @@ INS8250 -> INS8250B By default this part is similar to the NS16550A, but an extended 32-byte send and receive buffer can be - optionally enabled. Made by Startech. + optionally enabled. Made by Startech. @@ -2590,7 +2590,7 @@ INS8250 -> INS8250B By default this part behaves similar to the NS16550A, but an extended 64-byte send and receive - buffer can be optionally enabled. Made by Texas + buffer can be optionally enabled. Made by Texas Instruments. @@ -2600,7 +2600,7 @@ INS8250 -> INS8250B This proprietary plug-in card contains a 2048-byte send and receive buffer, and supports data rates to - 230.4Kbit/sec. Made by Hayes. + 230.4Kbit/sec. Made by Hayes. @@ -2608,14 +2608,14 @@ INS8250 -> INS8250B In addition to these “dumb” UARTs, many vendors produce - intelligent serial communication boards. This type of design + intelligent serial communication boards. This type of design usually provides a microprocessor that interfaces with several UARTs, processes and buffers the data, and then alerts the - main PC processor when necessary. Because the UARTs are not + main PC processor when necessary. Because the UARTs are not directly accessed by the PC processor in this type of communication system, it is not necessary for the vendor to use UARTs that are compatible with the 8250, 16450, or the - 16550 UART. This leaves the designer free to components that + 16550 UART. This leaves the designer free to components that may have better performance characteristics. @@ -2627,8 +2627,8 @@ INS8250 -> INS8250B The sio driver provides support for NS8250-, NS16450-, NS16550 and NS16550A-based EIA - RS-232C (CCITT V.24) communications interfaces. Several - multiport cards are supported as well. See the sio4 manual page for detailed technical + RS-232C (CCITT V.24) communications interfaces. Several + multiport cards are supported as well. See the sio4 manual page for detailed technical documentation. @@ -2639,8 +2639,8 @@ INS8250 -> INS8250B August 1995. Here is a config snippet from a machine with a Digi - International PC/8 with 16550. It has 8 modems connected to - these 8 lines, and they work just great. Do not forget to add + International PC/8 with 16550. It has 8 modems connected to + these 8 lines, and they work just great. Do not forget to add options COM_MULTIPORT or it will not work very well! @@ -2676,7 +2676,7 @@ device sio11 at isa? port 0x138 tty flags 0xb05 irq 9 vector siointr< You either need the kernel sources installed so you can recompile the necessary options or you will need - someone else to compile it for you. The 2.0.5 default + someone else to compile it for you. The 2.0.5 default kernel does not come with multiport support enabled and you will need to add a device entry for each port anyways. @@ -2692,15 +2692,15 @@ device sio11 at isa? port 0x138 tty flags 0xb05 irq 9 vector siointr< One important note — the actual UART chips for the Boca 16 - are in the connector box, not on the internal board itself. So - if you have it unplugged, probes of those ports will fail. I + are in the connector box, not on the internal board itself. So + if you have it unplugged, probes of those ports will fail. I have never tested booting with the box unplugged and plugging it back in, and I suggest you do not either. If you do not already have a custom kernel configuration file set up, refer to Kernel Configuration for - general procedures. The following are the specifics for the + general procedures. The following are the specifics for the Boca 16 board and assume you are using the kernel name MYKERNEL and editing with vi. @@ -2717,13 +2717,13 @@ options COM_MULTIPORT Where the current device sion lines are, - you will need to add 16 more devices. Only + you will need to add 16 more devices. Only the last device includes the interrupt vector for the - board. (See the sio4 manual page for detail as + board. (See the sio4 manual page for detail as to why.) The following example is for a Boca Board with - an interrupt of 3, and a base IO address 100h. The IO + an interrupt of 3, and a base IO address 100h. The IO address for Each port is +8 hexadecimal from the - previous port, thus the 100h, 108h, 110h... addresses. + previous port, thus the 100h, 108h, 110h... addresses. device sio1 at isa? port 0x100 tty flags 0x1005 @@ -2742,21 +2742,21 @@ device sio16 at isa? port 0x178 tty flags 0x1005 irq 3 vector siointrYY indicates if FIFO is enabled or disabled(enabled), IRQ sharing is used(yes) and if there - is an AST/4 compatible IRQ control register(no). In this + is an AST/4 compatible IRQ control register(no). In this example, flags 0x1005 indicates that the master port is - sio16. If I added another board and assigned sio17 + sio16. If I added another board and assigned sio17 through sio28, the flags for all 16 ports on that board would be 0x1C05, where - 1C indicates the minor number of the master port. Do not + 1C indicates the minor number of the master port. Do not change the 05 setting. Save and complete the kernel configuration, - recompile, install and reboot. Presuming you have + recompile, install and reboot. Presuming you have successfully installed the recompiled kernel and have it set to the correct address and IRQ, your boot message should indicate the successful probe of the Boca ports @@ -2834,7 +2834,7 @@ sio16: type 16550A (multiport master) &prompt.root; echo at > ttyd* - for each device you have made. You + for each device you have made. You should see the RX lights flash for each working port. @@ -2852,7 +2852,7 @@ sio16: type 16550A (multiport master) The Cyclades multiport cards are based on the cy driver instead of the usual sio driver used by other multiport - cards. Configuration is a simple matter of: + cards. Configuration is a simple matter of: @@ -2884,7 +2884,7 @@ device cy0 at isa? tty irq 10 iomem 0xd4000 iosiz 0x2000 vector cyintr If appropriate, add dialup entries to /etc/ttys - by duplicating serial device (ttyd) entries and using ttyc in place of ttyd. For example: + by duplicating serial device (ttyd) entries and using ttyc in place of ttyd. For example: ttyc0 "/usr/libexec/getty std.38400" unknown on insecure @@ -2953,16 +2953,16 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure devised by Seagate Technology, the makers of the first affordable 5.25" winchester disk. - The acronym says Enhanced, and rightly so. In the first place + The acronym says Enhanced, and rightly so. In the first place the speed of the interface is higher, 10 or 15 Mbits/second - instead of the 5 Mbits/second of ST412 interfaced drives. Secondly + instead of the 5 Mbits/second of ST412 interfaced drives. Secondly some higher level commands are added, making the ESDI interface - somewhat 'smarter' to the operating system driver writers. It is - by no means as smart as SCSI by the way. ESDI is standardized by + somewhat 'smarter' to the operating system driver writers. It is + by no means as smart as SCSI by the way. ESDI is standardized by ANSI. Capacities of the drives are boosted by putting more sectors - on each track. Typical is 35 sectors per track, high capacity + on each track. Typical is 35 sectors per track, high capacity drives I have seen were up to 54 sectors/track. Although ESDI has been largely obsoleted by IDE and SCSI @@ -2978,19 +2978,19 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Physical connections The ESDI interface uses two cables connected to each - drive. One cable is a 34 pin flat cable edge connector that + drive. One cable is a 34 pin flat cable edge connector that carries the command and status signals from the controller to - the drive and vice-versa. The command cable is daisy chained - between all the drives. So, it forms a bus onto which all + the drive and vice-versa. The command cable is daisy chained + between all the drives. So, it forms a bus onto which all drives are connected. The second cable is a 20 pin flat cable edge connector - that carries the data to and from the drive. This cable is + that carries the data to and from the drive. This cable is radially connected, so each drive has its own direct connection to the controller. To the best of my knowledge PC ESDI controllers are - limited to using a maximum of 2 drives per controller. This is + limited to using a maximum of 2 drives per controller. This is compatibility feature(?) left over from the WD1003 standard that reserves only a single bit for device addressing. @@ -3000,13 +3000,13 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Device addressing On each command cable a maximum of 7 devices and 1 - controller can be present. To enable the controller to + controller can be present. To enable the controller to uniquely identify which drive it addresses, each ESDI device is equipped with jumpers or switches to select the devices address. On PC type controllers the first drive is set to address - 0, the second disk to address 1. Always + 0, the second disk to address 1. Always make sure you set each disk to an unique address! So, on a PC with its two drives/controller maximum the first drive is drive 0, the second is drive 1. @@ -3018,14 +3018,14 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure The daisy chained command cable (the 34 pin cable remember?) needs to be terminated at the last drive on the - chain. For this purpose ESDI drives come with a termination + chain. For this purpose ESDI drives come with a termination resistor network that can be removed or disabled by a jumper when it is not used. So, one and only one drive, the one at the farthest end of the command cable has its - terminator installed/enabled. The controller automatically - terminates the other end of the cable. Please note that this + terminator installed/enabled. The controller automatically + terminates the other end of the cable. Please note that this implies that the controller must be at one end of the cable and not in the middle. @@ -3039,12 +3039,12 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure place? People who tried ESDI disks with FreeBSD are known to have - developed a profound sense of frustration. A combination of + developed a profound sense of frustration. A combination of factors works against you to produce effects that are hard to understand when you have never seen them before. This has also led to the popular legend ESDI and FreeBSD is - a plain NO-GO. The following sections try to list all the + a plain NO-GO. The following sections try to list all the pitfalls and solutions. @@ -3052,12 +3052,12 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure ESDI speed variants As briefly mentioned before, ESDI comes in two speed - flavors. The older drives and controllers use a 10 - Mbits/second data transfer rate. Newer stuff uses 15 + flavors. The older drives and controllers use a 10 + Mbits/second data transfer rate. Newer stuff uses 15 Mbits/second. It is not hard to imagine that 15 Mbits/second drive cause - problems on controllers laid out for 10 Mbits/second. As + problems on controllers laid out for 10 Mbits/second. As always, consult your controller and drive documentation to see if things match. @@ -3068,18 +3068,18 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Mainstream ESDI drives use 34 to 36 sectors per track. Most (older) controllers cannot handle more than this number - of sectors. Newer, higher capacity, drives use higher numbers - of sectors per track. For instance, I own a 670 Mb drive that + of sectors. Newer, higher capacity, drives use higher numbers + of sectors per track. For instance, I own a 670 Mb drive that has 54 sectors per track. In my case, the controller could not handle this number of - sectors. It proved to work well except that it only used 35 - sectors on each track. This meant losing a lot of disk + sectors. It proved to work well except that it only used 35 + sectors on each track. This meant losing a lot of disk space. Once again, check the documentation of your hardware for - more info. Going out-of-spec like in the example might or - might not work. Give it a try or get another more capable + more info. Going out-of-spec like in the example might or + might not work. Give it a try or get another more capable controller. @@ -3088,26 +3088,26 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Hard or soft sectoring Most ESDI drives allow hard or soft sectoring to be - selected using a jumper. Hard sectoring means that the drive + selected using a jumper. Hard sectoring means that the drive will produce a sector pulse on the start of each new sector. The controller uses this pulse to tell when it should start to write or read. Hard sectoring allows a selection of sector size (normally - 256, 512 or 1024 bytes per formatted sector). FreeBSD uses - 512 byte sectors. The number of sectors per track also varies + 256, 512 or 1024 bytes per formatted sector). FreeBSD uses + 512 byte sectors. The number of sectors per track also varies while still using the same number of bytes per formatted - sector. The number of unformatted bytes + sector. The number of unformatted bytes per sector varies, dependent on your controller it needs more - or less overhead bytes to work correctly. Pushing more + or less overhead bytes to work correctly. Pushing more sectors on a track of course gives you more usable space, but might give problems if your controller needs more bytes than the drive offers. In case of soft sectoring, the controller itself - determines where to start/stop reading or writing. For ESDI + determines where to start/stop reading or writing. For ESDI hard sectoring is the default (at least on everything I came - across). I never felt the urge to try soft sectoring. + across). I never felt the urge to try soft sectoring. In general, experiment with sector settings before you install FreeBSD because you need to re-run the low-level @@ -3119,21 +3119,21 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Low level formatting ESDI drives need to be low level formatted before they are - usable. A reformat is needed whenever you figgle with the + usable. A reformat is needed whenever you figgle with the number of sectors/track jumpers or the physical orientation of - the drive (horizontal, vertical). So, first think, then - format. The format time must not be underestimated, for big + the drive (horizontal, vertical). So, first think, then + format. The format time must not be underestimated, for big disks it can take hours. After a low level format, a surface scan is done to find - and flag bad sectors. Most disks have a manufacturer bad block - list listed on a piece of paper or adhesive sticker. In + and flag bad sectors. Most disks have a manufacturer bad block + list listed on a piece of paper or adhesive sticker. In addition, on most disks the list is also written onto the - disk. Please use the manufacturer's list. It is much easier to + disk. Please use the manufacturer's list. It is much easier to remap a defect now than after FreeBSD is installed. Stay away from low-level formatters that mark all sectors - of a track as bad as soon as they find one bad sector. Not + of a track as bad as soon as they find one bad sector. Not only does this waste space, it also and more importantly causes you grief with bad144 (see the section on bad144). @@ -3144,8 +3144,8 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Translations Translations, although not exclusively a ESDI-only - problem, might give you real trouble. Translations come in - multiple flavors. Most of them have in common that they + problem, might give you real trouble. Translations come in + multiple flavors. Most of them have in common that they attempt to work around the limitations posed upon disk geometries by the original IBM PC/AT design (thanks IBM!). @@ -3153,27 +3153,27 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure First of all there is the (in)famous 1024 cylinder limit. For a system to be able to boot, the stuff (whatever operating system) must be in the first 1024 cylinders of a - disk. Only 10 bits are available to encode the cylinder - number. For the number of sectors the limit is 64 (0-63). When + disk. Only 10 bits are available to encode the cylinder + number. For the number of sectors the limit is 64 (0-63). When you combine the 1024 cylinder limit with the 16 head limit (also a design feature) you max out at fairly limited disk sizes. To work around this problem, the manufacturers of ESDI PC - controllers added a BIOS prom extension on their boards. This + controllers added a BIOS prom extension on their boards. This BIOS extension handles disk I/O for booting (and for some operating systems all disk I/O) - by using translation. For instance, a big drive might be + by using translation. For instance, a big drive might be presented to the system as having 32 heads and 64 - sectors/track. The result is that the number of cylinders is + sectors/track. The result is that the number of cylinders is reduced to something below 1024 and is therefore usable by the - system without problems. It is noteworthy to know that FreeBSD - does not use the BIOS after its kernel has started. More on + system without problems. It is noteworthy to know that FreeBSD + does not use the BIOS after its kernel has started. More on this later. A second reason for translations is the fact that most older system BIOSes could only handle drives with 17 sectors - per track (the old ST412 standard). Newer system BIOSes + per track (the old ST412 standard). Newer system BIOSes usually have a user-defined drive type (in most cases this is drive type 47). @@ -3187,8 +3187,8 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure While on the subject of translations, I have seen one controller type (but there are probably more like this) offer the option to logically split a drive in multiple partitions - as a BIOS option. I had select 1 drive == 1 partition because - this controller wrote this info onto the disk. On power-up it + as a BIOS option. I had select 1 drive == 1 partition because + this controller wrote this info onto the disk. On power-up it read the info and presented itself to the system based on the info from the disk. @@ -3198,19 +3198,19 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Spare sectoring Most ESDI controllers offer the possibility to remap bad - sectors. During/after the low-level format of the disk bad + sectors. During/after the low-level format of the disk bad sectors are marked as such, and a replacement sector is put in place (logically of course) of the bad one. In most cases the remapping is done by using N-1 sectors on each track for actual data storage, and sector N itself is - the spare sector. N is the total number of sectors physically - available on the track. The idea behind this is that the - operating system sees a 'perfect' disk without bad sectors. In + the spare sector. N is the total number of sectors physically + available on the track. The idea behind this is that the + operating system sees a 'perfect' disk without bad sectors. In the case of FreeBSD this concept is not usable. The problem is that the translation from bad to good is performed by the BIOS of the - ESDI controller. FreeBSD, being a true 32 bit operating + ESDI controller. FreeBSD, being a true 32 bit operating system, does not use the BIOS after it has been booted. Instead, it has device drivers that talk directly to the hardware. @@ -3225,35 +3225,35 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Bad block handling - The preceding section leaves us with a problem. The + The preceding section leaves us with a problem. The controller's bad block handling is not usable and still FreeBSD's filesystems assume perfect media without any flaws. - To solve this problem, FreeBSD use the bad144 tool. Bad144 (named after a + To solve this problem, FreeBSD use the bad144 tool. Bad144 (named after a Digital Equipment standard for bad block handling) scans a - FreeBSD slice for bad blocks. Having found these bad blocks, + FreeBSD slice for bad blocks. Having found these bad blocks, it writes a table with the offending block numbers to the end of the FreeBSD slice. When the disk is in operation, the disk accesses are - checked against the table read from the disk. Whenever a + checked against the table read from the disk. Whenever a block number is requested that is in the bad144 list, a replacement block (also from the end of the FreeBSD slice) is - used. In this way, the bad144 replacement scheme presents + used. In this way, the bad144 replacement scheme presents 'perfect' media to the FreeBSD filesystems. There are a number of potential pitfalls associated with - the use of bad144. First of all, the slice cannot have more - than 126 bad sectors. If your drive has a high number of bad + the use of bad144. First of all, the slice cannot have more + than 126 bad sectors. If your drive has a high number of bad sectors, you might need to divide it into multiple FreeBSD - slices each containing less than 126 bad sectors. Stay away + slices each containing less than 126 bad sectors. Stay away from low-level format programs that mark every sector of a track as bad when they - find a flaw on the track. As you can imagine, the 126 limit + find a flaw on the track. As you can imagine, the 126 limit is quickly reached when the low-level format is done this way. Second, if the slice contains the root filesystem, the - slice should be within the 1024 cylinder BIOS limit. During + slice should be within the 1024 cylinder BIOS limit. During the boot process the bad144 list is read using the BIOS and this only succeeds when the list is within the 1024 cylinder limit. @@ -3270,17 +3270,17 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Kernel configuration - ESDI disks are handled by the same wddriver as IDE and ST412 MFM disks. The + ESDI disks are handled by the same wddriver as IDE and ST412 MFM disks. The wd driver should work for all WD1003 compatible interfaces. Most hardware is jumperable for one of two different I/O - address ranges and IRQ lines. This allows you to have two wd + address ranges and IRQ lines. This allows you to have two wd type controllers in one system. When your hardware allows non-standard strappings, you can use these with FreeBSD as long as you enter the correct info - into the kernel config file. An example from the kernel config + into the kernel config file. An example from the kernel config file (they live in /sys/i386/conf BTW). @@ -3305,36 +3305,36 @@ disk wd3 at wdc1 drive 1 Adaptec 2320 controllers I successfully installed FreeBSD onto a ESDI disk - controlled by a ACB-2320. No other operating system was + controlled by a ACB-2320. No other operating system was present on the disk. To do so I low level formatted the disk using NEFMT.EXE (ftpable from www.adaptec.com) and answered NO to the question whether the disk should be formatted with a spare - sector on each track. The BIOS on the ACD-2320 was disabled. I + sector on each track. The BIOS on the ACD-2320 was disabled. I used the free configurable option in the system BIOS to allow the BIOS to boot it. Before using NEFMT.EXE I tried to format the disk using - the ACB-2320 BIOS builtin formatter. This proved to be a show + the ACB-2320 BIOS builtin formatter. This proved to be a show stopper, because it did not give me an option to disable spare - sectoring. With spare sectoring enabled the FreeBSD + sectoring. With spare sectoring enabled the FreeBSD installation process broke down on the bad144 run. Please check carefully which ACB-232xy variant you have. The x is either 0 or 2, indicating a controller without or with a floppy controller on board. - The y is more interesting. It can either be a blank, a - A-8 or a D. A blank indicates a plain 10 Mbits/second - controller. An A-8 indicates a 15 Mbits/second controller - capable of handling 52 sectors/track. A D means a 15 + The y is more interesting. It can either be a blank, a + A-8 or a D. A blank indicates a plain 10 Mbits/second + controller. An A-8 indicates a 15 Mbits/second controller + capable of handling 52 sectors/track. A D means a 15 Mbits/second controller that can also handle drives with > 36 sectors/track (also 52 ?). All variations should be capable of using 1:1 - interleaving. Use 1:1, FreeBSD is fast enough to handle + interleaving. Use 1:1, FreeBSD is fast enough to handle it. @@ -3343,12 +3343,12 @@ disk wd3 at wdc1 drive 1 Western Digital WD1007 controllers I successfully installed FreeBSD onto a ESDI disk - controlled by a WD1007 controller. To be precise, it was a - WD1007-WA2. Other variations of the WD1007 do exist. + controlled by a WD1007 controller. To be precise, it was a + WD1007-WA2. Other variations of the WD1007 do exist. To get it to work, I had to disable the sector translation - and the WD1007's onboard BIOS. This implied I could not use - the low-level formatter built into this BIOS. Instead, I + and the WD1007's onboard BIOS. This implied I could not use + the low-level formatter built into this BIOS. Instead, I grabbed WDFMT.EXE from www.wdc.com Running this formatted my drive just fine. @@ -3358,7 +3358,7 @@ disk wd3 at wdc1 drive 1 Ultrastor U14F controllers According to multiple reports from the net, Ultrastor ESDI - boards work OK with FreeBSD. I lack any further info on + boards work OK with FreeBSD. I lack any further info on particular settings. @@ -3405,88 +3405,88 @@ disk wd3 at wdc1 drive 1 Copyright © 1995, &a.wilko;.July 6, 1996. - SCSI is an acronym for Small Computer Systems Interface. It + SCSI is an acronym for Small Computer Systems Interface. It is an ANSI standard that has become one of the leading I/O buses - in the computer industry. The foundation of the SCSI standard was + in the computer industry. The foundation of the SCSI standard was laid by Shugart Associates (the same guys that gave the world the first mini floppy disks) when they introduced the SASI bus (Shugart Associates Standard Interface). After some time an industry effort was started to come to a more strict standard allowing devices from different vendors to - work together. This effort was recognized in the ANSI SCSI-1 - standard. The SCSI-1 standard (approx 1985) is rapidly becoming - obsolete. The current standard is SCSI-2 (see Further reading), with SCSI-3 on the drawing boards. In addition to a physical interconnection standard, SCSI defines a logical (command set) standard to which disk devices - must adhere. This standard is called the Common Command Set (CCS) + must adhere. This standard is called the Common Command Set (CCS) and was developed more or less in parallel with ANSI SCSI-1. SCSI-2 includes the (revised) CCS as part of the standard itself. - The commands are dependent on the type of device at hand. It does + The commands are dependent on the type of device at hand. It does not make much sense of course to define a Write command for a scanner. The SCSI bus is a parallel bus, which comes in a number of - variants. The oldest and most used is an 8 bit wide bus, with - single-ended signals, carried on 50 wires. (If you do not know + variants. The oldest and most used is an 8 bit wide bus, with + single-ended signals, carried on 50 wires. (If you do not know what single-ended means, do not worry, that is what this document is all about.) Modern designs also use 16 bit wide buses, with - differential signals. This allows transfer speeds of - 20Mbytes/second, on cables lengths of up to 25 meters. SCSI-2 + differential signals. This allows transfer speeds of + 20Mbytes/second, on cables lengths of up to 25 meters. SCSI-2 allows a maximum bus width of 32 bits, using an additional cable. Quickly emerging are Ultra SCSI (also called Fast-20) and Ultra2 - (also called Fast-40). Fast-20 is 20 million transfers per second + (also called Fast-40). Fast-20 is 20 million transfers per second (20 Mbytes/sec on a 8 bit bus), Fast-40 is 40 million transfers - per second (40 Mbytes/sec on a 8 bit bus). Most hard drives sold + per second (40 Mbytes/sec on a 8 bit bus). Most hard drives sold today are single-ended Ultra SCSI (8 or 16 bits). Of course the SCSI bus not only has data lines, but also a - number of control signals. A very elaborate protocol is part of + number of control signals. A very elaborate protocol is part of the standard to allow multiple devices to share the bus in an - efficient manner. In SCSI-2, the data is always checked using a - separate parity line. In pre-SCSI-2 designs parity was + efficient manner. In SCSI-2, the data is always checked using a + separate parity line. In pre-SCSI-2 designs parity was optional. In SCSI-3 even faster bus types are introduced, along with a serial SCSI busses that reduces the cabling overhead and allows a - higher maximum bus length. You might see names like SSA and - Fiberchannel in this context. None of the serial buses are + higher maximum bus length. You might see names like SSA and + Fiberchannel in this context. None of the serial buses are currently in widespread use (especially not in the typical FreeBSD - environment). For this reason the serial bus types are not + environment). For this reason the serial bus types are not discussed any further. As you could have guessed from the description above, SCSI - devices are intelligent. They have to be to adhere to the SCSI - standard (which is over 2 inches thick BTW). So, for a hard disk + devices are intelligent. They have to be to adhere to the SCSI + standard (which is over 2 inches thick BTW). So, for a hard disk drive for instance you do not specify a head/cylinder/sector to address a particular block, but simply the number of the block you - want. Elaborate caching schemes, automatic bad block replacement + want. Elaborate caching schemes, automatic bad block replacement etc are all made possible by this 'intelligent device' approach. On a SCSI bus, each possible pair of devices can communicate. Whether their function allows this is another matter, but the - standard does not restrict it. To avoid signal contention, the 2 + standard does not restrict it. To avoid signal contention, the 2 devices have to arbitrate for the bus before using it. The philosophy of SCSI is to have a standard that allows - older-standard devices to work with newer-standard ones. So, an - old SCSI-1 device should normally work on a SCSI-2 bus. I say + older-standard devices to work with newer-standard ones. So, an + old SCSI-1 device should normally work on a SCSI-2 bus. I say Normally, because it is not absolutely sure that the implementation of an old device follows the (old) standard closely - enough to be acceptable on a new bus. Modern devices are usually + enough to be acceptable on a new bus. Modern devices are usually more well-behaved, because the standardization has become more strict and is better adhered to by the device manufacturers. Generally speaking, the chances of getting a working set of devices on a single bus is better when all the devices are SCSI-2 - or newer. This implies that you do not have to dump all your old + or newer. This implies that you do not have to dump all your old stuff when you get that shiny 2GB disk: I own a system on which a pre-SCSI-1 disk, a SCSI-2 QIC tape unit, a SCSI-1 helical scan - tape unit and 2 SCSI-1 disks work together quite happily. From a + tape unit and 2 SCSI-1 disks work together quite happily. From a performance standpoint you might want to separate your older and newer (=faster) devices however. @@ -3494,13 +3494,13 @@ disk wd3 at wdc1 drive 1 Components of SCSI - As said before, SCSI devices are smart. The idea is to put + As said before, SCSI devices are smart. The idea is to put the knowledge about intimate hardware details onto the SCSI - device itself. In this way, the host system does not have to + device itself. In this way, the host system does not have to worry about things like how many heads are hard disks has, or - how many tracks there are on a specific tape device. If you are + how many tracks there are on a specific tape device. If you are curious, the standard specifies commands with which you can - query your devices on their hardware particulars. FreeBSD uses + query your devices on their hardware particulars. FreeBSD uses this capability during boot to check out what devices are connected and whether they need any special treatment. @@ -3510,15 +3510,15 @@ disk wd3 at wdc1 drive 1 every odd new device that is introduced. For cabling and connectors there is a golden rule: get good - stuff. With bus speeds going up all the time you will save + stuff. With bus speeds going up all the time you will save yourself a lot of grief by using good material. So, gold plated connectors, shielded cabling, sturdy connector hoods with strain reliefs etc are the way to go. - Second golden rule: do no use cables longer than necessary. I + Second golden rule: do no use cables longer than necessary. I once spent 3 days hunting down a problem with a flaky machine only to discover that shortening the SCSI bus by 1 meter solved - the problem. And the original bus length was well within the + the problem. And the original bus length was well within the SCSI specification. @@ -3527,15 +3527,15 @@ disk wd3 at wdc1 drive 1 SCSI bus types From an electrical point of view, there are two incompatible - bus types: single-ended and differential. This means that there + bus types: single-ended and differential. This means that there are two different main groups of SCSI devices and controllers, - which cannot be mixed on the same bus. It is possible however + which cannot be mixed on the same bus. It is possible however to use special converter hardware to transform a single-ended - bus into a differential one (and vice versa). The differences + bus into a differential one (and vice versa). The differences between the bus types are explained in the next sections. In lots of SCSI related documentation there is a sort of - jargon in use to abbreviate the different bus types. A small + jargon in use to abbreviate the different bus types. A small list: @@ -3573,16 +3573,16 @@ disk wd3 at wdc1 drive 1 Fast means that the timing on the bus is somewhat different, so that on a narrow (8 bit) bus 10 Mbytes/sec are possible - instead of 5 Mbytes/sec for 'slow' SCSI. As discussed before, + instead of 5 Mbytes/sec for 'slow' SCSI. As discussed before, bus speeds of 20 and 40 million transfers/second are also emerging (Fast-20 == Ultra SCSI and Fast-40 == Ultra2 SCSI). The data lines > 8 are only used for data transfers and - device addressing. The transfers of commands and status + device addressing. The transfers of commands and status messages etc are only performed on the lowest 8 data lines. The standard allows narrow devices to operate on a wide bus. - The usable bus width is negotiated between the devices. You + The usable bus width is negotiated between the devices. You have to watch your device addressing closely when mixing wide and narrow. @@ -3592,19 +3592,19 @@ disk wd3 at wdc1 drive 1 A single-ended SCSI bus uses signals that are either 5 Volts or 0 Volts (indeed, TTL levels) and are relative to a - COMMON ground reference. A singled ended 8 bit SCSI bus has + COMMON ground reference. A singled ended 8 bit SCSI bus has approximately 25 ground lines, who are all tied to a single - `rail' on all devices. A standard single ended bus has a - maximum length of 6 meters. If the same bus is used with + `rail' on all devices. A standard single ended bus has a + maximum length of 6 meters. If the same bus is used with fast-SCSI devices, the maximum length allowed drops to 3 - meters. Fast-SCSI means that instead of 5Mbytes/sec the bus + meters. Fast-SCSI means that instead of 5Mbytes/sec the bus allows 10Mbytes/sec transfers. Fast-20 (Ultra SCSI) and Fast-40 allow for 20 and 40 - million transfers/second respectively. So, F20 is 20 + million transfers/second respectively. So, F20 is 20 Mbytes/second on a 8 bit bus, 40 Mbytes/second on a 16 bit bus - etc. For F20 the max bus length is 1.5 meters, for F40 it - becomes 0.75 meters. Be aware that F20 is pushing the limits + etc. For F20 the max bus length is 1.5 meters, for F40 it + becomes 0.75 meters. Be aware that F20 is pushing the limits quite a bit, so you will quickly find out if your SCSI bus is electrically sound. @@ -3615,7 +3615,7 @@ disk wd3 at wdc1 drive 1 It is obvious that with the newer fast-SCSI devices the - bus length can become a real bottleneck. This is why the + bus length can become a real bottleneck. This is why the differential SCSI bus was introduced in the SCSI-2 standard. @@ -3624,14 +3624,14 @@ disk wd3 at wdc1 drive 1 linkend="scsi-further-reading">Further reading) itself, connectors etc are listed there in painstaking detail. - Beware of devices using non-standard cabling. For instance + Beware of devices using non-standard cabling. For instance Apple uses a 25pin D-type connecter (like the one on serial - ports and parallel printers). Considering that the official + ports and parallel printers). Considering that the official SCSI bus needs 50 pins you can imagine the use of this - connector needs some 'creative cabling'. The reduction of the + connector needs some 'creative cabling'. The reduction of the number of ground wires they used is a bad idea, you better stick to 50 pins cabling in accordance with the SCSI - standard. For Fast-20 and 40 do not even think about buses + standard. For Fast-20 and 40 do not even think about buses like this. @@ -3641,27 +3641,27 @@ disk wd3 at wdc1 drive 1 A differential SCSI bus has a maximum length of 25 meters. Quite a difference from the 3 meters for a single-ended - fast-SCSI bus. The idea behind differential signals is that - each bus signal has its own return wire. So, each signal is - carried on a (preferably twisted) pair of wires. The voltage + fast-SCSI bus. The idea behind differential signals is that + each bus signal has its own return wire. So, each signal is + carried on a (preferably twisted) pair of wires. The voltage difference between these two wires determines whether the - signal is asserted or de-asserted. To a certain extent the + signal is asserted or de-asserted. To a certain extent the voltage difference between ground and the signal wire pair is not relevant (do not try 10 kVolts though). It is beyond the scope of this document to explain why - this differential idea is so much better. Just accept that + this differential idea is so much better. Just accept that electrically seen the use of differential signals gives a much - better noise margin. You will normally find differential buses - in use for inter-cabinet connections. Because of the lower + better noise margin. You will normally find differential buses + in use for inter-cabinet connections. Because of the lower cost single ended is mostly used for shorter buses like inside cabinets. There is nothing that stops you from using differential stuff with FreeBSD, as long as you use a controller that has - device driver support in FreeBSD. As an example, Adaptec + device driver support in FreeBSD. As an example, Adaptec marketed the AHA1740 as a single ended board, whereas the - AHA1744 was differential. The software interface to the host + AHA1744 was differential. The software interface to the host is identical for both. @@ -3670,62 +3670,62 @@ disk wd3 at wdc1 drive 1 Terminators Terminators in SCSI terminology are resistor networks that - are used to get a correct impedance matching. Impedance + are used to get a correct impedance matching. Impedance matching is important to get clean signals on the bus, without - reflections or ringing. If you once made a long distance + reflections or ringing. If you once made a long distance telephone call on a bad line you probably know what - reflections are. With 20Mbytes/sec traveling over your SCSI + reflections are. With 20Mbytes/sec traveling over your SCSI bus, you do not want signals echoing back. Terminators come in various incarnations, with more or - less sophisticated designs. Of course, there are internal and - external variants. Many SCSI devices come with a number of + less sophisticated designs. Of course, there are internal and + external variants. Many SCSI devices come with a number of sockets in which a number of resistor networks can (must be!) - installed. If you remove terminators from a device, carefully - store them. You will need them when you ever decide to - reconfigure your SCSI bus. There is enough variation in even + installed. If you remove terminators from a device, carefully + store them. You will need them when you ever decide to + reconfigure your SCSI bus. There is enough variation in even these simple tiny things to make finding the exact replacement - a frustrating business. There are also SCSI devices that have + a frustrating business. There are also SCSI devices that have a single jumper to enable or disable a built-in terminator. There are special terminators you can stick onto a flat cable - bus. Others look like external connectors, or a connector - hood without a cable. So, lots of choice as you can + bus. Others look like external connectors, or a connector + hood without a cable. So, lots of choice as you can see. There is much debate going on if and when you should switch from simple resistor (passive) terminators to active - terminators. Active terminators contain slightly more - elaborate circuit to give cleaner bus signals. The general + terminators. Active terminators contain slightly more + elaborate circuit to give cleaner bus signals. The general consensus seems to be that the usefulness of active termination increases when you have long buses and/or fast - devices. If you ever have problems with your SCSI buses you - might consider trying an active terminator. Try to borrow one + devices. If you ever have problems with your SCSI buses you + might consider trying an active terminator. Try to borrow one first, they reputedly are quite expensive. Please keep in mind that terminators for differential and - single-ended buses are not identical. You should not mix the two variants. + single-ended buses are not identical. You should not mix the two variants. OK, and now where should you install your terminators? - This is by far the most misunderstood part of SCSI. And it is - by far the simplest. The rule is: every + This is by far the most misunderstood part of SCSI. And it is + by far the simplest. The rule is: every single line on the SCSI bus has 2 (two) terminators, one at each end of the bus. So, two and not one or three - or whatever. Do yourself a favor and stick to this rule. It + or whatever. Do yourself a favor and stick to this rule. It will save you endless grief, because wrong termination has the - potential to introduce highly mysterious bugs. (Note the + potential to introduce highly mysterious bugs. (Note the “potential” here; the nastiest part is that it may or may not work.) A common pitfall is to have an internal (flat) cable in a machine and also an external cable attached to the controller. It seems almost everybody forgets to remove the terminators - from the controller. The terminator must now be on the last + from the controller. The terminator must now be on the last external device, and not on the controller! In general, every reconfiguration of a SCSI bus must pay attention to this. - Termination is to be done on a per-line basis. This + Termination is to be done on a per-line basis. This means if you have both narrow and wide buses connected to the same host adapter, you need to enable termination on the higher 8 bits of the bus on the adapter (as well as the last @@ -3733,19 +3733,19 @@ disk wd3 at wdc1 drive 1 What I did myself is remove all terminators from my SCSI - devices and controllers. I own a couple of external + devices and controllers. I own a couple of external terminators, for both the Centronics-type external cabling and - for the internal flat cable connectors. This makes + for the internal flat cable connectors. This makes reconfiguration much easier. On modern devices, sometimes integrated terminators are - used. These things are special purpose integrated circuits - that can be dis/en-abled with a control pin. It is not - necessary to physically remove them from a device. You may + used. These things are special purpose integrated circuits + that can be dis/en-abled with a control pin. It is not + necessary to physically remove them from a device. You may find them on newer host adapters, sometimes they are software - configurable, using some sort of setup tool. Some will even + configurable, using some sort of setup tool. Some will even auto-detect the cables attached to the connectors and - automatically set up the termination as necessary. At any + automatically set up the termination as necessary. At any rate, consult your documentation! @@ -3754,30 +3754,30 @@ disk wd3 at wdc1 drive 1 Terminator power The terminators discussed in the previous chapter need - power to operate properly. On the SCSI bus, a line is - dedicated to this purpose. So, simple huh? + power to operate properly. On the SCSI bus, a line is + dedicated to this purpose. So, simple huh? - Not so. Each device can provide its own terminator power - to the terminator sockets it has on-device. But if you have + Not so. Each device can provide its own terminator power + to the terminator sockets it has on-device. But if you have external terminators, or when the device supplying the terminator power to the SCSI bus line is switched off you are in trouble. The idea is that initiators (these are devices that initiate actions on the bus, a discussion follows) must supply - terminator power. All SCSI devices are allowed (but not + terminator power. All SCSI devices are allowed (but not required) to supply terminator power. To allow for un-powered devices on a bus, the terminator - power must be supplied to the bus via a diode. This prevents + power must be supplied to the bus via a diode. This prevents the backflow of current to un-powered devices. To prevent all kinds of nastiness, the terminator power is - usually fused. As you can imagine, fuses might blow. This - can, but does not have to, lead to a non functional bus. If + usually fused. As you can imagine, fuses might blow. This + can, but does not have to, lead to a non functional bus. If multiple devices supply terminator power, a single blown fuse - will not put you out of business. A single supplier with a - blown fuse certainly will. Clever external terminators + will not put you out of business. A single supplier with a + blown fuse certainly will. Clever external terminators sometimes have a LED indication that shows whether terminator power is present. @@ -3793,47 +3793,47 @@ disk wd3 at wdc1 drive 1 distinguish or address the different devices connected to it. - This is done by means of the SCSI or target ID. Each - device has a unique target ID. You can select the ID to which + This is done by means of the SCSI or target ID. Each + device has a unique target ID. You can select the ID to which a device must respond using a set of jumpers, or a dip switch, - or something similar. Some SCSI host adapters let you change - the target ID from the boot menu. (Yet some others will not + or something similar. Some SCSI host adapters let you change + the target ID from the boot menu. (Yet some others will not let you change the ID from 7.) Consult the documentation of your device for more information. Beware of multiple devices configured to use the same ID. - Chaos normally reigns in this case. A pitfall is that one of + Chaos normally reigns in this case. A pitfall is that one of the devices sharing the same ID sometimes even manages to answer to I/O requests! - For an 8 bit bus, a maximum of 8 targets is possible. The + For an 8 bit bus, a maximum of 8 targets is possible. The maximum is 8 because the selection is done bitwise using the 8 - data lines on the bus. For wide buses this increases to the + data lines on the bus. For wide buses this increases to the number of data lines (usually 16). A narrow SCSI device can not communicate with a SCSI - device with a target ID larger than 7. This means it is + device with a target ID larger than 7. This means it is generally not a good idea to move your SCSI host adapter's target ID to something higher than 7 (or your CD-ROM will stop working). The higher the SCSI target ID, the higher the priority the - devices has. When it comes to arbitration between devices + devices has. When it comes to arbitration between devices that want to use the bus at the same time, the device that has - the highest SCSI ID will win. This also means that the SCSI - host adapter usually uses target ID 7. Note however that the + the highest SCSI ID will win. This also means that the SCSI + host adapter usually uses target ID 7. Note however that the lower 8 IDs have higher priorities than the higher 8 IDs on a - wide-SCSI bus. Thus, the order of target IDs is: [7 6 .. 1 0 15 14 .. 9 8] on a wide-SCSI - system. (If you you are wondering why the lower 8 have higher + wide-SCSI bus. Thus, the order of target IDs is: [7 6 .. 1 0 15 14 .. 9 8] on a wide-SCSI + system. (If you you are wondering why the lower 8 have higher priority, read the previous paragraph for a hint.) For a further subdivision, the standard allows for Logical - Units or LUNs for short. A single target ID may have multiple - LUNs. For example, a tape device including a tape changer may + Units or LUNs for short. A single target ID may have multiple + LUNs. For example, a tape device including a tape changer may have LUN 0 for the tape device itself, and LUN 1 for the tape - changer. In this way, the host system can address each of the + changer. In this way, the host system can address each of the functional units of the tape changer as desired. @@ -3841,22 +3841,22 @@ disk wd3 at wdc1 drive 1 Bus layout - SCSI buses are linear. So, not shaped like Y-junctions, + SCSI buses are linear. So, not shaped like Y-junctions, star topologies, rings, cobwebs or whatever else people might - want to invent. One of the most common mistakes is for people + want to invent. One of the most common mistakes is for people with wide-SCSI host adapters to connect devices on all three connecters (external connector, internal wide connector, - internal narrow connector). Don't do that. It may appear to + internal narrow connector). Don't do that. It may appear to work if you are really lucky, but I can almost guarantee that your system will stop functioning at the most unfortunate moment (this is also known as “Murphy's law”). You might notice that the terminator issue discussed - earlier becomes rather hairy if your bus is not linear. Also, + earlier becomes rather hairy if your bus is not linear. Also, if you have more connectors than devices on your internal SCSI cable, make sure you attach devices on connectors on both ends instead of using the connectors in the middle and let one or - both ends dangle. This will screw up the termination of the + both ends dangle. This will screw up the termination of the bus. The electrical characteristics, its noise margins and @@ -3880,76 +3880,76 @@ disk wd3 at wdc1 drive 1 a electrically sound bus. When you want to use a SCSI disk on your PC as boot disk, - you must aware of some quirks related to PC BIOSes. The PC + you must aware of some quirks related to PC BIOSes. The PC BIOS in its first incarnation used a low level physical - interface to the hard disk. So, you had to tell the BIOS + interface to the hard disk. So, you had to tell the BIOS (using a setup tool or a BIOS built-in setup) how your disk - physically looked like. This involved stating number of heads, + physically looked like. This involved stating number of heads, number of cylinders, number of sectors per track, obscure things like precompensation and reduced write current cylinder etc. One might be inclined to think that since SCSI disks are - smart you can forget about this. Alas, the arcane setup issue - is still present today. The system BIOS needs to know how to + smart you can forget about this. Alas, the arcane setup issue + is still present today. The system BIOS needs to know how to access your SCSI disk with the head/cyl/sector method in order to load the FreeBSD kernel during boot. The SCSI host adapter or SCSI controller you have put in your AT/EISA/PCI/whatever bus to connect your disk therefore - has its own on-board BIOS. During system startup, the SCSI + has its own on-board BIOS. During system startup, the SCSI BIOS takes over the hard disk interface routines from the - system BIOS. To fool the system BIOS, the system setup is - normally set to No hard disk present. Obvious, isn't + system BIOS. To fool the system BIOS, the system setup is + normally set to No hard disk present. Obvious, isn't it? The SCSI BIOS itself presents to the system a so called - translated drive. This means + translated drive. This means that a fake drive table is constructed that allows the PC to - boot the drive. This translation is often (but not always) + boot the drive. This translation is often (but not always) done using a pseudo drive with 64 heads and 32 sectors per - track. By varying the number of cylinders, the SCSI BIOS - adapts to the actual drive size. It is useful to note that 32 - * 64 / 2 = the size of your drive in megabytes. The division + track. By varying the number of cylinders, the SCSI BIOS + adapts to the actual drive size. It is useful to note that 32 + * 64 / 2 = the size of your drive in megabytes. The division by 2 is to get from disk blocks that are normally 512 bytes in size to Kbytes. - Right. All is well now?! No, it is not. The system BIOS - has another quirk you might run into. The number of cylinders - of a bootable hard disk cannot be greater than 1024. Using the + Right. All is well now?! No, it is not. The system BIOS + has another quirk you might run into. The number of cylinders + of a bootable hard disk cannot be greater than 1024. Using the translation above, this is a show-stopper for disks greater - than 1 GB. With disk capacities going up all the time this is + than 1 GB. With disk capacities going up all the time this is causing problems. Fortunately, the solution is simple: just use another - translation, e.g. with 128 heads instead of 32. In most cases + translation, e.g. with 128 heads instead of 32. In most cases new SCSI BIOS versions are available to upgrade older SCSI - host adapters. Some newer adapters have an option, in the form + host adapters. Some newer adapters have an option, in the form of a jumper or software setup selection, to switch the translation the SCSI BIOS uses. It is very important that all operating systems on the disk use the same translation to get the - right idea about where to find the relevant partitions. So, + right idea about where to find the relevant partitions. So, when installing FreeBSD you must answer any questions about heads/cylinders etc using the translated values your host adapter uses. Failing to observe the translation issue might lead to un-bootable systems or operating systems overwriting each - others partitions. Using fdisk you should be able to see all + others partitions. Using fdisk you should be able to see all partitions. You might have heard some talk of “lying” devices? Older FreeBSD kernels used to report the geometry of SCSI disks when - booting. An example from one of my systems: + booting. An example from one of my systems: aha0 targ 0 lun 0: <MICROP 1588-15MB1057404HSP4> sd0: 636MB (1303250 total sec), 1632 cyl, 15 head, 53 sec, bytes/sec 512 - Newer kernels usually do not report this information. e.g. + Newer kernels usually do not report this information. e.g. (bt0:0:0): "SEAGATE ST41651 7574" type 0 fixed SCSI 2 @@ -3958,15 +3958,15 @@ sd0(bt0:0:0): Direct-Access 1350MB (2766300 512 byte sectors) Why has this changed? - This info is retrieved from the SCSI disk itself. Newer - disks often use a technique called zone bit recording. The + This info is retrieved from the SCSI disk itself. Newer + disks often use a technique called zone bit recording. The idea is that on the outer cylinders of the drive there is more - space so more sectors per track can be put on them. This + space so more sectors per track can be put on them. This results in disks that have more tracks on outer cylinders than on the inner cylinders and, last but not least, have more - capacity. You can imagine that the value reported by the drive + capacity. You can imagine that the value reported by the drive when inquiring about the geometry now becomes suspect at best, - and nearly always misleading. When asked for a geometry , it + and nearly always misleading. When asked for a geometry , it is nearly always better to supply the geometry used by the BIOS, or if the BIOS is never going to know about this disk, (e.g. it is not a booting disk) to @@ -3977,23 +3977,23 @@ sd0(bt0:0:0): Direct-Access 1350MB (2766300 512 byte sectors) SCSI subsystem design - FreeBSD uses a layered SCSI subsystem. For each different - controller card a device driver is written. This driver knows - all the intimate details about the hardware it controls. The + FreeBSD uses a layered SCSI subsystem. For each different + controller card a device driver is written. This driver knows + all the intimate details about the hardware it controls. The driver has a interface to the upper layers of the SCSI subsystem through which it receives its commands and reports back any status. On top of the card drivers there are a number of more - generic drivers for a class of devices. More specific: a + generic drivers for a class of devices. More specific: a driver for tape devices (abbreviation: st), magnetic disks - (sd), CD-ROMs (cd) etc. In case you are wondering where you + (sd), CD-ROMs (cd) etc. In case you are wondering where you can find this stuff, it all lives in - /sys/scsi. See the man pages in section 4 + /sys/scsi. See the man pages in section 4 for more details. The multi level design allows a decoupling of low-level - bit banging and more high level stuff. Adding support for + bit banging and more high level stuff. Adding support for another piece of hardware is a much more manageable problem. @@ -4004,19 +4004,19 @@ sd0(bt0:0:0): Direct-Access 1350MB (2766300 512 byte sectors) Dependent on your hardware, the kernel configuration file must contain one or more lines describing your host - adapter(s). This includes I/O addresses, interrupts etc. + adapter(s). This includes I/O addresses, interrupts etc. Consult the man page for your adapter driver to get more info. Apart from that, check out /sys/i386/conf/LINT for an overview of a - kernel config file. LINT contains every - possible option you can dream of. It does + kernel config file. LINT contains every + possible option you can dream of. It does not imply LINT will actually get you to a working kernel at all. Although it is probably stating the obvious: the kernel - config file should reflect your actual hardware setup. So, + config file should reflect your actual hardware setup. So, interrupts, I/O addresses etc must match the kernel config - file. During system boot messages will be displayed to + file. During system boot messages will be displayed to indicate whether the configured hardware was actually found. @@ -4074,7 +4074,7 @@ device cd0 at scbus? [the first ever CD-ROM found, no wiring] The example above tells the kernel to look for a ahc (Adaptec 274x) controller, then for an NCR/Symbios board, and - so on. The lines following the controller specifications tell + so on. The lines following the controller specifications tell the kernel to configure specific devices but only attach them when they match the target ID and LUN specified on the corresponding bus. @@ -4082,37 +4082,37 @@ device cd0 at scbus? [the first ever CD-ROM found, no wiring] Wired down devices get “first shot” at the unit numbers so the first non “wired down” device, is allocated the unit number one greater than the highest “wired down” unit number - for that kind of device. So, if you had a SCSI tape at target + for that kind of device. So, if you had a SCSI tape at target ID 2 it would be configured as st2, as the tape at target ID 6 is wired down to unit number 1. Wired down devices need not be found to get their unit - number. The unit number for a wired down device is reserved - for that device, even if it is turned off at boot time. This + number. The unit number for a wired down device is reserved + for that device, even if it is turned off at boot time. This allows the device to be turned on and brought on-line at a - later time, without rebooting. Notice that a device's unit + later time, without rebooting. Notice that a device's unit number has no relationship with its target ID on the SCSI bus. Below is another example of a kernel config file as used - by FreeBSD version < 2.0.5. The difference with the first - example is that devices are not “wired down”. “Wired down” + by FreeBSD version < 2.0.5. The difference with the first + example is that devices are not “wired down”. “Wired down” means that you specify which SCSI target belongs to which device. A kernel built to the config file below will attach the first SCSI disk it finds to sd0, the second disk to sd1 etc. If you ever removed or added a disk, all other devices of the - same type (disk in this case) would 'move around'. This + same type (disk in this case) would 'move around'. This implies you have to change /etc/fstab each time. Although the old style still works, you are strongly recommended to use this new - feature. It will save you a lot of grief whenever you shift - your hardware around on the SCSI buses. So, when you re-use + feature. It will save you a lot of grief whenever you shift + your hardware around on the SCSI buses. So, when you re-use your old trusty config file after upgrading from a pre-FreeBSD2.0.5.R system check this out. @@ -4134,15 +4134,15 @@ device st0 [support for 2 SCSI tapes] [for the CD-ROM] device cd0 #Only need one of these, the code dynamically grows - Both examples support SCSI disks. If during boot more + Both examples support SCSI disks. If during boot more devices of a specific type (e.g. sd disks) are found than are configured in the booting kernel, the system will simply allocate more devices, incrementing the unit number starting - at the last number “wired down”. If there are no “wired down” + at the last number “wired down”. If there are no “wired down” devices then counting starts at unit 0. Use man 4 scsi to check for - the latest info on the SCSI subsystem. For more detailed info + the latest info on the SCSI subsystem. For more detailed info on host adapter drivers use eg man 4 ahc for info on the Adaptec 294x driver. @@ -4153,24 +4153,24 @@ device cd0 #Only need one of these, the code dynamically growsExperience has shown that some devices are slow to respond to INQUIRY commands after a SCSI bus reset (which happens at - boot time). An INQUIRY command is sent by the kernel on boot + boot time). An INQUIRY command is sent by the kernel on boot to see what kind of device (disk, tape, CD-ROM etc) is - connected to a specific target ID. This process is called + connected to a specific target ID. This process is called device probing by the way. To work around the 'slow response' problem, FreeBSD allows a tunable delay time before the SCSI devices are probed - following a SCSI bus reset. You can set this delay time in + following a SCSI bus reset. You can set this delay time in your kernel configuration file using a line like: options SCSI_DELAY=15 #Be pessimistic about Joe SCSI device - This line sets the delay time to 15 seconds. On my own + This line sets the delay time to 15 seconds. On my own system I had to use 3 seconds minimum to get my trusty old - CD-ROM drive to be recognized. Start with a high value (say 30 + CD-ROM drive to be recognized. Start with a high value (say 30 seconds or so) when you have problems with device - recognition. If this helps, tune it back until it just stays + recognition. If this helps, tune it back until it just stays working. @@ -4180,13 +4180,13 @@ options SCSI_DELAY=15 #Be pessimistic about Joe SCSI deviceAlthough the SCSI standard tries to be complete and concise, it is a complex standard and implementing things - correctly is no easy task. Some vendors do a better job then + correctly is no easy task. Some vendors do a better job then others. This is exactly where the “rogue” devices come into view. Rogues are devices that are recognized by the FreeBSD kernel - as behaving slightly (...) non-standard. Rogue devices are - reported by the kernel when booting. An example for two of my + as behaving slightly (...) non-standard. Rogue devices are + reported by the kernel when booting. An example for two of my cartridge tape units: @@ -4199,14 +4199,14 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue For instance, there are devices that respond to all LUNs on a certain target ID, even if they are actually only one - device. It is easy to see that the kernel might be fooled into + device. It is easy to see that the kernel might be fooled into believing that there are 8 LUNs at that particular target ID. The confusion this causes is left as an exercise to the reader. The SCSI subsystem of FreeBSD recognizes devices with bad habits by looking at the INQUIRY response they send when - probed. Because the INQUIRY response also includes the version + probed. Because the INQUIRY response also includes the version number of the device firmware, it is even possible that for different firmware versions different workarounds are used. See e.g. /sys/scsi/st.c and @@ -4214,14 +4214,14 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue this is done. This scheme works fine, but keep in mind that it of course - only works for devices that are known to be weird. If you are + only works for devices that are known to be weird. If you are the first to connect your bogus Mumbletech SCSI CD-ROM you might be the one that has to define which workaround is needed. After you got your Mumbletech working, please send the required workaround to the FreeBSD development team for - inclusion in the next release of FreeBSD. Other Mumbletech + inclusion in the next release of FreeBSD. Other Mumbletech owners will be grateful to you. @@ -4230,14 +4230,14 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue Multiple LUN devices In some cases you come across devices that use multiple - logical units (LUNs) on a single SCSI ID. In most cases - FreeBSD only probes devices for LUN 0. An example are so + logical units (LUNs) on a single SCSI ID. In most cases + FreeBSD only probes devices for LUN 0. An example are so called bridge boards that connect 2 non-SCSI harddisks to a SCSI bus (e.g. an Emulex MD21 found in old Sun systems). This means that any devices with LUNs != 0 are not - normally found during device probe on system boot. To work + normally found during device probe on system boot. To work around this problem you must add an appropriate entry in /sys/scsi/scsiconf.c and rebuild your kernel. @@ -4260,7 +4260,7 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue } The kernel on boot scans the inquiry data it receives - against the table and acts accordingly. See the source for + against the table and acts accordingly. See the source for more info. @@ -4272,9 +4272,9 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue support what is called tagged command queuing (TCQ). In a nutshell, TCQ allows the device to have multiple I/O - requests outstanding at the same time. Because the device is + requests outstanding at the same time. Because the device is intelligent, it can optimise its operations (like head - positioning) based on its own request queue. On SCSI devices + positioning) based on its own request queue. On SCSI devices like RAID (Redundant Array of Independent Disks) arrays the TCQ function is indispensable to take advantage of the device's inherent parallelism. @@ -4286,8 +4286,8 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue It should be noted however that TCQ requires device driver support and that some devices implemented it “not quite right” - in their firmware. This problem bit me once, and it leads to - highly mysterious problems. In such cases, try to disable + in their firmware. This problem bit me once, and it leads to + highly mysterious problems. In such cases, try to disable TCQ. @@ -4296,18 +4296,18 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue Busmaster host adapters Most, but not all, SCSI host adapters are bus mastering - controllers. This means that they can do I/O on their own + controllers. This means that they can do I/O on their own without putting load onto the host CPU for data movement. This is of course an advantage for a multitasking - operating system like FreeBSD. It must be noted however that + operating system like FreeBSD. It must be noted however that there might be some rough edges. For instance an Adaptec 1542 controller can be set to use different transfer speeds on the host bus (ISA or AT in this - case). The controller is settable to different rates because - not all motherboards can handle the higher speeds. Problems + case). The controller is settable to different rates because + not all motherboards can handle the higher speeds. Problems like hangups, bad data etc might be the result of using a higher data transfer rate then your motherboard can stomach. @@ -4318,12 +4318,12 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue In the case of a Adaptec 1542, there is an option that can be put into the kernel config file to allow dynamic determination of the right, read: fastest feasible, transfer - rate. This option is disabled by default: + rate. This option is disabled by default: options "TUNE_1542" #dynamic tune of bus DMA speed - Check the man pages for the host adapter that you use. Or + Check the man pages for the host adapter that you use. Or better still, use the ultimate documentation (read: driver source). @@ -4334,7 +4334,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speedTracking down problems The following list is an attempt to give a guideline for the - most common SCSI problems and their solutions. It is by no means + most common SCSI problems and their solutions. It is by no means complete. @@ -4382,16 +4382,16 @@ options "TUNE_1542" #dynamic tune of bus DMA speed If you can compile a kernel, make one with the SCSIDEBUG option, and try accessing the device with - debugging turned on for that device. If your device does + debugging turned on for that device. If your device does not even probe at startup, you may have to define the address of the device that is failing, and the desired debug level in /sys/scsi/scsidebug.h. If it probes but just does not work, you can use the scsi8 command to dynamically set a debug level to it in a running kernel (if SCSIDEBUG is - defined). This will give you copious debugging output with - which to confuse the gurus. see man 4 - scsi for more exact information. Also look at + defined). This will give you copious debugging output with + which to confuse the gurus. See man 4 + scsi for more exact information. Also look at man 8 scsi. @@ -4474,7 +4474,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speed “SCSI: Understanding the Small Computer System - Interface”, written by NCR Corporation. Available from: + Interface”, written by NCR Corporation. Available from: Prentice Hall, Englewood Cliffs, NJ, 07632 Phone: (201) 767-5937 ISBN 0-13-796855-8 @@ -4488,13 +4488,13 @@ options "TUNE_1542" #dynamic tune of bus DMA speed “SCSI Interconnection Guide Book”, an AMP publication (dated 4/93, Catalog 65237) that lists the various SCSI - connectors and suggests cabling schemes. Available from + connectors and suggests cabling schemes. Available from AMP at (800) 522-6752 or (717) 564-0100 “Fast Track to SCSI”, A Product Guide written by - Fujitsu. Available from: Prentice Hall, Englewood Cliffs, + Fujitsu. Available from: Prentice Hall, Englewood Cliffs, NJ, 07632 Phone: (201) 767-5937 ISBN 0-13-307000-X @@ -4517,11 +4517,11 @@ options "TUNE_1542" #dynamic tune of bus DMA speedOn Usenet the newsgroups comp.periphs.scsi and comp.periphs are - noteworthy places to look for more info. You can also find the + noteworthy places to look for more info. You can also find the SCSI-Faq there, which is posted periodically. Most major SCSI device and host adapter suppliers operate - ftp sites and/or BBS systems. They may be valuable sources of + ftp sites and/or BBS systems. They may be valuable sources of information about the devices you own. @@ -4563,11 +4563,11 @@ options "TUNE_1542" #dynamic tune of bus DMA speedAs mentioned in the SCSI section, virtually all SCSI hard drives sold today are SCSI-2 compliant and thus will work fine as long as you connect them to - a supported SCSI host adapter. Most problems people encounter + a supported SCSI host adapter. Most problems people encounter are either due to badly designed cabling (cable too long, star topology, etc.), insufficient termination, or defective parts. Please refer to the SCSI - section first if your SCSI hard drive is not working. However, + section first if your SCSI hard drive is not working. However, there are a couple of things you may want to take into account before you purchase SCSI hard drives for your system. @@ -4576,62 +4576,62 @@ options "TUNE_1542" #dynamic tune of bus DMA speedRotational speed Rotational speeds of SCSI drives sold today range from - around 4,500RPM to 10,000RPM. Most of them are either 5,400RPM - or 7,200RPM. Even though the 7,200RPM drives can generally + around 4,500RPM to 10,000RPM. Most of them are either 5,400RPM + or 7,200RPM. Even though the 7,200RPM drives can generally transfer data faster, they run considerably hotter than their - 5,400RPM counterparts. A large fraction of today's disk drive - malfunctions are heat-related. If you do not have very good + 5,400RPM counterparts. A large fraction of today's disk drive + malfunctions are heat-related. If you do not have very good cooling in your PC case, you may want to stick with 5,400RPM or slower drives. Note that newer drives, with higher areal recording densities, can deliver much more bits per rotation than older - ones. Today's top-of-line 5,400RPM drives can sustain a + ones. Today's top-of-line 5,400RPM drives can sustain a throughput comparable to 7,200RPM drives of one or two model - generations ago. The number to find on the spec sheet for - bandwidth is “internal data (or transfer) rate”. It is + generations ago. The number to find on the spec sheet for + bandwidth is “internal data (or transfer) rate”. It is usually in megabits/sec so divide it by 8 and you'll get the rough approximation of how much megabytes/sec you can get out of the drive. (If you are a speed maniac and want a 10,000RPM drive for your cute little peecee, be my guest; however, those drives - become extremely hot. Don't even think about it if you don't + become extremely hot. Don't even think about it if you don't have a fan blowing air directly at the drive or a properly ventilated disk enclosure.) Obviously, the latest 10,000RPM drives and 7,200RPM drives can deliver more data than the latest 5,400RPM drives, so if absolute bandwidth is the necessity for your applications, you - have little choice but to get the faster drives. Also, if you + have little choice but to get the faster drives. Also, if you need low latency, faster drives are better; not only do they usually have lower average seek times, but also the rotational delay is one place where slow-spinning drives can never beat a - faster one. (The average rotational latency is half the time + faster one. (The average rotational latency is half the time it takes to rotate the drive once; thus, it's 3 milliseconds for 10,000RPM drives, 4.2ms for 7,200RPM drives and 5.6ms for 5,400RPM drives.) Latency is seek time plus rotational delay. Make sure you understand whether you need low latency or more accesses per second, though; in the latter case (e.g., news servers), it may not be optimal to purchase one big fast - drive. You can achieve similar or even better results by + drive. You can achieve similar or even better results by using the ccd (concatenated disk) driver to create a striped disk array out of multiple slower drives for comparable overall cost. Make sure you have adequate air flow around the drive, - especially if you are going to use a fast-spinning drive. You + especially if you are going to use a fast-spinning drive. You generally need at least 1/2" (1.25cm) of spacing above and - below a drive. Understand how the air flows through your PC - case. Most cases have the power supply suck the air out of - the back. See where the air flows in, and put the drive where + below a drive. Understand how the air flows through your PC + case. Most cases have the power supply suck the air out of + the back. See where the air flows in, and put the drive where it will have the largest volume of cool air flowing around it. You may need to seal some unwanted holes or add a new fan for effective cooling. - Another consideration is noise. Many 7,200 or faster + Another consideration is noise. Many 7,200 or faster drives generate a high-pitched whine which is quite unpleasant - to most people. That, plus the extra fans often required for + to most people. That, plus the extra fans often required for cooling, may make 7,200 or faster drives unsuitable for some office and home environments. @@ -4640,11 +4640,11 @@ options "TUNE_1542" #dynamic tune of bus DMA speed Form factor - Most SCSI drives sold today are of 3.5" form factor. They + Most SCSI drives sold today are of 3.5" form factor. They come in two different heights; 1.6" (“half-height”) or 1" - (“low-profile”). The half-height drive is the same height as a - CD-ROM drive. However, don't forget the spacing rule - mentioned in the previous section. If you have three standard + (“low-profile”). The half-height drive is the same height as a + CD-ROM drive. However, don't forget the spacing rule + mentioned in the previous section. If you have three standard 3.5" drive bays, you will not be able to put three half-height drives in there (without frying them, that is). @@ -4654,32 +4654,32 @@ options "TUNE_1542" #dynamic tune of bus DMA speedInterface The majority of SCSI hard drives sold today are Ultra or - Ultra-wide SCSI. The maximum bandwidth of Ultra SCSI is - 20MB/sec, and Ultra-wide SCSI is 40MB/sec. There is no + Ultra-wide SCSI. The maximum bandwidth of Ultra SCSI is + 20MB/sec, and Ultra-wide SCSI is 40MB/sec. There is no difference in max cable length between Ultra and Ultra-wide; however, the more devices you have on the same bus, the sooner - you will start having bus integrity problems. Unless you have + you will start having bus integrity problems. Unless you have a well-designed disk enclosure, it is not easy to make more than 5 or 6 Ultra SCSI drives work on a single bus. On the other hand, if you need to connect many drives, - going for Fast-wide SCSI may not be a bad idea. That will + going for Fast-wide SCSI may not be a bad idea. That will have the same max bandwidth as Ultra (narrow) SCSI, while - electronically it's much easier to get it “right”. My advice + electronically it's much easier to get it “right”. My advice would be: if you want to connect many disks, get wide SCSI drives; they usually cost a little more but it may save you - down the road. (Besides, if you can't afford the cost + down the road. (Besides, if you can't afford the cost difference, you shouldn't be building a disk array.) There are two variant of wide SCSI drives; 68-pin and - 80-pin SCA (Single Connector Attach). The SCA drives don't + 80-pin SCA (Single Connector Attach). The SCA drives don't have a separate 4-pin power connector, and also read the SCSI - ID settings through the 80-pin connector. If you are really + ID settings through the 80-pin connector. If you are really serious about building a large storage system, get SCA drives and a good SCA enclosure (dual power supply with at least one - extra fan). They are more electronically sound than 68-pin + extra fan). They are more electronically sound than 68-pin counterparts because there is no “stub” of the SCSI bus inside - the disk canister as in arrays built from 68-pin drives. They + the disk canister as in arrays built from 68-pin drives. They are easier to install too (you just need to screw the drive in the canister, instead of trying to squeeze in your fingers in a tight place to hook up all the little cables (like the SCSI @@ -4706,9 +4706,9 @@ options "TUNE_1542" #dynamic tune of bus DMA speedGeneral tape access commands mt1 provides generic access to the tape - drives. Some of the more common commands are + drives. Some of the more common commands are rewind, erase, and - status. See the mt1 + status. See the mt1 manual page for a detailed description. @@ -4717,9 +4717,9 @@ options "TUNE_1542" #dynamic tune of bus DMA speedController Interfaces There are several different interfaces that support tape - drives. The interfaces are SCSI, IDE, Floppy and Parallel Port. + drives. The interfaces are SCSI, IDE, Floppy and Parallel Port. A wide variety of tape drives are available for these - interfaces. Controllers are discussed in + interfaces. Controllers are discussed in Disk/tape controllers. @@ -4732,13 +4732,13 @@ options "TUNE_1542" #dynamic tune of bus DMA speedst4 manual page for a detailed description. The drives listed below are currently being used by members - of the FreeBSD community. They are not the only drives that - will work with FreeBSD. They just happen to be the ones that we + of the FreeBSD community. They are not the only drives that + will work with FreeBSD. They just happen to be the ones that we use. @@ -4871,19 +4871,19 @@ options "TUNE_1542" #dynamic tune of bus DMA speedThis is a QIC tape drive. - Native capacity is 1.35GB when using QIC-1350 tapes. This + Native capacity is 1.35GB when using QIC-1350 tapes. This drive will read and write QIC-150 (DC6150), QIC-250 (DC6250), and QIC-525 (DC6525) tapes as well. Data transfer rate is 350kB/s using - dump8. Rates of 530kB/s have been + dump8. Rates of 530kB/s have been reported when using Amanda Production of this drive has been discontinued. The SCSI bus connector on this tape drive is reversed from - that on most other SCSI devices. Make sure that you have + that on most other SCSI devices. Make sure that you have enough SCSI cable to twist the cable one-half turn before and after the Archive Anaconda tape drive, or turn your other SCSI devices upside-down. @@ -4892,7 +4892,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speed If you have a SCSI-2 controller, short jumper 6. - Otherwise, the drive behaves are a SCSI-1 device. When + Otherwise, the drive behaves are a SCSI-1 device. When operating as a SCSI-1 device, this drive, “locks” the SCSI bus during some tape operations, including: fsf, rewind, and rewoffl. @@ -4964,16 +4964,16 @@ options "TUNE_1542" #dynamic tune of bus DMA speedThe boot message identifier for this drive is ARCHIVE VIPER 150 21531 -004 Archive Viper 150 is a known rogue - type 1 removable SCSI 1. A multitude of firmware revisions - exist for this drive. Your drive may report different numbers + type 1 removable SCSI 1. A multitude of firmware revisions + exist for this drive. Your drive may report different numbers (e.g 21247 -005. This is a QIC tape drive. - Native capacity is 150/250MB. Both 150MB (DC6150) and - 250MB (DC6250) tapes have the recording format. The 250MB - tapes are approximately 67% longer than the 150MB tapes. This - drive can read 120MB tapes as well. It can not write 120MB + Native capacity is 150/250MB. Both 150MB (DC6150) and + 250MB (DC6250) tapes have the recording format. The 250MB + tapes are approximately 67% longer than the 150MB tapes. This + drive can read 120MB tapes as well. It can not write 120MB tapes. Data transfer rate is 100kB/s @@ -4985,8 +4985,8 @@ options "TUNE_1542" #dynamic tune of bus DMA speedst4). Under FreeBSD 2.2-current, use mt - blocksize 512 to set the blocksize. (The - particular drive had firmware revision 21247 -005. Other + blocksize 512 to set the blocksize. (The + particular drive had firmware revision 21247 -005. Other firmware revisions may behave differently) Previous versions of FreeBSD did not have this problem. @@ -5013,7 +5013,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speedData transfer rate is 180kB/s at 90 inches/sec. The drive reads QIC-525, QIC-150, QIC-120 and QIC-24 - tapes. Writes QIC-525, QIC-150, and QIC-120. + tapes. Writes QIC-525, QIC-150, and QIC-120. Firmware revisions prior to 25462 -011 are bug ridden and will not function properly. @@ -5075,7 +5075,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speedData transfer rate is 1.2MB/s. - This drive is identical to the Quantum DLT2000. The drive + This drive is identical to the Quantum DLT2000. The drive firmware can be set to emulate several well-known drives, including an Exabyte 8mm drive. @@ -5102,9 +5102,9 @@ options "TUNE_1542" #dynamic tune of bus DMA speed WARNING: This drive does not meet the SCSI-2 - specifications. The drive locks up completely in response to + specifications. The drive locks up completely in response to a SCSI MODE_SELECT command unless there is a formatted tape in - the drive. Before using this drive, set the tape blocksize + the drive. Before using this drive, set the tape blocksize with @@ -5112,7 +5112,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speedBefore using a minicartridge for the first time, the - minicartridge must be formated. FreeBSD 2.1.0-RELEASE and + minicartridge must be formated. FreeBSD 2.1.0-RELEASE and earlier: @@ -5146,12 +5146,12 @@ options "TUNE_1542" #dynamic tune of bus DMA speedData transfer rate is 270kB/s. This drive is fairly slow in responding to the SCSI bus - during boot. A custom kernel may be required (set SCSI_DELAY + during boot. A custom kernel may be required (set SCSI_DELAY to 10 seconds). There are a large number of firmware configurations for this drive, some have been customized to a particular vendor's - hardware. The firmware can be changed via EPROM + hardware. The firmware can be changed via EPROM replacement. Production of this drive has been discontinued. @@ -5203,11 +5203,11 @@ options "TUNE_1542" #dynamic tune of bus DMA speedThe boot message identifier for this drive is HP C1533A 9503 type 1 removable SCSI 2. - This is a DDS-2 tape drive. DDS-2 means hardware data + This is a DDS-2 tape drive. DDS-2 means hardware data compression and narrower tracks for increased data capacity. - Native capacity is 4GB when using 120m tapes. This drive + Native capacity is 4GB when using 120m tapes. This drive supports hardware data compression. Data transfer rate is 510kB/s. @@ -5215,7 +5215,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speedThis drive is used in Hewlett-Packard's SureStore 6000eU and 6000i tape drives and C1533A DDS-2 DAT drive. - The drive has a block of 8 dip switches. The proper + The drive has a block of 8 dip switches. The proper settings for FreeBSD are: 1 ON; 2 ON; 3 OFF; 4 ON; 5 ON; 6 ON; 7 ON; 8 ON. @@ -5261,11 +5261,11 @@ options "TUNE_1542" #dynamic tune of bus DMA speed - Switch 3 controls MRS (Media Recognition System). MRS - tapes have stripes on the transparent leader. These identify - the tape as DDS (Digital Data Storage) grade media. Tapes + Switch 3 controls MRS (Media Recognition System). MRS + tapes have stripes on the transparent leader. These identify + the tape as DDS (Digital Data Storage) grade media. Tapes that do not have the stripes will be treated as - write-protected. Switch 3 OFF enables MRS. Switch 3 ON + write-protected. Switch 3 OFF enables MRS. Switch 3 ON disables MRS. See HP @@ -5273,8 +5273,8 @@ options "TUNE_1542" #dynamic tune of bus DMA speedHewlett-Packard Disk and Tape Technical Information for more information on configuring this drive. Warning: Quality control on these - drives varies greatly. One FreeBSD core-team member has - returned 2 of these drives. Neither lasted more than 5 + drives varies greatly. One FreeBSD core-team member has + returned 2 of these drives. Neither lasted more than 5 months. Reported by: &a.se; @@ -5288,7 +5288,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speed type 1 removable SCSI 2 Sequential-Access density code 0x13, variable blocks. - This is a DDS-1 tape drive. DDS-1 is the original DAT + This is a DDS-1 tape drive. DDS-1 is the original DAT tape format. Native capacity is 2GB when using 90m tapes. @@ -5302,12 +5302,12 @@ options "TUNE_1542" #dynamic tune of bus DMA speed The HP C1534A DDS format DAT drive has two indicator - lights, one green and one amber. The green one indicates tape + lights, one green and one amber. The green one indicates tape action: slow flash during load, steady when loaded, fast flash - during read/write operations. The amber one indicates + during read/write operations. The amber one indicates warnings: slow flash when cleaning is required or tape is nearing the end of its useful life, steady indicates an hard - fault. (factory service required?) + fault. (factory service required?) Reported by Gary Crutcher gcrutchr@nightflight.com @@ -5318,11 +5318,11 @@ options "TUNE_1542" #dynamic tune of bus DMA speedThe boot message identifier for this drive is "". - This is a DDS-2 tape drive with a tape changer. DDS-2 + This is a DDS-2 tape drive with a tape changer. DDS-2 means hardware data compression and narrower tracks for increased data capacity. - Native capacity is 24GB when using 120m tapes. This drive + Native capacity is 24GB when using 120m tapes. This drive supports hardware data compression. Data transfer rate is 510kB/s (native). @@ -5331,15 +5331,15 @@ options "TUNE_1542" #dynamic tune of bus DMA speed12000e tape drive. - The drive has two selectors on the rear panel. The - selector closer to the fan is SCSI id. The other selector + The drive has two selectors on the rear panel. The + selector closer to the fan is SCSI id. The other selector should be set to 7. - There are four internal switches. These should be set: 1 + There are four internal switches. These should be set: 1 ON; 2 ON; 3 ON; 4 OFF. At present the kernel drivers do not automatically change - tapes at the end of a volume. This shell script can be used + tapes at the end of a volume. This shell script can be used to change tapes: @@ -5389,7 +5389,7 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" -A C620 type 1 removable SCSI 2 Sequential-Access density code 0x13 - This is a DDS-1 tape drive. DDS-1 is the original DAT + This is a DDS-1 tape drive. DDS-1 is the original DAT tape format. Native capacity is 1.2GB. @@ -5407,7 +5407,7 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" The boot message identifier for this drive is HP HP35470A 9 09 type 1 removable SCSI 2 - This is a DDS-1 tape drive. DDS-1 is the original DAT + This is a DDS-1 tape drive. DDS-1 is the original DAT tape format. Native capacity is 2GB when using 90m tapes. @@ -5421,8 +5421,8 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" DAT drive, and HP C1536A DDS format DAT drive. Warning: Quality control on these - drives varies greatly. One FreeBSD core-team member has - returned 5 of these drives. None lasted more than 9 + drives varies greatly. One FreeBSD core-team member has + returned 5 of these drives. None lasted more than 9 months. Reported by: David Dawes dawes@rf900.physics.usyd.edu.au @@ -5437,13 +5437,13 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" 1009 type 1 removable SCSI 2 Sequential-Access density code 0x13. - This is a DDS-DC tape drive. DDS-DC is DDS-1 with - hardware data compression. DDS-1 is the original DAT tape + This is a DDS-DC tape drive. DDS-DC is DDS-1 with + hardware data compression. DDS-1 is the original DAT tape format. - Native capacity is 2GB when using 90m tapes. It cannot - handle 120m tapes. This drive supports hardware data - compression. Please refer to the section on Native capacity is 2GB when using 90m tapes. It cannot + handle 120m tapes. This drive supports hardware data + compression. Please refer to the section on HP C1533A for the proper switch settings. @@ -5460,10 +5460,10 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" Pressing the front panel button will eject the tape and bring the tape drive back to life. - WARNING: HP 35480-03110 only. On at least two occasions + WARNING: HP 35480-03110 only. On at least two occasions this tape drive when used with FreeBSD 2.1.0, an IBM Server 320 and an 2940W SCSI controller resulted in all SCSI disk - partitions being lost. The problem has not be analyzed or + partitions being lost. The problem has not be analyzed or resolved at this time. @@ -5473,21 +5473,21 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" URL="http://www.sel.sony.com/SEL/ccpg/storage/tape/t5000.html">Sony SDT-5000 There are at least two significantly different models: one - is a DDS-1 and the other DDS-2. The DDS-1 version is - SDT-5000 3.02. The DDS-2 version is SONY SDT-5000 327M. - The DDS-2 version has a 1MB cache. This cache is able to keep + is a DDS-1 and the other DDS-2. The DDS-1 version is + SDT-5000 3.02. The DDS-2 version is SONY SDT-5000 327M. + The DDS-2 version has a 1MB cache. This cache is able to keep the tape streaming in almost any circumstances. The boot message identifier for this drive is SONY SDT-5000 3.02 type 1 removable SCSI 2 Sequential-Access density code 0x13 - Native capacity is 4GB when using 120m tapes. This drive + Native capacity is 4GB when using 120m tapes. This drive supports hardware data compression. Data transfer rate is depends upon the model or the drive. The rate is 630kB/s for the SONY SDT-5000 327M while - compressing the data. For the SONY SDT-5000 3.02, the data + compressing the data. For the SONY SDT-5000 3.02, the data transfer rate is 225kB/s. In order to get this drive to stream, set the blocksize to @@ -5513,13 +5513,13 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" Native capacity is 150/250MB. This drive has quirks which are known and work around code - is present in the scsi tape device driver (st4). Upgrading the firmware to XXX + is present in the scsi tape device driver (st4). Upgrading the firmware to XXX version will fix the quirks and provide SCSI 2 capabilities. Data transfer rate is 80kB/s. - IBM and Emerald units will not work. Replacing the + IBM and Emerald units will not work. Replacing the firmware EPROM of these units will solve the problem. Reported by: Michael Smith @@ -5546,14 +5546,14 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" This is a QIC tape drive. - Native capacity is 2.5GB. The drive will read all + Native capacity is 2.5GB. The drive will read all cartridges from the 60 MB (DC600A) upwards, and write 150 MB - (DC6150) upwards. Hardware compression is optionally + (DC6150) upwards. Hardware compression is optionally supported for the 2.5 GB cartridges. This drives quirks are known and pre-compiled into the scsi tape device driver (st4) - beginning with FreeBSD 2.2-current. For previous versions of + beginning with FreeBSD 2.2-current. For previous versions of FreeBSD, use mt to read one block from the tape, rewind the tape, and then execute the backup program (mt fsr 1; mt rewind; dump @@ -5580,9 +5580,9 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" Data transfer rate is 180kB/s. - The drive reads 60, 120, 150, and 525MB tapes. The drive - will not write 60MB (DC600 cartridge) tapes. In order to - overwrite 120 and 150 tapes reliably, first erase (mt erase) the tape. 120 and 150 tapes + The drive reads 60, 120, 150, and 525MB tapes. The drive + will not write 60MB (DC600 cartridge) tapes. In order to + overwrite 120 and 150 tapes reliably, first erase (mt erase) the tape. 120 and 150 tapes used a wider track (fewer tracks per tape) than 525MB tapes. The “extra” width of the previous tracks is not overwritten, as a result the new data lies in a band surrounded on both @@ -5635,9 +5635,9 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" Jordan's Picks Generally speaking those in The FreeBSD Project prefer SCSI CDROM drives over IDE CDROM - drives. However not all SCSI CDROM drives are equal. Some feel + drives. However not all SCSI CDROM drives are equal. Some feel the quality of some SCSI CDROM drives have been deteriorating to - that of IDE CDROM drives. Toshiba used to be the favored + that of IDE CDROM drives. Toshiba used to be the favored stand-by, but many on the SCSI mailing list have found displeasure with the 12x speed XM-5701TA as its volume (when playing audio CDROMs) is not controllable by the various audio player @@ -5648,7 +5648,7 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" SCSI specification. Many SCSI CDROMs will respond to multiple LUNs for its - target address. Known violators include the 6x Teac CD-56S + target address. Known violators include the 6x Teac CD-56S 1.0D. diff --git a/en_US.ISO8859-1/books/handbook/install/chapter.sgml b/en_US.ISO8859-1/books/handbook/install/chapter.sgml index e26e9dcf6e..1541acfb01 100644 --- a/en_US.ISO8859-1/books/handbook/install/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/install/chapter.sgml @@ -2,18 +2,18 @@ Installing FreeBSD So, you would like to try out FreeBSD on your system? This section - is a quick-start guide for what you need to do. FreeBSD can be + is a quick-start guide for what you need to do. FreeBSD can be installed from a variety of media including CD-ROM, floppy disk, magnetic tape, an MS-DOS partition and, if you have a network connection, via anonymous ftp or NFS. Regardless of the installation media you choose, you can get started by creating the installation - disks as described below. Booting your computer into the + disks as described below. Booting your computer into the FreeBSD installer, even if you aren't planning on installing FreeBSD right away, will provide important information about compatibility between FreeBSD and your hardware which may, in turn, dictate which - installation options are even possible. It can also provide early + installation options are even possible. It can also provide early clues to any compatibility problems which could prevent FreeBSD running on your system at all. @@ -35,9 +35,9 @@ Review the supported configurations section of this installation guide to be sure - that your hardware is supported by FreeBSD. It may be helpful + that your hardware is supported by FreeBSD. It may be helpful to make a list of any special cards you have installed, such as - SCSI controllers, Ethernet adapters or sound cards. This list + SCSI controllers, Ethernet adapters or sound cards. This list should include relevant configuration parameters such as interrupts (IRQ) and IO port addresses. @@ -58,7 +58,7 @@ If you're running DOS and have the proper drivers to access your CD, run the install.bat script provided on the - CD. This will attempt to boot into the FreeBSD + CD. This will attempt to boot into the FreeBSD installation straight from DOS. @@ -130,16 +130,16 @@ With the kern.flp in the A: drive, reboot your - computer. The next request you should get is for the + computer. The next request you should get is for the mfsroot.flp floppy, after which the installation will proceed normally. If you do not type anything at the boot prompt which appears during this process, FreeBSD will automatically boot with its default - configuration after a delay of about five seconds. As FreeBSD + configuration after a delay of about five seconds. As FreeBSD boots, it probes your computer to determine what hardware is - installed. The results of this probing is displayed on the + installed. The results of this probing is displayed on the screen. @@ -153,7 +153,7 @@ If something goes wrong… Due to limitations of the PC architecture, it is impossible for - probing to be 100 percent reliable. In the event that your hardware + probing to be 100 percent reliable. In the event that your hardware is incorrectly identified, or that the probing causes your computer to lock up, first check the supported configurations @@ -163,24 +163,24 @@ If your hardware is supported, reset the computer and when the visual kernel configuration choice is presented, take it. This puts FreeBSD into a configuration mode - where you can supply hints about your hardware. The FreeBSD kernel on + where you can supply hints about your hardware. The FreeBSD kernel on the installation disk is configured assuming that most hardware devices are in their factory default configuration in terms of IRQs, - IO addresses and DMA channels. If your hardware has been + IO addresses and DMA channels. If your hardware has been reconfigured, you will most likely need to use the configuration editor to tell FreeBSD where things are. It is also possible that a probe for a device not present will - cause a later probe for another device that is present to fail. In + cause a later probe for another device that is present to fail. In that case, the probes for the conflicting driver(s) should be disabled. Do not disable any device you will need during installation, such - as your screen (sc0). If the installation + as your screen (sc0). If the installation wedges or fails mysteriously after leaving the configuration editor, you have probably removed or changed something that you should not - have. Simply reboot and try again. + have. Simply reboot and try again. In the configuration mode, you can: @@ -211,8 +211,8 @@ After FreeBSD has been installed, changes made in the configuration mode will be permanent so you do not have to reconfigure - every time you boot. Even so, it is likely that you will want to - build a custom kernel to optimize the performance of your system. See + every time you boot. Even so, it is likely that you will want to + build a custom kernel to optimize the performance of your system. See Kernel configuration for more information on creating custom kernels. @@ -223,7 +223,7 @@ FreeBSD currently runs on a wide variety of ISA, VLB, EISA and PCI bus based PC's, ranging from 386sx to Pentium class machines - (though the 386sx is not recommended). Support for generic IDE or + (though the 386sx is not recommended). Support for generic IDE or ESDI drive configurations, various SCSI controller, network and serial cards is also provided. @@ -232,7 +232,7 @@ recommended minimum. Following is a list of all disk controllers and Ethernet cards - currently known to work with FreeBSD. Other configurations may very + currently known to work with FreeBSD. Other configurations may very well work, and we have simply not received any indication of this. @@ -298,11 +298,11 @@ You cannot boot from the SoundBlaster cards as they have no on-board BIOS, which is necessary for mapping the boot device into the system BIOS - I/O vectors. They are perfectly usable for external tapes, - CDROMs, etc, however. The same goes for any other AIC-6x60 - based card without a boot ROM. Some systems DO have a boot + I/O vectors. They are perfectly usable for external tapes, + CDROMs, etc, however. The same goes for any other AIC-6x60 + based card without a boot ROM. Some systems DO have a boot ROM, which is generally indicated by some sort of message - when the system is first powered up or reset. Check your + when the system is first powered up or reset. Check your system/board documentation for more details. @@ -414,7 +414,7 @@ SMC Elite 16 WD8013 Ethernet interface, and most other WD8003E, WD8003EBT, WD8003W, WD8013W, WD8003S, WD8003SBT and - WD8013EBT based clones. SMC Elite Ultra and 9432TX based + WD8013EBT based clones. SMC Elite Ultra and 9432TX based cards are also supported. @@ -581,7 +581,7 @@ FreeBSD does not currently support - PnP (plug-n-play) features present on some ethernet cards. If + PnP (plug-n-play) features present on some ethernet cards. If your card has PnP and is giving you problems, try disabling its PnP features. @@ -678,7 +678,7 @@ Preparing for the Installation There are a number of different methods by which FreeBSD can be - installed. The following describes what preparation needs to be + installed. The following describes what preparation needs to be done for each type. @@ -703,11 +703,11 @@ If you are creating the boot floppies from a UNIX machine, see the beginning of this - guide for examples. of how to create the boot floppies. + guide for examples. of how to create the boot floppies. Once you have booted from DOS or floppy, you should then be able to select CDROM as the media type in the Media menu and load - the entire distribution from CDROM. No other types of + the entire distribution from CDROM. No other types of installation media should be required. After your system is fully installed and you have rebooted @@ -715,12 +715,12 @@ mount /cdrom Before removing the CD again, also note that it is necessary - to first type: umount /cdrom. Do not just + to first type: umount /cdrom. Do not just remove it from the drive! Before invoking the installation, be sure that the CDROM is - in the drive so that the install probe can find it. This is + in the drive so that the install probe can find it. This is also true if you wish the CDROM to be added to the default system configuration automatically during the install (whether or not you actually use it as the installation media). @@ -728,7 +728,7 @@ Finally, if you would like people to be able to FTP install FreeBSD directly from the CDROM in your machine, you will find it - quite easy. After the machine is fully installed, you simply need + quite easy. After the machine is fully installed, you simply need to add the following line to the password file (using the vipw command): @@ -753,20 +753,20 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent You will need, at minimum, as many 1.44MB or 1.2MB floppies as it takes to hold all files in the bin (binary distribution) - directory. If you are preparing these floppies under DOS, then + directory. If you are preparing these floppies under DOS, then THESE floppies must be formatted using the MS-DOS FORMAT - command. If you are using Windows, use the Windows File Manager + command. If you are using Windows, use the Windows File Manager format command. Do not trust Factory Preformatted - floppies! Format them again yourself, just to make sure. Many + floppies! Format them again yourself, just to make sure. Many problems reported by our users in the past have resulted from the use of improperly formatted media, which is why I am taking such special care to mention it here! If you are creating the floppies from another FreeBSD machine, a format is still not a bad idea though you do not need to put a - DOS filesystem on each floppy. You can use the disklabel and + DOS filesystem on each floppy. You can use the disklabel and newfs commands to put a UFS filesystem on them instead, as the following sequence of commands (for a 3.5" 1.44MB floppy disk) illustrates: @@ -789,11 +789,11 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent system. After you have formatted the floppies, you will need to copy - the files onto them. The distribution files are split into chunks + the files onto them. The distribution files are split into chunks conveniently sized so that 5 of them will fit on a conventional - 1.44MB floppy. Go through all your floppies, packing as many + 1.44MB floppy. Go through all your floppies, packing as many files as will fit on each one, until you have got all the - distributions you want packed up in this fashion. Each + distributions you want packed up in this fashion. Each distribution should go into a subdirectory on the floppy, e.g.: a:\bin\bin.aa, a:\bin\bin.ab, and so on. @@ -808,7 +808,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent To prepare for installation from an MS-DOS partition, copy the files from the distribution into a directory called - C:\FREEBSD. The directory tree structure of + C:\FREEBSD. The directory tree structure of the CDROM must be partially reproduced within this directory so we suggest using the DOS xcopy command. For example, to prepare for a minimal installation of FreeBSD: @@ -834,7 +834,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent Before installing from QIC/SCSI Tape Installing from tape is probably the easiest method, short of - an on-line install using FTP or a CDROM install. The installation + an on-line install using FTP or a CDROM install. The installation program expects the files to be simply tar'ed onto the tape, so after getting all of the files for distribution you are interested in, simply tar them onto the tape with a command like: @@ -849,7 +849,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent that you leave enough room in some temporary directory (which you will be allowed to choose) to accommodate the full contents of the tape you have created. Due to the non-random access nature of tapes, this method of - installation requires quite a bit of temporary storage. You + installation requires quite a bit of temporary storage. You should expect to require as much temporary storage as you have stuff written on tape. @@ -895,28 +895,28 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent SLIP support is rather primitive, and limited primarily to hard-wired links, such as a serial cable running between a laptop - computer and another computer. The link should be hard-wired as + computer and another computer. The link should be hard-wired as the SLIP installation does not currently offer a dialing capability; that facility is provided with the PPP utility, which should be used in preference to SLIP whenever possible. If you are using a modem, then PPP is almost certainly your - only choice. Make sure that you have your service provider's + only choice. Make sure that you have your service provider's information handy as you will need to know it fairly soon in the - installation process. You will need to know how to dial your ISP + installation process. You will need to know how to dial your ISP using the “AT commands” specific to your modem, as the PPP - dialer provides only a very simple terminal emulator. If you're + dialer provides only a very simple terminal emulator. If you're using PAP or CHAP, you'll need to type the necessary set authname and set authkey commands before typing term. Refer to the user-ppp handbook and FAQ entries for - further information. If you have problems, logging can be + further information. If you have problems, logging can be directed to the screen using the command set log local .... If a hard-wired connection to another FreeBSD (2.0R or later) machine is available, you might also consider installing over a - “laplink” parallel port cable. The data rate over the parallel + “laplink” parallel port cable. The data rate over the parallel port is much higher than what is typically possible over a serial line (up to 50k/sec), thus resulting in a quicker installation. @@ -926,7 +926,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent common PC ethernet cards, a table of supported cards (and their required settings) is provided in Supported - Hardware. If you are using one of the supported PCMCIA + Hardware. If you are using one of the supported PCMCIA ethernet cards, also be sure that it is plugged in before the laptop is powered on! FreeBSD does not, unfortunately, currently support hot insertion of PCMCIA @@ -934,12 +934,12 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent You will also need to know your IP address on the network, the netmask value for your address class, and the name of your - machine. Your system administrator can tell you which values to - use for your particular network setup. If you will be referring + machine. Your system administrator can tell you which values to + use for your particular network setup. If you will be referring to other hosts by name rather than IP address, you will also need a name server and possibly the address of a gateway (if you are using PPP, it is your provider's IP address) to use in talking to - it. If you do not know the answers to all or most of these + it. If you do not know the answers to all or most of these questions, then you should really probably talk to your system administrator first before trying this type of installation. @@ -974,8 +974,8 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent /usr/archive/stuff. In FreeBSD's /etc/exports file, this is - controlled by the option. Other - NFS servers may have different conventions. If you are getting + controlled by the option. Other + NFS servers may have different conventions. If you are getting Permission Denied messages from the server then it is likely that you do not have this enabled properly. @@ -985,14 +985,14 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent Preparing for FTP Installation FTP installation may be done from any mirror site containing - a reasonably up-to-date version of FreeBSD &rel.current;. A + a reasonably up-to-date version of FreeBSD &rel.current;. A full menu of reasonable choices from almost anywhere in the world is provided by the FTP site menu. If you are installing from some other FTP site not listed in this menu, or you are having troubles getting your name server configured properly, you can also specify your own URL by - selecting the “Other” choice in that menu. A URL can also be + selecting the “Other” choice in that menu. A URL can also be a direct IP address, so the following would work in the absence of a name server: @@ -1008,7 +1008,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent FTP Active - For all FTP transfers, use “Active” mode. This + For all FTP transfers, use “Active” mode. This will not work through firewalls, but will often work with older ftp servers that do not support passive mode. If your connection hangs with passive mode (the @@ -1019,7 +1019,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent FTP Passive - For all FTP transfers, use “Passive” mode. This + For all FTP transfers, use “Passive” mode. This allows the user to pass through firewalls that do not allow incoming connections on random port addresses. @@ -1036,13 +1036,13 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent For a proxy FTP server, you should usually give name of the server you really want as a part of the username, after an - @-sign. The proxy server then 'fakes' the real server. An + @-sign. The proxy server then 'fakes' the real server. An example: Say you want to install from ftp.freebsd.org, using the proxy FTP server foo.bar.com, listening on port 1234. In this case, you go to the options menu, set the FTP username to ftp@ftp.freebsd.org, and the password to your e-mail - address. As your installation media, you specify FTP (or + address. As your installation media, you specify FTP (or passive FTP, if the proxy support it), and the URL @@ -1076,10 +1076,10 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent The FreeBSD boot floppies contain all the on-line documentation you should need to be able to navigate through an installation and if it does not then we would like to know what you found most - confusing. Send your comments to the &a.doc;. It is the objective + confusing. Send your comments to the &a.doc;. It is the objective of the FreeBSD installation program (sysinstall) to be self-documenting enough that painful “step-by-step” guides are no - longer necessary. It may take us a little while to reach that + longer necessary. It may take us a little while to reach that objective, but that is the objective! Meanwhile, you may also find the following “typical @@ -1091,17 +1091,17 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent Boot the kern.flp floppy and, when asked, remove it and insert the - mfsroot.flp floppy and hit return.. After a boot sequence which can + mfsroot.flp floppy and hit return. After a boot sequence which can take anywhere from 30 seconds to 3 minutes, depending on your hardware, you should be presented with a menu of initial - choices. If the kern.flp floppy does not boot at all, or the boot + choices. If the kern.flp floppy does not boot at all, or the boot hangs at some stage, go read the Q&A section of the Hardware Guide for possible causes. - Press F1. You should see some basic usage instructions on - the menu system and general navigation. If you have not used + Press F1. You should see some basic usage instructions on + the menu system and general navigation. If you have not used this menu system before then please read this thoroughly! @@ -1116,17 +1116,17 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent through a typical installation, give you a high degree of control over each step of the installation or simply whizz through it (using reasonable defaults when possible) as fast - as possible. If you have never used FreeBSD before then the + as possible. If you have never used FreeBSD before then the Novice installation method is most recommended. The final configuration menu choice allows you to further configure your FreeBSD installation by giving you menu-driven - access to various system defaults. Some items, like + access to various system defaults. Some items, like networking, may be especially important if you did a CDROM/Tape/Floppy installation and have not yet configured - your network interfaces (assuming you have any). Properly + your network interfaces (assuming you have any). Properly configuring such interfaces here will allow FreeBSD to come up on the network when you first reboot from the hard disk. @@ -1141,7 +1141,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent MS-DOS User's Questions and Answers Many FreeBSD users wish to install FreeBSD on PCs inhabited by - MS-DOS. Here are some commonly asked questions about installing + MS-DOS. Here are some commonly asked questions about installing FreeBSD on such systems. Help! I have no space! Do I need to delete @@ -1154,11 +1154,11 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent FIPS allows you to split an existing MS-DOS partition into two pieces, preserving the original partition and allowing you to - install onto the second free piece. You first defragment your + install onto the second free piece. You first defragment your MS-DOS partition, using the DOS 6.xx DEFRAG utility or the Norton - Disk tools, then run FIPS. It will prompt you for the rest of the - information it needs. Afterwards, you can reboot and install - FreeBSD on the new free slice. See the + Disk tools, then run FIPS. It will prompt you for the rest of the + information it needs. Afterwards, you can reboot and install + FreeBSD on the new free slice. See the Distributions menu for an estimation of how much free space you will need for the kind of installation you want. @@ -1166,11 +1166,11 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent Can I use compressed MS-DOS filesystems from FreeBSD? - No. If you are using a utility such as Stacker(tm) or + No. If you are using a utility such as Stacker(tm) or DoubleSpace(tm), FreeBSD will only be able to use whatever portion - of the filesystem you leave uncompressed. The rest of the + of the filesystem you leave uncompressed. The rest of the filesystem will show up as one large file (the stacked/dblspaced - file!). Do not remove that file! You + file!). Do not remove that file! You will probably regret it greatly! It is probably better to create another uncompressed MS-DOS @@ -1180,11 +1180,11 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent Can I mount my MS-DOS extended partitions? - Yes. DOS extended partitions are mapped in at the end of the - other “slices” in FreeBSD, e.g. your D: drive might be /dev/sd0s5, - your E: drive /dev/sd0s6, and so on. This example assumes, of - course, that your extended partition is on SCSI drive 0. For IDE - drives, substitute wd for sd appropriately. You otherwise + Yes. DOS extended partitions are mapped in at the end of the + other “slices” in FreeBSD, e.g. your D: drive might be /dev/sd0s5, + your E: drive /dev/sd0s6, and so on. This example assumes, of + course, that your extended partition is on SCSI drive 0. For IDE + drives, substitute wd for sd appropriately. You otherwise mount extended partitions exactly like you would mount any other DOS drive, e.g.: diff --git a/en_US.ISO8859-1/books/handbook/introduction/chapter.sgml b/en_US.ISO8859-1/books/handbook/introduction/chapter.sgml index 77510aa99d..234b91a5a2 100644 --- a/en_US.ISO8859-1/books/handbook/introduction/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/introduction/chapter.sgml @@ -2,12 +2,12 @@ Introduction FreeBSD is a 4.4BSD-Lite based operating system for Intel - architecture (x86) based PCs. For an overview of FreeBSD, see - FreeBSD in a nutshell. For a + architecture (x86) based PCs. For an overview of FreeBSD, see + FreeBSD in a nutshell. For a history of the project, read a brief - history of FreeBSD. To see a description of the latest release, + history of FreeBSD. To see a description of the latest release, read about the current - release. If you're interested in contributing something to the + release. If you're interested in contributing something to the FreeBSD project (code, equipment, sacks of unmarked bills), please see about contributing to FreeBSD. @@ -17,10 +17,10 @@ FreeBSD is a state of the art operating system for personal computers based on the Intel CPU architecture, which includes the - 386, 486 and Pentium processors (both SX and DX versions). Intel - compatible CPUs from AMD and Cyrix are supported as well. FreeBSD + 386, 486 and Pentium processors (both SX and DX versions). Intel + compatible CPUs from AMD and Cyrix are supported as well. FreeBSD provides you with many advanced features previously available only - on much more expensive computers. These features include: + on much more expensive computers. These features include: @@ -34,14 +34,14 @@ Multiuser access means that many people can use a FreeBSD system simultaneously for a - variety of things. System peripherals such as printers and + variety of things. System peripherals such as printers and tape drives are also properly SHARED BETWEEN ALL users on the system. Complete TCP/IP networking - including SLIP, PPP, NFS and NIS support. This means that + including SLIP, PPP, NFS and NIS support. This means that your FreeBSD machine can inter-operate easily with other systems as well act as an enterprise server, providing vital functions such as NFS (remote file access) and e-mail services @@ -77,13 +77,13 @@ Hundreds of ready-to-run - applications are available from the FreeBSD ports and packages collection. Why search the net + applications are available from the FreeBSD ports and packages collection. Why search the net when you can find it all right here? Thousands of additional and easy-to-port applications available on - the Internet. FreeBSD is source code compatible with most + the Internet. FreeBSD is source code compatible with most popular commercial Unix systems and thus most applications require few, if any, changes to compile. @@ -103,7 +103,7 @@ A full complement of C, - C++ and Fortran development tools. Many + C++ and Fortran development tools. Many additional languages for advanced research and development are also available in the ports and packages collection. @@ -111,7 +111,7 @@ Source code for the entire system means you have the greatest degree of control over your - environment. Why be locked into a proprietary solution and at + environment. Why be locked into a proprietary solution and at the mercy of your vendor when you can have a truly Open System? @@ -131,15 +131,15 @@ FreeBSD is based on the 4.4BSD-Lite release from Computer Systems Research Group (CSRG) at the University of California at Berkeley, and carries on the distinguished tradition of BSD systems - development. In addition to the fine work provided by CSRG, the + development. In addition to the fine work provided by CSRG, the FreeBSD Project has put in many thousands of hours in fine tuning the system for maximum performance and reliability in real-life load - situations. As many of the commercial giants struggle to field PC + situations. As many of the commercial giants struggle to field PC operating systems with such features, performance and reliability, FreeBSD can offer them now! The applications to which FreeBSD can be put are truly limited - only by your own imagination. From software development to factory + only by your own imagination. From software development to factory automation, inventory control to azimuth correction of remote satellite antennae; if it can be done with a commercial UNIX product then it is more than likely that you can do it with FreeBSD, too! @@ -153,7 +153,7 @@ available, the system can also be customized to an almost unheard of degree for special applications or projects, and in ways not generally possible with operating systems from most major commercial - vendors. Here is just a sampling of some of the applications in + vendors. Here is just a sampling of some of the applications in which people are currently using FreeBSD: @@ -205,7 +205,7 @@ of computer science or a related engineering field? There is no better way of learning about operating systems, computer architecture and networking than the hands on, under the hood - experience that FreeBSD can provide. A number of freely + experience that FreeBSD can provide. A number of freely available CAD, mathematical and graphic design packages also make it highly useful to those whose primary interest in a computer is to get other work @@ -216,7 +216,7 @@ Research: With source code for the entire system available, FreeBSD is an excellent platform for research in operating systems as well as other - branches of computer science. FreeBSD's freely available + branches of computer science. FreeBSD's freely available nature also makes it possible for remote groups to collaborate on ideas or shared development without having to worry about special licensing agreements or limitations on what may be @@ -238,7 +238,7 @@ one of the excellent commercial servers provided by X Inside. Unlike an X terminal, FreeBSD allows many applications to be run locally, if desired, thus relieving the burden on a - central server. FreeBSD can even boot “diskless”, making + central server. FreeBSD can even boot “diskless”, making individual workstations even cheaper and easier to administer. @@ -254,7 +254,7 @@ FreeBSD is available in both source and binary form on CDROM and - via anonymous ftp. See Obtaining + via anonymous ftp. See Obtaining FreeBSD for more details. @@ -271,89 +271,89 @@ Our original goal was to produce an intermediate snapshot of 386BSD in order to fix a number of problems with it that the - patchkit mechanism just was not capable of solving. Some of you may + patchkit mechanism just was not capable of solving. Some of you may remember the early working title for the project being “386BSD 0.5” or “386BSD Interim” in reference to that fact. 386BSD was Bill Jolitz's operating system, which had been up to that point suffering rather severely from almost a year's worth of - neglect. As the patchkit swelled ever more uncomfortably with each + neglect. As the patchkit swelled ever more uncomfortably with each passing day, we were in unanimous agreement that something had to be done and decided to try and assist Bill by providing this interim - “cleanup” snapshot. Those plans came to a rude halt when Bill + “cleanup” snapshot. Those plans came to a rude halt when Bill Jolitz suddenly decided to withdraw his sanction from the project and without any clear indication of what would be done instead. It did not take us long to decide that the goal remained worthwhile, even without Bill's support, and so we adopted the name - “FreeBSD”, coined by David Greenman. Our initial objectives were + “FreeBSD”, coined by David Greenman. Our initial objectives were set after consulting with the system's current users and, once it became clear that the project was on the road to perhaps even becoming a reality, I contacted Walnut Creek CDROM with an eye towards improving FreeBSD's distribution channels for those many - unfortunates without easy access to the Internet. Walnut Creek + unfortunates without easy access to the Internet. Walnut Creek CDROM not only supported the idea of distributing FreeBSD on CD but went so far as to provide the project with a machine to work on and - a fast Internet connection. Without Walnut Creek CDROM's almost + a fast Internet connection. Without Walnut Creek CDROM's almost unprecedented degree of faith in what was, at the time, a completely unknown project, it is quite unlikely that FreeBSD would have gotten as far, as fast, as it has today. The first CDROM (and general net-wide) distribution was FreeBSD - 1.0, released in December of 1993. This was based on the + 1.0, released in December of 1993. This was based on the 4.3BSD-Lite (“Net/2”) tape from U.C. Berkeley, with many components - also provided by 386BSD and the Free Software Foundation. It was a + also provided by 386BSD and the Free Software Foundation. It was a fairly reasonable success for a first offering, and we followed it with the highly successful FreeBSD 1.1 release in May of 1994. Around this time, some rather unexpected storm clouds formed on the horizon as Novell and U.C. Berkeley settled their long-running - lawsuit over the legal status of the Berkeley Net/2 tape. A + lawsuit over the legal status of the Berkeley Net/2 tape. A condition of that settlement was U.C. Berkeley's concession that large parts of Net/2 were “encumbered” code and the property of Novell, who had in turn acquired it from AT&T some time - previously. What Berkeley got in return was Novell's “blessing” + previously. What Berkeley got in return was Novell's “blessing” that the 4.4BSD-Lite release, when it was finally released, would be declared unencumbered and all existing Net/2 users would be strongly - encouraged to switch. This included FreeBSD, and the project was + encouraged to switch. This included FreeBSD, and the project was given until the end of July 1994 to stop shipping its own Net/2 - based product. Under the terms of that agreement, the project was + based product. Under the terms of that agreement, the project was allowed one last release before the deadline, that release being FreeBSD 1.1.5.1. FreeBSD then set about the arduous task of literally re-inventing itself from a completely new and rather incomplete set - of 4.4BSD-Lite bits. The “Lite” releases were light in part because + of 4.4BSD-Lite bits. The “Lite” releases were light in part because Berkeley's CSRG had removed large chunks of code required for actually constructing a bootable running system (due to various legal requirements) and the fact that the Intel port of 4.4 was - highly incomplete. It took the project until December of 1994 to + highly incomplete. It took the project until December of 1994 to make this transition, and in January of 1995 it released FreeBSD 2.0 - to the net and on CDROM. Despite being still more than a little + to the net and on CDROM. Despite being still more than a little rough around the edges, the release was a significant success and was followed by the more robust and easier to install FreeBSD 2.0.5 release in June of 1995. We released FreeBSD 2.1.5 in August of 1996, and it appeared to be popular enough among the ISP and commercial communities that - another release along the 2.1-stable branch was merited. This was + another release along the 2.1-stable branch was merited. This was FreeBSD 2.1.7.1, released in February 1997 and capping the end of - mainstream development on 2.1-stable. Now in maintenance mode, only + mainstream development on 2.1-stable. Now in maintenance mode, only security enhancements and other critical bug fixes will be done on this branch (RELENG_2_1_0). FreeBSD 2.2 was branched from the development mainline (“-current”) in November 1996 as the RELENG_2_2 branch, and the - first full release (2.2.1) was released in April, 1997. Further + first full release (2.2.1) was released in April, 1997. Further releases along the 2.2 branch were done in the Summer and Fall of '97, the latest being 2.2.7 which appeared in late July of '98. The first official 3.0 release appeared in October, 1998 and the last release on the 2.2 branch, 2.2.8, appeared in November, 1998. - The tree branched again on Jan 20, 1999. This led to + The tree branched again on Jan 20, 1999. This led to 4.0-current and a 3.x-stable branch, from which 3.1 will be released on February 15th, 1999. @@ -368,20 +368,20 @@ Contributed by &a.jkh;. The goals of the FreeBSD Project are to provide software that - may be used for any purpose and without strings attached. Many of + may be used for any purpose and without strings attached. Many of us have a significant investment in the code (and project) and would certainly not mind a little financial compensation now and then, but - we're definitely not prepared to insist on it. We believe that our + we're definitely not prepared to insist on it. We believe that our first and foremost “mission” is to provide code to any and all comers, and for whatever purpose, so that the code gets the widest - possible use and provides the widest possible benefit. This is, I + possible use and provides the widest possible benefit. This is, I believe, one of the most fundamental goals of Free Software and one that we enthusiastically support. That code in our source tree which falls under the GNU Public License (GPL) or GNU Library Public License (GLPL) comes with slightly more strings attached, though at least on the side of - enforced access rather than the usual opposite. Due to the + enforced access rather than the usual opposite. Due to the additional complexities that can evolve in the commercial use of GPL software, we do, however, endeavor to replace such software with submissions under the more relaxed BSD copyright whenever possible. @@ -396,13 +396,13 @@ The development of FreeBSD is a very open and flexible process, FreeBSD being literally built from the contributions of hundreds of people around the world, as can be seen from our list of contributors. We are constantly + linkend="staff">list of contributors. We are constantly on the lookout for new developers and ideas, and those interested in becoming more closely involved with the project need simply contact - us at the &a.hackers;. Those who prefer to work more independently + us at the &a.hackers;. Those who prefer to work more independently are also accommodated, and they are free to use our FTP facilities at ftp.freebsd.org to distribute their own patches or work-in-progress sources. The &a.announce; is also available to those wishing to make other FreeBSD users aware of major areas of work. + URL="ftp://ftp.freebsd.org/pub/FreeBSD/incoming">ftp.freebsd.org to distribute their own patches or work-in-progress sources. The &a.announce; is also available to those wishing to make other FreeBSD users aware of major areas of work. Useful things to know about the FreeBSD project and its development process, whether working independently or in close @@ -415,10 +415,10 @@ The central source tree for FreeBSD is maintained by CVS (Concurrent Version System), a freely available source code control tool which comes bundled with FreeBSD. The primary CVS repository resides on a machine in Concord CA, USA from where it is replicated to numerous mirror machines throughout the world. The CVS tree, as well as the -current and CVS (Concurrent Version System), a freely available source code control tool which comes bundled with FreeBSD. The primary CVS repository resides on a machine in Concord CA, USA from where it is replicated to numerous mirror machines throughout the world. The CVS tree, as well as the -current and -stable trees which are checked out of it, can be easily replicated to your own machine as - well. Please refer to the + well. Please refer to the Synchronizing your source tree section for more information on doing this. @@ -433,7 +433,7 @@ the CVS tree, and are thus authorized to make modifications to the FreeBSD source (the term “committer” comes from the cvs1 commit command, which is used to - bring new changes into the CVS repository). The best way of + bring new changes into the CVS repository). The best way of making submissions for review by the committers list is to use the send-pr1 command, though if something appears to be jammed in the system then you may also reach them by sending mail to committers@freebsd.org. @@ -445,9 +445,9 @@ The FreeBSD core team would be equivalent to the board of directors if - the FreeBSD Project were a company. The primary task of the + the FreeBSD Project were a company. The primary task of the core team is to make sure the project, as a whole, is in - good shape and is heading in the right directions. Inviting + good shape and is heading in the right directions. Inviting dedicated and responsible developers to join our group of committers is one of the functions of the core team, as is the recruitment of new core team members as others move on. @@ -479,7 +479,7 @@ Last, but definitely not least, the largest group of developers are the users themselves who provide feedback and - bug-fixes to us on an almost constant basis. The primary + bug-fixes to us on an almost constant basis. The primary way of keeping in touch with FreeBSD's more non-centralized development is to subscribe to the &a.hackers; (see mailing list @@ -501,7 +501,7 @@ In summary, our development model is organized as a loose set of - concentric circles. The centralized model is designed for the + concentric circles. The centralized model is designed for the convenience of the users of FreeBSD, who are thereby provided with an easy way of tracking one central code base, not to keep potential contributors out! Our desire is to present a @@ -521,16 +521,16 @@ FreeBSD is a freely available, full source 4.4BSD-Lite based release for Intel i386/i486/Pentium/PentiumPro/Pentium II (or - compatible) based PC's. It is based primarily on software from U.C. + compatible) based PC's. It is based primarily on software from U.C. Berkeley's CSRG group, with some enhancements from NetBSD, OpenBSD, 386BSD, and the Free Software Foundation. Since our release of FreeBSD 2.0 in January of 95, the performance, feature set, and stability of FreeBSD has improved - dramatically. The largest change is a revamped virtual memory + dramatically. The largest change is a revamped virtual memory system with a merged VM/file buffer cache that not only increases performance, but reduces FreeBSD's memory footprint, making a 5MB - configuration a more acceptable minimum. Other enhancements include + configuration a more acceptable minimum. Other enhancements include full NIS client and server support, transaction TCP support, dial-on-demand PPP, an improved SCSI subsystem, early ISDN support, support for FDDI and Fast Ethernet (100Mbit) adapters, improved @@ -539,24 +539,24 @@ We have also taken the comments and suggestions of many of our users to heart and have attempted to provide what we hope is a more - sane and easily understood installation process. Your feedback on + sane and easily understood installation process. Your feedback on this (constantly evolving) process is especially welcome! In addition to the base distributions, FreeBSD offers a new ported software collection with hundreds of commonly sought-after - programs. At the end of August 1998 there were more than 1700 ports! + programs. At the end of August 1998 there were more than 1700 ports! The list of ports ranges from http (WWW) servers, to games, - languages, editors and almost everything in between. The entire + languages, editors and almost everything in between. The entire ports collection requires approximately 26MB of storage, all ports - being expressed as “deltas” to their original sources. This + being expressed as “deltas” to their original sources. This makes it much easier for us to update ports, and greatly reduces - the disk space demands made by the older 1.0 ports collection. To + the disk space demands made by the older 1.0 ports collection. To compile a port, you simply change to the directory of the program you wish to install, type make all followed by make install - after successful compilation and let the system do the rest. The + after successful compilation and let the system do the rest. The full original distribution for each port you build is retrieved dynamically off the CDROM or a local ftp site, so you need only - enough disk space to build the ports you want. (Almost) every port + enough disk space to build the ports you want. (Almost) every port is also provided as a pre-compiled “package” which can be installed with a simple command (pkg_add) by those who do not wish to compile their own ports from source. @@ -564,7 +564,7 @@ A number of additional documents which you may find very helpful in the process of installing and using FreeBSD may now also be found in the /usr/share/doc directory on any machine - running FreeBSD 2.1 or later. You may view the locally installed + running FreeBSD 2.1 or later. You may view the locally installed manuals with any HTML capable browser using the following URLs: @@ -593,12 +593,12 @@ URL="http://www.freebsd.org">http://www.freebsd.org. The core of FreeBSD does not contain DES code which would - inhibit its being exported outside the United States. There is an + inhibit its being exported outside the United States. There is an add-on package to the core distribution, for use only in the United - States, that contains the programs that normally use DES. The - auxiliary packages provided separately can be used by anyone. A + States, that contains the programs that normally use DES. The + auxiliary packages provided separately can be used by anyone. A freely (from outside the U.S.) exportable European distribution of - DES for our non-U.S. users also exists and is described in the + DES for our non-U.S. users also exists and is described in the FreeBSD FAQ. If password security for FreeBSD is all you need, and you have @@ -606,7 +606,7 @@ (Suns, DEC machines, etc) into FreeBSD password entries, then FreeBSD's MD5 based security may be all you require! We feel that our default security model is more than a match for DES, and without - any messy export issues to deal with. If you are outside (or even + any messy export issues to deal with. If you are outside (or even inside) the U.S., give it a try! diff --git a/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.sgml b/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.sgml index bfdf8592c9..30c999f236 100644 --- a/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.sgml @@ -5,7 +5,7 @@ 1995. This large section of the handbook discusses the basics of - building your own custom kernel for FreeBSD. This section is + building your own custom kernel for FreeBSD. This section is appropriate for both novice system administrators and those with advanced Unix experience. @@ -14,12 +14,12 @@ Why Build a Custom Kernel? Building a custom kernel is one of the most important rites of - passage every Unix system administrator must endure. This process, + passage every Unix system administrator must endure. This process, while time-consuming, will provide many benefits to your FreeBSD - system. Unlike the GENERIC kernel, which must support every + system. Unlike the GENERIC kernel, which must support every possible SCSI and network card, along with tons of other rarely used hardware support, a custom kernel only contains support for - your PC's hardware. This has a number of + your PC's hardware. This has a number of benefits: @@ -35,7 +35,7 @@ because the kernel is the one process which must always be present in memory, and so all of that unused code ties up pages of RAM that your programs would otherwise be able to - use. Therefore, on a system with limited RAM, building a + use. Therefore, on a system with limited RAM, building a custom kernel is of critical importance. @@ -57,14 +57,14 @@ First, let us take a quick tour of the kernel build directory. All directories mentioned will be relative to the main /usr/src/sys directory, which is also - accessible through /sys. There are a number of + accessible through /sys. There are a number of subdirectories here representing different parts of the kernel, but the most important, for our purposes, are i386/conf, where you will edit your custom kernel configuration, and compile, - which is the staging area where your kernel will be built. Notice + which is the staging area where your kernel will be built. Notice the logical organization of the directory tree, with each supported - device, filesystem, and option in its own subdirectory. Also, + device, filesystem, and option in its own subdirectory. Also, anything inside the i386 directory deals with PC hardware only, while everything outside the i386 directory is common to all platforms which @@ -73,7 +73,7 @@ If there is not a /usr/src/sys directory on your system, then - the kernel source has not been been installed. The easiest way + the kernel source has not been been installed. The easiest way to do this is by running /stand/sysinstall as root, choosing Configure, then Distributions, then src, @@ -82,7 +82,7 @@ Next, move to the i386/conf directory and copy the GENERIC configuration file to the name - you want to give your kernel. For example: + you want to give your kernel. For example: &prompt.root; cd /usr/src/sys/i386/conf @@ -92,7 +92,7 @@ Traditionally, this name is in all capital letters and, if you are maintaining multiple FreeBSD machines with different hardware, it is a good idea to name it after your - machine's hostname. We will call it MYKERNEL + machine's hostname. We will call it MYKERNEL for the purpose of this example. @@ -102,17 +102,17 @@ Now, edit MYKERNEL with your favorite text - editor. If you are just starting out, the only editor available + editor. If you are just starting out, the only editor available will probably be vi, which is too complex to explain here, but is covered well in many books in the bibliography. Feel free to change + linkend="bibliography">bibliography. Feel free to change the comment lines at the top to reflect your configuration or the changes you have made to differentiate it from GENERIC. If you have build a kernel under SunOS or some other BSD - operating system, much of this file will be very familiar to you. If + operating system, much of this file will be very familiar to you. If you are coming from some other operating system such as DOS, on the other hand, the GENERIC configuration file might seem overwhelming to you, so follow the descriptions in the @@ -123,9 +123,9 @@ If you are trying to upgrade your kernel from an older version of FreeBSD, you will probably have to get a new version of config8 from the same place you got the new - kernel sources. It is located in + kernel sources. It is located in /usr/src/usr.sbin, so you will need to - download those sources as well. Re-build and install it before + download those sources as well. Re-build and install it before running the next commands. @@ -142,8 +142,8 @@ The new kernel will be copied to the root directory as /kernel and the old kernel will be - moved to /kernel.old. Now, shutdown the system - and reboot to use your kernel. In case something goes wrong, there + moved to /kernel.old. Now, shutdown the system + and reboot to use your kernel. In case something goes wrong, there are some troubleshooting instructions at the end of this document. Be sure to read the section which explains how to recover in case your new kernel The Configuration File - The general format of a configuration file is quite simple. Each - line contains a keyword and one or more arguments. For simplicity, - most lines only contain one argument. Anything following a + The general format of a configuration file is quite simple. Each + line contains a keyword and one or more arguments. For simplicity, + most lines only contain one argument. Anything following a # is considered a comment and ignored. The following sections describe each keyword, generally in the order they are listed in GENERIC, although some @@ -174,21 +174,21 @@ An exhaustive list of options and more detailed explanations of the device lines is present in the LINT configuration file, located in the same - directory as GENERIC. If you are in doubt as to + directory as GENERIC. If you are in doubt as to the purpose or necessity of a line, check first in LINT. The kernel is currently being moved to a better organization of - the option handling. Traditionally, each option in the config file + the option handling. Traditionally, each option in the config file was simply converted into a switch for the - CFLAGS line of the kernel Makefile. Naturally, + CFLAGS line of the kernel Makefile. Naturally, this caused a creeping optionism, with nobody really knowing which option has been referenced in what files. In the new scheme, every #ifdef that is intended to be dependent upon an option gets this option out of an opt_foo.h - declaration file created in the compile directory by config. The list of valid options for + declaration file created in the compile directory by config. The list of valid options for config lives in two files: options that do not depend on the architecture are listed in /sys/conf/options, architecture-dependent ones @@ -248,7 +248,7 @@ different values of cpu_type as are present in the GENERIC kernel. For a custom kernel, it is best to specify only the cpu - you have. If, for example, you have an Intel Pentium, use + you have. If, for example, you have an Intel Pentium, use I586_CPU for cpu_type. @@ -257,15 +257,15 @@ Next, we have ident, - which is the identification of the kernel. You should + which is the identification of the kernel. You should change this from GENERIC to whatever you named your kernel, in this example, - MYKERNEL. The value you put in + MYKERNEL. The value you put in ident will print when you boot up the kernel, so it is useful to give a kernel a different name if you want to keep it separate from your usual kernel (if you want to build an experimental kernel, - for example). Note that, as with machine and + for example). Note that, as with machine and cpu, enclose your kernel's name in quotation marks if it contains any numbers. @@ -280,13 +280,13 @@ This file sets the size of a number of important - system tables. This number is supposed to be roughly + system tables. This number is supposed to be roughly equal to the number of simultaneous users you expect to - have on your machine. However, under normal + have on your machine. However, under normal circumstances, you will want to set maxusers to at least 4, especially if you are using the X Window System or - compiling software. The reason is that the most important + compiling software. The reason is that the most important table set by maxusers is the maximum number of processes, which is set to 20 + 16 * maxusers, so if you set @@ -294,11 +294,11 @@ can only have 36 simultaneous processes, including the 18 or so that the system starts up at boot time, and the 15 or so you will probably create when you start the X Window - System. Even a simple task like reading a man page will start up nine - processes to filter, decompress, and view it. Setting + System. Even a simple task like reading a man page will start up nine + processes to filter, decompress, and view it. Setting maxusers to 4 will allow you to have up to 84 simultaneous processes, which should be - enough for anyone. If, however, you see the dreaded + enough for anyone. If, however, you see the dreaded proc table full error when trying to start another program, or are running a server with a large number of simultaneous users (like Walnut Creek CDROM's FTP site), @@ -307,10 +307,10 @@ maxuser does not limit the number of users which - can log into your machine. It simply sets various table + can log into your machine. It simply sets various table sizes to reasonable values considering the maximum number of users you will likely have on your system and - how many processes each of them will be running. One + how many processes each of them will be running. One keyword which does limit the number of simultaneous remote logins is This line specifies the location and name of the - kernel. Traditionally the kernel is called + kernel. Traditionally the kernel is called vmunix but in FreeBSD, it is aptly - named kernel. You should always use + named kernel. You should always use kernel for kernel_name because changing it will - render numerous system utilities inoperative. The second + render numerous system utilities inoperative. The second part of the line specifies the disk and partition where - the root filesystem and kernel can be found. Typically + the root filesystem and kernel can be found. Typically this will be wd0 for systems with non-SCSI drives, or sd0 for systems with SCSI drives. @@ -355,14 +355,14 @@ This line allows the kernel to simulate a math co-processor if your computer does not have one (386 or - 486SX). If you have a Pentium, a 486DX, or a 386 or 486SX + 486SX). If you have a Pentium, a 486DX, or a 386 or 486SX with a separate 387 or 487 chip, you can comment this line out. The normal math co-processor emulation routines that come with FreeBSD are not very - accurate. If you do not have a math co-processor, and + accurate. If you do not have a math co-processor, and you need the best accuracy, I recommend that you change this option to GPL_MATH_EMULATE to use the superior GNU math support, which is not included by @@ -374,7 +374,7 @@ options "COMPAT_43" - Compatibility with 4.3BSD. Leave this in; some + Compatibility with 4.3BSD. Leave this in; some programs will act strangely if you comment this out. @@ -385,7 +385,7 @@ ISA devices and EISA devices operating in an ISA compatibility mode can only perform DMA (Direct Memory - Access) to memory below 16 megabytes. This option enables + Access) to memory below 16 megabytes. This option enables such devices to work in systems with more than 16 megabytes of memory. @@ -405,11 +405,11 @@ options SYSVSHM - This option provides for System V shared memory. The + This option provides for System V shared memory. The most common use of this is the XSHM extension in X Windows, which many graphics-intensive programs (such as the movie player XAnim, and Linux DOOM) will automatically - take advantage of for extra speed. If you use the X + take advantage of for extra speed. If you use the X Window System, you will definitely want to include this. @@ -418,7 +418,7 @@ options SYSVSEM - Support for System V semaphores. Less commonly used + Support for System V semaphores. Less commonly used but only adds a few hundred bytes to the kernel. @@ -426,7 +426,7 @@ options SYSVMSG - Support for System V messages. Again, only adds a few + Support for System V messages. Again, only adds a few hundred bytes to the kernel. @@ -444,7 +444,7 @@ Filesystem Options - These options add support for various filesystems. You must + These options add support for various filesystems. You must include at least one of these to support the device you boot from; typically this will be FFS if you boot from a hard drive, or NFS if you are booting a @@ -467,7 +467,7 @@ options NFS - Network Filesystem. Unless you plan to mount + Network Filesystem. Unless you plan to mount partitions from a Unix file server over Ethernet, you can comment this out. @@ -476,11 +476,11 @@ options MSDOSFS - MS-DOS Filesystem. Unless you plan to mount a DOS + MS-DOS Filesystem. Unless you plan to mount a DOS formatted hard drive partition at boot time, you can - safely comment this out. It will be automatically loaded + safely comment this out. It will be automatically loaded the first time you mount a DOS partition, as described - above. Also, the excellent mtools software (in the ports + above. Also, the excellent mtools software (in the ports collection) allows you to access DOS floppies without having to mount and unmount them (and does not require MSDOSFS at all). @@ -490,10 +490,10 @@ options "CD9660" - ISO 9660 filesystem for CD-ROMs. Comment it out if + ISO 9660 filesystem for CD-ROMs. Comment it out if you do not have a CD-ROM drive or only mount data CD's occasionally (since it will be dynamically loaded the - first time you mount a data CD). Audio CD's do not need + first time you mount a data CD). Audio CD's do not need this filesystem. @@ -501,7 +501,7 @@ options PROCFS - Process filesystem. This is a pretend filesystem + Process filesystem. This is a pretend filesystem mounted on /proc which allows programs like ps1 to give you more information on what processes are running. @@ -511,12 +511,12 @@ options MFS - Memory-mapped file system. This is basically a RAM + Memory-mapped file system. This is basically a RAM disk for fast storage of temporary files, useful if you have a lot of swap space that you want to take advantage - of. A perfect place to mount an MFS partition is on the + of. A perfect place to mount an MFS partition is on the /tmp directory, since many programs - store temporary data here. To mount an MFS RAM disk on + store temporary data here. To mount an MFS RAM disk on /tmp, add the following line to /etc/fstab and then reboot or type mount /tmp: @@ -547,8 +547,8 @@ options "EXT2FS" - Linux's native file system. With ext2fs support you - are able to read and write to Linux partitions. This is + Linux's native file system. With ext2fs support you + are able to read and write to Linux partitions. This is useful if you dual-boot FreeBSD and Linux and want to share data between the two systems. @@ -557,10 +557,10 @@ options QUOTA - Enable disk quotas. If you have a public access + Enable disk quotas. If you have a public access system, and do not want users to be able to overflow the /home partition, you can establish - disk quotas for each user. Refer to the + disk quotas for each user. Refer to the Disk Quotas section for more information. @@ -574,7 +574,7 @@ Basic Controllers and Devices These sections describe the basic disk, tape, and CD-ROM - controllers supported by FreeBSD. There are separate sections for + controllers supported by FreeBSD. There are separate sections for SCSI controllers and network cards. @@ -582,7 +582,7 @@ controller isa0 - All PC's supported by FreeBSD have one of these. If + All PC's supported by FreeBSD have one of these. If you have an IBM PS/2 (Micro Channel Architecture), then you cannot run FreeBSD at this time. @@ -591,7 +591,7 @@ controller pci0 - Include this if you have a PCI motherboard. This + Include this if you have a PCI motherboard. This enables auto-detection of PCI cards and gatewaying from the PCI to the ISA bus. @@ -604,7 +604,7 @@ A: floppy drive, and fd1 is the B: drive. ft0 is a QIC-80 tape drive - attached to the floppy controller. Comment out any lines + attached to the floppy controller. Comment out any lines corresponding to devices you do not have. @@ -618,10 +618,10 @@ controller wdc0 - This is the primary IDE controller. wd0 and wd1 are the master and slave hard - drive, respectively. wdc1 is + This is the primary IDE controller. wd0 and wd1 are the master and slave hard + drive, respectively. wdc1 is a secondary IDE controller where you might have a third or - fourth hard drive, or an IDE CD-ROM. Comment out the + fourth hard drive, or an IDE CD-ROM. Comment out the lines which do not apply (if you have a SCSI hard drive, you will probably want to comment out all six lines, for example). @@ -631,11 +631,11 @@ device wcd0 - This device provides IDE CD-ROM support. Be sure to + This device provides IDE CD-ROM support. Be sure to leave wdc0 uncommented, and wdc1 if you have more than one IDE controller and your CD-ROM is on the second one - card. To use this, you must also include the line + card. To use this, you must also include the line options ATAPI. @@ -646,7 +646,7 @@ npx0 is the interface to the floating point math unit in FreeBSD, either the - hardware co-processor or the software math emulator. It + hardware co-processor or the software math emulator. It is not optional. @@ -664,10 +664,10 @@ The following drivers are for the so-called - proprietary CD-ROM drives. These + proprietary CD-ROM drives. These drives have their own controller card or might plug into a - sound card such as the SoundBlaster 16. They are - not IDE or SCSI. Most older + sound card such as the SoundBlaster 16. They are + not IDE or SCSI. Most older single-speed and double-speed CD-ROMs use these interfaces, while newer quad-speeds are likely to be IDE or SCSI Controllers The next ten or so lines include support for different - kinds of SCSI controllers. Comment out all except for the + kinds of SCSI controllers. Comment out all except for the one(s) you have: @@ -812,10 +812,10 @@ This causes the kernel to pause 15 seconds before - probing each SCSI device in your system. If you only have + probing each SCSI device in your system. If you only have IDE hard drives, you can ignore this, otherwise you will probably want to lower this number, perhaps to 5 seconds, - to speed up booting. Of course if you do this, and + to speed up booting. Of course if you do this, and FreeBSD has trouble recognizing your SCSI devices, you will have to raise it back up. @@ -825,7 +825,7 @@ If you have any SCSI controllers, this line provides - generic SCSI support. If you do not have SCSI, you can + generic SCSI support. If you do not have SCSI, you can comment this, and the following three lines, out. @@ -879,11 +879,11 @@ vector scintr sc0 is the default - console driver, which resembles an SCO console. Since most + console driver, which resembles an SCO console. Since most full-screen programs access the console through a terminal database library like termcap, it should not matter much whether you use this or vt0, the VT220 compatible console - driver. When you log in, set your TERM variable to + driver. When you log in, set your TERM variable to “scoansi” if full-screen programs have trouble running under this console. @@ -894,9 +894,9 @@ This is a VT220-compatible console driver, backwards - compatible to VT100/102. It works well on some laptops - which have hardware incompatibilities with sc0. Also, set your TERM variable - to vt100 or vt220 when you log in. This driver + compatible to VT100/102. It works well on some laptops + which have hardware incompatibilities with sc0. Also, set your TERM variable + to vt100 or vt220 when you log in. This driver might also prove useful when connecting to a large number of different machines over the network, where the termcap or @@ -915,7 +915,7 @@ options XSERVER - Only applicable with the vt0 console driver. This + Only applicable with the vt0 console driver. This includes code required to run the XFree86 X Window Server under the vt0 console driver. @@ -958,8 +958,8 @@ Serial and Parallel Ports - Nearly all systems have these. If you are attaching a printer - to one of these ports, the Printing section of the handbook is very useful. If + Nearly all systems have these. If you are attaching a printer + to one of these ports, the Printing section of the handbook is very useful. If you are using modem, Dialup access provides extensive detail on serial port configuration for use with such devices. @@ -973,10 +973,10 @@ Note that if you have an internal modem on COM4 and a serial port at COM2 you will have to change the IRQ of the modem to 2 (for obscure technical reasons IRQ 2 = IRQ 9) - in order to access it from FreeBSD. If you have a + in order to access it from FreeBSD. If you have a multiport serial card, check the manual page for sio4 for more information on the - proper values for these lines. Some video cards (notably + proper values for these lines. Some video cards (notably those based on S3 chips) use IO addresses of the form 0x*2e8, and since many cheap serial cards do not fully decode the 16-bit IO address space, @@ -995,7 +995,7 @@ lpt0 through lpt2 are the three printer ports you - could conceivably have. Most people just have one, + could conceivably have. Most people just have one, though, so feel free to comment out the other two lines if you do not have them. @@ -1009,7 +1009,7 @@ Networking FreeBSD, as with Unix in general, places a - big emphasis on networking. Therefore, even + big emphasis on networking. Therefore, even if you do not have an Ethernet card, pay attention to the mandatory options and the dial-up networking support. @@ -1017,9 +1017,9 @@ options INET - Networking support. Leave it in even if you do not - plan to be connected to a network. Most programs require - at least loopback networking (i.e. making network + Networking support. Leave it in even if you do not + plan to be connected to a network. Most programs require + at least loopback networking (i.e. making network connections within your PC) so this is essentially mandatory. @@ -1029,8 +1029,8 @@ The next lines enable support for various Ethernet - cards. If you do not have a network card, you can comment - out all of these lines. Otherwise, you will want to leave + cards. If you do not have a network card, you can comment + out all of these lines. Otherwise, you will want to leave in support for your particular Ethernet card(s): @@ -1181,9 +1181,9 @@ loop is the generic - loopback device for TCP/IP. If you telnet or FTP to - localhost (a.k.a. 127.0.0.1) it will come back at you - through this pseudo-device. Mandatory. + loopback device for TCP/IP. If you telnet or FTP to + localhost (a.k.a. 127.0.0.1) it will come back at you + through this pseudo-device. Mandatory. @@ -1201,12 +1201,12 @@ sl is for SLIP (Serial - Line Internet Protocol) support. This has been almost + Line Internet Protocol) support. This has been almost entirely supplanted by PPP, which is easier to set up, better suited for modem-to-modem connections, as well as - more powerful. The number after + more powerful. The number after sl specifies how many - simultaneous SLIP sessions to support. This handbook has + simultaneous SLIP sessions to support. This handbook has more information on setting up a SLIP client or server. @@ -1218,11 +1218,11 @@ ppp is for kernel-mode PPP (Point-to-Point Protocol) support for dial-up Internet - connections. There is also version of PPP implemented as a + connections. There is also version of PPP implemented as a user application that uses the tun and offers more flexibility and - features such as demand dialing. If you still want to use + features such as demand dialing. If you still want to use this PPP driver, read the kernel-mode PPP - section of the handbook. As with the sl device, + section of the handbook. As with the sl device, number specifies how many simultaneous PPP connections to support. @@ -1233,10 +1233,10 @@ tun is used by the - user-mode PPP software. This program is easy to set up and - very fast. It also has special features such as automatic - dial-on-demand. The number after tun specifies the number of - simultaneous PPP sessions to support. See the tun specifies the number of + simultaneous PPP sessions to support. See the user-mode PPP section of the handbook for more information. @@ -1246,17 +1246,17 @@ number - Berkeley packet filter. This pseudo-device allows + Berkeley packet filter. This pseudo-device allows network interfaces to be placed in promiscuous mode, - capturing every packet on a broadcast network (e.g. an - ethernet). These packets can be captured to disk and/or + capturing every packet on a broadcast network (e.g. an + ethernet). These packets can be captured to disk and/or examined with the tcpdump1 program. Note that implementation of this capability can seriously - compromise your overall network security. The + compromise your overall network security. The number after bpfilter is the number of interfaces that can be examined simultaneously. Optional, not recommended except for those who are fully - aware of the potential pitfalls. Not all network cards + aware of the potential pitfalls. Not all network cards support this capability. @@ -1269,7 +1269,7 @@ Sound cards This is the first section containing lines that are not in the - GENERIC kernel. To include sound card support, you will have to + GENERIC kernel. To include sound card support, you will have to copy the appropriate lines from the LINT kernel (which contains support for every device) as follows: @@ -1277,7 +1277,7 @@ controller snd0 - Generic sound driver code. Required for all of the + Generic sound driver code. Required for all of the following sound cards except pca. @@ -1324,7 +1324,7 @@ device sbmidi0 at isa? port 0x330 - SoundBlaster 16 MIDI interface. If you have a + SoundBlaster 16 MIDI interface. If you have a SoundBlaster 16, you must include this line, or the kernel will not compile. @@ -1350,7 +1350,7 @@ conflicts - AdLib FM-synthesis audio. Include this line for + AdLib FM-synthesis audio. Include this line for AdLib, SoundBlaster, and ProAudioSpectrum users, if you want to play MIDI songs with a program such as playmidi (in the ports collection). @@ -1377,7 +1377,7 @@ tty - Digital audio through PC speaker. This is going to be + Digital audio through PC speaker. This is going to be very poor sound quality and quite CPU-intensive, so you have been warned (but it does not require a sound card). @@ -1400,7 +1400,7 @@ Pseudo-device drivers are parts of the kernel that act like device drivers but do not correspond to any actual hardware in the - machine. The network-related pseudo-devices are in that section, + machine. The network-related pseudo-devices are in that section, while the remainder are here. @@ -1408,7 +1408,7 @@ pseudo-device gzip gzip allows you to run - FreeBSD programs that have been compressed with gzip. The programs in + FreeBSD programs that have been compressed with gzip. The programs in /stand are compressed so it is a good idea to have this option in your kernel. @@ -1418,7 +1418,7 @@ log is used for logging - of kernel error messages. Mandatory. + of kernel error messages. Mandatory. @@ -1427,12 +1427,12 @@ pty is a - “pseudo-terminal” or simulated login port. It is used + “pseudo-terminal” or simulated login port. It is used by incoming telnet and rlogin sessions, xterm, and - some other applications such as emacs. The + some other applications such as emacs. The number indicates the number of - ptys to create. If you need + ptys to create. If you need more than GENERIC default of 16 simultaneous xterm windows and/or remote logins, be sure to increase this number accordingly, up to a maximum of 256. @@ -1443,24 +1443,24 @@ number - Snoop device. This pseudo-device allows one terminal + Snoop device. This pseudo-device allows one terminal session to watch another using the - watch8 command. Note that + watch8 command. Note that implementation of this capability has important security - and privacy implications. The number + and privacy implications. The number after snp is the total number of simultaneous snoop - sessions. Optional. + sessions. Optional. pseudo-device vn - Vnode driver. Allows a file to be treated as a device + Vnode driver. Allows a file to be treated as a device after being set up with the vnconfig8 - command. This driver can be useful for manipulating + command. This driver can be useful for manipulating floppy disk images and using a file as a swap device (e.g. - an MS Windows swap file). Optional. + an MS Windows swap file). Optional. @@ -1468,12 +1468,12 @@ number - Concatenated disks. This pseudo-device allows you to + Concatenated disks. This pseudo-device allows you to concatenate multiple disk partitions into one large - “meta”-disk. The number after ccd + “meta”-disk. The number after ccd is the total number of concatenated disks (not total number of disks that can be concatenated) that can be - created. (See ccd4 and + created. (See ccd4 and ccdconfig8 man pages for more details.) Optional. @@ -1487,7 +1487,7 @@ Joystick, PC Speaker, Miscellaneous This section describes some miscellaneous hardware devices - supported by FreeBSD. Note that none of these lines are included + supported by FreeBSD. Note that none of these lines are included in the GENERIC kernel, you will have to copy them from this handbook or the LINT kernel (which contains support for every device): @@ -1504,13 +1504,13 @@ Supports IBM BASIC-style noises through the PC - speaker. Some fun programs which use this are + speaker. Some fun programs which use this are /usr/sbin/spkrtest, which is a shell script that plays some simple songs, and /usr/games/piano which lets you play songs using the keyboard as a simple piano (this file only exists if you have installed the - games package). Also, the excellent + games package). Also, the excellent text role-playing game NetHack (in the ports collection) can be configured to use this device to play songs when you play musical instruments in the game. @@ -1528,17 +1528,17 @@ Making Device Nodes Almost every device in the kernel has a corresponding “node” - entry in the /dev directory. These nodes look + entry in the /dev directory. These nodes look like regular files, but are actually special entries into the kernel - which programs use to access the device. The shell script + which programs use to access the device. The shell script /dev/MAKEDEV, which is executed when you first install the operating system, creates nearly all of the device nodes - supported. However, it does not create all of + supported. However, it does not create all of them, so when you add support for a new device, it pays to make sure that the appropriate entries are in this directory, and if not, add - them. Here is a simple example: + them. Here is a simple example: - Suppose you add the IDE CD-ROM support to the kernel. The line + Suppose you add the IDE CD-ROM support to the kernel. The line to add is: @@ -1548,7 +1548,7 @@ controller wcd0 that start with wcd0 in the /dev directory, possibly followed by a letter, such as c, or preceded by the letter r, which means a “raw” - device. It turns out that those files are not there, so I must + device. It turns out that those files are not there, so I must change to the /dev directory and type: @@ -1569,7 +1569,7 @@ controller wcd0 When creating device nodes for devices such as sound cards, if other people have access to your machine, it may be desirable to protect the devices from outside access by adding them to the - /etc/fbtab file. See man + /etc/fbtab file. See man fbtab for more information. @@ -1579,7 +1579,7 @@ controller wcd0 All SCSI controllers use the same set of /dev entries, so you do not need to create - these. Also, network cards and SLIP/PPP pseudo-devices do not + these. Also, network cards and SLIP/PPP pseudo-devices do not have entries in /dev at all, so you do not have to worry about these either. @@ -1590,7 +1590,7 @@ controller wcd0 If Something Goes Wrong There are four categories of trouble that can occur when - building a custom kernel. They are: + building a custom kernel. They are: @@ -1598,10 +1598,10 @@ controller wcd0 If the config command fails when you give it your kernel description, you have - probably made a simple error somewhere. Fortunately, + probably made a simple error somewhere. Fortunately, config will print the line number that it had trouble with, so you can quickly skip to - it with vi. For example, if + it with vi. For example, if you see: @@ -1618,7 +1618,7 @@ controller wcd0 If the make command fails, it usually signals an error in your kernel description, but not severe enough for config - to catch it. Again, look over your configuration, and if + to catch it. Again, look over your configuration, and if you still cannot resolve the problem, send mail to the &a.questions; with your kernel configuration, and it should be diagnosed very quickly. @@ -1631,17 +1631,17 @@ controller wcd0 If your new kernel does not boot, or fails to recognize your devices, do not panic! Fortunately, BSD has an excellent mechanism for recovering from incompatible - kernels. Simply type the name of the kernel you want to boot + kernels. Simply type the name of the kernel you want to boot from (i.e. kernel.old) at the FreeBSD boot prompt - instead of pressing return. When reconfiguring a kernel, it + instead of pressing return. When reconfiguring a kernel, it is always a good idea to keep a kernel that is known to work on hand. After booting with a good kernel you can check over your - configuration file and try to build it again. One helpful + configuration file and try to build it again. One helpful resource is the /var/log/messages file which records, among other things, all of the kernel - messages from every successful boot. Also, the + messages from every successful boot. Also, the dmesg8 command will print the kernel messages from the current boot. @@ -1649,14 +1649,14 @@ controller wcd0 If you are having trouble building a kernel, make sure to keep a GENERIC, or some other kernel that is known to work on hand as a different name that will not get erased - on the next build. You cannot rely on + on the next build. You cannot rely on kernel.old because when installing a new kernel, kernel.old is overwritten with the last installed kernel which may be - non-functional. Also, as soon as possible, move the + non-functional. Also, as soon as possible, move the working kernel to the proper kernel location or commands such as ps1 will not work - properly. The proper command to “unlock” the + properly. The proper command to “unlock” the kernel file that make installs (in order to move another kernel back permanently) is: @@ -1684,8 +1684,8 @@ controller wcd0 for example, an experimental “2.2.0” kernel on a 2.1.0-RELEASE system, many system-status commands like ps1 and vmstat8 - will not work any more. You must recompile the libkvm library as well as these - utilities. This is one reason it is not normally a good + will not work any more. You must recompile the libkvm library as well as these + utilities. This is one reason it is not normally a good idea to use a different version of the kernel from the rest of the operating system. diff --git a/en_US.ISO8859-1/books/handbook/kerneldebug/chapter.sgml b/en_US.ISO8859-1/books/handbook/kerneldebug/chapter.sgml index 2507290ae1..c7e43305ab 100644 --- a/en_US.ISO8859-1/books/handbook/kerneldebug/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/kerneldebug/chapter.sgml @@ -8,48 +8,48 @@ Debugging a Kernel Crash Dump with <command>kgdb</command> Here are some instructions for getting kernel debugging working - on a crash dump. They assume that you have enough swap space for a - crash dump. If you have multiple swap partitions and the first one + on a crash dump. They assume that you have enough swap space for a + crash dump. If you have multiple swap partitions and the first one is too small to hold the dump, you can configure your kernel to use an alternate dump device (in the config kernel line), or you can specify an alternate using the - dumpon8 command. The best way to use + dumpon8 command. The best way to use dumpon 8 is to set the dumpdev variable in - /etc/rc.conf. Typically you want to specify one of + /etc/rc.conf. Typically you want to specify one of the swap devices specified in /etc/fstab. Dumps to non-swap devices, tapes for example, - are currently not supported. Config your kernel using - config -g. See Kernel + are currently not supported. Config your kernel using + config -g. See Kernel Configuration for details on configuring the FreeBSD kernel. Use the dumpon8 command to tell the kernel where to dump to (note that this will have to be done after configuring the partition in question as swap space via - swapon8). This is normally arranged via + swapon8). This is normally arranged via /etc/rc.conf and /etc/rc. Alternatively, you can hard-code the dump device via the dump - clause in the config line of your kernel config file. This is + clause in the config line of your kernel config file. This is deprecated and should be used only if you want a crash dump from a kernel that crashes during booting. In the following, the term kgdb refers to - gdb run in “kernel debug mode”. This can be + gdb run in “kernel debug mode”. This can be accomplished by either starting the gdb with the option , or by linking and starting it - under the name kgdb. This is not being done by + under the name kgdb. This is not being done by default, however, and the idea is basically deprecated since the GNU folks do not like their tools to behave differently when - called by another name. This feature may well be discontinued in + called by another name. This feature may well be discontinued in further releases. When the kernel has been built make a copy of it, say kernel.debug, and then run strip - -d on the original. Install the original as normal. You + -d on the original. Install the original as normal. You may also install the unstripped kernel, but symbol table lookup time for some programs will drastically increase, and since the whole kernel is loaded entirely at boot time and cannot be swapped out @@ -69,13 +69,13 @@ Dumps to non-swap devices, tapes for example, This instructs savecore8 to - use another kernel for symbol name extraction. It would otherwise + use another kernel for symbol name extraction. It would otherwise default to the currently running kernel and most likely not do anything at all since the crash dump and the kernel symbols differ. Now, after a crash dump, go to - /sys/compile/WHATEVER and run kgdb. From kgdb + /sys/compile/WHATEVER and run kgdb. From kgdb do: @@ -88,7 +88,7 @@ Dumps to non-swap devices, tapes for example, kernel sources just like you can for any other program. Here is a script log of a kgdb - session illustrating the procedure. Long lines have been folded to + session illustrating the procedure. Long lines have been folded to improve readability, and the lines are numbered for reference. Despite this, it is a real-world error trace taken during the development of the pcvt console driver. @@ -203,8 +203,8 @@ Dumps to non-swap devices, tapes for example, Force usage of a new stack frame; this is no longer - necessary now. The stack frames are supposed to point to - the right locations now, even in case of a trap. (I do not + necessary now. The stack frames are supposed to point to + the right locations now, even in case of a trap. (I do not have a new core dump handy <g>, my kernel has not panicked for a rather long time.) From looking at the code in source line 403, there is a high probability that either @@ -243,9 +243,9 @@ Dumps to non-swap devices, tapes for example, Debugging a crash dump with DDD Examining a kernel crash dump with a graphical debugger like - ddd is also possible. Add the + ddd is also possible. Add the option to the ddd command line you would use - normally. For example; + normally. For example; &prompt.root; ddd -k /var/crash/kernel.0 /var/crash/vmcore.0 @@ -260,32 +260,32 @@ Dumps to non-swap devices, tapes for example, What do you do if a kernel dumped core but you did not expect it, and it is therefore not compiled using config - -g? Not everything is lost here. Do not panic! + -g? Not everything is lost here. Do not panic! - Of course, you still need to enable crash dumps. See above on + Of course, you still need to enable crash dumps. See above on the options you have to specify in order to do this. Go to your kernel compile directory, and edit the line - containing COPTFLAGS?=-O. Add the + containing COPTFLAGS?=-O. Add the option there (but do not - change anything on the level of optimization). If you do already + change anything on the level of optimization). If you do already know roughly the probable location of the failing piece of code (e.g., the pcvt driver in the example - above), remove all the object files for this code. Rebuild the - kernel. Due to the time stamp change on the Makefile, there will be + above), remove all the object files for this code. Rebuild the + kernel. Due to the time stamp change on the Makefile, there will be some other object files rebuild, for example - trap.o. With a bit of luck, the added + trap.o. With a bit of luck, the added option will not change anything for the generated code, so you will finally get a new kernel with similar - code to the faulting one but some debugging symbols. You should at + code to the faulting one but some debugging symbols. You should at least verify the old and new sizes with the - size1 command. If there is a mismatch, you + size1 command. If there is a mismatch, you probably need to give up here. - Go and examine the dump as described above. The debugging + Go and examine the dump as described above. The debugging symbols might be incomplete for some places, as can be seen in the stack trace in the example above where some functions are displayed - without line numbers and argument lists. If you need more debugging + without line numbers and argument lists. If you need more debugging symbols, remove the appropriate object files and repeat the kgdb session until you know enough. @@ -300,52 +300,52 @@ Dumps to non-swap devices, tapes for example, While kgdb as an offline debugger provides a very high level of user interface, there are some things - it cannot do. The most important ones being breakpointing and + it cannot do. The most important ones being breakpointing and single-stepping kernel code. If you need to do low-level debugging on your kernel, there is - an on-line debugger available called DDB. It allows to setting + an on-line debugger available called DDB. It allows to setting breakpoints, single-steping kernel functions, examining and changing - kernel variables, etc. However, it cannot access kernel source + kernel variables, etc. However, it cannot access kernel source files, and only has access to the global and static symbols, not to the full debug information like kgdb. To configure your kernel to include DDB, add the option line -options DDB to your config file, and rebuild. (See to your config file, and rebuild. (See Kernel Configuration for details on configuring the FreeBSD kernel. Note that if you have an older version of the boot blocks, - your debugger symbols might not be loaded at all. Update the boot + your debugger symbols might not be loaded at all. Update the boot blocks; the recent ones load the DDB symbols automagically.) Once your DDB kernel is running, there are several ways to enter - DDB. The first, and earliest way is to type the boot flag - right at the boot prompt. The kernel will start - up in debug mode and enter DDB prior to any device probing. Hence + DDB. The first, and earliest way is to type the boot flag + right at the boot prompt. The kernel will start + up in debug mode and enter DDB prior to any device probing. Hence you can even debug the device probe/attach functions. The second scenario is a hot-key on the keyboard, usually - Ctrl-Alt-ESC. For syscons, this can be remapped; some of the - distributed maps do this, so watch out. There is an option available + Ctrl-Alt-ESC. For syscons, this can be remapped; some of the + distributed maps do this, so watch out. There is an option available for serial consoles that allows the use of a serial line BREAK on the console line to enter DDB (options - BREAK_TO_DEBUGGER in the kernel config file). It is + BREAK_TO_DEBUGGER in the kernel config file). It is not the default since there are a lot of crappy serial adapters around that gratuitously generate a BREAK condition, for example when pulling the cable. The third way is that any panic condition will branch to DDB if - the kernel is configured to use it. For this reason, it is not + the kernel is configured to use it. For this reason, it is not wise to configure a kernel with DDB for a machine running unattended. - The DDB commands roughly resemble some gdb commands. The first thing you probably + The DDB commands roughly resemble some gdb commands. The first thing you probably need to do is to set a breakpoint: @@ -356,7 +356,7 @@ options DDB to your config file, and rebuild. (See Numbers are taken hexadecimal by default, but to make them distinct from symbol names; hexadecimal numbers starting with the letters a-f need to be preceded with - 0x (this is optional for other numbers). Simple + 0x (this is optional for other numbers). Simple expressions are allowed, for example: function-name + 0x103. @@ -386,7 +386,7 @@ options DDB to your config file, and rebuild. (See The first form will be accepted immediately after - a breakpoint hit, and deletes the current breakpoint. The second + a breakpoint hit, and deletes the current breakpoint. The second form can remove any breakpoint, but you need to specify the exact address; this can be obtained from: @@ -422,8 +422,8 @@ options DDB to your config file, and rebuild. (See @@ -487,9 +487,9 @@ options DDB to your config file, and rebuild. (See Now you have now examined why your kernel failed, and you wish - to reboot. Remember that, depending on the severity of previous + to reboot. Remember that, depending on the severity of previous malfunctioning, not all parts of the kernel might still be working - as expected. Perform one of the following actions to shut down and + as expected. Perform one of the following actions to shut down and reboot your system: @@ -497,8 +497,8 @@ options DDB to your config file, and rebuild. (See This will cause your kernel to dump core and reboot, so you can - later analyze the core on a higher level with kgdb. This command - usually must be followed by another continue statement. There is now an alias for + later analyze the core on a higher level with kgdb. This command + usually must be followed by another continue statement. There is now an alias for this: panic. @@ -507,7 +507,7 @@ options DDB to your config file, and rebuild. (See Which might be a good way to cleanly shut down the running system, sync() all disks, and finally - reboot. As long as the disk and file system interfaces of the + reboot. As long as the disk and file system interfaces of the kernel are not damaged, this might be a good way for an almost clean shutdown. @@ -526,7 +526,7 @@ options DDB to your config file, and rebuild. (See However, it is highly recommended to have a printed copy of the ddb4 manual page - ready for a debugging session. Remember that it is hard to read the + ready for a debugging session. Remember that it is hard to read the on-line manual while single-stepping the kernel. @@ -538,9 +538,9 @@ options DDB to your config file, and rebuild. (See GDB has already supported remote debugging - for a long time. This is done using a very simple protocol along a - serial line. Unlike the other methods described above, you will - need two machines for doing this. One is the host providing the + for a long time. This is done using a very simple protocol along a + serial line. Unlike the other methods described above, you will + need two machines for doing this. One is the host providing the debugging environment, including all the sources, and a copy of the kernel binary with all the symbols in it, and the other one is the target machine that simply runs a similar copy of the very same @@ -548,12 +548,12 @@ options DDB to your config file, and rebuild. (See You should configure the kernel in question with config -g, include into the - configuration, and compile it as usual. This gives a large blurb of - a binary, due to the debugging information. Copy this kernel to the + configuration, and compile it as usual. This gives a large blurb of + a binary, due to the debugging information. Copy this kernel to the target machine, strip the debugging symbols off with strip -x, and boot it using the boot - option. Connect the first serial line of the target machine to any - serial line of the debugging host. Now, on the debugging machine, + option. Connect the first serial line of the target machine to any + serial line of the debugging host. Now, on the debugging machine, go to the compile directory of the target kernel, and start gdb: @@ -589,8 +589,8 @@ Stopped at Debugger+0x35: movb $0, edata+0x51bc Every time you type gdb, the mode will be toggled between - remote GDB and local DDB. In order to force a next trap - immediately, simply type s (step). Your hosting GDB will now + remote GDB and local DDB. In order to force a next trap + immediately, simply type s (step). Your hosting GDB will now gain control over the target kernel: @@ -605,7 +605,7 @@ Debugger (msg=0xf01b0383 "Boot flags requested debugger") an Emacs window (which gives you an automatic source code display in another Emacs window) etc. - Remote GDB can also be used to debug LKMs. First build the LKM + Remote GDB can also be used to debug LKMs. First build the LKM with debugging symbols: @@ -625,8 +625,8 @@ EXEC 0 4 f5109000 001c f510f010 1 linux_mod Take the load address of the module and add 0x20 (probably to - account for the a.out header). This is the address that the module - code was relocated to. Use the add-symbol-file command in GDB to tell the + account for the a.out header). This is the address that the module + code was relocated to. Use the add-symbol-file command in GDB to tell the debugger about the module: @@ -644,10 +644,10 @@ text_addr = 0xf5109020? (y or n) y Debugging a Console Driver Since you need a console driver to run DDB on, things are more - complicated if the console driver itself is failing. You might + complicated if the console driver itself is failing. You might remember the use of a serial console (either with modified boot blocks, or by specifying at the Boot: prompt), and hook up a standard terminal - onto your first serial port. DDB works on any configured console + onto your first serial port. DDB works on any configured console driver, of course also on a serial console. diff --git a/en_US.ISO8859-1/books/handbook/kernelopts/chapter.sgml b/en_US.ISO8859-1/books/handbook/kernelopts/chapter.sgml index 4b494b6c43..bb648cd468 100644 --- a/en_US.ISO8859-1/books/handbook/kernelopts/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/kernelopts/chapter.sgml @@ -14,23 +14,23 @@ The use of kernel options is basically described in the kernel configuration - section. There's also an explanation of “historic” and - “new-style” options. The ultimate goal is to eventually turn all + section. There's also an explanation of “historic” and + “new-style” options. The ultimate goal is to eventually turn all the supported options in the kernel into new-style ones, so for people who correctly did a make depend in their kernel compile directory after running config8, the build process will automatically pick up modified options, and only recompile those files where it is - necessary. Wiping out the old compile directory on each run of + necessary. Wiping out the old compile directory on each run of config8 as it is still done now can then be eliminated again. Basically, a kernel option is nothing else than the definition - of a C preprocessor macro for the kernel compilation process. To + of a C preprocessor macro for the kernel compilation process. To make the build truly optional, the corresponding part of the kernel source (or kernel .h file) must be written with the option concept in mind, i.e. the default must have been made - overridable by the config option. This is usually done with + overridable by the config option. This is usually done with something like: @@ -40,7 +40,7 @@ This way, an administrator mentioning another value for the option in his config file will take the default out of effect, and - replace it with his new value. Clearly, the new value will be + replace it with his new value. Clearly, the new value will be substituted into the source code during the preprocessor run, so it must be a valid C expression in whatever context the default value would have been used. @@ -63,32 +63,32 @@ People familiar with the C language will immediately recognize that everything could be counted as a “config option” where there is at least a single #ifdef - referencing it... However, it's unlikely that many people would + referencing it... However, it's unlikely that many people would put options notyet,notdef in their config file, and then wonder why the kernel compilation - falls over. :-) + falls over. :-) Clearly, using arbitrary names for the options makes it very - hard to track their usage throughout the kernel source tree. That + hard to track their usage throughout the kernel source tree. That is the rationale behind the new-style option scheme, where each option goes into a separate .h file in the kernel compile directory, which is by convention named - opt_foo.h. This way, + opt_foo.h. This way, the usual Makefile dependencies could be applied, and make can determine what needs to be recompiled once an option has been changed. The old-style option mechanism still has one advantage for local options or maybe experimental options that have a short anticipated lifetime: since it is easy to add a new #ifdef to the kernel source, this has already - made it a kernel config option. In this case, the administrator + made it a kernel config option. In this case, the administrator using such an option is responsible himself for knowing about its implications (and maybe manually forcing the recompilation of parts - of his kernel). Once the transition of all supported options has + of his kernel). Once the transition of all supported options has been done, config8 will warn whenever an unsupported option appears in the config file, but it will nevertheless include it into the kernel Makefile. @@ -102,19 +102,19 @@ options notyet,notdef sys/i386/conf/options.<arch>, e. g. sys/i386/conf/options.i386), and select an opt_foo.h file where your new option would best go into. If there is already something that comes close to the purpose of - the new option, pick this. For example, options modifying the + the new option, pick this. For example, options modifying the overall behaviour of the SCSI subsystem can go into - opt_scsi.h. By default, simply mentioning an + opt_scsi.h. By default, simply mentioning an option in the appropriate option file, say FOO, implies its value will go into the corresponding file - opt_foo.h. This can be overridden on the + opt_foo.h. This can be overridden on the right-hand side of a rule by specifying another filename. If there is no opt_foo.h already - available for the intended new option, invent a new name. Make it + available for the intended new option, invent a new name. Make it meaningful, and comment the new section in the - options[.<arch>] file. config8 will automagically pick up the change, and create that file next time it is run. Most options should go in a header file by themselves.. + options[.<arch>] file. config8 will automagically pick up the change, and create that file next time it is run. Most options should go in a header file by themselves.. Packing too many options into a single opt_foo.h will cause @@ -129,13 +129,13 @@ options notyet,notdef &prompt.user; find /usr/src/sys -name type f | xargs fgrep NEW_OPTION - is your friend in finding them. Go and edit all those files, + is your friend in finding them. Go and edit all those files, and add #include "opt_foo.h" - on top, before all the #include <xxx.h> stuff. This sequence + on top, before all the #include <xxx.h> stuff. This sequence is most important as the options could override defaults from the regular include files, if the defaults are of the form @@ -152,7 +152,7 @@ options notyet,notdef opt_foo.h cannot be included into those files since it would break the headers more seriously, but if it is not included, then places that include it - may get an inconsistent value for the option. Yes, there are + may get an inconsistent value for the option. Yes, there are precedents for this right now, but that does not make them more correct. diff --git a/en_US.ISO8859-1/books/handbook/l10n/chapter.sgml b/en_US.ISO8859-1/books/handbook/l10n/chapter.sgml index b37df3d188..e9444cd3d6 100644 --- a/en_US.ISO8859-1/books/handbook/l10n/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/l10n/chapter.sgml @@ -52,7 +52,7 @@ font8x8=cp866-8x8 key remapped to match Russian termcap5 entry for FreeBSD console. - RUS/LAT switch will be CapsLock. Old CapsLock function still + RUS/LAT switch will be CapsLock. Old CapsLock function still available via Shift+CapsLock. CapsLock LED will indicate RUS mode, not CapsLock mode. @@ -96,7 +96,7 @@ ttyv0 "/usr/libexec/getty Pc" cons25r on secure The best way is using /etc/login.conf russian user's login class in passwd5 entry login class - position. See login.conf5 for + position. See login.conf5 for details. @@ -235,8 +235,8 @@ setenv MM_CHARSET KOI8-R Since most printers with Russian characters comes with hardware code page CP866, special output filter needed for KOI8-R - -> CP866 conversion. Such filter installed by default as - /usr/libexec/lpr/ru/koi2alt. So, Russian + -> CP866 conversion. Such filter installed by default as + /usr/libexec/lpr/ru/koi2alt. So, Russian printer /etc/printcap entry should looks like: @@ -282,7 +282,7 @@ lp|Russian local line printer:\ XFree86 port from /usr/ports/x11/XFree86 already have most recent XFree86 version, so it will work, if you - install XFree86 from this port. XFree86 version shipped + install XFree86 from this port. XFree86 version shipped with the latest FreeBSD distribution should work too (check XFree86 version number not less than 3.3 first). @@ -295,8 +295,8 @@ lp|Russian local line printer:\ &prompt.root; make all install - there. This port install latest - version of KOI8-R fonts. XFree86 3.3 already have some + there. This port install latest + version of KOI8-R fonts. XFree86 3.3 already have some KOI8-R fonts, but this ones scaled better. Check find "Files" section @@ -323,7 +323,7 @@ XkbKeymap "xfree86(ru)" line into XkbDisable is turned off (commented out) there. - RUS/LAT switch will be CapsLock. Old CapsLock function still + RUS/LAT switch will be CapsLock. Old CapsLock function still available via Shift+CapsLock (in LAT mode only). @@ -346,7 +346,7 @@ XkbKeymap "xfree86(ru)" line into German Language (ISO 8859-1) - Slaven Rezic eserte@cs.tu-berlin.de wrote a tutorial how to use umlauts on a FreeBSD machine. The tutorial is written in German and available at http://www.de.freebsd.org/de/umlaute/. + Slaven Rezic eserte@cs.tu-berlin.de wrote a tutorial how to use umlauts on a FreeBSD machine. The tutorial is written in German and available at http://www.de.freebsd.org/de/umlaute/. diff --git a/en_US.ISO8859-1/books/handbook/linuxemu/chapter.sgml b/en_US.ISO8859-1/books/handbook/linuxemu/chapter.sgml index adf9e71a9e..a90d279f6d 100644 --- a/en_US.ISO8859-1/books/handbook/linuxemu/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/linuxemu/chapter.sgml @@ -9,14 +9,14 @@ Linux emulation in FreeBSD has reached a point where it is possible to run a large fraction of Linux binaries in both a.out and - ELF format. The linux emulation in the 2.1-STABLE branch is capable + ELF format. The linux emulation in the 2.1-STABLE branch is capable of running Linux DOOM and Mathematica; the version present in &rel.current;-RELEASE is vastly more capable and runs all these as well as Quake, Abuse, IDL, netrek for Linux and a whole host of other programs. There are some Linux-specific operating system features that are - not supported on FreeBSD. Linux binaries will not work on FreeBSD + not supported on FreeBSD. Linux binaries will not work on FreeBSD if they use the Linux /proc filesystem (which is different from the optional FreeBSD /proc filesystem) or i386-specific calls, such as enabling virtual 8086 @@ -31,8 +31,8 @@ The GENERIC kernel in 2.1-STABLE is not configured for linux compatibility so you must reconfigure your - kernel for it. There are two ways to do this: 1. linking the - emulator statically in the kernel itself and 2. configuring your + kernel for it. There are two ways to do this: 1. linking the + emulator statically in the kernel itself and 2. configuring your kernel to dynamically load the linux loadable kernel module (LKM). @@ -50,7 +50,7 @@ options COMPAT_LINUX options SYSVSHM The linux system calls require 4.3BSD system - call compatibility. So make sure you have the following. + call compatibility. So make sure you have the following. options "COMPAT_43" @@ -67,7 +67,7 @@ options LINUX section. If you decide to use the LKM you must also install the - loadable module. A mismatch of versions between the kernel and + loadable module. A mismatch of versions between the kernel and loadable module can cause the kernel to crash, so the safest thing to do is to reinstall the LKM when you install the kernel. @@ -95,11 +95,11 @@ Module Name EXEC 0 3 f0baf000 0018 f0bb4000 1 linux_emulator You can cause the LKM to be loaded when the - system boots in either of two ways. In FreeBSD 2.2.1-RELEASE and + system boots in either of two ways. In FreeBSD 2.2.1-RELEASE and 2.1-STABLE enable it in /etc/sysconfig -linux=YES by changing it from NO to YES. FreeBSD 2.1 +linux=YES by changing it from NO to YES. FreeBSD 2.1 RELEASE and earlier do not have such a line and on those you will need to edit /etc/rc.local to add the following line. @@ -112,9 +112,9 @@ linux Installing Linux Emulation in 2.2.2-RELEASE and later It is no longer necessary to specify options LINUX or - options COMPAT_LINUX. Linux emulation is done with an LKM + options COMPAT_LINUX. Linux emulation is done with an LKM (“Loadable Kernel Module”) so it can be installed on the fly - without having to reboot. You will need the following things in + without having to reboot. You will need the following things in your startup files, however: @@ -149,14 +149,14 @@ EXEC 0 4 f09e6000 001c f09ec010 1 linux_mod However, there have been reports that this - fails on some 2.2-RELEASE and later systems. If for some reason + fails on some 2.2-RELEASE and later systems. If for some reason you cannot load the linux LKM, then statically link the emulator in the kernel by adding options LINUX - to your kernel config file. Then run config + to your kernel config file. Then run config and install the new kernel as described in the kernel configuration section. @@ -170,7 +170,7 @@ options LINUX Installing using the linux_lib port Most linux applications use shared libraries, so you are - still not done until you install the shared libraries. It is + still not done until you install the shared libraries. It is possible to do this by hand, however, it is vastly simpler to just grab the linux_lib port: @@ -179,12 +179,12 @@ options LINUX &prompt.root; make all install - and you should have a working linux emulator. Legend (and + and you should have a working linux emulator. Legend (and the mail archives :-) seems to hold that Linux emulation works best with linux binaries linked against the ZMAGIC libraries; QMAGIC libraries (such as those used in Slackware V2.0) may tend - to give the Linuxulator heartburn. Also, expect some programs to complain - about incorrect minor versions of the system libraries. In + to give the Linuxulator heartburn. Also, expect some programs to complain + about incorrect minor versions of the system libraries. In general, however, this does not seem to be a problem. @@ -194,17 +194,17 @@ options LINUX Installing libraries manually If you do not have the “ports” distribution, you can - install the libraries by hand instead. You will need the Linux + install the libraries by hand instead. You will need the Linux shared libraries that the program depends on and the runtime - linker. Also, you will need to create a "shadow root" + linker. Also, you will need to create a "shadow root" directory, /compat/linux, for Linux - libraries on your FreeBSD system. Any shared libraries opened + libraries on your FreeBSD system. Any shared libraries opened by Linux programs run under FreeBSD will look in this tree - first. So, if a Linux program loads, for example, + first. So, if a Linux program loads, for example, /lib/libc.so, FreeBSD will first try to open /compat/linux/lib/libc.so, and if that does not exist then it will try - /lib/libc.so. Shared libraries should be + /lib/libc.so. Shared libraries should be installed in the shadow tree /compat/linux/lib rather than the paths that the Linux ld.so reports. @@ -216,7 +216,7 @@ options LINUX Generally, you will need to look for the shared libraries that Linux binaries depend on only the first few times that you - install a Linux program on your FreeBSD system. After a while, + install a Linux program on your FreeBSD system. After a while, you will have a sufficient set of Linux shared libraries on your system to be able to run newly imported Linux binaries without any extra work. @@ -235,7 +235,7 @@ options LINUX If you have access to a Linux system, see what shared libraries the application needs, and copy them to your FreeBSD system. - Example: you have just ftp'ed the Linux binary of Doom. Put it + Example: you have just ftp'ed the Linux binary of Doom. Put it on the Linux system you have access to, and check which shared libraries it needs by running ldd linuxxdoom: @@ -266,9 +266,9 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 a matching major revision number to the first column of the ldd output, you will not need to copy the file named in the last column to your system, the one you already have should - work. It is advisable to copy the shared library anyway if it - is a newer version, though. You can remove the old one, as - long as you make the symbolic link point to the new one. So, + work. It is advisable to copy the shared library anyway if it + is a newer version, though. You can remove the old one, as + long as you make the symbolic link point to the new one. So, if you have these libraries on your system: @@ -299,7 +299,7 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 The symbolic link mechanism is only - needed for Linux binaries. The FreeBSD runtime linker takes + needed for Linux binaries. The FreeBSD runtime linker takes care of looking for matching major revision numbers itself and you do not need to worry about it. @@ -314,7 +314,7 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 Finally, if you run FreeBSD 2.2-RELEASE you must make sure that you have the Linux runtime linker and its config files on - your system. You should copy these files from the Linux system + your system. You should copy these files from the Linux system to their appropriate place on your FreeBSD system (to the /compat/linux tree): @@ -324,8 +324,8 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 If you do not have access to a Linux system, you should get - the extra files you need from various ftp sites. Information on - where to look for the various files is appended below. For now, + the extra files you need from various ftp sites. Information on + where to look for the various files is appended below. For now, let us assume you know where to get the files. Retrieve the following files (all from the same ftp site to @@ -343,16 +343,16 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 ldconfig and ldd do not necessarily need to be under /compat/linux; you can install them - elsewhere in the system too. Just make sure they do not conflict - with their FreeBSD counterparts. A good idea would be to install + elsewhere in the system too. Just make sure they do not conflict + with their FreeBSD counterparts. A good idea would be to install them in /usr/local/bin as ldconfig-linux and ldd-linux. Create the file /compat/linux/etc/ld.so.conf, containing the directories in which the Linux runtime linker should look - for shared libs. It is a plain text file, containing a directory - name on each line. /lib and + for shared libs. It is a plain text file, containing a directory + name on each line. /lib and /usr/lib are standard, you could add the following: @@ -362,7 +362,7 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 When a linux binary opens a library such as /lib/libc.so the emulator maps the name to - /compat/linux/lib/libc.so internally. All + /compat/linux/lib/libc.so internally. All linux libraries should be installed under /compat/linux (e.g. /compat/linux/lib/libc.so, /compat/linux/usr/X11/lib/libX11.so, etc.) @@ -378,7 +378,7 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 ldconfig is statically linked, so it does not need any - shared libraries to run. It creates the file + shared libraries to run. It creates the file /compat/linux/etc/ld.so.cache which contains the names of all the shared libraries and should be rerun to recreate this file whenever you install additional @@ -390,8 +390,8 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 and ldconfig is not needed or used. You should now be set up for Linux binaries which only need - a shared libc. You can test this by running the Linux ldd on - itself. Supposing that you have it installed as ldd-linux, it + a shared libc. You can test this by running the Linux ldd on + itself. Supposing that you have it installed as ldd-linux, it should produce something like: @@ -400,19 +400,19 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 This being done, you are ready to install new Linux - binaries. Whenever you install a new Linux program, you should + binaries. Whenever you install a new Linux program, you should check if it needs shared libraries, and if so, whether you have them installed in the /compat/linux tree. To do this, you run the Linux version ldd on the new program, - and watch its output. ldd (see also the manual page for ldd1) + and watch its output. ldd (see also the manual page for ldd1) will print a list of shared libraries that the program depends on, in the form majorname (jumpversion) => fullname. If it prints not found instead of fullname it means that - you need an extra library. The library needed is shown in - majorname and will be of the form libXXXX.so.N. You will need to + you need an extra library. The library needed is shown in + majorname and will be of the form libXXXX.so.N. You will need to find a libXXXX.so.N.mm on a Linux ftp site, and install it on - your system. The XXXX (name) and N (major revision number) + your system. The XXXX (name) and N (major revision number) should match; the minor number(s) mm are less important, though it is advised to take the most recent version. @@ -423,7 +423,7 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 Installing Linux ELF binaries ELF binaries sometimes require an extra step of - “branding”. If you attempt to run an unbranded ELF binary, + “branding”. If you attempt to run an unbranded ELF binary, you will get an error message like the following; @@ -466,18 +466,18 @@ multi on where the order here specifies that /etc/hosts is searched first and DNS is - searched second. When + searched second. When /compat/linux/etc/host.conf is not installed linux applications find FreeBSD's /etc/host.conf and complain about the - incompatible FreeBSD syntax. You should remove bind if you + incompatible FreeBSD syntax. You should remove bind if you have not configured a name-server using the /etc/resolv.conf file. Lastly, those who run 2.1-STABLE need to set an the RESOLV_HOST_CONF environment variable so that applications will - know how to search the host tables. If you run FreeBSD - 2.2-RELEASE or later, you can skip this. For the + know how to search the host tables. If you run FreeBSD + 2.2-RELEASE or later, you can skip this. For the /bin/csh shell use: @@ -503,12 +503,12 @@ multi on Linux is distributed by several groups that make their own set - of binaries that they distribute. Each distribution has its own - name, like “Slackware” or “Yggdrasil”. The distributions are - available on a lot of ftp sites. Sometimes the files are unpacked, + of binaries that they distribute. Each distribution has its own + name, like “Slackware” or “Yggdrasil”. The distributions are + available on a lot of ftp sites. Sometimes the files are unpacked, and you can get the individual files you need, but mostly they are stored in distribution sets, usually consisting of subdirectories - with gzipped tar files in them. The primary ftp sites for the + with gzipped tar files in them. The primary ftp sites for the distributions are: @@ -538,15 +538,15 @@ multi on - For simplicity, let us concentrate on Slackware here. This + For simplicity, let us concentrate on Slackware here. This distribution consists of a number of subdirectories, containing - separate packages. Normally, they are controlled by an install - program, but you can retrieve files “by hand” too. First of all, + separate packages. Normally, they are controlled by an install + program, but you can retrieve files “by hand” too. First of all, you will need to look in the contents subdir of the - distribution. You will find a lot of small text files here - describing the contents of the separate packages. The fastest way + distribution. You will find a lot of small text files here + describing the contents of the separate packages. The fastest way to look something up is to retrieve all the files in the contents - subdirectory, and grep through them for the file you need. Here is + subdirectory, and grep through them for the file you need. Here is an example of a list of files that you might need, and in which contents-file you will find it by grepping through them: @@ -585,10 +585,10 @@ multi on So, in this case, you will need the packages ldso, shlibs, - xf_lib and oldlibs. In each of the contents-files for these + xf_lib and oldlibs. In each of the contents-files for these packages, look for a line saying PACKAGE LOCATION, it will tell you on which “disk” the package is, in our case it will tell - us in which subdirectory we need to look. For our example, we + us in which subdirectory we need to look. For our example, we would find the following locations: @@ -611,7 +611,7 @@ multi on The locations called “diskXX” refer to the slakware/XX subdirectories of the distribution, others may be found in the - contrib subdirectory. In this case, we + contrib subdirectory. In this case, we could now retrieve the packages we need by retrieving the following files (relative to the root of the Slackware distribution tree): @@ -655,13 +655,13 @@ multi on This document shows how to install the Linux binary distribution of Mathematica 2.2 on FreeBSD 2.1. - Mathematica supports Linux but not FreeBSD as it stands. So + Mathematica supports Linux but not FreeBSD as it stands. So once you have configured your system for Linux compatibility you have most of what you need to run Mathematica. For those who already have the student edition of Mathematica for DOS the cost of upgrading to the Linux version at the time this - was written, March 1996, was $45.00. It can be ordered directly + was written, March 1996, was $45.00. It can be ordered directly from Wolfram at (217) 398-6500 and paid for by credit card. @@ -670,8 +670,8 @@ multi on The binaries are currently distributed by Wolfram on CDROM. The CDROM has about a dozen tar files, each of which is a binary - distribution for one of the supported architectures. The one for - Linux is named LINUX.TAR. You can, for + distribution for one of the supported architectures. The one for + Linux is named LINUX.TAR. You can, for example, unpack this into /usr/local/Mathematica: @@ -703,14 +703,14 @@ richc.isdn.bcm.tmc.edu 9845-03452-90255 So, for example, the “machine ID” of richc is - 9845-03452-90255. You can ignore the message about the ioctl - that is not implemented. It will not prevent Mathematica from + 9845-03452-90255. You can ignore the message about the ioctl + that is not implemented. It will not prevent Mathematica from running in any way and you can safely ignore it, though you will see the message every time you run Mathematica. When you register with Wolfram, either by email, phone or fax, you will give them the “machine ID” and they will respond with a - corresponding password consisting of groups of numbers. You need + corresponding password consisting of groups of numbers. You need to add them both along with the machine name and license number in your mathpass file. @@ -722,21 +722,21 @@ richc.isdn.bcm.tmc.edu 9845-03452-90255 It will ask you to enter your license number - and the Wolfram supplied password. If you get them mixed up or + and the Wolfram supplied password. If you get them mixed up or for some reason the math.install fails, that is OK; you can simply edit the file mathpass in this same directory to correct the info manually. After getting past the password, math.install will ask you if you accept the install defaults provided, or if you want to use - your own. If you are like us and distrust all install programs, - you probably want to specify the actual directories. Beware. + your own. If you are like us and distrust all install programs, + you probably want to specify the actual directories. Beware. Although the math.install program asks you to specify directories, it will not create them for you, so you should perhaps have a second window open with another shell so that you can create them - before you give them to the install program. Or, if it fails, you + before you give them to the install program. Or, if it fails, you can create the directories and then restart the math.install - program. The directories we chose to create beforehand and + program. The directories we chose to create beforehand and specify to math.install were: @@ -762,23 +762,23 @@ richc.isdn.bcm.tmc.edu 9845-03452-90255 You can also tell it to use /tmp/math.record for the system record file, - where it puts logs of sessions. After this math.install will + where it puts logs of sessions. After this math.install will continue on to unpacking things and placing everything where it should go. The Mathematica Notebook feature is included separately, as - the X Front End, and you have to install it separately. To get the + the X Front End, and you have to install it separately. To get the X Front End stuff correctly installed, cd into the /usr/local/Mathematica/FrontEnd directory and - execute the xfe.install shell script. You will have to tell it + execute the xfe.install shell script. You will have to tell it where to put things, but you do not have to create any directories because it will use the same directories that had been created for - math.install. When it finishes, there should be a new shell script + math.install. When it finishes, there should be a new shell script in /usr/local/Mathematica/bin called mathematica. Lastly, you need to modify each of the shell scripts that - Mathematica has installed. At the beginning of every shell script + Mathematica has installed. At the beginning of every shell script in /usr/local/Mathematica/bin add the following line: @@ -798,7 +798,7 @@ richc.isdn.bcm.tmc.edu 9845-03452-90255 This tells Mathematica to use the linux version - of host.conf. This file has a different syntax from FreeBSD's + of host.conf. This file has a different syntax from FreeBSD's host.conf, so you will get an error message about /etc/host.conf if you leave this out. @@ -809,11 +809,11 @@ richc.isdn.bcm.tmc.edu 9845-03452-90255 /usr/local/Mathematica/bin to your path. - That is about all it takes. With this you should be able to + That is about all it takes. With this you should be able to type mathematica and get a really slick looking Mathematica - Notebook screen up. Mathematica has included the Motif user + Notebook screen up. Mathematica has included the Motif user interfaces, but it is compiled in statically, so you do not need - the Motif libraries. Good luck doing this yourself! + the Motif libraries. Good luck doing this yourself! diff --git a/en_US.ISO8859-1/books/handbook/mirrors/chapter.sgml b/en_US.ISO8859-1/books/handbook/mirrors/chapter.sgml index d47e578e4e..fc41eedd55 100644 --- a/en_US.ISO8859-1/books/handbook/mirrors/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/mirrors/chapter.sgml @@ -37,7 +37,7 @@ on static lists of hosts. Additionally, FreeBSD is available via anonymous FTP from the - following mirror sites. If you choose to obtain FreeBSD via + following mirror sites. If you choose to obtain FreeBSD via anonymous FTP, please try to use a site near you. Argentina, @@ -831,7 +831,7 @@ The latest versions of export-restricted code for FreeBSD (2.0C or later) (eBones and secure) are being made available at the - following locations. If you are outside the U.S. or Canada, please + following locations. If you are outside the U.S. or Canada, please get secure (DES) and eBones (Kerberos) from one of the following foreign distribution sites: @@ -902,7 +902,7 @@ CTM Sites CTM/FreeBSD is available via - anonymous FTP from the following mirror sites. If you choose to + anonymous FTP from the following mirror sites. If you choose to obtain CTM via anonymous FTP, please try to use a site near you. @@ -989,7 +989,7 @@ If you did not find a mirror near to you or the mirror is incomplete, try FTP search at http://ftpsearch.ntnu.no/ftpsearch. FTP search is a great free archie server in Trondheim, Norway. + URL="http://ftpsearch.ntnu.no/ftpsearch/">http://ftpsearch.ntnu.no/ftpsearch. FTP search is a great free archie server in Trondheim, Norway. @@ -1379,18 +1379,18 @@ The following CVSup site is especially designed for CTM users. Unlike the other CVSup mirrors, - it is kept up-to-date by CTM. That means if you CVSup cvs-all with release=cvs + linkend="ctm">CTM users. Unlike the other CVSup mirrors, + it is kept up-to-date by CTM. That means if you CVSup cvs-all with release=cvs from this site, you get a version of the repository (including the inevitable .ctm_status file) which is - suitable for being updated using the CTM cvs-cur deltas. This allows users who track + suitable for being updated using the CTM cvs-cur deltas. This allows users who track the entire cvs-all tree to go from CVSup to CTM without having to rebuild their repository from scratch using a fresh CTM base delta. This special feature only works for the cvs-all distribution with - cvs as the release tag. CVSupping any other + cvs as the release tag. CVSupping any other distribution and/or release will get you the specified distribution, but it will not be suitable for CTM updating. @@ -1398,8 +1398,8 @@ Because the current version of CTM does not preserve the timestamps of files, the timestamps at this mirror site are not - the same as those at other mirror sites. Switching between this - site and other sites is not recommended. It will work correctly, + the same as those at other mirror sites. Switching between this + site and other sites is not recommended. It will work correctly, but will be somewhat inefficient. diff --git a/en_US.ISO8859-1/books/handbook/pgpkeys/chapter.sgml b/en_US.ISO8859-1/books/handbook/pgpkeys/chapter.sgml index 4323cc68e1..e22fe1c300 100644 --- a/en_US.ISO8859-1/books/handbook/pgpkeys/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/pgpkeys/chapter.sgml @@ -2,7 +2,7 @@ PGP keys In case you need to verify a signature or send encrypted email to - one of the officers or core team members a number of keys are + one of the officers or core team members a number of keys are provided here for your convenience. diff --git a/en_US.ISO8859-1/books/handbook/policies/chapter.sgml b/en_US.ISO8859-1/books/handbook/policies/chapter.sgml index 500b2b1d46..6ea699c051 100644 --- a/en_US.ISO8859-1/books/handbook/policies/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/policies/chapter.sgml @@ -24,22 +24,22 @@ MAINTAINER= email-addresses The semantics of this are as follows: - The maintainer owns and is responsible for that code. This + The maintainer owns and is responsible for that code. This means that he is responsible for fixing bugs and answer problem reports pertaining to that piece of the code, and in the case of contributed software, for tracking new versions, as appropriate. Changes to directories which have a maintainer defined shall be - sent to the maintainer for review before being committed. Only if + sent to the maintainer for review before being committed. Only if the maintainer does not respond for an unacceptable period of time, to several emails, will it be acceptable to commit changes without - review by the maintainer. However, it is suggested that you try and + review by the maintainer. However, it is suggested that you try and have the changes reviewed by someone else if at all possible. It is of course not acceptable to add a person or group as - maintainer unless they agree to assume this duty. On the other hand + maintainer unless they agree to assume this duty. On the other hand it doesn't have to be a committer and it can easily be a group of people. @@ -48,44 +48,44 @@ MAINTAINER= email-addresses Contributed Software - Contributed by &a.phk; and &a.obrien;. + Contributed by &a.phk; and &a.obrien;. June 1996. Some parts of the FreeBSD distribution consist of software that - is actively being maintained outside the FreeBSD project. For + is actively being maintained outside the FreeBSD project. For historical reasons, we call this contributed - software. Some examples are perl, gcc and patch. + software. Some examples are perl, gcc and patch. Over the last couple of years, various methods have been used in dealing with this type of software and all have some number of - advantages and drawbacks. No clear winner has emerged. + advantages and drawbacks. No clear winner has emerged. Since this is the case, after some debate one of these methods has been selected as the “official” method and will be required for - future imports of software of this kind. Furthermore, it is + future imports of software of this kind. Furthermore, it is strongly suggested that existing contributed software converge on this model over time, as it has significant advantages over the old method, including the ability to easily obtain diffs relative to the “official” versions of the source by everyone (even without cvs - access). This will make it significantly easier to return changes + access). This will make it significantly easier to return changes to the primary developers of the contributed software. Ultimately, however, it comes down to the people actually doing - the work. If using this model is particularly unsuited to the + the work. If using this model is particularly unsuited to the package being dealt with, exceptions to these rules may be granted only with the approval of the core team and with the general - consensus of the other developers. The ability to maintain the + consensus of the other developers. The ability to maintain the package in the future will be a key issue in the decisions. Because of some unfortunate design limitations with the RCS file format and CVS's use of vendor branches, minor, trivial and/or cosmetic changes are strongly discouraged on - files that are still tracking the vendor branch. “Spelling + files that are still tracking the vendor branch. “Spelling fixes” are explicitly included here under the “cosmetic” category and are to be avoided for files with - revision 1.1.x.x. The repository bloat impact from a single character + revision 1.1.x.x. The repository bloat impact from a single character change can be rather dramatic. @@ -93,8 +93,8 @@ MAINTAINER= email-addresses language will be used as example of how this model works: src/contrib/tcl contains the source as - distributed by the maintainers of this package. Parts that are - entirely not applicable for FreeBSD can be removed. In the case of + distributed by the maintainers of this package. Parts that are + entirely not applicable for FreeBSD can be removed. In the case of Tcl, the mac, win and compat subdirectories were eliminated before the import @@ -111,23 +111,23 @@ MAINTAINER= email-addresses src/tools/tools/tcl_bmake contains a couple of shell-scripts that can be of help when the tcl software needs - updating. These are not part of the built or installed + updating. These are not part of the built or installed software. The important thing here is that the src/contrib/tcl directory is created according to the rules: It is supposed to contain the sources as distributed (on a proper CVS vendor-branch and without RCS keyword expansion) with as few FreeBSD-specific changes - as possible. The 'easy-import' tool on freefall will assist in + as possible. The 'easy-import' tool on freefall will assist in doing the import, but if there are any doubts on how to go about it, it is imperative that you ask first and not blunder ahead and hope - it “works out”. CVS is not forgiving of import accidents and a fair + it “works out”. CVS is not forgiving of import accidents and a fair amount of effort is required to back out major mistakes. Because of the previously mentioned design limitations with CVS's vendor branches, it is required that “official” patches from the vendor be applied to the original distributed sources and the result - re-imported onto the vendor branch again. Official patches should + re-imported onto the vendor branch again. Official patches should never be patched into the FreeBSD checked out version and "committed", as this destroys the vendor branch coherency and makes importing future versions rather difficult as there will be @@ -136,7 +136,7 @@ MAINTAINER= email-addresses Since many packages contain files that are meant for compatibility with other architectures and environments that FreeBSD, it is permissible to remove parts of the distribution tree - that are of no interest to FreeBSD in order to save space. Files + that are of no interest to FreeBSD in order to save space. Files containing copyright notices and release-note kind of information applicable to the remaining files shall not be removed. @@ -144,7 +144,7 @@ MAINTAINER= email-addresses If it seems easier, the bmake Makefiles can be produced from the dist tree automatically by some utility, something which would hopefully make it even easier to upgrade to a - new version. If this is done, be sure to check in such utilities + new version. If this is done, be sure to check in such utilities (as necessary) in the src/tools directory along with the port itself so that it is available to future maintainers. @@ -180,14 +180,14 @@ MAINTAINER= email-addresses However, please do not import FREEBSD-upgrade with the contributed source. Rather you should cvs add FREEBSD-upgrade ; cvs ci after the - initial import. Example wording from + initial import. Example wording from src/contrib/cpio is below: This directory contains virgin sources of the original distribution files -on a "vendor" branch. Do not, under any circumstances, attempt to upgrade -the files in this directory via patches and a cvs commit. New versions or -official-patch versions must be imported. Please remember to import with +on a "vendor" branch. Do not, under any circumstances, attempt to upgrade +the files in this directory via patches and a cvs commit. New versions or +official-patch versions must be imported. Please remember to import with "-ko" to prevent CVS from corrupting any vendor RCS Ids. For the import of GNU cpio 2.4.2, the following files were removed: @@ -233,7 +233,7 @@ obrien@freebsd.org - 30 March 1997 If you are adding shared library support to a port or other piece of software that doesn't have one, the version numbers should - follow these rules. Generally, the resulting numbers will have + follow these rules. Generally, the resulting numbers will have nothing to do with the release version of the software. The three principles of shared library building are: @@ -260,14 +260,14 @@ obrien@freebsd.org - 30 March 1997 For instance, added functions and bugfixes result in the minor version number being bumped, while deleted functions, changed - function call syntax etc. will force the major version number to + function call syntax etc. will force the major version number to change. - Stick to version numbers of the form major.minor (x.y). Our + Stick to version numbers of the form major.minor (x.y). Our dynamic linker does not handle version numbers of the form x.y.z - well. Any version number after the y (ie. the third digit) is + well. Any version number after the y (ie. the third digit) is totally ignored when comparing shared lib version numbers to decide - which library to link with. Given two shared libraries that differ + which library to link with. Given two shared libraries that differ only in the “micro” revision, ld.so will link with the higher one. Ie: if you link with libfoo.so.3.3.3, the linker only records 3.3 in the headers, and will link with anything @@ -276,14 +276,14 @@ obrien@freebsd.org - 30 March 1997 ld.so will always use the highest - “minor” revision. Ie: it will use libc.so.2.2 + “minor” revision. Ie: it will use libc.so.2.2 in preference to libc.so.2.0, even if the program was initially linked with libc.so.2.0. For non-port libraries, it is also our policy to change the - shared library version number only once between releases. When you + shared library version number only once between releases. When you make a change to a system library that requires the version number to be bumped, check the Makefile's commit logs. It is the responsibility of the committer to ensure that the first diff --git a/en_US.ISO8859-1/books/handbook/ports/chapter.sgml b/en_US.ISO8859-1/books/handbook/ports/chapter.sgml index 35e532e05b..0eb95aa909 100644 --- a/en_US.ISO8859-1/books/handbook/ports/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/ports/chapter.sgml @@ -8,16 +8,16 @@ For all the hype about open standards, getting a program to work on different versions of Unix in the real world can be a tedious and - tricky business, as anyone who has tried it will know. You may be + tricky business, as anyone who has tried it will know. You may be lucky enough to find that the program you want will compile cleanly on your system, install itself in all the right places and run flawlessly - “out of the box”, but this is unfortunately rather rare. With most + “out of the box”, but this is unfortunately rather rare. With most programs, you will find yourself doing a fair bit of head-scratching, and there are quite a few programs that will result in premature greying, or even chronic alopecia... Some software distributions have attacked this problem by - providing configuration scripts. Some of these are very clever, but + providing configuration scripts. Some of these are very clever, but they have an unfortunate tendency to triumphantly announce that your system is something you have never heard of and then ask you lots of questions that sound like a final exam in system-level Unix @@ -102,7 +102,7 @@ FreeBSD ports still use the tarball mechanism, but use a skeleton to hold the "knowledge" of how to get the program working on FreeBSD, - rather than expecting the user to be able to work it out. They also + rather than expecting the user to be able to work it out. They also supply their own customised Makefile, so that almost every port can be built in the same way. @@ -110,14 +110,14 @@ If you look at a port skeleton (either on your FreeBSD system or the FTP site) and expect to find all sorts of pointy-headed rocket science lurking there, you may be disappointed by the one or two rather unexciting-looking files and directories you find there. (We will discuss in a minute how to go about the FTP site) and expect to find all sorts of pointy-headed rocket science lurking there, you may be disappointed by the one or two rather unexciting-looking files and directories you find there. (We will discuss in a minute how to go about Getting a port). - “How on earth can this do anything?” I hear you cry. “There + “How on earth can this do anything?” I hear you cry. “There is no source code there!” Fear not, gentle reader, all will become clear (hopefully). - Let's see what happens if we try and install a port. I have chosen + Let's see what happens if we try and install a port. I have chosen ElectricFence, a useful tool for developers, as the skeleton is more straightforward than most. @@ -160,7 +160,7 @@ install -c -o bin -g bin -m 444 /usr/ports/devel/ElectricFence/work/ElectricFenc The make program has noticed that you did not have a local copy of the source code and tried to FTP it down so it could get the - job done. I already had the source handy in my example, so it did + job done. I already had the source handy in my example, so it did not need to fetch it. Let's go through this and see what the make program was @@ -203,13 +203,13 @@ install -c -o bin -g bin -m 444 /usr/ports/devel/ElectricFence/work/ElectricFenc Install the program executable and other supporting files, man pages, etc. under the /usr/local hierarchy, where they will not - get mixed up with system programs. This also makes sure that + get mixed up with system programs. This also makes sure that all the ports you install will go in the same place, instead of being flung all over your system. - Register the installation in a database. This means that, + Register the installation in a database. This means that, if you do not like the program, you can cleanly remove all traces of it from your system. @@ -219,7 +219,7 @@ install -c -o bin -g bin -m 444 /usr/ports/devel/ElectricFence/work/ElectricFenc Scroll up to the make output and see if you can match these - steps to it. And if you were not impressed before, you should be by + steps to it. And if you were not impressed before, you should be by now! @@ -228,7 +228,7 @@ install -c -o bin -g bin -m 444 /usr/ports/devel/ElectricFence/work/ElectricFenc Getting a FreeBSD Port There are two ways of getting hold of the FreeBSD port for a - program. One requires a FreeBSD + program. One requires a FreeBSD CDROM, the other involves using an Internet Connection. @@ -253,17 +253,17 @@ DISTDIR= /tmp/distfiles WRKDIRPREFIX= /tmp Substitute /tmp for any place you have enough - free space. Then, just cd to the appropriate + free space. Then, just cd to the appropriate subdirectory under /cdrom/ports and type make install as - usual. WRKDIRPREFIX will cause the port to be + usual. WRKDIRPREFIX will cause the port to be build under /tmp/cdrom/ports; for instance, games/oneko will be built under /tmp/cdrom/ports/games/oneko. There are some ports for which we cannot provide the - original source in the CDROM due to licensing limitations. In + original source in the CDROM due to licensing limitations. In that case, you will need to look at the section on Compiling ports using an Internet connection. @@ -275,22 +275,22 @@ WRKDIRPREFIX= /tmp If you do not have a CDROM, or you want to make sure you get the very latest version of the port you want, you will need to download the - skeleton for the port. Now + skeleton for the port. Now this might sound like rather a fiddly job full of pitfalls, but it is actually very easy. First, if you are running a release version of FreeBSD, make sure you get the appropriate “upgradekiet” for your replease from the ports - web page. These packages include files that have been + web page. These packages include files that have been updated since the release that you may need to compile new ports. The key to the skeletons is that the FreeBSD FTP server can create on-the-fly - tarballs for you. Here is + tarballs for you. Here is how it works, with the gnats program in the databases directory as - an example (the bits in square brackets are comments. Do not type + an example (the bits in square brackets are comments. Do not type them in if you are trying this yourself!):- @@ -312,19 +312,19 @@ password. Remember to use binary (also known as image) mode!] What happened here? We connected to the FTP server in the - usual way and went to its databases sub-directory. When we gave it + usual way and went to its databases sub-directory. When we gave it the command get gnats.tar, the FTP server tarred up the gnats directory for us. We then extracted the gnats skeleton and went into the gnats - directory to build the port. As we explained earlier, the make process noticed we did not have a copy of the source locally, so it fetched one before extracting, patching and building it. - Let's try something more ambitious now. Instead of getting a + Let's try something more ambitious now. Instead of getting a single port skeleton, let's get a whole sub-directory, for example - all the database skeletons in the ports collection. It looks + all the database skeletons in the ports collection. It looks almost the same:- @@ -347,7 +347,7 @@ password. Remember to use binary (also known as image) mode!] set of database programs on our FreeBSD machine! All we did that was different from getting a single port skeleton and building it was that we got a whole directory at once, and compiled everything - in it at once. Pretty impressive, no? + in it at once. Pretty impressive, no? If you expect to be installing many ports, it is probably worth downloading all the ports directories. @@ -369,7 +369,7 @@ password. Remember to use binary (also known as image) mode!] The most important component of a skeleton is the Makefile. This contains various statements that specify how the port should - be compiled and installed. Here is the Makefile for + be compiled and installed. Here is the Makefile for ElectricFence:- @@ -404,8 +404,8 @@ do-install: linkend="ports-tarball">tarball, but without the extension. - CATEGORIES states what kind of program this is. In - this case, a utility for developers. See the CATEGORIES states what kind of program this is. In + this case, a utility for developers. See the categories section of this handbook for a complete list. @@ -423,7 +423,7 @@ do-install: Skipping over the next few lines for a minute, the line .include <bsd.port.mk> says that the other statements and commands needed for this port are - in a standard file called bsd.port.mk. As + in a standard file called bsd.port.mk. As these are the same for all ports, there is no point in duplicating them all over the place, so they are kept in a single standard file. @@ -432,7 +432,7 @@ do-install: examination of how Makefiles work; suffice it to say that the line starting with MAN3 ensures that the ElectricFence man page is compressed after installation, to help conserve your precious disk - space. The original port did not provide an install target, + space. The original port did not provide an install target, so the three lines from do-install ensure that the files produced by this port are placed in the correct destination. @@ -444,7 +444,7 @@ do-install: The file containing the checksum for the port is called md5, after the MD5 algorithm used for ports - checksums. It lives in a directory with the slightly confusing + checksums. It lives in a directory with the slightly confusing name of files. This directory can also contain other miscellaneous files that @@ -491,31 +491,31 @@ do-install: What to do when a port does not work. - Oh. You can do one of four (4) things : + Oh. You can do one of four (4) things : - Fix it yourself. Technical details on how ports work can + Fix it yourself. Technical details on how ports work can be found in Porting applications. - Gripe. This is done by e-mail only! Send such e-mail to + Gripe. This is done by e-mail only! Send such e-mail to the &a.ports; and please include the name/version of the port, where you got both the port source & distfile(s) from, and what the text of the error was. - Forget it. This is the easiest for most — very few of the + Forget it. This is the easiest for most — very few of the programs in ports can be classified as essential! - Grab the pre-compiled package from a ftp server. The + Grab the pre-compiled package from a ftp server. The “master” package collection is on FreeBSD's FTP server in the packages @@ -538,29 +538,29 @@ do-install: - Q. I thought this was going to be a discussion about + Q. I thought this was going to be a discussion about modems??! - A. Ah. You must be thinking of the serial ports on the - back of your computer. We are using “port” here to mean the + A. Ah. You must be thinking of the serial ports on the + back of your computer. We are using “port” here to mean the result of “porting” a program from one version of Unix to - another. (It is an unfortunate bad habit of computer people to + another. (It is an unfortunate bad habit of computer people to use the same word to refer to several completely different things). - Q. I thought you were supposed to use packages to install + Q. I thought you were supposed to use packages to install extra programs? - A. Yes, that is usually the quickest and easiest way of + A. Yes, that is usually the quickest and easiest way of doing it. - Q. So why bother with ports then? + Q. So why bother with ports then? - A. Several reasons:- + A. Several reasons:- @@ -572,7 +572,7 @@ do-install: - Some people do not trust binary distributions. At + Some people do not trust binary distributions. At least with source code you can (in theory) read through it and look for potential problems yourself. @@ -607,21 +607,21 @@ do-install: - Q. What is a patch? + Q. What is a patch? - A. A patch is a small (usually) file that specifies how to - go from one version of a file to another. It contains text + A. A patch is a small (usually) file that specifies how to + go from one version of a file to another. It contains text that says, in effect, things like “delete line 23”, “add these two lines after line 468” or “change line 197 to - this”. Also known as a “diff”, since it is generated by a + this”. Also known as a “diff”, since it is generated by a program of that name. - Q. What is all this about + Q. What is all this about tarballs? - A. It is a file ending in .tar or + A. It is a file ending in .tar or .tar.gz (with variations like .tar.Z, or even .tgz if you are trying to squeeze the names into a DOS @@ -629,7 +629,7 @@ do-install: Basically, it is a directory tree that has been archived into a single file (.tar) and optionally - compressed (.gz). This technique was + compressed (.gz). This technique was originally used for Tape ARchives (hence the name tar), but it is a widely used way of distributing program source code around @@ -649,19 +649,19 @@ do-install: - Q. And a checksum? + Q. And a checksum? - A. It is a number generated by adding up all the data in - the file you want to check. If any of the characters change, + A. It is a number generated by adding up all the data in + the file you want to check. If any of the characters change, the checksum will no longer be equal to the total, so a simple - comparison will allow you to spot the difference. (In + comparison will allow you to spot the difference. (In practice, it is done in a more complicated way to spot problems like position-swapping, which will not show up with a simplistic addition). - Q. I did what you said for compiling ports from a CDROM and it worked great + Q. I did what you said for compiling ports from a CDROM and it worked great until I tried to install the kermit port:- @@ -671,25 +671,25 @@ do-install: Why can it not be found? Have I got a dud CDROM? - A. The licensing terms for kermit do not allow us to put + A. The licensing terms for kermit do not allow us to put the tarball for it on the CDROM, so you will have to fetch it by hand — sorry! The reason why you got all those error messages was because you were not connected to the Internet at - the time. Once you have downloaded it from any of the sites + the time. Once you have downloaded it from any of the sites above, you can re-start the process (try and choose the nearest site to you, though, to save your time and the Internet's bandwidth). - Q. I did that, but when I tried to put it into + Q. I did that, but when I tried to put it into /usr/ports/distfiles I got some error about not having permission. - A. The ports mechanism looks for the tarball in + A. The ports mechanism looks for the tarball in /usr/ports/distfiles, but you will not be able to copy anything there because it is sym-linked to the - CDROM, which is read-only. You can tell it to look somewhere + CDROM, which is read-only. You can tell it to look somewhere else by doing @@ -698,14 +698,14 @@ do-install: - Q. Does the ports scheme only work if you have everything + Q. Does the ports scheme only work if you have everything in /usr/ports? My system administrator says I must put everything under /u/people/guests/wurzburger, but it does not seem to work. - A. You can use the PORTSDIR and PREFIX variables to tell - the ports mechanism to use different directories. For + A. You can use the PORTSDIR and PREFIX variables to tell + the ports mechanism to use different directories. For instance, @@ -739,12 +739,12 @@ do-install: - Q. I do not have a FreeBSD CDROM, but I would like to have + Q. I do not have a FreeBSD CDROM, but I would like to have all the tarballs handy on my system so I do not have to wait - for a download every time I install a port. Is there an easy + for a download every time I install a port. Is there an easy way to get them all at once? - A. To get every single tarball for the ports collection, + A. To get every single tarball for the ports collection, do @@ -765,12 +765,12 @@ do-install: - Q. I know it is probably faster to fetch the tarballs from - one of the FreeBSD mirror sites close by. Is there any way to + Q. I know it is probably faster to fetch the tarballs from + one of the FreeBSD mirror sites close by. Is there any way to tell the port to fetch them from servers other than ones listed in the MASTER_SITES? - A. Yes. If you know, for example, ftp.FreeBSD.ORG is much + A. Yes. If you know, for example, ftp.FreeBSD.ORG is much closer than sites listed in MASTER_SITES, do as following example. @@ -781,43 +781,43 @@ do-install: - Q. I want to know what files make is going to need before + Q. I want to know what files make is going to need before it tries to pull them down. - A. make fetch-list will display a list of the files + A. make fetch-list will display a list of the files needed for a port. - Q. Is there any way to stop the port from compiling? I + Q. Is there any way to stop the port from compiling? I want to do some hacking on the source before I install it, but it is a bit tiresome having to watch it and hit control-C every time. - A. Doing make extract will stop it after it has fetched + A. Doing make extract will stop it after it has fetched and extracted the source code. - Q. I am trying to make my own port and I want to be able + Q. I am trying to make my own port and I want to be able to stop it compiling until I have had a chance to see if my - patches worked properly. Is there something like make + patches worked properly. Is there something like make extract, but for patches? - A. Yep, make patch is what you want. You will probably - find the PATCH_DEBUG option useful as well. And by the way, + A. Yep, make patch is what you want. You will probably + find the PATCH_DEBUG option useful as well. And by the way, thank you for your efforts! - Q. I have heard that some compiler options can cause bugs. + Q. I have heard that some compiler options can cause bugs. Is this true? How can I make sure that I compile ports with the right settings? - A. Yes, with version 2.6.3 of gcc (the version shipped + A. Yes, with version 2.6.3 of gcc (the version shipped with FreeBSD 2.1.0 and 2.1.5), the option could result in buggy code unless you used the option as - well. (Most of the ports don't use ). You + well. (Most of the ports don't use ). You should be able to specify the compiler options used by something like @@ -826,7 +826,7 @@ do-install: or by editing /etc/make.conf, but - unfortunately not all ports respect this. The surest way is to + unfortunately not all ports respect this. The surest way is to do make configure, then go into the source directory and inspect the Makefiles by hand, but this can get tedious if the source has lots of sub-directories, each with their own @@ -834,12 +834,12 @@ do-install: - Q. There are so many ports it is hard to find the one I - want. Is there a list anywhere of what ports are available? + Q. There are so many ports it is hard to find the one I + want. Is there a list anywhere of what ports are available? - A. Look in the INDEX file in - /usr/ports. If you would like to search the - ports collection for a keyword, you can do that too. For example, + A. Look in the INDEX file in + /usr/ports. If you would like to search the + ports collection for a keyword, you can do that too. For example, you can find ports relevant to the LISP programming language using: @@ -850,25 +850,25 @@ do-install: - Q. I went to install the foo port but the system + Q. I went to install the foo port but the system suddenly stopped compiling it and starting compiling the bar - port. What's going on? + port. What's going on? - A. The foo port needs something that is supplied with + A. The foo port needs something that is supplied with bar — for instance, if foo uses graphics, bar might have - a library with useful graphics processing routines. Or bar + a library with useful graphics processing routines. Or bar might be a tool that is needed to compile the foo port. - Q. I installed the grizzle + Q. I installed the grizzle program from the ports and frankly it is a complete waste of - disk space. I want to delete it but I do not know where it put - all the files. Any clues? + disk space. I want to delete it but I do not know where it put + all the files. Any clues? - A. No problem, just do + A. No problem, just do &prompt.root; pkg_delete grizzle-6.5 @@ -877,11 +877,11 @@ do-install: - Q. Hang on a minute, you have to know the version number to - use that command. You do not seriously expect me to remember + Q. Hang on a minute, you have to know the version number to + use that command. You do not seriously expect me to remember that, do you?? - A. Not at all, you can find it out by doing + A. Not at all, you can find it out by doing &prompt.root; pkg_info -a | grep grizzle @@ -891,13 +891,13 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. Talking of disk space, the ports directory seems to be - taking up an awful lot of room. Is it safe to go in there and + Q. Talking of disk space, the ports directory seems to be + taking up an awful lot of room. Is it safe to go in there and delete things? - A. Yes, if you have installed the program and are fairly + A. Yes, if you have installed the program and are fairly certain you will not need the source again, there is no point - in keeping it hanging around. The best way to do this + in keeping it hanging around. The best way to do this is @@ -910,19 +910,19 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. I tried that and it still left all those tarballs or + Q. I tried that and it still left all those tarballs or whatever you called them in the distfiles - directory. Can I delete those as well? + directory. Can I delete those as well? - A. Yes, if you are sure you have finished with them, those + A. Yes, if you are sure you have finished with them, those can go as well. - Q. I like having lots and lots of programs to play with. + Q. I like having lots and lots of programs to play with. Is there any way of installing all the ports in one go? - A. Just do + A. Just do &prompt.root; cd /usr/ports @@ -931,22 +931,22 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. OK, I tried that, but I thought it would take a very - long time so I went to bed and left it to get on with it. When + Q. OK, I tried that, but I thought it would take a very + long time so I went to bed and left it to get on with it. When I looked at the computer this morning, it had only done three - and a half ports. Did something go wrong? + and a half ports. Did something go wrong? - A. No, the problem is that some of the ports need to ask + A. No, the problem is that some of the ports need to ask you questions that we cannot answer for you (eg “Do you want to print on A4 or US letter sized paper?”) and they need to have someone on hand to answer them. - Q. I really do not want to spend all day staring at the - monitor. Any better ideas? + Q. I really do not want to spend all day staring at the + monitor. Any better ideas? - A. OK, do this before you go to bed/work/the local + A. OK, do this before you go to bed/work/the local park:- @@ -955,7 +955,7 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc This will install every port that does - not require user input. Then, when you + not require user input. Then, when you come back, do @@ -967,12 +967,12 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. At work, we are using frobble, which is in your ports + Q. At work, we are using frobble, which is in your ports collection, but we have altered it quite a bit to get it to do - what we need. Is there any way of making our own packages, so + what we need. Is there any way of making our own packages, so we can distribute it more easily around our sites? - A. No problem, assuming you know how to make patches for + A. No problem, assuming you know how to make patches for your changes:- @@ -986,10 +986,10 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. This ports stuff is really clever. I am desperate to - find out how you did it. What is the secret? + Q. This ports stuff is really clever. I am desperate to + find out how you did it. What is the secret? - A. Nothing secret about it at all, just look at the + A. Nothing secret about it at all, just look at the bsd.ports.mk and bsd.ports.subdir.mk files in your makefiles @@ -1011,27 +1011,27 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc Making a port yourself Contributed by &a.jkh;, &a.gpalmer;, &a.asami; - &a.obrien; and &a.hoek;. 28 August 1996. + &a.obrien; and &a.hoek;. 28 August 1996. So, now you are interested in making your own port? Great! What follows are some guidelines for creating a new port for - FreeBSD. The bulk of the work is done by + FreeBSD. The bulk of the work is done by /usr/share/mk/bsd.port.mk, which all port - Makefiles include. Please refer to that file for more details on - the inner workings of the ports collection. Even if you don't + Makefiles include. Please refer to that file for more details on + the inner workings of the ports collection. Even if you don't hack Makefiles daily, it is well commented, and you will still gain much knowledge from it. Only a fraction of the overridable variables (VAR) are mentioned - in this document. Most (if not all) are documented at the start of - bsd.port.mk. This file users a non-standard - tab setting. Emacs and + in this document. Most (if not all) are documented at the start of + bsd.port.mk. This file users a non-standard + tab setting. Emacs and Vim should recognise the setting on - loading the file. vi or ex + loading the file. vi or ex can be set to use the correct value by typing :set tabstop=4 once the file has been loaded. @@ -1039,7 +1039,7 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc Quick Porting - This section tells you how to do a quick port. In many + This section tells you how to do a quick port. In many cases, it is not enough, but we will see. First, get the original tarball and put it into DISTDIR, which defaults to @@ -1048,7 +1048,7 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc The following assumes that the software compiled out-of-the-box, i.e., there was absolutely no change required - for the port to work on your FreeBSD box. If you needed to + for the port to work on your FreeBSD box. If you needed to change something, you will have to refer to the next section too. @@ -1080,10 +1080,10 @@ USE_IMAKE= yes .include <bsd.port.mk> - See if you can figure it out. Do not worry about the + See if you can figure it out. Do not worry about the contents of the $Id$ line, it will be filled in automatically by CVS when the port - is imported to our main ports tree. You can find a more + is imported to our main ports tree. You can find a more detailed example in the sample Makefile section. @@ -1106,7 +1106,7 @@ USE_IMAKE= yes This is the one-line description of the port. Please do not include the package name (or version - number of the software) in the comment. Here is + number of the software) in the comment. Here is an example: @@ -1117,7 +1117,7 @@ A cat chasing a mouse all over the screen. <filename>DESCR</filename> - This is a longer description of the port. One to a few + This is a longer description of the port. One to a few paragraphs concisely explaining what the port does is sufficient. @@ -1127,7 +1127,7 @@ A cat chasing a mouse all over the screen. Please be careful if you are copying from the README or manpage; too often they are not a concise description of the port or are in an - awkward format (e.g., manpages have justified spacing). If the + awkward format (e.g., manpages have justified spacing). If the ported software has an official WWW homepage, you should list it here. @@ -1151,12 +1151,12 @@ asami@cs.berkeley.edu <filename>PLIST</filename> - This file lists all the files installed by the port. It + This file lists all the files installed by the port. It is also called the “packing list” because the package is - generated by packing the files listed here. The pathnames + generated by packing the files listed here. The pathnames are relative to the installation prefix (usually /usr/local or - /usr/X11R6). If you are using the + /usr/X11R6). If you are using the MANn variables (as you should be), do not list any manpages here. @@ -1175,13 +1175,13 @@ lib/X11/oneko/mouse.xpm You should list all the files, but not the name - directories, in the list. Also, if the port creates + directories, in the list. Also, if the port creates directories for itself during installtion, make sure to add @dirrm lines as necessary to remove them when the port is deleted. It is recommended that you keep all the filenames in - this file sorted alphabetically. It will make verifying the + this file sorted alphabetically. It will make verifying the changes when you upgrade the port much easier. @@ -1200,7 +1200,7 @@ lib/X11/oneko/mouse.xpm Testing the port You should make sure that the port rules do exactly what - you want it to do, including packaging up the port. These are + you want it to do, including packaging up the port. These are the important points you need to verify. @@ -1260,7 +1260,7 @@ lib/X11/oneko/mouse.xpm Make sure that there aren't any warnings issued in any of the package and deinstall stages, After step 3, check - to see if all the new directories are correctly deleted. Also, + to see if all the new directories are correctly deleted. Also, try using the software after step 4, to ensure that is works correctly when installed from a package. @@ -1269,8 +1269,8 @@ lib/X11/oneko/mouse.xpm Checking your port with <command>portlint</command> Please use portlint to see if your port - conforms to our guidelines. The portlint - program is part of the ports collection. In particular, your may + conforms to our guidelines. The portlint + program is part of the ports collection. In particular, your may want to check if the Makefile is in the right shape and the package is @@ -1285,10 +1285,10 @@ lib/X11/oneko/mouse.xpm Now that you are happy with your port, the only thing remaining is to put it in the main FreeBSD ports tree and make - everybody else happy about it too. We do not need your + everybody else happy about it too. We do not need your work directory or the pkgname.tgz package, so delete them - now. Next, simply include the output of shar `find + now. Next, simply include the output of shar `find port_dir` in a bug report and send it with the send-pr @@ -1298,15 +1298,15 @@ lib/X11/oneko/mouse.xpm about send-pr 1 - . If the uncompressed port is larger than + . If the uncompressed port is larger than 20KB, you should compress it into a tarfile and use uuencode 1 before including it in the bug report (uuencoded tarfiles are acceptable even if the bug report is smaller than - 20KB but are not preferred). Be sure to classify the bug report as + 20KB but are not preferred). Be sure to classify the bug report as category ports and class - change-request. (Do not mark the report + change-request. (Do not mark the report confidential!) One more time, do not include the original source @@ -1317,7 +1317,7 @@ lib/X11/oneko/mouse.xpm In the past, we asked you to upload new port submissions in our ftp site (ftp.freebsd.org). This is no longer + role="fqdn">ftp.freebsd.org). This is no longer recommended as read access is turned off on that incoming/ directory of that site due to the large amount of pirated software showing up there. @@ -1325,7 +1325,7 @@ lib/X11/oneko/mouse.xpm We will look at your port, get back to you if necessary, and put it in the - tree. Your name will also appear in the list of “Additional + tree. Your name will also appear in the list of “Additional FreeBSD contributors” on the FreeBSD Handbook and other files. Isn't that great?!? :) @@ -1336,7 +1336,7 @@ lib/X11/oneko/mouse.xpm Slow Porting Ok, so it was not that simple, and the port required some - modifications to get it to work. In this section, we will + modifications to get it to work. In this section, we will explain, step by step, how to modify it to get it to work with the ports paradigm. @@ -1352,39 +1352,39 @@ lib/X11/oneko/mouse.xpm But do not worry if you do not really understand what bsd.port.mk is doing, not many people - do... :> + do... :> - The fetch target is run. The fetch target is + The fetch target is run. The fetch target is responsible for making sure that the tarball exists locally in DISTDIR. If fetch cannot find the required files in DISTDIR it will look up the URL MASTER_SITES, which is set in the Makefile, as well as our main ftp site at ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/, where we put sanctioned distfiles as backup. It will then attempt to fetch the named distribution file with FETCH, assuming that the requesting site has direct access to the Internet. If that succeeds, it will save the file in DISTDIR for future use and proceed. + URL="ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/">ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/, where we put sanctioned distfiles as backup. It will then attempt to fetch the named distribution file with FETCH, assuming that the requesting site has direct access to the Internet. If that succeeds, it will save the file in DISTDIR for future use and proceed. - The extract target is run. It looks for your port's + The extract target is run. It looks for your port's distribution file (typically a gzip'd tarball) in DISTDIR and unpacks it into a temporary subdirectory specified by WRKDIR (defaults to work). - The patch target is run. First, any patches defined + The patch target is run. First, any patches defined in PATCHFILES are - applied. Second, if any patches are found in PATCHDIR (defaults to the + applied. Second, if any patches are found in PATCHDIR (defaults to the patches subdirectory), they are applied at this time in alphabetical order. - The configure target is run. This can do any one of + The configure target is run. This can do any one of many different things. @@ -1414,10 +1414,10 @@ lib/X11/oneko/mouse.xpm - The build target is run. This is responsible for + The build target is run. This is responsible for descending into the port's private working directory (WRKSRC) and - building it. If USE_GMAKE is set, GNU + building it. If USE_GMAKE is set, GNU make will be used, otherwise the system make will be used. @@ -1426,7 +1426,7 @@ lib/X11/oneko/mouse.xpm - The above are the default actions. In addition, you can + The above are the default actions. In addition, you can define targets pre-something or post-something, or put scripts with those names, in the scripts subdirectory, and they will be run before or after the default @@ -1438,14 +1438,14 @@ lib/X11/oneko/mouse.xpm post-extract target will be called after the regular extraction actions, and the pre-build script will be executed before - the default build rules are done. It is recommended that you + the default build rules are done. It is recommended that you use Makefile targets if the actions are simple enough, because it will be easier for someone to figure out what kind of non-default action the port requires. The default actions are done by the - bsd.port.mk targets do-something. For example, the - commands to extract a port are in the target do-extract. If you are not happy with + bsd.port.mk targets do-something. For example, the + commands to extract a port are in the target do-extract. If you are not happy with the default target, you can fix it by redefining the do-something target in your Makefile. @@ -1454,7 +1454,7 @@ lib/X11/oneko/mouse.xpm The “main” targets (e.g., extract, configure, etc.) do nothing more than make sure all the stages up to that one are completed and call the real targets or scripts, and they are not intended - to be changed. If you want to fix the extraction, fix + to be changed. If you want to fix the extraction, fix do-extract, but never ever touch extract! @@ -1471,7 +1471,7 @@ lib/X11/oneko/mouse.xpm Get the original sources (normally) as a compressed tarball (foo.tar.gz or foo.tar.Z) and copy it into - DISTDIR. Always use + DISTDIR. Always use mainstream sources when and where you can. @@ -1479,7 +1479,7 @@ lib/X11/oneko/mouse.xpm to the net, or can only find sites that have irritatingly non-standard formats, you might want to put a copy on a reliable ftp or http server that you control (e.g., your home - page). Make sure you set MASTER_SITES to + page). Make sure you set MASTER_SITES to reflect your choice. If you @@ -1488,23 +1488,23 @@ lib/X11/oneko/mouse.xpm public_html/ directory on freefall), we can “house” it ourselves by putting - it on ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/LOCAL_PORTS/ as the last resort. Please refer to this - location as MASTER_SITE_LOCAL. Send mail to + it on ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/LOCAL_PORTS/ as the last resort. Please refer to this + location as MASTER_SITE_LOCAL. Send mail to the &a.ports;if you are not sure what to do. If your port's distfile changes all the time for no good reason, consider putting the distfile in your home page and - listing it as the first MASTER_SITES. This + listing it as the first MASTER_SITES. This will prevent users from getting checksum mismatch errors, and also reduce the workload of - maintainers of our ftp site. Also, if there isonly one master + maintainers of our ftp site. Also, if there isonly one master site for the port, it is recommended that you house a backup at your site and list it as the second MASTER_SITES. If your port requires some additional `patches' that are available on the Internet, fetch them too and put them in - DISTDIR. Do not worry if + DISTDIR. Do not worry if they come from a site other than where you got the main source tarball, we have a way to handle these situations (see the description of Unpack a copy of the tarball in a private directory and make whatever changes are necessary to get the port to compile - properly under the current version of FreeBSD. Keep + properly under the current version of FreeBSD. Keep careful track of everything you do, as - you will be automating the process shortly. Everything, + you will be automating the process shortly. Everything, including the deletion, addition or modification of files should be doable using an automated script or patch file when your port is finished. @@ -1527,7 +1527,7 @@ lib/X11/oneko/mouse.xpm If your port requires significant user interaction/customization to compile or install, you should take a look at one of Larry Wall's classic Configure scripts - and perhaps do something similar yourself. The goal of the + and perhaps do something similar yourself. The goal of the new ports collection is to make each port as “plug-and-play” as possible for the end-user while using a minimum of disk space. @@ -1545,18 +1545,18 @@ lib/X11/oneko/mouse.xpm In the preparation of the port, files that have been added or changed can be picked up with a recursive diff for later - feeding to patch. Each set of patches you wish to apply + feeding to patch. Each set of patches you wish to apply should be collected into a file named patch-xx where xx denotes the sequence in which the patches will be applied — these are done in alphabetical order, thus - aa first, ab second and so on. These files + aa first, ab second and so on. These files should be stored in PATCHDIR, from where they will be - automatically applied. All patches should be relative to + automatically applied. All patches should be relative to WRKSRC (generally the directory your port's tarball unpacks itself into, that being - where the build is done). To make fixes and upgrades easier, + where the build is done). To make fixes and upgrades easier, you should avoid having more than one patch fix the same file (e.g., patch-aa and patch-ab both changing WRKSRC/foobar.c). @@ -1567,7 +1567,7 @@ lib/X11/oneko/mouse.xpm Include any additional customization commands to your configure script and save it in the - scripts subdirectory. As mentioned + scripts subdirectory. As mentioned above, you can also do this as Makefile targets and/or scripts with the name pre-configure or @@ -1580,7 +1580,7 @@ lib/X11/oneko/mouse.xpm If your port requires user input to build, configure or install, then set IS_INTERACTIVE in your - Makefile. This will allow “overnight builds” to skip your port + Makefile. This will allow “overnight builds” to skip your port if the user sets the variable BATCH in his environment (and if the user sets the variable INTERACTIVE, then only @@ -1589,7 +1589,7 @@ lib/X11/oneko/mouse.xpm It is also recommended that if there are reasonable default answers to the questions, you check the PACKAGE_BUILDING variable and turn off the - interactive script when it is set. This will allow us to build + interactive script when it is set. This will allow us to build the packages for CD-ROMs and ftp. @@ -1612,9 +1612,9 @@ lib/X11/oneko/mouse.xpm The original source Does it live in DISTDIR as a standard gzip'd - tarball? If so, you can go on to the next step. If not, you + tarball? If so, you can go on to the next step. If not, you should look at overriding any of the EXTRACT_CMD, EXTRACT_BEFORE_ARGS, EXTRACT_AFTER_ARGS, EXTRACT_SUFX, or DISTFILES variables, depending on - how alien a format your port's distribution file is. (The + how alien a format your port's distribution file is. (The most common case is EXTRACT_SUFX=.tar.Z, when the tarball is condensed by regular compress, not gzip.) @@ -1630,7 +1630,7 @@ lib/X11/oneko/mouse.xpm <makevar>DISTNAME</makevar> You should set DISTNAME to be the base name of - your port. The default rules expect the distribution file + your port. The default rules expect the distribution file list (DISTFILES) to be named DISTNAMEEXTRACT_SUFX which, if it is a normal tarball, is going to be something like foozolix-1.0.tar.gz for a setting of DISTNAME=foozolix-1.0. @@ -1640,8 +1640,8 @@ lib/X11/oneko/mouse.xpm work/DISTNAME, e.g. work/foozolix-1.0/. All this behavior can be overridden, of course; it simply - represents the most common time-saving defaults. For a port - requiring multiple distribution files, simply set DISTFILES explicitly. If only a + represents the most common time-saving defaults. For a port + requiring multiple distribution files, simply set DISTFILES explicitly. If only a subset of DISTFILES are actual extractable archives, then set them up in EXTRACT_ONLY, which will override the DISTFILES list when @@ -1657,7 +1657,7 @@ lib/X11/oneko/mouse.xpm If DISTNAME does not conform to our guidelines for a good package name, you should set the PKGNAME - variable to something better. See the abovementioned guidelines + variable to something better. See the abovementioned guidelines for more details. @@ -1667,29 +1667,29 @@ lib/X11/oneko/mouse.xpm When a package is created, it is put under /usr/ports/packages/All and links are made from one or more subdirectories of - /usr/ports/packages. The names of these - subdirectories are specified by the variable CATEGORIES. It is intended to + /usr/ports/packages. The names of these + subdirectories are specified by the variable CATEGORIES. It is intended to make life easier for the user when he is wading through the - pile of packages on the ftp site or the CD-ROM. Please take a + pile of packages on the ftp site or the CD-ROM. Please take a look at the existing categories and pick the ones that are suitable for your port. This list also determines where in the ports tree the port - is imported. If you put more than one category here, it is + is imported. If you put more than one category here, it is assumed that the port files will be put in the subdirectory with - the name in the first category. See the categories section for more discussion about how to pick the right categories. If you port truly belongs to something that is different from all the existing ones, you can even create a new category - name. In that case, please send mail to the &a.ports; to propose + name. In that case, please send mail to the &a.ports; to propose a new category. There is no error checking for category - names. make package will happily create a + names. make package will happily create a new directory if you mustype the category name, so be careful! @@ -1699,7 +1699,7 @@ lib/X11/oneko/mouse.xpm <makevar>MASTER_SITES</makevar> Record the directory part of the ftp/http-URL pointing at - the original tarball in MASTER_SITES. Do not forget the + the original tarball in MASTER_SITES. Do not forget the trailing slash (/)! The make macros will try to use this specification for @@ -1707,7 +1707,7 @@ lib/X11/oneko/mouse.xpm already on the system. It is recommended that you put multiple sites on this - list, preferably from different continents. This will + list, preferably from different continents. This will safeguard against wide-area network problems, and we are even planning to add support for automatically determining the closest master site and fetching from there! @@ -1717,8 +1717,8 @@ lib/X11/oneko/mouse.xpm Linux Sunsite, you refer to those sites in an easy compact form using MASTER_SITE_XCONTRIB, MASTER_SITE_GNU, MASTER_SITE_PERL_CPAN, MASTER_SITE_TEX_CTAN, and - MASTER_SITE_SUNSITE. Simply set MASTER_SITE_SUBDIR to the - path with in the archive. Here is an example: + MASTER_SITE_SUNSITE. Simply set MASTER_SITE_SUBDIR to the + path with in the archive. Here is an example: MASTER_SITES= ${MASTER_SITE_XCONTRIB} @@ -1755,10 +1755,10 @@ MASTER_SITE_SUBDIR= applications If the patch is distributed with some other files, such as documentation, in a gzip'd tarball, you can't just use - PATCHFILES. If that is + PATCHFILES. If that is the case, add the name and the location of the patch tarball to DISTFILES and - MASTER_SITES. Then, from + MASTER_SITES. Then, from the pre-patch target, apply the patch either by running the patch command from there, or copying the patch file into the PATCHDIR directory and calling it @@ -1769,7 +1769,7 @@ MASTER_SITE_SUBDIR= applications regular source by then, so there is no need to explicitly extract it if it is a regular gzip'd or compress'd tarball. If you do the latter, take extra care not to overwrite - something that already exists in that directory. Also do + something that already exists in that directory. Also do not forget to add a command to remove the copied patch in the pre-clean target. @@ -1779,7 +1779,7 @@ MASTER_SITE_SUBDIR= applications <makevar>MAINTAINER</makevar> - Set your mail-address here. Please. :) + Set your mail-address here. Please. :) For detailed description of the responsibility of maintainers, refer to Dependencies - Many ports depend on other ports. There are five + Many ports depend on other ports. There are five variables that you can use to ensure that all the required - bits will be on the user's machine. There are also some + bits will be on the user's machine. There are also some pre-supported dependency variables for common cases, plus a few more to control the behaviour of dependencies. @@ -1802,12 +1802,12 @@ MASTER_SITE_SUBDIR= applications <makevar>LIB_DEPENDS</makevar> This variable specifies the shared libraries this port - depends on. It is a list of lib:dir:target tuples where + depends on. It is a list of lib:dir:target tuples where lib is the name of the shared library, and dir is the directory in which to find it in case it is not available, and target is the target to call in - that directory. For example, + that directory. For example, LIB_DEPENDS= jpeg\\.9\\.:${PORTSDIR}/graphics/jpeg:install @@ -1816,19 +1816,19 @@ LIB_DEPENDS= jpeg\\.9\\.:${PORTSDIR}/graphics/jpeg:install major version 9, and descend into the graphics/jpeg subdirectory of your ports tree to build and install it if it is not - found. The target part can be + found. The target part can be omitted if it is equal to DEPENDS_TARGET (which defaults to install). The lib part is an argument - given to ldconfig -r | grep -wF. There + given to ldconfig -r | grep -wF. There shall be no reqular expressions in this variable. The dependency is checked twice, once from within the extract target and then from within - the install target. Also, the name of the + the install target. Also, the name of the dependency is put in to the package so that pkg_add will automatically install it if it is not on the user's system. @@ -1839,12 +1839,12 @@ LIB_DEPENDS= jpeg\\.9\\.:${PORTSDIR}/graphics/jpeg:install <makevar>RUN_DEPENDS</makevar> This variable specifies executables or files this port - depends on during run-time. It is a list of path:dir:target tuples where + depends on during run-time. It is a list of path:dir:target tuples where path is the name of the executable or file, and dir is the directory in which to find it in case it is not available, and target is the target to call in - that directory. If + that directory. If path starts with a slash (/), it is treated as a file and its existence is tested with test -e; @@ -1861,7 +1861,7 @@ RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \ will check if the file or directory /usr/local/etc/innd exists, and build and install it from the news/inn - subdirectory of the ports tree if it is not found. It will + subdirectory of the ports tree if it is not found. It will also see if an executable called wish8.0 is in your search path, and descend into the x11-toolkits/tk80 subdirectory of your ports tree to build and install it if it is not @@ -1874,10 +1874,10 @@ RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \ use the full pathname. - The dependency is checked from within the install target. Also, the name of the + The dependency is checked from within the install target. Also, the name of the dependency is put in to the package so that pkg_add will automatically install it if it - is not on the user's system. The + is not on the user's system. The target part can be omitted if it is the same DEPENDS_TARGET. @@ -1887,7 +1887,7 @@ RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \ <makevar>BUILD_DEPENDS</makevar> This variable specifies executables or files this port - requires to build. Like RUN_DEPENDS, it is + requires to build. Like RUN_DEPENDS, it is a list of path:dir:target tuples. For example, @@ -1902,8 +1902,8 @@ BUILD_DEPENDS= unzip:${PORTSDIR}/archivers/unzip “build” here means everything from extracting to - compilation. The dependency is checked from within the - extract target. The + compilation. The dependency is checked from within the + extract target. The target part can be omitted if it is the same as DEPENDS_TARGET @@ -1913,8 +1913,8 @@ BUILD_DEPENDS= unzip:${PORTSDIR}/archivers/unzip <makevar>FETCH_DEPENDS</makevar> This variable specifies executables or files this port - requires to fetch. Like the previous two, it is a list of - path:dir:target tuples. For + requires to fetch. Like the previous two, it is a list of + path:dir:target tuples. For example, @@ -1926,7 +1926,7 @@ FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2 tree to build and install it if it is not found. The dependency is checked from within the - fetch target. The + fetch target. The target part can be omitted if it is the same as DEPENDS_TARGET. @@ -1938,8 +1938,8 @@ FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2 If there is a dependency that does not fall into either of the above four categories, or your port requires to have the source of the other port extracted in addition to having - them installed, then use this variable. This is a list of - dir:target, as there is nothing to check, unlike the previous four. The target part can be omitted if it is the same as DEPENDS_TARGET. + them installed, then use this variable. This is a list of + dir:target, as there is nothing to check, unlike the previous four. The target part can be omitted if it is the same as DEPENDS_TARGET. @@ -1947,15 +1947,15 @@ FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2 Define USE_XLIB=yes if your port requires the X Window System to be installed (it is implied by - USE_IMAKE). Define + USE_IMAKE). Define USE_GMAKE=yes if your port requires GNU make instead of BSD - make. Define + make. Define USE_AUTOCONF=yes if your port requires GNU - autoconf to be run. Define USE_QT=yes if - your port uses the latest qt toolkit. Use + autoconf to be run. Define USE_QT=yes if + your port uses the latest qt toolkit. Use USE_PERL5=yes if your port requires version - 5 of the perl language. (The last is especially important since + 5 of the perl language. (The last is especially important since some versions of FreeBSD has perl5 as part of the base system while others don't.) @@ -1965,25 +1965,25 @@ FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2 As mentioned above, the default target to call when a dependency is required is - DEPENDS_TARGET. It defaults to - install. This is a user variable; is is - never defined in a port's Makefile. If + DEPENDS_TARGET. It defaults to + install. This is a user variable; is is + never defined in a port's Makefile. If your port needs a special way to handle a dependency, use the :target part of the *_DEPENDS variables instead of redefining DEPENDS_TARGET. When you type make clean, its - dependencies are automatically cleaned too. If you do not wish + dependencies are automatically cleaned too. If you do not wish this to happen, define the variable NOCLEANDEPENDS in your environment. To depend on another port unconditionally, it is customary to use the string nonexistent as the first field of BUILD_DEPENDS or - RUN_DEPENDS. Use this only when you need to - the to get to the source of the other port. You can often save - compilation time by specifying the target too. For + RUN_DEPENDS. Use this only when you need to + the to get to the source of the other port. You can often save + compilation time by specifying the target too. For instance @@ -1992,10 +1992,10 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract will always descend to the JPEG port and extract it. Do not use DEPENDS unless there is no - other way the behaviour you want can be accomplished. It will + other way the behaviour you want can be accomplished. It will cause the other port to be always build (and installed, by default), and the dependency will go into the packages as - well. If this is really what you need, I recommend you + well. If this is really what you need, I recommend you write it as BUILD_DEPENDS and RUN_DEPENDS instead—at least the intention will be clear. @@ -2006,19 +2006,19 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract Building mechanisms If your package uses GNU make, set - USE_GMAKE=yes. If your package uses + USE_GMAKE=yes. If your package uses configure, set - HAS_CONFIGURE=yes. If your package uses GNU + HAS_CONFIGURE=yes. If your package uses GNU configure, set GNU_CONFIGURE=yes (this implies - HAS_CONFIGURE). If you want to give some + HAS_CONFIGURE). If you want to give some extra arguments to configure (the default argument list --prefix=${PREFIX} for GNU configure and empty for non-GNU configure), set those extra arguments in - CONFIGURE_ARGS. If your package uses GNU + CONFIGURE_ARGS. If your package uses GNU autoconf, set - USE_AUTOCONF=yes. This implies + USE_AUTOCONF=yes. This implies GNU_CONFIGURE, and will cause autoconf to be run before configure. @@ -2026,9 +2026,9 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract If your package is an X application that creates Makefiles from Imakefiles using imake, then set - USE_IMAKE=yes. This will cause the + USE_IMAKE=yes. This will cause the configure stage to automatically do an xmkmf - -a. If the flag is a + -a. If the flag is a problem for your port, set XMKMF=xmkmf. If the port uses imake but does not understand the @@ -2040,7 +2040,7 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract If your port's source Makefile has something else than all as the main build target, set ALL_TARGET - accordingly. Same goes for install and + accordingly. Same goes for install and INSTALL_TARGET. @@ -2049,7 +2049,7 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract Special considerations There are some more things you have to take into account when - you create a port. This section explains the most common of + you create a port. This section explains the most common of those. @@ -2068,7 +2068,7 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract pair to your pkg/PLIST file so that a user who installed the package can start using teh shared libraru immediately and deinstallation will not cause the system to - still believe the library is there. These lines should + still believe the library is there. These lines should immediately follow the line for the shared library itself, as in: @@ -2080,10 +2080,10 @@ lib/libtvl80.so.1 Never, ever, ever add a line that says ldconfig without any arguments to your Makefile or - pkg/PLIST. This will reset the shared + pkg/PLIST. This will reset the shared libraru cache to the contents of /usr/lib only, and will royally screw up the user's machine ("Help, xinit - does not run anymore after I install this port!"). Anybody who + does not run anymore after I install this port!"). Anybody who does this will be shot and cut in 65,536 pieces by a rusty knife and have is liver chopped out by a bunch of crows and will eternally rot to death in the deepest bowels of hell (not @@ -2096,7 +2096,7 @@ lib/libtvl80.so.1 Since FreeBSD is moving to ELF shortly after 3.0-RELEASE, we need to convert many ports that build shared libraries - to support ELF. Complicating this task is that a 3.0 + to support ELF. Complicating this task is that a 3.0 system can run as both ELF and a.out, and we wish to unofficially support the 2.2 as long as possible. Below are the guidelines on how to convert a.out only ports to @@ -2112,7 +2112,7 @@ lib/libtvl80.so.1 A.out libraries should be moved out of /usr/local/lib and similar to an - aout subdirectory. (If you don't move them + aout subdirectory. (If you don't move them out of the way, ELF ports will happily overwrite a.out libraries.) The move-aout-libs target in the 3.0-CURRENT src/Makefile (called from @@ -2125,16 +2125,16 @@ lib/libtvl80.so.1 Format The ports tree will build packages in the format the machine - is in. This means a.out for 2.2 and a.out or ELF for 3.0 depending - on what `objformat` returns. Also, once users + is in. This means a.out for 2.2 and a.out or ELF for 3.0 depending + on what `objformat` returns. Also, once users move a.out libraries to a subdirectory, building a.out libraries - will be unsupported. (I.e., it may still work if you know what you + will be unsupported. (I.e., it may still work if you know what you are doing, but you are on your own.) If a port only works for a.out, set BROKEN_ELF to a string describing the reason - why. Such ports will be skipped during a build on an ELF + why. Such ports will be skipped during a build on an ELF system. @@ -2146,10 +2146,10 @@ lib/libtvl80.so.1 PORTOBJFORMAT to aout or elf and export it in the environments CONFIGURE_ENV, SCRIPTS_ENV and - MAKE_ENV. (It's always going to be + MAKE_ENV. (It's always going to be aout in 2.2-STABLE). It is also passed to PLIST_SUB as - PORTOBJFORMAT=${PORTOBJFORMAT}. (See comment + PORTOBJFORMAT=${PORTOBJFORMAT}. (See comment on ldconfig lines below.) The variable is set using this line in @@ -2159,7 +2159,7 @@ lib/libtvl80.so.1 PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout Ports' make processes should use this variable to decide what - to do. However, if the port's configure + to do. However, if the port's configure script already automatically detects an ELF system, it is not necessary to refer to PORTOBJFORMAT. @@ -2178,7 +2178,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

libfoo.so.M where M is the single version number, and an a.out library should be called - libfoo.so.M.N where M is the major version and N is the the minor version number. Do not mix those; never install an ELF shared library called libfoo.so.N.M or an a.out shared library (or symlink) called libfoo.so.N. + libfoo.so.M.N where M is the major version and N is the the minor version number. Do not mix those; never install an ELF shared library called libfoo.so.N.M or an a.out shared library (or symlink) called libfoo.so.N. @@ -2194,7 +2194,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

You need to install a symlink from libfoo.so to libfoo.so.N to - make ELF linkers happy. Since it should be listed in + make ELF linkers happy. Since it should be listed in PLIST too, and it won't hurt in the a.out case (some ports even require the link for dynamic loading), you should just make this link regardless of the setting of @@ -2206,7 +2206,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

All port Makefiles are edited to remove minor numbers from LIB_DEPENDS, and also to have the regexp - support removed. (E.g., foo\\.1\\.\\(33|40\\) + support removed. (E.g., foo\\.1\\.\\(33|40\\) becomes foo.2.) They will be matched using grep -wF. @@ -2216,7 +2216,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

PLIST should contain the short (ELF) shlib names if the a.out minor number is zero, and the long - (a.out) names otherwise. bsd.port.mk will + (a.out) names otherwise. bsd.port.mk will automatically add .0 to the end of short shlib lines if PORTOBJFORMAT equals aout, and will delete the minor number from @@ -2227,7 +2227,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

NO_FILTER_SHLIBS. This will turn off the + NO_FILTER_SHLIBS. This will turn off the editing of PLIST mentioned in the previous paragraph. @@ -2259,16 +2259,16 @@ ${SETENV} OBJFORMAT=${PORTOBJFORMAT} ${LDCONFIG} -m .... packages by having a variable (for instance, resolution, or paper size) take different values, create one subdirectory per package to make it easier forusers to see what to do, but try to share as - many files as possible between ports. Typically you only need a + many files as possible between ports. Typically you only need a very short Makefile in all but one of the - directories if you use variables cleverly. In the sole + directories if you use variables cleverly. In the sole Makefiles, you can use MASTERDIR to specify the directory where the - rest of the files are. Also, use a variable as part of + rest of the files are. Also, use a variable as part of PKGNAME so the packages will have different names. - This will be best demonstrated by an example. This is part of + This will be best demonstrated by an example. This is part of japanese/xdvi300/Makefile; @@ -2284,7 +2284,7 @@ RESOLUTION?= 300 .endif japanese/xdvi300 also has all the regular - patches, package files, etc. If you type make + patches, package files, etc. If you type make there, it will take the default value for the resolution (300) and build the port normally. @@ -2299,12 +2299,12 @@ MASTERDIR= ${.CURDIR}/../xdvi300 .include ${MASTERDIR}/Makefile (xdvi240/Makefile and - xdvi400/Makefile are similar). The + xdvi400/Makefile are similar). The MASTERDIR definition tells bsd.port.mk that the refulat set of subdirectories like PATCHDIR and PKGDIR are to be found under - xdvi300. The + xdvi300. The RESOLUTION=118 line will override the RESOLUTION=300 line in xdvi300/Makefile and the port will be built @@ -2316,31 +2316,31 @@ MASTERDIR= ${.CURDIR}/../xdvi300 First, please read our policy on shared library versioning to understand - what to do with shared library versions in general. Do + what to do with shared library versions in general. Do not blindly assume software authors know what they are - doing; many of them do not. It is very important that + doing; many of them do not. It is very important that these details are carefully considered, as we have quite a unique situation where we are trying to have dozens of potentially incompatible software pairs co-exist. Careless port imports have caused great trouble regarding shared libraries in the past (ever wondered why the port jpeg-6b has a shared library version of 9.0?). - If in doubt, send a message to the &a.ports;. Most of the + If in doubt, send a message to the &a.ports;. Most of the time, your job ends by determining the right shared library version and making appropriate patches to implement it. However, if there is a port which is a different version of the same software already in the tree, the situation is - much more complex. In short, the FreeBSD implementation + much more complex. In short, the FreeBSD implementation does not allow the user to specify to the linker which version of shared library to link against (the linker will - always pick the highest numbered version). This means, if + always pick the highest numbered version). This means, if there is a libfoo.so.3.2 and libfoo.so.4.0 in the system, there is no way to tell the linker to link a - particular application to libfoo.so.3.2. It is + particular application to libfoo.so.3.2. It is essentially completely overshadowed in terms of - compilation-time linkage. In this case, the only solution + compilation-time linkage. In this case, the only solution is to rename the base part of the shared library. For instance, change libfoo.so.4.0 to libfoo4.so.1.0 so both version 3.2 and 4.0 can be @@ -2354,7 +2354,7 @@ MASTERDIR= ${.CURDIR}/../xdvi300 add any manpages to pkg/PLIST (this means you must not list manpages in the PLIST—see generating PLIST for more). It + linkend="porting-plist">generating PLIST for more). It also makes the install stage automatically compress or uncompress manpages depending on the setting of NOMANCOMPRESS in @@ -2418,7 +2418,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz There are many programs that require a Motif library (available from several commercial vendors, while there is a free clone reported to be able to run many applications in - x11-toolkits/lesstif) to compile. Since + x11-toolkits/lesstif) to compile. Since it is a popular toolkit and their licenses usually permit redistribution of statically linked binaries, we have made special provisions for handling ports that require Motif in a @@ -2430,7 +2430,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz <makevar>REQUIRES_MOTIF</makevar> If your port requires Motif, define this variable in the - Makefile. This will prevent people who don't own a copy of + Makefile. This will prevent people who don't own a copy of Motif from even attempting to build it. @@ -2439,7 +2439,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz This variable will be set by bsd.port.mk to be the appropriate reference - to the Motif library. Please patch the source to use this + to the Motif library. Please patch the source to use this wherever the Motif library is referenced in the Makefile or Imakefile. @@ -2473,7 +2473,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz If your port installs fonts for the X Window system, put them in X11BASE/lib/X11/fonts/local. - This directory is new to XFree86 release 3.3.3. If it does not + This directory is new to XFree86 release 3.3.3. If it does not exist, please create it, and print out a message urging the user to update their XFree86 to 3.3.3 or newer, or at least add this directory to the font path in @@ -2485,12 +2485,12 @@ ${PREFIX}/man/ja/man4/baz.4.gz The new version of texinfo (included in 2.2.2-RELEASE and onwards) contains a utility called install-info - to add and delete entries to the dir file. If + to add and delete entries to the dir file. If your port installs any info documents, please follow this instructions so your port/package will correctly update the user's PREFIX/info/dir - file. (Sorry for the length of this section, but is it imperative - to weave all the info files together. If done correctly, it will + file. (Sorry for the length of this section, but is it imperative + to weave all the info files together. If done correctly, it will produce a beautiful listing, so please bear with me! @@ -2517,14 +2517,14 @@ Options: Here's a seven-step procedure to convert ports to use - install-info. I will use + install-info. I will use editors/emacs as an example. Look at the texinfo sources and make a patch to insert @dircategory and @direntry - statements to files that don't have them. This is part of + statements to files that don't have them. This is part of my patch: @@ -2543,10 +2543,10 @@ Options: @finalout : - The format should be self-explanatory. Many authors + The format should be self-explanatory. Many authors leave a dir file in the source tree that contains all the entries you need, so look around - before you try to write your own. Also, make sure you + before you try to write your own. Also, make sure you look into related ports and make the section names and entry indentations consistent (we recommend that all entry text start at the 4th tab stop). @@ -2563,15 +2563,15 @@ Options: entries to install-info as arguments ( and ) instead of patching the texinfo - sources. I do not think this is a good idea for ports + sources. I do not think this is a good idea for ports because you need to duplicate the same information in three places (Makefile and @exec/@unexec of - PLIST; see below). However, if you + PLIST; see below). However, if you have a Japanese (or other multibyte encoding) info files, you will have to use the extra arguments to install-info because makeinfo can't handle those texinfo - sources. (See Makefile and + sources. (See Makefile and PLIST of japanese/skk for examples on how to do this). @@ -2583,7 +2583,7 @@ Options: Since the texinfo sources are newer than the info files, they should be rebuilt when you type make; but many Makefiles don't include correct - dependencies for info files. In emacs' case, I had to + dependencies for info files. In emacs' case, I had to patch the main Makefile.in so it will descend into the man subdirectory to rebuild the info pages. @@ -2614,7 +2614,7 @@ Options: The second hunk was necessary because the default target in the man subdir is called info, while the main - Makefile wants to call all. I also deleted the installation + Makefile wants to call all. I also deleted the installation of the info info file because we already have one with the same name in /usr/share/info (that patch is not @@ -2624,8 +2624,8 @@ Options: If there is a place in the Makefile that is installing the - dir file, delete it. Your - port may not be doing it. Also, remove any commands that + dir file, delete it. Your + port may not be doing it. Also, remove any commands that are otherwise mucking around with the dir file. @@ -2653,7 +2653,7 @@ Options: (This step is only necessary if you are modifying an existing port.) Take a look at pkg/PLIST and delete anything that is - trying to patch up info/dir. They + trying to patch up info/dir. They may be in pkg/INSTALL or some other file, so search extensively. @@ -2680,7 +2680,7 @@ diff -u -r1.15 PLIST Add a post-install target to the Makefile to create a - dir file if it is not there. Also, + dir file if it is not there. Also, call install-info with the installed info files. @@ -2708,7 +2708,7 @@ diff -u -r1.26 Makefile Do not use anything other than /usr/share/info/dir and the above - command to create a new info file. In fact, I'd add the + command to create a new info file. In fact, I'd add the first three lines of the above patch to bsd.port.mk if you (the porter) wouldn't have to do it in PLIST by @@ -2760,7 +2760,7 @@ diff -u -r1.15 PLIST - Test and admire your work. :). Check the dir file before and after each + Test and admire your work. :). Check the dir file before and after each step. @@ -2778,14 +2778,14 @@ diff -u -r1.15 PLIST <filename>MESSAGE</filename> If you need to display a message to the installer, you may - place the message in pkg/MESSAGE. This + place the message in pkg/MESSAGE. This capability is often useful to display additional installation steps to be taken after a pkg_add or to display licensing information. The pkg/MESSAGE file does not need to - be added to pkg/PLIST. Also, it will not get + be added to pkg/PLIST. Also, it will not get automatically printed if the user is using the port, not the package, so you should probably display it from the post-install target yourself. @@ -2797,13 +2797,13 @@ diff -u -r1.15 PLIST If your port needs to execute commands when the binary package is installed with pkg_add you can do this via the - pkg/INSTALL script. This script will + pkg/INSTALL script. This script will automatically be added to the package, and will be run twice by - pkg_add. The first time will as + pkg_add. The first time will as INSTALL ${PKGNAME} PRE-INSTALL and the second time as INSTALL ${PKGNAME} - POST-INSTALL. $2 can be - tested to determine which mode the script is being run in. The + POST-INSTALL. $2 can be + tested to determine which mode the script is being run in. The PKG_PREFIX environmental variable will be set to the package installation directory. See pkg_add @@ -2823,7 +2823,7 @@ diff -u -r1.15 PLIST If your port needs to determine if it should install or not, you can create a pkg/REQ - “requirements” script. It will be invoked + “requirements” script. It will be invoked automatically at installation/deinstallation time to determine whether or not installation/deinstallation should proceed. @@ -2833,13 +2833,13 @@ diff -u -r1.15 PLIST Some ports, particularly the p5- ports, need to change their PLIST depending on what options they are - configured with (or version of perl, in the case of p5- ports). To + configured with (or version of perl, in the case of p5- ports). To make this easy, any instances in the PLIST of %%OSREL%%, %%PERL_VER%%, and %%PERL_VERSION%% will be substituted for - appropriately. The value of %%OSREL%% is the + appropriately. The value of %%OSREL%% is the numeric revision of the operating system (e.g., - 2.2.7). %%PERL_VERSION%% is + 2.2.7). %%PERL_VERSION%% is the full version number of perl (e.g., 5.00502) and %%PERL_VER%% is the perl version number minus the patchlevel (e.g., 5.005). @@ -2886,7 +2886,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} All the filenames in the pkg subdirectory are defined using variables so you can change them in your - Makefile if need be. This is especially useful when you + Makefile if need be. This is especially useful when you are sharing the same pkg subdirectory among several ports or have to write to one of the above files (see writing to places other than @@ -2946,7 +2946,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} Please change these variables rather than overriding - PKG_ARGS. If you change + PKG_ARGS. If you change PKG_ARGS, those files will not correctly be installed in /var/db/pkg upon install from a port. @@ -2958,7 +2958,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} Some software packages have restrictive licenses or can be in violation to the law (PKP's patent on public key crypto, ITAR - (export of crypto software) to name just two of them). What we + (export of crypto software) to name just two of them). What we can do with them varies a lot, depending on the exact wordings of the respective licenses. @@ -2967,7 +2967,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} licensing terms of the software and make sure that the FreeBSD project will not be held accountable of violating them by redistributing the source or compiled binaries either via ftp - or CD-ROM. If in doubt, please contact the &a.ports;. + or CD-ROM. If in doubt, please contact the &a.ports;. There are two variables you can set in the Makefile to @@ -2979,9 +2979,9 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} If the port has a “do not sell for profit” type of license, set the variable NO_CDROM to a - string describing the reason why. We + string describing the reason why. We will make sure such ports won't go into the CD-ROM come - release time. The distfile and package will still be + release time. The distfile and package will still be available via ftp. @@ -2990,9 +2990,9 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} for each site, or the resulting binary package can't be distributed due to licensing; set the variable NO_PACKAGE to a string describing the - reason why. We will make sure such + reason why. We will make sure such packages won't go on the ftp site, nor into the CD-ROM - come release time. The distfile will still be included on + come release time. The distfile will still be included on both however. @@ -3000,7 +3000,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} If the port has legal restrictions on who can use it (e.g., crypto stuff) or has a “no commercial use” license, set the variable RESTRICTED to be the - string describing the reason why. For such ports, the + string describing the reason why. For such ports, the distfiles/packages will not be available even from our ftp sites. @@ -3024,12 +3024,12 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} When you notice that a port is out of date compared to the latest version from the original authors, first make sure you - have the latest port. You can find them in the + have the latest port. You can find them in the ports/ports-current directory of the ftp mirror sites. The next step is to send a mail to the maintainer, if one is - listed in the port's Makefile. That person may already be + listed in the port's Makefile. That person may already be working on an upgrade, or have a reason to not upgrade the port right now (because of, for example, stability problems of the new version). @@ -3043,12 +3043,12 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} and the original as in our tree is superedit.bak, then send us the result of diff -ruN superedit.bak - superedit). Please examine the output to make - sure all the changes make sense. The best way to send us the + superedit). Please examine the output to make + sure all the changes make sense. The best way to send us the diff is by including it to send-pr1 - (category ports). Please mention any added or deleted files + (category ports). Please mention any added or deleted files in the message, as they have to be explicitly specified to CVS - when doing a commit. If the diff is more than about 20KB, please + when doing a commit. If the diff is more than about 20KB, please compress and uuencode it; otherwise, just include it in as is in the PR. @@ -3062,18 +3062,18 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} Here is a list of common do's and dont's that you encounter during the porting process.You should check your own port against this list, but you can also check ports in the PR - database that others have submitted. Submit any comments on + database that others have submitted. Submit any comments on ports you check as described in Bug - Reports and General Commentary. Checking ports in + Reports and General Commentary. Checking ports in the PR database will both make it faster for us to commit them, and prove that you know what you are doing. Strip Binaries - Do strip binaries. If the original source already strips the + Do strip binaries. If the original source already strips the binaries, fine; otherwise you should add a - post-install rule to to it yourself. Here is an + post-install rule to to it yourself. Here is an example; @@ -3084,7 +3084,7 @@ post-install: file 1 command on the installed executable to check - whether the binary is stripped or not. If it does not say + whether the binary is stripped or not. If it does not say not stripped, it is stripped. @@ -3127,10 +3127,10 @@ post-install: <makevar>WRKDIR</makevar> Do not write anything to files outside - WRKDIR. WRKDIR is the only + WRKDIR. WRKDIR is the only place that is guaranteed to be writable during the port build (see compiling ports from CDROM for an - example of building ports from a read-only tree). If you need to + example of building ports from a read-only tree). If you need to modigy some file in PKGDIR, do so by redefining a variable, not by writing over it. @@ -3140,8 +3140,8 @@ post-install: <makevar>WRKDIRPREFIX</makevar> Make sure your port honors - WRKDIRPREFIX. Most ports don't have to worry - about this. In particular, if you are referring to a + WRKDIRPREFIX. Most ports don't have to worry + about this. In particular, if you are referring to a WRKDIR of another port, note that the correct location is WRKDIRPREFIXPORTSDIR/subdir/name/work not PORTSDIR/subdir/name/work or .CURDIR/../../subdir/name/work or some such. @@ -3157,7 +3157,7 @@ post-install: You may come across code that needs modifications or conditional compilation based upon what version of UNIX it is - running under. If you need to make such changes to the code for + running under. If you need to make such changes to the code for conditional compilation, make sure you make the changes as general as possible so that we can back-port code to FreeBSD 1.x systems and cross-port to other BSD systems such as 4.4BSD from CSRG, @@ -3166,7 +3166,7 @@ post-install: The preferred way to tell 4.3BSD/Reno (1990) and newer versions of the BSD code apart is by using the BSD macro defined in - <sys/param.h>. Hopefully that file is + <sys/param.h>. Hopefully that file is already included; if not, add the code: @@ -3174,10 +3174,10 @@ post-install: #include <sys/param.h> #endif - to the proper place in the .c file. We + to the proper place in the .c file. We believe that every system that defines these two symbols has - sys/param.h. If you find a system that - doesn't, we would like to know. Please send mail to the + sys/param.h. If you find a system that + doesn't, we would like to know. Please send mail to the &a.ports;. Another way is to use the GNU Autoconf style of doing @@ -3212,10 +3212,10 @@ post-install: above). The value of the BSD macro is - 199506 for the 4.4BSD-Lite2 code base. This is - stated for informational purposes only. It should not be used to + 199506 for the 4.4BSD-Lite2 code base. This is + stated for informational purposes only. It should not be used to distinguish between versions of FreeBSD based only on 4.4-Lite vs. - versions that have merged in changes from 4.4-Lite2. The + versions that have merged in changes from 4.4-Lite2. The __FreeBSD__ macro should be used instead. @@ -3226,8 +3226,8 @@ post-install: __FreeBSD__ is defined in all - versions of FreeBSD. Use it if the change you are making - only affects FreeBSD. Porting gotchas like the use of + versions of FreeBSD. Use it if the change you are making + only affects FreeBSD. Porting gotchas like the use of sys_errlist[] vs strerror() are Berkeleyisms, not FreeBSD changes. @@ -3235,8 +3235,8 @@ post-install: In FreeBSD 2.x, __FreeBSD__ is - defined to be 2. In earlier - versions, it is 1. Later + defined to be 2. In earlier + versions, it is 1. Later versions will bump it to match their major version number. @@ -3244,12 +3244,12 @@ post-install: If you need to tell the difference between a FreeBSD 1.x system and a FreeBSD 2.x or 3.x system, usually the right answer is to use the BSD macros - described above. If there actually is a FreeBSD specific + described above. If there actually is a FreeBSD specific change (such as special shared library options when using ld) then it is OK to use __FreeBSD__ and #if __FreeBSD__ > 1 to detect a FreeBSD 2.x - and later system. If you need more granularity in + and later system. If you need more granularity in detecting FreeBSD systems since 2.0-RELEASE you can use the following: @@ -3463,12 +3463,12 @@ post-install: Note that 2.2-STABLE sometimes identifies itself as - “2.2.5-STABLE” after the 2.2.5-RELEASE. The pattern used to + “2.2.5-STABLE” after the 2.2.5-RELEASE. The pattern used to be year followed by the month, but we decided to change it to a more straightforward major/minor system starting from - 2.2. This is because the parallel development on several + 2.2. This is because the parallel development on several branches made it infeasible to classify the releases simply - by their real release dates. If you are making a port now, + by their real release dates. If you are making a port now, you don't have to worry about old -CURRENTs; they are listed here just for your reference. @@ -3476,7 +3476,7 @@ post-install: In the hundreds of ports that have been done, there have only been one or two cases where __FreeBSD__ - should have been used. Just because an earlier port screwed up + should have been used. Just because an earlier port screwed up and used it in the wrong place does not mean you should do so too. @@ -3486,7 +3486,7 @@ post-install: bsd.port.mk Do not write anything after the .include - <bsd.port.mk> line. it usually can be avoided by + <bsd.port.mk> line. it usually can be avoided by including bsd.port.pre.mk somewhere in the middle of your Makefile and bsd.port.post.mk at the end. @@ -3609,11 +3609,11 @@ post-install: If your software has some documentation other than the standard man and info pages that you think is useful for the user, install it under - PREFIX/share/doc. This can be + PREFIX/share/doc. This can be done, like the previous item, in the post-install target. - Create a new directory for your port. The directory name - should reflect what the port is. This usually means PKGNAME minus the version part. + Create a new directory for your port. The directory name + should reflect what the port is. This usually means PKGNAME minus the version part. However, if you think the user might want different versions of the port to be installed at the same time, you can use the whole PKGNAME. @@ -3636,7 +3636,7 @@ post-install: /etc/make.conf.) Also you can use the pkg/MESSAGE file to - display messages upon installation. See the using pkg/MESSAGE section for details. @@ -3651,12 +3651,12 @@ post-install: <makevar>DIST_SUBDIR</makevar> Do not let your port clutter - /usr/ports/distfiles. If your port + /usr/ports/distfiles. If your port requires a lot of files to be fetched, or contains a file that has a name that might conflict with other ports (e.g., Makefile), set DIST_SUBDIR to the name of the port (PKGNAME without the - version part should work fine). This will change DISTDIR from the default + version part should work fine). This will change DISTDIR from the default /usr/ports/distfiles to /usr/ports/distfiles/DIST_SUBDIR, and in effect puts everything that is required for your port @@ -3664,7 +3664,7 @@ post-install: It will also look at the subdirectory with the same name on the backup master site at - ftp.freebsd.org. (Setting DISTDIR explicitly in your + ftp.freebsd.org. (Setting DISTDIR explicitly in your Makefile will not accomplish this, so please use DIST_SUBDIR.) @@ -3691,10 +3691,10 @@ post-install: RCS strings - Do not put RCS strings in patches. CVS will mangle them + Do not put RCS strings in patches. CVS will mangle them when we put the files into the ports tree, and when we check them out again, they will come out different and the patch - will fail. RCS strings are surrounded by dollar ($) signs, and typically start with + will fail. RCS strings are surrounded by dollar ($) signs, and typically start with $Id or $RCS. @@ -3705,10 +3705,10 @@ post-install: Using the recurse () option to diff to generate patches is fine, but please take a look at the resulting patches to make - sure you don't have any unnecessary junk in there. In + sure you don't have any unnecessary junk in there. In particular, diffs between two backup files, Makefiles when the port uses Imake or GNU configure, etc., are unnecessary and - should be deleted. If you had to edit + should be deleted. If you had to edit configure.in and run autoconf to regenerate configure, do not take the diffs of @@ -3718,7 +3718,7 @@ post-install: Also, if you had to delete a file, then you can do it in the post-extract - target rather than as part of the patch. Once you are happy + target rather than as part of the patch. Once you are happy with the resulting diff, please split it up into one source file per patch file. @@ -3727,7 +3727,7 @@ post-install: <makevar>PREFIX</makevar> - Do try to make your port install relative to PREFIX. (The value of this + Do try to make your port install relative to PREFIX. (The value of this variable will be set to LOCALBASE (default /usr/local), unless USE_X_PREFIX or USE_IMAKE is set, in which case it will be X11BASE (default @@ -3736,7 +3736,7 @@ post-install: Not hard-coding /usr/local or /usr/X11R6 anywhere in the source will make the port much more flexible and able to cater to the - needs of other sites. For X ports that use imake, this is + needs of other sites. For X ports that use imake, this is automatic; otherwise, this can often be done by simply replacing the occurrences of /usr/local (or /usr/X11R6 for X ports that do not @@ -3751,12 +3751,12 @@ post-install: The variable PREFIX can be reassigned in your Makefile or in the user's - environment. However, it is strongly discouraged for + environment. However, it is strongly discouraged for individual ports to set this variable explicitly in the Makefiles. Also, refer to programs/files from other ports with the - variables mentioned above, not explicit pathnames. For + variables mentioned above, not explicit pathnames. For instance, if your port requires a macro PAGER to be the full pathname of less, use the compiler flag: @@ -3776,22 +3776,22 @@ post-install: Subdirectories Try to let the port put things in the right subdirectories - of PREFIX. Some ports + of PREFIX. Some ports lump everything and put it in the subdirectory with the port's - name, which is incorrect. Also, many ports put everything + name, which is incorrect. Also, many ports put everything except binaries, header files and manual pages in the a subdirectory of lib, which does not - bode well with the BSD paradigm. Many of the files should be + bode well with the BSD paradigm. Many of the files should be moved to one of the following: etc (setup/configuration files), libexec (executables started internally), sbin (executables for superusers/managers), info (documentation for info browser) or share (architecture independent - files). See man hier7 for + files). See man hier7 for details, the rules governing /usr pretty - much apply to /usr/local too. The - exception are ports dealing with USENET “news”. They may use + much apply to /usr/local too. The + exception are ports dealing with USENET “news”. They may use PREFIX/news as a destination for their files. @@ -3801,9 +3801,9 @@ post-install: Cleaning up empty directories Do make your ports clean up after themselves when they are - deinstalled. This is usually accomplished by adding + deinstalled. This is usually accomplished by adding @dirrm lines for all directories that are - specifically created by the port. You need to delete + specifically created by the port. You need to delete subdirectories before you can delete parent directories. @@ -3816,7 +3816,7 @@ lib/X11/oneko/sounds/cat.au @dirrm lib/X11/oneko However, sometimes @dirrm will give you - errors because other ports also share the same subdirectory. You + errors because other ports also share the same subdirectory. You can call rmdir from @unexec to remove only empty directories without warning. @@ -3836,16 +3836,16 @@ lib/X11/oneko/sounds/cat.au If your port requires a certain user to be on the installed system, let the pkg/INSTALL script call pw to create it - automatically. Look at net/cvsup-mirror + automatically. Look at net/cvsup-mirror for an example. If your port must use the same user/group ID number when it is installed a binarypackage as when it was compiled, then you mus - choose a free UID from 50 to 99 and register it below. Look at + choose a free UID from 50 to 99 and register it below. Look at japanese/Wnn for an example. Make sure you don't use a UID already used by the system - or other ports. This is the current list of UIDs between 50 + or other ports. This is the current list of UIDs between 50 and 99. @@ -3869,7 +3869,7 @@ qmailr:*:86:82:QMail user:/var/qmail:/nonexistent msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh Please include a notice when you submit a port (or an - upgrade) that reserves a new UID or GID in this range. This allows + upgrade) that reserves a new UID or GID in this range. This allows us to keep the list of reserved IDs up to date. @@ -3893,7 +3893,7 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh Respect <makevar>CFLAGS</makevar> The port should respect the CFLAGS - variable. If it doesn't, please add NO_PACKAGE=ignores + variable. If it doesn't, please add NO_PACKAGE=ignores cflags to the Makefile. @@ -3903,7 +3903,7 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh If your port requires some configuration files in PREFIX/etc, do not just install them and list them in - pkg/PLIST. That will cause + pkg/PLIST. That will cause pkg_delete to delete files carefully edited by the user and a new installation to wipe them out. @@ -3927,7 +3927,7 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh Feedback Do send applicable changes/patches to the original - author/maintainer for inclusion in next release of the code. This + author/maintainer for inclusion in next release of the code. This will only make your job that much easier for the next release. @@ -3937,7 +3937,7 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh The files pkg/DESCR, pkg/COMMENT, and - pkg/PLIST should each be double-checked. If + pkg/PLIST should each be double-checked. If you are reviewing a port and feel they can be worded better, do so. @@ -3965,13 +3965,13 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh A Sample <filename>Makefile</filename> Here is a sample Makefile that you can - use to create a new port. Make sure you remove all the extra + use to create a new port. Make sure you remove all the extra comments (ones between brackets)! It is recommended that you follow this format (ordering of - variables, empty lines between sections, etc.). This format is + variables, empty lines between sections, etc.). This format is designed so that the most important information is easy to - locate. We recommend that you use portlint to check the Makefile. @@ -4060,7 +4060,7 @@ pre-install: Package Names The following are the conventions you should follow in - naming your packages. This is to have our package directory + naming your packages. This is to have our package directory easy to scan, as there are already lots and lots of packages and users are going to turn away if they hurt their eyes! @@ -4075,9 +4075,9 @@ pre-install: FreeBSD strives to support the native language of its - users. The language- part should be a two letter + users. The language- part should be a two letter abbreviation of the natural language defined by ISO-639 if - the port is specific to a certain language. Examples are + the port is specific to a certain language. Examples are ja for Japanese, ru for Russian, vi for Vietnamese, zh for Chinese, ko for Korean and de for German. @@ -4085,17 +4085,17 @@ pre-install: The name part should be all lowercases, except for a really large - package (with lots of programs in it). Things like + package (with lots of programs in it). Things like XFree86 (yes there really is a port of it, check it - out) and ImageMagick fall into this category. Otherwise, + out) and ImageMagick fall into this category. Otherwise, convert the name (or at least the first letter) to - lowercase. If the capital letters are + lowercase. If the capital letters are important to the name (for example, with one-letter names like R or V) you may use capital letters at your discretion. There is a tradition of naming Perl 5 modules by prepending p5- and converting the double-colon separator to a hyphen; for example, the Data::Dumper module becomes - p5-Data-Dumper. If the software in question has numbers, + p5-Data-Dumper. If the software in question has numbers, hyphens, or underscores in its name, you may include them as well (like kinput2). @@ -4105,13 +4105,13 @@ pre-install: defaults (usually part of the directory name in a family of ports), the -compiled.specifics part should state the - compiled-in defaults (the hyphen is optional). Examples + compiled-in defaults (the hyphen is optional). Examples are papersize and font units. The version string should be a period-separated list - of integers and single lowercase alphabetics. The only + of integers and single lowercase alphabetics. The only exception is the string pl (meaning `patchlevel'), which can be used only when there are no major and minor version numbers in the software. @@ -4226,7 +4226,7 @@ pre-install: If there is absolutely no trace of version information in the original source and it is unlikely that the original author will ever release another version, just set the version string - to 1.0 (like the piewm example above). Otherwise, ask the + to 1.0 (like the piewm example above). Otherwise, ask the original author or use the date string (yy.mm.dd) as the version. @@ -4236,14 +4236,14 @@ pre-install: Categories As you already know, ports are classified in several - categories. But for this to wor, it is important that porters and + categories. But for this to wor, it is important that porters and users understand what each category and how we deicde what to put in each category. Current list of categories - First, this is the current list of port categories. Those + First, this is the current list of port categories. Those marked with an asterisk (*) are virtual categories—those that do not have a corresponding subdirectory in the ports tree. @@ -4307,7 +4307,7 @@ pre-install: comms - Communication software. Mostly software to talk to + Communication software. Mostly software to talk to your serial port. @@ -4329,7 +4329,7 @@ pre-install: devel - Development utilities. Do not put libraries here just + Development utilities. Do not put libraries here just because they are libraries—unless they truly don't belong to anywhere else, they shouldn't be in this category. @@ -4337,7 +4337,7 @@ pre-install: editors - General editors. Specialized editors go in the + General editors. Specialized editors go in the section for those tools (e.g., a mathematical-formula editor will go in math). @@ -4349,7 +4349,7 @@ pre-install: emulators - Emulators for other operating systems. Terminal + Emulators for other operating systems. Terminal emulators do not belong here—X-based ones should go to x11 and text-based ones to either @@ -4412,9 +4412,9 @@ pre-install: misc Miscellaneous utilities—basically things that - doesn't belong to anywhere else. This is the only category + doesn't belong to anywhere else. This is the only category that should not appear with any other non-virtual - category. If you have misc with + category. If you have misc with something else in your CATEGORIES line, that means you can safely delete misc and just put the port in that other subdirectory! @@ -4452,7 +4452,7 @@ pre-install: print - Printing software. Desktop publishing tools + Printing software. Desktop publishing tools (previewers, etc.) belong here too. @@ -4503,7 +4503,7 @@ pre-install: textproc - Text processing utilities. It does not include + Text processing utilities. It does not include desktop publishing tools, which go to print/. @@ -4540,7 +4540,7 @@ pre-install: www - Software related to the World Wide Web. HTML language + Software related to the World Wide Web. HTML language support belong here too. @@ -4551,7 +4551,7 @@ pre-install: Do not put regular X applications here. If your port is an X application, define USE_XLIB (implied by USE_IMAKE) and put it in - appropriate categories. Also, many of them go into other + appropriate categories. Also, many of them go into other x11-* categories (see below). @@ -4589,21 +4589,21 @@ pre-install: As many of the categories overlap, you often have to choose which of the categories should be the primary category of your - port. There are several rules that govern this usse. Here is the + port. There are several rules that govern this usse. Here is the list of priorities, in decreasing order of precedence. - Language specific categories alwasys come first. For + Language specific categories alwasys come first. For example, if your port installs Japanese X11 fonts, then your CATEGORIES line would read japanese x11. - Specific categories win over less-specific ones. For + Specific categories win over less-specific ones. For instance, an HTML editor should be listed as www - editors, not the other way around. Also, you don't + editors, not the other way around. Also, you don't need to list net when the port belongs to either of mail, mbone, news, security, or @@ -4612,7 +4612,7 @@ pre-install: x11 is used as a secondary category - only when the primary category is a natural language. In + only when the primary category is a natural language. In particular, you should not put x11 in the category line for X applications. @@ -4625,7 +4625,7 @@ pre-install: If you are not sure about the category, please put a comment to that effect in your send-pr submission so we - can discuss it before import it. (If you are a committer, send a + can discuss it before import it. (If you are a committer, send a note &a.ports; so we can discuss it first—too often new ports are imported to a wrong category only to be moved right away.) @@ -4636,8 +4636,8 @@ pre-install: Changes to this document and the ports system If you maintain a lot of ports, you should consider following - the &a.ports;. Important changes to - the way ports work will be announced there. You can always + the &a.ports;. Important changes to + the way ports work will be announced there. You can always find more detailed information on the latest changes by looking at diff --git a/en_US.ISO8859-1/books/handbook/ppp-and-slip/chapter.sgml b/en_US.ISO8859-1/books/handbook/ppp-and-slip/chapter.sgml index fa8199e611..fd9fa545d1 100644 --- a/en_US.ISO8859-1/books/handbook/ppp-and-slip/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/ppp-and-slip/chapter.sgml @@ -3,9 +3,9 @@ If your connection to the Internet is through a modem, or you wish to provide other people with dialup connections to the Internet using - FreeBSD, you have the option of using PPP or SLIP. Furthermore, two + FreeBSD, you have the option of using PPP or SLIP. Furthermore, two varieties of PPP are provided: user (sometimes - referred to as iijppp) and kernel. The + referred to as iijppp) and kernel. The procedures for configuring both types of PPP, and for setting up SLIP are described in this chapter. @@ -14,33 +14,33 @@ Setting up User PPP User PPP was introduced to FreeBSD in release 2.0.5 as an - addition to the existing kernel implementation of PPP. So, what is + addition to the existing kernel implementation of PPP. So, what is different about this new PPP that warrants its addition? To quote from the manual page:
- This is a user process PPP software package. Normally, PPP + This is a user process PPP software package. Normally, PPP is implemented as a part of the kernel (e.g. as managed by pppd) and it is thus somewhat hard to debug and/or modify its - behavior. However, in this implementation PPP is done as a user + behavior. However, in this implementation PPP is done as a user process with the help of the tunnel device driver (tun).
In essence, this means that rather than running a PPP daemon, - the ppp program can be run as and when desired. No PPP interface + the ppp program can be run as and when desired. No PPP interface needs to be compiled into the kernel, as the program can use the generic tunnel device to get data into and out of the kernel. From here on out, user ppp will be referred to simply as ppp unless a distinction needs to be made between it and any other PPP - client/server software such as pppd. Unless otherwise stated, all + client/server software such as pppd. Unless otherwise stated, all commands in this section should be executed as root. - There are a large number of enhancements in version 2 of ppp. You + There are a large number of enhancements in version 2 of ppp. You can discover what version you have by running ppp with no arguments - and typing show version at the prompt. It is a + and typing show version at the prompt. It is a simple matter to upgrade to the latest version of ppp (under any version of FreeBSD) by downloading the latest archive via www.Awfulhak.org. @@ -51,7 +51,7 @@ This document assumes you are in roughly this position: You have an account with an Internet Service Provider (ISP) - which lets you use PPP. Further, you have a modem (or other + which lets you use PPP. Further, you have a modem (or other device) connected and configured correctly which allows you to connect to your ISP. @@ -66,19 +66,19 @@ - Your login name and password. This can be either a + Your login name and password. This can be either a regular unix style login/password pair, or a PPP PAP or CHAP login/password pair. - The IP addresses of one or more nameservers. Normally, - you will be given two IP numbers. You + The IP addresses of one or more nameservers. Normally, + you will be given two IP numbers. You must have this information for PPP version 1.x unless you run - your own nameserver. From version 2 onwards, + your own nameserver. From version 2 onwards, PPP supports nameserver address - negotiation. If your ISP supports this, then using the command + negotiation. If your ISP supports this, then using the command enable dns in your config file will tell PPP to set the nameservers for you. @@ -92,7 +92,7 @@ The IP address of your ISP's gateway. The gateway is the machine to which you will connect and will be set up as your - default route. If your ISP hasn't given + default route. If your ISP hasn't given you this number, we can make one up and your ISP's PPP server will tell us the correct value when we connect. @@ -101,12 +101,12 @@ - Your ISP's netmask. If your ISP hasn't given you this + Your ISP's netmask. If your ISP hasn't given you this information, you can safely use a netmask of 255.255.255.0. If your ISP allocates you a static IP address and hostname - then you can enter this information. Otherwise, we simply let the + then you can enter this information. Otherwise, we simply let the peer assign whatever IP number it sees fit. @@ -120,18 +120,18 @@ Building a ppp ready kernel As the description states, ppp uses the kernel tun - device. It is necessary to make sure that your kernel has support + device. It is necessary to make sure that your kernel has support for this device compiled in. To check this, go to your kernel compile directory (/sys/i386/conf or /sys/pc98/conf) and examine your kernel - configuration file. It needs to have the line + configuration file. It needs to have the line pseudo-device tun 1 - in it somewhere. The stock GENERIC kernel + in it somewhere. The stock GENERIC kernel has this as standard, so if you have not installed a custom kernel or you do not have a /sys directory, you do not have to change anything. @@ -141,7 +141,7 @@ pseudo-device tun 1 example, if you are setting up a server and could have 16 dialup ppp connections at any one time then you will need to use 16 instead of 1), then you should add the line, re-compile, - re-install and boot the new kernel. Please refer to the + re-install and boot the new kernel. Please refer to the Configuring the FreeBSD Kernel section for more information on kernel configuration. @@ -161,32 +161,32 @@ tun3: flags=8010<POINTOPOINT,MULTICAST> mtu 1500 This case shows four tunnel devices, two of which are - currently configured and being used. It should be noted that the + currently configured and being used. It should be noted that the RUNNING flag above indicates that the interface has been used at some point—it is not an error if your interface does not show up as RUNNING. If you have a kernel without the tun device, and you can not - rebuild it for some reason, all is not lost. You should be able - to dynamically load the code. Refer to the appropriate modload8 + rebuild it for some reason, all is not lost. You should be able + to dynamically load the code. Refer to the appropriate modload8 and lkm4 pages for further details. You may also wish to take this opportunity to configure a - firewall. Details can be found in the Firewalls section. + firewall. Details can be found in the Firewalls section. Check the tun device - Most users will only require one tun device (/dev/tun0). If you + Most users will only require one tun device (/dev/tun0). If you have used more (i.e., a number other than 1 in the pseudo-device line in the kernel configuration file) then alter all references to tun0 below to reflect whichever device number you are using. The easiest way to make sure that the tun0 device is - configured correctly is to re-make it. To do this, execute the + configured correctly is to re-make it. To do this, execute the following commands: @@ -226,10 +226,10 @@ tun0: flags=8010<POINTOPOINT,MULTICAST> mtu 1500 Name Resolution Configuration The resolver is the part of the system that turns IP addresses - into hostnames and vice versa. It can be configured to look for + into hostnames and vice versa. It can be configured to look for maps that describe IP to hostname mappings in one of two places. The first is a file called /etc/hosts - (man 5 hosts). The second is the + (man 5 hosts). The second is the Internet Domain Name Service (DNS), a distributed data base, the discussion of which is beyond the scope of this document. @@ -238,8 +238,8 @@ tun0: flags=8010<POINTOPOINT,MULTICAST> mtu 1500 The resolver is a set of system calls that do the name mappings, but you have to tell them where to find their - information. You do this by first editing the file - /etc/host.conf. Do not call this file + information. You do this by first editing the file + /etc/host.conf. Do not call this file /etc/hosts.conf (note the extra s) as the results can be confusing. @@ -265,8 +265,8 @@ bind Edit the <filename>/etc/hosts</filename>(5) file This file should contain the IP addresses and names of - machines on your network. At a bare minimum it should contain - entries for the machine which will be running ppp. Assuming that + machines on your network. At a bare minimum it should contain + entries for the machine which will be running ppp. Assuming that your machine is called foo.bar.com with the IP address 10.0.0.1, /etc/hosts should contain: @@ -276,8 +276,8 @@ bind 10.0.0.1 foo.bar.com foo The first line defines the alias localhost as a synonym - for the current machine. Regardless of your own IP address, the - IP address for this line should always be 127.0.0.1. The second + for the current machine. Regardless of your own IP address, the + IP address for this line should always be 127.0.0.1. The second line maps the name foo.bar.com (and the shorthand foo) to the IP address 10.0.0.1. @@ -290,8 +290,8 @@ bind Edit the <filename>/etc/resolv.conf</filename> file /etc/resolv.conf tells the resolver how - to behave. If you are running your own DNS, you may leave this - file empty. Normally, you will need to enter the following + to behave. If you are running your own DNS, you may leave this + file empty. Normally, you will need to enter the following line(s): @@ -302,15 +302,15 @@ domain bar.com The x.x.x.x and y.y.y.y addresses are those given to you - by your ISP. Add as many nameserver lines as your ISP - provides. The domain line defaults to your hostname's - domain, and is probably unnecessary. Refer to the resolv.conf + by your ISP. Add as many nameserver lines as your ISP + provides. The domain line defaults to your hostname's + domain, and is probably unnecessary. Refer to the resolv.conf manual page for details of other possible entries in this file. If you are running PPP version 2 or greater, the enable dns command will tell PPP to request that your ISP - confirms the nameserver values. If your ISP supplies different + confirms the nameserver values. If your ISP supplies different addresses (or if there are no nameserver lines in /etc/resolv.conf), PPP will rewrite the file with the ISP-supplied values. @@ -322,12 +322,12 @@ domain bar.com Both user ppp and pppd (the kernel level implementation of PPP) use configuration files located in the - /etc/ppp directory. The sample configuration + /etc/ppp directory. The sample configuration files provided are a good reference for user ppp, so don't delete them. Configuring ppp requires that you edit a number of files, - depending on your requirements. What you put in them depends to + depending on your requirements. What you put in them depends to some extent on whether your ISP allocates IP addresses statically (i.e., you get given one IP address, and always use that one) or dynamically (i.e., your IP address can be different for each PPP @@ -338,7 +338,7 @@ domain bar.com PPP and Static IP addresses You will need to create a configuration file called - /etc/ppp/ppp.conf. It should look similar + /etc/ppp/ppp.conf. It should look similar to the example below. @@ -368,7 +368,7 @@ domain bar.com Line 1: - Identifies the default entry. Commands in this + Identifies the default entry. Commands in this entry are executed automatically when ppp is run. @@ -377,7 +377,7 @@ domain bar.com Identifies the device to which the modem is - connected. COM1: is /dev/cuaa0 and + connected. COM1: is /dev/cuaa0 and COM2: is /dev/cuaa1. @@ -385,7 +385,7 @@ domain bar.com Line 3: - Sets the speed you want to connect at. If 115200 + Sets the speed you want to connect at. If 115200 doesn't work (it should with any reasonably new modem), try 38400 instead. @@ -394,9 +394,9 @@ domain bar.com Line 4: - The dial string. User PPP uses an expect-send + The dial string. User PPP uses an expect-send syntax similar to the chat8 - program. Refer to the manual page for information on + program. Refer to the manual page for information on the features of this language. @@ -412,15 +412,15 @@ domain bar.com Line 6: - Sets the phone number for this provider. Multiple + Sets the phone number for this provider. Multiple phone numbers may be specified using the : or | - character as a separator. The difference between these - spearators is described in the ppp manual page. To + character as a separator. The difference between these + spearators is described in the ppp manual page. To summarize, if you want to rotate through the numbers, - use the :. If you want to always attempt to dial + use the :. If you want to always attempt to dial the first number first and only use the other numbers if - the first number fails, use the |. Always quote the + the first number fails, use the |. Always quote the entire set of phone numbers as shown. @@ -429,7 +429,7 @@ domain bar.com The login string is of the same chat-like syntax as - the dial string. In this example, the string works for + the dial string. In this example, the string works for a service whose login session looks like this: @@ -441,13 +441,13 @@ protocol: ppp You will need to alter this script to suit your own - needs. When you write this script for the first time, + needs. When you write this script for the first time, you should enable “chat” logging to ensure that the conversation is going as expected. If you're using PAP or CHAP, there will be no login at this point, so your login string can be left - blank. See + blank. See PAP and CHAP authentication for further details. @@ -457,8 +457,8 @@ protocol: ppp Sets the default timeout (in seconds) for the - connection. Here, the connection will be closed - automatically after 300 seconds of inactivity. If you + connection. Here, the connection will be closed + automatically after 300 seconds of inactivity. If you never want to timeout, set this value to zero. @@ -466,18 +466,18 @@ protocol: ppp Line 9: - Sets the interface addresses. The string x.x.x.x + Sets the interface addresses. The string x.x.x.x should be replaced by the IP address that your provider - has allocated to you. The string y.y.y.y should be + has allocated to you. The string y.y.y.y should be replaced by the IP address that your ISP indicated for - their gateway (the machine to which you connect). If + their gateway (the machine to which you connect). If your ISP hasn't given you a gateway address, use - 10.0.0.2/0. If you need + 10.0.0.2/0. If you need to use a “guessed” address, make sure that you create an entry in /etc/ppp/ppp.linkup as per the instructions for PPP and Dynamic - IP addresses. If this line is omitted, ppp cannot + IP addresses. If this line is omitted, ppp cannot run in or mode. @@ -486,9 +486,9 @@ protocol: ppp Line 10: - Adds a default route to your ISPs gateway. The + Adds a default route to your ISPs gateway. The special word HISADDR is replaced with - the gateway address specified on line 9. It is + the gateway address specified on line 9. It is important that this line appears after line 9, otherwise HISADDR will not yet be initialized. @@ -501,7 +501,7 @@ protocol: ppp This line tells PPP to ask your ISP to confirm that your - nameserver addresses are correct. If your ISP supports this + nameserver addresses are correct. If your ISP supports this facility, PPP can then update /etc/resolv.conf with the correct nameserver entries. @@ -512,8 +512,8 @@ protocol: ppp It is not necessary to add an entry to ppp.linkup when you have a static IP address as your routing table entries are already correct before - you connect. You may however wish to create an entry to invoke - programs after connection. This is explained later with the + you connect. You may however wish to create an entry to invoke + programs after connection. This is explained later with the sendmail example. Example configuration files can be found in the @@ -526,9 +526,9 @@ protocol: ppp If your service provider does not assign static IP numbers, ppp can be configured to negotiate - the local and remote addresses. This is done by “guessing” an + the local and remote addresses. This is done by “guessing” an IP number and allowing ppp to set it up correctly using the IP - Configuration Protocol (IPCP) after connecting. The + Configuration Protocol (IPCP) after connecting. The ppp.conf configuration is the same as PPP and Static IP addresses, with the following change: @@ -537,7 +537,7 @@ protocol: ppp 9 set ifaddr 10.0.0.1/0 10.0.0.2/0 255.255.255.0 Again, do not include the line numbers, they are just for - reference in this discussion. Indentation of at least one space + reference in this discussion. Indentation of at least one space is required. @@ -545,7 +545,7 @@ protocol: ppp Line 9: The number after the / character is the number - of bits of the address that ppp will insist on. You may + of bits of the address that ppp will insist on. You may wish to use IP numbers more appropriate to your circumstances, but the above example will always work. @@ -553,7 +553,7 @@ protocol: ppp The last argument (0.0.0.0) tells PPP to negotiate using address 0.0.0.0 rather than 10.0.0.1. Do not use + role="ipaddr">10.0.0.1. Do not use 0.0.0.0 as the first argument to set ifaddr as it prevents PPP from setting up an intial route in mode. @@ -566,7 +566,7 @@ protocol: ppp If you are running version 1.x of PPP, uou will also need to create an entry in /etc/ppp/ppp.linkup. ppp.linkup is used after a connection has - been established. At this point, ppp will know what IP + been established. At this point, ppp will know what IP addresses should really be used. The following entry will delete the existing bogus routes, and create correct ones: @@ -583,9 +583,9 @@ protocol: ppp On establishing a connection, ppp will look for an entry in ppp.linkup according to the following rules: First, try to match the same label - as we used in ppp.conf. If that + as we used in ppp.conf. If that fails, look for an entry for the IP number of our - gateway. This entry is a four-octet IP style label. If + gateway. This entry is a four-octet IP style label. If we still haven't found an entry, look for the MYADDR entry. @@ -618,12 +618,12 @@ protocol: ppp /etc/ppp/ppp.linkup.sample for a detailed example. - Version 2 of PPP introduces “sticky routes”. Any + Version 2 of PPP introduces “sticky routes”. Any add or delete lines that contain MYADDR or HISADDR will be remembered, and any time the actual values of MYADDR or HISADDR change, the - routes will be re-applied. This removes the necessity of repeating + routes will be re-applied. This removes the necessity of repeating these lines in ppp.linkup. @@ -635,13 +635,13 @@ protocol: ppp When you configure ppp to receive incoming calls on a machine connected to a LAN, you must decide if you wish to - forward packets to the LAN. If you do, you should allocate the + forward packets to the LAN. If you do, you should allocate the peer an IP number from your LAN's subet, and use the command enable proxy - in your ppp.conf file. You should also + in your ppp.conf file. You should also confirm that the /etc/rc.conf file (this file used to be called /etc/sysconfig) contains the following: @@ -676,7 +676,7 @@ gateway=YES PPP permissions - ppp must normally be run as user id 0. If however you + ppp must normally be run as user id 0. If however you wish to allow ppp to run in server mode as a normal user by executing ppp as described below, that user must be given permission to run ppp by adding them to the @@ -716,7 +716,7 @@ echo "Starting PPP for $IDENT" exec /usr/sbin/ppp -direct $IDENT - This script should be executable. Now make a symbolic + This script should be executable. Now make a symbolic link called ppp-dialup to this script using the following commands: @@ -727,7 +727,7 @@ exec /usr/sbin/ppp -direct $IDENT You should use this script as the shell for all your dialup ppp users. This is an example from /etc/password for - a dialup PPP user with username pchilds. (remember don't + a dialup PPP user with username pchilds. (remember don't directly edit the password file, use vipw) @@ -766,7 +766,7 @@ pchilds:*:1011:300:Peter Childs PPP:/home/ppp:/etc/ppp/ppp-dialupEach of these users dialup accounts should have their - shell set to the symbolic link created above. (ie. mary's + shell set to the symbolic link created above. (ie. mary's shell should be /etc/ppp/ppp-mary). @@ -796,9 +796,9 @@ ttyd1: The default: section is - loaded for each session. For each dialup line enabled in + loaded for each session. For each dialup line enabled in /etc/ttys create an entry similar to the - one for ttyd0: above. Each line + one for ttyd0: above. Each line should get a unique IP address from your pool of IP addresses for dynamic users. @@ -809,7 +809,7 @@ ttyd1: Along with the contents of the sample /etc/ppp/ppp.conf above you should add a - section for each of the statically assigned dialup users. We + section for each of the statically assigned dialup users. We will continue with our fred, sam, and mary example. @@ -824,7 +824,7 @@ mary: The file /etc/ppp/ppp.linkup should also contain routing information for each static IP user if - required. The line below would add a route for the 203.14.101.0 class C via the client's ppp link. @@ -878,7 +878,7 @@ exec /usr/sbin/ppp -direct pap$IDENT For each dialup line enabled in /etc/ttys create a corresponding entry - in /etc/ppp/ppp.conf. This will + in /etc/ppp/ppp.conf. This will happily co-exist with the definitions we created above. @@ -901,7 +901,7 @@ enable passwdauth If you wish to assign some users a static IP number, you can specify the number as the third argument in - /etc/ppp/ppp.secret. See + /etc/ppp/ppp.secret. See /etc/ppp/ppp.secret.sample for examples. @@ -943,7 +943,7 @@ set nbns 203.14.100.5 Some ISPs set their system up so that the authentication part of your connection is done using either of the PAP or CHAP - authentication mechanisms. If this is the case, your ISP will + authentication mechanisms. If this is the case, your ISP will not give a login: prompt when you connect, but will start talking PPP immediately. @@ -964,7 +964,7 @@ set nbns 203.14.100.5 13 set authkey MyPassword As always, do not include the line numbers, they are just - for reference in this discussion. Indentation of at least one + for reference in this discussion. Indentation of at least one space is required. @@ -972,7 +972,7 @@ set nbns 203.14.100.5 Line 7: Your ISP will not normally require that you log into - the server if you're using PAP or CHAP. You must + the server if you're using PAP or CHAP. You must therefore disable your "set login" string. @@ -980,7 +980,7 @@ set nbns 203.14.100.5 Line 12: - This line specifies your PAP/CHAP user name. You + This line specifies your PAP/CHAP user name. You will need to insert the correct value for MyUserName. @@ -989,8 +989,8 @@ set nbns 203.14.100.5 Line 13: - This line specifies your PAP/CHAP password. You - will need to insert the correct value for MyPassword. You may want to add an + This line specifies your PAP/CHAP password. You + will need to insert the correct value for MyPassword. You may want to add an additional line @@ -1011,7 +1011,7 @@ set nbns 203.14.100.5 It is possible to talk to the ppp program while it is running in the background, but only if a suitable diagnostic port has - been set up. To do this, add the following line to your + been set up. To do this, add the following line to your configuration: @@ -1019,7 +1019,7 @@ set server /var/run/ppp-tun%d DiagnosticPassword 0177 This will tell PPP to listen to the specified unix-domain socket, asking clients for the specified password before allowing - access. The %d in the name is replaced with teh + access. The %d in the name is replaced with teh tun device number that is in use. Once a socket has been set up, the @@ -1033,7 +1033,7 @@ set server /var/run/ppp-tun%d DiagnosticPassword 0177 Final system configuration You now have ppp configured, but there are a few more things - to do before it is ready to work. They all involve editing the + to do before it is ready to work. They all involve editing the /etc/rc.conf file (was /etc/sysconfig). @@ -1047,7 +1047,7 @@ hostname=foo.bar.com name, it's probably best that you use this name as your host name. - Look for the network_interfaces variable. If you want to + Look for the network_interfaces variable. If you want to configure your system to dial your ISP on demand, make sure the tun0 device is added to the list, otherwise remove it. @@ -1057,15 +1057,15 @@ network_interfaces="lo0 tun0" ifconfig_tun0= The ifconfig_tun0 variable should be empty, and a file called /etc/start_if.tun0 should - be created. This file should contain the line + be created. This file should contain the line ppp -auto mysystem This script is executed at network configuration time, - starting your ppp daemon in automatic mode. If you have a LAN + starting your ppp daemon in automatic mode. If you have a LAN for which this machine is a gateway, you may also wish to use - the switch. Refer to the manual page + the switch. Refer to the manual page for further details. @@ -1082,7 +1082,7 @@ router=NO (/etc/sysconfig) It is probably worth your while ensuring that the sendmail_flags line does not include the option, otherwise sendmail will attempt to do a network lookup every now - and then, possibly causing your machine to dial out. You may + and then, possibly causing your machine to dial out. You may try: @@ -1107,7 +1107,7 @@ sendmail_flags="-bd" 4 !bg sendmail -bd -q30m If you don't like this, it is possible to set up a “dfilter” - to block SMTP traffic. Refer to the sample files for further + to block SMTP traffic. Refer to the sample files for further details. All that is left is to reboot the machine. @@ -1152,7 +1152,7 @@ sendmail_flags="-bd" Create an entry in - /etc/ppp/ppp.conf. The pmdemand example should suffice for + /etc/ppp/ppp.conf. The pmdemand example should suffice for most ISPs. @@ -1200,7 +1200,7 @@ sendmail_flags="-bd" Create an entry in - /etc/ppp/ppp.conf. The direct-server example should + /etc/ppp/ppp.conf. The direct-server example should suffice. @@ -1320,7 +1320,7 @@ defaultroute # put this if you want that PPP server will be your - Now your computer is connected with PPP. If the connection + Now your computer is connected with PPP. If the connection fails for some reasons you can add the option to the /etc/ppp/options file and check messages on the console to track the problem @@ -1351,7 +1351,7 @@ pppd /dev/tty01 19200 /etc/ppp/kermit.dial is kermit script that dials and makes all necessary authorization on the remote - host. (Example of such script is attached to the end of this + host. (Example of such script is attached to the end of this document) Use the following /etc/ppp/pppdown script @@ -1564,8 +1564,8 @@ echo \13 exit This /etc/ppp/kermit.dial script is used - for dialing and authorizing on remote host. You will need to - customize it for your needs. Put your login and password in this + for dialing and authorizing on remote host. You will need to + customize it for your needs. Put your login and password in this script, also you will need to change input statement depending on responses from your modem and remote host. @@ -1695,14 +1695,14 @@ exit 1 1995. The following is one way to set up a FreeBSD machine for SLIP on - a static host network. For dynamic hostname assignments (i.e., your + a static host network. For dynamic hostname assignments (i.e., your address changes each time you dial up), you probably need to do something much fancier. - First, determine which serial port your modem is connected to. I + First, determine which serial port your modem is connected to. I have a symbolic link to /dev/modem from /dev/cuaa1, and only use the modem name in my configuration - files. It can become quite cumbersome when you need to fix a bunch + files. It can become quite cumbersome when you need to fix a bunch of files in /etc and .kermrc's all over the system! @@ -1714,7 +1714,7 @@ exit 1 Make sure you have -pseudo-device sl 1 in your kernel's config file. It is included in +pseudo-device sl 1 in your kernel's config file. It is included in the GENERIC kernel, so this will not be a problem unless you deleted it. @@ -1727,7 +1727,7 @@ pseudo-device sl 1 in your kernel's config file. It is i Add your home machine, the gateway and nameservers to - your /etc/hosts file. Mine looks like + your /etc/hosts file. Mine looks like this: @@ -1744,12 +1744,12 @@ pseudo-device sl 1 in your kernel's config file. It is i Make sure you have before in your - /etc/host.conf. Otherwise, funny things + /etc/host.conf. Otherwise, funny things may happen. - Edit the file /etc/rc.conf. Note + Edit the file /etc/rc.conf. Note that you should edit the file /etc/sysconfig instead if you are running FreeBSD previous to version 2.2.2. @@ -1805,14 +1805,14 @@ domain HIP.Berkeley.EDU nameserver 128.32.136.9 nameserver 128.32.136.12 - As you can see, these set up the nameserver hosts. Of + As you can see, these set up the nameserver hosts. Of course, the actual domain names and addresses depend on your environment. Set the password for root and toor (and any other - accounts that does not have a password). Use passwd, do not + accounts that does not have a password). Use passwd, do not edit the /etc/passwd or /etc/master.passwd files! @@ -1835,8 +1835,8 @@ nameserver 128.32.136.12 Dial up, type slip at the prompt, enter your machine - name and password. The things you need to enter depends on - your environment. I use kermit, with a script like this: + name and password. The things you need to enter depends on + your environment. I use kermit, with a script like this: # kermit setup @@ -1854,13 +1854,13 @@ output silvia\x0d, input 10 Password:, if failure stop, - output ***\x0d, echo \x0aCONNECTED\x0a (of course, you have to change the hostname and password to fit - yours). Then you can just type slip from the kermit + yours). Then you can just type slip from the kermit prompt to get connected. Leaving your password in plain text anywhere in the - filesystem is generally a BAD idea. Do it at your own - risk. I am just too lazy. + filesystem is generally a BAD idea. Do it at your own + risk. I am just too lazy. @@ -1891,16 +1891,16 @@ output ***\x0d, echo \x0aCONNECTED\x0a &prompt.root; kill -INT `cat /var/run/slattach.modem.pid` (as root) - to kill slattach. Then go back to kermit (fg if you suspended + to kill slattach. Then go back to kermit (fg if you suspended it) and exit from it (q). The slattach man page says you have to use ifconfig sl0 down to mark the interface down, but this does not seem to make any - difference for me. (ifconfig sl0 reports the same + difference for me. (ifconfig sl0 reports the same thing.) Some times, your modem might refuse to drop the carrier (mine - often does). In that case, simply start kermit and quit it again. + often does). In that case, simply start kermit and quit it again. It usually goes out on the second try. @@ -1908,7 +1908,7 @@ output ***\x0d, echo \x0aCONNECTED\x0a Troubleshooting - If it does not work, feel free to ask me. The things that + If it does not work, feel free to ask me. The things that people tripped over so far: @@ -1926,7 +1926,7 @@ output ***\x0d, echo \x0aCONNECTED\x0a Try ifconfig sl0 to see your - interface status. I get: + interface status. I get: &prompt.root; ifconfig sl0 @@ -1938,7 +1938,7 @@ sl0: flags=10<POINTOPOINT> Also, netstat -r will give the routing table, in case you get the "no route to host" - messages from ping. Mine looks like: + messages from ping. Mine looks like: &prompt.root; netstat -r @@ -1974,17 +1974,17 @@ silvia.HIP.Berke localhost.Berkeley UGH 34 47641234 lo0 - 0.438 This document provides suggestions for setting up SLIP Server services on a FreeBSD system, which typically means configuring your system to automatically startup connections upon login for remote - SLIP clients. The author has written this document based on his + SLIP clients. The author has written this document based on his experience; however, as your system and needs may be different, this document may not answer all of your questions, and the author cannot be responsible if you damage your system or lose data due to attempting to follow the suggestions here. This guide was originally written for SLIP Server services on a - FreeBSD 1.x system. It has been modified to reflect changes in the + FreeBSD 1.x system. It has been modified to reflect changes in the pathnames and the removal of the SLIP interface compression flags in early versions of FreeBSD 2.X, which appear to be the only major - changes between FreeBSD versions. If you do encounter mistakes in + changes between FreeBSD versions. If you do encounter mistakes in this document, please email the author with enough information to help correct the problem. @@ -1993,10 +1993,10 @@ silvia.HIP.Berke localhost.Berkeley UGH 34 47641234 lo0 - 0.438 Prerequisites This document is very technical in nature, so background - knowledge is required. It is assumed that you are familiar with + knowledge is required. It is assumed that you are familiar with the TCP/IP network protocol, and in particular, network and node addressing, network address masks, subnetting, routing, and - routing protocols, such as RIP. Configuring SLIP services on a + routing protocols, such as RIP. Configuring SLIP services on a dial-up server requires a knowledge of these concepts, and if you are not familiar with them, please read a copy of either Craig Hunt's TCP/IP Network Administration @@ -2006,14 +2006,14 @@ silvia.HIP.Berke localhost.Berkeley UGH 34 47641234 lo0 - 0.438 It is further assumed that you have already setup your modem(s) and configured the appropriate system files to allow - logins through your modems. If you have not prepared your system + logins through your modems. If you have not prepared your system for this yet, please see the tutorial for configuring dialup services; if you have a World-Wide Web browser available, browse the list of tutorials at http://www.freebsd.org/; otherwise, check the place where you found this document for a document named dialup.txt or something - similar. You may also want to check the manual pages for + similar. You may also want to check the manual pages for sio4 for information on the serial port device driver and ttys5, gettytab5, @@ -2032,7 +2032,7 @@ silvia.HIP.Berke localhost.Berkeley UGH 34 47641234 lo0 - 0.438 works as follows: a SLIP user dials up your FreeBSD SLIP Server system and logs in with a special SLIP login ID that uses /usr/sbin/sliplogin as the special user's - shell. The sliplogin program + shell. The sliplogin program browses the file /etc/sliphome/slip.hosts to find a matching line for the special user, and if it finds a match, connects the serial line to an available SLIP interface and @@ -2078,7 +2078,7 @@ Shelmerg dc-slip sl-helmer 0xfffffc00 autocomp to set the local IP address (dc-slip), remote IP address (sl-helmer), network mask for the SLIP interface (0xfffffc00), and any additional - flags (autocomp). If something + flags (autocomp). If something goes wrong, sliplogin usually logs good informational messages via the daemon syslog facility, which usually goes into /var/log/messages @@ -2115,7 +2115,7 @@ sl1* 296 <Link> 0 0 0 0 The sl0 and sl1 interfaces shown in netstat -i's output indicate that there are - two SLIP interfaces built into the kernel. (The asterisks after + two SLIP interfaces built into the kernel. (The asterisks after the sl0 and sl1 indicate that the interfaces are “down”.) @@ -2207,7 +2207,7 @@ pseudo-device sl 2 domain name service, depending on your specifications in /etc/host.conf), and I believe the network mask may be a name that can be resolved by a lookup into - /etc/networks. On a sample system, + /etc/networks. On a sample system, /etc/sliphome/slip.hosts looks like this: @@ -2260,7 +2260,7 @@ Shelmerg dc-slip sl-helmerg 0xfffffc00 autocompslips-prereqs section @@ -2269,7 +2269,7 @@ Shelmerg dc-slip sl-helmerg 0xfffffc00 autocompIf you are going to use a separate subnet for your SLIP clients, you will need to allocate the subnet number out of your assigned IP network number and assign each of your SLIP client's - IP numbers out of that subnet. Then, you will probably either + IP numbers out of that subnet. Then, you will probably either need to configure a static route to the SLIP subnet via your SLIP server on your nearest IP router, or install gated on your FreeBSD SLIP server and configure it to talk the appropriate routing protocols to your @@ -2331,7 +2331,7 @@ Shelmerg dc-slip sl-helmerg 0xfffffc00 autocompThe additional line in this slip.login, arp -s $5 00:11:22:33:44:55 pub, creates - an ARP entry in the SLIP server's ARP table. This ARP entry + an ARP entry in the SLIP server's ARP table. This ARP entry causes the SLIP server to respond with the SLIP server's Ethernet MAC address whenever a another IP node on the Ethernet asks to speak to the SLIP client's IP address. @@ -2441,7 +2441,7 @@ Shelmerg dc-slip sl-helmerg 0xfffffc00 autocompAdding static routes to your nearest default routers can be troublesome (or impossible, if you do not have authority to do - so...). If you have a multiple-router network in your + so...). If you have a multiple-router network in your organization, some routers, such as Cisco and Proteon, may not only need to be configured with the static route to the SLIP subnet, but also need to be told which static routes to tell @@ -2461,7 +2461,7 @@ Shelmerg dc-slip sl-helmerg 0xfffffc00 autocompgated from the ports collection or retrieve and build it yourself from the GateD anonymous ftp site; I believe the current version as of this writing is gated-R3_5Alpha_8.tar.Z, which includes support for FreeBSD “out-of-the-box”. Complete information and documentation on gated is available on the Web starting at the Merit GateD Consortium. Compile and install it, and then write a /etc/gated.conf file to configure your gated; here is a sample, similar to what the author used on a FreeBSD SLIP server: + URL="ftp://ftp.gated.merit.edu/research.and.development/gated/">the GateD anonymous ftp site; I believe the current version as of this writing is gated-R3_5Alpha_8.tar.Z, which includes support for FreeBSD “out-of-the-box”. Complete information and documentation on gated is available on the Web starting at the Merit GateD Consortium. Compile and install it, and then write a /etc/gated.conf file to configure your gated; here is a sample, similar to what the author used on a FreeBSD SLIP server: # @@ -2508,10 +2508,10 @@ import proto rip interface ed { Ethernet; if you are using a different Ethernet driver than the ed driver, you will need to change the references to the ed interface - appropriately. This sample file also sets up tracing to + appropriately. This sample file also sets up tracing to /var/tmp/gated.output for debugging gated's activity; you can - certainly turn off the tracing options if gated works OK for you. You will need to + certainly turn off the tracing options if gated works OK for you. You will need to change the xxx.xxx.yy's into the network address of your own SLIP subnet (be sure to change the net mask in the proto direct @@ -2522,7 +2522,7 @@ import proto rip interface ed { to run gated in place of routed on your FreeBSD system; change the routed/gated startup parameters in /etc/netstart as appropriate for your - system. Please see the manual page for gated for information on gated's command-line parameters. + system. Please see the manual page for gated for information on gated's command-line parameters. diff --git a/en_US.ISO8859-1/books/handbook/printing/chapter.sgml b/en_US.ISO8859-1/books/handbook/printing/chapter.sgml index 7756117e3a..94d1196547 100644 --- a/en_US.ISO8859-1/books/handbook/printing/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/printing/chapter.sgml @@ -6,8 +6,8 @@ In order to use printers with FreeBSD, you will need to set them up to work with the Berkeley line printer spooling system, also known - as the LPD spooling system. It is the standard printer control system - in FreeBSD. This section introduces the LPD spooling system, often + as the LPD spooling system. It is the standard printer control system + in FreeBSD. This section introduces the LPD spooling system, often simply called LPD. If you are already familiar with LPD or another printer spooling @@ -19,7 +19,7 @@ What the Spooler Does - LPD controls everything about a host's printers. It is + LPD controls everything about a host's printers. It is responsible for a number of things: @@ -81,7 +81,7 @@ If you are the sole user of your system, you may be wondering why you should bother with the spooler when you do not need access - control, header pages, or printer accounting. While it is possible + control, header pages, or printer accounting. While it is possible to enable direct access to a printer, you should use the spooler anyway since @@ -97,7 +97,7 @@ LPD can conveniently run a job to be printed through filters to add date/time headers or convert a special file format (such as a TeX DVI file) into a format the printer will - understand. You will not have to do these steps manually. + understand. You will not have to do these steps manually. @@ -117,7 +117,7 @@ Setting Up the Spooling System To use printers with the LPD spooling system, you will need to - set up both your printer hardware and the LPD software. This + set up both your printer hardware and the LPD software. This document describes two levels of setup: @@ -146,7 +146,7 @@ Simple Printer Setup This section tells how to configure printer hardware and the - LPD software to use the printer. It teaches the basics: + LPD software to use the printer. It teaches the basics: @@ -172,8 +172,8 @@ With Networked Data Stream Interaces. Although this section is called “Simple Printer Setup,” it is - actually fairly complex. Getting the printer to work with your - computer and the LPD spooler is the hardest part. The advanced + actually fairly complex. Getting the printer to work with your + computer and the LPD spooler is the hardest part. The advanced options like header pages and accounting are fairly easy once you get the printer working. @@ -182,7 +182,7 @@ Hardware Setup This section tells about the various ways you can connect a - printer to your PC. It talks about the kinds of ports and cables, + printer to your PC. It talks about the kinds of ports and cables, and also the kernel configuration you may need to enable FreeBSD to speak to the printer. @@ -202,9 +202,9 @@ Serial interfaces use a serial - port on your computer to send data to the printer. Serial + port on your computer to send data to the printer. Serial interfaces are common in the computer industry and cables - are readily available and also easy to construct. Serial + are readily available and also easy to construct. Serial interfaces sometimes need special cables and might require you to configure somewhat complex communications options. @@ -212,9 +212,9 @@ Parallel interfaces use a parallel port on your computer to send data to the - printer. Parallel interfaces are common in the PC market. + printer. Parallel interfaces are common in the PC market. Cables are readily available but more difficult to - construct by hand. There are usually no communications + construct by hand. There are usually no communications options with parallel interfaces, making their configuration exceedingly simple. @@ -227,26 +227,26 @@ In general, serial interfaces are slower than parallel - interfaces. Parallel interfaces usually offer just one-way + interfaces. Parallel interfaces usually offer just one-way communication (computer to printer) while serial gives you - two-way. Many newer parallel ports can also receive data from + two-way. Many newer parallel ports can also receive data from the printer, but only few printers need to send data back to the - computer. And FreeBSD does not support two-way parallel + computer. And FreeBSD does not support two-way parallel communication yet. Usually, the only time you need two-way communication with - the printer is if the printer speaks PostScript. PostScript - printers can be very verbose. In fact, PostScript jobs are + the printer is if the printer speaks PostScript. PostScript + printers can be very verbose. In fact, PostScript jobs are actually programs sent to the printer; they need not produce paper at all and may return results directly to the computer. PostScript also uses two-way communication to tell the computer about problems, such as errors in the PostScript program or - paper jams. Your users may be appreciative of such information. + paper jams. Your users may be appreciative of such information. Furthermore, the best way to do effective accounting with a PostScript printer requires two-way communication: you ask the printer for its page count (how many pages it has printed in its lifetime), then send the user's job, then ask again for its page - count. Subtract the two values and you know how much paper to + count. Subtract the two values and you know how much paper to charge the user. So, which interface should you use? @@ -262,9 +262,9 @@ If you do not need two-way communication and can pick - parallel or serial, prefer the parallel interface. It + parallel or serial, prefer the parallel interface. It keeps a serial port free for other peripherals—such as a - terminal or a modem—and is faster most of the time. It + terminal or a modem—and is faster most of the time. It is also easier to configure. @@ -281,11 +281,11 @@ Parallel Ports To hook up a printer using a parallel interface, connect - the Centronics cable between the printer and the computer. The + the Centronics cable between the printer and the computer. The instructions that came with the printer, the computer, or both should give you complete guidance. - Remember which parallel port you used on the computer. The + Remember which parallel port you used on the computer. The first parallel port is /dev/lpt0 to FreeBSD; the second is /dev/lpt1, and so on. @@ -295,7 +295,7 @@ Serial Ports To hook up a printer using a serial interface, connect the - proper serial cable between the printer and the computer. The + proper serial cable between the printer and the computer. The instructions that came with the printer, the computer, or both should give you complete guidance. @@ -307,7 +307,7 @@ A modem cable connects each pin of the connector on one end of the cable straight through to its corresponding pin of the connector on the other - end. This type of cable is also known as a “DTE-to-DCE” + end. This type of cable is also known as a “DTE-to-DCE” cable. @@ -315,7 +315,7 @@ A null-modem cable connects some pins straight through, swaps others (send data to receive data, for example), and shorts some internally in each - connector hood. This type of cable is also known as a + connector hood. This type of cable is also known as a “DTE-to-DTE” cable. @@ -330,13 +330,13 @@ You should also set up the communications parameters for the printer, usually through front-panel controls or DIP switches on - the printer. Choose the highest bps (bits per second, sometimes + the printer. Choose the highest bps (bits per second, sometimes baud rate) rate that both your computer and - the printer can support. Choose 7 or 8 data bits; none, even, - or odd parity; and 1 or 2 stop bits. Also choose a flow control + the printer can support. Choose 7 or 8 data bits; none, even, + or odd parity; and 1 or 2 stop bits. Also choose a flow control protocol: either none, or XON/XOFF (also known as “in-band” or “software”) - flow control. Remember these settings for the software + flow control. Remember these settings for the software configuration that follows. @@ -368,13 +368,13 @@ Test if the operating system can send data to the - printer. Section Checking Printer Communications gives some + printer. Section Checking Printer Communications gives some suggestions on how to do this. Set up LPD for the printer by modifying the file - /etc/printcap. Section /etc/printcap. Section The /etc/printcap File shows you how. @@ -385,8 +385,8 @@ Kernel Configuration The operating system kernel is compiled to work with a - specific set of devices. The serial or parallel interface for - your printer is a part of that set. Therefore, it might be + specific set of devices. The serial or parallel interface for + your printer is a part of that set. Therefore, it might be necessary to add support for an additional serial or parallel port if your kernel is not already configured for one. @@ -398,7 +398,7 @@ Where N is the - number of the serial port, starting from zero. If you see + number of the serial port, starting from zero. If you see output similar to the following: @@ -416,7 +416,7 @@ sio2: type 16550A Where N is the - number of the parallel port, starting from zero. If you see + number of the parallel port, starting from zero. If you see output similar to the following @@ -428,7 +428,7 @@ sio2: type 16550A port you are using for the printer. To add support for a serial port, see the section on kernel - configuration. To add support for a parallel port, see that + configuration. To add support for a parallel port, see that section and the section that follows. @@ -439,7 +439,7 @@ sio2: type 16550A Even though the kernel may support communication along a serial or parallel port, you will still need a software interface through which programs running on the system can - send and receive data. That is what entries in the + send and receive data. That is what entries in the /dev directory are for. To add a /dev @@ -450,7 +450,7 @@ sio2: type 16550A Become root with the su - command. Enter the root password when prompted. + command. Enter the root password when prompted. @@ -469,7 +469,7 @@ sio2: type 16550A Where port is the device entry for the - port you want to make. Use lpt0 for the first parallel port, + port you want to make. Use lpt0 for the first parallel port, lpt1 for the second, and so on; use ttyd0 for the first serial port, ttyd1 @@ -503,7 +503,7 @@ sio2: type 16550A The interrupt-driven method is - the default with the GENERIC kernel. With this method, + the default with the GENERIC kernel. With this method, the operating system uses an IRQ line to determine when the printer is ready for data. @@ -511,7 +511,7 @@ sio2: type 16550A The polled method directs the operating system to repeatedly ask the printer if it is - ready for more data. When it responds ready, the kernel + ready for more data. When it responds ready, the kernel sends more data. @@ -519,7 +519,7 @@ sio2: type 16550A The interrupt-driven method is somewhat faster but uses up - a precious IRQ line. You should use whichever one + a precious IRQ line. You should use whichever one works. You can set the communications mode in two ways: by @@ -532,9 +532,9 @@ sio2: type 16550A - Edit your kernel configuration file. Look for or - add an lpt0 entry. If you - are setting up the second parallel port, use lpt1 instead. Use lpt2 for the third port, and so + Edit your kernel configuration file. Look for or + add an lpt0 entry. If you + are setting up the second parallel port, use lpt1 instead. Use lpt2 for the third port, and so on. @@ -562,8 +562,8 @@ device lpt0 at isa? port? tty vector lptintr - Save the file. Then configure, build, and install - the kernel, then reboot. See Save the file. Then configure, build, and install + the kernel, then reboot. See kernel configuration for more details. @@ -601,7 +601,7 @@ device lpt0 at isa? port? tty vector lptintr You could put these commands in your /etc/rc.local file to set the mode each - time your system boots. See lptcontrol8 for more information. + time your system boots. See lptcontrol8 for more information. @@ -610,16 +610,16 @@ device lpt0 at isa? port? tty vector lptintr Before proceeding to configure the spooling system, you should make sure the operating system can successfully send - data to your printer. It is a lot easier to debug printer + data to your printer. It is a lot easier to debug printer communication and the spooling system separately. - To test the printer, we will send some text to it. For + To test the printer, we will send some text to it. For printers that can immediately print characters sent to them, the program lptest is perfect: it generates all 96 printable ASCII characters in 96 lines. For a PostScript (or other language-based) printer, we - will need a more sophisticated test. A small PostScript + will need a more sophisticated test. A small PostScript program, such as the following, will suffice: @@ -633,7 +633,7 @@ showpage When this document refers to a printer language, I am assuming a language like PostScript, and not Hewlett - Packard's PCL. Although PCL has great functionality, you can + Packard's PCL. Although PCL has great functionality, you can intermingle plain text with its escape sequences. PostScript cannot directly print plain text, and that is the kind of printer language for which we must make special @@ -664,7 +664,7 @@ showpage If the printer can print plain text, then use - lptest. Type: + lptest. Type: &prompt.root; lptest > /dev/lptN @@ -677,7 +677,7 @@ showpage If the printer understands PostScript or other printer language, then send a small - program to the printer. Type: + program to the printer. Type: &prompt.root; cat > /dev/lptN @@ -686,7 +686,7 @@ showpage Then, line by line, type the program carefully as you cannot edit a line once you have pressed RETURN - or ENTER. When you have finished entering the + or ENTER. When you have finished entering the program, press CONTROL+D, or whatever your end of file key is. @@ -708,7 +708,7 @@ showpage - You should see something print. Do not worry if the + You should see something print. Do not worry if the text does not look right; we will fix such things later. @@ -754,7 +754,7 @@ printer:dv=/dev/ttyd2:br#19200:pa=none Connect to the printer with - tip. Type: + tip. Type: &prompt.root; tip printer @@ -772,7 +772,7 @@ printer:dv=/dev/ttyd2:br#19200:pa=none If the printer can print plain text, then use - lptest. Type: + lptest. Type: ~$lptest @@ -782,12 +782,12 @@ printer:dv=/dev/ttyd2:br#19200:pa=none If the printer understands PostScript or other printer language, then send a small - program to the printer. Type the program, line + program to the printer. Type the program, line by line, very carefully as backspacing or other editing keys may be - significant to the printer. You may also need to + significant to the printer. You may also need to type a special end-of-file key for the printer - so it knows it received the whole program. For + so it knows it received the whole program. For PostScript printers, press CONTROL+D. Alternatively, you can put the program in a @@ -798,7 +798,7 @@ printer:dv=/dev/ttyd2:br#19200:pa=none Where file is the name of the - file containing the program. After + file containing the program. After tip sends the file, press any required end-of-file key. @@ -809,7 +809,7 @@ printer:dv=/dev/ttyd2:br#19200:pa=none - You should see something print. Do not worry if the + You should see something print. Do not worry if the text does not look right; we will fix that later. @@ -822,17 +822,17 @@ printer:dv=/dev/ttyd2:br#19200:pa=none At this point, your printer should be hooked up, your kernel configured to communicate with it (if necessary), and you - have been able to send some simple data to the printer. Now, we + have been able to send some simple data to the printer. Now, we are ready to configure LPD to control access to your printer. You configure LPD by editing the file - /etc/printcap. The LPD spooling system + /etc/printcap. The LPD spooling system reads this file each time the spooler is used, so updates to the file take immediate effect. The format of the - printcap file is straightforward. Use your favorite text editor to make changes to /etc/printcap. The format is identical to other capability files like /usr/share/misc/termcap and /etc/remote. For complete information about the format, see the cgetent3. + printcap file is straightforward. Use your favorite text editor to make changes to /etc/printcap. The format is identical to other capability files like /usr/share/misc/termcap and /etc/remote. For complete information about the format, see the cgetent3. The simple spooler configuration consists of the following steps: @@ -864,7 +864,7 @@ printer:dv=/dev/ttyd2:br#19200:pa=none with the lp capability; see Identifying the Printer - Device. Also, if the printer is on a serial port, set + Device. Also, if the printer is on a serial port, set up the communication parameters with the fs, fc, xs, and xc capabilities; see Language-based printers, such as PostScript printers, - cannot directly print plain text. The simple setup outlined + cannot directly print plain text. The simple setup outlined above and described in the following sections assumes that if you are installing such a printer you will print only files that the printer can understand. Users often expect that they can print plain text to any of - the printers installed on your system. Programs that interface + the printers installed on your system. Programs that interface to LPD to do their printing usually make the same assumption. If you are installing such a printer and want to be able to print jobs in the printer language and print plain text jobs, you are strongly urged to add an additional step to the simple setup outlined above: install an automatic plain-text-to-PostScript (or other printer language) - conversion program. Section Accommodating Plain Text Jobs on PostScript Printers tells how to do this. @@ -920,8 +920,8 @@ printer:dv=/dev/ttyd2:br#19200:pa=none At least one of the printers specified in the /etc/printcap should have the alias - lp. This is the default - printer's name. If users do not have the PRINTER environment + lp. This is the default + printer's name. If users do not have the PRINTER environment variable nor specify a printer name on the command line of any of the LPD commands, then lp will be the default printer they get to use. @@ -931,8 +931,8 @@ printer:dv=/dev/ttyd2:br#19200:pa=none and model. Once you have picked a name and some common aliases, put - them in the /etc/printcap file. The name - of the printer should start in the leftmost column. Separate + them in the /etc/printcap file. The name + of the printer should start in the leftmost column. Separate each alias with a vertical bar and put a colon after the last alias. @@ -953,7 +953,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4: rattan and has as aliases line, diablo, lp, and Diablo 630 - Line Printer. Since it has the alias lp, it is also the default printer. The + Line Printer. Since it has the alias lp, it is also the default printer. The second is named bamboo, and has as aliases ps, PS, S, @@ -966,15 +966,15 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4: Suppressing Header Pages The LPD spooling system will by default print a - header page for each job. The header + header page for each job. The header page contains the user name who requested the job, the host from which the job came, and the name of the job, in nice - large letters. Unfortunately, all this extra text gets in the + large letters. Unfortunately, all this extra text gets in the way of debugging the simple printer setup, so we will suppress header pages. To suppress header pages, add the sh capability to the entry for the - printer in /etc/printcap. Here is the + printer in /etc/printcap. Here is the example /etc/printcap with sh added: @@ -989,7 +989,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Note how we used the correct format: the first line starts in the leftmost column, and subsequent lines - are indented with a single TAB. Every line in an entry except + are indented with a single TAB. Every line in an entry except the last ends in a backslash character. @@ -1004,7 +1004,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Because of the variable nature of spooling directories, it is customary to put these directories under - /var/spool. It is not necessary to + /var/spool. It is not necessary to backup the contents of spooling directories, either. Recreating them is as simple as running mkdir. @@ -1019,7 +1019,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ However, if you have a lot of printers on your network, you might want to put the spooling directories under a single directory that you reserve just for printing - with LPD. We will do this for our two example printers + with LPD. We will do this for our two example printers rattan and bamboo: @@ -1031,7 +1031,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ If you are concerned about the privacy of jobs that users print, you might want to protect the spooling - directory so it is not publicly accessible. Spooling + directory so it is not publicly accessible. Spooling directories should be owned and be readable, writable, and searchable by user daemon and group daemon, and no one else. We will do this for our example printers: @@ -1046,7 +1046,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Finally, you need to tell LPD about these directories - using the /etc/printcap file. You + using the /etc/printcap file. You specify the pathname of the spooling directory with the sd capability: @@ -1075,8 +1075,8 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ In section Adding /dev Entries for the Ports, we identified which entry in the /dev directory FreeBSD - will use to communicate with the printer. Now, we tell LPD - that information. When the spooling system has a job to + will use to communicate with the printer. Now, we tell LPD + that information. When the spooling system has a job to print, it will open the specified device on behalf of the filter program (which is responsible for passing data to the printer). @@ -1111,7 +1111,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ If the printer you are installing is connected to a parallel port, skip to the section Installing the - Text Filter. Otherwise, be sure to follow the + Text Filter. Otherwise, be sure to follow the instructions in the next section. @@ -1203,11 +1203,11 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ the sgttyb structure; it clears any bits in the fc capability, then sets bits in the fs - capability, then applies the resultant setting. It does the + capability, then applies the resultant setting. It does the same for the local mode bits as well. Let us add to our example printer on the sixth serial - port. We will set the bps rate to 38400. For the flag bits, + port. We will set the bps rate to 38400. For the flag bits, we will set the TANDEM, ANYP, LITOUT, FLUSHO, and PASS8 flags. For the local mode bits, we will set the LITOUT and PASS8 flags: @@ -1223,15 +1223,15 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Installing the Text Filter We are now ready to tell LPD what text filter to use to - send jobs to the printer. A text filter, + send jobs to the printer. A text filter, also known as an input filter, is a - program that LPD runs when it has a job to print. When LPD + program that LPD runs when it has a job to print. When LPD runs the text filter for a printer, it sets the filter's standard input to the job to print, and its standard output to - the printer device specified with the lp capability. The filter is expected + the printer device specified with the lp capability. The filter is expected to read the job from standard input, perform any necessary translation for the printer, and write the results to standard - output, which will get printed. For more information on the + output, which will get printed. For more information on the text filter, see section Filters. @@ -1240,14 +1240,14 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ /bin/cat to send the job to the printer. FreeBSD comes with another filter called lpf that handles backspacing and underlining for printers that might not deal with such - character streams well. And, of course, you can use any other - filter program you want. The filter lpf is described in detail in section + character streams well. And, of course, you can use any other + filter program you want. The filter lpf is described in detail in section lpf: a Text Filter. First, let us make the shell script /usr/local/libexec/if-simple be a simple - text filter. Put the following text into that file with your + text filter. Put the following text into that file with your favorite text editor: @@ -1268,7 +1268,7 @@ exit 2 And then tell LPD to use it by specifying it with the if capability in - /etc/printcap. We will add it to the two + /etc/printcap. We will add it to the two printers we have so far in the example /etc/printcap: @@ -1293,7 +1293,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ You have reached the end of the simple LPD setup. Unfortunately, congratulations are not quite yet in order, since we still have to test the setup and correct any - problems. To test the setup, try printing something. To + problems. To test the setup, try printing something. To print with the LPD system, you use the command lpr, which submits a job for printing. @@ -1317,14 +1317,14 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ (or an alias) specified in /etc/printcap. To test the default printer, type lpr - without any argument. Again, if you are + without any argument. Again, if you are testing a printer that expects PostScript, send a PostScript program in that language instead of using - lptest. You + lptest. You can do so by putting the program in a file and typing lpr file. For a PostScript printer, you should get the results of - the program. If you are using + the program. If you are using lptest, then your results should look like the following: @@ -1336,7 +1336,7 @@ $%&'()*+,-./01234567 To further test the printer, try downloading larger programs (for language-based printers) or running - lptest with different arguments. For example, lptest 80 60 will produce 60 lines of 80 characters each. + lptest with different arguments. For example, lptest 80 60 will produce 60 lines of 80 characters each. If the printer did not work, see the next section, Troubleshooting. @@ -1356,17 +1356,17 @@ $%&'()*+,-./01234567 eject a full sheet. The printer printed the above, but it sat for - awhile and did nothing. In fact, you might have + awhile and did nothing. In fact, you might have needed to press a PRINT REMAINING or FORM FEED button on the printer to get any results to appear. If this is the case, the printer was probably waiting to see if there was any more data for your job - before it printed anything. To fix this problem, you + before it printed anything. To fix this problem, you can have the text filter send a FORM FEED character - (or whatever is necessary) to the printer. This is + (or whatever is necessary) to the printer. This is usually sufficient to have the printer immediately - print any text remaining in its internal buffer. It + print any text remaining in its internal buffer. It is also useful to make sure each print job ends on a full sheet, so the next job does not start somewhere on the middle of the last page of the previous @@ -1404,18 +1404,18 @@ exit 2 You have become another victim of the staircase effect, caused by conflicting interpretations of what characters should - indicate a new-line. UNIX-style operating systems use + indicate a new-line. UNIX-style operating systems use a single character: ASCII code 10, the line feed (LF). MS-DOS, OS/2, and others uses a pair of characters, ASCII code 10 and ASCII code 13 - (the carriage return or CR). Many printers use the + (the carriage return or CR). Many printers use the MS-DOS convention for representing new-lines. When you print with FreeBSD, your text used just - the line feed character. The printer, upon seeing a + the line feed character. The printer, upon seeing a line feed character, advanced the paper one line, but maintained the same horizontal position on the page - for the next character to print. That is what the + for the next character to print. That is what the carriage return is for: to move the location of the next character to print to the left edge of the paper. @@ -1446,7 +1446,7 @@ exit 2 Use the printer's configuration switches or control panel to alter its interpretation of - these characters. Check your printer's manual + these characters. Check your printer's manual to find out how to do this. @@ -1455,16 +1455,16 @@ exit 2 have to reconfigure the printer to use a an interpretation for CR and LF characters that those other operating - systems use. You might prefer one of the + systems use. You might prefer one of the other solutions, below. Have FreeBSD's serial line driver - automatically convert LF to CR+LF. Of course, + automatically convert LF to CR+LF. Of course, this works with printers on serial ports - only. To enable this + only. To enable this feature, set the CRMOD bit in fs capability in the /etc/printcap file for the printer. @@ -1473,18 +1473,18 @@ exit 2 Send an escape code to the printer to have it temporarily treat LF - characters differently. Consult your printer's + characters differently. Consult your printer's manual for escape codes that your printer might - support. When you find the proper escape code, + support. When you find the proper escape code, modify the text filter to send the code first, then send the print job. Here is an example text filter for printers that understand the Hewlett-Packard PCL escape - codes. This filter makes the printer treat LF + codes. This filter makes the printer treat LF characters as a LF and CR; then it sends the job; then it sends a form feed to eject the last - page of the job. It should work with nearly all + page of the job. It should work with nearly all Hewlett Packard printers. @@ -1502,9 +1502,9 @@ exit 2 Here is an example /etc/printcap from a host - called orchid. It has a single printer attached + called orchid. It has a single printer attached to its first parallel port, a Hewlett Packard - LaserJet 3Si named teak. It is using the + LaserJet 3Si named teak. It is using the above script as its text filter: @@ -1524,12 +1524,12 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ It overprinted each line. - The printer never advanced a line. All of the + The printer never advanced a line. All of the lines of text were printed on top of each other on one line. This problem is the “opposite” of the staircase - effect, described above, and is much rarer. Somewhere, + effect, described above, and is much rarer. Somewhere, the LF characters that FreeBSD uses to end a line are being treated as CR characters to return the print location to the left edge of the paper, but not also @@ -1568,13 +1568,13 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ While printing, the printer did not print a few - characters in each line. The problem might have + characters in each line. The problem might have gotten worse as the printer ran, losing more and more characters. The problem is that the printer cannot keep up with the speed at which the computer sends data over a - serial line. (This problem should not occur with + serial line. (This problem should not occur with printers on parallel ports.) There are two ways to overcome the problem: @@ -1587,7 +1587,7 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ If the printer supports carrier flow - control, specify the MDMBUF bit in the fs capability. Make sure + control, specify the MDMBUF bit in the fs capability. Make sure the cable connecting the printer to the computer is correctly wired for carrier flow control. @@ -1627,10 +1627,10 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ If nothing happened, the problem is probably - within FreeBSD and not the hardware. Add the log file + within FreeBSD and not the hardware. Add the log file (lf) capability to the entry for the printer you are debugging in the - /etc/printcap file. For example, + /etc/printcap file. For example, here is the entry for rattan, with the lf capability: @@ -1640,10 +1640,10 @@ rattan|line|diablo|lp|Diablo 630 Line Printer:\ :lp=/dev/lpt0:\ :if=/usr/local/libexec/if-simple:\ :lf=/var/log/rattan.log - Then, try printing again. Check + Then, try printing again. Check the log file (in our example, /var/log/rattan.log) to see any - error messages that might appear. Based on the + error messages that might appear. Based on the messages you see, try to correct the problem. If you do not specify a lf capability, LPD uses @@ -1662,7 +1662,7 @@ rattan|line|diablo|lp|Diablo 630 Line Printer:\ Using Printers This section tells you how to use printers you have setup with - FreeBSD. Here is an overview of the user-level commands: + FreeBSD. Here is an overview of the user-level commands: @@ -1701,10 +1701,10 @@ rattan|line|diablo|lp|Diablo 630 Line Printer:\ lpq accept an option to specify on which printer/queue to operate, as listed in the - /etc/printcap file. This enables you to - submit, remove, and check on jobs for various printers. If you do + /etc/printcap file. This enables you to + submit, remove, and check on jobs for various printers. If you do not use the option, then these commands use the - printer specified in the PRINTER environment variable. Finally, if + printer specified in the PRINTER environment variable. Finally, if you do not have a PRINTER environment variable, these commands default to the printer named lp. @@ -1724,9 +1724,9 @@ rattan|line|diablo|lp|Diablo 630 Line Printer:\ This prints each of the listed files to the - default printer. If you list no files, + default printer. If you list no files, lpr reads - data to print from standard input. For example, this command + data to print from standard input. For example, this command prints some important system files: @@ -1769,20 +1769,20 @@ rattan|line|diablo|lp|Diablo 630 Line Printer:\ lpr, the data you wish to print is put together in a package called a “print job”, which is sent to the LPD spooling - system. Each printer has a queue of jobs, and your job waits in + system. Each printer has a queue of jobs, and your job waits in that queue along with other jobs from yourself and from other - users. The printer prints those jobs in a first-come, first-served + users. The printer prints those jobs in a first-come, first-served order. To display the queue for the default printer, type - lpq. For a - specific printer, use the option. For + lpq. For a + specific printer, use the option. For example, the command &prompt.user; lpq -P bamboo - shows the queue for the printer named bamboo. Here is an example of the output of + shows the queue for the printer named bamboo. Here is an example of the output of the lpq command: @@ -1794,9 +1794,9 @@ active kelly 9 /etc/host.conf, /etc/hosts.equiv 88 bytes This shows three jobs in the queue for - bamboo. The first job, submitted by - user kelly, got assigned “job number” 9. Every - job for a printer gets a unique job number. Most of the time you + bamboo. The first job, submitted by + user kelly, got assigned “job number” 9. Every + job for a printer gets a unique job number. Most of the time you can ignore the job number, but you will need it if you want to cancel the job; see section Removing Jobs for @@ -1805,16 +1805,16 @@ active kelly 9 /etc/host.conf, /etc/hosts.equiv 88 bytes Job number nine consists of two files; multiple files given on the lpr command - line are treated as part of a single job. It is the currently + line are treated as part of a single job. It is the currently active job (note the word active under the “Rank” column), which means the printer should be - currently printing that job. The second job consists of data + currently printing that job. The second job consists of data passed as the standard input to the lpr - command. The third job came from user mary; it is a much larger - job. The pathname of the files she's trying to print is too long + command. The third job came from user mary; it is a much larger + job. The pathname of the files she's trying to print is too long to fit, so the lpq command just shows three dots. @@ -1827,7 +1827,7 @@ active kelly 9 /etc/host.conf, /etc/hosts.equiv 88 bytes The lpq command also support a option to generate a detailed - long listing. Here is an example of lpq -l: + long listing. Here is an example of lpq -l: waiting for bamboo to become ready (offline ?) @@ -1850,7 +1850,7 @@ mary: 3rd [job 011rose] If you change your mind about printing a job, you can remove the job from the queue with the lprm - command. Often, you can even use + command. Often, you can even use lprm to remove an active job, but some or all of the job might still get printed. @@ -1858,14 +1858,14 @@ mary: 3rd [job 011rose] To remove a job from the default printer, first use lpq to find - the job number. Then type: + the job number. Then type: &prompt.user; lprm job-number To remove the job from a specific printer, add - the option. The following command removes job + the option. The following command removes job number 10 from the queue for the printer bamboo: @@ -1889,7 +1889,7 @@ mary: 3rd [job 011rose] Removes all jobs (for the default printer) belonging - to user. The superuser can + to user. The superuser can remove other users' jobs; you can remove only your own jobs. @@ -1901,7 +1901,7 @@ mary: 3rd [job 011rose] With no job number, user name, or appearing on the command line, - lprm removes the currently active job on the default printer, if it belongs to you. The superuser can remove any active job. + lprm removes the currently active job on the default printer, if it belongs to you. The superuser can remove any active job. @@ -1922,7 +1922,7 @@ mary: 3rd [job 011rose] lprm will let you remove jobs only from the host from which the jobs were submitted, even if the same printer is available from other - hosts. The following command sequence demonstrates this: + hosts. The following command sequence demonstrates this: &prompt.user; lpr -P rattan myfile @@ -1949,7 +1949,7 @@ cfA013rose dequeued lpr command supports a number of options that control formatting text, converting graphic and other file formats, producing multiple - copies, handling of the job, and more. This section describes the + copies, handling of the job, and more. This section describes the options. @@ -1958,7 +1958,7 @@ cfA013rose dequeued The following lpr - options control formatting of the files in the job. Use these + options control formatting of the files in the job. Use these options if the job does not contain plain text or if you want plain text formatted through the pr @@ -1980,8 +1980,8 @@ cfA013rose dequeued All of these options except and require conversion filters installed for - the destination printer. For example, the - option requires the DVI conversion filter. Section -d + option requires the DVI conversion filter. Section Conversion Filters gives details. @@ -2021,7 +2021,7 @@ cfA013rose dequeued Indent the output by number columns; if you omit number, indent by 8 - columns. This option works only with certain conversion + columns. This option works only with certain conversion filters. @@ -2052,7 +2052,7 @@ cfA013rose dequeued Format plain text with pr - before printing. See pr1 for more information. + before printing. See pr1 for more information. @@ -2063,7 +2063,7 @@ cfA013rose dequeued Use title on the pr - header instead of the file name. This option has effect + header instead of the file name. This option has effect only when used with the option. @@ -2105,7 +2105,7 @@ cfA013rose dequeued command, which formats that source and makes GNU troff output and passes it to lpr, - which submits the job to the LPD spooler. Because we used the + which submits the job to the LPD spooler. Because we used the option to @@ -2127,9 +2127,9 @@ cfA013rose dequeued -# copies Produce a number of copies of each file in the job - instead of just one copy. An administrator may disable + instead of just one copy. An administrator may disable this option to reduce printer wear-and-tear and - encourage photocopier usage. See section Restricting Multiple Copies. This example prints three copies of @@ -2146,9 +2146,9 @@ cfA013rose dequeued -m - Send mail after completing the print job. With this + Send mail after completing the print job. With this option, the LPD system will send mail to your account - when it finishes handling your job. In its message, it + when it finishes handling your job. In its message, it will tell you if the job completed successfully or if there was an error, and (often) what the error was. @@ -2162,9 +2162,9 @@ cfA013rose dequeued make symbolic links to them instead. If you are printing a large job, you probably want - to use this option. It saves space in the spooling + to use this option. It saves space in the spooling directory (your job might overflow the free space on the - filesystem where the spooling directory resides). It + filesystem where the spooling directory resides). It saves time as well since LPD will not have to copy each and every byte of your job to the spooling directory. @@ -2178,7 +2178,7 @@ cfA013rose dequeued eventually have to copy files from the local host to the remote host, so the option will save space only on the local spooling directory, - not the remote. It is still useful, though. + not the remote. It is still useful, though. @@ -2188,7 +2188,7 @@ cfA013rose dequeued Remove the files in the job after copying them to the spooling directory, or after printing them with the - option. Be careful with this + option. Be careful with this option! @@ -2204,7 +2204,7 @@ cfA013rose dequeued lpr adjust the text that normally appears on a job's header page. If header pages are suppressed for the destination printer, - these options have no effect. See section Header Pages for information about setting up header pages. @@ -2213,7 +2213,7 @@ cfA013rose dequeued -C text Replace the hostname on the header page with - text. The hostname is + text. The hostname is normally the name of the host from which the job was submitted. @@ -2223,7 +2223,7 @@ cfA013rose dequeued Replace the job name on the header page with - text. The job name is + text. The job name is normally the name of the first file of the job, or stdin if you are printing standard input. @@ -2236,7 +2236,7 @@ cfA013rose dequeued At some sites, this option may have no effect due - to the way header pages are generated. See Header Pages for details. @@ -2252,7 +2252,7 @@ cfA013rose dequeued Administrating Printers As an administrator for your printers, you have had to - install, set up, and test them. Using the + install, set up, and test them. Using the lpc command, you can interact with your printers in yet more ways. With @@ -2279,27 +2279,27 @@ cfA013rose dequeued First, a note about terminology: if a printer is stopped, it will not print anything in its - queue. Users can still submit jobs, which will wait in the queue + queue. Users can still submit jobs, which will wait in the queue until the printer is started or the queue is cleared. If a queue is disabled, no user (except - root) can submit jobs for the printer. An - enabled queue allows jobs to be submitted. A + root) can submit jobs for the printer. An + enabled queue allows jobs to be submitted. A printer can be started for a disabled queue, in which case it will continue to print jobs in the queue until the queue is empty. In general, you have to have root privileges to use the lpc - command. Ordinary users can use the + command. Ordinary users can use the lpc command to get printer status and to restart a hung printer only. Here is a summary of the lpc - commands. Most of the commands takes a printer-name argument to tell on which - printer to operate. You can use all + commands. Most of the commands takes a printer-name argument to tell on which + printer to operate. You can use all for the printer-name to mean all printers listed in /etc/printcap. @@ -2308,7 +2308,7 @@ cfA013rose dequeued abort printer-name - Cancel the current job and stop the printer. Users + Cancel the current job and stop the printer. Users can still submit jobs if the queue's enabled. @@ -2318,10 +2318,10 @@ cfA013rose dequeued Remove old files from the printer's spooling - directory. Occasionally, the files that make up a job are + directory. Occasionally, the files that make up a job are not properly removed by LPD, particularly if there have been errors during printing or a lot of administrative - activity. This command finds files that do not belong in + activity. This command finds files that do not belong in the spooling directory and removes them. @@ -2330,14 +2330,14 @@ cfA013rose dequeued printer-name - Disable queuing of new jobs. If the printer's + Disable queuing of new jobs. If the printer's started, it will continue to print any jobs remaining in - the queue. The superuser (root) can always submit jobs, + the queue. The superuser (root) can always submit jobs, even to a disabled queue. This command is useful while you are testing a new printer or filter installation: disable the queue and - submit jobs as root. Other users will not be able to + submit jobs as root. Other users will not be able to submit jobs until you complete your testing and re-enable the queue with the enable command. @@ -2349,9 +2349,9 @@ cfA013rose dequeued message - Take a printer down. Equivalent to + Take a printer down. Equivalent to disable followed by - stop. The message appears as the printer's + stop. The message appears as the printer's status whenever a user checks the printer's queue with lpq @@ -2364,7 +2364,7 @@ cfA013rose dequeued printer-name - Enable the queue for a printer. Users can submit jobs + Enable the queue for a printer. Users can submit jobs but the printer will not print anything until it is started. @@ -2375,7 +2375,7 @@ cfA013rose dequeued Print help on the command - command-name. With no + command-name. With no command-name, print a summary of the commands available. @@ -2385,10 +2385,10 @@ cfA013rose dequeued printer-name - Start the printer. Ordinary users can use this + Start the printer. Ordinary users can use this command if some extraordinary circumstance hangs LPD, but they cannot start a printer stopped with either the - stop or down commands. The restart command is equivalent to + stop or down commands. The restart command is equivalent to abort followed by start. @@ -2397,7 +2397,7 @@ cfA013rose dequeued printer-name - Start the printer. The printer will print jobs in its + Start the printer. The printer will print jobs in its queue. @@ -2406,8 +2406,8 @@ cfA013rose dequeued printer-name - Stop the printer. The printer will finish the current - job and will not print anything else in its queue. Even + Stop the printer. The printer will finish the current + job and will not print anything else in its queue. Even though the printer is stopped, users can still submit jobs to an enabled queue. @@ -2430,7 +2430,7 @@ cfA013rose dequeued printer-name - Bring a printer up; the opposite of the down command. Equivalent to + Bring a printer up; the opposite of the down command. Equivalent to start followed by enable. @@ -2439,7 +2439,7 @@ cfA013rose dequeued lpc accepts - the above commands on the command line. If you do not enter any + the above commands on the command line. If you do not enter any commands, lpc enters an interactive mode, where you can enter commands until you type @@ -2462,9 +2462,9 @@ cfA013rose dequeued Although LPD handles network protocols, queuing, access control, and other aspects of printing, most of the real work happens in the - filters. Filters are programs that + filters. Filters are programs that communicate with the printer and handle its device dependencies - and special requirements. In the simple printer setup, we + and special requirements. In the simple printer setup, we installed a plain text filter—an extremely simple one that should work with most printers (section Installing the @@ -2472,15 +2472,15 @@ cfA013rose dequeued However, in order to take advantage of format conversion, printer accounting, specific printer quirks, and so on, you should - understand how filters work. It will ultimately be the filter's - responsibility to handle these aspects. And the bad news is that + understand how filters work. It will ultimately be the filter's + responsibility to handle these aspects. And the bad news is that most of the time you have to provide filters - yourself. The good news is that many are generally available; + yourself. The good news is that many are generally available; when they are not, they are usually easy to write. Also, FreeBSD comes with one, /usr/libexec/lpr/lpf, that works with many - printers that can print plain text. (It handles backspacing and + printers that can print plain text. (It handles backspacing and tabs in the file, and does accounting, but that is about all it does.) There are also several filters and filter components in the FreeBSD ports collection. @@ -2492,32 +2492,32 @@ cfA013rose dequeued Section How Filters Work, tries to give an overview of a - filter's role in the printing process. You should read this + filter's role in the printing process. You should read this section to get an understanding of what is happening “under - the hood” when LPD uses filters. This knowledge could help + the hood” when LPD uses filters. This knowledge could help you anticipate and debug problems you might encounter as you install more and more filters on each of your printers. LPD expects every printer to be able to print plain text - by default. This presents a problem for PostScript (or + by default. This presents a problem for PostScript (or other language-based printers) which cannot directly print - plain text. Section Accommodating Plain Text Jobs on PostScript Printers tells you what you should do to overcome this - problem. I recommend reading this section if you have a + problem. I recommend reading this section if you have a PostScript printer. PostScript is a popular output format for many programs. Even some people (myself included) write PostScript code - directly. But PostScript printers are expensive. Section + directly. But PostScript printers are expensive. Section Simulating PostScript on Non-PostScript Printers tells how you can further modify a printer's text filter to accept and print PostScript data on a - non-PostScript printer. I recommend + non-PostScript printer. I recommend reading this section if you do not have a PostScript printer. @@ -2526,17 +2526,17 @@ cfA013rose dequeued Section Conversion Filters tells about a way you can automate the conversion of specific file formats, such as graphic or typesetting data, into formats your printer can - understand. After reading this section, you should be able + understand. After reading this section, you should be able to set up your printers such that users can type lpr -t to print troff data, or lpr -d to print TeX DVI data, or lpr -v to print raster image data, and so - forth. I recommend reading this section. + forth. I recommend reading this section. Section Output Filters tells all about a not often used - feature of LPD: output filters. Unless you are printing + feature of LPD: output filters. Unless you are printing header pages (see Header Pages), you can probably skip that section altogether. @@ -2545,7 +2545,7 @@ cfA013rose dequeued Section lpf: a Text Filter describes lpf, a fairly complete if simple text filter for line printers (and laser printers that act like - line printers) that comes with FreeBSD. If you need a quick + line printers) that comes with FreeBSD. If you need a quick way to get printer accounting working for plain text, or if you have a printer which emits smoke when it sees backspace characters, you should definitely consider lpf. @@ -2562,7 +2562,7 @@ cfA013rose dequeued communicating with the printer. When LPD wants to print a file in a job, it starts a filter - program. It sets the filter's standard input to the file to + program. It sets the filter's standard input to the file to print, its standard output to the printer, and its standard error to the error logging file (specified in the lf capability in /etc/printcap, or @@ -2574,10 +2574,10 @@ cfA013rose dequeued lpr - command line. For example, if the user typed lpr + command line. For example, if the user typed lpr -t, LPD would start the troff filter, listed in the tf capability for the destination - printer. If the user wanted to print plain text, it would start + printer. If the user wanted to print plain text, it would start the if filter (this is mostly true: see Output Filters @@ -2591,16 +2591,16 @@ cfA013rose dequeued The text filter, confusingly called the input filter in LPD - documentation, handles regular text printing. Think of it - as the default filter. LPD expects every printer to be + documentation, handles regular text printing. Think of it + as the default filter. LPD expects every printer to be able to print plain text by default, and it is the text filter's job to make sure backspaces, tabs, or other - special characters do not confuse the printer. If you are + special characters do not confuse the printer. If you are in an environment where you have to account for printer usage, the text filter must also account for pages printed, usually by counting the number of lines printed and comparing that to the number of lines per page the - printer supports. The text filter is started with the + printer supports. The text filter is started with the following argument list: @@ -2679,13 +2679,13 @@ cfA013rose dequeued A conversion filter converts a specific file format into one the printer can render onto - paper. For example, ditroff typesetting data cannot be + paper. For example, ditroff typesetting data cannot be directly printed, but you can install a conversion filter for ditroff files to convert the ditroff data into a form - the printer can digest and print. Section + the printer can digest and print. Section Conversion Filters tells all about them. Conversion filters also need to do accounting, if you need - printer accounting. Conversion filters are started with + printer accounting. Conversion filters are started with the following arguments: @@ -2706,9 +2706,9 @@ cfA013rose dequeued The output filter is used only if there is no text filter, or if header pages are enabled. - In my experience, output filters are rarely used. Section + In my experience, output filters are rarely used. Section Output - Filters describe them. There are only two arguments + Filters describe them. There are only two arguments to an output filter: @@ -2737,7 +2737,7 @@ cfA013rose dequeued If the filter failed to print the file but wants LPD - to try to print the file again. LPD will restart a + to try to print the file again. LPD will restart a filter if it exits with this status. @@ -2746,7 +2746,7 @@ cfA013rose dequeued If the filter failed to print the file and does not - want LPD to try again. LPD will throw out the + want LPD to try again. LPD will throw out the file. @@ -2756,13 +2756,13 @@ cfA013rose dequeued The text filter that comes with the FreeBSD release, /usr/libexec/lpr/lpf, takes advantage of the page width and length arguments to determine when to send a - form feed and how to account for printer usage. It uses the + form feed and how to account for printer usage. It uses the login, host, and accounting file arguments to make the accounting entries. If you are shopping for filters, see if they are - LPD-compatible. If they are, they must support the argument - lists described above. If you plan on writing filters for + LPD-compatible. If they are, they must support the argument + lists described above. If you plan on writing filters for general use, then have them support the same argument lists and exit codes. @@ -2779,36 +2779,36 @@ cfA013rose dequeued But, if you would like to send both PostScript and plain text jobs to the printer, then you are urged to augment your - printer setup. To do so, we have the text filter detect if the - arriving job is plain text or PostScript. All PostScript jobs + printer setup. To do so, we have the text filter detect if the + arriving job is plain text or PostScript. All PostScript jobs must start with %! (for other - printer languages, see your printer documentation). If those are + printer languages, see your printer documentation). If those are the first two characters in the job, we have PostScript, and can - pass the rest of the job directly. If those are not the first + pass the rest of the job directly. If those are not the first two characters in the file, then the filter will convert the text into PostScript and print the result. How do we do this? If you have got a serial printer, a great way to do it is to - install lprps. lprps is a PostScript printer filter which - performs two-way communication with the printer. It updates the + install lprps. lprps is a PostScript printer filter which + performs two-way communication with the printer. It updates the printer's status file with verbose information from the printer, so users and administrators can see exactly what the state of - the printer is (such as toner low or paper jam). But + the printer is (such as toner low or paper jam). But more importantly, it includes a program called psif which detects whether the incoming job is plain text and calls textps - (another program that comes with lprps) to convert it to PostScript. It + (another program that comes with lprps) to convert it to PostScript. It then uses lprps to send the job to the printer. lprps is part of the FreeBSD ports collection (see The Ports - Collection). You - can fetch, build and install it yourself, of course. After + Collection). You + can fetch, build and install it yourself, of course. After installing lprps, just specify the pathname to the psif program that - is part of lprps. If you + is part of lprps. If you installed lprps from the ports collection, use the following in the serial PostScript printer's entry in /etc/printcap: @@ -2850,8 +2850,8 @@ else fi In the above script, textps is a program we installed - separately to convert plain text to PostScript. You can use any - text-to-PostScript program you wish. The FreeBSD ports + separately to convert plain text to PostScript. You can use any + text-to-PostScript program you wish. The FreeBSD ports collection (see The Ports Collection) includes a full featured text-to-PostScript program called @@ -2863,33 +2863,33 @@ fi Simulating PostScript on Non-PostScript Printers PostScript is the de facto - standard for high quality typesetting and printing. PostScript + standard for high quality typesetting and printing. PostScript is, however, an expensive standard. Thankfully, Alladin Enterprises has a free PostScript work-alike called Ghostscript that runs with - FreeBSD. Ghostscript can read most PostScript files and can + FreeBSD. Ghostscript can read most PostScript files and can render their pages onto a variety of devices, including many - brands of non-PostScript printers. By installing Ghostscript + brands of non-PostScript printers. By installing Ghostscript and using a special text filter for your printer, you can make your non-PostScript printer act like a real PostScript printer. Ghostscript should be in the FreeBSD ports collection, if - you would like to install it from there. You can fetch, build, + you would like to install it from there. You can fetch, build, and install it quite easily yourself, as well. To simulate PostScript, we have the text filter detect if it - is printing a PostScript file. If it is not, then the filter + is printing a PostScript file. If it is not, then the filter will pass the file directly to the printer; otherwise, it will use Ghostscript to first convert the file into a format the printer will understand. Here is an example: the following script is a text filter - for Hewlett Packard DeskJet 500 printers. For other printers, + for Hewlett Packard DeskJet 500 printers. For other printers, substitute the argument to the - gs (Ghostscript) command. (Type gs -h to get a list of devices the current installation of Ghostscript supports.) + gs (Ghostscript) command. (Type gs -h to get a list of devices the current installation of Ghostscript supports.) #!/bin/sh @@ -2930,7 +2930,7 @@ exit 2 :if=/usr/local/libexec/hpif: - That is it. You can type lpr plain.text and lpr + That is it. You can type lpr plain.text and lpr whatever.ps and both should print successfully. @@ -2950,10 +2950,10 @@ exit 2 Why Install Conversion Filters? Conversion filters make printing various kinds of files - easy. As an example, suppose we do a lot of work with the TeX - typesetting system, and we have a PostScript printer. Every + easy. As an example, suppose we do a lot of work with the TeX + typesetting system, and we have a PostScript printer. Every time we generate a DVI file from TeX, we cannot print it - directly until we convert the DVI file into PostScript. The + directly until we convert the DVI file into PostScript. The command sequence goes like this: @@ -2963,7 +2963,7 @@ exit 2 By installing a conversion filter for DVI files, we can skip the hand conversion step each time by - having LPD do it for us. Now, each time we get a DVI file, we + having LPD do it for us. Now, each time we get a DVI file, we are just one step away from printing it: @@ -2971,14 +2971,14 @@ exit 2 We got LPD to do the DVI file conversion - for us by specifying the option. Section + for us by specifying the option. Section Formatting and Conversion Options lists the conversion options. For each of the conversion options you want a printer to support, install a conversion filter and - specify its pathname in /etc/printcap. A + specify its pathname in /etc/printcap. A conversion filter is like the text filter for the simple printer setup (see section Installing the Text Filter) except that instead of printing plain text, the filter converts the file into a @@ -2990,8 +2990,8 @@ exit 2 Which Conversions Filters Should I Install? You should install the conversion filters you expect to - use. If you print a lot of DVI data, then a DVI conversion - filter is in order. If you have got plenty of troff to print + use. If you print a lot of DVI data, then a DVI conversion + filter is in order. If you have got plenty of troff to print out, then you probably want a troff filter. The following table summarizes the filters that LPD works @@ -3066,12 +3066,12 @@ exit 2 its entry in /etc/printcap. Despite what others might contend, formats like FORTRAN - text and plot are probably obsolete. At your site, you can + text and plot are probably obsolete. At your site, you can give new meanings to these or any of the formatting options - just by installing custom filters. For example, suppose you + just by installing custom filters. For example, suppose you would like to directly print Printerleaf files (files from the Interleaf desktop publishing program), but will never print - plot files. You could install a Printerleaf conversion filter + plot files. You could install a Printerleaf conversion filter under the gf capability and then educate your users that lpr -g mean “print Printerleaf files.” @@ -3083,7 +3083,7 @@ exit 2 Since conversion filters are programs you install outside of the base FreeBSD installation, they should probably go - under /usr/local. The directory + under /usr/local. The directory /usr/local/libexec is a popular location, since they are specialized programs that only LPD will run; regular users should not ever need to run them. @@ -3093,7 +3093,7 @@ exit 2 /etc/printcap. In our example, we will add the DVI conversion filter to - the entry for the printer named bamboo. Here is the example + the entry for the printer named bamboo. Here is the example /etc/printcap file again, with the new df capability for the printer bamboo. @@ -3114,7 +3114,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ :df=/usr/local/libexec/psdf: The DVI filter is a shell script named - /usr/local/libexec/psdf. Here is that + /usr/local/libexec/psdf. Here is that script: @@ -3128,7 +3128,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ exec /usr/local/bin/dvips -f | /usr/local/libexec/lprps "$@" This script runs - dvips in filter mode (the argument) on standard input, which is the job to print. It then starts the PostScript printer filter lprps (see section Accommodating Plain Text Jobs on PostScript + dvips in filter mode (the argument) on standard input, which is the job to print. It then starts the PostScript printer filter lprps (see section Accommodating Plain Text Jobs on PostScript Printers) with the arguments LPD passed to this script. lprps will use those arguments to account for the pages printed. @@ -3139,8 +3139,8 @@ exec /usr/local/bin/dvips -f | /usr/local/libexec/lprps "$@" More Conversion Filter Examples Since there is no fixed set of steps to install - conversion filters, let me instead provide more examples. Use - these as guidance to making your own filters. Use them + conversion filters, let me instead provide more examples. Use + these as guidance to making your own filters. Use them directly, if appropriate. This example script is a raster (well, GIF file, actually) @@ -3187,7 +3187,7 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ exec grops | /usr/local/libexec/lprps "$@" The above script makes use of lprps again to handle the communication - with the printer. If the printer were on a parallel port, we + with the printer. If the printer were on a parallel port, we would use this script instead: @@ -3198,7 +3198,7 @@ exec grops | /usr/local/libexec/lprps "$@" # exec grops - That is it. Here is the entry we need to + That is it. Here is the entry we need to add to /etc/printcap to enable the filter: @@ -3206,8 +3206,8 @@ exec grops :tf=/usr/local/libexec/pstf: Here is an example that might make old hands at FORTRAN - blush. It is a FORTRAN-text filter for any printer that can - directly print plain text. We will install it for the printer + blush. It is a FORTRAN-text filter for any printer that can + directly print plain text. We will install it for the printer teak: @@ -3227,20 +3227,20 @@ exit 2 :rf=/usr/local/libexec/hprf: - Here is one final, somewhat complex example. We will add - a DVI filter to the LaserJet printer teak introduced earlier. First, the + Here is one final, somewhat complex example. We will add + a DVI filter to the LaserJet printer teak introduced earlier. First, the easy part: updating /etc/printcap with the location of the DVI filter: :df=/usr/local/libexec/hpdf: - Now, for the hard part: making the filter. For that, we - need a DVI-to-LaserJet/PCL conversion program. The FreeBSD + Now, for the hard part: making the filter. For that, we + need a DVI-to-LaserJet/PCL conversion program. The FreeBSD ports collection (see The Ports Collection) has one: dvi2xx is the - name of the package. Installing this package gives us the + name of the package. Installing this package gives us the program we need, dvilj2p, which converts DVI into LaserJet IIp, LaserJet III, and LaserJet 2000 compatible codes. @@ -3249,11 +3249,11 @@ exit 2 the filter hpdf quite complex since dvilj2p cannot - read from standard input. It wants to work with a filename. + read from standard input. It wants to work with a filename. What is worse, the filename has to end in .dvi so using /dev/fd/0 for standard input is - problematic. We can get around that problem by linking + problematic. We can get around that problem by linking (symbolically) a temporary file name (one that ends in .dvi) to /dev/fd/0, thereby forcing @@ -3262,7 +3262,7 @@ exit 2 The only other fly in the ointment is the fact that we cannot use /tmp for the temporary link. Symbolic links are owned by user and group - bin. The filter runs as user daemon. And the + bin. The filter runs as user daemon. And the /tmp directory has the sticky bit set. The filter can create the link, but it will not be able clean up when done and remove it since the link will belong to a @@ -3271,7 +3271,7 @@ exit 2 Instead, the filter will make the symbolic link in the current working directory, which is the spooling directory (specified by the sd capability - in /etc/printcap). This is a perfect + in /etc/printcap). This is a perfect place for filters to do their work, especially since there is (sometimes) more free disk space in the spooling directory than under /tmp. @@ -3349,9 +3349,9 @@ exit 0 printing environment, but at the cost forcing the user to specify (on the lpr - command line) which one to use. If your users are not + command line) which one to use. If your users are not particularly computer literate, having to specify a filter - option will become annoying. What is worse, though, is that + option will become annoying. What is worse, though, is that an incorrectly specified filter option may run a filter on the wrong type of file and cause your printer to spew out hundreds of sheets of paper. @@ -3359,15 +3359,15 @@ exit 0 Rather than install conversion filters at all, you might want to try having the text filter (since it is the default filter) detect the type of file it has been asked to print and - then automatically run the right conversion filter. Tools + then automatically run the right conversion filter. Tools such as file can be of help - here. Of course, it will be hard to determine the differences + here. Of course, it will be hard to determine the differences between some file types—and, of course, you can still provide conversion filters just for them. The FreeBSD ports collection has a text filter that performs automatic conversion called - apsfilter. It can detect plain text, PostScript, and DVI files, run the proper conversions, and print. + apsfilter. It can detect plain text, PostScript, and DVI files, run the proper conversions, and print. @@ -3376,9 +3376,9 @@ exit 0 Output Filters The LPD spooling system supports one other type of filter - that we have not yet explored: an output filter. An output + that we have not yet explored: an output filter. An output filter is intended for printing plain text only, like the text - filter, but with many simplifications. If you are using an + filter, but with many simplifications. If you are using an output filter but no text filter, then: @@ -3394,7 +3394,7 @@ exit 0 LPD does not pass the user's login or host to the - filter, so it is not intended to do accounting. In fact, + filter, so it is not intended to do accounting. In fact, it gets only two arguments: @@ -3412,12 +3412,12 @@ exit 0 - Do not be seduced by an output filter's simplicity. If you + Do not be seduced by an output filter's simplicity. If you would like each file in a job to start on a different page an - output filter will not work. Use a text + output filter will not work. Use a text filter (also known as an input filter); see section Installing the Text - Filter. Furthermore, an output filter is actually + Filter. Furthermore, an output filter is actually more complex in that it has to examine the byte stream being sent to it for special flag characters and must send signals to itself on behalf of LPD. @@ -3425,35 +3425,35 @@ exit 0 However, an output filter is necessary if you want header pages and need to send escape sequences or other initialization strings to be able to print the header - page. (But it is also futile if you want + page. (But it is also futile if you want to charge header pages to the requesting user's account, since LPD does not give any user or host information to the output filter.) On a single printer, LPD allows both an output filter and - text or other filters. In such cases, LPD will start the output + text or other filters. In such cases, LPD will start the output filter to print the header page (see section Header - Pages) only. LPD then expects the output filter to + Pages) only. LPD then expects the output filter to stop itself by sending two bytes to the - filter: ASCII 031 followed by ASCII 001. When an output filter + filter: ASCII 031 followed by ASCII 001. When an output filter sees these two bytes (031, 001), it should stop by sending - SIGSTOP to itself. When LPD's done running other filters, it + SIGSTOP to itself. When LPD's done running other filters, it will restart the output filter by sending SIGCONT to it. If there is an output filter but no text filter and LPD is working on a plain text job, LPD uses the - output filter to do the job. As stated before, the output + output filter to do the job. As stated before, the output filter will print each file of the job in sequence with no intervening form feeds or other paper advancement, and this is - probably not what you want. In almost all + probably not what you want. In almost all cases, you need a text filter. The program lpf, which we introduced earlier as a text filter, can also run as an output - filter. If you need a quick-and-dirty output filter but do not + filter. If you need a quick-and-dirty output filter but do not want to write the byte detection and signal sending code, try - lpf. You can also wrap lpf in a shell script to handle any + lpf. You can also wrap lpf in a shell script to handle any initialization codes the printer might require. @@ -3466,11 +3466,11 @@ exit 0 filter) that can indent output (job submitted with lpr -i), allow literal characters to pass (job submitted with lpr -l), adjust the printing position for backspaces and tabs in the job, and - account for pages printed. It can also act like an output + account for pages printed. It can also act like an output filter. lpf is suitable for many - printing environments. And although it has no capability to + printing environments. And although it has no capability to send initialization sequences to a printer, it is easy to write a shell script to do the needed initialization and then execute lpf. @@ -3478,9 +3478,9 @@ exit 0 In order for lpf to do page accounting correctly, it needs correct values filled in for the pw and pl capabilities in the - /etc/printcap file. It uses these values + /etc/printcap file. It uses these values to determine how much text can fit on a page and how many pages - were in a user's job. For more information on printer + were in a user's job. For more information on printer accounting, see Accounting for Printer Usage. @@ -3497,20 +3497,20 @@ exit 0 Header pages, also known as banner or burst pages identify to whom jobs belong - after they are printed. They are usually printed in large, bold + after they are printed. They are usually printed in large, bold letters, perhaps with decorative borders, so that in a stack of printouts they stand out from the real documents that comprise - users' jobs. They enable users to locate their jobs quickly. The + users' jobs. They enable users to locate their jobs quickly. The obvious drawback to a header page is that it is yet one more sheet that has to be printed for every job, their ephemeral usefulness lasting not more than a few minutes, ultimately finding themselves - in a recycling bin or rubbish heap. (Note that header pages go + in a recycling bin or rubbish heap. (Note that header pages go with each job, not each file in a job, so the paper waste might not be that bad.) The LPD system can provide header pages automatically for your printouts if your printer can directly print - plain text. If you have a PostScript printer, you will need an + plain text. If you have a PostScript printer, you will need an external program to generate the header page; see Header Pages on PostScript Printers. @@ -3522,14 +3522,14 @@ exit 0 In the Simple Printer Setup, we turned off header pages by specifying sh (meaning “suppress - header”) in the /etc/printcap file. To + header”) in the /etc/printcap file. To enable header pages for a printer, just remove the sh capability. Sounds too easy, right? - You are right. You might have to + You are right. You might have to provide an output filter to send initialization strings to the - printer. Here is an example output filter for Hewlett Packard + printer. Here is an example output filter for Hewlett Packard PCL-compatible printers: @@ -3542,7 +3542,7 @@ printf "\033&k2G" || exit 2 exec /usr/libexec/lpr/lpf Specify the path to the output filter in the - of capability. See of capability. See Output Filters for more information. Here is an example /etc/printcap file @@ -3561,7 +3561,7 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ :of=/usr/local/libexec/hpof: Now, when users print jobs to teak, they get a header page with each - job. If users want to spend time searching for their printouts, + job. If users want to spend time searching for their printouts, they can suppress header pages by submitting the job with lpr -h; see Header Page @@ -3583,7 +3583,7 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ By enabling header pages, LPD will produce a long header, a full page of large letters identifying - the user, host, and job. Here is an example (kelly printed the + the user, host, and job. Here is an example (kelly printed the job named outline from host rose): @@ -3649,7 +3649,7 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ rose:kelly Job: outline Date: Sun Sep 17 11:07:51 1995 Also by default, LPD prints the header page - first, then the job. To reverse that, specify hl (header last) in + first, then the job. To reverse that, specify hl (header last) in /etc/printcap. @@ -3667,18 +3667,18 @@ rose:kelly Job: outline Date: Sun Sep 17 11:07:51 1995 will have control when the header page is printed that could do accounting, and it is not provided with any user or host information or an accounting file, so it has - no idea whom to charge for printer use. It is also not enough + no idea whom to charge for printer use. It is also not enough to just “add one page” to the text filter or any of the conversion filters (which do have user and host information) since users can suppress header pages with lpr - -h. They could still be charged for header pages - they did not print. Basically, lpr -h will + -h. They could still be charged for header pages + they did not print. Basically, lpr -h will be the preferred option of environmentally-minded users, but you cannot offer any incentive to use it. It is still not enough to have each of the filters generate their own header pages (thereby being able - to charge for them). If users wanted the option of suppressing + to charge for them). If users wanted the option of suppressing the header pages with lpr -h, they will still get them and be charged for them since LPD does not pass any knowledge of the option to any of the @@ -3704,20 +3704,20 @@ rose:kelly Job: outline Date: Sun Sep 17 11:07:51 1995 Write a smart output filter. Normally, an output filter is not meant to do anything more than initialize a printer or do some simple character - conversion. It is suited for header pages and plain text - jobs (when there is no text (input) filter). But, if there + conversion. It is suited for header pages and plain text + jobs (when there is no text (input) filter). But, if there is a text filter for the plain text jobs, then LPD will - start the output filter only for the header pages. And + start the output filter only for the header pages. And the output filter can parse the header page text that LPD generates to determine what user and host to charge for - the header page. The only other problem with this method + the header page. The only other problem with this method is that the output filter still does not know what accounting file to use (it is not passed the name of the file from the af capability), but if you have a well-known accounting file, - you can hard-code that into the output filter. To + you can hard-code that into the output filter. To facilitate the parsing step, use the sh (short header) capability in - /etc/printcap. Then again, all that + /etc/printcap. Then again, all that might be too much trouble, and users will certainly appreciate the more generous system administrator who makes header pages free. @@ -3732,18 +3732,18 @@ rose:kelly Job: outline Date: Sun Sep 17 11:07:51 1995 Header Pages on PostScript Printers As described above, LPD can generate a plain text header - page suitable for many printers. Of course, PostScript cannot + page suitable for many printers. Of course, PostScript cannot directly print plain text, so the header page feature of LPD is useless—or mostly so. One obvious way to get header pages is to have every conversion filter and the text filter generate the header page. The filters should should use the user and host arguments to - generate a suitable header page. The drawback of this method is + generate a suitable header page. The drawback of this method is that users will always get a header page, even if they submit jobs with lpr -h. - Let us explore this method. The following script takes + Let us explore this method. The following script takes three arguments (user login name, host name, and job name) and makes a simple PostScript header page: @@ -3830,7 +3830,7 @@ EOF Now, each of the conversion filters and the text filter can call this script to first generate the header - page, and then print the user's job. Here is the DVI conversion + page, and then print the user's job. Here is the DVI conversion filter from earlier in this document, modified to make a header page: @@ -3868,14 +3868,14 @@ done /usr/local/bin/dvips -f ) | eval /usr/local/libexec/lprps $orig_args Notice how the filter has to parse the - argument list in order to determine the user and host name. The - parsing for the other conversion filters is identical. The text + argument list in order to determine the user and host name. The + parsing for the other conversion filters is identical. The text filter takes a slightly different set of arguments, though (see section How Filters Work). As we have mentioned before, the above scheme, though fairly simple, disables the “suppress header page” option (the - option) to lpr. If users wanted to save a tree (or a + option) to lpr. If users wanted to save a tree (or a few pennies, if you charge for header pages), they would not be able to do so, since every filter's going to print a header page with every job. @@ -3884,16 +3884,16 @@ done you will need to use the trick introduced in section Accounting for Header Pages: write an output filter that parses the LPD-generated header page and produces a - PostScript version. If the user submits the job with + PostScript version. If the user submits the job with lpr -h, then LPD will not generate a header - page, and neither will your output filter. Otherwise, your + page, and neither will your output filter. Otherwise, your output filter will read the text from LPD and send the appropriate header page PostScript code to the printer. If you have a PostScript printer on a serial line, you can make use of lprps, which comes with an output filter, psof, which - does the above. Note that psof + does the above. Note that psof does not charge for header pages. @@ -3903,14 +3903,14 @@ done Networked Printing FreeBSD supports networked printing: sending jobs to remote - printers. Networked printing generally refers to two different + printers. Networked printing generally refers to two different things: - Accessing a printer attached to a remote host. You + Accessing a printer attached to a remote host. You install a printer that has a conventional serial or parallel - interface on one host. Then, you set up LPD to enable + interface on one host. Then, you set up LPD to enable access to the printer from other hosts on the network. Section Printers @@ -3918,17 +3918,17 @@ done - Accessing a printer attached directly to a network. The + Accessing a printer attached directly to a network. The printer has a network interface in addition (or in place of) - a more conventional serial or parallel interface. Such a + a more conventional serial or parallel interface. Such a printer might work as follows: It might understand the LPD protocol and can even - queue jobs from remote hosts. In this case, it acts - just like a regular host running LPD. Follow the same + queue jobs from remote hosts. In this case, it acts + just like a regular host running LPD. Follow the same procedure in section Printers Installed on Remote Hosts to set up such a printer. @@ -3958,18 +3958,18 @@ done The LPD spooling system has built-in support for sending jobs to other hosts also running LPD (or are compatible with - LPD). This feature enables you to install a printer on one host - and make it accessible from other hosts. It also works with + LPD). This feature enables you to install a printer on one host + and make it accessible from other hosts. It also works with printers that have network interfaces that understand the LPD protocol. To enable this kind of remote printing, first install a printer on one host, the printer host, using the simple printer setup described in Simple Printer Setup. Do - any advanced setup in Advanced Printer Setup that you need. Make sure to + linkend="printing-simple">Simple Printer Setup. Do + any advanced setup in Advanced Printer Setup that you need. Make sure to test the printer and see if it works with the features of LPD - you have enabled. Also ensure that the local + you have enabled. Also ensure that the local host has authorization to use the LPD service in the remote host (see Restricting Jobs @@ -3979,7 +3979,7 @@ done compatible with LPD, then the printer host in the discussion below is the printer itself, and the printer name is the name you configured for - the printer. See the documentation that accompanied your + the printer. See the documentation that accompanied your printer and/or printer-network interface. Then, on the other hosts you want to have access to the @@ -3988,7 +3988,7 @@ done - Name the entry anything you want. For simplicity, + Name the entry anything you want. For simplicity, though, you probably want to use the same name and aliases as on the printer host. @@ -4000,7 +4000,7 @@ done Make a spooling directory and specify its location in - the sd capability. LPD will + the sd capability. LPD will store jobs here before they get sent to the printer host. @@ -4016,16 +4016,16 @@ done - That is it. You do not need to list conversion + That is it. You do not need to list conversion filters, page dimensions, or anything else in the /etc/printcap file. - Here is an example. The host rose has two printers, - bamboo and rattan. We will enable users on the host - orchid to print to those printers. Here is the + Here is an example. The host rose has two printers, + bamboo and rattan. We will enable users on the host + orchid to print to those printers. Here is the /etc/printcap file for orchid (back from section - Enabling Header Pages). It already had the entry for + Enabling Header Pages). It already had the entry for the printer teak; we have added entries for the two printers on the host rose: @@ -4065,7 +4065,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Now, users on orchid can print to - rattan and bamboo. If, for example, a user on orchid + rattan and bamboo. If, for example, a user on orchid typed @@ -4073,9 +4073,9 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ the LPD system on orchid would copy the job to the spooling directory /var/spool/lpd/bamboo and note that it was - a DVI job. As soon as the host rose has room in its bamboo spooling directory, the two LPDs - would transfer the file to rose. The file would wait in rose's - queue until it was finally printed. It would be converted from + a DVI job. As soon as the host rose has room in its bamboo spooling directory, the two LPDs + would transfer the file to rose. The file would wait in rose's + queue until it was finally printed. It would be converted from DVI to PostScript (since bamboo is a PostScript printer) on rose. @@ -4088,7 +4088,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ you can get two versions: one which emulates a spooler (the more expensive version), or one which just lets you send data to it as if you were using a serial or parallel port (the cheaper - version). This section tells how to use the cheaper version. + version). This section tells how to use the cheaper version. For the more expensive one, see the previous section Printers Installed on Remote Hosts. @@ -4097,18 +4097,18 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ lets you specify what serial or parallel interface to use, and (if you are using a serial interface), what baud rate, whether to use flow control, delays for tabs, conversion of newlines, - and more. But there is no way to specify a connection to a + and more. But there is no way to specify a connection to a printer that is listening on a TCP/IP or other network port. To send data to a networked printer, you need to develop a communications program that can be called by the text and - conversion filters. Here is one such example: the script + conversion filters. Here is one such example: the script netprint takes all data on - standard input and sends it to a network-attached printer. We + standard input and sends it to a network-attached printer. We specify the hostname of the printer as the first argument and the port number to which to connect as the second argument to - netprint. Note that this supports + netprint. Note that this supports one-way communication only (FreeBSD to printer); many network printers support two-way communication, and you might want to take advantage of that (to get printer status, perform @@ -4140,9 +4140,9 @@ while (<STDIN>) { print PRINTER; } exit 0; We can then use this script in various - filters. Suppose we had a Diablo 750-N line printer connected - to the network. The printer accepts data to print on port - number 5100. The host name of the printer is scrivener. Here + filters. Suppose we had a Diablo 750-N line printer connected + to the network. The printer accepts data to print on port + number 5100. The host name of the printer is scrivener. Here is the text filter for the printer: @@ -4169,16 +4169,16 @@ exit 0; Restricting Multiple Copies The LPD system makes it easy for users to print multiple - copies of a file. Users can print jobs with lpr + copies of a file. Users can print jobs with lpr -#5 (for example) and get five copies of each file - in the job. Whether this is a good thing is up to you. + in the job. Whether this is a good thing is up to you. If you feel multiple copies cause unnecessary wear and tear on your printers, you can disable the option to lpr by adding the sc capability to the - /etc/printcap file. When users submit jobs + /etc/printcap file. When users submit jobs with the option, they will see: @@ -4192,8 +4192,8 @@ exit 0; will still be able to submit multiple-copy jobs by using another host. - Here is an example. This is the - /etc/printcap file for the host rose. The + Here is an example. This is the + /etc/printcap file for the host rose. The printer rattan is quite hearty, so we will allow multiple copies, but the laser printer bamboo's a bit more delicate, so we will disable multiple copies by adding the sc capability: @@ -4254,7 +4254,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ You can control who can print to what printers by using the UNIX group mechanism and the rg - capability in /etc/printcap. Just place + capability in /etc/printcap. Just place the users you want to have access to a printer in a certain group, and then name that group in the rg capability. @@ -4275,7 +4275,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ For example, we will let anyone access the printer rattan, but only those in group - artists can use bamboo. Here is the familiar + artists can use bamboo. Here is the familiar /etc/printcap for host rose: @@ -4295,10 +4295,10 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Let us leave the other example /etc/printcap file (for the host orchid) - alone. Of course, anyone on orchid can print to - bamboo. It might be the case that we only + alone. Of course, anyone on orchid can print to + bamboo. It might be the case that we only allow certain logins on orchid anyway, and want them to have - access to the printer. Or not. + access to the printer. Or not. There can be only one restricted group per printer. @@ -4310,14 +4310,14 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ If you have many users accessing the printers, you probably need to put an upper limit on the sizes of the files users can - submit to print. After all, there is only so much free space on + submit to print. After all, there is only so much free space on the filesystem that houses the spooling directories, and you also need to make sure there is room for the jobs of other users. LPD enables you to limit the maximum byte size a file in a job can be with the mx capability. - The units are in BUFSIZ blocks, which are 1024 bytes. If you + The units are in BUFSIZ blocks, which are 1024 bytes. If you put a zero for this capability, there will be no limit on file size. @@ -4327,13 +4327,13 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ LPD will not refuse a file that is larger than the limit you - place on a printer. Instead, it will queue as much of the file - up to the limit, which will then get printed. The rest will be - discarded. Whether this is correct behavior is up for + place on a printer. Instead, it will queue as much of the file + up to the limit, which will then get printed. The rest will be + discarded. Whether this is correct behavior is up for debate. Let us add limits to our example printers - rattan and bamboo. Since those artists' PostScript + rattan and bamboo. Since those artists' PostScript files tend to be large, we will limit them to five megabytes. We will put no limit on the plain text line printer: @@ -4360,10 +4360,10 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ :df=/usr/local/libexec/psdf: Again, the limits apply to the local users - only. If you have set up access to your printers remotely, - remote users will not get those limits. You will need to + only. If you have set up access to your printers remotely, + remote users will not get those limits. You will need to specify the mx capability in the - remote /etc/printcap files as well. See + remote /etc/printcap files as well. See section Printers Installed on Remote Hosts for more information on @@ -4388,13 +4388,13 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ You can control from which remote hosts a local LPD accepts requests with the files /etc/hosts.equiv and - /etc/hosts.lpd. LPD checks to see + /etc/hosts.lpd. LPD checks to see if an incoming request is from a host listed in either - one of these files. If not, LPD refuses the + one of these files. If not, LPD refuses the request. The format of these files is simple: one host name - per line. Note that the file + per line. Note that the file /etc/hosts.equiv is also used by the ruserok3 protocol, and affects programs like @@ -4424,15 +4424,15 @@ madrigal.fishbaum.de You can control how much free space there needs to remain on the filesystem where a spooling directory - resides. Make a file called + resides. Make a file called minfree in the spooling directory - for the local printer. Insert in that file a number + for the local printer. Insert in that file a number representing how many disk blocks (512 bytes) of free space there has to be for a remote job to be accepted. This lets you insure that remote users will not fill - your filesystem. You can also use it to give a certain + your filesystem. You can also use it to give a certain priority to local users: they will be able to queue jobs long after the free disk space has fallen below the amount specified in the minfree @@ -4440,7 +4440,7 @@ madrigal.fishbaum.de For example, let us add a minfree file for the printer - bamboo. We examine + bamboo. We examine /etc/printcap to find the spooling directory for this printer; here is bamboo's entry: @@ -4453,7 +4453,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ :df=/usr/local/libexec/psdf: The spooling directory is the given - in the sd capability. We + in the sd capability. We will make three megabytes (which is 6144 disk blocks) the amount of free disk space that must exist on the filesystem for LPD to accept remote jobs: @@ -4470,18 +4470,18 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ You can control which remote users can print to local printers by specifying the rs capability in - /etc/printcap. When rs appears in the entry for a + /etc/printcap. When rs appears in the entry for a locally-attached printer, LPD will accept jobs from remote hosts if the user submitting the job also has an account of the same login name on - the local host. Otherwise, LPD refuses the job. + the local host. Otherwise, LPD refuses the job. This capability is particularly useful in an environment where there are (for example) different departments sharing a network, and some users transcend - departmental boundaries. By giving them accounts on + departmental boundaries. By giving them accounts on your systems, they can use your printers from their own - departmental systems. If you would rather allow them to + departmental systems. If you would rather allow them to use only your printers and not your compute resources, you can give them “token” accounts, with no home directory and a useless shell like @@ -4498,16 +4498,16 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Accounting for Printer Usage - So, you need to charge for printouts. And why not? Paper - and ink cost money. And then there are maintenance + So, you need to charge for printouts. And why not? Paper + and ink cost money. And then there are maintenance costs—printers are loaded with moving parts and tend to break - down. You have examined your printers, usage patterns, and + down. You have examined your printers, usage patterns, and maintenance fees and have come up with a per-page (or per-foot, - per-meter, or per-whatever) cost. Now, how do you actually start + per-meter, or per-whatever) cost. Now, how do you actually start accounting for printouts? Well, the bad news is the LPD spooling system does not provide - much help in this department. Accounting is highly dependent on + much help in this department. Accounting is highly dependent on the kind of printer in use, the formats being printed, and your requirements in charging for printer usage. @@ -4515,8 +4515,8 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ To implement accounting, you have to modify a printer's text filter (to charge for plain text jobs) and the conversion filters (to charge for other file formats), to count pages or query the - printer for pages printed. You cannot get away with using the - simple output filter, since it cannot do accounting. See section + printer for pages printed. You cannot get away with using the + simple output filter, since it cannot do accounting. See section Filters. @@ -4525,21 +4525,21 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Periodic accounting is the more - common way, possibly because it is easier. Whenever someone + common way, possibly because it is easier. Whenever someone prints a job, the filter logs the user, host, and number of - pages to an accounting file. Every month, semester, year, + pages to an accounting file. Every month, semester, year, or whatever time period you prefer, you collect the accounting files for the various printers, tally up the - pages printed by users, and charge for usage. Then you + pages printed by users, and charge for usage. Then you truncate all the logging files, starting with a clean slate for the next period. Timely accounting is less common, - probably because it is more difficult. This method has the + probably because it is more difficult. This method has the filters charge users for printouts as soon as they use the - printers. Like disk quotas, the accounting is immediate. + printers. Like disk quotas, the accounting is immediate. You can prevent users from printing when their account goes in the red, and might provide a way for users to check and adjust their “print quotas.” But this method requires some @@ -4551,12 +4551,12 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ The LPD spooling system supports both methods easily: since you have to provide the filters (well, most of the time), you also - have to provide the accounting code. But there is a bright side: - you have enormous flexibility in your accounting methods. For + have to provide the accounting code. But there is a bright side: + you have enormous flexibility in your accounting methods. For example, you choose whether to use periodic or timely accounting. You choose what information to log: user names, host names, job types, pages printed, square footage of paper used, how long the - job took to print, and so forth. And you do so by modifying the + job took to print, and so forth. And you do so by modifying the filters to save this information. @@ -4564,7 +4564,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Quick and Dirty Printer Accounting FreeBSD comes with two programs that can get you set up - with simple periodic accounting right away. They are the text + with simple periodic accounting right away. They are the text filter lpf, described in section lpf: a Text Filter, and @@ -4575,17 +4575,17 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ As mentioned in the section on filters (Filters), LPD starts the text and the conversion filters with the name of the - accounting file to use on the filter command line. The filters + accounting file to use on the filter command line. The filters can use this argument to know where to write an accounting file - entry. The name of this file comes from the af capability in + entry. The name of this file comes from the af capability in /etc/printcap, and if not specified as an absolute path, is relative to the spooling directory. LPD starts lpf with page width and length arguments (from the pw - and pl capabilities). lpf uses these arguments to determine how - much paper will be used. After sending the file to the printer, - it then writes an accounting entry in the accounting file. The + and pl capabilities). lpf uses these arguments to determine how + much paper will be used. After sending the file to the printer, + it then writes an accounting entry in the accounting file. The entries look like this: @@ -4598,19 +4598,19 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ You should use a separate accounting file for each printer, as lpf has no file locking logic built into it, and two lpfs might corrupt each other's entries if - they were to write to the same file at the same time. A easy way + they were to write to the same file at the same time. A easy way to insure a separate accounting file for each printer is to use af=acct in - /etc/printcap. Then, each accounting file + /etc/printcap. Then, each accounting file will be in the spooling directory for a printer, in a file named acct. When you are ready to charge users for printouts, run the pac - program. Just change to the spooling directory for the printer + program. Just change to the spooling directory for the printer you want to collect on and type - pac. You + pac. You will get a dollar-centric summary like the following: @@ -4634,7 +4634,7 @@ total 337.00 154 $ 6.74 Which printer to - summarize. This option works only if there is an + summarize. This option works only if there is an absolute path in the af capability in /etc/printcap. @@ -4651,9 +4651,9 @@ total 337.00 154 $ 6.74 - Ignore host name in the accounting files. With this + Ignore host name in the accounting files. With this option, user smith on host alpha is the same user smith - on host gamma. Without, they are different + on host gamma. Without, they are different users. @@ -4664,7 +4664,7 @@ total 337.00 154 $ 6.74 Compute charges with price dollars per page or per foot instead of the price from the pc capability in /etc/printcap, or two cents (the - default). You can specify price as a floating point + default). You can specify price as a floating point number. @@ -4697,7 +4697,7 @@ total 337.00 154 $ 6.74 In the default summary that pac produces, you see the number of pages printed by each user from - various hosts. If, at your site, host does not matter (because + various hosts. If, at your site, host does not matter (because users can use any host), run pac -m, to produce the following summary: @@ -4717,28 +4717,28 @@ total 337.00 154 $ 6.74 pac uses the pc capability in the /etc/printcap file (default of 200, or 2 - cents per page). Specify, in hundredths of cents, the price per + cents per page). Specify, in hundredths of cents, the price per page or per foot you want to charge for printouts in this - capability. You can override this value when you run + capability. You can override this value when you run pac with - the option. The units for the + the option. The units for the option are in dollars, though, not - hundredths of cents. For example, + hundredths of cents. For example, &prompt.root; pac -p1.50 makes each page cost one dollar and fifty - cents. You can really rake in the profits by using this + cents. You can really rake in the profits by using this option. Finally, running pac -s will save the summary information in a summary accounting file, which is named the same as the printer's accounting file, but with - _sum appended to the name. It then truncates - the accounting file. When you run + _sum appended to the name. It then truncates + the accounting file. When you run pac again, it rereads the summary file to get starting totals, then adds information from the regular accounting file. @@ -4749,12 +4749,12 @@ total 337.00 154 $ 6.74 How Can You Count Pages Printed? In order to perform even remotely accurate accounting, you - need to be able to determine how much paper a job uses. This is + need to be able to determine how much paper a job uses. This is the essential problem of printer accounting. For plain text jobs, the problem's not that hard to solve: you count how many lines are in a job and compare it to how many - lines per page your printer supports. Do not forget to take + lines per page your printer supports. Do not forget to take into account backspaces in the file which overprint lines, or long logical lines that wrap onto one or more additional physical lines. @@ -4762,7 +4762,7 @@ total 337.00 154 $ 6.74 The text filter lpf (introduced in lpf: a Text Filter) takes into account these things when it does - accounting. If you are writing a text filter which needs to do + accounting. If you are writing a text filter which needs to do accounting, you might want to examine lpf's source code. How do you handle other file formats, though? @@ -4771,24 +4771,24 @@ total 337.00 154 $ 6.74 you can have your filter parse the diagnostic output of dvilj or - dvips and look to see how many pages were converted. You might be able to do similar things with other file formats and conversion programs. + dvips and look to see how many pages were converted. You might be able to do similar things with other file formats and conversion programs. But these methods suffer from the fact that the printer may - not actually print all those pages. For example, it could jam, + not actually print all those pages. For example, it could jam, run out of toner, or explode—and the user would still get charged. So, what can you do? There is only one sure way to do - accurate accounting. Get a printer that + accurate accounting. Get a printer that can tell you how much paper it uses, and attach it via a serial - line or a network connection. Nearly all PostScript printers - support this notion. Other makes and models do as well - (networked Imagen laser printers, for example). Modify the + line or a network connection. Nearly all PostScript printers + support this notion. Other makes and models do as well + (networked Imagen laser printers, for example). Modify the filters for these printers to get the page usage after they print each job and have them log accounting information based on - that value only. There is no line counting + that value only. There is no line counting nor error-prone file examination required. Of course, you can always be generous and make all printouts @@ -4803,7 +4803,7 @@ total 337.00 154 $ 6.74 If you have been reading straight through this manual, by now you have learned just about everything there is to know about the - LPD spooling system that comes with FreeBSD. You can probably + LPD spooling system that comes with FreeBSD. You can probably appreciate many of its shortcomings, which naturally leads to the question: “What other spooling systems are out there (and work with FreeBSD)?” @@ -4819,7 +4819,7 @@ total 337.00 154 $ 6.74 PLP was based on software developed by Patrick Powell and then maintained by an Internet-wide group of developers. The main site for the software is at ftp://ftp.iona.ie/pub/plp. There is also a web page. + URL="ftp://ftp.iona.ie/pub/plp">ftp://ftp.iona.ie/pub/plp. There is also a web page. It is quite similar to the BSD LPD spooler, but boasts a host of features, including: @@ -4858,9 +4858,9 @@ total 337.00 154 $ 6.74 LPRng, which purportedly means “LPR: the Next - Generation” is a complete rewrite of PLP. Patrick Powell + Generation” is a complete rewrite of PLP. Patrick Powell and Justin Mason (the principal maintainer of PLP) - collaborated to make LPRng. The main site for LPRng is + collaborated to make LPRng. The main site for LPRng is ftp://dickory.sdsu.edu/pub/LPRng. diff --git a/en_US.ISO8859-1/books/handbook/security/chapter.sgml b/en_US.ISO8859-1/books/handbook/security/chapter.sgml index 2bc0726f7a..45fd5953d2 100644 --- a/en_US.ISO8859-1/books/handbook/security/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/security/chapter.sgml @@ -10,14 +10,14 @@ In order to protect the security of passwords on UN*X systems from being easily exposed, passwords have traditionally been - scrambled in some way. Starting with Bell Labs' Seventh Edition + scrambled in some way. Starting with Bell Labs' Seventh Edition Unix, passwords were encrypted using what the security people call a - “one-way hash function”. That is to say, the password is + “one-way hash function”. That is to say, the password is transformed in such a way that the original password cannot be regained except by brute-force searching the space of possible - passwords. Unfortunately, the only secure method that was available + passwords. Unfortunately, the only secure method that was available to the AT&T researchers at the time was based on DES, the Data - Encryption Standard. This causes only minimal difficulty for + Encryption Standard. This causes only minimal difficulty for commercial vendors, but is a serious problem for an operating system like FreeBSD where all the source code is freely available, because national governments in many places like to place restrictions on @@ -28,23 +28,23 @@ still not running afoul of the law? We decided to take a dual-track approach: we would make distributions which contained only a non-regulated password scrambler, and then provide as a separate - add-on library the DES-based password hash. The password-scrambling + add-on library the DES-based password hash. The password-scrambling function was moved out of the C library to a separate library, called libcrypt because the name of - the C function to implement it is crypt. In FreeBSD 1.x and some pre-release + the C function to implement it is crypt. In FreeBSD 1.x and some pre-release 2.0 snapshots, the non-regulated scrambler uses an insecure function written by Nate Williams; in subsequent releases this was replaced by a mechanism using the RSA Data Security, Inc., MD5 one-way hash - function. Because neither of these functions involve encryption, + function. Because neither of these functions involve encryption, they are believed to be exportable from the US and importable into many other countries. Meanwhile, work was also underway on the DES-based password hash - function. First, a version of the crypt function which was written outside the - US was imported, thus synchronizing the US and non-US code. Then, + function. First, a version of the crypt function which was written outside the + US was imported, thus synchronizing the US and non-US code. Then, the library was modified and split into two; the DES libcrypt contains only the code involved in performing the one-way password hash, and a separate libcipher was created with the entry points - to actually perform encryption. The code was partitioned in this + to actually perform encryption. The code was partitioned in this way to make it easier to get an export license for the compiled library. @@ -54,8 +54,8 @@ mechanism It is fairly easy to recognize whether a particular password - string was created using the DES- or MD5-based hash function. MD5 - password strings always begin with the characters $1$. DES password strings do not + string was created using the DES- or MD5-based hash function. MD5 + password strings always begin with the characters $1$. DES password strings do not have any particular identifying characteristics, but they are shorter than MD5 passwords, and are coded in a 64-character alphabet which does not include the $ character, so a relatively short @@ -63,10 +63,10 @@ password. Determining which library is being used on your system is - fairly easy for most programs, except for those like init which are statically linked. (For + fairly easy for most programs, except for those like init which are statically linked. (For those programs, the only way is to try them on a known password and see if it works.) Programs which use crypt are linked against libcrypt, which for each type of library is - a symbolic link to the appropriate implementation. For example, + a symbolic link to the appropriate implementation. For example, on a system using the DES versions: @@ -94,69 +94,69 @@ lrwxr-xr-x 1 bin bin 15 Sep 5 12:50 libcrypt_p.a -> libdescrypt_p.aS/Key is a one-time password scheme based on a one-way hash function (in our version, this is MD4 for compatibility; other - versions have used MD5 and DES-MAC). S/Key has been a standard part + versions have used MD5 and DES-MAC). S/Key has been a standard part of all FreeBSD distributions since version 1.1.5, and is also - implemented on a large and growing number of other systems. S/Key + implemented on a large and growing number of other systems. S/Key is a registered trademark of Bell Communications Research, Inc. There are three different sorts of passwords which we will talk - about in the discussion below. The first is your usual UNIX-style - or Kerberos password; we will call this a “UNIX password”. The + about in the discussion below. The first is your usual UNIX-style + or Kerberos password; we will call this a “UNIX password”. The second sort is the one-time password which is generated by the S/Key key program and accepted by the keyinit program and the login - prompt; we will call this a “one-time password”. The final sort + prompt; we will call this a “one-time password”. The final sort of password is the secret password which you give to the key program (and sometimes the keyinit program) which it uses to generate one-time passwords; we will call it a “secret password” or just unqualified “password”. The secret password does not necessarily have anything to do with your UNIX password (while they can be the same, this is not - recommended). While UNIX passwords are limited to eight characters + recommended). While UNIX passwords are limited to eight characters in length, your S/Key secret password can be as long as you like; I - use seven-word phrases. In general, the S/Key system operates + use seven-word phrases. In general, the S/Key system operates completely independently of the UNIX password system. There are in addition two other sorts of data involved in the S/Key system; one is called the “seed” or (confusingly) “key”, and consists of two letters and five digits, and the other is the - “iteration count” and is a number between 100 and 1. S/Key + “iteration count” and is a number between 100 and 1. S/Key constructs a one-time password from these components by concatenating the seed and the secret password, then applying a one-way hash (the RSA Data Security, Inc., MD4 secure hash function) iteration-count times, and turning the result into six short English - words. The login and su programs keep track of the last one-time + words. The login and su programs keep track of the last one-time password used, and the user is authenticated if the hash of the - user-provided password is equal to the previous password. Because a + user-provided password is equal to the previous password. Because a one-way hash function is used, it is not possible to generate future one-time passwords having overheard one which was successfully used; the iteration count is decremented after each successful login to - keep the user and login program in sync. (When you get the + keep the user and login program in sync. (When you get the iteration count down to 1, it is time to reinitialize S/Key.) There are four programs involved in the S/Key system which we - will discuss below. The key program + will discuss below. The key program accepts an iteration count, a seed, and a secret password, and - generates a one-time password. The keyinit program is used to initialized S/Key, + generates a one-time password. The keyinit program is used to initialized S/Key, and to change passwords, iteration counts, or seeds; it takes either a secret password, or an iteration count, seed, and one-time - password. The keyinfo program + password. The keyinfo program examines the /etc/skeykeys file and prints out - the invoking user's current iteration count and seed. Finally, the + the invoking user's current iteration count and seed. Finally, the login and su programs contain the necessary logic to - accept S/Key one-time passwords for authentication. The login program is also capable of disallowing + accept S/Key one-time passwords for authentication. The login program is also capable of disallowing the use of UNIX passwords on connections coming from specified addresses. - There are four different sorts of operations we will cover. The + There are four different sorts of operations we will cover. The first is using the keyinit program over a secure connection to set up S/Key for the first time, or to - change your password or seed. The second operation is using the + change your password or seed. The second operation is using the keyinit program over an insecure connection, in conjunction with the key program over a secure connection, to do - the same. The third is using the key program to log in over an insecure - connection. The fourth is using the key program to generate a number of keys + the same. The third is using the key program to log in over an insecure + connection. The fourth is using the key program to generate a number of keys which can be written down or printed out to carry with you when going to some location without secure connections to anywhere (like at a conference). @@ -185,14 +185,14 @@ HAS FONT GOUT FATE BOOM ) - There is a lot of information here. At theEnter secret + There is a lot of information here. At theEnter secret password: prompt, you should enter some password or phrase (I use phrases of minimum seven words) which will be needed to generate - login keys. The line starting `ID' gives the parameters of your + login keys. The line starting `ID' gives the parameters of your particular S/Key instance: your login name, the iteration count, - and seed. When logging in with S/Key, the system will remember + and seed. When logging in with S/Key, the system will remember these parameters and present them back to you so you do not have - to remember them. The last line gives the particular one-time + to remember them. The last line gives the particular one-time password which corresponds to those parameters and your secret password; if you were to re-login immediately, this one-time password is the one you would use. @@ -206,9 +206,9 @@ HAS FONT GOUT FATE BOOM ) insecure connection, you will need to already have a secure connection to some place where you can run the key program; this might be in the form of a desk accessory on a Macintosh, or a shell prompt on a machine you - trust (we will show the latter). You will also need to make up an + trust (we will show the latter). You will also need to make up an iteration count (100 is probably a good value), and you may make - up your own seed or use a randomly-generated one. Over on the + up your own seed or use a randomly-generated one. Over on the insecure connection (to the machine you are initializing), use the keyinit -s command: @@ -224,7 +224,7 @@ s/key 100 kh94742 To accept the default seed (which the keyinit program - confusingly calls a key), press return. Then move over to your + confusingly calls a key), press return. Then move over to your secure connection or S/Key desk accessory, and give it the same parameters: @@ -274,10 +274,10 @@ s/key 92 hi52030 Note that, before prompting for a password, the login program prints out the iteration number and seed which you will need in - order to generate the appropriate key. You will also find a + order to generate the appropriate key. You will also find a useful feature (not shown here): if you press return at the password prompt, the login program will turn echo on, so you can - see what you are typing. This can be extremely useful if you are + see what you are typing. This can be extremely useful if you are attempting to type in an S/Key by hand, such as from a printout. @@ -293,13 +293,13 @@ s/key 92 hi52030 Generating a single one-time password Now, to generate the one-time password needed to answer this - login prompt, we use a trusted machine and the key program. (There are versions of the + login prompt, we use a trusted machine and the key program. (There are versions of the key program from DOS and Windows machines, and there is an S/Key desk accessory for Macintosh computers as well.) The command-line key program takes as its parameters the iteration count and seed; you can cut-and-paste right from the login prompt starting at key to - the end of the line. Thus: + the end of the line. Thus: @@ -324,7 +324,7 @@ Last login: Wed Jun 28 15:31:00 from halloran-eldar.l This is the easiest mechanism if you have - a trusted machine. There is a Java S/Key key applet, key applet, The Java OTP Calculator, that you can download and run locally on any Java supporting brower. @@ -335,10 +335,10 @@ Last login: Wed Jun 28 15:31:00 from halloran-eldar.l Generating multiple one-time passwords Sometimes we have to go places where no trusted machines or - connections are available. In this case, it is possible to use + connections are available. In this case, it is possible to use the key command to generate a number of one-time passwords in the same command; these can then - be printed out. For example: + be printed out. For example: @@ -356,10 +356,10 @@ Reminder - Do not use this program while logged in via telnet or rlogin. The requests twenty-five keys in sequence; the indicates the ending iteration number; and the rest is as - before. Note that these are printed out in - reverse order of eventual use. If you are + before. Note that these are printed out in + reverse order of eventual use. If you are really paranoid, you might want to write the results down by hand; - otherwise you can cut-and-paste into lpr. Note that each line shows both the + otherwise you can cut-and-paste into lpr. Note that each line shows both the iteration count and the one-time password; you may still find it handy to scratch off passwords as you use them. @@ -371,17 +371,17 @@ Reminder - Do not use this program while logged in via telnet or rlogin. The configuration file /etc/skey.access can be used to configure restrictions on the use of UNIX passwords based on the host name, user name, terminal port, or IP address of - a login session. The complete format of the file is documented in + a login session. The complete format of the file is documented in the skey.access5 manual page; there are also some security cautions there which should be read before depending on this file for security. If there is no /etc/skey.access file (which is the default state as FreeBSD is shipped), then all users - will be allowed to use UNIX passwords. If the file exists, + will be allowed to use UNIX passwords. If the file exists, however, then all users will be required to use S/Key unless explicitly permitted to do otherwise by configuration statements - in the skey.access file. In all cases, UNIX + in the skey.access file. In all cases, UNIX passwords are permitted on the console. Here is a sample configuration file which illustrates the @@ -395,7 +395,7 @@ permit port ttyd0 The first line (permit internet) allows users whose IP source address (which is vulnerable to spoofing) matches the specified value and - mask, to use UNIX passwords. This should not be considered a + mask, to use UNIX passwords. This should not be considered a security mechanism, but rather, a means to remind authorized users that they are using an insecure network and need to use S/Key for authentication. @@ -427,7 +427,7 @@ permit port ttyd0 more controllable. The following instructions can be used as a guide on how to set - up Kerberos as distributed for FreeBSD. However, you should refer to + up Kerberos as distributed for FreeBSD. However, you should refer to the relevant manual pages for a complete description. In FreeBSD, the Kerberos is not that from the original @@ -438,7 +438,7 @@ permit port ttyd0 For those needing to get a legal foreign distribution of this software, please do not get it from a USA or - Canada site. You will get that site in big + Canada site. You will get that site in big trouble! A legal copy of this is available from ftp.internat.freebsd.org, which is in South Africa and an official FreeBSD mirror site. @@ -447,8 +447,8 @@ permit port ttyd0 Creating the initial database - This is done on the Kerberos server only. First make sure that - you do not have any old Kerberos databases around. You should + This is done on the Kerberos server only. First make sure that + you do not have any old Kerberos databases around. You should change to the directory /etc/kerberosIV and check that only the following files are present: @@ -468,9 +468,9 @@ README krb.conf krb.realms You should now edit the krb.conf and krb.realms files to define your Kerberos - realm. In this case the realm will be + realm. In this case the realm will be GRONDAR.ZA and the server is - grunt.grondar.za. We edit or create the + grunt.grondar.za. We edit or create the krb.conf file: @@ -487,23 +487,23 @@ TELECOM.MIT.EDU bitsy.mit.edu ARC.NASA.GOV trident.arc.nasa.gov - In this case, the other realms do not need to be there. They + In this case, the other realms do not need to be there. They are here as an example of how a machine may be made aware of - multiple realms. You may wish to not include them for + multiple realms. You may wish to not include them for simplicity. - The first line names the realm in which this system works. The - other lines contain realm/host entries. The first item on a line + The first line names the realm in which this system works. The + other lines contain realm/host entries. The first item on a line is a realm, and the second is a host in that realm that is acting - as a “key distribution centre”. The words admin server + as a “key distribution centre”. The words admin server following a hosts name means that host also provides an - administrative database server. For further explanation of these + administrative database server. For further explanation of these terms, please consult the Kerberos man pages. Now we have to add grunt.grondar.za to the GRONDAR.ZA realm and also add an entry to put all hosts in the .grondar.za domain in - the GRONDAR.ZA realm. The + the GRONDAR.ZA realm. The krb.realms file would be updated as follows: @@ -516,16 +516,16 @@ grunt.grondar.za GRONDAR.ZA .mit.edu ATHENA.MIT.EDU - Again, the other realms do not need to be there. They are here + Again, the other realms do not need to be there. They are here as an example of how a machine may be made aware of multiple - realms. You may wish to remove them to simplify things. + realms. You may wish to remove them to simplify things. The first line puts the specific - system into the named realm. The rest of the lines show how to + system into the named realm. The rest of the lines show how to default systems of a particular subdomain to a named realm. - Now we are ready to create the database. This only needs to - run on the Kerberos server (or Key Distribution Centre). Issue the + Now we are ready to create the database. This only needs to + run on the Kerberos server (or Key Distribution Centre). Issue the kdb_init command to do this: @@ -538,7 +538,7 @@ It is important that you NOT FORGET this password. Now we have to save the key so that servers on the local - machine can pick it up. Use the kstash command to do this. + machine can pick it up. Use the kstash command to do this. &prompt.root; kstash @@ -559,7 +559,7 @@ Master key entered. BEWARE! Making it all run Two principals need to be added to the database for each system that will be secured with - Kerberos. Their names are kpasswd + Kerberos. Their names are kpasswd and rcmd These two principals are made for each system, with the instance being the name of the individual system. @@ -630,11 +630,11 @@ Edit O.K. Creating the server file We now have to extract all the instances which define the - services on each machine. For this we use the - ext_srvtab command. This will create a file which + services on each machine. For this we use the + ext_srvtab command. This will create a file which must be copied or moved by secure means to each Kerberos client's /etc/kerberosIV - directory. This file must be present on each server and client, + directory. This file must be present on each server and client, and is crucial to the operation of Kerberos. @@ -649,7 +649,7 @@ Generating 'grunt-new-srvtab'.... Now, this command only generates a temporary file which must be renamed to srvtab so that all the - server can pick it up. Use the mv + server can pick it up. Use the mv command to move it into place on the original system: @@ -658,7 +658,7 @@ Generating 'grunt-new-srvtab'.... If the file is for a client system, and the network is not deemed safe, then copy the client-new-srvtab to removable media - and transport it by secure physical means. Be sure to rename it to + and transport it by secure physical means. Be sure to rename it to srvtab in the client's /etc/kerberosIV directory, and make sure it is mode 600: @@ -672,8 +672,8 @@ Generating 'grunt-new-srvtab'.... Populating the database - We now have to add some user entries into the database. First - let's create an entry for the user jane. Use + We now have to add some user entries into the database. First + let's create an entry for the user jane. Use the kdb_edit command to do this: @@ -710,10 +710,10 @@ Edit O.K. Testing it all out - First we have to start the Kerberos daemons. NOTE that if you + First we have to start the Kerberos daemons. NOTE that if you have correctly edited your /etc/rc.conf then - this will happen automatically when you reboot. This is only - necessary on the Kerberos server. Kerberos clients will + this will happen automatically when you reboot. This is only + necessary on the Kerberos server. Kerberos clients will automagically get what they need from the /etc/kerberosIV directory. @@ -777,10 +777,10 @@ Password changed. Adding <command>su</command> privileges Kerberos allows us to give each - user who needs root privileges their own separate supassword. We could now add an id which is - authorized to su to root. This is controlled by having an + user who needs root privileges their own separate supassword. We could now add an id which is + authorized to su to root. This is controlled by having an instance of root associated with a - principal. Using kdb_edit we can create the + principal. Using kdb_edit we can create the entry jane.root in the Kerberos database: @@ -855,7 +855,7 @@ May 2 20:43:12 May 3 04:43:12 krbtgt.GRONDAR.ZA@GRONDAR.ZA Using other commands In an earlier example, we created a principal called - jane with an instance root. This was based on a user with the same + jane with an instance root. This was based on a user with the same name as the principal, and this is a Kerberos default; that a <principal>.<instance> of the form <username>.root will allow that @@ -926,7 +926,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Firewalls are an area of increasing interest for people who are connected to the Internet, and are even finding applications on - private networks to provide enhanced security. This section will + private networks to provide enhanced security. This section will hopefully explain what firewalls are, how to use them, and how to use the facilities provided in the FreeBSD kernel to implement them. @@ -937,10 +937,10 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 will solve all your security problems. It may help, but a poorly setup firewall system is more of a - security risk than not having one at all. A firewall can only add + security risk than not having one at all. A firewall can only add another layer of security to your systems, but they will not be able to stop a really determined cracker from penetrating your - internal network. If you let internal security lapse because you + internal network. If you let internal security lapse because you believe your firewall to be impenetrable, you have just made the crackers job that bit easier. @@ -950,10 +950,10 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 What is a firewall? There are currently two distinct types of firewalls in common - use on the Internet today. The first type is more properly called + use on the Internet today. The first type is more properly called a packet filtering router, where the kernel on a multi-homed machine chooses whether to forward or - block packets based on a set of rules. The second type, known as + block packets based on a set of rules. The second type, known as proxy servers, rely on daemons to provide authentication and to forward packets, possibly on a multi-homed machine which has kernel packet forwarding @@ -962,13 +962,13 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Sometimes sites combine the two types of firewalls, so that only a certain machine (known as a bastion host) is allowed to send packets through a packet - filtering router onto an internal network. Proxy services are run + filtering router onto an internal network. Proxy services are run on the bastion host, which are generally more secure than normal authentication mechanisms. FreeBSD comes with a kernel packet filter (known as IPFW), which is what the rest of this section - will concentrate on. Proxy servers can be built on FreeBSD from + will concentrate on. Proxy servers can be built on FreeBSD from third party software, but there is such a variety of proxy servers available that it would be impossible to cover them in this document. @@ -978,22 +978,22 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Packet filtering routers A router is a machine which forwards packets between two or - more networks. A packet filtering router has an extra piece of + more networks. A packet filtering router has an extra piece of code in its kernel, which compares each packet to a list of - rules before deciding if it should be forwarded or not. Most + rules before deciding if it should be forwarded or not. Most modern IP routing software has packet filtering code in it, - which defaults to forwarding all packets. To enable the filters, + which defaults to forwarding all packets. To enable the filters, you need to define a set of rules for the filtering code, so that it can decide if the packet should be allowed to pass or not. To decide if a packet should be passed on or not, the code looks through its set of rules for a rule which matches the - contents of this packets headers. Once a match is found, the - rule action is obeyed. The rule action could be to drop the + contents of this packets headers. Once a match is found, the + rule action is obeyed. The rule action could be to drop the packet, to forward the packet, or even to send an ICMP message - back to the originator. Only the first match counts, as the - rules are searched in order. Hence, the list of rules can be + back to the originator. Only the first match counts, as the + rules are searched in order. Hence, the list of rules can be referred to as a “rule chain”. The packet matching criteria varies depending on the @@ -1012,7 +1012,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 daemons (telnetd, ftpd, etc) replaced with special servers. These servers are called proxy servers as they normally only allow onward - connections to be made. This enables you to run (for example) a + connections to be made. This enables you to run (for example) a proxy telnet server on your firewall host, and people can telnet in to your firewall from the outside, go through some authentication mechanism, and then gain access to the internal @@ -1024,14 +1024,14 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 available, including “one-shot” password systems so that even if someone manages to discover what password you used, they will not be able to use it to gain access to your systems as the - password instantly expires. As they do not actually give users + password instantly expires. As they do not actually give users access to the host machine, it becomes a lot more difficult for someone to install backdoors around your security system. Proxy servers often have ways of restricting access further, so that only certain hosts can gain access to the servers, and often they can be set up so that you can limit which users can - talk to which destination machine. Again, what facilities are + talk to which destination machine. Again, what facilities are available depends largely on what proxy software you choose. @@ -1044,14 +1044,14 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 IPFW, the software supplied with FreeBSD, is a packet filtering and accounting system which resides in the kernel, and has a user-land control utility, - ipfw8. Together, they allow you to define and + ipfw8. Together, they allow you to define and query the rules currently used by the kernel in its routing decisions. There are two related parts to IPFW. The - firewall section allows you to perform packet filtering. There is + firewall section allows you to perform packet filtering. There is also an IP accounting section which allows you to track usage of - your router, based on similar rules to the firewall section. This + your router, based on similar rules to the firewall section. This allows you to see (for example) how much traffic your router is getting from a certain machine, or how much WWW (World Wide Web) traffic it is forwarding. @@ -1059,7 +1059,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 As a result of the way that IPFW is designed, you can use IPFW on non-router machines to perform packet filtering on incoming and outgoing - connections. This is a special case of the more general use of + connections. This is a special case of the more general use of IPFW, and the same commands and techniques should be used in this situation. @@ -1071,7 +1071,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 As the main part of the IPFW system lives in the kernel, you will need to add one or more options to your kernel configuration file, depending on what facilities you want, - and recompile your kernel. See + and recompile your kernel. See reconfiguring the kernel for more details on how to recompile your kernel. @@ -1091,7 +1091,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Enables code to allow logging of packets through - syslogd8. Without this option, even + syslogd8. Without this option, even if you specify that packets should be logged in the filter rules, nothing will happen. @@ -1101,14 +1101,14 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Limits the number of packets logged through - syslogd8 on a per entry basis. You + syslogd8 on a per entry basis. You may wish to use this option in hostile environments in which you want to log firewall activity, but do not want to be open to a denial of service attack via syslog flooding. When a chain entry reaches the packet limit specified, - logging is turned off for that particular entry. To + logging is turned off for that particular entry. To resume logging, you will need to reset the associated counter using the ipfw8 utility: @@ -1125,7 +1125,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Previous versions of FreeBSD contained an - IPFIREWALL_ACCT option. This is now obsolete as + IPFIREWALL_ACCT option. This is now obsolete as the firewall code automatically includes accounting facilities. @@ -1135,17 +1135,17 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Configuring IPFW The configuration of the IPFW software is - done through the ipfw8 utility. The syntax + done through the ipfw8 utility. The syntax for this command looks quite complicated, but it is relatively simple once you understand its structure. There are currently four different command categories used by the utility: addition/deletion, listing, flushing, and clearing. Addition/deletion is used to build the rules that control how - packets are accepted, rejected, and logged. Listing is used to + packets are accepted, rejected, and logged. Listing is used to examine the contents of your rule set (otherwise known as the - chain) and packet counters (accounting). Flushing is used to - remove all entries from the chain. Clearing is used to zero out + chain) and packet counters (accounting). Flushing is used to + remove all entries from the chain. Clearing is used to zero out one or more accounting entries. @@ -1181,7 +1181,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 The command given can be shortened to - the shortest unique form. The valid + the shortest unique form. The valid commands are: @@ -1204,7 +1204,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Previous versions of IPFW used separate - firewall and accounting entries. The present version provides + firewall and accounting entries. The present version provides packet accounting with each firewall entry. If an index value is supplied, @@ -1232,7 +1232,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 allow - Pass the packet on as normal. (aliases: + Pass the packet on as normal. (aliases: pass and accept) @@ -1240,7 +1240,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 deny - Drop the packet. The source is not notified via an + Drop the packet. The source is not notified via an ICMP message (thus it appears that the packet never arrived at the destination). @@ -1250,7 +1250,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Update packet counters but do not allow/deny the - packet based on this rule. The search continues with + packet based on this rule. The search continues with the next chain entry. @@ -1310,9 +1310,9 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 The is optional and may specify the IP address or domain name of a local IP interface, - or an interface name (e.g. ed0) to - match only packets coming through this interface. Interface unit - numbers can be specified with an optional wildcard. For example, + or an interface name (e.g. ed0) to + match only packets coming through this interface. Interface unit + numbers can be specified with an optional wildcard. For example, ppp* would match all kernel PPP interfaces. @@ -1336,11 +1336,11 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 A valid hostname may be specified in place of the IP - address. is a decimal + address. is a decimal number representing how many bits in the address mask should be - set. e.g. specifying 192.216.222.1/24 will create a mask which will allow any + set. e.g. specifying 192.216.222.1/24 will create a mask which will allow any address in a class C subnet (in this case, 192.216.222) to be - matched. is an IP + matched. is an IP address which will be logically AND'ed with the address given. The keyword any may be used to specify “any IP address”. @@ -1354,7 +1354,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 port-port - to specify a range of ports. You may also + to specify a range of ports. You may also combine a single range with a list, but the range must always be specified first. @@ -1388,12 +1388,12 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Matches if the IP header contains the comma separated list of options specified in - spec. The supported list of IP + spec. The supported list of IP options are: ssrr (strict source route), lsrr (loose source route), rr (record packet route), and ts - (timestamp). The absence of a particular option may be + (timestamp). The absence of a particular option may be denoted with a leading !. @@ -1403,7 +1403,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Matches if the packet is part of an already established TCP connection (i.e. it has the RST or ACK - bits set). You can optimize the performance of the + bits set). You can optimize the performance of the firewall by placing established rules early in the chain. @@ -1422,11 +1422,11 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Matches if the TCP header contains the comma - separated list of flags. The + separated list of flags. The supported flags are fin, syn, rst, psh, ack, and - urg. The absence of a particular + urg. The absence of a particular flag may be indicated by a leading !. @@ -1435,9 +1435,9 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Matches if the ICMP type is present in the list - types. The list may be specified + types. The list may be specified as any combination of ranges and/or individual types - separated by commas. Commonly used ICMP types are: + separated by commas. Commonly used ICMP types are: 0 echo reply (ping reply), 3 destination unreachable, 5 redirect, 8 echo request (ping request), and @@ -1470,7 +1470,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 -a - While listing, show counter values. This option is + While listing, show counter values. This option is the only way to see accounting counters. @@ -1507,7 +1507,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 This causes all entries in the firewall chain to be removed except the fixed default policy enforced by the kernel (index - 65535). Use caution when flushing rules, the default deny + 65535). Use caution when flushing rules, the default deny policy will leave your system cut off from the network until allow entries are added to the chain. @@ -1524,7 +1524,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 When used without an index argument, - all packet counters are cleared. If an + all packet counters are cleared. If an index is supplied, the clearing operation only affects a specific chain entry. @@ -1582,7 +1582,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Building a packet filtering firewall - The following suggestions are just that: suggestions. The + The following suggestions are just that: suggestions. The requirements of each firewall are different and I cannot tell you how to build a firewall to meet your particular requirements. @@ -1591,9 +1591,9 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 When initially setting up your firewall, unless you have a test bench setup where you can configure your firewall host in a controlled environment, I strongly recommend you use the logging - version of the commands and enable logging in the kernel. This + version of the commands and enable logging in the kernel. This will allow you to quickly identify problem areas and cure them - without too much disruption. Even after the initial setup phase is + without too much disruption. Even after the initial setup phase is complete, I recommend using the logging for of `deny' as it allows tracing of possible attacks and also modification of the firewall rules if your requirements alter. @@ -1603,25 +1603,25 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 large amounts of log data as one log line will be generated for every packet that passes through the firewall, so large ftp/http transfers, etc, will really slow the - system down. It also increases the latencies on those packets as + system down. It also increases the latencies on those packets as it requires more work to be done by the kernel before the packet - can be passed on. syslogd with also start using up a lot more + can be passed on. syslogd with also start using up a lot more processor time as it logs all the extra data to disk, and it could quite easily fill the partition /var/log is located on. As currently supplied, FreeBSD does not have the ability to - load firewall rules at boot time. My suggestion is to put a call + load firewall rules at boot time. My suggestion is to put a call to a shell script in the /etc/netstart - script. Put the call early enough in the netstart file so that the + script. Put the call early enough in the netstart file so that the firewall is configured before any of the IP interfaces are - configured. This means that there is no window during which time + configured. This means that there is no window during which time your network is open. The actual script used to load the rules is entirely up to - you. There is currently no support in the ipfw utility for loading multiple rules in - the one command. The system I use is to use the command: + you. There is currently no support in the ipfw utility for loading multiple rules in + the one command. The system I use is to use the command: &prompt.root; ipfw list @@ -1629,8 +1629,8 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 to write a list of the current rules out to a file, and then use a text editor to prepend ipfw - before all the lines. This will allow the script to - be fed into /bin/sh and reload the rules into the kernel. Perhaps + before all the lines. This will allow the script to + be fed into /bin/sh and reload the rules into the kernel. Perhaps not the most efficient way, but it works. The next problem is what your firewall should actually @@ -1650,33 +1650,33 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Block all incoming UDP - traffic. There are very few useful services that travel over + traffic. There are very few useful services that travel over UDP, and what useful traffic there is is normally a security - threat (e.g. Suns RPC and NFS protocols). This has its + threat (e.g. Suns RPC and NFS protocols). This has its disadvantages also, since UDP is a connectionless protocol, denying incoming UDP traffic also blocks the replies to - outgoing UDP traffic. This can cause a problem for people + outgoing UDP traffic. This can cause a problem for people (on the inside) using external archie (prospero) servers. If you want to allow access to archie, you'll have to allow packets coming from ports 191 and 1525 to any internal UDP - port through the firewall. ntp is another service you may + port through the firewall. ntp is another service you may consider allowing through, which comes from port 123. - Block traffic to port 6000 from the outside. Port 6000 + Block traffic to port 6000 from the outside. Port 6000 is the port used for access to X11 servers, and can be a security threat (especially if people are in the habit of doing xhost + on their - workstations). X11 can actually use a range of ports + workstations). X11 can actually use a range of ports starting at 6000, the upper limit being how many X displays - you can run on the machine. The upper limit as defined by + you can run on the machine. The upper limit as defined by RFC 1700 (Assigned Numbers) is 6063. Check what ports any internal servers use (e.g. SQL - servers, etc). It is probably a good idea to block those as + servers, etc). It is probably a good idea to block those as well, as they normally fall outside the 1-1024 range specified above. @@ -1689,8 +1689,8 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 URL="ftp://ftp.cert.org/pub/tech_tips/packet_filtering">ftp://ftp.cert.org/pub/tech_tips/packet_filtering As I said above, these are only - guidelines. You will have to decide what - filter rules you want to use on your firewall yourself. I cannot + guidelines. You will have to decide what + filter rules you want to use on your firewall yourself. I cannot accept ANY responsibility if someone breaks into your network, even if you follow the advice given above. diff --git a/en_US.ISO8859-1/books/handbook/serialcomms/chapter.sgml b/en_US.ISO8859-1/books/handbook/serialcomms/chapter.sgml index d6b6a4415c..e6b2d5de47 100644 --- a/en_US.ISO8859-1/books/handbook/serialcomms/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/serialcomms/chapter.sgml @@ -8,13 +8,13 @@ Assembled from FAQ. This section should give you some general information about - serial ports. If you do not find what you want here, check into the + serial ports. If you do not find what you want here, check into the Terminal and Dialup sections of the handbook. The ttydX (or cuaaX) device is the regular device you will want to open for your - applications. When a process opens the device, it will have a - default set of terminal I/O settings. You can see these settings + applications. When a process opens the device, it will have a + default set of terminal I/O settings. You can see these settings with the command @@ -22,8 +22,8 @@ When you change the settings to this device, the settings are in - effect until the device is closed. When it is reopened, it goes - back to the default set. To make changes to the default set, you + effect until the device is closed. When it is reopened, it goes + back to the default set. To make changes to the default set, you can open and adjust the settings of the “initial state” device. For example, to turn on CLOCAL mode, 8 bits, and XON/XOFF flow control by default for ttyd5, do: @@ -33,12 +33,12 @@ A good place to do this is in - /etc/rc.serial. Now, an application will have + /etc/rc.serial. Now, an application will have these settings by default when it opens ttyd5. It can still change these settings to its liking, though. You can also prevent certain settings from being changed by an - application by making adjustments to the “lock state” device. For + application by making adjustments to the “lock state” device. For example, to lock the speed of ttyd5 to 57600 bps, do @@ -51,7 +51,7 @@ bps. Naturally, you should make the initial state and lock state - devices writable only by root. The + devices writable only by root. The MAKEDEV script does not do this when it creates the device entries. @@ -65,31 +65,31 @@ Terminals provide a convenient and low-cost way to access the power of your FreeBSD system when you are not at the computer's - console or on a connected network. This section describes how to + console or on a connected network. This section describes how to use terminals with FreeBSD. Uses and Types of Terminals - The original Unix systems did not have consoles. Instead, + The original Unix systems did not have consoles. Instead, people logged in and ran programs through terminals that were - connected to the computer's serial ports. It is quite similar to + connected to the computer's serial ports. It is quite similar to using a modem and some terminal software to dial into a remote system to do text-only work. Today's PCs have consoles capable of high quality graphics, but the ability to establish a login session on a serial port still exists in nearly every Unix-style operating system today; - FreeBSD is no exception. By using a terminal attached to a unused + FreeBSD is no exception. By using a terminal attached to a unused serial port, you can log in and run any text program that you would normally run on the console or in an xterm window in the X Window System. For the business user, you can attach many terminals to a - FreeBSD system and place them on your employees' desktops. For a + FreeBSD system and place them on your employees' desktops. For a home user, a spare computer such as an older IBM PC or a Macintosh can be a terminal wired into a more powerful computer running - FreeBSD. You can turn what might otherwise be a single-user + FreeBSD. You can turn what might otherwise be a single-user computer into a powerful multiple user system. For FreeBSD, there are three kinds of terminals: @@ -120,16 +120,16 @@ Dumb Terminals Dumb terminals are specialized pieces of hardware that let - you connect to computers over serial lines. They are called + you connect to computers over serial lines. They are called “dumb” because they have only enough computational power to - display, send, and receive text. You cannot run any programs on - them. It is the computer to which you connect them that has all + display, send, and receive text. You cannot run any programs on + them. It is the computer to which you connect them that has all the power to run text editors, compilers, email, games, and so forth. There are hundreds of kinds of dumb terminals made by many manufacturers, including Digital Equipment Corporation's VT-100 - and Wyse's WY-75. Just about any kind will work with FreeBSD. + and Wyse's WY-75. Just about any kind will work with FreeBSD. Some high-end terminals can even display graphics, but only certain software packages can take advantage of these advanced features. @@ -149,7 +149,7 @@ All you need is the proper cable and some terminal emulation software to run on the computer. - Such a configuration is popular in homes. For example, if + Such a configuration is popular in homes. For example, if your spouse is busy working on your FreeBSD system's console, you can do some text-only work at the same time from a less powerful personal computer hooked up as a terminal to the @@ -161,8 +161,8 @@ X Terminals X terminals are the most sophisticated kind of terminal - available. Instead of connecting to a serial port, they usually - connect to a network like Ethernet. Instead of being relegated + available. Instead of connecting to a serial port, they usually + connect to a network like Ethernet. Instead of being relegated to text-only applications, they can display any X application. @@ -177,8 +177,8 @@ Cables and Ports To connect a terminal to your FreeBSD system, you need the - right kind of cable and a serial port to which to connect it. This - section tells you what to do. If you are already familiar with + right kind of cable and a serial port to which to connect it. This + section tells you what to do. If you are already familiar with your terminal and the cable it requires, skip to Configuration. @@ -190,7 +190,7 @@ serial—also known as RS-232C—cables to connect the terminal to the FreeBSD system. - There are a couple of kinds of serial cables. Which one + There are a couple of kinds of serial cables. Which one you'll use depends on the terminal you want to connect: @@ -198,15 +198,15 @@ If you are connecting a personal computer to act as a - terminal, use a null-modem cable. A null-modem cable connects + terminal, use a null-modem cable. A null-modem cable connects two computers or terminals together. If you have an actual terminal, your best source of information on what cable to use is the documentation that - accompanied the terminal. If you do not have the - documentation, then try a null-modem cable. If that does not work, then + accompanied the terminal. If you do not have the + documentation, then try a null-modem cable. If that does not work, then try a standard cable. @@ -223,13 +223,13 @@ Null-modem cables A null-modem cable passes some signals straight through, - like “signal ground,” but switches other signals. For + like “signal ground,” but switches other signals. For example, the “send data” pin on one end goes to the “receive data” pin on the other end. If you like making your own cables, here is a table showing a recommended way to construct a null-modem cable for - use with terminals. This table shows the RS-232C signal names + use with terminals. This table shows the RS-232C signal names and the pin numbers on a DB-25 connector. @@ -324,7 +324,7 @@ Standard RS-232C Cables A standard serial cable passes all the RS-232C signals - straight-through. That is, the “send data” pin on one end + straight-through. That is, the “send data” pin on one end of the cable goes to the “send data” pin on the other end. This is the type of cable to connect a modem to your FreeBSD system, and the type of cable needed for some @@ -345,17 +345,17 @@ Kinds of Ports - Several kinds of serial ports exist. Before you purchase + Several kinds of serial ports exist. Before you purchase or construct a cable, you need to make sure it will fit the ports on your terminal and on the FreeBSD system. - Most terminals will have DB25 ports. Personal computers, + Most terminals will have DB25 ports. Personal computers, including PCs running FreeBSD, will have DB25 or DB9 ports. If you have a multiport serial card for your PC, you may have RJ-12 or RJ-45 ports. See the documentation that accompanied the hardware for - specifications on the kind of port in use. A visual + specifications on the kind of port in use. A visual inspection of the port often works, too. @@ -364,19 +364,19 @@ Port Names In FreeBSD, you access each serial port through an entry - in the /dev directory. There are two + in the /dev directory. There are two different kinds of entries: Callin ports are named - /dev/ttydX where X is the port number, starting from zero. Generally, you use the callin port for terminals. Callin ports require that the serial line assert the data carrier detect (DCD) signal to work. + /dev/ttydX where X is the port number, starting from zero. Generally, you use the callin port for terminals. Callin ports require that the serial line assert the data carrier detect (DCD) signal to work. Callout ports are named - /dev/cuaaX. You usually do not use the callout port for terminals, just for modems. You may use the callout port if the serial cable or the terminal does not support the carrier detect signal. + /dev/cuaaX. You usually do not use the callout port for terminals, just for modems. You may use the callout port if the serial cable or the terminal does not support the carrier detect signal. @@ -385,13 +385,13 @@ If you have connected a terminal to the first serial port (COM1 in DOS parlance), then you want to use - /dev/ttyd0 to refer to the terminal. If + /dev/ttyd0 to refer to the terminal. If it is on the second serial port (also known as COM2), it is /dev/ttyd1, and so forth. Note that you may have to configure your kernel to support each serial port, especially if you have a multiport serial - card. See Configuring the FreeBSD Kernel for more + card. See Configuring the FreeBSD Kernel for more information. @@ -402,7 +402,7 @@ Configuration This section describes what you need to configure on your - FreeBSD system to enable a login session on a terminal. It + FreeBSD system to enable a login session on a terminal. It assumes you have already configured your kernel to support the serial port to which the terminal is connected—and that you have connected it. @@ -412,8 +412,8 @@ reading a login name and starting the login program. To do so, you have to edit the /etc/ttys - file. First, use the su command to - become root. Then, make the following changes to + file. First, use the su command to + become root. Then, make the following changes to /etc/ttys: @@ -449,16 +449,16 @@ As an optional step, you may wish to create a custom getty type for use in step 2 by making an - entry in /etc/gettytab. This document does + entry in /etc/gettytab. This document does not explain how to do so; you are encouraged to see the gettytab5 and the getty8 manual pages for more information. - The remaining sections detail how to do these steps. We will + The remaining sections detail how to do these steps. We will use a running example throughout these sections to illustrate what - we need to do. In our example, we will connect two terminals to + we need to do. In our example, we will connect two terminals to the system: a Wyse-50 and a old 286 IBM PC running Procomm - terminal software emulating a VT-100 terminal. We connect the Wyse + terminal software emulating a VT-100 terminal. We connect the Wyse to the second serial port and the 286 to the sixth serial port (a port on a multiport serial card). @@ -474,24 +474,24 @@ there. The /etc/ttys file lists all of the - ports on your FreeBSD system where you want to allow logins. For + ports on your FreeBSD system where you want to allow logins. For example, the first virtual console ttyv0 - has an entry in this file. You can log in on the console using - this entry. This file contains entries for the other virtual - consoles, serial ports, and pseudo-ttys. For a hardwired + has an entry in this file. You can log in on the console using + this entry. This file contains entries for the other virtual + consoles, serial ports, and pseudo-ttys. For a hardwired terminal, just list the serial port's /dev entry without the /dev part. When you installed your FreeBSD system, the /etc/ttys file included entries for the first four serial ports: ttyd0 through - ttyd3. If you are attaching a terminal on + ttyd3. If you are attaching a terminal on one of those ports, you do not need to add an entry. In our example, we attached a Wyse-50 to the second serial port, ttyd1, which is already in - the file. We need to add an entry for the 286 PC connected to - the sixth serial port. Here is an excerpt of the + the file. We need to add an entry for the 286 PC connected to + the sixth serial port. Here is an excerpt of the /etc/ttys file after we add the new entry: @@ -505,8 +505,8 @@ ttyd5 Type Next, we need to specify what program will be run to handle - the logins on a terminal. For FreeBSD, the standard program to - do that is /usr/libexec/getty. It is what + the logins on a terminal. For FreeBSD, the standard program to + do that is /usr/libexec/getty. It is what provides the login: prompt. The program getty takes one @@ -519,10 +519,10 @@ ttyd5 /etc/gettytab. The file /etc/gettytab contains lots of - entries for terminal lines both old and new. In almost all + entries for terminal lines both old and new. In almost all cases, the entries that start with the text std will work for hardwired terminals. - These entries ignore parity. There is a std entry for each bps rate from 110 to - 115200. Of course, you can add your own entries to this file. + These entries ignore parity. There is a std entry for each bps rate from 110 to + 115200. Of course, you can add your own entries to this file. The manual page gettytab5 provides more information. When setting the getty type in @@ -530,7 +530,7 @@ ttyd5 communications settings on the terminal match. For our example, the Wyse-50 uses no parity and connects at - 38400 bps. The 286 PC uses no parity and connects at 19200 bps. + 38400 bps. The 286 PC uses no parity and connects at 19200 bps. Here is the /etc/ttys file so far (showing just the two terminals in which we are interested): @@ -539,7 +539,7 @@ ttyd1 "/usr/libexec/getty std.38400" unknown off secure ttyd5 "/usr/libexec/getty std.19200" Note that the second field—where we specify - what program to run—appears in quotes. This is important, + what program to run—appears in quotes. This is important, otherwise the type argument to getty might be interpreted as the next field. @@ -549,7 +549,7 @@ ttyd5 "/usr/libexec/getty std.19200" Specifying the Default Terminal Type The third field in the /etc/ttys file - lists the default terminal type for the port. For dialup ports, + lists the default terminal type for the port. For dialup ports, you typically put unknown or dialup in this field because users may dial up with practically any kind of terminal or software. @@ -559,19 +559,19 @@ ttyd5 "/usr/libexec/getty std.19200" Users will usually use the tset program in their .login or .profile files to check the terminal type and prompt for one if - necessary. By setting a terminal type in the + necessary. By setting a terminal type in the /etc/ttys file, users can forego such prompting. To find out what terminal types FreeBSD supports, see the - file /usr/share/misc/termcap. It lists - about 600 terminal types. You can add more if you wish. See + file /usr/share/misc/termcap. It lists + about 600 terminal types. You can add more if you wish. See the termcap5 manual page for information. In our example, the Wyse-50 is a Wyse-50 type of terminal (although it can emulate others, we will leave it in Wyse-50 - mode). The 286 PC is running Procomm which will be set to - emulate a VT-100. Here are the pertinent yet unfinished entries + mode). The 286 PC is running Procomm which will be set to + emulate a VT-100. Here are the pertinent yet unfinished entries from the /etc/ttys file: @@ -584,15 +584,15 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 Enabling the Port The next field in /etc/ttys, the fourth - field, tells whether to enable the port. Putting on here will have the init process start the program in the + field, tells whether to enable the port. Putting on here will have the init process start the program in the second field, getty, which will - prompt for a login. If you put off in the fourth field, there will be no + prompt for a login. If you put off in the fourth field, there will be no getty, and hence no logins on the port. So, naturally, you want an on - in this field. Here again is the /etc/ttys - file. We have turned each port on. + in this field. Here again is the /etc/ttys + file. We have turned each port on. ttyd1 "/usr/libexec/getty std.38400" wy50 on secure @@ -605,21 +605,21 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on We have arrived at the last field (well, almost: there is an optional window specifier, but we - will ignore that). The last field tells whether the port is + will ignore that). The last field tells whether the port is secure. What does “secure” mean? It means that the root account (or any account with a user - ID of 0) may login on the port. Insecure ports do not allow + ID of 0) may login on the port. Insecure ports do not allow root to login. How do you use secure and insecure ports? By marking a port as insecure, the terminal to which it is - connected will not allow root to login. People who know the + connected will not allow root to login. People who know the root password to your FreeBSD system will first have to login - using a regular user account. To gain superuser privileges, + using a regular user account. To gain superuser privileges, they will then have to use the su command. @@ -629,14 +629,14 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on system log (and logins are also recorded in the wtmp file). By marking a port as secure, the terminal will allow root - in. People who know the root password will just login as root. + in. People who know the root password will just login as root. You will not have the potentially useful login and su command records. Which should you use? Just use “insecure.” Use “insecure” even for terminals not - in public user areas or behind locked doors. It is quite easy + in public user areas or behind locked doors. It is quite easy to login and use su if you need superuser privileges. @@ -659,7 +659,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroom After you edit /etc/ttys, you do not - want to have to reboot your system to get init to see the changes. So, init will reread + want to have to reboot your system to get init to see the changes. So, init will reread /etc/ttys if it receives a SIGHUP (hangup) signal. @@ -683,7 +683,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomDebugging your connection Even with the most meticulous attention to detail, something - could still go wrong while setting up a terminal. Here is a list + could still go wrong while setting up a terminal. Here is a list of symptoms and some suggested fixes. @@ -696,22 +696,22 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroom Make sure the cable is connected firmly to both the - terminal and the FreeBSD computer. Make sure it is the + terminal and the FreeBSD computer. Make sure it is the right kind of cable. Make sure the terminal and FreeBSD agree on the bps - rate and parity settings. If you have a video display + rate and parity settings. If you have a video display terminal, make sure the contrast and brightness controls - are turned up. If it is a printing terminal, make sure + are turned up. If it is a printing terminal, make sure paper and ink are in good supply. Make sure that a getty - process is running and serving the terminal. Type + process is running and serving the terminal. Type &prompt.root; ps -axww|grep getty - to get a list of running getty processes. You should see an - entry for the terminal. For example, the display + to get a list of running getty processes. You should see an + entry for the terminal. For example, the display 22189 d1 Is+ 0:00.03 /usr/libexec/getty std.38400 ttyd1 @@ -722,7 +722,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomIf no getty process is running, make sure you have enabled the port in - /etc/ttys. Make sure you have run + /etc/ttys. Make sure you have run kill -HUP 1. @@ -732,9 +732,9 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroom Make sure the terminal and FreeBSD agree on the bps - rate and parity settings. Check the getty processes to + rate and parity settings. Check the getty processes to make sure the correct getty - type is in use. If not, edit + type is in use. If not, edit /etc/ttys and run kill -HUP 1. @@ -761,7 +761,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomContributed by &a.ghelmer;. This document provides suggestions for configuring a FreeBSD - system to handle dialup modems. This document is written based on + system to handle dialup modems. This document is written based on the author's experience with FreeBSD versions 1.0, 1.1, and 1.1.5.1 (and experience with dialup modems on other UNIX-like operating systems); however, this document may not answer all of your @@ -774,9 +774,9 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomPrerequisites To begin with, the author assumes you have some basic - knowledge of FreeBSD. You need to have FreeBSD installed, know + knowledge of FreeBSD. You need to have FreeBSD installed, know how to edit files in a UNIX-like environment, and how to look up - manual pages on the system. As discussed below, you will need + manual pages on the system. As discussed below, you will need certain versions of FreeBSD, and knowledge of some terminology & modem and cabling. @@ -785,9 +785,9 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomFreeBSD Version First, it is assumed that you are using FreeBSD version 1.1 - or higher (including versions 2.x). FreeBSD version 1.0 + or higher (including versions 2.x). FreeBSD version 1.0 included two different serial drivers, which complicates the - situation. Also, the serial device driver (sio) has improved in every release of + situation. Also, the serial device driver (sio) has improved in every release of FreeBSD, so more recent versions of FreeBSD are assumed to have better and more efficient drivers than earlier versions. @@ -838,7 +838,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroom When talking about communications data rates, the author - does not use the term “baud”. Baud + does not use the term “baud”. Baud refers to the number of electrical state transitions that may be made in a period of time, while “bps” (bits per second) is the “correct” term to use (at least it does not seem to bother the curmudgeons @@ -853,12 +853,12 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroom Internal modems usually lack non-volatile RAM, so their - configuration may be limited only to setting DIP switches. If + configuration may be limited only to setting DIP switches. If your internal modem has any signal indicator lights, it is probably difficult to view the lights when the system's cover is in place. @@ -894,7 +894,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomThe first, connecting your modem, is usually simple — most - straight-through serial cables work without any problems. You + straight-through serial cables work without any problems. You need to have a cable with appropriate connectors (DB-25 or DB-9, male or female) on each end, and the cable must be a DCE-to-DTE cable with these signals wired: @@ -942,12 +942,12 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomCD signal to detect when a call has been answered or the line has been hung up, and the DTR signal to reset the modem after a session - is complete. Some cables are wired without all of the needed + is complete. Some cables are wired without all of the needed signals, so if you have problems, such as a login session not going away when the line hangs up, you may have a problem with your cable. - The second prerequisite depends on the modem(s) you use. If + The second prerequisite depends on the modem(s) you use. If you do not know your modem's command set by heart, you will need to have the modem's reference book or user's guide handy. Sample commands for USR Sportster 14,400 external modems will be @@ -955,12 +955,12 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroom Lastly, you will need to know how to setup your modem so - that it will work well with FreeBSD. Like other UNIX-like + that it will work well with FreeBSD. Like other UNIX-like operating systems, FreeBSD uses the hardware signals to find out when a call has been answered or a line has been hung up and to - hangup and reset the modem after a call. FreeBSD avoids sending + hangup and reset the modem after a call. FreeBSD avoids sending commands to the modem or watching for status reports from the - modem. If you are familiar with connecting modems to PC-based + modem. If you are familiar with connecting modems to PC-based bulletin board systems, this may seem awkward. @@ -970,11 +970,11 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomFreeBSD supports NS8250-, NS16450-, NS16550-, and NS16550A-based EIA RS-232C (CCITT V.24) communications - interfaces. The 8250 and 16450 devices have single-character - buffers. The 16550 device provides a 16-character buffer, which - allows for better system performance. (Bugs in plain 16550's + interfaces. The 8250 and 16450 devices have single-character + buffers. The 16550 device provides a 16-character buffer, which + allows for better system performance. (Bugs in plain 16550's prevent the use of the 16-character buffer, so use 16550A's if - possible). Because single-character-buffer devices require more + possible). Because single-character-buffer devices require more work by the operating system than the 16-character-buffer devices, 16550A-based serial interface cards are much prefered. If the system has many active serial ports or will have a heavy @@ -988,10 +988,10 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomQuick Overview Here is the process that FreeBSD follows to accept dialup - logins. A getty process, spawned by + logins. A getty process, spawned by init, patiently waits to open the assigned serial port (/dev/ttyd0, for our - example). The command ps ax might + example). The command ps ax might show this: @@ -1000,11 +1000,11 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomWhen a user dials the modem's line and the modems connect, the - CD line is asserted by the modem. The kernel + CD line is asserted by the modem. The kernel notices that carrier has been detected and completes getty's open of the - port. getty sends a login: prompt at the specified initial line - speed. getty watches to see if + port. getty sends a login: prompt at the specified initial line + speed. getty watches to see if legitimate characters are received, and, in a typical configuration, if it finds junk (probably due to the modem's connection speed being different than getty's speed), getty tries adjusting the line speeds until @@ -1012,7 +1012,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomWe hope getty finds the correct speed and the user sees a login: - prompt. After the user enters his/her login name, getty executes + prompt. After the user enters his/her login name, getty executes /usr/bin/login, which completes the login by asking for the user's password and then starting the user's shell. @@ -1030,14 +1030,14 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomCOM3:, and COM4:. FreeBSD can presently also handle “dumb” multiport serial interface cards, such as the Boca Board 1008 and 2016 (please see the manual page sio4 for kernel configuration information - if you have a multiport serial card). The default kernel only + if you have a multiport serial card). The default kernel only looks for the standard COM ports, though. To see if your kernel recognizes any of your serial ports, watch for messages while the kernel is booting, or use the /sbin/dmesg command to replay the - kernel's boot messages. In particular, look for messages that - start with the characters sio. Hint: + kernel's boot messages. In particular, look for messages that + start with the characters sio. Hint: to view just the messages that have the word sio, use the command: @@ -1069,16 +1069,16 @@ sio3: type 16550A in /usr/src/share/doc/smm] and “FreeBSD Configuration Options” [in /sys/conf/options and in - /sys/arch/conf/options.arch, with arch for example being i386] for more information on configuring and building kernels. You may have to unpack the kernel source distribution if have not installed the system sources already (srcdist/srcsys.?? in FreeBSD 1.1, srcdist/sys.?? in FreeBSD 1.1.5.1, or the entire source distribution in FreeBSD 2.0) to be able to configure and build kernels. + /sys/arch/conf/options.arch, with arch for example being i386] for more information on configuring and building kernels. You may have to unpack the kernel source distribution if have not installed the system sources already (srcdist/srcsys.?? in FreeBSD 1.1, srcdist/sys.?? in FreeBSD 1.1.5.1, or the entire source distribution in FreeBSD 2.0) to be able to configure and build kernels. Create a kernel configuration file for your system (if you have not already) by cding to - /sys/i386/conf. Then, if you are creating a + /sys/i386/conf. Then, if you are creating a new custom configuration file, copy the file GENERICAH (or GENERICBT, if you have a BusTek SCSI controller on FreeBSD 1.x) to YOURSYS, where YOURSYS - is the name of your system, but in upper-case letters. Edit the + is the name of your system, but in upper-case letters. Edit the file, and change the device lines: @@ -1088,9 +1088,9 @@ device sio2 at isa? port "IO_COM3" tty irq 5 vector siointr device sio3 at isa? port "IO_COM4" tty irq 9 vector siointr You can comment-out or completely remove lines for devices you - do not have. If you have a multiport serial board, such as the + do not have. If you have a multiport serial board, such as the Boca Board BB2016, please see the sio4 man page for complete information on - how to write configuration lines for multiport boards. Be careful + how to write configuration lines for multiport boards. Be careful if you are using a configuration file that was previously used for a different version of FreeBSD because the device flags have changed between versions. @@ -1103,7 +1103,7 @@ device sio3 at isa? port "IO_COM4" tty irq 9 vector siointr IO_COM4 is 0x2e8, which are fairly common port addresses for their respective serial ports; interrupts 4, 3, 5, and 9 are fairly common interrupt request - lines. Also note that regular serial ports cannot share interrupts on ISA-bus PCs + lines. Also note that regular serial ports cannot share interrupts on ISA-bus PCs (multiport boards have on-board electronics that allow all the 16550A's on the board to share one or two interrupt request lines). @@ -1123,18 +1123,18 @@ device sio3 at isa? port "IO_COM4" tty irq 9 vector siointr Most devices in the kernel are accessed through “device special files”, which are located in the - /dev directory. The sio devices are accessed through the + /dev directory. The sio devices are accessed through the /dev/ttyd? (dial-in) and - /dev/cua0? (call-out) devices. On FreeBSD + /dev/cua0? (call-out) devices. On FreeBSD version 1.1.5 and higher, there are also initialization devices (/dev/ttyid? and /dev/cuai0?) and locking devices (/dev/ttyld? and - /dev/cual0?). The initialization devices are + /dev/cual0?). The initialization devices are used to initialize communications port parameters each time a port is opened, such as crtscts for modems which use CTS/RTS signaling for flow - control. The locking devices are used to lock flags on ports to + control. The locking devices are used to lock flags on ports to prevent users or programs changing certain parameters; see the manual pages termios4, sio4, and stty1 for information on the terminal settings, locking & initializing @@ -1146,7 +1146,7 @@ device sio3 at isa? port "IO_COM4" tty irq 9 vector siointr A shell script called MAKEDEV in the /dev directory manages the device special - files. (The manual page for MAKEDEV8 on + files. (The manual page for MAKEDEV8 on FreeBSD 1.1.5 is fairly bogus in its discussion of COM ports, so ignore it.) To use MAKEDEV to make dialup device special files @@ -1167,7 +1167,7 @@ device sio3 at isa? port "IO_COM4" tty irq 9 vector siointr /dev/cua* files) to make sure that only users who should have access to those device special files can read & write on them — you probably do not want to allow - your average user to use your modems to dialout. The default + your average user to use your modems to dialout. The default permissions on the /dev/cua* files should be sufficient: @@ -1188,43 +1188,43 @@ crw-rw---- 1 uucp dialer 28, 193 Feb 15 14:38 /dev/cual01 There are three system configuration files in the /etc directory that you will probably need to - edit to allow dialup access to your FreeBSD system. The first, + edit to allow dialup access to your FreeBSD system. The first, /etc/gettytab, contains configuration information for the /usr/libexec/getty - daemon. Second, /etc/ttys holds information + daemon. Second, /etc/ttys holds information that tells /sbin/init what - tty devices should have getty processes running on them. Lastly, + tty devices should have getty processes running on them. Lastly, you can place port initialization commands in the /etc/rc.serial script if you have FreeBSD 1.1.5.1 or higher; otherwise, you can initialize ports in the /etc/rc.local script. There are two schools of thought regarding dialup modems on - UNIX. One group likes to configure their modems and system so + UNIX. One group likes to configure their modems and system so that no matter at what speed a remote user dials in, the local - computer-to-modem RS-232 interface runs at a locked speed. The + computer-to-modem RS-232 interface runs at a locked speed. The benefit of this configuration is that the remote user always sees - a system login prompt immediately. The downside is that the system + a system login prompt immediately. The downside is that the system does not know what a user's true data rate is, so full-screen programs like Emacs will not adjust their screen-painting methods to make their response better for slower connections. The other school configures their modems' RS-232 interface to - vary its speed based on the remote user's connection speed. For + vary its speed based on the remote user's connection speed. For example, V.32bis (14.4 Kbps) connections to the modem might make the modem run its RS-232 interface at 19.2 Kbps, while 2400 bps connections make the modem's RS-232 interface run at 2400 bps. Because getty does not understand any particular modem's connection speed reporting, getty gives a login: message at an initial speed and - watches the characters that come back in response. If the user + watches the characters that come back in response. If the user sees junk, it is assumed that they know they should press the <Enter> key until they see a - recognizable prompt. If the data rates do not match, getty sees anything the user types as + recognizable prompt. If the data rates do not match, getty sees anything the user types as “junk”, tries going to the next speed and gives the - login: prompt again. This procedure can + login: prompt again. This procedure can continue ad nauseum, but normally only takes a keystroke or two - before the user sees a good prompt. Obviously, this login sequence + before the user sees a good prompt. Obviously, this login sequence does not look as clean as the former “locked-speed” method, but a user on a low-speed connection should receive better interactive response from full-screen programs. @@ -1238,7 +1238,7 @@ crw-rw---- 1 uucp dialer 28, 193 Feb 15 14:38 /dev/cual01 <filename>/etc/gettytab</filename> /etc/gettytab is a termcap5-style file of configuration - information for getty8. Please see the + information for getty8. Please see the gettytab5 manual page for complete information on the format of the file and the list of capabilities. @@ -1258,8 +1258,8 @@ crw-rw---- 1 uucp dialer 28, 193 Feb 15 14:38 /dev/cual01 You will need to setup an entry in /etc/gettytab to give getty information about the speeds you - wish to use for your modem. If you have a 2400 bps modem, you - can probably use the existing D2400 entry. This entry already exists + wish to use for your modem. If you have a 2400 bps modem, you + can probably use the existing D2400 entry. This entry already exists in the FreeBSD 1.1.5.1 gettytab file, so you do not need to add it unless it is missing under your version of FreeBSD: @@ -1296,7 +1296,7 @@ uq|V19200|High Speed Modem at 19200,8-bit:\ :nx=V9600:tc=std.19200: On FreeBSD 1.1.5 and later, this will result in 8-bit, no - parity connections. Under FreeBSD 1.1, add + parity connections. Under FreeBSD 1.1, add :np: parameters to the std.xxx entries at the top of the file for 8 bits, no parity; otherwise, the default is 7 bits, even parity. @@ -1304,16 +1304,16 @@ uq|V19200|High Speed Modem at 19200,8-bit:\ The example above starts the communications rate at 19.2 Kbps (for a V.32bis connection), then cycles through 9600 bps (for V.32), 2400 bps, 1200 bps, 300 bps, and back to 19.2 - Kbps. Communications rate cycling is implemented with the + Kbps. Communications rate cycling is implemented with the nx= (“next - table”) capability. Each of the lines uses a + table”) capability. Each of the lines uses a tc= (“table continuation”) entry to pick up the rest of the “standard” settings for a particular data rate. If you have a 28.8 Kbps modem and/or you want to take advantage of compression on a 14.4 Kbps modem, you need to use - a higher communications rate than 19.2 Kbps. Here is an + a higher communications rate than 19.2 Kbps. Here is an example of a gettytab entry starting a 57.6 Kbps: @@ -1347,14 +1347,14 @@ vq|VH57600|Very High Speed Modem at 57600,8-bit:\ /etc/ttys also provides security information to login (user root may only login on ttys marked - secure). See the manual page for + secure). See the manual page for ttys5 for more information. You will need to either modify existing lines in /etc/ttys or add new lines to make init run getty processes automatically on your new - dialup ports. The general format of the line will be the same, + dialup ports. The general format of the line will be the same, whether you are using a locked-speed or matching-speed configuration: @@ -1363,38 +1363,38 @@ ttyd0 "/usr/libexec/getty xxx" dialup on The first item in the above line is the device special file for this entry — ttyd0 means - /dev/ttyd0 is the file that this getty will be watching. The second item, + /dev/ttyd0 is the file that this getty will be watching. The second item, "/usr/libexec/getty xxx" (xxx will be replaced by the initial gettytab capability) is the process init will run on the - device. The third item, dialup, - is the default terminal type. The fourth parameter, - on, indicates to init that the line is operational. There + device. The third item, dialup, + is the default terminal type. The fourth parameter, + on, indicates to init that the line is operational. There can be a fifth parameter, secure, but it should only be used for terminals which are physically secure (such as the system console). The default terminal type (dialup in the example above) may depend on - local preferences. dialup is the + local preferences. dialup is the traditional default terminal type on dialup lines so that users may customize their login scripts to notice when the terminal is dialup and automatically adjust - their terminal type. However, the author finds it easier at his + their terminal type. However, the author finds it easier at his site to specify vt102 as the default terminal type, since the users just use VT102 emulation on their remote systems. After you have made changes to /etc/ttys, you may send the init process a HUP - signal to re-read the file. You can use the command + signal to re-read the file. You can use the command &prompt.root; kill -1 1 - to send the signal. If this is your first time setting up + to send the signal. If this is your first time setting up the system, though, you may want to wait until your modem(s) are properly configured and connected before signaling init. @@ -1403,7 +1403,7 @@ ttyd0 "/usr/libexec/getty xxx" dialup on Locked-Speed Config For a locked-speed configuration, your ttys entry needs to have a fixed-speed - entry provided to getty. For a + entry provided to getty. For a modem whose port speed is locked at 19.2 Kbps, the ttys entry might look like this: @@ -1422,7 +1422,7 @@ ttyd0 "/usr/libexec/getty std.19200" dialup on In a matching-speed configuration, your ttys entry needs to reference the appropriate beginning “auto-baud” (sic) entry in - /etc/gettytab. For example, if you added + /etc/gettytab. For example, if you added the above suggested entry for a matching-speed modem that starts at 19.2 Kbps (the gettytab entry containing the V19200 starting point), your @@ -1485,7 +1485,7 @@ stty -f /dev/ttyd3 crtscts If you have a modem whose parameters may be permanently set in non-volatile RAM, you will need to use a terminal program (such as Telix under PC-DOS or tip under - FreeBSD) to set the parameters. Connect to the modem using the + FreeBSD) to set the parameters. Connect to the modem using the same communications speed as the initial speed getty will use and configure the modem's non-volatile RAM to match these requirements: @@ -1586,7 +1586,7 @@ AT&C1&D2&H1&I0&R2&W Result codes should be disabled/suppressed for dialup modems to avoid problems that can occur if getty mistakenly gives a login: prompt to a modem that is in command - mode and the modem echoes the command or returns a result code. I + mode and the modem echoes the command or returns a result code. I have heard this sequence can result in a extended, silly conversation between getty and the modem. @@ -1597,7 +1597,7 @@ AT&C1&D2&H1&I0&R2&W For a locked-speed configuration, you will need to configure the modem to maintain a constant modem-to-computer data rate - independent of the communications rate. On a USR Sportster + independent of the communications rate. On a USR Sportster 14,400 external modem, these commands will lock the modem-to-computer data rate at the speed used to issue the commands: @@ -1612,7 +1612,7 @@ AT&B1&W For a variable-speed configuration, you will need to configure your modem to adjust its serial port data rate to - match the incoming call rate. On a USR Sportster 14,400 + match the incoming call rate. On a USR Sportster 14,400 external modem, these commands will lock the modem's error-corrected data rate to the speed used to issue the commands, but allow the serial port rate to vary for @@ -1628,9 +1628,9 @@ AT&B2&W Most high-speed modems provide commands to view the modem's current operating parameters in a somewhat human-readable - fashion. On the USR Sportster 14,400 external modems, the + fashion. On the USR Sportster 14,400 external modems, the command ATI5 displays the settings - that are stored in the non-volatile RAM. To see the true + that are stored in the non-volatile RAM. To see the true operating parameters of the modem (as influenced by the USR's DIP switch settings), use the commands ATZ and then ATI4. @@ -1680,7 +1680,7 @@ AT&B2&W and the modem has not accepted a call yet, this means that getty has completed its open on - the communications port. This could indicate a problem with the + the communications port. This could indicate a problem with the cabling or a mis-configured modem, because getty should not be able to open the communications port until CD (carrier detect) has been asserted by the modem. @@ -1689,10 +1689,10 @@ AT&B2&W processes waiting to open the desired ttyd? port, double-check your entries in /etc/ttys to see if there are any mistakes - there. Also, check the log file + there. Also, check the log file /var/log/messages to see if there are any log messages from init or - getty regarding any problems. If + getty regarding any problems. If there are any messages, triple-check the configuration files /etc/ttys and /etc/gettytab, as well as the appropriate @@ -1706,8 +1706,8 @@ AT&B2&W Try Dialing In Try dialing into the system; be sure to use 8 bits, no - parity, 1 stop bit on the remote system. If you do not get a - prompt right away, or get garbage, try pressing <Enter> about once per second. If + parity, 1 stop bit on the remote system. If you do not get a + prompt right away, or get garbage, try pressing <Enter> about once per second. If you still do not see a login: prompt after a while, try sending a BREAK. If you are using a high-speed modem to do the dialing, try @@ -1743,13 +1743,13 @@ AT&B2&W If you dial but the modem on the FreeBSD system will not answer, make sure that the modem is configured to answer the - phone when DTR is asserted. If the modem + phone when DTR is asserted. If the modem seems to be configured correctly, verify that the DTR line is asserted by checking the modem's indicator lights (if it has any). If you have gone over everything several times and it still - does not work, take a break and come back to it later. If it + does not work, take a break and come back to it later. If it still does not work, perhaps you can send an electronic mail message to the &a.questions;describing your modem and your problem, and the good folks on the list will try to help. @@ -1781,13 +1781,13 @@ AT&B2&W Information integrated from FAQ. The following are tips to getting your host to be able to - connect over the modem to another computer. This is appropriate for + connect over the modem to another computer. This is appropriate for establishing a terminal session with a remote host. This is useful to log onto a BBS. This kind of connection can be extremely helpful to get a file - on the Internet if you have problems with PPP. If you need to ftp + on the Internet if you have problems with PPP. If you need to ftp something and PPP is broken, use the terminal session to ftp it. Then use zmodem to transfer it to your machine. @@ -1799,8 +1799,8 @@ AT&B2&W On your system, the programs tip and cu are probably executable only by uucp and group - dialer. You can use the group dialer to control who has access to your - modem or remote systems. Just add yourself to group + dialer. You can use the group dialer to control who has access to your + modem or remote systems. Just add yourself to group dialer. Alternatively, you can let everyone on your system run @@ -1819,7 +1819,7 @@ AT&B2&W My stock Hayes modem is not supported, what can I do? Actually, the man page for tip - is out of date. There is a generic Hayes dialer already built in. + is out of date. There is a generic Hayes dialer already built in. Just use at=hayes in your /etc/remote file. @@ -1827,25 +1827,25 @@ AT&B2&W advanced features of newer modems—messages like BUSY, NO DIALTONE, or CONNECT - 115200 will just confuse it. You should turn those + 115200 will just confuse it. You should turn those messages off when you use tip (using ATX0&W). Also, the dial timeout for tip - is 60 seconds. Your modem should use something less, or else tip - will think there is a communication problem. Try + is 60 seconds. Your modem should use something less, or else tip + will think there is a communication problem. Try ATS7=45&W. Actually, as shipped tip does - not yet support it fully. The solution is to edit the file + not yet support it fully. The solution is to edit the file tipconf.h in the directory /usr/src/usr.bin/tip/tip Obviously you need the source distribution to do this. Edit the line #define HAYES 0 to #define HAYES - 1. Then make and - make install. Everything works + 1. Then make and + make install. Everything works nicely after that. @@ -1854,7 +1854,7 @@ AT&B2&W How am I expected to enter these AT commands? Make what is called a “direct” - entry in your /etc/remote file. For example, + entry in your /etc/remote file. For example, if your modem is hooked up to the first serial port, /dev/cuaa0, then put in the following line: @@ -1862,7 +1862,7 @@ AT&B2&W cuaa0:dv=/dev/cuaa0:br#19200:pa=none Use the highest bps rate your modem supports in - the br capability. Then, type tip + the br capability. Then, type tip cuaa0 and you will be connected to your modem. @@ -1882,7 +1882,7 @@ cuaa0:dv=/dev/cuaa0:br#19200:pa=none line is the serial port (e.g./dev/cuaa0) and speed is - the speed (e.g.57600). When you are + the speed (e.g.57600). When you are done entering the AT commands hit ~. to exit. @@ -1894,8 +1894,8 @@ cuaa0:dv=/dev/cuaa0:br#19200:pa=none The @ sign in the phone number capability tells tip to look in /etc/phones for a phone - number. But the @ sign is also a special character - in capability files like /etc/remote. Escape + number. But the @ sign is also a special character + in capability files like /etc/remote. Escape it with a backslash: @@ -1907,7 +1907,7 @@ pn=\@ How can I dial a phone number on the command line? Put what is called a “generic” - entry in your /etc/remote file. For example: + entry in your /etc/remote file. For example: tip115200|Dial any phone number at 115200 bps:\ @@ -1940,9 +1940,9 @@ cu115200|Use cu to dial any number at 115200bps:\ Put in an entry for tip1200 or cu1200, but go ahead and use - whatever bps rate is appropriate with the br capability. tip thinks a good default is 1200 bps which + whatever bps rate is appropriate with the br capability. tip thinks a good default is 1200 bps which is why it looks for a tip1200 - entry. You do not have to use 1200 bps, though. + entry. You do not have to use 1200 bps, though. @@ -1951,7 +1951,7 @@ cu115200|Use cu to dial any number at 115200bps:\ Rather than waiting until you are connected and typing CONNECT <host> each time, - use tip's cm capability. For + use tip's cm capability. For example, these entries in /etc/remote: @@ -1995,7 +1995,7 @@ big-university 5551113 big-university 5551114 tip will try each one in the - listed order, then give up. If you want to keep retrying, run + listed order, then give up. If you want to keep retrying, run tip in a while loop. @@ -2006,15 +2006,15 @@ big-university 5551114 CTRL+P is the default “force” character, used to tell tip that the next character is - literal data. You can set the force character to any other + literal data. You can set the force character to any other character with the ~s escape, which means “set a variable.” Type ~sforce=single-char - followed by a newline. single-char is any single character. + followed by a newline. single-char is any single character. If you leave out single-char, then the force character is the nul character, which you can get by typing CTRL+2 - or CTRL+SPACE. A pretty good value for single-char is SHIFT+CTRL+6, which I + or CTRL+SPACE. A pretty good value for single-char is SHIFT+CTRL+6, which I have seen only used on some terminal servers. You can have the force character be whatever you want by @@ -2030,8 +2030,8 @@ force=<single-char> Suddenly everything I type is in UPPER CASE?? You must have pressed CTRL+A, tip's “raise character,” specially - designed for people with broken caps-lock keys. Use ~s as above and set the variable - raisechar to something reasonable. In fact, you can set it to + designed for people with broken caps-lock keys. Use ~s as above and set the variable + raisechar to something reasonable. In fact, you can set it to the same as the force character, if you never expect to use either of these features. @@ -2051,9 +2051,9 @@ raisechar=^^ If you are talking to another UNIX system, you can send and receive files with ~p (put) and - ~t (take). These commands run + ~t (take). These commands run cat and echo on the remote system to accept and - send files. The syntax is: + send files. The syntax is: ~p diff --git a/en_US.ISO8859-1/books/handbook/staff/chapter.sgml b/en_US.ISO8859-1/books/handbook/staff/chapter.sgml index 9f530dabbb..fa045523bd 100644 --- a/en_US.ISO8859-1/books/handbook/staff/chapter.sgml +++ b/en_US.ISO8859-1/books/handbook/staff/chapter.sgml @@ -87,7 +87,7 @@ The FreeBSD Developers These are the people who have commit privileges and do the - engineering work on the FreeBSD source tree. All core team members + engineering work on the FreeBSD source tree. All core team members are also developers. diff --git a/en_US.ISO8859-1/books/porters-handbook/book.sgml b/en_US.ISO8859-1/books/porters-handbook/book.sgml index 35e532e05b..0eb95aa909 100644 --- a/en_US.ISO8859-1/books/porters-handbook/book.sgml +++ b/en_US.ISO8859-1/books/porters-handbook/book.sgml @@ -8,16 +8,16 @@ For all the hype about open standards, getting a program to work on different versions of Unix in the real world can be a tedious and - tricky business, as anyone who has tried it will know. You may be + tricky business, as anyone who has tried it will know. You may be lucky enough to find that the program you want will compile cleanly on your system, install itself in all the right places and run flawlessly - “out of the box”, but this is unfortunately rather rare. With most + “out of the box”, but this is unfortunately rather rare. With most programs, you will find yourself doing a fair bit of head-scratching, and there are quite a few programs that will result in premature greying, or even chronic alopecia... Some software distributions have attacked this problem by - providing configuration scripts. Some of these are very clever, but + providing configuration scripts. Some of these are very clever, but they have an unfortunate tendency to triumphantly announce that your system is something you have never heard of and then ask you lots of questions that sound like a final exam in system-level Unix @@ -102,7 +102,7 @@ FreeBSD ports still use the tarball mechanism, but use a skeleton to hold the "knowledge" of how to get the program working on FreeBSD, - rather than expecting the user to be able to work it out. They also + rather than expecting the user to be able to work it out. They also supply their own customised Makefile, so that almost every port can be built in the same way. @@ -110,14 +110,14 @@ If you look at a port skeleton (either on your FreeBSD system or the FTP site) and expect to find all sorts of pointy-headed rocket science lurking there, you may be disappointed by the one or two rather unexciting-looking files and directories you find there. (We will discuss in a minute how to go about the FTP site) and expect to find all sorts of pointy-headed rocket science lurking there, you may be disappointed by the one or two rather unexciting-looking files and directories you find there. (We will discuss in a minute how to go about Getting a port). - “How on earth can this do anything?” I hear you cry. “There + “How on earth can this do anything?” I hear you cry. “There is no source code there!” Fear not, gentle reader, all will become clear (hopefully). - Let's see what happens if we try and install a port. I have chosen + Let's see what happens if we try and install a port. I have chosen ElectricFence, a useful tool for developers, as the skeleton is more straightforward than most. @@ -160,7 +160,7 @@ install -c -o bin -g bin -m 444 /usr/ports/devel/ElectricFence/work/ElectricFenc The make program has noticed that you did not have a local copy of the source code and tried to FTP it down so it could get the - job done. I already had the source handy in my example, so it did + job done. I already had the source handy in my example, so it did not need to fetch it. Let's go through this and see what the make program was @@ -203,13 +203,13 @@ install -c -o bin -g bin -m 444 /usr/ports/devel/ElectricFence/work/ElectricFenc Install the program executable and other supporting files, man pages, etc. under the /usr/local hierarchy, where they will not - get mixed up with system programs. This also makes sure that + get mixed up with system programs. This also makes sure that all the ports you install will go in the same place, instead of being flung all over your system. - Register the installation in a database. This means that, + Register the installation in a database. This means that, if you do not like the program, you can cleanly remove all traces of it from your system. @@ -219,7 +219,7 @@ install -c -o bin -g bin -m 444 /usr/ports/devel/ElectricFence/work/ElectricFenc Scroll up to the make output and see if you can match these - steps to it. And if you were not impressed before, you should be by + steps to it. And if you were not impressed before, you should be by now! @@ -228,7 +228,7 @@ install -c -o bin -g bin -m 444 /usr/ports/devel/ElectricFence/work/ElectricFenc Getting a FreeBSD Port There are two ways of getting hold of the FreeBSD port for a - program. One requires a FreeBSD + program. One requires a FreeBSD CDROM, the other involves using an Internet Connection. @@ -253,17 +253,17 @@ DISTDIR= /tmp/distfiles WRKDIRPREFIX= /tmp Substitute /tmp for any place you have enough - free space. Then, just cd to the appropriate + free space. Then, just cd to the appropriate subdirectory under /cdrom/ports and type make install as - usual. WRKDIRPREFIX will cause the port to be + usual. WRKDIRPREFIX will cause the port to be build under /tmp/cdrom/ports; for instance, games/oneko will be built under /tmp/cdrom/ports/games/oneko. There are some ports for which we cannot provide the - original source in the CDROM due to licensing limitations. In + original source in the CDROM due to licensing limitations. In that case, you will need to look at the section on Compiling ports using an Internet connection. @@ -275,22 +275,22 @@ WRKDIRPREFIX= /tmp If you do not have a CDROM, or you want to make sure you get the very latest version of the port you want, you will need to download the - skeleton for the port. Now + skeleton for the port. Now this might sound like rather a fiddly job full of pitfalls, but it is actually very easy. First, if you are running a release version of FreeBSD, make sure you get the appropriate “upgradekiet” for your replease from the ports - web page. These packages include files that have been + web page. These packages include files that have been updated since the release that you may need to compile new ports. The key to the skeletons is that the FreeBSD FTP server can create on-the-fly - tarballs for you. Here is + tarballs for you. Here is how it works, with the gnats program in the databases directory as - an example (the bits in square brackets are comments. Do not type + an example (the bits in square brackets are comments. Do not type them in if you are trying this yourself!):- @@ -312,19 +312,19 @@ password. Remember to use binary (also known as image) mode!] What happened here? We connected to the FTP server in the - usual way and went to its databases sub-directory. When we gave it + usual way and went to its databases sub-directory. When we gave it the command get gnats.tar, the FTP server tarred up the gnats directory for us. We then extracted the gnats skeleton and went into the gnats - directory to build the port. As we explained earlier, the make process noticed we did not have a copy of the source locally, so it fetched one before extracting, patching and building it. - Let's try something more ambitious now. Instead of getting a + Let's try something more ambitious now. Instead of getting a single port skeleton, let's get a whole sub-directory, for example - all the database skeletons in the ports collection. It looks + all the database skeletons in the ports collection. It looks almost the same:- @@ -347,7 +347,7 @@ password. Remember to use binary (also known as image) mode!] set of database programs on our FreeBSD machine! All we did that was different from getting a single port skeleton and building it was that we got a whole directory at once, and compiled everything - in it at once. Pretty impressive, no? + in it at once. Pretty impressive, no? If you expect to be installing many ports, it is probably worth downloading all the ports directories. @@ -369,7 +369,7 @@ password. Remember to use binary (also known as image) mode!] The most important component of a skeleton is the Makefile. This contains various statements that specify how the port should - be compiled and installed. Here is the Makefile for + be compiled and installed. Here is the Makefile for ElectricFence:- @@ -404,8 +404,8 @@ do-install: linkend="ports-tarball">tarball, but without the extension. - CATEGORIES states what kind of program this is. In - this case, a utility for developers. See the CATEGORIES states what kind of program this is. In + this case, a utility for developers. See the categories section of this handbook for a complete list. @@ -423,7 +423,7 @@ do-install: Skipping over the next few lines for a minute, the line .include <bsd.port.mk> says that the other statements and commands needed for this port are - in a standard file called bsd.port.mk. As + in a standard file called bsd.port.mk. As these are the same for all ports, there is no point in duplicating them all over the place, so they are kept in a single standard file. @@ -432,7 +432,7 @@ do-install: examination of how Makefiles work; suffice it to say that the line starting with MAN3 ensures that the ElectricFence man page is compressed after installation, to help conserve your precious disk - space. The original port did not provide an install target, + space. The original port did not provide an install target, so the three lines from do-install ensure that the files produced by this port are placed in the correct destination. @@ -444,7 +444,7 @@ do-install: The file containing the checksum for the port is called md5, after the MD5 algorithm used for ports - checksums. It lives in a directory with the slightly confusing + checksums. It lives in a directory with the slightly confusing name of files. This directory can also contain other miscellaneous files that @@ -491,31 +491,31 @@ do-install: What to do when a port does not work. - Oh. You can do one of four (4) things : + Oh. You can do one of four (4) things : - Fix it yourself. Technical details on how ports work can + Fix it yourself. Technical details on how ports work can be found in Porting applications. - Gripe. This is done by e-mail only! Send such e-mail to + Gripe. This is done by e-mail only! Send such e-mail to the &a.ports; and please include the name/version of the port, where you got both the port source & distfile(s) from, and what the text of the error was. - Forget it. This is the easiest for most — very few of the + Forget it. This is the easiest for most — very few of the programs in ports can be classified as essential! - Grab the pre-compiled package from a ftp server. The + Grab the pre-compiled package from a ftp server. The “master” package collection is on FreeBSD's FTP server in the packages @@ -538,29 +538,29 @@ do-install: - Q. I thought this was going to be a discussion about + Q. I thought this was going to be a discussion about modems??! - A. Ah. You must be thinking of the serial ports on the - back of your computer. We are using “port” here to mean the + A. Ah. You must be thinking of the serial ports on the + back of your computer. We are using “port” here to mean the result of “porting” a program from one version of Unix to - another. (It is an unfortunate bad habit of computer people to + another. (It is an unfortunate bad habit of computer people to use the same word to refer to several completely different things). - Q. I thought you were supposed to use packages to install + Q. I thought you were supposed to use packages to install extra programs? - A. Yes, that is usually the quickest and easiest way of + A. Yes, that is usually the quickest and easiest way of doing it. - Q. So why bother with ports then? + Q. So why bother with ports then? - A. Several reasons:- + A. Several reasons:- @@ -572,7 +572,7 @@ do-install: - Some people do not trust binary distributions. At + Some people do not trust binary distributions. At least with source code you can (in theory) read through it and look for potential problems yourself. @@ -607,21 +607,21 @@ do-install: - Q. What is a patch? + Q. What is a patch? - A. A patch is a small (usually) file that specifies how to - go from one version of a file to another. It contains text + A. A patch is a small (usually) file that specifies how to + go from one version of a file to another. It contains text that says, in effect, things like “delete line 23”, “add these two lines after line 468” or “change line 197 to - this”. Also known as a “diff”, since it is generated by a + this”. Also known as a “diff”, since it is generated by a program of that name. - Q. What is all this about + Q. What is all this about tarballs? - A. It is a file ending in .tar or + A. It is a file ending in .tar or .tar.gz (with variations like .tar.Z, or even .tgz if you are trying to squeeze the names into a DOS @@ -629,7 +629,7 @@ do-install: Basically, it is a directory tree that has been archived into a single file (.tar) and optionally - compressed (.gz). This technique was + compressed (.gz). This technique was originally used for Tape ARchives (hence the name tar), but it is a widely used way of distributing program source code around @@ -649,19 +649,19 @@ do-install: - Q. And a checksum? + Q. And a checksum? - A. It is a number generated by adding up all the data in - the file you want to check. If any of the characters change, + A. It is a number generated by adding up all the data in + the file you want to check. If any of the characters change, the checksum will no longer be equal to the total, so a simple - comparison will allow you to spot the difference. (In + comparison will allow you to spot the difference. (In practice, it is done in a more complicated way to spot problems like position-swapping, which will not show up with a simplistic addition). - Q. I did what you said for compiling ports from a CDROM and it worked great + Q. I did what you said for compiling ports from a CDROM and it worked great until I tried to install the kermit port:- @@ -671,25 +671,25 @@ do-install: Why can it not be found? Have I got a dud CDROM? - A. The licensing terms for kermit do not allow us to put + A. The licensing terms for kermit do not allow us to put the tarball for it on the CDROM, so you will have to fetch it by hand — sorry! The reason why you got all those error messages was because you were not connected to the Internet at - the time. Once you have downloaded it from any of the sites + the time. Once you have downloaded it from any of the sites above, you can re-start the process (try and choose the nearest site to you, though, to save your time and the Internet's bandwidth). - Q. I did that, but when I tried to put it into + Q. I did that, but when I tried to put it into /usr/ports/distfiles I got some error about not having permission. - A. The ports mechanism looks for the tarball in + A. The ports mechanism looks for the tarball in /usr/ports/distfiles, but you will not be able to copy anything there because it is sym-linked to the - CDROM, which is read-only. You can tell it to look somewhere + CDROM, which is read-only. You can tell it to look somewhere else by doing @@ -698,14 +698,14 @@ do-install: - Q. Does the ports scheme only work if you have everything + Q. Does the ports scheme only work if you have everything in /usr/ports? My system administrator says I must put everything under /u/people/guests/wurzburger, but it does not seem to work. - A. You can use the PORTSDIR and PREFIX variables to tell - the ports mechanism to use different directories. For + A. You can use the PORTSDIR and PREFIX variables to tell + the ports mechanism to use different directories. For instance, @@ -739,12 +739,12 @@ do-install: - Q. I do not have a FreeBSD CDROM, but I would like to have + Q. I do not have a FreeBSD CDROM, but I would like to have all the tarballs handy on my system so I do not have to wait - for a download every time I install a port. Is there an easy + for a download every time I install a port. Is there an easy way to get them all at once? - A. To get every single tarball for the ports collection, + A. To get every single tarball for the ports collection, do @@ -765,12 +765,12 @@ do-install: - Q. I know it is probably faster to fetch the tarballs from - one of the FreeBSD mirror sites close by. Is there any way to + Q. I know it is probably faster to fetch the tarballs from + one of the FreeBSD mirror sites close by. Is there any way to tell the port to fetch them from servers other than ones listed in the MASTER_SITES? - A. Yes. If you know, for example, ftp.FreeBSD.ORG is much + A. Yes. If you know, for example, ftp.FreeBSD.ORG is much closer than sites listed in MASTER_SITES, do as following example. @@ -781,43 +781,43 @@ do-install: - Q. I want to know what files make is going to need before + Q. I want to know what files make is going to need before it tries to pull them down. - A. make fetch-list will display a list of the files + A. make fetch-list will display a list of the files needed for a port. - Q. Is there any way to stop the port from compiling? I + Q. Is there any way to stop the port from compiling? I want to do some hacking on the source before I install it, but it is a bit tiresome having to watch it and hit control-C every time. - A. Doing make extract will stop it after it has fetched + A. Doing make extract will stop it after it has fetched and extracted the source code. - Q. I am trying to make my own port and I want to be able + Q. I am trying to make my own port and I want to be able to stop it compiling until I have had a chance to see if my - patches worked properly. Is there something like make + patches worked properly. Is there something like make extract, but for patches? - A. Yep, make patch is what you want. You will probably - find the PATCH_DEBUG option useful as well. And by the way, + A. Yep, make patch is what you want. You will probably + find the PATCH_DEBUG option useful as well. And by the way, thank you for your efforts! - Q. I have heard that some compiler options can cause bugs. + Q. I have heard that some compiler options can cause bugs. Is this true? How can I make sure that I compile ports with the right settings? - A. Yes, with version 2.6.3 of gcc (the version shipped + A. Yes, with version 2.6.3 of gcc (the version shipped with FreeBSD 2.1.0 and 2.1.5), the option could result in buggy code unless you used the option as - well. (Most of the ports don't use ). You + well. (Most of the ports don't use ). You should be able to specify the compiler options used by something like @@ -826,7 +826,7 @@ do-install: or by editing /etc/make.conf, but - unfortunately not all ports respect this. The surest way is to + unfortunately not all ports respect this. The surest way is to do make configure, then go into the source directory and inspect the Makefiles by hand, but this can get tedious if the source has lots of sub-directories, each with their own @@ -834,12 +834,12 @@ do-install: - Q. There are so many ports it is hard to find the one I - want. Is there a list anywhere of what ports are available? + Q. There are so many ports it is hard to find the one I + want. Is there a list anywhere of what ports are available? - A. Look in the INDEX file in - /usr/ports. If you would like to search the - ports collection for a keyword, you can do that too. For example, + A. Look in the INDEX file in + /usr/ports. If you would like to search the + ports collection for a keyword, you can do that too. For example, you can find ports relevant to the LISP programming language using: @@ -850,25 +850,25 @@ do-install: - Q. I went to install the foo port but the system + Q. I went to install the foo port but the system suddenly stopped compiling it and starting compiling the bar - port. What's going on? + port. What's going on? - A. The foo port needs something that is supplied with + A. The foo port needs something that is supplied with bar — for instance, if foo uses graphics, bar might have - a library with useful graphics processing routines. Or bar + a library with useful graphics processing routines. Or bar might be a tool that is needed to compile the foo port. - Q. I installed the grizzle + Q. I installed the grizzle program from the ports and frankly it is a complete waste of - disk space. I want to delete it but I do not know where it put - all the files. Any clues? + disk space. I want to delete it but I do not know where it put + all the files. Any clues? - A. No problem, just do + A. No problem, just do &prompt.root; pkg_delete grizzle-6.5 @@ -877,11 +877,11 @@ do-install: - Q. Hang on a minute, you have to know the version number to - use that command. You do not seriously expect me to remember + Q. Hang on a minute, you have to know the version number to + use that command. You do not seriously expect me to remember that, do you?? - A. Not at all, you can find it out by doing + A. Not at all, you can find it out by doing &prompt.root; pkg_info -a | grep grizzle @@ -891,13 +891,13 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. Talking of disk space, the ports directory seems to be - taking up an awful lot of room. Is it safe to go in there and + Q. Talking of disk space, the ports directory seems to be + taking up an awful lot of room. Is it safe to go in there and delete things? - A. Yes, if you have installed the program and are fairly + A. Yes, if you have installed the program and are fairly certain you will not need the source again, there is no point - in keeping it hanging around. The best way to do this + in keeping it hanging around. The best way to do this is @@ -910,19 +910,19 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. I tried that and it still left all those tarballs or + Q. I tried that and it still left all those tarballs or whatever you called them in the distfiles - directory. Can I delete those as well? + directory. Can I delete those as well? - A. Yes, if you are sure you have finished with them, those + A. Yes, if you are sure you have finished with them, those can go as well. - Q. I like having lots and lots of programs to play with. + Q. I like having lots and lots of programs to play with. Is there any way of installing all the ports in one go? - A. Just do + A. Just do &prompt.root; cd /usr/ports @@ -931,22 +931,22 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. OK, I tried that, but I thought it would take a very - long time so I went to bed and left it to get on with it. When + Q. OK, I tried that, but I thought it would take a very + long time so I went to bed and left it to get on with it. When I looked at the computer this morning, it had only done three - and a half ports. Did something go wrong? + and a half ports. Did something go wrong? - A. No, the problem is that some of the ports need to ask + A. No, the problem is that some of the ports need to ask you questions that we cannot answer for you (eg “Do you want to print on A4 or US letter sized paper?”) and they need to have someone on hand to answer them. - Q. I really do not want to spend all day staring at the - monitor. Any better ideas? + Q. I really do not want to spend all day staring at the + monitor. Any better ideas? - A. OK, do this before you go to bed/work/the local + A. OK, do this before you go to bed/work/the local park:- @@ -955,7 +955,7 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc This will install every port that does - not require user input. Then, when you + not require user input. Then, when you come back, do @@ -967,12 +967,12 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. At work, we are using frobble, which is in your ports + Q. At work, we are using frobble, which is in your ports collection, but we have altered it quite a bit to get it to do - what we need. Is there any way of making our own packages, so + what we need. Is there any way of making our own packages, so we can distribute it more easily around our sites? - A. No problem, assuming you know how to make patches for + A. No problem, assuming you know how to make patches for your changes:- @@ -986,10 +986,10 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. This ports stuff is really clever. I am desperate to - find out how you did it. What is the secret? + Q. This ports stuff is really clever. I am desperate to + find out how you did it. What is the secret? - A. Nothing secret about it at all, just look at the + A. Nothing secret about it at all, just look at the bsd.ports.mk and bsd.ports.subdir.mk files in your makefiles @@ -1011,27 +1011,27 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc Making a port yourself Contributed by &a.jkh;, &a.gpalmer;, &a.asami; - &a.obrien; and &a.hoek;. 28 August 1996. + &a.obrien; and &a.hoek;. 28 August 1996. So, now you are interested in making your own port? Great! What follows are some guidelines for creating a new port for - FreeBSD. The bulk of the work is done by + FreeBSD. The bulk of the work is done by /usr/share/mk/bsd.port.mk, which all port - Makefiles include. Please refer to that file for more details on - the inner workings of the ports collection. Even if you don't + Makefiles include. Please refer to that file for more details on + the inner workings of the ports collection. Even if you don't hack Makefiles daily, it is well commented, and you will still gain much knowledge from it. Only a fraction of the overridable variables (VAR) are mentioned - in this document. Most (if not all) are documented at the start of - bsd.port.mk. This file users a non-standard - tab setting. Emacs and + in this document. Most (if not all) are documented at the start of + bsd.port.mk. This file users a non-standard + tab setting. Emacs and Vim should recognise the setting on - loading the file. vi or ex + loading the file. vi or ex can be set to use the correct value by typing :set tabstop=4 once the file has been loaded. @@ -1039,7 +1039,7 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc Quick Porting - This section tells you how to do a quick port. In many + This section tells you how to do a quick port. In many cases, it is not enough, but we will see. First, get the original tarball and put it into DISTDIR, which defaults to @@ -1048,7 +1048,7 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc The following assumes that the software compiled out-of-the-box, i.e., there was absolutely no change required - for the port to work on your FreeBSD box. If you needed to + for the port to work on your FreeBSD box. If you needed to change something, you will have to refer to the next section too. @@ -1080,10 +1080,10 @@ USE_IMAKE= yes .include <bsd.port.mk> - See if you can figure it out. Do not worry about the + See if you can figure it out. Do not worry about the contents of the $Id$ line, it will be filled in automatically by CVS when the port - is imported to our main ports tree. You can find a more + is imported to our main ports tree. You can find a more detailed example in the sample Makefile section. @@ -1106,7 +1106,7 @@ USE_IMAKE= yes This is the one-line description of the port. Please do not include the package name (or version - number of the software) in the comment. Here is + number of the software) in the comment. Here is an example: @@ -1117,7 +1117,7 @@ A cat chasing a mouse all over the screen. <filename>DESCR</filename> - This is a longer description of the port. One to a few + This is a longer description of the port. One to a few paragraphs concisely explaining what the port does is sufficient. @@ -1127,7 +1127,7 @@ A cat chasing a mouse all over the screen. Please be careful if you are copying from the README or manpage; too often they are not a concise description of the port or are in an - awkward format (e.g., manpages have justified spacing). If the + awkward format (e.g., manpages have justified spacing). If the ported software has an official WWW homepage, you should list it here. @@ -1151,12 +1151,12 @@ asami@cs.berkeley.edu <filename>PLIST</filename> - This file lists all the files installed by the port. It + This file lists all the files installed by the port. It is also called the “packing list” because the package is - generated by packing the files listed here. The pathnames + generated by packing the files listed here. The pathnames are relative to the installation prefix (usually /usr/local or - /usr/X11R6). If you are using the + /usr/X11R6). If you are using the MANn variables (as you should be), do not list any manpages here. @@ -1175,13 +1175,13 @@ lib/X11/oneko/mouse.xpm You should list all the files, but not the name - directories, in the list. Also, if the port creates + directories, in the list. Also, if the port creates directories for itself during installtion, make sure to add @dirrm lines as necessary to remove them when the port is deleted. It is recommended that you keep all the filenames in - this file sorted alphabetically. It will make verifying the + this file sorted alphabetically. It will make verifying the changes when you upgrade the port much easier. @@ -1200,7 +1200,7 @@ lib/X11/oneko/mouse.xpm Testing the port You should make sure that the port rules do exactly what - you want it to do, including packaging up the port. These are + you want it to do, including packaging up the port. These are the important points you need to verify. @@ -1260,7 +1260,7 @@ lib/X11/oneko/mouse.xpm Make sure that there aren't any warnings issued in any of the package and deinstall stages, After step 3, check - to see if all the new directories are correctly deleted. Also, + to see if all the new directories are correctly deleted. Also, try using the software after step 4, to ensure that is works correctly when installed from a package. @@ -1269,8 +1269,8 @@ lib/X11/oneko/mouse.xpm Checking your port with <command>portlint</command> Please use portlint to see if your port - conforms to our guidelines. The portlint - program is part of the ports collection. In particular, your may + conforms to our guidelines. The portlint + program is part of the ports collection. In particular, your may want to check if the Makefile is in the right shape and the package is @@ -1285,10 +1285,10 @@ lib/X11/oneko/mouse.xpm Now that you are happy with your port, the only thing remaining is to put it in the main FreeBSD ports tree and make - everybody else happy about it too. We do not need your + everybody else happy about it too. We do not need your work directory or the pkgname.tgz package, so delete them - now. Next, simply include the output of shar `find + now. Next, simply include the output of shar `find port_dir` in a bug report and send it with the send-pr @@ -1298,15 +1298,15 @@ lib/X11/oneko/mouse.xpm about send-pr 1 - . If the uncompressed port is larger than + . If the uncompressed port is larger than 20KB, you should compress it into a tarfile and use uuencode 1 before including it in the bug report (uuencoded tarfiles are acceptable even if the bug report is smaller than - 20KB but are not preferred). Be sure to classify the bug report as + 20KB but are not preferred). Be sure to classify the bug report as category ports and class - change-request. (Do not mark the report + change-request. (Do not mark the report confidential!) One more time, do not include the original source @@ -1317,7 +1317,7 @@ lib/X11/oneko/mouse.xpm In the past, we asked you to upload new port submissions in our ftp site (ftp.freebsd.org). This is no longer + role="fqdn">ftp.freebsd.org). This is no longer recommended as read access is turned off on that incoming/ directory of that site due to the large amount of pirated software showing up there. @@ -1325,7 +1325,7 @@ lib/X11/oneko/mouse.xpm We will look at your port, get back to you if necessary, and put it in the - tree. Your name will also appear in the list of “Additional + tree. Your name will also appear in the list of “Additional FreeBSD contributors” on the FreeBSD Handbook and other files. Isn't that great?!? :) @@ -1336,7 +1336,7 @@ lib/X11/oneko/mouse.xpm Slow Porting Ok, so it was not that simple, and the port required some - modifications to get it to work. In this section, we will + modifications to get it to work. In this section, we will explain, step by step, how to modify it to get it to work with the ports paradigm. @@ -1352,39 +1352,39 @@ lib/X11/oneko/mouse.xpm But do not worry if you do not really understand what bsd.port.mk is doing, not many people - do... :> + do... :> - The fetch target is run. The fetch target is + The fetch target is run. The fetch target is responsible for making sure that the tarball exists locally in DISTDIR. If fetch cannot find the required files in DISTDIR it will look up the URL MASTER_SITES, which is set in the Makefile, as well as our main ftp site at ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/, where we put sanctioned distfiles as backup. It will then attempt to fetch the named distribution file with FETCH, assuming that the requesting site has direct access to the Internet. If that succeeds, it will save the file in DISTDIR for future use and proceed. + URL="ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/">ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/, where we put sanctioned distfiles as backup. It will then attempt to fetch the named distribution file with FETCH, assuming that the requesting site has direct access to the Internet. If that succeeds, it will save the file in DISTDIR for future use and proceed. - The extract target is run. It looks for your port's + The extract target is run. It looks for your port's distribution file (typically a gzip'd tarball) in DISTDIR and unpacks it into a temporary subdirectory specified by WRKDIR (defaults to work). - The patch target is run. First, any patches defined + The patch target is run. First, any patches defined in PATCHFILES are - applied. Second, if any patches are found in PATCHDIR (defaults to the + applied. Second, if any patches are found in PATCHDIR (defaults to the patches subdirectory), they are applied at this time in alphabetical order. - The configure target is run. This can do any one of + The configure target is run. This can do any one of many different things. @@ -1414,10 +1414,10 @@ lib/X11/oneko/mouse.xpm - The build target is run. This is responsible for + The build target is run. This is responsible for descending into the port's private working directory (WRKSRC) and - building it. If USE_GMAKE is set, GNU + building it. If USE_GMAKE is set, GNU make will be used, otherwise the system make will be used. @@ -1426,7 +1426,7 @@ lib/X11/oneko/mouse.xpm - The above are the default actions. In addition, you can + The above are the default actions. In addition, you can define targets pre-something or post-something, or put scripts with those names, in the scripts subdirectory, and they will be run before or after the default @@ -1438,14 +1438,14 @@ lib/X11/oneko/mouse.xpm post-extract target will be called after the regular extraction actions, and the pre-build script will be executed before - the default build rules are done. It is recommended that you + the default build rules are done. It is recommended that you use Makefile targets if the actions are simple enough, because it will be easier for someone to figure out what kind of non-default action the port requires. The default actions are done by the - bsd.port.mk targets do-something. For example, the - commands to extract a port are in the target do-extract. If you are not happy with + bsd.port.mk targets do-something. For example, the + commands to extract a port are in the target do-extract. If you are not happy with the default target, you can fix it by redefining the do-something target in your Makefile. @@ -1454,7 +1454,7 @@ lib/X11/oneko/mouse.xpm The “main” targets (e.g., extract, configure, etc.) do nothing more than make sure all the stages up to that one are completed and call the real targets or scripts, and they are not intended - to be changed. If you want to fix the extraction, fix + to be changed. If you want to fix the extraction, fix do-extract, but never ever touch extract! @@ -1471,7 +1471,7 @@ lib/X11/oneko/mouse.xpm Get the original sources (normally) as a compressed tarball (foo.tar.gz or foo.tar.Z) and copy it into - DISTDIR. Always use + DISTDIR. Always use mainstream sources when and where you can. @@ -1479,7 +1479,7 @@ lib/X11/oneko/mouse.xpm to the net, or can only find sites that have irritatingly non-standard formats, you might want to put a copy on a reliable ftp or http server that you control (e.g., your home - page). Make sure you set MASTER_SITES to + page). Make sure you set MASTER_SITES to reflect your choice. If you @@ -1488,23 +1488,23 @@ lib/X11/oneko/mouse.xpm public_html/ directory on freefall), we can “house” it ourselves by putting - it on ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/LOCAL_PORTS/ as the last resort. Please refer to this - location as MASTER_SITE_LOCAL. Send mail to + it on ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/LOCAL_PORTS/ as the last resort. Please refer to this + location as MASTER_SITE_LOCAL. Send mail to the &a.ports;if you are not sure what to do. If your port's distfile changes all the time for no good reason, consider putting the distfile in your home page and - listing it as the first MASTER_SITES. This + listing it as the first MASTER_SITES. This will prevent users from getting checksum mismatch errors, and also reduce the workload of - maintainers of our ftp site. Also, if there isonly one master + maintainers of our ftp site. Also, if there isonly one master site for the port, it is recommended that you house a backup at your site and list it as the second MASTER_SITES. If your port requires some additional `patches' that are available on the Internet, fetch them too and put them in - DISTDIR. Do not worry if + DISTDIR. Do not worry if they come from a site other than where you got the main source tarball, we have a way to handle these situations (see the description of Unpack a copy of the tarball in a private directory and make whatever changes are necessary to get the port to compile - properly under the current version of FreeBSD. Keep + properly under the current version of FreeBSD. Keep careful track of everything you do, as - you will be automating the process shortly. Everything, + you will be automating the process shortly. Everything, including the deletion, addition or modification of files should be doable using an automated script or patch file when your port is finished. @@ -1527,7 +1527,7 @@ lib/X11/oneko/mouse.xpm If your port requires significant user interaction/customization to compile or install, you should take a look at one of Larry Wall's classic Configure scripts - and perhaps do something similar yourself. The goal of the + and perhaps do something similar yourself. The goal of the new ports collection is to make each port as “plug-and-play” as possible for the end-user while using a minimum of disk space. @@ -1545,18 +1545,18 @@ lib/X11/oneko/mouse.xpm In the preparation of the port, files that have been added or changed can be picked up with a recursive diff for later - feeding to patch. Each set of patches you wish to apply + feeding to patch. Each set of patches you wish to apply should be collected into a file named patch-xx where xx denotes the sequence in which the patches will be applied — these are done in alphabetical order, thus - aa first, ab second and so on. These files + aa first, ab second and so on. These files should be stored in PATCHDIR, from where they will be - automatically applied. All patches should be relative to + automatically applied. All patches should be relative to WRKSRC (generally the directory your port's tarball unpacks itself into, that being - where the build is done). To make fixes and upgrades easier, + where the build is done). To make fixes and upgrades easier, you should avoid having more than one patch fix the same file (e.g., patch-aa and patch-ab both changing WRKSRC/foobar.c). @@ -1567,7 +1567,7 @@ lib/X11/oneko/mouse.xpm Include any additional customization commands to your configure script and save it in the - scripts subdirectory. As mentioned + scripts subdirectory. As mentioned above, you can also do this as Makefile targets and/or scripts with the name pre-configure or @@ -1580,7 +1580,7 @@ lib/X11/oneko/mouse.xpm If your port requires user input to build, configure or install, then set IS_INTERACTIVE in your - Makefile. This will allow “overnight builds” to skip your port + Makefile. This will allow “overnight builds” to skip your port if the user sets the variable BATCH in his environment (and if the user sets the variable INTERACTIVE, then only @@ -1589,7 +1589,7 @@ lib/X11/oneko/mouse.xpm It is also recommended that if there are reasonable default answers to the questions, you check the PACKAGE_BUILDING variable and turn off the - interactive script when it is set. This will allow us to build + interactive script when it is set. This will allow us to build the packages for CD-ROMs and ftp. @@ -1612,9 +1612,9 @@ lib/X11/oneko/mouse.xpm The original source Does it live in DISTDIR as a standard gzip'd - tarball? If so, you can go on to the next step. If not, you + tarball? If so, you can go on to the next step. If not, you should look at overriding any of the EXTRACT_CMD, EXTRACT_BEFORE_ARGS, EXTRACT_AFTER_ARGS, EXTRACT_SUFX, or DISTFILES variables, depending on - how alien a format your port's distribution file is. (The + how alien a format your port's distribution file is. (The most common case is EXTRACT_SUFX=.tar.Z, when the tarball is condensed by regular compress, not gzip.) @@ -1630,7 +1630,7 @@ lib/X11/oneko/mouse.xpm <makevar>DISTNAME</makevar> You should set DISTNAME to be the base name of - your port. The default rules expect the distribution file + your port. The default rules expect the distribution file list (DISTFILES) to be named DISTNAMEEXTRACT_SUFX which, if it is a normal tarball, is going to be something like foozolix-1.0.tar.gz for a setting of DISTNAME=foozolix-1.0. @@ -1640,8 +1640,8 @@ lib/X11/oneko/mouse.xpm work/DISTNAME, e.g. work/foozolix-1.0/. All this behavior can be overridden, of course; it simply - represents the most common time-saving defaults. For a port - requiring multiple distribution files, simply set DISTFILES explicitly. If only a + represents the most common time-saving defaults. For a port + requiring multiple distribution files, simply set DISTFILES explicitly. If only a subset of DISTFILES are actual extractable archives, then set them up in EXTRACT_ONLY, which will override the DISTFILES list when @@ -1657,7 +1657,7 @@ lib/X11/oneko/mouse.xpm If DISTNAME does not conform to our guidelines for a good package name, you should set the PKGNAME - variable to something better. See the abovementioned guidelines + variable to something better. See the abovementioned guidelines for more details. @@ -1667,29 +1667,29 @@ lib/X11/oneko/mouse.xpm When a package is created, it is put under /usr/ports/packages/All and links are made from one or more subdirectories of - /usr/ports/packages. The names of these - subdirectories are specified by the variable CATEGORIES. It is intended to + /usr/ports/packages. The names of these + subdirectories are specified by the variable CATEGORIES. It is intended to make life easier for the user when he is wading through the - pile of packages on the ftp site or the CD-ROM. Please take a + pile of packages on the ftp site or the CD-ROM. Please take a look at the existing categories and pick the ones that are suitable for your port. This list also determines where in the ports tree the port - is imported. If you put more than one category here, it is + is imported. If you put more than one category here, it is assumed that the port files will be put in the subdirectory with - the name in the first category. See the categories section for more discussion about how to pick the right categories. If you port truly belongs to something that is different from all the existing ones, you can even create a new category - name. In that case, please send mail to the &a.ports; to propose + name. In that case, please send mail to the &a.ports; to propose a new category. There is no error checking for category - names. make package will happily create a + names. make package will happily create a new directory if you mustype the category name, so be careful! @@ -1699,7 +1699,7 @@ lib/X11/oneko/mouse.xpm <makevar>MASTER_SITES</makevar> Record the directory part of the ftp/http-URL pointing at - the original tarball in MASTER_SITES. Do not forget the + the original tarball in MASTER_SITES. Do not forget the trailing slash (/)! The make macros will try to use this specification for @@ -1707,7 +1707,7 @@ lib/X11/oneko/mouse.xpm already on the system. It is recommended that you put multiple sites on this - list, preferably from different continents. This will + list, preferably from different continents. This will safeguard against wide-area network problems, and we are even planning to add support for automatically determining the closest master site and fetching from there! @@ -1717,8 +1717,8 @@ lib/X11/oneko/mouse.xpm Linux Sunsite, you refer to those sites in an easy compact form using MASTER_SITE_XCONTRIB, MASTER_SITE_GNU, MASTER_SITE_PERL_CPAN, MASTER_SITE_TEX_CTAN, and - MASTER_SITE_SUNSITE. Simply set MASTER_SITE_SUBDIR to the - path with in the archive. Here is an example: + MASTER_SITE_SUNSITE. Simply set MASTER_SITE_SUBDIR to the + path with in the archive. Here is an example: MASTER_SITES= ${MASTER_SITE_XCONTRIB} @@ -1755,10 +1755,10 @@ MASTER_SITE_SUBDIR= applications If the patch is distributed with some other files, such as documentation, in a gzip'd tarball, you can't just use - PATCHFILES. If that is + PATCHFILES. If that is the case, add the name and the location of the patch tarball to DISTFILES and - MASTER_SITES. Then, from + MASTER_SITES. Then, from the pre-patch target, apply the patch either by running the patch command from there, or copying the patch file into the PATCHDIR directory and calling it @@ -1769,7 +1769,7 @@ MASTER_SITE_SUBDIR= applications regular source by then, so there is no need to explicitly extract it if it is a regular gzip'd or compress'd tarball. If you do the latter, take extra care not to overwrite - something that already exists in that directory. Also do + something that already exists in that directory. Also do not forget to add a command to remove the copied patch in the pre-clean target. @@ -1779,7 +1779,7 @@ MASTER_SITE_SUBDIR= applications <makevar>MAINTAINER</makevar> - Set your mail-address here. Please. :) + Set your mail-address here. Please. :) For detailed description of the responsibility of maintainers, refer to Dependencies - Many ports depend on other ports. There are five + Many ports depend on other ports. There are five variables that you can use to ensure that all the required - bits will be on the user's machine. There are also some + bits will be on the user's machine. There are also some pre-supported dependency variables for common cases, plus a few more to control the behaviour of dependencies. @@ -1802,12 +1802,12 @@ MASTER_SITE_SUBDIR= applications <makevar>LIB_DEPENDS</makevar> This variable specifies the shared libraries this port - depends on. It is a list of lib:dir:target tuples where + depends on. It is a list of lib:dir:target tuples where lib is the name of the shared library, and dir is the directory in which to find it in case it is not available, and target is the target to call in - that directory. For example, + that directory. For example, LIB_DEPENDS= jpeg\\.9\\.:${PORTSDIR}/graphics/jpeg:install @@ -1816,19 +1816,19 @@ LIB_DEPENDS= jpeg\\.9\\.:${PORTSDIR}/graphics/jpeg:install major version 9, and descend into the graphics/jpeg subdirectory of your ports tree to build and install it if it is not - found. The target part can be + found. The target part can be omitted if it is equal to DEPENDS_TARGET (which defaults to install). The lib part is an argument - given to ldconfig -r | grep -wF. There + given to ldconfig -r | grep -wF. There shall be no reqular expressions in this variable. The dependency is checked twice, once from within the extract target and then from within - the install target. Also, the name of the + the install target. Also, the name of the dependency is put in to the package so that pkg_add will automatically install it if it is not on the user's system. @@ -1839,12 +1839,12 @@ LIB_DEPENDS= jpeg\\.9\\.:${PORTSDIR}/graphics/jpeg:install <makevar>RUN_DEPENDS</makevar> This variable specifies executables or files this port - depends on during run-time. It is a list of path:dir:target tuples where + depends on during run-time. It is a list of path:dir:target tuples where path is the name of the executable or file, and dir is the directory in which to find it in case it is not available, and target is the target to call in - that directory. If + that directory. If path starts with a slash (/), it is treated as a file and its existence is tested with test -e; @@ -1861,7 +1861,7 @@ RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \ will check if the file or directory /usr/local/etc/innd exists, and build and install it from the news/inn - subdirectory of the ports tree if it is not found. It will + subdirectory of the ports tree if it is not found. It will also see if an executable called wish8.0 is in your search path, and descend into the x11-toolkits/tk80 subdirectory of your ports tree to build and install it if it is not @@ -1874,10 +1874,10 @@ RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \ use the full pathname. - The dependency is checked from within the install target. Also, the name of the + The dependency is checked from within the install target. Also, the name of the dependency is put in to the package so that pkg_add will automatically install it if it - is not on the user's system. The + is not on the user's system. The target part can be omitted if it is the same DEPENDS_TARGET. @@ -1887,7 +1887,7 @@ RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \ <makevar>BUILD_DEPENDS</makevar> This variable specifies executables or files this port - requires to build. Like RUN_DEPENDS, it is + requires to build. Like RUN_DEPENDS, it is a list of path:dir:target tuples. For example, @@ -1902,8 +1902,8 @@ BUILD_DEPENDS= unzip:${PORTSDIR}/archivers/unzip “build” here means everything from extracting to - compilation. The dependency is checked from within the - extract target. The + compilation. The dependency is checked from within the + extract target. The target part can be omitted if it is the same as DEPENDS_TARGET @@ -1913,8 +1913,8 @@ BUILD_DEPENDS= unzip:${PORTSDIR}/archivers/unzip <makevar>FETCH_DEPENDS</makevar> This variable specifies executables or files this port - requires to fetch. Like the previous two, it is a list of - path:dir:target tuples. For + requires to fetch. Like the previous two, it is a list of + path:dir:target tuples. For example, @@ -1926,7 +1926,7 @@ FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2 tree to build and install it if it is not found. The dependency is checked from within the - fetch target. The + fetch target. The target part can be omitted if it is the same as DEPENDS_TARGET. @@ -1938,8 +1938,8 @@ FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2 If there is a dependency that does not fall into either of the above four categories, or your port requires to have the source of the other port extracted in addition to having - them installed, then use this variable. This is a list of - dir:target, as there is nothing to check, unlike the previous four. The target part can be omitted if it is the same as DEPENDS_TARGET. + them installed, then use this variable. This is a list of + dir:target, as there is nothing to check, unlike the previous four. The target part can be omitted if it is the same as DEPENDS_TARGET. @@ -1947,15 +1947,15 @@ FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2 Define USE_XLIB=yes if your port requires the X Window System to be installed (it is implied by - USE_IMAKE). Define + USE_IMAKE). Define USE_GMAKE=yes if your port requires GNU make instead of BSD - make. Define + make. Define USE_AUTOCONF=yes if your port requires GNU - autoconf to be run. Define USE_QT=yes if - your port uses the latest qt toolkit. Use + autoconf to be run. Define USE_QT=yes if + your port uses the latest qt toolkit. Use USE_PERL5=yes if your port requires version - 5 of the perl language. (The last is especially important since + 5 of the perl language. (The last is especially important since some versions of FreeBSD has perl5 as part of the base system while others don't.) @@ -1965,25 +1965,25 @@ FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2 As mentioned above, the default target to call when a dependency is required is - DEPENDS_TARGET. It defaults to - install. This is a user variable; is is - never defined in a port's Makefile. If + DEPENDS_TARGET. It defaults to + install. This is a user variable; is is + never defined in a port's Makefile. If your port needs a special way to handle a dependency, use the :target part of the *_DEPENDS variables instead of redefining DEPENDS_TARGET. When you type make clean, its - dependencies are automatically cleaned too. If you do not wish + dependencies are automatically cleaned too. If you do not wish this to happen, define the variable NOCLEANDEPENDS in your environment. To depend on another port unconditionally, it is customary to use the string nonexistent as the first field of BUILD_DEPENDS or - RUN_DEPENDS. Use this only when you need to - the to get to the source of the other port. You can often save - compilation time by specifying the target too. For + RUN_DEPENDS. Use this only when you need to + the to get to the source of the other port. You can often save + compilation time by specifying the target too. For instance @@ -1992,10 +1992,10 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract will always descend to the JPEG port and extract it. Do not use DEPENDS unless there is no - other way the behaviour you want can be accomplished. It will + other way the behaviour you want can be accomplished. It will cause the other port to be always build (and installed, by default), and the dependency will go into the packages as - well. If this is really what you need, I recommend you + well. If this is really what you need, I recommend you write it as BUILD_DEPENDS and RUN_DEPENDS instead—at least the intention will be clear. @@ -2006,19 +2006,19 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract Building mechanisms If your package uses GNU make, set - USE_GMAKE=yes. If your package uses + USE_GMAKE=yes. If your package uses configure, set - HAS_CONFIGURE=yes. If your package uses GNU + HAS_CONFIGURE=yes. If your package uses GNU configure, set GNU_CONFIGURE=yes (this implies - HAS_CONFIGURE). If you want to give some + HAS_CONFIGURE). If you want to give some extra arguments to configure (the default argument list --prefix=${PREFIX} for GNU configure and empty for non-GNU configure), set those extra arguments in - CONFIGURE_ARGS. If your package uses GNU + CONFIGURE_ARGS. If your package uses GNU autoconf, set - USE_AUTOCONF=yes. This implies + USE_AUTOCONF=yes. This implies GNU_CONFIGURE, and will cause autoconf to be run before configure. @@ -2026,9 +2026,9 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract If your package is an X application that creates Makefiles from Imakefiles using imake, then set - USE_IMAKE=yes. This will cause the + USE_IMAKE=yes. This will cause the configure stage to automatically do an xmkmf - -a. If the flag is a + -a. If the flag is a problem for your port, set XMKMF=xmkmf. If the port uses imake but does not understand the @@ -2040,7 +2040,7 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract If your port's source Makefile has something else than all as the main build target, set ALL_TARGET - accordingly. Same goes for install and + accordingly. Same goes for install and INSTALL_TARGET. @@ -2049,7 +2049,7 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract Special considerations There are some more things you have to take into account when - you create a port. This section explains the most common of + you create a port. This section explains the most common of those. @@ -2068,7 +2068,7 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract pair to your pkg/PLIST file so that a user who installed the package can start using teh shared libraru immediately and deinstallation will not cause the system to - still believe the library is there. These lines should + still believe the library is there. These lines should immediately follow the line for the shared library itself, as in: @@ -2080,10 +2080,10 @@ lib/libtvl80.so.1 Never, ever, ever add a line that says ldconfig without any arguments to your Makefile or - pkg/PLIST. This will reset the shared + pkg/PLIST. This will reset the shared libraru cache to the contents of /usr/lib only, and will royally screw up the user's machine ("Help, xinit - does not run anymore after I install this port!"). Anybody who + does not run anymore after I install this port!"). Anybody who does this will be shot and cut in 65,536 pieces by a rusty knife and have is liver chopped out by a bunch of crows and will eternally rot to death in the deepest bowels of hell (not @@ -2096,7 +2096,7 @@ lib/libtvl80.so.1 Since FreeBSD is moving to ELF shortly after 3.0-RELEASE, we need to convert many ports that build shared libraries - to support ELF. Complicating this task is that a 3.0 + to support ELF. Complicating this task is that a 3.0 system can run as both ELF and a.out, and we wish to unofficially support the 2.2 as long as possible. Below are the guidelines on how to convert a.out only ports to @@ -2112,7 +2112,7 @@ lib/libtvl80.so.1 A.out libraries should be moved out of /usr/local/lib and similar to an - aout subdirectory. (If you don't move them + aout subdirectory. (If you don't move them out of the way, ELF ports will happily overwrite a.out libraries.) The move-aout-libs target in the 3.0-CURRENT src/Makefile (called from @@ -2125,16 +2125,16 @@ lib/libtvl80.so.1 Format The ports tree will build packages in the format the machine - is in. This means a.out for 2.2 and a.out or ELF for 3.0 depending - on what `objformat` returns. Also, once users + is in. This means a.out for 2.2 and a.out or ELF for 3.0 depending + on what `objformat` returns. Also, once users move a.out libraries to a subdirectory, building a.out libraries - will be unsupported. (I.e., it may still work if you know what you + will be unsupported. (I.e., it may still work if you know what you are doing, but you are on your own.) If a port only works for a.out, set BROKEN_ELF to a string describing the reason - why. Such ports will be skipped during a build on an ELF + why. Such ports will be skipped during a build on an ELF system. @@ -2146,10 +2146,10 @@ lib/libtvl80.so.1 PORTOBJFORMAT to aout or elf and export it in the environments CONFIGURE_ENV, SCRIPTS_ENV and - MAKE_ENV. (It's always going to be + MAKE_ENV. (It's always going to be aout in 2.2-STABLE). It is also passed to PLIST_SUB as - PORTOBJFORMAT=${PORTOBJFORMAT}. (See comment + PORTOBJFORMAT=${PORTOBJFORMAT}. (See comment on ldconfig lines below.) The variable is set using this line in @@ -2159,7 +2159,7 @@ lib/libtvl80.so.1 PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout Ports' make processes should use this variable to decide what - to do. However, if the port's configure + to do. However, if the port's configure script already automatically detects an ELF system, it is not necessary to refer to PORTOBJFORMAT. @@ -2178,7 +2178,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

libfoo.so.M where M is the single version number, and an a.out library should be called - libfoo.so.M.N where M is the major version and N is the the minor version number. Do not mix those; never install an ELF shared library called libfoo.so.N.M or an a.out shared library (or symlink) called libfoo.so.N. + libfoo.so.M.N where M is the major version and N is the the minor version number. Do not mix those; never install an ELF shared library called libfoo.so.N.M or an a.out shared library (or symlink) called libfoo.so.N. @@ -2194,7 +2194,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

You need to install a symlink from libfoo.so to libfoo.so.N to - make ELF linkers happy. Since it should be listed in + make ELF linkers happy. Since it should be listed in PLIST too, and it won't hurt in the a.out case (some ports even require the link for dynamic loading), you should just make this link regardless of the setting of @@ -2206,7 +2206,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

All port Makefiles are edited to remove minor numbers from LIB_DEPENDS, and also to have the regexp - support removed. (E.g., foo\\.1\\.\\(33|40\\) + support removed. (E.g., foo\\.1\\.\\(33|40\\) becomes foo.2.) They will be matched using grep -wF. @@ -2216,7 +2216,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

PLIST should contain the short (ELF) shlib names if the a.out minor number is zero, and the long - (a.out) names otherwise. bsd.port.mk will + (a.out) names otherwise. bsd.port.mk will automatically add .0 to the end of short shlib lines if PORTOBJFORMAT equals aout, and will delete the minor number from @@ -2227,7 +2227,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

NO_FILTER_SHLIBS. This will turn off the + NO_FILTER_SHLIBS. This will turn off the editing of PLIST mentioned in the previous paragraph. @@ -2259,16 +2259,16 @@ ${SETENV} OBJFORMAT=${PORTOBJFORMAT} ${LDCONFIG} -m .... packages by having a variable (for instance, resolution, or paper size) take different values, create one subdirectory per package to make it easier forusers to see what to do, but try to share as - many files as possible between ports. Typically you only need a + many files as possible between ports. Typically you only need a very short Makefile in all but one of the - directories if you use variables cleverly. In the sole + directories if you use variables cleverly. In the sole Makefiles, you can use MASTERDIR to specify the directory where the - rest of the files are. Also, use a variable as part of + rest of the files are. Also, use a variable as part of PKGNAME so the packages will have different names. - This will be best demonstrated by an example. This is part of + This will be best demonstrated by an example. This is part of japanese/xdvi300/Makefile; @@ -2284,7 +2284,7 @@ RESOLUTION?= 300 .endif japanese/xdvi300 also has all the regular - patches, package files, etc. If you type make + patches, package files, etc. If you type make there, it will take the default value for the resolution (300) and build the port normally. @@ -2299,12 +2299,12 @@ MASTERDIR= ${.CURDIR}/../xdvi300 .include ${MASTERDIR}/Makefile (xdvi240/Makefile and - xdvi400/Makefile are similar). The + xdvi400/Makefile are similar). The MASTERDIR definition tells bsd.port.mk that the refulat set of subdirectories like PATCHDIR and PKGDIR are to be found under - xdvi300. The + xdvi300. The RESOLUTION=118 line will override the RESOLUTION=300 line in xdvi300/Makefile and the port will be built @@ -2316,31 +2316,31 @@ MASTERDIR= ${.CURDIR}/../xdvi300 First, please read our policy on shared library versioning to understand - what to do with shared library versions in general. Do + what to do with shared library versions in general. Do not blindly assume software authors know what they are - doing; many of them do not. It is very important that + doing; many of them do not. It is very important that these details are carefully considered, as we have quite a unique situation where we are trying to have dozens of potentially incompatible software pairs co-exist. Careless port imports have caused great trouble regarding shared libraries in the past (ever wondered why the port jpeg-6b has a shared library version of 9.0?). - If in doubt, send a message to the &a.ports;. Most of the + If in doubt, send a message to the &a.ports;. Most of the time, your job ends by determining the right shared library version and making appropriate patches to implement it. However, if there is a port which is a different version of the same software already in the tree, the situation is - much more complex. In short, the FreeBSD implementation + much more complex. In short, the FreeBSD implementation does not allow the user to specify to the linker which version of shared library to link against (the linker will - always pick the highest numbered version). This means, if + always pick the highest numbered version). This means, if there is a libfoo.so.3.2 and libfoo.so.4.0 in the system, there is no way to tell the linker to link a - particular application to libfoo.so.3.2. It is + particular application to libfoo.so.3.2. It is essentially completely overshadowed in terms of - compilation-time linkage. In this case, the only solution + compilation-time linkage. In this case, the only solution is to rename the base part of the shared library. For instance, change libfoo.so.4.0 to libfoo4.so.1.0 so both version 3.2 and 4.0 can be @@ -2354,7 +2354,7 @@ MASTERDIR= ${.CURDIR}/../xdvi300 add any manpages to pkg/PLIST (this means you must not list manpages in the PLIST—see generating PLIST for more). It + linkend="porting-plist">generating PLIST for more). It also makes the install stage automatically compress or uncompress manpages depending on the setting of NOMANCOMPRESS in @@ -2418,7 +2418,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz There are many programs that require a Motif library (available from several commercial vendors, while there is a free clone reported to be able to run many applications in - x11-toolkits/lesstif) to compile. Since + x11-toolkits/lesstif) to compile. Since it is a popular toolkit and their licenses usually permit redistribution of statically linked binaries, we have made special provisions for handling ports that require Motif in a @@ -2430,7 +2430,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz <makevar>REQUIRES_MOTIF</makevar> If your port requires Motif, define this variable in the - Makefile. This will prevent people who don't own a copy of + Makefile. This will prevent people who don't own a copy of Motif from even attempting to build it. @@ -2439,7 +2439,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz This variable will be set by bsd.port.mk to be the appropriate reference - to the Motif library. Please patch the source to use this + to the Motif library. Please patch the source to use this wherever the Motif library is referenced in the Makefile or Imakefile. @@ -2473,7 +2473,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz If your port installs fonts for the X Window system, put them in X11BASE/lib/X11/fonts/local. - This directory is new to XFree86 release 3.3.3. If it does not + This directory is new to XFree86 release 3.3.3. If it does not exist, please create it, and print out a message urging the user to update their XFree86 to 3.3.3 or newer, or at least add this directory to the font path in @@ -2485,12 +2485,12 @@ ${PREFIX}/man/ja/man4/baz.4.gz The new version of texinfo (included in 2.2.2-RELEASE and onwards) contains a utility called install-info - to add and delete entries to the dir file. If + to add and delete entries to the dir file. If your port installs any info documents, please follow this instructions so your port/package will correctly update the user's PREFIX/info/dir - file. (Sorry for the length of this section, but is it imperative - to weave all the info files together. If done correctly, it will + file. (Sorry for the length of this section, but is it imperative + to weave all the info files together. If done correctly, it will produce a beautiful listing, so please bear with me! @@ -2517,14 +2517,14 @@ Options: Here's a seven-step procedure to convert ports to use - install-info. I will use + install-info. I will use editors/emacs as an example. Look at the texinfo sources and make a patch to insert @dircategory and @direntry - statements to files that don't have them. This is part of + statements to files that don't have them. This is part of my patch: @@ -2543,10 +2543,10 @@ Options: @finalout : - The format should be self-explanatory. Many authors + The format should be self-explanatory. Many authors leave a dir file in the source tree that contains all the entries you need, so look around - before you try to write your own. Also, make sure you + before you try to write your own. Also, make sure you look into related ports and make the section names and entry indentations consistent (we recommend that all entry text start at the 4th tab stop). @@ -2563,15 +2563,15 @@ Options: entries to install-info as arguments ( and ) instead of patching the texinfo - sources. I do not think this is a good idea for ports + sources. I do not think this is a good idea for ports because you need to duplicate the same information in three places (Makefile and @exec/@unexec of - PLIST; see below). However, if you + PLIST; see below). However, if you have a Japanese (or other multibyte encoding) info files, you will have to use the extra arguments to install-info because makeinfo can't handle those texinfo - sources. (See Makefile and + sources. (See Makefile and PLIST of japanese/skk for examples on how to do this). @@ -2583,7 +2583,7 @@ Options: Since the texinfo sources are newer than the info files, they should be rebuilt when you type make; but many Makefiles don't include correct - dependencies for info files. In emacs' case, I had to + dependencies for info files. In emacs' case, I had to patch the main Makefile.in so it will descend into the man subdirectory to rebuild the info pages. @@ -2614,7 +2614,7 @@ Options: The second hunk was necessary because the default target in the man subdir is called info, while the main - Makefile wants to call all. I also deleted the installation + Makefile wants to call all. I also deleted the installation of the info info file because we already have one with the same name in /usr/share/info (that patch is not @@ -2624,8 +2624,8 @@ Options: If there is a place in the Makefile that is installing the - dir file, delete it. Your - port may not be doing it. Also, remove any commands that + dir file, delete it. Your + port may not be doing it. Also, remove any commands that are otherwise mucking around with the dir file. @@ -2653,7 +2653,7 @@ Options: (This step is only necessary if you are modifying an existing port.) Take a look at pkg/PLIST and delete anything that is - trying to patch up info/dir. They + trying to patch up info/dir. They may be in pkg/INSTALL or some other file, so search extensively. @@ -2680,7 +2680,7 @@ diff -u -r1.15 PLIST Add a post-install target to the Makefile to create a - dir file if it is not there. Also, + dir file if it is not there. Also, call install-info with the installed info files. @@ -2708,7 +2708,7 @@ diff -u -r1.26 Makefile Do not use anything other than /usr/share/info/dir and the above - command to create a new info file. In fact, I'd add the + command to create a new info file. In fact, I'd add the first three lines of the above patch to bsd.port.mk if you (the porter) wouldn't have to do it in PLIST by @@ -2760,7 +2760,7 @@ diff -u -r1.15 PLIST - Test and admire your work. :). Check the dir file before and after each + Test and admire your work. :). Check the dir file before and after each step. @@ -2778,14 +2778,14 @@ diff -u -r1.15 PLIST <filename>MESSAGE</filename> If you need to display a message to the installer, you may - place the message in pkg/MESSAGE. This + place the message in pkg/MESSAGE. This capability is often useful to display additional installation steps to be taken after a pkg_add or to display licensing information. The pkg/MESSAGE file does not need to - be added to pkg/PLIST. Also, it will not get + be added to pkg/PLIST. Also, it will not get automatically printed if the user is using the port, not the package, so you should probably display it from the post-install target yourself. @@ -2797,13 +2797,13 @@ diff -u -r1.15 PLIST If your port needs to execute commands when the binary package is installed with pkg_add you can do this via the - pkg/INSTALL script. This script will + pkg/INSTALL script. This script will automatically be added to the package, and will be run twice by - pkg_add. The first time will as + pkg_add. The first time will as INSTALL ${PKGNAME} PRE-INSTALL and the second time as INSTALL ${PKGNAME} - POST-INSTALL. $2 can be - tested to determine which mode the script is being run in. The + POST-INSTALL. $2 can be + tested to determine which mode the script is being run in. The PKG_PREFIX environmental variable will be set to the package installation directory. See pkg_add @@ -2823,7 +2823,7 @@ diff -u -r1.15 PLIST If your port needs to determine if it should install or not, you can create a pkg/REQ - “requirements” script. It will be invoked + “requirements” script. It will be invoked automatically at installation/deinstallation time to determine whether or not installation/deinstallation should proceed. @@ -2833,13 +2833,13 @@ diff -u -r1.15 PLIST Some ports, particularly the p5- ports, need to change their PLIST depending on what options they are - configured with (or version of perl, in the case of p5- ports). To + configured with (or version of perl, in the case of p5- ports). To make this easy, any instances in the PLIST of %%OSREL%%, %%PERL_VER%%, and %%PERL_VERSION%% will be substituted for - appropriately. The value of %%OSREL%% is the + appropriately. The value of %%OSREL%% is the numeric revision of the operating system (e.g., - 2.2.7). %%PERL_VERSION%% is + 2.2.7). %%PERL_VERSION%% is the full version number of perl (e.g., 5.00502) and %%PERL_VER%% is the perl version number minus the patchlevel (e.g., 5.005). @@ -2886,7 +2886,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} All the filenames in the pkg subdirectory are defined using variables so you can change them in your - Makefile if need be. This is especially useful when you + Makefile if need be. This is especially useful when you are sharing the same pkg subdirectory among several ports or have to write to one of the above files (see writing to places other than @@ -2946,7 +2946,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} Please change these variables rather than overriding - PKG_ARGS. If you change + PKG_ARGS. If you change PKG_ARGS, those files will not correctly be installed in /var/db/pkg upon install from a port. @@ -2958,7 +2958,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} Some software packages have restrictive licenses or can be in violation to the law (PKP's patent on public key crypto, ITAR - (export of crypto software) to name just two of them). What we + (export of crypto software) to name just two of them). What we can do with them varies a lot, depending on the exact wordings of the respective licenses. @@ -2967,7 +2967,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} licensing terms of the software and make sure that the FreeBSD project will not be held accountable of violating them by redistributing the source or compiled binaries either via ftp - or CD-ROM. If in doubt, please contact the &a.ports;. + or CD-ROM. If in doubt, please contact the &a.ports;. There are two variables you can set in the Makefile to @@ -2979,9 +2979,9 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} If the port has a “do not sell for profit” type of license, set the variable NO_CDROM to a - string describing the reason why. We + string describing the reason why. We will make sure such ports won't go into the CD-ROM come - release time. The distfile and package will still be + release time. The distfile and package will still be available via ftp. @@ -2990,9 +2990,9 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} for each site, or the resulting binary package can't be distributed due to licensing; set the variable NO_PACKAGE to a string describing the - reason why. We will make sure such + reason why. We will make sure such packages won't go on the ftp site, nor into the CD-ROM - come release time. The distfile will still be included on + come release time. The distfile will still be included on both however. @@ -3000,7 +3000,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} If the port has legal restrictions on who can use it (e.g., crypto stuff) or has a “no commercial use” license, set the variable RESTRICTED to be the - string describing the reason why. For such ports, the + string describing the reason why. For such ports, the distfiles/packages will not be available even from our ftp sites. @@ -3024,12 +3024,12 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} When you notice that a port is out of date compared to the latest version from the original authors, first make sure you - have the latest port. You can find them in the + have the latest port. You can find them in the ports/ports-current directory of the ftp mirror sites. The next step is to send a mail to the maintainer, if one is - listed in the port's Makefile. That person may already be + listed in the port's Makefile. That person may already be working on an upgrade, or have a reason to not upgrade the port right now (because of, for example, stability problems of the new version). @@ -3043,12 +3043,12 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} and the original as in our tree is superedit.bak, then send us the result of diff -ruN superedit.bak - superedit). Please examine the output to make - sure all the changes make sense. The best way to send us the + superedit). Please examine the output to make + sure all the changes make sense. The best way to send us the diff is by including it to send-pr1 - (category ports). Please mention any added or deleted files + (category ports). Please mention any added or deleted files in the message, as they have to be explicitly specified to CVS - when doing a commit. If the diff is more than about 20KB, please + when doing a commit. If the diff is more than about 20KB, please compress and uuencode it; otherwise, just include it in as is in the PR. @@ -3062,18 +3062,18 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} Here is a list of common do's and dont's that you encounter during the porting process.You should check your own port against this list, but you can also check ports in the PR - database that others have submitted. Submit any comments on + database that others have submitted. Submit any comments on ports you check as described in Bug - Reports and General Commentary. Checking ports in + Reports and General Commentary. Checking ports in the PR database will both make it faster for us to commit them, and prove that you know what you are doing. Strip Binaries - Do strip binaries. If the original source already strips the + Do strip binaries. If the original source already strips the binaries, fine; otherwise you should add a - post-install rule to to it yourself. Here is an + post-install rule to to it yourself. Here is an example; @@ -3084,7 +3084,7 @@ post-install: file 1 command on the installed executable to check - whether the binary is stripped or not. If it does not say + whether the binary is stripped or not. If it does not say not stripped, it is stripped. @@ -3127,10 +3127,10 @@ post-install: <makevar>WRKDIR</makevar> Do not write anything to files outside - WRKDIR. WRKDIR is the only + WRKDIR. WRKDIR is the only place that is guaranteed to be writable during the port build (see compiling ports from CDROM for an - example of building ports from a read-only tree). If you need to + example of building ports from a read-only tree). If you need to modigy some file in PKGDIR, do so by redefining a variable, not by writing over it. @@ -3140,8 +3140,8 @@ post-install: <makevar>WRKDIRPREFIX</makevar> Make sure your port honors - WRKDIRPREFIX. Most ports don't have to worry - about this. In particular, if you are referring to a + WRKDIRPREFIX. Most ports don't have to worry + about this. In particular, if you are referring to a WRKDIR of another port, note that the correct location is WRKDIRPREFIXPORTSDIR/subdir/name/work not PORTSDIR/subdir/name/work or .CURDIR/../../subdir/name/work or some such. @@ -3157,7 +3157,7 @@ post-install: You may come across code that needs modifications or conditional compilation based upon what version of UNIX it is - running under. If you need to make such changes to the code for + running under. If you need to make such changes to the code for conditional compilation, make sure you make the changes as general as possible so that we can back-port code to FreeBSD 1.x systems and cross-port to other BSD systems such as 4.4BSD from CSRG, @@ -3166,7 +3166,7 @@ post-install: The preferred way to tell 4.3BSD/Reno (1990) and newer versions of the BSD code apart is by using the BSD macro defined in - <sys/param.h>. Hopefully that file is + <sys/param.h>. Hopefully that file is already included; if not, add the code: @@ -3174,10 +3174,10 @@ post-install: #include <sys/param.h> #endif - to the proper place in the .c file. We + to the proper place in the .c file. We believe that every system that defines these two symbols has - sys/param.h. If you find a system that - doesn't, we would like to know. Please send mail to the + sys/param.h. If you find a system that + doesn't, we would like to know. Please send mail to the &a.ports;. Another way is to use the GNU Autoconf style of doing @@ -3212,10 +3212,10 @@ post-install: above). The value of the BSD macro is - 199506 for the 4.4BSD-Lite2 code base. This is - stated for informational purposes only. It should not be used to + 199506 for the 4.4BSD-Lite2 code base. This is + stated for informational purposes only. It should not be used to distinguish between versions of FreeBSD based only on 4.4-Lite vs. - versions that have merged in changes from 4.4-Lite2. The + versions that have merged in changes from 4.4-Lite2. The __FreeBSD__ macro should be used instead. @@ -3226,8 +3226,8 @@ post-install: __FreeBSD__ is defined in all - versions of FreeBSD. Use it if the change you are making - only affects FreeBSD. Porting gotchas like the use of + versions of FreeBSD. Use it if the change you are making + only affects FreeBSD. Porting gotchas like the use of sys_errlist[] vs strerror() are Berkeleyisms, not FreeBSD changes. @@ -3235,8 +3235,8 @@ post-install: In FreeBSD 2.x, __FreeBSD__ is - defined to be 2. In earlier - versions, it is 1. Later + defined to be 2. In earlier + versions, it is 1. Later versions will bump it to match their major version number. @@ -3244,12 +3244,12 @@ post-install: If you need to tell the difference between a FreeBSD 1.x system and a FreeBSD 2.x or 3.x system, usually the right answer is to use the BSD macros - described above. If there actually is a FreeBSD specific + described above. If there actually is a FreeBSD specific change (such as special shared library options when using ld) then it is OK to use __FreeBSD__ and #if __FreeBSD__ > 1 to detect a FreeBSD 2.x - and later system. If you need more granularity in + and later system. If you need more granularity in detecting FreeBSD systems since 2.0-RELEASE you can use the following: @@ -3463,12 +3463,12 @@ post-install: Note that 2.2-STABLE sometimes identifies itself as - “2.2.5-STABLE” after the 2.2.5-RELEASE. The pattern used to + “2.2.5-STABLE” after the 2.2.5-RELEASE. The pattern used to be year followed by the month, but we decided to change it to a more straightforward major/minor system starting from - 2.2. This is because the parallel development on several + 2.2. This is because the parallel development on several branches made it infeasible to classify the releases simply - by their real release dates. If you are making a port now, + by their real release dates. If you are making a port now, you don't have to worry about old -CURRENTs; they are listed here just for your reference. @@ -3476,7 +3476,7 @@ post-install: In the hundreds of ports that have been done, there have only been one or two cases where __FreeBSD__ - should have been used. Just because an earlier port screwed up + should have been used. Just because an earlier port screwed up and used it in the wrong place does not mean you should do so too. @@ -3486,7 +3486,7 @@ post-install: bsd.port.mk Do not write anything after the .include - <bsd.port.mk> line. it usually can be avoided by + <bsd.port.mk> line. it usually can be avoided by including bsd.port.pre.mk somewhere in the middle of your Makefile and bsd.port.post.mk at the end. @@ -3609,11 +3609,11 @@ post-install: If your software has some documentation other than the standard man and info pages that you think is useful for the user, install it under - PREFIX/share/doc. This can be + PREFIX/share/doc. This can be done, like the previous item, in the post-install target. - Create a new directory for your port. The directory name - should reflect what the port is. This usually means PKGNAME minus the version part. + Create a new directory for your port. The directory name + should reflect what the port is. This usually means PKGNAME minus the version part. However, if you think the user might want different versions of the port to be installed at the same time, you can use the whole PKGNAME. @@ -3636,7 +3636,7 @@ post-install: /etc/make.conf.) Also you can use the pkg/MESSAGE file to - display messages upon installation. See the using pkg/MESSAGE section for details. @@ -3651,12 +3651,12 @@ post-install: <makevar>DIST_SUBDIR</makevar> Do not let your port clutter - /usr/ports/distfiles. If your port + /usr/ports/distfiles. If your port requires a lot of files to be fetched, or contains a file that has a name that might conflict with other ports (e.g., Makefile), set DIST_SUBDIR to the name of the port (PKGNAME without the - version part should work fine). This will change DISTDIR from the default + version part should work fine). This will change DISTDIR from the default /usr/ports/distfiles to /usr/ports/distfiles/DIST_SUBDIR, and in effect puts everything that is required for your port @@ -3664,7 +3664,7 @@ post-install: It will also look at the subdirectory with the same name on the backup master site at - ftp.freebsd.org. (Setting DISTDIR explicitly in your + ftp.freebsd.org. (Setting DISTDIR explicitly in your Makefile will not accomplish this, so please use DIST_SUBDIR.) @@ -3691,10 +3691,10 @@ post-install: RCS strings - Do not put RCS strings in patches. CVS will mangle them + Do not put RCS strings in patches. CVS will mangle them when we put the files into the ports tree, and when we check them out again, they will come out different and the patch - will fail. RCS strings are surrounded by dollar ($) signs, and typically start with + will fail. RCS strings are surrounded by dollar ($) signs, and typically start with $Id or $RCS. @@ -3705,10 +3705,10 @@ post-install: Using the recurse () option to diff to generate patches is fine, but please take a look at the resulting patches to make - sure you don't have any unnecessary junk in there. In + sure you don't have any unnecessary junk in there. In particular, diffs between two backup files, Makefiles when the port uses Imake or GNU configure, etc., are unnecessary and - should be deleted. If you had to edit + should be deleted. If you had to edit configure.in and run autoconf to regenerate configure, do not take the diffs of @@ -3718,7 +3718,7 @@ post-install: Also, if you had to delete a file, then you can do it in the post-extract - target rather than as part of the patch. Once you are happy + target rather than as part of the patch. Once you are happy with the resulting diff, please split it up into one source file per patch file. @@ -3727,7 +3727,7 @@ post-install: <makevar>PREFIX</makevar> - Do try to make your port install relative to PREFIX. (The value of this + Do try to make your port install relative to PREFIX. (The value of this variable will be set to LOCALBASE (default /usr/local), unless USE_X_PREFIX or USE_IMAKE is set, in which case it will be X11BASE (default @@ -3736,7 +3736,7 @@ post-install: Not hard-coding /usr/local or /usr/X11R6 anywhere in the source will make the port much more flexible and able to cater to the - needs of other sites. For X ports that use imake, this is + needs of other sites. For X ports that use imake, this is automatic; otherwise, this can often be done by simply replacing the occurrences of /usr/local (or /usr/X11R6 for X ports that do not @@ -3751,12 +3751,12 @@ post-install: The variable PREFIX can be reassigned in your Makefile or in the user's - environment. However, it is strongly discouraged for + environment. However, it is strongly discouraged for individual ports to set this variable explicitly in the Makefiles. Also, refer to programs/files from other ports with the - variables mentioned above, not explicit pathnames. For + variables mentioned above, not explicit pathnames. For instance, if your port requires a macro PAGER to be the full pathname of less, use the compiler flag: @@ -3776,22 +3776,22 @@ post-install: Subdirectories Try to let the port put things in the right subdirectories - of PREFIX. Some ports + of PREFIX. Some ports lump everything and put it in the subdirectory with the port's - name, which is incorrect. Also, many ports put everything + name, which is incorrect. Also, many ports put everything except binaries, header files and manual pages in the a subdirectory of lib, which does not - bode well with the BSD paradigm. Many of the files should be + bode well with the BSD paradigm. Many of the files should be moved to one of the following: etc (setup/configuration files), libexec (executables started internally), sbin (executables for superusers/managers), info (documentation for info browser) or share (architecture independent - files). See man hier7 for + files). See man hier7 for details, the rules governing /usr pretty - much apply to /usr/local too. The - exception are ports dealing with USENET “news”. They may use + much apply to /usr/local too. The + exception are ports dealing with USENET “news”. They may use PREFIX/news as a destination for their files. @@ -3801,9 +3801,9 @@ post-install: Cleaning up empty directories Do make your ports clean up after themselves when they are - deinstalled. This is usually accomplished by adding + deinstalled. This is usually accomplished by adding @dirrm lines for all directories that are - specifically created by the port. You need to delete + specifically created by the port. You need to delete subdirectories before you can delete parent directories. @@ -3816,7 +3816,7 @@ lib/X11/oneko/sounds/cat.au @dirrm lib/X11/oneko However, sometimes @dirrm will give you - errors because other ports also share the same subdirectory. You + errors because other ports also share the same subdirectory. You can call rmdir from @unexec to remove only empty directories without warning. @@ -3836,16 +3836,16 @@ lib/X11/oneko/sounds/cat.au If your port requires a certain user to be on the installed system, let the pkg/INSTALL script call pw to create it - automatically. Look at net/cvsup-mirror + automatically. Look at net/cvsup-mirror for an example. If your port must use the same user/group ID number when it is installed a binarypackage as when it was compiled, then you mus - choose a free UID from 50 to 99 and register it below. Look at + choose a free UID from 50 to 99 and register it below. Look at japanese/Wnn for an example. Make sure you don't use a UID already used by the system - or other ports. This is the current list of UIDs between 50 + or other ports. This is the current list of UIDs between 50 and 99. @@ -3869,7 +3869,7 @@ qmailr:*:86:82:QMail user:/var/qmail:/nonexistent msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh Please include a notice when you submit a port (or an - upgrade) that reserves a new UID or GID in this range. This allows + upgrade) that reserves a new UID or GID in this range. This allows us to keep the list of reserved IDs up to date. @@ -3893,7 +3893,7 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh Respect <makevar>CFLAGS</makevar> The port should respect the CFLAGS - variable. If it doesn't, please add NO_PACKAGE=ignores + variable. If it doesn't, please add NO_PACKAGE=ignores cflags to the Makefile. @@ -3903,7 +3903,7 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh If your port requires some configuration files in PREFIX/etc, do not just install them and list them in - pkg/PLIST. That will cause + pkg/PLIST. That will cause pkg_delete to delete files carefully edited by the user and a new installation to wipe them out. @@ -3927,7 +3927,7 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh Feedback Do send applicable changes/patches to the original - author/maintainer for inclusion in next release of the code. This + author/maintainer for inclusion in next release of the code. This will only make your job that much easier for the next release. @@ -3937,7 +3937,7 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh The files pkg/DESCR, pkg/COMMENT, and - pkg/PLIST should each be double-checked. If + pkg/PLIST should each be double-checked. If you are reviewing a port and feel they can be worded better, do so. @@ -3965,13 +3965,13 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh A Sample <filename>Makefile</filename> Here is a sample Makefile that you can - use to create a new port. Make sure you remove all the extra + use to create a new port. Make sure you remove all the extra comments (ones between brackets)! It is recommended that you follow this format (ordering of - variables, empty lines between sections, etc.). This format is + variables, empty lines between sections, etc.). This format is designed so that the most important information is easy to - locate. We recommend that you use portlint to check the Makefile. @@ -4060,7 +4060,7 @@ pre-install: Package Names The following are the conventions you should follow in - naming your packages. This is to have our package directory + naming your packages. This is to have our package directory easy to scan, as there are already lots and lots of packages and users are going to turn away if they hurt their eyes! @@ -4075,9 +4075,9 @@ pre-install: FreeBSD strives to support the native language of its - users. The language- part should be a two letter + users. The language- part should be a two letter abbreviation of the natural language defined by ISO-639 if - the port is specific to a certain language. Examples are + the port is specific to a certain language. Examples are ja for Japanese, ru for Russian, vi for Vietnamese, zh for Chinese, ko for Korean and de for German. @@ -4085,17 +4085,17 @@ pre-install: The name part should be all lowercases, except for a really large - package (with lots of programs in it). Things like + package (with lots of programs in it). Things like XFree86 (yes there really is a port of it, check it - out) and ImageMagick fall into this category. Otherwise, + out) and ImageMagick fall into this category. Otherwise, convert the name (or at least the first letter) to - lowercase. If the capital letters are + lowercase. If the capital letters are important to the name (for example, with one-letter names like R or V) you may use capital letters at your discretion. There is a tradition of naming Perl 5 modules by prepending p5- and converting the double-colon separator to a hyphen; for example, the Data::Dumper module becomes - p5-Data-Dumper. If the software in question has numbers, + p5-Data-Dumper. If the software in question has numbers, hyphens, or underscores in its name, you may include them as well (like kinput2). @@ -4105,13 +4105,13 @@ pre-install: defaults (usually part of the directory name in a family of ports), the -compiled.specifics part should state the - compiled-in defaults (the hyphen is optional). Examples + compiled-in defaults (the hyphen is optional). Examples are papersize and font units. The version string should be a period-separated list - of integers and single lowercase alphabetics. The only + of integers and single lowercase alphabetics. The only exception is the string pl (meaning `patchlevel'), which can be used only when there are no major and minor version numbers in the software. @@ -4226,7 +4226,7 @@ pre-install: If there is absolutely no trace of version information in the original source and it is unlikely that the original author will ever release another version, just set the version string - to 1.0 (like the piewm example above). Otherwise, ask the + to 1.0 (like the piewm example above). Otherwise, ask the original author or use the date string (yy.mm.dd) as the version. @@ -4236,14 +4236,14 @@ pre-install: Categories As you already know, ports are classified in several - categories. But for this to wor, it is important that porters and + categories. But for this to wor, it is important that porters and users understand what each category and how we deicde what to put in each category. Current list of categories - First, this is the current list of port categories. Those + First, this is the current list of port categories. Those marked with an asterisk (*) are virtual categories—those that do not have a corresponding subdirectory in the ports tree. @@ -4307,7 +4307,7 @@ pre-install: comms - Communication software. Mostly software to talk to + Communication software. Mostly software to talk to your serial port. @@ -4329,7 +4329,7 @@ pre-install: devel - Development utilities. Do not put libraries here just + Development utilities. Do not put libraries here just because they are libraries—unless they truly don't belong to anywhere else, they shouldn't be in this category. @@ -4337,7 +4337,7 @@ pre-install: editors - General editors. Specialized editors go in the + General editors. Specialized editors go in the section for those tools (e.g., a mathematical-formula editor will go in math). @@ -4349,7 +4349,7 @@ pre-install: emulators - Emulators for other operating systems. Terminal + Emulators for other operating systems. Terminal emulators do not belong here—X-based ones should go to x11 and text-based ones to either @@ -4412,9 +4412,9 @@ pre-install: misc Miscellaneous utilities—basically things that - doesn't belong to anywhere else. This is the only category + doesn't belong to anywhere else. This is the only category that should not appear with any other non-virtual - category. If you have misc with + category. If you have misc with something else in your CATEGORIES line, that means you can safely delete misc and just put the port in that other subdirectory! @@ -4452,7 +4452,7 @@ pre-install: print - Printing software. Desktop publishing tools + Printing software. Desktop publishing tools (previewers, etc.) belong here too. @@ -4503,7 +4503,7 @@ pre-install: textproc - Text processing utilities. It does not include + Text processing utilities. It does not include desktop publishing tools, which go to print/. @@ -4540,7 +4540,7 @@ pre-install: www - Software related to the World Wide Web. HTML language + Software related to the World Wide Web. HTML language support belong here too. @@ -4551,7 +4551,7 @@ pre-install: Do not put regular X applications here. If your port is an X application, define USE_XLIB (implied by USE_IMAKE) and put it in - appropriate categories. Also, many of them go into other + appropriate categories. Also, many of them go into other x11-* categories (see below). @@ -4589,21 +4589,21 @@ pre-install: As many of the categories overlap, you often have to choose which of the categories should be the primary category of your - port. There are several rules that govern this usse. Here is the + port. There are several rules that govern this usse. Here is the list of priorities, in decreasing order of precedence. - Language specific categories alwasys come first. For + Language specific categories alwasys come first. For example, if your port installs Japanese X11 fonts, then your CATEGORIES line would read japanese x11. - Specific categories win over less-specific ones. For + Specific categories win over less-specific ones. For instance, an HTML editor should be listed as www - editors, not the other way around. Also, you don't + editors, not the other way around. Also, you don't need to list net when the port belongs to either of mail, mbone, news, security, or @@ -4612,7 +4612,7 @@ pre-install: x11 is used as a secondary category - only when the primary category is a natural language. In + only when the primary category is a natural language. In particular, you should not put x11 in the category line for X applications. @@ -4625,7 +4625,7 @@ pre-install: If you are not sure about the category, please put a comment to that effect in your send-pr submission so we - can discuss it before import it. (If you are a committer, send a + can discuss it before import it. (If you are a committer, send a note &a.ports; so we can discuss it first—too often new ports are imported to a wrong category only to be moved right away.) @@ -4636,8 +4636,8 @@ pre-install: Changes to this document and the ports system If you maintain a lot of ports, you should consider following - the &a.ports;. Important changes to - the way ports work will be announced there. You can always + the &a.ports;. Important changes to + the way ports work will be announced there. You can always find more detailed information on the latest changes by looking at diff --git a/en_US.ISO_8859-1/books/handbook/advanced-networking/chapter.sgml b/en_US.ISO_8859-1/books/handbook/advanced-networking/chapter.sgml index 1a2a36d58e..35d5491ae5 100644 --- a/en_US.ISO_8859-1/books/handbook/advanced-networking/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/advanced-networking/chapter.sgml @@ -10,13 +10,13 @@ For one machine to be able to find another, there must be a mechanism in place to describe how to get from one to the other. - This is called Routing. A “route” is a defined pair of addresses: - a “destination” and a “gateway”. The pair indicates that if you are + This is called Routing. A “route” is a defined pair of addresses: + a “destination” and a “gateway”. The pair indicates that if you are trying to get to this destination, send along - through this gateway. There are three types of - destinations: individual hosts, subnets, and “default”. The - “default route” is used if none of the other routes apply. We will - talk a little bit more about default routes later on. There are + through this gateway. There are three types of + destinations: individual hosts, subnets, and “default”. The + “default route” is used if none of the other routes apply. We will + talk a little bit more about default routes later on. There are also three types of gateways: individual hosts, interfaces (also called “links”), and ethernet hardware addresses. @@ -47,20 +47,20 @@ host2.foobar.com link#1 UC 0 0 The interface (Netif column) that it specifies to use for localhost is - lo0, also known as the loopback device. This + lo0, also known as the loopback device. This says to keep all traffic for this destination internal, rather than sending it out over the LAN, since it will only end up back where it started anyway. - The next thing that stands out are the 0:e0:... addresses. These are ethernet - hardware addresses. FreeBSD will automatically identify any hosts + The next thing that stands out are the 0:e0:... addresses. These are ethernet + hardware addresses. FreeBSD will automatically identify any hosts (test0 in the example) on the local ethernet and add a route for that host, directly to it over the - ethernet interface, ed0. There is + ethernet interface, ed0. There is also a timeout (Expire column) associated with this type of route, which is used if we fail to - hear from the host in a specific amount of time. In this case the - route will be automatically deleted. These hosts are identified + hear from the host in a specific amount of time. In this case the + route will be automatically deleted. These hosts are identified using a mechanism known as RIP (Routing Information Protocol), which figures out routes to local hosts based upon a shortest path determination. @@ -69,28 +69,28 @@ host2.foobar.com link#1 UC 0 0 (10.20.30.255 is the broadcast address for the subnet 10.20.30, and foobar.com is the domain name - associated with that subnet). The designation link#1 refers to the first ethernet card in - the machine. You will notice no additional interface is specified + associated with that subnet). The designation link#1 refers to the first ethernet card in + the machine. You will notice no additional interface is specified for those. Both of these groups (local network hosts and local subnets) have their routes automatically configured by a daemon called - routed. If this is not run, then + routed. If this is not run, then only routes which are statically defined (ie. entered explicitly) will exist. The host1 line refers to our - host, which it knows by ethernet address. Since we are the + host, which it knows by ethernet address. Since we are the sending host, FreeBSD knows to use the loopback interface (lo0) rather than sending it out over the ethernet interface. The two host2 lines are an example of what happens when we use an ifconfig alias (see the - section of ethernet for reasons why we would do this). The + section of ethernet for reasons why we would do this). The => symbol after the lo0 interface says that not only are we using the loopback (since this is address also refers to the local - host), but specifically it is an alias. Such routes only show up + host), but specifically it is an alias. Such routes only show up on the host that supports the alias; all other hosts on the local network will simply have a link#1 line for such. @@ -98,8 +98,8 @@ host2.foobar.com link#1 UC 0 0 The final line (destination subnet 224) deals with MultiCasting, which will be covered in a another section. - The other column that we should talk about are the Flags. Each route has different attributes - that are described in the column. Below is a short table of some + The other column that we should talk about are the Flags. Each route has different attributes + that are described in the column. Below is a short table of some of these flags and their meanings: @@ -162,14 +162,14 @@ host2.foobar.com link#1 UC 0 0 When the local system needs to make a connection to remote host, it checks the routing table to determine if a known path - exists. If the remote host falls into a subnet that we know how to + exists. If the remote host falls into a subnet that we know how to reach (Cloned routes), then the system checks to see if it can connect along that interface. If all known paths fail, the system has one last option: the - “default” route. This route is a + “default” route. This route is a special type of gateway route (usually the only one present in the - system), and is always marked with a c in the flags field. For hosts on a + system), and is always marked with a c in the flags field. For hosts on a local area network, this gateway is set to whatever machine has a direct connection to the outside world (whether via PPP link, or your hardware device attached to a dedicated data line). @@ -179,7 +179,7 @@ host2.foobar.com link#1 UC 0 0 the default route will be the gateway machine at your Internet Service Provider's (ISP) site. - Let us look at an example of default routes. This is a common + Let us look at an example of default routes. This is a common configuration: @@ -187,7 +187,7 @@ host2.foobar.com link#1 UC 0 0 The hosts Local1 and Local2 are at your site, with the formed - being your PPP connection to your ISP's Terminal Server. Your ISP + being your PPP connection to your ISP's Terminal Server. Your ISP has a local network at their site, which has, among other things, the server where you connect and a hardware device (T1-GW) attached to the ISP's Internet feed. @@ -227,13 +227,13 @@ host2.foobar.com link#1 UC 0 0 Remember, since the PPP interface is using an address on the ISP's local network for your side of the connection, routes for any other machines on the ISP's local network will be - automatically generated. Hence, you will already know how to reach + automatically generated. Hence, you will already know how to reach the T1-GW machine, so there is no need for the intermediate step of sending traffic to the ISP server. As a final note, it is common to use the address ...1 as the gateway address for your local - network. So (using the same example), if your local class-C + network. So (using the same example), if your local class-C address space was 10.20.30 and your ISP was using 10.9.9 then the default routes would be: @@ -251,20 +251,20 @@ Local1 (10.20.30.1, 10.9.9.30) --> T1-GW (10.9.9.1) There is one other type of configuration that we should cover, and that is a host that sits on two different networks. Technically, any machine functioning as a gateway (in the example - above, using a PPP connection) counts as a dual-homed host. But + above, using a PPP connection) counts as a dual-homed host. But the term is really only used to refer to a machine that sits on two local-area networks. In one case, the machine as two ethernet cards, each having an - address on the separate subnets. Alternately, the machine may only - have one ethernet card, and be using ifconfig aliasing. The former + address on the separate subnets. Alternately, the machine may only + have one ethernet card, and be using ifconfig aliasing. The former is used if two physically separate ethernet networks are in use, the latter if there is one physical network segment, but two logically separate subnets. Either way, routing tables are set up so that each subnet knows that this machine is the defined gateway (inbound route) to - the other subnet. This configuration, with the machine acting as + the other subnet. This configuration, with the machine acting as a Bridge between the two subnets, is often used when we need to implement packet filtering or firewall security in either or both directions. @@ -286,21 +286,21 @@ Local1 (10.20.30.1, 10.9.9.30) --> T1-GW (10.9.9.1) When you get an address space assigned to your site, your service provider will set up their routing tables so that all traffic for your subnet will be sent down your PPP link to your - site. But how do sites across the country know to send to your + site. But how do sites across the country know to send to your ISP? There is a system (much like the distributed DNS information) that keeps track of all assigned address-spaces, and defines their - point of connection to the Internet Backbone. The “Backbone” are + point of connection to the Internet Backbone. The “Backbone” are the main trunk lines that carry Internet traffic across the - country, and around the world. Each backbone machine has a copy of + country, and around the world. Each backbone machine has a copy of a master set of tables, which direct traffic for a particular network to a specific backbone carrier, and from there down the chain of service providers until it reaches your network. It is the task of your service provider to advertise to the backbone sites that they are the point of connection (and thus the - path inward) for your site. This is known as route + path inward) for your site. This is known as route propagation. @@ -309,14 +309,14 @@ Local1 (10.20.30.1, 10.9.9.30) --> T1-GW (10.9.9.1) Troubleshooting Sometimes, there is a problem with routing propagation, and - some sites are unable to connect to you. Perhaps the most useful + some sites are unable to connect to you. Perhaps the most useful command for trying to figure out where a routing is breaking down - is the traceroute8 command. It is equally + is the traceroute8 command. It is equally useful if you cannot seem to make a connection to a remote machine - (ie. ping8 fails). + (ie. ping8 fails). The traceroute8 command is run with the - name of the remote host you are trying to connect to. It will show + name of the remote host you are trying to connect to. It will show the gateway hosts along the path of the attempt, eventually either reaching the target host, or terminating because of a lack of connection. @@ -339,38 +339,38 @@ Local1 (10.20.30.1, 10.9.9.30) --> T1-GW (10.9.9.1) The problem nearly always occurs when (FreeBSD) PC systems are networked with high-performance workstations, such as those made by - Silicon Graphics, Inc., and Sun Microsystems, Inc. The NFS mount + Silicon Graphics, Inc., and Sun Microsystems, Inc. The NFS mount will work fine, and some operations may succeed, but suddenly the server will seem to become unresponsive to the client, even though - requests to and from other systems continue to be processed. This + requests to and from other systems continue to be processed. This happens to the client system, whether the client is the FreeBSD - system or the workstation. On many systems, there is no way to shut + system or the workstation. On many systems, there is no way to shut down the client gracefully once this problem has manifested itself. The only solution is often to reset the client, because the NFS situation cannot be resolved. Though the “correct” solution is to get a higher performance and capacity Ethernet adapter for the FreeBSD system, there is a simple - workaround that will allow satisfactory operation. If the FreeBSD + workaround that will allow satisfactory operation. If the FreeBSD system is the server, include the option on the mount from - the client. If the FreeBSD system is the client, then mount the NFS - file system with the option . These options may be + the client. If the FreeBSD system is the client, then mount the NFS + file system with the option . These options may be specified using the fourth field of the fstab entry on the client for automatic mounts, or by using the parameter of the mount command for manual mounts. It should be noted that there is a different problem, sometimes mistaken for this one, when the NFS servers and clients are on - different networks. If that is the case, make certain that your + different networks. If that is the case, make certain that your routers are routing the necessary UDP information, or you will not get anywhere, no matter what else you are doing. In the following examples, fastws is the host (interface) name of a high-performance workstation, and freebox is the host (interface) name of a FreeBSD system with a lower-performance - Ethernet adapter. Also, /sharedfs will be the exported NFS + Ethernet adapter. Also, /sharedfs will be the exported NFS filesystem (see man exports), and /project will be the mount - point on the client for the exported file system. In all cases, + point on the client for the exported file system. In all cases, note that additional options, such as or and may be desirable in your application. @@ -402,18 +402,18 @@ freebox:/sharedfs /project nfs rw,-w=1024 0 0 the above restrictions on the read or write size. For anyone who cares, here is what happens when the failure - occurs, which also explains why it is unrecoverable. NFS typically + occurs, which also explains why it is unrecoverable. NFS typically works with a “block” size of 8k (though it may do fragments of - smaller sizes). Since the maximum Ethernet packet is around 1500 + smaller sizes). Since the maximum Ethernet packet is around 1500 bytes, the NFS “block” gets split into multiple Ethernet packets, even though it is still a single unit to the upper-level code, and - must be received, assembled, and acknowledged as a unit. The + must be received, assembled, and acknowledged as a unit. The high-performance workstations can pump out the packets which comprise the NFS unit one right after the other, just as close - together as the standard allows. On the smaller, lower capacity + together as the standard allows. On the smaller, lower capacity cards, the later packets overrun the earlier packets of the same unit before they can be transferred to the host and the unit as a - whole cannot be reconstructed or acknowledged. As a result, the + whole cannot be reconstructed or acknowledged. As a result, the workstation will time out and try again, but it will try again with the entire 8K unit, and the process will be repeated, ad infinitum. @@ -425,7 +425,7 @@ freebox:/sharedfs /project nfs rw,-w=1024 0 0 Overruns may still occur when a high-performance workstations is slamming data out to a PC system, but with the better cards, such - overruns are not guaranteed on NFS “units”. When an overrun occurs, + overruns are not guaranteed on NFS “units”. When an overrun occurs, the units affected will be retransmitted, and there will be a fair chance that they will be received, assembled, and acknowledged. @@ -438,8 +438,8 @@ freebox:/sharedfs /project nfs rw,-w=1024 0 0 netboot.com/netboot.rom allow you to boot your FreeBSD machine over the network and run FreeBSD without having - a disk on your client. Under 2.0 it is now possible to have local - swap. Swapping over NFS is also still supported. + a disk on your client. Under 2.0 it is now possible to have local + swap. Swapping over NFS is also still supported. Supported Ethernet cards include: Western Digital/SMC 8003, 8013, 8216 and compatibles; NE1000/NE2000 and compatibles (requires @@ -453,7 +453,7 @@ freebox:/sharedfs /project nfs rw,-w=1024 0 0 - Find a machine that will be your server. This machine + Find a machine that will be your server. This machine will require enough disk space to hold the FreeBSD 2.0 binaries and have bootp, tftp and NFS services available. Tested machines: @@ -466,7 +466,7 @@ freebox:/sharedfs /project nfs rw,-w=1024 0 0 - Sun/Solaris 2.3. (you may need to get + Sun/Solaris 2.3. (you may need to get bootp) @@ -492,12 +492,12 @@ diskless:\ Set up a TFTP server (on same machine as bootp server) - to provide booting information to client. The name of this + to provide booting information to client. The name of this file is cfg.X.X.X.X (or /tftpboot/cfg.X.X.X.X, it will try both) where X.X.X.X is the IP address - of the client. The contents of this file can be any valid - netboot commands. Under 2.0, netboot has the following + of the client. The contents of this file can be any valid + netboot commands. Under 2.0, netboot has the following commands: @@ -611,7 +611,7 @@ hostname myclient.mydomain If you are swapping over NFS (completely diskless configuration) create a swap file for your client using - dd. If your swapfs command has the arguments + dd. If your swapfs command has the arguments /swapfs and the size 20000 as in the example above, the swapfile for myclient will be called /swapfs/swap.X.X.X.X where @@ -650,7 +650,7 @@ hostname myclient.mydomain When extracting /dev in /rootfs/myclient, beware that some systems (HPUX) will not create device files that - FreeBSD is happy with. You may have to go to single + FreeBSD is happy with. You may have to go to single user mode on the first bootup (press control-c during the bootup phase), cd /dev and do a sh ./MAKEDEV all @@ -679,7 +679,7 @@ hostname myclient.mydomain At present there isn't an officially sanctioned way of doing this, although I have been using a shared /usr filesystem and individual - / filesystems for each client. If anyone has + / filesystems for each client. If anyone has any suggestions on how to do this cleanly, please let me and/or the &a.core; know. @@ -690,7 +690,7 @@ hostname myclient.mydomain Netboot can be compiled to support NE1000/2000 cards by changing the configuration in - /sys/i386/boot/netboot/Makefile. See the + /sys/i386/boot/netboot/Makefile. See the comments at the top of this file. @@ -718,7 +718,7 @@ hostname myclient.mydomain If you are planning to use ISDN primarily to connect to the Internet with an Internet Provider on a dialup non-dedicated basis, I suggest you look into Terminal - Adapters. This will give you the most flexibility, with the + Adapters. This will give you the most flexibility, with the fewest problems, if you change providers. @@ -731,7 +731,7 @@ hostname myclient.mydomain Cost is a significant factor in determining what solution you - will choose. The following options are listed from least expensive + will choose. The following options are listed from least expensive to most expensive. @@ -741,10 +741,10 @@ hostname myclient.mydomain Contributed by &a.hm;. This section is really only relevant to ISDN users in countries - where the DSS1/Q.931 ISDN standard is supported. + where the DSS1/Q.931 ISDN standard is supported. Some growing number of PC ISDN cards are supported under FreeBSD - 2.2.x and up by the isdn4bsd driver package. It is still under + 2.2.x and up by the isdn4bsd driver package. It is still under development but the reports show that it is successfully used all over Europe. @@ -753,17 +753,17 @@ hostname myclient.mydomain the main isdn4bsd ftp site (you have to log in as user isdn4bsd , give your mail address as the password and change to the pub - directory. Anonymous ftp as user ftp or + directory. Anonymous ftp as user ftp or anonymous will not give the desired result). Isdn4bsd allows you to connect to other ISDN routers using - either IP over raw HDLC or by using synchronous PPP. A telephone + either IP over raw HDLC or by using synchronous PPP. A telephone answering machine application is also available. Many ISDN PC cards are supported, mostly the ones with a Siemens ISDN chipset (ISAC/HSCX), support for other chipsets (from Motorola, - Cologne Chip Designs) is currently under development. For an + Cologne Chip Designs) is currently under development. For an up-to-date list of supported cards, please have a look at the README file. @@ -773,7 +773,7 @@ hostname myclient.mydomain enhancing isdn4bsd, please get in touch with hm@kts.org. - A majordomo maintained mailing list is available. To join the + A majordomo maintained mailing list is available. To join the list, send mail to majordomo@FreeBSD.ORG and specify: @@ -794,21 +794,21 @@ subscribe freebsd-isdn A TA will operate basically the same as a modem except connection and throughput speeds will be much faster than your old - modem. You will need to configure PPP + modem. You will need to configure PPP exactly the - same as for a modem setup. Make sure you set your serial speed as + same as for a modem setup. Make sure you set your serial speed as high as possible. The main advantage of using a TA to connect to an Internet - Provider is that you can do Dynamic PPP. As IP address space + Provider is that you can do Dynamic PPP. As IP address space becomes more and more scarce, most providers are not willing to - provide you with a static IP anymore. Most standalone routers are + provide you with a static IP anymore. Most standalone routers are not able to accommodate dynamic IP allocation. TA's completely rely on the PPP daemon that you are running - for their features and stability of connection. This allows you + for their features and stability of connection. This allows you to upgrade easily from using a modem to ISDN on a FreeBSD machine, - if you already have PPP setup. However, at the same time any + if you already have PPP setup. However, at the same time any problems you experienced with the PPP program and are going to persist. @@ -850,8 +850,8 @@ subscribe freebsd-isdn the TA to a synchronous serial card. Do not be fooled into buying an internal TA and thinking you - have avoided the synchronous/asynchronous issue. Internal TA's - simply have a standard PC serial port chip built into them. All + have avoided the synchronous/asynchronous issue. Internal TA's + simply have a standard PC serial port chip built into them. All this will do, is save you having to buy another serial cable, and find another empty electrical socket. @@ -860,8 +860,8 @@ subscribe freebsd-isdn probably more flexible. The choice of sync/TA vs standalone router is largely a - religious issue. There has been some discussion of this in the - mailing lists. I suggest you search the archives for the complete discussion. @@ -871,7 +871,7 @@ subscribe freebsd-isdn Standalone ISDN Bridges/Routers ISDN bridges or routers are not at all specific to FreeBSD or - any other operating system. For a more complete description of + any other operating system. For a more complete description of routing and bridging technology, please refer to a Networking reference book. @@ -879,10 +879,10 @@ subscribe freebsd-isdn interchangeably. As the cost of low end ISDN routers/bridges comes down, it - will likely become a more and more popular choice. An ISDN router + will likely become a more and more popular choice. An ISDN router is a small box that plugs directly into your local Ethernet network(or card), and manages its own connection to the other - bridge/router. It has all the software to do PPP and other + bridge/router. It has all the software to do PPP and other protocols built in. A router will allow you much faster throughput that a standard @@ -890,13 +890,13 @@ subscribe freebsd-isdn connection. The main problem with ISDN routers and bridges is that - interoperability between manufacturers can still be a problem. If + interoperability between manufacturers can still be a problem. If you are planning to connect to an Internet provider, I recommend that you discuss your needs with them. If you are planning to connect two lan segments together, ie: home lan to the office lan, this is the simplest lowest - maintenance solution. Since you are buying the equipment for both + maintenance solution. Since you are buying the equipment for both sides of the connection you can be assured that the link will work. @@ -907,7 +907,7 @@ subscribe freebsd-isdn Branch office or Home network - Network is 10 Base T Ethernet. Connect router to network + Network is 10 Base T Ethernet. Connect router to network cable with AUI/10BT transceiver, if necessary. @@ -949,7 +949,7 @@ ISDN BRI line One large advantage of most routers/bridges is that they allow you to have 2 separate independent PPP connections to 2 separate - sites at the same time. This is not supported on most TA's, + sites at the same time. This is not supported on most TA's, except for specific(expensive) models that have two serial ports. Do not confuse this with channel bonding, MPP etc. @@ -958,7 +958,7 @@ ISDN BRI line to tap into it, but don't want to get another ISDN line at work. A router at the office location can manage a dedicated B channel connection (64Kbs) to the internet, as well as a use the other B - channel for a separate data connection. The second B channel can + channel for a separate data connection. The second B channel can be used for dialin, dialout or dynamically bond(MPP etc.) with the first B channel for more bandwidth. diff --git a/en_US.ISO_8859-1/books/handbook/backups/chapter.sgml b/en_US.ISO_8859-1/books/handbook/backups/chapter.sgml index d0bc0b1d65..58eda9d816 100644 --- a/en_US.ISO_8859-1/books/handbook/backups/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/backups/chapter.sgml @@ -9,7 +9,7 @@ impossible to provide a exhaustive listing of hardware that FreeBSD supports, this section serves as a catalog of the device drivers included with FreeBSD and the hardware each drivers supports. Where possible and - appropriate, notes about specific products are included. You may also want + appropriate, notes about specific products are included. You may also want to refer to the kernel configuration file section in this handbook for a list of supported devices. @@ -41,22 +41,22 @@ Storage) 4mm tapes are replacing QIC as the workstation backup media of - choice. This trend accelerated greatly when Conner purchased Archive, + choice. This trend accelerated greatly when Conner purchased Archive, a leading manufacturer of QIC drives, and then stopped production of - QIC drives. 4mm drives are small and quiet but do not have the - reputation for reliability that is enjoyed by 8mm drives. The + QIC drives. 4mm drives are small and quiet but do not have the + reputation for reliability that is enjoyed by 8mm drives. The cartridges are less expensive and smaller (3 x 2 x 0.5 inches, 76 x 51 - x 12 mm) than 8mm cartridges. 4mm, like 8mm, has comparatively short + x 12 mm) than 8mm cartridges. 4mm, like 8mm, has comparatively short head life for the same reason, both use helical scan. Data thruput on these drives starts ~150kB/s, peaking at ~500kB/s. - Data capacity starts at 1.3 GB and ends at 2.0 GB. Hardware + Data capacity starts at 1.3 GB and ends at 2.0 GB. Hardware compression, available with most of these drives, approximately - doubles the capacity. Multi-drive tape library units can have 6 drives - in a single cabinet with automatic tape changing. Library capacities + doubles the capacity. Multi-drive tape library units can have 6 drives + in a single cabinet with automatic tape changing. Library capacities reach 240 GB. - 4mm drives, like 8mm drives, use helical-scan. All the benefits + 4mm drives, like 8mm drives, use helical-scan. All the benefits and drawbacks of helical-scan apply to both 4mm and 8mm drives. Tapes should be retired from use after 2,000 passes or 100 full @@ -67,23 +67,23 @@ 8mm (Exabyte) 8mm tapes are the most common SCSI tape drives; they are the best - choice of exchanging tapes. Nearly every site has an exabyte 2 GB 8mm - tape drive. 8mm drives are reliable, convenient and quiet. Cartridges + choice of exchanging tapes. Nearly every site has an exabyte 2 GB 8mm + tape drive. 8mm drives are reliable, convenient and quiet. Cartridges are inexpensive and small (4.8 x 3.3 x 0.6 inches; 122 x 84 x 15 mm). One downside of 8mm tape is relatively short head and tape life due to the high rate of relative motion of the tape across the heads. - Data thruput ranges from ~250kB/s to ~500kB/s. Data sizes start at - 300 MB and go up to 7 GB. Hardware compression, available with most of - these drives, approximately doubles the capacity. These drives are + Data thruput ranges from ~250kB/s to ~500kB/s. Data sizes start at + 300 MB and go up to 7 GB. Hardware compression, available with most of + these drives, approximately doubles the capacity. These drives are available as single units or multi-drive tape libraries with 6 drives - and 120 tapes in a single cabinet. Tapes are changed automatically by - the unit. Library capacities reach 840+ GB. + and 120 tapes in a single cabinet. Tapes are changed automatically by + the unit. Library capacities reach 840+ GB. Data is recorded onto the tape using helical-scan, the heads are - positioned at an angle to the media (approximately 6 degrees). The - tape wraps around 270 degrees of the spool that holds the heads. The - spool spins while the tape slides over the spool. The result is a high + positioned at an angle to the media (approximately 6 degrees). The + tape wraps around 270 degrees of the spool that holds the heads. The + spool spins while the tape slides over the spool. The result is a high density of data and closely packed tracks that angle across the tape from one edge to the other. @@ -92,31 +92,31 @@ QIC QIC-150 tapes and drives are, perhaps, the most common tape drive - and media around. QIC tape drives are the least expensive "serious" - backup drives. The downside is the cost of media. QIC tapes are + and media around. QIC tape drives are the least expensive "serious" + backup drives. The downside is the cost of media. QIC tapes are expensive compared to 8mm or 4mm tapes, up to 5 times the price per GB - data storage. But, if your needs can be satisfied with a half-dozen - tapes, QIC may be the correct choice. QIC is the - most common tape drive. Every site has a QIC - drive of some density or another. Therein lies the rub, QIC has a + data storage. But, if your needs can be satisfied with a half-dozen + tapes, QIC may be the correct choice. QIC is the + most common tape drive. Every site has a QIC + drive of some density or another. Therein lies the rub, QIC has a large number of densities on physically similar (sometimes identical) - tapes. QIC drives are not quiet. These drives audibly seek before they + tapes. QIC drives are not quiet. These drives audibly seek before they begin to record data and are clearly audible whenever reading, writing - or seeking. QIC tapes measure (6 x 4 x 0.7 inches; 15.2 x 10.2 x 1.7 - mm). Mini-cartridges, - which also use 1/4" wide tape are discussed separately. Tape libraries + or seeking. QIC tapes measure (6 x 4 x 0.7 inches; 15.2 x 10.2 x 1.7 + mm). Mini-cartridges, + which also use 1/4" wide tape are discussed separately. Tape libraries and changers are not available. - Data thruput ranges from ~150kB/s to ~500kB/s. Data capacity - ranges from 40 MB to 15 GB. Hardware compression is available on many - of the newer QIC drives. QIC drives are less frequently installed; + Data thruput ranges from ~150kB/s to ~500kB/s. Data capacity + ranges from 40 MB to 15 GB. Hardware compression is available on many + of the newer QIC drives. QIC drives are less frequently installed; they are being supplanted by DAT drives. - Data is recorded onto the tape in tracks. The tracks run along the - long axis of the tape media from one end to the other. The number of + Data is recorded onto the tape in tracks. The tracks run along the + long axis of the tape media from one end to the other. The number of tracks, and therefore the width of a track, varies with the tape's - capacity. Most if not all newer drives provide backward-compatibility - at least for reading (but often also for writing). QIC has a good + capacity. Most if not all newer drives provide backward-compatibility + at least for reading (but often also for writing). QIC has a good reputation regarding the safety of the data (the mechanics are simpler and more robust than for helical scan drives). @@ -133,25 +133,25 @@ DLT DLT has the fastest data transfer rate of all the drive types - listed here. The 1/2" (12.5mm) tape is contained in a single spool - cartridge (4 x 4 x 1 inches; 100 x 100 x 25 mm). The cartridge has a - swinging gate along one entire side of the cartridge. The drive - mechanism opens this gate to extract the tape leader. The tape leader - has an oval hole in it which the drive uses to "hook" the tape. The - take-up spool is located inside the tape drive. All the other tape + listed here. The 1/2" (12.5mm) tape is contained in a single spool + cartridge (4 x 4 x 1 inches; 100 x 100 x 25 mm). The cartridge has a + swinging gate along one entire side of the cartridge. The drive + mechanism opens this gate to extract the tape leader. The tape leader + has an oval hole in it which the drive uses to "hook" the tape. The + take-up spool is located inside the tape drive. All the other tape cartridges listed here (9 track tapes are the only exception) have both the supply and take-up spools located inside the tape cartridge itself. Data thruput is approximately 1.5MB/s, three times the thruput of - 4mm, 8mm, or QIC tape drives. Data capacities range from 10GB to 20GB - for a single drive. Drives are available in both multi-tape changers + 4mm, 8mm, or QIC tape drives. Data capacities range from 10GB to 20GB + for a single drive. Drives are available in both multi-tape changers and multi-tape, multi-drive tape libraries containing from 5 to 900 tapes over 1 to 20 drives, providing from 50GB to 9TB of storage. Data is recorded onto the tape in tracks parallel to the direction - of travel (just like QIC tapes). Two tracks are written at once. + of travel (just like QIC tapes). Two tracks are written at once. Read/write head lifetimes are relatively long; once the tape stops moving, there is no relative motion between the heads and the tape. @@ -161,7 +161,7 @@ Using a new tape for the first time The first time that you try to read or write a new, -completely blank tape, the operation will fail. The console +completely blank tape, the operation will fail. The console messages should be similar to: @@ -171,7 +171,7 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready The tape does not contain an Identifier Block (block number 0). All QIC tape drives since the adoption of QIC-525 standard write an - Identifier Block to the tape. There are two solutions: + Identifier Block to the tape. There are two solutions: mt fsf 1 causes the tape drive to write an Identifier Block to the tape. @@ -220,7 +220,7 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready and restore 8 - are the traditional Unix backup programs. They operate + are the traditional Unix backup programs. They operate on the drive as a collection of disk blocks, below the abstractions of files, links and directories that are created by the filesystems. @@ -237,13 +237,13 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready 8 does not write files and directories to tape, but rather writes the data blocks that are the building blocks of files - and directories. + and directories. dump 8 has quirks that remain from its early days in - Version 6 of ATT Unix (circa 1975). The default parameters are + Version 6 of ATT Unix (circa 1975). The default parameters are suitable for 9-track tapes (6250 bpi), not the high-density media - available today (up to 62,182 ftpi). These defaults must be overridden + available today (up to 62,182 ftpi). These defaults must be overridden on the command line to utilize the capacity of current tape drives. @@ -253,28 +253,28 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready and rrestore 8 backup data across the - network to a tape drive attached to another computer. Both programs + network to a tape drive attached to another computer. Both programs rely upon rcmd 3 and ruserok 3 to access the remote tape - drive. Therefore, the user performing the backup must have - rhosts access to the remote computer. The + drive. Therefore, the user performing the backup must have + rhosts access to the remote computer. The arguments to rdump 8 and rrestore 8 - must suitable to use on the remote computer. (e.g. + must suitable to use on the remote computer. (e.g. When rdump'ing from a FreeBSD computer to an Exabyte tape drive connected to a Sun called komodo, use: /sbin/rdump 0dsbfu 54000 13000 126 komodo:/dev/nrst8 /dev/rsd0a 2>&1) Beware: there are security implications to allowing rhosts - commands. Evaluate your situation carefully. + commands. Evaluate your situation carefully. @@ -284,7 +284,7 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready tar 1 also dates back to Version 6 of ATT Unix (circa - 1975). + 1975). tar 1 operates in cooperation with the filesystem; @@ -309,21 +309,21 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready Most versions of tar 1 - do not support backups across the network. The GNU + do not support backups across the network. The GNU version of tar 1, which FreeBSD utilizes, supports remote devices using the same syntax as - rdump. To + rdump. To tar 1 to an Exabyte tape drive connected to a Sun called komodo, use: /usr/bin/tar cf komodo:/dev/nrst8 . - 2>&1. For versions without remote device support, + 2>&1. For versions without remote device support, you can use a pipeline and rsh 1 to send the data to a - remote tape drive. (XXX add an example command) + remote tape drive. (XXX add an example command) @@ -332,15 +332,15 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready cpio 1 is the original Unix - file interchange tape program for magnetic media. + file interchange tape program for magnetic media. cpio 1 has options (among many others) to perform byte-swapping, write a number of different - archives format, and pipe the data to other programs. This last + archives format, and pipe the data to other programs. This last feature makes cpio 1 and excellent choice for - installation media. + installation media. cpio 1 does not know how to walk the directory tree and a list of files must be provided thru @@ -349,10 +349,10 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready cpio 1 does not support backups - across the network. You can use a pipeline and + across the network. You can use a pipeline and rsh 1 to send the data to a - remote tape drive. (XXX add an example command) + remote tape drive. (XXX add an example command) @@ -361,12 +361,12 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready pax 1 is IEEE/POSIX's answer to - tar and cpio. Over the years the + tar and cpio. Over the years the various versions of tar and cpio - have gotten slightly incompatible. So rather than fight it out to + have gotten slightly incompatible. So rather than fight it out to fully standardize them, POSIX created a new archive utility. pax attempts to read and write many of the various - cpio and tar formats, plus new formats of its own. Its command set + cpio and tar formats, plus new formats of its own. Its command set more resembles cpio than tar. @@ -376,23 +376,23 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready Amanda (Advanced Maryland Network Disk Archiver) is a client/server backup - system, rather than a single program. An Amanda server will backup to + system, rather than a single program. An Amanda server will backup to a single tape drive any number of computers that have Amanda clients - and network communications with the Amanda server. A common problem at + and network communications with the Amanda server. A common problem at locations with a number of large disks is the length of time required to backup to data directly to tape exceeds the amount of time - available for the task. Amanda solves this problem. Amanda can use a - "holding disk" to backup several filesystems at the same time. Amanda + available for the task. Amanda solves this problem. Amanda can use a + "holding disk" to backup several filesystems at the same time. Amanda creates "archive sets": a group of tapes used over a period of time to create full backups of all the filesystems listed in Amanda's - configuration file. The "archive set" also contains nightly + configuration file. The "archive set" also contains nightly incremental (or differential) backups of all the filesystems. Restoring a damaged filesystem requires the most recent full backup and the incremental backups. The configuration file provides fine control backups and the - network traffic that Amanda generates. Amanda will use any of the - above backup programs to write the data to tape. Amanda is available + network traffic that Amanda generates. Amanda will use any of the + above backup programs to write the data to tape. Amanda is available as either a port or a package, it is not installed by default. @@ -400,22 +400,22 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready Do nothing “Do nothing” is not a computer program, but it is the - most widely used backup strategy. There are no initial costs. There is - no backup schedule to follow. Just say no. If something happens to + most widely used backup strategy. There are no initial costs. There is + no backup schedule to follow. Just say no. If something happens to your data, grin and bear it! If your time and your data is worth little to nothing, then “Do nothing” is the most suitable backup program for your - computer. But beware, Unix is a useful tool, you may find that within + computer. But beware, Unix is a useful tool, you may find that within six months you have a collection of files that are valuable to you. “Do nothing” is the correct backup method for /usr/obj and other directory trees that can be - exactly recreated by your computer. An example is the files that + exactly recreated by your computer. An example is the files that comprise these handbook pages-they have been generated from - SGML input files. Creating backups of these - HTML files is not necessary. The + SGML input files. Creating backups of these + HTML files is not necessary. The SGML source files are backed up regularly. @@ -426,17 +426,17 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready dump 8 Period. Elizabeth D. Zwicky torture tested all the backup programs discussed - here. The clear choice for preserving all your data and all the + here. The clear choice for preserving all your data and all the peculiarities of Unix filesystems is dump - 8. Elizabeth created + 8. Elizabeth created filesystems containing a large variety of unusual conditions (and some not so unusual ones) and tested each program by do a backup and - restore of that filesystems. The peculiarities included: files with + restore of that filesystems. The peculiarities included: files with holes, files with holes and a block of nulls, files with funny characters in their names, unreadable and unwritable files, devices, files that change size during the backup, files that are - created/deleted during the backup and more. She presented the results + created/deleted during the backup and more. She presented the results at LISA V in Oct. 1991. See torture-testing Backup and Archive Programs. @@ -457,14 +457,14 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready Second, determine that the boot and fixit floppies (boot.flp and fixit.flp) - have all your devices. The easiest way to check is to reboot your + have all your devices. The easiest way to check is to reboot your machine with the boot floppy in the floppy drive and check the boot - messages. If all your devices are listed and functional, skip on to + messages. If all your devices are listed and functional, skip on to step three. Otherwise, you have to create two custom bootable floppies which has a kernel that can mount your all of your disks and - access your tape drive. These floppies must contain: + access your tape drive. These floppies must contain: fdisk 8, @@ -474,7 +474,7 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready 8, mount 8, and whichever backup - program you use. These programs must be statically linked. If you + program you use. These programs must be statically linked. If you use dump 8, the floppy must contain @@ -482,25 +482,25 @@ st0(ncr1:4:0): Logical unit is in process of becoming ready restore 8. - Third, create backup tapes regularly. Any changes that you make - after your last backup may be irretrievably lost. Write-protect the + Third, create backup tapes regularly. Any changes that you make + after your last backup may be irretrievably lost. Write-protect the backup tapes. Fourth, test the floppies (either boot.flp and fixit.flp or the two custom bootable - floppies you made in step two.) and backup tapes. Make notes of the - procedure. Store these notes with the bootable floppy, the printouts - and the backup tapes. You will be so distraught when restoring that + floppies you made in step two.) and backup tapes. Make notes of the + procedure. Store these notes with the bootable floppy, the printouts + and the backup tapes. You will be so distraught when restoring that the notes may prevent you from destroying your backup tapes (How? In place of tar xvf /dev/rst0, you might accidently type tar cvf /dev/rst0 and over-write your backup tape). For an added measure of security, make bootable floppies and two - backup tapes each time. Store one of each at a remote location. A - remote location is NOT the basement of the same office building. A + backup tapes each time. Store one of each at a remote location. A + remote location is NOT the basement of the same office building. A number of firms in the World Trade Center learned this lesson the - hard way. A remote location should be physically separated from your + hard way. A remote location should be physically separated from your computers and disk drives by a significant distance. An example script for creating a bootable floppy: @@ -666,20 +666,20 @@ chmod 644 /mnt/etc/passwd doing regular backups so there is no need to worry about the software. - If the hardware has been damaged. First, replace those parts + If the hardware has been damaged. First, replace those parts that have been damaged. - If your hardware is okay, check your floppies. If you are using + If your hardware is okay, check your floppies. If you are using a custom boot floppy, boot single-user (type -s - at the boot: prompt). Skip the following + at the boot: prompt). Skip the following paragraph. If you are using the boot.flp and - fixit.flp floppies, keep reading. Insert the + fixit.flp floppies, keep reading. Insert the boot.flp floppy in the first floppy drive and - boot the computer. The original install menu will be displayed on - the screen. Select the Fixit--Repair mode with CDROM or - floppy. option. Insert the + boot the computer. The original install menu will be displayed on + the screen. Select the Fixit--Repair mode with CDROM or + floppy. option. Insert the fixit.flp when prompted. restore and the other programs that you need are located in /mnt2/stand. @@ -690,23 +690,23 @@ chmod 644 /mnt/etc/passwd mount 8 (e.g. mount /dev/sd0a - /mnt) the root partition of your first disk. If the + /mnt) the root partition of your first disk. If the disklabel was damaged, use disklabel 8 to re-partition and - label the disk to match the label that your printed and saved. Use + label the disk to match the label that your printed and saved. Use newfs 8 to re-create the - filesystems. Re-mount the root partition of the floppy read-write - (mount -u -o rw /mnt). Use your backup program + filesystems. Re-mount the root partition of the floppy read-write + (mount -u -o rw /mnt). Use your backup program and backup tapes to recover the data for this filesystem (e.g. - restore vrf /dev/st0). Unmount the filesystem + restore vrf /dev/st0). Unmount the filesystem (e.g. umount /mnt) Repeat for each filesystem that was damaged. Once your system is running, backup your data onto new tapes. - Whatever caused the crash or data loss may strike again. An another + Whatever caused the crash or data loss may strike again. An another hour spent now, may save you from further distress later. diff --git a/en_US.ISO_8859-1/books/handbook/basics/chapter.sgml b/en_US.ISO_8859-1/books/handbook/basics/chapter.sgml index 4fd4f4b9fd..685547733f 100644 --- a/en_US.ISO_8859-1/books/handbook/basics/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/basics/chapter.sgml @@ -6,11 +6,11 @@ The Online Manual The most comprehensive documentation on FreeBSD is in the form - of man pages. Nearly every program on the + of man pages. Nearly every program on the system comes with a short reference manual explaining the basic - operation and various arguments. These manuals can be view with the + operation and various arguments. These manuals can be view with the man - command. Use of the man command is simple: + command. Use of the man command is simple: &prompt.user; man command @@ -18,7 +18,7 @@ command is - the name of the command you wish to learn about. For example, to + the name of the command you wish to learn about. For example, to learn more about ls command type: &prompt.user; man ls @@ -63,9 +63,9 @@ In some cases, the same topic may appear in more than - one section of the on-line manual. For example, there is a + one section of the on-line manual. For example, there is a chmod - user command and a chmod() system call. In + user command and a chmod() system call. In this case, you can tell the man command which one you want by specifying the section: @@ -74,7 +74,7 @@ This will display the manual page for the user - command chmod. References to a + command chmod. References to a particular section of the on-line manual are traditionally placed in parenthesis in written documentation, so chmod1 refers to the chmod @@ -116,7 +116,7 @@ GNU Info Files FreeBSD includes many applications and utilities produced by the - Free Software Foundation (FSF). In addition to man pages, these + Free Software Foundation (FSF). In addition to man pages, these programs come with more extensive hypertext documents called “info” files which can be viewed with the info command or, if you installed @@ -128,7 +128,7 @@ &prompt.user; info - For a brief introduction, type h. For a quick + For a brief introduction, type h. For a quick command reference, type ?. diff --git a/en_US.ISO_8859-1/books/handbook/bibliography/chapter.sgml b/en_US.ISO_8859-1/books/handbook/bibliography/chapter.sgml index 6f5c05ed25..bd73d8b64e 100644 --- a/en_US.ISO_8859-1/books/handbook/bibliography/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/bibliography/chapter.sgml @@ -4,7 +4,7 @@ While the manual pages provide the definitive reference for individual pieces of the FreeBSD operating system, they are notorious for not illustrating how to put the pieces together to make the whole - operating system run smoothly. For this, there is no substitute for a + operating system run smoothly. For this, there is no substitute for a good book on UNIX system administration and a good users' manual. @@ -26,33 +26,33 @@ FreeBSD for PC 98'ers (in Japanese), published by SHUWA - System Co, LTD. ISBN 4-87966-468-5 C3055 P2900E. + System Co, LTD. ISBN 4-87966-468-5 C3055 P2900E. - FreeBSD (in Japanese), published by CUTT. ISBN + FreeBSD (in Japanese), published by CUTT. ISBN 4-906391-22-2 C3055 P2400E. Complete Introduction to FreeBSD (in Japanese), published by Shoeisha Co., Ltd. ISBN 4-88135-473-6 P3600E. + URL="http://www.shoeisha.co.jp/pc/index/shinkan/97_05_06.htm">Complete Introduction to FreeBSD (in Japanese), published by Shoeisha Co., Ltd. ISBN 4-88135-473-6 P3600E. Personal UNIX Starter Kit FreeBSD (in Japanese), published by ASCII. ISBN 4-7561-1733-3 P3000E. + URL="http://www.ascii.co.jp/pb/book1/shinkan/detail/1322785.html">Personal UNIX Starter Kit FreeBSD (in Japanese), published by ASCII. ISBN 4-7561-1733-3 P3000E. FreeBSD Handbook (Japanese translation), published by - ASCII. ISBN + ASCII. ISBN 4-7561-1580-2 P3800E. FreeBSD mit Methode (in German), published by Computer und - Literatur Verlag/Vertrieb Hanser, 1998. ISBN 3-932311-31-0. + Literatur Verlag/Vertrieb Hanser, 1998. ISBN 3-932311-31-0. @@ -90,27 +90,27 @@ - Computer Systems Research Group, UC Berkeley. 4.4BSD User's Reference Manual. O'Reilly + Computer Systems Research Group, UC Berkeley. 4.4BSD User's Reference Manual. O'Reilly & Associates, Inc., 1994. ISBN 1-56592-075-9 - Computer Systems Research Group, UC Berkeley. 4.4BSD User's Supplementary Documents. + Computer Systems Research Group, UC Berkeley. 4.4BSD User's Supplementary Documents. O'Reilly & Associates, Inc., 1994. ISBN 1-56592-076-7 - UNIX in a Nutshell. O'Reilly + UNIX in a Nutshell. O'Reilly & Associates, Inc., 1990. ISBN 093717520X - Mui, Linda. What You Need To Know When You Can't - Find Your UNIX System Administrator. O'Reilly - & Associates, Inc., 1995. ISBN 1-56592-104-6 + Mui, Linda. What You Need To Know When You Can't + Find Your UNIX System Administrator. O'Reilly + & Associates, Inc., 1995. ISBN 1-56592-104-6 @@ -121,11 +121,11 @@ Jpman Project, - Japan FreeBSD Users Group. . FreeBSD User's Reference Manual (Japanese translation). Mainichi - Communications Inc., 1998. ISBN4-8399-0088-4 + Communications Inc., 1998. ISBN4-8399-0088-4 P3800E. @@ -140,54 +140,54 @@ - Albitz, Paul and Liu, Cricket. DNS and + Albitz, Paul and Liu, Cricket. DNS and BIND, 2nd Ed. O'Reilly & Associates, Inc., - 1997. ISBN 1-56592-236-0 + 1997. ISBN 1-56592-236-0 - Computer Systems Research Group, UC Berkeley. 4.4BSD System Manager's Manual. O'Reilly - & Associates, Inc., 1994. ISBN + Computer Systems Research Group, UC Berkeley. 4.4BSD System Manager's Manual. O'Reilly + & Associates, Inc., 1994. ISBN 1-56592-080-5 - Costales, Brian, et al. Sendmail, 2nd + Costales, Brian, et al. Sendmail, 2nd Ed. O'Reilly & Associates, Inc., 1997. ISBN 1-56592-222-0 - Frisch, Æleen. Essential System + Frisch, Æleen. Essential System Administration, 2nd Ed. O'Reilly & - Associates, Inc., 1995. ISBN 1-56592-127-5 + Associates, Inc., 1995. ISBN 1-56592-127-5 - Hunt, Craig. TCP/IP Network - Administration. O'Reilly & Associates, Inc., - 1992. ISBN 0-937175-82-X + Hunt, Craig. TCP/IP Network + Administration. O'Reilly & Associates, Inc., + 1992. ISBN 0-937175-82-X - Nemeth, Evi. UNIX System Administration - Handbook. 2nd Ed. Prentice Hall, 1995. ISBN 0131510517 Stern, Hal Managing NFS and NIS - O'Reilly & Associates, Inc., 1991. ISBN + O'Reilly & Associates, Inc., 1991. ISBN 0-937175-75-7 Jpman Project, - Japan FreeBSD Users Group. . FreeBSD System Administrator's Manual (Japanese translation). Mainichi - Communications Inc., 1998. ISBN4-8399-0109-0 + Communications Inc., 1998. ISBN4-8399-0109-0 P3300E. @@ -202,61 +202,61 @@ - Asente, Paul. X Window System - Toolkit. Digital Press. ISBN + Asente, Paul. X Window System + Toolkit. Digital Press. ISBN 1-55558-051-3 - Computer Systems Research Group, UC Berkeley. 4.4BSD Programmer's Reference Manual. - O'Reilly & Associates, Inc., 1994. ISBN + Computer Systems Research Group, UC Berkeley. 4.4BSD Programmer's Reference Manual. + O'Reilly & Associates, Inc., 1994. ISBN 1-56592-078-3 - Computer Systems Research Group, UC Berkeley. 4.4BSD Programmer's Supplementary - Documents. O'Reilly & Associates, Inc., 1994. + Computer Systems Research Group, UC Berkeley. 4.4BSD Programmer's Supplementary + Documents. O'Reilly & Associates, Inc., 1994. ISBN 1-56592-079-1 - Harbison, Samuel P. and Steele, Guy L. Jr. C: A - Reference Manual. 4rd ed. Prentice Hall, 1995. + Harbison, Samuel P. and Steele, Guy L. Jr. C: A + Reference Manual. 4rd ed. Prentice Hall, 1995. ISBN 0-13-326224-3 - Kernighan, Brian and Dennis M. Ritchie. The C - Programming Language.. PTR Prentice Hall, 1988. + Kernighan, Brian and Dennis M. Ritchie. The C + Programming Language.. PTR Prentice Hall, 1988. ISBN 0-13-110362-9 - Lehey, Greg. Porting UNIX Software. + Lehey, Greg. Porting UNIX Software. O'Reilly & Associates, Inc., 1995. ISBN 1-56592-126-7 Plauger, P. J. The Standard C - Library. Prentice Hall, 1992. ISBN + Library. Prentice Hall, 1992. ISBN 0-13-131509-9 - Stevens, W. Richard. Advanced Programming in the - UNIX Environment. Reading, Mass. : + Stevens, W. Richard. Advanced Programming in the + UNIX Environment. Reading, Mass. : Addison-Wesley, 1992 ISBN 0-201-56317-7 - Stevens, W. Richard. UNIX Network - Programming. 2nd Ed, PTR Prentice Hall, 1998. ISBN + Stevens, W. Richard. UNIX Network + Programming. 2nd Ed, PTR Prentice Hall, 1998. ISBN 0-13-490012-X - Wells, Bill. “Writing Serial Drivers for UNIX”. + Wells, Bill. “Writing Serial Drivers for UNIX”. Dr. Dobb's Journal. 19(15), December 1994. pp68-71, 97-99. @@ -273,66 +273,66 @@ - Andleigh, Prabhat K. UNIX System - Architecture. Prentice-Hall, Inc., 1990. ISBN 0-13-949843-5 - Jolitz, William. “Porting UNIX to the + Jolitz, William. “Porting UNIX to the 386”. Dr. - Dobb's Journal. January 1991-July 1992. + Dobb's Journal. January 1991-July 1992. Leffler, Samuel J., Marshall Kirk McKusick, Michael J Karels and John Quarterman The Design and Implementation of the 4.3BSD UNIX Operating - System. Reading, Mass. : Addison-Wesley, + System. Reading, Mass. : Addison-Wesley, 1989. ISBN 0-201-06196-1 Leffler, Samuel J., Marshall Kirk McKusick, The Design and Implementation of the 4.3BSD UNIX Operating - System: Answer Book. Reading, Mass. : + System: Answer Book. Reading, Mass. : Addison-Wesley, 1991. ISBN 0-201-54629-9 McKusick, Marshall Kirk, Keith Bostic, Michael J Karels, - and John Quarterman. The Design and Implementation - of the 4.4BSD Operating System. Reading, Mass. : + and John Quarterman. The Design and Implementation + of the 4.4BSD Operating System. Reading, Mass. : Addison-Wesley, 1996. ISBN 0-201-54979-4 - Stevens, W. Richard. TCP/IP Illustrated, Volume - 1: The Protocols. Reading, Mass. : + Stevens, W. Richard. TCP/IP Illustrated, Volume + 1: The Protocols. Reading, Mass. : Addison-Wesley, 1996. ISBN 0-201-63346-9 - Schimmel, Curt. Unix Systems for Modern - Architectures. Reading, Mass. : Addison-Wesley, - 1994. ISBN 0-201-63338-8 + Schimmel, Curt. Unix Systems for Modern + Architectures. Reading, Mass. : Addison-Wesley, + 1994. ISBN 0-201-63338-8 - Stevens, W. Richard. TCP/IP Illustrated, Volume + Stevens, W. Richard. TCP/IP Illustrated, Volume 3: TCP for Transactions, HTTP, NNTP and the UNIX Domain - Protocols. Reading, Mass. : Addison-Wesley, + Protocols. Reading, Mass. : Addison-Wesley, 1996. ISBN 0-201-63495-3 - Vahalia, Uresh. UNIX Internals -- The New - Frontiers. Prentice Hall, 1996. ISBN + Vahalia, Uresh. UNIX Internals -- The New + Frontiers. Prentice Hall, 1996. ISBN 0-13-101908-2 - Wright, Gary R. and W. Richard Stevens. TCP/IP + Wright, Gary R. and W. Richard Stevens. TCP/IP Illustrated, Volume 2: The Implementation. Reading, Mass. : Addison-Wesley, 1995. ISBN 0-201-63354-X @@ -352,18 +352,18 @@ Cheswick, William R. and Steven M. Bellovin. Firewalls and Internet Security: Repelling the Wily - Hacker. Reading, Mass. : Addison-Wesley, + Hacker. Reading, Mass. : Addison-Wesley, 1995. ISBN 0-201-63357-4 - Garfinkel, Simson and Gene Spafford. Practical - UNIX Security. 2nd Ed. O'Reilly & Associates, - Inc., 1996. ISBN 1-56592-148-8 + Garfinkel, Simson and Gene Spafford. Practical + UNIX Security. 2nd Ed. O'Reilly & Associates, + Inc., 1996. ISBN 1-56592-148-8 - Garfinkel, Simson. PGP Pretty Good + Garfinkel, Simson. PGP Pretty Good Privacy O'Reilly & Associates, Inc., 1995. ISBN 1-56592-098-8 @@ -380,14 +380,14 @@ - Anderson, Don and Tom Shanley. Pentium Processor - System Architecture. 2nd Ed. Reading, Mass. : + Anderson, Don and Tom Shanley. Pentium Processor + System Architecture. 2nd Ed. Reading, Mass. : Addison-Wesley, 1995. ISBN 0-201-40992-5 - Ferraro, Richard F. Programmer's Guide to the - EGA, VGA, and Super VGA Cards. 3rd ed. Reading, + Ferraro, Richard F. Programmer's Guide to the + EGA, VGA, and Super VGA Cards. 3rd ed. Reading, Mass. : Addison-Wesley, 1995. ISBN 0-201-62490-7 @@ -400,26 +400,26 @@ - Shanley, Tom. 80486 System - Architecture. 3rd ed. Reading, Mass. : - Addison-Wesley, 1995. ISBN 0-201-40994-1 + Shanley, Tom. 80486 System + Architecture. 3rd ed. Reading, Mass. : + Addison-Wesley, 1995. ISBN 0-201-40994-1 - Shanley, Tom. ISA System - Architecture. 3rd ed. Reading, Mass. : + Shanley, Tom. ISA System + Architecture. 3rd ed. Reading, Mass. : Addison-Wesley, 1995. ISBN 0-201-40996-8 - Shanley, Tom. PCI System - Architecture. 3rd ed. Reading, Mass. : - Addison-Wesley, 1995. ISBN 0-201-40993-3 + Shanley, Tom. PCI System + Architecture. 3rd ed. Reading, Mass. : + Addison-Wesley, 1995. ISBN 0-201-40993-3 - Van Gilluwe, Frank. The Undocumented - PC. Reading, Mass: Addison-Wesley Pub. Co., + Van Gilluwe, Frank. The Undocumented + PC. Reading, Mass: Addison-Wesley Pub. Co., 1994. ISBN 0-201-62277-7 @@ -436,45 +436,45 @@ Lion, John Lion's Commentary on UNIX, 6th Ed. - With Source Code. ITP Media Group, 1996. ISBN 1573980137 - Raymond, Eric s. The New Hacker's Dictonary, 3rd - edition. MIT Press, 1996. ISBN + Raymond, Eric s. The New Hacker's Dictonary, 3rd + edition. MIT Press, 1996. ISBN 0-262-68092-0 Also known as the Jargon File - Salus, Peter H. A quarter century of - UNIX. Addison-Wesley Publishing Company, Inc., + Salus, Peter H. A quarter century of + UNIX. Addison-Wesley Publishing Company, Inc., 1994. ISBN 0-201-54777-5 Simon Garfinkel, Daniel Weise, Steven Strassmann. - The UNIX-HATERS Handbook. IDG Books + The UNIX-HATERS Handbook. IDG Books Worldwide, Inc., 1994. ISBN 1-56884-203-1 Don Libes, Sandy Ressler Life with - UNIX — special edition. Prentice-Hall, Inc., + UNIX — special edition. Prentice-Hall, Inc., 1989. ISBN 0-13-536657-7 - The BSD family tree. 1997. ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/src/share/misc/bsd-family-tree or local on a FreeBSD-current machine. The BSD Release Announcements - collection. 1997. . 1997. http://www.de.FreeBSD.ORG/de/ftp/releases/ @@ -486,8 +486,8 @@ url="ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/src/share/misc/bsd-family Old BSD releases from the Computer Systems Research - group (CSRG). http://www.mckusick.com/csrg/: The 4CD set covers all BSD versions from 1BSD to 4.4BSD and 4.4BSD-Lite2 (but not 2.11BSD, unfortunately). As well, the last disk holds the final sources plus the SCCS files. + group (CSRG). http://www.mckusick.com/csrg/: The 4CD set covers all BSD versions from 1BSD to 4.4BSD and 4.4BSD-Lite2 (but not 2.11BSD, unfortunately). As well, the last disk holds the final sources plus the SCCS files. @@ -501,8 +501,8 @@ url="ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/src/share/misc/bsd-family - The C/C++ Users Journal. R&D - Publications Inc. ISSN 1075-2838 + The C/C++ Users Journal. R&D + Publications Inc. ISSN 1075-2838 diff --git a/en_US.ISO_8859-1/books/handbook/book.sgml b/en_US.ISO_8859-1/books/handbook/book.sgml index a16117c8ed..73e1dd73be 100644 --- a/en_US.ISO_8859-1/books/handbook/book.sgml +++ b/en_US.ISO_8859-1/books/handbook/book.sgml @@ -4,7 +4,7 @@ %mailing-lists; %newsgroups; - @@ -33,18 +33,18 @@ Welcome to FreeBSD! This handbook covers the installation and day - to day use of FreeBSD Release &rel.current;. This + to day use of FreeBSD Release &rel.current;. This manual is a work in progress and is the work of - many individuals. Many sections do not yet exist and some of those - that do exist need to be updated. If you are interested in helping - with this project, send email to the &a.doc;. The latest version of + many individuals. Many sections do not yet exist and some of those + that do exist need to be updated. If you are interested in helping + with this project, send email to the &a.doc;. The latest version of this document is always available from the FreeBSD World Wide Web server. It may also be downloaded in plain text, postscript or HTML with HTTP or gzip'd from the FreeBSD FTP server or one of the numerous mirror sites. You may also want to + linkend="mirrors-ftp">mirror sites. You may also want to Search the Handbook. diff --git a/en_US.ISO_8859-1/books/handbook/contrib/chapter.sgml b/en_US.ISO_8859-1/books/handbook/contrib/chapter.sgml index 6d64db5434..d36fd7e6d4 100644 --- a/en_US.ISO_8859-1/books/handbook/contrib/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/contrib/chapter.sgml @@ -6,12 +6,12 @@ So you want to contribute something to FreeBSD? That is great! We can always use the help, and FreeBSD is one of those systems that relies on the contributions of its user base in - order to survive. Your contributions are not only appreciated, they + order to survive. Your contributions are not only appreciated, they are vital to FreeBSD's continued growth! Contrary to what some people might also have you believe, you do not need to be a hot-shot programmer or a close personal friend of the - FreeBSD core team in order to have your contributions accepted. The + FreeBSD core team in order to have your contributions accepted. The FreeBSD Project's development is done by a large and growing number of international contributors whose ages and areas of technical expertise vary greatly, and there is always more work to be done than there are @@ -21,16 +21,16 @@ system environment (and its installation) rather than just a kernel or a few scattered utilities, our TODO list also spans a very wide range of tasks, from documentation, beta testing and presentation to - highly specialized types of kernel development. No matter what your + highly specialized types of kernel development. No matter what your skill level, there is almost certainly something you can do to help the project! Commercial entities engaged in FreeBSD-related enterprises are - also encouraged to contact us. Need a special extension to make your + also encouraged to contact us. Need a special extension to make your product work? You will find us receptive to your requests, given that - they are not too outlandish. Working on a value-added product? + they are not too outlandish. Working on a value-added product? Please let us know! We may be able to work cooperatively on some - aspect of it. The free software world is challenging a lot of + aspect of it. The free software world is challenging a lot of existing assumptions about how software is developed, sold, and maintained throughout its life cycle, and we urge you to at least give it a second look. @@ -41,10 +41,10 @@ The following list of tasks and sub-projects represents something of an amalgam of the various core team TODO lists and user - requests we have collected over the last couple of months. Where - possible, tasks have been ranked by degree of urgency. If you are + requests we have collected over the last couple of months. Where + possible, tasks have been ranked by degree of urgency. If you are interested in working on one of the tasks you see here, send mail to - the coordinator listed by clicking on their names. If no + the coordinator listed by clicking on their names. If no coordinator has been appointed, maybe you would like to volunteer? @@ -59,7 +59,7 @@ - 3-stage boot issues. Overall coordination: + 3-stage boot issues. Overall coordination: &a.hackers; @@ -75,7 +75,7 @@ - Filesystem problems. Overall coordination: &a.fs; + Filesystem problems. Overall coordination: &a.fs; @@ -88,7 +88,7 @@ - Fix the union file system. Coordinator: + Fix the union file system. Coordinator: &a.dg; @@ -97,12 +97,12 @@ - Implement Int13 vm86 disk driver. Coordinator: + Implement Int13 vm86 disk driver. Coordinator: &a.hackers; - New bus architecture. Coordinator: &a.newbus; + New bus architecture. Coordinator: &a.newbus; @@ -116,7 +116,7 @@ - Port PCI subsystem to new architecture. Coordinator: + Port PCI subsystem to new architecture. Coordinator: &a.dfr; @@ -139,7 +139,7 @@ - Kernel issues. Overall coordination: &a.hackers; + Kernel issues. Overall coordination: &a.hackers; @@ -156,7 +156,7 @@ Make the entire kernel use - suser() instead of comparing to 0. It + suser() instead of comparing to 0. It is presently using about half of each. Coordinator: &a.eivind; @@ -164,7 +164,7 @@ Split securelevels into different parts, to allow an administrator to throw away those privileges he can throw - away. Setting the overall securelevel needs to have the + away. Setting the overall securelevel needs to have the same effect as now, obviously. Coordinator: &a.eivind; @@ -196,7 +196,7 @@ Add code to teh NFS layer so that you cannot chdir("..") out of an NFS partition. E.g., /usr is a UFS partition with - /usr/src NFS exported. Now it is + /usr/src NFS exported. Now it is possible to use the NFS filehandle for /usr/src to get access to /usr. @@ -230,7 +230,7 @@ - PCMCIA/PCCARD. Coordinators: &a.msmith; and &a.phk; + PCMCIA/PCCARD. Coordinators: &a.msmith; and &a.phk; @@ -267,7 +267,7 @@ - Advanced Power Management. Coordinators: &a.msmith; and + Advanced Power Management. Coordinators: &a.msmith; and &a.phk; @@ -310,7 +310,7 @@ NetWare Server (protected mode ODI driver) loader and subservices to allow the use of ODI card drivers supplied - with network cards. The same thing for NDIS drivers and + with network cards. The same thing for NDIS drivers and NetWare SCSI drivers. @@ -327,7 +327,7 @@ A concerted effort at support for portable computers. This is somewhat handled by changing PCMCIA bridging rules - and power management event handling. But there are things + and power management event handling. But there are things like detecting internal vs. external display and picking a different screen resolution based on that fact, not spinning down the disk if the machine is in dock, and allowing @@ -343,7 +343,7 @@ Most of the tasks listed in the previous sections require either a considerable investment of time or an in-depth knowledge - of the FreeBSD kernel (or both). However, there are also many + of the FreeBSD kernel (or both). However, there are also many useful tasks which are suitable for "weekend hackers", or people without programming skills. @@ -359,16 +359,16 @@ - Read the freebsd-bugs mailing list. There might be a + Read the freebsd-bugs mailing list. There might be a problem you can comment constructively on or with patches - you can test. Or you could even try to fix one of the + you can test. Or you could even try to fix one of the problems yourself. - Read through the FAQ and Handbook periodically. If + Read through the FAQ and Handbook periodically. If anything is badly explained, out of date or even just - completely wrong, let us know. Even better, send us a fix + completely wrong, let us know. Even better, send us a fix (SGML is not difficult to learn, but there is no objection to ASCII submissions). @@ -376,7 +376,7 @@ Help translate FreeBSD documentation into your native language (if not already available) — just send an email to - &a.doc; asking if anyone is working on it. Note that you + &a.doc; asking if anyone is working on it. Note that you are not committing yourself to translating every single FreeBSD document by doing this — in fact, the documentation most in need of translation is the installation @@ -386,7 +386,7 @@ Read the freebsd-questions mailing list and &ng.misc occasionally (or even - regularly). It can be very satisfying to share your + regularly). It can be very satisfying to share your expertise and help people solve their problems; sometimes you may even learn something new yourself! These forums can also be a source of ideas for things to work on. @@ -450,24 +450,24 @@ Bug reports and general commentary An idea or suggestion of general - technical interest should be mailed to the &a.hackers;. Likewise, + technical interest should be mailed to the &a.hackers;. Likewise, people with an interest in such things (and a tolerance for a high volume of mail!) may subscribe to the - hackers mailing list by sending mail to &a.majordomo;. See + hackers mailing list by sending mail to &a.majordomo;. See mailing lists for more information about this and other mailing lists. If you find a bug or are submitting a specific change, please report it using the send-pr1program or its WEB-based - equivalent. Try to fill-in each field of the bug report. + equivalent. Try to fill-in each field of the bug report. Unless they exceed 65KB, include any patches directly in the - report. Consider compressing them and using - uuencode1 if they exceed 20KB. Upload very large submissions to ftp.freebsd.org:/pub/FreeBSD/incoming/. + report. Consider compressing them and using + uuencode1 if they exceed 20KB. Upload very large submissions to ftp.freebsd.org:/pub/FreeBSD/incoming/. After filing a report, you should receive confirmation along - with a tracking number. Keep this tracking number so that you can - update us with details about the problem by sending mail to bug-followup@FreeBSD.ORG. Use the number as the message subject, e.g. "Re: kern/3377". Additional information for any bug report should be submitted this way. + with a tracking number. Keep this tracking number so that you can + update us with details about the problem by sending mail to bug-followup@FreeBSD.ORG. Use the number as the message subject, e.g. "Re: kern/3377". Additional information for any bug report should be submitted this way. If you do not receive confirmation in a timely fashion (3 days to a week, depending on your email connection) or are, for some @@ -480,7 +480,7 @@ Changes to the documentation - Changes to the documentation are overseen by the &a.doc;. Send + Changes to the documentation are overseen by the &a.doc;. Send submissions and changes (even small ones are welcome!) using send-pr as described in Bug Reports and General @@ -503,16 +503,16 @@ Working from older sources unfortunately means that your changes may sometimes be too obsolete or too divergent for easy - re-integration into FreeBSD. Chances of this can be minimized + re-integration into FreeBSD. Chances of this can be minimized somewhat by subscribing to the &a.announce; and the &a.current; lists, where discussions on the current state of the system take place. Assuming that you can manage to secure fairly up-to-date sources to base your changes on, the next step is to produce a set - of diffs to send to the FreeBSD maintainers. This is done with + of diffs to send to the FreeBSD maintainers. This is done with the diff1 command, with the “context diff” - form being preferred. For example: + form being preferred. For example: &prompt.user; diff -c oldfile newfile @@ -525,15 +525,15 @@ would generate such a set of context diffs for - the given source file or directory hierarchy. See the man page + the given source file or directory hierarchy. See the man page for diff1 for more details. Once you have a set of diffs (which you may test with the patch1 command), you should submit them for - inclusion with FreeBSD. Use the send-pr1 + inclusion with FreeBSD. Use the send-pr1 program as described in Bug Reports and General - Commentary. Do not just send the diffs to + Commentary. Do not just send the diffs to the &a.hackers; or they will get lost! We greatly appreciate your submission (this is a volunteer project!); because we are busy, we may not be able to address it immediately, but it will remain in @@ -541,22 +541,22 @@ If you feel it appropriate (e.g. you have added, deleted, or renamed files), bundle your changes into a tar file and run the - uuencode1 program on it. Shar archives are + uuencode1 program on it. Shar archives are also welcome. If your change is of a potentially sensitive nature, e.g. you are unsure of copyright issues governing its further distribution or you are simply not ready to release it without a tighter review first, then you should send it to &a.core; directly rather than - submitting it with send-pr1. The core + submitting it with send-pr1. The core mailing list reaches a much smaller group of people who do much of - the day-to-day work on FreeBSD. Note that this group is also + the day-to-day work on FreeBSD. Note that this group is also very busy and so you should only send mail to them where it is truly necessary. Please refer to man 9 intro and man 9 style for some information on - coding style. We would appreciate it if you were at least aware + coding style. We would appreciate it if you were at least aware of this information before submitting code. @@ -571,16 +571,16 @@ URL="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming">ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming. When working with large amounts of code, the touchy subject of - copyrights also invariably comes up. Acceptable copyrights for + copyrights also invariably comes up. Acceptable copyrights for code included in FreeBSD are: - The BSD copyright. This copyright is most preferred due + The BSD copyright. This copyright is most preferred due to its “no strings attached” nature and general - attractiveness to commercial enterprises. Far from + attractiveness to commercial enterprises. Far from discouraging such commercial use, the FreeBSD Project actively encourages such participation by commercial interests who might eventually be inclined to invest @@ -588,13 +588,13 @@ - The GNU Public License, or “GPL”. This license is not + The GNU Public License, or “GPL”. This license is not quite as popular with us due to the amount of extra effort demanded of anyone using the code for commercial purposes, but given the sheer quantity of GPL'd code we currently require (compiler, assembler, text formatter, etc) it would be silly to refuse additional contributions under this - license. Code under the GPL also goes into a different part + license. Code under the GPL also goes into a different part of the tree, that being /sys/gnu or /usr/src/gnu, and is therefore easily identifiable to anyone for whom the GPL presents a @@ -606,7 +606,7 @@ Contributions coming under any other type of copyright must be carefully reviewed before their inclusion into FreeBSD will be - considered. Contributions for which particularly restrictive + considered. Contributions for which particularly restrictive commercial copyrights apply are generally rejected, though the authors are always encouraged to make such changes available through their own channels. @@ -670,7 +670,7 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. FreeBSD, Inc. was founded in early 1995 by &a.jkh; and &a.dg; with the goal of furthering the aims of the FreeBSD - Project and giving it a minimal corporate presence. Any and all + Project and giving it a minimal corporate presence. Any and all funds donated (as well as any profits that may eventually be realized by FreeBSD, Inc.) will be used exclusively to further the project's goals. @@ -709,7 +709,7 @@ box can be opened) If you do not wish to be listed in our donors section, please specify this - when making your donation. Thanks! + when making your donation. Thanks! @@ -731,9 +731,9 @@ box can be opened) Hardware for which ongoing compliance testing is - desired. We are currently trying to put together a testing + desired. We are currently trying to put together a testing lab of all components that FreeBSD supports so that proper - regression testing can be done with each new release. We + regression testing can be done with each new release. We are still lacking many important pieces (network cards, motherboards, etc) and if you would like to make such a donation, please contact &a.dg; for information on @@ -742,7 +742,7 @@ box can be opened) Hardware currently unsupported by FreeBSD for which - you would like to see such support added. Please contact + you would like to see such support added. Please contact the &a.core; before sending such items as we will need to find a developer willing to take on the task before we can accept delivery of new hardware. @@ -756,7 +756,7 @@ box can be opened) Donating Internet access - We can always use new mirror sites for FTP, WWW or cvsup. If + We can always use new mirror sites for FTP, WWW or cvsup. If you would like to be such a mirror, please contact the FreeBSD project administrators admin@FreeBSD.ORG for more information. @@ -965,7 +965,7 @@ box can be opened) - Ernst Winter ewinter@lobo.muc.de contributed a 2.88 MB floppy drive to the project. This will hopefully increase the pressure for rewriting the floppy disk driver. ;-) + Ernst Winter ewinter@lobo.muc.de contributed a 2.88 MB floppy drive to the project. This will hopefully increase the pressure for rewriting the floppy disk driver. ;-) @@ -973,7 +973,7 @@ box can be opened) Technologies sent one each of their DC-390, DC-390U and DC-390F FAST and ULTRA SCSI host adapter cards for regression testing of the NCR and AMD drivers - with their cards. They are also to be applauded for + with their cards. They are also to be applauded for making driver sources for free operating systems available from their FTP server ftp://ftp.tekram.com/scsi/FreeBSD. @@ -1011,12 +1011,12 @@ box can be opened) CDROM has donated almost more than we can say (see the history document for - more details). In particular, we would like to thank + more details). In particular, we would like to thank them for the original hardware used for freefall.FreeBSD.ORG, our primary development machine, and for thud.FreeBSD.ORG, a testing and - build box. We are also indebted to them for funding + build box. We are also indebted to them for funding various contributors over the years and providing us with unrestricted use of their T1 connection to the Internet. @@ -1110,7 +1110,7 @@ box can be opened) This software was originally derived from William F. Jolitz's 386BSD release 0.1, though almost none of the original 386BSD - specific code remains. This software has been essentially + specific code remains. This software has been essentially re-implemented from the 4.4BSD-Lite release provided by the Computer Science Research Group (CSRG) at the University of California, Berkeley and associated academic contributors. diff --git a/en_US.ISO_8859-1/books/handbook/cutting-edge/chapter.sgml b/en_US.ISO_8859-1/books/handbook/cutting-edge/chapter.sgml index a97ada4bd4..ff5c2b368f 100644 --- a/en_US.ISO_8859-1/books/handbook/cutting-edge/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/cutting-edge/chapter.sgml @@ -1,10 +1,10 @@ The Cutting Edge: FreeBSD-current and FreeBSD-stable - FreeBSD is under constant development between releases. For + FreeBSD is under constant development between releases. For people who want to be on the cutting edge, there are several easy mechanisms for keeping your system in sync with the latest - developments. Be warned: the cutting edge is not for everyone! This + developments. Be warned: the cutting edge is not for everyone! This chapter will help you decide if you want to track the development system, or stick with one of the released versions. @@ -19,12 +19,12 @@ What is FreeBSD-current? FreeBSD-current is, quite literally, nothing more than a daily - snapshot of the working sources for FreeBSD. These include work + snapshot of the working sources for FreeBSD. These include work in progress, experimental changes and transitional mechanisms that may or may not be present in the next official release of the - software. While many of us compile almost daily from + software. While many of us compile almost daily from FreeBSD-current sources, there are periods of time when the - sources are literally un-compilable. These problems are generally + sources are literally un-compilable. These problems are generally resolved as expeditiously as possible, but whether or not FreeBSD-current sources bring disaster or greatly desired functionality can literally be a matter of which part of any given @@ -58,7 +58,7 @@ Peripheral members of the FreeBSD (or some other) group who merely wish to keep an eye on things and use the current sources for reference purposes (e.g. for - reading, not running). These people + reading, not running). These people also make the occasional comment or contribute code. @@ -83,7 +83,7 @@ - In any way “officially supported” by us. We do our + In any way “officially supported” by us. We do our best to help people genuinely in one of the 3 “legitimate” FreeBSD-current categories, but we simply do not have the time to provide tech support for it. @@ -108,13 +108,13 @@ - Join the &a.current; and the &a.cvsall; . This is not - just a good idea, it is essential. If + Join the &a.current; and the &a.cvsall; . This is not + just a good idea, it is essential. If you are not on the FreeBSD-current mailing list, you will not see the comments that people are making about the current state of the system and thus will probably end up stumbling over a lot of problems that others - have already found and solved. Even more importantly, you + have already found and solved. Even more importantly, you will miss out on important bulletins which may be critical to your system's continued health. @@ -131,28 +131,28 @@ subscribe freebsd-current subscribe cvs-all in the - body of your message. Optionally, you can also say help + body of your message. Optionally, you can also say help and Majordomo will send you full help on how to subscribe and unsubscribe to the various other mailing lists we support. - Grab the sources from ftp.FreeBSD.ORG. You can do + Grab the sources from ftp.FreeBSD.ORG. You can do this in three ways: Use the CTM - facility. Unless you have a good TCP/IP connection + facility. Unless you have a good TCP/IP connection at a flat rate, this is the way to do it. Use the cvsup program with this supfile. This is the second most recommended method, since it allows you to grab the entire collection once and then only what has changed from then on. Many people run cvsup from cron and keep their sources up-to-date automatically. For a fairly easy interface to this, simply type: + URL="ftp://ftp.FreeBSD.org/pub/FreeBSD/FreeBSD-current/src/share/examples/cvsup/standard-supfile">this supfile. This is the second most recommended method, since it allows you to grab the entire collection once and then only what has changed from then on. Many people run cvsup from cron and keep their sources up-to-date automatically. For a fairly easy interface to this, simply type: &prompt.root; pkg_add -f ftp://ftp.FreeBSD.org/pub/FreeBSD/development/CVSup/cvsupit.tgz @@ -162,9 +162,9 @@ subscribe cvs-all - Use ftp. The source tree for FreeBSD-current is + Use ftp. The source tree for FreeBSD-current is always “exported” on: ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-current We also use wu-ftpd which allows compressed/tar'd grabbing of whole trees. e.g. you see: + URL="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-current">ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-current We also use wu-ftpd which allows compressed/tar'd grabbing of whole trees. e.g. you see: usr.bin/lex @@ -188,20 +188,20 @@ subscribe cvs-all Essentially, if you need rapid on-demand access to the source and communications bandwidth is not a consideration, - use cvsup or ftp. Otherwise, use CTM. + use cvsup or ftp. Otherwise, use CTM. If you are grabbing the sources to run, and not just look at, then grab all of current, not - just selected portions. The reason for this is that various + just selected portions. The reason for this is that various parts of the source depend on updates elsewhere, and trying to compile just a subset is almost guaranteed to get you into trouble. Before compiling current, read the Makefile in - /usr/src carefully. You should at + /usr/src carefully. You should at least run a make world the first time - through as part of the upgrading process. Reading the + through as part of the upgrading process. Reading the &a.current; will keep you up-to-date on other bootstrapping procedures that sometimes become necessary as we move towards the next release. @@ -231,7 +231,7 @@ subscribe cvs-all FreeBSD-stable is our development branch for a more low-key and conservative set of changes intended for our next mainstream - release. Changes of an experimental or untested nature do not go + release. Changes of an experimental or untested nature do not go into this branch (see FreeBSD-current). @@ -241,7 +241,7 @@ subscribe cvs-all If you are a commercial user or someone who puts maximum stability of their FreeBSD system before all other concerns, you - should consider tracking stable. This is + should consider tracking stable. This is especially true if you have installed the most recent release (&rel.current;-RELEASE at the time of this writing) since the stable branch is effectively a bug-fix stream relative to the previous release. @@ -250,10 +250,10 @@ subscribe cvs-all The stable tree endeavors, above all, to be fully compilable and stable at all times, but we do occasionally make mistakes (these are still active sources with - quickly-transmitted updates, after all). We also do our best to + quickly-transmitted updates, after all). We also do our best to thoroughly test fixes in current before bringing them into stable, but sometimes - our tests fail to catch every case. If something breaks for you + our tests fail to catch every case. If something breaks for you in stable, please let us know immediately! (see next section). @@ -266,10 +266,10 @@ subscribe cvs-all - Join the &a.stable; . This will keep you informed of + Join the &a.stable; . This will keep you informed of build-dependencies that may appear in stable or any other issues requiring - special attention. Developers will also make announcements + special attention. Developers will also make announcements in this mailing list when they are contemplating some controversial fix or update, giving the users a chance to respond if they have any issues to raise concerning the @@ -288,7 +288,7 @@ subscribe freebsd-stable subscribe cvs-all in the - body of your message. Optionally, you can also say help + body of your message. Optionally, you can also say help and Majordomo will send you full help on how to subscribe and unsubscribe to the various other mailing lists we support. @@ -302,21 +302,21 @@ subscribe cvs-all If you are already running a previous release of 2.2 and wish to upgrade via sources then you can easily do so from ftp.FreeBSD.ORG. This can be done in one of + role="fqdn">ftp.FreeBSD.ORG. This can be done in one of three ways: Use the CTM - facility. Unless you have a good TCP/IP connection + facility. Unless you have a good TCP/IP connection at a flat rate, this is the way to do it. Use the cvsup program with this supfile. This is the second most recommended method, since it allows you to grab the entire collection once and then only what has changed from then on. Many people run cvsup from cron to keep their sources up-to-date automatically. For a fairly easy interface to this, simply type; + URL="ftp://ftp.FreeBSD.org/pub/FreeBSD/FreeBSD-current/src/share/examples/cvsup/stable-supfile">this supfile. This is the second most recommended method, since it allows you to grab the entire collection once and then only what has changed from then on. Many people run cvsup from cron to keep their sources up-to-date automatically. For a fairly easy interface to this, simply type; &prompt.root; pkg_add -f ftp://ftp.FreeBSD.org/pub/FreeBSD/development/CVSup/cvsupit.tgz @@ -324,12 +324,12 @@ subscribe cvs-all - Use ftp. The source tree for FreeBSD-stable is + Use ftp. The source tree for FreeBSD-stable is always “exported” on: ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-stable We also use wu-ftpd which allows - compressed/tar'd grabbing of whole trees. e.g. you + compressed/tar'd grabbing of whole trees. e.g. you see: @@ -355,15 +355,15 @@ subscribe cvs-all Essentially, if you need rapid on-demand access to the source and communications bandwidth is not a consideration, - use cvsup or ftp. Otherwise, use CTM. + use cvsup or ftp. Otherwise, use CTM. Before compiling stable, read the Makefile in - /usr/src carefully. You should at + /usr/src carefully. You should at least run a make world the first time - through as part of the upgrading process. Reading the + through as part of the upgrading process. Reading the &a.stable; will keep you up-to-date on other bootstrapping procedures that sometimes become necessary as we move towards the next release. @@ -383,46 +383,46 @@ subscribe cvs-all There are various ways of using an Internet (or email) connection to stay up-to-date with any given area of the FreeBSD - project sources, or all areas, depending on what interests you. The + project sources, or all areas, depending on what interests you. The primary services we offer are Anonymous CVS, CVSup, and CTM. Anonymous CVS and CVSup use the - pull model of updating sources. In the case of + pull model of updating sources. In the case of CVSup the user (or a cron script) invokes the cvsup program, and it interacts with a cvsupd server - somewhere to bring your files up to date. The updates you receive + somewhere to bring your files up to date. The updates you receive are up-to-the-minute and you get them when, and only when, you want - them. You can easily restrict your updates to the specific files or - directories that are of interest to you. Updates are generated on + them. You can easily restrict your updates to the specific files or + directories that are of interest to you. Updates are generated on the fly by the server, according to what you have and what you want - to have. Anonymous CVS is quite a bit more simplistic + to have. Anonymous CVS is quite a bit more simplistic than CVSup in that it's just an extension to CVS which allows it to pull changes directly from a remote CVS - repository. CVSup can do this far more + repository. CVSup can do this far more efficiently, but Anonymous CVS is easier to use. CTM, on the other hand, does not interactively compare the sources you have with those on the master - archive or otherwise pull them across.. Instead, a script which identifies changes in files since + archive or otherwise pull them across.. Instead, a script which identifies changes in files since its previous run is executed several times a day on the master CTM machine, any detected changes being compressed, stamped with a sequence-number and encoded for transmission over email (in printable - ASCII only). Once received, these “CTM deltas” can then be handed + ASCII only). Once received, these “CTM deltas” can then be handed to the ctm_rmail1 utility which will automatically decode, verify - and apply the changes to the user's copy of the sources. This + and apply the changes to the user's copy of the sources. This process is far more efficient than CVSup, and places less strain on our server resources since it is a push rather than a pull model. - There are other trade-offs, of course. If you inadvertently + There are other trade-offs, of course. If you inadvertently wipe out portions of your archive, CVSup will detect and rebuild the - damaged portions for you. CTM won't do this, and if you wipe some + damaged portions for you. CTM won't do this, and if you wipe some portion of your source tree out (and don't have it backed up) then you will have to start from scratch (from the most recent CVS “base delta”) and rebuild it all with CTM or, with anoncvs, simply @@ -442,9 +442,9 @@ subscribe cvs-all Anonymous CVS (or, as it is otherwise known, anoncvs) is a feature provided by the CVS utilities bundled with FreeBSD for synchronizing with a remote CVS - repository. Among other things, it allows users of FreeBSD to + repository. Among other things, it allows users of FreeBSD to perform, with no special privileges, read-only CVS operations - against one of the FreeBSD project's official anoncvs servers. To + against one of the FreeBSD project's official anoncvs servers. To use it, one simply sets the CVSROOT environment variable to point at the appropriate anoncvs server and then uses the @@ -457,7 +457,7 @@ subscribe cvs-all linkend="cvsup">CVSup and anoncvs services both perform essentially the same function, there are various trade-offs which can influence the user's choice of - synchronization methods. In a nutshell, + synchronization methods. In a nutshell, CVSup is much more efficient in its usage of network resources and is by far the most technically sophisticated of the two, but at a price. To use @@ -470,7 +470,7 @@ subscribe cvs-all Anoncvs, by contrast, can be used to examine anything from an individual file to a specific program (like ls or grep) by - referencing the CVS module name. Of course, + referencing the CVS module name. Of course, anoncvs is also only good for read-only operations on the CVS repository, so if it's your intention to support local development in one repository shared with the @@ -487,7 +487,7 @@ subscribe cvs-all to use an Anonymous CVS repository is a simple matter of setting the CVSROOT environment variable to point to one of the FreeBSD project's - anoncvs servers. At the time of this writing, + anoncvs servers. At the time of this writing, the following servers are available: @@ -506,11 +506,11 @@ subscribe cvs-all and what some of the permissible values for it in the FreeBSD Project repository are. - There are two kinds of tags, revision tags and branch tags. A - revision tag refers to a specific revision. Its meaning stays the - same from day to day. A branch tag, on the other hand, refers to + There are two kinds of tags, revision tags and branch tags. A + revision tag refers to a specific revision. Its meaning stays the + same from day to day. A branch tag, on the other hand, refers to the latest revision on a given line of development, at any given - time. Because a branch tag does not refer to a specific revision, + time. Because a branch tag does not refer to a specific revision, it may mean something different tomorrow than it means today. @@ -533,7 +533,7 @@ subscribe cvs-all The line of development for FreeBSD-3.x, also known as - FreeBSD-stable. Not valid for the ports collection. + FreeBSD-stable. Not valid for the ports collection. @@ -542,7 +542,7 @@ subscribe cvs-all The line of development for FreeBSD-2.2.x, also known as - 2.2-stable. Not valid for the ports collection. + 2.2-stable. Not valid for the ports collection. @@ -551,7 +551,7 @@ subscribe cvs-all The line of development for FreeBSD-2.1.x - this branch - is largely obsolete. Not valid for the ports + is largely obsolete. Not valid for the ports collection. @@ -574,7 +574,7 @@ subscribe cvs-all RELENG_2_2_5_RELEASE - FreeBSD-2.2.5. Not valid for the ports + FreeBSD-2.2.5. Not valid for the ports collection. @@ -583,7 +583,7 @@ subscribe cvs-all RELENG_2_2_2_RELEASE - FreeBSD-2.2.2. Not valid for the ports + FreeBSD-2.2.2. Not valid for the ports collection. @@ -592,7 +592,7 @@ subscribe cvs-all RELENG_2_2_1_RELEASE - FreeBSD-2.2.1. Not valid for the ports + FreeBSD-2.2.1. Not valid for the ports collection. @@ -601,7 +601,7 @@ subscribe cvs-all RELENG_2_2_0_RELEASE - FreeBSD-2.2.0. Not valid for the ports + FreeBSD-2.2.0. Not valid for the ports collection. @@ -610,7 +610,7 @@ subscribe cvs-all RELENG_2_1_7_RELEASE - FreeBSD-2.1.7. Not valid for the ports + FreeBSD-2.1.7. Not valid for the ports collection. @@ -619,7 +619,7 @@ subscribe cvs-all RELENG_2_1_6_1_RELEASE - FreeBSD-2.1.6.1. Not valid for the ports + FreeBSD-2.1.6.1. Not valid for the ports collection. @@ -628,7 +628,7 @@ subscribe cvs-all RELENG_2_1_6_RELEASE - FreeBSD-2.1.6. Not valid for the ports + FreeBSD-2.1.6. Not valid for the ports collection. @@ -637,7 +637,7 @@ subscribe cvs-all RELENG_2_1_5_RELEASE - FreeBSD-2.1.5. Not valid for the ports + FreeBSD-2.1.5. Not valid for the ports collection. @@ -646,14 +646,14 @@ subscribe cvs-all RELENG_2_1_0_RELEASE - FreeBSD-2.1.0. Not valid for the ports + FreeBSD-2.1.0. Not valid for the ports collection. When you specify a branch tag, you normally receive the latest - versions of the files on that line of development. If you wish to + versions of the files on that line of development. If you wish to receive some past version, you can do so by specifying a date with the flag. See the cvs @@ -744,13 +744,13 @@ subscribe cvs-all <application>CTM</application> - Contributed by &a.phk;. Updated + Contributed by &a.phk;. Updated 19-October-1997. CTM is a method for keeping a remote - directory tree in sync with a central one. It has been developed + directory tree in sync with a central one. It has been developed for usage with FreeBSD's source trees, though other people may - find it useful for other purposes as time goes by. Little, if + find it useful for other purposes as time goes by. Little, if any, documentation currently exists at this time on the process of creating deltas, so talk to &a.phk; for more information should you wish to use CTM for other things. @@ -760,24 +760,24 @@ subscribe cvs-all Why should I use <application>CTM</application>? CTM will give you a local copy of the - FreeBSD source trees. There are a number of “flavors” of the - tree available. Whether you wish to track the entire cvs tree or + FreeBSD source trees. There are a number of “flavors” of the + tree available. Whether you wish to track the entire cvs tree or just one of the branches, CTM can provide you - the information. If you are an active developer on FreeBSD, but + the information. If you are an active developer on FreeBSD, but have lousy or non-existent TCP/IP connectivity, or simply wish to have the changes automatically sent to you, - CTM was made for you. You will need to obtain + CTM was made for you. You will need to obtain up to three deltas per day for the most active branches. However, you should consider having them sent by automatic - email. The sizes of the updates are always kept as small as - possible. This is typically less than 5K, with an occasional + email. The sizes of the updates are always kept as small as + possible. This is typically less than 5K, with an occasional (one in ten) being 10-50K and every now and then a biggie of 100K+ or more coming around. You will also need to make yourself aware of the various caveats related to working directly from the development - sources rather than a pre-packaged release. This is particularly - true if you choose the “current” sources. It is recommended + sources rather than a pre-packaged release. This is particularly + true if you choose the “current” sources. It is recommended that you read Staying current with FreeBSD. @@ -804,7 +804,7 @@ subscribe cvs-all URL="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-current/src/usr.sbin/ctm">ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-current/src/usr.sbin/ctm The “deltas” you feed CTM can be had - two ways, FTP or e-mail. If you have general FTP access to the + two ways, FTP or e-mail. If you have general FTP access to the Internet then the following FTP sites support access to CTM: @@ -819,29 +819,29 @@ subscribe cvs-all If you may wish to get your deltas via email: Send email to &a.majordomo; to subscribe to one of the - CTM distribution lists. “ctm-cvs-cur” - supports the entire cvs tree. “ctm-src-cur” supports the head - of the development branch. “ctm-src-2_2” supports the 2.2 - release branch, etc. (If you do not know how to subscribe + CTM distribution lists. “ctm-cvs-cur” + supports the entire cvs tree. “ctm-src-cur” supports the head + of the development branch. “ctm-src-2_2” supports the 2.2 + release branch, etc. (If you do not know how to subscribe yourself using majordomo, send a message first containing the word help — it will send you back usage instructions.) When you begin receiving your CTM updates in the mail, you may use the ctm_rmail program - to unpack and apply them. You can actually use the + to unpack and apply them. You can actually use the ctm_rmail program directly from a entry in /etc/aliases if you want to have the - process run in a fully automated fashion. Check the + process run in a fully automated fashion. Check the ctm_rmail man page for more details. No matter what method you use to get the CTM deltas, you should subscribe to the - ctm-announce@FreeBSD.ORG mailing list. In the + ctm-announce@FreeBSD.ORG mailing list. In the future, this will be the only place where announcements concerning the operations of the CTM system - will be posted. Send an email to &a.majordomo; with a single + will be posted. Send an email to &a.majordomo; with a single line of subscribe ctm-announce to get added to the list. @@ -855,29 +855,29 @@ subscribe cvs-all you will need to get a to a starting point for the deltas produced subsequently to it. - First you should determine what you already have. Everyone - can start from an “empty” directory. You must use an + First you should determine what you already have. Everyone + can start from an “empty” directory. You must use an initial “Empty&rdquo delta to start off your - CTM supported tree. At some point it is + CTM supported tree. At some point it is intended that one of these “started” deltas be - distributed on the CD for your convenience. This does not + distributed on the CD for your convenience. This does not currently happen however. You can recognize However, since the trees are many tens of megabytes, you should prefer to start from - something already at hand. If you have a RELEASE CD, you can - copy or extract an initial source from it. This will save a + something already at hand. If you have a RELEASE CD, you can + copy or extract an initial source from it. This will save a significant transfer of data. You can recognize these “starter” deltas by the X appended to the number - (src-cur.3210XEmpty.gz for instance). The + (src-cur.3210XEmpty.gz for instance). The designation following the X - corresponds to the origin of your initial “seed”. Empty is - an empty directory. As a rule a base transition from + corresponds to the origin of your initial “seed”. Empty is + an empty directory. As a rule a base transition from Empty is produced - every 100 deltas. By the way, they are large! 25 to 30 + every 100 deltas. By the way, they are large! 25 to 30 Megabytes of gzip'ed data is common for the XEmpty deltas. @@ -901,7 +901,7 @@ However, since the trees need to gunzip them first, this saves disk space. Unless it feels very secure about the entire process, - CTM will not touch your tree. To verify a + CTM will not touch your tree. To verify a delta you can also use the flag and CTM will not actually touch your tree; it will merely verify the integrity of the delta and see if it @@ -916,13 +916,13 @@ However, since the trees make up my mind on what options should do what, how and when... - That's really all there is to it. Every time you get a new + That's really all there is to it. Every time you get a new delta, just run it through CTM to keep your sources up to date. Do not remove the deltas if they are hard to download again. You just might want to keep them around in case something bad - happens. Even if you only have floppy disks, consider using + happens. Even if you only have floppy disks, consider using fdwrite to make a copy. @@ -931,16 +931,16 @@ However, since the trees Keeping your local changes As a developer one would like to experiment with and change - files in the source tree. CTM supports local modifications in a + files in the source tree. CTM supports local modifications in a limited way: before checking for the presence of a file foo, it first looks for - foo.ctm. If this file exists, CTM will + foo.ctm. If this file exists, CTM will operate on it instead of foo. This behaviour gives us a simple way to maintain local changes: simply copy the files you plan to modify to the corresponding file names with a .ctm - suffix. Then you can freely hack the code, while CTM keeps the + suffix. Then you can freely hack the code, while CTM keeps the .ctm file up-to-date. @@ -998,7 +998,7 @@ However, since the trees For every file specified in a CTM delta, the and options - are applied in the order given on the command line. The file + are applied in the order given on the command line. The file is processed by CTM only if it is marked as eligible after all the and options are applied to it. @@ -1026,7 +1026,7 @@ However, since the trees The bad news is that I am very busy, so any help in doing - this will be most welcome. And do not forget to tell me what + this will be most welcome. And do not forget to tell me what you want also... @@ -1035,8 +1035,8 @@ However, since the trees Miscellaneous stuff All the “DES infected” (e.g. export controlled) source is - not included. You will get the “international” version only. - If sufficient interest appears, we will set up a sec-cur sequence too. There is a + not included. You will get the “international” version only. + If sufficient interest appears, we will set up a sec-cur sequence too. There is a sequence of deltas for the ports collection too, but interest has not been all that high yet. Tell me if you want an email list for that too and we will @@ -1106,28 +1106,28 @@ However, since the trees CVSup is a software package for distributing and updating source trees from a master CVS repository on a remote server - host. The FreeBSD sources are maintained in a CVS repository on - a central development machine in California. With CVSup, + host. The FreeBSD sources are maintained in a CVS repository on + a central development machine in California. With CVSup, FreeBSD users can easily keep their own source trees up to date. CVSup uses the so-called pull model of - updating. Under the pull model, each client asks the server for - updates, if and when they are wanted. The server waits - passively for update requests from its clients. Thus all - updates are instigated by the client. The server never sends - unsolicited updates. Users must either run the CVSup client + updating. Under the pull model, each client asks the server for + updates, if and when they are wanted. The server waits + passively for update requests from its clients. Thus all + updates are instigated by the client. The server never sends + unsolicited updates. Users must either run the CVSup client manually to get an update, or they must set up a cron job to run it automatically on a regular basis. The term CVSup, capitalized just so, refers to the entire - software package. Its main components are the client cvsup + software package. Its main components are the client cvsup which runs on each user's machine, and the server cvsupd which runs at each of the FreeBSD mirror sites. As you read the FreeBSD documentation and mailing lists, you - may see references to sup. Sup was the - predecessor of CVSup, and it served a similar purpose. CVSup is + may see references to sup. Sup was the + predecessor of CVSup, and it served a similar purpose. CVSup is in used in much the same way as sup and, in fact, uses configuration files which are backward-compatible with sup's. Sup is no longer used in the FreeBSD project, because CVSup is @@ -1145,15 +1145,15 @@ However, since the trees If you are running FreeBSD-2.1.6 or 2.1.7, you unfortunately cannot use the binary package versions due to the fact that they require a version of the C library that does not yet exist in - FreeBSD-2.1.{6,7}. You can easily use the port, however, just as with FreeBSD 2.2. Simply unpack the tar file, cd to the cvsup subdirectory and type make install. + FreeBSD-2.1.{6,7}. You can easily use the port, however, just as with FreeBSD 2.2. Simply unpack the tar file, cd to the cvsup subdirectory and type make install. Because CVSup is written in Modula-3, both the package and the port require that the Modula-3 runtime libraries be installed. These are available as the lang/modula-3-lib port and the lang/modula-3-lib-3.6 package. If you follow the same directions as for cvsup, these libraries will be compiled and/or installed automatically when you install the CVSup port or package. + URL="http://www.research.digital.com/SRC/modula-3/html/home.html">Modula-3, both the package and the port require that the Modula-3 runtime libraries be installed. These are available as the lang/modula-3-lib port and the lang/modula-3-lib-3.6 package. If you follow the same directions as for cvsup, these libraries will be compiled and/or installed automatically when you install the CVSup port or package. The Modula-3 libraries are rather large, and fetching and - compiling them is not an instantaneous process. For that - reason, a third option is provided. You can get + compiling them is not an instantaneous process. For that + reason, a third option is provided. You can get statically linked FreeBSD executables for CVSup from either the USA distribution site: @@ -1202,7 +1202,7 @@ However, since the trees - Most users will need only the client. These executables are + Most users will need only the client. These executables are entirely self-contained, and they will run on any version of FreeBSD from FreeBSD-2.1.0 to FreeBSD-current. @@ -1234,10 +1234,10 @@ However, since the trees Configuration CVSup's operation is controlled by a configuration file - called the supfile. Beginning with + called the supfile. Beginning with FreeBSD-2.2, there are some sample supfiles in the directory /usr/share/examples/cvsup. These examples are also available from ftp://ftp.FreeBSD.org/pub/FreeBSD/FreeBSD-current/src/share/examples/cvsup/ if you are on a pre-2.2 system. + URL="file:/usr/share/examples/cvsup">/usr/share/examples/cvsup. These examples are also available from ftp://ftp.FreeBSD.org/pub/FreeBSD/FreeBSD-current/src/share/examples/cvsup/ if you are on a pre-2.2 system. The information in a supfile answers the following questions for cvsup: @@ -1275,38 +1275,38 @@ However, since the trees In the following sections, we will construct a typical supfile by answering each of these - questions in turn. First, we describe the overall structure of + questions in turn. First, we describe the overall structure of a supfile. - A supfile is a text file. Comments - begin with # and extend to the end of the line. Lines that + A supfile is a text file. Comments + begin with # and extend to the end of the line. Lines that are blank and lines that contain only comments are ignored. Each remaining line describes a set of files that the user - wishes to receive. The line begins with the name of a + wishes to receive. The line begins with the name of a “collection”, a logical grouping of files defined by the server. The name of the collection tells the server which files you - want. After the collection name come zero or more fields, - separated by white space. These fields answer the questions - listed above. There are two types of fields: flag fields and - value fields. A flag field consists of a keyword standing - alone, e.g., delete or compress. A value field also begins + want. After the collection name come zero or more fields, + separated by white space. These fields answer the questions + listed above. There are two types of fields: flag fields and + value fields. A flag field consists of a keyword standing + alone, e.g., delete or compress. A value field also begins with a keyword, but the keyword is followed without intervening - white space by = and a second word. For example, + white space by = and a second word. For example, release=cvs is a value field. A supfile typically specifies more than - one collection to receive. One way to structure a + one collection to receive. One way to structure a supfile is to specify all of the relevant - fields explicitly for each collection. However, that tends to + fields explicitly for each collection. However, that tends to make the supfile lines quite long, and it is inconvenient because most fields are the same for all of the - collections in a supfile. CVSup provides a - defaulting mechanism to avoid these problems. Lines beginning + collections in a supfile. CVSup provides a + defaulting mechanism to avoid these problems. Lines beginning with the special pseudo-collection name *default can be used to set flags and values which will be used as defaults for the - subsequent collections in the supfile. A + subsequent collections in the supfile. A default value can be overridden for an individual collection, by specifying a different value with the collection itself. Defaults can also be changed or augmented in mid-supfile by @@ -1324,15 +1324,15 @@ However, since the trees Which files do you want to receive? The files available via CVSup are organized into named - groups called “collections”. The collections that are + groups called “collections”. The collections that are available are described here. In this example, we wish to receive the - entire main source tree for the FreeBSD system. There is + linkend="cvsup-collec">here. In this example, we wish to receive the + entire main source tree for the FreeBSD system. There is a single large collection src-all which will give us all of that, except the export-controlled cryptography - support. Let us assume for this example that we are in - the USA or Canada. Then we can get the cryptography code - with one additional collection, cvs-crypto. As a first + support. Let us assume for this example that we are in + the USA or Canada. Then we can get the cryptography code + with one additional collection, cvs-crypto. As a first step toward constructing our supfile, we simply list these collections, one per line: @@ -1345,30 +1345,30 @@ cvs-crypto Which version(s) of them do you want? With CVSup, you can receive virtually any version of - the sources that ever existed. That is possible because + the sources that ever existed. That is possible because the cvsupd server works directly from the CVS repository, - which contains all of the versions. You specify which one + which contains all of the versions. You specify which one of them you want using the tag= and value fields. Be very - careful to specify any tag= fields correctly. Some tags - are valid only for certain collections of files. If you + careful to specify any tag= fields correctly. Some tags + are valid only for certain collections of files. If you specify an incorrect or misspelled tag, CVSup will delete - files which you probably do not want deleted. In + files which you probably do not want deleted. In particular, use only tag=. for the ports-* collections. The tag= field names a symbolic tag in the - repository. There are two kinds of tags, revision tags - and branch tags. A revision tag refers to a specific - revision. Its meaning stays the same from day to day. A + repository. There are two kinds of tags, revision tags + and branch tags. A revision tag refers to a specific + revision. Its meaning stays the same from day to day. A branch tag, on the other hand, refers to the latest revision on a given line of development, at any given - time. Because a branch tag does not refer to a specific + time. Because a branch tag does not refer to a specific revision, it may mean something different tomorrow than it means today. @@ -1384,7 +1384,7 @@ cvs-crypto The . is not punctuation; it is the name - of the tag. Valid for all collections. + of the tag. Valid for all collections. @@ -1394,7 +1394,7 @@ cvs-crypto The line of development for FreeBSD-3.x, also known as - FreeBSD-stable. Not valid for the ports collection. + FreeBSD-stable. Not valid for the ports collection. @@ -1403,7 +1403,7 @@ cvs-crypto The line of development for FreeBSD-2.2.x, also known as - 2.2-stable. Not valid for the ports collection. + 2.2-stable. Not valid for the ports collection. @@ -1411,7 +1411,7 @@ cvs-crypto The line of development for FreeBSD-2.1.x - - this branch is largely obsolete. Not valid for the + this branch is largely obsolete. Not valid for the ports-* collections. @@ -1428,7 +1428,7 @@ cvs-crypto tag=RELENG_3_0_0_RELEASE - FreeBSD-3.0. Not valid for the ports-* + FreeBSD-3.0. Not valid for the ports-* collections. @@ -1437,7 +1437,7 @@ cvs-crypto tag=RELENG_2_2_8_RELEASE - FreeBSD-2.2.8. Not valid for the ports-* + FreeBSD-2.2.8. Not valid for the ports-* collections. @@ -1446,14 +1446,14 @@ cvs-crypto tag=RELENG_2_2_7_RELEASE - FreeBSD-2.2.7. Not valid for the ports-* + FreeBSD-2.2.7. Not valid for the ports-* collections. tag=RELENG_2_2_6_RELEASE - FreeBSD-2.2.6. Not valid for the ports-* + FreeBSD-2.2.6. Not valid for the ports-* collections. @@ -1462,7 +1462,7 @@ cvs-crypto tag=RELENG_2_2_5_RELEASE - FreeBSD-2.2.5. Not valid for the ports-* + FreeBSD-2.2.5. Not valid for the ports-* collections. @@ -1471,7 +1471,7 @@ cvs-crypto tag=RELENG_2_2_2_RELEASE - FreeBSD-2.2.2. Not valid for the ports-* + FreeBSD-2.2.2. Not valid for the ports-* collections. @@ -1480,7 +1480,7 @@ cvs-crypto tag=RELENG_2_2_1_RELEASE - FreeBSD-2.2.1. Not valid for the ports-* + FreeBSD-2.2.1. Not valid for the ports-* collections. @@ -1489,7 +1489,7 @@ cvs-crypto tag=RELENG_2_2_0_RELEASE - FreeBSD-2.2.0. Not valid for the ports-* + FreeBSD-2.2.0. Not valid for the ports-* collections. @@ -1498,7 +1498,7 @@ cvs-crypto tag=RELENG_2_1_7_RELEASE - FreeBSD-2.1.7. Not valid for the ports-* + FreeBSD-2.1.7. Not valid for the ports-* collections. @@ -1507,7 +1507,7 @@ cvs-crypto tag=RELENG_2_1_6_1_RELEASE - FreeBSD-2.1.6.1. Not valid for the ports-* + FreeBSD-2.1.6.1. Not valid for the ports-* collections. @@ -1516,7 +1516,7 @@ cvs-crypto tag=RELENG_2_1_6_RELEASE - FreeBSD-2.1.6. Not valid for the ports-* + FreeBSD-2.1.6. Not valid for the ports-* collections. @@ -1525,7 +1525,7 @@ cvs-crypto tag=RELENG_2_1_5_RELEASE - FreeBSD-2.1.5. Not valid for the ports-* + FreeBSD-2.1.5. Not valid for the ports-* collections. @@ -1534,7 +1534,7 @@ cvs-crypto tag=RELENG_2_1_0_RELEASE - FreeBSD-2.1.0. Not valid for the ports-* + FreeBSD-2.1.0. Not valid for the ports-* collections. @@ -1544,19 +1544,19 @@ cvs-crypto Be very - careful to type the tag name exactly as shown. CVSup - cannot distinguish between valid and invalid tags. If you + careful to type the tag name exactly as shown. CVSup + cannot distinguish between valid and invalid tags. If you misspell the tag, CVSup will behave as though you had specified a valid tag which happens to refer to no files - at all. It will delete your existing sources in that + at all. It will delete your existing sources in that case. When you specify a branch tag, you normally receive the latest versions of the files on that line of - development. If you wish to receive some past version, + development. If you wish to receive some past version, you can do so by specifying a date with the value - field. The cvsup1 manual page explains how to do + field. The cvsup1 manual page explains how to do that. For our example, we wish to receive FreeBSD-current. @@ -1569,13 +1569,13 @@ cvs-crypto There is an important special case that comes into play if you specify neither a tag= field nor a date= - field. In that case, you receive the actual RCS files + field. In that case, you receive the actual RCS files directly from the server's CVS repository, rather than - receiving a particular version. Developers generally - prefer this mode of operation. By maintaining a copy of + receiving a particular version. Developers generally + prefer this mode of operation. By maintaining a copy of the repository itself on their systems, they gain the ability to browse the revision histories and examine past - versions of files. This gain is achieved at a large cost + versions of files. This gain is achieved at a large cost in terms of disk space, however. @@ -1583,17 +1583,17 @@ cvs-crypto Where do you want to get them from? We use the host= field to tell cvsup where to obtain - its updates. Any of the CVSup mirror sites will do, though you should try to select - one that is close to you in cyberspace. In this example we + one that is close to you in cyberspace. In this example we will use a fictional FreeBSD distribution site, cvsup666.FreeBSD.org: *default host=cvsup666.FreeBSD.org You will need to change the host to one that actually -exists before running CVSup. On any particular run of +exists before running CVSup. On any particular run of cvsup, you can override the host setting on the command line, with . @@ -1603,8 +1603,8 @@ exists before running CVSup. On any particular run of machine? The prefix= field tells cvsup where to put the files - it receives. In this example, we will put the source files - directly into our main source tree, /usr/src. The src + it receives. In this example, we will put the source files + directly into our main source tree, /usr/src. The src directory is already implicit in the collections we have chosen to receive, so this is the correct specification: @@ -1617,9 +1617,9 @@ exists before running CVSup. On any particular run of Where should cvsup maintain its status files? The cvsup client maintains certain status files in - what is called the “base” directory. These files help + what is called the “base” directory. These files help CVSup to work more efficiently, by keeping track of which - updates you have already received. We will use the + updates you have already received. We will use the standard base directory, /usr/local/etc/cvsup: @@ -1630,7 +1630,7 @@ exists before running CVSup. On any particular run of need the above line. If your base directory does not already exist, now - would be a good time to create it. The cvsup client will + would be a good time to create it. The cvsup client will refuse to run if the base directory does not exist. @@ -1644,24 +1644,24 @@ exists before running CVSup. On any particular run of *default release=cvs delete use-rel-suffix compress release=cvs indicates that the server should get its - information out of the main FreeBSD CVS repository. This + information out of the main FreeBSD CVS repository. This is virtually always the case, but there are other possibilities which are beyond the scope of this discussion. - delete gives CVSup permission to delete files. You + delete gives CVSup permission to delete files. You should always specify this, so that CVSup can keep your - source tree fully up to date. CVSup is careful to delete - only those files for which it is responsible. Any extra + source tree fully up to date. CVSup is careful to delete + only those files for which it is responsible. Any extra files you happen to have will be left strictly alone. - use-rel-suffix is ... arcane. If you really want to - know about it, see the cvsup1 manual page. Otherwise, + use-rel-suffix is ... arcane. If you really want to + know about it, see the cvsup1 manual page. Otherwise, just specify it and do not worry about it. compress enables the use of gzip-style compression - on the communication channel. If your network link is T1 + on the communication channel. If your network link is T1 speed or faster, you probably should not use compression. Otherwise, it helps substantially. @@ -1691,7 +1691,7 @@ cvs-crypto Running <application>CVSup</application> - You are now ready to try an update. The command line for + You are now ready to try an update. The command line for doing this is quite simple: @@ -1699,17 +1699,17 @@ cvs-crypto where supfile is of course the name of the supfile you - have just created. Assuming you are running under X11, cvsup + have just created. Assuming you are running under X11, cvsup will display a GUI window with some buttons to do the usual - things. Press the “go” button, and watch it run. + things. Press the “go” button, and watch it run. Since you are updating your actual /usr/src tree in this example, you will need to run the program as root so that cvsup - has the permissions it needs to update your files. Having just + has the permissions it needs to update your files. Having just created your configuration file, and having never used this program before, that might understandably make you nervous. There is an easy way to do a trial run without touching your - precious files. Just create an empty directory somewhere + precious files. Just create an empty directory somewhere convenient, and name it as an extra argument on the command line: @@ -1719,13 +1719,13 @@ cvs-crypto The directory you specify will be used as the destination - directory for all file updates. CVSup will examine your usual + directory for all file updates. CVSup will examine your usual files in /usr/src, but it will not modify - or delete any of them. Any file updates will instead land in - /var/tmp/dest/usr/src. CVSup will also + or delete any of them. Any file updates will instead land in + /var/tmp/dest/usr/src. CVSup will also leave its base directory status files untouched when run this - way. The new versions of those files will be written into the - specified directory. As long as you have read access to + way. The new versions of those files will be written into the + specified directory. As long as you have read access to /usr/src, you do not even need to be root to perform this kind of trial run. @@ -1737,21 +1737,21 @@ cvs-crypto &prompt.root; cvsup -g -L 2 supfile - The tells cvsup not to use its GUI. This is automatic + The tells cvsup not to use its GUI. This is automatic if you are not running X11, but otherwise you have to specify it. The tells cvsup to print out the details of all the - file updates it is doing. There are three levels of verbosity, - from to . The default is 0, which means total + file updates it is doing. There are three levels of verbosity, + from to . The default is 0, which means total silence except for error messages. - There are plenty of other options available. For a brief - list of them, type cvsup -H. For more detailed descriptions, + There are plenty of other options available. For a brief + list of them, type cvsup -H. For more detailed descriptions, see the manual page. Once you are satisfied with the way updates are working, you - can arrange for regular runs of cvsup using cron8. Obviously, + can arrange for regular runs of cvsup using cron8. Obviously, you should not let cvsup use its GUI when running it from cron. @@ -1761,14 +1761,14 @@ cvs-crypto <application>CVSup</application> File Collections The file collections available via CVSup are organized - hierarchically. There are a few large collections, and they are - divided into smaller sub-collections. Receiving a large + hierarchically. There are a few large collections, and they are + divided into smaller sub-collections. Receiving a large collection is equivalent to receiving each of its - sub-collections. The hierarchical relationships among + sub-collections. The hierarchical relationships among collections are reflected by the use of indentation in the list below. - The most commonly used collections are src-all, cvs-crypto, and ports-all. The other collections are used + The most commonly used collections are src-all, cvs-crypto, and ports-all. The other collections are used only by small groups of people for specialized purposes, and some mirror sites may not carry all of them. @@ -2451,7 +2451,7 @@ cvs-crypto release=self - The CVSup server's own configuration files. Used by + The CVSup server's own configuration files. Used by CVSup mirror sites. @@ -2479,7 +2479,7 @@ cvs-crypto release=current - The installed World Wide Web data. Used by WWW + The installed World Wide Web data. Used by WWW mirror sites. @@ -2497,7 +2497,7 @@ cvs-crypto Page. Most FreeBSD-related discussion of CVSup takes place on the - &a.hackers;. New versions of the software are announced there, + &a.hackers;. New versions of the software are announced there, as well as on the &a.announce;. Questions and bug reports should be addressed to the author diff --git a/en_US.ISO_8859-1/books/handbook/disks/chapter.sgml b/en_US.ISO_8859-1/books/handbook/disks/chapter.sgml index 1bfe3b074c..abf4234f94 100644 --- a/en_US.ISO_8859-1/books/handbook/disks/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/disks/chapter.sgml @@ -4,84 +4,84 @@ Contributed by &a.obrien; 26 April 1998 Lets say we want to add a new SCSI disk to a machine that currently - only has a single drive. First turn off the computer and install the + only has a single drive. First turn off the computer and install the drive in the computer following the instructions of the computer, - controller, and drive manufacturer. Due the wide variations of procedures + controller, and drive manufacturer. Due the wide variations of procedures to do this, the details are beyond the scope of this document. - Login as user root. After you've installed the + Login as user root. After you've installed the drive, inspect /var/run/dmesg.boot to ensure the new - disk was found. Continuing with our example, the newly added drive will be + disk was found. Continuing with our example, the newly added drive will be sd1 and we want to mount it on - /1. (if you are adding an IDE drive substitute + /1. (if you are adding an IDE drive substitute wd for sd) Because FreeBSD runs on IBM-PC compatible computers, it must take into - account the PC BIOS partitions. These are different from the traditional - BSD partitions. A PC disk has up to four BIOS partition entries. If the + account the PC BIOS partitions. These are different from the traditional + BSD partitions. A PC disk has up to four BIOS partition entries. If the disk is going to be truly dedicated to FreeBSD, you can use the - dedicated mode. Otherwise, FreeBSD will have to live - with in one of the PC BIOS partitions. FreeBSD calls the PC BIOS + dedicated mode. Otherwise, FreeBSD will have to live + with in one of the PC BIOS partitions. FreeBSD calls the PC BIOS partitions, slices so as not to confuse them with - traditional BSD partitions. You may also use slices on a disk that is + traditional BSD partitions. You may also use slices on a disk that is dedicated to FreeBSD, but used in a computer that also has another - operating system installed. This is to not confuse the + operating system installed. This is to not confuse the fdisk utility of the other operating system. In the slice case the drive will be added as - /dev/sd1s1e. This is read as: SCSI disk, unit number + /dev/sd1s1e. This is read as: SCSI disk, unit number 1 (second SCSI disk), slice 1 (PC BIOS partition 1), and - e BSD partition. In the dedicated case, the drive + e BSD partition. In the dedicated case, the drive will be added simply as /dev/sd1e. Using sysinstall You may use /stand/sysinstall to partition and - label a new disk using its easy to use menus. Either login as user - root or use the su command. Run + label a new disk using its easy to use menus. Either login as user + root or use the su command. Run /stand/sysinstall and enter the - Configure menu. With in the FreeBSD + Configure menu. With in the FreeBSD Configuration Menu, scroll down and select the - Partition item. Next you should be presented with a - list of hard drives installed in your system. If you do not see + Partition item. Next you should be presented with a + list of hard drives installed in your system. If you do not see sd1 listed, you need to recheck your physical installation and dmesg output in the file /var/run/dmesg.boot. Select sd1 to enter the FDISK Partition - Editor. Choose A to use the entire disk - for FreeBSD. When asked if you want to remain cooperative with + Editor. Choose A to use the entire disk + for FreeBSD. When asked if you want to remain cooperative with any future possible operating systems, answer - YES. Write the changes to the disk using - W. Now exit the FDISK editor using - q. Next you will be asked about the Master Boot - Record. Since you are adding a disk to an already running system, choose + YES. Write the changes to the disk using + W. Now exit the FDISK editor using + q. Next you will be asked about the Master Boot + Record. Since you are adding a disk to an already running system, choose None. - Next enter the Disk Label Editor. This is where - you will create the traditional BSD partitions. A disk can have up to - eight partitions, labeled a-h. A few of the partition labels have - special uses. The a partition is used for the root - partition (/). Thus only your system disk (e.g, the - disk you boot from) should have an a partition. The + Next enter the Disk Label Editor. This is where + you will create the traditional BSD partitions. A disk can have up to + eight partitions, labeled a-h. A few of the partition labels have + special uses. The a partition is used for the root + partition (/). Thus only your system disk (e.g, the + disk you boot from) should have an a partition. The b partition is used for swap partitions, and you may - have many disks with swap partitions. The c partition + have many disks with swap partitions. The c partition addresses the entire disk in dedicated mode, or the entire FreeBSD slice - in slice mode. The other partitions are for general use. + in slice mode. The other partitions are for general use. Sysinstall's Label editor favors the e partition - for non-root, non-swap partitions. With in the Label editor, create a - single file system using C. When prompted if this + for non-root, non-swap partitions. With in the Label editor, create a + single file system using C. When prompted if this will be a FS (file system) or swap, choose FS and - give a mount point (e.g, /mnt). When adding a disk + give a mount point (e.g, /mnt). When adding a disk in post-install mode, Sysinstall will not create entries in /etc/fstab for you, so the mount point you specify isn't important. You are now ready to write the new label to the disk and create a - file system on it. Do this by hitting W. Ignore any - errors from Sysinstall that it could not mount the new partition. Exit + file system on it. Do this by hitting W. Ignore any + errors from Sysinstall that it could not mount the new partition. Exit the Label Editor and Sysinstall completely. The last step is to edit /etc/fstab to add an @@ -101,9 +101,9 @@ Dedicated If you will not be sharing the new drive with another operating - system, you may use the dedicated mode. Remember + system, you may use the dedicated mode. Remember this mode can confuse Microsoft operating systems; however, no damage - will be done by them. IBM's OS/2 however, will + will be done by them. IBM's OS/2 however, will “appropriate” any partition it finds which it doesn't understand. diff --git a/en_US.ISO_8859-1/books/handbook/eresources/chapter.sgml b/en_US.ISO_8859-1/books/handbook/eresources/chapter.sgml index 5346c92816..83b09ef7a0 100644 --- a/en_US.ISO_8859-1/books/handbook/eresources/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/eresources/chapter.sgml @@ -4,15 +4,15 @@ Contributed by &a.jkh;. The rapid pace of FreeBSD progress makes print media impractical - as a means of following the latest developments. Electronic resources + as a means of following the latest developments. Electronic resources are the best, if not often the only, way stay informed of the latest - advances. Since FreeBSD is a volunteer effort, the user community + advances. Since FreeBSD is a volunteer effort, the user community itself also generally serves as a “technical support department” of sorts, with electronic mail and USENET news being the most effective way of reaching that community. The most important points of contact with the FreeBSD user - community are outlined below. If you are aware of other resources not + community are outlined below. If you are aware of other resources not mentioned here, please send them to the &a.doc;so that they may also be included. @@ -23,14 +23,14 @@ Though many of the FreeBSD development members read USENET, we cannot always guarantee that we will get to your questions in a timely fashion (or at all) if you post them only to one of the - comp.unix.bsd.freebsd.* groups. By addressing your questions to the + comp.unix.bsd.freebsd.* groups. By addressing your questions to the appropriate mailing list you will reach both us and a concentrated FreeBSD audience, invariably assuring a better (or at least faster) response. The charters for the various lists are given at the bottom of - this document. Please read the charter before - joining or sending mail to any list. Most of our list + this document. Please read the charter before + joining or sending mail to any list. Most of our list subscribers now receive many hundreds of FreeBSD related messages every day, and by setting down charters and rules for proper use we are striving to keep the signal-to-noise ratio of the lists high. @@ -40,7 +40,7 @@ Archives are kept for all of the mailing lists and can be searched using the FreeBSD World Wide Web - server. The keyword searchable archive offers an + server. The keyword searchable archive offers an excellent way of finding answers to frequently asked questions and should be consulted before posting a question. @@ -121,7 +121,7 @@ Technical lists: The following - lists are for technical discussion. You should read the charter + lists are for technical discussion. You should read the charter for each list carefully before joining or sending mail to one as there are firm guidelines for their use and content. @@ -252,7 +252,7 @@ Limited lists: The following lists require approval from core@FreeBSD.ORG to join, though anyone is free to send messages to them which fall within - the scope of their charters. It is also a good idea establish a + the scope of their charters. It is also a good idea establish a presence in the technical lists before asking to join one of these limited lists. @@ -307,7 +307,7 @@ CVS lists: The following lists are for people interested in seeing the log messages for changes - to various areas of the source tree. They are Read-Only lists and should not have mail + to various areas of the source tree. They are Read-Only lists and should not have mail sent to them. @@ -336,7 +336,7 @@ All mailing lists live on FreeBSD.ORG, so to post to a given list you simply mail to - listname@FreeBSD.ORG. It will + listname@FreeBSD.ORG. It will then be redistributed to mailing list members world-wide. To subscribe to a list, send mail to &a.majordomo; and include @@ -344,7 +344,7 @@ subscribe <listname> [<optional address>] - in the body of your message. For example, to + in the body of your message. For example, to subscribe yourself to freebsd-announce, you'd do: @@ -368,7 +368,7 @@ subscribe freebsd-announce local-announce@somesite.com Finally, it is also possible to unsubscribe yourself from a list, get a list of other list members or see the list of mailing lists again by sending other types of control - messages to majordomo. For a complete list of available commands, + messages to majordomo. For a complete list of available commands, do this: @@ -407,9 +407,9 @@ help The topic of any posting should adhere to the basic charter of the list it is posted to, e.g. if the list is about technical issues then your posting should contain - technical discussion. Ongoing irrelevant chatter or flaming + technical discussion. Ongoing irrelevant chatter or flaming only detracts from the value of the mailing list for - everyone on it and will not be tolerated. For free-form + everyone on it and will not be tolerated. For free-form discussion on no particular topic, the freebsd-chat freebsd-chat@freebsd.org mailing list is freely available and should be used instead. @@ -418,13 +418,13 @@ help No posting should be made to more than 2 mailing lists, and only to 2 when a clear and obvious need to post to both - lists exists. For most lists, there is already a great deal + lists exists. For most lists, there is already a great deal of subscriber overlap and except for the most esoteric mixes (say "-stable & -scsi"), there really is no reason to - post to more than one list at a time. If a message is sent + post to more than one list at a time. If a message is sent to you in such a way that multiple mailing lists appear on the Cc line then the cc line should also be trimmed before - sending it out again. You are still responsible for your own + sending it out again. You are still responsible for your own cross-postings, no matter who the originator might have been. @@ -432,10 +432,10 @@ help Personal attacks and profanity (in the context of an argument) are not allowed, and that includes users and - developers alike. Gross breaches of netiquette, like + developers alike. Gross breaches of netiquette, like excerpting or reposting private mail when permission to do so was not and would not be forthcoming, are frowned upon - but not specifically enforced. However, there are also very few cases + but not specifically enforced. However, there are also very few cases where such content would fit within the charter of a list and it would therefore probably rate a warning (or ban) on that basis alone. @@ -470,7 +470,7 @@ help This list is purely for discussion of freebsd.org related issues and to report problems or abuse of project - resources. It is a closed list, though anyone may report + resources. It is a closed list, though anyone may report a problem (with our systems!) to it. @@ -484,8 +484,8 @@ help This is the mailing list for people interested only in occasional announcements of significant FreeBSD events. This includes announcements about snapshots and other - releases. It contains announcements of new FreeBSD - capabilities. It may contain calls for volunteers etc. + releases. It contains announcements of new FreeBSD + capabilities. It may contain calls for volunteers etc. This is a low volume, strictly moderated mailing list. @@ -498,10 +498,10 @@ help discussions This is a moderated list for discussion of FreeBSD - architecture. Messages will mostly be kept technical in + architecture. Messages will mostly be kept technical in nature, with (rare) exceptions for other messages the moderator deems need to reach all the subscribers of the - list. Examples of suitable topics; + list. Examples of suitable topics; @@ -527,7 +527,7 @@ help The moderator reserves the right to do minor editing (spell-checking, grammar correction, trimming) of messages - that are posted to the list. The volume of the list will be + that are posted to the list. The volume of the list will be kept low, which may involve having to delay topics until an active discussion has been resolved. @@ -555,11 +555,11 @@ help This list contains the overflow from the other lists about non-technical, social - information. It includes discussion about whether Jordan + information. It includes discussion about whether Jordan looks like a toon ferret or not, whether or not to type in capitals, who is drinking too much coffee, where the best beer is brewed, who is brewing beer in their basement, and - so on. Occasional announcements of important events (such + so on. Occasional announcements of important events (such as upcoming parties, weddings, births, new jobs, etc) can be made to the technical lists, but the follow ups should be directed to this -chat list. @@ -572,7 +572,7 @@ help FreeBSD core team This is an internal mailing list for use by the core - members. Messages can be sent to it when a serious + members. Messages can be sent to it when a serious FreeBSD-related matter requires arbitration or high-level scrutiny. @@ -585,11 +585,11 @@ help FreeBSD-current This is the - mailing list for users of freebsd-current. It includes + mailing list for users of freebsd-current. It includes warnings about new features coming out in -current that will affect the users, and instructions on steps that must - be taken to remain -current. Anyone running “current” must - subscribe to this list. This is a technical mailing list + be taken to remain -current. Anyone running “current” must + subscribe to this list. This is a technical mailing list for which strictly technical content is expected. @@ -601,10 +601,10 @@ help FreeBSD-current This is the - digest version of the freebsd-current mailing list. The + digest version of the freebsd-current mailing list. The digest consists of all messages sent to freebsd-current - bundled together and mailed out as a single message. The - average digest size is about 40kB. This list is Read-Only and should not be posted + bundled together and mailed out as a single message. The + average digest size is about 40kB. This list is Read-Only and should not be posted to. @@ -616,9 +616,9 @@ help This mailing list is for the discussion of issues and projects related to the creation of documenation for - FreeBSD. The members of this mailing list are collectively + FreeBSD. The members of this mailing list are collectively referred to as “The FreeBSD Documentation - Project”. It is an open list; feel free to join and + Project”. It is an open list; feel free to join and contribute! @@ -628,7 +628,7 @@ help Filesystems - Discussions concerning FreeBSD filesystems. This is a + Discussions concerning FreeBSD filesystems. This is a technical mailing list for which strictly technical content is expected. @@ -662,11 +662,11 @@ help Technical discussions This is a forum for technical discussions related to - FreeBSD. This is the primary technical mailing list. It + FreeBSD. This is the primary technical mailing list. It is for individuals actively working on FreeBSD, to bring - up problems or discuss alternative solutions. Individuals + up problems or discuss alternative solutions. Individuals interested in following the technical discussion are also - welcome. This is a technical mailing list for which + welcome. This is a technical mailing list for which strictly technical content is expected. @@ -677,9 +677,9 @@ help Technical discussions This is the digest version of the freebsd-hackers - mailing list. The digest consists of all messages sent to + mailing list. The digest consists of all messages sent to freebsd-hackers bundled together and mailed out as a - single message. The average digest size is about 40kB. + single message. The average digest size is about 40kB. This list is Read-Only and should not be posted to. @@ -717,7 +717,7 @@ help This mailing list is for discussing topics relevant to Internet Service - Providers (ISPs) using FreeBSD. This is a technical + Providers (ISPs) using FreeBSD. This is a technical mailing list for which strictly technical content is expected. @@ -735,7 +735,7 @@ help and asking for help elsewhere, how to use mailing lists and which lists to use, general chat, making mistakes, boasting, sharing ideas, stories, moral (but not technical) support, and - taking an active part in the FreeBSD community. We take our + taking an active part in the FreeBSD community. We take our problems and support questions to freebsd-questions, and use freebsd-newbies to meet others who are doing the same things that we do as newbies. @@ -750,7 +750,7 @@ help Cross-platform freebsd issues, general discussion and proposals for non-Intel - FreeBSD ports. This is a technical mailing list for which + FreeBSD ports. This is a technical mailing list for which strictly technical content is expected. @@ -764,7 +764,7 @@ help Discussions concerning FreeBSD's “ports collection” (/usr/ports), proposed ports, modifications to ports collection infrastructure and general coordination - efforts. This is a technical mailing list for which + efforts. This is a technical mailing list for which strictly technical content is expected. @@ -775,7 +775,7 @@ help User questions This - is the mailing list for questions about FreeBSD. You + is the mailing list for questions about FreeBSD. You should not send “how to” questions to the technical lists unless you consider the question to be pretty technical. @@ -789,9 +789,9 @@ help This is the digest version of the freebsd-questions mailing - list. The digest consists of all messages sent to + list. The digest consists of all messages sent to freebsd-questions bundled together and mailed out as a - single message. The average digest size is about + single message. The average digest size is about 40kB. @@ -803,7 +803,7 @@ help This is the mailing list for people working on the scsi - subsystem for FreeBSD. This is a technical mailing list + subsystem for FreeBSD. This is a technical mailing list for which strictly technical content is expected. @@ -814,7 +814,7 @@ help Security issues FreeBSD computer security issues (DES, Kerberos, known - security holes and fixes, etc). This is a technical + security holes and fixes, etc). This is a technical mailing list for which strictly technical content is expected. @@ -825,7 +825,7 @@ help Security Notifications Notifications of FreeBSD security problems and fixes. - This is not a discussion list. The discussion list is + This is not a discussion list. The discussion list is FreeBSD-security. @@ -835,7 +835,7 @@ help This list discusses topics related to unsually small and - embedded FreeBSD installations. This is a technical mailing + embedded FreeBSD installations. This is a technical mailing list for which strictly technical content is expected. @@ -847,11 +847,11 @@ help FreeBSD-stable This is the - mailing list for users of freebsd-stable. It includes + mailing list for users of freebsd-stable. It includes warnings about new features coming out in -stable that will affect the users, and instructions on steps that must - be taken to remain -stable. Anyone running “stable” - should subscribe to this list. This is a technical mailing + be taken to remain -stable. Anyone running “stable” + should subscribe to this list. This is a technical mailing list for which strictly technical content is expected. @@ -866,9 +866,9 @@ help This is the mailing list for the coordinators from each of the local area Users Groups to discuss matters with each other and a designated individual from the Core - Team. This mail list should be limited to meeting + Team. This mail list should be limited to meeting synopsis and coordination of projects that span User - Groups. It is a closed list. + Groups. It is a closed list. @@ -882,7 +882,7 @@ help In addition to two FreeBSD specific newsgroups, there are many others in which FreeBSD is discussed or are otherwise relevant to - FreeBSD users. Keyword searchable archives are available for some of these newsgroups from courtesy of Warren Toomey wkt@cs.adfa.oz.au. diff --git a/en_US.ISO_8859-1/books/handbook/hw/chapter.sgml b/en_US.ISO_8859-1/books/handbook/hw/chapter.sgml index 9397bbcfee..2a12526c35 100644 --- a/en_US.ISO_8859-1/books/handbook/hw/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/hw/chapter.sgml @@ -3,26 +3,26 @@ Issues of hardware compatibility are among the most troublesome in the computer industry today and FreeBSD is by no means immune to - trouble. In this respect, FreeBSD's advantage of being able to run on + trouble. In this respect, FreeBSD's advantage of being able to run on inexpensive commodity PC hardware is also its liability when it comes - to support for the amazing variety of components on the market. While + to support for the amazing variety of components on the market. While it would be impossible to provide a exhaustive listing of hardware that FreeBSD supports, this section serves as a catalog of the device drivers included with FreeBSD and the hardware each drivers supports. Where possible and appropriate, notes about specific products are - included. You may also want to refer to the kernel configuration file section in this handbook for a list of supported devices. As FreeBSD is a volunteer project without a funded testing department, we depend on you, the user, for much of the information - contained in this catalog. If you have direct experience of hardware + contained in this catalog. If you have direct experience of hardware that does or does not work with FreeBSD, please let us know by sending - e-mail to the &a.doc;. Questions about supported hardware should be + e-mail to the &a.doc;. Questions about supported hardware should be directed to the &a.questions; (see Mailing Lists for more - information). When submitting information or asking a question, + information). When submitting information or asking a question, please remember to specify exactly what version of FreeBSD you are using and include as many details of your hardware as possible. @@ -33,7 +33,7 @@ The following links have proven useful in selecting hardware. Though some of what you see won't necessarily be specific (or even applicable) to FreeBSD, most of the hardware information out there - is OS independent. Please check with the FreeBSD hardware guide to + is OS independent. Please check with the FreeBSD hardware guide to make sure that your chosen configuration is supported before making any purchases. @@ -55,10 +55,10 @@ The following list of sample hardware configurations by no means constitutes an endorsement of a given hardware vendor or product by - The FreeBSD Project. This information is + The FreeBSD Project. This information is provided only as a public service and merely catalogs some of the experiences that various individuals have had with different - hardware combinations. Your mileage may vary. Slippery when wet. + hardware combinations. Your mileage may vary. Slippery when wet. Beware of dog. @@ -66,9 +66,9 @@ Jordan's Picks I have had fairly good luck building workstation and server - configurations with the following components. I can't guarantee + configurations with the following components. I can't guarantee that you will too, nor that any of the companies here will remain - “best buys” forever. I will try, when I can, to keep this list + “best buys” forever. I will try, when I can, to keep this list up-to-date but cannot obviously guarantee that it will be at any given time. @@ -80,7 +80,7 @@ URL="http://www.tyan.com/html/products.html">Tyan S1668 dual-processor motherboard as well as the Intel PR440FX motherboard with on-board SCSI WIDE and 100/10MB Intel - Etherexpress NIC. You can build a dandy little single or dual + Etherexpress NIC. You can build a dandy little single or dual processor system (which is supported in FreeBSD 3.0) for very little cost now that the Pentium Pro 180/256K chips have fallen so greatly in price, but no telling how much longer this will @@ -131,7 +131,7 @@ There are two types of 3940 on the market—the older model with AIC 7880 chips on it, and hte newer one with AIC 7895 - chips. The newer model requires CAM support which is not yet part of FreeBSD—you have to add it, or install from one of the CAM binary snapshot release. @@ -145,7 +145,7 @@ you can afford it.” Even in small desktop configurations, SCSI often makes more sense since it allows you to easily migrate drives from server to desktop as falling drive prices make it - economical to do so. If you have more than one machine to + economical to do so. If you have more than one machine to administer then think of it not simply as storage, think of it as a food chain! For a serious server configuration, there's not even any argument—use SCSI equipment and good cables. @@ -159,16 +159,16 @@ while the Toshiba drives have always been favourites of mine (in whatever speed is hot that week), I'm still fond of my good old Plextor PX-12CS drive. It's + url="http://www.plextor.com">Plextor PX-12CS drive. It's only a 12 speed, but it's offered excellent performance and reliability. Generally speaking, most SCSI CDROM drives I've seen have been of pretty solid construction and you probably won't go - wrong with an HP or NEC SCSI CDROM drive either. SCSI CDROM + wrong with an HP or NEC SCSI CDROM drive either. SCSI CDROM prices also appear to have dropped considerably in the last few months and are now quite competitive with IDE CDROMs while - remaining a technically superior solution. I now see no reason + remaining a technically superior solution. I now see no reason whatsoever to settle for an IDE CDROM drive if given a choice between the two. @@ -180,9 +180,9 @@ At the time of this writing, FreeBSD supports 3 types of CDR drives (though I believe they all ultimately come from Phillips anyway): The Phillips CDD 522 (Acts like a Plasmon), the PLASMON - RF4100 and the HP 6020i. I myself use the HP 6020i for burning + RF4100 and the HP 6020i. I myself use the HP 6020i for burning CDROMs (in 2.2 and alter releases—it does not work with - earlier releases of the SCSI code) and it works very well. See + earlier releases of the SCSI code) and it works very well. See /usr/share/examples/worm on your 2.2 system for example scripts used to created ISO9660 filesystem images (with RockRidge extensions) and burn them onto an HP6020i CDR. @@ -208,12 +208,12 @@ Inc. (formerly X Inside, Inc) then I can heartily recommend the Matrox Millenium II card. Note that support for this card is also excellent with the XFree86 server, which is now at version 3.3.2. + URL="http://www.matrox.com/mgaweb/brochure.htm">Millenium II card. Note that support for this card is also excellent with the XFree86 server, which is now at version 3.3.2. You also certainly can't go wrong with one of Number 9's cards — their S3 Vision 868 and 968 based cards (the 9FX series) also being quite - fast and very well supported by XFree86's S3 server. You can + fast and very well supported by XFree86's S3 server. You can also pick up their Revolution 3D cards very cheaply these days, especially if you require a lot of video memory. @@ -223,7 +223,7 @@ Monitors I have had very good luck with the Sony Multiscan 17seII monitors, as have I with the Viewsonic offering in the same (Trinitron) tube. For larger than 17", all I can recommend at the time of this writing is to not spend any less than U.S. $2,000 for a 21" monitor or $1,700 for a 20" monitor if that's what you really need. There are good monitors available in the >=20" range and there are also cheap monitors in the >=20" range. Unfortunately, very few are both cheap and good! + URL="http://cons3.sel.sony.com/SEL/ccpg/display/ms17se2.html">Sony Multiscan 17seII monitors, as have I with the Viewsonic offering in the same (Trinitron) tube. For larger than 17", all I can recommend at the time of this writing is to not spend any less than U.S. $2,000 for a 21" monitor or $1,700 for a 20" monitor if that's what you really need. There are good monitors available in the >=20" range and there are also cheap monitors in the >=20" range. Unfortunately, very few are both cheap and good! @@ -234,7 +234,7 @@ ande foremost, followed by the SMC Ultra 16 controller for any ISA application and the SMC EtherPower or Compex ENET32 - cards for slightly cheaper PCI based networking. In general, any + cards for slightly cheaper PCI based networking. In general, any PCI NIC based around DEC's DC21041 Ethernet controller chip, such as the Zynx ZX342 or DEC DE435, will generally work quite well and can frequently be found in 2-port and 4-port version @@ -254,16 +254,16 @@ If you're looking for high-speed serial networking solutions, then Digi International makes the SYNC/570 series, with drivers now in FreeBSD-current. Emerging Technologies also manufactures a board with T1/E1 capabilities, using software they provide. I have no direct experience using either product, however. + URL="http://www.dgii.com/prodprofiles/profiles-prices/digiprofiles/digispecs/sync570.html">SYNC/570 series, with drivers now in FreeBSD-current. Emerging Technologies also manufactures a board with T1/E1 capabilities, using software they provide. I have no direct experience using either product, however. Multiport card options are somewhat more numerous, though it has to be said that FreeBSD's support for Cyclades's products is probably the tightest, primarily as a result of that company's commitment to making sure that we are adequately supplied with - evaluation boards and technical specs. I've heard that the + evaluation boards and technical specs. I've heard that the Cyclom-16Ye offers the best price/performance, though I've not - checked the prices lately. Other multiport cards I've heard good + checked the prices lately. Other multiport cards I've heard good things about are the BOCA and AST cards, and Stallion Technologies apparently offers an unofficial driver @@ -278,7 +278,7 @@ I currently use a Creative Labs AWE32 though just about anything from Creative Labs will generally work these - days. This is not to say that other types of sound cards don't + days. This is not to say that other types of sound cards don't also work, simply that I have little experience with them (I was a former GUS fan, but Gravis's soundcard situation has been dire for some time). @@ -290,17 +290,17 @@ For video capture, there are two good choices — any card based on the Brooktree BT848 chip, such as the Hauppage or WinTV - boards, will work very nicely with FreeBSD. Another board which + boards, will work very nicely with FreeBSD. Another board which works for me is the Matrox Meteor - card. FreeBSD also supports the older video spigot card from + card. FreeBSD also supports the older video spigot card from Creative Labs, but those are getting somewhat difficult to find. Note that the Meteor frame grabber card will not work with motherboards based on the 440FX chipset! See the motherboard reference section for - details. In such cases, it's better to go with a BT848 based + details. In such cases, it's better to go with a BT848 based board. @@ -361,9 +361,9 @@ 1 or 2): - Write back cache coherency problems. Hardware flaw, + Write back cache coherency problems. Hardware flaw, only known work around is to set the external cache to - write-through mode. Upgrade to Saturn-II. + write-through mode. Upgrade to Saturn-II. @@ -374,7 +374,7 @@ Works fine, but many MB manufactures leave out the external dirty bit SRAM needed for write back operation. Work arounds are either run it in write through mode, or - get the dirty bit SRAM installed. (I have these for the + get the dirty bit SRAM installed. (I have these for the ASUS PCI/I-486SP3G rev 1.6 and later boards). @@ -383,10 +383,10 @@ Can not run more than 2 bus master devices. - Admitted Intel design flaw. Workarounds include do not + Admitted Intel design flaw. Workarounds include do not run more than 2 bus masters, special hardware design to replace the PCI bus arbiter (appears on Intel Altair - board and several other Intel server group MB's). And + board and several other Intel server group MB's). And of course Intel's official answer, move to the Triton chip set, we “fixed it there”. @@ -397,8 +397,8 @@ No known cache coherency or bus master problems, - chip set does not implement parity checking. Workaround - for parity issue. Use Triton-II based motherboards if + chip set does not implement parity checking. Workaround + for parity issue. Use Triton-II based motherboards if you have the choice. @@ -408,7 +408,7 @@ All reports on motherboards using this chipset have - been favorable so far. No known problems. + been favorable so far. No known problems. @@ -418,7 +418,7 @@ Early versions of this chipset suffered from a PCI write-posting bug which can cause noticeable performance degradation in applications where large amounts of PCI - bus traffic is involved. B0 stepping or later revisions + bus traffic is involved. B0 stepping or later revisions of the chipset fixed this problem. @@ -428,7 +428,7 @@ This Pentium Pro support chipset seems to work well, and does not suffer from any of the early Orion chipset problems. It also supports a wider variety of memory, including ECC and parity. The only known problem with it is that the Matrox Meteor frame grabber card doesn't like it. + URL="http://www.intel.com/procs/ppro/index.htm">Pentium Pro support chipset seems to work well, and does not suffer from any of the early Orion chipset problems. It also supports a wider variety of memory, including ECC and parity. The only known problem with it is that the Matrox Meteor frame grabber card doesn't like it. @@ -452,7 +452,7 @@ In fact, our main ftp site ftp.freebsd.org (also known as "ftp.cdrom.com", world's largest - ftp site) runs FreeBSD on a Pentium Pro. Configurations details are available for interested parties. @@ -462,16 +462,16 @@ The Intel Pentium (P54C), Pentium MMX (P55C), AMD K6 and Cyrix/IBM 6x86MX processors are all reported to work with - FreeBSD. I will not go into details of which processor is + FreeBSD. I will not go into details of which processor is faster than what, there are zillions of web sites on the - Internet that tells you one way or another. :) + Internet that tells you one way or another. :) Various CPUs have different voltage/cooling requirements. Make sure your motherboard can supply the exact voltage needed - by the CPU. For instance, many recent MMX chips require split - voltage (e.g., 2.9V core, 3.3V I/O). Also, some AMD and - Cyrix/IBM chips run hotter than Intel chips. In that case, + by the CPU. For instance, many recent MMX chips require split + voltage (e.g., 2.9V core, 3.3V I/O). Also, some AMD and + Cyrix/IBM chips run hotter than Intel chips. In that case, make sure you have good heatsink/fans (you can get the list of certified parts from their web pages). @@ -486,10 +486,10 @@ 1997. Pentium class machines use different clock speeds for the - various parts of the system. These being the speed of the - CPU, external memory bus, and the PCI bus. It is not always + various parts of the system. These being the speed of the + CPU, external memory bus, and the PCI bus. It is not always true that a “faster” processor will make a system faster than - a “slower” one, due to the various clock speeds used. Below is + a “slower” one, due to the various clock speeds used. Below is a table showing the differences: @@ -623,8 +623,8 @@ The AMD K6 Bug In 1997, there have been reports of the AMD K6 seg - faulting during heavy compilation. That problem has been - fixed in 3Q '97. According to reports, K6 chips with date mark + faulting during heavy compilation. That problem has been + fixed in 3Q '97. According to reports, K6 chips with date mark “9733” or larger (i.e., manufactured in the 33rd week of '97 or later) do not have this bug. @@ -646,7 +646,7 @@ 286 class - Sorry, FreeBSD does not run on 80286 machines. It is nearly + Sorry, FreeBSD does not run on 80286 machines. It is nearly impossible to run today's large full-featured UNIXes on such hardware. @@ -657,9 +657,9 @@ * Memory The minimum amount of memory you must have to install FreeBSD - is 5 MB. Once your system is up and running you can build a custom kernel - that will use less memory. If you use the boot4.flp you can get + that will use less memory. If you use the boot4.flp you can get away with having only 4 MB. @@ -699,8 +699,8 @@ The Universal Asynchronous Receiver/Transmitter (UART) controller is the key component of the serial communications - subsystem of a computer. The UART takes bytes of data and - transmits the individual bits in a sequential fashion. At the + subsystem of a computer. The UART takes bytes of data and + transmits the individual bits in a sequential fashion. At the destination, a second UART re-assembles the bits into complete bytes. @@ -709,11 +709,11 @@ other devices. There are two primary forms of serial transmission: - Synchronous and Asynchronous. Depending on the modes that are + Synchronous and Asynchronous. Depending on the modes that are supported by the hardware, the name of the communication sub-system will usually include a A if it supports Asynchronous communications, and a S if it supports - Synchronous communications. Both forms are described + Synchronous communications. Both forms are described below. Some common acronyms are: @@ -734,11 +734,11 @@ Synchronous serial transmission requires that the sender and receiver share a clock with one another, or that the sender provide a strobe or other timing signal so that the - receiver knows when to “read” the next bit of the data. In + receiver knows when to “read” the next bit of the data. In most forms of serial Synchronous communication, if there is no data available at a given instant to transmit, a fill character must be sent instead so that data is always being - transmitted. Synchronous communication is usually more + transmitted. Synchronous communication is usually more efficient because only data bits are transmitted between sender and receiver, and synchronous communication can be more more costly if extra wiring and circuits are required to share @@ -750,11 +750,11 @@ Printers and fixed disk devices are not normally serial devices because most fixed disk interface standards send an entire word of data for each clock or strobe signal by using a - separate wire for each bit of the word. In the PC industry, + separate wire for each bit of the word. In the PC industry, these are known as Parallel devices. The standard serial communications hardware in the PC does - not support Synchronous operations. This mode is described + not support Synchronous operations. This mode is described here for comparison purposes only. @@ -764,59 +764,59 @@ Asynchronous transmission allows data to be transmitted without the sender having to send a clock signal to the - receiver. Instead, the sender and receiver must agree on + receiver. Instead, the sender and receiver must agree on timing parameters in advance and special bits are added to each word which are used to synchronize the sending and receiving units. When a word is given to the UART for Asynchronous transmissions, a bit called the "Start Bit" is added to the - beginning of each word that is to be transmitted. The Start + beginning of each word that is to be transmitted. The Start Bit is used to alert the receiver that a word of data is about to be sent, and to force the clock in the receiver into - synchronization with the clock in the transmitter. These two + synchronization with the clock in the transmitter. These two clocks must be accurate enough to not have the frequency drift by more than 10% during the transmission of the - remaining bits in the word. (This requirement was set in the + remaining bits in the word. (This requirement was set in the days of mechanical teleprinters and is easily met by modern electronic equipment.) After the Start Bit, the individual bits of the word of data are sent, with the Least Significant Bit (LSB) being sent - first. Each bit in the transmission is transmitted for + first. Each bit in the transmission is transmitted for exactly the same amount of time as all of the other bits, and the receiver “looks” at the wire at approximately halfway through the period assigned to each bit to determine if the - bit is a 1 or a 0. For example, if it takes two seconds + bit is a 1 or a 0. For example, if it takes two seconds to send each bit, the receiver will examine the signal to determine if it is a 1 or a 0 after one second has passed, then it will wait two seconds and then examine the value of the next bit, and so on. The sender does not know when the receiver has “looked” at - the value of the bit. The sender only knows when the clock + the value of the bit. The sender only knows when the clock says to begin transmitting the next bit of the word. When the entire data word has been sent, the transmitter - may add a Parity Bit that the transmitter generates. The + may add a Parity Bit that the transmitter generates. The Parity Bit may be used by the receiver to perform simple error - checking. Then at least one Stop Bit is sent by the + checking. Then at least one Stop Bit is sent by the transmitter. When the receiver has received all of the bits in the data word, it may check for the Parity Bits (both sender and receiver must agree on whether a Parity Bit is to be used), - and then the receiver looks for a Stop Bit. If the Stop Bit + and then the receiver looks for a Stop Bit. If the Stop Bit does not appear when it is supposed to, the UART considers the entire word to be garbled and will report a Framing Error to - the host processor when the data word is read. The usual + the host processor when the data word is read. The usual cause of a Framing Error is that the sender and receiver clocks were not running at the same speed, or that the signal was interrupted. Regardless of whether the data was received correctly or not, the UART automatically discards the Start, Parity and - Stop bits. If the sender and receiver are configured + Stop bits. If the sender and receiver are configured identically, these bits are not passed to the host. If another word is ready for transmission, the Start Bit @@ -838,7 +838,7 @@ circuits for signals that can be used to indicate the state of the transmission media, and to regulate the flow of data in the event that the remote device is not prepared to accept - more data. For example, when the device connected to the + more data. For example, when the device connected to the UART is a modem, the modem may report the presence of a carrier on the phone line while the computer may be able to instruct the modem to reset itself or to not take calls by @@ -853,7 +853,7 @@ In most computer systems, the UART is connected to circuitry that generates signals that comply with the EIA - RS232-C specification. There is also a CCITT standard named + RS232-C specification. There is also a CCITT standard named V.24 that mirrors the specifications included in RS232-C. @@ -862,15 +862,15 @@ RS232-C Bit Assignments (Marks and Spaces) In RS232-C, a value of 1 is called a Mark and a - value of 0 is called a Space. When a communication line + value of 0 is called a Space. When a communication line is idle, the line is said to be “Marking”, or transmitting continuous 1 values. - The Start bit always has a value of 0 (a Space). The - Stop Bit always has a value of 1 (a Mark). This means + The Start bit always has a value of 0 (a Space). The + Stop Bit always has a value of 1 (a Mark). This means that there will always be a Mark (1) to Space (0) transition on the line at the start of every word, even when multiple - word are transmitted back to back. This guarantees that + word are transmitted back to back. This guarantees that sender and receiver can resynchronize their clocks regardless of the content of the data bits that are being transmitted. @@ -883,9 +883,9 @@ In RS232-C, the "Marking" signal (a 1) is represented by a voltage between -2 VDC and -12 VDC, and a "Spacing" signal (a 0) is represented by a voltage between 0 and +12 - VDC. The transmitter is supposed to send +12 VDC or -12 + VDC. The transmitter is supposed to send +12 VDC or -12 VDC, and the receiver is supposed to allow for some voltage - loss in long cables. Some transmitters in low power devices + loss in long cables. Some transmitters in low power devices (like portable computers) sometimes use only +5 VDC and -5 VDC, but these values are still acceptable to a RS232-C receiver, provided that the cable lengths are short. @@ -897,12 +897,12 @@ RS232-C also specifies a signal called a Break, which is caused by sending continuous Spacing values (no Start or - Stop bits). When there is no electricity present on the + Stop bits). When there is no electricity present on the data circuit, the line is considered to be sending Break. The Break signal must be of a duration longer than the time it takes to send a complete byte plus Start, Stop and - Parity bits. Most UARTs can distinguish between a Framing + Parity bits. Most UARTs can distinguish between a Framing Error and a Break, but if the UART cannot do this, the Framing Error detection can be used to identify Breaks. @@ -910,7 +910,7 @@ In the days of teleprinters, when numerous printers around the country were wired in series (such as news services), any unit could cause a Break by temporarily - opening the entire circuit so that no current flowed. This + opening the entire circuit so that no current flowed. This was used to allow a location with urgent news to interrupt some other location that was currently sending information. @@ -919,10 +919,10 @@ If the Break is longer than 1.6 seconds, it is considered a "Modem Break", and some modems can be programmed to terminate the conversation and go on-hook or enter the - modems' command mode when the modem detects this signal. If + modems' command mode when the modem detects this signal. If the Break is smaller than 1.6 seconds, it signifies a Data Break and it is up to the remote computer to respond to this - signal. Sometimes this form of Break is used as an + signal. Sometimes this form of Break is used as an Attention or Interrupt signal and sometimes is accepted as a substitute for the ASCII CONTROL-C character. @@ -932,7 +932,7 @@ Breaks cannot be generated from paper tape or from any other byte value, since bytes are always sent with Start - and Stop bit. The UART is usually capable of generating + and Stop bit. The UART is usually capable of generating the continuous Spacing signal in response to a special command from the host processor. @@ -944,26 +944,26 @@ The RS232-C specification defines two types of equipment: the Data Terminal Equipment (DTE) and the Data - Carrier Equipment (DCE). Usually, the DTE device is the - terminal (or computer), and the DCE is a modem. Across the + Carrier Equipment (DCE). Usually, the DTE device is the + terminal (or computer), and the DCE is a modem. Across the phone line at the other end of a conversation, the receiving modem is also a DCE device and the computer that is - connected to that modem is a DTE device. The DCE device + connected to that modem is a DTE device. The DCE device receives signals on the pins that the DTE device transmits on, and vice versa. When two devices that are both DTE or both DCE must be connected together without a modem or a similar media - translater between them, a NULL modem must be used. The + translater between them, a NULL modem must be used. The NULL modem electrically re-arranges the cabling so that the transmitter output is connected to the receiver input on the - other device, and vice versa. Similar translations are + other device, and vice versa. Similar translations are performed on all of the control signals so that each device will see what it thinks are DCE (or DTE) signals from the other device. The number of signals generated by the DTE and DCE - devices are not symmetrical. The DTE device generates fewer + devices are not symmetrical. The DTE device generates fewer signals for the DCE device than the DTE device receives from the DCE. @@ -979,14 +979,14 @@ In the IBM Personal Computer and similar systems, a subset of RS232-C signals are provided via nine pin - connectors (DB9). The signals that are not included on the + connectors (DB9). The signals that are not included on the PC connector deal mainly with synchronous operation, and this transmission mode is not supported by the UART that IBM selected for use in the IBM PC. Depending on the computer manufacturer, a DB25, a DB9, or both types of connector may be used for RS232-C - communications. (The IBM PC also uses a DB25 connector for + communications. (The IBM PC also uses a DB25 connector for the parallel printer interface which causes some confusion.) @@ -1267,7 +1267,7 @@ Bits, Baud and Symbols Baud is a measurement of transmission speed in - asynchronous communication. Because of advances in modem + asynchronous communication. Because of advances in modem communication technology, this term is frequently misused when describing the data rates in newer devices. @@ -1276,8 +1276,8 @@ data that is actually moved from one DTE device to the other. The Baud count includes the overhead bits Start, Stop and Parity that are generated by the sending UART and removed by - the receiving UART. This means that seven-bit words of data - actually take 10 bits to be completely transmitted. Therefore, + the receiving UART. This means that seven-bit words of data + actually take 10 bits to be completely transmitted. Therefore, a modem capable of moving 300 bits per second from one place to another can normally only move 30 7-bit words if Parity is used and one Start and Stop bit are present. @@ -1289,12 +1289,12 @@ The formula for converting bytes per second into a baud rate and vice versa was simple until error-correcting modems - came along. These modems receive the serial stream of bits + came along. These modems receive the serial stream of bits from the UART in the host computer (even when internal modems are used the data is still frequently serialized) and converts - the bits back into bytes. These bytes are then combined into + the bits back into bytes. These bytes are then combined into packets and sent over the phone line using a Synchronous - transmission method. This means that the Stop, Start, and + transmission method. This means that the Stop, Start, and Parity bits added by the UART in the DTE (the computer) were removed by the modem before transmission by the sending modem. When these bytes are received by the remote modem, the remote @@ -1307,7 +1307,7 @@ the two modems can perform error correction, which means that the receiving modem is able to ask the sending modem to resend a block of data that was not received with the correct - checksum. This checking is handled by the modems, and the DTE + checksum. This checking is handled by the modems, and the DTE devices are usually unaware that the process is occurring. @@ -1315,7 +1315,7 @@ additional bits of data that the two modems must share between themselves to perform error-correction are mostly concealed from the effective transmission rate seen by the sending and - receiving DTE equipment. For example, if a modem sends ten + receiving DTE equipment. For example, if a modem sends ten 7-bit words to another modem without including the Start, Stop and Parity bits, the sending modem will be able to add 30 bits of its own information that the receiving modem can use to do @@ -1323,16 +1323,16 @@ the real data. The use of the term Baud is further confused by modems - that perform compression. A single 8-bit word passed over the + that perform compression. A single 8-bit word passed over the telephone line might represent a dozen words that were - transmitted to the sending modem. The receiving modem will + transmitted to the sending modem. The receiving modem will expand the data back to its original content and pass that data to the receiving DTE. Modern modems also include buffers that allow the rate that bits move across the phone line (DCE to DCE) to be a different speed than the speed that the bits move between the - DTE and DCE on both ends of the conversation. Normally the + DTE and DCE on both ends of the conversation. Normally the speed between the DTE and DCE is higher than the DCE to DCE speed because of the use of compression by the modems. @@ -1341,7 +1341,7 @@ differing bits-per-seconds speeds that are used present on the DTE-DCE and DCE-DCE links, the usage of the term Baud to describe the overall communication speed causes problems and - can misrepresent the true transmission speed. So Bits Per + can misrepresent the true transmission speed. So Bits Per Second (bps) is the correct term to use to describe the transmission rate seen at the DCE to DCE interface and Baud or Bits Per Second are acceptable terms to use when a connection @@ -1351,12 +1351,12 @@ Modern high speed modems (2400, 9600, 14,400, and 19,200bps) in reality still operate at or below 2400 baud, or - more accurately, 2400 Symbols per second. High speed modem + more accurately, 2400 Symbols per second. High speed modem are able to encode more bits of data into each Symbol using a technique called Constellation Stuffing, which is why the effective bits per second rate of the modem is higher, but the modem continues to operate within the limited audio bandwidth - that the telephone system provides. Modems operating at 28,800 + that the telephone system provides. Modems operating at 28,800 and higher speeds have variable Symbol rates, but the technique is the same. @@ -1367,7 +1367,7 @@ Starting with the original IBM Personal Computer, IBM selected the National Semiconductor INS8250 UART for use in - the IBM PC Parallel/Serial Adapter. Subsequent generations of + the IBM PC Parallel/Serial Adapter. Subsequent generations of compatible computers from IBM and other vendors continued to use the INS8250 or improved versions of the National Semiconductor UART family. @@ -1377,7 +1377,7 @@ National Semiconductor UART Family Tree There have been several versions and subsequent - generations of the INS8250 UART. Each major version is + generations of the INS8250 UART. Each major version is described below. @@ -1398,12 +1398,12 @@ INS8250 -> INS8250B INS8250 This part was used in the original IBM PC and - IBM PC/XT. The original name for this part was the + IBM PC/XT. The original name for this part was the INS8250 ACE (Asynchronous Communications Element) and it is made from NMOS technology. The 8250 uses eight I/O ports and has a one-byte - send and a one-byte receive buffer. This original + send and a one-byte receive buffer. This original UART has several race conditions and other flaws. The original IBM BIOS includes code to work around these flaws, but this made the BIOS dependent on the @@ -1417,7 +1417,7 @@ INS8250 -> INS8250B This is the slower speed of the INS8250 made - from NMOS technology. It contains the same problems + from NMOS technology. It contains the same problems as the original INS8250. @@ -1448,7 +1448,7 @@ INS8250 -> INS8250B Same as NS8250A with improvements so it can be - used with faster CPU bus designs. IBM used this + used with faster CPU bus designs. IBM used this part in the IBM AT and updated the IBM BIOS to no longer rely on the bugs in the INS8250. @@ -1513,14 +1513,14 @@ INS8250 -> INS8250B years ago, and the NS16550AFN no longer exists by that name. (If you have a NS16550AFN, look at the date code on the part, which is a four digit number that usually starts with - a nine. The first two digits of the number are the year, + a nine. The first two digits of the number are the year, and the last two digits are the week in that year when the - part was packaged. If you have a NS16550AFN, it is probably + part was packaged. If you have a NS16550AFN, it is probably a few years old.) The new numbers are like PC16550DV, with minor differences in the suffix letters depending on the package - material and its shape. (A description of the numbering + material and its shape. (A description of the numbering system can be found below.) It is important to understand that in some stores, you @@ -1545,7 +1545,7 @@ INS8250 -> INS8250B are now of the format PCnnnnnrgp. - The r is the revision field. The + The r is the revision field. The current revision of the 16550 from National Semiconductor is D. @@ -1581,7 +1581,7 @@ INS8250 -> INS8250B If an I precedes the package-type letter, it indicates an “industrial” grade part, which has higher specs than a standard part but not as high as Military Specification - (Milspec) component. This is an optional field. + (Milspec) component. This is an optional field. So what we used to call a NS16550AFN (DIP Package) is now called a PC16550DN or PC16550DIN. @@ -1593,7 +1593,7 @@ INS8250 -> INS8250B Other Vendors and Similar UARTs Over the years, the 8250, 8250A, 16450 and 16550 have been - licensed or copied by other chip vendors. In the case of the + licensed or copied by other chip vendors. In the case of the 8250, 8250A and 16450, the exact circuit (the “megacell”) was licensed to many vendors, including Western Digital and Intel. Other vendors reverse-engineered the part or produced @@ -1602,9 +1602,9 @@ INS8250 -> INS8250B In internal modems, the modem designer will frequently emulate the 8250A/16450 with the modem microprocessor, and the emulated UART will frequently have a hidden buffer consisting - of several hundred bytes. Because of the size of the buffer, + of several hundred bytes. Because of the size of the buffer, these emulations can be as reliable as a 16550A in their - ability to handle high speed data. However, most operating + ability to handle high speed data. However, most operating systems will still report that the UART is only a 8250A or 16450, and may not make effective use of the extra buffering present in the emulated UART unless special drivers are @@ -1617,16 +1617,16 @@ INS8250 -> INS8250B be lowered by this action. A common misconception is that all parts with “16550A” - written on them are identical in performance. There are + written on them are identical in performance. There are differences, and in some cases, outright flaws in most of these 16550A clones. When the NS16550 was developed, the National Semiconductor obtained several patents on the design and they also limited licensing, making it harder for other vendors to provide a - chip with similar features. Because of the patents, + chip with similar features. Because of the patents, reverse-engineered designs and emulations had to avoid - infringing the claims covered by the patents. Subsequently, + infringing the claims covered by the patents. Subsequently, these copies almost never perform exactly the same as the NS16550A or PC16550D, which are the parts most computer and modem makers want to buy but are sometimes unwilling to pay @@ -1634,21 +1634,21 @@ INS8250 -> INS8250B Some of the differences in the clone 16550A parts are unimportant, while others can prevent the device from being - used at all with a given operating system or driver. These + used at all with a given operating system or driver. These differences may show up when using other drivers, or when particular combinations of events occur that were not well - tested or considered in the Windows driver. This is because + tested or considered in the Windows driver. This is because most modem vendors and 16550-clone makers use the Microsoft drivers from Windows for Workgroups 3.11 and the Microsoft MSD utility as the primary tests for compatibility with the - NS16550A. This over-simplistic criteria means that if a + NS16550A. This over-simplistic criteria means that if a different operating system is used, problems could appear due to subtle differences between the clones and genuine components. National Semiconductor has made available a program named COMTEST that performs compatibility tests independent of any - OS drivers. It should be remembered that the purpose of this + OS drivers. It should be remembered that the purpose of this type of program is to demonstrate the flaws in the products of the competition, so the program will report major as well as extremely subtle differences in behavior in the part being @@ -1657,7 +1657,7 @@ INS8250 -> INS8250B In a series of tests performed by the author of this document in 1994, components made by National Semiconductor, TI, StarTech, and CMD as well as megacells and emulations - embedded in internal modems were tested with COMTEST. A + embedded in internal modems were tested with COMTEST. A difference count for some of these components is listed below. Because these tests were performed in 1994, they may not reflect the current performance of the given product from a @@ -1665,7 +1665,7 @@ INS8250 -> INS8250B It should be noted that COMTEST normally aborts when an excessive number or certain types of problems have been - detected. As part of this testing, COMTEST was modified so + detected. As part of this testing, COMTEST was modified so that it would not abort no matter how many differences were encountered. @@ -1736,12 +1736,12 @@ INS8250 -> INS8250B To date, the author of this document has not found any non-National parts that report zero - differences using the COMTEST program. It should + differences using the COMTEST program. It should also be noted that National has had five versions of the 16550 over the years and the newest parts behave a bit differently than the classic NS16550AFN that is considered the benchmark for - functionality. COMTEST appears to turn a blind eye + functionality. COMTEST appears to turn a blind eye to the differences within the National product line and reports no errors on the National parts (except for the original 16550) even when there @@ -1752,24 +1752,24 @@ INS8250 -> INS8250B It is important to understand that a simple count of differences from COMTEST does not reveal a lot about what - differences are important and which are not. For example, + differences are important and which are not. For example, about half of the differences reported in the two modems listed above that have internal UARTs were caused by the clone - UARTs not supporting five- and six-bit character modes. The + UARTs not supporting five- and six-bit character modes. The real 16550, 16450, and 8250 UARTs all support these modes and COMTEST checks the functionality of these modes so over fifty - differences are reported. However, almost no modern modem + differences are reported. However, almost no modern modem supports five- or six-bit characters, particularly those with - error-correction and compression capabilities. This means + error-correction and compression capabilities. This means that the differences related to five- and six-bit character modes can be discounted. Many of the differences COMTEST reports have to do with - timing. In many of the clone designs, when the host reads + timing. In many of the clone designs, when the host reads from one port, the status bits in some other port may not update in the same amount of time (some faster, some slower) as a real NS16550AFN and COMTEST looks - for these differences. This means that the number of + for these differences. This means that the number of differences can be misleading in that one device may only have one or two differences but they are extremely serious, and some other device that updates the status registers faster or @@ -1785,7 +1785,7 @@ INS8250 -> INS8250B If you run COMTEST on a 16550 that is in a modem or a modem is attached to the serial port, you need to first issue a ATE0&W command to the modem so that the modem will not - echo any of the test characters. If you forget to do this, + echo any of the test characters. If you forget to do this, COMTEST will report at least this one difference: @@ -1798,12 +1798,12 @@ INS8250 -> INS8250B 8250/16450/16550 Registers The 8250/16450/16550 UART occupies eight contiguous I/O - port addresses. In the IBM PC, there are two defined + port addresses. In the IBM PC, there are two defined locations for these eight ports and they are known - collectively as COM1 and COM2. The makers of PC-clones and + collectively as COM1 and COM2. The makers of PC-clones and add-on cards have created two additional areas known as COM3 and COM4, but these extra COM ports conflict with other - hardware on some systems. The most common conflict is with + hardware on some systems. The most common conflict is with video adapters that provide IBM 8514 emulation. COM1 is located from 0x3f8 to 0x3ff and normally uses IRQ @@ -1849,7 +1849,7 @@ INS8250 -> INS8250B value will be divided from the master input clock (in the IBM PC, the master clock is 1.8432MHz) and the resulting clock will determine the baud rate of - the UART. This register holds bits 0 thru 7 of the + the UART. This register holds bits 0 thru 7 of the divisor. @@ -1860,7 +1860,7 @@ INS8250 -> INS8250B value will be divided from the master input clock (in the IBM PC, the master clock is 1.8432MHz) and the resulting clock will determine the baud rate of - the UART. This register holds bits 8 thru 15 of the + the UART. This register holds bits 8 thru 15 of the divisor. @@ -1875,13 +1875,13 @@ INS8250 -> INS8250B Interrupt Enable Register (IER)The 8250/16450/16550 UART classifies - events into one of four categories. Each + events into one of four categories. Each category can be configured to generate an - interrupt when any of the events occurs. The + interrupt when any of the events occurs. The 8250/16450/16550 UART generates a single external interrupt signal regardless of how many events in the enabled categories have - occurred. It is up to the host processor to + occurred. It is up to the host processor to respond to the interrupt and then poll the enabled interrupt categories (usually all categories have interrupts enabled) to @@ -2026,7 +2026,7 @@ INS8250 -> INS8250B Bit 3 - DMA Mode Select. If Bit 0 + DMA Mode Select. If Bit 0 is set to "1" (FIFOs enabled), setting this bit changes the operation of the -RXRDY and -TXRDY signals from Mode 0 to Mode 1. @@ -2034,27 +2034,27 @@ INS8250 -> INS8250B Bit 2 - Transmit FIFO Reset. When a + Transmit FIFO Reset. When a "1" is written to this bit, the contents of the - FIFO are discarded. Any word currently being - transmitted will be sent intact. This function + FIFO are discarded. Any word currently being + transmitted will be sent intact. This function is useful in aborting transfers. Bit 1 - Receiver FIFO Reset. When a + Receiver FIFO Reset. When a "1" is written to this bit, the contents of the - FIFO are discarded. Any word currently being + FIFO are discarded. Any word currently being assembled in the shift register will be received intact. Bit 0 - 16550 FIFO Enable. When + 16550 FIFO Enable. When set, both the transmit and receive FIFOs are - enabled. Any contents in the holding register, + enabled. Any contents in the holding register, shift registers or FIFOs are lost when FIFOs are enabled or disabled. @@ -2082,13 +2082,13 @@ INS8250 -> INS8250B Bit 7 - FIFOs enabled. On the + FIFOs enabled. On the 8250/16450 UART, this bit is zero. Bit 6 - FIFOs enabled. On the + FIFOs enabled. On the 8250/16450 UART, this bit is zero. @@ -2104,7 +2104,7 @@ INS8250 -> INS8250B Bit 3 - Interrupt ID Bit #2. On the + Interrupt ID Bit #2. On the 8250/16450 UART, this bit is zero. @@ -2118,14 +2118,14 @@ INS8250 -> INS8250B Interrupt ID Bit #0.These three bits combine to report the category of event that caused the interrupt that is in - progress. These categories have priorities, so + progress. These categories have priorities, so if multiple categories of events occur at the same time, the UART will report the more important events first and the host must resolve - the events in the order they are reported. All + the events in the order they are reported. All events that caused the current interrupt must be resolved before any new interrupts will be - generated. (This is a limitation of the PC + generated. (This is a limitation of the PC architecture.) @@ -2181,7 +2181,7 @@ INS8250 -> INS8250B Bit 0 - Interrupt Pending Bit. If + Interrupt Pending Bit. If this bit is set to "0", then at least one interrupt is pending. @@ -2210,27 +2210,27 @@ INS8250 -> INS8250B Bit 7 Divisor Latch Access Bit - (DLAB). When set, access to the data + (DLAB). When set, access to the data transmit/receive register (THR/RBR) and the - Interrupt Enable Register (IER) is disabled. Any + Interrupt Enable Register (IER) is disabled. Any access to these ports is now redirected to the - Divisor Latch Registers. Setting this bit, + Divisor Latch Registers. Setting this bit, loading the Divisor Registers, and clearing DLAB should be done with interrupts disabled. Bit 6 - Set Break. When set to "1", + Set Break. When set to "1", the transmitter begins to transmit continuous - Spacing until this bit is set to "0". This + Spacing until this bit is set to "0". This overrides any bits of characters that are being transmitted. Bit 5 - Stick Parity. When parity + Stick Parity. When parity is enabled, setting this bit causes parity to always be "1" or "0", based on the value of Bit 4. @@ -2241,15 +2241,15 @@ INS8250 -> INS8250B Even Parity Select (EPS). When parity is enabled and Bit 5 is "0", setting this bit causes even parity to be transmitted - and expected. Otherwise, odd parity is + and expected. Otherwise, odd parity is used. Bit 3 - Parity Enable (PEN). When + Parity Enable (PEN). When set to "1", a parity bit is inserted between the - last bit of the data and the Stop Bit. The UART + last bit of the data and the Stop Bit. The UART will also expect parity to be present in the received data. @@ -2259,8 +2259,8 @@ INS8250 -> INS8250B Number of Stop Bits (STB). If set to "1" and using 5-bit data words, 1.5 Stop Bits are transmitted and expected in each - data word. For 6, 7 and 8-bit data words, 2 - Stop Bits are transmitted and expected. When + data word. For 6, 7 and 8-bit data words, 2 + Stop Bits are transmitted and expected. When this bit is set to "0", one Stop Bit is used on each data word. @@ -2351,20 +2351,20 @@ INS8250 -> INS8250B Bit 4 - Loop-Back Enable. When set to "1", the UART + Loop-Back Enable. When set to "1", the UART transmitter and receiver are internally connected together to allow diagnostic - operations. In addition, the UART modem control + operations. In addition, the UART modem control outputs are connected to the UART modem control - inputs. CTS is connected to RTS, DTR is + inputs. CTS is connected to RTS, DTR is connected to DSR, OUT1 is connected to RI, and OUT 2 is connected to DCD. Bit 3 - OUT 2. An auxiliary output that the host - processor may set high or low. In the IBM PC + OUT 2. An auxiliary output that the host + processor may set high or low. In the IBM PC serial adapter (and most clones), OUT 2 is used to tri-state (disable) the interrupt signal from the 8250/16450/16550 UART. @@ -2372,21 +2372,21 @@ INS8250 -> INS8250B Bit 2 - OUT 1. An auxiliary output that the host - processor may set high or low. This output is + OUT 1. An auxiliary output that the host + processor may set high or low. This output is not used on the IBM PC serial adapter. Bit 1 - Request to Send (RTS). When set to "1", the + Request to Send (RTS). When set to "1", the output of the UART -RTS line is Low (Active). Bit 0 - Data Terminal Ready (DTR). When set to "1", + Data Terminal Ready (DTR). When set to "1", the output of the UART -DTR line is Low (Active). @@ -2409,8 +2409,8 @@ INS8250 -> INS8250B Bit 7 - Error in Receiver FIFO. On the 8250/16450 - UART, this bit is zero. This bit is set to "1" + Error in Receiver FIFO. On the 8250/16450 + UART, this bit is zero. This bit is set to "1" when any of the bytes in the FIFO have one or more of the following error conditions: PE, FE, or BI. @@ -2418,48 +2418,48 @@ INS8250 -> INS8250B Bit 6 - Transmitter Empty (TEMT). When set to "1", + Transmitter Empty (TEMT). When set to "1", there are no words remaining in the transmit - FIFO or the transmit shift register. The + FIFO or the transmit shift register. The transmitter is completely idle. Bit 5 Transmitter Holding Register Empty - (THRE). When set to "1", the FIFO (or holding + (THRE). When set to "1", the FIFO (or holding register) now has room for at least one - additional word to transmit. The transmitter may + additional word to transmit. The transmitter may still be transmitting when this bit is set to "1". Bit 4 - Break Interrupt (BI). The receiver has + Break Interrupt (BI). The receiver has detected a Break signal. Bit 3 - Framing Error (FE). A Start Bit was + Framing Error (FE). A Start Bit was detected but the Stop Bit did not appear at the - expected time. The received word is probably + expected time. The received word is probably garbled. Bit 2 - Parity Error (PE). The parity bit was + Parity Error (PE). The parity bit was incorrect for the word received. Bit 1 - Overrun Error (OE). A new word was received - and therewas no room in the receive buffer. The + Overrun Error (OE). A new word was received + and therewas no room in the receive buffer. The newly-arrived word in the shift register is - discarded. On 8250/16450 UARTs, the word in the + discarded. On 8250/16450 UARTs, the word in the holding register is discarded and the newly- arrived word is put in the holding register. @@ -2468,7 +2468,7 @@ INS8250 -> INS8250B Bit 0 Data Ready (DR) One or more words are in - the receive FIFO that the host may read. A word + the receive FIFO that the host may read. A word must be completely received and moved from the shift register into the FIFO (or holding register for 8250/16450 designs) before this bit @@ -2493,31 +2493,31 @@ INS8250 -> INS8250B Bit 7 - Data Carrier Detect (DCD). Reflects the + Data Carrier Detect (DCD). Reflects the state of the DCD line on the UART. Bit 6 - Ring Indicator (RI). Reflects the state of + Ring Indicator (RI). Reflects the state of the RI line on the UART. Bit 5 - Data Set Ready (DSR). Reflects the state of + Data Set Ready (DSR). Reflects the state of the DSR line on the UART. Bit 4 - Clear To Send (CTS). Reflects the state of + Clear To Send (CTS). Reflects the state of the CTS line on the UART. Bit 3 - Delta Data Carrier Detect (DDCD). Set to + Delta Data Carrier Detect (DDCD). Set to "1" if the -DCD line has changed state one more more times since the last time the MSR was read by the host. @@ -2525,7 +2525,7 @@ INS8250 -> INS8250B Bit 2 - Trailing Edge Ring Indicator (TERI). Set to + Trailing Edge Ring Indicator (TERI). Set to "1" if the -RI line has had a low to high transition since the last time the MSR was read by the host. @@ -2533,7 +2533,7 @@ INS8250 -> INS8250B Bit 1 - Delta Data Set Ready (DDSR). Set to "1" if + Delta Data Set Ready (DDSR). Set to "1" if the -DSR line has changed state one more more times since the last time the MSR was read by the host. @@ -2541,7 +2541,7 @@ INS8250 -> INS8250B Bit 0 - Delta Clear To Send (DCTS). Set to "1" if + Delta Clear To Send (DCTS). Set to "1" if the -CTS line has changed state one more more times since the last time the MSR was read by the host. @@ -2553,8 +2553,8 @@ INS8250 -> INS8250B +0x07 write/read - Scratch Register (SCR). This register performs no - function in the UART. Any value can be written by the + Scratch Register (SCR). This register performs no + function in the UART. Any value can be written by the host to this location and read by the host later on. @@ -2568,8 +2568,8 @@ INS8250 -> INS8250B Although National Semiconductor has not offered any components compatible with the 16550 that provide additional - features, various other vendors have. Some of these - components are described below. It should be understood that + features, various other vendors have. Some of these + components are described below. It should be understood that to effectively utilize these improvements, drivers may have to be provided by the chip vendor since most of the popular operating systems do not support features beyond those @@ -2581,7 +2581,7 @@ INS8250 -> INS8250B By default this part is similar to the NS16550A, but an extended 32-byte send and receive buffer can be - optionally enabled. Made by Startech. + optionally enabled. Made by Startech. @@ -2590,7 +2590,7 @@ INS8250 -> INS8250B By default this part behaves similar to the NS16550A, but an extended 64-byte send and receive - buffer can be optionally enabled. Made by Texas + buffer can be optionally enabled. Made by Texas Instruments. @@ -2600,7 +2600,7 @@ INS8250 -> INS8250B This proprietary plug-in card contains a 2048-byte send and receive buffer, and supports data rates to - 230.4Kbit/sec. Made by Hayes. + 230.4Kbit/sec. Made by Hayes. @@ -2608,14 +2608,14 @@ INS8250 -> INS8250B In addition to these “dumb” UARTs, many vendors produce - intelligent serial communication boards. This type of design + intelligent serial communication boards. This type of design usually provides a microprocessor that interfaces with several UARTs, processes and buffers the data, and then alerts the - main PC processor when necessary. Because the UARTs are not + main PC processor when necessary. Because the UARTs are not directly accessed by the PC processor in this type of communication system, it is not necessary for the vendor to use UARTs that are compatible with the 8250, 16450, or the - 16550 UART. This leaves the designer free to components that + 16550 UART. This leaves the designer free to components that may have better performance characteristics. @@ -2627,8 +2627,8 @@ INS8250 -> INS8250B The sio driver provides support for NS8250-, NS16450-, NS16550 and NS16550A-based EIA - RS-232C (CCITT V.24) communications interfaces. Several - multiport cards are supported as well. See the sio4 manual page for detailed technical + RS-232C (CCITT V.24) communications interfaces. Several + multiport cards are supported as well. See the sio4 manual page for detailed technical documentation. @@ -2639,8 +2639,8 @@ INS8250 -> INS8250B August 1995. Here is a config snippet from a machine with a Digi - International PC/8 with 16550. It has 8 modems connected to - these 8 lines, and they work just great. Do not forget to add + International PC/8 with 16550. It has 8 modems connected to + these 8 lines, and they work just great. Do not forget to add options COM_MULTIPORT or it will not work very well! @@ -2676,7 +2676,7 @@ device sio11 at isa? port 0x138 tty flags 0xb05 irq 9 vector siointr< You either need the kernel sources installed so you can recompile the necessary options or you will need - someone else to compile it for you. The 2.0.5 default + someone else to compile it for you. The 2.0.5 default kernel does not come with multiport support enabled and you will need to add a device entry for each port anyways. @@ -2692,15 +2692,15 @@ device sio11 at isa? port 0x138 tty flags 0xb05 irq 9 vector siointr< One important note — the actual UART chips for the Boca 16 - are in the connector box, not on the internal board itself. So - if you have it unplugged, probes of those ports will fail. I + are in the connector box, not on the internal board itself. So + if you have it unplugged, probes of those ports will fail. I have never tested booting with the box unplugged and plugging it back in, and I suggest you do not either. If you do not already have a custom kernel configuration file set up, refer to Kernel Configuration for - general procedures. The following are the specifics for the + general procedures. The following are the specifics for the Boca 16 board and assume you are using the kernel name MYKERNEL and editing with vi. @@ -2717,13 +2717,13 @@ options COM_MULTIPORT Where the current device sion lines are, - you will need to add 16 more devices. Only + you will need to add 16 more devices. Only the last device includes the interrupt vector for the - board. (See the sio4 manual page for detail as + board. (See the sio4 manual page for detail as to why.) The following example is for a Boca Board with - an interrupt of 3, and a base IO address 100h. The IO + an interrupt of 3, and a base IO address 100h. The IO address for Each port is +8 hexadecimal from the - previous port, thus the 100h, 108h, 110h... addresses. + previous port, thus the 100h, 108h, 110h... addresses. device sio1 at isa? port 0x100 tty flags 0x1005 @@ -2742,21 +2742,21 @@ device sio16 at isa? port 0x178 tty flags 0x1005 irq 3 vector siointrYY indicates if FIFO is enabled or disabled(enabled), IRQ sharing is used(yes) and if there - is an AST/4 compatible IRQ control register(no). In this + is an AST/4 compatible IRQ control register(no). In this example, flags 0x1005 indicates that the master port is - sio16. If I added another board and assigned sio17 + sio16. If I added another board and assigned sio17 through sio28, the flags for all 16 ports on that board would be 0x1C05, where - 1C indicates the minor number of the master port. Do not + 1C indicates the minor number of the master port. Do not change the 05 setting. Save and complete the kernel configuration, - recompile, install and reboot. Presuming you have + recompile, install and reboot. Presuming you have successfully installed the recompiled kernel and have it set to the correct address and IRQ, your boot message should indicate the successful probe of the Boca ports @@ -2834,7 +2834,7 @@ sio16: type 16550A (multiport master) &prompt.root; echo at > ttyd* - for each device you have made. You + for each device you have made. You should see the RX lights flash for each working port. @@ -2852,7 +2852,7 @@ sio16: type 16550A (multiport master) The Cyclades multiport cards are based on the cy driver instead of the usual sio driver used by other multiport - cards. Configuration is a simple matter of: + cards. Configuration is a simple matter of: @@ -2884,7 +2884,7 @@ device cy0 at isa? tty irq 10 iomem 0xd4000 iosiz 0x2000 vector cyintr If appropriate, add dialup entries to /etc/ttys - by duplicating serial device (ttyd) entries and using ttyc in place of ttyd. For example: + by duplicating serial device (ttyd) entries and using ttyc in place of ttyd. For example: ttyc0 "/usr/libexec/getty std.38400" unknown on insecure @@ -2953,16 +2953,16 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure devised by Seagate Technology, the makers of the first affordable 5.25" winchester disk. - The acronym says Enhanced, and rightly so. In the first place + The acronym says Enhanced, and rightly so. In the first place the speed of the interface is higher, 10 or 15 Mbits/second - instead of the 5 Mbits/second of ST412 interfaced drives. Secondly + instead of the 5 Mbits/second of ST412 interfaced drives. Secondly some higher level commands are added, making the ESDI interface - somewhat 'smarter' to the operating system driver writers. It is - by no means as smart as SCSI by the way. ESDI is standardized by + somewhat 'smarter' to the operating system driver writers. It is + by no means as smart as SCSI by the way. ESDI is standardized by ANSI. Capacities of the drives are boosted by putting more sectors - on each track. Typical is 35 sectors per track, high capacity + on each track. Typical is 35 sectors per track, high capacity drives I have seen were up to 54 sectors/track. Although ESDI has been largely obsoleted by IDE and SCSI @@ -2978,19 +2978,19 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Physical connections The ESDI interface uses two cables connected to each - drive. One cable is a 34 pin flat cable edge connector that + drive. One cable is a 34 pin flat cable edge connector that carries the command and status signals from the controller to - the drive and vice-versa. The command cable is daisy chained - between all the drives. So, it forms a bus onto which all + the drive and vice-versa. The command cable is daisy chained + between all the drives. So, it forms a bus onto which all drives are connected. The second cable is a 20 pin flat cable edge connector - that carries the data to and from the drive. This cable is + that carries the data to and from the drive. This cable is radially connected, so each drive has its own direct connection to the controller. To the best of my knowledge PC ESDI controllers are - limited to using a maximum of 2 drives per controller. This is + limited to using a maximum of 2 drives per controller. This is compatibility feature(?) left over from the WD1003 standard that reserves only a single bit for device addressing. @@ -3000,13 +3000,13 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Device addressing On each command cable a maximum of 7 devices and 1 - controller can be present. To enable the controller to + controller can be present. To enable the controller to uniquely identify which drive it addresses, each ESDI device is equipped with jumpers or switches to select the devices address. On PC type controllers the first drive is set to address - 0, the second disk to address 1. Always + 0, the second disk to address 1. Always make sure you set each disk to an unique address! So, on a PC with its two drives/controller maximum the first drive is drive 0, the second is drive 1. @@ -3018,14 +3018,14 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure The daisy chained command cable (the 34 pin cable remember?) needs to be terminated at the last drive on the - chain. For this purpose ESDI drives come with a termination + chain. For this purpose ESDI drives come with a termination resistor network that can be removed or disabled by a jumper when it is not used. So, one and only one drive, the one at the farthest end of the command cable has its - terminator installed/enabled. The controller automatically - terminates the other end of the cable. Please note that this + terminator installed/enabled. The controller automatically + terminates the other end of the cable. Please note that this implies that the controller must be at one end of the cable and not in the middle. @@ -3039,12 +3039,12 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure place? People who tried ESDI disks with FreeBSD are known to have - developed a profound sense of frustration. A combination of + developed a profound sense of frustration. A combination of factors works against you to produce effects that are hard to understand when you have never seen them before. This has also led to the popular legend ESDI and FreeBSD is - a plain NO-GO. The following sections try to list all the + a plain NO-GO. The following sections try to list all the pitfalls and solutions. @@ -3052,12 +3052,12 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure ESDI speed variants As briefly mentioned before, ESDI comes in two speed - flavors. The older drives and controllers use a 10 - Mbits/second data transfer rate. Newer stuff uses 15 + flavors. The older drives and controllers use a 10 + Mbits/second data transfer rate. Newer stuff uses 15 Mbits/second. It is not hard to imagine that 15 Mbits/second drive cause - problems on controllers laid out for 10 Mbits/second. As + problems on controllers laid out for 10 Mbits/second. As always, consult your controller and drive documentation to see if things match. @@ -3068,18 +3068,18 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Mainstream ESDI drives use 34 to 36 sectors per track. Most (older) controllers cannot handle more than this number - of sectors. Newer, higher capacity, drives use higher numbers - of sectors per track. For instance, I own a 670 Mb drive that + of sectors. Newer, higher capacity, drives use higher numbers + of sectors per track. For instance, I own a 670 Mb drive that has 54 sectors per track. In my case, the controller could not handle this number of - sectors. It proved to work well except that it only used 35 - sectors on each track. This meant losing a lot of disk + sectors. It proved to work well except that it only used 35 + sectors on each track. This meant losing a lot of disk space. Once again, check the documentation of your hardware for - more info. Going out-of-spec like in the example might or - might not work. Give it a try or get another more capable + more info. Going out-of-spec like in the example might or + might not work. Give it a try or get another more capable controller. @@ -3088,26 +3088,26 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Hard or soft sectoring Most ESDI drives allow hard or soft sectoring to be - selected using a jumper. Hard sectoring means that the drive + selected using a jumper. Hard sectoring means that the drive will produce a sector pulse on the start of each new sector. The controller uses this pulse to tell when it should start to write or read. Hard sectoring allows a selection of sector size (normally - 256, 512 or 1024 bytes per formatted sector). FreeBSD uses - 512 byte sectors. The number of sectors per track also varies + 256, 512 or 1024 bytes per formatted sector). FreeBSD uses + 512 byte sectors. The number of sectors per track also varies while still using the same number of bytes per formatted - sector. The number of unformatted bytes + sector. The number of unformatted bytes per sector varies, dependent on your controller it needs more - or less overhead bytes to work correctly. Pushing more + or less overhead bytes to work correctly. Pushing more sectors on a track of course gives you more usable space, but might give problems if your controller needs more bytes than the drive offers. In case of soft sectoring, the controller itself - determines where to start/stop reading or writing. For ESDI + determines where to start/stop reading or writing. For ESDI hard sectoring is the default (at least on everything I came - across). I never felt the urge to try soft sectoring. + across). I never felt the urge to try soft sectoring. In general, experiment with sector settings before you install FreeBSD because you need to re-run the low-level @@ -3119,21 +3119,21 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Low level formatting ESDI drives need to be low level formatted before they are - usable. A reformat is needed whenever you figgle with the + usable. A reformat is needed whenever you figgle with the number of sectors/track jumpers or the physical orientation of - the drive (horizontal, vertical). So, first think, then - format. The format time must not be underestimated, for big + the drive (horizontal, vertical). So, first think, then + format. The format time must not be underestimated, for big disks it can take hours. After a low level format, a surface scan is done to find - and flag bad sectors. Most disks have a manufacturer bad block - list listed on a piece of paper or adhesive sticker. In + and flag bad sectors. Most disks have a manufacturer bad block + list listed on a piece of paper or adhesive sticker. In addition, on most disks the list is also written onto the - disk. Please use the manufacturer's list. It is much easier to + disk. Please use the manufacturer's list. It is much easier to remap a defect now than after FreeBSD is installed. Stay away from low-level formatters that mark all sectors - of a track as bad as soon as they find one bad sector. Not + of a track as bad as soon as they find one bad sector. Not only does this waste space, it also and more importantly causes you grief with bad144 (see the section on bad144). @@ -3144,8 +3144,8 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Translations Translations, although not exclusively a ESDI-only - problem, might give you real trouble. Translations come in - multiple flavors. Most of them have in common that they + problem, might give you real trouble. Translations come in + multiple flavors. Most of them have in common that they attempt to work around the limitations posed upon disk geometries by the original IBM PC/AT design (thanks IBM!). @@ -3153,27 +3153,27 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure First of all there is the (in)famous 1024 cylinder limit. For a system to be able to boot, the stuff (whatever operating system) must be in the first 1024 cylinders of a - disk. Only 10 bits are available to encode the cylinder - number. For the number of sectors the limit is 64 (0-63). When + disk. Only 10 bits are available to encode the cylinder + number. For the number of sectors the limit is 64 (0-63). When you combine the 1024 cylinder limit with the 16 head limit (also a design feature) you max out at fairly limited disk sizes. To work around this problem, the manufacturers of ESDI PC - controllers added a BIOS prom extension on their boards. This + controllers added a BIOS prom extension on their boards. This BIOS extension handles disk I/O for booting (and for some operating systems all disk I/O) - by using translation. For instance, a big drive might be + by using translation. For instance, a big drive might be presented to the system as having 32 heads and 64 - sectors/track. The result is that the number of cylinders is + sectors/track. The result is that the number of cylinders is reduced to something below 1024 and is therefore usable by the - system without problems. It is noteworthy to know that FreeBSD - does not use the BIOS after its kernel has started. More on + system without problems. It is noteworthy to know that FreeBSD + does not use the BIOS after its kernel has started. More on this later. A second reason for translations is the fact that most older system BIOSes could only handle drives with 17 sectors - per track (the old ST412 standard). Newer system BIOSes + per track (the old ST412 standard). Newer system BIOSes usually have a user-defined drive type (in most cases this is drive type 47). @@ -3187,8 +3187,8 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure While on the subject of translations, I have seen one controller type (but there are probably more like this) offer the option to logically split a drive in multiple partitions - as a BIOS option. I had select 1 drive == 1 partition because - this controller wrote this info onto the disk. On power-up it + as a BIOS option. I had select 1 drive == 1 partition because + this controller wrote this info onto the disk. On power-up it read the info and presented itself to the system based on the info from the disk. @@ -3198,19 +3198,19 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Spare sectoring Most ESDI controllers offer the possibility to remap bad - sectors. During/after the low-level format of the disk bad + sectors. During/after the low-level format of the disk bad sectors are marked as such, and a replacement sector is put in place (logically of course) of the bad one. In most cases the remapping is done by using N-1 sectors on each track for actual data storage, and sector N itself is - the spare sector. N is the total number of sectors physically - available on the track. The idea behind this is that the - operating system sees a 'perfect' disk without bad sectors. In + the spare sector. N is the total number of sectors physically + available on the track. The idea behind this is that the + operating system sees a 'perfect' disk without bad sectors. In the case of FreeBSD this concept is not usable. The problem is that the translation from bad to good is performed by the BIOS of the - ESDI controller. FreeBSD, being a true 32 bit operating + ESDI controller. FreeBSD, being a true 32 bit operating system, does not use the BIOS after it has been booted. Instead, it has device drivers that talk directly to the hardware. @@ -3225,35 +3225,35 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Bad block handling - The preceding section leaves us with a problem. The + The preceding section leaves us with a problem. The controller's bad block handling is not usable and still FreeBSD's filesystems assume perfect media without any flaws. - To solve this problem, FreeBSD use the bad144 tool. Bad144 (named after a + To solve this problem, FreeBSD use the bad144 tool. Bad144 (named after a Digital Equipment standard for bad block handling) scans a - FreeBSD slice for bad blocks. Having found these bad blocks, + FreeBSD slice for bad blocks. Having found these bad blocks, it writes a table with the offending block numbers to the end of the FreeBSD slice. When the disk is in operation, the disk accesses are - checked against the table read from the disk. Whenever a + checked against the table read from the disk. Whenever a block number is requested that is in the bad144 list, a replacement block (also from the end of the FreeBSD slice) is - used. In this way, the bad144 replacement scheme presents + used. In this way, the bad144 replacement scheme presents 'perfect' media to the FreeBSD filesystems. There are a number of potential pitfalls associated with - the use of bad144. First of all, the slice cannot have more - than 126 bad sectors. If your drive has a high number of bad + the use of bad144. First of all, the slice cannot have more + than 126 bad sectors. If your drive has a high number of bad sectors, you might need to divide it into multiple FreeBSD - slices each containing less than 126 bad sectors. Stay away + slices each containing less than 126 bad sectors. Stay away from low-level format programs that mark every sector of a track as bad when they - find a flaw on the track. As you can imagine, the 126 limit + find a flaw on the track. As you can imagine, the 126 limit is quickly reached when the low-level format is done this way. Second, if the slice contains the root filesystem, the - slice should be within the 1024 cylinder BIOS limit. During + slice should be within the 1024 cylinder BIOS limit. During the boot process the bad144 list is read using the BIOS and this only succeeds when the list is within the 1024 cylinder limit. @@ -3270,17 +3270,17 @@ ttyc7 "/usr/libexec/getty std.38400" unknown on insecure Kernel configuration - ESDI disks are handled by the same wddriver as IDE and ST412 MFM disks. The + ESDI disks are handled by the same wddriver as IDE and ST412 MFM disks. The wd driver should work for all WD1003 compatible interfaces. Most hardware is jumperable for one of two different I/O - address ranges and IRQ lines. This allows you to have two wd + address ranges and IRQ lines. This allows you to have two wd type controllers in one system. When your hardware allows non-standard strappings, you can use these with FreeBSD as long as you enter the correct info - into the kernel config file. An example from the kernel config + into the kernel config file. An example from the kernel config file (they live in /sys/i386/conf BTW). @@ -3305,36 +3305,36 @@ disk wd3 at wdc1 drive 1 Adaptec 2320 controllers I successfully installed FreeBSD onto a ESDI disk - controlled by a ACB-2320. No other operating system was + controlled by a ACB-2320. No other operating system was present on the disk. To do so I low level formatted the disk using NEFMT.EXE (ftpable from www.adaptec.com) and answered NO to the question whether the disk should be formatted with a spare - sector on each track. The BIOS on the ACD-2320 was disabled. I + sector on each track. The BIOS on the ACD-2320 was disabled. I used the free configurable option in the system BIOS to allow the BIOS to boot it. Before using NEFMT.EXE I tried to format the disk using - the ACB-2320 BIOS builtin formatter. This proved to be a show + the ACB-2320 BIOS builtin formatter. This proved to be a show stopper, because it did not give me an option to disable spare - sectoring. With spare sectoring enabled the FreeBSD + sectoring. With spare sectoring enabled the FreeBSD installation process broke down on the bad144 run. Please check carefully which ACB-232xy variant you have. The x is either 0 or 2, indicating a controller without or with a floppy controller on board. - The y is more interesting. It can either be a blank, a - A-8 or a D. A blank indicates a plain 10 Mbits/second - controller. An A-8 indicates a 15 Mbits/second controller - capable of handling 52 sectors/track. A D means a 15 + The y is more interesting. It can either be a blank, a + A-8 or a D. A blank indicates a plain 10 Mbits/second + controller. An A-8 indicates a 15 Mbits/second controller + capable of handling 52 sectors/track. A D means a 15 Mbits/second controller that can also handle drives with > 36 sectors/track (also 52 ?). All variations should be capable of using 1:1 - interleaving. Use 1:1, FreeBSD is fast enough to handle + interleaving. Use 1:1, FreeBSD is fast enough to handle it. @@ -3343,12 +3343,12 @@ disk wd3 at wdc1 drive 1 Western Digital WD1007 controllers I successfully installed FreeBSD onto a ESDI disk - controlled by a WD1007 controller. To be precise, it was a - WD1007-WA2. Other variations of the WD1007 do exist. + controlled by a WD1007 controller. To be precise, it was a + WD1007-WA2. Other variations of the WD1007 do exist. To get it to work, I had to disable the sector translation - and the WD1007's onboard BIOS. This implied I could not use - the low-level formatter built into this BIOS. Instead, I + and the WD1007's onboard BIOS. This implied I could not use + the low-level formatter built into this BIOS. Instead, I grabbed WDFMT.EXE from www.wdc.com Running this formatted my drive just fine. @@ -3358,7 +3358,7 @@ disk wd3 at wdc1 drive 1 Ultrastor U14F controllers According to multiple reports from the net, Ultrastor ESDI - boards work OK with FreeBSD. I lack any further info on + boards work OK with FreeBSD. I lack any further info on particular settings. @@ -3405,88 +3405,88 @@ disk wd3 at wdc1 drive 1 Copyright © 1995, &a.wilko;.July 6, 1996. - SCSI is an acronym for Small Computer Systems Interface. It + SCSI is an acronym for Small Computer Systems Interface. It is an ANSI standard that has become one of the leading I/O buses - in the computer industry. The foundation of the SCSI standard was + in the computer industry. The foundation of the SCSI standard was laid by Shugart Associates (the same guys that gave the world the first mini floppy disks) when they introduced the SASI bus (Shugart Associates Standard Interface). After some time an industry effort was started to come to a more strict standard allowing devices from different vendors to - work together. This effort was recognized in the ANSI SCSI-1 - standard. The SCSI-1 standard (approx 1985) is rapidly becoming - obsolete. The current standard is SCSI-2 (see Further reading), with SCSI-3 on the drawing boards. In addition to a physical interconnection standard, SCSI defines a logical (command set) standard to which disk devices - must adhere. This standard is called the Common Command Set (CCS) + must adhere. This standard is called the Common Command Set (CCS) and was developed more or less in parallel with ANSI SCSI-1. SCSI-2 includes the (revised) CCS as part of the standard itself. - The commands are dependent on the type of device at hand. It does + The commands are dependent on the type of device at hand. It does not make much sense of course to define a Write command for a scanner. The SCSI bus is a parallel bus, which comes in a number of - variants. The oldest and most used is an 8 bit wide bus, with - single-ended signals, carried on 50 wires. (If you do not know + variants. The oldest and most used is an 8 bit wide bus, with + single-ended signals, carried on 50 wires. (If you do not know what single-ended means, do not worry, that is what this document is all about.) Modern designs also use 16 bit wide buses, with - differential signals. This allows transfer speeds of - 20Mbytes/second, on cables lengths of up to 25 meters. SCSI-2 + differential signals. This allows transfer speeds of + 20Mbytes/second, on cables lengths of up to 25 meters. SCSI-2 allows a maximum bus width of 32 bits, using an additional cable. Quickly emerging are Ultra SCSI (also called Fast-20) and Ultra2 - (also called Fast-40). Fast-20 is 20 million transfers per second + (also called Fast-40). Fast-20 is 20 million transfers per second (20 Mbytes/sec on a 8 bit bus), Fast-40 is 40 million transfers - per second (40 Mbytes/sec on a 8 bit bus). Most hard drives sold + per second (40 Mbytes/sec on a 8 bit bus). Most hard drives sold today are single-ended Ultra SCSI (8 or 16 bits). Of course the SCSI bus not only has data lines, but also a - number of control signals. A very elaborate protocol is part of + number of control signals. A very elaborate protocol is part of the standard to allow multiple devices to share the bus in an - efficient manner. In SCSI-2, the data is always checked using a - separate parity line. In pre-SCSI-2 designs parity was + efficient manner. In SCSI-2, the data is always checked using a + separate parity line. In pre-SCSI-2 designs parity was optional. In SCSI-3 even faster bus types are introduced, along with a serial SCSI busses that reduces the cabling overhead and allows a - higher maximum bus length. You might see names like SSA and - Fiberchannel in this context. None of the serial buses are + higher maximum bus length. You might see names like SSA and + Fiberchannel in this context. None of the serial buses are currently in widespread use (especially not in the typical FreeBSD - environment). For this reason the serial bus types are not + environment). For this reason the serial bus types are not discussed any further. As you could have guessed from the description above, SCSI - devices are intelligent. They have to be to adhere to the SCSI - standard (which is over 2 inches thick BTW). So, for a hard disk + devices are intelligent. They have to be to adhere to the SCSI + standard (which is over 2 inches thick BTW). So, for a hard disk drive for instance you do not specify a head/cylinder/sector to address a particular block, but simply the number of the block you - want. Elaborate caching schemes, automatic bad block replacement + want. Elaborate caching schemes, automatic bad block replacement etc are all made possible by this 'intelligent device' approach. On a SCSI bus, each possible pair of devices can communicate. Whether their function allows this is another matter, but the - standard does not restrict it. To avoid signal contention, the 2 + standard does not restrict it. To avoid signal contention, the 2 devices have to arbitrate for the bus before using it. The philosophy of SCSI is to have a standard that allows - older-standard devices to work with newer-standard ones. So, an - old SCSI-1 device should normally work on a SCSI-2 bus. I say + older-standard devices to work with newer-standard ones. So, an + old SCSI-1 device should normally work on a SCSI-2 bus. I say Normally, because it is not absolutely sure that the implementation of an old device follows the (old) standard closely - enough to be acceptable on a new bus. Modern devices are usually + enough to be acceptable on a new bus. Modern devices are usually more well-behaved, because the standardization has become more strict and is better adhered to by the device manufacturers. Generally speaking, the chances of getting a working set of devices on a single bus is better when all the devices are SCSI-2 - or newer. This implies that you do not have to dump all your old + or newer. This implies that you do not have to dump all your old stuff when you get that shiny 2GB disk: I own a system on which a pre-SCSI-1 disk, a SCSI-2 QIC tape unit, a SCSI-1 helical scan - tape unit and 2 SCSI-1 disks work together quite happily. From a + tape unit and 2 SCSI-1 disks work together quite happily. From a performance standpoint you might want to separate your older and newer (=faster) devices however. @@ -3494,13 +3494,13 @@ disk wd3 at wdc1 drive 1 Components of SCSI - As said before, SCSI devices are smart. The idea is to put + As said before, SCSI devices are smart. The idea is to put the knowledge about intimate hardware details onto the SCSI - device itself. In this way, the host system does not have to + device itself. In this way, the host system does not have to worry about things like how many heads are hard disks has, or - how many tracks there are on a specific tape device. If you are + how many tracks there are on a specific tape device. If you are curious, the standard specifies commands with which you can - query your devices on their hardware particulars. FreeBSD uses + query your devices on their hardware particulars. FreeBSD uses this capability during boot to check out what devices are connected and whether they need any special treatment. @@ -3510,15 +3510,15 @@ disk wd3 at wdc1 drive 1 every odd new device that is introduced. For cabling and connectors there is a golden rule: get good - stuff. With bus speeds going up all the time you will save + stuff. With bus speeds going up all the time you will save yourself a lot of grief by using good material. So, gold plated connectors, shielded cabling, sturdy connector hoods with strain reliefs etc are the way to go. - Second golden rule: do no use cables longer than necessary. I + Second golden rule: do no use cables longer than necessary. I once spent 3 days hunting down a problem with a flaky machine only to discover that shortening the SCSI bus by 1 meter solved - the problem. And the original bus length was well within the + the problem. And the original bus length was well within the SCSI specification. @@ -3527,15 +3527,15 @@ disk wd3 at wdc1 drive 1 SCSI bus types From an electrical point of view, there are two incompatible - bus types: single-ended and differential. This means that there + bus types: single-ended and differential. This means that there are two different main groups of SCSI devices and controllers, - which cannot be mixed on the same bus. It is possible however + which cannot be mixed on the same bus. It is possible however to use special converter hardware to transform a single-ended - bus into a differential one (and vice versa). The differences + bus into a differential one (and vice versa). The differences between the bus types are explained in the next sections. In lots of SCSI related documentation there is a sort of - jargon in use to abbreviate the different bus types. A small + jargon in use to abbreviate the different bus types. A small list: @@ -3573,16 +3573,16 @@ disk wd3 at wdc1 drive 1 Fast means that the timing on the bus is somewhat different, so that on a narrow (8 bit) bus 10 Mbytes/sec are possible - instead of 5 Mbytes/sec for 'slow' SCSI. As discussed before, + instead of 5 Mbytes/sec for 'slow' SCSI. As discussed before, bus speeds of 20 and 40 million transfers/second are also emerging (Fast-20 == Ultra SCSI and Fast-40 == Ultra2 SCSI). The data lines > 8 are only used for data transfers and - device addressing. The transfers of commands and status + device addressing. The transfers of commands and status messages etc are only performed on the lowest 8 data lines. The standard allows narrow devices to operate on a wide bus. - The usable bus width is negotiated between the devices. You + The usable bus width is negotiated between the devices. You have to watch your device addressing closely when mixing wide and narrow. @@ -3592,19 +3592,19 @@ disk wd3 at wdc1 drive 1 A single-ended SCSI bus uses signals that are either 5 Volts or 0 Volts (indeed, TTL levels) and are relative to a - COMMON ground reference. A singled ended 8 bit SCSI bus has + COMMON ground reference. A singled ended 8 bit SCSI bus has approximately 25 ground lines, who are all tied to a single - `rail' on all devices. A standard single ended bus has a - maximum length of 6 meters. If the same bus is used with + `rail' on all devices. A standard single ended bus has a + maximum length of 6 meters. If the same bus is used with fast-SCSI devices, the maximum length allowed drops to 3 - meters. Fast-SCSI means that instead of 5Mbytes/sec the bus + meters. Fast-SCSI means that instead of 5Mbytes/sec the bus allows 10Mbytes/sec transfers. Fast-20 (Ultra SCSI) and Fast-40 allow for 20 and 40 - million transfers/second respectively. So, F20 is 20 + million transfers/second respectively. So, F20 is 20 Mbytes/second on a 8 bit bus, 40 Mbytes/second on a 16 bit bus - etc. For F20 the max bus length is 1.5 meters, for F40 it - becomes 0.75 meters. Be aware that F20 is pushing the limits + etc. For F20 the max bus length is 1.5 meters, for F40 it + becomes 0.75 meters. Be aware that F20 is pushing the limits quite a bit, so you will quickly find out if your SCSI bus is electrically sound. @@ -3615,7 +3615,7 @@ disk wd3 at wdc1 drive 1 It is obvious that with the newer fast-SCSI devices the - bus length can become a real bottleneck. This is why the + bus length can become a real bottleneck. This is why the differential SCSI bus was introduced in the SCSI-2 standard. @@ -3624,14 +3624,14 @@ disk wd3 at wdc1 drive 1 linkend="scsi-further-reading">Further reading) itself, connectors etc are listed there in painstaking detail. - Beware of devices using non-standard cabling. For instance + Beware of devices using non-standard cabling. For instance Apple uses a 25pin D-type connecter (like the one on serial - ports and parallel printers). Considering that the official + ports and parallel printers). Considering that the official SCSI bus needs 50 pins you can imagine the use of this - connector needs some 'creative cabling'. The reduction of the + connector needs some 'creative cabling'. The reduction of the number of ground wires they used is a bad idea, you better stick to 50 pins cabling in accordance with the SCSI - standard. For Fast-20 and 40 do not even think about buses + standard. For Fast-20 and 40 do not even think about buses like this. @@ -3641,27 +3641,27 @@ disk wd3 at wdc1 drive 1 A differential SCSI bus has a maximum length of 25 meters. Quite a difference from the 3 meters for a single-ended - fast-SCSI bus. The idea behind differential signals is that - each bus signal has its own return wire. So, each signal is - carried on a (preferably twisted) pair of wires. The voltage + fast-SCSI bus. The idea behind differential signals is that + each bus signal has its own return wire. So, each signal is + carried on a (preferably twisted) pair of wires. The voltage difference between these two wires determines whether the - signal is asserted or de-asserted. To a certain extent the + signal is asserted or de-asserted. To a certain extent the voltage difference between ground and the signal wire pair is not relevant (do not try 10 kVolts though). It is beyond the scope of this document to explain why - this differential idea is so much better. Just accept that + this differential idea is so much better. Just accept that electrically seen the use of differential signals gives a much - better noise margin. You will normally find differential buses - in use for inter-cabinet connections. Because of the lower + better noise margin. You will normally find differential buses + in use for inter-cabinet connections. Because of the lower cost single ended is mostly used for shorter buses like inside cabinets. There is nothing that stops you from using differential stuff with FreeBSD, as long as you use a controller that has - device driver support in FreeBSD. As an example, Adaptec + device driver support in FreeBSD. As an example, Adaptec marketed the AHA1740 as a single ended board, whereas the - AHA1744 was differential. The software interface to the host + AHA1744 was differential. The software interface to the host is identical for both. @@ -3670,62 +3670,62 @@ disk wd3 at wdc1 drive 1 Terminators Terminators in SCSI terminology are resistor networks that - are used to get a correct impedance matching. Impedance + are used to get a correct impedance matching. Impedance matching is important to get clean signals on the bus, without - reflections or ringing. If you once made a long distance + reflections or ringing. If you once made a long distance telephone call on a bad line you probably know what - reflections are. With 20Mbytes/sec traveling over your SCSI + reflections are. With 20Mbytes/sec traveling over your SCSI bus, you do not want signals echoing back. Terminators come in various incarnations, with more or - less sophisticated designs. Of course, there are internal and - external variants. Many SCSI devices come with a number of + less sophisticated designs. Of course, there are internal and + external variants. Many SCSI devices come with a number of sockets in which a number of resistor networks can (must be!) - installed. If you remove terminators from a device, carefully - store them. You will need them when you ever decide to - reconfigure your SCSI bus. There is enough variation in even + installed. If you remove terminators from a device, carefully + store them. You will need them when you ever decide to + reconfigure your SCSI bus. There is enough variation in even these simple tiny things to make finding the exact replacement - a frustrating business. There are also SCSI devices that have + a frustrating business. There are also SCSI devices that have a single jumper to enable or disable a built-in terminator. There are special terminators you can stick onto a flat cable - bus. Others look like external connectors, or a connector - hood without a cable. So, lots of choice as you can + bus. Others look like external connectors, or a connector + hood without a cable. So, lots of choice as you can see. There is much debate going on if and when you should switch from simple resistor (passive) terminators to active - terminators. Active terminators contain slightly more - elaborate circuit to give cleaner bus signals. The general + terminators. Active terminators contain slightly more + elaborate circuit to give cleaner bus signals. The general consensus seems to be that the usefulness of active termination increases when you have long buses and/or fast - devices. If you ever have problems with your SCSI buses you - might consider trying an active terminator. Try to borrow one + devices. If you ever have problems with your SCSI buses you + might consider trying an active terminator. Try to borrow one first, they reputedly are quite expensive. Please keep in mind that terminators for differential and - single-ended buses are not identical. You should not mix the two variants. + single-ended buses are not identical. You should not mix the two variants. OK, and now where should you install your terminators? - This is by far the most misunderstood part of SCSI. And it is - by far the simplest. The rule is: every + This is by far the most misunderstood part of SCSI. And it is + by far the simplest. The rule is: every single line on the SCSI bus has 2 (two) terminators, one at each end of the bus. So, two and not one or three - or whatever. Do yourself a favor and stick to this rule. It + or whatever. Do yourself a favor and stick to this rule. It will save you endless grief, because wrong termination has the - potential to introduce highly mysterious bugs. (Note the + potential to introduce highly mysterious bugs. (Note the “potential” here; the nastiest part is that it may or may not work.) A common pitfall is to have an internal (flat) cable in a machine and also an external cable attached to the controller. It seems almost everybody forgets to remove the terminators - from the controller. The terminator must now be on the last + from the controller. The terminator must now be on the last external device, and not on the controller! In general, every reconfiguration of a SCSI bus must pay attention to this. - Termination is to be done on a per-line basis. This + Termination is to be done on a per-line basis. This means if you have both narrow and wide buses connected to the same host adapter, you need to enable termination on the higher 8 bits of the bus on the adapter (as well as the last @@ -3733,19 +3733,19 @@ disk wd3 at wdc1 drive 1 What I did myself is remove all terminators from my SCSI - devices and controllers. I own a couple of external + devices and controllers. I own a couple of external terminators, for both the Centronics-type external cabling and - for the internal flat cable connectors. This makes + for the internal flat cable connectors. This makes reconfiguration much easier. On modern devices, sometimes integrated terminators are - used. These things are special purpose integrated circuits - that can be dis/en-abled with a control pin. It is not - necessary to physically remove them from a device. You may + used. These things are special purpose integrated circuits + that can be dis/en-abled with a control pin. It is not + necessary to physically remove them from a device. You may find them on newer host adapters, sometimes they are software - configurable, using some sort of setup tool. Some will even + configurable, using some sort of setup tool. Some will even auto-detect the cables attached to the connectors and - automatically set up the termination as necessary. At any + automatically set up the termination as necessary. At any rate, consult your documentation! @@ -3754,30 +3754,30 @@ disk wd3 at wdc1 drive 1 Terminator power The terminators discussed in the previous chapter need - power to operate properly. On the SCSI bus, a line is - dedicated to this purpose. So, simple huh? + power to operate properly. On the SCSI bus, a line is + dedicated to this purpose. So, simple huh? - Not so. Each device can provide its own terminator power - to the terminator sockets it has on-device. But if you have + Not so. Each device can provide its own terminator power + to the terminator sockets it has on-device. But if you have external terminators, or when the device supplying the terminator power to the SCSI bus line is switched off you are in trouble. The idea is that initiators (these are devices that initiate actions on the bus, a discussion follows) must supply - terminator power. All SCSI devices are allowed (but not + terminator power. All SCSI devices are allowed (but not required) to supply terminator power. To allow for un-powered devices on a bus, the terminator - power must be supplied to the bus via a diode. This prevents + power must be supplied to the bus via a diode. This prevents the backflow of current to un-powered devices. To prevent all kinds of nastiness, the terminator power is - usually fused. As you can imagine, fuses might blow. This - can, but does not have to, lead to a non functional bus. If + usually fused. As you can imagine, fuses might blow. This + can, but does not have to, lead to a non functional bus. If multiple devices supply terminator power, a single blown fuse - will not put you out of business. A single supplier with a - blown fuse certainly will. Clever external terminators + will not put you out of business. A single supplier with a + blown fuse certainly will. Clever external terminators sometimes have a LED indication that shows whether terminator power is present. @@ -3793,47 +3793,47 @@ disk wd3 at wdc1 drive 1 distinguish or address the different devices connected to it. - This is done by means of the SCSI or target ID. Each - device has a unique target ID. You can select the ID to which + This is done by means of the SCSI or target ID. Each + device has a unique target ID. You can select the ID to which a device must respond using a set of jumpers, or a dip switch, - or something similar. Some SCSI host adapters let you change - the target ID from the boot menu. (Yet some others will not + or something similar. Some SCSI host adapters let you change + the target ID from the boot menu. (Yet some others will not let you change the ID from 7.) Consult the documentation of your device for more information. Beware of multiple devices configured to use the same ID. - Chaos normally reigns in this case. A pitfall is that one of + Chaos normally reigns in this case. A pitfall is that one of the devices sharing the same ID sometimes even manages to answer to I/O requests! - For an 8 bit bus, a maximum of 8 targets is possible. The + For an 8 bit bus, a maximum of 8 targets is possible. The maximum is 8 because the selection is done bitwise using the 8 - data lines on the bus. For wide buses this increases to the + data lines on the bus. For wide buses this increases to the number of data lines (usually 16). A narrow SCSI device can not communicate with a SCSI - device with a target ID larger than 7. This means it is + device with a target ID larger than 7. This means it is generally not a good idea to move your SCSI host adapter's target ID to something higher than 7 (or your CD-ROM will stop working). The higher the SCSI target ID, the higher the priority the - devices has. When it comes to arbitration between devices + devices has. When it comes to arbitration between devices that want to use the bus at the same time, the device that has - the highest SCSI ID will win. This also means that the SCSI - host adapter usually uses target ID 7. Note however that the + the highest SCSI ID will win. This also means that the SCSI + host adapter usually uses target ID 7. Note however that the lower 8 IDs have higher priorities than the higher 8 IDs on a - wide-SCSI bus. Thus, the order of target IDs is: [7 6 .. 1 0 15 14 .. 9 8] on a wide-SCSI - system. (If you you are wondering why the lower 8 have higher + wide-SCSI bus. Thus, the order of target IDs is: [7 6 .. 1 0 15 14 .. 9 8] on a wide-SCSI + system. (If you you are wondering why the lower 8 have higher priority, read the previous paragraph for a hint.) For a further subdivision, the standard allows for Logical - Units or LUNs for short. A single target ID may have multiple - LUNs. For example, a tape device including a tape changer may + Units or LUNs for short. A single target ID may have multiple + LUNs. For example, a tape device including a tape changer may have LUN 0 for the tape device itself, and LUN 1 for the tape - changer. In this way, the host system can address each of the + changer. In this way, the host system can address each of the functional units of the tape changer as desired. @@ -3841,22 +3841,22 @@ disk wd3 at wdc1 drive 1 Bus layout - SCSI buses are linear. So, not shaped like Y-junctions, + SCSI buses are linear. So, not shaped like Y-junctions, star topologies, rings, cobwebs or whatever else people might - want to invent. One of the most common mistakes is for people + want to invent. One of the most common mistakes is for people with wide-SCSI host adapters to connect devices on all three connecters (external connector, internal wide connector, - internal narrow connector). Don't do that. It may appear to + internal narrow connector). Don't do that. It may appear to work if you are really lucky, but I can almost guarantee that your system will stop functioning at the most unfortunate moment (this is also known as “Murphy's law”). You might notice that the terminator issue discussed - earlier becomes rather hairy if your bus is not linear. Also, + earlier becomes rather hairy if your bus is not linear. Also, if you have more connectors than devices on your internal SCSI cable, make sure you attach devices on connectors on both ends instead of using the connectors in the middle and let one or - both ends dangle. This will screw up the termination of the + both ends dangle. This will screw up the termination of the bus. The electrical characteristics, its noise margins and @@ -3880,76 +3880,76 @@ disk wd3 at wdc1 drive 1 a electrically sound bus. When you want to use a SCSI disk on your PC as boot disk, - you must aware of some quirks related to PC BIOSes. The PC + you must aware of some quirks related to PC BIOSes. The PC BIOS in its first incarnation used a low level physical - interface to the hard disk. So, you had to tell the BIOS + interface to the hard disk. So, you had to tell the BIOS (using a setup tool or a BIOS built-in setup) how your disk - physically looked like. This involved stating number of heads, + physically looked like. This involved stating number of heads, number of cylinders, number of sectors per track, obscure things like precompensation and reduced write current cylinder etc. One might be inclined to think that since SCSI disks are - smart you can forget about this. Alas, the arcane setup issue - is still present today. The system BIOS needs to know how to + smart you can forget about this. Alas, the arcane setup issue + is still present today. The system BIOS needs to know how to access your SCSI disk with the head/cyl/sector method in order to load the FreeBSD kernel during boot. The SCSI host adapter or SCSI controller you have put in your AT/EISA/PCI/whatever bus to connect your disk therefore - has its own on-board BIOS. During system startup, the SCSI + has its own on-board BIOS. During system startup, the SCSI BIOS takes over the hard disk interface routines from the - system BIOS. To fool the system BIOS, the system setup is - normally set to No hard disk present. Obvious, isn't + system BIOS. To fool the system BIOS, the system setup is + normally set to No hard disk present. Obvious, isn't it? The SCSI BIOS itself presents to the system a so called - translated drive. This means + translated drive. This means that a fake drive table is constructed that allows the PC to - boot the drive. This translation is often (but not always) + boot the drive. This translation is often (but not always) done using a pseudo drive with 64 heads and 32 sectors per - track. By varying the number of cylinders, the SCSI BIOS - adapts to the actual drive size. It is useful to note that 32 - * 64 / 2 = the size of your drive in megabytes. The division + track. By varying the number of cylinders, the SCSI BIOS + adapts to the actual drive size. It is useful to note that 32 + * 64 / 2 = the size of your drive in megabytes. The division by 2 is to get from disk blocks that are normally 512 bytes in size to Kbytes. - Right. All is well now?! No, it is not. The system BIOS - has another quirk you might run into. The number of cylinders - of a bootable hard disk cannot be greater than 1024. Using the + Right. All is well now?! No, it is not. The system BIOS + has another quirk you might run into. The number of cylinders + of a bootable hard disk cannot be greater than 1024. Using the translation above, this is a show-stopper for disks greater - than 1 GB. With disk capacities going up all the time this is + than 1 GB. With disk capacities going up all the time this is causing problems. Fortunately, the solution is simple: just use another - translation, e.g. with 128 heads instead of 32. In most cases + translation, e.g. with 128 heads instead of 32. In most cases new SCSI BIOS versions are available to upgrade older SCSI - host adapters. Some newer adapters have an option, in the form + host adapters. Some newer adapters have an option, in the form of a jumper or software setup selection, to switch the translation the SCSI BIOS uses. It is very important that all operating systems on the disk use the same translation to get the - right idea about where to find the relevant partitions. So, + right idea about where to find the relevant partitions. So, when installing FreeBSD you must answer any questions about heads/cylinders etc using the translated values your host adapter uses. Failing to observe the translation issue might lead to un-bootable systems or operating systems overwriting each - others partitions. Using fdisk you should be able to see all + others partitions. Using fdisk you should be able to see all partitions. You might have heard some talk of “lying” devices? Older FreeBSD kernels used to report the geometry of SCSI disks when - booting. An example from one of my systems: + booting. An example from one of my systems: aha0 targ 0 lun 0: <MICROP 1588-15MB1057404HSP4> sd0: 636MB (1303250 total sec), 1632 cyl, 15 head, 53 sec, bytes/sec 512 - Newer kernels usually do not report this information. e.g. + Newer kernels usually do not report this information. e.g. (bt0:0:0): "SEAGATE ST41651 7574" type 0 fixed SCSI 2 @@ -3958,15 +3958,15 @@ sd0(bt0:0:0): Direct-Access 1350MB (2766300 512 byte sectors) Why has this changed? - This info is retrieved from the SCSI disk itself. Newer - disks often use a technique called zone bit recording. The + This info is retrieved from the SCSI disk itself. Newer + disks often use a technique called zone bit recording. The idea is that on the outer cylinders of the drive there is more - space so more sectors per track can be put on them. This + space so more sectors per track can be put on them. This results in disks that have more tracks on outer cylinders than on the inner cylinders and, last but not least, have more - capacity. You can imagine that the value reported by the drive + capacity. You can imagine that the value reported by the drive when inquiring about the geometry now becomes suspect at best, - and nearly always misleading. When asked for a geometry , it + and nearly always misleading. When asked for a geometry , it is nearly always better to supply the geometry used by the BIOS, or if the BIOS is never going to know about this disk, (e.g. it is not a booting disk) to @@ -3977,23 +3977,23 @@ sd0(bt0:0:0): Direct-Access 1350MB (2766300 512 byte sectors) SCSI subsystem design - FreeBSD uses a layered SCSI subsystem. For each different - controller card a device driver is written. This driver knows - all the intimate details about the hardware it controls. The + FreeBSD uses a layered SCSI subsystem. For each different + controller card a device driver is written. This driver knows + all the intimate details about the hardware it controls. The driver has a interface to the upper layers of the SCSI subsystem through which it receives its commands and reports back any status. On top of the card drivers there are a number of more - generic drivers for a class of devices. More specific: a + generic drivers for a class of devices. More specific: a driver for tape devices (abbreviation: st), magnetic disks - (sd), CD-ROMs (cd) etc. In case you are wondering where you + (sd), CD-ROMs (cd) etc. In case you are wondering where you can find this stuff, it all lives in - /sys/scsi. See the man pages in section 4 + /sys/scsi. See the man pages in section 4 for more details. The multi level design allows a decoupling of low-level - bit banging and more high level stuff. Adding support for + bit banging and more high level stuff. Adding support for another piece of hardware is a much more manageable problem. @@ -4004,19 +4004,19 @@ sd0(bt0:0:0): Direct-Access 1350MB (2766300 512 byte sectors) Dependent on your hardware, the kernel configuration file must contain one or more lines describing your host - adapter(s). This includes I/O addresses, interrupts etc. + adapter(s). This includes I/O addresses, interrupts etc. Consult the man page for your adapter driver to get more info. Apart from that, check out /sys/i386/conf/LINT for an overview of a - kernel config file. LINT contains every - possible option you can dream of. It does + kernel config file. LINT contains every + possible option you can dream of. It does not imply LINT will actually get you to a working kernel at all. Although it is probably stating the obvious: the kernel - config file should reflect your actual hardware setup. So, + config file should reflect your actual hardware setup. So, interrupts, I/O addresses etc must match the kernel config - file. During system boot messages will be displayed to + file. During system boot messages will be displayed to indicate whether the configured hardware was actually found. @@ -4074,7 +4074,7 @@ device cd0 at scbus? [the first ever CD-ROM found, no wiring] The example above tells the kernel to look for a ahc (Adaptec 274x) controller, then for an NCR/Symbios board, and - so on. The lines following the controller specifications tell + so on. The lines following the controller specifications tell the kernel to configure specific devices but only attach them when they match the target ID and LUN specified on the corresponding bus. @@ -4082,37 +4082,37 @@ device cd0 at scbus? [the first ever CD-ROM found, no wiring] Wired down devices get “first shot” at the unit numbers so the first non “wired down” device, is allocated the unit number one greater than the highest “wired down” unit number - for that kind of device. So, if you had a SCSI tape at target + for that kind of device. So, if you had a SCSI tape at target ID 2 it would be configured as st2, as the tape at target ID 6 is wired down to unit number 1. Wired down devices need not be found to get their unit - number. The unit number for a wired down device is reserved - for that device, even if it is turned off at boot time. This + number. The unit number for a wired down device is reserved + for that device, even if it is turned off at boot time. This allows the device to be turned on and brought on-line at a - later time, without rebooting. Notice that a device's unit + later time, without rebooting. Notice that a device's unit number has no relationship with its target ID on the SCSI bus. Below is another example of a kernel config file as used - by FreeBSD version < 2.0.5. The difference with the first - example is that devices are not “wired down”. “Wired down” + by FreeBSD version < 2.0.5. The difference with the first + example is that devices are not “wired down”. “Wired down” means that you specify which SCSI target belongs to which device. A kernel built to the config file below will attach the first SCSI disk it finds to sd0, the second disk to sd1 etc. If you ever removed or added a disk, all other devices of the - same type (disk in this case) would 'move around'. This + same type (disk in this case) would 'move around'. This implies you have to change /etc/fstab each time. Although the old style still works, you are strongly recommended to use this new - feature. It will save you a lot of grief whenever you shift - your hardware around on the SCSI buses. So, when you re-use + feature. It will save you a lot of grief whenever you shift + your hardware around on the SCSI buses. So, when you re-use your old trusty config file after upgrading from a pre-FreeBSD2.0.5.R system check this out. @@ -4134,15 +4134,15 @@ device st0 [support for 2 SCSI tapes] [for the CD-ROM] device cd0 #Only need one of these, the code dynamically grows - Both examples support SCSI disks. If during boot more + Both examples support SCSI disks. If during boot more devices of a specific type (e.g. sd disks) are found than are configured in the booting kernel, the system will simply allocate more devices, incrementing the unit number starting - at the last number “wired down”. If there are no “wired down” + at the last number “wired down”. If there are no “wired down” devices then counting starts at unit 0. Use man 4 scsi to check for - the latest info on the SCSI subsystem. For more detailed info + the latest info on the SCSI subsystem. For more detailed info on host adapter drivers use eg man 4 ahc for info on the Adaptec 294x driver. @@ -4153,24 +4153,24 @@ device cd0 #Only need one of these, the code dynamically growsExperience has shown that some devices are slow to respond to INQUIRY commands after a SCSI bus reset (which happens at - boot time). An INQUIRY command is sent by the kernel on boot + boot time). An INQUIRY command is sent by the kernel on boot to see what kind of device (disk, tape, CD-ROM etc) is - connected to a specific target ID. This process is called + connected to a specific target ID. This process is called device probing by the way. To work around the 'slow response' problem, FreeBSD allows a tunable delay time before the SCSI devices are probed - following a SCSI bus reset. You can set this delay time in + following a SCSI bus reset. You can set this delay time in your kernel configuration file using a line like: options SCSI_DELAY=15 #Be pessimistic about Joe SCSI device - This line sets the delay time to 15 seconds. On my own + This line sets the delay time to 15 seconds. On my own system I had to use 3 seconds minimum to get my trusty old - CD-ROM drive to be recognized. Start with a high value (say 30 + CD-ROM drive to be recognized. Start with a high value (say 30 seconds or so) when you have problems with device - recognition. If this helps, tune it back until it just stays + recognition. If this helps, tune it back until it just stays working. @@ -4180,13 +4180,13 @@ options SCSI_DELAY=15 #Be pessimistic about Joe SCSI deviceAlthough the SCSI standard tries to be complete and concise, it is a complex standard and implementing things - correctly is no easy task. Some vendors do a better job then + correctly is no easy task. Some vendors do a better job then others. This is exactly where the “rogue” devices come into view. Rogues are devices that are recognized by the FreeBSD kernel - as behaving slightly (...) non-standard. Rogue devices are - reported by the kernel when booting. An example for two of my + as behaving slightly (...) non-standard. Rogue devices are + reported by the kernel when booting. An example for two of my cartridge tape units: @@ -4199,14 +4199,14 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue For instance, there are devices that respond to all LUNs on a certain target ID, even if they are actually only one - device. It is easy to see that the kernel might be fooled into + device. It is easy to see that the kernel might be fooled into believing that there are 8 LUNs at that particular target ID. The confusion this causes is left as an exercise to the reader. The SCSI subsystem of FreeBSD recognizes devices with bad habits by looking at the INQUIRY response they send when - probed. Because the INQUIRY response also includes the version + probed. Because the INQUIRY response also includes the version number of the device firmware, it is even possible that for different firmware versions different workarounds are used. See e.g. /sys/scsi/st.c and @@ -4214,14 +4214,14 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue this is done. This scheme works fine, but keep in mind that it of course - only works for devices that are known to be weird. If you are + only works for devices that are known to be weird. If you are the first to connect your bogus Mumbletech SCSI CD-ROM you might be the one that has to define which workaround is needed. After you got your Mumbletech working, please send the required workaround to the FreeBSD development team for - inclusion in the next release of FreeBSD. Other Mumbletech + inclusion in the next release of FreeBSD. Other Mumbletech owners will be grateful to you. @@ -4230,14 +4230,14 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue Multiple LUN devices In some cases you come across devices that use multiple - logical units (LUNs) on a single SCSI ID. In most cases - FreeBSD only probes devices for LUN 0. An example are so + logical units (LUNs) on a single SCSI ID. In most cases + FreeBSD only probes devices for LUN 0. An example are so called bridge boards that connect 2 non-SCSI harddisks to a SCSI bus (e.g. an Emulex MD21 found in old Sun systems). This means that any devices with LUNs != 0 are not - normally found during device probe on system boot. To work + normally found during device probe on system boot. To work around this problem you must add an appropriate entry in /sys/scsi/scsiconf.c and rebuild your kernel. @@ -4260,7 +4260,7 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue } The kernel on boot scans the inquiry data it receives - against the table and acts accordingly. See the source for + against the table and acts accordingly. See the source for more info. @@ -4272,9 +4272,9 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue support what is called tagged command queuing (TCQ). In a nutshell, TCQ allows the device to have multiple I/O - requests outstanding at the same time. Because the device is + requests outstanding at the same time. Because the device is intelligent, it can optimise its operations (like head - positioning) based on its own request queue. On SCSI devices + positioning) based on its own request queue. On SCSI devices like RAID (Redundant Array of Independent Disks) arrays the TCQ function is indispensable to take advantage of the device's inherent parallelism. @@ -4286,8 +4286,8 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue It should be noted however that TCQ requires device driver support and that some devices implemented it “not quite right” - in their firmware. This problem bit me once, and it leads to - highly mysterious problems. In such cases, try to disable + in their firmware. This problem bit me once, and it leads to + highly mysterious problems. In such cases, try to disable TCQ. @@ -4296,18 +4296,18 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue Busmaster host adapters Most, but not all, SCSI host adapters are bus mastering - controllers. This means that they can do I/O on their own + controllers. This means that they can do I/O on their own without putting load onto the host CPU for data movement. This is of course an advantage for a multitasking - operating system like FreeBSD. It must be noted however that + operating system like FreeBSD. It must be noted however that there might be some rough edges. For instance an Adaptec 1542 controller can be set to use different transfer speeds on the host bus (ISA or AT in this - case). The controller is settable to different rates because - not all motherboards can handle the higher speeds. Problems + case). The controller is settable to different rates because + not all motherboards can handle the higher speeds. Problems like hangups, bad data etc might be the result of using a higher data transfer rate then your motherboard can stomach. @@ -4318,12 +4318,12 @@ Mar 29 21:16:37 yedi /kernel: st1: Archive Viper 150 is a known rogue In the case of a Adaptec 1542, there is an option that can be put into the kernel config file to allow dynamic determination of the right, read: fastest feasible, transfer - rate. This option is disabled by default: + rate. This option is disabled by default: options "TUNE_1542" #dynamic tune of bus DMA speed - Check the man pages for the host adapter that you use. Or + Check the man pages for the host adapter that you use. Or better still, use the ultimate documentation (read: driver source). @@ -4334,7 +4334,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speedTracking down problems The following list is an attempt to give a guideline for the - most common SCSI problems and their solutions. It is by no means + most common SCSI problems and their solutions. It is by no means complete. @@ -4382,16 +4382,16 @@ options "TUNE_1542" #dynamic tune of bus DMA speed If you can compile a kernel, make one with the SCSIDEBUG option, and try accessing the device with - debugging turned on for that device. If your device does + debugging turned on for that device. If your device does not even probe at startup, you may have to define the address of the device that is failing, and the desired debug level in /sys/scsi/scsidebug.h. If it probes but just does not work, you can use the scsi8 command to dynamically set a debug level to it in a running kernel (if SCSIDEBUG is - defined). This will give you copious debugging output with - which to confuse the gurus. see man 4 - scsi for more exact information. Also look at + defined). This will give you copious debugging output with + which to confuse the gurus. See man 4 + scsi for more exact information. Also look at man 8 scsi. @@ -4474,7 +4474,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speed “SCSI: Understanding the Small Computer System - Interface”, written by NCR Corporation. Available from: + Interface”, written by NCR Corporation. Available from: Prentice Hall, Englewood Cliffs, NJ, 07632 Phone: (201) 767-5937 ISBN 0-13-796855-8 @@ -4488,13 +4488,13 @@ options "TUNE_1542" #dynamic tune of bus DMA speed “SCSI Interconnection Guide Book”, an AMP publication (dated 4/93, Catalog 65237) that lists the various SCSI - connectors and suggests cabling schemes. Available from + connectors and suggests cabling schemes. Available from AMP at (800) 522-6752 or (717) 564-0100 “Fast Track to SCSI”, A Product Guide written by - Fujitsu. Available from: Prentice Hall, Englewood Cliffs, + Fujitsu. Available from: Prentice Hall, Englewood Cliffs, NJ, 07632 Phone: (201) 767-5937 ISBN 0-13-307000-X @@ -4517,11 +4517,11 @@ options "TUNE_1542" #dynamic tune of bus DMA speedOn Usenet the newsgroups comp.periphs.scsi and comp.periphs are - noteworthy places to look for more info. You can also find the + noteworthy places to look for more info. You can also find the SCSI-Faq there, which is posted periodically. Most major SCSI device and host adapter suppliers operate - ftp sites and/or BBS systems. They may be valuable sources of + ftp sites and/or BBS systems. They may be valuable sources of information about the devices you own. @@ -4563,11 +4563,11 @@ options "TUNE_1542" #dynamic tune of bus DMA speedAs mentioned in the SCSI section, virtually all SCSI hard drives sold today are SCSI-2 compliant and thus will work fine as long as you connect them to - a supported SCSI host adapter. Most problems people encounter + a supported SCSI host adapter. Most problems people encounter are either due to badly designed cabling (cable too long, star topology, etc.), insufficient termination, or defective parts. Please refer to the SCSI - section first if your SCSI hard drive is not working. However, + section first if your SCSI hard drive is not working. However, there are a couple of things you may want to take into account before you purchase SCSI hard drives for your system. @@ -4576,62 +4576,62 @@ options "TUNE_1542" #dynamic tune of bus DMA speedRotational speed Rotational speeds of SCSI drives sold today range from - around 4,500RPM to 10,000RPM. Most of them are either 5,400RPM - or 7,200RPM. Even though the 7,200RPM drives can generally + around 4,500RPM to 10,000RPM. Most of them are either 5,400RPM + or 7,200RPM. Even though the 7,200RPM drives can generally transfer data faster, they run considerably hotter than their - 5,400RPM counterparts. A large fraction of today's disk drive - malfunctions are heat-related. If you do not have very good + 5,400RPM counterparts. A large fraction of today's disk drive + malfunctions are heat-related. If you do not have very good cooling in your PC case, you may want to stick with 5,400RPM or slower drives. Note that newer drives, with higher areal recording densities, can deliver much more bits per rotation than older - ones. Today's top-of-line 5,400RPM drives can sustain a + ones. Today's top-of-line 5,400RPM drives can sustain a throughput comparable to 7,200RPM drives of one or two model - generations ago. The number to find on the spec sheet for - bandwidth is “internal data (or transfer) rate”. It is + generations ago. The number to find on the spec sheet for + bandwidth is “internal data (or transfer) rate”. It is usually in megabits/sec so divide it by 8 and you'll get the rough approximation of how much megabytes/sec you can get out of the drive. (If you are a speed maniac and want a 10,000RPM drive for your cute little peecee, be my guest; however, those drives - become extremely hot. Don't even think about it if you don't + become extremely hot. Don't even think about it if you don't have a fan blowing air directly at the drive or a properly ventilated disk enclosure.) Obviously, the latest 10,000RPM drives and 7,200RPM drives can deliver more data than the latest 5,400RPM drives, so if absolute bandwidth is the necessity for your applications, you - have little choice but to get the faster drives. Also, if you + have little choice but to get the faster drives. Also, if you need low latency, faster drives are better; not only do they usually have lower average seek times, but also the rotational delay is one place where slow-spinning drives can never beat a - faster one. (The average rotational latency is half the time + faster one. (The average rotational latency is half the time it takes to rotate the drive once; thus, it's 3 milliseconds for 10,000RPM drives, 4.2ms for 7,200RPM drives and 5.6ms for 5,400RPM drives.) Latency is seek time plus rotational delay. Make sure you understand whether you need low latency or more accesses per second, though; in the latter case (e.g., news servers), it may not be optimal to purchase one big fast - drive. You can achieve similar or even better results by + drive. You can achieve similar or even better results by using the ccd (concatenated disk) driver to create a striped disk array out of multiple slower drives for comparable overall cost. Make sure you have adequate air flow around the drive, - especially if you are going to use a fast-spinning drive. You + especially if you are going to use a fast-spinning drive. You generally need at least 1/2" (1.25cm) of spacing above and - below a drive. Understand how the air flows through your PC - case. Most cases have the power supply suck the air out of - the back. See where the air flows in, and put the drive where + below a drive. Understand how the air flows through your PC + case. Most cases have the power supply suck the air out of + the back. See where the air flows in, and put the drive where it will have the largest volume of cool air flowing around it. You may need to seal some unwanted holes or add a new fan for effective cooling. - Another consideration is noise. Many 7,200 or faster + Another consideration is noise. Many 7,200 or faster drives generate a high-pitched whine which is quite unpleasant - to most people. That, plus the extra fans often required for + to most people. That, plus the extra fans often required for cooling, may make 7,200 or faster drives unsuitable for some office and home environments. @@ -4640,11 +4640,11 @@ options "TUNE_1542" #dynamic tune of bus DMA speed Form factor - Most SCSI drives sold today are of 3.5" form factor. They + Most SCSI drives sold today are of 3.5" form factor. They come in two different heights; 1.6" (“half-height”) or 1" - (“low-profile”). The half-height drive is the same height as a - CD-ROM drive. However, don't forget the spacing rule - mentioned in the previous section. If you have three standard + (“low-profile”). The half-height drive is the same height as a + CD-ROM drive. However, don't forget the spacing rule + mentioned in the previous section. If you have three standard 3.5" drive bays, you will not be able to put three half-height drives in there (without frying them, that is). @@ -4654,32 +4654,32 @@ options "TUNE_1542" #dynamic tune of bus DMA speedInterface The majority of SCSI hard drives sold today are Ultra or - Ultra-wide SCSI. The maximum bandwidth of Ultra SCSI is - 20MB/sec, and Ultra-wide SCSI is 40MB/sec. There is no + Ultra-wide SCSI. The maximum bandwidth of Ultra SCSI is + 20MB/sec, and Ultra-wide SCSI is 40MB/sec. There is no difference in max cable length between Ultra and Ultra-wide; however, the more devices you have on the same bus, the sooner - you will start having bus integrity problems. Unless you have + you will start having bus integrity problems. Unless you have a well-designed disk enclosure, it is not easy to make more than 5 or 6 Ultra SCSI drives work on a single bus. On the other hand, if you need to connect many drives, - going for Fast-wide SCSI may not be a bad idea. That will + going for Fast-wide SCSI may not be a bad idea. That will have the same max bandwidth as Ultra (narrow) SCSI, while - electronically it's much easier to get it “right”. My advice + electronically it's much easier to get it “right”. My advice would be: if you want to connect many disks, get wide SCSI drives; they usually cost a little more but it may save you - down the road. (Besides, if you can't afford the cost + down the road. (Besides, if you can't afford the cost difference, you shouldn't be building a disk array.) There are two variant of wide SCSI drives; 68-pin and - 80-pin SCA (Single Connector Attach). The SCA drives don't + 80-pin SCA (Single Connector Attach). The SCA drives don't have a separate 4-pin power connector, and also read the SCSI - ID settings through the 80-pin connector. If you are really + ID settings through the 80-pin connector. If you are really serious about building a large storage system, get SCA drives and a good SCA enclosure (dual power supply with at least one - extra fan). They are more electronically sound than 68-pin + extra fan). They are more electronically sound than 68-pin counterparts because there is no “stub” of the SCSI bus inside - the disk canister as in arrays built from 68-pin drives. They + the disk canister as in arrays built from 68-pin drives. They are easier to install too (you just need to screw the drive in the canister, instead of trying to squeeze in your fingers in a tight place to hook up all the little cables (like the SCSI @@ -4706,9 +4706,9 @@ options "TUNE_1542" #dynamic tune of bus DMA speedGeneral tape access commands mt1 provides generic access to the tape - drives. Some of the more common commands are + drives. Some of the more common commands are rewind, erase, and - status. See the mt1 + status. See the mt1 manual page for a detailed description. @@ -4717,9 +4717,9 @@ options "TUNE_1542" #dynamic tune of bus DMA speedController Interfaces There are several different interfaces that support tape - drives. The interfaces are SCSI, IDE, Floppy and Parallel Port. + drives. The interfaces are SCSI, IDE, Floppy and Parallel Port. A wide variety of tape drives are available for these - interfaces. Controllers are discussed in + interfaces. Controllers are discussed in Disk/tape controllers. @@ -4732,13 +4732,13 @@ options "TUNE_1542" #dynamic tune of bus DMA speedst4 manual page for a detailed description. The drives listed below are currently being used by members - of the FreeBSD community. They are not the only drives that - will work with FreeBSD. They just happen to be the ones that we + of the FreeBSD community. They are not the only drives that + will work with FreeBSD. They just happen to be the ones that we use. @@ -4871,19 +4871,19 @@ options "TUNE_1542" #dynamic tune of bus DMA speedThis is a QIC tape drive. - Native capacity is 1.35GB when using QIC-1350 tapes. This + Native capacity is 1.35GB when using QIC-1350 tapes. This drive will read and write QIC-150 (DC6150), QIC-250 (DC6250), and QIC-525 (DC6525) tapes as well. Data transfer rate is 350kB/s using - dump8. Rates of 530kB/s have been + dump8. Rates of 530kB/s have been reported when using Amanda Production of this drive has been discontinued. The SCSI bus connector on this tape drive is reversed from - that on most other SCSI devices. Make sure that you have + that on most other SCSI devices. Make sure that you have enough SCSI cable to twist the cable one-half turn before and after the Archive Anaconda tape drive, or turn your other SCSI devices upside-down. @@ -4892,7 +4892,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speed If you have a SCSI-2 controller, short jumper 6. - Otherwise, the drive behaves are a SCSI-1 device. When + Otherwise, the drive behaves are a SCSI-1 device. When operating as a SCSI-1 device, this drive, “locks” the SCSI bus during some tape operations, including: fsf, rewind, and rewoffl. @@ -4964,16 +4964,16 @@ options "TUNE_1542" #dynamic tune of bus DMA speedThe boot message identifier for this drive is ARCHIVE VIPER 150 21531 -004 Archive Viper 150 is a known rogue - type 1 removable SCSI 1. A multitude of firmware revisions - exist for this drive. Your drive may report different numbers + type 1 removable SCSI 1. A multitude of firmware revisions + exist for this drive. Your drive may report different numbers (e.g 21247 -005. This is a QIC tape drive. - Native capacity is 150/250MB. Both 150MB (DC6150) and - 250MB (DC6250) tapes have the recording format. The 250MB - tapes are approximately 67% longer than the 150MB tapes. This - drive can read 120MB tapes as well. It can not write 120MB + Native capacity is 150/250MB. Both 150MB (DC6150) and + 250MB (DC6250) tapes have the recording format. The 250MB + tapes are approximately 67% longer than the 150MB tapes. This + drive can read 120MB tapes as well. It can not write 120MB tapes. Data transfer rate is 100kB/s @@ -4985,8 +4985,8 @@ options "TUNE_1542" #dynamic tune of bus DMA speedst4). Under FreeBSD 2.2-current, use mt - blocksize 512 to set the blocksize. (The - particular drive had firmware revision 21247 -005. Other + blocksize 512 to set the blocksize. (The + particular drive had firmware revision 21247 -005. Other firmware revisions may behave differently) Previous versions of FreeBSD did not have this problem. @@ -5013,7 +5013,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speedData transfer rate is 180kB/s at 90 inches/sec. The drive reads QIC-525, QIC-150, QIC-120 and QIC-24 - tapes. Writes QIC-525, QIC-150, and QIC-120. + tapes. Writes QIC-525, QIC-150, and QIC-120. Firmware revisions prior to 25462 -011 are bug ridden and will not function properly. @@ -5075,7 +5075,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speedData transfer rate is 1.2MB/s. - This drive is identical to the Quantum DLT2000. The drive + This drive is identical to the Quantum DLT2000. The drive firmware can be set to emulate several well-known drives, including an Exabyte 8mm drive. @@ -5102,9 +5102,9 @@ options "TUNE_1542" #dynamic tune of bus DMA speed WARNING: This drive does not meet the SCSI-2 - specifications. The drive locks up completely in response to + specifications. The drive locks up completely in response to a SCSI MODE_SELECT command unless there is a formatted tape in - the drive. Before using this drive, set the tape blocksize + the drive. Before using this drive, set the tape blocksize with @@ -5112,7 +5112,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speedBefore using a minicartridge for the first time, the - minicartridge must be formated. FreeBSD 2.1.0-RELEASE and + minicartridge must be formated. FreeBSD 2.1.0-RELEASE and earlier: @@ -5146,12 +5146,12 @@ options "TUNE_1542" #dynamic tune of bus DMA speedData transfer rate is 270kB/s. This drive is fairly slow in responding to the SCSI bus - during boot. A custom kernel may be required (set SCSI_DELAY + during boot. A custom kernel may be required (set SCSI_DELAY to 10 seconds). There are a large number of firmware configurations for this drive, some have been customized to a particular vendor's - hardware. The firmware can be changed via EPROM + hardware. The firmware can be changed via EPROM replacement. Production of this drive has been discontinued. @@ -5203,11 +5203,11 @@ options "TUNE_1542" #dynamic tune of bus DMA speedThe boot message identifier for this drive is HP C1533A 9503 type 1 removable SCSI 2. - This is a DDS-2 tape drive. DDS-2 means hardware data + This is a DDS-2 tape drive. DDS-2 means hardware data compression and narrower tracks for increased data capacity. - Native capacity is 4GB when using 120m tapes. This drive + Native capacity is 4GB when using 120m tapes. This drive supports hardware data compression. Data transfer rate is 510kB/s. @@ -5215,7 +5215,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speedThis drive is used in Hewlett-Packard's SureStore 6000eU and 6000i tape drives and C1533A DDS-2 DAT drive. - The drive has a block of 8 dip switches. The proper + The drive has a block of 8 dip switches. The proper settings for FreeBSD are: 1 ON; 2 ON; 3 OFF; 4 ON; 5 ON; 6 ON; 7 ON; 8 ON. @@ -5261,11 +5261,11 @@ options "TUNE_1542" #dynamic tune of bus DMA speed - Switch 3 controls MRS (Media Recognition System). MRS - tapes have stripes on the transparent leader. These identify - the tape as DDS (Digital Data Storage) grade media. Tapes + Switch 3 controls MRS (Media Recognition System). MRS + tapes have stripes on the transparent leader. These identify + the tape as DDS (Digital Data Storage) grade media. Tapes that do not have the stripes will be treated as - write-protected. Switch 3 OFF enables MRS. Switch 3 ON + write-protected. Switch 3 OFF enables MRS. Switch 3 ON disables MRS. See HP @@ -5273,8 +5273,8 @@ options "TUNE_1542" #dynamic tune of bus DMA speedHewlett-Packard Disk and Tape Technical Information for more information on configuring this drive. Warning: Quality control on these - drives varies greatly. One FreeBSD core-team member has - returned 2 of these drives. Neither lasted more than 5 + drives varies greatly. One FreeBSD core-team member has + returned 2 of these drives. Neither lasted more than 5 months. Reported by: &a.se; @@ -5288,7 +5288,7 @@ options "TUNE_1542" #dynamic tune of bus DMA speed type 1 removable SCSI 2 Sequential-Access density code 0x13, variable blocks. - This is a DDS-1 tape drive. DDS-1 is the original DAT + This is a DDS-1 tape drive. DDS-1 is the original DAT tape format. Native capacity is 2GB when using 90m tapes. @@ -5302,12 +5302,12 @@ options "TUNE_1542" #dynamic tune of bus DMA speed The HP C1534A DDS format DAT drive has two indicator - lights, one green and one amber. The green one indicates tape + lights, one green and one amber. The green one indicates tape action: slow flash during load, steady when loaded, fast flash - during read/write operations. The amber one indicates + during read/write operations. The amber one indicates warnings: slow flash when cleaning is required or tape is nearing the end of its useful life, steady indicates an hard - fault. (factory service required?) + fault. (factory service required?) Reported by Gary Crutcher gcrutchr@nightflight.com @@ -5318,11 +5318,11 @@ options "TUNE_1542" #dynamic tune of bus DMA speedThe boot message identifier for this drive is "". - This is a DDS-2 tape drive with a tape changer. DDS-2 + This is a DDS-2 tape drive with a tape changer. DDS-2 means hardware data compression and narrower tracks for increased data capacity. - Native capacity is 24GB when using 120m tapes. This drive + Native capacity is 24GB when using 120m tapes. This drive supports hardware data compression. Data transfer rate is 510kB/s (native). @@ -5331,15 +5331,15 @@ options "TUNE_1542" #dynamic tune of bus DMA speed12000e tape drive. - The drive has two selectors on the rear panel. The - selector closer to the fan is SCSI id. The other selector + The drive has two selectors on the rear panel. The + selector closer to the fan is SCSI id. The other selector should be set to 7. - There are four internal switches. These should be set: 1 + There are four internal switches. These should be set: 1 ON; 2 ON; 3 ON; 4 OFF. At present the kernel drivers do not automatically change - tapes at the end of a volume. This shell script can be used + tapes at the end of a volume. This shell script can be used to change tapes: @@ -5389,7 +5389,7 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" -A C620 type 1 removable SCSI 2 Sequential-Access density code 0x13 - This is a DDS-1 tape drive. DDS-1 is the original DAT + This is a DDS-1 tape drive. DDS-1 is the original DAT tape format. Native capacity is 1.2GB. @@ -5407,7 +5407,7 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" The boot message identifier for this drive is HP HP35470A 9 09 type 1 removable SCSI 2 - This is a DDS-1 tape drive. DDS-1 is the original DAT + This is a DDS-1 tape drive. DDS-1 is the original DAT tape format. Native capacity is 2GB when using 90m tapes. @@ -5421,8 +5421,8 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" DAT drive, and HP C1536A DDS format DAT drive. Warning: Quality control on these - drives varies greatly. One FreeBSD core-team member has - returned 5 of these drives. None lasted more than 9 + drives varies greatly. One FreeBSD core-team member has + returned 5 of these drives. None lasted more than 9 months. Reported by: David Dawes dawes@rf900.physics.usyd.edu.au @@ -5437,13 +5437,13 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" 1009 type 1 removable SCSI 2 Sequential-Access density code 0x13. - This is a DDS-DC tape drive. DDS-DC is DDS-1 with - hardware data compression. DDS-1 is the original DAT tape + This is a DDS-DC tape drive. DDS-DC is DDS-1 with + hardware data compression. DDS-1 is the original DAT tape format. - Native capacity is 2GB when using 90m tapes. It cannot - handle 120m tapes. This drive supports hardware data - compression. Please refer to the section on Native capacity is 2GB when using 90m tapes. It cannot + handle 120m tapes. This drive supports hardware data + compression. Please refer to the section on HP C1533A for the proper switch settings. @@ -5460,10 +5460,10 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" Pressing the front panel button will eject the tape and bring the tape drive back to life. - WARNING: HP 35480-03110 only. On at least two occasions + WARNING: HP 35480-03110 only. On at least two occasions this tape drive when used with FreeBSD 2.1.0, an IBM Server 320 and an 2940W SCSI controller resulted in all SCSI disk - partitions being lost. The problem has not be analyzed or + partitions being lost. The problem has not be analyzed or resolved at this time. @@ -5473,21 +5473,21 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" URL="http://www.sel.sony.com/SEL/ccpg/storage/tape/t5000.html">Sony SDT-5000 There are at least two significantly different models: one - is a DDS-1 and the other DDS-2. The DDS-1 version is - SDT-5000 3.02. The DDS-2 version is SONY SDT-5000 327M. - The DDS-2 version has a 1MB cache. This cache is able to keep + is a DDS-1 and the other DDS-2. The DDS-1 version is + SDT-5000 3.02. The DDS-2 version is SONY SDT-5000 327M. + The DDS-2 version has a 1MB cache. This cache is able to keep the tape streaming in almost any circumstances. The boot message identifier for this drive is SONY SDT-5000 3.02 type 1 removable SCSI 2 Sequential-Access density code 0x13 - Native capacity is 4GB when using 120m tapes. This drive + Native capacity is 4GB when using 120m tapes. This drive supports hardware data compression. Data transfer rate is depends upon the model or the drive. The rate is 630kB/s for the SONY SDT-5000 327M while - compressing the data. For the SONY SDT-5000 3.02, the data + compressing the data. For the SONY SDT-5000 3.02, the data transfer rate is 225kB/s. In order to get this drive to stream, set the blocksize to @@ -5513,13 +5513,13 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" Native capacity is 150/250MB. This drive has quirks which are known and work around code - is present in the scsi tape device driver (st4). Upgrading the firmware to XXX + is present in the scsi tape device driver (st4). Upgrading the firmware to XXX version will fix the quirks and provide SCSI 2 capabilities. Data transfer rate is 80kB/s. - IBM and Emerald units will not work. Replacing the + IBM and Emerald units will not work. Replacing the firmware EPROM of these units will solve the problem. Reported by: Michael Smith @@ -5546,14 +5546,14 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" This is a QIC tape drive. - Native capacity is 2.5GB. The drive will read all + Native capacity is 2.5GB. The drive will read all cartridges from the 60 MB (DC600A) upwards, and write 150 MB - (DC6150) upwards. Hardware compression is optionally + (DC6150) upwards. Hardware compression is optionally supported for the 2.5 GB cartridges. This drives quirks are known and pre-compiled into the scsi tape device driver (st4) - beginning with FreeBSD 2.2-current. For previous versions of + beginning with FreeBSD 2.2-current. For previous versions of FreeBSD, use mt to read one block from the tape, rewind the tape, and then execute the backup program (mt fsr 1; mt rewind; dump @@ -5580,9 +5580,9 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" Data transfer rate is 180kB/s. - The drive reads 60, 120, 150, and 525MB tapes. The drive - will not write 60MB (DC600 cartridge) tapes. In order to - overwrite 120 and 150 tapes reliably, first erase (mt erase) the tape. 120 and 150 tapes + The drive reads 60, 120, 150, and 525MB tapes. The drive + will not write 60MB (DC600 cartridge) tapes. In order to + overwrite 120 and 150 tapes reliably, first erase (mt erase) the tape. 120 and 150 tapes used a wider track (fewer tracks per tape) than 525MB tapes. The “extra” width of the previous tracks is not overwritten, as a result the new data lies in a band surrounded on both @@ -5635,9 +5635,9 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" Jordan's Picks Generally speaking those in The FreeBSD Project prefer SCSI CDROM drives over IDE CDROM - drives. However not all SCSI CDROM drives are equal. Some feel + drives. However not all SCSI CDROM drives are equal. Some feel the quality of some SCSI CDROM drives have been deteriorating to - that of IDE CDROM drives. Toshiba used to be the favored + that of IDE CDROM drives. Toshiba used to be the favored stand-by, but many on the SCSI mailing list have found displeasure with the 12x speed XM-5701TA as its volume (when playing audio CDROMs) is not controllable by the various audio player @@ -5648,7 +5648,7 @@ scsi -f $2 -s 100 -c "1b 0 0 $cdb3 $cdb4 $cdb5" SCSI specification. Many SCSI CDROMs will respond to multiple LUNs for its - target address. Known violators include the 6x Teac CD-56S + target address. Known violators include the 6x Teac CD-56S 1.0D. diff --git a/en_US.ISO_8859-1/books/handbook/install/chapter.sgml b/en_US.ISO_8859-1/books/handbook/install/chapter.sgml index e26e9dcf6e..1541acfb01 100644 --- a/en_US.ISO_8859-1/books/handbook/install/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/install/chapter.sgml @@ -2,18 +2,18 @@ Installing FreeBSD So, you would like to try out FreeBSD on your system? This section - is a quick-start guide for what you need to do. FreeBSD can be + is a quick-start guide for what you need to do. FreeBSD can be installed from a variety of media including CD-ROM, floppy disk, magnetic tape, an MS-DOS partition and, if you have a network connection, via anonymous ftp or NFS. Regardless of the installation media you choose, you can get started by creating the installation - disks as described below. Booting your computer into the + disks as described below. Booting your computer into the FreeBSD installer, even if you aren't planning on installing FreeBSD right away, will provide important information about compatibility between FreeBSD and your hardware which may, in turn, dictate which - installation options are even possible. It can also provide early + installation options are even possible. It can also provide early clues to any compatibility problems which could prevent FreeBSD running on your system at all. @@ -35,9 +35,9 @@ Review the supported configurations section of this installation guide to be sure - that your hardware is supported by FreeBSD. It may be helpful + that your hardware is supported by FreeBSD. It may be helpful to make a list of any special cards you have installed, such as - SCSI controllers, Ethernet adapters or sound cards. This list + SCSI controllers, Ethernet adapters or sound cards. This list should include relevant configuration parameters such as interrupts (IRQ) and IO port addresses. @@ -58,7 +58,7 @@ If you're running DOS and have the proper drivers to access your CD, run the install.bat script provided on the - CD. This will attempt to boot into the FreeBSD + CD. This will attempt to boot into the FreeBSD installation straight from DOS. @@ -130,16 +130,16 @@ With the kern.flp in the A: drive, reboot your - computer. The next request you should get is for the + computer. The next request you should get is for the mfsroot.flp floppy, after which the installation will proceed normally. If you do not type anything at the boot prompt which appears during this process, FreeBSD will automatically boot with its default - configuration after a delay of about five seconds. As FreeBSD + configuration after a delay of about five seconds. As FreeBSD boots, it probes your computer to determine what hardware is - installed. The results of this probing is displayed on the + installed. The results of this probing is displayed on the screen. @@ -153,7 +153,7 @@ If something goes wrong… Due to limitations of the PC architecture, it is impossible for - probing to be 100 percent reliable. In the event that your hardware + probing to be 100 percent reliable. In the event that your hardware is incorrectly identified, or that the probing causes your computer to lock up, first check the supported configurations @@ -163,24 +163,24 @@ If your hardware is supported, reset the computer and when the visual kernel configuration choice is presented, take it. This puts FreeBSD into a configuration mode - where you can supply hints about your hardware. The FreeBSD kernel on + where you can supply hints about your hardware. The FreeBSD kernel on the installation disk is configured assuming that most hardware devices are in their factory default configuration in terms of IRQs, - IO addresses and DMA channels. If your hardware has been + IO addresses and DMA channels. If your hardware has been reconfigured, you will most likely need to use the configuration editor to tell FreeBSD where things are. It is also possible that a probe for a device not present will - cause a later probe for another device that is present to fail. In + cause a later probe for another device that is present to fail. In that case, the probes for the conflicting driver(s) should be disabled. Do not disable any device you will need during installation, such - as your screen (sc0). If the installation + as your screen (sc0). If the installation wedges or fails mysteriously after leaving the configuration editor, you have probably removed or changed something that you should not - have. Simply reboot and try again. + have. Simply reboot and try again. In the configuration mode, you can: @@ -211,8 +211,8 @@ After FreeBSD has been installed, changes made in the configuration mode will be permanent so you do not have to reconfigure - every time you boot. Even so, it is likely that you will want to - build a custom kernel to optimize the performance of your system. See + every time you boot. Even so, it is likely that you will want to + build a custom kernel to optimize the performance of your system. See Kernel configuration for more information on creating custom kernels. @@ -223,7 +223,7 @@ FreeBSD currently runs on a wide variety of ISA, VLB, EISA and PCI bus based PC's, ranging from 386sx to Pentium class machines - (though the 386sx is not recommended). Support for generic IDE or + (though the 386sx is not recommended). Support for generic IDE or ESDI drive configurations, various SCSI controller, network and serial cards is also provided. @@ -232,7 +232,7 @@ recommended minimum. Following is a list of all disk controllers and Ethernet cards - currently known to work with FreeBSD. Other configurations may very + currently known to work with FreeBSD. Other configurations may very well work, and we have simply not received any indication of this. @@ -298,11 +298,11 @@ You cannot boot from the SoundBlaster cards as they have no on-board BIOS, which is necessary for mapping the boot device into the system BIOS - I/O vectors. They are perfectly usable for external tapes, - CDROMs, etc, however. The same goes for any other AIC-6x60 - based card without a boot ROM. Some systems DO have a boot + I/O vectors. They are perfectly usable for external tapes, + CDROMs, etc, however. The same goes for any other AIC-6x60 + based card without a boot ROM. Some systems DO have a boot ROM, which is generally indicated by some sort of message - when the system is first powered up or reset. Check your + when the system is first powered up or reset. Check your system/board documentation for more details. @@ -414,7 +414,7 @@ SMC Elite 16 WD8013 Ethernet interface, and most other WD8003E, WD8003EBT, WD8003W, WD8013W, WD8003S, WD8003SBT and - WD8013EBT based clones. SMC Elite Ultra and 9432TX based + WD8013EBT based clones. SMC Elite Ultra and 9432TX based cards are also supported. @@ -581,7 +581,7 @@ FreeBSD does not currently support - PnP (plug-n-play) features present on some ethernet cards. If + PnP (plug-n-play) features present on some ethernet cards. If your card has PnP and is giving you problems, try disabling its PnP features. @@ -678,7 +678,7 @@ Preparing for the Installation There are a number of different methods by which FreeBSD can be - installed. The following describes what preparation needs to be + installed. The following describes what preparation needs to be done for each type. @@ -703,11 +703,11 @@ If you are creating the boot floppies from a UNIX machine, see the beginning of this - guide for examples. of how to create the boot floppies. + guide for examples. of how to create the boot floppies. Once you have booted from DOS or floppy, you should then be able to select CDROM as the media type in the Media menu and load - the entire distribution from CDROM. No other types of + the entire distribution from CDROM. No other types of installation media should be required. After your system is fully installed and you have rebooted @@ -715,12 +715,12 @@ mount /cdrom Before removing the CD again, also note that it is necessary - to first type: umount /cdrom. Do not just + to first type: umount /cdrom. Do not just remove it from the drive! Before invoking the installation, be sure that the CDROM is - in the drive so that the install probe can find it. This is + in the drive so that the install probe can find it. This is also true if you wish the CDROM to be added to the default system configuration automatically during the install (whether or not you actually use it as the installation media). @@ -728,7 +728,7 @@ Finally, if you would like people to be able to FTP install FreeBSD directly from the CDROM in your machine, you will find it - quite easy. After the machine is fully installed, you simply need + quite easy. After the machine is fully installed, you simply need to add the following line to the password file (using the vipw command): @@ -753,20 +753,20 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent You will need, at minimum, as many 1.44MB or 1.2MB floppies as it takes to hold all files in the bin (binary distribution) - directory. If you are preparing these floppies under DOS, then + directory. If you are preparing these floppies under DOS, then THESE floppies must be formatted using the MS-DOS FORMAT - command. If you are using Windows, use the Windows File Manager + command. If you are using Windows, use the Windows File Manager format command. Do not trust Factory Preformatted - floppies! Format them again yourself, just to make sure. Many + floppies! Format them again yourself, just to make sure. Many problems reported by our users in the past have resulted from the use of improperly formatted media, which is why I am taking such special care to mention it here! If you are creating the floppies from another FreeBSD machine, a format is still not a bad idea though you do not need to put a - DOS filesystem on each floppy. You can use the disklabel and + DOS filesystem on each floppy. You can use the disklabel and newfs commands to put a UFS filesystem on them instead, as the following sequence of commands (for a 3.5" 1.44MB floppy disk) illustrates: @@ -789,11 +789,11 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent system. After you have formatted the floppies, you will need to copy - the files onto them. The distribution files are split into chunks + the files onto them. The distribution files are split into chunks conveniently sized so that 5 of them will fit on a conventional - 1.44MB floppy. Go through all your floppies, packing as many + 1.44MB floppy. Go through all your floppies, packing as many files as will fit on each one, until you have got all the - distributions you want packed up in this fashion. Each + distributions you want packed up in this fashion. Each distribution should go into a subdirectory on the floppy, e.g.: a:\bin\bin.aa, a:\bin\bin.ab, and so on. @@ -808,7 +808,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent To prepare for installation from an MS-DOS partition, copy the files from the distribution into a directory called - C:\FREEBSD. The directory tree structure of + C:\FREEBSD. The directory tree structure of the CDROM must be partially reproduced within this directory so we suggest using the DOS xcopy command. For example, to prepare for a minimal installation of FreeBSD: @@ -834,7 +834,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent Before installing from QIC/SCSI Tape Installing from tape is probably the easiest method, short of - an on-line install using FTP or a CDROM install. The installation + an on-line install using FTP or a CDROM install. The installation program expects the files to be simply tar'ed onto the tape, so after getting all of the files for distribution you are interested in, simply tar them onto the tape with a command like: @@ -849,7 +849,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent that you leave enough room in some temporary directory (which you will be allowed to choose) to accommodate the full contents of the tape you have created. Due to the non-random access nature of tapes, this method of - installation requires quite a bit of temporary storage. You + installation requires quite a bit of temporary storage. You should expect to require as much temporary storage as you have stuff written on tape. @@ -895,28 +895,28 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent SLIP support is rather primitive, and limited primarily to hard-wired links, such as a serial cable running between a laptop - computer and another computer. The link should be hard-wired as + computer and another computer. The link should be hard-wired as the SLIP installation does not currently offer a dialing capability; that facility is provided with the PPP utility, which should be used in preference to SLIP whenever possible. If you are using a modem, then PPP is almost certainly your - only choice. Make sure that you have your service provider's + only choice. Make sure that you have your service provider's information handy as you will need to know it fairly soon in the - installation process. You will need to know how to dial your ISP + installation process. You will need to know how to dial your ISP using the “AT commands” specific to your modem, as the PPP - dialer provides only a very simple terminal emulator. If you're + dialer provides only a very simple terminal emulator. If you're using PAP or CHAP, you'll need to type the necessary set authname and set authkey commands before typing term. Refer to the user-ppp handbook and FAQ entries for - further information. If you have problems, logging can be + further information. If you have problems, logging can be directed to the screen using the command set log local .... If a hard-wired connection to another FreeBSD (2.0R or later) machine is available, you might also consider installing over a - “laplink” parallel port cable. The data rate over the parallel + “laplink” parallel port cable. The data rate over the parallel port is much higher than what is typically possible over a serial line (up to 50k/sec), thus resulting in a quicker installation. @@ -926,7 +926,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent common PC ethernet cards, a table of supported cards (and their required settings) is provided in Supported - Hardware. If you are using one of the supported PCMCIA + Hardware. If you are using one of the supported PCMCIA ethernet cards, also be sure that it is plugged in before the laptop is powered on! FreeBSD does not, unfortunately, currently support hot insertion of PCMCIA @@ -934,12 +934,12 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent You will also need to know your IP address on the network, the netmask value for your address class, and the name of your - machine. Your system administrator can tell you which values to - use for your particular network setup. If you will be referring + machine. Your system administrator can tell you which values to + use for your particular network setup. If you will be referring to other hosts by name rather than IP address, you will also need a name server and possibly the address of a gateway (if you are using PPP, it is your provider's IP address) to use in talking to - it. If you do not know the answers to all or most of these + it. If you do not know the answers to all or most of these questions, then you should really probably talk to your system administrator first before trying this type of installation. @@ -974,8 +974,8 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent /usr/archive/stuff. In FreeBSD's /etc/exports file, this is - controlled by the option. Other - NFS servers may have different conventions. If you are getting + controlled by the option. Other + NFS servers may have different conventions. If you are getting Permission Denied messages from the server then it is likely that you do not have this enabled properly. @@ -985,14 +985,14 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent Preparing for FTP Installation FTP installation may be done from any mirror site containing - a reasonably up-to-date version of FreeBSD &rel.current;. A + a reasonably up-to-date version of FreeBSD &rel.current;. A full menu of reasonable choices from almost anywhere in the world is provided by the FTP site menu. If you are installing from some other FTP site not listed in this menu, or you are having troubles getting your name server configured properly, you can also specify your own URL by - selecting the “Other” choice in that menu. A URL can also be + selecting the “Other” choice in that menu. A URL can also be a direct IP address, so the following would work in the absence of a name server: @@ -1008,7 +1008,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent FTP Active - For all FTP transfers, use “Active” mode. This + For all FTP transfers, use “Active” mode. This will not work through firewalls, but will often work with older ftp servers that do not support passive mode. If your connection hangs with passive mode (the @@ -1019,7 +1019,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent FTP Passive - For all FTP transfers, use “Passive” mode. This + For all FTP transfers, use “Passive” mode. This allows the user to pass through firewalls that do not allow incoming connections on random port addresses. @@ -1036,13 +1036,13 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent For a proxy FTP server, you should usually give name of the server you really want as a part of the username, after an - @-sign. The proxy server then 'fakes' the real server. An + @-sign. The proxy server then 'fakes' the real server. An example: Say you want to install from ftp.freebsd.org, using the proxy FTP server foo.bar.com, listening on port 1234. In this case, you go to the options menu, set the FTP username to ftp@ftp.freebsd.org, and the password to your e-mail - address. As your installation media, you specify FTP (or + address. As your installation media, you specify FTP (or passive FTP, if the proxy support it), and the URL @@ -1076,10 +1076,10 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent The FreeBSD boot floppies contain all the on-line documentation you should need to be able to navigate through an installation and if it does not then we would like to know what you found most - confusing. Send your comments to the &a.doc;. It is the objective + confusing. Send your comments to the &a.doc;. It is the objective of the FreeBSD installation program (sysinstall) to be self-documenting enough that painful “step-by-step” guides are no - longer necessary. It may take us a little while to reach that + longer necessary. It may take us a little while to reach that objective, but that is the objective! Meanwhile, you may also find the following “typical @@ -1091,17 +1091,17 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent Boot the kern.flp floppy and, when asked, remove it and insert the - mfsroot.flp floppy and hit return.. After a boot sequence which can + mfsroot.flp floppy and hit return. After a boot sequence which can take anywhere from 30 seconds to 3 minutes, depending on your hardware, you should be presented with a menu of initial - choices. If the kern.flp floppy does not boot at all, or the boot + choices. If the kern.flp floppy does not boot at all, or the boot hangs at some stage, go read the Q&A section of the Hardware Guide for possible causes. - Press F1. You should see some basic usage instructions on - the menu system and general navigation. If you have not used + Press F1. You should see some basic usage instructions on + the menu system and general navigation. If you have not used this menu system before then please read this thoroughly! @@ -1116,17 +1116,17 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent through a typical installation, give you a high degree of control over each step of the installation or simply whizz through it (using reasonable defaults when possible) as fast - as possible. If you have never used FreeBSD before then the + as possible. If you have never used FreeBSD before then the Novice installation method is most recommended. The final configuration menu choice allows you to further configure your FreeBSD installation by giving you menu-driven - access to various system defaults. Some items, like + access to various system defaults. Some items, like networking, may be especially important if you did a CDROM/Tape/Floppy installation and have not yet configured - your network interfaces (assuming you have any). Properly + your network interfaces (assuming you have any). Properly configuring such interfaces here will allow FreeBSD to come up on the network when you first reboot from the hard disk. @@ -1141,7 +1141,7 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent MS-DOS User's Questions and Answers Many FreeBSD users wish to install FreeBSD on PCs inhabited by - MS-DOS. Here are some commonly asked questions about installing + MS-DOS. Here are some commonly asked questions about installing FreeBSD on such systems. Help! I have no space! Do I need to delete @@ -1154,11 +1154,11 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent FIPS allows you to split an existing MS-DOS partition into two pieces, preserving the original partition and allowing you to - install onto the second free piece. You first defragment your + install onto the second free piece. You first defragment your MS-DOS partition, using the DOS 6.xx DEFRAG utility or the Norton - Disk tools, then run FIPS. It will prompt you for the rest of the - information it needs. Afterwards, you can reboot and install - FreeBSD on the new free slice. See the + Disk tools, then run FIPS. It will prompt you for the rest of the + information it needs. Afterwards, you can reboot and install + FreeBSD on the new free slice. See the Distributions menu for an estimation of how much free space you will need for the kind of installation you want. @@ -1166,11 +1166,11 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent Can I use compressed MS-DOS filesystems from FreeBSD? - No. If you are using a utility such as Stacker(tm) or + No. If you are using a utility such as Stacker(tm) or DoubleSpace(tm), FreeBSD will only be able to use whatever portion - of the filesystem you leave uncompressed. The rest of the + of the filesystem you leave uncompressed. The rest of the filesystem will show up as one large file (the stacked/dblspaced - file!). Do not remove that file! You + file!). Do not remove that file! You will probably regret it greatly! It is probably better to create another uncompressed MS-DOS @@ -1180,11 +1180,11 @@ ftp:*:99:99::0:0:FTP:/cdrom:/nonexistent Can I mount my MS-DOS extended partitions? - Yes. DOS extended partitions are mapped in at the end of the - other “slices” in FreeBSD, e.g. your D: drive might be /dev/sd0s5, - your E: drive /dev/sd0s6, and so on. This example assumes, of - course, that your extended partition is on SCSI drive 0. For IDE - drives, substitute wd for sd appropriately. You otherwise + Yes. DOS extended partitions are mapped in at the end of the + other “slices” in FreeBSD, e.g. your D: drive might be /dev/sd0s5, + your E: drive /dev/sd0s6, and so on. This example assumes, of + course, that your extended partition is on SCSI drive 0. For IDE + drives, substitute wd for sd appropriately. You otherwise mount extended partitions exactly like you would mount any other DOS drive, e.g.: diff --git a/en_US.ISO_8859-1/books/handbook/internals/chapter.sgml b/en_US.ISO_8859-1/books/handbook/internals/chapter.sgml index c16680a0b3..d02a3473df 100644 --- a/en_US.ISO_8859-1/books/handbook/internals/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/internals/chapter.sgml @@ -11,7 +11,7 @@ Booting FreeBSD is essentially a three step process: load the kernel, determine the root filesystem and initialize user-land - things. This leads to some interesting possibilities shown + things. This leads to some interesting possibilities shown below. @@ -26,7 +26,7 @@ Biosboot - Biosboot is our “bootblocks”. It consists of two + Biosboot is our “bootblocks”. It consists of two files which will be installed in the first 8Kbytes of the floppy or hard-disk slice to be booted from. @@ -38,13 +38,13 @@ Dosboot - Dosboot was written by DI. Christian Gusenbauer, and + Dosboot was written by DI. Christian Gusenbauer, and is unfortunately at this time one of the few pieces of code that will not compile under FreeBSD itself because it is written for Microsoft compilers. Dosboot will boot the kernel from a MS-DOS file or - from a FreeBSD filesystem partition on the disk. It + from a FreeBSD filesystem partition on the disk. It attempts to negotiate with the various and strange kinds of memory manglers that lurk in high memory on MS/DOS systems and usually wins them for its case. @@ -80,7 +80,7 @@ UFS - This is the most normal type of root filesystem. It + This is the most normal type of root filesystem. It can reside on a floppy or on hard disk. @@ -99,7 +99,7 @@ This is actually a UFS filesystem which has been - compiled into the kernel. That means that the kernel does + compiled into the kernel. That means that the kernel does not really need any hard disks, floppies or other hardware to function. @@ -137,8 +137,8 @@ /sbin/init, as long as you keep in mind that: - there is no stdin/out/err unless you open it yourself. If you - exit, the machine panics. Signal handling is special for + there is no stdin/out/err unless you open it yourself. If you + exit, the machine panics. Signal handling is special for pid == 1. An example of this is the @@ -259,16 +259,16 @@ It then loads the first 15 sectors at 0x10000 (segment BOOTSEG in the biosboot Makefile), and sets up the stack to - work below 0x1fff0. After this, it jumps to the - entry of boot2 within that code. I.e., it jumps over itself and the + work below 0x1fff0. After this, it jumps to the + entry of boot2 within that code. I.e., it jumps over itself and the (dummy) partition table, and it is going to adjust the %cs selector—we are still in 16-bit mode there. boot2 asks for the boot file, and examines the - a.out header. It masks the file entry point + a.out header. It masks the file entry point (usually 0xf0100000) by - 0x00ffffff, and loads the file there. Hence the - usual load point is 1 MB (0x00100000). During + 0x00ffffff, and loads the file there. Hence the + usual load point is 1 MB (0x00100000). During load, the boot code toggles back and forth between real and protected mode, to use the BIOS in real mode. @@ -276,11 +276,11 @@ 0x18 and 0x20 for %cs and %ds/%es in protected mode, and 0x28 to jump back into real - mode. The kernel is finally started with %cs 0x08 and + mode. The kernel is finally started with %cs 0x08 and %ds/%es/%ss 0x10, which refer to dummy descriptors covering the entire address space. - The kernel will be started at its load point. Since it has been + The kernel will be started at its load point. Since it has been linked for another (high) address, it will have to execute PIC until the page table and page directory stuff is setup properly, at which point paging will be enabled and the kernel will finally run at the @@ -290,7 +290,7 @@ 1995. The physical pages immediately following the kernel BSS contain - proc0's page directory, page tables, and upages. Some time later + proc0's page directory, page tables, and upages. Some time later when the VM system is initialized, the physical memory between 0x1000-0x9ffff and the physical memory after the kernel (text+data+bss+proc0 stuff+other misc) is made available in @@ -303,7 +303,7 @@ DMA: What it Is and How it Works Copyright © 1995,1997 &a.uhclem;, All Rights - Reserved. 10 December 1996. Last Update 8 October + Reserved. 10 December 1996. Last Update 8 October 1997. Direct Memory Access (DMA) is a method of allowing data to be @@ -319,25 +319,25 @@ The PC DMA subsystem is based on the Intel 8237 DMA controller. The 8237 contains four DMA channels that can be programmed independently and any one of the channels may be active at any - moment. These channels are numbered 0, 1, 2 and 3. Starting with + moment. These channels are numbered 0, 1, 2 and 3. Starting with the PC/AT, IBM added a second 8237 chip, and numbered those channels 4, 5, 6 and 7. The original DMA controller (0, 1, 2 and 3) moves one byte in - each transfer. The second DMA controller (4, 5, 6, and 7) moves + each transfer. The second DMA controller (4, 5, 6, and 7) moves 16-bits from two adjacent memory locations in each transfer, with - the first byte always coming from an even-numbered address. The two + the first byte always coming from an even-numbered address. The two controllers are identical components and the difference in transfer size is caused by the way the second controller is wired into the system. The 8237 has two electrical signals for each channel, named DRQ - and -DACK. There are additional signals with the names HRQ (Hold + and -DACK. There are additional signals with the names HRQ (Hold Request), HLDA (Hold Acknowledge), -EOP (End of Process), and the bus control signals -MEMR (Memory Read), -MEMW (Memory Write), -IOR (I/O Read), and -IOW (I/O Write). - The 8237 DMA is known as a “fly-by” DMA controller. This + The 8237 DMA is known as a “fly-by” DMA controller. This means that the data being moved from one location to another does not pass through the DMA chip and is not stored in the DMA chip. Subsequently, the DMA can only transfer data between an I/O port and @@ -361,24 +361,24 @@ A Sample DMA transfer Here is an example of the steps that occur to cause and - perform a DMA transfer. In this example, the floppy disk + perform a DMA transfer. In this example, the floppy disk controller (FDC) has just read a byte from a diskette and wants - the DMA to place it in memory at location 0x00123456. The process + the DMA to place it in memory at location 0x00123456. The process begins by the FDC asserting the DRQ2 signal (the DRQ line for DMA channel 2) to alert the DMA controller. The DMA controller will note that the DRQ2 signal is asserted. The DMA controller will then make sure that DMA channel 2 has been - programmed and is unmasked (enabled). The DMA controller also + programmed and is unmasked (enabled). The DMA controller also makes sure that none of the other DMA channels are active or want - to be active and have a higher priority. Once these checks are + to be active and have a higher priority. Once these checks are complete, the DMA asks the CPU to release the bus so that the DMA - may use the bus. The DMA requests the bus by asserting the HRQ + may use the bus. The DMA requests the bus by asserting the HRQ signal which goes to the CPU. The CPU detects the HRQ signal, and will complete executing - the current instruction. Once the processor has reached a state - where it can release the bus, it will. Now all of the signals + the current instruction. Once the processor has reached a state + where it can release the bus, it will. Now all of the signals normally generated by the CPU (-MEMR, -MEMW, -IOR, -IOW and a few others) are placed in a tri-stated condition (neither high or low) and then the CPU asserts the HLDA signal which tells the DMA @@ -397,12 +397,12 @@ location. The DMA will then let the device that requested the DMA - transfer know that the transfer is commencing. This is done by + transfer know that the transfer is commencing. This is done by asserting the -DACK signal, or in the case of the floppy disk controller, -DACK2 is asserted. The floppy disk controller is now responsible for placing the - byte to be transferred on the bus Data lines. Unless the floppy + byte to be transferred on the bus Data lines. Unless the floppy controller needs more time to get the data byte on the bus (and if the peripheral does need more time it alerts the DMA via the READY signal), the DMA will wait one DMA clock, and then de-assert the @@ -412,22 +412,22 @@ Since the DMA cycle only transfers a single byte at a time, the FDC now drops the DRQ2 signal, so the DMA knows that it is no - longer needed. The DMA will de-assert the -DACK2 signal, so that + longer needed. The DMA will de-assert the -DACK2 signal, so that the FDC knows it must stop placing data on the bus. The DMA will now check to see if any of the other DMA channels - have any work to do. If none of the channels have their DRQ lines + have any work to do. If none of the channels have their DRQ lines asserted, the DMA controller has completed its work and will now tri-state the -MEMR, -MEMW, -IOR, -IOW and address signals. - Finally, the DMA will de-assert the HRQ signal. The CPU sees - this, and de-asserts the HOLDA signal. Now the CPU activates its + Finally, the DMA will de-assert the HRQ signal. The CPU sees + this, and de-asserts the HOLDA signal. Now the CPU activates its -MEMR, -MEMW, -IOR, -IOW and address lines, and it resumes executing instructions and accessing main memory and the peripherals. For a typical floppy disk sector, the above process is - repeated 512 times, once for each byte. Each time a byte is + repeated 512 times, once for each byte. Each time a byte is transferred, the address register in the DMA is incremented and the counter in the DMA that shows how many bytes are to be transferred is decremented. @@ -435,7 +435,7 @@ When the counter reaches zero, the DMA asserts the EOP signal, which indicates that the counter has reached zero and no more data will be transferred until the DMA controller is reprogrammed by - the CPU. This event is also called the Terminal Count (TC). + the CPU. This event is also called the Terminal Count (TC). There is only one EOP signal, and since only DMA channel can be active at any instant, the DMA channel that is currently active must be the DMA channel that just completed its task. @@ -446,10 +446,10 @@ When that happens, it means the DMA will not transfer any more information for that peripheral without intervention by the CPU. The peripheral can then assert one of the interrupt signals to get - the processors' attention. In the PC architecture, the DMA chip - itself is not capable of generating an interrupt. The peripheral + the processors' attention. In the PC architecture, the DMA chip + itself is not capable of generating an interrupt. The peripheral and its associated hardware is responsible for generating any - interrupt that occurs. Subsequently, it is possible to have a + interrupt that occurs. Subsequently, it is possible to have a peripheral that uses DMA but does not use interrupts. It is important to understand that although the CPU always @@ -470,53 +470,53 @@ You may have noticed earlier that instead of the DMA setting the address lines to 0x00123456 as we said earlier, the DMA only - set 0x3456. The reason for this takes a bit of explaining. + set 0x3456. The reason for this takes a bit of explaining. When the original IBM PC was designed, IBM elected to use both DMA and interrupt controller chips that were designed for use with the 8085, an 8-bit processor with an address space of 16 bits - (64K). Since the IBM PC supported more than 64K of memory, + (64K). Since the IBM PC supported more than 64K of memory, something had to be done to allow the DMA to read or write memory - locations above the 64K mark. What IBM did to solve this problem + locations above the 64K mark. What IBM did to solve this problem was to add an external data latch for each DMA channel that holds the upper bits of the address to be read to or written from. Whenever a DMA channel is active, the contents of that latch are written to the address bus and kept there until the DMA operation - for the channel ends. IBM called these latches “Page + for the channel ends. IBM called these latches “Page Registers”. So for our example above, the DMA would put the 0x3456 part of the address on the bus, and the Page Register for DMA channel 2 - would put 0x0012xxxx on the bus. Together, these two values form + would put 0x0012xxxx on the bus. Together, these two values form the complete address in memory that is to be accessed. Because the Page Register latch is independent of the DMA chip, the area of memory to be read or written must not span a 64K - physical boundary. For example, if the DMA accesses memory + physical boundary. For example, if the DMA accesses memory location 0xffff, after that transfer the DMA will then increment the address register and the DMA will access the next byte at - location 0x0000, not 0x10000. The results of letting this happen + location 0x0000, not 0x10000. The results of letting this happen are probably not intended. “Physical” 64K boundaries should not be confused with 8086-mode 64K “Segments”, which are created by mathematically adding a segment register with an - offset register. Page Registers have no address overlap and are + offset register. Page Registers have no address overlap and are mathematically OR-ed together. To further complicate matters, the external DMA address latches on the PC/AT hold only eight bits, so that gives us 8+16=24 bits, which means that the DMA can only point at memory - locations between 0 and 16Meg. For newer computers that allow + locations between 0 and 16Meg. For newer computers that allow more than 16Meg of memory, the standard PC-compatible DMA cannot access memory locations above 16Meg. To get around this restriction, operating systems will reserve a RAM buffer in an area below 16Meg that also does not span a - physical 64K boundary. Then the DMA will be programmed to - transfer data from the peripheral and into that buffer. Once the + physical 64K boundary. Then the DMA will be programmed to + transfer data from the peripheral and into that buffer. Once the DMA has moved the data into this buffer, the operating system will then copy the data from the buffer to the address where the data is really supposed to be stored. @@ -524,8 +524,8 @@ When writing data from an address above 16Meg to a DMA-based peripheral, the data must be first copied from where it resides into a buffer located below 16Meg, and then the DMA can copy the - data from the buffer to the hardware. In FreeBSD, these reserved - buffers are called “Bounce Buffers”. In the MS-DOS world, they + data from the buffer to the hardware. In FreeBSD, these reserved + buffers are called “Bounce Buffers”. In the MS-DOS world, they are sometimes called “Smart Buffers”. @@ -539,17 +539,17 @@ DMA Operational Modes and Settings - The 8237 DMA can be operated in several modes. The main ones + The 8237 DMA can be operated in several modes. The main ones are: Single - A single byte (or word) is transferred. The DMA must + A single byte (or word) is transferred. The DMA must release and re-acquire the bus for each additional byte. This is commonly-used by devices that cannot transfer the - entire block of data immediately. The peripheral will + entire block of data immediately. The peripheral will request the DMA each time it is ready for another transfer. @@ -563,19 +563,19 @@ Once the DMA acquires the system bus, an entire block - of data is transferred, up to a maximum of 64K. If the + of data is transferred, up to a maximum of 64K. If the peripheral needs additional time, it can assert the READY - signal to suspend the transfer briefly. READY should not + signal to suspend the transfer briefly. READY should not be used excessively, and for slow peripheral transfers, the Single Transfer Mode should be used instead. The difference between Block and Demand is that once a Block transfer is started, it runs until the transfer - count reaches zero. DRQ only needs to be asserted until - -DACK is asserted. Demand Mode will transfer one more + count reaches zero. DRQ only needs to be asserted until + -DACK is asserted. Demand Mode will transfer one more bytes until DRQ is de-asserted, at which point the DMA suspends the transfer and releases the bus back to the - CPU. When DRQ is asserted later, the transfer resumes + CPU. When DRQ is asserted later, the transfer resumes where it was suspended. Older hard disk controllers used Demand Mode until CPU @@ -592,36 +592,36 @@ This mechanism allows a DMA channel to request the bus, but then the attached peripheral device is responsible for placing the addressing information on the - bus instead of the DMA. This is also used to implement a + bus instead of the DMA. This is also used to implement a technique known as “Bus Mastering”. When a DMA channel in Cascade Mode receives control of the bus, the DMA does not place addresses and I/O control signals on the bus like the DMA normally does when it is - active. Instead, the DMA only asserts the -DACK signal + active. Instead, the DMA only asserts the -DACK signal for the active DMA channel. At this point it is up to the peripheral connected to that DMA channel to provide address and bus control - signals. The peripheral has complete control over the + signals. The peripheral has complete control over the system bus, and can do reads and/or writes to any address - below 16Meg. When the peripheral is finished with the + below 16Meg. When the peripheral is finished with the bus, it de-asserts the DRQ line, and the DMA controller can then return control to the CPU or to some other DMA channel. Cascade Mode can be used to chain multiple DMA controllers together, and this is exactly what DMA Channel - 4 is used for in the PC architecture. When a peripheral + 4 is used for in the PC architecture. When a peripheral requests the bus on DMA channels 0, 1, 2 or 3, the slave DMA controller asserts HLDREQ, but this wire is actually connected to DRQ4 on the primary DMA controller instead of - to the CPU. The primary DMA controller, thinking it has + to the CPU. The primary DMA controller, thinking it has work to do on Channel 4, requests the bus from the CPU - using HLDREQ signal. Once the CPU grants the bus to the + using HLDREQ signal. Once the CPU grants the bus to the primary DMA controller, -DACK4 is asserted, and that wire is actually connected to the HLDA signal on the slave DMA - controller. The slave DMA controller then transfers data + controller. The slave DMA controller then transfers data for the DMA channel that requested it (0, 1, 2 or 3), or the slave DMA may grant the bus to a peripheral that wants to perform its own bus-mastering, such as a SCSI @@ -639,24 +639,24 @@ When a peripheral is performing Bus Mastering, it is important that the peripheral transmit data to or from - memory constantly while it holds the system bus. If the + memory constantly while it holds the system bus. If the peripheral cannot do this, it must release the bus frequently so that the system can perform refresh operations on main memory. The Dynamic RAM used in all PCs for main memory must be accessed frequently to keep the bits stored in the - components “charged”. Dynamic RAM essentially consists of + components “charged”. Dynamic RAM essentially consists of millions of capacitors with each one holding one bit of - data. These capacitors are charged with power to - represent a 1 or drained to represent a 0. Because + data. These capacitors are charged with power to + represent a 1 or drained to represent a 0. Because all capacitors leak, power must be added at regular - intervals to keep the 1 values intact. The RAM chips + intervals to keep the 1 values intact. The RAM chips actually handle the task of pumping power back into all of the appropriate locations in RAM, but they must be told when to do it by the rest of the computer so that the refresh activity won't interfere with the computer wanting - to access RAM normally. If the computer is unable to + to access RAM normally. If the computer is unable to refresh memory, the contents of memory will become corrupted in just a few milliseconds. @@ -679,8 +679,8 @@ Demand transfers, but when the DMA transfer counter reaches zero, the counter and address are set back to where they were when the DMA channel was originally - programmed. This means that as long as the peripheral - requests transfers, they will be granted. It is up to the + programmed. This means that as long as the peripheral + requests transfers, they will be granted. It is up to the CPU to move new data into the fixed buffer ahead of where the DMA is about to transfer it when doing output operations, and read new data out of the buffer behind @@ -688,7 +688,7 @@ operations. This technique is frequently used on audio devices - that have small or no hardware “sample” buffers. There + that have small or no hardware “sample” buffers. There is additional CPU overhead to manage this “circular” buffer, but in some cases this may be the only way to eliminate the latency that occurs when the DMA counter @@ -706,7 +706,7 @@ Programming the DMA The DMA channel that is to be programmed should always be - “masked” before loading any settings. This is because the + “masked” before loading any settings. This is because the hardware might unexpectedly assert the DRQ for that channel, and the DMA might respond, even though not all of the parameters have been loaded or updated. @@ -715,8 +715,8 @@ transfer (memory-to-I/O or I/O-to-memory), what mode of DMA operation is to be used for the transfer (Single, Block, Demand, Cascade, etc), and finally the address and length of the transfer - are loaded. The length that is loaded is one less than the amount - you expect the DMA to transfer. The LSB and MSB of the address + are loaded. The length that is loaded is one less than the amount + you expect the DMA to transfer. The LSB and MSB of the address and length are written to the same 8-bit I/O port, so another port must be written to first to guarantee that the DMA accepts the first byte as the LSB and the second byte as the MSB of the length @@ -727,14 +727,14 @@ ports. Once all the settings are ready, the DMA channel can be - un-masked. That DMA channel is now considered to be “armed”, + un-masked. That DMA channel is now considered to be “armed”, and will respond when the DRQ line for that channel is asserted. Refer to a hardware data book for precise programming details - for the 8237. You will also need to refer to the I/O port map for + for the 8237. You will also need to refer to the I/O port map for the PC system, which describes where the DMA and Page Register - ports are located. A complete port map table is located + ports are located. A complete port map table is located below. @@ -743,8 +743,8 @@ DMA Port Map All systems based on the IBM-PC and PC/AT have the DMA - hardware located at the same I/O ports. The complete list is - provided below. Ports assigned to DMA Controller #2 are undefined + hardware located at the same I/O ports. The complete list is + provided below. Ports assigned to DMA Controller #2 are undefined on non-AT designs. @@ -1241,14 +1241,14 @@ The Intel 82374 EISA System Component (ESC) was introduced in early 1996 and includes a DMA controller that provides a superset of 8237 functionality as well as other PC-compatible - core peripheral components in a single package. This chip is + core peripheral components in a single package. This chip is targeted at both EISA and PCI platforms, and provides modern DMA features like scatter-gather, ring buffers as well as direct access by the system DMA to all 32 bits of address space. If these features are used, code should also be included to provide similar functionality in the previous 16 years worth of - PC-compatible computers. For compatibility reasons, some of the + PC-compatible computers. For compatibility reasons, some of the 82374 registers must be programmed after programming the traditional 8237 registers for each transfer. Writing to a traditional 8237 register forces the contents of @@ -1653,7 +1653,7 @@ The FreeBSD VM System - Contributed by &a.dillon;. 6 Feb 1999 + Contributed by &a.dillon;. 6 Feb 1999 Management of physical @@ -1666,7 +1666,7 @@ queues.</para> <para>A page can be in a wired, active, inactive, cache, or free - state. Except for the wired state, the page is typically placed in a + state. Except for the wired state, the page is typically placed in a doubly link list queue representing the state that it is in. Wired pages are not placed on any queue.</para> @@ -1684,9 +1684,9 @@ in the page's flags.</para> <para>In general terms, each of the paging queues operates in a LRU - fashion. A page is typicaly placed in a wired or active state + fashion. A page is typicaly placed in a wired or active state initially. When wired, the page is usually associated with a page - table somewhere. The VM system ages the page by scanning pages in a + table somewhere. The VM system ages the page by scanning pages in a more active paging queue (LRU) in order to move them to a less-active paging queue. Pages that get moved into the cache are still associated with a VM object but are candidates for immediate @@ -1707,12 +1707,12 @@ maintain reasonable ratios of pages in the various queues as well as attempts to maintain a reasonable breakdown of clean vs dirty pages. The amount of rebalancing that occurs depends on the system's memory - load. This rebalancing is implemented by the pageout daemon and + load. This rebalancing is implemented by the pageout daemon and involves laundering dirty pages (syncing them with their backing store), noticing when pages are activity referenced (resetting their position in the LRU queues or moving them between queues), migrating pages between queues when the queues are out of balance, and so - forth. FreeBSD's VM system is willing to take a reasonable number of + forth. FreeBSD's VM system is willing to take a reasonable number of reactivation page faults to determine how active or how idle a page actually is. This leads to better decisions being made as to when to launder or swap-out a page.</para> @@ -1725,7 +1725,7 @@ <para>FreeBSD implements the idea of a generic “VM object”. VM objects can be associated with backing store of various types—unbacked, swap-backed, physical device-backed, - or file-backed storage. Since the filesystem uses the same VM + or file-backed storage. Since the filesystem uses the same VM objects to manage in-core data relating to files, the result is a unified buffer cache.</para> @@ -1762,7 +1762,7 @@ the same manner, disk I/O is typically issued by mapping portions of objects into buffer structures and then issuing the I/O on the buffer structures. The underlying vm_page_t's are typically busied - for the duration of the I/O. Filesystem buffers also have their own + for the duration of the I/O. Filesystem buffers also have their own notion of being busy, which is useful to filesystem driver code which would rather operate on filesystem buffers instead of hard VM pages.</para> @@ -1812,7 +1812,7 @@ mappings relating to <literal>struct buf</literal> entities.</para> <para>Unlike Linux, FreeBSD does NOT map all of physical memory into - KVM. This means that FreeBSD can handle memory configurations up to + KVM. This means that FreeBSD can handle memory configurations up to 4G on 32 bit platforms. In fact, if the mmu were capable of it, FreeBSD could theoretically handle memory configurations up to 8TB on a 32 bit platform. However, since most 32 bit platforms are only @@ -1837,7 +1837,7 @@ <filename>/usr/src/sys/i386/conf/<replaceable>CONFIG_FILE</replaceable></filename>. A description of all available kernel configuration options can be found in <filename>/usr/src/sys/i386/conf/LINT</filename>.</para> <para>In a large system configuration you may wish to increase - <literal>maxusers</literal>. Values typically range from 10 to 128. + <literal>maxusers</literal>. Values typically range from 10 to 128. Note that raising <literal>maxusers</literal> too high can cause the system to overflow available KVM resulting in unpredictable operation. It is better to leave maxusers at some reasonable number @@ -1849,7 +1849,7 @@ from 1024 to 4096.</para> <para>The <literal>NBUF</literal> parameter is also traditionally used - to scale the system. This parameter determines the amount of KVA the + to scale the system. This parameter determines the amount of KVA the system can use to map filesystem buffers for I/O. Note that this parameter has nothing whatsoever to do with the unified buffer cache! This parameter is dynamically tuned in 3.0-CURRENT and diff --git a/en_US.ISO_8859-1/books/handbook/introduction/chapter.sgml b/en_US.ISO_8859-1/books/handbook/introduction/chapter.sgml index 77510aa99d..234b91a5a2 100644 --- a/en_US.ISO_8859-1/books/handbook/introduction/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/introduction/chapter.sgml @@ -2,12 +2,12 @@ <title>Introduction FreeBSD is a 4.4BSD-Lite based operating system for Intel - architecture (x86) based PCs. For an overview of FreeBSD, see - FreeBSD in a nutshell. For a + architecture (x86) based PCs. For an overview of FreeBSD, see + FreeBSD in a nutshell. For a history of the project, read a brief - history of FreeBSD. To see a description of the latest release, + history of FreeBSD. To see a description of the latest release, read about the current - release. If you're interested in contributing something to the + release. If you're interested in contributing something to the FreeBSD project (code, equipment, sacks of unmarked bills), please see about contributing to FreeBSD. @@ -17,10 +17,10 @@ FreeBSD is a state of the art operating system for personal computers based on the Intel CPU architecture, which includes the - 386, 486 and Pentium processors (both SX and DX versions). Intel - compatible CPUs from AMD and Cyrix are supported as well. FreeBSD + 386, 486 and Pentium processors (both SX and DX versions). Intel + compatible CPUs from AMD and Cyrix are supported as well. FreeBSD provides you with many advanced features previously available only - on much more expensive computers. These features include: + on much more expensive computers. These features include: @@ -34,14 +34,14 @@ Multiuser access means that many people can use a FreeBSD system simultaneously for a - variety of things. System peripherals such as printers and + variety of things. System peripherals such as printers and tape drives are also properly SHARED BETWEEN ALL users on the system. Complete TCP/IP networking - including SLIP, PPP, NFS and NIS support. This means that + including SLIP, PPP, NFS and NIS support. This means that your FreeBSD machine can inter-operate easily with other systems as well act as an enterprise server, providing vital functions such as NFS (remote file access) and e-mail services @@ -77,13 +77,13 @@ Hundreds of ready-to-run - applications are available from the FreeBSD ports and packages collection. Why search the net + applications are available from the FreeBSD ports and packages collection. Why search the net when you can find it all right here? Thousands of additional and easy-to-port applications available on - the Internet. FreeBSD is source code compatible with most + the Internet. FreeBSD is source code compatible with most popular commercial Unix systems and thus most applications require few, if any, changes to compile. @@ -103,7 +103,7 @@ A full complement of C, - C++ and Fortran development tools. Many + C++ and Fortran development tools. Many additional languages for advanced research and development are also available in the ports and packages collection. @@ -111,7 +111,7 @@ Source code for the entire system means you have the greatest degree of control over your - environment. Why be locked into a proprietary solution and at + environment. Why be locked into a proprietary solution and at the mercy of your vendor when you can have a truly Open System? @@ -131,15 +131,15 @@ FreeBSD is based on the 4.4BSD-Lite release from Computer Systems Research Group (CSRG) at the University of California at Berkeley, and carries on the distinguished tradition of BSD systems - development. In addition to the fine work provided by CSRG, the + development. In addition to the fine work provided by CSRG, the FreeBSD Project has put in many thousands of hours in fine tuning the system for maximum performance and reliability in real-life load - situations. As many of the commercial giants struggle to field PC + situations. As many of the commercial giants struggle to field PC operating systems with such features, performance and reliability, FreeBSD can offer them now! The applications to which FreeBSD can be put are truly limited - only by your own imagination. From software development to factory + only by your own imagination. From software development to factory automation, inventory control to azimuth correction of remote satellite antennae; if it can be done with a commercial UNIX product then it is more than likely that you can do it with FreeBSD, too! @@ -153,7 +153,7 @@ available, the system can also be customized to an almost unheard of degree for special applications or projects, and in ways not generally possible with operating systems from most major commercial - vendors. Here is just a sampling of some of the applications in + vendors. Here is just a sampling of some of the applications in which people are currently using FreeBSD: @@ -205,7 +205,7 @@ of computer science or a related engineering field? There is no better way of learning about operating systems, computer architecture and networking than the hands on, under the hood - experience that FreeBSD can provide. A number of freely + experience that FreeBSD can provide. A number of freely available CAD, mathematical and graphic design packages also make it highly useful to those whose primary interest in a computer is to get other work @@ -216,7 +216,7 @@ Research: With source code for the entire system available, FreeBSD is an excellent platform for research in operating systems as well as other - branches of computer science. FreeBSD's freely available + branches of computer science. FreeBSD's freely available nature also makes it possible for remote groups to collaborate on ideas or shared development without having to worry about special licensing agreements or limitations on what may be @@ -238,7 +238,7 @@ one of the excellent commercial servers provided by X Inside. Unlike an X terminal, FreeBSD allows many applications to be run locally, if desired, thus relieving the burden on a - central server. FreeBSD can even boot “diskless”, making + central server. FreeBSD can even boot “diskless”, making individual workstations even cheaper and easier to administer. @@ -254,7 +254,7 @@ FreeBSD is available in both source and binary form on CDROM and - via anonymous ftp. See Obtaining + via anonymous ftp. See Obtaining FreeBSD for more details. @@ -271,89 +271,89 @@ Our original goal was to produce an intermediate snapshot of 386BSD in order to fix a number of problems with it that the - patchkit mechanism just was not capable of solving. Some of you may + patchkit mechanism just was not capable of solving. Some of you may remember the early working title for the project being “386BSD 0.5” or “386BSD Interim” in reference to that fact. 386BSD was Bill Jolitz's operating system, which had been up to that point suffering rather severely from almost a year's worth of - neglect. As the patchkit swelled ever more uncomfortably with each + neglect. As the patchkit swelled ever more uncomfortably with each passing day, we were in unanimous agreement that something had to be done and decided to try and assist Bill by providing this interim - “cleanup” snapshot. Those plans came to a rude halt when Bill + “cleanup” snapshot. Those plans came to a rude halt when Bill Jolitz suddenly decided to withdraw his sanction from the project and without any clear indication of what would be done instead. It did not take us long to decide that the goal remained worthwhile, even without Bill's support, and so we adopted the name - “FreeBSD”, coined by David Greenman. Our initial objectives were + “FreeBSD”, coined by David Greenman. Our initial objectives were set after consulting with the system's current users and, once it became clear that the project was on the road to perhaps even becoming a reality, I contacted Walnut Creek CDROM with an eye towards improving FreeBSD's distribution channels for those many - unfortunates without easy access to the Internet. Walnut Creek + unfortunates without easy access to the Internet. Walnut Creek CDROM not only supported the idea of distributing FreeBSD on CD but went so far as to provide the project with a machine to work on and - a fast Internet connection. Without Walnut Creek CDROM's almost + a fast Internet connection. Without Walnut Creek CDROM's almost unprecedented degree of faith in what was, at the time, a completely unknown project, it is quite unlikely that FreeBSD would have gotten as far, as fast, as it has today. The first CDROM (and general net-wide) distribution was FreeBSD - 1.0, released in December of 1993. This was based on the + 1.0, released in December of 1993. This was based on the 4.3BSD-Lite (“Net/2”) tape from U.C. Berkeley, with many components - also provided by 386BSD and the Free Software Foundation. It was a + also provided by 386BSD and the Free Software Foundation. It was a fairly reasonable success for a first offering, and we followed it with the highly successful FreeBSD 1.1 release in May of 1994. Around this time, some rather unexpected storm clouds formed on the horizon as Novell and U.C. Berkeley settled their long-running - lawsuit over the legal status of the Berkeley Net/2 tape. A + lawsuit over the legal status of the Berkeley Net/2 tape. A condition of that settlement was U.C. Berkeley's concession that large parts of Net/2 were “encumbered” code and the property of Novell, who had in turn acquired it from AT&T some time - previously. What Berkeley got in return was Novell's “blessing” + previously. What Berkeley got in return was Novell's “blessing” that the 4.4BSD-Lite release, when it was finally released, would be declared unencumbered and all existing Net/2 users would be strongly - encouraged to switch. This included FreeBSD, and the project was + encouraged to switch. This included FreeBSD, and the project was given until the end of July 1994 to stop shipping its own Net/2 - based product. Under the terms of that agreement, the project was + based product. Under the terms of that agreement, the project was allowed one last release before the deadline, that release being FreeBSD 1.1.5.1. FreeBSD then set about the arduous task of literally re-inventing itself from a completely new and rather incomplete set - of 4.4BSD-Lite bits. The “Lite” releases were light in part because + of 4.4BSD-Lite bits. The “Lite” releases were light in part because Berkeley's CSRG had removed large chunks of code required for actually constructing a bootable running system (due to various legal requirements) and the fact that the Intel port of 4.4 was - highly incomplete. It took the project until December of 1994 to + highly incomplete. It took the project until December of 1994 to make this transition, and in January of 1995 it released FreeBSD 2.0 - to the net and on CDROM. Despite being still more than a little + to the net and on CDROM. Despite being still more than a little rough around the edges, the release was a significant success and was followed by the more robust and easier to install FreeBSD 2.0.5 release in June of 1995. We released FreeBSD 2.1.5 in August of 1996, and it appeared to be popular enough among the ISP and commercial communities that - another release along the 2.1-stable branch was merited. This was + another release along the 2.1-stable branch was merited. This was FreeBSD 2.1.7.1, released in February 1997 and capping the end of - mainstream development on 2.1-stable. Now in maintenance mode, only + mainstream development on 2.1-stable. Now in maintenance mode, only security enhancements and other critical bug fixes will be done on this branch (RELENG_2_1_0). FreeBSD 2.2 was branched from the development mainline (“-current”) in November 1996 as the RELENG_2_2 branch, and the - first full release (2.2.1) was released in April, 1997. Further + first full release (2.2.1) was released in April, 1997. Further releases along the 2.2 branch were done in the Summer and Fall of '97, the latest being 2.2.7 which appeared in late July of '98. The first official 3.0 release appeared in October, 1998 and the last release on the 2.2 branch, 2.2.8, appeared in November, 1998. - The tree branched again on Jan 20, 1999. This led to + The tree branched again on Jan 20, 1999. This led to 4.0-current and a 3.x-stable branch, from which 3.1 will be released on February 15th, 1999. @@ -368,20 +368,20 @@ Contributed by &a.jkh;. The goals of the FreeBSD Project are to provide software that - may be used for any purpose and without strings attached. Many of + may be used for any purpose and without strings attached. Many of us have a significant investment in the code (and project) and would certainly not mind a little financial compensation now and then, but - we're definitely not prepared to insist on it. We believe that our + we're definitely not prepared to insist on it. We believe that our first and foremost “mission” is to provide code to any and all comers, and for whatever purpose, so that the code gets the widest - possible use and provides the widest possible benefit. This is, I + possible use and provides the widest possible benefit. This is, I believe, one of the most fundamental goals of Free Software and one that we enthusiastically support. That code in our source tree which falls under the GNU Public License (GPL) or GNU Library Public License (GLPL) comes with slightly more strings attached, though at least on the side of - enforced access rather than the usual opposite. Due to the + enforced access rather than the usual opposite. Due to the additional complexities that can evolve in the commercial use of GPL software, we do, however, endeavor to replace such software with submissions under the more relaxed BSD copyright whenever possible. @@ -396,13 +396,13 @@ The development of FreeBSD is a very open and flexible process, FreeBSD being literally built from the contributions of hundreds of people around the world, as can be seen from our list of contributors. We are constantly + linkend="staff">list of contributors. We are constantly on the lookout for new developers and ideas, and those interested in becoming more closely involved with the project need simply contact - us at the &a.hackers;. Those who prefer to work more independently + us at the &a.hackers;. Those who prefer to work more independently are also accommodated, and they are free to use our FTP facilities at ftp.freebsd.org to distribute their own patches or work-in-progress sources. The &a.announce; is also available to those wishing to make other FreeBSD users aware of major areas of work. + URL="ftp://ftp.freebsd.org/pub/FreeBSD/incoming">ftp.freebsd.org to distribute their own patches or work-in-progress sources. The &a.announce; is also available to those wishing to make other FreeBSD users aware of major areas of work. Useful things to know about the FreeBSD project and its development process, whether working independently or in close @@ -415,10 +415,10 @@ The central source tree for FreeBSD is maintained by CVS (Concurrent Version System), a freely available source code control tool which comes bundled with FreeBSD. The primary CVS repository resides on a machine in Concord CA, USA from where it is replicated to numerous mirror machines throughout the world. The CVS tree, as well as the -current and CVS (Concurrent Version System), a freely available source code control tool which comes bundled with FreeBSD. The primary CVS repository resides on a machine in Concord CA, USA from where it is replicated to numerous mirror machines throughout the world. The CVS tree, as well as the -current and -stable trees which are checked out of it, can be easily replicated to your own machine as - well. Please refer to the + well. Please refer to the Synchronizing your source tree section for more information on doing this. @@ -433,7 +433,7 @@ the CVS tree, and are thus authorized to make modifications to the FreeBSD source (the term “committer” comes from the cvs1 commit command, which is used to - bring new changes into the CVS repository). The best way of + bring new changes into the CVS repository). The best way of making submissions for review by the committers list is to use the send-pr1 command, though if something appears to be jammed in the system then you may also reach them by sending mail to committers@freebsd.org. @@ -445,9 +445,9 @@ The FreeBSD core team would be equivalent to the board of directors if - the FreeBSD Project were a company. The primary task of the + the FreeBSD Project were a company. The primary task of the core team is to make sure the project, as a whole, is in - good shape and is heading in the right directions. Inviting + good shape and is heading in the right directions. Inviting dedicated and responsible developers to join our group of committers is one of the functions of the core team, as is the recruitment of new core team members as others move on. @@ -479,7 +479,7 @@ Last, but definitely not least, the largest group of developers are the users themselves who provide feedback and - bug-fixes to us on an almost constant basis. The primary + bug-fixes to us on an almost constant basis. The primary way of keeping in touch with FreeBSD's more non-centralized development is to subscribe to the &a.hackers; (see mailing list @@ -501,7 +501,7 @@ In summary, our development model is organized as a loose set of - concentric circles. The centralized model is designed for the + concentric circles. The centralized model is designed for the convenience of the users of FreeBSD, who are thereby provided with an easy way of tracking one central code base, not to keep potential contributors out! Our desire is to present a @@ -521,16 +521,16 @@ FreeBSD is a freely available, full source 4.4BSD-Lite based release for Intel i386/i486/Pentium/PentiumPro/Pentium II (or - compatible) based PC's. It is based primarily on software from U.C. + compatible) based PC's. It is based primarily on software from U.C. Berkeley's CSRG group, with some enhancements from NetBSD, OpenBSD, 386BSD, and the Free Software Foundation. Since our release of FreeBSD 2.0 in January of 95, the performance, feature set, and stability of FreeBSD has improved - dramatically. The largest change is a revamped virtual memory + dramatically. The largest change is a revamped virtual memory system with a merged VM/file buffer cache that not only increases performance, but reduces FreeBSD's memory footprint, making a 5MB - configuration a more acceptable minimum. Other enhancements include + configuration a more acceptable minimum. Other enhancements include full NIS client and server support, transaction TCP support, dial-on-demand PPP, an improved SCSI subsystem, early ISDN support, support for FDDI and Fast Ethernet (100Mbit) adapters, improved @@ -539,24 +539,24 @@ We have also taken the comments and suggestions of many of our users to heart and have attempted to provide what we hope is a more - sane and easily understood installation process. Your feedback on + sane and easily understood installation process. Your feedback on this (constantly evolving) process is especially welcome! In addition to the base distributions, FreeBSD offers a new ported software collection with hundreds of commonly sought-after - programs. At the end of August 1998 there were more than 1700 ports! + programs. At the end of August 1998 there were more than 1700 ports! The list of ports ranges from http (WWW) servers, to games, - languages, editors and almost everything in between. The entire + languages, editors and almost everything in between. The entire ports collection requires approximately 26MB of storage, all ports - being expressed as “deltas” to their original sources. This + being expressed as “deltas” to their original sources. This makes it much easier for us to update ports, and greatly reduces - the disk space demands made by the older 1.0 ports collection. To + the disk space demands made by the older 1.0 ports collection. To compile a port, you simply change to the directory of the program you wish to install, type make all followed by make install - after successful compilation and let the system do the rest. The + after successful compilation and let the system do the rest. The full original distribution for each port you build is retrieved dynamically off the CDROM or a local ftp site, so you need only - enough disk space to build the ports you want. (Almost) every port + enough disk space to build the ports you want. (Almost) every port is also provided as a pre-compiled “package” which can be installed with a simple command (pkg_add) by those who do not wish to compile their own ports from source. @@ -564,7 +564,7 @@ A number of additional documents which you may find very helpful in the process of installing and using FreeBSD may now also be found in the /usr/share/doc directory on any machine - running FreeBSD 2.1 or later. You may view the locally installed + running FreeBSD 2.1 or later. You may view the locally installed manuals with any HTML capable browser using the following URLs: @@ -593,12 +593,12 @@ URL="http://www.freebsd.org">http://www.freebsd.org. The core of FreeBSD does not contain DES code which would - inhibit its being exported outside the United States. There is an + inhibit its being exported outside the United States. There is an add-on package to the core distribution, for use only in the United - States, that contains the programs that normally use DES. The - auxiliary packages provided separately can be used by anyone. A + States, that contains the programs that normally use DES. The + auxiliary packages provided separately can be used by anyone. A freely (from outside the U.S.) exportable European distribution of - DES for our non-U.S. users also exists and is described in the + DES for our non-U.S. users also exists and is described in the FreeBSD FAQ. If password security for FreeBSD is all you need, and you have @@ -606,7 +606,7 @@ (Suns, DEC machines, etc) into FreeBSD password entries, then FreeBSD's MD5 based security may be all you require! We feel that our default security model is more than a match for DES, and without - any messy export issues to deal with. If you are outside (or even + any messy export issues to deal with. If you are outside (or even inside) the U.S., give it a try! diff --git a/en_US.ISO_8859-1/books/handbook/kernelconfig/chapter.sgml b/en_US.ISO_8859-1/books/handbook/kernelconfig/chapter.sgml index bfdf8592c9..30c999f236 100644 --- a/en_US.ISO_8859-1/books/handbook/kernelconfig/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/kernelconfig/chapter.sgml @@ -5,7 +5,7 @@ 1995. This large section of the handbook discusses the basics of - building your own custom kernel for FreeBSD. This section is + building your own custom kernel for FreeBSD. This section is appropriate for both novice system administrators and those with advanced Unix experience. @@ -14,12 +14,12 @@ Why Build a Custom Kernel? Building a custom kernel is one of the most important rites of - passage every Unix system administrator must endure. This process, + passage every Unix system administrator must endure. This process, while time-consuming, will provide many benefits to your FreeBSD - system. Unlike the GENERIC kernel, which must support every + system. Unlike the GENERIC kernel, which must support every possible SCSI and network card, along with tons of other rarely used hardware support, a custom kernel only contains support for - your PC's hardware. This has a number of + your PC's hardware. This has a number of benefits: @@ -35,7 +35,7 @@ because the kernel is the one process which must always be present in memory, and so all of that unused code ties up pages of RAM that your programs would otherwise be able to - use. Therefore, on a system with limited RAM, building a + use. Therefore, on a system with limited RAM, building a custom kernel is of critical importance. @@ -57,14 +57,14 @@ First, let us take a quick tour of the kernel build directory. All directories mentioned will be relative to the main /usr/src/sys directory, which is also - accessible through /sys. There are a number of + accessible through /sys. There are a number of subdirectories here representing different parts of the kernel, but the most important, for our purposes, are i386/conf, where you will edit your custom kernel configuration, and compile, - which is the staging area where your kernel will be built. Notice + which is the staging area where your kernel will be built. Notice the logical organization of the directory tree, with each supported - device, filesystem, and option in its own subdirectory. Also, + device, filesystem, and option in its own subdirectory. Also, anything inside the i386 directory deals with PC hardware only, while everything outside the i386 directory is common to all platforms which @@ -73,7 +73,7 @@ If there is not a /usr/src/sys directory on your system, then - the kernel source has not been been installed. The easiest way + the kernel source has not been been installed. The easiest way to do this is by running /stand/sysinstall as root, choosing Configure, then Distributions, then src, @@ -82,7 +82,7 @@ Next, move to the i386/conf directory and copy the GENERIC configuration file to the name - you want to give your kernel. For example: + you want to give your kernel. For example: &prompt.root; cd /usr/src/sys/i386/conf @@ -92,7 +92,7 @@ Traditionally, this name is in all capital letters and, if you are maintaining multiple FreeBSD machines with different hardware, it is a good idea to name it after your - machine's hostname. We will call it MYKERNEL + machine's hostname. We will call it MYKERNEL for the purpose of this example. @@ -102,17 +102,17 @@ Now, edit MYKERNEL with your favorite text - editor. If you are just starting out, the only editor available + editor. If you are just starting out, the only editor available will probably be vi, which is too complex to explain here, but is covered well in many books in the bibliography. Feel free to change + linkend="bibliography">bibliography. Feel free to change the comment lines at the top to reflect your configuration or the changes you have made to differentiate it from GENERIC. If you have build a kernel under SunOS or some other BSD - operating system, much of this file will be very familiar to you. If + operating system, much of this file will be very familiar to you. If you are coming from some other operating system such as DOS, on the other hand, the GENERIC configuration file might seem overwhelming to you, so follow the descriptions in the @@ -123,9 +123,9 @@ If you are trying to upgrade your kernel from an older version of FreeBSD, you will probably have to get a new version of config8 from the same place you got the new - kernel sources. It is located in + kernel sources. It is located in /usr/src/usr.sbin, so you will need to - download those sources as well. Re-build and install it before + download those sources as well. Re-build and install it before running the next commands. @@ -142,8 +142,8 @@ The new kernel will be copied to the root directory as /kernel and the old kernel will be - moved to /kernel.old. Now, shutdown the system - and reboot to use your kernel. In case something goes wrong, there + moved to /kernel.old. Now, shutdown the system + and reboot to use your kernel. In case something goes wrong, there are some troubleshooting instructions at the end of this document. Be sure to read the section which explains how to recover in case your new kernel The Configuration File - The general format of a configuration file is quite simple. Each - line contains a keyword and one or more arguments. For simplicity, - most lines only contain one argument. Anything following a + The general format of a configuration file is quite simple. Each + line contains a keyword and one or more arguments. For simplicity, + most lines only contain one argument. Anything following a # is considered a comment and ignored. The following sections describe each keyword, generally in the order they are listed in GENERIC, although some @@ -174,21 +174,21 @@ An exhaustive list of options and more detailed explanations of the device lines is present in the LINT configuration file, located in the same - directory as GENERIC. If you are in doubt as to + directory as GENERIC. If you are in doubt as to the purpose or necessity of a line, check first in LINT. The kernel is currently being moved to a better organization of - the option handling. Traditionally, each option in the config file + the option handling. Traditionally, each option in the config file was simply converted into a switch for the - CFLAGS line of the kernel Makefile. Naturally, + CFLAGS line of the kernel Makefile. Naturally, this caused a creeping optionism, with nobody really knowing which option has been referenced in what files. In the new scheme, every #ifdef that is intended to be dependent upon an option gets this option out of an opt_foo.h - declaration file created in the compile directory by config. The list of valid options for + declaration file created in the compile directory by config. The list of valid options for config lives in two files: options that do not depend on the architecture are listed in /sys/conf/options, architecture-dependent ones @@ -248,7 +248,7 @@ different values of cpu_type as are present in the GENERIC kernel. For a custom kernel, it is best to specify only the cpu - you have. If, for example, you have an Intel Pentium, use + you have. If, for example, you have an Intel Pentium, use I586_CPU for cpu_type. @@ -257,15 +257,15 @@ Next, we have ident, - which is the identification of the kernel. You should + which is the identification of the kernel. You should change this from GENERIC to whatever you named your kernel, in this example, - MYKERNEL. The value you put in + MYKERNEL. The value you put in ident will print when you boot up the kernel, so it is useful to give a kernel a different name if you want to keep it separate from your usual kernel (if you want to build an experimental kernel, - for example). Note that, as with machine and + for example). Note that, as with machine and cpu, enclose your kernel's name in quotation marks if it contains any numbers. @@ -280,13 +280,13 @@ This file sets the size of a number of important - system tables. This number is supposed to be roughly + system tables. This number is supposed to be roughly equal to the number of simultaneous users you expect to - have on your machine. However, under normal + have on your machine. However, under normal circumstances, you will want to set maxusers to at least 4, especially if you are using the X Window System or - compiling software. The reason is that the most important + compiling software. The reason is that the most important table set by maxusers is the maximum number of processes, which is set to 20 + 16 * maxusers, so if you set @@ -294,11 +294,11 @@ can only have 36 simultaneous processes, including the 18 or so that the system starts up at boot time, and the 15 or so you will probably create when you start the X Window - System. Even a simple task like reading a man page will start up nine - processes to filter, decompress, and view it. Setting + System. Even a simple task like reading a man page will start up nine + processes to filter, decompress, and view it. Setting maxusers to 4 will allow you to have up to 84 simultaneous processes, which should be - enough for anyone. If, however, you see the dreaded + enough for anyone. If, however, you see the dreaded proc table full error when trying to start another program, or are running a server with a large number of simultaneous users (like Walnut Creek CDROM's FTP site), @@ -307,10 +307,10 @@ maxuser does not limit the number of users which - can log into your machine. It simply sets various table + can log into your machine. It simply sets various table sizes to reasonable values considering the maximum number of users you will likely have on your system and - how many processes each of them will be running. One + how many processes each of them will be running. One keyword which does limit the number of simultaneous remote logins is This line specifies the location and name of the - kernel. Traditionally the kernel is called + kernel. Traditionally the kernel is called vmunix but in FreeBSD, it is aptly - named kernel. You should always use + named kernel. You should always use kernel for kernel_name because changing it will - render numerous system utilities inoperative. The second + render numerous system utilities inoperative. The second part of the line specifies the disk and partition where - the root filesystem and kernel can be found. Typically + the root filesystem and kernel can be found. Typically this will be wd0 for systems with non-SCSI drives, or sd0 for systems with SCSI drives. @@ -355,14 +355,14 @@ This line allows the kernel to simulate a math co-processor if your computer does not have one (386 or - 486SX). If you have a Pentium, a 486DX, or a 386 or 486SX + 486SX). If you have a Pentium, a 486DX, or a 386 or 486SX with a separate 387 or 487 chip, you can comment this line out. The normal math co-processor emulation routines that come with FreeBSD are not very - accurate. If you do not have a math co-processor, and + accurate. If you do not have a math co-processor, and you need the best accuracy, I recommend that you change this option to GPL_MATH_EMULATE to use the superior GNU math support, which is not included by @@ -374,7 +374,7 @@ options "COMPAT_43" - Compatibility with 4.3BSD. Leave this in; some + Compatibility with 4.3BSD. Leave this in; some programs will act strangely if you comment this out. @@ -385,7 +385,7 @@ ISA devices and EISA devices operating in an ISA compatibility mode can only perform DMA (Direct Memory - Access) to memory below 16 megabytes. This option enables + Access) to memory below 16 megabytes. This option enables such devices to work in systems with more than 16 megabytes of memory. @@ -405,11 +405,11 @@ options SYSVSHM - This option provides for System V shared memory. The + This option provides for System V shared memory. The most common use of this is the XSHM extension in X Windows, which many graphics-intensive programs (such as the movie player XAnim, and Linux DOOM) will automatically - take advantage of for extra speed. If you use the X + take advantage of for extra speed. If you use the X Window System, you will definitely want to include this. @@ -418,7 +418,7 @@ options SYSVSEM - Support for System V semaphores. Less commonly used + Support for System V semaphores. Less commonly used but only adds a few hundred bytes to the kernel. @@ -426,7 +426,7 @@ options SYSVMSG - Support for System V messages. Again, only adds a few + Support for System V messages. Again, only adds a few hundred bytes to the kernel. @@ -444,7 +444,7 @@ Filesystem Options - These options add support for various filesystems. You must + These options add support for various filesystems. You must include at least one of these to support the device you boot from; typically this will be FFS if you boot from a hard drive, or NFS if you are booting a @@ -467,7 +467,7 @@ options NFS - Network Filesystem. Unless you plan to mount + Network Filesystem. Unless you plan to mount partitions from a Unix file server over Ethernet, you can comment this out. @@ -476,11 +476,11 @@ options MSDOSFS - MS-DOS Filesystem. Unless you plan to mount a DOS + MS-DOS Filesystem. Unless you plan to mount a DOS formatted hard drive partition at boot time, you can - safely comment this out. It will be automatically loaded + safely comment this out. It will be automatically loaded the first time you mount a DOS partition, as described - above. Also, the excellent mtools software (in the ports + above. Also, the excellent mtools software (in the ports collection) allows you to access DOS floppies without having to mount and unmount them (and does not require MSDOSFS at all). @@ -490,10 +490,10 @@ options "CD9660" - ISO 9660 filesystem for CD-ROMs. Comment it out if + ISO 9660 filesystem for CD-ROMs. Comment it out if you do not have a CD-ROM drive or only mount data CD's occasionally (since it will be dynamically loaded the - first time you mount a data CD). Audio CD's do not need + first time you mount a data CD). Audio CD's do not need this filesystem. @@ -501,7 +501,7 @@ options PROCFS - Process filesystem. This is a pretend filesystem + Process filesystem. This is a pretend filesystem mounted on /proc which allows programs like ps1 to give you more information on what processes are running. @@ -511,12 +511,12 @@ options MFS - Memory-mapped file system. This is basically a RAM + Memory-mapped file system. This is basically a RAM disk for fast storage of temporary files, useful if you have a lot of swap space that you want to take advantage - of. A perfect place to mount an MFS partition is on the + of. A perfect place to mount an MFS partition is on the /tmp directory, since many programs - store temporary data here. To mount an MFS RAM disk on + store temporary data here. To mount an MFS RAM disk on /tmp, add the following line to /etc/fstab and then reboot or type mount /tmp: @@ -547,8 +547,8 @@ options "EXT2FS" - Linux's native file system. With ext2fs support you - are able to read and write to Linux partitions. This is + Linux's native file system. With ext2fs support you + are able to read and write to Linux partitions. This is useful if you dual-boot FreeBSD and Linux and want to share data between the two systems. @@ -557,10 +557,10 @@ options QUOTA - Enable disk quotas. If you have a public access + Enable disk quotas. If you have a public access system, and do not want users to be able to overflow the /home partition, you can establish - disk quotas for each user. Refer to the + disk quotas for each user. Refer to the Disk Quotas section for more information. @@ -574,7 +574,7 @@ Basic Controllers and Devices These sections describe the basic disk, tape, and CD-ROM - controllers supported by FreeBSD. There are separate sections for + controllers supported by FreeBSD. There are separate sections for SCSI controllers and network cards. @@ -582,7 +582,7 @@ controller isa0 - All PC's supported by FreeBSD have one of these. If + All PC's supported by FreeBSD have one of these. If you have an IBM PS/2 (Micro Channel Architecture), then you cannot run FreeBSD at this time. @@ -591,7 +591,7 @@ controller pci0 - Include this if you have a PCI motherboard. This + Include this if you have a PCI motherboard. This enables auto-detection of PCI cards and gatewaying from the PCI to the ISA bus. @@ -604,7 +604,7 @@ A: floppy drive, and fd1 is the B: drive. ft0 is a QIC-80 tape drive - attached to the floppy controller. Comment out any lines + attached to the floppy controller. Comment out any lines corresponding to devices you do not have. @@ -618,10 +618,10 @@ controller wdc0 - This is the primary IDE controller. wd0 and wd1 are the master and slave hard - drive, respectively. wdc1 is + This is the primary IDE controller. wd0 and wd1 are the master and slave hard + drive, respectively. wdc1 is a secondary IDE controller where you might have a third or - fourth hard drive, or an IDE CD-ROM. Comment out the + fourth hard drive, or an IDE CD-ROM. Comment out the lines which do not apply (if you have a SCSI hard drive, you will probably want to comment out all six lines, for example). @@ -631,11 +631,11 @@ device wcd0 - This device provides IDE CD-ROM support. Be sure to + This device provides IDE CD-ROM support. Be sure to leave wdc0 uncommented, and wdc1 if you have more than one IDE controller and your CD-ROM is on the second one - card. To use this, you must also include the line + card. To use this, you must also include the line options ATAPI. @@ -646,7 +646,7 @@ npx0 is the interface to the floating point math unit in FreeBSD, either the - hardware co-processor or the software math emulator. It + hardware co-processor or the software math emulator. It is not optional. @@ -664,10 +664,10 @@ The following drivers are for the so-called - proprietary CD-ROM drives. These + proprietary CD-ROM drives. These drives have their own controller card or might plug into a - sound card such as the SoundBlaster 16. They are - not IDE or SCSI. Most older + sound card such as the SoundBlaster 16. They are + not IDE or SCSI. Most older single-speed and double-speed CD-ROMs use these interfaces, while newer quad-speeds are likely to be IDE or SCSI Controllers The next ten or so lines include support for different - kinds of SCSI controllers. Comment out all except for the + kinds of SCSI controllers. Comment out all except for the one(s) you have: @@ -812,10 +812,10 @@ This causes the kernel to pause 15 seconds before - probing each SCSI device in your system. If you only have + probing each SCSI device in your system. If you only have IDE hard drives, you can ignore this, otherwise you will probably want to lower this number, perhaps to 5 seconds, - to speed up booting. Of course if you do this, and + to speed up booting. Of course if you do this, and FreeBSD has trouble recognizing your SCSI devices, you will have to raise it back up. @@ -825,7 +825,7 @@ If you have any SCSI controllers, this line provides - generic SCSI support. If you do not have SCSI, you can + generic SCSI support. If you do not have SCSI, you can comment this, and the following three lines, out. @@ -879,11 +879,11 @@ vector scintr sc0 is the default - console driver, which resembles an SCO console. Since most + console driver, which resembles an SCO console. Since most full-screen programs access the console through a terminal database library like termcap, it should not matter much whether you use this or vt0, the VT220 compatible console - driver. When you log in, set your TERM variable to + driver. When you log in, set your TERM variable to “scoansi” if full-screen programs have trouble running under this console. @@ -894,9 +894,9 @@ This is a VT220-compatible console driver, backwards - compatible to VT100/102. It works well on some laptops - which have hardware incompatibilities with sc0. Also, set your TERM variable - to vt100 or vt220 when you log in. This driver + compatible to VT100/102. It works well on some laptops + which have hardware incompatibilities with sc0. Also, set your TERM variable + to vt100 or vt220 when you log in. This driver might also prove useful when connecting to a large number of different machines over the network, where the termcap or @@ -915,7 +915,7 @@ options XSERVER - Only applicable with the vt0 console driver. This + Only applicable with the vt0 console driver. This includes code required to run the XFree86 X Window Server under the vt0 console driver. @@ -958,8 +958,8 @@ Serial and Parallel Ports - Nearly all systems have these. If you are attaching a printer - to one of these ports, the Printing section of the handbook is very useful. If + Nearly all systems have these. If you are attaching a printer + to one of these ports, the Printing section of the handbook is very useful. If you are using modem, Dialup access provides extensive detail on serial port configuration for use with such devices. @@ -973,10 +973,10 @@ Note that if you have an internal modem on COM4 and a serial port at COM2 you will have to change the IRQ of the modem to 2 (for obscure technical reasons IRQ 2 = IRQ 9) - in order to access it from FreeBSD. If you have a + in order to access it from FreeBSD. If you have a multiport serial card, check the manual page for sio4 for more information on the - proper values for these lines. Some video cards (notably + proper values for these lines. Some video cards (notably those based on S3 chips) use IO addresses of the form 0x*2e8, and since many cheap serial cards do not fully decode the 16-bit IO address space, @@ -995,7 +995,7 @@ lpt0 through lpt2 are the three printer ports you - could conceivably have. Most people just have one, + could conceivably have. Most people just have one, though, so feel free to comment out the other two lines if you do not have them. @@ -1009,7 +1009,7 @@ Networking FreeBSD, as with Unix in general, places a - big emphasis on networking. Therefore, even + big emphasis on networking. Therefore, even if you do not have an Ethernet card, pay attention to the mandatory options and the dial-up networking support. @@ -1017,9 +1017,9 @@ options INET - Networking support. Leave it in even if you do not - plan to be connected to a network. Most programs require - at least loopback networking (i.e. making network + Networking support. Leave it in even if you do not + plan to be connected to a network. Most programs require + at least loopback networking (i.e. making network connections within your PC) so this is essentially mandatory. @@ -1029,8 +1029,8 @@ The next lines enable support for various Ethernet - cards. If you do not have a network card, you can comment - out all of these lines. Otherwise, you will want to leave + cards. If you do not have a network card, you can comment + out all of these lines. Otherwise, you will want to leave in support for your particular Ethernet card(s): @@ -1181,9 +1181,9 @@ loop is the generic - loopback device for TCP/IP. If you telnet or FTP to - localhost (a.k.a. 127.0.0.1) it will come back at you - through this pseudo-device. Mandatory. + loopback device for TCP/IP. If you telnet or FTP to + localhost (a.k.a. 127.0.0.1) it will come back at you + through this pseudo-device. Mandatory. @@ -1201,12 +1201,12 @@ sl is for SLIP (Serial - Line Internet Protocol) support. This has been almost + Line Internet Protocol) support. This has been almost entirely supplanted by PPP, which is easier to set up, better suited for modem-to-modem connections, as well as - more powerful. The number after + more powerful. The number after sl specifies how many - simultaneous SLIP sessions to support. This handbook has + simultaneous SLIP sessions to support. This handbook has more information on setting up a SLIP client or server. @@ -1218,11 +1218,11 @@ ppp is for kernel-mode PPP (Point-to-Point Protocol) support for dial-up Internet - connections. There is also version of PPP implemented as a + connections. There is also version of PPP implemented as a user application that uses the tun and offers more flexibility and - features such as demand dialing. If you still want to use + features such as demand dialing. If you still want to use this PPP driver, read the kernel-mode PPP - section of the handbook. As with the sl device, + section of the handbook. As with the sl device, number specifies how many simultaneous PPP connections to support. @@ -1233,10 +1233,10 @@ tun is used by the - user-mode PPP software. This program is easy to set up and - very fast. It also has special features such as automatic - dial-on-demand. The number after tun specifies the number of - simultaneous PPP sessions to support. See the tun specifies the number of + simultaneous PPP sessions to support. See the user-mode PPP section of the handbook for more information. @@ -1246,17 +1246,17 @@ number - Berkeley packet filter. This pseudo-device allows + Berkeley packet filter. This pseudo-device allows network interfaces to be placed in promiscuous mode, - capturing every packet on a broadcast network (e.g. an - ethernet). These packets can be captured to disk and/or + capturing every packet on a broadcast network (e.g. an + ethernet). These packets can be captured to disk and/or examined with the tcpdump1 program. Note that implementation of this capability can seriously - compromise your overall network security. The + compromise your overall network security. The number after bpfilter is the number of interfaces that can be examined simultaneously. Optional, not recommended except for those who are fully - aware of the potential pitfalls. Not all network cards + aware of the potential pitfalls. Not all network cards support this capability. @@ -1269,7 +1269,7 @@ Sound cards This is the first section containing lines that are not in the - GENERIC kernel. To include sound card support, you will have to + GENERIC kernel. To include sound card support, you will have to copy the appropriate lines from the LINT kernel (which contains support for every device) as follows: @@ -1277,7 +1277,7 @@ controller snd0 - Generic sound driver code. Required for all of the + Generic sound driver code. Required for all of the following sound cards except pca. @@ -1324,7 +1324,7 @@ device sbmidi0 at isa? port 0x330 - SoundBlaster 16 MIDI interface. If you have a + SoundBlaster 16 MIDI interface. If you have a SoundBlaster 16, you must include this line, or the kernel will not compile. @@ -1350,7 +1350,7 @@ conflicts - AdLib FM-synthesis audio. Include this line for + AdLib FM-synthesis audio. Include this line for AdLib, SoundBlaster, and ProAudioSpectrum users, if you want to play MIDI songs with a program such as playmidi (in the ports collection). @@ -1377,7 +1377,7 @@ tty - Digital audio through PC speaker. This is going to be + Digital audio through PC speaker. This is going to be very poor sound quality and quite CPU-intensive, so you have been warned (but it does not require a sound card). @@ -1400,7 +1400,7 @@ Pseudo-device drivers are parts of the kernel that act like device drivers but do not correspond to any actual hardware in the - machine. The network-related pseudo-devices are in that section, + machine. The network-related pseudo-devices are in that section, while the remainder are here. @@ -1408,7 +1408,7 @@ pseudo-device gzip gzip allows you to run - FreeBSD programs that have been compressed with gzip. The programs in + FreeBSD programs that have been compressed with gzip. The programs in /stand are compressed so it is a good idea to have this option in your kernel. @@ -1418,7 +1418,7 @@ log is used for logging - of kernel error messages. Mandatory. + of kernel error messages. Mandatory. @@ -1427,12 +1427,12 @@ pty is a - “pseudo-terminal” or simulated login port. It is used + “pseudo-terminal” or simulated login port. It is used by incoming telnet and rlogin sessions, xterm, and - some other applications such as emacs. The + some other applications such as emacs. The number indicates the number of - ptys to create. If you need + ptys to create. If you need more than GENERIC default of 16 simultaneous xterm windows and/or remote logins, be sure to increase this number accordingly, up to a maximum of 256. @@ -1443,24 +1443,24 @@ number - Snoop device. This pseudo-device allows one terminal + Snoop device. This pseudo-device allows one terminal session to watch another using the - watch8 command. Note that + watch8 command. Note that implementation of this capability has important security - and privacy implications. The number + and privacy implications. The number after snp is the total number of simultaneous snoop - sessions. Optional. + sessions. Optional. pseudo-device vn - Vnode driver. Allows a file to be treated as a device + Vnode driver. Allows a file to be treated as a device after being set up with the vnconfig8 - command. This driver can be useful for manipulating + command. This driver can be useful for manipulating floppy disk images and using a file as a swap device (e.g. - an MS Windows swap file). Optional. + an MS Windows swap file). Optional. @@ -1468,12 +1468,12 @@ number - Concatenated disks. This pseudo-device allows you to + Concatenated disks. This pseudo-device allows you to concatenate multiple disk partitions into one large - “meta”-disk. The number after ccd + “meta”-disk. The number after ccd is the total number of concatenated disks (not total number of disks that can be concatenated) that can be - created. (See ccd4 and + created. (See ccd4 and ccdconfig8 man pages for more details.) Optional. @@ -1487,7 +1487,7 @@ Joystick, PC Speaker, Miscellaneous This section describes some miscellaneous hardware devices - supported by FreeBSD. Note that none of these lines are included + supported by FreeBSD. Note that none of these lines are included in the GENERIC kernel, you will have to copy them from this handbook or the LINT kernel (which contains support for every device): @@ -1504,13 +1504,13 @@ Supports IBM BASIC-style noises through the PC - speaker. Some fun programs which use this are + speaker. Some fun programs which use this are /usr/sbin/spkrtest, which is a shell script that plays some simple songs, and /usr/games/piano which lets you play songs using the keyboard as a simple piano (this file only exists if you have installed the - games package). Also, the excellent + games package). Also, the excellent text role-playing game NetHack (in the ports collection) can be configured to use this device to play songs when you play musical instruments in the game. @@ -1528,17 +1528,17 @@ Making Device Nodes Almost every device in the kernel has a corresponding “node” - entry in the /dev directory. These nodes look + entry in the /dev directory. These nodes look like regular files, but are actually special entries into the kernel - which programs use to access the device. The shell script + which programs use to access the device. The shell script /dev/MAKEDEV, which is executed when you first install the operating system, creates nearly all of the device nodes - supported. However, it does not create all of + supported. However, it does not create all of them, so when you add support for a new device, it pays to make sure that the appropriate entries are in this directory, and if not, add - them. Here is a simple example: + them. Here is a simple example: - Suppose you add the IDE CD-ROM support to the kernel. The line + Suppose you add the IDE CD-ROM support to the kernel. The line to add is: @@ -1548,7 +1548,7 @@ controller wcd0 that start with wcd0 in the /dev directory, possibly followed by a letter, such as c, or preceded by the letter r, which means a “raw” - device. It turns out that those files are not there, so I must + device. It turns out that those files are not there, so I must change to the /dev directory and type: @@ -1569,7 +1569,7 @@ controller wcd0 When creating device nodes for devices such as sound cards, if other people have access to your machine, it may be desirable to protect the devices from outside access by adding them to the - /etc/fbtab file. See man + /etc/fbtab file. See man fbtab for more information. @@ -1579,7 +1579,7 @@ controller wcd0 All SCSI controllers use the same set of /dev entries, so you do not need to create - these. Also, network cards and SLIP/PPP pseudo-devices do not + these. Also, network cards and SLIP/PPP pseudo-devices do not have entries in /dev at all, so you do not have to worry about these either. @@ -1590,7 +1590,7 @@ controller wcd0 If Something Goes Wrong There are four categories of trouble that can occur when - building a custom kernel. They are: + building a custom kernel. They are: @@ -1598,10 +1598,10 @@ controller wcd0 If the config command fails when you give it your kernel description, you have - probably made a simple error somewhere. Fortunately, + probably made a simple error somewhere. Fortunately, config will print the line number that it had trouble with, so you can quickly skip to - it with vi. For example, if + it with vi. For example, if you see: @@ -1618,7 +1618,7 @@ controller wcd0 If the make command fails, it usually signals an error in your kernel description, but not severe enough for config - to catch it. Again, look over your configuration, and if + to catch it. Again, look over your configuration, and if you still cannot resolve the problem, send mail to the &a.questions; with your kernel configuration, and it should be diagnosed very quickly. @@ -1631,17 +1631,17 @@ controller wcd0 If your new kernel does not boot, or fails to recognize your devices, do not panic! Fortunately, BSD has an excellent mechanism for recovering from incompatible - kernels. Simply type the name of the kernel you want to boot + kernels. Simply type the name of the kernel you want to boot from (i.e. kernel.old) at the FreeBSD boot prompt - instead of pressing return. When reconfiguring a kernel, it + instead of pressing return. When reconfiguring a kernel, it is always a good idea to keep a kernel that is known to work on hand. After booting with a good kernel you can check over your - configuration file and try to build it again. One helpful + configuration file and try to build it again. One helpful resource is the /var/log/messages file which records, among other things, all of the kernel - messages from every successful boot. Also, the + messages from every successful boot. Also, the dmesg8 command will print the kernel messages from the current boot. @@ -1649,14 +1649,14 @@ controller wcd0 If you are having trouble building a kernel, make sure to keep a GENERIC, or some other kernel that is known to work on hand as a different name that will not get erased - on the next build. You cannot rely on + on the next build. You cannot rely on kernel.old because when installing a new kernel, kernel.old is overwritten with the last installed kernel which may be - non-functional. Also, as soon as possible, move the + non-functional. Also, as soon as possible, move the working kernel to the proper kernel location or commands such as ps1 will not work - properly. The proper command to “unlock” the + properly. The proper command to “unlock” the kernel file that make installs (in order to move another kernel back permanently) is: @@ -1684,8 +1684,8 @@ controller wcd0 for example, an experimental “2.2.0” kernel on a 2.1.0-RELEASE system, many system-status commands like ps1 and vmstat8 - will not work any more. You must recompile the libkvm library as well as these - utilities. This is one reason it is not normally a good + will not work any more. You must recompile the libkvm library as well as these + utilities. This is one reason it is not normally a good idea to use a different version of the kernel from the rest of the operating system. diff --git a/en_US.ISO_8859-1/books/handbook/kerneldebug/chapter.sgml b/en_US.ISO_8859-1/books/handbook/kerneldebug/chapter.sgml index 2507290ae1..c7e43305ab 100644 --- a/en_US.ISO_8859-1/books/handbook/kerneldebug/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/kerneldebug/chapter.sgml @@ -8,48 +8,48 @@ Debugging a Kernel Crash Dump with <command>kgdb</command> Here are some instructions for getting kernel debugging working - on a crash dump. They assume that you have enough swap space for a - crash dump. If you have multiple swap partitions and the first one + on a crash dump. They assume that you have enough swap space for a + crash dump. If you have multiple swap partitions and the first one is too small to hold the dump, you can configure your kernel to use an alternate dump device (in the config kernel line), or you can specify an alternate using the - dumpon8 command. The best way to use + dumpon8 command. The best way to use dumpon 8 is to set the dumpdev variable in - /etc/rc.conf. Typically you want to specify one of + /etc/rc.conf. Typically you want to specify one of the swap devices specified in /etc/fstab. Dumps to non-swap devices, tapes for example, - are currently not supported. Config your kernel using - config -g. See Kernel + are currently not supported. Config your kernel using + config -g. See Kernel Configuration for details on configuring the FreeBSD kernel. Use the dumpon8 command to tell the kernel where to dump to (note that this will have to be done after configuring the partition in question as swap space via - swapon8). This is normally arranged via + swapon8). This is normally arranged via /etc/rc.conf and /etc/rc. Alternatively, you can hard-code the dump device via the dump - clause in the config line of your kernel config file. This is + clause in the config line of your kernel config file. This is deprecated and should be used only if you want a crash dump from a kernel that crashes during booting. In the following, the term kgdb refers to - gdb run in “kernel debug mode”. This can be + gdb run in “kernel debug mode”. This can be accomplished by either starting the gdb with the option , or by linking and starting it - under the name kgdb. This is not being done by + under the name kgdb. This is not being done by default, however, and the idea is basically deprecated since the GNU folks do not like their tools to behave differently when - called by another name. This feature may well be discontinued in + called by another name. This feature may well be discontinued in further releases. When the kernel has been built make a copy of it, say kernel.debug, and then run strip - -d on the original. Install the original as normal. You + -d on the original. Install the original as normal. You may also install the unstripped kernel, but symbol table lookup time for some programs will drastically increase, and since the whole kernel is loaded entirely at boot time and cannot be swapped out @@ -69,13 +69,13 @@ Dumps to non-swap devices, tapes for example, This instructs savecore8 to - use another kernel for symbol name extraction. It would otherwise + use another kernel for symbol name extraction. It would otherwise default to the currently running kernel and most likely not do anything at all since the crash dump and the kernel symbols differ. Now, after a crash dump, go to - /sys/compile/WHATEVER and run kgdb. From kgdb + /sys/compile/WHATEVER and run kgdb. From kgdb do: @@ -88,7 +88,7 @@ Dumps to non-swap devices, tapes for example, kernel sources just like you can for any other program. Here is a script log of a kgdb - session illustrating the procedure. Long lines have been folded to + session illustrating the procedure. Long lines have been folded to improve readability, and the lines are numbered for reference. Despite this, it is a real-world error trace taken during the development of the pcvt console driver. @@ -203,8 +203,8 @@ Dumps to non-swap devices, tapes for example, Force usage of a new stack frame; this is no longer - necessary now. The stack frames are supposed to point to - the right locations now, even in case of a trap. (I do not + necessary now. The stack frames are supposed to point to + the right locations now, even in case of a trap. (I do not have a new core dump handy <g>, my kernel has not panicked for a rather long time.) From looking at the code in source line 403, there is a high probability that either @@ -243,9 +243,9 @@ Dumps to non-swap devices, tapes for example, Debugging a crash dump with DDD Examining a kernel crash dump with a graphical debugger like - ddd is also possible. Add the + ddd is also possible. Add the option to the ddd command line you would use - normally. For example; + normally. For example; &prompt.root; ddd -k /var/crash/kernel.0 /var/crash/vmcore.0 @@ -260,32 +260,32 @@ Dumps to non-swap devices, tapes for example, What do you do if a kernel dumped core but you did not expect it, and it is therefore not compiled using config - -g? Not everything is lost here. Do not panic! + -g? Not everything is lost here. Do not panic! - Of course, you still need to enable crash dumps. See above on + Of course, you still need to enable crash dumps. See above on the options you have to specify in order to do this. Go to your kernel compile directory, and edit the line - containing COPTFLAGS?=-O. Add the + containing COPTFLAGS?=-O. Add the option there (but do not - change anything on the level of optimization). If you do already + change anything on the level of optimization). If you do already know roughly the probable location of the failing piece of code (e.g., the pcvt driver in the example - above), remove all the object files for this code. Rebuild the - kernel. Due to the time stamp change on the Makefile, there will be + above), remove all the object files for this code. Rebuild the + kernel. Due to the time stamp change on the Makefile, there will be some other object files rebuild, for example - trap.o. With a bit of luck, the added + trap.o. With a bit of luck, the added option will not change anything for the generated code, so you will finally get a new kernel with similar - code to the faulting one but some debugging symbols. You should at + code to the faulting one but some debugging symbols. You should at least verify the old and new sizes with the - size1 command. If there is a mismatch, you + size1 command. If there is a mismatch, you probably need to give up here. - Go and examine the dump as described above. The debugging + Go and examine the dump as described above. The debugging symbols might be incomplete for some places, as can be seen in the stack trace in the example above where some functions are displayed - without line numbers and argument lists. If you need more debugging + without line numbers and argument lists. If you need more debugging symbols, remove the appropriate object files and repeat the kgdb session until you know enough. @@ -300,52 +300,52 @@ Dumps to non-swap devices, tapes for example, While kgdb as an offline debugger provides a very high level of user interface, there are some things - it cannot do. The most important ones being breakpointing and + it cannot do. The most important ones being breakpointing and single-stepping kernel code. If you need to do low-level debugging on your kernel, there is - an on-line debugger available called DDB. It allows to setting + an on-line debugger available called DDB. It allows to setting breakpoints, single-steping kernel functions, examining and changing - kernel variables, etc. However, it cannot access kernel source + kernel variables, etc. However, it cannot access kernel source files, and only has access to the global and static symbols, not to the full debug information like kgdb. To configure your kernel to include DDB, add the option line -options DDB to your config file, and rebuild. (See to your config file, and rebuild. (See Kernel Configuration for details on configuring the FreeBSD kernel. Note that if you have an older version of the boot blocks, - your debugger symbols might not be loaded at all. Update the boot + your debugger symbols might not be loaded at all. Update the boot blocks; the recent ones load the DDB symbols automagically.) Once your DDB kernel is running, there are several ways to enter - DDB. The first, and earliest way is to type the boot flag - right at the boot prompt. The kernel will start - up in debug mode and enter DDB prior to any device probing. Hence + DDB. The first, and earliest way is to type the boot flag + right at the boot prompt. The kernel will start + up in debug mode and enter DDB prior to any device probing. Hence you can even debug the device probe/attach functions. The second scenario is a hot-key on the keyboard, usually - Ctrl-Alt-ESC. For syscons, this can be remapped; some of the - distributed maps do this, so watch out. There is an option available + Ctrl-Alt-ESC. For syscons, this can be remapped; some of the + distributed maps do this, so watch out. There is an option available for serial consoles that allows the use of a serial line BREAK on the console line to enter DDB (options - BREAK_TO_DEBUGGER in the kernel config file). It is + BREAK_TO_DEBUGGER in the kernel config file). It is not the default since there are a lot of crappy serial adapters around that gratuitously generate a BREAK condition, for example when pulling the cable. The third way is that any panic condition will branch to DDB if - the kernel is configured to use it. For this reason, it is not + the kernel is configured to use it. For this reason, it is not wise to configure a kernel with DDB for a machine running unattended. - The DDB commands roughly resemble some gdb commands. The first thing you probably + The DDB commands roughly resemble some gdb commands. The first thing you probably need to do is to set a breakpoint: @@ -356,7 +356,7 @@ options DDB to your config file, and rebuild. (See Numbers are taken hexadecimal by default, but to make them distinct from symbol names; hexadecimal numbers starting with the letters a-f need to be preceded with - 0x (this is optional for other numbers). Simple + 0x (this is optional for other numbers). Simple expressions are allowed, for example: function-name + 0x103. @@ -386,7 +386,7 @@ options DDB to your config file, and rebuild. (See The first form will be accepted immediately after - a breakpoint hit, and deletes the current breakpoint. The second + a breakpoint hit, and deletes the current breakpoint. The second form can remove any breakpoint, but you need to specify the exact address; this can be obtained from: @@ -422,8 +422,8 @@ options DDB to your config file, and rebuild. (See @@ -487,9 +487,9 @@ options DDB to your config file, and rebuild. (See Now you have now examined why your kernel failed, and you wish - to reboot. Remember that, depending on the severity of previous + to reboot. Remember that, depending on the severity of previous malfunctioning, not all parts of the kernel might still be working - as expected. Perform one of the following actions to shut down and + as expected. Perform one of the following actions to shut down and reboot your system: @@ -497,8 +497,8 @@ options DDB to your config file, and rebuild. (See This will cause your kernel to dump core and reboot, so you can - later analyze the core on a higher level with kgdb. This command - usually must be followed by another continue statement. There is now an alias for + later analyze the core on a higher level with kgdb. This command + usually must be followed by another continue statement. There is now an alias for this: panic. @@ -507,7 +507,7 @@ options DDB to your config file, and rebuild. (See Which might be a good way to cleanly shut down the running system, sync() all disks, and finally - reboot. As long as the disk and file system interfaces of the + reboot. As long as the disk and file system interfaces of the kernel are not damaged, this might be a good way for an almost clean shutdown. @@ -526,7 +526,7 @@ options DDB to your config file, and rebuild. (See However, it is highly recommended to have a printed copy of the ddb4 manual page - ready for a debugging session. Remember that it is hard to read the + ready for a debugging session. Remember that it is hard to read the on-line manual while single-stepping the kernel. @@ -538,9 +538,9 @@ options DDB to your config file, and rebuild. (See GDB has already supported remote debugging - for a long time. This is done using a very simple protocol along a - serial line. Unlike the other methods described above, you will - need two machines for doing this. One is the host providing the + for a long time. This is done using a very simple protocol along a + serial line. Unlike the other methods described above, you will + need two machines for doing this. One is the host providing the debugging environment, including all the sources, and a copy of the kernel binary with all the symbols in it, and the other one is the target machine that simply runs a similar copy of the very same @@ -548,12 +548,12 @@ options DDB to your config file, and rebuild. (See You should configure the kernel in question with config -g, include into the - configuration, and compile it as usual. This gives a large blurb of - a binary, due to the debugging information. Copy this kernel to the + configuration, and compile it as usual. This gives a large blurb of + a binary, due to the debugging information. Copy this kernel to the target machine, strip the debugging symbols off with strip -x, and boot it using the boot - option. Connect the first serial line of the target machine to any - serial line of the debugging host. Now, on the debugging machine, + option. Connect the first serial line of the target machine to any + serial line of the debugging host. Now, on the debugging machine, go to the compile directory of the target kernel, and start gdb: @@ -589,8 +589,8 @@ Stopped at Debugger+0x35: movb $0, edata+0x51bc Every time you type gdb, the mode will be toggled between - remote GDB and local DDB. In order to force a next trap - immediately, simply type s (step). Your hosting GDB will now + remote GDB and local DDB. In order to force a next trap + immediately, simply type s (step). Your hosting GDB will now gain control over the target kernel: @@ -605,7 +605,7 @@ Debugger (msg=0xf01b0383 "Boot flags requested debugger") an Emacs window (which gives you an automatic source code display in another Emacs window) etc. - Remote GDB can also be used to debug LKMs. First build the LKM + Remote GDB can also be used to debug LKMs. First build the LKM with debugging symbols: @@ -625,8 +625,8 @@ EXEC 0 4 f5109000 001c f510f010 1 linux_mod Take the load address of the module and add 0x20 (probably to - account for the a.out header). This is the address that the module - code was relocated to. Use the add-symbol-file command in GDB to tell the + account for the a.out header). This is the address that the module + code was relocated to. Use the add-symbol-file command in GDB to tell the debugger about the module: @@ -644,10 +644,10 @@ text_addr = 0xf5109020? (y or n) y Debugging a Console Driver Since you need a console driver to run DDB on, things are more - complicated if the console driver itself is failing. You might + complicated if the console driver itself is failing. You might remember the use of a serial console (either with modified boot blocks, or by specifying at the Boot: prompt), and hook up a standard terminal - onto your first serial port. DDB works on any configured console + onto your first serial port. DDB works on any configured console driver, of course also on a serial console. diff --git a/en_US.ISO_8859-1/books/handbook/kernelopts/chapter.sgml b/en_US.ISO_8859-1/books/handbook/kernelopts/chapter.sgml index 4b494b6c43..bb648cd468 100644 --- a/en_US.ISO_8859-1/books/handbook/kernelopts/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/kernelopts/chapter.sgml @@ -14,23 +14,23 @@ The use of kernel options is basically described in the kernel configuration - section. There's also an explanation of “historic” and - “new-style” options. The ultimate goal is to eventually turn all + section. There's also an explanation of “historic” and + “new-style” options. The ultimate goal is to eventually turn all the supported options in the kernel into new-style ones, so for people who correctly did a make depend in their kernel compile directory after running config8, the build process will automatically pick up modified options, and only recompile those files where it is - necessary. Wiping out the old compile directory on each run of + necessary. Wiping out the old compile directory on each run of config8 as it is still done now can then be eliminated again. Basically, a kernel option is nothing else than the definition - of a C preprocessor macro for the kernel compilation process. To + of a C preprocessor macro for the kernel compilation process. To make the build truly optional, the corresponding part of the kernel source (or kernel .h file) must be written with the option concept in mind, i.e. the default must have been made - overridable by the config option. This is usually done with + overridable by the config option. This is usually done with something like: @@ -40,7 +40,7 @@ This way, an administrator mentioning another value for the option in his config file will take the default out of effect, and - replace it with his new value. Clearly, the new value will be + replace it with his new value. Clearly, the new value will be substituted into the source code during the preprocessor run, so it must be a valid C expression in whatever context the default value would have been used. @@ -63,32 +63,32 @@ People familiar with the C language will immediately recognize that everything could be counted as a “config option” where there is at least a single #ifdef - referencing it... However, it's unlikely that many people would + referencing it... However, it's unlikely that many people would put options notyet,notdef in their config file, and then wonder why the kernel compilation - falls over. :-) + falls over. :-) Clearly, using arbitrary names for the options makes it very - hard to track their usage throughout the kernel source tree. That + hard to track their usage throughout the kernel source tree. That is the rationale behind the new-style option scheme, where each option goes into a separate .h file in the kernel compile directory, which is by convention named - opt_foo.h. This way, + opt_foo.h. This way, the usual Makefile dependencies could be applied, and make can determine what needs to be recompiled once an option has been changed. The old-style option mechanism still has one advantage for local options or maybe experimental options that have a short anticipated lifetime: since it is easy to add a new #ifdef to the kernel source, this has already - made it a kernel config option. In this case, the administrator + made it a kernel config option. In this case, the administrator using such an option is responsible himself for knowing about its implications (and maybe manually forcing the recompilation of parts - of his kernel). Once the transition of all supported options has + of his kernel). Once the transition of all supported options has been done, config8 will warn whenever an unsupported option appears in the config file, but it will nevertheless include it into the kernel Makefile. @@ -102,19 +102,19 @@ options notyet,notdef sys/i386/conf/options.<arch>, e. g. sys/i386/conf/options.i386), and select an opt_foo.h file where your new option would best go into. If there is already something that comes close to the purpose of - the new option, pick this. For example, options modifying the + the new option, pick this. For example, options modifying the overall behaviour of the SCSI subsystem can go into - opt_scsi.h. By default, simply mentioning an + opt_scsi.h. By default, simply mentioning an option in the appropriate option file, say FOO, implies its value will go into the corresponding file - opt_foo.h. This can be overridden on the + opt_foo.h. This can be overridden on the right-hand side of a rule by specifying another filename. If there is no opt_foo.h already - available for the intended new option, invent a new name. Make it + available for the intended new option, invent a new name. Make it meaningful, and comment the new section in the - options[.<arch>] file. config8 will automagically pick up the change, and create that file next time it is run. Most options should go in a header file by themselves.. + options[.<arch>] file. config8 will automagically pick up the change, and create that file next time it is run. Most options should go in a header file by themselves.. Packing too many options into a single opt_foo.h will cause @@ -129,13 +129,13 @@ options notyet,notdef &prompt.user; find /usr/src/sys -name type f | xargs fgrep NEW_OPTION - is your friend in finding them. Go and edit all those files, + is your friend in finding them. Go and edit all those files, and add #include "opt_foo.h" - on top, before all the #include <xxx.h> stuff. This sequence + on top, before all the #include <xxx.h> stuff. This sequence is most important as the options could override defaults from the regular include files, if the defaults are of the form @@ -152,7 +152,7 @@ options notyet,notdef opt_foo.h cannot be included into those files since it would break the headers more seriously, but if it is not included, then places that include it - may get an inconsistent value for the option. Yes, there are + may get an inconsistent value for the option. Yes, there are precedents for this right now, but that does not make them more correct. diff --git a/en_US.ISO_8859-1/books/handbook/l10n/chapter.sgml b/en_US.ISO_8859-1/books/handbook/l10n/chapter.sgml index b37df3d188..e9444cd3d6 100644 --- a/en_US.ISO_8859-1/books/handbook/l10n/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/l10n/chapter.sgml @@ -52,7 +52,7 @@ font8x8=cp866-8x8 key remapped to match Russian termcap5 entry for FreeBSD console. - RUS/LAT switch will be CapsLock. Old CapsLock function still + RUS/LAT switch will be CapsLock. Old CapsLock function still available via Shift+CapsLock. CapsLock LED will indicate RUS mode, not CapsLock mode. @@ -96,7 +96,7 @@ ttyv0 "/usr/libexec/getty Pc" cons25r on secure The best way is using /etc/login.conf russian user's login class in passwd5 entry login class - position. See login.conf5 for + position. See login.conf5 for details. @@ -235,8 +235,8 @@ setenv MM_CHARSET KOI8-R Since most printers with Russian characters comes with hardware code page CP866, special output filter needed for KOI8-R - -> CP866 conversion. Such filter installed by default as - /usr/libexec/lpr/ru/koi2alt. So, Russian + -> CP866 conversion. Such filter installed by default as + /usr/libexec/lpr/ru/koi2alt. So, Russian printer /etc/printcap entry should looks like: @@ -282,7 +282,7 @@ lp|Russian local line printer:\ XFree86 port from /usr/ports/x11/XFree86 already have most recent XFree86 version, so it will work, if you - install XFree86 from this port. XFree86 version shipped + install XFree86 from this port. XFree86 version shipped with the latest FreeBSD distribution should work too (check XFree86 version number not less than 3.3 first). @@ -295,8 +295,8 @@ lp|Russian local line printer:\ &prompt.root; make all install - there. This port install latest - version of KOI8-R fonts. XFree86 3.3 already have some + there. This port install latest + version of KOI8-R fonts. XFree86 3.3 already have some KOI8-R fonts, but this ones scaled better. Check find "Files" section @@ -323,7 +323,7 @@ XkbKeymap "xfree86(ru)" line into XkbDisable is turned off (commented out) there. - RUS/LAT switch will be CapsLock. Old CapsLock function still + RUS/LAT switch will be CapsLock. Old CapsLock function still available via Shift+CapsLock (in LAT mode only). @@ -346,7 +346,7 @@ XkbKeymap "xfree86(ru)" line into German Language (ISO 8859-1) - Slaven Rezic eserte@cs.tu-berlin.de wrote a tutorial how to use umlauts on a FreeBSD machine. The tutorial is written in German and available at http://www.de.freebsd.org/de/umlaute/. + Slaven Rezic eserte@cs.tu-berlin.de wrote a tutorial how to use umlauts on a FreeBSD machine. The tutorial is written in German and available at http://www.de.freebsd.org/de/umlaute/. diff --git a/en_US.ISO_8859-1/books/handbook/linuxemu/chapter.sgml b/en_US.ISO_8859-1/books/handbook/linuxemu/chapter.sgml index adf9e71a9e..a90d279f6d 100644 --- a/en_US.ISO_8859-1/books/handbook/linuxemu/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/linuxemu/chapter.sgml @@ -9,14 +9,14 @@ Linux emulation in FreeBSD has reached a point where it is possible to run a large fraction of Linux binaries in both a.out and - ELF format. The linux emulation in the 2.1-STABLE branch is capable + ELF format. The linux emulation in the 2.1-STABLE branch is capable of running Linux DOOM and Mathematica; the version present in &rel.current;-RELEASE is vastly more capable and runs all these as well as Quake, Abuse, IDL, netrek for Linux and a whole host of other programs. There are some Linux-specific operating system features that are - not supported on FreeBSD. Linux binaries will not work on FreeBSD + not supported on FreeBSD. Linux binaries will not work on FreeBSD if they use the Linux /proc filesystem (which is different from the optional FreeBSD /proc filesystem) or i386-specific calls, such as enabling virtual 8086 @@ -31,8 +31,8 @@ The GENERIC kernel in 2.1-STABLE is not configured for linux compatibility so you must reconfigure your - kernel for it. There are two ways to do this: 1. linking the - emulator statically in the kernel itself and 2. configuring your + kernel for it. There are two ways to do this: 1. linking the + emulator statically in the kernel itself and 2. configuring your kernel to dynamically load the linux loadable kernel module (LKM). @@ -50,7 +50,7 @@ options COMPAT_LINUX options SYSVSHM The linux system calls require 4.3BSD system - call compatibility. So make sure you have the following. + call compatibility. So make sure you have the following. options "COMPAT_43" @@ -67,7 +67,7 @@ options LINUX section. If you decide to use the LKM you must also install the - loadable module. A mismatch of versions between the kernel and + loadable module. A mismatch of versions between the kernel and loadable module can cause the kernel to crash, so the safest thing to do is to reinstall the LKM when you install the kernel. @@ -95,11 +95,11 @@ Module Name EXEC 0 3 f0baf000 0018 f0bb4000 1 linux_emulator You can cause the LKM to be loaded when the - system boots in either of two ways. In FreeBSD 2.2.1-RELEASE and + system boots in either of two ways. In FreeBSD 2.2.1-RELEASE and 2.1-STABLE enable it in /etc/sysconfig -linux=YES by changing it from NO to YES. FreeBSD 2.1 +linux=YES by changing it from NO to YES. FreeBSD 2.1 RELEASE and earlier do not have such a line and on those you will need to edit /etc/rc.local to add the following line. @@ -112,9 +112,9 @@ linux Installing Linux Emulation in 2.2.2-RELEASE and later It is no longer necessary to specify options LINUX or - options COMPAT_LINUX. Linux emulation is done with an LKM + options COMPAT_LINUX. Linux emulation is done with an LKM (“Loadable Kernel Module”) so it can be installed on the fly - without having to reboot. You will need the following things in + without having to reboot. You will need the following things in your startup files, however: @@ -149,14 +149,14 @@ EXEC 0 4 f09e6000 001c f09ec010 1 linux_mod However, there have been reports that this - fails on some 2.2-RELEASE and later systems. If for some reason + fails on some 2.2-RELEASE and later systems. If for some reason you cannot load the linux LKM, then statically link the emulator in the kernel by adding options LINUX - to your kernel config file. Then run config + to your kernel config file. Then run config and install the new kernel as described in the kernel configuration section. @@ -170,7 +170,7 @@ options LINUX Installing using the linux_lib port Most linux applications use shared libraries, so you are - still not done until you install the shared libraries. It is + still not done until you install the shared libraries. It is possible to do this by hand, however, it is vastly simpler to just grab the linux_lib port: @@ -179,12 +179,12 @@ options LINUX &prompt.root; make all install - and you should have a working linux emulator. Legend (and + and you should have a working linux emulator. Legend (and the mail archives :-) seems to hold that Linux emulation works best with linux binaries linked against the ZMAGIC libraries; QMAGIC libraries (such as those used in Slackware V2.0) may tend - to give the Linuxulator heartburn. Also, expect some programs to complain - about incorrect minor versions of the system libraries. In + to give the Linuxulator heartburn. Also, expect some programs to complain + about incorrect minor versions of the system libraries. In general, however, this does not seem to be a problem. @@ -194,17 +194,17 @@ options LINUX Installing libraries manually If you do not have the “ports” distribution, you can - install the libraries by hand instead. You will need the Linux + install the libraries by hand instead. You will need the Linux shared libraries that the program depends on and the runtime - linker. Also, you will need to create a "shadow root" + linker. Also, you will need to create a "shadow root" directory, /compat/linux, for Linux - libraries on your FreeBSD system. Any shared libraries opened + libraries on your FreeBSD system. Any shared libraries opened by Linux programs run under FreeBSD will look in this tree - first. So, if a Linux program loads, for example, + first. So, if a Linux program loads, for example, /lib/libc.so, FreeBSD will first try to open /compat/linux/lib/libc.so, and if that does not exist then it will try - /lib/libc.so. Shared libraries should be + /lib/libc.so. Shared libraries should be installed in the shadow tree /compat/linux/lib rather than the paths that the Linux ld.so reports. @@ -216,7 +216,7 @@ options LINUX Generally, you will need to look for the shared libraries that Linux binaries depend on only the first few times that you - install a Linux program on your FreeBSD system. After a while, + install a Linux program on your FreeBSD system. After a while, you will have a sufficient set of Linux shared libraries on your system to be able to run newly imported Linux binaries without any extra work. @@ -235,7 +235,7 @@ options LINUX If you have access to a Linux system, see what shared libraries the application needs, and copy them to your FreeBSD system. - Example: you have just ftp'ed the Linux binary of Doom. Put it + Example: you have just ftp'ed the Linux binary of Doom. Put it on the Linux system you have access to, and check which shared libraries it needs by running ldd linuxxdoom: @@ -266,9 +266,9 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 a matching major revision number to the first column of the ldd output, you will not need to copy the file named in the last column to your system, the one you already have should - work. It is advisable to copy the shared library anyway if it - is a newer version, though. You can remove the old one, as - long as you make the symbolic link point to the new one. So, + work. It is advisable to copy the shared library anyway if it + is a newer version, though. You can remove the old one, as + long as you make the symbolic link point to the new one. So, if you have these libraries on your system: @@ -299,7 +299,7 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 The symbolic link mechanism is only - needed for Linux binaries. The FreeBSD runtime linker takes + needed for Linux binaries. The FreeBSD runtime linker takes care of looking for matching major revision numbers itself and you do not need to worry about it. @@ -314,7 +314,7 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 Finally, if you run FreeBSD 2.2-RELEASE you must make sure that you have the Linux runtime linker and its config files on - your system. You should copy these files from the Linux system + your system. You should copy these files from the Linux system to their appropriate place on your FreeBSD system (to the /compat/linux tree): @@ -324,8 +324,8 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 If you do not have access to a Linux system, you should get - the extra files you need from various ftp sites. Information on - where to look for the various files is appended below. For now, + the extra files you need from various ftp sites. Information on + where to look for the various files is appended below. For now, let us assume you know where to get the files. Retrieve the following files (all from the same ftp site to @@ -343,16 +343,16 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 ldconfig and ldd do not necessarily need to be under /compat/linux; you can install them - elsewhere in the system too. Just make sure they do not conflict - with their FreeBSD counterparts. A good idea would be to install + elsewhere in the system too. Just make sure they do not conflict + with their FreeBSD counterparts. A good idea would be to install them in /usr/local/bin as ldconfig-linux and ldd-linux. Create the file /compat/linux/etc/ld.so.conf, containing the directories in which the Linux runtime linker should look - for shared libs. It is a plain text file, containing a directory - name on each line. /lib and + for shared libs. It is a plain text file, containing a directory + name on each line. /lib and /usr/lib are standard, you could add the following: @@ -362,7 +362,7 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 When a linux binary opens a library such as /lib/libc.so the emulator maps the name to - /compat/linux/lib/libc.so internally. All + /compat/linux/lib/libc.so internally. All linux libraries should be installed under /compat/linux (e.g. /compat/linux/lib/libc.so, /compat/linux/usr/X11/lib/libX11.so, etc.) @@ -378,7 +378,7 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 ldconfig is statically linked, so it does not need any - shared libraries to run. It creates the file + shared libraries to run. It creates the file /compat/linux/etc/ld.so.cache which contains the names of all the shared libraries and should be rerun to recreate this file whenever you install additional @@ -390,8 +390,8 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 and ldconfig is not needed or used. You should now be set up for Linux binaries which only need - a shared libc. You can test this by running the Linux ldd on - itself. Supposing that you have it installed as ldd-linux, it + a shared libc. You can test this by running the Linux ldd on + itself. Supposing that you have it installed as ldd-linux, it should produce something like: @@ -400,19 +400,19 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 This being done, you are ready to install new Linux - binaries. Whenever you install a new Linux program, you should + binaries. Whenever you install a new Linux program, you should check if it needs shared libraries, and if so, whether you have them installed in the /compat/linux tree. To do this, you run the Linux version ldd on the new program, - and watch its output. ldd (see also the manual page for ldd1) + and watch its output. ldd (see also the manual page for ldd1) will print a list of shared libraries that the program depends on, in the form majorname (jumpversion) => fullname. If it prints not found instead of fullname it means that - you need an extra library. The library needed is shown in - majorname and will be of the form libXXXX.so.N. You will need to + you need an extra library. The library needed is shown in + majorname and will be of the form libXXXX.so.N. You will need to find a libXXXX.so.N.mm on a Linux ftp site, and install it on - your system. The XXXX (name) and N (major revision number) + your system. The XXXX (name) and N (major revision number) should match; the minor number(s) mm are less important, though it is advised to take the most recent version. @@ -423,7 +423,7 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 Installing Linux ELF binaries ELF binaries sometimes require an extra step of - “branding”. If you attempt to run an unbranded ELF binary, + “branding”. If you attempt to run an unbranded ELF binary, you will get an error message like the following; @@ -466,18 +466,18 @@ multi on where the order here specifies that /etc/hosts is searched first and DNS is - searched second. When + searched second. When /compat/linux/etc/host.conf is not installed linux applications find FreeBSD's /etc/host.conf and complain about the - incompatible FreeBSD syntax. You should remove bind if you + incompatible FreeBSD syntax. You should remove bind if you have not configured a name-server using the /etc/resolv.conf file. Lastly, those who run 2.1-STABLE need to set an the RESOLV_HOST_CONF environment variable so that applications will - know how to search the host tables. If you run FreeBSD - 2.2-RELEASE or later, you can skip this. For the + know how to search the host tables. If you run FreeBSD + 2.2-RELEASE or later, you can skip this. For the /bin/csh shell use: @@ -503,12 +503,12 @@ multi on Linux is distributed by several groups that make their own set - of binaries that they distribute. Each distribution has its own - name, like “Slackware” or “Yggdrasil”. The distributions are - available on a lot of ftp sites. Sometimes the files are unpacked, + of binaries that they distribute. Each distribution has its own + name, like “Slackware” or “Yggdrasil”. The distributions are + available on a lot of ftp sites. Sometimes the files are unpacked, and you can get the individual files you need, but mostly they are stored in distribution sets, usually consisting of subdirectories - with gzipped tar files in them. The primary ftp sites for the + with gzipped tar files in them. The primary ftp sites for the distributions are: @@ -538,15 +538,15 @@ multi on - For simplicity, let us concentrate on Slackware here. This + For simplicity, let us concentrate on Slackware here. This distribution consists of a number of subdirectories, containing - separate packages. Normally, they are controlled by an install - program, but you can retrieve files “by hand” too. First of all, + separate packages. Normally, they are controlled by an install + program, but you can retrieve files “by hand” too. First of all, you will need to look in the contents subdir of the - distribution. You will find a lot of small text files here - describing the contents of the separate packages. The fastest way + distribution. You will find a lot of small text files here + describing the contents of the separate packages. The fastest way to look something up is to retrieve all the files in the contents - subdirectory, and grep through them for the file you need. Here is + subdirectory, and grep through them for the file you need. Here is an example of a list of files that you might need, and in which contents-file you will find it by grepping through them: @@ -585,10 +585,10 @@ multi on So, in this case, you will need the packages ldso, shlibs, - xf_lib and oldlibs. In each of the contents-files for these + xf_lib and oldlibs. In each of the contents-files for these packages, look for a line saying PACKAGE LOCATION, it will tell you on which “disk” the package is, in our case it will tell - us in which subdirectory we need to look. For our example, we + us in which subdirectory we need to look. For our example, we would find the following locations: @@ -611,7 +611,7 @@ multi on The locations called “diskXX” refer to the slakware/XX subdirectories of the distribution, others may be found in the - contrib subdirectory. In this case, we + contrib subdirectory. In this case, we could now retrieve the packages we need by retrieving the following files (relative to the root of the Slackware distribution tree): @@ -655,13 +655,13 @@ multi on This document shows how to install the Linux binary distribution of Mathematica 2.2 on FreeBSD 2.1. - Mathematica supports Linux but not FreeBSD as it stands. So + Mathematica supports Linux but not FreeBSD as it stands. So once you have configured your system for Linux compatibility you have most of what you need to run Mathematica. For those who already have the student edition of Mathematica for DOS the cost of upgrading to the Linux version at the time this - was written, March 1996, was $45.00. It can be ordered directly + was written, March 1996, was $45.00. It can be ordered directly from Wolfram at (217) 398-6500 and paid for by credit card. @@ -670,8 +670,8 @@ multi on The binaries are currently distributed by Wolfram on CDROM. The CDROM has about a dozen tar files, each of which is a binary - distribution for one of the supported architectures. The one for - Linux is named LINUX.TAR. You can, for + distribution for one of the supported architectures. The one for + Linux is named LINUX.TAR. You can, for example, unpack this into /usr/local/Mathematica: @@ -703,14 +703,14 @@ richc.isdn.bcm.tmc.edu 9845-03452-90255 So, for example, the “machine ID” of richc is - 9845-03452-90255. You can ignore the message about the ioctl - that is not implemented. It will not prevent Mathematica from + 9845-03452-90255. You can ignore the message about the ioctl + that is not implemented. It will not prevent Mathematica from running in any way and you can safely ignore it, though you will see the message every time you run Mathematica. When you register with Wolfram, either by email, phone or fax, you will give them the “machine ID” and they will respond with a - corresponding password consisting of groups of numbers. You need + corresponding password consisting of groups of numbers. You need to add them both along with the machine name and license number in your mathpass file. @@ -722,21 +722,21 @@ richc.isdn.bcm.tmc.edu 9845-03452-90255 It will ask you to enter your license number - and the Wolfram supplied password. If you get them mixed up or + and the Wolfram supplied password. If you get them mixed up or for some reason the math.install fails, that is OK; you can simply edit the file mathpass in this same directory to correct the info manually. After getting past the password, math.install will ask you if you accept the install defaults provided, or if you want to use - your own. If you are like us and distrust all install programs, - you probably want to specify the actual directories. Beware. + your own. If you are like us and distrust all install programs, + you probably want to specify the actual directories. Beware. Although the math.install program asks you to specify directories, it will not create them for you, so you should perhaps have a second window open with another shell so that you can create them - before you give them to the install program. Or, if it fails, you + before you give them to the install program. Or, if it fails, you can create the directories and then restart the math.install - program. The directories we chose to create beforehand and + program. The directories we chose to create beforehand and specify to math.install were: @@ -762,23 +762,23 @@ richc.isdn.bcm.tmc.edu 9845-03452-90255 You can also tell it to use /tmp/math.record for the system record file, - where it puts logs of sessions. After this math.install will + where it puts logs of sessions. After this math.install will continue on to unpacking things and placing everything where it should go. The Mathematica Notebook feature is included separately, as - the X Front End, and you have to install it separately. To get the + the X Front End, and you have to install it separately. To get the X Front End stuff correctly installed, cd into the /usr/local/Mathematica/FrontEnd directory and - execute the xfe.install shell script. You will have to tell it + execute the xfe.install shell script. You will have to tell it where to put things, but you do not have to create any directories because it will use the same directories that had been created for - math.install. When it finishes, there should be a new shell script + math.install. When it finishes, there should be a new shell script in /usr/local/Mathematica/bin called mathematica. Lastly, you need to modify each of the shell scripts that - Mathematica has installed. At the beginning of every shell script + Mathematica has installed. At the beginning of every shell script in /usr/local/Mathematica/bin add the following line: @@ -798,7 +798,7 @@ richc.isdn.bcm.tmc.edu 9845-03452-90255 This tells Mathematica to use the linux version - of host.conf. This file has a different syntax from FreeBSD's + of host.conf. This file has a different syntax from FreeBSD's host.conf, so you will get an error message about /etc/host.conf if you leave this out. @@ -809,11 +809,11 @@ richc.isdn.bcm.tmc.edu 9845-03452-90255 /usr/local/Mathematica/bin to your path. - That is about all it takes. With this you should be able to + That is about all it takes. With this you should be able to type mathematica and get a really slick looking Mathematica - Notebook screen up. Mathematica has included the Motif user + Notebook screen up. Mathematica has included the Motif user interfaces, but it is compiled in statically, so you do not need - the Motif libraries. Good luck doing this yourself! + the Motif libraries. Good luck doing this yourself! diff --git a/en_US.ISO_8859-1/books/handbook/mirrors/chapter.sgml b/en_US.ISO_8859-1/books/handbook/mirrors/chapter.sgml index d47e578e4e..fc41eedd55 100644 --- a/en_US.ISO_8859-1/books/handbook/mirrors/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/mirrors/chapter.sgml @@ -37,7 +37,7 @@ on static lists of hosts. Additionally, FreeBSD is available via anonymous FTP from the - following mirror sites. If you choose to obtain FreeBSD via + following mirror sites. If you choose to obtain FreeBSD via anonymous FTP, please try to use a site near you. Argentina, @@ -831,7 +831,7 @@ The latest versions of export-restricted code for FreeBSD (2.0C or later) (eBones and secure) are being made available at the - following locations. If you are outside the U.S. or Canada, please + following locations. If you are outside the U.S. or Canada, please get secure (DES) and eBones (Kerberos) from one of the following foreign distribution sites: @@ -902,7 +902,7 @@ CTM Sites CTM/FreeBSD is available via - anonymous FTP from the following mirror sites. If you choose to + anonymous FTP from the following mirror sites. If you choose to obtain CTM via anonymous FTP, please try to use a site near you. @@ -989,7 +989,7 @@ If you did not find a mirror near to you or the mirror is incomplete, try FTP search at http://ftpsearch.ntnu.no/ftpsearch. FTP search is a great free archie server in Trondheim, Norway. + URL="http://ftpsearch.ntnu.no/ftpsearch/">http://ftpsearch.ntnu.no/ftpsearch. FTP search is a great free archie server in Trondheim, Norway. @@ -1379,18 +1379,18 @@ The following CVSup site is especially designed for CTM users. Unlike the other CVSup mirrors, - it is kept up-to-date by CTM. That means if you CVSup cvs-all with release=cvs + linkend="ctm">CTM users. Unlike the other CVSup mirrors, + it is kept up-to-date by CTM. That means if you CVSup cvs-all with release=cvs from this site, you get a version of the repository (including the inevitable .ctm_status file) which is - suitable for being updated using the CTM cvs-cur deltas. This allows users who track + suitable for being updated using the CTM cvs-cur deltas. This allows users who track the entire cvs-all tree to go from CVSup to CTM without having to rebuild their repository from scratch using a fresh CTM base delta. This special feature only works for the cvs-all distribution with - cvs as the release tag. CVSupping any other + cvs as the release tag. CVSupping any other distribution and/or release will get you the specified distribution, but it will not be suitable for CTM updating. @@ -1398,8 +1398,8 @@ Because the current version of CTM does not preserve the timestamps of files, the timestamps at this mirror site are not - the same as those at other mirror sites. Switching between this - site and other sites is not recommended. It will work correctly, + the same as those at other mirror sites. Switching between this + site and other sites is not recommended. It will work correctly, but will be somewhat inefficient. diff --git a/en_US.ISO_8859-1/books/handbook/pgpkeys/chapter.sgml b/en_US.ISO_8859-1/books/handbook/pgpkeys/chapter.sgml index 4323cc68e1..e22fe1c300 100644 --- a/en_US.ISO_8859-1/books/handbook/pgpkeys/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/pgpkeys/chapter.sgml @@ -2,7 +2,7 @@ PGP keys In case you need to verify a signature or send encrypted email to - one of the officers or core team members a number of keys are + one of the officers or core team members a number of keys are provided here for your convenience. diff --git a/en_US.ISO_8859-1/books/handbook/policies/chapter.sgml b/en_US.ISO_8859-1/books/handbook/policies/chapter.sgml index 500b2b1d46..6ea699c051 100644 --- a/en_US.ISO_8859-1/books/handbook/policies/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/policies/chapter.sgml @@ -24,22 +24,22 @@ MAINTAINER= email-addresses The semantics of this are as follows: - The maintainer owns and is responsible for that code. This + The maintainer owns and is responsible for that code. This means that he is responsible for fixing bugs and answer problem reports pertaining to that piece of the code, and in the case of contributed software, for tracking new versions, as appropriate. Changes to directories which have a maintainer defined shall be - sent to the maintainer for review before being committed. Only if + sent to the maintainer for review before being committed. Only if the maintainer does not respond for an unacceptable period of time, to several emails, will it be acceptable to commit changes without - review by the maintainer. However, it is suggested that you try and + review by the maintainer. However, it is suggested that you try and have the changes reviewed by someone else if at all possible. It is of course not acceptable to add a person or group as - maintainer unless they agree to assume this duty. On the other hand + maintainer unless they agree to assume this duty. On the other hand it doesn't have to be a committer and it can easily be a group of people. @@ -48,44 +48,44 @@ MAINTAINER= email-addresses Contributed Software - Contributed by &a.phk; and &a.obrien;. + Contributed by &a.phk; and &a.obrien;. June 1996. Some parts of the FreeBSD distribution consist of software that - is actively being maintained outside the FreeBSD project. For + is actively being maintained outside the FreeBSD project. For historical reasons, we call this contributed - software. Some examples are perl, gcc and patch. + software. Some examples are perl, gcc and patch. Over the last couple of years, various methods have been used in dealing with this type of software and all have some number of - advantages and drawbacks. No clear winner has emerged. + advantages and drawbacks. No clear winner has emerged. Since this is the case, after some debate one of these methods has been selected as the “official” method and will be required for - future imports of software of this kind. Furthermore, it is + future imports of software of this kind. Furthermore, it is strongly suggested that existing contributed software converge on this model over time, as it has significant advantages over the old method, including the ability to easily obtain diffs relative to the “official” versions of the source by everyone (even without cvs - access). This will make it significantly easier to return changes + access). This will make it significantly easier to return changes to the primary developers of the contributed software. Ultimately, however, it comes down to the people actually doing - the work. If using this model is particularly unsuited to the + the work. If using this model is particularly unsuited to the package being dealt with, exceptions to these rules may be granted only with the approval of the core team and with the general - consensus of the other developers. The ability to maintain the + consensus of the other developers. The ability to maintain the package in the future will be a key issue in the decisions. Because of some unfortunate design limitations with the RCS file format and CVS's use of vendor branches, minor, trivial and/or cosmetic changes are strongly discouraged on - files that are still tracking the vendor branch. “Spelling + files that are still tracking the vendor branch. “Spelling fixes” are explicitly included here under the “cosmetic” category and are to be avoided for files with - revision 1.1.x.x. The repository bloat impact from a single character + revision 1.1.x.x. The repository bloat impact from a single character change can be rather dramatic. @@ -93,8 +93,8 @@ MAINTAINER= email-addresses language will be used as example of how this model works: src/contrib/tcl contains the source as - distributed by the maintainers of this package. Parts that are - entirely not applicable for FreeBSD can be removed. In the case of + distributed by the maintainers of this package. Parts that are + entirely not applicable for FreeBSD can be removed. In the case of Tcl, the mac, win and compat subdirectories were eliminated before the import @@ -111,23 +111,23 @@ MAINTAINER= email-addresses src/tools/tools/tcl_bmake contains a couple of shell-scripts that can be of help when the tcl software needs - updating. These are not part of the built or installed + updating. These are not part of the built or installed software. The important thing here is that the src/contrib/tcl directory is created according to the rules: It is supposed to contain the sources as distributed (on a proper CVS vendor-branch and without RCS keyword expansion) with as few FreeBSD-specific changes - as possible. The 'easy-import' tool on freefall will assist in + as possible. The 'easy-import' tool on freefall will assist in doing the import, but if there are any doubts on how to go about it, it is imperative that you ask first and not blunder ahead and hope - it “works out”. CVS is not forgiving of import accidents and a fair + it “works out”. CVS is not forgiving of import accidents and a fair amount of effort is required to back out major mistakes. Because of the previously mentioned design limitations with CVS's vendor branches, it is required that “official” patches from the vendor be applied to the original distributed sources and the result - re-imported onto the vendor branch again. Official patches should + re-imported onto the vendor branch again. Official patches should never be patched into the FreeBSD checked out version and "committed", as this destroys the vendor branch coherency and makes importing future versions rather difficult as there will be @@ -136,7 +136,7 @@ MAINTAINER= email-addresses Since many packages contain files that are meant for compatibility with other architectures and environments that FreeBSD, it is permissible to remove parts of the distribution tree - that are of no interest to FreeBSD in order to save space. Files + that are of no interest to FreeBSD in order to save space. Files containing copyright notices and release-note kind of information applicable to the remaining files shall not be removed. @@ -144,7 +144,7 @@ MAINTAINER= email-addresses If it seems easier, the bmake Makefiles can be produced from the dist tree automatically by some utility, something which would hopefully make it even easier to upgrade to a - new version. If this is done, be sure to check in such utilities + new version. If this is done, be sure to check in such utilities (as necessary) in the src/tools directory along with the port itself so that it is available to future maintainers. @@ -180,14 +180,14 @@ MAINTAINER= email-addresses However, please do not import FREEBSD-upgrade with the contributed source. Rather you should cvs add FREEBSD-upgrade ; cvs ci after the - initial import. Example wording from + initial import. Example wording from src/contrib/cpio is below: This directory contains virgin sources of the original distribution files -on a "vendor" branch. Do not, under any circumstances, attempt to upgrade -the files in this directory via patches and a cvs commit. New versions or -official-patch versions must be imported. Please remember to import with +on a "vendor" branch. Do not, under any circumstances, attempt to upgrade +the files in this directory via patches and a cvs commit. New versions or +official-patch versions must be imported. Please remember to import with "-ko" to prevent CVS from corrupting any vendor RCS Ids. For the import of GNU cpio 2.4.2, the following files were removed: @@ -233,7 +233,7 @@ obrien@freebsd.org - 30 March 1997 If you are adding shared library support to a port or other piece of software that doesn't have one, the version numbers should - follow these rules. Generally, the resulting numbers will have + follow these rules. Generally, the resulting numbers will have nothing to do with the release version of the software. The three principles of shared library building are: @@ -260,14 +260,14 @@ obrien@freebsd.org - 30 March 1997 For instance, added functions and bugfixes result in the minor version number being bumped, while deleted functions, changed - function call syntax etc. will force the major version number to + function call syntax etc. will force the major version number to change. - Stick to version numbers of the form major.minor (x.y). Our + Stick to version numbers of the form major.minor (x.y). Our dynamic linker does not handle version numbers of the form x.y.z - well. Any version number after the y (ie. the third digit) is + well. Any version number after the y (ie. the third digit) is totally ignored when comparing shared lib version numbers to decide - which library to link with. Given two shared libraries that differ + which library to link with. Given two shared libraries that differ only in the “micro” revision, ld.so will link with the higher one. Ie: if you link with libfoo.so.3.3.3, the linker only records 3.3 in the headers, and will link with anything @@ -276,14 +276,14 @@ obrien@freebsd.org - 30 March 1997 ld.so will always use the highest - “minor” revision. Ie: it will use libc.so.2.2 + “minor” revision. Ie: it will use libc.so.2.2 in preference to libc.so.2.0, even if the program was initially linked with libc.so.2.0. For non-port libraries, it is also our policy to change the - shared library version number only once between releases. When you + shared library version number only once between releases. When you make a change to a system library that requires the version number to be bumped, check the Makefile's commit logs. It is the responsibility of the committer to ensure that the first diff --git a/en_US.ISO_8859-1/books/handbook/ports/chapter.sgml b/en_US.ISO_8859-1/books/handbook/ports/chapter.sgml index 35e532e05b..0eb95aa909 100644 --- a/en_US.ISO_8859-1/books/handbook/ports/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/ports/chapter.sgml @@ -8,16 +8,16 @@ For all the hype about open standards, getting a program to work on different versions of Unix in the real world can be a tedious and - tricky business, as anyone who has tried it will know. You may be + tricky business, as anyone who has tried it will know. You may be lucky enough to find that the program you want will compile cleanly on your system, install itself in all the right places and run flawlessly - “out of the box”, but this is unfortunately rather rare. With most + “out of the box”, but this is unfortunately rather rare. With most programs, you will find yourself doing a fair bit of head-scratching, and there are quite a few programs that will result in premature greying, or even chronic alopecia... Some software distributions have attacked this problem by - providing configuration scripts. Some of these are very clever, but + providing configuration scripts. Some of these are very clever, but they have an unfortunate tendency to triumphantly announce that your system is something you have never heard of and then ask you lots of questions that sound like a final exam in system-level Unix @@ -102,7 +102,7 @@ FreeBSD ports still use the tarball mechanism, but use a skeleton to hold the "knowledge" of how to get the program working on FreeBSD, - rather than expecting the user to be able to work it out. They also + rather than expecting the user to be able to work it out. They also supply their own customised Makefile, so that almost every port can be built in the same way. @@ -110,14 +110,14 @@ If you look at a port skeleton (either on your FreeBSD system or the FTP site) and expect to find all sorts of pointy-headed rocket science lurking there, you may be disappointed by the one or two rather unexciting-looking files and directories you find there. (We will discuss in a minute how to go about the FTP site) and expect to find all sorts of pointy-headed rocket science lurking there, you may be disappointed by the one or two rather unexciting-looking files and directories you find there. (We will discuss in a minute how to go about Getting a port). - “How on earth can this do anything?” I hear you cry. “There + “How on earth can this do anything?” I hear you cry. “There is no source code there!” Fear not, gentle reader, all will become clear (hopefully). - Let's see what happens if we try and install a port. I have chosen + Let's see what happens if we try and install a port. I have chosen ElectricFence, a useful tool for developers, as the skeleton is more straightforward than most. @@ -160,7 +160,7 @@ install -c -o bin -g bin -m 444 /usr/ports/devel/ElectricFence/work/ElectricFenc The make program has noticed that you did not have a local copy of the source code and tried to FTP it down so it could get the - job done. I already had the source handy in my example, so it did + job done. I already had the source handy in my example, so it did not need to fetch it. Let's go through this and see what the make program was @@ -203,13 +203,13 @@ install -c -o bin -g bin -m 444 /usr/ports/devel/ElectricFence/work/ElectricFenc Install the program executable and other supporting files, man pages, etc. under the /usr/local hierarchy, where they will not - get mixed up with system programs. This also makes sure that + get mixed up with system programs. This also makes sure that all the ports you install will go in the same place, instead of being flung all over your system. - Register the installation in a database. This means that, + Register the installation in a database. This means that, if you do not like the program, you can cleanly remove all traces of it from your system. @@ -219,7 +219,7 @@ install -c -o bin -g bin -m 444 /usr/ports/devel/ElectricFence/work/ElectricFenc Scroll up to the make output and see if you can match these - steps to it. And if you were not impressed before, you should be by + steps to it. And if you were not impressed before, you should be by now! @@ -228,7 +228,7 @@ install -c -o bin -g bin -m 444 /usr/ports/devel/ElectricFence/work/ElectricFenc Getting a FreeBSD Port There are two ways of getting hold of the FreeBSD port for a - program. One requires a FreeBSD + program. One requires a FreeBSD CDROM, the other involves using an Internet Connection. @@ -253,17 +253,17 @@ DISTDIR= /tmp/distfiles WRKDIRPREFIX= /tmp Substitute /tmp for any place you have enough - free space. Then, just cd to the appropriate + free space. Then, just cd to the appropriate subdirectory under /cdrom/ports and type make install as - usual. WRKDIRPREFIX will cause the port to be + usual. WRKDIRPREFIX will cause the port to be build under /tmp/cdrom/ports; for instance, games/oneko will be built under /tmp/cdrom/ports/games/oneko. There are some ports for which we cannot provide the - original source in the CDROM due to licensing limitations. In + original source in the CDROM due to licensing limitations. In that case, you will need to look at the section on Compiling ports using an Internet connection. @@ -275,22 +275,22 @@ WRKDIRPREFIX= /tmp If you do not have a CDROM, or you want to make sure you get the very latest version of the port you want, you will need to download the - skeleton for the port. Now + skeleton for the port. Now this might sound like rather a fiddly job full of pitfalls, but it is actually very easy. First, if you are running a release version of FreeBSD, make sure you get the appropriate “upgradekiet” for your replease from the ports - web page. These packages include files that have been + web page. These packages include files that have been updated since the release that you may need to compile new ports. The key to the skeletons is that the FreeBSD FTP server can create on-the-fly - tarballs for you. Here is + tarballs for you. Here is how it works, with the gnats program in the databases directory as - an example (the bits in square brackets are comments. Do not type + an example (the bits in square brackets are comments. Do not type them in if you are trying this yourself!):- @@ -312,19 +312,19 @@ password. Remember to use binary (also known as image) mode!] What happened here? We connected to the FTP server in the - usual way and went to its databases sub-directory. When we gave it + usual way and went to its databases sub-directory. When we gave it the command get gnats.tar, the FTP server tarred up the gnats directory for us. We then extracted the gnats skeleton and went into the gnats - directory to build the port. As we explained earlier, the make process noticed we did not have a copy of the source locally, so it fetched one before extracting, patching and building it. - Let's try something more ambitious now. Instead of getting a + Let's try something more ambitious now. Instead of getting a single port skeleton, let's get a whole sub-directory, for example - all the database skeletons in the ports collection. It looks + all the database skeletons in the ports collection. It looks almost the same:- @@ -347,7 +347,7 @@ password. Remember to use binary (also known as image) mode!] set of database programs on our FreeBSD machine! All we did that was different from getting a single port skeleton and building it was that we got a whole directory at once, and compiled everything - in it at once. Pretty impressive, no? + in it at once. Pretty impressive, no? If you expect to be installing many ports, it is probably worth downloading all the ports directories. @@ -369,7 +369,7 @@ password. Remember to use binary (also known as image) mode!] The most important component of a skeleton is the Makefile. This contains various statements that specify how the port should - be compiled and installed. Here is the Makefile for + be compiled and installed. Here is the Makefile for ElectricFence:- @@ -404,8 +404,8 @@ do-install: linkend="ports-tarball">tarball, but without the extension. - CATEGORIES states what kind of program this is. In - this case, a utility for developers. See the CATEGORIES states what kind of program this is. In + this case, a utility for developers. See the categories section of this handbook for a complete list. @@ -423,7 +423,7 @@ do-install: Skipping over the next few lines for a minute, the line .include <bsd.port.mk> says that the other statements and commands needed for this port are - in a standard file called bsd.port.mk. As + in a standard file called bsd.port.mk. As these are the same for all ports, there is no point in duplicating them all over the place, so they are kept in a single standard file. @@ -432,7 +432,7 @@ do-install: examination of how Makefiles work; suffice it to say that the line starting with MAN3 ensures that the ElectricFence man page is compressed after installation, to help conserve your precious disk - space. The original port did not provide an install target, + space. The original port did not provide an install target, so the three lines from do-install ensure that the files produced by this port are placed in the correct destination. @@ -444,7 +444,7 @@ do-install: The file containing the checksum for the port is called md5, after the MD5 algorithm used for ports - checksums. It lives in a directory with the slightly confusing + checksums. It lives in a directory with the slightly confusing name of files. This directory can also contain other miscellaneous files that @@ -491,31 +491,31 @@ do-install: What to do when a port does not work. - Oh. You can do one of four (4) things : + Oh. You can do one of four (4) things : - Fix it yourself. Technical details on how ports work can + Fix it yourself. Technical details on how ports work can be found in Porting applications. - Gripe. This is done by e-mail only! Send such e-mail to + Gripe. This is done by e-mail only! Send such e-mail to the &a.ports; and please include the name/version of the port, where you got both the port source & distfile(s) from, and what the text of the error was. - Forget it. This is the easiest for most — very few of the + Forget it. This is the easiest for most — very few of the programs in ports can be classified as essential! - Grab the pre-compiled package from a ftp server. The + Grab the pre-compiled package from a ftp server. The “master” package collection is on FreeBSD's FTP server in the packages @@ -538,29 +538,29 @@ do-install: - Q. I thought this was going to be a discussion about + Q. I thought this was going to be a discussion about modems??! - A. Ah. You must be thinking of the serial ports on the - back of your computer. We are using “port” here to mean the + A. Ah. You must be thinking of the serial ports on the + back of your computer. We are using “port” here to mean the result of “porting” a program from one version of Unix to - another. (It is an unfortunate bad habit of computer people to + another. (It is an unfortunate bad habit of computer people to use the same word to refer to several completely different things). - Q. I thought you were supposed to use packages to install + Q. I thought you were supposed to use packages to install extra programs? - A. Yes, that is usually the quickest and easiest way of + A. Yes, that is usually the quickest and easiest way of doing it. - Q. So why bother with ports then? + Q. So why bother with ports then? - A. Several reasons:- + A. Several reasons:- @@ -572,7 +572,7 @@ do-install: - Some people do not trust binary distributions. At + Some people do not trust binary distributions. At least with source code you can (in theory) read through it and look for potential problems yourself. @@ -607,21 +607,21 @@ do-install: - Q. What is a patch? + Q. What is a patch? - A. A patch is a small (usually) file that specifies how to - go from one version of a file to another. It contains text + A. A patch is a small (usually) file that specifies how to + go from one version of a file to another. It contains text that says, in effect, things like “delete line 23”, “add these two lines after line 468” or “change line 197 to - this”. Also known as a “diff”, since it is generated by a + this”. Also known as a “diff”, since it is generated by a program of that name. - Q. What is all this about + Q. What is all this about tarballs? - A. It is a file ending in .tar or + A. It is a file ending in .tar or .tar.gz (with variations like .tar.Z, or even .tgz if you are trying to squeeze the names into a DOS @@ -629,7 +629,7 @@ do-install: Basically, it is a directory tree that has been archived into a single file (.tar) and optionally - compressed (.gz). This technique was + compressed (.gz). This technique was originally used for Tape ARchives (hence the name tar), but it is a widely used way of distributing program source code around @@ -649,19 +649,19 @@ do-install: - Q. And a checksum? + Q. And a checksum? - A. It is a number generated by adding up all the data in - the file you want to check. If any of the characters change, + A. It is a number generated by adding up all the data in + the file you want to check. If any of the characters change, the checksum will no longer be equal to the total, so a simple - comparison will allow you to spot the difference. (In + comparison will allow you to spot the difference. (In practice, it is done in a more complicated way to spot problems like position-swapping, which will not show up with a simplistic addition). - Q. I did what you said for compiling ports from a CDROM and it worked great + Q. I did what you said for compiling ports from a CDROM and it worked great until I tried to install the kermit port:- @@ -671,25 +671,25 @@ do-install: Why can it not be found? Have I got a dud CDROM? - A. The licensing terms for kermit do not allow us to put + A. The licensing terms for kermit do not allow us to put the tarball for it on the CDROM, so you will have to fetch it by hand — sorry! The reason why you got all those error messages was because you were not connected to the Internet at - the time. Once you have downloaded it from any of the sites + the time. Once you have downloaded it from any of the sites above, you can re-start the process (try and choose the nearest site to you, though, to save your time and the Internet's bandwidth). - Q. I did that, but when I tried to put it into + Q. I did that, but when I tried to put it into /usr/ports/distfiles I got some error about not having permission. - A. The ports mechanism looks for the tarball in + A. The ports mechanism looks for the tarball in /usr/ports/distfiles, but you will not be able to copy anything there because it is sym-linked to the - CDROM, which is read-only. You can tell it to look somewhere + CDROM, which is read-only. You can tell it to look somewhere else by doing @@ -698,14 +698,14 @@ do-install: - Q. Does the ports scheme only work if you have everything + Q. Does the ports scheme only work if you have everything in /usr/ports? My system administrator says I must put everything under /u/people/guests/wurzburger, but it does not seem to work. - A. You can use the PORTSDIR and PREFIX variables to tell - the ports mechanism to use different directories. For + A. You can use the PORTSDIR and PREFIX variables to tell + the ports mechanism to use different directories. For instance, @@ -739,12 +739,12 @@ do-install: - Q. I do not have a FreeBSD CDROM, but I would like to have + Q. I do not have a FreeBSD CDROM, but I would like to have all the tarballs handy on my system so I do not have to wait - for a download every time I install a port. Is there an easy + for a download every time I install a port. Is there an easy way to get them all at once? - A. To get every single tarball for the ports collection, + A. To get every single tarball for the ports collection, do @@ -765,12 +765,12 @@ do-install: - Q. I know it is probably faster to fetch the tarballs from - one of the FreeBSD mirror sites close by. Is there any way to + Q. I know it is probably faster to fetch the tarballs from + one of the FreeBSD mirror sites close by. Is there any way to tell the port to fetch them from servers other than ones listed in the MASTER_SITES? - A. Yes. If you know, for example, ftp.FreeBSD.ORG is much + A. Yes. If you know, for example, ftp.FreeBSD.ORG is much closer than sites listed in MASTER_SITES, do as following example. @@ -781,43 +781,43 @@ do-install: - Q. I want to know what files make is going to need before + Q. I want to know what files make is going to need before it tries to pull them down. - A. make fetch-list will display a list of the files + A. make fetch-list will display a list of the files needed for a port. - Q. Is there any way to stop the port from compiling? I + Q. Is there any way to stop the port from compiling? I want to do some hacking on the source before I install it, but it is a bit tiresome having to watch it and hit control-C every time. - A. Doing make extract will stop it after it has fetched + A. Doing make extract will stop it after it has fetched and extracted the source code. - Q. I am trying to make my own port and I want to be able + Q. I am trying to make my own port and I want to be able to stop it compiling until I have had a chance to see if my - patches worked properly. Is there something like make + patches worked properly. Is there something like make extract, but for patches? - A. Yep, make patch is what you want. You will probably - find the PATCH_DEBUG option useful as well. And by the way, + A. Yep, make patch is what you want. You will probably + find the PATCH_DEBUG option useful as well. And by the way, thank you for your efforts! - Q. I have heard that some compiler options can cause bugs. + Q. I have heard that some compiler options can cause bugs. Is this true? How can I make sure that I compile ports with the right settings? - A. Yes, with version 2.6.3 of gcc (the version shipped + A. Yes, with version 2.6.3 of gcc (the version shipped with FreeBSD 2.1.0 and 2.1.5), the option could result in buggy code unless you used the option as - well. (Most of the ports don't use ). You + well. (Most of the ports don't use ). You should be able to specify the compiler options used by something like @@ -826,7 +826,7 @@ do-install: or by editing /etc/make.conf, but - unfortunately not all ports respect this. The surest way is to + unfortunately not all ports respect this. The surest way is to do make configure, then go into the source directory and inspect the Makefiles by hand, but this can get tedious if the source has lots of sub-directories, each with their own @@ -834,12 +834,12 @@ do-install: - Q. There are so many ports it is hard to find the one I - want. Is there a list anywhere of what ports are available? + Q. There are so many ports it is hard to find the one I + want. Is there a list anywhere of what ports are available? - A. Look in the INDEX file in - /usr/ports. If you would like to search the - ports collection for a keyword, you can do that too. For example, + A. Look in the INDEX file in + /usr/ports. If you would like to search the + ports collection for a keyword, you can do that too. For example, you can find ports relevant to the LISP programming language using: @@ -850,25 +850,25 @@ do-install: - Q. I went to install the foo port but the system + Q. I went to install the foo port but the system suddenly stopped compiling it and starting compiling the bar - port. What's going on? + port. What's going on? - A. The foo port needs something that is supplied with + A. The foo port needs something that is supplied with bar — for instance, if foo uses graphics, bar might have - a library with useful graphics processing routines. Or bar + a library with useful graphics processing routines. Or bar might be a tool that is needed to compile the foo port. - Q. I installed the grizzle + Q. I installed the grizzle program from the ports and frankly it is a complete waste of - disk space. I want to delete it but I do not know where it put - all the files. Any clues? + disk space. I want to delete it but I do not know where it put + all the files. Any clues? - A. No problem, just do + A. No problem, just do &prompt.root; pkg_delete grizzle-6.5 @@ -877,11 +877,11 @@ do-install: - Q. Hang on a minute, you have to know the version number to - use that command. You do not seriously expect me to remember + Q. Hang on a minute, you have to know the version number to + use that command. You do not seriously expect me to remember that, do you?? - A. Not at all, you can find it out by doing + A. Not at all, you can find it out by doing &prompt.root; pkg_info -a | grep grizzle @@ -891,13 +891,13 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. Talking of disk space, the ports directory seems to be - taking up an awful lot of room. Is it safe to go in there and + Q. Talking of disk space, the ports directory seems to be + taking up an awful lot of room. Is it safe to go in there and delete things? - A. Yes, if you have installed the program and are fairly + A. Yes, if you have installed the program and are fairly certain you will not need the source again, there is no point - in keeping it hanging around. The best way to do this + in keeping it hanging around. The best way to do this is @@ -910,19 +910,19 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. I tried that and it still left all those tarballs or + Q. I tried that and it still left all those tarballs or whatever you called them in the distfiles - directory. Can I delete those as well? + directory. Can I delete those as well? - A. Yes, if you are sure you have finished with them, those + A. Yes, if you are sure you have finished with them, those can go as well. - Q. I like having lots and lots of programs to play with. + Q. I like having lots and lots of programs to play with. Is there any way of installing all the ports in one go? - A. Just do + A. Just do &prompt.root; cd /usr/ports @@ -931,22 +931,22 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. OK, I tried that, but I thought it would take a very - long time so I went to bed and left it to get on with it. When + Q. OK, I tried that, but I thought it would take a very + long time so I went to bed and left it to get on with it. When I looked at the computer this morning, it had only done three - and a half ports. Did something go wrong? + and a half ports. Did something go wrong? - A. No, the problem is that some of the ports need to ask + A. No, the problem is that some of the ports need to ask you questions that we cannot answer for you (eg “Do you want to print on A4 or US letter sized paper?”) and they need to have someone on hand to answer them. - Q. I really do not want to spend all day staring at the - monitor. Any better ideas? + Q. I really do not want to spend all day staring at the + monitor. Any better ideas? - A. OK, do this before you go to bed/work/the local + A. OK, do this before you go to bed/work/the local park:- @@ -955,7 +955,7 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc This will install every port that does - not require user input. Then, when you + not require user input. Then, when you come back, do @@ -967,12 +967,12 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. At work, we are using frobble, which is in your ports + Q. At work, we are using frobble, which is in your ports collection, but we have altered it quite a bit to get it to do - what we need. Is there any way of making our own packages, so + what we need. Is there any way of making our own packages, so we can distribute it more easily around our sites? - A. No problem, assuming you know how to make patches for + A. No problem, assuming you know how to make patches for your changes:- @@ -986,10 +986,10 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. This ports stuff is really clever. I am desperate to - find out how you did it. What is the secret? + Q. This ports stuff is really clever. I am desperate to + find out how you did it. What is the secret? - A. Nothing secret about it at all, just look at the + A. Nothing secret about it at all, just look at the bsd.ports.mk and bsd.ports.subdir.mk files in your makefiles @@ -1011,27 +1011,27 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc Making a port yourself Contributed by &a.jkh;, &a.gpalmer;, &a.asami; - &a.obrien; and &a.hoek;. 28 August 1996. + &a.obrien; and &a.hoek;. 28 August 1996. So, now you are interested in making your own port? Great! What follows are some guidelines for creating a new port for - FreeBSD. The bulk of the work is done by + FreeBSD. The bulk of the work is done by /usr/share/mk/bsd.port.mk, which all port - Makefiles include. Please refer to that file for more details on - the inner workings of the ports collection. Even if you don't + Makefiles include. Please refer to that file for more details on + the inner workings of the ports collection. Even if you don't hack Makefiles daily, it is well commented, and you will still gain much knowledge from it. Only a fraction of the overridable variables (VAR) are mentioned - in this document. Most (if not all) are documented at the start of - bsd.port.mk. This file users a non-standard - tab setting. Emacs and + in this document. Most (if not all) are documented at the start of + bsd.port.mk. This file users a non-standard + tab setting. Emacs and Vim should recognise the setting on - loading the file. vi or ex + loading the file. vi or ex can be set to use the correct value by typing :set tabstop=4 once the file has been loaded. @@ -1039,7 +1039,7 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc Quick Porting - This section tells you how to do a quick port. In many + This section tells you how to do a quick port. In many cases, it is not enough, but we will see. First, get the original tarball and put it into DISTDIR, which defaults to @@ -1048,7 +1048,7 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc The following assumes that the software compiled out-of-the-box, i.e., there was absolutely no change required - for the port to work on your FreeBSD box. If you needed to + for the port to work on your FreeBSD box. If you needed to change something, you will have to refer to the next section too. @@ -1080,10 +1080,10 @@ USE_IMAKE= yes .include <bsd.port.mk> - See if you can figure it out. Do not worry about the + See if you can figure it out. Do not worry about the contents of the $Id$ line, it will be filled in automatically by CVS when the port - is imported to our main ports tree. You can find a more + is imported to our main ports tree. You can find a more detailed example in the sample Makefile section. @@ -1106,7 +1106,7 @@ USE_IMAKE= yes This is the one-line description of the port. Please do not include the package name (or version - number of the software) in the comment. Here is + number of the software) in the comment. Here is an example: @@ -1117,7 +1117,7 @@ A cat chasing a mouse all over the screen. <filename>DESCR</filename> - This is a longer description of the port. One to a few + This is a longer description of the port. One to a few paragraphs concisely explaining what the port does is sufficient. @@ -1127,7 +1127,7 @@ A cat chasing a mouse all over the screen. Please be careful if you are copying from the README or manpage; too often they are not a concise description of the port or are in an - awkward format (e.g., manpages have justified spacing). If the + awkward format (e.g., manpages have justified spacing). If the ported software has an official WWW homepage, you should list it here. @@ -1151,12 +1151,12 @@ asami@cs.berkeley.edu <filename>PLIST</filename> - This file lists all the files installed by the port. It + This file lists all the files installed by the port. It is also called the “packing list” because the package is - generated by packing the files listed here. The pathnames + generated by packing the files listed here. The pathnames are relative to the installation prefix (usually /usr/local or - /usr/X11R6). If you are using the + /usr/X11R6). If you are using the MANn variables (as you should be), do not list any manpages here. @@ -1175,13 +1175,13 @@ lib/X11/oneko/mouse.xpm You should list all the files, but not the name - directories, in the list. Also, if the port creates + directories, in the list. Also, if the port creates directories for itself during installtion, make sure to add @dirrm lines as necessary to remove them when the port is deleted. It is recommended that you keep all the filenames in - this file sorted alphabetically. It will make verifying the + this file sorted alphabetically. It will make verifying the changes when you upgrade the port much easier. @@ -1200,7 +1200,7 @@ lib/X11/oneko/mouse.xpm Testing the port You should make sure that the port rules do exactly what - you want it to do, including packaging up the port. These are + you want it to do, including packaging up the port. These are the important points you need to verify. @@ -1260,7 +1260,7 @@ lib/X11/oneko/mouse.xpm Make sure that there aren't any warnings issued in any of the package and deinstall stages, After step 3, check - to see if all the new directories are correctly deleted. Also, + to see if all the new directories are correctly deleted. Also, try using the software after step 4, to ensure that is works correctly when installed from a package. @@ -1269,8 +1269,8 @@ lib/X11/oneko/mouse.xpm Checking your port with <command>portlint</command> Please use portlint to see if your port - conforms to our guidelines. The portlint - program is part of the ports collection. In particular, your may + conforms to our guidelines. The portlint + program is part of the ports collection. In particular, your may want to check if the Makefile is in the right shape and the package is @@ -1285,10 +1285,10 @@ lib/X11/oneko/mouse.xpm Now that you are happy with your port, the only thing remaining is to put it in the main FreeBSD ports tree and make - everybody else happy about it too. We do not need your + everybody else happy about it too. We do not need your work directory or the pkgname.tgz package, so delete them - now. Next, simply include the output of shar `find + now. Next, simply include the output of shar `find port_dir` in a bug report and send it with the send-pr @@ -1298,15 +1298,15 @@ lib/X11/oneko/mouse.xpm about send-pr 1 - . If the uncompressed port is larger than + . If the uncompressed port is larger than 20KB, you should compress it into a tarfile and use uuencode 1 before including it in the bug report (uuencoded tarfiles are acceptable even if the bug report is smaller than - 20KB but are not preferred). Be sure to classify the bug report as + 20KB but are not preferred). Be sure to classify the bug report as category ports and class - change-request. (Do not mark the report + change-request. (Do not mark the report confidential!) One more time, do not include the original source @@ -1317,7 +1317,7 @@ lib/X11/oneko/mouse.xpm In the past, we asked you to upload new port submissions in our ftp site (ftp.freebsd.org). This is no longer + role="fqdn">ftp.freebsd.org). This is no longer recommended as read access is turned off on that incoming/ directory of that site due to the large amount of pirated software showing up there. @@ -1325,7 +1325,7 @@ lib/X11/oneko/mouse.xpm We will look at your port, get back to you if necessary, and put it in the - tree. Your name will also appear in the list of “Additional + tree. Your name will also appear in the list of “Additional FreeBSD contributors” on the FreeBSD Handbook and other files. Isn't that great?!? :) @@ -1336,7 +1336,7 @@ lib/X11/oneko/mouse.xpm Slow Porting Ok, so it was not that simple, and the port required some - modifications to get it to work. In this section, we will + modifications to get it to work. In this section, we will explain, step by step, how to modify it to get it to work with the ports paradigm. @@ -1352,39 +1352,39 @@ lib/X11/oneko/mouse.xpm But do not worry if you do not really understand what bsd.port.mk is doing, not many people - do... :> + do... :> - The fetch target is run. The fetch target is + The fetch target is run. The fetch target is responsible for making sure that the tarball exists locally in DISTDIR. If fetch cannot find the required files in DISTDIR it will look up the URL MASTER_SITES, which is set in the Makefile, as well as our main ftp site at ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/, where we put sanctioned distfiles as backup. It will then attempt to fetch the named distribution file with FETCH, assuming that the requesting site has direct access to the Internet. If that succeeds, it will save the file in DISTDIR for future use and proceed. + URL="ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/">ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/, where we put sanctioned distfiles as backup. It will then attempt to fetch the named distribution file with FETCH, assuming that the requesting site has direct access to the Internet. If that succeeds, it will save the file in DISTDIR for future use and proceed. - The extract target is run. It looks for your port's + The extract target is run. It looks for your port's distribution file (typically a gzip'd tarball) in DISTDIR and unpacks it into a temporary subdirectory specified by WRKDIR (defaults to work). - The patch target is run. First, any patches defined + The patch target is run. First, any patches defined in PATCHFILES are - applied. Second, if any patches are found in PATCHDIR (defaults to the + applied. Second, if any patches are found in PATCHDIR (defaults to the patches subdirectory), they are applied at this time in alphabetical order. - The configure target is run. This can do any one of + The configure target is run. This can do any one of many different things. @@ -1414,10 +1414,10 @@ lib/X11/oneko/mouse.xpm - The build target is run. This is responsible for + The build target is run. This is responsible for descending into the port's private working directory (WRKSRC) and - building it. If USE_GMAKE is set, GNU + building it. If USE_GMAKE is set, GNU make will be used, otherwise the system make will be used. @@ -1426,7 +1426,7 @@ lib/X11/oneko/mouse.xpm - The above are the default actions. In addition, you can + The above are the default actions. In addition, you can define targets pre-something or post-something, or put scripts with those names, in the scripts subdirectory, and they will be run before or after the default @@ -1438,14 +1438,14 @@ lib/X11/oneko/mouse.xpm post-extract target will be called after the regular extraction actions, and the pre-build script will be executed before - the default build rules are done. It is recommended that you + the default build rules are done. It is recommended that you use Makefile targets if the actions are simple enough, because it will be easier for someone to figure out what kind of non-default action the port requires. The default actions are done by the - bsd.port.mk targets do-something. For example, the - commands to extract a port are in the target do-extract. If you are not happy with + bsd.port.mk targets do-something. For example, the + commands to extract a port are in the target do-extract. If you are not happy with the default target, you can fix it by redefining the do-something target in your Makefile. @@ -1454,7 +1454,7 @@ lib/X11/oneko/mouse.xpm The “main” targets (e.g., extract, configure, etc.) do nothing more than make sure all the stages up to that one are completed and call the real targets or scripts, and they are not intended - to be changed. If you want to fix the extraction, fix + to be changed. If you want to fix the extraction, fix do-extract, but never ever touch extract! @@ -1471,7 +1471,7 @@ lib/X11/oneko/mouse.xpm Get the original sources (normally) as a compressed tarball (foo.tar.gz or foo.tar.Z) and copy it into - DISTDIR. Always use + DISTDIR. Always use mainstream sources when and where you can. @@ -1479,7 +1479,7 @@ lib/X11/oneko/mouse.xpm to the net, or can only find sites that have irritatingly non-standard formats, you might want to put a copy on a reliable ftp or http server that you control (e.g., your home - page). Make sure you set MASTER_SITES to + page). Make sure you set MASTER_SITES to reflect your choice. If you @@ -1488,23 +1488,23 @@ lib/X11/oneko/mouse.xpm public_html/ directory on freefall), we can “house” it ourselves by putting - it on ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/LOCAL_PORTS/ as the last resort. Please refer to this - location as MASTER_SITE_LOCAL. Send mail to + it on ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/LOCAL_PORTS/ as the last resort. Please refer to this + location as MASTER_SITE_LOCAL. Send mail to the &a.ports;if you are not sure what to do. If your port's distfile changes all the time for no good reason, consider putting the distfile in your home page and - listing it as the first MASTER_SITES. This + listing it as the first MASTER_SITES. This will prevent users from getting checksum mismatch errors, and also reduce the workload of - maintainers of our ftp site. Also, if there isonly one master + maintainers of our ftp site. Also, if there isonly one master site for the port, it is recommended that you house a backup at your site and list it as the second MASTER_SITES. If your port requires some additional `patches' that are available on the Internet, fetch them too and put them in - DISTDIR. Do not worry if + DISTDIR. Do not worry if they come from a site other than where you got the main source tarball, we have a way to handle these situations (see the description of Unpack a copy of the tarball in a private directory and make whatever changes are necessary to get the port to compile - properly under the current version of FreeBSD. Keep + properly under the current version of FreeBSD. Keep careful track of everything you do, as - you will be automating the process shortly. Everything, + you will be automating the process shortly. Everything, including the deletion, addition or modification of files should be doable using an automated script or patch file when your port is finished. @@ -1527,7 +1527,7 @@ lib/X11/oneko/mouse.xpm If your port requires significant user interaction/customization to compile or install, you should take a look at one of Larry Wall's classic Configure scripts - and perhaps do something similar yourself. The goal of the + and perhaps do something similar yourself. The goal of the new ports collection is to make each port as “plug-and-play” as possible for the end-user while using a minimum of disk space. @@ -1545,18 +1545,18 @@ lib/X11/oneko/mouse.xpm In the preparation of the port, files that have been added or changed can be picked up with a recursive diff for later - feeding to patch. Each set of patches you wish to apply + feeding to patch. Each set of patches you wish to apply should be collected into a file named patch-xx where xx denotes the sequence in which the patches will be applied — these are done in alphabetical order, thus - aa first, ab second and so on. These files + aa first, ab second and so on. These files should be stored in PATCHDIR, from where they will be - automatically applied. All patches should be relative to + automatically applied. All patches should be relative to WRKSRC (generally the directory your port's tarball unpacks itself into, that being - where the build is done). To make fixes and upgrades easier, + where the build is done). To make fixes and upgrades easier, you should avoid having more than one patch fix the same file (e.g., patch-aa and patch-ab both changing WRKSRC/foobar.c). @@ -1567,7 +1567,7 @@ lib/X11/oneko/mouse.xpm Include any additional customization commands to your configure script and save it in the - scripts subdirectory. As mentioned + scripts subdirectory. As mentioned above, you can also do this as Makefile targets and/or scripts with the name pre-configure or @@ -1580,7 +1580,7 @@ lib/X11/oneko/mouse.xpm If your port requires user input to build, configure or install, then set IS_INTERACTIVE in your - Makefile. This will allow “overnight builds” to skip your port + Makefile. This will allow “overnight builds” to skip your port if the user sets the variable BATCH in his environment (and if the user sets the variable INTERACTIVE, then only @@ -1589,7 +1589,7 @@ lib/X11/oneko/mouse.xpm It is also recommended that if there are reasonable default answers to the questions, you check the PACKAGE_BUILDING variable and turn off the - interactive script when it is set. This will allow us to build + interactive script when it is set. This will allow us to build the packages for CD-ROMs and ftp. @@ -1612,9 +1612,9 @@ lib/X11/oneko/mouse.xpm The original source Does it live in DISTDIR as a standard gzip'd - tarball? If so, you can go on to the next step. If not, you + tarball? If so, you can go on to the next step. If not, you should look at overriding any of the EXTRACT_CMD, EXTRACT_BEFORE_ARGS, EXTRACT_AFTER_ARGS, EXTRACT_SUFX, or DISTFILES variables, depending on - how alien a format your port's distribution file is. (The + how alien a format your port's distribution file is. (The most common case is EXTRACT_SUFX=.tar.Z, when the tarball is condensed by regular compress, not gzip.) @@ -1630,7 +1630,7 @@ lib/X11/oneko/mouse.xpm <makevar>DISTNAME</makevar> You should set DISTNAME to be the base name of - your port. The default rules expect the distribution file + your port. The default rules expect the distribution file list (DISTFILES) to be named DISTNAMEEXTRACT_SUFX which, if it is a normal tarball, is going to be something like foozolix-1.0.tar.gz for a setting of DISTNAME=foozolix-1.0. @@ -1640,8 +1640,8 @@ lib/X11/oneko/mouse.xpm work/DISTNAME, e.g. work/foozolix-1.0/. All this behavior can be overridden, of course; it simply - represents the most common time-saving defaults. For a port - requiring multiple distribution files, simply set DISTFILES explicitly. If only a + represents the most common time-saving defaults. For a port + requiring multiple distribution files, simply set DISTFILES explicitly. If only a subset of DISTFILES are actual extractable archives, then set them up in EXTRACT_ONLY, which will override the DISTFILES list when @@ -1657,7 +1657,7 @@ lib/X11/oneko/mouse.xpm If DISTNAME does not conform to our guidelines for a good package name, you should set the PKGNAME - variable to something better. See the abovementioned guidelines + variable to something better. See the abovementioned guidelines for more details. @@ -1667,29 +1667,29 @@ lib/X11/oneko/mouse.xpm When a package is created, it is put under /usr/ports/packages/All and links are made from one or more subdirectories of - /usr/ports/packages. The names of these - subdirectories are specified by the variable CATEGORIES. It is intended to + /usr/ports/packages. The names of these + subdirectories are specified by the variable CATEGORIES. It is intended to make life easier for the user when he is wading through the - pile of packages on the ftp site or the CD-ROM. Please take a + pile of packages on the ftp site or the CD-ROM. Please take a look at the existing categories and pick the ones that are suitable for your port. This list also determines where in the ports tree the port - is imported. If you put more than one category here, it is + is imported. If you put more than one category here, it is assumed that the port files will be put in the subdirectory with - the name in the first category. See the categories section for more discussion about how to pick the right categories. If you port truly belongs to something that is different from all the existing ones, you can even create a new category - name. In that case, please send mail to the &a.ports; to propose + name. In that case, please send mail to the &a.ports; to propose a new category. There is no error checking for category - names. make package will happily create a + names. make package will happily create a new directory if you mustype the category name, so be careful! @@ -1699,7 +1699,7 @@ lib/X11/oneko/mouse.xpm <makevar>MASTER_SITES</makevar> Record the directory part of the ftp/http-URL pointing at - the original tarball in MASTER_SITES. Do not forget the + the original tarball in MASTER_SITES. Do not forget the trailing slash (/)! The make macros will try to use this specification for @@ -1707,7 +1707,7 @@ lib/X11/oneko/mouse.xpm already on the system. It is recommended that you put multiple sites on this - list, preferably from different continents. This will + list, preferably from different continents. This will safeguard against wide-area network problems, and we are even planning to add support for automatically determining the closest master site and fetching from there! @@ -1717,8 +1717,8 @@ lib/X11/oneko/mouse.xpm Linux Sunsite, you refer to those sites in an easy compact form using MASTER_SITE_XCONTRIB, MASTER_SITE_GNU, MASTER_SITE_PERL_CPAN, MASTER_SITE_TEX_CTAN, and - MASTER_SITE_SUNSITE. Simply set MASTER_SITE_SUBDIR to the - path with in the archive. Here is an example: + MASTER_SITE_SUNSITE. Simply set MASTER_SITE_SUBDIR to the + path with in the archive. Here is an example: MASTER_SITES= ${MASTER_SITE_XCONTRIB} @@ -1755,10 +1755,10 @@ MASTER_SITE_SUBDIR= applications If the patch is distributed with some other files, such as documentation, in a gzip'd tarball, you can't just use - PATCHFILES. If that is + PATCHFILES. If that is the case, add the name and the location of the patch tarball to DISTFILES and - MASTER_SITES. Then, from + MASTER_SITES. Then, from the pre-patch target, apply the patch either by running the patch command from there, or copying the patch file into the PATCHDIR directory and calling it @@ -1769,7 +1769,7 @@ MASTER_SITE_SUBDIR= applications regular source by then, so there is no need to explicitly extract it if it is a regular gzip'd or compress'd tarball. If you do the latter, take extra care not to overwrite - something that already exists in that directory. Also do + something that already exists in that directory. Also do not forget to add a command to remove the copied patch in the pre-clean target. @@ -1779,7 +1779,7 @@ MASTER_SITE_SUBDIR= applications <makevar>MAINTAINER</makevar> - Set your mail-address here. Please. :) + Set your mail-address here. Please. :) For detailed description of the responsibility of maintainers, refer to Dependencies - Many ports depend on other ports. There are five + Many ports depend on other ports. There are five variables that you can use to ensure that all the required - bits will be on the user's machine. There are also some + bits will be on the user's machine. There are also some pre-supported dependency variables for common cases, plus a few more to control the behaviour of dependencies. @@ -1802,12 +1802,12 @@ MASTER_SITE_SUBDIR= applications <makevar>LIB_DEPENDS</makevar> This variable specifies the shared libraries this port - depends on. It is a list of lib:dir:target tuples where + depends on. It is a list of lib:dir:target tuples where lib is the name of the shared library, and dir is the directory in which to find it in case it is not available, and target is the target to call in - that directory. For example, + that directory. For example, LIB_DEPENDS= jpeg\\.9\\.:${PORTSDIR}/graphics/jpeg:install @@ -1816,19 +1816,19 @@ LIB_DEPENDS= jpeg\\.9\\.:${PORTSDIR}/graphics/jpeg:install major version 9, and descend into the graphics/jpeg subdirectory of your ports tree to build and install it if it is not - found. The target part can be + found. The target part can be omitted if it is equal to DEPENDS_TARGET (which defaults to install). The lib part is an argument - given to ldconfig -r | grep -wF. There + given to ldconfig -r | grep -wF. There shall be no reqular expressions in this variable. The dependency is checked twice, once from within the extract target and then from within - the install target. Also, the name of the + the install target. Also, the name of the dependency is put in to the package so that pkg_add will automatically install it if it is not on the user's system. @@ -1839,12 +1839,12 @@ LIB_DEPENDS= jpeg\\.9\\.:${PORTSDIR}/graphics/jpeg:install <makevar>RUN_DEPENDS</makevar> This variable specifies executables or files this port - depends on during run-time. It is a list of path:dir:target tuples where + depends on during run-time. It is a list of path:dir:target tuples where path is the name of the executable or file, and dir is the directory in which to find it in case it is not available, and target is the target to call in - that directory. If + that directory. If path starts with a slash (/), it is treated as a file and its existence is tested with test -e; @@ -1861,7 +1861,7 @@ RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \ will check if the file or directory /usr/local/etc/innd exists, and build and install it from the news/inn - subdirectory of the ports tree if it is not found. It will + subdirectory of the ports tree if it is not found. It will also see if an executable called wish8.0 is in your search path, and descend into the x11-toolkits/tk80 subdirectory of your ports tree to build and install it if it is not @@ -1874,10 +1874,10 @@ RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \ use the full pathname. - The dependency is checked from within the install target. Also, the name of the + The dependency is checked from within the install target. Also, the name of the dependency is put in to the package so that pkg_add will automatically install it if it - is not on the user's system. The + is not on the user's system. The target part can be omitted if it is the same DEPENDS_TARGET. @@ -1887,7 +1887,7 @@ RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \ <makevar>BUILD_DEPENDS</makevar> This variable specifies executables or files this port - requires to build. Like RUN_DEPENDS, it is + requires to build. Like RUN_DEPENDS, it is a list of path:dir:target tuples. For example, @@ -1902,8 +1902,8 @@ BUILD_DEPENDS= unzip:${PORTSDIR}/archivers/unzip “build” here means everything from extracting to - compilation. The dependency is checked from within the - extract target. The + compilation. The dependency is checked from within the + extract target. The target part can be omitted if it is the same as DEPENDS_TARGET @@ -1913,8 +1913,8 @@ BUILD_DEPENDS= unzip:${PORTSDIR}/archivers/unzip <makevar>FETCH_DEPENDS</makevar> This variable specifies executables or files this port - requires to fetch. Like the previous two, it is a list of - path:dir:target tuples. For + requires to fetch. Like the previous two, it is a list of + path:dir:target tuples. For example, @@ -1926,7 +1926,7 @@ FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2 tree to build and install it if it is not found. The dependency is checked from within the - fetch target. The + fetch target. The target part can be omitted if it is the same as DEPENDS_TARGET. @@ -1938,8 +1938,8 @@ FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2 If there is a dependency that does not fall into either of the above four categories, or your port requires to have the source of the other port extracted in addition to having - them installed, then use this variable. This is a list of - dir:target, as there is nothing to check, unlike the previous four. The target part can be omitted if it is the same as DEPENDS_TARGET. + them installed, then use this variable. This is a list of + dir:target, as there is nothing to check, unlike the previous four. The target part can be omitted if it is the same as DEPENDS_TARGET. @@ -1947,15 +1947,15 @@ FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2 Define USE_XLIB=yes if your port requires the X Window System to be installed (it is implied by - USE_IMAKE). Define + USE_IMAKE). Define USE_GMAKE=yes if your port requires GNU make instead of BSD - make. Define + make. Define USE_AUTOCONF=yes if your port requires GNU - autoconf to be run. Define USE_QT=yes if - your port uses the latest qt toolkit. Use + autoconf to be run. Define USE_QT=yes if + your port uses the latest qt toolkit. Use USE_PERL5=yes if your port requires version - 5 of the perl language. (The last is especially important since + 5 of the perl language. (The last is especially important since some versions of FreeBSD has perl5 as part of the base system while others don't.) @@ -1965,25 +1965,25 @@ FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2 As mentioned above, the default target to call when a dependency is required is - DEPENDS_TARGET. It defaults to - install. This is a user variable; is is - never defined in a port's Makefile. If + DEPENDS_TARGET. It defaults to + install. This is a user variable; is is + never defined in a port's Makefile. If your port needs a special way to handle a dependency, use the :target part of the *_DEPENDS variables instead of redefining DEPENDS_TARGET. When you type make clean, its - dependencies are automatically cleaned too. If you do not wish + dependencies are automatically cleaned too. If you do not wish this to happen, define the variable NOCLEANDEPENDS in your environment. To depend on another port unconditionally, it is customary to use the string nonexistent as the first field of BUILD_DEPENDS or - RUN_DEPENDS. Use this only when you need to - the to get to the source of the other port. You can often save - compilation time by specifying the target too. For + RUN_DEPENDS. Use this only when you need to + the to get to the source of the other port. You can often save + compilation time by specifying the target too. For instance @@ -1992,10 +1992,10 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract will always descend to the JPEG port and extract it. Do not use DEPENDS unless there is no - other way the behaviour you want can be accomplished. It will + other way the behaviour you want can be accomplished. It will cause the other port to be always build (and installed, by default), and the dependency will go into the packages as - well. If this is really what you need, I recommend you + well. If this is really what you need, I recommend you write it as BUILD_DEPENDS and RUN_DEPENDS instead—at least the intention will be clear. @@ -2006,19 +2006,19 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract Building mechanisms If your package uses GNU make, set - USE_GMAKE=yes. If your package uses + USE_GMAKE=yes. If your package uses configure, set - HAS_CONFIGURE=yes. If your package uses GNU + HAS_CONFIGURE=yes. If your package uses GNU configure, set GNU_CONFIGURE=yes (this implies - HAS_CONFIGURE). If you want to give some + HAS_CONFIGURE). If you want to give some extra arguments to configure (the default argument list --prefix=${PREFIX} for GNU configure and empty for non-GNU configure), set those extra arguments in - CONFIGURE_ARGS. If your package uses GNU + CONFIGURE_ARGS. If your package uses GNU autoconf, set - USE_AUTOCONF=yes. This implies + USE_AUTOCONF=yes. This implies GNU_CONFIGURE, and will cause autoconf to be run before configure. @@ -2026,9 +2026,9 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract If your package is an X application that creates Makefiles from Imakefiles using imake, then set - USE_IMAKE=yes. This will cause the + USE_IMAKE=yes. This will cause the configure stage to automatically do an xmkmf - -a. If the flag is a + -a. If the flag is a problem for your port, set XMKMF=xmkmf. If the port uses imake but does not understand the @@ -2040,7 +2040,7 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract If your port's source Makefile has something else than all as the main build target, set ALL_TARGET - accordingly. Same goes for install and + accordingly. Same goes for install and INSTALL_TARGET. @@ -2049,7 +2049,7 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract Special considerations There are some more things you have to take into account when - you create a port. This section explains the most common of + you create a port. This section explains the most common of those. @@ -2068,7 +2068,7 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract pair to your pkg/PLIST file so that a user who installed the package can start using teh shared libraru immediately and deinstallation will not cause the system to - still believe the library is there. These lines should + still believe the library is there. These lines should immediately follow the line for the shared library itself, as in: @@ -2080,10 +2080,10 @@ lib/libtvl80.so.1 Never, ever, ever add a line that says ldconfig without any arguments to your Makefile or - pkg/PLIST. This will reset the shared + pkg/PLIST. This will reset the shared libraru cache to the contents of /usr/lib only, and will royally screw up the user's machine ("Help, xinit - does not run anymore after I install this port!"). Anybody who + does not run anymore after I install this port!"). Anybody who does this will be shot and cut in 65,536 pieces by a rusty knife and have is liver chopped out by a bunch of crows and will eternally rot to death in the deepest bowels of hell (not @@ -2096,7 +2096,7 @@ lib/libtvl80.so.1 Since FreeBSD is moving to ELF shortly after 3.0-RELEASE, we need to convert many ports that build shared libraries - to support ELF. Complicating this task is that a 3.0 + to support ELF. Complicating this task is that a 3.0 system can run as both ELF and a.out, and we wish to unofficially support the 2.2 as long as possible. Below are the guidelines on how to convert a.out only ports to @@ -2112,7 +2112,7 @@ lib/libtvl80.so.1 A.out libraries should be moved out of /usr/local/lib and similar to an - aout subdirectory. (If you don't move them + aout subdirectory. (If you don't move them out of the way, ELF ports will happily overwrite a.out libraries.) The move-aout-libs target in the 3.0-CURRENT src/Makefile (called from @@ -2125,16 +2125,16 @@ lib/libtvl80.so.1 Format The ports tree will build packages in the format the machine - is in. This means a.out for 2.2 and a.out or ELF for 3.0 depending - on what `objformat` returns. Also, once users + is in. This means a.out for 2.2 and a.out or ELF for 3.0 depending + on what `objformat` returns. Also, once users move a.out libraries to a subdirectory, building a.out libraries - will be unsupported. (I.e., it may still work if you know what you + will be unsupported. (I.e., it may still work if you know what you are doing, but you are on your own.) If a port only works for a.out, set BROKEN_ELF to a string describing the reason - why. Such ports will be skipped during a build on an ELF + why. Such ports will be skipped during a build on an ELF system. @@ -2146,10 +2146,10 @@ lib/libtvl80.so.1 PORTOBJFORMAT to aout or elf and export it in the environments CONFIGURE_ENV, SCRIPTS_ENV and - MAKE_ENV. (It's always going to be + MAKE_ENV. (It's always going to be aout in 2.2-STABLE). It is also passed to PLIST_SUB as - PORTOBJFORMAT=${PORTOBJFORMAT}. (See comment + PORTOBJFORMAT=${PORTOBJFORMAT}. (See comment on ldconfig lines below.) The variable is set using this line in @@ -2159,7 +2159,7 @@ lib/libtvl80.so.1 PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout Ports' make processes should use this variable to decide what - to do. However, if the port's configure + to do. However, if the port's configure script already automatically detects an ELF system, it is not necessary to refer to PORTOBJFORMAT. @@ -2178,7 +2178,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

libfoo.so.M where M is the single version number, and an a.out library should be called - libfoo.so.M.N where M is the major version and N is the the minor version number. Do not mix those; never install an ELF shared library called libfoo.so.N.M or an a.out shared library (or symlink) called libfoo.so.N. + libfoo.so.M.N where M is the major version and N is the the minor version number. Do not mix those; never install an ELF shared library called libfoo.so.N.M or an a.out shared library (or symlink) called libfoo.so.N. @@ -2194,7 +2194,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

You need to install a symlink from libfoo.so to libfoo.so.N to - make ELF linkers happy. Since it should be listed in + make ELF linkers happy. Since it should be listed in PLIST too, and it won't hurt in the a.out case (some ports even require the link for dynamic loading), you should just make this link regardless of the setting of @@ -2206,7 +2206,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

All port Makefiles are edited to remove minor numbers from LIB_DEPENDS, and also to have the regexp - support removed. (E.g., foo\\.1\\.\\(33|40\\) + support removed. (E.g., foo\\.1\\.\\(33|40\\) becomes foo.2.) They will be matched using grep -wF. @@ -2216,7 +2216,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

PLIST should contain the short (ELF) shlib names if the a.out minor number is zero, and the long - (a.out) names otherwise. bsd.port.mk will + (a.out) names otherwise. bsd.port.mk will automatically add .0 to the end of short shlib lines if PORTOBJFORMAT equals aout, and will delete the minor number from @@ -2227,7 +2227,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

NO_FILTER_SHLIBS. This will turn off the + NO_FILTER_SHLIBS. This will turn off the editing of PLIST mentioned in the previous paragraph. @@ -2259,16 +2259,16 @@ ${SETENV} OBJFORMAT=${PORTOBJFORMAT} ${LDCONFIG} -m .... packages by having a variable (for instance, resolution, or paper size) take different values, create one subdirectory per package to make it easier forusers to see what to do, but try to share as - many files as possible between ports. Typically you only need a + many files as possible between ports. Typically you only need a very short Makefile in all but one of the - directories if you use variables cleverly. In the sole + directories if you use variables cleverly. In the sole Makefiles, you can use MASTERDIR to specify the directory where the - rest of the files are. Also, use a variable as part of + rest of the files are. Also, use a variable as part of PKGNAME so the packages will have different names. - This will be best demonstrated by an example. This is part of + This will be best demonstrated by an example. This is part of japanese/xdvi300/Makefile; @@ -2284,7 +2284,7 @@ RESOLUTION?= 300 .endif japanese/xdvi300 also has all the regular - patches, package files, etc. If you type make + patches, package files, etc. If you type make there, it will take the default value for the resolution (300) and build the port normally. @@ -2299,12 +2299,12 @@ MASTERDIR= ${.CURDIR}/../xdvi300 .include ${MASTERDIR}/Makefile (xdvi240/Makefile and - xdvi400/Makefile are similar). The + xdvi400/Makefile are similar). The MASTERDIR definition tells bsd.port.mk that the refulat set of subdirectories like PATCHDIR and PKGDIR are to be found under - xdvi300. The + xdvi300. The RESOLUTION=118 line will override the RESOLUTION=300 line in xdvi300/Makefile and the port will be built @@ -2316,31 +2316,31 @@ MASTERDIR= ${.CURDIR}/../xdvi300 First, please read our policy on shared library versioning to understand - what to do with shared library versions in general. Do + what to do with shared library versions in general. Do not blindly assume software authors know what they are - doing; many of them do not. It is very important that + doing; many of them do not. It is very important that these details are carefully considered, as we have quite a unique situation where we are trying to have dozens of potentially incompatible software pairs co-exist. Careless port imports have caused great trouble regarding shared libraries in the past (ever wondered why the port jpeg-6b has a shared library version of 9.0?). - If in doubt, send a message to the &a.ports;. Most of the + If in doubt, send a message to the &a.ports;. Most of the time, your job ends by determining the right shared library version and making appropriate patches to implement it. However, if there is a port which is a different version of the same software already in the tree, the situation is - much more complex. In short, the FreeBSD implementation + much more complex. In short, the FreeBSD implementation does not allow the user to specify to the linker which version of shared library to link against (the linker will - always pick the highest numbered version). This means, if + always pick the highest numbered version). This means, if there is a libfoo.so.3.2 and libfoo.so.4.0 in the system, there is no way to tell the linker to link a - particular application to libfoo.so.3.2. It is + particular application to libfoo.so.3.2. It is essentially completely overshadowed in terms of - compilation-time linkage. In this case, the only solution + compilation-time linkage. In this case, the only solution is to rename the base part of the shared library. For instance, change libfoo.so.4.0 to libfoo4.so.1.0 so both version 3.2 and 4.0 can be @@ -2354,7 +2354,7 @@ MASTERDIR= ${.CURDIR}/../xdvi300 add any manpages to pkg/PLIST (this means you must not list manpages in the PLIST—see generating PLIST for more). It + linkend="porting-plist">generating PLIST for more). It also makes the install stage automatically compress or uncompress manpages depending on the setting of NOMANCOMPRESS in @@ -2418,7 +2418,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz There are many programs that require a Motif library (available from several commercial vendors, while there is a free clone reported to be able to run many applications in - x11-toolkits/lesstif) to compile. Since + x11-toolkits/lesstif) to compile. Since it is a popular toolkit and their licenses usually permit redistribution of statically linked binaries, we have made special provisions for handling ports that require Motif in a @@ -2430,7 +2430,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz <makevar>REQUIRES_MOTIF</makevar> If your port requires Motif, define this variable in the - Makefile. This will prevent people who don't own a copy of + Makefile. This will prevent people who don't own a copy of Motif from even attempting to build it. @@ -2439,7 +2439,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz This variable will be set by bsd.port.mk to be the appropriate reference - to the Motif library. Please patch the source to use this + to the Motif library. Please patch the source to use this wherever the Motif library is referenced in the Makefile or Imakefile. @@ -2473,7 +2473,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz If your port installs fonts for the X Window system, put them in X11BASE/lib/X11/fonts/local. - This directory is new to XFree86 release 3.3.3. If it does not + This directory is new to XFree86 release 3.3.3. If it does not exist, please create it, and print out a message urging the user to update their XFree86 to 3.3.3 or newer, or at least add this directory to the font path in @@ -2485,12 +2485,12 @@ ${PREFIX}/man/ja/man4/baz.4.gz The new version of texinfo (included in 2.2.2-RELEASE and onwards) contains a utility called install-info - to add and delete entries to the dir file. If + to add and delete entries to the dir file. If your port installs any info documents, please follow this instructions so your port/package will correctly update the user's PREFIX/info/dir - file. (Sorry for the length of this section, but is it imperative - to weave all the info files together. If done correctly, it will + file. (Sorry for the length of this section, but is it imperative + to weave all the info files together. If done correctly, it will produce a beautiful listing, so please bear with me! @@ -2517,14 +2517,14 @@ Options: Here's a seven-step procedure to convert ports to use - install-info. I will use + install-info. I will use editors/emacs as an example. Look at the texinfo sources and make a patch to insert @dircategory and @direntry - statements to files that don't have them. This is part of + statements to files that don't have them. This is part of my patch: @@ -2543,10 +2543,10 @@ Options: @finalout : - The format should be self-explanatory. Many authors + The format should be self-explanatory. Many authors leave a dir file in the source tree that contains all the entries you need, so look around - before you try to write your own. Also, make sure you + before you try to write your own. Also, make sure you look into related ports and make the section names and entry indentations consistent (we recommend that all entry text start at the 4th tab stop). @@ -2563,15 +2563,15 @@ Options: entries to install-info as arguments ( and ) instead of patching the texinfo - sources. I do not think this is a good idea for ports + sources. I do not think this is a good idea for ports because you need to duplicate the same information in three places (Makefile and @exec/@unexec of - PLIST; see below). However, if you + PLIST; see below). However, if you have a Japanese (or other multibyte encoding) info files, you will have to use the extra arguments to install-info because makeinfo can't handle those texinfo - sources. (See Makefile and + sources. (See Makefile and PLIST of japanese/skk for examples on how to do this). @@ -2583,7 +2583,7 @@ Options: Since the texinfo sources are newer than the info files, they should be rebuilt when you type make; but many Makefiles don't include correct - dependencies for info files. In emacs' case, I had to + dependencies for info files. In emacs' case, I had to patch the main Makefile.in so it will descend into the man subdirectory to rebuild the info pages. @@ -2614,7 +2614,7 @@ Options: The second hunk was necessary because the default target in the man subdir is called info, while the main - Makefile wants to call all. I also deleted the installation + Makefile wants to call all. I also deleted the installation of the info info file because we already have one with the same name in /usr/share/info (that patch is not @@ -2624,8 +2624,8 @@ Options: If there is a place in the Makefile that is installing the - dir file, delete it. Your - port may not be doing it. Also, remove any commands that + dir file, delete it. Your + port may not be doing it. Also, remove any commands that are otherwise mucking around with the dir file. @@ -2653,7 +2653,7 @@ Options: (This step is only necessary if you are modifying an existing port.) Take a look at pkg/PLIST and delete anything that is - trying to patch up info/dir. They + trying to patch up info/dir. They may be in pkg/INSTALL or some other file, so search extensively. @@ -2680,7 +2680,7 @@ diff -u -r1.15 PLIST Add a post-install target to the Makefile to create a - dir file if it is not there. Also, + dir file if it is not there. Also, call install-info with the installed info files. @@ -2708,7 +2708,7 @@ diff -u -r1.26 Makefile Do not use anything other than /usr/share/info/dir and the above - command to create a new info file. In fact, I'd add the + command to create a new info file. In fact, I'd add the first three lines of the above patch to bsd.port.mk if you (the porter) wouldn't have to do it in PLIST by @@ -2760,7 +2760,7 @@ diff -u -r1.15 PLIST - Test and admire your work. :). Check the dir file before and after each + Test and admire your work. :). Check the dir file before and after each step. @@ -2778,14 +2778,14 @@ diff -u -r1.15 PLIST <filename>MESSAGE</filename> If you need to display a message to the installer, you may - place the message in pkg/MESSAGE. This + place the message in pkg/MESSAGE. This capability is often useful to display additional installation steps to be taken after a pkg_add or to display licensing information. The pkg/MESSAGE file does not need to - be added to pkg/PLIST. Also, it will not get + be added to pkg/PLIST. Also, it will not get automatically printed if the user is using the port, not the package, so you should probably display it from the post-install target yourself. @@ -2797,13 +2797,13 @@ diff -u -r1.15 PLIST If your port needs to execute commands when the binary package is installed with pkg_add you can do this via the - pkg/INSTALL script. This script will + pkg/INSTALL script. This script will automatically be added to the package, and will be run twice by - pkg_add. The first time will as + pkg_add. The first time will as INSTALL ${PKGNAME} PRE-INSTALL and the second time as INSTALL ${PKGNAME} - POST-INSTALL. $2 can be - tested to determine which mode the script is being run in. The + POST-INSTALL. $2 can be + tested to determine which mode the script is being run in. The PKG_PREFIX environmental variable will be set to the package installation directory. See pkg_add @@ -2823,7 +2823,7 @@ diff -u -r1.15 PLIST If your port needs to determine if it should install or not, you can create a pkg/REQ - “requirements” script. It will be invoked + “requirements” script. It will be invoked automatically at installation/deinstallation time to determine whether or not installation/deinstallation should proceed. @@ -2833,13 +2833,13 @@ diff -u -r1.15 PLIST Some ports, particularly the p5- ports, need to change their PLIST depending on what options they are - configured with (or version of perl, in the case of p5- ports). To + configured with (or version of perl, in the case of p5- ports). To make this easy, any instances in the PLIST of %%OSREL%%, %%PERL_VER%%, and %%PERL_VERSION%% will be substituted for - appropriately. The value of %%OSREL%% is the + appropriately. The value of %%OSREL%% is the numeric revision of the operating system (e.g., - 2.2.7). %%PERL_VERSION%% is + 2.2.7). %%PERL_VERSION%% is the full version number of perl (e.g., 5.00502) and %%PERL_VER%% is the perl version number minus the patchlevel (e.g., 5.005). @@ -2886,7 +2886,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} All the filenames in the pkg subdirectory are defined using variables so you can change them in your - Makefile if need be. This is especially useful when you + Makefile if need be. This is especially useful when you are sharing the same pkg subdirectory among several ports or have to write to one of the above files (see writing to places other than @@ -2946,7 +2946,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} Please change these variables rather than overriding - PKG_ARGS. If you change + PKG_ARGS. If you change PKG_ARGS, those files will not correctly be installed in /var/db/pkg upon install from a port. @@ -2958,7 +2958,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} Some software packages have restrictive licenses or can be in violation to the law (PKP's patent on public key crypto, ITAR - (export of crypto software) to name just two of them). What we + (export of crypto software) to name just two of them). What we can do with them varies a lot, depending on the exact wordings of the respective licenses. @@ -2967,7 +2967,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} licensing terms of the software and make sure that the FreeBSD project will not be held accountable of violating them by redistributing the source or compiled binaries either via ftp - or CD-ROM. If in doubt, please contact the &a.ports;. + or CD-ROM. If in doubt, please contact the &a.ports;. There are two variables you can set in the Makefile to @@ -2979,9 +2979,9 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} If the port has a “do not sell for profit” type of license, set the variable NO_CDROM to a - string describing the reason why. We + string describing the reason why. We will make sure such ports won't go into the CD-ROM come - release time. The distfile and package will still be + release time. The distfile and package will still be available via ftp. @@ -2990,9 +2990,9 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} for each site, or the resulting binary package can't be distributed due to licensing; set the variable NO_PACKAGE to a string describing the - reason why. We will make sure such + reason why. We will make sure such packages won't go on the ftp site, nor into the CD-ROM - come release time. The distfile will still be included on + come release time. The distfile will still be included on both however. @@ -3000,7 +3000,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} If the port has legal restrictions on who can use it (e.g., crypto stuff) or has a “no commercial use” license, set the variable RESTRICTED to be the - string describing the reason why. For such ports, the + string describing the reason why. For such ports, the distfiles/packages will not be available even from our ftp sites. @@ -3024,12 +3024,12 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} When you notice that a port is out of date compared to the latest version from the original authors, first make sure you - have the latest port. You can find them in the + have the latest port. You can find them in the ports/ports-current directory of the ftp mirror sites. The next step is to send a mail to the maintainer, if one is - listed in the port's Makefile. That person may already be + listed in the port's Makefile. That person may already be working on an upgrade, or have a reason to not upgrade the port right now (because of, for example, stability problems of the new version). @@ -3043,12 +3043,12 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} and the original as in our tree is superedit.bak, then send us the result of diff -ruN superedit.bak - superedit). Please examine the output to make - sure all the changes make sense. The best way to send us the + superedit). Please examine the output to make + sure all the changes make sense. The best way to send us the diff is by including it to send-pr1 - (category ports). Please mention any added or deleted files + (category ports). Please mention any added or deleted files in the message, as they have to be explicitly specified to CVS - when doing a commit. If the diff is more than about 20KB, please + when doing a commit. If the diff is more than about 20KB, please compress and uuencode it; otherwise, just include it in as is in the PR. @@ -3062,18 +3062,18 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} Here is a list of common do's and dont's that you encounter during the porting process.You should check your own port against this list, but you can also check ports in the PR - database that others have submitted. Submit any comments on + database that others have submitted. Submit any comments on ports you check as described in Bug - Reports and General Commentary. Checking ports in + Reports and General Commentary. Checking ports in the PR database will both make it faster for us to commit them, and prove that you know what you are doing. Strip Binaries - Do strip binaries. If the original source already strips the + Do strip binaries. If the original source already strips the binaries, fine; otherwise you should add a - post-install rule to to it yourself. Here is an + post-install rule to to it yourself. Here is an example; @@ -3084,7 +3084,7 @@ post-install: file 1 command on the installed executable to check - whether the binary is stripped or not. If it does not say + whether the binary is stripped or not. If it does not say not stripped, it is stripped. @@ -3127,10 +3127,10 @@ post-install: <makevar>WRKDIR</makevar> Do not write anything to files outside - WRKDIR. WRKDIR is the only + WRKDIR. WRKDIR is the only place that is guaranteed to be writable during the port build (see compiling ports from CDROM for an - example of building ports from a read-only tree). If you need to + example of building ports from a read-only tree). If you need to modigy some file in PKGDIR, do so by redefining a variable, not by writing over it. @@ -3140,8 +3140,8 @@ post-install: <makevar>WRKDIRPREFIX</makevar> Make sure your port honors - WRKDIRPREFIX. Most ports don't have to worry - about this. In particular, if you are referring to a + WRKDIRPREFIX. Most ports don't have to worry + about this. In particular, if you are referring to a WRKDIR of another port, note that the correct location is WRKDIRPREFIXPORTSDIR/subdir/name/work not PORTSDIR/subdir/name/work or .CURDIR/../../subdir/name/work or some such. @@ -3157,7 +3157,7 @@ post-install: You may come across code that needs modifications or conditional compilation based upon what version of UNIX it is - running under. If you need to make such changes to the code for + running under. If you need to make such changes to the code for conditional compilation, make sure you make the changes as general as possible so that we can back-port code to FreeBSD 1.x systems and cross-port to other BSD systems such as 4.4BSD from CSRG, @@ -3166,7 +3166,7 @@ post-install: The preferred way to tell 4.3BSD/Reno (1990) and newer versions of the BSD code apart is by using the BSD macro defined in - <sys/param.h>. Hopefully that file is + <sys/param.h>. Hopefully that file is already included; if not, add the code: @@ -3174,10 +3174,10 @@ post-install: #include <sys/param.h> #endif - to the proper place in the .c file. We + to the proper place in the .c file. We believe that every system that defines these two symbols has - sys/param.h. If you find a system that - doesn't, we would like to know. Please send mail to the + sys/param.h. If you find a system that + doesn't, we would like to know. Please send mail to the &a.ports;. Another way is to use the GNU Autoconf style of doing @@ -3212,10 +3212,10 @@ post-install: above). The value of the BSD macro is - 199506 for the 4.4BSD-Lite2 code base. This is - stated for informational purposes only. It should not be used to + 199506 for the 4.4BSD-Lite2 code base. This is + stated for informational purposes only. It should not be used to distinguish between versions of FreeBSD based only on 4.4-Lite vs. - versions that have merged in changes from 4.4-Lite2. The + versions that have merged in changes from 4.4-Lite2. The __FreeBSD__ macro should be used instead. @@ -3226,8 +3226,8 @@ post-install: __FreeBSD__ is defined in all - versions of FreeBSD. Use it if the change you are making - only affects FreeBSD. Porting gotchas like the use of + versions of FreeBSD. Use it if the change you are making + only affects FreeBSD. Porting gotchas like the use of sys_errlist[] vs strerror() are Berkeleyisms, not FreeBSD changes. @@ -3235,8 +3235,8 @@ post-install: In FreeBSD 2.x, __FreeBSD__ is - defined to be 2. In earlier - versions, it is 1. Later + defined to be 2. In earlier + versions, it is 1. Later versions will bump it to match their major version number. @@ -3244,12 +3244,12 @@ post-install: If you need to tell the difference between a FreeBSD 1.x system and a FreeBSD 2.x or 3.x system, usually the right answer is to use the BSD macros - described above. If there actually is a FreeBSD specific + described above. If there actually is a FreeBSD specific change (such as special shared library options when using ld) then it is OK to use __FreeBSD__ and #if __FreeBSD__ > 1 to detect a FreeBSD 2.x - and later system. If you need more granularity in + and later system. If you need more granularity in detecting FreeBSD systems since 2.0-RELEASE you can use the following: @@ -3463,12 +3463,12 @@ post-install: Note that 2.2-STABLE sometimes identifies itself as - “2.2.5-STABLE” after the 2.2.5-RELEASE. The pattern used to + “2.2.5-STABLE” after the 2.2.5-RELEASE. The pattern used to be year followed by the month, but we decided to change it to a more straightforward major/minor system starting from - 2.2. This is because the parallel development on several + 2.2. This is because the parallel development on several branches made it infeasible to classify the releases simply - by their real release dates. If you are making a port now, + by their real release dates. If you are making a port now, you don't have to worry about old -CURRENTs; they are listed here just for your reference. @@ -3476,7 +3476,7 @@ post-install: In the hundreds of ports that have been done, there have only been one or two cases where __FreeBSD__ - should have been used. Just because an earlier port screwed up + should have been used. Just because an earlier port screwed up and used it in the wrong place does not mean you should do so too. @@ -3486,7 +3486,7 @@ post-install: bsd.port.mk Do not write anything after the .include - <bsd.port.mk> line. it usually can be avoided by + <bsd.port.mk> line. it usually can be avoided by including bsd.port.pre.mk somewhere in the middle of your Makefile and bsd.port.post.mk at the end. @@ -3609,11 +3609,11 @@ post-install: If your software has some documentation other than the standard man and info pages that you think is useful for the user, install it under - PREFIX/share/doc. This can be + PREFIX/share/doc. This can be done, like the previous item, in the post-install target. - Create a new directory for your port. The directory name - should reflect what the port is. This usually means PKGNAME minus the version part. + Create a new directory for your port. The directory name + should reflect what the port is. This usually means PKGNAME minus the version part. However, if you think the user might want different versions of the port to be installed at the same time, you can use the whole PKGNAME. @@ -3636,7 +3636,7 @@ post-install: /etc/make.conf.) Also you can use the pkg/MESSAGE file to - display messages upon installation. See the using pkg/MESSAGE section for details. @@ -3651,12 +3651,12 @@ post-install: <makevar>DIST_SUBDIR</makevar> Do not let your port clutter - /usr/ports/distfiles. If your port + /usr/ports/distfiles. If your port requires a lot of files to be fetched, or contains a file that has a name that might conflict with other ports (e.g., Makefile), set DIST_SUBDIR to the name of the port (PKGNAME without the - version part should work fine). This will change DISTDIR from the default + version part should work fine). This will change DISTDIR from the default /usr/ports/distfiles to /usr/ports/distfiles/DIST_SUBDIR, and in effect puts everything that is required for your port @@ -3664,7 +3664,7 @@ post-install: It will also look at the subdirectory with the same name on the backup master site at - ftp.freebsd.org. (Setting DISTDIR explicitly in your + ftp.freebsd.org. (Setting DISTDIR explicitly in your Makefile will not accomplish this, so please use DIST_SUBDIR.) @@ -3691,10 +3691,10 @@ post-install: RCS strings - Do not put RCS strings in patches. CVS will mangle them + Do not put RCS strings in patches. CVS will mangle them when we put the files into the ports tree, and when we check them out again, they will come out different and the patch - will fail. RCS strings are surrounded by dollar ($) signs, and typically start with + will fail. RCS strings are surrounded by dollar ($) signs, and typically start with $Id or $RCS. @@ -3705,10 +3705,10 @@ post-install: Using the recurse () option to diff to generate patches is fine, but please take a look at the resulting patches to make - sure you don't have any unnecessary junk in there. In + sure you don't have any unnecessary junk in there. In particular, diffs between two backup files, Makefiles when the port uses Imake or GNU configure, etc., are unnecessary and - should be deleted. If you had to edit + should be deleted. If you had to edit configure.in and run autoconf to regenerate configure, do not take the diffs of @@ -3718,7 +3718,7 @@ post-install: Also, if you had to delete a file, then you can do it in the post-extract - target rather than as part of the patch. Once you are happy + target rather than as part of the patch. Once you are happy with the resulting diff, please split it up into one source file per patch file. @@ -3727,7 +3727,7 @@ post-install: <makevar>PREFIX</makevar> - Do try to make your port install relative to PREFIX. (The value of this + Do try to make your port install relative to PREFIX. (The value of this variable will be set to LOCALBASE (default /usr/local), unless USE_X_PREFIX or USE_IMAKE is set, in which case it will be X11BASE (default @@ -3736,7 +3736,7 @@ post-install: Not hard-coding /usr/local or /usr/X11R6 anywhere in the source will make the port much more flexible and able to cater to the - needs of other sites. For X ports that use imake, this is + needs of other sites. For X ports that use imake, this is automatic; otherwise, this can often be done by simply replacing the occurrences of /usr/local (or /usr/X11R6 for X ports that do not @@ -3751,12 +3751,12 @@ post-install: The variable PREFIX can be reassigned in your Makefile or in the user's - environment. However, it is strongly discouraged for + environment. However, it is strongly discouraged for individual ports to set this variable explicitly in the Makefiles. Also, refer to programs/files from other ports with the - variables mentioned above, not explicit pathnames. For + variables mentioned above, not explicit pathnames. For instance, if your port requires a macro PAGER to be the full pathname of less, use the compiler flag: @@ -3776,22 +3776,22 @@ post-install: Subdirectories Try to let the port put things in the right subdirectories - of PREFIX. Some ports + of PREFIX. Some ports lump everything and put it in the subdirectory with the port's - name, which is incorrect. Also, many ports put everything + name, which is incorrect. Also, many ports put everything except binaries, header files and manual pages in the a subdirectory of lib, which does not - bode well with the BSD paradigm. Many of the files should be + bode well with the BSD paradigm. Many of the files should be moved to one of the following: etc (setup/configuration files), libexec (executables started internally), sbin (executables for superusers/managers), info (documentation for info browser) or share (architecture independent - files). See man hier7 for + files). See man hier7 for details, the rules governing /usr pretty - much apply to /usr/local too. The - exception are ports dealing with USENET “news”. They may use + much apply to /usr/local too. The + exception are ports dealing with USENET “news”. They may use PREFIX/news as a destination for their files. @@ -3801,9 +3801,9 @@ post-install: Cleaning up empty directories Do make your ports clean up after themselves when they are - deinstalled. This is usually accomplished by adding + deinstalled. This is usually accomplished by adding @dirrm lines for all directories that are - specifically created by the port. You need to delete + specifically created by the port. You need to delete subdirectories before you can delete parent directories. @@ -3816,7 +3816,7 @@ lib/X11/oneko/sounds/cat.au @dirrm lib/X11/oneko However, sometimes @dirrm will give you - errors because other ports also share the same subdirectory. You + errors because other ports also share the same subdirectory. You can call rmdir from @unexec to remove only empty directories without warning. @@ -3836,16 +3836,16 @@ lib/X11/oneko/sounds/cat.au If your port requires a certain user to be on the installed system, let the pkg/INSTALL script call pw to create it - automatically. Look at net/cvsup-mirror + automatically. Look at net/cvsup-mirror for an example. If your port must use the same user/group ID number when it is installed a binarypackage as when it was compiled, then you mus - choose a free UID from 50 to 99 and register it below. Look at + choose a free UID from 50 to 99 and register it below. Look at japanese/Wnn for an example. Make sure you don't use a UID already used by the system - or other ports. This is the current list of UIDs between 50 + or other ports. This is the current list of UIDs between 50 and 99. @@ -3869,7 +3869,7 @@ qmailr:*:86:82:QMail user:/var/qmail:/nonexistent msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh Please include a notice when you submit a port (or an - upgrade) that reserves a new UID or GID in this range. This allows + upgrade) that reserves a new UID or GID in this range. This allows us to keep the list of reserved IDs up to date. @@ -3893,7 +3893,7 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh Respect <makevar>CFLAGS</makevar> The port should respect the CFLAGS - variable. If it doesn't, please add NO_PACKAGE=ignores + variable. If it doesn't, please add NO_PACKAGE=ignores cflags to the Makefile. @@ -3903,7 +3903,7 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh If your port requires some configuration files in PREFIX/etc, do not just install them and list them in - pkg/PLIST. That will cause + pkg/PLIST. That will cause pkg_delete to delete files carefully edited by the user and a new installation to wipe them out. @@ -3927,7 +3927,7 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh Feedback Do send applicable changes/patches to the original - author/maintainer for inclusion in next release of the code. This + author/maintainer for inclusion in next release of the code. This will only make your job that much easier for the next release. @@ -3937,7 +3937,7 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh The files pkg/DESCR, pkg/COMMENT, and - pkg/PLIST should each be double-checked. If + pkg/PLIST should each be double-checked. If you are reviewing a port and feel they can be worded better, do so. @@ -3965,13 +3965,13 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh A Sample <filename>Makefile</filename> Here is a sample Makefile that you can - use to create a new port. Make sure you remove all the extra + use to create a new port. Make sure you remove all the extra comments (ones between brackets)! It is recommended that you follow this format (ordering of - variables, empty lines between sections, etc.). This format is + variables, empty lines between sections, etc.). This format is designed so that the most important information is easy to - locate. We recommend that you use portlint to check the Makefile. @@ -4060,7 +4060,7 @@ pre-install: Package Names The following are the conventions you should follow in - naming your packages. This is to have our package directory + naming your packages. This is to have our package directory easy to scan, as there are already lots and lots of packages and users are going to turn away if they hurt their eyes! @@ -4075,9 +4075,9 @@ pre-install: FreeBSD strives to support the native language of its - users. The language- part should be a two letter + users. The language- part should be a two letter abbreviation of the natural language defined by ISO-639 if - the port is specific to a certain language. Examples are + the port is specific to a certain language. Examples are ja for Japanese, ru for Russian, vi for Vietnamese, zh for Chinese, ko for Korean and de for German. @@ -4085,17 +4085,17 @@ pre-install: The name part should be all lowercases, except for a really large - package (with lots of programs in it). Things like + package (with lots of programs in it). Things like XFree86 (yes there really is a port of it, check it - out) and ImageMagick fall into this category. Otherwise, + out) and ImageMagick fall into this category. Otherwise, convert the name (or at least the first letter) to - lowercase. If the capital letters are + lowercase. If the capital letters are important to the name (for example, with one-letter names like R or V) you may use capital letters at your discretion. There is a tradition of naming Perl 5 modules by prepending p5- and converting the double-colon separator to a hyphen; for example, the Data::Dumper module becomes - p5-Data-Dumper. If the software in question has numbers, + p5-Data-Dumper. If the software in question has numbers, hyphens, or underscores in its name, you may include them as well (like kinput2). @@ -4105,13 +4105,13 @@ pre-install: defaults (usually part of the directory name in a family of ports), the -compiled.specifics part should state the - compiled-in defaults (the hyphen is optional). Examples + compiled-in defaults (the hyphen is optional). Examples are papersize and font units. The version string should be a period-separated list - of integers and single lowercase alphabetics. The only + of integers and single lowercase alphabetics. The only exception is the string pl (meaning `patchlevel'), which can be used only when there are no major and minor version numbers in the software. @@ -4226,7 +4226,7 @@ pre-install: If there is absolutely no trace of version information in the original source and it is unlikely that the original author will ever release another version, just set the version string - to 1.0 (like the piewm example above). Otherwise, ask the + to 1.0 (like the piewm example above). Otherwise, ask the original author or use the date string (yy.mm.dd) as the version. @@ -4236,14 +4236,14 @@ pre-install: Categories As you already know, ports are classified in several - categories. But for this to wor, it is important that porters and + categories. But for this to wor, it is important that porters and users understand what each category and how we deicde what to put in each category. Current list of categories - First, this is the current list of port categories. Those + First, this is the current list of port categories. Those marked with an asterisk (*) are virtual categories—those that do not have a corresponding subdirectory in the ports tree. @@ -4307,7 +4307,7 @@ pre-install: comms - Communication software. Mostly software to talk to + Communication software. Mostly software to talk to your serial port. @@ -4329,7 +4329,7 @@ pre-install: devel - Development utilities. Do not put libraries here just + Development utilities. Do not put libraries here just because they are libraries—unless they truly don't belong to anywhere else, they shouldn't be in this category. @@ -4337,7 +4337,7 @@ pre-install: editors - General editors. Specialized editors go in the + General editors. Specialized editors go in the section for those tools (e.g., a mathematical-formula editor will go in math). @@ -4349,7 +4349,7 @@ pre-install: emulators - Emulators for other operating systems. Terminal + Emulators for other operating systems. Terminal emulators do not belong here—X-based ones should go to x11 and text-based ones to either @@ -4412,9 +4412,9 @@ pre-install: misc Miscellaneous utilities—basically things that - doesn't belong to anywhere else. This is the only category + doesn't belong to anywhere else. This is the only category that should not appear with any other non-virtual - category. If you have misc with + category. If you have misc with something else in your CATEGORIES line, that means you can safely delete misc and just put the port in that other subdirectory! @@ -4452,7 +4452,7 @@ pre-install: print - Printing software. Desktop publishing tools + Printing software. Desktop publishing tools (previewers, etc.) belong here too. @@ -4503,7 +4503,7 @@ pre-install: textproc - Text processing utilities. It does not include + Text processing utilities. It does not include desktop publishing tools, which go to print/. @@ -4540,7 +4540,7 @@ pre-install: www - Software related to the World Wide Web. HTML language + Software related to the World Wide Web. HTML language support belong here too. @@ -4551,7 +4551,7 @@ pre-install: Do not put regular X applications here. If your port is an X application, define USE_XLIB (implied by USE_IMAKE) and put it in - appropriate categories. Also, many of them go into other + appropriate categories. Also, many of them go into other x11-* categories (see below). @@ -4589,21 +4589,21 @@ pre-install: As many of the categories overlap, you often have to choose which of the categories should be the primary category of your - port. There are several rules that govern this usse. Here is the + port. There are several rules that govern this usse. Here is the list of priorities, in decreasing order of precedence. - Language specific categories alwasys come first. For + Language specific categories alwasys come first. For example, if your port installs Japanese X11 fonts, then your CATEGORIES line would read japanese x11. - Specific categories win over less-specific ones. For + Specific categories win over less-specific ones. For instance, an HTML editor should be listed as www - editors, not the other way around. Also, you don't + editors, not the other way around. Also, you don't need to list net when the port belongs to either of mail, mbone, news, security, or @@ -4612,7 +4612,7 @@ pre-install: x11 is used as a secondary category - only when the primary category is a natural language. In + only when the primary category is a natural language. In particular, you should not put x11 in the category line for X applications. @@ -4625,7 +4625,7 @@ pre-install: If you are not sure about the category, please put a comment to that effect in your send-pr submission so we - can discuss it before import it. (If you are a committer, send a + can discuss it before import it. (If you are a committer, send a note &a.ports; so we can discuss it first—too often new ports are imported to a wrong category only to be moved right away.) @@ -4636,8 +4636,8 @@ pre-install: Changes to this document and the ports system If you maintain a lot of ports, you should consider following - the &a.ports;. Important changes to - the way ports work will be announced there. You can always + the &a.ports;. Important changes to + the way ports work will be announced there. You can always find more detailed information on the latest changes by looking at diff --git a/en_US.ISO_8859-1/books/handbook/ppp-and-slip/chapter.sgml b/en_US.ISO_8859-1/books/handbook/ppp-and-slip/chapter.sgml index fa8199e611..fd9fa545d1 100644 --- a/en_US.ISO_8859-1/books/handbook/ppp-and-slip/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/ppp-and-slip/chapter.sgml @@ -3,9 +3,9 @@ If your connection to the Internet is through a modem, or you wish to provide other people with dialup connections to the Internet using - FreeBSD, you have the option of using PPP or SLIP. Furthermore, two + FreeBSD, you have the option of using PPP or SLIP. Furthermore, two varieties of PPP are provided: user (sometimes - referred to as iijppp) and kernel. The + referred to as iijppp) and kernel. The procedures for configuring both types of PPP, and for setting up SLIP are described in this chapter. @@ -14,33 +14,33 @@ Setting up User PPP User PPP was introduced to FreeBSD in release 2.0.5 as an - addition to the existing kernel implementation of PPP. So, what is + addition to the existing kernel implementation of PPP. So, what is different about this new PPP that warrants its addition? To quote from the manual page:
- This is a user process PPP software package. Normally, PPP + This is a user process PPP software package. Normally, PPP is implemented as a part of the kernel (e.g. as managed by pppd) and it is thus somewhat hard to debug and/or modify its - behavior. However, in this implementation PPP is done as a user + behavior. However, in this implementation PPP is done as a user process with the help of the tunnel device driver (tun).
In essence, this means that rather than running a PPP daemon, - the ppp program can be run as and when desired. No PPP interface + the ppp program can be run as and when desired. No PPP interface needs to be compiled into the kernel, as the program can use the generic tunnel device to get data into and out of the kernel. From here on out, user ppp will be referred to simply as ppp unless a distinction needs to be made between it and any other PPP - client/server software such as pppd. Unless otherwise stated, all + client/server software such as pppd. Unless otherwise stated, all commands in this section should be executed as root. - There are a large number of enhancements in version 2 of ppp. You + There are a large number of enhancements in version 2 of ppp. You can discover what version you have by running ppp with no arguments - and typing show version at the prompt. It is a + and typing show version at the prompt. It is a simple matter to upgrade to the latest version of ppp (under any version of FreeBSD) by downloading the latest archive via www.Awfulhak.org. @@ -51,7 +51,7 @@ This document assumes you are in roughly this position: You have an account with an Internet Service Provider (ISP) - which lets you use PPP. Further, you have a modem (or other + which lets you use PPP. Further, you have a modem (or other device) connected and configured correctly which allows you to connect to your ISP. @@ -66,19 +66,19 @@ - Your login name and password. This can be either a + Your login name and password. This can be either a regular unix style login/password pair, or a PPP PAP or CHAP login/password pair. - The IP addresses of one or more nameservers. Normally, - you will be given two IP numbers. You + The IP addresses of one or more nameservers. Normally, + you will be given two IP numbers. You must have this information for PPP version 1.x unless you run - your own nameserver. From version 2 onwards, + your own nameserver. From version 2 onwards, PPP supports nameserver address - negotiation. If your ISP supports this, then using the command + negotiation. If your ISP supports this, then using the command enable dns in your config file will tell PPP to set the nameservers for you. @@ -92,7 +92,7 @@ The IP address of your ISP's gateway. The gateway is the machine to which you will connect and will be set up as your - default route. If your ISP hasn't given + default route. If your ISP hasn't given you this number, we can make one up and your ISP's PPP server will tell us the correct value when we connect. @@ -101,12 +101,12 @@ - Your ISP's netmask. If your ISP hasn't given you this + Your ISP's netmask. If your ISP hasn't given you this information, you can safely use a netmask of 255.255.255.0. If your ISP allocates you a static IP address and hostname - then you can enter this information. Otherwise, we simply let the + then you can enter this information. Otherwise, we simply let the peer assign whatever IP number it sees fit. @@ -120,18 +120,18 @@ Building a ppp ready kernel As the description states, ppp uses the kernel tun - device. It is necessary to make sure that your kernel has support + device. It is necessary to make sure that your kernel has support for this device compiled in. To check this, go to your kernel compile directory (/sys/i386/conf or /sys/pc98/conf) and examine your kernel - configuration file. It needs to have the line + configuration file. It needs to have the line pseudo-device tun 1 - in it somewhere. The stock GENERIC kernel + in it somewhere. The stock GENERIC kernel has this as standard, so if you have not installed a custom kernel or you do not have a /sys directory, you do not have to change anything. @@ -141,7 +141,7 @@ pseudo-device tun 1 example, if you are setting up a server and could have 16 dialup ppp connections at any one time then you will need to use 16 instead of 1), then you should add the line, re-compile, - re-install and boot the new kernel. Please refer to the + re-install and boot the new kernel. Please refer to the Configuring the FreeBSD Kernel section for more information on kernel configuration. @@ -161,32 +161,32 @@ tun3: flags=8010<POINTOPOINT,MULTICAST> mtu 1500 This case shows four tunnel devices, two of which are - currently configured and being used. It should be noted that the + currently configured and being used. It should be noted that the RUNNING flag above indicates that the interface has been used at some point—it is not an error if your interface does not show up as RUNNING. If you have a kernel without the tun device, and you can not - rebuild it for some reason, all is not lost. You should be able - to dynamically load the code. Refer to the appropriate modload8 + rebuild it for some reason, all is not lost. You should be able + to dynamically load the code. Refer to the appropriate modload8 and lkm4 pages for further details. You may also wish to take this opportunity to configure a - firewall. Details can be found in the Firewalls section. + firewall. Details can be found in the Firewalls section. Check the tun device - Most users will only require one tun device (/dev/tun0). If you + Most users will only require one tun device (/dev/tun0). If you have used more (i.e., a number other than 1 in the pseudo-device line in the kernel configuration file) then alter all references to tun0 below to reflect whichever device number you are using. The easiest way to make sure that the tun0 device is - configured correctly is to re-make it. To do this, execute the + configured correctly is to re-make it. To do this, execute the following commands: @@ -226,10 +226,10 @@ tun0: flags=8010<POINTOPOINT,MULTICAST> mtu 1500 Name Resolution Configuration The resolver is the part of the system that turns IP addresses - into hostnames and vice versa. It can be configured to look for + into hostnames and vice versa. It can be configured to look for maps that describe IP to hostname mappings in one of two places. The first is a file called /etc/hosts - (man 5 hosts). The second is the + (man 5 hosts). The second is the Internet Domain Name Service (DNS), a distributed data base, the discussion of which is beyond the scope of this document. @@ -238,8 +238,8 @@ tun0: flags=8010<POINTOPOINT,MULTICAST> mtu 1500 The resolver is a set of system calls that do the name mappings, but you have to tell them where to find their - information. You do this by first editing the file - /etc/host.conf. Do not call this file + information. You do this by first editing the file + /etc/host.conf. Do not call this file /etc/hosts.conf (note the extra s) as the results can be confusing. @@ -265,8 +265,8 @@ bind Edit the <filename>/etc/hosts</filename>(5) file This file should contain the IP addresses and names of - machines on your network. At a bare minimum it should contain - entries for the machine which will be running ppp. Assuming that + machines on your network. At a bare minimum it should contain + entries for the machine which will be running ppp. Assuming that your machine is called foo.bar.com with the IP address 10.0.0.1, /etc/hosts should contain: @@ -276,8 +276,8 @@ bind 10.0.0.1 foo.bar.com foo The first line defines the alias localhost as a synonym - for the current machine. Regardless of your own IP address, the - IP address for this line should always be 127.0.0.1. The second + for the current machine. Regardless of your own IP address, the + IP address for this line should always be 127.0.0.1. The second line maps the name foo.bar.com (and the shorthand foo) to the IP address 10.0.0.1. @@ -290,8 +290,8 @@ bind Edit the <filename>/etc/resolv.conf</filename> file /etc/resolv.conf tells the resolver how - to behave. If you are running your own DNS, you may leave this - file empty. Normally, you will need to enter the following + to behave. If you are running your own DNS, you may leave this + file empty. Normally, you will need to enter the following line(s): @@ -302,15 +302,15 @@ domain bar.com The x.x.x.x and y.y.y.y addresses are those given to you - by your ISP. Add as many nameserver lines as your ISP - provides. The domain line defaults to your hostname's - domain, and is probably unnecessary. Refer to the resolv.conf + by your ISP. Add as many nameserver lines as your ISP + provides. The domain line defaults to your hostname's + domain, and is probably unnecessary. Refer to the resolv.conf manual page for details of other possible entries in this file. If you are running PPP version 2 or greater, the enable dns command will tell PPP to request that your ISP - confirms the nameserver values. If your ISP supplies different + confirms the nameserver values. If your ISP supplies different addresses (or if there are no nameserver lines in /etc/resolv.conf), PPP will rewrite the file with the ISP-supplied values. @@ -322,12 +322,12 @@ domain bar.com Both user ppp and pppd (the kernel level implementation of PPP) use configuration files located in the - /etc/ppp directory. The sample configuration + /etc/ppp directory. The sample configuration files provided are a good reference for user ppp, so don't delete them. Configuring ppp requires that you edit a number of files, - depending on your requirements. What you put in them depends to + depending on your requirements. What you put in them depends to some extent on whether your ISP allocates IP addresses statically (i.e., you get given one IP address, and always use that one) or dynamically (i.e., your IP address can be different for each PPP @@ -338,7 +338,7 @@ domain bar.com PPP and Static IP addresses You will need to create a configuration file called - /etc/ppp/ppp.conf. It should look similar + /etc/ppp/ppp.conf. It should look similar to the example below. @@ -368,7 +368,7 @@ domain bar.com Line 1: - Identifies the default entry. Commands in this + Identifies the default entry. Commands in this entry are executed automatically when ppp is run. @@ -377,7 +377,7 @@ domain bar.com Identifies the device to which the modem is - connected. COM1: is /dev/cuaa0 and + connected. COM1: is /dev/cuaa0 and COM2: is /dev/cuaa1. @@ -385,7 +385,7 @@ domain bar.com Line 3: - Sets the speed you want to connect at. If 115200 + Sets the speed you want to connect at. If 115200 doesn't work (it should with any reasonably new modem), try 38400 instead. @@ -394,9 +394,9 @@ domain bar.com Line 4: - The dial string. User PPP uses an expect-send + The dial string. User PPP uses an expect-send syntax similar to the chat8 - program. Refer to the manual page for information on + program. Refer to the manual page for information on the features of this language. @@ -412,15 +412,15 @@ domain bar.com Line 6: - Sets the phone number for this provider. Multiple + Sets the phone number for this provider. Multiple phone numbers may be specified using the : or | - character as a separator. The difference between these - spearators is described in the ppp manual page. To + character as a separator. The difference between these + spearators is described in the ppp manual page. To summarize, if you want to rotate through the numbers, - use the :. If you want to always attempt to dial + use the :. If you want to always attempt to dial the first number first and only use the other numbers if - the first number fails, use the |. Always quote the + the first number fails, use the |. Always quote the entire set of phone numbers as shown. @@ -429,7 +429,7 @@ domain bar.com The login string is of the same chat-like syntax as - the dial string. In this example, the string works for + the dial string. In this example, the string works for a service whose login session looks like this: @@ -441,13 +441,13 @@ protocol: ppp You will need to alter this script to suit your own - needs. When you write this script for the first time, + needs. When you write this script for the first time, you should enable “chat” logging to ensure that the conversation is going as expected. If you're using PAP or CHAP, there will be no login at this point, so your login string can be left - blank. See + blank. See PAP and CHAP authentication for further details. @@ -457,8 +457,8 @@ protocol: ppp Sets the default timeout (in seconds) for the - connection. Here, the connection will be closed - automatically after 300 seconds of inactivity. If you + connection. Here, the connection will be closed + automatically after 300 seconds of inactivity. If you never want to timeout, set this value to zero. @@ -466,18 +466,18 @@ protocol: ppp Line 9: - Sets the interface addresses. The string x.x.x.x + Sets the interface addresses. The string x.x.x.x should be replaced by the IP address that your provider - has allocated to you. The string y.y.y.y should be + has allocated to you. The string y.y.y.y should be replaced by the IP address that your ISP indicated for - their gateway (the machine to which you connect). If + their gateway (the machine to which you connect). If your ISP hasn't given you a gateway address, use - 10.0.0.2/0. If you need + 10.0.0.2/0. If you need to use a “guessed” address, make sure that you create an entry in /etc/ppp/ppp.linkup as per the instructions for PPP and Dynamic - IP addresses. If this line is omitted, ppp cannot + IP addresses. If this line is omitted, ppp cannot run in or mode. @@ -486,9 +486,9 @@ protocol: ppp Line 10: - Adds a default route to your ISPs gateway. The + Adds a default route to your ISPs gateway. The special word HISADDR is replaced with - the gateway address specified on line 9. It is + the gateway address specified on line 9. It is important that this line appears after line 9, otherwise HISADDR will not yet be initialized. @@ -501,7 +501,7 @@ protocol: ppp This line tells PPP to ask your ISP to confirm that your - nameserver addresses are correct. If your ISP supports this + nameserver addresses are correct. If your ISP supports this facility, PPP can then update /etc/resolv.conf with the correct nameserver entries. @@ -512,8 +512,8 @@ protocol: ppp It is not necessary to add an entry to ppp.linkup when you have a static IP address as your routing table entries are already correct before - you connect. You may however wish to create an entry to invoke - programs after connection. This is explained later with the + you connect. You may however wish to create an entry to invoke + programs after connection. This is explained later with the sendmail example. Example configuration files can be found in the @@ -526,9 +526,9 @@ protocol: ppp If your service provider does not assign static IP numbers, ppp can be configured to negotiate - the local and remote addresses. This is done by “guessing” an + the local and remote addresses. This is done by “guessing” an IP number and allowing ppp to set it up correctly using the IP - Configuration Protocol (IPCP) after connecting. The + Configuration Protocol (IPCP) after connecting. The ppp.conf configuration is the same as PPP and Static IP addresses, with the following change: @@ -537,7 +537,7 @@ protocol: ppp 9 set ifaddr 10.0.0.1/0 10.0.0.2/0 255.255.255.0 Again, do not include the line numbers, they are just for - reference in this discussion. Indentation of at least one space + reference in this discussion. Indentation of at least one space is required. @@ -545,7 +545,7 @@ protocol: ppp Line 9: The number after the / character is the number - of bits of the address that ppp will insist on. You may + of bits of the address that ppp will insist on. You may wish to use IP numbers more appropriate to your circumstances, but the above example will always work. @@ -553,7 +553,7 @@ protocol: ppp The last argument (0.0.0.0) tells PPP to negotiate using address 0.0.0.0 rather than 10.0.0.1. Do not use + role="ipaddr">10.0.0.1. Do not use 0.0.0.0 as the first argument to set ifaddr as it prevents PPP from setting up an intial route in mode. @@ -566,7 +566,7 @@ protocol: ppp If you are running version 1.x of PPP, uou will also need to create an entry in /etc/ppp/ppp.linkup. ppp.linkup is used after a connection has - been established. At this point, ppp will know what IP + been established. At this point, ppp will know what IP addresses should really be used. The following entry will delete the existing bogus routes, and create correct ones: @@ -583,9 +583,9 @@ protocol: ppp On establishing a connection, ppp will look for an entry in ppp.linkup according to the following rules: First, try to match the same label - as we used in ppp.conf. If that + as we used in ppp.conf. If that fails, look for an entry for the IP number of our - gateway. This entry is a four-octet IP style label. If + gateway. This entry is a four-octet IP style label. If we still haven't found an entry, look for the MYADDR entry. @@ -618,12 +618,12 @@ protocol: ppp /etc/ppp/ppp.linkup.sample for a detailed example. - Version 2 of PPP introduces “sticky routes”. Any + Version 2 of PPP introduces “sticky routes”. Any add or delete lines that contain MYADDR or HISADDR will be remembered, and any time the actual values of MYADDR or HISADDR change, the - routes will be re-applied. This removes the necessity of repeating + routes will be re-applied. This removes the necessity of repeating these lines in ppp.linkup. @@ -635,13 +635,13 @@ protocol: ppp When you configure ppp to receive incoming calls on a machine connected to a LAN, you must decide if you wish to - forward packets to the LAN. If you do, you should allocate the + forward packets to the LAN. If you do, you should allocate the peer an IP number from your LAN's subet, and use the command enable proxy - in your ppp.conf file. You should also + in your ppp.conf file. You should also confirm that the /etc/rc.conf file (this file used to be called /etc/sysconfig) contains the following: @@ -676,7 +676,7 @@ gateway=YES PPP permissions - ppp must normally be run as user id 0. If however you + ppp must normally be run as user id 0. If however you wish to allow ppp to run in server mode as a normal user by executing ppp as described below, that user must be given permission to run ppp by adding them to the @@ -716,7 +716,7 @@ echo "Starting PPP for $IDENT" exec /usr/sbin/ppp -direct $IDENT - This script should be executable. Now make a symbolic + This script should be executable. Now make a symbolic link called ppp-dialup to this script using the following commands: @@ -727,7 +727,7 @@ exec /usr/sbin/ppp -direct $IDENT You should use this script as the shell for all your dialup ppp users. This is an example from /etc/password for - a dialup PPP user with username pchilds. (remember don't + a dialup PPP user with username pchilds. (remember don't directly edit the password file, use vipw) @@ -766,7 +766,7 @@ pchilds:*:1011:300:Peter Childs PPP:/home/ppp:/etc/ppp/ppp-dialupEach of these users dialup accounts should have their - shell set to the symbolic link created above. (ie. mary's + shell set to the symbolic link created above. (ie. mary's shell should be /etc/ppp/ppp-mary). @@ -796,9 +796,9 @@ ttyd1: The default: section is - loaded for each session. For each dialup line enabled in + loaded for each session. For each dialup line enabled in /etc/ttys create an entry similar to the - one for ttyd0: above. Each line + one for ttyd0: above. Each line should get a unique IP address from your pool of IP addresses for dynamic users. @@ -809,7 +809,7 @@ ttyd1: Along with the contents of the sample /etc/ppp/ppp.conf above you should add a - section for each of the statically assigned dialup users. We + section for each of the statically assigned dialup users. We will continue with our fred, sam, and mary example. @@ -824,7 +824,7 @@ mary: The file /etc/ppp/ppp.linkup should also contain routing information for each static IP user if - required. The line below would add a route for the 203.14.101.0 class C via the client's ppp link. @@ -878,7 +878,7 @@ exec /usr/sbin/ppp -direct pap$IDENT For each dialup line enabled in /etc/ttys create a corresponding entry - in /etc/ppp/ppp.conf. This will + in /etc/ppp/ppp.conf. This will happily co-exist with the definitions we created above. @@ -901,7 +901,7 @@ enable passwdauth If you wish to assign some users a static IP number, you can specify the number as the third argument in - /etc/ppp/ppp.secret. See + /etc/ppp/ppp.secret. See /etc/ppp/ppp.secret.sample for examples. @@ -943,7 +943,7 @@ set nbns 203.14.100.5 Some ISPs set their system up so that the authentication part of your connection is done using either of the PAP or CHAP - authentication mechanisms. If this is the case, your ISP will + authentication mechanisms. If this is the case, your ISP will not give a login: prompt when you connect, but will start talking PPP immediately. @@ -964,7 +964,7 @@ set nbns 203.14.100.5 13 set authkey MyPassword As always, do not include the line numbers, they are just - for reference in this discussion. Indentation of at least one + for reference in this discussion. Indentation of at least one space is required. @@ -972,7 +972,7 @@ set nbns 203.14.100.5 Line 7: Your ISP will not normally require that you log into - the server if you're using PAP or CHAP. You must + the server if you're using PAP or CHAP. You must therefore disable your "set login" string. @@ -980,7 +980,7 @@ set nbns 203.14.100.5 Line 12: - This line specifies your PAP/CHAP user name. You + This line specifies your PAP/CHAP user name. You will need to insert the correct value for MyUserName. @@ -989,8 +989,8 @@ set nbns 203.14.100.5 Line 13: - This line specifies your PAP/CHAP password. You - will need to insert the correct value for MyPassword. You may want to add an + This line specifies your PAP/CHAP password. You + will need to insert the correct value for MyPassword. You may want to add an additional line @@ -1011,7 +1011,7 @@ set nbns 203.14.100.5 It is possible to talk to the ppp program while it is running in the background, but only if a suitable diagnostic port has - been set up. To do this, add the following line to your + been set up. To do this, add the following line to your configuration: @@ -1019,7 +1019,7 @@ set server /var/run/ppp-tun%d DiagnosticPassword 0177 This will tell PPP to listen to the specified unix-domain socket, asking clients for the specified password before allowing - access. The %d in the name is replaced with teh + access. The %d in the name is replaced with teh tun device number that is in use. Once a socket has been set up, the @@ -1033,7 +1033,7 @@ set server /var/run/ppp-tun%d DiagnosticPassword 0177 Final system configuration You now have ppp configured, but there are a few more things - to do before it is ready to work. They all involve editing the + to do before it is ready to work. They all involve editing the /etc/rc.conf file (was /etc/sysconfig). @@ -1047,7 +1047,7 @@ hostname=foo.bar.com name, it's probably best that you use this name as your host name. - Look for the network_interfaces variable. If you want to + Look for the network_interfaces variable. If you want to configure your system to dial your ISP on demand, make sure the tun0 device is added to the list, otherwise remove it. @@ -1057,15 +1057,15 @@ network_interfaces="lo0 tun0" ifconfig_tun0= The ifconfig_tun0 variable should be empty, and a file called /etc/start_if.tun0 should - be created. This file should contain the line + be created. This file should contain the line ppp -auto mysystem This script is executed at network configuration time, - starting your ppp daemon in automatic mode. If you have a LAN + starting your ppp daemon in automatic mode. If you have a LAN for which this machine is a gateway, you may also wish to use - the switch. Refer to the manual page + the switch. Refer to the manual page for further details. @@ -1082,7 +1082,7 @@ router=NO (/etc/sysconfig) It is probably worth your while ensuring that the sendmail_flags line does not include the option, otherwise sendmail will attempt to do a network lookup every now - and then, possibly causing your machine to dial out. You may + and then, possibly causing your machine to dial out. You may try: @@ -1107,7 +1107,7 @@ sendmail_flags="-bd" 4 !bg sendmail -bd -q30m If you don't like this, it is possible to set up a “dfilter” - to block SMTP traffic. Refer to the sample files for further + to block SMTP traffic. Refer to the sample files for further details. All that is left is to reboot the machine. @@ -1152,7 +1152,7 @@ sendmail_flags="-bd" Create an entry in - /etc/ppp/ppp.conf. The pmdemand example should suffice for + /etc/ppp/ppp.conf. The pmdemand example should suffice for most ISPs. @@ -1200,7 +1200,7 @@ sendmail_flags="-bd" Create an entry in - /etc/ppp/ppp.conf. The direct-server example should + /etc/ppp/ppp.conf. The direct-server example should suffice. @@ -1320,7 +1320,7 @@ defaultroute # put this if you want that PPP server will be your - Now your computer is connected with PPP. If the connection + Now your computer is connected with PPP. If the connection fails for some reasons you can add the option to the /etc/ppp/options file and check messages on the console to track the problem @@ -1351,7 +1351,7 @@ pppd /dev/tty01 19200 /etc/ppp/kermit.dial is kermit script that dials and makes all necessary authorization on the remote - host. (Example of such script is attached to the end of this + host. (Example of such script is attached to the end of this document) Use the following /etc/ppp/pppdown script @@ -1564,8 +1564,8 @@ echo \13 exit This /etc/ppp/kermit.dial script is used - for dialing and authorizing on remote host. You will need to - customize it for your needs. Put your login and password in this + for dialing and authorizing on remote host. You will need to + customize it for your needs. Put your login and password in this script, also you will need to change input statement depending on responses from your modem and remote host. @@ -1695,14 +1695,14 @@ exit 1 1995. The following is one way to set up a FreeBSD machine for SLIP on - a static host network. For dynamic hostname assignments (i.e., your + a static host network. For dynamic hostname assignments (i.e., your address changes each time you dial up), you probably need to do something much fancier. - First, determine which serial port your modem is connected to. I + First, determine which serial port your modem is connected to. I have a symbolic link to /dev/modem from /dev/cuaa1, and only use the modem name in my configuration - files. It can become quite cumbersome when you need to fix a bunch + files. It can become quite cumbersome when you need to fix a bunch of files in /etc and .kermrc's all over the system! @@ -1714,7 +1714,7 @@ exit 1 Make sure you have -pseudo-device sl 1 in your kernel's config file. It is included in +pseudo-device sl 1 in your kernel's config file. It is included in the GENERIC kernel, so this will not be a problem unless you deleted it. @@ -1727,7 +1727,7 @@ pseudo-device sl 1 in your kernel's config file. It is i Add your home machine, the gateway and nameservers to - your /etc/hosts file. Mine looks like + your /etc/hosts file. Mine looks like this: @@ -1744,12 +1744,12 @@ pseudo-device sl 1 in your kernel's config file. It is i Make sure you have before in your - /etc/host.conf. Otherwise, funny things + /etc/host.conf. Otherwise, funny things may happen. - Edit the file /etc/rc.conf. Note + Edit the file /etc/rc.conf. Note that you should edit the file /etc/sysconfig instead if you are running FreeBSD previous to version 2.2.2. @@ -1805,14 +1805,14 @@ domain HIP.Berkeley.EDU nameserver 128.32.136.9 nameserver 128.32.136.12 - As you can see, these set up the nameserver hosts. Of + As you can see, these set up the nameserver hosts. Of course, the actual domain names and addresses depend on your environment. Set the password for root and toor (and any other - accounts that does not have a password). Use passwd, do not + accounts that does not have a password). Use passwd, do not edit the /etc/passwd or /etc/master.passwd files! @@ -1835,8 +1835,8 @@ nameserver 128.32.136.12 Dial up, type slip at the prompt, enter your machine - name and password. The things you need to enter depends on - your environment. I use kermit, with a script like this: + name and password. The things you need to enter depends on + your environment. I use kermit, with a script like this: # kermit setup @@ -1854,13 +1854,13 @@ output silvia\x0d, input 10 Password:, if failure stop, - output ***\x0d, echo \x0aCONNECTED\x0a (of course, you have to change the hostname and password to fit - yours). Then you can just type slip from the kermit + yours). Then you can just type slip from the kermit prompt to get connected. Leaving your password in plain text anywhere in the - filesystem is generally a BAD idea. Do it at your own - risk. I am just too lazy. + filesystem is generally a BAD idea. Do it at your own + risk. I am just too lazy. @@ -1891,16 +1891,16 @@ output ***\x0d, echo \x0aCONNECTED\x0a &prompt.root; kill -INT `cat /var/run/slattach.modem.pid` (as root) - to kill slattach. Then go back to kermit (fg if you suspended + to kill slattach. Then go back to kermit (fg if you suspended it) and exit from it (q). The slattach man page says you have to use ifconfig sl0 down to mark the interface down, but this does not seem to make any - difference for me. (ifconfig sl0 reports the same + difference for me. (ifconfig sl0 reports the same thing.) Some times, your modem might refuse to drop the carrier (mine - often does). In that case, simply start kermit and quit it again. + often does). In that case, simply start kermit and quit it again. It usually goes out on the second try. @@ -1908,7 +1908,7 @@ output ***\x0d, echo \x0aCONNECTED\x0a Troubleshooting - If it does not work, feel free to ask me. The things that + If it does not work, feel free to ask me. The things that people tripped over so far: @@ -1926,7 +1926,7 @@ output ***\x0d, echo \x0aCONNECTED\x0a Try ifconfig sl0 to see your - interface status. I get: + interface status. I get: &prompt.root; ifconfig sl0 @@ -1938,7 +1938,7 @@ sl0: flags=10<POINTOPOINT> Also, netstat -r will give the routing table, in case you get the "no route to host" - messages from ping. Mine looks like: + messages from ping. Mine looks like: &prompt.root; netstat -r @@ -1974,17 +1974,17 @@ silvia.HIP.Berke localhost.Berkeley UGH 34 47641234 lo0 - 0.438 This document provides suggestions for setting up SLIP Server services on a FreeBSD system, which typically means configuring your system to automatically startup connections upon login for remote - SLIP clients. The author has written this document based on his + SLIP clients. The author has written this document based on his experience; however, as your system and needs may be different, this document may not answer all of your questions, and the author cannot be responsible if you damage your system or lose data due to attempting to follow the suggestions here. This guide was originally written for SLIP Server services on a - FreeBSD 1.x system. It has been modified to reflect changes in the + FreeBSD 1.x system. It has been modified to reflect changes in the pathnames and the removal of the SLIP interface compression flags in early versions of FreeBSD 2.X, which appear to be the only major - changes between FreeBSD versions. If you do encounter mistakes in + changes between FreeBSD versions. If you do encounter mistakes in this document, please email the author with enough information to help correct the problem. @@ -1993,10 +1993,10 @@ silvia.HIP.Berke localhost.Berkeley UGH 34 47641234 lo0 - 0.438 Prerequisites This document is very technical in nature, so background - knowledge is required. It is assumed that you are familiar with + knowledge is required. It is assumed that you are familiar with the TCP/IP network protocol, and in particular, network and node addressing, network address masks, subnetting, routing, and - routing protocols, such as RIP. Configuring SLIP services on a + routing protocols, such as RIP. Configuring SLIP services on a dial-up server requires a knowledge of these concepts, and if you are not familiar with them, please read a copy of either Craig Hunt's TCP/IP Network Administration @@ -2006,14 +2006,14 @@ silvia.HIP.Berke localhost.Berkeley UGH 34 47641234 lo0 - 0.438 It is further assumed that you have already setup your modem(s) and configured the appropriate system files to allow - logins through your modems. If you have not prepared your system + logins through your modems. If you have not prepared your system for this yet, please see the tutorial for configuring dialup services; if you have a World-Wide Web browser available, browse the list of tutorials at http://www.freebsd.org/; otherwise, check the place where you found this document for a document named dialup.txt or something - similar. You may also want to check the manual pages for + similar. You may also want to check the manual pages for sio4 for information on the serial port device driver and ttys5, gettytab5, @@ -2032,7 +2032,7 @@ silvia.HIP.Berke localhost.Berkeley UGH 34 47641234 lo0 - 0.438 works as follows: a SLIP user dials up your FreeBSD SLIP Server system and logs in with a special SLIP login ID that uses /usr/sbin/sliplogin as the special user's - shell. The sliplogin program + shell. The sliplogin program browses the file /etc/sliphome/slip.hosts to find a matching line for the special user, and if it finds a match, connects the serial line to an available SLIP interface and @@ -2078,7 +2078,7 @@ Shelmerg dc-slip sl-helmer 0xfffffc00 autocomp to set the local IP address (dc-slip), remote IP address (sl-helmer), network mask for the SLIP interface (0xfffffc00), and any additional - flags (autocomp). If something + flags (autocomp). If something goes wrong, sliplogin usually logs good informational messages via the daemon syslog facility, which usually goes into /var/log/messages @@ -2115,7 +2115,7 @@ sl1* 296 <Link> 0 0 0 0 The sl0 and sl1 interfaces shown in netstat -i's output indicate that there are - two SLIP interfaces built into the kernel. (The asterisks after + two SLIP interfaces built into the kernel. (The asterisks after the sl0 and sl1 indicate that the interfaces are “down”.) @@ -2207,7 +2207,7 @@ pseudo-device sl 2 domain name service, depending on your specifications in /etc/host.conf), and I believe the network mask may be a name that can be resolved by a lookup into - /etc/networks. On a sample system, + /etc/networks. On a sample system, /etc/sliphome/slip.hosts looks like this: @@ -2260,7 +2260,7 @@ Shelmerg dc-slip sl-helmerg 0xfffffc00 autocompslips-prereqs section @@ -2269,7 +2269,7 @@ Shelmerg dc-slip sl-helmerg 0xfffffc00 autocompIf you are going to use a separate subnet for your SLIP clients, you will need to allocate the subnet number out of your assigned IP network number and assign each of your SLIP client's - IP numbers out of that subnet. Then, you will probably either + IP numbers out of that subnet. Then, you will probably either need to configure a static route to the SLIP subnet via your SLIP server on your nearest IP router, or install gated on your FreeBSD SLIP server and configure it to talk the appropriate routing protocols to your @@ -2331,7 +2331,7 @@ Shelmerg dc-slip sl-helmerg 0xfffffc00 autocompThe additional line in this slip.login, arp -s $5 00:11:22:33:44:55 pub, creates - an ARP entry in the SLIP server's ARP table. This ARP entry + an ARP entry in the SLIP server's ARP table. This ARP entry causes the SLIP server to respond with the SLIP server's Ethernet MAC address whenever a another IP node on the Ethernet asks to speak to the SLIP client's IP address. @@ -2441,7 +2441,7 @@ Shelmerg dc-slip sl-helmerg 0xfffffc00 autocompAdding static routes to your nearest default routers can be troublesome (or impossible, if you do not have authority to do - so...). If you have a multiple-router network in your + so...). If you have a multiple-router network in your organization, some routers, such as Cisco and Proteon, may not only need to be configured with the static route to the SLIP subnet, but also need to be told which static routes to tell @@ -2461,7 +2461,7 @@ Shelmerg dc-slip sl-helmerg 0xfffffc00 autocompgated from the ports collection or retrieve and build it yourself from the GateD anonymous ftp site; I believe the current version as of this writing is gated-R3_5Alpha_8.tar.Z, which includes support for FreeBSD “out-of-the-box”. Complete information and documentation on gated is available on the Web starting at the Merit GateD Consortium. Compile and install it, and then write a /etc/gated.conf file to configure your gated; here is a sample, similar to what the author used on a FreeBSD SLIP server: + URL="ftp://ftp.gated.merit.edu/research.and.development/gated/">the GateD anonymous ftp site; I believe the current version as of this writing is gated-R3_5Alpha_8.tar.Z, which includes support for FreeBSD “out-of-the-box”. Complete information and documentation on gated is available on the Web starting at the Merit GateD Consortium. Compile and install it, and then write a /etc/gated.conf file to configure your gated; here is a sample, similar to what the author used on a FreeBSD SLIP server: # @@ -2508,10 +2508,10 @@ import proto rip interface ed { Ethernet; if you are using a different Ethernet driver than the ed driver, you will need to change the references to the ed interface - appropriately. This sample file also sets up tracing to + appropriately. This sample file also sets up tracing to /var/tmp/gated.output for debugging gated's activity; you can - certainly turn off the tracing options if gated works OK for you. You will need to + certainly turn off the tracing options if gated works OK for you. You will need to change the xxx.xxx.yy's into the network address of your own SLIP subnet (be sure to change the net mask in the proto direct @@ -2522,7 +2522,7 @@ import proto rip interface ed { to run gated in place of routed on your FreeBSD system; change the routed/gated startup parameters in /etc/netstart as appropriate for your - system. Please see the manual page for gated for information on gated's command-line parameters. + system. Please see the manual page for gated for information on gated's command-line parameters. diff --git a/en_US.ISO_8859-1/books/handbook/printing/chapter.sgml b/en_US.ISO_8859-1/books/handbook/printing/chapter.sgml index 7756117e3a..94d1196547 100644 --- a/en_US.ISO_8859-1/books/handbook/printing/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/printing/chapter.sgml @@ -6,8 +6,8 @@ In order to use printers with FreeBSD, you will need to set them up to work with the Berkeley line printer spooling system, also known - as the LPD spooling system. It is the standard printer control system - in FreeBSD. This section introduces the LPD spooling system, often + as the LPD spooling system. It is the standard printer control system + in FreeBSD. This section introduces the LPD spooling system, often simply called LPD. If you are already familiar with LPD or another printer spooling @@ -19,7 +19,7 @@ What the Spooler Does - LPD controls everything about a host's printers. It is + LPD controls everything about a host's printers. It is responsible for a number of things: @@ -81,7 +81,7 @@ If you are the sole user of your system, you may be wondering why you should bother with the spooler when you do not need access - control, header pages, or printer accounting. While it is possible + control, header pages, or printer accounting. While it is possible to enable direct access to a printer, you should use the spooler anyway since @@ -97,7 +97,7 @@ LPD can conveniently run a job to be printed through filters to add date/time headers or convert a special file format (such as a TeX DVI file) into a format the printer will - understand. You will not have to do these steps manually. + understand. You will not have to do these steps manually. @@ -117,7 +117,7 @@ Setting Up the Spooling System To use printers with the LPD spooling system, you will need to - set up both your printer hardware and the LPD software. This + set up both your printer hardware and the LPD software. This document describes two levels of setup: @@ -146,7 +146,7 @@ Simple Printer Setup This section tells how to configure printer hardware and the - LPD software to use the printer. It teaches the basics: + LPD software to use the printer. It teaches the basics: @@ -172,8 +172,8 @@ With Networked Data Stream Interaces. Although this section is called “Simple Printer Setup,” it is - actually fairly complex. Getting the printer to work with your - computer and the LPD spooler is the hardest part. The advanced + actually fairly complex. Getting the printer to work with your + computer and the LPD spooler is the hardest part. The advanced options like header pages and accounting are fairly easy once you get the printer working. @@ -182,7 +182,7 @@ Hardware Setup This section tells about the various ways you can connect a - printer to your PC. It talks about the kinds of ports and cables, + printer to your PC. It talks about the kinds of ports and cables, and also the kernel configuration you may need to enable FreeBSD to speak to the printer. @@ -202,9 +202,9 @@ Serial interfaces use a serial - port on your computer to send data to the printer. Serial + port on your computer to send data to the printer. Serial interfaces are common in the computer industry and cables - are readily available and also easy to construct. Serial + are readily available and also easy to construct. Serial interfaces sometimes need special cables and might require you to configure somewhat complex communications options. @@ -212,9 +212,9 @@ Parallel interfaces use a parallel port on your computer to send data to the - printer. Parallel interfaces are common in the PC market. + printer. Parallel interfaces are common in the PC market. Cables are readily available but more difficult to - construct by hand. There are usually no communications + construct by hand. There are usually no communications options with parallel interfaces, making their configuration exceedingly simple. @@ -227,26 +227,26 @@ In general, serial interfaces are slower than parallel - interfaces. Parallel interfaces usually offer just one-way + interfaces. Parallel interfaces usually offer just one-way communication (computer to printer) while serial gives you - two-way. Many newer parallel ports can also receive data from + two-way. Many newer parallel ports can also receive data from the printer, but only few printers need to send data back to the - computer. And FreeBSD does not support two-way parallel + computer. And FreeBSD does not support two-way parallel communication yet. Usually, the only time you need two-way communication with - the printer is if the printer speaks PostScript. PostScript - printers can be very verbose. In fact, PostScript jobs are + the printer is if the printer speaks PostScript. PostScript + printers can be very verbose. In fact, PostScript jobs are actually programs sent to the printer; they need not produce paper at all and may return results directly to the computer. PostScript also uses two-way communication to tell the computer about problems, such as errors in the PostScript program or - paper jams. Your users may be appreciative of such information. + paper jams. Your users may be appreciative of such information. Furthermore, the best way to do effective accounting with a PostScript printer requires two-way communication: you ask the printer for its page count (how many pages it has printed in its lifetime), then send the user's job, then ask again for its page - count. Subtract the two values and you know how much paper to + count. Subtract the two values and you know how much paper to charge the user. So, which interface should you use? @@ -262,9 +262,9 @@ If you do not need two-way communication and can pick - parallel or serial, prefer the parallel interface. It + parallel or serial, prefer the parallel interface. It keeps a serial port free for other peripherals—such as a - terminal or a modem—and is faster most of the time. It + terminal or a modem—and is faster most of the time. It is also easier to configure. @@ -281,11 +281,11 @@ Parallel Ports To hook up a printer using a parallel interface, connect - the Centronics cable between the printer and the computer. The + the Centronics cable between the printer and the computer. The instructions that came with the printer, the computer, or both should give you complete guidance. - Remember which parallel port you used on the computer. The + Remember which parallel port you used on the computer. The first parallel port is /dev/lpt0 to FreeBSD; the second is /dev/lpt1, and so on. @@ -295,7 +295,7 @@ Serial Ports To hook up a printer using a serial interface, connect the - proper serial cable between the printer and the computer. The + proper serial cable between the printer and the computer. The instructions that came with the printer, the computer, or both should give you complete guidance. @@ -307,7 +307,7 @@ A modem cable connects each pin of the connector on one end of the cable straight through to its corresponding pin of the connector on the other - end. This type of cable is also known as a “DTE-to-DCE” + end. This type of cable is also known as a “DTE-to-DCE” cable. @@ -315,7 +315,7 @@ A null-modem cable connects some pins straight through, swaps others (send data to receive data, for example), and shorts some internally in each - connector hood. This type of cable is also known as a + connector hood. This type of cable is also known as a “DTE-to-DTE” cable. @@ -330,13 +330,13 @@ You should also set up the communications parameters for the printer, usually through front-panel controls or DIP switches on - the printer. Choose the highest bps (bits per second, sometimes + the printer. Choose the highest bps (bits per second, sometimes baud rate) rate that both your computer and - the printer can support. Choose 7 or 8 data bits; none, even, - or odd parity; and 1 or 2 stop bits. Also choose a flow control + the printer can support. Choose 7 or 8 data bits; none, even, + or odd parity; and 1 or 2 stop bits. Also choose a flow control protocol: either none, or XON/XOFF (also known as “in-band” or “software”) - flow control. Remember these settings for the software + flow control. Remember these settings for the software configuration that follows. @@ -368,13 +368,13 @@ Test if the operating system can send data to the - printer. Section Checking Printer Communications gives some + printer. Section Checking Printer Communications gives some suggestions on how to do this. Set up LPD for the printer by modifying the file - /etc/printcap. Section /etc/printcap. Section The /etc/printcap File shows you how. @@ -385,8 +385,8 @@ Kernel Configuration The operating system kernel is compiled to work with a - specific set of devices. The serial or parallel interface for - your printer is a part of that set. Therefore, it might be + specific set of devices. The serial or parallel interface for + your printer is a part of that set. Therefore, it might be necessary to add support for an additional serial or parallel port if your kernel is not already configured for one. @@ -398,7 +398,7 @@ Where N is the - number of the serial port, starting from zero. If you see + number of the serial port, starting from zero. If you see output similar to the following: @@ -416,7 +416,7 @@ sio2: type 16550A Where N is the - number of the parallel port, starting from zero. If you see + number of the parallel port, starting from zero. If you see output similar to the following @@ -428,7 +428,7 @@ sio2: type 16550A port you are using for the printer. To add support for a serial port, see the section on kernel - configuration. To add support for a parallel port, see that + configuration. To add support for a parallel port, see that section and the section that follows. @@ -439,7 +439,7 @@ sio2: type 16550A Even though the kernel may support communication along a serial or parallel port, you will still need a software interface through which programs running on the system can - send and receive data. That is what entries in the + send and receive data. That is what entries in the /dev directory are for. To add a /dev @@ -450,7 +450,7 @@ sio2: type 16550A Become root with the su - command. Enter the root password when prompted. + command. Enter the root password when prompted. @@ -469,7 +469,7 @@ sio2: type 16550A Where port is the device entry for the - port you want to make. Use lpt0 for the first parallel port, + port you want to make. Use lpt0 for the first parallel port, lpt1 for the second, and so on; use ttyd0 for the first serial port, ttyd1 @@ -503,7 +503,7 @@ sio2: type 16550A The interrupt-driven method is - the default with the GENERIC kernel. With this method, + the default with the GENERIC kernel. With this method, the operating system uses an IRQ line to determine when the printer is ready for data. @@ -511,7 +511,7 @@ sio2: type 16550A The polled method directs the operating system to repeatedly ask the printer if it is - ready for more data. When it responds ready, the kernel + ready for more data. When it responds ready, the kernel sends more data. @@ -519,7 +519,7 @@ sio2: type 16550A The interrupt-driven method is somewhat faster but uses up - a precious IRQ line. You should use whichever one + a precious IRQ line. You should use whichever one works. You can set the communications mode in two ways: by @@ -532,9 +532,9 @@ sio2: type 16550A - Edit your kernel configuration file. Look for or - add an lpt0 entry. If you - are setting up the second parallel port, use lpt1 instead. Use lpt2 for the third port, and so + Edit your kernel configuration file. Look for or + add an lpt0 entry. If you + are setting up the second parallel port, use lpt1 instead. Use lpt2 for the third port, and so on. @@ -562,8 +562,8 @@ device lpt0 at isa? port? tty vector lptintr - Save the file. Then configure, build, and install - the kernel, then reboot. See Save the file. Then configure, build, and install + the kernel, then reboot. See kernel configuration for more details. @@ -601,7 +601,7 @@ device lpt0 at isa? port? tty vector lptintr You could put these commands in your /etc/rc.local file to set the mode each - time your system boots. See lptcontrol8 for more information. + time your system boots. See lptcontrol8 for more information. @@ -610,16 +610,16 @@ device lpt0 at isa? port? tty vector lptintr Before proceeding to configure the spooling system, you should make sure the operating system can successfully send - data to your printer. It is a lot easier to debug printer + data to your printer. It is a lot easier to debug printer communication and the spooling system separately. - To test the printer, we will send some text to it. For + To test the printer, we will send some text to it. For printers that can immediately print characters sent to them, the program lptest is perfect: it generates all 96 printable ASCII characters in 96 lines. For a PostScript (or other language-based) printer, we - will need a more sophisticated test. A small PostScript + will need a more sophisticated test. A small PostScript program, such as the following, will suffice: @@ -633,7 +633,7 @@ showpage When this document refers to a printer language, I am assuming a language like PostScript, and not Hewlett - Packard's PCL. Although PCL has great functionality, you can + Packard's PCL. Although PCL has great functionality, you can intermingle plain text with its escape sequences. PostScript cannot directly print plain text, and that is the kind of printer language for which we must make special @@ -664,7 +664,7 @@ showpage If the printer can print plain text, then use - lptest. Type: + lptest. Type: &prompt.root; lptest > /dev/lptN @@ -677,7 +677,7 @@ showpage If the printer understands PostScript or other printer language, then send a small - program to the printer. Type: + program to the printer. Type: &prompt.root; cat > /dev/lptN @@ -686,7 +686,7 @@ showpage Then, line by line, type the program carefully as you cannot edit a line once you have pressed RETURN - or ENTER. When you have finished entering the + or ENTER. When you have finished entering the program, press CONTROL+D, or whatever your end of file key is. @@ -708,7 +708,7 @@ showpage - You should see something print. Do not worry if the + You should see something print. Do not worry if the text does not look right; we will fix such things later. @@ -754,7 +754,7 @@ printer:dv=/dev/ttyd2:br#19200:pa=none Connect to the printer with - tip. Type: + tip. Type: &prompt.root; tip printer @@ -772,7 +772,7 @@ printer:dv=/dev/ttyd2:br#19200:pa=none If the printer can print plain text, then use - lptest. Type: + lptest. Type: ~$lptest @@ -782,12 +782,12 @@ printer:dv=/dev/ttyd2:br#19200:pa=none If the printer understands PostScript or other printer language, then send a small - program to the printer. Type the program, line + program to the printer. Type the program, line by line, very carefully as backspacing or other editing keys may be - significant to the printer. You may also need to + significant to the printer. You may also need to type a special end-of-file key for the printer - so it knows it received the whole program. For + so it knows it received the whole program. For PostScript printers, press CONTROL+D. Alternatively, you can put the program in a @@ -798,7 +798,7 @@ printer:dv=/dev/ttyd2:br#19200:pa=none Where file is the name of the - file containing the program. After + file containing the program. After tip sends the file, press any required end-of-file key. @@ -809,7 +809,7 @@ printer:dv=/dev/ttyd2:br#19200:pa=none - You should see something print. Do not worry if the + You should see something print. Do not worry if the text does not look right; we will fix that later. @@ -822,17 +822,17 @@ printer:dv=/dev/ttyd2:br#19200:pa=none At this point, your printer should be hooked up, your kernel configured to communicate with it (if necessary), and you - have been able to send some simple data to the printer. Now, we + have been able to send some simple data to the printer. Now, we are ready to configure LPD to control access to your printer. You configure LPD by editing the file - /etc/printcap. The LPD spooling system + /etc/printcap. The LPD spooling system reads this file each time the spooler is used, so updates to the file take immediate effect. The format of the - printcap file is straightforward. Use your favorite text editor to make changes to /etc/printcap. The format is identical to other capability files like /usr/share/misc/termcap and /etc/remote. For complete information about the format, see the cgetent3. + printcap file is straightforward. Use your favorite text editor to make changes to /etc/printcap. The format is identical to other capability files like /usr/share/misc/termcap and /etc/remote. For complete information about the format, see the cgetent3. The simple spooler configuration consists of the following steps: @@ -864,7 +864,7 @@ printer:dv=/dev/ttyd2:br#19200:pa=none with the lp capability; see Identifying the Printer - Device. Also, if the printer is on a serial port, set + Device. Also, if the printer is on a serial port, set up the communication parameters with the fs, fc, xs, and xc capabilities; see Language-based printers, such as PostScript printers, - cannot directly print plain text. The simple setup outlined + cannot directly print plain text. The simple setup outlined above and described in the following sections assumes that if you are installing such a printer you will print only files that the printer can understand. Users often expect that they can print plain text to any of - the printers installed on your system. Programs that interface + the printers installed on your system. Programs that interface to LPD to do their printing usually make the same assumption. If you are installing such a printer and want to be able to print jobs in the printer language and print plain text jobs, you are strongly urged to add an additional step to the simple setup outlined above: install an automatic plain-text-to-PostScript (or other printer language) - conversion program. Section Accommodating Plain Text Jobs on PostScript Printers tells how to do this. @@ -920,8 +920,8 @@ printer:dv=/dev/ttyd2:br#19200:pa=none At least one of the printers specified in the /etc/printcap should have the alias - lp. This is the default - printer's name. If users do not have the PRINTER environment + lp. This is the default + printer's name. If users do not have the PRINTER environment variable nor specify a printer name on the command line of any of the LPD commands, then lp will be the default printer they get to use. @@ -931,8 +931,8 @@ printer:dv=/dev/ttyd2:br#19200:pa=none and model. Once you have picked a name and some common aliases, put - them in the /etc/printcap file. The name - of the printer should start in the leftmost column. Separate + them in the /etc/printcap file. The name + of the printer should start in the leftmost column. Separate each alias with a vertical bar and put a colon after the last alias. @@ -953,7 +953,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4: rattan and has as aliases line, diablo, lp, and Diablo 630 - Line Printer. Since it has the alias lp, it is also the default printer. The + Line Printer. Since it has the alias lp, it is also the default printer. The second is named bamboo, and has as aliases ps, PS, S, @@ -966,15 +966,15 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4: Suppressing Header Pages The LPD spooling system will by default print a - header page for each job. The header + header page for each job. The header page contains the user name who requested the job, the host from which the job came, and the name of the job, in nice - large letters. Unfortunately, all this extra text gets in the + large letters. Unfortunately, all this extra text gets in the way of debugging the simple printer setup, so we will suppress header pages. To suppress header pages, add the sh capability to the entry for the - printer in /etc/printcap. Here is the + printer in /etc/printcap. Here is the example /etc/printcap with sh added: @@ -989,7 +989,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Note how we used the correct format: the first line starts in the leftmost column, and subsequent lines - are indented with a single TAB. Every line in an entry except + are indented with a single TAB. Every line in an entry except the last ends in a backslash character. @@ -1004,7 +1004,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Because of the variable nature of spooling directories, it is customary to put these directories under - /var/spool. It is not necessary to + /var/spool. It is not necessary to backup the contents of spooling directories, either. Recreating them is as simple as running mkdir. @@ -1019,7 +1019,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ However, if you have a lot of printers on your network, you might want to put the spooling directories under a single directory that you reserve just for printing - with LPD. We will do this for our two example printers + with LPD. We will do this for our two example printers rattan and bamboo: @@ -1031,7 +1031,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ If you are concerned about the privacy of jobs that users print, you might want to protect the spooling - directory so it is not publicly accessible. Spooling + directory so it is not publicly accessible. Spooling directories should be owned and be readable, writable, and searchable by user daemon and group daemon, and no one else. We will do this for our example printers: @@ -1046,7 +1046,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Finally, you need to tell LPD about these directories - using the /etc/printcap file. You + using the /etc/printcap file. You specify the pathname of the spooling directory with the sd capability: @@ -1075,8 +1075,8 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ In section Adding /dev Entries for the Ports, we identified which entry in the /dev directory FreeBSD - will use to communicate with the printer. Now, we tell LPD - that information. When the spooling system has a job to + will use to communicate with the printer. Now, we tell LPD + that information. When the spooling system has a job to print, it will open the specified device on behalf of the filter program (which is responsible for passing data to the printer). @@ -1111,7 +1111,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ If the printer you are installing is connected to a parallel port, skip to the section Installing the - Text Filter. Otherwise, be sure to follow the + Text Filter. Otherwise, be sure to follow the instructions in the next section. @@ -1203,11 +1203,11 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ the sgttyb structure; it clears any bits in the fc capability, then sets bits in the fs - capability, then applies the resultant setting. It does the + capability, then applies the resultant setting. It does the same for the local mode bits as well. Let us add to our example printer on the sixth serial - port. We will set the bps rate to 38400. For the flag bits, + port. We will set the bps rate to 38400. For the flag bits, we will set the TANDEM, ANYP, LITOUT, FLUSHO, and PASS8 flags. For the local mode bits, we will set the LITOUT and PASS8 flags: @@ -1223,15 +1223,15 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Installing the Text Filter We are now ready to tell LPD what text filter to use to - send jobs to the printer. A text filter, + send jobs to the printer. A text filter, also known as an input filter, is a - program that LPD runs when it has a job to print. When LPD + program that LPD runs when it has a job to print. When LPD runs the text filter for a printer, it sets the filter's standard input to the job to print, and its standard output to - the printer device specified with the lp capability. The filter is expected + the printer device specified with the lp capability. The filter is expected to read the job from standard input, perform any necessary translation for the printer, and write the results to standard - output, which will get printed. For more information on the + output, which will get printed. For more information on the text filter, see section Filters. @@ -1240,14 +1240,14 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ /bin/cat to send the job to the printer. FreeBSD comes with another filter called lpf that handles backspacing and underlining for printers that might not deal with such - character streams well. And, of course, you can use any other - filter program you want. The filter lpf is described in detail in section + character streams well. And, of course, you can use any other + filter program you want. The filter lpf is described in detail in section lpf: a Text Filter. First, let us make the shell script /usr/local/libexec/if-simple be a simple - text filter. Put the following text into that file with your + text filter. Put the following text into that file with your favorite text editor: @@ -1268,7 +1268,7 @@ exit 2 And then tell LPD to use it by specifying it with the if capability in - /etc/printcap. We will add it to the two + /etc/printcap. We will add it to the two printers we have so far in the example /etc/printcap: @@ -1293,7 +1293,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ You have reached the end of the simple LPD setup. Unfortunately, congratulations are not quite yet in order, since we still have to test the setup and correct any - problems. To test the setup, try printing something. To + problems. To test the setup, try printing something. To print with the LPD system, you use the command lpr, which submits a job for printing. @@ -1317,14 +1317,14 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ (or an alias) specified in /etc/printcap. To test the default printer, type lpr - without any argument. Again, if you are + without any argument. Again, if you are testing a printer that expects PostScript, send a PostScript program in that language instead of using - lptest. You + lptest. You can do so by putting the program in a file and typing lpr file. For a PostScript printer, you should get the results of - the program. If you are using + the program. If you are using lptest, then your results should look like the following: @@ -1336,7 +1336,7 @@ $%&'()*+,-./01234567 To further test the printer, try downloading larger programs (for language-based printers) or running - lptest with different arguments. For example, lptest 80 60 will produce 60 lines of 80 characters each. + lptest with different arguments. For example, lptest 80 60 will produce 60 lines of 80 characters each. If the printer did not work, see the next section, Troubleshooting. @@ -1356,17 +1356,17 @@ $%&'()*+,-./01234567 eject a full sheet. The printer printed the above, but it sat for - awhile and did nothing. In fact, you might have + awhile and did nothing. In fact, you might have needed to press a PRINT REMAINING or FORM FEED button on the printer to get any results to appear. If this is the case, the printer was probably waiting to see if there was any more data for your job - before it printed anything. To fix this problem, you + before it printed anything. To fix this problem, you can have the text filter send a FORM FEED character - (or whatever is necessary) to the printer. This is + (or whatever is necessary) to the printer. This is usually sufficient to have the printer immediately - print any text remaining in its internal buffer. It + print any text remaining in its internal buffer. It is also useful to make sure each print job ends on a full sheet, so the next job does not start somewhere on the middle of the last page of the previous @@ -1404,18 +1404,18 @@ exit 2 You have become another victim of the staircase effect, caused by conflicting interpretations of what characters should - indicate a new-line. UNIX-style operating systems use + indicate a new-line. UNIX-style operating systems use a single character: ASCII code 10, the line feed (LF). MS-DOS, OS/2, and others uses a pair of characters, ASCII code 10 and ASCII code 13 - (the carriage return or CR). Many printers use the + (the carriage return or CR). Many printers use the MS-DOS convention for representing new-lines. When you print with FreeBSD, your text used just - the line feed character. The printer, upon seeing a + the line feed character. The printer, upon seeing a line feed character, advanced the paper one line, but maintained the same horizontal position on the page - for the next character to print. That is what the + for the next character to print. That is what the carriage return is for: to move the location of the next character to print to the left edge of the paper. @@ -1446,7 +1446,7 @@ exit 2 Use the printer's configuration switches or control panel to alter its interpretation of - these characters. Check your printer's manual + these characters. Check your printer's manual to find out how to do this. @@ -1455,16 +1455,16 @@ exit 2 have to reconfigure the printer to use a an interpretation for CR and LF characters that those other operating - systems use. You might prefer one of the + systems use. You might prefer one of the other solutions, below. Have FreeBSD's serial line driver - automatically convert LF to CR+LF. Of course, + automatically convert LF to CR+LF. Of course, this works with printers on serial ports - only. To enable this + only. To enable this feature, set the CRMOD bit in fs capability in the /etc/printcap file for the printer. @@ -1473,18 +1473,18 @@ exit 2 Send an escape code to the printer to have it temporarily treat LF - characters differently. Consult your printer's + characters differently. Consult your printer's manual for escape codes that your printer might - support. When you find the proper escape code, + support. When you find the proper escape code, modify the text filter to send the code first, then send the print job. Here is an example text filter for printers that understand the Hewlett-Packard PCL escape - codes. This filter makes the printer treat LF + codes. This filter makes the printer treat LF characters as a LF and CR; then it sends the job; then it sends a form feed to eject the last - page of the job. It should work with nearly all + page of the job. It should work with nearly all Hewlett Packard printers. @@ -1502,9 +1502,9 @@ exit 2 Here is an example /etc/printcap from a host - called orchid. It has a single printer attached + called orchid. It has a single printer attached to its first parallel port, a Hewlett Packard - LaserJet 3Si named teak. It is using the + LaserJet 3Si named teak. It is using the above script as its text filter: @@ -1524,12 +1524,12 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ It overprinted each line. - The printer never advanced a line. All of the + The printer never advanced a line. All of the lines of text were printed on top of each other on one line. This problem is the “opposite” of the staircase - effect, described above, and is much rarer. Somewhere, + effect, described above, and is much rarer. Somewhere, the LF characters that FreeBSD uses to end a line are being treated as CR characters to return the print location to the left edge of the paper, but not also @@ -1568,13 +1568,13 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ While printing, the printer did not print a few - characters in each line. The problem might have + characters in each line. The problem might have gotten worse as the printer ran, losing more and more characters. The problem is that the printer cannot keep up with the speed at which the computer sends data over a - serial line. (This problem should not occur with + serial line. (This problem should not occur with printers on parallel ports.) There are two ways to overcome the problem: @@ -1587,7 +1587,7 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ If the printer supports carrier flow - control, specify the MDMBUF bit in the fs capability. Make sure + control, specify the MDMBUF bit in the fs capability. Make sure the cable connecting the printer to the computer is correctly wired for carrier flow control. @@ -1627,10 +1627,10 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ If nothing happened, the problem is probably - within FreeBSD and not the hardware. Add the log file + within FreeBSD and not the hardware. Add the log file (lf) capability to the entry for the printer you are debugging in the - /etc/printcap file. For example, + /etc/printcap file. For example, here is the entry for rattan, with the lf capability: @@ -1640,10 +1640,10 @@ rattan|line|diablo|lp|Diablo 630 Line Printer:\ :lp=/dev/lpt0:\ :if=/usr/local/libexec/if-simple:\ :lf=/var/log/rattan.log - Then, try printing again. Check + Then, try printing again. Check the log file (in our example, /var/log/rattan.log) to see any - error messages that might appear. Based on the + error messages that might appear. Based on the messages you see, try to correct the problem. If you do not specify a lf capability, LPD uses @@ -1662,7 +1662,7 @@ rattan|line|diablo|lp|Diablo 630 Line Printer:\ Using Printers This section tells you how to use printers you have setup with - FreeBSD. Here is an overview of the user-level commands: + FreeBSD. Here is an overview of the user-level commands: @@ -1701,10 +1701,10 @@ rattan|line|diablo|lp|Diablo 630 Line Printer:\ lpq accept an option to specify on which printer/queue to operate, as listed in the - /etc/printcap file. This enables you to - submit, remove, and check on jobs for various printers. If you do + /etc/printcap file. This enables you to + submit, remove, and check on jobs for various printers. If you do not use the option, then these commands use the - printer specified in the PRINTER environment variable. Finally, if + printer specified in the PRINTER environment variable. Finally, if you do not have a PRINTER environment variable, these commands default to the printer named lp. @@ -1724,9 +1724,9 @@ rattan|line|diablo|lp|Diablo 630 Line Printer:\ This prints each of the listed files to the - default printer. If you list no files, + default printer. If you list no files, lpr reads - data to print from standard input. For example, this command + data to print from standard input. For example, this command prints some important system files: @@ -1769,20 +1769,20 @@ rattan|line|diablo|lp|Diablo 630 Line Printer:\ lpr, the data you wish to print is put together in a package called a “print job”, which is sent to the LPD spooling - system. Each printer has a queue of jobs, and your job waits in + system. Each printer has a queue of jobs, and your job waits in that queue along with other jobs from yourself and from other - users. The printer prints those jobs in a first-come, first-served + users. The printer prints those jobs in a first-come, first-served order. To display the queue for the default printer, type - lpq. For a - specific printer, use the option. For + lpq. For a + specific printer, use the option. For example, the command &prompt.user; lpq -P bamboo - shows the queue for the printer named bamboo. Here is an example of the output of + shows the queue for the printer named bamboo. Here is an example of the output of the lpq command: @@ -1794,9 +1794,9 @@ active kelly 9 /etc/host.conf, /etc/hosts.equiv 88 bytes This shows three jobs in the queue for - bamboo. The first job, submitted by - user kelly, got assigned “job number” 9. Every - job for a printer gets a unique job number. Most of the time you + bamboo. The first job, submitted by + user kelly, got assigned “job number” 9. Every + job for a printer gets a unique job number. Most of the time you can ignore the job number, but you will need it if you want to cancel the job; see section Removing Jobs for @@ -1805,16 +1805,16 @@ active kelly 9 /etc/host.conf, /etc/hosts.equiv 88 bytes Job number nine consists of two files; multiple files given on the lpr command - line are treated as part of a single job. It is the currently + line are treated as part of a single job. It is the currently active job (note the word active under the “Rank” column), which means the printer should be - currently printing that job. The second job consists of data + currently printing that job. The second job consists of data passed as the standard input to the lpr - command. The third job came from user mary; it is a much larger - job. The pathname of the files she's trying to print is too long + command. The third job came from user mary; it is a much larger + job. The pathname of the files she's trying to print is too long to fit, so the lpq command just shows three dots. @@ -1827,7 +1827,7 @@ active kelly 9 /etc/host.conf, /etc/hosts.equiv 88 bytes The lpq command also support a option to generate a detailed - long listing. Here is an example of lpq -l: + long listing. Here is an example of lpq -l: waiting for bamboo to become ready (offline ?) @@ -1850,7 +1850,7 @@ mary: 3rd [job 011rose] If you change your mind about printing a job, you can remove the job from the queue with the lprm - command. Often, you can even use + command. Often, you can even use lprm to remove an active job, but some or all of the job might still get printed. @@ -1858,14 +1858,14 @@ mary: 3rd [job 011rose] To remove a job from the default printer, first use lpq to find - the job number. Then type: + the job number. Then type: &prompt.user; lprm job-number To remove the job from a specific printer, add - the option. The following command removes job + the option. The following command removes job number 10 from the queue for the printer bamboo: @@ -1889,7 +1889,7 @@ mary: 3rd [job 011rose] Removes all jobs (for the default printer) belonging - to user. The superuser can + to user. The superuser can remove other users' jobs; you can remove only your own jobs. @@ -1901,7 +1901,7 @@ mary: 3rd [job 011rose] With no job number, user name, or appearing on the command line, - lprm removes the currently active job on the default printer, if it belongs to you. The superuser can remove any active job. + lprm removes the currently active job on the default printer, if it belongs to you. The superuser can remove any active job. @@ -1922,7 +1922,7 @@ mary: 3rd [job 011rose] lprm will let you remove jobs only from the host from which the jobs were submitted, even if the same printer is available from other - hosts. The following command sequence demonstrates this: + hosts. The following command sequence demonstrates this: &prompt.user; lpr -P rattan myfile @@ -1949,7 +1949,7 @@ cfA013rose dequeued lpr command supports a number of options that control formatting text, converting graphic and other file formats, producing multiple - copies, handling of the job, and more. This section describes the + copies, handling of the job, and more. This section describes the options. @@ -1958,7 +1958,7 @@ cfA013rose dequeued The following lpr - options control formatting of the files in the job. Use these + options control formatting of the files in the job. Use these options if the job does not contain plain text or if you want plain text formatted through the pr @@ -1980,8 +1980,8 @@ cfA013rose dequeued All of these options except and require conversion filters installed for - the destination printer. For example, the - option requires the DVI conversion filter. Section -d + option requires the DVI conversion filter. Section Conversion Filters gives details. @@ -2021,7 +2021,7 @@ cfA013rose dequeued Indent the output by number columns; if you omit number, indent by 8 - columns. This option works only with certain conversion + columns. This option works only with certain conversion filters. @@ -2052,7 +2052,7 @@ cfA013rose dequeued Format plain text with pr - before printing. See pr1 for more information. + before printing. See pr1 for more information. @@ -2063,7 +2063,7 @@ cfA013rose dequeued Use title on the pr - header instead of the file name. This option has effect + header instead of the file name. This option has effect only when used with the option. @@ -2105,7 +2105,7 @@ cfA013rose dequeued command, which formats that source and makes GNU troff output and passes it to lpr, - which submits the job to the LPD spooler. Because we used the + which submits the job to the LPD spooler. Because we used the option to @@ -2127,9 +2127,9 @@ cfA013rose dequeued -# copies Produce a number of copies of each file in the job - instead of just one copy. An administrator may disable + instead of just one copy. An administrator may disable this option to reduce printer wear-and-tear and - encourage photocopier usage. See section Restricting Multiple Copies. This example prints three copies of @@ -2146,9 +2146,9 @@ cfA013rose dequeued -m - Send mail after completing the print job. With this + Send mail after completing the print job. With this option, the LPD system will send mail to your account - when it finishes handling your job. In its message, it + when it finishes handling your job. In its message, it will tell you if the job completed successfully or if there was an error, and (often) what the error was. @@ -2162,9 +2162,9 @@ cfA013rose dequeued make symbolic links to them instead. If you are printing a large job, you probably want - to use this option. It saves space in the spooling + to use this option. It saves space in the spooling directory (your job might overflow the free space on the - filesystem where the spooling directory resides). It + filesystem where the spooling directory resides). It saves time as well since LPD will not have to copy each and every byte of your job to the spooling directory. @@ -2178,7 +2178,7 @@ cfA013rose dequeued eventually have to copy files from the local host to the remote host, so the option will save space only on the local spooling directory, - not the remote. It is still useful, though. + not the remote. It is still useful, though. @@ -2188,7 +2188,7 @@ cfA013rose dequeued Remove the files in the job after copying them to the spooling directory, or after printing them with the - option. Be careful with this + option. Be careful with this option! @@ -2204,7 +2204,7 @@ cfA013rose dequeued lpr adjust the text that normally appears on a job's header page. If header pages are suppressed for the destination printer, - these options have no effect. See section Header Pages for information about setting up header pages. @@ -2213,7 +2213,7 @@ cfA013rose dequeued -C text Replace the hostname on the header page with - text. The hostname is + text. The hostname is normally the name of the host from which the job was submitted. @@ -2223,7 +2223,7 @@ cfA013rose dequeued Replace the job name on the header page with - text. The job name is + text. The job name is normally the name of the first file of the job, or stdin if you are printing standard input. @@ -2236,7 +2236,7 @@ cfA013rose dequeued At some sites, this option may have no effect due - to the way header pages are generated. See Header Pages for details. @@ -2252,7 +2252,7 @@ cfA013rose dequeued Administrating Printers As an administrator for your printers, you have had to - install, set up, and test them. Using the + install, set up, and test them. Using the lpc command, you can interact with your printers in yet more ways. With @@ -2279,27 +2279,27 @@ cfA013rose dequeued First, a note about terminology: if a printer is stopped, it will not print anything in its - queue. Users can still submit jobs, which will wait in the queue + queue. Users can still submit jobs, which will wait in the queue until the printer is started or the queue is cleared. If a queue is disabled, no user (except - root) can submit jobs for the printer. An - enabled queue allows jobs to be submitted. A + root) can submit jobs for the printer. An + enabled queue allows jobs to be submitted. A printer can be started for a disabled queue, in which case it will continue to print jobs in the queue until the queue is empty. In general, you have to have root privileges to use the lpc - command. Ordinary users can use the + command. Ordinary users can use the lpc command to get printer status and to restart a hung printer only. Here is a summary of the lpc - commands. Most of the commands takes a printer-name argument to tell on which - printer to operate. You can use all + commands. Most of the commands takes a printer-name argument to tell on which + printer to operate. You can use all for the printer-name to mean all printers listed in /etc/printcap. @@ -2308,7 +2308,7 @@ cfA013rose dequeued abort printer-name - Cancel the current job and stop the printer. Users + Cancel the current job and stop the printer. Users can still submit jobs if the queue's enabled. @@ -2318,10 +2318,10 @@ cfA013rose dequeued Remove old files from the printer's spooling - directory. Occasionally, the files that make up a job are + directory. Occasionally, the files that make up a job are not properly removed by LPD, particularly if there have been errors during printing or a lot of administrative - activity. This command finds files that do not belong in + activity. This command finds files that do not belong in the spooling directory and removes them. @@ -2330,14 +2330,14 @@ cfA013rose dequeued printer-name - Disable queuing of new jobs. If the printer's + Disable queuing of new jobs. If the printer's started, it will continue to print any jobs remaining in - the queue. The superuser (root) can always submit jobs, + the queue. The superuser (root) can always submit jobs, even to a disabled queue. This command is useful while you are testing a new printer or filter installation: disable the queue and - submit jobs as root. Other users will not be able to + submit jobs as root. Other users will not be able to submit jobs until you complete your testing and re-enable the queue with the enable command. @@ -2349,9 +2349,9 @@ cfA013rose dequeued message - Take a printer down. Equivalent to + Take a printer down. Equivalent to disable followed by - stop. The message appears as the printer's + stop. The message appears as the printer's status whenever a user checks the printer's queue with lpq @@ -2364,7 +2364,7 @@ cfA013rose dequeued printer-name - Enable the queue for a printer. Users can submit jobs + Enable the queue for a printer. Users can submit jobs but the printer will not print anything until it is started. @@ -2375,7 +2375,7 @@ cfA013rose dequeued Print help on the command - command-name. With no + command-name. With no command-name, print a summary of the commands available. @@ -2385,10 +2385,10 @@ cfA013rose dequeued printer-name - Start the printer. Ordinary users can use this + Start the printer. Ordinary users can use this command if some extraordinary circumstance hangs LPD, but they cannot start a printer stopped with either the - stop or down commands. The restart command is equivalent to + stop or down commands. The restart command is equivalent to abort followed by start. @@ -2397,7 +2397,7 @@ cfA013rose dequeued printer-name - Start the printer. The printer will print jobs in its + Start the printer. The printer will print jobs in its queue. @@ -2406,8 +2406,8 @@ cfA013rose dequeued printer-name - Stop the printer. The printer will finish the current - job and will not print anything else in its queue. Even + Stop the printer. The printer will finish the current + job and will not print anything else in its queue. Even though the printer is stopped, users can still submit jobs to an enabled queue. @@ -2430,7 +2430,7 @@ cfA013rose dequeued printer-name - Bring a printer up; the opposite of the down command. Equivalent to + Bring a printer up; the opposite of the down command. Equivalent to start followed by enable. @@ -2439,7 +2439,7 @@ cfA013rose dequeued lpc accepts - the above commands on the command line. If you do not enter any + the above commands on the command line. If you do not enter any commands, lpc enters an interactive mode, where you can enter commands until you type @@ -2462,9 +2462,9 @@ cfA013rose dequeued Although LPD handles network protocols, queuing, access control, and other aspects of printing, most of the real work happens in the - filters. Filters are programs that + filters. Filters are programs that communicate with the printer and handle its device dependencies - and special requirements. In the simple printer setup, we + and special requirements. In the simple printer setup, we installed a plain text filter—an extremely simple one that should work with most printers (section Installing the @@ -2472,15 +2472,15 @@ cfA013rose dequeued However, in order to take advantage of format conversion, printer accounting, specific printer quirks, and so on, you should - understand how filters work. It will ultimately be the filter's - responsibility to handle these aspects. And the bad news is that + understand how filters work. It will ultimately be the filter's + responsibility to handle these aspects. And the bad news is that most of the time you have to provide filters - yourself. The good news is that many are generally available; + yourself. The good news is that many are generally available; when they are not, they are usually easy to write. Also, FreeBSD comes with one, /usr/libexec/lpr/lpf, that works with many - printers that can print plain text. (It handles backspacing and + printers that can print plain text. (It handles backspacing and tabs in the file, and does accounting, but that is about all it does.) There are also several filters and filter components in the FreeBSD ports collection. @@ -2492,32 +2492,32 @@ cfA013rose dequeued Section How Filters Work, tries to give an overview of a - filter's role in the printing process. You should read this + filter's role in the printing process. You should read this section to get an understanding of what is happening “under - the hood” when LPD uses filters. This knowledge could help + the hood” when LPD uses filters. This knowledge could help you anticipate and debug problems you might encounter as you install more and more filters on each of your printers. LPD expects every printer to be able to print plain text - by default. This presents a problem for PostScript (or + by default. This presents a problem for PostScript (or other language-based printers) which cannot directly print - plain text. Section Accommodating Plain Text Jobs on PostScript Printers tells you what you should do to overcome this - problem. I recommend reading this section if you have a + problem. I recommend reading this section if you have a PostScript printer. PostScript is a popular output format for many programs. Even some people (myself included) write PostScript code - directly. But PostScript printers are expensive. Section + directly. But PostScript printers are expensive. Section Simulating PostScript on Non-PostScript Printers tells how you can further modify a printer's text filter to accept and print PostScript data on a - non-PostScript printer. I recommend + non-PostScript printer. I recommend reading this section if you do not have a PostScript printer. @@ -2526,17 +2526,17 @@ cfA013rose dequeued Section Conversion Filters tells about a way you can automate the conversion of specific file formats, such as graphic or typesetting data, into formats your printer can - understand. After reading this section, you should be able + understand. After reading this section, you should be able to set up your printers such that users can type lpr -t to print troff data, or lpr -d to print TeX DVI data, or lpr -v to print raster image data, and so - forth. I recommend reading this section. + forth. I recommend reading this section. Section Output Filters tells all about a not often used - feature of LPD: output filters. Unless you are printing + feature of LPD: output filters. Unless you are printing header pages (see Header Pages), you can probably skip that section altogether. @@ -2545,7 +2545,7 @@ cfA013rose dequeued Section lpf: a Text Filter describes lpf, a fairly complete if simple text filter for line printers (and laser printers that act like - line printers) that comes with FreeBSD. If you need a quick + line printers) that comes with FreeBSD. If you need a quick way to get printer accounting working for plain text, or if you have a printer which emits smoke when it sees backspace characters, you should definitely consider lpf. @@ -2562,7 +2562,7 @@ cfA013rose dequeued communicating with the printer. When LPD wants to print a file in a job, it starts a filter - program. It sets the filter's standard input to the file to + program. It sets the filter's standard input to the file to print, its standard output to the printer, and its standard error to the error logging file (specified in the lf capability in /etc/printcap, or @@ -2574,10 +2574,10 @@ cfA013rose dequeued lpr - command line. For example, if the user typed lpr + command line. For example, if the user typed lpr -t, LPD would start the troff filter, listed in the tf capability for the destination - printer. If the user wanted to print plain text, it would start + printer. If the user wanted to print plain text, it would start the if filter (this is mostly true: see Output Filters @@ -2591,16 +2591,16 @@ cfA013rose dequeued The text filter, confusingly called the input filter in LPD - documentation, handles regular text printing. Think of it - as the default filter. LPD expects every printer to be + documentation, handles regular text printing. Think of it + as the default filter. LPD expects every printer to be able to print plain text by default, and it is the text filter's job to make sure backspaces, tabs, or other - special characters do not confuse the printer. If you are + special characters do not confuse the printer. If you are in an environment where you have to account for printer usage, the text filter must also account for pages printed, usually by counting the number of lines printed and comparing that to the number of lines per page the - printer supports. The text filter is started with the + printer supports. The text filter is started with the following argument list: @@ -2679,13 +2679,13 @@ cfA013rose dequeued A conversion filter converts a specific file format into one the printer can render onto - paper. For example, ditroff typesetting data cannot be + paper. For example, ditroff typesetting data cannot be directly printed, but you can install a conversion filter for ditroff files to convert the ditroff data into a form - the printer can digest and print. Section + the printer can digest and print. Section Conversion Filters tells all about them. Conversion filters also need to do accounting, if you need - printer accounting. Conversion filters are started with + printer accounting. Conversion filters are started with the following arguments: @@ -2706,9 +2706,9 @@ cfA013rose dequeued The output filter is used only if there is no text filter, or if header pages are enabled. - In my experience, output filters are rarely used. Section + In my experience, output filters are rarely used. Section Output - Filters describe them. There are only two arguments + Filters describe them. There are only two arguments to an output filter: @@ -2737,7 +2737,7 @@ cfA013rose dequeued If the filter failed to print the file but wants LPD - to try to print the file again. LPD will restart a + to try to print the file again. LPD will restart a filter if it exits with this status. @@ -2746,7 +2746,7 @@ cfA013rose dequeued If the filter failed to print the file and does not - want LPD to try again. LPD will throw out the + want LPD to try again. LPD will throw out the file. @@ -2756,13 +2756,13 @@ cfA013rose dequeued The text filter that comes with the FreeBSD release, /usr/libexec/lpr/lpf, takes advantage of the page width and length arguments to determine when to send a - form feed and how to account for printer usage. It uses the + form feed and how to account for printer usage. It uses the login, host, and accounting file arguments to make the accounting entries. If you are shopping for filters, see if they are - LPD-compatible. If they are, they must support the argument - lists described above. If you plan on writing filters for + LPD-compatible. If they are, they must support the argument + lists described above. If you plan on writing filters for general use, then have them support the same argument lists and exit codes. @@ -2779,36 +2779,36 @@ cfA013rose dequeued But, if you would like to send both PostScript and plain text jobs to the printer, then you are urged to augment your - printer setup. To do so, we have the text filter detect if the - arriving job is plain text or PostScript. All PostScript jobs + printer setup. To do so, we have the text filter detect if the + arriving job is plain text or PostScript. All PostScript jobs must start with %! (for other - printer languages, see your printer documentation). If those are + printer languages, see your printer documentation). If those are the first two characters in the job, we have PostScript, and can - pass the rest of the job directly. If those are not the first + pass the rest of the job directly. If those are not the first two characters in the file, then the filter will convert the text into PostScript and print the result. How do we do this? If you have got a serial printer, a great way to do it is to - install lprps. lprps is a PostScript printer filter which - performs two-way communication with the printer. It updates the + install lprps. lprps is a PostScript printer filter which + performs two-way communication with the printer. It updates the printer's status file with verbose information from the printer, so users and administrators can see exactly what the state of - the printer is (such as toner low or paper jam). But + the printer is (such as toner low or paper jam). But more importantly, it includes a program called psif which detects whether the incoming job is plain text and calls textps - (another program that comes with lprps) to convert it to PostScript. It + (another program that comes with lprps) to convert it to PostScript. It then uses lprps to send the job to the printer. lprps is part of the FreeBSD ports collection (see The Ports - Collection). You - can fetch, build and install it yourself, of course. After + Collection). You + can fetch, build and install it yourself, of course. After installing lprps, just specify the pathname to the psif program that - is part of lprps. If you + is part of lprps. If you installed lprps from the ports collection, use the following in the serial PostScript printer's entry in /etc/printcap: @@ -2850,8 +2850,8 @@ else fi In the above script, textps is a program we installed - separately to convert plain text to PostScript. You can use any - text-to-PostScript program you wish. The FreeBSD ports + separately to convert plain text to PostScript. You can use any + text-to-PostScript program you wish. The FreeBSD ports collection (see The Ports Collection) includes a full featured text-to-PostScript program called @@ -2863,33 +2863,33 @@ fi Simulating PostScript on Non-PostScript Printers PostScript is the de facto - standard for high quality typesetting and printing. PostScript + standard for high quality typesetting and printing. PostScript is, however, an expensive standard. Thankfully, Alladin Enterprises has a free PostScript work-alike called Ghostscript that runs with - FreeBSD. Ghostscript can read most PostScript files and can + FreeBSD. Ghostscript can read most PostScript files and can render their pages onto a variety of devices, including many - brands of non-PostScript printers. By installing Ghostscript + brands of non-PostScript printers. By installing Ghostscript and using a special text filter for your printer, you can make your non-PostScript printer act like a real PostScript printer. Ghostscript should be in the FreeBSD ports collection, if - you would like to install it from there. You can fetch, build, + you would like to install it from there. You can fetch, build, and install it quite easily yourself, as well. To simulate PostScript, we have the text filter detect if it - is printing a PostScript file. If it is not, then the filter + is printing a PostScript file. If it is not, then the filter will pass the file directly to the printer; otherwise, it will use Ghostscript to first convert the file into a format the printer will understand. Here is an example: the following script is a text filter - for Hewlett Packard DeskJet 500 printers. For other printers, + for Hewlett Packard DeskJet 500 printers. For other printers, substitute the argument to the - gs (Ghostscript) command. (Type gs -h to get a list of devices the current installation of Ghostscript supports.) + gs (Ghostscript) command. (Type gs -h to get a list of devices the current installation of Ghostscript supports.) #!/bin/sh @@ -2930,7 +2930,7 @@ exit 2 :if=/usr/local/libexec/hpif: - That is it. You can type lpr plain.text and lpr + That is it. You can type lpr plain.text and lpr whatever.ps and both should print successfully. @@ -2950,10 +2950,10 @@ exit 2 Why Install Conversion Filters? Conversion filters make printing various kinds of files - easy. As an example, suppose we do a lot of work with the TeX - typesetting system, and we have a PostScript printer. Every + easy. As an example, suppose we do a lot of work with the TeX + typesetting system, and we have a PostScript printer. Every time we generate a DVI file from TeX, we cannot print it - directly until we convert the DVI file into PostScript. The + directly until we convert the DVI file into PostScript. The command sequence goes like this: @@ -2963,7 +2963,7 @@ exit 2 By installing a conversion filter for DVI files, we can skip the hand conversion step each time by - having LPD do it for us. Now, each time we get a DVI file, we + having LPD do it for us. Now, each time we get a DVI file, we are just one step away from printing it: @@ -2971,14 +2971,14 @@ exit 2 We got LPD to do the DVI file conversion - for us by specifying the option. Section + for us by specifying the option. Section Formatting and Conversion Options lists the conversion options. For each of the conversion options you want a printer to support, install a conversion filter and - specify its pathname in /etc/printcap. A + specify its pathname in /etc/printcap. A conversion filter is like the text filter for the simple printer setup (see section Installing the Text Filter) except that instead of printing plain text, the filter converts the file into a @@ -2990,8 +2990,8 @@ exit 2 Which Conversions Filters Should I Install? You should install the conversion filters you expect to - use. If you print a lot of DVI data, then a DVI conversion - filter is in order. If you have got plenty of troff to print + use. If you print a lot of DVI data, then a DVI conversion + filter is in order. If you have got plenty of troff to print out, then you probably want a troff filter. The following table summarizes the filters that LPD works @@ -3066,12 +3066,12 @@ exit 2 its entry in /etc/printcap. Despite what others might contend, formats like FORTRAN - text and plot are probably obsolete. At your site, you can + text and plot are probably obsolete. At your site, you can give new meanings to these or any of the formatting options - just by installing custom filters. For example, suppose you + just by installing custom filters. For example, suppose you would like to directly print Printerleaf files (files from the Interleaf desktop publishing program), but will never print - plot files. You could install a Printerleaf conversion filter + plot files. You could install a Printerleaf conversion filter under the gf capability and then educate your users that lpr -g mean “print Printerleaf files.” @@ -3083,7 +3083,7 @@ exit 2 Since conversion filters are programs you install outside of the base FreeBSD installation, they should probably go - under /usr/local. The directory + under /usr/local. The directory /usr/local/libexec is a popular location, since they are specialized programs that only LPD will run; regular users should not ever need to run them. @@ -3093,7 +3093,7 @@ exit 2 /etc/printcap. In our example, we will add the DVI conversion filter to - the entry for the printer named bamboo. Here is the example + the entry for the printer named bamboo. Here is the example /etc/printcap file again, with the new df capability for the printer bamboo. @@ -3114,7 +3114,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ :df=/usr/local/libexec/psdf: The DVI filter is a shell script named - /usr/local/libexec/psdf. Here is that + /usr/local/libexec/psdf. Here is that script: @@ -3128,7 +3128,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ exec /usr/local/bin/dvips -f | /usr/local/libexec/lprps "$@" This script runs - dvips in filter mode (the argument) on standard input, which is the job to print. It then starts the PostScript printer filter lprps (see section Accommodating Plain Text Jobs on PostScript + dvips in filter mode (the argument) on standard input, which is the job to print. It then starts the PostScript printer filter lprps (see section Accommodating Plain Text Jobs on PostScript Printers) with the arguments LPD passed to this script. lprps will use those arguments to account for the pages printed. @@ -3139,8 +3139,8 @@ exec /usr/local/bin/dvips -f | /usr/local/libexec/lprps "$@" More Conversion Filter Examples Since there is no fixed set of steps to install - conversion filters, let me instead provide more examples. Use - these as guidance to making your own filters. Use them + conversion filters, let me instead provide more examples. Use + these as guidance to making your own filters. Use them directly, if appropriate. This example script is a raster (well, GIF file, actually) @@ -3187,7 +3187,7 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ exec grops | /usr/local/libexec/lprps "$@" The above script makes use of lprps again to handle the communication - with the printer. If the printer were on a parallel port, we + with the printer. If the printer were on a parallel port, we would use this script instead: @@ -3198,7 +3198,7 @@ exec grops | /usr/local/libexec/lprps "$@" # exec grops - That is it. Here is the entry we need to + That is it. Here is the entry we need to add to /etc/printcap to enable the filter: @@ -3206,8 +3206,8 @@ exec grops :tf=/usr/local/libexec/pstf: Here is an example that might make old hands at FORTRAN - blush. It is a FORTRAN-text filter for any printer that can - directly print plain text. We will install it for the printer + blush. It is a FORTRAN-text filter for any printer that can + directly print plain text. We will install it for the printer teak: @@ -3227,20 +3227,20 @@ exit 2 :rf=/usr/local/libexec/hprf: - Here is one final, somewhat complex example. We will add - a DVI filter to the LaserJet printer teak introduced earlier. First, the + Here is one final, somewhat complex example. We will add + a DVI filter to the LaserJet printer teak introduced earlier. First, the easy part: updating /etc/printcap with the location of the DVI filter: :df=/usr/local/libexec/hpdf: - Now, for the hard part: making the filter. For that, we - need a DVI-to-LaserJet/PCL conversion program. The FreeBSD + Now, for the hard part: making the filter. For that, we + need a DVI-to-LaserJet/PCL conversion program. The FreeBSD ports collection (see The Ports Collection) has one: dvi2xx is the - name of the package. Installing this package gives us the + name of the package. Installing this package gives us the program we need, dvilj2p, which converts DVI into LaserJet IIp, LaserJet III, and LaserJet 2000 compatible codes. @@ -3249,11 +3249,11 @@ exit 2 the filter hpdf quite complex since dvilj2p cannot - read from standard input. It wants to work with a filename. + read from standard input. It wants to work with a filename. What is worse, the filename has to end in .dvi so using /dev/fd/0 for standard input is - problematic. We can get around that problem by linking + problematic. We can get around that problem by linking (symbolically) a temporary file name (one that ends in .dvi) to /dev/fd/0, thereby forcing @@ -3262,7 +3262,7 @@ exit 2 The only other fly in the ointment is the fact that we cannot use /tmp for the temporary link. Symbolic links are owned by user and group - bin. The filter runs as user daemon. And the + bin. The filter runs as user daemon. And the /tmp directory has the sticky bit set. The filter can create the link, but it will not be able clean up when done and remove it since the link will belong to a @@ -3271,7 +3271,7 @@ exit 2 Instead, the filter will make the symbolic link in the current working directory, which is the spooling directory (specified by the sd capability - in /etc/printcap). This is a perfect + in /etc/printcap). This is a perfect place for filters to do their work, especially since there is (sometimes) more free disk space in the spooling directory than under /tmp. @@ -3349,9 +3349,9 @@ exit 0 printing environment, but at the cost forcing the user to specify (on the lpr - command line) which one to use. If your users are not + command line) which one to use. If your users are not particularly computer literate, having to specify a filter - option will become annoying. What is worse, though, is that + option will become annoying. What is worse, though, is that an incorrectly specified filter option may run a filter on the wrong type of file and cause your printer to spew out hundreds of sheets of paper. @@ -3359,15 +3359,15 @@ exit 0 Rather than install conversion filters at all, you might want to try having the text filter (since it is the default filter) detect the type of file it has been asked to print and - then automatically run the right conversion filter. Tools + then automatically run the right conversion filter. Tools such as file can be of help - here. Of course, it will be hard to determine the differences + here. Of course, it will be hard to determine the differences between some file types—and, of course, you can still provide conversion filters just for them. The FreeBSD ports collection has a text filter that performs automatic conversion called - apsfilter. It can detect plain text, PostScript, and DVI files, run the proper conversions, and print. + apsfilter. It can detect plain text, PostScript, and DVI files, run the proper conversions, and print. @@ -3376,9 +3376,9 @@ exit 0 Output Filters The LPD spooling system supports one other type of filter - that we have not yet explored: an output filter. An output + that we have not yet explored: an output filter. An output filter is intended for printing plain text only, like the text - filter, but with many simplifications. If you are using an + filter, but with many simplifications. If you are using an output filter but no text filter, then: @@ -3394,7 +3394,7 @@ exit 0 LPD does not pass the user's login or host to the - filter, so it is not intended to do accounting. In fact, + filter, so it is not intended to do accounting. In fact, it gets only two arguments: @@ -3412,12 +3412,12 @@ exit 0 - Do not be seduced by an output filter's simplicity. If you + Do not be seduced by an output filter's simplicity. If you would like each file in a job to start on a different page an - output filter will not work. Use a text + output filter will not work. Use a text filter (also known as an input filter); see section Installing the Text - Filter. Furthermore, an output filter is actually + Filter. Furthermore, an output filter is actually more complex in that it has to examine the byte stream being sent to it for special flag characters and must send signals to itself on behalf of LPD. @@ -3425,35 +3425,35 @@ exit 0 However, an output filter is necessary if you want header pages and need to send escape sequences or other initialization strings to be able to print the header - page. (But it is also futile if you want + page. (But it is also futile if you want to charge header pages to the requesting user's account, since LPD does not give any user or host information to the output filter.) On a single printer, LPD allows both an output filter and - text or other filters. In such cases, LPD will start the output + text or other filters. In such cases, LPD will start the output filter to print the header page (see section Header - Pages) only. LPD then expects the output filter to + Pages) only. LPD then expects the output filter to stop itself by sending two bytes to the - filter: ASCII 031 followed by ASCII 001. When an output filter + filter: ASCII 031 followed by ASCII 001. When an output filter sees these two bytes (031, 001), it should stop by sending - SIGSTOP to itself. When LPD's done running other filters, it + SIGSTOP to itself. When LPD's done running other filters, it will restart the output filter by sending SIGCONT to it. If there is an output filter but no text filter and LPD is working on a plain text job, LPD uses the - output filter to do the job. As stated before, the output + output filter to do the job. As stated before, the output filter will print each file of the job in sequence with no intervening form feeds or other paper advancement, and this is - probably not what you want. In almost all + probably not what you want. In almost all cases, you need a text filter. The program lpf, which we introduced earlier as a text filter, can also run as an output - filter. If you need a quick-and-dirty output filter but do not + filter. If you need a quick-and-dirty output filter but do not want to write the byte detection and signal sending code, try - lpf. You can also wrap lpf in a shell script to handle any + lpf. You can also wrap lpf in a shell script to handle any initialization codes the printer might require. @@ -3466,11 +3466,11 @@ exit 0 filter) that can indent output (job submitted with lpr -i), allow literal characters to pass (job submitted with lpr -l), adjust the printing position for backspaces and tabs in the job, and - account for pages printed. It can also act like an output + account for pages printed. It can also act like an output filter. lpf is suitable for many - printing environments. And although it has no capability to + printing environments. And although it has no capability to send initialization sequences to a printer, it is easy to write a shell script to do the needed initialization and then execute lpf. @@ -3478,9 +3478,9 @@ exit 0 In order for lpf to do page accounting correctly, it needs correct values filled in for the pw and pl capabilities in the - /etc/printcap file. It uses these values + /etc/printcap file. It uses these values to determine how much text can fit on a page and how many pages - were in a user's job. For more information on printer + were in a user's job. For more information on printer accounting, see Accounting for Printer Usage. @@ -3497,20 +3497,20 @@ exit 0 Header pages, also known as banner or burst pages identify to whom jobs belong - after they are printed. They are usually printed in large, bold + after they are printed. They are usually printed in large, bold letters, perhaps with decorative borders, so that in a stack of printouts they stand out from the real documents that comprise - users' jobs. They enable users to locate their jobs quickly. The + users' jobs. They enable users to locate their jobs quickly. The obvious drawback to a header page is that it is yet one more sheet that has to be printed for every job, their ephemeral usefulness lasting not more than a few minutes, ultimately finding themselves - in a recycling bin or rubbish heap. (Note that header pages go + in a recycling bin or rubbish heap. (Note that header pages go with each job, not each file in a job, so the paper waste might not be that bad.) The LPD system can provide header pages automatically for your printouts if your printer can directly print - plain text. If you have a PostScript printer, you will need an + plain text. If you have a PostScript printer, you will need an external program to generate the header page; see Header Pages on PostScript Printers. @@ -3522,14 +3522,14 @@ exit 0 In the Simple Printer Setup, we turned off header pages by specifying sh (meaning “suppress - header”) in the /etc/printcap file. To + header”) in the /etc/printcap file. To enable header pages for a printer, just remove the sh capability. Sounds too easy, right? - You are right. You might have to + You are right. You might have to provide an output filter to send initialization strings to the - printer. Here is an example output filter for Hewlett Packard + printer. Here is an example output filter for Hewlett Packard PCL-compatible printers: @@ -3542,7 +3542,7 @@ printf "\033&k2G" || exit 2 exec /usr/libexec/lpr/lpf Specify the path to the output filter in the - of capability. See of capability. See Output Filters for more information. Here is an example /etc/printcap file @@ -3561,7 +3561,7 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ :of=/usr/local/libexec/hpof: Now, when users print jobs to teak, they get a header page with each - job. If users want to spend time searching for their printouts, + job. If users want to spend time searching for their printouts, they can suppress header pages by submitting the job with lpr -h; see Header Page @@ -3583,7 +3583,7 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ By enabling header pages, LPD will produce a long header, a full page of large letters identifying - the user, host, and job. Here is an example (kelly printed the + the user, host, and job. Here is an example (kelly printed the job named outline from host rose): @@ -3649,7 +3649,7 @@ teak|hp|laserjet|Hewlett Packard LaserJet 3Si:\ rose:kelly Job: outline Date: Sun Sep 17 11:07:51 1995 Also by default, LPD prints the header page - first, then the job. To reverse that, specify hl (header last) in + first, then the job. To reverse that, specify hl (header last) in /etc/printcap. @@ -3667,18 +3667,18 @@ rose:kelly Job: outline Date: Sun Sep 17 11:07:51 1995 will have control when the header page is printed that could do accounting, and it is not provided with any user or host information or an accounting file, so it has - no idea whom to charge for printer use. It is also not enough + no idea whom to charge for printer use. It is also not enough to just “add one page” to the text filter or any of the conversion filters (which do have user and host information) since users can suppress header pages with lpr - -h. They could still be charged for header pages - they did not print. Basically, lpr -h will + -h. They could still be charged for header pages + they did not print. Basically, lpr -h will be the preferred option of environmentally-minded users, but you cannot offer any incentive to use it. It is still not enough to have each of the filters generate their own header pages (thereby being able - to charge for them). If users wanted the option of suppressing + to charge for them). If users wanted the option of suppressing the header pages with lpr -h, they will still get them and be charged for them since LPD does not pass any knowledge of the option to any of the @@ -3704,20 +3704,20 @@ rose:kelly Job: outline Date: Sun Sep 17 11:07:51 1995 Write a smart output filter. Normally, an output filter is not meant to do anything more than initialize a printer or do some simple character - conversion. It is suited for header pages and plain text - jobs (when there is no text (input) filter). But, if there + conversion. It is suited for header pages and plain text + jobs (when there is no text (input) filter). But, if there is a text filter for the plain text jobs, then LPD will - start the output filter only for the header pages. And + start the output filter only for the header pages. And the output filter can parse the header page text that LPD generates to determine what user and host to charge for - the header page. The only other problem with this method + the header page. The only other problem with this method is that the output filter still does not know what accounting file to use (it is not passed the name of the file from the af capability), but if you have a well-known accounting file, - you can hard-code that into the output filter. To + you can hard-code that into the output filter. To facilitate the parsing step, use the sh (short header) capability in - /etc/printcap. Then again, all that + /etc/printcap. Then again, all that might be too much trouble, and users will certainly appreciate the more generous system administrator who makes header pages free. @@ -3732,18 +3732,18 @@ rose:kelly Job: outline Date: Sun Sep 17 11:07:51 1995 Header Pages on PostScript Printers As described above, LPD can generate a plain text header - page suitable for many printers. Of course, PostScript cannot + page suitable for many printers. Of course, PostScript cannot directly print plain text, so the header page feature of LPD is useless—or mostly so. One obvious way to get header pages is to have every conversion filter and the text filter generate the header page. The filters should should use the user and host arguments to - generate a suitable header page. The drawback of this method is + generate a suitable header page. The drawback of this method is that users will always get a header page, even if they submit jobs with lpr -h. - Let us explore this method. The following script takes + Let us explore this method. The following script takes three arguments (user login name, host name, and job name) and makes a simple PostScript header page: @@ -3830,7 +3830,7 @@ EOF Now, each of the conversion filters and the text filter can call this script to first generate the header - page, and then print the user's job. Here is the DVI conversion + page, and then print the user's job. Here is the DVI conversion filter from earlier in this document, modified to make a header page: @@ -3868,14 +3868,14 @@ done /usr/local/bin/dvips -f ) | eval /usr/local/libexec/lprps $orig_args Notice how the filter has to parse the - argument list in order to determine the user and host name. The - parsing for the other conversion filters is identical. The text + argument list in order to determine the user and host name. The + parsing for the other conversion filters is identical. The text filter takes a slightly different set of arguments, though (see section How Filters Work). As we have mentioned before, the above scheme, though fairly simple, disables the “suppress header page” option (the - option) to lpr. If users wanted to save a tree (or a + option) to lpr. If users wanted to save a tree (or a few pennies, if you charge for header pages), they would not be able to do so, since every filter's going to print a header page with every job. @@ -3884,16 +3884,16 @@ done you will need to use the trick introduced in section Accounting for Header Pages: write an output filter that parses the LPD-generated header page and produces a - PostScript version. If the user submits the job with + PostScript version. If the user submits the job with lpr -h, then LPD will not generate a header - page, and neither will your output filter. Otherwise, your + page, and neither will your output filter. Otherwise, your output filter will read the text from LPD and send the appropriate header page PostScript code to the printer. If you have a PostScript printer on a serial line, you can make use of lprps, which comes with an output filter, psof, which - does the above. Note that psof + does the above. Note that psof does not charge for header pages. @@ -3903,14 +3903,14 @@ done Networked Printing FreeBSD supports networked printing: sending jobs to remote - printers. Networked printing generally refers to two different + printers. Networked printing generally refers to two different things: - Accessing a printer attached to a remote host. You + Accessing a printer attached to a remote host. You install a printer that has a conventional serial or parallel - interface on one host. Then, you set up LPD to enable + interface on one host. Then, you set up LPD to enable access to the printer from other hosts on the network. Section Printers @@ -3918,17 +3918,17 @@ done - Accessing a printer attached directly to a network. The + Accessing a printer attached directly to a network. The printer has a network interface in addition (or in place of) - a more conventional serial or parallel interface. Such a + a more conventional serial or parallel interface. Such a printer might work as follows: It might understand the LPD protocol and can even - queue jobs from remote hosts. In this case, it acts - just like a regular host running LPD. Follow the same + queue jobs from remote hosts. In this case, it acts + just like a regular host running LPD. Follow the same procedure in section Printers Installed on Remote Hosts to set up such a printer. @@ -3958,18 +3958,18 @@ done The LPD spooling system has built-in support for sending jobs to other hosts also running LPD (or are compatible with - LPD). This feature enables you to install a printer on one host - and make it accessible from other hosts. It also works with + LPD). This feature enables you to install a printer on one host + and make it accessible from other hosts. It also works with printers that have network interfaces that understand the LPD protocol. To enable this kind of remote printing, first install a printer on one host, the printer host, using the simple printer setup described in Simple Printer Setup. Do - any advanced setup in Advanced Printer Setup that you need. Make sure to + linkend="printing-simple">Simple Printer Setup. Do + any advanced setup in Advanced Printer Setup that you need. Make sure to test the printer and see if it works with the features of LPD - you have enabled. Also ensure that the local + you have enabled. Also ensure that the local host has authorization to use the LPD service in the remote host (see Restricting Jobs @@ -3979,7 +3979,7 @@ done compatible with LPD, then the printer host in the discussion below is the printer itself, and the printer name is the name you configured for - the printer. See the documentation that accompanied your + the printer. See the documentation that accompanied your printer and/or printer-network interface. Then, on the other hosts you want to have access to the @@ -3988,7 +3988,7 @@ done - Name the entry anything you want. For simplicity, + Name the entry anything you want. For simplicity, though, you probably want to use the same name and aliases as on the printer host. @@ -4000,7 +4000,7 @@ done Make a spooling directory and specify its location in - the sd capability. LPD will + the sd capability. LPD will store jobs here before they get sent to the printer host. @@ -4016,16 +4016,16 @@ done - That is it. You do not need to list conversion + That is it. You do not need to list conversion filters, page dimensions, or anything else in the /etc/printcap file. - Here is an example. The host rose has two printers, - bamboo and rattan. We will enable users on the host - orchid to print to those printers. Here is the + Here is an example. The host rose has two printers, + bamboo and rattan. We will enable users on the host + orchid to print to those printers. Here is the /etc/printcap file for orchid (back from section - Enabling Header Pages). It already had the entry for + Enabling Header Pages). It already had the entry for the printer teak; we have added entries for the two printers on the host rose: @@ -4065,7 +4065,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Now, users on orchid can print to - rattan and bamboo. If, for example, a user on orchid + rattan and bamboo. If, for example, a user on orchid typed @@ -4073,9 +4073,9 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ the LPD system on orchid would copy the job to the spooling directory /var/spool/lpd/bamboo and note that it was - a DVI job. As soon as the host rose has room in its bamboo spooling directory, the two LPDs - would transfer the file to rose. The file would wait in rose's - queue until it was finally printed. It would be converted from + a DVI job. As soon as the host rose has room in its bamboo spooling directory, the two LPDs + would transfer the file to rose. The file would wait in rose's + queue until it was finally printed. It would be converted from DVI to PostScript (since bamboo is a PostScript printer) on rose. @@ -4088,7 +4088,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ you can get two versions: one which emulates a spooler (the more expensive version), or one which just lets you send data to it as if you were using a serial or parallel port (the cheaper - version). This section tells how to use the cheaper version. + version). This section tells how to use the cheaper version. For the more expensive one, see the previous section Printers Installed on Remote Hosts. @@ -4097,18 +4097,18 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ lets you specify what serial or parallel interface to use, and (if you are using a serial interface), what baud rate, whether to use flow control, delays for tabs, conversion of newlines, - and more. But there is no way to specify a connection to a + and more. But there is no way to specify a connection to a printer that is listening on a TCP/IP or other network port. To send data to a networked printer, you need to develop a communications program that can be called by the text and - conversion filters. Here is one such example: the script + conversion filters. Here is one such example: the script netprint takes all data on - standard input and sends it to a network-attached printer. We + standard input and sends it to a network-attached printer. We specify the hostname of the printer as the first argument and the port number to which to connect as the second argument to - netprint. Note that this supports + netprint. Note that this supports one-way communication only (FreeBSD to printer); many network printers support two-way communication, and you might want to take advantage of that (to get printer status, perform @@ -4140,9 +4140,9 @@ while (<STDIN>) { print PRINTER; } exit 0; We can then use this script in various - filters. Suppose we had a Diablo 750-N line printer connected - to the network. The printer accepts data to print on port - number 5100. The host name of the printer is scrivener. Here + filters. Suppose we had a Diablo 750-N line printer connected + to the network. The printer accepts data to print on port + number 5100. The host name of the printer is scrivener. Here is the text filter for the printer: @@ -4169,16 +4169,16 @@ exit 0; Restricting Multiple Copies The LPD system makes it easy for users to print multiple - copies of a file. Users can print jobs with lpr + copies of a file. Users can print jobs with lpr -#5 (for example) and get five copies of each file - in the job. Whether this is a good thing is up to you. + in the job. Whether this is a good thing is up to you. If you feel multiple copies cause unnecessary wear and tear on your printers, you can disable the option to lpr by adding the sc capability to the - /etc/printcap file. When users submit jobs + /etc/printcap file. When users submit jobs with the option, they will see: @@ -4192,8 +4192,8 @@ exit 0; will still be able to submit multiple-copy jobs by using another host. - Here is an example. This is the - /etc/printcap file for the host rose. The + Here is an example. This is the + /etc/printcap file for the host rose. The printer rattan is quite hearty, so we will allow multiple copies, but the laser printer bamboo's a bit more delicate, so we will disable multiple copies by adding the sc capability: @@ -4254,7 +4254,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ You can control who can print to what printers by using the UNIX group mechanism and the rg - capability in /etc/printcap. Just place + capability in /etc/printcap. Just place the users you want to have access to a printer in a certain group, and then name that group in the rg capability. @@ -4275,7 +4275,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ For example, we will let anyone access the printer rattan, but only those in group - artists can use bamboo. Here is the familiar + artists can use bamboo. Here is the familiar /etc/printcap for host rose: @@ -4295,10 +4295,10 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Let us leave the other example /etc/printcap file (for the host orchid) - alone. Of course, anyone on orchid can print to - bamboo. It might be the case that we only + alone. Of course, anyone on orchid can print to + bamboo. It might be the case that we only allow certain logins on orchid anyway, and want them to have - access to the printer. Or not. + access to the printer. Or not. There can be only one restricted group per printer. @@ -4310,14 +4310,14 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ If you have many users accessing the printers, you probably need to put an upper limit on the sizes of the files users can - submit to print. After all, there is only so much free space on + submit to print. After all, there is only so much free space on the filesystem that houses the spooling directories, and you also need to make sure there is room for the jobs of other users. LPD enables you to limit the maximum byte size a file in a job can be with the mx capability. - The units are in BUFSIZ blocks, which are 1024 bytes. If you + The units are in BUFSIZ blocks, which are 1024 bytes. If you put a zero for this capability, there will be no limit on file size. @@ -4327,13 +4327,13 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ LPD will not refuse a file that is larger than the limit you - place on a printer. Instead, it will queue as much of the file - up to the limit, which will then get printed. The rest will be - discarded. Whether this is correct behavior is up for + place on a printer. Instead, it will queue as much of the file + up to the limit, which will then get printed. The rest will be + discarded. Whether this is correct behavior is up for debate. Let us add limits to our example printers - rattan and bamboo. Since those artists' PostScript + rattan and bamboo. Since those artists' PostScript files tend to be large, we will limit them to five megabytes. We will put no limit on the plain text line printer: @@ -4360,10 +4360,10 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ :df=/usr/local/libexec/psdf: Again, the limits apply to the local users - only. If you have set up access to your printers remotely, - remote users will not get those limits. You will need to + only. If you have set up access to your printers remotely, + remote users will not get those limits. You will need to specify the mx capability in the - remote /etc/printcap files as well. See + remote /etc/printcap files as well. See section Printers Installed on Remote Hosts for more information on @@ -4388,13 +4388,13 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ You can control from which remote hosts a local LPD accepts requests with the files /etc/hosts.equiv and - /etc/hosts.lpd. LPD checks to see + /etc/hosts.lpd. LPD checks to see if an incoming request is from a host listed in either - one of these files. If not, LPD refuses the + one of these files. If not, LPD refuses the request. The format of these files is simple: one host name - per line. Note that the file + per line. Note that the file /etc/hosts.equiv is also used by the ruserok3 protocol, and affects programs like @@ -4424,15 +4424,15 @@ madrigal.fishbaum.de You can control how much free space there needs to remain on the filesystem where a spooling directory - resides. Make a file called + resides. Make a file called minfree in the spooling directory - for the local printer. Insert in that file a number + for the local printer. Insert in that file a number representing how many disk blocks (512 bytes) of free space there has to be for a remote job to be accepted. This lets you insure that remote users will not fill - your filesystem. You can also use it to give a certain + your filesystem. You can also use it to give a certain priority to local users: they will be able to queue jobs long after the free disk space has fallen below the amount specified in the minfree @@ -4440,7 +4440,7 @@ madrigal.fishbaum.de For example, let us add a minfree file for the printer - bamboo. We examine + bamboo. We examine /etc/printcap to find the spooling directory for this printer; here is bamboo's entry: @@ -4453,7 +4453,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ :df=/usr/local/libexec/psdf: The spooling directory is the given - in the sd capability. We + in the sd capability. We will make three megabytes (which is 6144 disk blocks) the amount of free disk space that must exist on the filesystem for LPD to accept remote jobs: @@ -4470,18 +4470,18 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ You can control which remote users can print to local printers by specifying the rs capability in - /etc/printcap. When rs appears in the entry for a + /etc/printcap. When rs appears in the entry for a locally-attached printer, LPD will accept jobs from remote hosts if the user submitting the job also has an account of the same login name on - the local host. Otherwise, LPD refuses the job. + the local host. Otherwise, LPD refuses the job. This capability is particularly useful in an environment where there are (for example) different departments sharing a network, and some users transcend - departmental boundaries. By giving them accounts on + departmental boundaries. By giving them accounts on your systems, they can use your printers from their own - departmental systems. If you would rather allow them to + departmental systems. If you would rather allow them to use only your printers and not your compute resources, you can give them “token” accounts, with no home directory and a useless shell like @@ -4498,16 +4498,16 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Accounting for Printer Usage - So, you need to charge for printouts. And why not? Paper - and ink cost money. And then there are maintenance + So, you need to charge for printouts. And why not? Paper + and ink cost money. And then there are maintenance costs—printers are loaded with moving parts and tend to break - down. You have examined your printers, usage patterns, and + down. You have examined your printers, usage patterns, and maintenance fees and have come up with a per-page (or per-foot, - per-meter, or per-whatever) cost. Now, how do you actually start + per-meter, or per-whatever) cost. Now, how do you actually start accounting for printouts? Well, the bad news is the LPD spooling system does not provide - much help in this department. Accounting is highly dependent on + much help in this department. Accounting is highly dependent on the kind of printer in use, the formats being printed, and your requirements in charging for printer usage. @@ -4515,8 +4515,8 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ To implement accounting, you have to modify a printer's text filter (to charge for plain text jobs) and the conversion filters (to charge for other file formats), to count pages or query the - printer for pages printed. You cannot get away with using the - simple output filter, since it cannot do accounting. See section + printer for pages printed. You cannot get away with using the + simple output filter, since it cannot do accounting. See section Filters. @@ -4525,21 +4525,21 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Periodic accounting is the more - common way, possibly because it is easier. Whenever someone + common way, possibly because it is easier. Whenever someone prints a job, the filter logs the user, host, and number of - pages to an accounting file. Every month, semester, year, + pages to an accounting file. Every month, semester, year, or whatever time period you prefer, you collect the accounting files for the various printers, tally up the - pages printed by users, and charge for usage. Then you + pages printed by users, and charge for usage. Then you truncate all the logging files, starting with a clean slate for the next period. Timely accounting is less common, - probably because it is more difficult. This method has the + probably because it is more difficult. This method has the filters charge users for printouts as soon as they use the - printers. Like disk quotas, the accounting is immediate. + printers. Like disk quotas, the accounting is immediate. You can prevent users from printing when their account goes in the red, and might provide a way for users to check and adjust their “print quotas.” But this method requires some @@ -4551,12 +4551,12 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ The LPD spooling system supports both methods easily: since you have to provide the filters (well, most of the time), you also - have to provide the accounting code. But there is a bright side: - you have enormous flexibility in your accounting methods. For + have to provide the accounting code. But there is a bright side: + you have enormous flexibility in your accounting methods. For example, you choose whether to use periodic or timely accounting. You choose what information to log: user names, host names, job types, pages printed, square footage of paper used, how long the - job took to print, and so forth. And you do so by modifying the + job took to print, and so forth. And you do so by modifying the filters to save this information. @@ -4564,7 +4564,7 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ Quick and Dirty Printer Accounting FreeBSD comes with two programs that can get you set up - with simple periodic accounting right away. They are the text + with simple periodic accounting right away. They are the text filter lpf, described in section lpf: a Text Filter, and @@ -4575,17 +4575,17 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ As mentioned in the section on filters (Filters), LPD starts the text and the conversion filters with the name of the - accounting file to use on the filter command line. The filters + accounting file to use on the filter command line. The filters can use this argument to know where to write an accounting file - entry. The name of this file comes from the af capability in + entry. The name of this file comes from the af capability in /etc/printcap, and if not specified as an absolute path, is relative to the spooling directory. LPD starts lpf with page width and length arguments (from the pw - and pl capabilities). lpf uses these arguments to determine how - much paper will be used. After sending the file to the printer, - it then writes an accounting entry in the accounting file. The + and pl capabilities). lpf uses these arguments to determine how + much paper will be used. After sending the file to the printer, + it then writes an accounting entry in the accounting file. The entries look like this: @@ -4598,19 +4598,19 @@ bamboo|ps|PS|S|panasonic|Panasonic KX-P4455 PostScript v51.4:\ You should use a separate accounting file for each printer, as lpf has no file locking logic built into it, and two lpfs might corrupt each other's entries if - they were to write to the same file at the same time. A easy way + they were to write to the same file at the same time. A easy way to insure a separate accounting file for each printer is to use af=acct in - /etc/printcap. Then, each accounting file + /etc/printcap. Then, each accounting file will be in the spooling directory for a printer, in a file named acct. When you are ready to charge users for printouts, run the pac - program. Just change to the spooling directory for the printer + program. Just change to the spooling directory for the printer you want to collect on and type - pac. You + pac. You will get a dollar-centric summary like the following: @@ -4634,7 +4634,7 @@ total 337.00 154 $ 6.74 Which printer to - summarize. This option works only if there is an + summarize. This option works only if there is an absolute path in the af capability in /etc/printcap. @@ -4651,9 +4651,9 @@ total 337.00 154 $ 6.74 - Ignore host name in the accounting files. With this + Ignore host name in the accounting files. With this option, user smith on host alpha is the same user smith - on host gamma. Without, they are different + on host gamma. Without, they are different users. @@ -4664,7 +4664,7 @@ total 337.00 154 $ 6.74 Compute charges with price dollars per page or per foot instead of the price from the pc capability in /etc/printcap, or two cents (the - default). You can specify price as a floating point + default). You can specify price as a floating point number. @@ -4697,7 +4697,7 @@ total 337.00 154 $ 6.74 In the default summary that pac produces, you see the number of pages printed by each user from - various hosts. If, at your site, host does not matter (because + various hosts. If, at your site, host does not matter (because users can use any host), run pac -m, to produce the following summary: @@ -4717,28 +4717,28 @@ total 337.00 154 $ 6.74 pac uses the pc capability in the /etc/printcap file (default of 200, or 2 - cents per page). Specify, in hundredths of cents, the price per + cents per page). Specify, in hundredths of cents, the price per page or per foot you want to charge for printouts in this - capability. You can override this value when you run + capability. You can override this value when you run pac with - the option. The units for the + the option. The units for the option are in dollars, though, not - hundredths of cents. For example, + hundredths of cents. For example, &prompt.root; pac -p1.50 makes each page cost one dollar and fifty - cents. You can really rake in the profits by using this + cents. You can really rake in the profits by using this option. Finally, running pac -s will save the summary information in a summary accounting file, which is named the same as the printer's accounting file, but with - _sum appended to the name. It then truncates - the accounting file. When you run + _sum appended to the name. It then truncates + the accounting file. When you run pac again, it rereads the summary file to get starting totals, then adds information from the regular accounting file. @@ -4749,12 +4749,12 @@ total 337.00 154 $ 6.74 How Can You Count Pages Printed? In order to perform even remotely accurate accounting, you - need to be able to determine how much paper a job uses. This is + need to be able to determine how much paper a job uses. This is the essential problem of printer accounting. For plain text jobs, the problem's not that hard to solve: you count how many lines are in a job and compare it to how many - lines per page your printer supports. Do not forget to take + lines per page your printer supports. Do not forget to take into account backspaces in the file which overprint lines, or long logical lines that wrap onto one or more additional physical lines. @@ -4762,7 +4762,7 @@ total 337.00 154 $ 6.74 The text filter lpf (introduced in lpf: a Text Filter) takes into account these things when it does - accounting. If you are writing a text filter which needs to do + accounting. If you are writing a text filter which needs to do accounting, you might want to examine lpf's source code. How do you handle other file formats, though? @@ -4771,24 +4771,24 @@ total 337.00 154 $ 6.74 you can have your filter parse the diagnostic output of dvilj or - dvips and look to see how many pages were converted. You might be able to do similar things with other file formats and conversion programs. + dvips and look to see how many pages were converted. You might be able to do similar things with other file formats and conversion programs. But these methods suffer from the fact that the printer may - not actually print all those pages. For example, it could jam, + not actually print all those pages. For example, it could jam, run out of toner, or explode—and the user would still get charged. So, what can you do? There is only one sure way to do - accurate accounting. Get a printer that + accurate accounting. Get a printer that can tell you how much paper it uses, and attach it via a serial - line or a network connection. Nearly all PostScript printers - support this notion. Other makes and models do as well - (networked Imagen laser printers, for example). Modify the + line or a network connection. Nearly all PostScript printers + support this notion. Other makes and models do as well + (networked Imagen laser printers, for example). Modify the filters for these printers to get the page usage after they print each job and have them log accounting information based on - that value only. There is no line counting + that value only. There is no line counting nor error-prone file examination required. Of course, you can always be generous and make all printouts @@ -4803,7 +4803,7 @@ total 337.00 154 $ 6.74 If you have been reading straight through this manual, by now you have learned just about everything there is to know about the - LPD spooling system that comes with FreeBSD. You can probably + LPD spooling system that comes with FreeBSD. You can probably appreciate many of its shortcomings, which naturally leads to the question: “What other spooling systems are out there (and work with FreeBSD)?” @@ -4819,7 +4819,7 @@ total 337.00 154 $ 6.74 PLP was based on software developed by Patrick Powell and then maintained by an Internet-wide group of developers. The main site for the software is at ftp://ftp.iona.ie/pub/plp. There is also a web page. + URL="ftp://ftp.iona.ie/pub/plp">ftp://ftp.iona.ie/pub/plp. There is also a web page. It is quite similar to the BSD LPD spooler, but boasts a host of features, including: @@ -4858,9 +4858,9 @@ total 337.00 154 $ 6.74 LPRng, which purportedly means “LPR: the Next - Generation” is a complete rewrite of PLP. Patrick Powell + Generation” is a complete rewrite of PLP. Patrick Powell and Justin Mason (the principal maintainer of PLP) - collaborated to make LPRng. The main site for LPRng is + collaborated to make LPRng. The main site for LPRng is ftp://dickory.sdsu.edu/pub/LPRng. diff --git a/en_US.ISO_8859-1/books/handbook/quotas/chapter.sgml b/en_US.ISO_8859-1/books/handbook/quotas/chapter.sgml index d594296cc4..1aa60cdb11 100644 --- a/en_US.ISO_8859-1/books/handbook/quotas/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/quotas/chapter.sgml @@ -9,7 +9,7 @@ user, or members of a group, may allocate on a per-file system basis. This is used most often on timesharing systems where it is desirable to limit the amount of resources any one user or group of users may - allocate. This will prevent one user from consuming all of the + allocate. This will prevent one user from consuming all of the available disk space. @@ -17,7 +17,7 @@ Configuring Your System to Enable Disk Quotas Before attempting to use disk quotas it is necessary to make - sure that quotas are configured in your kernel. This is done by + sure that quotas are configured in your kernel. This is done by adding the following line to your kernel configuration file: @@ -26,12 +26,12 @@ options QUOTA The stock GENERIC kernel does not have this enabled by default, so you will have to configure, build and install a - custom kernel in order to use disk quotas. Please refer to the + custom kernel in order to use disk quotas. Please refer to the Configuring the FreeBSD Kernel section for more information on kernel configuration. Next you will need to enable disk quotas in - /etc/sysconfig. This is done by changing the + /etc/sysconfig. This is done by changing the line: @@ -50,19 +50,19 @@ quotas=YES check_quotas=YES Finally you will need to edit /etc/fstab to - enable disk quotas on a per-file system basis. This is where you + enable disk quotas on a per-file system basis. This is where you can either enable user or group quotas or both for all of your file systems. To enable per-user quotas on a file system, add the userquota option to the options field in the /etc/fstab entry for the file system you want - to to enable quotas on. For example: + to to enable quotas on. For example: /dev/sd1s2g /home ufs rw,userquota 1 2 Similarly, to enable group quotas, use the - groupquota option instead of the userquota keyword. To enable both user and + groupquota option instead of the userquota keyword. To enable both user and group quotas, change the entry as follows: @@ -71,20 +71,20 @@ check_quotas=YES By default the quota files are stored in the root directory of the file system with the names quota.user and quota.group for user and group quotas - respectively. See man fstab for more - information. Even though that man page says that you can specify an + respectively. See man fstab for more + information. Even though that man page says that you can specify an alternate location for the quota files, this is not recommended since all of the various quota utilities do not seem to handle this properly. At this point you should reboot your system with your new - kernel. /etc/rc will automatically run the + kernel. /etc/rc will automatically run the appropriate commands to create the initial quota files for all of the quotas you enabled in /etc/fstab, so there is no need to manually create any zero length quota files. In the normal course of operations you should not be required to - run the quotacheck, quotaon, or quotaoff commands manually. However, you may + run the quotacheck, quotaon, or quotaoff commands manually. However, you may want to read their man pages just to be familiar with their operation. @@ -94,7 +94,7 @@ check_quotas=YES Setting Quota Limits Once you have configured your system to enable quotas, verify - that they really are enabled. An easy way to do this is to run + that they really are enabled. An easy way to do this is to run &prompt.root; quota -v @@ -109,28 +109,28 @@ check_quotas=YES You have several options on how to enforce limits on the amount of disk space a user or group may allocate, and how many files they - may create. You may limit allocations based on disk space (block + may create. You may limit allocations based on disk space (block quotas) or number of files (inode quotas) or a combination of both. Each of these limits are further broken down into two categories: hard and soft limits. - A hard limit may not be exceeded. Once a user reaches their + A hard limit may not be exceeded. Once a user reaches their hard limit they may not make any further allocations on the file - system in question. For example, if the user has a hard limit of + system in question. For example, if the user has a hard limit of 500 blocks on a file system and is currently using 490 blocks, the - user can only allocate an additional 10 blocks. Attempting to + user can only allocate an additional 10 blocks. Attempting to allocate an additional 11 blocks will fail. Soft limits on the other hand can be exceeded for a limited - amount of time. This period of time is known as the grace period, - which is one week by default. If a user stays over his or her soft + amount of time. This period of time is known as the grace period, + which is one week by default. If a user stays over his or her soft limit longer than their grace period, the soft limit will turn into - a hard limit and no further allocations will be allowed. When the + a hard limit and no further allocations will be allowed. When the user drops back below the soft limit, the grace period will be reset. The following is an example of what you might see when you run - then edquota command. When the + then edquota command. When the edquota command is invoked, you are placed into the editor specified by the EDITOR environment variable, or in the vi @@ -166,10 +166,10 @@ Quotas for user test: quota limits will be in place when you exit the editor. Sometimes it is desirable to set quota limits on a range of - uids. This can be done by use of the option on - the edquota command. First, assign + uids. This can be done by use of the option on + the edquota command. First, assign the desired quota limit to a user, and then run edquota -p - protouser startuid-enduid. For example, if user + protouser startuid-enduid. For example, if user test has the desired quota limits, the following command can be used to duplicate those quota limits for uids 10,000 through 19,999: @@ -179,7 +179,7 @@ Quotas for user test: The ability to specify uid ranges was added to the system after - 2.1 was released. If you need this feature on a 2.1 system, you + 2.1 was released. If you need this feature on a 2.1 system, you will need to obtain a newer copy of edquota. See man edquota for more detailed @@ -192,10 +192,10 @@ Quotas for user test: You can use either the quota or the repquota commands to check quota - limits and disk usage. The quota + limits and disk usage. The quota command can be used to check individual user and group quotas and - disk usage. Only the super-user may examine quotas and usage for - other users, or for groups that they are not a member of. The + disk usage. Only the super-user may examine quotas and usage for + other users, or for groups that they are not a member of. The repquota command can be used to get a summary of all quotas and disk usage for file systems with quotas enabled. @@ -213,12 +213,12 @@ Disk quotas for user test (uid 1002): On the /usr file system in the above example this user is currently 15 blocks over their soft limit of 50 blocks and - has 5 days of their grace period left. Note the asterisk * which + has 5 days of their grace period left. Note the asterisk * which indicates that the user is currently over their quota limit. Normally file systems that the user is not using any disk space on will not show up in the output from the quota command, even if they have a quota limit - assigned for that file system. The option will + assigned for that file system. The option will display those file systems, such as the /usr/var file system in the above example. diff --git a/en_US.ISO_8859-1/books/handbook/security/chapter.sgml b/en_US.ISO_8859-1/books/handbook/security/chapter.sgml index 2bc0726f7a..45fd5953d2 100644 --- a/en_US.ISO_8859-1/books/handbook/security/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/security/chapter.sgml @@ -10,14 +10,14 @@ In order to protect the security of passwords on UN*X systems from being easily exposed, passwords have traditionally been - scrambled in some way. Starting with Bell Labs' Seventh Edition + scrambled in some way. Starting with Bell Labs' Seventh Edition Unix, passwords were encrypted using what the security people call a - “one-way hash function”. That is to say, the password is + “one-way hash function”. That is to say, the password is transformed in such a way that the original password cannot be regained except by brute-force searching the space of possible - passwords. Unfortunately, the only secure method that was available + passwords. Unfortunately, the only secure method that was available to the AT&T researchers at the time was based on DES, the Data - Encryption Standard. This causes only minimal difficulty for + Encryption Standard. This causes only minimal difficulty for commercial vendors, but is a serious problem for an operating system like FreeBSD where all the source code is freely available, because national governments in many places like to place restrictions on @@ -28,23 +28,23 @@ still not running afoul of the law? We decided to take a dual-track approach: we would make distributions which contained only a non-regulated password scrambler, and then provide as a separate - add-on library the DES-based password hash. The password-scrambling + add-on library the DES-based password hash. The password-scrambling function was moved out of the C library to a separate library, called libcrypt because the name of - the C function to implement it is crypt. In FreeBSD 1.x and some pre-release + the C function to implement it is crypt. In FreeBSD 1.x and some pre-release 2.0 snapshots, the non-regulated scrambler uses an insecure function written by Nate Williams; in subsequent releases this was replaced by a mechanism using the RSA Data Security, Inc., MD5 one-way hash - function. Because neither of these functions involve encryption, + function. Because neither of these functions involve encryption, they are believed to be exportable from the US and importable into many other countries. Meanwhile, work was also underway on the DES-based password hash - function. First, a version of the crypt function which was written outside the - US was imported, thus synchronizing the US and non-US code. Then, + function. First, a version of the crypt function which was written outside the + US was imported, thus synchronizing the US and non-US code. Then, the library was modified and split into two; the DES libcrypt contains only the code involved in performing the one-way password hash, and a separate libcipher was created with the entry points - to actually perform encryption. The code was partitioned in this + to actually perform encryption. The code was partitioned in this way to make it easier to get an export license for the compiled library. @@ -54,8 +54,8 @@ mechanism It is fairly easy to recognize whether a particular password - string was created using the DES- or MD5-based hash function. MD5 - password strings always begin with the characters $1$. DES password strings do not + string was created using the DES- or MD5-based hash function. MD5 + password strings always begin with the characters $1$. DES password strings do not have any particular identifying characteristics, but they are shorter than MD5 passwords, and are coded in a 64-character alphabet which does not include the $ character, so a relatively short @@ -63,10 +63,10 @@ password. Determining which library is being used on your system is - fairly easy for most programs, except for those like init which are statically linked. (For + fairly easy for most programs, except for those like init which are statically linked. (For those programs, the only way is to try them on a known password and see if it works.) Programs which use crypt are linked against libcrypt, which for each type of library is - a symbolic link to the appropriate implementation. For example, + a symbolic link to the appropriate implementation. For example, on a system using the DES versions: @@ -94,69 +94,69 @@ lrwxr-xr-x 1 bin bin 15 Sep 5 12:50 libcrypt_p.a -> libdescrypt_p.aS/Key is a one-time password scheme based on a one-way hash function (in our version, this is MD4 for compatibility; other - versions have used MD5 and DES-MAC). S/Key has been a standard part + versions have used MD5 and DES-MAC). S/Key has been a standard part of all FreeBSD distributions since version 1.1.5, and is also - implemented on a large and growing number of other systems. S/Key + implemented on a large and growing number of other systems. S/Key is a registered trademark of Bell Communications Research, Inc. There are three different sorts of passwords which we will talk - about in the discussion below. The first is your usual UNIX-style - or Kerberos password; we will call this a “UNIX password”. The + about in the discussion below. The first is your usual UNIX-style + or Kerberos password; we will call this a “UNIX password”. The second sort is the one-time password which is generated by the S/Key key program and accepted by the keyinit program and the login - prompt; we will call this a “one-time password”. The final sort + prompt; we will call this a “one-time password”. The final sort of password is the secret password which you give to the key program (and sometimes the keyinit program) which it uses to generate one-time passwords; we will call it a “secret password” or just unqualified “password”. The secret password does not necessarily have anything to do with your UNIX password (while they can be the same, this is not - recommended). While UNIX passwords are limited to eight characters + recommended). While UNIX passwords are limited to eight characters in length, your S/Key secret password can be as long as you like; I - use seven-word phrases. In general, the S/Key system operates + use seven-word phrases. In general, the S/Key system operates completely independently of the UNIX password system. There are in addition two other sorts of data involved in the S/Key system; one is called the “seed” or (confusingly) “key”, and consists of two letters and five digits, and the other is the - “iteration count” and is a number between 100 and 1. S/Key + “iteration count” and is a number between 100 and 1. S/Key constructs a one-time password from these components by concatenating the seed and the secret password, then applying a one-way hash (the RSA Data Security, Inc., MD4 secure hash function) iteration-count times, and turning the result into six short English - words. The login and su programs keep track of the last one-time + words. The login and su programs keep track of the last one-time password used, and the user is authenticated if the hash of the - user-provided password is equal to the previous password. Because a + user-provided password is equal to the previous password. Because a one-way hash function is used, it is not possible to generate future one-time passwords having overheard one which was successfully used; the iteration count is decremented after each successful login to - keep the user and login program in sync. (When you get the + keep the user and login program in sync. (When you get the iteration count down to 1, it is time to reinitialize S/Key.) There are four programs involved in the S/Key system which we - will discuss below. The key program + will discuss below. The key program accepts an iteration count, a seed, and a secret password, and - generates a one-time password. The keyinit program is used to initialized S/Key, + generates a one-time password. The keyinit program is used to initialized S/Key, and to change passwords, iteration counts, or seeds; it takes either a secret password, or an iteration count, seed, and one-time - password. The keyinfo program + password. The keyinfo program examines the /etc/skeykeys file and prints out - the invoking user's current iteration count and seed. Finally, the + the invoking user's current iteration count and seed. Finally, the login and su programs contain the necessary logic to - accept S/Key one-time passwords for authentication. The login program is also capable of disallowing + accept S/Key one-time passwords for authentication. The login program is also capable of disallowing the use of UNIX passwords on connections coming from specified addresses. - There are four different sorts of operations we will cover. The + There are four different sorts of operations we will cover. The first is using the keyinit program over a secure connection to set up S/Key for the first time, or to - change your password or seed. The second operation is using the + change your password or seed. The second operation is using the keyinit program over an insecure connection, in conjunction with the key program over a secure connection, to do - the same. The third is using the key program to log in over an insecure - connection. The fourth is using the key program to generate a number of keys + the same. The third is using the key program to log in over an insecure + connection. The fourth is using the key program to generate a number of keys which can be written down or printed out to carry with you when going to some location without secure connections to anywhere (like at a conference). @@ -185,14 +185,14 @@ HAS FONT GOUT FATE BOOM ) - There is a lot of information here. At theEnter secret + There is a lot of information here. At theEnter secret password: prompt, you should enter some password or phrase (I use phrases of minimum seven words) which will be needed to generate - login keys. The line starting `ID' gives the parameters of your + login keys. The line starting `ID' gives the parameters of your particular S/Key instance: your login name, the iteration count, - and seed. When logging in with S/Key, the system will remember + and seed. When logging in with S/Key, the system will remember these parameters and present them back to you so you do not have - to remember them. The last line gives the particular one-time + to remember them. The last line gives the particular one-time password which corresponds to those parameters and your secret password; if you were to re-login immediately, this one-time password is the one you would use. @@ -206,9 +206,9 @@ HAS FONT GOUT FATE BOOM ) insecure connection, you will need to already have a secure connection to some place where you can run the key program; this might be in the form of a desk accessory on a Macintosh, or a shell prompt on a machine you - trust (we will show the latter). You will also need to make up an + trust (we will show the latter). You will also need to make up an iteration count (100 is probably a good value), and you may make - up your own seed or use a randomly-generated one. Over on the + up your own seed or use a randomly-generated one. Over on the insecure connection (to the machine you are initializing), use the keyinit -s command: @@ -224,7 +224,7 @@ s/key 100 kh94742 To accept the default seed (which the keyinit program - confusingly calls a key), press return. Then move over to your + confusingly calls a key), press return. Then move over to your secure connection or S/Key desk accessory, and give it the same parameters: @@ -274,10 +274,10 @@ s/key 92 hi52030 Note that, before prompting for a password, the login program prints out the iteration number and seed which you will need in - order to generate the appropriate key. You will also find a + order to generate the appropriate key. You will also find a useful feature (not shown here): if you press return at the password prompt, the login program will turn echo on, so you can - see what you are typing. This can be extremely useful if you are + see what you are typing. This can be extremely useful if you are attempting to type in an S/Key by hand, such as from a printout. @@ -293,13 +293,13 @@ s/key 92 hi52030 Generating a single one-time password Now, to generate the one-time password needed to answer this - login prompt, we use a trusted machine and the key program. (There are versions of the + login prompt, we use a trusted machine and the key program. (There are versions of the key program from DOS and Windows machines, and there is an S/Key desk accessory for Macintosh computers as well.) The command-line key program takes as its parameters the iteration count and seed; you can cut-and-paste right from the login prompt starting at key to - the end of the line. Thus: + the end of the line. Thus: @@ -324,7 +324,7 @@ Last login: Wed Jun 28 15:31:00 from halloran-eldar.l This is the easiest mechanism if you have - a trusted machine. There is a Java S/Key key applet, key applet, The Java OTP Calculator, that you can download and run locally on any Java supporting brower. @@ -335,10 +335,10 @@ Last login: Wed Jun 28 15:31:00 from halloran-eldar.l Generating multiple one-time passwords Sometimes we have to go places where no trusted machines or - connections are available. In this case, it is possible to use + connections are available. In this case, it is possible to use the key command to generate a number of one-time passwords in the same command; these can then - be printed out. For example: + be printed out. For example: @@ -356,10 +356,10 @@ Reminder - Do not use this program while logged in via telnet or rlogin. The requests twenty-five keys in sequence; the indicates the ending iteration number; and the rest is as - before. Note that these are printed out in - reverse order of eventual use. If you are + before. Note that these are printed out in + reverse order of eventual use. If you are really paranoid, you might want to write the results down by hand; - otherwise you can cut-and-paste into lpr. Note that each line shows both the + otherwise you can cut-and-paste into lpr. Note that each line shows both the iteration count and the one-time password; you may still find it handy to scratch off passwords as you use them. @@ -371,17 +371,17 @@ Reminder - Do not use this program while logged in via telnet or rlogin. The configuration file /etc/skey.access can be used to configure restrictions on the use of UNIX passwords based on the host name, user name, terminal port, or IP address of - a login session. The complete format of the file is documented in + a login session. The complete format of the file is documented in the skey.access5 manual page; there are also some security cautions there which should be read before depending on this file for security. If there is no /etc/skey.access file (which is the default state as FreeBSD is shipped), then all users - will be allowed to use UNIX passwords. If the file exists, + will be allowed to use UNIX passwords. If the file exists, however, then all users will be required to use S/Key unless explicitly permitted to do otherwise by configuration statements - in the skey.access file. In all cases, UNIX + in the skey.access file. In all cases, UNIX passwords are permitted on the console. Here is a sample configuration file which illustrates the @@ -395,7 +395,7 @@ permit port ttyd0 The first line (permit internet) allows users whose IP source address (which is vulnerable to spoofing) matches the specified value and - mask, to use UNIX passwords. This should not be considered a + mask, to use UNIX passwords. This should not be considered a security mechanism, but rather, a means to remind authorized users that they are using an insecure network and need to use S/Key for authentication. @@ -427,7 +427,7 @@ permit port ttyd0 more controllable. The following instructions can be used as a guide on how to set - up Kerberos as distributed for FreeBSD. However, you should refer to + up Kerberos as distributed for FreeBSD. However, you should refer to the relevant manual pages for a complete description. In FreeBSD, the Kerberos is not that from the original @@ -438,7 +438,7 @@ permit port ttyd0 For those needing to get a legal foreign distribution of this software, please do not get it from a USA or - Canada site. You will get that site in big + Canada site. You will get that site in big trouble! A legal copy of this is available from ftp.internat.freebsd.org, which is in South Africa and an official FreeBSD mirror site. @@ -447,8 +447,8 @@ permit port ttyd0 Creating the initial database - This is done on the Kerberos server only. First make sure that - you do not have any old Kerberos databases around. You should + This is done on the Kerberos server only. First make sure that + you do not have any old Kerberos databases around. You should change to the directory /etc/kerberosIV and check that only the following files are present: @@ -468,9 +468,9 @@ README krb.conf krb.realms You should now edit the krb.conf and krb.realms files to define your Kerberos - realm. In this case the realm will be + realm. In this case the realm will be GRONDAR.ZA and the server is - grunt.grondar.za. We edit or create the + grunt.grondar.za. We edit or create the krb.conf file: @@ -487,23 +487,23 @@ TELECOM.MIT.EDU bitsy.mit.edu ARC.NASA.GOV trident.arc.nasa.gov - In this case, the other realms do not need to be there. They + In this case, the other realms do not need to be there. They are here as an example of how a machine may be made aware of - multiple realms. You may wish to not include them for + multiple realms. You may wish to not include them for simplicity. - The first line names the realm in which this system works. The - other lines contain realm/host entries. The first item on a line + The first line names the realm in which this system works. The + other lines contain realm/host entries. The first item on a line is a realm, and the second is a host in that realm that is acting - as a “key distribution centre”. The words admin server + as a “key distribution centre”. The words admin server following a hosts name means that host also provides an - administrative database server. For further explanation of these + administrative database server. For further explanation of these terms, please consult the Kerberos man pages. Now we have to add grunt.grondar.za to the GRONDAR.ZA realm and also add an entry to put all hosts in the .grondar.za domain in - the GRONDAR.ZA realm. The + the GRONDAR.ZA realm. The krb.realms file would be updated as follows: @@ -516,16 +516,16 @@ grunt.grondar.za GRONDAR.ZA .mit.edu ATHENA.MIT.EDU - Again, the other realms do not need to be there. They are here + Again, the other realms do not need to be there. They are here as an example of how a machine may be made aware of multiple - realms. You may wish to remove them to simplify things. + realms. You may wish to remove them to simplify things. The first line puts the specific - system into the named realm. The rest of the lines show how to + system into the named realm. The rest of the lines show how to default systems of a particular subdomain to a named realm. - Now we are ready to create the database. This only needs to - run on the Kerberos server (or Key Distribution Centre). Issue the + Now we are ready to create the database. This only needs to + run on the Kerberos server (or Key Distribution Centre). Issue the kdb_init command to do this: @@ -538,7 +538,7 @@ It is important that you NOT FORGET this password. Now we have to save the key so that servers on the local - machine can pick it up. Use the kstash command to do this. + machine can pick it up. Use the kstash command to do this. &prompt.root; kstash @@ -559,7 +559,7 @@ Master key entered. BEWARE! Making it all run Two principals need to be added to the database for each system that will be secured with - Kerberos. Their names are kpasswd + Kerberos. Their names are kpasswd and rcmd These two principals are made for each system, with the instance being the name of the individual system. @@ -630,11 +630,11 @@ Edit O.K. Creating the server file We now have to extract all the instances which define the - services on each machine. For this we use the - ext_srvtab command. This will create a file which + services on each machine. For this we use the + ext_srvtab command. This will create a file which must be copied or moved by secure means to each Kerberos client's /etc/kerberosIV - directory. This file must be present on each server and client, + directory. This file must be present on each server and client, and is crucial to the operation of Kerberos. @@ -649,7 +649,7 @@ Generating 'grunt-new-srvtab'.... Now, this command only generates a temporary file which must be renamed to srvtab so that all the - server can pick it up. Use the mv + server can pick it up. Use the mv command to move it into place on the original system: @@ -658,7 +658,7 @@ Generating 'grunt-new-srvtab'.... If the file is for a client system, and the network is not deemed safe, then copy the client-new-srvtab to removable media - and transport it by secure physical means. Be sure to rename it to + and transport it by secure physical means. Be sure to rename it to srvtab in the client's /etc/kerberosIV directory, and make sure it is mode 600: @@ -672,8 +672,8 @@ Generating 'grunt-new-srvtab'.... Populating the database - We now have to add some user entries into the database. First - let's create an entry for the user jane. Use + We now have to add some user entries into the database. First + let's create an entry for the user jane. Use the kdb_edit command to do this: @@ -710,10 +710,10 @@ Edit O.K. Testing it all out - First we have to start the Kerberos daemons. NOTE that if you + First we have to start the Kerberos daemons. NOTE that if you have correctly edited your /etc/rc.conf then - this will happen automatically when you reboot. This is only - necessary on the Kerberos server. Kerberos clients will + this will happen automatically when you reboot. This is only + necessary on the Kerberos server. Kerberos clients will automagically get what they need from the /etc/kerberosIV directory. @@ -777,10 +777,10 @@ Password changed. Adding <command>su</command> privileges Kerberos allows us to give each - user who needs root privileges their own separate supassword. We could now add an id which is - authorized to su to root. This is controlled by having an + user who needs root privileges their own separate supassword. We could now add an id which is + authorized to su to root. This is controlled by having an instance of root associated with a - principal. Using kdb_edit we can create the + principal. Using kdb_edit we can create the entry jane.root in the Kerberos database: @@ -855,7 +855,7 @@ May 2 20:43:12 May 3 04:43:12 krbtgt.GRONDAR.ZA@GRONDAR.ZA Using other commands In an earlier example, we created a principal called - jane with an instance root. This was based on a user with the same + jane with an instance root. This was based on a user with the same name as the principal, and this is a Kerberos default; that a <principal>.<instance> of the form <username>.root will allow that @@ -926,7 +926,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Firewalls are an area of increasing interest for people who are connected to the Internet, and are even finding applications on - private networks to provide enhanced security. This section will + private networks to provide enhanced security. This section will hopefully explain what firewalls are, how to use them, and how to use the facilities provided in the FreeBSD kernel to implement them. @@ -937,10 +937,10 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 will solve all your security problems. It may help, but a poorly setup firewall system is more of a - security risk than not having one at all. A firewall can only add + security risk than not having one at all. A firewall can only add another layer of security to your systems, but they will not be able to stop a really determined cracker from penetrating your - internal network. If you let internal security lapse because you + internal network. If you let internal security lapse because you believe your firewall to be impenetrable, you have just made the crackers job that bit easier. @@ -950,10 +950,10 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 What is a firewall? There are currently two distinct types of firewalls in common - use on the Internet today. The first type is more properly called + use on the Internet today. The first type is more properly called a packet filtering router, where the kernel on a multi-homed machine chooses whether to forward or - block packets based on a set of rules. The second type, known as + block packets based on a set of rules. The second type, known as proxy servers, rely on daemons to provide authentication and to forward packets, possibly on a multi-homed machine which has kernel packet forwarding @@ -962,13 +962,13 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Sometimes sites combine the two types of firewalls, so that only a certain machine (known as a bastion host) is allowed to send packets through a packet - filtering router onto an internal network. Proxy services are run + filtering router onto an internal network. Proxy services are run on the bastion host, which are generally more secure than normal authentication mechanisms. FreeBSD comes with a kernel packet filter (known as IPFW), which is what the rest of this section - will concentrate on. Proxy servers can be built on FreeBSD from + will concentrate on. Proxy servers can be built on FreeBSD from third party software, but there is such a variety of proxy servers available that it would be impossible to cover them in this document. @@ -978,22 +978,22 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Packet filtering routers A router is a machine which forwards packets between two or - more networks. A packet filtering router has an extra piece of + more networks. A packet filtering router has an extra piece of code in its kernel, which compares each packet to a list of - rules before deciding if it should be forwarded or not. Most + rules before deciding if it should be forwarded or not. Most modern IP routing software has packet filtering code in it, - which defaults to forwarding all packets. To enable the filters, + which defaults to forwarding all packets. To enable the filters, you need to define a set of rules for the filtering code, so that it can decide if the packet should be allowed to pass or not. To decide if a packet should be passed on or not, the code looks through its set of rules for a rule which matches the - contents of this packets headers. Once a match is found, the - rule action is obeyed. The rule action could be to drop the + contents of this packets headers. Once a match is found, the + rule action is obeyed. The rule action could be to drop the packet, to forward the packet, or even to send an ICMP message - back to the originator. Only the first match counts, as the - rules are searched in order. Hence, the list of rules can be + back to the originator. Only the first match counts, as the + rules are searched in order. Hence, the list of rules can be referred to as a “rule chain”. The packet matching criteria varies depending on the @@ -1012,7 +1012,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 daemons (telnetd, ftpd, etc) replaced with special servers. These servers are called proxy servers as they normally only allow onward - connections to be made. This enables you to run (for example) a + connections to be made. This enables you to run (for example) a proxy telnet server on your firewall host, and people can telnet in to your firewall from the outside, go through some authentication mechanism, and then gain access to the internal @@ -1024,14 +1024,14 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 available, including “one-shot” password systems so that even if someone manages to discover what password you used, they will not be able to use it to gain access to your systems as the - password instantly expires. As they do not actually give users + password instantly expires. As they do not actually give users access to the host machine, it becomes a lot more difficult for someone to install backdoors around your security system. Proxy servers often have ways of restricting access further, so that only certain hosts can gain access to the servers, and often they can be set up so that you can limit which users can - talk to which destination machine. Again, what facilities are + talk to which destination machine. Again, what facilities are available depends largely on what proxy software you choose. @@ -1044,14 +1044,14 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 IPFW, the software supplied with FreeBSD, is a packet filtering and accounting system which resides in the kernel, and has a user-land control utility, - ipfw8. Together, they allow you to define and + ipfw8. Together, they allow you to define and query the rules currently used by the kernel in its routing decisions. There are two related parts to IPFW. The - firewall section allows you to perform packet filtering. There is + firewall section allows you to perform packet filtering. There is also an IP accounting section which allows you to track usage of - your router, based on similar rules to the firewall section. This + your router, based on similar rules to the firewall section. This allows you to see (for example) how much traffic your router is getting from a certain machine, or how much WWW (World Wide Web) traffic it is forwarding. @@ -1059,7 +1059,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 As a result of the way that IPFW is designed, you can use IPFW on non-router machines to perform packet filtering on incoming and outgoing - connections. This is a special case of the more general use of + connections. This is a special case of the more general use of IPFW, and the same commands and techniques should be used in this situation. @@ -1071,7 +1071,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 As the main part of the IPFW system lives in the kernel, you will need to add one or more options to your kernel configuration file, depending on what facilities you want, - and recompile your kernel. See + and recompile your kernel. See reconfiguring the kernel for more details on how to recompile your kernel. @@ -1091,7 +1091,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Enables code to allow logging of packets through - syslogd8. Without this option, even + syslogd8. Without this option, even if you specify that packets should be logged in the filter rules, nothing will happen. @@ -1101,14 +1101,14 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Limits the number of packets logged through - syslogd8 on a per entry basis. You + syslogd8 on a per entry basis. You may wish to use this option in hostile environments in which you want to log firewall activity, but do not want to be open to a denial of service attack via syslog flooding. When a chain entry reaches the packet limit specified, - logging is turned off for that particular entry. To + logging is turned off for that particular entry. To resume logging, you will need to reset the associated counter using the ipfw8 utility: @@ -1125,7 +1125,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Previous versions of FreeBSD contained an - IPFIREWALL_ACCT option. This is now obsolete as + IPFIREWALL_ACCT option. This is now obsolete as the firewall code automatically includes accounting facilities. @@ -1135,17 +1135,17 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Configuring IPFW The configuration of the IPFW software is - done through the ipfw8 utility. The syntax + done through the ipfw8 utility. The syntax for this command looks quite complicated, but it is relatively simple once you understand its structure. There are currently four different command categories used by the utility: addition/deletion, listing, flushing, and clearing. Addition/deletion is used to build the rules that control how - packets are accepted, rejected, and logged. Listing is used to + packets are accepted, rejected, and logged. Listing is used to examine the contents of your rule set (otherwise known as the - chain) and packet counters (accounting). Flushing is used to - remove all entries from the chain. Clearing is used to zero out + chain) and packet counters (accounting). Flushing is used to + remove all entries from the chain. Clearing is used to zero out one or more accounting entries. @@ -1181,7 +1181,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 The command given can be shortened to - the shortest unique form. The valid + the shortest unique form. The valid commands are: @@ -1204,7 +1204,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Previous versions of IPFW used separate - firewall and accounting entries. The present version provides + firewall and accounting entries. The present version provides packet accounting with each firewall entry. If an index value is supplied, @@ -1232,7 +1232,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 allow - Pass the packet on as normal. (aliases: + Pass the packet on as normal. (aliases: pass and accept) @@ -1240,7 +1240,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 deny - Drop the packet. The source is not notified via an + Drop the packet. The source is not notified via an ICMP message (thus it appears that the packet never arrived at the destination). @@ -1250,7 +1250,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Update packet counters but do not allow/deny the - packet based on this rule. The search continues with + packet based on this rule. The search continues with the next chain entry. @@ -1310,9 +1310,9 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 The is optional and may specify the IP address or domain name of a local IP interface, - or an interface name (e.g. ed0) to - match only packets coming through this interface. Interface unit - numbers can be specified with an optional wildcard. For example, + or an interface name (e.g. ed0) to + match only packets coming through this interface. Interface unit + numbers can be specified with an optional wildcard. For example, ppp* would match all kernel PPP interfaces. @@ -1336,11 +1336,11 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 A valid hostname may be specified in place of the IP - address. is a decimal + address. is a decimal number representing how many bits in the address mask should be - set. e.g. specifying 192.216.222.1/24 will create a mask which will allow any + set. e.g. specifying 192.216.222.1/24 will create a mask which will allow any address in a class C subnet (in this case, 192.216.222) to be - matched. is an IP + matched. is an IP address which will be logically AND'ed with the address given. The keyword any may be used to specify “any IP address”. @@ -1354,7 +1354,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 port-port - to specify a range of ports. You may also + to specify a range of ports. You may also combine a single range with a list, but the range must always be specified first. @@ -1388,12 +1388,12 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Matches if the IP header contains the comma separated list of options specified in - spec. The supported list of IP + spec. The supported list of IP options are: ssrr (strict source route), lsrr (loose source route), rr (record packet route), and ts - (timestamp). The absence of a particular option may be + (timestamp). The absence of a particular option may be denoted with a leading !. @@ -1403,7 +1403,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Matches if the packet is part of an already established TCP connection (i.e. it has the RST or ACK - bits set). You can optimize the performance of the + bits set). You can optimize the performance of the firewall by placing established rules early in the chain. @@ -1422,11 +1422,11 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Matches if the TCP header contains the comma - separated list of flags. The + separated list of flags. The supported flags are fin, syn, rst, psh, ack, and - urg. The absence of a particular + urg. The absence of a particular flag may be indicated by a leading !. @@ -1435,9 +1435,9 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Matches if the ICMP type is present in the list - types. The list may be specified + types. The list may be specified as any combination of ranges and/or individual types - separated by commas. Commonly used ICMP types are: + separated by commas. Commonly used ICMP types are: 0 echo reply (ping reply), 3 destination unreachable, 5 redirect, 8 echo request (ping request), and @@ -1470,7 +1470,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 -a - While listing, show counter values. This option is + While listing, show counter values. This option is the only way to see accounting counters. @@ -1507,7 +1507,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 This causes all entries in the firewall chain to be removed except the fixed default policy enforced by the kernel (index - 65535). Use caution when flushing rules, the default deny + 65535). Use caution when flushing rules, the default deny policy will leave your system cut off from the network until allow entries are added to the chain. @@ -1524,7 +1524,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 When used without an index argument, - all packet counters are cleared. If an + all packet counters are cleared. If an index is supplied, the clearing operation only affects a specific chain entry. @@ -1582,7 +1582,7 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Building a packet filtering firewall - The following suggestions are just that: suggestions. The + The following suggestions are just that: suggestions. The requirements of each firewall are different and I cannot tell you how to build a firewall to meet your particular requirements. @@ -1591,9 +1591,9 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 When initially setting up your firewall, unless you have a test bench setup where you can configure your firewall host in a controlled environment, I strongly recommend you use the logging - version of the commands and enable logging in the kernel. This + version of the commands and enable logging in the kernel. This will allow you to quickly identify problem areas and cure them - without too much disruption. Even after the initial setup phase is + without too much disruption. Even after the initial setup phase is complete, I recommend using the logging for of `deny' as it allows tracing of possible attacks and also modification of the firewall rules if your requirements alter. @@ -1603,25 +1603,25 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 large amounts of log data as one log line will be generated for every packet that passes through the firewall, so large ftp/http transfers, etc, will really slow the - system down. It also increases the latencies on those packets as + system down. It also increases the latencies on those packets as it requires more work to be done by the kernel before the packet - can be passed on. syslogd with also start using up a lot more + can be passed on. syslogd with also start using up a lot more processor time as it logs all the extra data to disk, and it could quite easily fill the partition /var/log is located on. As currently supplied, FreeBSD does not have the ability to - load firewall rules at boot time. My suggestion is to put a call + load firewall rules at boot time. My suggestion is to put a call to a shell script in the /etc/netstart - script. Put the call early enough in the netstart file so that the + script. Put the call early enough in the netstart file so that the firewall is configured before any of the IP interfaces are - configured. This means that there is no window during which time + configured. This means that there is no window during which time your network is open. The actual script used to load the rules is entirely up to - you. There is currently no support in the ipfw utility for loading multiple rules in - the one command. The system I use is to use the command: + you. There is currently no support in the ipfw utility for loading multiple rules in + the one command. The system I use is to use the command: &prompt.root; ipfw list @@ -1629,8 +1629,8 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 to write a list of the current rules out to a file, and then use a text editor to prepend ipfw - before all the lines. This will allow the script to - be fed into /bin/sh and reload the rules into the kernel. Perhaps + before all the lines. This will allow the script to + be fed into /bin/sh and reload the rules into the kernel. Perhaps not the most efficient way, but it works. The next problem is what your firewall should actually @@ -1650,33 +1650,33 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 Block all incoming UDP - traffic. There are very few useful services that travel over + traffic. There are very few useful services that travel over UDP, and what useful traffic there is is normally a security - threat (e.g. Suns RPC and NFS protocols). This has its + threat (e.g. Suns RPC and NFS protocols). This has its disadvantages also, since UDP is a connectionless protocol, denying incoming UDP traffic also blocks the replies to - outgoing UDP traffic. This can cause a problem for people + outgoing UDP traffic. This can cause a problem for people (on the inside) using external archie (prospero) servers. If you want to allow access to archie, you'll have to allow packets coming from ports 191 and 1525 to any internal UDP - port through the firewall. ntp is another service you may + port through the firewall. ntp is another service you may consider allowing through, which comes from port 123. - Block traffic to port 6000 from the outside. Port 6000 + Block traffic to port 6000 from the outside. Port 6000 is the port used for access to X11 servers, and can be a security threat (especially if people are in the habit of doing xhost + on their - workstations). X11 can actually use a range of ports + workstations). X11 can actually use a range of ports starting at 6000, the upper limit being how many X displays - you can run on the machine. The upper limit as defined by + you can run on the machine. The upper limit as defined by RFC 1700 (Assigned Numbers) is 6063. Check what ports any internal servers use (e.g. SQL - servers, etc). It is probably a good idea to block those as + servers, etc). It is probably a good idea to block those as well, as they normally fall outside the 1-1024 range specified above. @@ -1689,8 +1689,8 @@ FreeBSD BUILT-19950429 (GR386) #0: Sat Apr 29 17:50:09 SAT 1995 URL="ftp://ftp.cert.org/pub/tech_tips/packet_filtering">ftp://ftp.cert.org/pub/tech_tips/packet_filtering As I said above, these are only - guidelines. You will have to decide what - filter rules you want to use on your firewall yourself. I cannot + guidelines. You will have to decide what + filter rules you want to use on your firewall yourself. I cannot accept ANY responsibility if someone breaks into your network, even if you follow the advice given above. diff --git a/en_US.ISO_8859-1/books/handbook/serialcomms/chapter.sgml b/en_US.ISO_8859-1/books/handbook/serialcomms/chapter.sgml index d6b6a4415c..e6b2d5de47 100644 --- a/en_US.ISO_8859-1/books/handbook/serialcomms/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/serialcomms/chapter.sgml @@ -8,13 +8,13 @@ Assembled from FAQ. This section should give you some general information about - serial ports. If you do not find what you want here, check into the + serial ports. If you do not find what you want here, check into the Terminal and Dialup sections of the handbook. The ttydX (or cuaaX) device is the regular device you will want to open for your - applications. When a process opens the device, it will have a - default set of terminal I/O settings. You can see these settings + applications. When a process opens the device, it will have a + default set of terminal I/O settings. You can see these settings with the command @@ -22,8 +22,8 @@ When you change the settings to this device, the settings are in - effect until the device is closed. When it is reopened, it goes - back to the default set. To make changes to the default set, you + effect until the device is closed. When it is reopened, it goes + back to the default set. To make changes to the default set, you can open and adjust the settings of the “initial state” device. For example, to turn on CLOCAL mode, 8 bits, and XON/XOFF flow control by default for ttyd5, do: @@ -33,12 +33,12 @@ A good place to do this is in - /etc/rc.serial. Now, an application will have + /etc/rc.serial. Now, an application will have these settings by default when it opens ttyd5. It can still change these settings to its liking, though. You can also prevent certain settings from being changed by an - application by making adjustments to the “lock state” device. For + application by making adjustments to the “lock state” device. For example, to lock the speed of ttyd5 to 57600 bps, do @@ -51,7 +51,7 @@ bps. Naturally, you should make the initial state and lock state - devices writable only by root. The + devices writable only by root. The MAKEDEV script does not do this when it creates the device entries. @@ -65,31 +65,31 @@ Terminals provide a convenient and low-cost way to access the power of your FreeBSD system when you are not at the computer's - console or on a connected network. This section describes how to + console or on a connected network. This section describes how to use terminals with FreeBSD. Uses and Types of Terminals - The original Unix systems did not have consoles. Instead, + The original Unix systems did not have consoles. Instead, people logged in and ran programs through terminals that were - connected to the computer's serial ports. It is quite similar to + connected to the computer's serial ports. It is quite similar to using a modem and some terminal software to dial into a remote system to do text-only work. Today's PCs have consoles capable of high quality graphics, but the ability to establish a login session on a serial port still exists in nearly every Unix-style operating system today; - FreeBSD is no exception. By using a terminal attached to a unused + FreeBSD is no exception. By using a terminal attached to a unused serial port, you can log in and run any text program that you would normally run on the console or in an xterm window in the X Window System. For the business user, you can attach many terminals to a - FreeBSD system and place them on your employees' desktops. For a + FreeBSD system and place them on your employees' desktops. For a home user, a spare computer such as an older IBM PC or a Macintosh can be a terminal wired into a more powerful computer running - FreeBSD. You can turn what might otherwise be a single-user + FreeBSD. You can turn what might otherwise be a single-user computer into a powerful multiple user system. For FreeBSD, there are three kinds of terminals: @@ -120,16 +120,16 @@ Dumb Terminals Dumb terminals are specialized pieces of hardware that let - you connect to computers over serial lines. They are called + you connect to computers over serial lines. They are called “dumb” because they have only enough computational power to - display, send, and receive text. You cannot run any programs on - them. It is the computer to which you connect them that has all + display, send, and receive text. You cannot run any programs on + them. It is the computer to which you connect them that has all the power to run text editors, compilers, email, games, and so forth. There are hundreds of kinds of dumb terminals made by many manufacturers, including Digital Equipment Corporation's VT-100 - and Wyse's WY-75. Just about any kind will work with FreeBSD. + and Wyse's WY-75. Just about any kind will work with FreeBSD. Some high-end terminals can even display graphics, but only certain software packages can take advantage of these advanced features. @@ -149,7 +149,7 @@ All you need is the proper cable and some terminal emulation software to run on the computer. - Such a configuration is popular in homes. For example, if + Such a configuration is popular in homes. For example, if your spouse is busy working on your FreeBSD system's console, you can do some text-only work at the same time from a less powerful personal computer hooked up as a terminal to the @@ -161,8 +161,8 @@ X Terminals X terminals are the most sophisticated kind of terminal - available. Instead of connecting to a serial port, they usually - connect to a network like Ethernet. Instead of being relegated + available. Instead of connecting to a serial port, they usually + connect to a network like Ethernet. Instead of being relegated to text-only applications, they can display any X application. @@ -177,8 +177,8 @@ Cables and Ports To connect a terminal to your FreeBSD system, you need the - right kind of cable and a serial port to which to connect it. This - section tells you what to do. If you are already familiar with + right kind of cable and a serial port to which to connect it. This + section tells you what to do. If you are already familiar with your terminal and the cable it requires, skip to Configuration. @@ -190,7 +190,7 @@ serial—also known as RS-232C—cables to connect the terminal to the FreeBSD system. - There are a couple of kinds of serial cables. Which one + There are a couple of kinds of serial cables. Which one you'll use depends on the terminal you want to connect: @@ -198,15 +198,15 @@ If you are connecting a personal computer to act as a - terminal, use a null-modem cable. A null-modem cable connects + terminal, use a null-modem cable. A null-modem cable connects two computers or terminals together. If you have an actual terminal, your best source of information on what cable to use is the documentation that - accompanied the terminal. If you do not have the - documentation, then try a null-modem cable. If that does not work, then + accompanied the terminal. If you do not have the + documentation, then try a null-modem cable. If that does not work, then try a standard cable. @@ -223,13 +223,13 @@ Null-modem cables A null-modem cable passes some signals straight through, - like “signal ground,” but switches other signals. For + like “signal ground,” but switches other signals. For example, the “send data” pin on one end goes to the “receive data” pin on the other end. If you like making your own cables, here is a table showing a recommended way to construct a null-modem cable for - use with terminals. This table shows the RS-232C signal names + use with terminals. This table shows the RS-232C signal names and the pin numbers on a DB-25 connector. @@ -324,7 +324,7 @@ Standard RS-232C Cables A standard serial cable passes all the RS-232C signals - straight-through. That is, the “send data” pin on one end + straight-through. That is, the “send data” pin on one end of the cable goes to the “send data” pin on the other end. This is the type of cable to connect a modem to your FreeBSD system, and the type of cable needed for some @@ -345,17 +345,17 @@ Kinds of Ports - Several kinds of serial ports exist. Before you purchase + Several kinds of serial ports exist. Before you purchase or construct a cable, you need to make sure it will fit the ports on your terminal and on the FreeBSD system. - Most terminals will have DB25 ports. Personal computers, + Most terminals will have DB25 ports. Personal computers, including PCs running FreeBSD, will have DB25 or DB9 ports. If you have a multiport serial card for your PC, you may have RJ-12 or RJ-45 ports. See the documentation that accompanied the hardware for - specifications on the kind of port in use. A visual + specifications on the kind of port in use. A visual inspection of the port often works, too. @@ -364,19 +364,19 @@ Port Names In FreeBSD, you access each serial port through an entry - in the /dev directory. There are two + in the /dev directory. There are two different kinds of entries: Callin ports are named - /dev/ttydX where X is the port number, starting from zero. Generally, you use the callin port for terminals. Callin ports require that the serial line assert the data carrier detect (DCD) signal to work. + /dev/ttydX where X is the port number, starting from zero. Generally, you use the callin port for terminals. Callin ports require that the serial line assert the data carrier detect (DCD) signal to work. Callout ports are named - /dev/cuaaX. You usually do not use the callout port for terminals, just for modems. You may use the callout port if the serial cable or the terminal does not support the carrier detect signal. + /dev/cuaaX. You usually do not use the callout port for terminals, just for modems. You may use the callout port if the serial cable or the terminal does not support the carrier detect signal. @@ -385,13 +385,13 @@ If you have connected a terminal to the first serial port (COM1 in DOS parlance), then you want to use - /dev/ttyd0 to refer to the terminal. If + /dev/ttyd0 to refer to the terminal. If it is on the second serial port (also known as COM2), it is /dev/ttyd1, and so forth. Note that you may have to configure your kernel to support each serial port, especially if you have a multiport serial - card. See Configuring the FreeBSD Kernel for more + card. See Configuring the FreeBSD Kernel for more information. @@ -402,7 +402,7 @@ Configuration This section describes what you need to configure on your - FreeBSD system to enable a login session on a terminal. It + FreeBSD system to enable a login session on a terminal. It assumes you have already configured your kernel to support the serial port to which the terminal is connected—and that you have connected it. @@ -412,8 +412,8 @@ reading a login name and starting the login program. To do so, you have to edit the /etc/ttys - file. First, use the su command to - become root. Then, make the following changes to + file. First, use the su command to + become root. Then, make the following changes to /etc/ttys: @@ -449,16 +449,16 @@ As an optional step, you may wish to create a custom getty type for use in step 2 by making an - entry in /etc/gettytab. This document does + entry in /etc/gettytab. This document does not explain how to do so; you are encouraged to see the gettytab5 and the getty8 manual pages for more information. - The remaining sections detail how to do these steps. We will + The remaining sections detail how to do these steps. We will use a running example throughout these sections to illustrate what - we need to do. In our example, we will connect two terminals to + we need to do. In our example, we will connect two terminals to the system: a Wyse-50 and a old 286 IBM PC running Procomm - terminal software emulating a VT-100 terminal. We connect the Wyse + terminal software emulating a VT-100 terminal. We connect the Wyse to the second serial port and the 286 to the sixth serial port (a port on a multiport serial card). @@ -474,24 +474,24 @@ there. The /etc/ttys file lists all of the - ports on your FreeBSD system where you want to allow logins. For + ports on your FreeBSD system where you want to allow logins. For example, the first virtual console ttyv0 - has an entry in this file. You can log in on the console using - this entry. This file contains entries for the other virtual - consoles, serial ports, and pseudo-ttys. For a hardwired + has an entry in this file. You can log in on the console using + this entry. This file contains entries for the other virtual + consoles, serial ports, and pseudo-ttys. For a hardwired terminal, just list the serial port's /dev entry without the /dev part. When you installed your FreeBSD system, the /etc/ttys file included entries for the first four serial ports: ttyd0 through - ttyd3. If you are attaching a terminal on + ttyd3. If you are attaching a terminal on one of those ports, you do not need to add an entry. In our example, we attached a Wyse-50 to the second serial port, ttyd1, which is already in - the file. We need to add an entry for the 286 PC connected to - the sixth serial port. Here is an excerpt of the + the file. We need to add an entry for the 286 PC connected to + the sixth serial port. Here is an excerpt of the /etc/ttys file after we add the new entry: @@ -505,8 +505,8 @@ ttyd5 Type Next, we need to specify what program will be run to handle - the logins on a terminal. For FreeBSD, the standard program to - do that is /usr/libexec/getty. It is what + the logins on a terminal. For FreeBSD, the standard program to + do that is /usr/libexec/getty. It is what provides the login: prompt. The program getty takes one @@ -519,10 +519,10 @@ ttyd5 /etc/gettytab. The file /etc/gettytab contains lots of - entries for terminal lines both old and new. In almost all + entries for terminal lines both old and new. In almost all cases, the entries that start with the text std will work for hardwired terminals. - These entries ignore parity. There is a std entry for each bps rate from 110 to - 115200. Of course, you can add your own entries to this file. + These entries ignore parity. There is a std entry for each bps rate from 110 to + 115200. Of course, you can add your own entries to this file. The manual page gettytab5 provides more information. When setting the getty type in @@ -530,7 +530,7 @@ ttyd5 communications settings on the terminal match. For our example, the Wyse-50 uses no parity and connects at - 38400 bps. The 286 PC uses no parity and connects at 19200 bps. + 38400 bps. The 286 PC uses no parity and connects at 19200 bps. Here is the /etc/ttys file so far (showing just the two terminals in which we are interested): @@ -539,7 +539,7 @@ ttyd1 "/usr/libexec/getty std.38400" unknown off secure ttyd5 "/usr/libexec/getty std.19200" Note that the second field—where we specify - what program to run—appears in quotes. This is important, + what program to run—appears in quotes. This is important, otherwise the type argument to getty might be interpreted as the next field. @@ -549,7 +549,7 @@ ttyd5 "/usr/libexec/getty std.19200" Specifying the Default Terminal Type The third field in the /etc/ttys file - lists the default terminal type for the port. For dialup ports, + lists the default terminal type for the port. For dialup ports, you typically put unknown or dialup in this field because users may dial up with practically any kind of terminal or software. @@ -559,19 +559,19 @@ ttyd5 "/usr/libexec/getty std.19200" Users will usually use the tset program in their .login or .profile files to check the terminal type and prompt for one if - necessary. By setting a terminal type in the + necessary. By setting a terminal type in the /etc/ttys file, users can forego such prompting. To find out what terminal types FreeBSD supports, see the - file /usr/share/misc/termcap. It lists - about 600 terminal types. You can add more if you wish. See + file /usr/share/misc/termcap. It lists + about 600 terminal types. You can add more if you wish. See the termcap5 manual page for information. In our example, the Wyse-50 is a Wyse-50 type of terminal (although it can emulate others, we will leave it in Wyse-50 - mode). The 286 PC is running Procomm which will be set to - emulate a VT-100. Here are the pertinent yet unfinished entries + mode). The 286 PC is running Procomm which will be set to + emulate a VT-100. Here are the pertinent yet unfinished entries from the /etc/ttys file: @@ -584,15 +584,15 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 Enabling the Port The next field in /etc/ttys, the fourth - field, tells whether to enable the port. Putting on here will have the init process start the program in the + field, tells whether to enable the port. Putting on here will have the init process start the program in the second field, getty, which will - prompt for a login. If you put off in the fourth field, there will be no + prompt for a login. If you put off in the fourth field, there will be no getty, and hence no logins on the port. So, naturally, you want an on - in this field. Here again is the /etc/ttys - file. We have turned each port on. + in this field. Here again is the /etc/ttys + file. We have turned each port on. ttyd1 "/usr/libexec/getty std.38400" wy50 on secure @@ -605,21 +605,21 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on We have arrived at the last field (well, almost: there is an optional window specifier, but we - will ignore that). The last field tells whether the port is + will ignore that). The last field tells whether the port is secure. What does “secure” mean? It means that the root account (or any account with a user - ID of 0) may login on the port. Insecure ports do not allow + ID of 0) may login on the port. Insecure ports do not allow root to login. How do you use secure and insecure ports? By marking a port as insecure, the terminal to which it is - connected will not allow root to login. People who know the + connected will not allow root to login. People who know the root password to your FreeBSD system will first have to login - using a regular user account. To gain superuser privileges, + using a regular user account. To gain superuser privileges, they will then have to use the su command. @@ -629,14 +629,14 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on system log (and logins are also recorded in the wtmp file). By marking a port as secure, the terminal will allow root - in. People who know the root password will just login as root. + in. People who know the root password will just login as root. You will not have the potentially useful login and su command records. Which should you use? Just use “insecure.” Use “insecure” even for terminals not - in public user areas or behind locked doors. It is quite easy + in public user areas or behind locked doors. It is quite easy to login and use su if you need superuser privileges. @@ -659,7 +659,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroom After you edit /etc/ttys, you do not - want to have to reboot your system to get init to see the changes. So, init will reread + want to have to reboot your system to get init to see the changes. So, init will reread /etc/ttys if it receives a SIGHUP (hangup) signal. @@ -683,7 +683,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomDebugging your connection Even with the most meticulous attention to detail, something - could still go wrong while setting up a terminal. Here is a list + could still go wrong while setting up a terminal. Here is a list of symptoms and some suggested fixes. @@ -696,22 +696,22 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroom Make sure the cable is connected firmly to both the - terminal and the FreeBSD computer. Make sure it is the + terminal and the FreeBSD computer. Make sure it is the right kind of cable. Make sure the terminal and FreeBSD agree on the bps - rate and parity settings. If you have a video display + rate and parity settings. If you have a video display terminal, make sure the contrast and brightness controls - are turned up. If it is a printing terminal, make sure + are turned up. If it is a printing terminal, make sure paper and ink are in good supply. Make sure that a getty - process is running and serving the terminal. Type + process is running and serving the terminal. Type &prompt.root; ps -axww|grep getty - to get a list of running getty processes. You should see an - entry for the terminal. For example, the display + to get a list of running getty processes. You should see an + entry for the terminal. For example, the display 22189 d1 Is+ 0:00.03 /usr/libexec/getty std.38400 ttyd1 @@ -722,7 +722,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomIf no getty process is running, make sure you have enabled the port in - /etc/ttys. Make sure you have run + /etc/ttys. Make sure you have run kill -HUP 1. @@ -732,9 +732,9 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroom Make sure the terminal and FreeBSD agree on the bps - rate and parity settings. Check the getty processes to + rate and parity settings. Check the getty processes to make sure the correct getty - type is in use. If not, edit + type is in use. If not, edit /etc/ttys and run kill -HUP 1. @@ -761,7 +761,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomContributed by &a.ghelmer;. This document provides suggestions for configuring a FreeBSD - system to handle dialup modems. This document is written based on + system to handle dialup modems. This document is written based on the author's experience with FreeBSD versions 1.0, 1.1, and 1.1.5.1 (and experience with dialup modems on other UNIX-like operating systems); however, this document may not answer all of your @@ -774,9 +774,9 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomPrerequisites To begin with, the author assumes you have some basic - knowledge of FreeBSD. You need to have FreeBSD installed, know + knowledge of FreeBSD. You need to have FreeBSD installed, know how to edit files in a UNIX-like environment, and how to look up - manual pages on the system. As discussed below, you will need + manual pages on the system. As discussed below, you will need certain versions of FreeBSD, and knowledge of some terminology & modem and cabling. @@ -785,9 +785,9 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomFreeBSD Version First, it is assumed that you are using FreeBSD version 1.1 - or higher (including versions 2.x). FreeBSD version 1.0 + or higher (including versions 2.x). FreeBSD version 1.0 included two different serial drivers, which complicates the - situation. Also, the serial device driver (sio) has improved in every release of + situation. Also, the serial device driver (sio) has improved in every release of FreeBSD, so more recent versions of FreeBSD are assumed to have better and more efficient drivers than earlier versions. @@ -838,7 +838,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroom When talking about communications data rates, the author - does not use the term “baud”. Baud + does not use the term “baud”. Baud refers to the number of electrical state transitions that may be made in a period of time, while “bps” (bits per second) is the “correct” term to use (at least it does not seem to bother the curmudgeons @@ -853,12 +853,12 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroom Internal modems usually lack non-volatile RAM, so their - configuration may be limited only to setting DIP switches. If + configuration may be limited only to setting DIP switches. If your internal modem has any signal indicator lights, it is probably difficult to view the lights when the system's cover is in place. @@ -894,7 +894,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomThe first, connecting your modem, is usually simple — most - straight-through serial cables work without any problems. You + straight-through serial cables work without any problems. You need to have a cable with appropriate connectors (DB-25 or DB-9, male or female) on each end, and the cable must be a DCE-to-DTE cable with these signals wired: @@ -942,12 +942,12 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomCD signal to detect when a call has been answered or the line has been hung up, and the DTR signal to reset the modem after a session - is complete. Some cables are wired without all of the needed + is complete. Some cables are wired without all of the needed signals, so if you have problems, such as a login session not going away when the line hangs up, you may have a problem with your cable. - The second prerequisite depends on the modem(s) you use. If + The second prerequisite depends on the modem(s) you use. If you do not know your modem's command set by heart, you will need to have the modem's reference book or user's guide handy. Sample commands for USR Sportster 14,400 external modems will be @@ -955,12 +955,12 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroom Lastly, you will need to know how to setup your modem so - that it will work well with FreeBSD. Like other UNIX-like + that it will work well with FreeBSD. Like other UNIX-like operating systems, FreeBSD uses the hardware signals to find out when a call has been answered or a line has been hung up and to - hangup and reset the modem after a call. FreeBSD avoids sending + hangup and reset the modem after a call. FreeBSD avoids sending commands to the modem or watching for status reports from the - modem. If you are familiar with connecting modems to PC-based + modem. If you are familiar with connecting modems to PC-based bulletin board systems, this may seem awkward. @@ -970,11 +970,11 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomFreeBSD supports NS8250-, NS16450-, NS16550-, and NS16550A-based EIA RS-232C (CCITT V.24) communications - interfaces. The 8250 and 16450 devices have single-character - buffers. The 16550 device provides a 16-character buffer, which - allows for better system performance. (Bugs in plain 16550's + interfaces. The 8250 and 16450 devices have single-character + buffers. The 16550 device provides a 16-character buffer, which + allows for better system performance. (Bugs in plain 16550's prevent the use of the 16-character buffer, so use 16550A's if - possible). Because single-character-buffer devices require more + possible). Because single-character-buffer devices require more work by the operating system than the 16-character-buffer devices, 16550A-based serial interface cards are much prefered. If the system has many active serial ports or will have a heavy @@ -988,10 +988,10 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomQuick Overview Here is the process that FreeBSD follows to accept dialup - logins. A getty process, spawned by + logins. A getty process, spawned by init, patiently waits to open the assigned serial port (/dev/ttyd0, for our - example). The command ps ax might + example). The command ps ax might show this: @@ -1000,11 +1000,11 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomWhen a user dials the modem's line and the modems connect, the - CD line is asserted by the modem. The kernel + CD line is asserted by the modem. The kernel notices that carrier has been detected and completes getty's open of the - port. getty sends a login: prompt at the specified initial line - speed. getty watches to see if + port. getty sends a login: prompt at the specified initial line + speed. getty watches to see if legitimate characters are received, and, in a typical configuration, if it finds junk (probably due to the modem's connection speed being different than getty's speed), getty tries adjusting the line speeds until @@ -1012,7 +1012,7 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomWe hope getty finds the correct speed and the user sees a login: - prompt. After the user enters his/her login name, getty executes + prompt. After the user enters his/her login name, getty executes /usr/bin/login, which completes the login by asking for the user's password and then starting the user's shell. @@ -1030,14 +1030,14 @@ ttyd5 "/usr/libexec/getty std.19200" vt100 on insecure # Guest bathroomCOM3:, and COM4:. FreeBSD can presently also handle “dumb” multiport serial interface cards, such as the Boca Board 1008 and 2016 (please see the manual page sio4 for kernel configuration information - if you have a multiport serial card). The default kernel only + if you have a multiport serial card). The default kernel only looks for the standard COM ports, though. To see if your kernel recognizes any of your serial ports, watch for messages while the kernel is booting, or use the /sbin/dmesg command to replay the - kernel's boot messages. In particular, look for messages that - start with the characters sio. Hint: + kernel's boot messages. In particular, look for messages that + start with the characters sio. Hint: to view just the messages that have the word sio, use the command: @@ -1069,16 +1069,16 @@ sio3: type 16550A in /usr/src/share/doc/smm] and “FreeBSD Configuration Options” [in /sys/conf/options and in - /sys/arch/conf/options.arch, with arch for example being i386] for more information on configuring and building kernels. You may have to unpack the kernel source distribution if have not installed the system sources already (srcdist/srcsys.?? in FreeBSD 1.1, srcdist/sys.?? in FreeBSD 1.1.5.1, or the entire source distribution in FreeBSD 2.0) to be able to configure and build kernels. + /sys/arch/conf/options.arch, with arch for example being i386] for more information on configuring and building kernels. You may have to unpack the kernel source distribution if have not installed the system sources already (srcdist/srcsys.?? in FreeBSD 1.1, srcdist/sys.?? in FreeBSD 1.1.5.1, or the entire source distribution in FreeBSD 2.0) to be able to configure and build kernels. Create a kernel configuration file for your system (if you have not already) by cding to - /sys/i386/conf. Then, if you are creating a + /sys/i386/conf. Then, if you are creating a new custom configuration file, copy the file GENERICAH (or GENERICBT, if you have a BusTek SCSI controller on FreeBSD 1.x) to YOURSYS, where YOURSYS - is the name of your system, but in upper-case letters. Edit the + is the name of your system, but in upper-case letters. Edit the file, and change the device lines: @@ -1088,9 +1088,9 @@ device sio2 at isa? port "IO_COM3" tty irq 5 vector siointr device sio3 at isa? port "IO_COM4" tty irq 9 vector siointr You can comment-out or completely remove lines for devices you - do not have. If you have a multiport serial board, such as the + do not have. If you have a multiport serial board, such as the Boca Board BB2016, please see the sio4 man page for complete information on - how to write configuration lines for multiport boards. Be careful + how to write configuration lines for multiport boards. Be careful if you are using a configuration file that was previously used for a different version of FreeBSD because the device flags have changed between versions. @@ -1103,7 +1103,7 @@ device sio3 at isa? port "IO_COM4" tty irq 9 vector siointr IO_COM4 is 0x2e8, which are fairly common port addresses for their respective serial ports; interrupts 4, 3, 5, and 9 are fairly common interrupt request - lines. Also note that regular serial ports cannot share interrupts on ISA-bus PCs + lines. Also note that regular serial ports cannot share interrupts on ISA-bus PCs (multiport boards have on-board electronics that allow all the 16550A's on the board to share one or two interrupt request lines). @@ -1123,18 +1123,18 @@ device sio3 at isa? port "IO_COM4" tty irq 9 vector siointr Most devices in the kernel are accessed through “device special files”, which are located in the - /dev directory. The sio devices are accessed through the + /dev directory. The sio devices are accessed through the /dev/ttyd? (dial-in) and - /dev/cua0? (call-out) devices. On FreeBSD + /dev/cua0? (call-out) devices. On FreeBSD version 1.1.5 and higher, there are also initialization devices (/dev/ttyid? and /dev/cuai0?) and locking devices (/dev/ttyld? and - /dev/cual0?). The initialization devices are + /dev/cual0?). The initialization devices are used to initialize communications port parameters each time a port is opened, such as crtscts for modems which use CTS/RTS signaling for flow - control. The locking devices are used to lock flags on ports to + control. The locking devices are used to lock flags on ports to prevent users or programs changing certain parameters; see the manual pages termios4, sio4, and stty1 for information on the terminal settings, locking & initializing @@ -1146,7 +1146,7 @@ device sio3 at isa? port "IO_COM4" tty irq 9 vector siointr A shell script called MAKEDEV in the /dev directory manages the device special - files. (The manual page for MAKEDEV8 on + files. (The manual page for MAKEDEV8 on FreeBSD 1.1.5 is fairly bogus in its discussion of COM ports, so ignore it.) To use MAKEDEV to make dialup device special files @@ -1167,7 +1167,7 @@ device sio3 at isa? port "IO_COM4" tty irq 9 vector siointr /dev/cua* files) to make sure that only users who should have access to those device special files can read & write on them — you probably do not want to allow - your average user to use your modems to dialout. The default + your average user to use your modems to dialout. The default permissions on the /dev/cua* files should be sufficient: @@ -1188,43 +1188,43 @@ crw-rw---- 1 uucp dialer 28, 193 Feb 15 14:38 /dev/cual01 There are three system configuration files in the /etc directory that you will probably need to - edit to allow dialup access to your FreeBSD system. The first, + edit to allow dialup access to your FreeBSD system. The first, /etc/gettytab, contains configuration information for the /usr/libexec/getty - daemon. Second, /etc/ttys holds information + daemon. Second, /etc/ttys holds information that tells /sbin/init what - tty devices should have getty processes running on them. Lastly, + tty devices should have getty processes running on them. Lastly, you can place port initialization commands in the /etc/rc.serial script if you have FreeBSD 1.1.5.1 or higher; otherwise, you can initialize ports in the /etc/rc.local script. There are two schools of thought regarding dialup modems on - UNIX. One group likes to configure their modems and system so + UNIX. One group likes to configure their modems and system so that no matter at what speed a remote user dials in, the local - computer-to-modem RS-232 interface runs at a locked speed. The + computer-to-modem RS-232 interface runs at a locked speed. The benefit of this configuration is that the remote user always sees - a system login prompt immediately. The downside is that the system + a system login prompt immediately. The downside is that the system does not know what a user's true data rate is, so full-screen programs like Emacs will not adjust their screen-painting methods to make their response better for slower connections. The other school configures their modems' RS-232 interface to - vary its speed based on the remote user's connection speed. For + vary its speed based on the remote user's connection speed. For example, V.32bis (14.4 Kbps) connections to the modem might make the modem run its RS-232 interface at 19.2 Kbps, while 2400 bps connections make the modem's RS-232 interface run at 2400 bps. Because getty does not understand any particular modem's connection speed reporting, getty gives a login: message at an initial speed and - watches the characters that come back in response. If the user + watches the characters that come back in response. If the user sees junk, it is assumed that they know they should press the <Enter> key until they see a - recognizable prompt. If the data rates do not match, getty sees anything the user types as + recognizable prompt. If the data rates do not match, getty sees anything the user types as “junk”, tries going to the next speed and gives the - login: prompt again. This procedure can + login: prompt again. This procedure can continue ad nauseum, but normally only takes a keystroke or two - before the user sees a good prompt. Obviously, this login sequence + before the user sees a good prompt. Obviously, this login sequence does not look as clean as the former “locked-speed” method, but a user on a low-speed connection should receive better interactive response from full-screen programs. @@ -1238,7 +1238,7 @@ crw-rw---- 1 uucp dialer 28, 193 Feb 15 14:38 /dev/cual01 <filename>/etc/gettytab</filename> /etc/gettytab is a termcap5-style file of configuration - information for getty8. Please see the + information for getty8. Please see the gettytab5 manual page for complete information on the format of the file and the list of capabilities. @@ -1258,8 +1258,8 @@ crw-rw---- 1 uucp dialer 28, 193 Feb 15 14:38 /dev/cual01 You will need to setup an entry in /etc/gettytab to give getty information about the speeds you - wish to use for your modem. If you have a 2400 bps modem, you - can probably use the existing D2400 entry. This entry already exists + wish to use for your modem. If you have a 2400 bps modem, you + can probably use the existing D2400 entry. This entry already exists in the FreeBSD 1.1.5.1 gettytab file, so you do not need to add it unless it is missing under your version of FreeBSD: @@ -1296,7 +1296,7 @@ uq|V19200|High Speed Modem at 19200,8-bit:\ :nx=V9600:tc=std.19200: On FreeBSD 1.1.5 and later, this will result in 8-bit, no - parity connections. Under FreeBSD 1.1, add + parity connections. Under FreeBSD 1.1, add :np: parameters to the std.xxx entries at the top of the file for 8 bits, no parity; otherwise, the default is 7 bits, even parity. @@ -1304,16 +1304,16 @@ uq|V19200|High Speed Modem at 19200,8-bit:\ The example above starts the communications rate at 19.2 Kbps (for a V.32bis connection), then cycles through 9600 bps (for V.32), 2400 bps, 1200 bps, 300 bps, and back to 19.2 - Kbps. Communications rate cycling is implemented with the + Kbps. Communications rate cycling is implemented with the nx= (“next - table”) capability. Each of the lines uses a + table”) capability. Each of the lines uses a tc= (“table continuation”) entry to pick up the rest of the “standard” settings for a particular data rate. If you have a 28.8 Kbps modem and/or you want to take advantage of compression on a 14.4 Kbps modem, you need to use - a higher communications rate than 19.2 Kbps. Here is an + a higher communications rate than 19.2 Kbps. Here is an example of a gettytab entry starting a 57.6 Kbps: @@ -1347,14 +1347,14 @@ vq|VH57600|Very High Speed Modem at 57600,8-bit:\ /etc/ttys also provides security information to login (user root may only login on ttys marked - secure). See the manual page for + secure). See the manual page for ttys5 for more information. You will need to either modify existing lines in /etc/ttys or add new lines to make init run getty processes automatically on your new - dialup ports. The general format of the line will be the same, + dialup ports. The general format of the line will be the same, whether you are using a locked-speed or matching-speed configuration: @@ -1363,38 +1363,38 @@ ttyd0 "/usr/libexec/getty xxx" dialup on The first item in the above line is the device special file for this entry — ttyd0 means - /dev/ttyd0 is the file that this getty will be watching. The second item, + /dev/ttyd0 is the file that this getty will be watching. The second item, "/usr/libexec/getty xxx" (xxx will be replaced by the initial gettytab capability) is the process init will run on the - device. The third item, dialup, - is the default terminal type. The fourth parameter, - on, indicates to init that the line is operational. There + device. The third item, dialup, + is the default terminal type. The fourth parameter, + on, indicates to init that the line is operational. There can be a fifth parameter, secure, but it should only be used for terminals which are physically secure (such as the system console). The default terminal type (dialup in the example above) may depend on - local preferences. dialup is the + local preferences. dialup is the traditional default terminal type on dialup lines so that users may customize their login scripts to notice when the terminal is dialup and automatically adjust - their terminal type. However, the author finds it easier at his + their terminal type. However, the author finds it easier at his site to specify vt102 as the default terminal type, since the users just use VT102 emulation on their remote systems. After you have made changes to /etc/ttys, you may send the init process a HUP - signal to re-read the file. You can use the command + signal to re-read the file. You can use the command &prompt.root; kill -1 1 - to send the signal. If this is your first time setting up + to send the signal. If this is your first time setting up the system, though, you may want to wait until your modem(s) are properly configured and connected before signaling init. @@ -1403,7 +1403,7 @@ ttyd0 "/usr/libexec/getty xxx" dialup on Locked-Speed Config For a locked-speed configuration, your ttys entry needs to have a fixed-speed - entry provided to getty. For a + entry provided to getty. For a modem whose port speed is locked at 19.2 Kbps, the ttys entry might look like this: @@ -1422,7 +1422,7 @@ ttyd0 "/usr/libexec/getty std.19200" dialup on In a matching-speed configuration, your ttys entry needs to reference the appropriate beginning “auto-baud” (sic) entry in - /etc/gettytab. For example, if you added + /etc/gettytab. For example, if you added the above suggested entry for a matching-speed modem that starts at 19.2 Kbps (the gettytab entry containing the V19200 starting point), your @@ -1485,7 +1485,7 @@ stty -f /dev/ttyd3 crtscts If you have a modem whose parameters may be permanently set in non-volatile RAM, you will need to use a terminal program (such as Telix under PC-DOS or tip under - FreeBSD) to set the parameters. Connect to the modem using the + FreeBSD) to set the parameters. Connect to the modem using the same communications speed as the initial speed getty will use and configure the modem's non-volatile RAM to match these requirements: @@ -1586,7 +1586,7 @@ AT&C1&D2&H1&I0&R2&W Result codes should be disabled/suppressed for dialup modems to avoid problems that can occur if getty mistakenly gives a login: prompt to a modem that is in command - mode and the modem echoes the command or returns a result code. I + mode and the modem echoes the command or returns a result code. I have heard this sequence can result in a extended, silly conversation between getty and the modem. @@ -1597,7 +1597,7 @@ AT&C1&D2&H1&I0&R2&W For a locked-speed configuration, you will need to configure the modem to maintain a constant modem-to-computer data rate - independent of the communications rate. On a USR Sportster + independent of the communications rate. On a USR Sportster 14,400 external modem, these commands will lock the modem-to-computer data rate at the speed used to issue the commands: @@ -1612,7 +1612,7 @@ AT&B1&W For a variable-speed configuration, you will need to configure your modem to adjust its serial port data rate to - match the incoming call rate. On a USR Sportster 14,400 + match the incoming call rate. On a USR Sportster 14,400 external modem, these commands will lock the modem's error-corrected data rate to the speed used to issue the commands, but allow the serial port rate to vary for @@ -1628,9 +1628,9 @@ AT&B2&W Most high-speed modems provide commands to view the modem's current operating parameters in a somewhat human-readable - fashion. On the USR Sportster 14,400 external modems, the + fashion. On the USR Sportster 14,400 external modems, the command ATI5 displays the settings - that are stored in the non-volatile RAM. To see the true + that are stored in the non-volatile RAM. To see the true operating parameters of the modem (as influenced by the USR's DIP switch settings), use the commands ATZ and then ATI4. @@ -1680,7 +1680,7 @@ AT&B2&W and the modem has not accepted a call yet, this means that getty has completed its open on - the communications port. This could indicate a problem with the + the communications port. This could indicate a problem with the cabling or a mis-configured modem, because getty should not be able to open the communications port until CD (carrier detect) has been asserted by the modem. @@ -1689,10 +1689,10 @@ AT&B2&W processes waiting to open the desired ttyd? port, double-check your entries in /etc/ttys to see if there are any mistakes - there. Also, check the log file + there. Also, check the log file /var/log/messages to see if there are any log messages from init or - getty regarding any problems. If + getty regarding any problems. If there are any messages, triple-check the configuration files /etc/ttys and /etc/gettytab, as well as the appropriate @@ -1706,8 +1706,8 @@ AT&B2&W Try Dialing In Try dialing into the system; be sure to use 8 bits, no - parity, 1 stop bit on the remote system. If you do not get a - prompt right away, or get garbage, try pressing <Enter> about once per second. If + parity, 1 stop bit on the remote system. If you do not get a + prompt right away, or get garbage, try pressing <Enter> about once per second. If you still do not see a login: prompt after a while, try sending a BREAK. If you are using a high-speed modem to do the dialing, try @@ -1743,13 +1743,13 @@ AT&B2&W If you dial but the modem on the FreeBSD system will not answer, make sure that the modem is configured to answer the - phone when DTR is asserted. If the modem + phone when DTR is asserted. If the modem seems to be configured correctly, verify that the DTR line is asserted by checking the modem's indicator lights (if it has any). If you have gone over everything several times and it still - does not work, take a break and come back to it later. If it + does not work, take a break and come back to it later. If it still does not work, perhaps you can send an electronic mail message to the &a.questions;describing your modem and your problem, and the good folks on the list will try to help. @@ -1781,13 +1781,13 @@ AT&B2&W Information integrated from FAQ. The following are tips to getting your host to be able to - connect over the modem to another computer. This is appropriate for + connect over the modem to another computer. This is appropriate for establishing a terminal session with a remote host. This is useful to log onto a BBS. This kind of connection can be extremely helpful to get a file - on the Internet if you have problems with PPP. If you need to ftp + on the Internet if you have problems with PPP. If you need to ftp something and PPP is broken, use the terminal session to ftp it. Then use zmodem to transfer it to your machine. @@ -1799,8 +1799,8 @@ AT&B2&W On your system, the programs tip and cu are probably executable only by uucp and group - dialer. You can use the group dialer to control who has access to your - modem or remote systems. Just add yourself to group + dialer. You can use the group dialer to control who has access to your + modem or remote systems. Just add yourself to group dialer. Alternatively, you can let everyone on your system run @@ -1819,7 +1819,7 @@ AT&B2&W My stock Hayes modem is not supported, what can I do? Actually, the man page for tip - is out of date. There is a generic Hayes dialer already built in. + is out of date. There is a generic Hayes dialer already built in. Just use at=hayes in your /etc/remote file. @@ -1827,25 +1827,25 @@ AT&B2&W advanced features of newer modems—messages like BUSY, NO DIALTONE, or CONNECT - 115200 will just confuse it. You should turn those + 115200 will just confuse it. You should turn those messages off when you use tip (using ATX0&W). Also, the dial timeout for tip - is 60 seconds. Your modem should use something less, or else tip - will think there is a communication problem. Try + is 60 seconds. Your modem should use something less, or else tip + will think there is a communication problem. Try ATS7=45&W. Actually, as shipped tip does - not yet support it fully. The solution is to edit the file + not yet support it fully. The solution is to edit the file tipconf.h in the directory /usr/src/usr.bin/tip/tip Obviously you need the source distribution to do this. Edit the line #define HAYES 0 to #define HAYES - 1. Then make and - make install. Everything works + 1. Then make and + make install. Everything works nicely after that. @@ -1854,7 +1854,7 @@ AT&B2&W How am I expected to enter these AT commands? Make what is called a “direct” - entry in your /etc/remote file. For example, + entry in your /etc/remote file. For example, if your modem is hooked up to the first serial port, /dev/cuaa0, then put in the following line: @@ -1862,7 +1862,7 @@ AT&B2&W cuaa0:dv=/dev/cuaa0:br#19200:pa=none Use the highest bps rate your modem supports in - the br capability. Then, type tip + the br capability. Then, type tip cuaa0 and you will be connected to your modem. @@ -1882,7 +1882,7 @@ cuaa0:dv=/dev/cuaa0:br#19200:pa=none line is the serial port (e.g./dev/cuaa0) and speed is - the speed (e.g.57600). When you are + the speed (e.g.57600). When you are done entering the AT commands hit ~. to exit. @@ -1894,8 +1894,8 @@ cuaa0:dv=/dev/cuaa0:br#19200:pa=none The @ sign in the phone number capability tells tip to look in /etc/phones for a phone - number. But the @ sign is also a special character - in capability files like /etc/remote. Escape + number. But the @ sign is also a special character + in capability files like /etc/remote. Escape it with a backslash: @@ -1907,7 +1907,7 @@ pn=\@ How can I dial a phone number on the command line? Put what is called a “generic” - entry in your /etc/remote file. For example: + entry in your /etc/remote file. For example: tip115200|Dial any phone number at 115200 bps:\ @@ -1940,9 +1940,9 @@ cu115200|Use cu to dial any number at 115200bps:\ Put in an entry for tip1200 or cu1200, but go ahead and use - whatever bps rate is appropriate with the br capability. tip thinks a good default is 1200 bps which + whatever bps rate is appropriate with the br capability. tip thinks a good default is 1200 bps which is why it looks for a tip1200 - entry. You do not have to use 1200 bps, though. + entry. You do not have to use 1200 bps, though. @@ -1951,7 +1951,7 @@ cu115200|Use cu to dial any number at 115200bps:\ Rather than waiting until you are connected and typing CONNECT <host> each time, - use tip's cm capability. For + use tip's cm capability. For example, these entries in /etc/remote: @@ -1995,7 +1995,7 @@ big-university 5551113 big-university 5551114 tip will try each one in the - listed order, then give up. If you want to keep retrying, run + listed order, then give up. If you want to keep retrying, run tip in a while loop. @@ -2006,15 +2006,15 @@ big-university 5551114 CTRL+P is the default “force” character, used to tell tip that the next character is - literal data. You can set the force character to any other + literal data. You can set the force character to any other character with the ~s escape, which means “set a variable.” Type ~sforce=single-char - followed by a newline. single-char is any single character. + followed by a newline. single-char is any single character. If you leave out single-char, then the force character is the nul character, which you can get by typing CTRL+2 - or CTRL+SPACE. A pretty good value for single-char is SHIFT+CTRL+6, which I + or CTRL+SPACE. A pretty good value for single-char is SHIFT+CTRL+6, which I have seen only used on some terminal servers. You can have the force character be whatever you want by @@ -2030,8 +2030,8 @@ force=<single-char> Suddenly everything I type is in UPPER CASE?? You must have pressed CTRL+A, tip's “raise character,” specially - designed for people with broken caps-lock keys. Use ~s as above and set the variable - raisechar to something reasonable. In fact, you can set it to + designed for people with broken caps-lock keys. Use ~s as above and set the variable + raisechar to something reasonable. In fact, you can set it to the same as the force character, if you never expect to use either of these features. @@ -2051,9 +2051,9 @@ raisechar=^^ If you are talking to another UNIX system, you can send and receive files with ~p (put) and - ~t (take). These commands run + ~t (take). These commands run cat and echo on the remote system to accept and - send files. The syntax is: + send files. The syntax is: ~p diff --git a/en_US.ISO_8859-1/books/handbook/staff/chapter.sgml b/en_US.ISO_8859-1/books/handbook/staff/chapter.sgml index 9f530dabbb..fa045523bd 100644 --- a/en_US.ISO_8859-1/books/handbook/staff/chapter.sgml +++ b/en_US.ISO_8859-1/books/handbook/staff/chapter.sgml @@ -87,7 +87,7 @@ The FreeBSD Developers These are the people who have commit privileges and do the - engineering work on the FreeBSD source tree. All core team members + engineering work on the FreeBSD source tree. All core team members are also developers. diff --git a/en_US.ISO_8859-1/books/porters-handbook/book.sgml b/en_US.ISO_8859-1/books/porters-handbook/book.sgml index 35e532e05b..0eb95aa909 100644 --- a/en_US.ISO_8859-1/books/porters-handbook/book.sgml +++ b/en_US.ISO_8859-1/books/porters-handbook/book.sgml @@ -8,16 +8,16 @@ For all the hype about open standards, getting a program to work on different versions of Unix in the real world can be a tedious and - tricky business, as anyone who has tried it will know. You may be + tricky business, as anyone who has tried it will know. You may be lucky enough to find that the program you want will compile cleanly on your system, install itself in all the right places and run flawlessly - “out of the box”, but this is unfortunately rather rare. With most + “out of the box”, but this is unfortunately rather rare. With most programs, you will find yourself doing a fair bit of head-scratching, and there are quite a few programs that will result in premature greying, or even chronic alopecia... Some software distributions have attacked this problem by - providing configuration scripts. Some of these are very clever, but + providing configuration scripts. Some of these are very clever, but they have an unfortunate tendency to triumphantly announce that your system is something you have never heard of and then ask you lots of questions that sound like a final exam in system-level Unix @@ -102,7 +102,7 @@ FreeBSD ports still use the tarball mechanism, but use a skeleton to hold the "knowledge" of how to get the program working on FreeBSD, - rather than expecting the user to be able to work it out. They also + rather than expecting the user to be able to work it out. They also supply their own customised Makefile, so that almost every port can be built in the same way. @@ -110,14 +110,14 @@ If you look at a port skeleton (either on your FreeBSD system or the FTP site) and expect to find all sorts of pointy-headed rocket science lurking there, you may be disappointed by the one or two rather unexciting-looking files and directories you find there. (We will discuss in a minute how to go about the FTP site) and expect to find all sorts of pointy-headed rocket science lurking there, you may be disappointed by the one or two rather unexciting-looking files and directories you find there. (We will discuss in a minute how to go about Getting a port). - “How on earth can this do anything?” I hear you cry. “There + “How on earth can this do anything?” I hear you cry. “There is no source code there!” Fear not, gentle reader, all will become clear (hopefully). - Let's see what happens if we try and install a port. I have chosen + Let's see what happens if we try and install a port. I have chosen ElectricFence, a useful tool for developers, as the skeleton is more straightforward than most. @@ -160,7 +160,7 @@ install -c -o bin -g bin -m 444 /usr/ports/devel/ElectricFence/work/ElectricFenc The make program has noticed that you did not have a local copy of the source code and tried to FTP it down so it could get the - job done. I already had the source handy in my example, so it did + job done. I already had the source handy in my example, so it did not need to fetch it. Let's go through this and see what the make program was @@ -203,13 +203,13 @@ install -c -o bin -g bin -m 444 /usr/ports/devel/ElectricFence/work/ElectricFenc Install the program executable and other supporting files, man pages, etc. under the /usr/local hierarchy, where they will not - get mixed up with system programs. This also makes sure that + get mixed up with system programs. This also makes sure that all the ports you install will go in the same place, instead of being flung all over your system. - Register the installation in a database. This means that, + Register the installation in a database. This means that, if you do not like the program, you can cleanly remove all traces of it from your system. @@ -219,7 +219,7 @@ install -c -o bin -g bin -m 444 /usr/ports/devel/ElectricFence/work/ElectricFenc Scroll up to the make output and see if you can match these - steps to it. And if you were not impressed before, you should be by + steps to it. And if you were not impressed before, you should be by now! @@ -228,7 +228,7 @@ install -c -o bin -g bin -m 444 /usr/ports/devel/ElectricFence/work/ElectricFenc Getting a FreeBSD Port There are two ways of getting hold of the FreeBSD port for a - program. One requires a FreeBSD + program. One requires a FreeBSD CDROM, the other involves using an Internet Connection. @@ -253,17 +253,17 @@ DISTDIR= /tmp/distfiles WRKDIRPREFIX= /tmp Substitute /tmp for any place you have enough - free space. Then, just cd to the appropriate + free space. Then, just cd to the appropriate subdirectory under /cdrom/ports and type make install as - usual. WRKDIRPREFIX will cause the port to be + usual. WRKDIRPREFIX will cause the port to be build under /tmp/cdrom/ports; for instance, games/oneko will be built under /tmp/cdrom/ports/games/oneko. There are some ports for which we cannot provide the - original source in the CDROM due to licensing limitations. In + original source in the CDROM due to licensing limitations. In that case, you will need to look at the section on Compiling ports using an Internet connection. @@ -275,22 +275,22 @@ WRKDIRPREFIX= /tmp If you do not have a CDROM, or you want to make sure you get the very latest version of the port you want, you will need to download the - skeleton for the port. Now + skeleton for the port. Now this might sound like rather a fiddly job full of pitfalls, but it is actually very easy. First, if you are running a release version of FreeBSD, make sure you get the appropriate “upgradekiet” for your replease from the ports - web page. These packages include files that have been + web page. These packages include files that have been updated since the release that you may need to compile new ports. The key to the skeletons is that the FreeBSD FTP server can create on-the-fly - tarballs for you. Here is + tarballs for you. Here is how it works, with the gnats program in the databases directory as - an example (the bits in square brackets are comments. Do not type + an example (the bits in square brackets are comments. Do not type them in if you are trying this yourself!):- @@ -312,19 +312,19 @@ password. Remember to use binary (also known as image) mode!] What happened here? We connected to the FTP server in the - usual way and went to its databases sub-directory. When we gave it + usual way and went to its databases sub-directory. When we gave it the command get gnats.tar, the FTP server tarred up the gnats directory for us. We then extracted the gnats skeleton and went into the gnats - directory to build the port. As we explained earlier, the make process noticed we did not have a copy of the source locally, so it fetched one before extracting, patching and building it. - Let's try something more ambitious now. Instead of getting a + Let's try something more ambitious now. Instead of getting a single port skeleton, let's get a whole sub-directory, for example - all the database skeletons in the ports collection. It looks + all the database skeletons in the ports collection. It looks almost the same:- @@ -347,7 +347,7 @@ password. Remember to use binary (also known as image) mode!] set of database programs on our FreeBSD machine! All we did that was different from getting a single port skeleton and building it was that we got a whole directory at once, and compiled everything - in it at once. Pretty impressive, no? + in it at once. Pretty impressive, no? If you expect to be installing many ports, it is probably worth downloading all the ports directories. @@ -369,7 +369,7 @@ password. Remember to use binary (also known as image) mode!] The most important component of a skeleton is the Makefile. This contains various statements that specify how the port should - be compiled and installed. Here is the Makefile for + be compiled and installed. Here is the Makefile for ElectricFence:- @@ -404,8 +404,8 @@ do-install: linkend="ports-tarball">tarball, but without the extension. - CATEGORIES states what kind of program this is. In - this case, a utility for developers. See the CATEGORIES states what kind of program this is. In + this case, a utility for developers. See the categories section of this handbook for a complete list. @@ -423,7 +423,7 @@ do-install: Skipping over the next few lines for a minute, the line .include <bsd.port.mk> says that the other statements and commands needed for this port are - in a standard file called bsd.port.mk. As + in a standard file called bsd.port.mk. As these are the same for all ports, there is no point in duplicating them all over the place, so they are kept in a single standard file. @@ -432,7 +432,7 @@ do-install: examination of how Makefiles work; suffice it to say that the line starting with MAN3 ensures that the ElectricFence man page is compressed after installation, to help conserve your precious disk - space. The original port did not provide an install target, + space. The original port did not provide an install target, so the three lines from do-install ensure that the files produced by this port are placed in the correct destination. @@ -444,7 +444,7 @@ do-install: The file containing the checksum for the port is called md5, after the MD5 algorithm used for ports - checksums. It lives in a directory with the slightly confusing + checksums. It lives in a directory with the slightly confusing name of files. This directory can also contain other miscellaneous files that @@ -491,31 +491,31 @@ do-install: What to do when a port does not work. - Oh. You can do one of four (4) things : + Oh. You can do one of four (4) things : - Fix it yourself. Technical details on how ports work can + Fix it yourself. Technical details on how ports work can be found in Porting applications. - Gripe. This is done by e-mail only! Send such e-mail to + Gripe. This is done by e-mail only! Send such e-mail to the &a.ports; and please include the name/version of the port, where you got both the port source & distfile(s) from, and what the text of the error was. - Forget it. This is the easiest for most — very few of the + Forget it. This is the easiest for most — very few of the programs in ports can be classified as essential! - Grab the pre-compiled package from a ftp server. The + Grab the pre-compiled package from a ftp server. The “master” package collection is on FreeBSD's FTP server in the packages @@ -538,29 +538,29 @@ do-install: - Q. I thought this was going to be a discussion about + Q. I thought this was going to be a discussion about modems??! - A. Ah. You must be thinking of the serial ports on the - back of your computer. We are using “port” here to mean the + A. Ah. You must be thinking of the serial ports on the + back of your computer. We are using “port” here to mean the result of “porting” a program from one version of Unix to - another. (It is an unfortunate bad habit of computer people to + another. (It is an unfortunate bad habit of computer people to use the same word to refer to several completely different things). - Q. I thought you were supposed to use packages to install + Q. I thought you were supposed to use packages to install extra programs? - A. Yes, that is usually the quickest and easiest way of + A. Yes, that is usually the quickest and easiest way of doing it. - Q. So why bother with ports then? + Q. So why bother with ports then? - A. Several reasons:- + A. Several reasons:- @@ -572,7 +572,7 @@ do-install: - Some people do not trust binary distributions. At + Some people do not trust binary distributions. At least with source code you can (in theory) read through it and look for potential problems yourself. @@ -607,21 +607,21 @@ do-install: - Q. What is a patch? + Q. What is a patch? - A. A patch is a small (usually) file that specifies how to - go from one version of a file to another. It contains text + A. A patch is a small (usually) file that specifies how to + go from one version of a file to another. It contains text that says, in effect, things like “delete line 23”, “add these two lines after line 468” or “change line 197 to - this”. Also known as a “diff”, since it is generated by a + this”. Also known as a “diff”, since it is generated by a program of that name. - Q. What is all this about + Q. What is all this about tarballs? - A. It is a file ending in .tar or + A. It is a file ending in .tar or .tar.gz (with variations like .tar.Z, or even .tgz if you are trying to squeeze the names into a DOS @@ -629,7 +629,7 @@ do-install: Basically, it is a directory tree that has been archived into a single file (.tar) and optionally - compressed (.gz). This technique was + compressed (.gz). This technique was originally used for Tape ARchives (hence the name tar), but it is a widely used way of distributing program source code around @@ -649,19 +649,19 @@ do-install: - Q. And a checksum? + Q. And a checksum? - A. It is a number generated by adding up all the data in - the file you want to check. If any of the characters change, + A. It is a number generated by adding up all the data in + the file you want to check. If any of the characters change, the checksum will no longer be equal to the total, so a simple - comparison will allow you to spot the difference. (In + comparison will allow you to spot the difference. (In practice, it is done in a more complicated way to spot problems like position-swapping, which will not show up with a simplistic addition). - Q. I did what you said for compiling ports from a CDROM and it worked great + Q. I did what you said for compiling ports from a CDROM and it worked great until I tried to install the kermit port:- @@ -671,25 +671,25 @@ do-install: Why can it not be found? Have I got a dud CDROM? - A. The licensing terms for kermit do not allow us to put + A. The licensing terms for kermit do not allow us to put the tarball for it on the CDROM, so you will have to fetch it by hand — sorry! The reason why you got all those error messages was because you were not connected to the Internet at - the time. Once you have downloaded it from any of the sites + the time. Once you have downloaded it from any of the sites above, you can re-start the process (try and choose the nearest site to you, though, to save your time and the Internet's bandwidth). - Q. I did that, but when I tried to put it into + Q. I did that, but when I tried to put it into /usr/ports/distfiles I got some error about not having permission. - A. The ports mechanism looks for the tarball in + A. The ports mechanism looks for the tarball in /usr/ports/distfiles, but you will not be able to copy anything there because it is sym-linked to the - CDROM, which is read-only. You can tell it to look somewhere + CDROM, which is read-only. You can tell it to look somewhere else by doing @@ -698,14 +698,14 @@ do-install: - Q. Does the ports scheme only work if you have everything + Q. Does the ports scheme only work if you have everything in /usr/ports? My system administrator says I must put everything under /u/people/guests/wurzburger, but it does not seem to work. - A. You can use the PORTSDIR and PREFIX variables to tell - the ports mechanism to use different directories. For + A. You can use the PORTSDIR and PREFIX variables to tell + the ports mechanism to use different directories. For instance, @@ -739,12 +739,12 @@ do-install: - Q. I do not have a FreeBSD CDROM, but I would like to have + Q. I do not have a FreeBSD CDROM, but I would like to have all the tarballs handy on my system so I do not have to wait - for a download every time I install a port. Is there an easy + for a download every time I install a port. Is there an easy way to get them all at once? - A. To get every single tarball for the ports collection, + A. To get every single tarball for the ports collection, do @@ -765,12 +765,12 @@ do-install: - Q. I know it is probably faster to fetch the tarballs from - one of the FreeBSD mirror sites close by. Is there any way to + Q. I know it is probably faster to fetch the tarballs from + one of the FreeBSD mirror sites close by. Is there any way to tell the port to fetch them from servers other than ones listed in the MASTER_SITES? - A. Yes. If you know, for example, ftp.FreeBSD.ORG is much + A. Yes. If you know, for example, ftp.FreeBSD.ORG is much closer than sites listed in MASTER_SITES, do as following example. @@ -781,43 +781,43 @@ do-install: - Q. I want to know what files make is going to need before + Q. I want to know what files make is going to need before it tries to pull them down. - A. make fetch-list will display a list of the files + A. make fetch-list will display a list of the files needed for a port. - Q. Is there any way to stop the port from compiling? I + Q. Is there any way to stop the port from compiling? I want to do some hacking on the source before I install it, but it is a bit tiresome having to watch it and hit control-C every time. - A. Doing make extract will stop it after it has fetched + A. Doing make extract will stop it after it has fetched and extracted the source code. - Q. I am trying to make my own port and I want to be able + Q. I am trying to make my own port and I want to be able to stop it compiling until I have had a chance to see if my - patches worked properly. Is there something like make + patches worked properly. Is there something like make extract, but for patches? - A. Yep, make patch is what you want. You will probably - find the PATCH_DEBUG option useful as well. And by the way, + A. Yep, make patch is what you want. You will probably + find the PATCH_DEBUG option useful as well. And by the way, thank you for your efforts! - Q. I have heard that some compiler options can cause bugs. + Q. I have heard that some compiler options can cause bugs. Is this true? How can I make sure that I compile ports with the right settings? - A. Yes, with version 2.6.3 of gcc (the version shipped + A. Yes, with version 2.6.3 of gcc (the version shipped with FreeBSD 2.1.0 and 2.1.5), the option could result in buggy code unless you used the option as - well. (Most of the ports don't use ). You + well. (Most of the ports don't use ). You should be able to specify the compiler options used by something like @@ -826,7 +826,7 @@ do-install: or by editing /etc/make.conf, but - unfortunately not all ports respect this. The surest way is to + unfortunately not all ports respect this. The surest way is to do make configure, then go into the source directory and inspect the Makefiles by hand, but this can get tedious if the source has lots of sub-directories, each with their own @@ -834,12 +834,12 @@ do-install: - Q. There are so many ports it is hard to find the one I - want. Is there a list anywhere of what ports are available? + Q. There are so many ports it is hard to find the one I + want. Is there a list anywhere of what ports are available? - A. Look in the INDEX file in - /usr/ports. If you would like to search the - ports collection for a keyword, you can do that too. For example, + A. Look in the INDEX file in + /usr/ports. If you would like to search the + ports collection for a keyword, you can do that too. For example, you can find ports relevant to the LISP programming language using: @@ -850,25 +850,25 @@ do-install: - Q. I went to install the foo port but the system + Q. I went to install the foo port but the system suddenly stopped compiling it and starting compiling the bar - port. What's going on? + port. What's going on? - A. The foo port needs something that is supplied with + A. The foo port needs something that is supplied with bar — for instance, if foo uses graphics, bar might have - a library with useful graphics processing routines. Or bar + a library with useful graphics processing routines. Or bar might be a tool that is needed to compile the foo port. - Q. I installed the grizzle + Q. I installed the grizzle program from the ports and frankly it is a complete waste of - disk space. I want to delete it but I do not know where it put - all the files. Any clues? + disk space. I want to delete it but I do not know where it put + all the files. Any clues? - A. No problem, just do + A. No problem, just do &prompt.root; pkg_delete grizzle-6.5 @@ -877,11 +877,11 @@ do-install: - Q. Hang on a minute, you have to know the version number to - use that command. You do not seriously expect me to remember + Q. Hang on a minute, you have to know the version number to + use that command. You do not seriously expect me to remember that, do you?? - A. Not at all, you can find it out by doing + A. Not at all, you can find it out by doing &prompt.root; pkg_info -a | grep grizzle @@ -891,13 +891,13 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. Talking of disk space, the ports directory seems to be - taking up an awful lot of room. Is it safe to go in there and + Q. Talking of disk space, the ports directory seems to be + taking up an awful lot of room. Is it safe to go in there and delete things? - A. Yes, if you have installed the program and are fairly + A. Yes, if you have installed the program and are fairly certain you will not need the source again, there is no point - in keeping it hanging around. The best way to do this + in keeping it hanging around. The best way to do this is @@ -910,19 +910,19 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. I tried that and it still left all those tarballs or + Q. I tried that and it still left all those tarballs or whatever you called them in the distfiles - directory. Can I delete those as well? + directory. Can I delete those as well? - A. Yes, if you are sure you have finished with them, those + A. Yes, if you are sure you have finished with them, those can go as well. - Q. I like having lots and lots of programs to play with. + Q. I like having lots and lots of programs to play with. Is there any way of installing all the ports in one go? - A. Just do + A. Just do &prompt.root; cd /usr/ports @@ -931,22 +931,22 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. OK, I tried that, but I thought it would take a very - long time so I went to bed and left it to get on with it. When + Q. OK, I tried that, but I thought it would take a very + long time so I went to bed and left it to get on with it. When I looked at the computer this morning, it had only done three - and a half ports. Did something go wrong? + and a half ports. Did something go wrong? - A. No, the problem is that some of the ports need to ask + A. No, the problem is that some of the ports need to ask you questions that we cannot answer for you (eg “Do you want to print on A4 or US letter sized paper?”) and they need to have someone on hand to answer them. - Q. I really do not want to spend all day staring at the - monitor. Any better ideas? + Q. I really do not want to spend all day staring at the + monitor. Any better ideas? - A. OK, do this before you go to bed/work/the local + A. OK, do this before you go to bed/work/the local park:- @@ -955,7 +955,7 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc This will install every port that does - not require user input. Then, when you + not require user input. Then, when you come back, do @@ -967,12 +967,12 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. At work, we are using frobble, which is in your ports + Q. At work, we are using frobble, which is in your ports collection, but we have altered it quite a bit to get it to do - what we need. Is there any way of making our own packages, so + what we need. Is there any way of making our own packages, so we can distribute it more easily around our sites? - A. No problem, assuming you know how to make patches for + A. No problem, assuming you know how to make patches for your changes:- @@ -986,10 +986,10 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc - Q. This ports stuff is really clever. I am desperate to - find out how you did it. What is the secret? + Q. This ports stuff is really clever. I am desperate to + find out how you did it. What is the secret? - A. Nothing secret about it at all, just look at the + A. Nothing secret about it at all, just look at the bsd.ports.mk and bsd.ports.subdir.mk files in your makefiles @@ -1011,27 +1011,27 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc Making a port yourself Contributed by &a.jkh;, &a.gpalmer;, &a.asami; - &a.obrien; and &a.hoek;. 28 August 1996. + &a.obrien; and &a.hoek;. 28 August 1996. So, now you are interested in making your own port? Great! What follows are some guidelines for creating a new port for - FreeBSD. The bulk of the work is done by + FreeBSD. The bulk of the work is done by /usr/share/mk/bsd.port.mk, which all port - Makefiles include. Please refer to that file for more details on - the inner workings of the ports collection. Even if you don't + Makefiles include. Please refer to that file for more details on + the inner workings of the ports collection. Even if you don't hack Makefiles daily, it is well commented, and you will still gain much knowledge from it. Only a fraction of the overridable variables (VAR) are mentioned - in this document. Most (if not all) are documented at the start of - bsd.port.mk. This file users a non-standard - tab setting. Emacs and + in this document. Most (if not all) are documented at the start of + bsd.port.mk. This file users a non-standard + tab setting. Emacs and Vim should recognise the setting on - loading the file. vi or ex + loading the file. vi or ex can be set to use the correct value by typing :set tabstop=4 once the file has been loaded. @@ -1039,7 +1039,7 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc Quick Porting - This section tells you how to do a quick port. In many + This section tells you how to do a quick port. In many cases, it is not enough, but we will see. First, get the original tarball and put it into DISTDIR, which defaults to @@ -1048,7 +1048,7 @@ grizzle-6.5 - the combined piano tutorial, LOGO interpreter and shoot 'em up arc The following assumes that the software compiled out-of-the-box, i.e., there was absolutely no change required - for the port to work on your FreeBSD box. If you needed to + for the port to work on your FreeBSD box. If you needed to change something, you will have to refer to the next section too. @@ -1080,10 +1080,10 @@ USE_IMAKE= yes .include <bsd.port.mk> - See if you can figure it out. Do not worry about the + See if you can figure it out. Do not worry about the contents of the $Id$ line, it will be filled in automatically by CVS when the port - is imported to our main ports tree. You can find a more + is imported to our main ports tree. You can find a more detailed example in the sample Makefile section. @@ -1106,7 +1106,7 @@ USE_IMAKE= yes This is the one-line description of the port. Please do not include the package name (or version - number of the software) in the comment. Here is + number of the software) in the comment. Here is an example: @@ -1117,7 +1117,7 @@ A cat chasing a mouse all over the screen. <filename>DESCR</filename> - This is a longer description of the port. One to a few + This is a longer description of the port. One to a few paragraphs concisely explaining what the port does is sufficient. @@ -1127,7 +1127,7 @@ A cat chasing a mouse all over the screen. Please be careful if you are copying from the README or manpage; too often they are not a concise description of the port or are in an - awkward format (e.g., manpages have justified spacing). If the + awkward format (e.g., manpages have justified spacing). If the ported software has an official WWW homepage, you should list it here. @@ -1151,12 +1151,12 @@ asami@cs.berkeley.edu <filename>PLIST</filename> - This file lists all the files installed by the port. It + This file lists all the files installed by the port. It is also called the “packing list” because the package is - generated by packing the files listed here. The pathnames + generated by packing the files listed here. The pathnames are relative to the installation prefix (usually /usr/local or - /usr/X11R6). If you are using the + /usr/X11R6). If you are using the MANn variables (as you should be), do not list any manpages here. @@ -1175,13 +1175,13 @@ lib/X11/oneko/mouse.xpm You should list all the files, but not the name - directories, in the list. Also, if the port creates + directories, in the list. Also, if the port creates directories for itself during installtion, make sure to add @dirrm lines as necessary to remove them when the port is deleted. It is recommended that you keep all the filenames in - this file sorted alphabetically. It will make verifying the + this file sorted alphabetically. It will make verifying the changes when you upgrade the port much easier. @@ -1200,7 +1200,7 @@ lib/X11/oneko/mouse.xpm Testing the port You should make sure that the port rules do exactly what - you want it to do, including packaging up the port. These are + you want it to do, including packaging up the port. These are the important points you need to verify. @@ -1260,7 +1260,7 @@ lib/X11/oneko/mouse.xpm Make sure that there aren't any warnings issued in any of the package and deinstall stages, After step 3, check - to see if all the new directories are correctly deleted. Also, + to see if all the new directories are correctly deleted. Also, try using the software after step 4, to ensure that is works correctly when installed from a package. @@ -1269,8 +1269,8 @@ lib/X11/oneko/mouse.xpm Checking your port with <command>portlint</command> Please use portlint to see if your port - conforms to our guidelines. The portlint - program is part of the ports collection. In particular, your may + conforms to our guidelines. The portlint + program is part of the ports collection. In particular, your may want to check if the Makefile is in the right shape and the package is @@ -1285,10 +1285,10 @@ lib/X11/oneko/mouse.xpm Now that you are happy with your port, the only thing remaining is to put it in the main FreeBSD ports tree and make - everybody else happy about it too. We do not need your + everybody else happy about it too. We do not need your work directory or the pkgname.tgz package, so delete them - now. Next, simply include the output of shar `find + now. Next, simply include the output of shar `find port_dir` in a bug report and send it with the send-pr @@ -1298,15 +1298,15 @@ lib/X11/oneko/mouse.xpm about send-pr 1 - . If the uncompressed port is larger than + . If the uncompressed port is larger than 20KB, you should compress it into a tarfile and use uuencode 1 before including it in the bug report (uuencoded tarfiles are acceptable even if the bug report is smaller than - 20KB but are not preferred). Be sure to classify the bug report as + 20KB but are not preferred). Be sure to classify the bug report as category ports and class - change-request. (Do not mark the report + change-request. (Do not mark the report confidential!) One more time, do not include the original source @@ -1317,7 +1317,7 @@ lib/X11/oneko/mouse.xpm In the past, we asked you to upload new port submissions in our ftp site (ftp.freebsd.org). This is no longer + role="fqdn">ftp.freebsd.org). This is no longer recommended as read access is turned off on that incoming/ directory of that site due to the large amount of pirated software showing up there. @@ -1325,7 +1325,7 @@ lib/X11/oneko/mouse.xpm We will look at your port, get back to you if necessary, and put it in the - tree. Your name will also appear in the list of “Additional + tree. Your name will also appear in the list of “Additional FreeBSD contributors” on the FreeBSD Handbook and other files. Isn't that great?!? :) @@ -1336,7 +1336,7 @@ lib/X11/oneko/mouse.xpm Slow Porting Ok, so it was not that simple, and the port required some - modifications to get it to work. In this section, we will + modifications to get it to work. In this section, we will explain, step by step, how to modify it to get it to work with the ports paradigm. @@ -1352,39 +1352,39 @@ lib/X11/oneko/mouse.xpm But do not worry if you do not really understand what bsd.port.mk is doing, not many people - do... :> + do... :> - The fetch target is run. The fetch target is + The fetch target is run. The fetch target is responsible for making sure that the tarball exists locally in DISTDIR. If fetch cannot find the required files in DISTDIR it will look up the URL MASTER_SITES, which is set in the Makefile, as well as our main ftp site at ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/, where we put sanctioned distfiles as backup. It will then attempt to fetch the named distribution file with FETCH, assuming that the requesting site has direct access to the Internet. If that succeeds, it will save the file in DISTDIR for future use and proceed. + URL="ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/">ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/, where we put sanctioned distfiles as backup. It will then attempt to fetch the named distribution file with FETCH, assuming that the requesting site has direct access to the Internet. If that succeeds, it will save the file in DISTDIR for future use and proceed. - The extract target is run. It looks for your port's + The extract target is run. It looks for your port's distribution file (typically a gzip'd tarball) in DISTDIR and unpacks it into a temporary subdirectory specified by WRKDIR (defaults to work). - The patch target is run. First, any patches defined + The patch target is run. First, any patches defined in PATCHFILES are - applied. Second, if any patches are found in PATCHDIR (defaults to the + applied. Second, if any patches are found in PATCHDIR (defaults to the patches subdirectory), they are applied at this time in alphabetical order. - The configure target is run. This can do any one of + The configure target is run. This can do any one of many different things. @@ -1414,10 +1414,10 @@ lib/X11/oneko/mouse.xpm - The build target is run. This is responsible for + The build target is run. This is responsible for descending into the port's private working directory (WRKSRC) and - building it. If USE_GMAKE is set, GNU + building it. If USE_GMAKE is set, GNU make will be used, otherwise the system make will be used. @@ -1426,7 +1426,7 @@ lib/X11/oneko/mouse.xpm - The above are the default actions. In addition, you can + The above are the default actions. In addition, you can define targets pre-something or post-something, or put scripts with those names, in the scripts subdirectory, and they will be run before or after the default @@ -1438,14 +1438,14 @@ lib/X11/oneko/mouse.xpm post-extract target will be called after the regular extraction actions, and the pre-build script will be executed before - the default build rules are done. It is recommended that you + the default build rules are done. It is recommended that you use Makefile targets if the actions are simple enough, because it will be easier for someone to figure out what kind of non-default action the port requires. The default actions are done by the - bsd.port.mk targets do-something. For example, the - commands to extract a port are in the target do-extract. If you are not happy with + bsd.port.mk targets do-something. For example, the + commands to extract a port are in the target do-extract. If you are not happy with the default target, you can fix it by redefining the do-something target in your Makefile. @@ -1454,7 +1454,7 @@ lib/X11/oneko/mouse.xpm The “main” targets (e.g., extract, configure, etc.) do nothing more than make sure all the stages up to that one are completed and call the real targets or scripts, and they are not intended - to be changed. If you want to fix the extraction, fix + to be changed. If you want to fix the extraction, fix do-extract, but never ever touch extract! @@ -1471,7 +1471,7 @@ lib/X11/oneko/mouse.xpm Get the original sources (normally) as a compressed tarball (foo.tar.gz or foo.tar.Z) and copy it into - DISTDIR. Always use + DISTDIR. Always use mainstream sources when and where you can. @@ -1479,7 +1479,7 @@ lib/X11/oneko/mouse.xpm to the net, or can only find sites that have irritatingly non-standard formats, you might want to put a copy on a reliable ftp or http server that you control (e.g., your home - page). Make sure you set MASTER_SITES to + page). Make sure you set MASTER_SITES to reflect your choice. If you @@ -1488,23 +1488,23 @@ lib/X11/oneko/mouse.xpm public_html/ directory on freefall), we can “house” it ourselves by putting - it on ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/LOCAL_PORTS/ as the last resort. Please refer to this - location as MASTER_SITE_LOCAL. Send mail to + it on ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/LOCAL_PORTS/ as the last resort. Please refer to this + location as MASTER_SITE_LOCAL. Send mail to the &a.ports;if you are not sure what to do. If your port's distfile changes all the time for no good reason, consider putting the distfile in your home page and - listing it as the first MASTER_SITES. This + listing it as the first MASTER_SITES. This will prevent users from getting checksum mismatch errors, and also reduce the workload of - maintainers of our ftp site. Also, if there isonly one master + maintainers of our ftp site. Also, if there isonly one master site for the port, it is recommended that you house a backup at your site and list it as the second MASTER_SITES. If your port requires some additional `patches' that are available on the Internet, fetch them too and put them in - DISTDIR. Do not worry if + DISTDIR. Do not worry if they come from a site other than where you got the main source tarball, we have a way to handle these situations (see the description of Unpack a copy of the tarball in a private directory and make whatever changes are necessary to get the port to compile - properly under the current version of FreeBSD. Keep + properly under the current version of FreeBSD. Keep careful track of everything you do, as - you will be automating the process shortly. Everything, + you will be automating the process shortly. Everything, including the deletion, addition or modification of files should be doable using an automated script or patch file when your port is finished. @@ -1527,7 +1527,7 @@ lib/X11/oneko/mouse.xpm If your port requires significant user interaction/customization to compile or install, you should take a look at one of Larry Wall's classic Configure scripts - and perhaps do something similar yourself. The goal of the + and perhaps do something similar yourself. The goal of the new ports collection is to make each port as “plug-and-play” as possible for the end-user while using a minimum of disk space. @@ -1545,18 +1545,18 @@ lib/X11/oneko/mouse.xpm In the preparation of the port, files that have been added or changed can be picked up with a recursive diff for later - feeding to patch. Each set of patches you wish to apply + feeding to patch. Each set of patches you wish to apply should be collected into a file named patch-xx where xx denotes the sequence in which the patches will be applied — these are done in alphabetical order, thus - aa first, ab second and so on. These files + aa first, ab second and so on. These files should be stored in PATCHDIR, from where they will be - automatically applied. All patches should be relative to + automatically applied. All patches should be relative to WRKSRC (generally the directory your port's tarball unpacks itself into, that being - where the build is done). To make fixes and upgrades easier, + where the build is done). To make fixes and upgrades easier, you should avoid having more than one patch fix the same file (e.g., patch-aa and patch-ab both changing WRKSRC/foobar.c). @@ -1567,7 +1567,7 @@ lib/X11/oneko/mouse.xpm Include any additional customization commands to your configure script and save it in the - scripts subdirectory. As mentioned + scripts subdirectory. As mentioned above, you can also do this as Makefile targets and/or scripts with the name pre-configure or @@ -1580,7 +1580,7 @@ lib/X11/oneko/mouse.xpm If your port requires user input to build, configure or install, then set IS_INTERACTIVE in your - Makefile. This will allow “overnight builds” to skip your port + Makefile. This will allow “overnight builds” to skip your port if the user sets the variable BATCH in his environment (and if the user sets the variable INTERACTIVE, then only @@ -1589,7 +1589,7 @@ lib/X11/oneko/mouse.xpm It is also recommended that if there are reasonable default answers to the questions, you check the PACKAGE_BUILDING variable and turn off the - interactive script when it is set. This will allow us to build + interactive script when it is set. This will allow us to build the packages for CD-ROMs and ftp. @@ -1612,9 +1612,9 @@ lib/X11/oneko/mouse.xpm The original source Does it live in DISTDIR as a standard gzip'd - tarball? If so, you can go on to the next step. If not, you + tarball? If so, you can go on to the next step. If not, you should look at overriding any of the EXTRACT_CMD, EXTRACT_BEFORE_ARGS, EXTRACT_AFTER_ARGS, EXTRACT_SUFX, or DISTFILES variables, depending on - how alien a format your port's distribution file is. (The + how alien a format your port's distribution file is. (The most common case is EXTRACT_SUFX=.tar.Z, when the tarball is condensed by regular compress, not gzip.) @@ -1630,7 +1630,7 @@ lib/X11/oneko/mouse.xpm <makevar>DISTNAME</makevar> You should set DISTNAME to be the base name of - your port. The default rules expect the distribution file + your port. The default rules expect the distribution file list (DISTFILES) to be named DISTNAMEEXTRACT_SUFX which, if it is a normal tarball, is going to be something like foozolix-1.0.tar.gz for a setting of DISTNAME=foozolix-1.0. @@ -1640,8 +1640,8 @@ lib/X11/oneko/mouse.xpm work/DISTNAME, e.g. work/foozolix-1.0/. All this behavior can be overridden, of course; it simply - represents the most common time-saving defaults. For a port - requiring multiple distribution files, simply set DISTFILES explicitly. If only a + represents the most common time-saving defaults. For a port + requiring multiple distribution files, simply set DISTFILES explicitly. If only a subset of DISTFILES are actual extractable archives, then set them up in EXTRACT_ONLY, which will override the DISTFILES list when @@ -1657,7 +1657,7 @@ lib/X11/oneko/mouse.xpm If DISTNAME does not conform to our guidelines for a good package name, you should set the PKGNAME - variable to something better. See the abovementioned guidelines + variable to something better. See the abovementioned guidelines for more details. @@ -1667,29 +1667,29 @@ lib/X11/oneko/mouse.xpm When a package is created, it is put under /usr/ports/packages/All and links are made from one or more subdirectories of - /usr/ports/packages. The names of these - subdirectories are specified by the variable CATEGORIES. It is intended to + /usr/ports/packages. The names of these + subdirectories are specified by the variable CATEGORIES. It is intended to make life easier for the user when he is wading through the - pile of packages on the ftp site or the CD-ROM. Please take a + pile of packages on the ftp site or the CD-ROM. Please take a look at the existing categories and pick the ones that are suitable for your port. This list also determines where in the ports tree the port - is imported. If you put more than one category here, it is + is imported. If you put more than one category here, it is assumed that the port files will be put in the subdirectory with - the name in the first category. See the categories section for more discussion about how to pick the right categories. If you port truly belongs to something that is different from all the existing ones, you can even create a new category - name. In that case, please send mail to the &a.ports; to propose + name. In that case, please send mail to the &a.ports; to propose a new category. There is no error checking for category - names. make package will happily create a + names. make package will happily create a new directory if you mustype the category name, so be careful! @@ -1699,7 +1699,7 @@ lib/X11/oneko/mouse.xpm <makevar>MASTER_SITES</makevar> Record the directory part of the ftp/http-URL pointing at - the original tarball in MASTER_SITES. Do not forget the + the original tarball in MASTER_SITES. Do not forget the trailing slash (/)! The make macros will try to use this specification for @@ -1707,7 +1707,7 @@ lib/X11/oneko/mouse.xpm already on the system. It is recommended that you put multiple sites on this - list, preferably from different continents. This will + list, preferably from different continents. This will safeguard against wide-area network problems, and we are even planning to add support for automatically determining the closest master site and fetching from there! @@ -1717,8 +1717,8 @@ lib/X11/oneko/mouse.xpm Linux Sunsite, you refer to those sites in an easy compact form using MASTER_SITE_XCONTRIB, MASTER_SITE_GNU, MASTER_SITE_PERL_CPAN, MASTER_SITE_TEX_CTAN, and - MASTER_SITE_SUNSITE. Simply set MASTER_SITE_SUBDIR to the - path with in the archive. Here is an example: + MASTER_SITE_SUNSITE. Simply set MASTER_SITE_SUBDIR to the + path with in the archive. Here is an example: MASTER_SITES= ${MASTER_SITE_XCONTRIB} @@ -1755,10 +1755,10 @@ MASTER_SITE_SUBDIR= applications If the patch is distributed with some other files, such as documentation, in a gzip'd tarball, you can't just use - PATCHFILES. If that is + PATCHFILES. If that is the case, add the name and the location of the patch tarball to DISTFILES and - MASTER_SITES. Then, from + MASTER_SITES. Then, from the pre-patch target, apply the patch either by running the patch command from there, or copying the patch file into the PATCHDIR directory and calling it @@ -1769,7 +1769,7 @@ MASTER_SITE_SUBDIR= applications regular source by then, so there is no need to explicitly extract it if it is a regular gzip'd or compress'd tarball. If you do the latter, take extra care not to overwrite - something that already exists in that directory. Also do + something that already exists in that directory. Also do not forget to add a command to remove the copied patch in the pre-clean target. @@ -1779,7 +1779,7 @@ MASTER_SITE_SUBDIR= applications <makevar>MAINTAINER</makevar> - Set your mail-address here. Please. :) + Set your mail-address here. Please. :) For detailed description of the responsibility of maintainers, refer to Dependencies - Many ports depend on other ports. There are five + Many ports depend on other ports. There are five variables that you can use to ensure that all the required - bits will be on the user's machine. There are also some + bits will be on the user's machine. There are also some pre-supported dependency variables for common cases, plus a few more to control the behaviour of dependencies. @@ -1802,12 +1802,12 @@ MASTER_SITE_SUBDIR= applications <makevar>LIB_DEPENDS</makevar> This variable specifies the shared libraries this port - depends on. It is a list of lib:dir:target tuples where + depends on. It is a list of lib:dir:target tuples where lib is the name of the shared library, and dir is the directory in which to find it in case it is not available, and target is the target to call in - that directory. For example, + that directory. For example, LIB_DEPENDS= jpeg\\.9\\.:${PORTSDIR}/graphics/jpeg:install @@ -1816,19 +1816,19 @@ LIB_DEPENDS= jpeg\\.9\\.:${PORTSDIR}/graphics/jpeg:install major version 9, and descend into the graphics/jpeg subdirectory of your ports tree to build and install it if it is not - found. The target part can be + found. The target part can be omitted if it is equal to DEPENDS_TARGET (which defaults to install). The lib part is an argument - given to ldconfig -r | grep -wF. There + given to ldconfig -r | grep -wF. There shall be no reqular expressions in this variable. The dependency is checked twice, once from within the extract target and then from within - the install target. Also, the name of the + the install target. Also, the name of the dependency is put in to the package so that pkg_add will automatically install it if it is not on the user's system. @@ -1839,12 +1839,12 @@ LIB_DEPENDS= jpeg\\.9\\.:${PORTSDIR}/graphics/jpeg:install <makevar>RUN_DEPENDS</makevar> This variable specifies executables or files this port - depends on during run-time. It is a list of path:dir:target tuples where + depends on during run-time. It is a list of path:dir:target tuples where path is the name of the executable or file, and dir is the directory in which to find it in case it is not available, and target is the target to call in - that directory. If + that directory. If path starts with a slash (/), it is treated as a file and its existence is tested with test -e; @@ -1861,7 +1861,7 @@ RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \ will check if the file or directory /usr/local/etc/innd exists, and build and install it from the news/inn - subdirectory of the ports tree if it is not found. It will + subdirectory of the ports tree if it is not found. It will also see if an executable called wish8.0 is in your search path, and descend into the x11-toolkits/tk80 subdirectory of your ports tree to build and install it if it is not @@ -1874,10 +1874,10 @@ RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \ use the full pathname. - The dependency is checked from within the install target. Also, the name of the + The dependency is checked from within the install target. Also, the name of the dependency is put in to the package so that pkg_add will automatically install it if it - is not on the user's system. The + is not on the user's system. The target part can be omitted if it is the same DEPENDS_TARGET. @@ -1887,7 +1887,7 @@ RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \ <makevar>BUILD_DEPENDS</makevar> This variable specifies executables or files this port - requires to build. Like RUN_DEPENDS, it is + requires to build. Like RUN_DEPENDS, it is a list of path:dir:target tuples. For example, @@ -1902,8 +1902,8 @@ BUILD_DEPENDS= unzip:${PORTSDIR}/archivers/unzip “build” here means everything from extracting to - compilation. The dependency is checked from within the - extract target. The + compilation. The dependency is checked from within the + extract target. The target part can be omitted if it is the same as DEPENDS_TARGET @@ -1913,8 +1913,8 @@ BUILD_DEPENDS= unzip:${PORTSDIR}/archivers/unzip <makevar>FETCH_DEPENDS</makevar> This variable specifies executables or files this port - requires to fetch. Like the previous two, it is a list of - path:dir:target tuples. For + requires to fetch. Like the previous two, it is a list of + path:dir:target tuples. For example, @@ -1926,7 +1926,7 @@ FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2 tree to build and install it if it is not found. The dependency is checked from within the - fetch target. The + fetch target. The target part can be omitted if it is the same as DEPENDS_TARGET. @@ -1938,8 +1938,8 @@ FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2 If there is a dependency that does not fall into either of the above four categories, or your port requires to have the source of the other port extracted in addition to having - them installed, then use this variable. This is a list of - dir:target, as there is nothing to check, unlike the previous four. The target part can be omitted if it is the same as DEPENDS_TARGET. + them installed, then use this variable. This is a list of + dir:target, as there is nothing to check, unlike the previous four. The target part can be omitted if it is the same as DEPENDS_TARGET. @@ -1947,15 +1947,15 @@ FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2 Define USE_XLIB=yes if your port requires the X Window System to be installed (it is implied by - USE_IMAKE). Define + USE_IMAKE). Define USE_GMAKE=yes if your port requires GNU make instead of BSD - make. Define + make. Define USE_AUTOCONF=yes if your port requires GNU - autoconf to be run. Define USE_QT=yes if - your port uses the latest qt toolkit. Use + autoconf to be run. Define USE_QT=yes if + your port uses the latest qt toolkit. Use USE_PERL5=yes if your port requires version - 5 of the perl language. (The last is especially important since + 5 of the perl language. (The last is especially important since some versions of FreeBSD has perl5 as part of the base system while others don't.) @@ -1965,25 +1965,25 @@ FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2 As mentioned above, the default target to call when a dependency is required is - DEPENDS_TARGET. It defaults to - install. This is a user variable; is is - never defined in a port's Makefile. If + DEPENDS_TARGET. It defaults to + install. This is a user variable; is is + never defined in a port's Makefile. If your port needs a special way to handle a dependency, use the :target part of the *_DEPENDS variables instead of redefining DEPENDS_TARGET. When you type make clean, its - dependencies are automatically cleaned too. If you do not wish + dependencies are automatically cleaned too. If you do not wish this to happen, define the variable NOCLEANDEPENDS in your environment. To depend on another port unconditionally, it is customary to use the string nonexistent as the first field of BUILD_DEPENDS or - RUN_DEPENDS. Use this only when you need to - the to get to the source of the other port. You can often save - compilation time by specifying the target too. For + RUN_DEPENDS. Use this only when you need to + the to get to the source of the other port. You can often save + compilation time by specifying the target too. For instance @@ -1992,10 +1992,10 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract will always descend to the JPEG port and extract it. Do not use DEPENDS unless there is no - other way the behaviour you want can be accomplished. It will + other way the behaviour you want can be accomplished. It will cause the other port to be always build (and installed, by default), and the dependency will go into the packages as - well. If this is really what you need, I recommend you + well. If this is really what you need, I recommend you write it as BUILD_DEPENDS and RUN_DEPENDS instead—at least the intention will be clear. @@ -2006,19 +2006,19 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract Building mechanisms If your package uses GNU make, set - USE_GMAKE=yes. If your package uses + USE_GMAKE=yes. If your package uses configure, set - HAS_CONFIGURE=yes. If your package uses GNU + HAS_CONFIGURE=yes. If your package uses GNU configure, set GNU_CONFIGURE=yes (this implies - HAS_CONFIGURE). If you want to give some + HAS_CONFIGURE). If you want to give some extra arguments to configure (the default argument list --prefix=${PREFIX} for GNU configure and empty for non-GNU configure), set those extra arguments in - CONFIGURE_ARGS. If your package uses GNU + CONFIGURE_ARGS. If your package uses GNU autoconf, set - USE_AUTOCONF=yes. This implies + USE_AUTOCONF=yes. This implies GNU_CONFIGURE, and will cause autoconf to be run before configure. @@ -2026,9 +2026,9 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract If your package is an X application that creates Makefiles from Imakefiles using imake, then set - USE_IMAKE=yes. This will cause the + USE_IMAKE=yes. This will cause the configure stage to automatically do an xmkmf - -a. If the flag is a + -a. If the flag is a problem for your port, set XMKMF=xmkmf. If the port uses imake but does not understand the @@ -2040,7 +2040,7 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract If your port's source Makefile has something else than all as the main build target, set ALL_TARGET - accordingly. Same goes for install and + accordingly. Same goes for install and INSTALL_TARGET. @@ -2049,7 +2049,7 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract Special considerations There are some more things you have to take into account when - you create a port. This section explains the most common of + you create a port. This section explains the most common of those. @@ -2068,7 +2068,7 @@ BUILD_DEPENDS= /nonexistent:${PORTSDIR}/graphics/jpeg:extract pair to your pkg/PLIST file so that a user who installed the package can start using teh shared libraru immediately and deinstallation will not cause the system to - still believe the library is there. These lines should + still believe the library is there. These lines should immediately follow the line for the shared library itself, as in: @@ -2080,10 +2080,10 @@ lib/libtvl80.so.1 Never, ever, ever add a line that says ldconfig without any arguments to your Makefile or - pkg/PLIST. This will reset the shared + pkg/PLIST. This will reset the shared libraru cache to the contents of /usr/lib only, and will royally screw up the user's machine ("Help, xinit - does not run anymore after I install this port!"). Anybody who + does not run anymore after I install this port!"). Anybody who does this will be shot and cut in 65,536 pieces by a rusty knife and have is liver chopped out by a bunch of crows and will eternally rot to death in the deepest bowels of hell (not @@ -2096,7 +2096,7 @@ lib/libtvl80.so.1 Since FreeBSD is moving to ELF shortly after 3.0-RELEASE, we need to convert many ports that build shared libraries - to support ELF. Complicating this task is that a 3.0 + to support ELF. Complicating this task is that a 3.0 system can run as both ELF and a.out, and we wish to unofficially support the 2.2 as long as possible. Below are the guidelines on how to convert a.out only ports to @@ -2112,7 +2112,7 @@ lib/libtvl80.so.1 A.out libraries should be moved out of /usr/local/lib and similar to an - aout subdirectory. (If you don't move them + aout subdirectory. (If you don't move them out of the way, ELF ports will happily overwrite a.out libraries.) The move-aout-libs target in the 3.0-CURRENT src/Makefile (called from @@ -2125,16 +2125,16 @@ lib/libtvl80.so.1 Format The ports tree will build packages in the format the machine - is in. This means a.out for 2.2 and a.out or ELF for 3.0 depending - on what `objformat` returns. Also, once users + is in. This means a.out for 2.2 and a.out or ELF for 3.0 depending + on what `objformat` returns. Also, once users move a.out libraries to a subdirectory, building a.out libraries - will be unsupported. (I.e., it may still work if you know what you + will be unsupported. (I.e., it may still work if you know what you are doing, but you are on your own.) If a port only works for a.out, set BROKEN_ELF to a string describing the reason - why. Such ports will be skipped during a build on an ELF + why. Such ports will be skipped during a build on an ELF system. @@ -2146,10 +2146,10 @@ lib/libtvl80.so.1 PORTOBJFORMAT to aout or elf and export it in the environments CONFIGURE_ENV, SCRIPTS_ENV and - MAKE_ENV. (It's always going to be + MAKE_ENV. (It's always going to be aout in 2.2-STABLE). It is also passed to PLIST_SUB as - PORTOBJFORMAT=${PORTOBJFORMAT}. (See comment + PORTOBJFORMAT=${PORTOBJFORMAT}. (See comment on ldconfig lines below.) The variable is set using this line in @@ -2159,7 +2159,7 @@ lib/libtvl80.so.1 PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout Ports' make processes should use this variable to decide what - to do. However, if the port's configure + to do. However, if the port's configure script already automatically detects an ELF system, it is not necessary to refer to PORTOBJFORMAT. @@ -2178,7 +2178,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

libfoo.so.M where M is the single version number, and an a.out library should be called - libfoo.so.M.N where M is the major version and N is the the minor version number. Do not mix those; never install an ELF shared library called libfoo.so.N.M or an a.out shared library (or symlink) called libfoo.so.N. + libfoo.so.M.N where M is the major version and N is the the minor version number. Do not mix those; never install an ELF shared library called libfoo.so.N.M or an a.out shared library (or symlink) called libfoo.so.N. @@ -2194,7 +2194,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

You need to install a symlink from libfoo.so to libfoo.so.N to - make ELF linkers happy. Since it should be listed in + make ELF linkers happy. Since it should be listed in PLIST too, and it won't hurt in the a.out case (some ports even require the link for dynamic loading), you should just make this link regardless of the setting of @@ -2206,7 +2206,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

All port Makefiles are edited to remove minor numbers from LIB_DEPENDS, and also to have the regexp - support removed. (E.g., foo\\.1\\.\\(33|40\\) + support removed. (E.g., foo\\.1\\.\\(33|40\\) becomes foo.2.) They will be matched using grep -wF. @@ -2216,7 +2216,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

PLIST should contain the short (ELF) shlib names if the a.out minor number is zero, and the long - (a.out) names otherwise. bsd.port.mk will + (a.out) names otherwise. bsd.port.mk will automatically add .0 to the end of short shlib lines if PORTOBJFORMAT equals aout, and will delete the minor number from @@ -2227,7 +2227,7 @@ PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout

NO_FILTER_SHLIBS. This will turn off the + NO_FILTER_SHLIBS. This will turn off the editing of PLIST mentioned in the previous paragraph. @@ -2259,16 +2259,16 @@ ${SETENV} OBJFORMAT=${PORTOBJFORMAT} ${LDCONFIG} -m .... packages by having a variable (for instance, resolution, or paper size) take different values, create one subdirectory per package to make it easier forusers to see what to do, but try to share as - many files as possible between ports. Typically you only need a + many files as possible between ports. Typically you only need a very short Makefile in all but one of the - directories if you use variables cleverly. In the sole + directories if you use variables cleverly. In the sole Makefiles, you can use MASTERDIR to specify the directory where the - rest of the files are. Also, use a variable as part of + rest of the files are. Also, use a variable as part of PKGNAME so the packages will have different names. - This will be best demonstrated by an example. This is part of + This will be best demonstrated by an example. This is part of japanese/xdvi300/Makefile; @@ -2284,7 +2284,7 @@ RESOLUTION?= 300 .endif japanese/xdvi300 also has all the regular - patches, package files, etc. If you type make + patches, package files, etc. If you type make there, it will take the default value for the resolution (300) and build the port normally. @@ -2299,12 +2299,12 @@ MASTERDIR= ${.CURDIR}/../xdvi300 .include ${MASTERDIR}/Makefile (xdvi240/Makefile and - xdvi400/Makefile are similar). The + xdvi400/Makefile are similar). The MASTERDIR definition tells bsd.port.mk that the refulat set of subdirectories like PATCHDIR and PKGDIR are to be found under - xdvi300. The + xdvi300. The RESOLUTION=118 line will override the RESOLUTION=300 line in xdvi300/Makefile and the port will be built @@ -2316,31 +2316,31 @@ MASTERDIR= ${.CURDIR}/../xdvi300 First, please read our policy on shared library versioning to understand - what to do with shared library versions in general. Do + what to do with shared library versions in general. Do not blindly assume software authors know what they are - doing; many of them do not. It is very important that + doing; many of them do not. It is very important that these details are carefully considered, as we have quite a unique situation where we are trying to have dozens of potentially incompatible software pairs co-exist. Careless port imports have caused great trouble regarding shared libraries in the past (ever wondered why the port jpeg-6b has a shared library version of 9.0?). - If in doubt, send a message to the &a.ports;. Most of the + If in doubt, send a message to the &a.ports;. Most of the time, your job ends by determining the right shared library version and making appropriate patches to implement it. However, if there is a port which is a different version of the same software already in the tree, the situation is - much more complex. In short, the FreeBSD implementation + much more complex. In short, the FreeBSD implementation does not allow the user to specify to the linker which version of shared library to link against (the linker will - always pick the highest numbered version). This means, if + always pick the highest numbered version). This means, if there is a libfoo.so.3.2 and libfoo.so.4.0 in the system, there is no way to tell the linker to link a - particular application to libfoo.so.3.2. It is + particular application to libfoo.so.3.2. It is essentially completely overshadowed in terms of - compilation-time linkage. In this case, the only solution + compilation-time linkage. In this case, the only solution is to rename the base part of the shared library. For instance, change libfoo.so.4.0 to libfoo4.so.1.0 so both version 3.2 and 4.0 can be @@ -2354,7 +2354,7 @@ MASTERDIR= ${.CURDIR}/../xdvi300 add any manpages to pkg/PLIST (this means you must not list manpages in the PLIST—see generating PLIST for more). It + linkend="porting-plist">generating PLIST for more). It also makes the install stage automatically compress or uncompress manpages depending on the setting of NOMANCOMPRESS in @@ -2418,7 +2418,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz There are many programs that require a Motif library (available from several commercial vendors, while there is a free clone reported to be able to run many applications in - x11-toolkits/lesstif) to compile. Since + x11-toolkits/lesstif) to compile. Since it is a popular toolkit and their licenses usually permit redistribution of statically linked binaries, we have made special provisions for handling ports that require Motif in a @@ -2430,7 +2430,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz <makevar>REQUIRES_MOTIF</makevar> If your port requires Motif, define this variable in the - Makefile. This will prevent people who don't own a copy of + Makefile. This will prevent people who don't own a copy of Motif from even attempting to build it. @@ -2439,7 +2439,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz This variable will be set by bsd.port.mk to be the appropriate reference - to the Motif library. Please patch the source to use this + to the Motif library. Please patch the source to use this wherever the Motif library is referenced in the Makefile or Imakefile. @@ -2473,7 +2473,7 @@ ${PREFIX}/man/ja/man4/baz.4.gz If your port installs fonts for the X Window system, put them in X11BASE/lib/X11/fonts/local. - This directory is new to XFree86 release 3.3.3. If it does not + This directory is new to XFree86 release 3.3.3. If it does not exist, please create it, and print out a message urging the user to update their XFree86 to 3.3.3 or newer, or at least add this directory to the font path in @@ -2485,12 +2485,12 @@ ${PREFIX}/man/ja/man4/baz.4.gz The new version of texinfo (included in 2.2.2-RELEASE and onwards) contains a utility called install-info - to add and delete entries to the dir file. If + to add and delete entries to the dir file. If your port installs any info documents, please follow this instructions so your port/package will correctly update the user's PREFIX/info/dir - file. (Sorry for the length of this section, but is it imperative - to weave all the info files together. If done correctly, it will + file. (Sorry for the length of this section, but is it imperative + to weave all the info files together. If done correctly, it will produce a beautiful listing, so please bear with me! @@ -2517,14 +2517,14 @@ Options: Here's a seven-step procedure to convert ports to use - install-info. I will use + install-info. I will use editors/emacs as an example. Look at the texinfo sources and make a patch to insert @dircategory and @direntry - statements to files that don't have them. This is part of + statements to files that don't have them. This is part of my patch: @@ -2543,10 +2543,10 @@ Options: @finalout : - The format should be self-explanatory. Many authors + The format should be self-explanatory. Many authors leave a dir file in the source tree that contains all the entries you need, so look around - before you try to write your own. Also, make sure you + before you try to write your own. Also, make sure you look into related ports and make the section names and entry indentations consistent (we recommend that all entry text start at the 4th tab stop). @@ -2563,15 +2563,15 @@ Options: entries to install-info as arguments ( and ) instead of patching the texinfo - sources. I do not think this is a good idea for ports + sources. I do not think this is a good idea for ports because you need to duplicate the same information in three places (Makefile and @exec/@unexec of - PLIST; see below). However, if you + PLIST; see below). However, if you have a Japanese (or other multibyte encoding) info files, you will have to use the extra arguments to install-info because makeinfo can't handle those texinfo - sources. (See Makefile and + sources. (See Makefile and PLIST of japanese/skk for examples on how to do this). @@ -2583,7 +2583,7 @@ Options: Since the texinfo sources are newer than the info files, they should be rebuilt when you type make; but many Makefiles don't include correct - dependencies for info files. In emacs' case, I had to + dependencies for info files. In emacs' case, I had to patch the main Makefile.in so it will descend into the man subdirectory to rebuild the info pages. @@ -2614,7 +2614,7 @@ Options: The second hunk was necessary because the default target in the man subdir is called info, while the main - Makefile wants to call all. I also deleted the installation + Makefile wants to call all. I also deleted the installation of the info info file because we already have one with the same name in /usr/share/info (that patch is not @@ -2624,8 +2624,8 @@ Options: If there is a place in the Makefile that is installing the - dir file, delete it. Your - port may not be doing it. Also, remove any commands that + dir file, delete it. Your + port may not be doing it. Also, remove any commands that are otherwise mucking around with the dir file. @@ -2653,7 +2653,7 @@ Options: (This step is only necessary if you are modifying an existing port.) Take a look at pkg/PLIST and delete anything that is - trying to patch up info/dir. They + trying to patch up info/dir. They may be in pkg/INSTALL or some other file, so search extensively. @@ -2680,7 +2680,7 @@ diff -u -r1.15 PLIST Add a post-install target to the Makefile to create a - dir file if it is not there. Also, + dir file if it is not there. Also, call install-info with the installed info files. @@ -2708,7 +2708,7 @@ diff -u -r1.26 Makefile Do not use anything other than /usr/share/info/dir and the above - command to create a new info file. In fact, I'd add the + command to create a new info file. In fact, I'd add the first three lines of the above patch to bsd.port.mk if you (the porter) wouldn't have to do it in PLIST by @@ -2760,7 +2760,7 @@ diff -u -r1.15 PLIST - Test and admire your work. :). Check the dir file before and after each + Test and admire your work. :). Check the dir file before and after each step. @@ -2778,14 +2778,14 @@ diff -u -r1.15 PLIST <filename>MESSAGE</filename> If you need to display a message to the installer, you may - place the message in pkg/MESSAGE. This + place the message in pkg/MESSAGE. This capability is often useful to display additional installation steps to be taken after a pkg_add or to display licensing information. The pkg/MESSAGE file does not need to - be added to pkg/PLIST. Also, it will not get + be added to pkg/PLIST. Also, it will not get automatically printed if the user is using the port, not the package, so you should probably display it from the post-install target yourself. @@ -2797,13 +2797,13 @@ diff -u -r1.15 PLIST If your port needs to execute commands when the binary package is installed with pkg_add you can do this via the - pkg/INSTALL script. This script will + pkg/INSTALL script. This script will automatically be added to the package, and will be run twice by - pkg_add. The first time will as + pkg_add. The first time will as INSTALL ${PKGNAME} PRE-INSTALL and the second time as INSTALL ${PKGNAME} - POST-INSTALL. $2 can be - tested to determine which mode the script is being run in. The + POST-INSTALL. $2 can be + tested to determine which mode the script is being run in. The PKG_PREFIX environmental variable will be set to the package installation directory. See pkg_add @@ -2823,7 +2823,7 @@ diff -u -r1.15 PLIST If your port needs to determine if it should install or not, you can create a pkg/REQ - “requirements” script. It will be invoked + “requirements” script. It will be invoked automatically at installation/deinstallation time to determine whether or not installation/deinstallation should proceed. @@ -2833,13 +2833,13 @@ diff -u -r1.15 PLIST Some ports, particularly the p5- ports, need to change their PLIST depending on what options they are - configured with (or version of perl, in the case of p5- ports). To + configured with (or version of perl, in the case of p5- ports). To make this easy, any instances in the PLIST of %%OSREL%%, %%PERL_VER%%, and %%PERL_VERSION%% will be substituted for - appropriately. The value of %%OSREL%% is the + appropriately. The value of %%OSREL%% is the numeric revision of the operating system (e.g., - 2.2.7). %%PERL_VERSION%% is + 2.2.7). %%PERL_VERSION%% is the full version number of perl (e.g., 5.00502) and %%PERL_VER%% is the perl version number minus the patchlevel (e.g., 5.005). @@ -2886,7 +2886,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} All the filenames in the pkg subdirectory are defined using variables so you can change them in your - Makefile if need be. This is especially useful when you + Makefile if need be. This is especially useful when you are sharing the same pkg subdirectory among several ports or have to write to one of the above files (see writing to places other than @@ -2946,7 +2946,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} Please change these variables rather than overriding - PKG_ARGS. If you change + PKG_ARGS. If you change PKG_ARGS, those files will not correctly be installed in /var/db/pkg upon install from a port. @@ -2958,7 +2958,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} Some software packages have restrictive licenses or can be in violation to the law (PKP's patent on public key crypto, ITAR - (export of crypto software) to name just two of them). What we + (export of crypto software) to name just two of them). What we can do with them varies a lot, depending on the exact wordings of the respective licenses. @@ -2967,7 +2967,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} licensing terms of the software and make sure that the FreeBSD project will not be held accountable of violating them by redistributing the source or compiled binaries either via ftp - or CD-ROM. If in doubt, please contact the &a.ports;. + or CD-ROM. If in doubt, please contact the &a.ports;. There are two variables you can set in the Makefile to @@ -2979,9 +2979,9 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} If the port has a “do not sell for profit” type of license, set the variable NO_CDROM to a - string describing the reason why. We + string describing the reason why. We will make sure such ports won't go into the CD-ROM come - release time. The distfile and package will still be + release time. The distfile and package will still be available via ftp. @@ -2990,9 +2990,9 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} for each site, or the resulting binary package can't be distributed due to licensing; set the variable NO_PACKAGE to a string describing the - reason why. We will make sure such + reason why. We will make sure such packages won't go on the ftp site, nor into the CD-ROM - come release time. The distfile will still be included on + come release time. The distfile will still be included on both however. @@ -3000,7 +3000,7 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} If the port has legal restrictions on who can use it (e.g., crypto stuff) or has a “no commercial use” license, set the variable RESTRICTED to be the - string describing the reason why. For such ports, the + string describing the reason why. For such ports, the distfiles/packages will not be available even from our ftp sites. @@ -3024,12 +3024,12 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} When you notice that a port is out of date compared to the latest version from the original authors, first make sure you - have the latest port. You can find them in the + have the latest port. You can find them in the ports/ports-current directory of the ftp mirror sites. The next step is to send a mail to the maintainer, if one is - listed in the port's Makefile. That person may already be + listed in the port's Makefile. That person may already be working on an upgrade, or have a reason to not upgrade the port right now (because of, for example, stability problems of the new version). @@ -3043,12 +3043,12 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} and the original as in our tree is superedit.bak, then send us the result of diff -ruN superedit.bak - superedit). Please examine the output to make - sure all the changes make sense. The best way to send us the + superedit). Please examine the output to make + sure all the changes make sense. The best way to send us the diff is by including it to send-pr1 - (category ports). Please mention any added or deleted files + (category ports). Please mention any added or deleted files in the message, as they have to be explicitly specified to CVS - when doing a commit. If the diff is more than about 20KB, please + when doing a commit. If the diff is more than about 20KB, please compress and uuencode it; otherwise, just include it in as is in the PR. @@ -3062,18 +3062,18 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION} Here is a list of common do's and dont's that you encounter during the porting process.You should check your own port against this list, but you can also check ports in the PR - database that others have submitted. Submit any comments on + database that others have submitted. Submit any comments on ports you check as described in Bug - Reports and General Commentary. Checking ports in + Reports and General Commentary. Checking ports in the PR database will both make it faster for us to commit them, and prove that you know what you are doing. Strip Binaries - Do strip binaries. If the original source already strips the + Do strip binaries. If the original source already strips the binaries, fine; otherwise you should add a - post-install rule to to it yourself. Here is an + post-install rule to to it yourself. Here is an example; @@ -3084,7 +3084,7 @@ post-install: file 1 command on the installed executable to check - whether the binary is stripped or not. If it does not say + whether the binary is stripped or not. If it does not say not stripped, it is stripped. @@ -3127,10 +3127,10 @@ post-install: <makevar>WRKDIR</makevar> Do not write anything to files outside - WRKDIR. WRKDIR is the only + WRKDIR. WRKDIR is the only place that is guaranteed to be writable during the port build (see compiling ports from CDROM for an - example of building ports from a read-only tree). If you need to + example of building ports from a read-only tree). If you need to modigy some file in PKGDIR, do so by redefining a variable, not by writing over it. @@ -3140,8 +3140,8 @@ post-install: <makevar>WRKDIRPREFIX</makevar> Make sure your port honors - WRKDIRPREFIX. Most ports don't have to worry - about this. In particular, if you are referring to a + WRKDIRPREFIX. Most ports don't have to worry + about this. In particular, if you are referring to a WRKDIR of another port, note that the correct location is WRKDIRPREFIXPORTSDIR/subdir/name/work not PORTSDIR/subdir/name/work or .CURDIR/../../subdir/name/work or some such. @@ -3157,7 +3157,7 @@ post-install: You may come across code that needs modifications or conditional compilation based upon what version of UNIX it is - running under. If you need to make such changes to the code for + running under. If you need to make such changes to the code for conditional compilation, make sure you make the changes as general as possible so that we can back-port code to FreeBSD 1.x systems and cross-port to other BSD systems such as 4.4BSD from CSRG, @@ -3166,7 +3166,7 @@ post-install: The preferred way to tell 4.3BSD/Reno (1990) and newer versions of the BSD code apart is by using the BSD macro defined in - <sys/param.h>. Hopefully that file is + <sys/param.h>. Hopefully that file is already included; if not, add the code: @@ -3174,10 +3174,10 @@ post-install: #include <sys/param.h> #endif - to the proper place in the .c file. We + to the proper place in the .c file. We believe that every system that defines these two symbols has - sys/param.h. If you find a system that - doesn't, we would like to know. Please send mail to the + sys/param.h. If you find a system that + doesn't, we would like to know. Please send mail to the &a.ports;. Another way is to use the GNU Autoconf style of doing @@ -3212,10 +3212,10 @@ post-install: above). The value of the BSD macro is - 199506 for the 4.4BSD-Lite2 code base. This is - stated for informational purposes only. It should not be used to + 199506 for the 4.4BSD-Lite2 code base. This is + stated for informational purposes only. It should not be used to distinguish between versions of FreeBSD based only on 4.4-Lite vs. - versions that have merged in changes from 4.4-Lite2. The + versions that have merged in changes from 4.4-Lite2. The __FreeBSD__ macro should be used instead. @@ -3226,8 +3226,8 @@ post-install: __FreeBSD__ is defined in all - versions of FreeBSD. Use it if the change you are making - only affects FreeBSD. Porting gotchas like the use of + versions of FreeBSD. Use it if the change you are making + only affects FreeBSD. Porting gotchas like the use of sys_errlist[] vs strerror() are Berkeleyisms, not FreeBSD changes. @@ -3235,8 +3235,8 @@ post-install: In FreeBSD 2.x, __FreeBSD__ is - defined to be 2. In earlier - versions, it is 1. Later + defined to be 2. In earlier + versions, it is 1. Later versions will bump it to match their major version number. @@ -3244,12 +3244,12 @@ post-install: If you need to tell the difference between a FreeBSD 1.x system and a FreeBSD 2.x or 3.x system, usually the right answer is to use the BSD macros - described above. If there actually is a FreeBSD specific + described above. If there actually is a FreeBSD specific change (such as special shared library options when using ld) then it is OK to use __FreeBSD__ and #if __FreeBSD__ > 1 to detect a FreeBSD 2.x - and later system. If you need more granularity in + and later system. If you need more granularity in detecting FreeBSD systems since 2.0-RELEASE you can use the following: @@ -3463,12 +3463,12 @@ post-install: Note that 2.2-STABLE sometimes identifies itself as - “2.2.5-STABLE” after the 2.2.5-RELEASE. The pattern used to + “2.2.5-STABLE” after the 2.2.5-RELEASE. The pattern used to be year followed by the month, but we decided to change it to a more straightforward major/minor system starting from - 2.2. This is because the parallel development on several + 2.2. This is because the parallel development on several branches made it infeasible to classify the releases simply - by their real release dates. If you are making a port now, + by their real release dates. If you are making a port now, you don't have to worry about old -CURRENTs; they are listed here just for your reference. @@ -3476,7 +3476,7 @@ post-install: In the hundreds of ports that have been done, there have only been one or two cases where __FreeBSD__ - should have been used. Just because an earlier port screwed up + should have been used. Just because an earlier port screwed up and used it in the wrong place does not mean you should do so too. @@ -3486,7 +3486,7 @@ post-install: bsd.port.mk Do not write anything after the .include - <bsd.port.mk> line. it usually can be avoided by + <bsd.port.mk> line. it usually can be avoided by including bsd.port.pre.mk somewhere in the middle of your Makefile and bsd.port.post.mk at the end. @@ -3609,11 +3609,11 @@ post-install: If your software has some documentation other than the standard man and info pages that you think is useful for the user, install it under - PREFIX/share/doc. This can be + PREFIX/share/doc. This can be done, like the previous item, in the post-install target. - Create a new directory for your port. The directory name - should reflect what the port is. This usually means PKGNAME minus the version part. + Create a new directory for your port. The directory name + should reflect what the port is. This usually means PKGNAME minus the version part. However, if you think the user might want different versions of the port to be installed at the same time, you can use the whole PKGNAME. @@ -3636,7 +3636,7 @@ post-install: /etc/make.conf.) Also you can use the pkg/MESSAGE file to - display messages upon installation. See the using pkg/MESSAGE section for details. @@ -3651,12 +3651,12 @@ post-install: <makevar>DIST_SUBDIR</makevar> Do not let your port clutter - /usr/ports/distfiles. If your port + /usr/ports/distfiles. If your port requires a lot of files to be fetched, or contains a file that has a name that might conflict with other ports (e.g., Makefile), set DIST_SUBDIR to the name of the port (PKGNAME without the - version part should work fine). This will change DISTDIR from the default + version part should work fine). This will change DISTDIR from the default /usr/ports/distfiles to /usr/ports/distfiles/DIST_SUBDIR, and in effect puts everything that is required for your port @@ -3664,7 +3664,7 @@ post-install: It will also look at the subdirectory with the same name on the backup master site at - ftp.freebsd.org. (Setting DISTDIR explicitly in your + ftp.freebsd.org. (Setting DISTDIR explicitly in your Makefile will not accomplish this, so please use DIST_SUBDIR.) @@ -3691,10 +3691,10 @@ post-install: RCS strings - Do not put RCS strings in patches. CVS will mangle them + Do not put RCS strings in patches. CVS will mangle them when we put the files into the ports tree, and when we check them out again, they will come out different and the patch - will fail. RCS strings are surrounded by dollar ($) signs, and typically start with + will fail. RCS strings are surrounded by dollar ($) signs, and typically start with $Id or $RCS. @@ -3705,10 +3705,10 @@ post-install: Using the recurse () option to diff to generate patches is fine, but please take a look at the resulting patches to make - sure you don't have any unnecessary junk in there. In + sure you don't have any unnecessary junk in there. In particular, diffs between two backup files, Makefiles when the port uses Imake or GNU configure, etc., are unnecessary and - should be deleted. If you had to edit + should be deleted. If you had to edit configure.in and run autoconf to regenerate configure, do not take the diffs of @@ -3718,7 +3718,7 @@ post-install: Also, if you had to delete a file, then you can do it in the post-extract - target rather than as part of the patch. Once you are happy + target rather than as part of the patch. Once you are happy with the resulting diff, please split it up into one source file per patch file. @@ -3727,7 +3727,7 @@ post-install: <makevar>PREFIX</makevar> - Do try to make your port install relative to PREFIX. (The value of this + Do try to make your port install relative to PREFIX. (The value of this variable will be set to LOCALBASE (default /usr/local), unless USE_X_PREFIX or USE_IMAKE is set, in which case it will be X11BASE (default @@ -3736,7 +3736,7 @@ post-install: Not hard-coding /usr/local or /usr/X11R6 anywhere in the source will make the port much more flexible and able to cater to the - needs of other sites. For X ports that use imake, this is + needs of other sites. For X ports that use imake, this is automatic; otherwise, this can often be done by simply replacing the occurrences of /usr/local (or /usr/X11R6 for X ports that do not @@ -3751,12 +3751,12 @@ post-install: The variable PREFIX can be reassigned in your Makefile or in the user's - environment. However, it is strongly discouraged for + environment. However, it is strongly discouraged for individual ports to set this variable explicitly in the Makefiles. Also, refer to programs/files from other ports with the - variables mentioned above, not explicit pathnames. For + variables mentioned above, not explicit pathnames. For instance, if your port requires a macro PAGER to be the full pathname of less, use the compiler flag: @@ -3776,22 +3776,22 @@ post-install: Subdirectories Try to let the port put things in the right subdirectories - of PREFIX. Some ports + of PREFIX. Some ports lump everything and put it in the subdirectory with the port's - name, which is incorrect. Also, many ports put everything + name, which is incorrect. Also, many ports put everything except binaries, header files and manual pages in the a subdirectory of lib, which does not - bode well with the BSD paradigm. Many of the files should be + bode well with the BSD paradigm. Many of the files should be moved to one of the following: etc (setup/configuration files), libexec (executables started internally), sbin (executables for superusers/managers), info (documentation for info browser) or share (architecture independent - files). See man hier7 for + files). See man hier7 for details, the rules governing /usr pretty - much apply to /usr/local too. The - exception are ports dealing with USENET “news”. They may use + much apply to /usr/local too. The + exception are ports dealing with USENET “news”. They may use PREFIX/news as a destination for their files. @@ -3801,9 +3801,9 @@ post-install: Cleaning up empty directories Do make your ports clean up after themselves when they are - deinstalled. This is usually accomplished by adding + deinstalled. This is usually accomplished by adding @dirrm lines for all directories that are - specifically created by the port. You need to delete + specifically created by the port. You need to delete subdirectories before you can delete parent directories. @@ -3816,7 +3816,7 @@ lib/X11/oneko/sounds/cat.au @dirrm lib/X11/oneko However, sometimes @dirrm will give you - errors because other ports also share the same subdirectory. You + errors because other ports also share the same subdirectory. You can call rmdir from @unexec to remove only empty directories without warning. @@ -3836,16 +3836,16 @@ lib/X11/oneko/sounds/cat.au If your port requires a certain user to be on the installed system, let the pkg/INSTALL script call pw to create it - automatically. Look at net/cvsup-mirror + automatically. Look at net/cvsup-mirror for an example. If your port must use the same user/group ID number when it is installed a binarypackage as when it was compiled, then you mus - choose a free UID from 50 to 99 and register it below. Look at + choose a free UID from 50 to 99 and register it below. Look at japanese/Wnn for an example. Make sure you don't use a UID already used by the system - or other ports. This is the current list of UIDs between 50 + or other ports. This is the current list of UIDs between 50 and 99. @@ -3869,7 +3869,7 @@ qmailr:*:86:82:QMail user:/var/qmail:/nonexistent msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh Please include a notice when you submit a port (or an - upgrade) that reserves a new UID or GID in this range. This allows + upgrade) that reserves a new UID or GID in this range. This allows us to keep the list of reserved IDs up to date. @@ -3893,7 +3893,7 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh Respect <makevar>CFLAGS</makevar> The port should respect the CFLAGS - variable. If it doesn't, please add NO_PACKAGE=ignores + variable. If it doesn't, please add NO_PACKAGE=ignores cflags to the Makefile. @@ -3903,7 +3903,7 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh If your port requires some configuration files in PREFIX/etc, do not just install them and list them in - pkg/PLIST. That will cause + pkg/PLIST. That will cause pkg_delete to delete files carefully edited by the user and a new installation to wipe them out. @@ -3927,7 +3927,7 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh Feedback Do send applicable changes/patches to the original - author/maintainer for inclusion in next release of the code. This + author/maintainer for inclusion in next release of the code. This will only make your job that much easier for the next release. @@ -3937,7 +3937,7 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh The files pkg/DESCR, pkg/COMMENT, and - pkg/PLIST should each be double-checked. If + pkg/PLIST should each be double-checked. If you are reviewing a port and feel they can be worded better, do so. @@ -3965,13 +3965,13 @@ msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh A Sample <filename>Makefile</filename> Here is a sample Makefile that you can - use to create a new port. Make sure you remove all the extra + use to create a new port. Make sure you remove all the extra comments (ones between brackets)! It is recommended that you follow this format (ordering of - variables, empty lines between sections, etc.). This format is + variables, empty lines between sections, etc.). This format is designed so that the most important information is easy to - locate. We recommend that you use portlint to check the Makefile. @@ -4060,7 +4060,7 @@ pre-install: Package Names The following are the conventions you should follow in - naming your packages. This is to have our package directory + naming your packages. This is to have our package directory easy to scan, as there are already lots and lots of packages and users are going to turn away if they hurt their eyes! @@ -4075,9 +4075,9 @@ pre-install: FreeBSD strives to support the native language of its - users. The language- part should be a two letter + users. The language- part should be a two letter abbreviation of the natural language defined by ISO-639 if - the port is specific to a certain language. Examples are + the port is specific to a certain language. Examples are ja for Japanese, ru for Russian, vi for Vietnamese, zh for Chinese, ko for Korean and de for German. @@ -4085,17 +4085,17 @@ pre-install: The name part should be all lowercases, except for a really large - package (with lots of programs in it). Things like + package (with lots of programs in it). Things like XFree86 (yes there really is a port of it, check it - out) and ImageMagick fall into this category. Otherwise, + out) and ImageMagick fall into this category. Otherwise, convert the name (or at least the first letter) to - lowercase. If the capital letters are + lowercase. If the capital letters are important to the name (for example, with one-letter names like R or V) you may use capital letters at your discretion. There is a tradition of naming Perl 5 modules by prepending p5- and converting the double-colon separator to a hyphen; for example, the Data::Dumper module becomes - p5-Data-Dumper. If the software in question has numbers, + p5-Data-Dumper. If the software in question has numbers, hyphens, or underscores in its name, you may include them as well (like kinput2). @@ -4105,13 +4105,13 @@ pre-install: defaults (usually part of the directory name in a family of ports), the -compiled.specifics part should state the - compiled-in defaults (the hyphen is optional). Examples + compiled-in defaults (the hyphen is optional). Examples are papersize and font units. The version string should be a period-separated list - of integers and single lowercase alphabetics. The only + of integers and single lowercase alphabetics. The only exception is the string pl (meaning `patchlevel'), which can be used only when there are no major and minor version numbers in the software. @@ -4226,7 +4226,7 @@ pre-install: If there is absolutely no trace of version information in the original source and it is unlikely that the original author will ever release another version, just set the version string - to 1.0 (like the piewm example above). Otherwise, ask the + to 1.0 (like the piewm example above). Otherwise, ask the original author or use the date string (yy.mm.dd) as the version. @@ -4236,14 +4236,14 @@ pre-install: Categories As you already know, ports are classified in several - categories. But for this to wor, it is important that porters and + categories. But for this to wor, it is important that porters and users understand what each category and how we deicde what to put in each category. Current list of categories - First, this is the current list of port categories. Those + First, this is the current list of port categories. Those marked with an asterisk (*) are virtual categories—those that do not have a corresponding subdirectory in the ports tree. @@ -4307,7 +4307,7 @@ pre-install: comms - Communication software. Mostly software to talk to + Communication software. Mostly software to talk to your serial port. @@ -4329,7 +4329,7 @@ pre-install: devel - Development utilities. Do not put libraries here just + Development utilities. Do not put libraries here just because they are libraries—unless they truly don't belong to anywhere else, they shouldn't be in this category. @@ -4337,7 +4337,7 @@ pre-install: editors - General editors. Specialized editors go in the + General editors. Specialized editors go in the section for those tools (e.g., a mathematical-formula editor will go in math). @@ -4349,7 +4349,7 @@ pre-install: emulators - Emulators for other operating systems. Terminal + Emulators for other operating systems. Terminal emulators do not belong here—X-based ones should go to x11 and text-based ones to either @@ -4412,9 +4412,9 @@ pre-install: misc Miscellaneous utilities—basically things that - doesn't belong to anywhere else. This is the only category + doesn't belong to anywhere else. This is the only category that should not appear with any other non-virtual - category. If you have misc with + category. If you have misc with something else in your CATEGORIES line, that means you can safely delete misc and just put the port in that other subdirectory! @@ -4452,7 +4452,7 @@ pre-install: print - Printing software. Desktop publishing tools + Printing software. Desktop publishing tools (previewers, etc.) belong here too. @@ -4503,7 +4503,7 @@ pre-install: textproc - Text processing utilities. It does not include + Text processing utilities. It does not include desktop publishing tools, which go to print/. @@ -4540,7 +4540,7 @@ pre-install: www - Software related to the World Wide Web. HTML language + Software related to the World Wide Web. HTML language support belong here too. @@ -4551,7 +4551,7 @@ pre-install: Do not put regular X applications here. If your port is an X application, define USE_XLIB (implied by USE_IMAKE) and put it in - appropriate categories. Also, many of them go into other + appropriate categories. Also, many of them go into other x11-* categories (see below). @@ -4589,21 +4589,21 @@ pre-install: As many of the categories overlap, you often have to choose which of the categories should be the primary category of your - port. There are several rules that govern this usse. Here is the + port. There are several rules that govern this usse. Here is the list of priorities, in decreasing order of precedence. - Language specific categories alwasys come first. For + Language specific categories alwasys come first. For example, if your port installs Japanese X11 fonts, then your CATEGORIES line would read japanese x11. - Specific categories win over less-specific ones. For + Specific categories win over less-specific ones. For instance, an HTML editor should be listed as www - editors, not the other way around. Also, you don't + editors, not the other way around. Also, you don't need to list net when the port belongs to either of mail, mbone, news, security, or @@ -4612,7 +4612,7 @@ pre-install: x11 is used as a secondary category - only when the primary category is a natural language. In + only when the primary category is a natural language. In particular, you should not put x11 in the category line for X applications. @@ -4625,7 +4625,7 @@ pre-install: If you are not sure about the category, please put a comment to that effect in your send-pr submission so we - can discuss it before import it. (If you are a committer, send a + can discuss it before import it. (If you are a committer, send a note &a.ports; so we can discuss it first—too often new ports are imported to a wrong category only to be moved right away.) @@ -4636,8 +4636,8 @@ pre-install: Changes to this document and the ports system If you maintain a lot of ports, you should consider following - the &a.ports;. Important changes to - the way ports work will be announced there. You can always + the &a.ports;. Important changes to + the way ports work will be announced there. You can always find more detailed information on the latest changes by looking at