diff options
Diffstat (limited to 'distrib/notes/m4.common')
| -rw-r--r-- | distrib/notes/m4.common | 146 |
1 files changed, 73 insertions, 73 deletions
diff --git a/distrib/notes/m4.common b/distrib/notes/m4.common index 3f4e6fa804b..b020c3e20ff 100644 --- a/distrib/notes/m4.common +++ b/distrib/notes/m4.common @@ -1,5 +1,5 @@ dnl -dnl $OpenBSD: m4.common,v 1.70 2007/02/28 22:30:02 miod Exp $ +dnl $OpenBSD: m4.common,v 1.71 2007/03/01 19:24:43 miod Exp $ dnl dnl Copyright (c) 2004 Todd T. Fries <todd@OpenBSD.org> dnl @@ -116,10 +116,10 @@ dnl Describes baseXX.tgz. Put ``shared'' as third argument if shared libraries dnl are available. dnl define({:-OpenBSDbase-:}, -{:- base{:--:}OSrev The OpenBSD/MACHINE OSREV base binary distribution. You - MUST install this distribution set. It contains the - base OpenBSD utilities that are necessary for the - system to run and be minimally functional. +{:- base{:--:}OSrev The OpenBSD/MACHINE OSREV base binary distribution. You MUST + install this distribution set. It contains the base OpenBSD + utilities that are necessary for the system to run and be + minimally functional. ifelse(X$3,Xshared,{:-It includes shared library support, and excludes everything described below.-:},{:-It excludes everything described below.-:})showsize($1,$2)-:})dnl dnl @@ -129,15 +129,15 @@ dnl Describes compXX.tgz. Put ``shared'' as third argument if shared libraries dnl are available. dnl define({:-OpenBSDcomp-:}, -{:- comp{:--:}OSrev The OpenBSD/MACHINE Compiler tools. All of the tools - relating to C, C++, and fortran are supported. This set - includes the system {:-include-:} files (/usr/{:-include-:}), the - linker, the compiler tool chain, and the various system - libraries{:--:}ifelse(X$3,Xshared,{:- (except the shared libraries, which are - included as part of the base set).-:},.) - This set also includes the manual pages for all - of the utilities it contains, as well as the system - call and library manual pages.showsize($1,$2)-:})dnl +{:- comp{:--:}OSrev The OpenBSD/MACHINE Compiler tools. All of the tools relating + to C, C++, Objective-F and Fortran are supported. This set + includes the system {:-include-:} files (/usr/{:-include-:}), the linker, + the compiler tool chain, and the various system libraries{:--:}ifelse(X$3,Xshared,{:- + (except the shared libraries, which are included as part of + the base set).-:},.) + This set also includes the manual pages for all of the + utilities it contains, as well as the system call and library + manual pages.showsize($1,$2)-:})dnl dnl dnl dnl OpenBSDetc( compressed size, uncompressed size [, noupgrade]) @@ -148,7 +148,7 @@ define({:-OpenBSDetc-:}, files that reside in /etc and in several other places. This set MUST be installed{:--:}ifelse(X$3,X,{:- if you are installing the system from scratch, but should NOT be used if you are - upgrading. (If you are upgrading, it's recommended that + upgrading. (If you are upgrading, it's recommended that you get a copy of this set and CAREFULLY upgrade your configuration files by hand; see the section named Upgrading a previously-installed OpenBSD System" below.)-:},.)showsize($1,$2)-:})dnl @@ -165,8 +165,8 @@ dnl OpenBSDman( compressed size, uncompressed size ) dnl Describes manXX.tgz. dnl define({:-OpenBSDman-:}, -{:- man{:--:}OSrev This set includes all of the manual pages for the - binaries and other software contained in the base set. +{:- man{:--:}OSrev This set includes all of the manual pages for the binaries + and other software contained in the base set. Note that it does not {:-include-:} any of the manual pages that are included in the other sets.showsize($1,$2)-:})dnl dnl @@ -175,8 +175,8 @@ dnl OpenBSDmisc( compressed size, uncompressed size ) dnl Describes miscXX.tgz. dnl define({:-OpenBSDmisc-:}, -{:- misc{:--:}OSrev This set includes the system dictionaries (which are - rather large), and the typesettable document set.showsize($1,$2)-:})dnl +{:- misc{:--:}OSrev This set includes the system dictionaries (which are rather + large), and the typesettable document set.showsize($1,$2)-:})dnl dnl dnl dnl OpenBSDxbase( compressed size, uncompressed size ) @@ -192,15 +192,15 @@ dnl Describes xetcXX.tgz. dnl define({:-OpenBSDxetc-:}, {:- xetc{:--:}OSrev This set includes the X window system configuration files - that reside in /etc. It's the equivalent of etc{:--:}OSrev for X.showsize($1,$2)-:})dnl + that reside in /etc. It's the equivalent of etc{:--:}OSrev for X.showsize($1,$2)-:})dnl dnl dnl dnl OpenBSDxshare( compressed size, uncompressed size ) dnl Describes xshareXX.tgz. dnl define({:-OpenBSDxshare-:}, -{:- xshare{:--:}OSrev This set includes all text files equivalent between - all architectures.showsize($1,$2)-:})dnl +{:- xshare{:--:}OSrev This set includes all text files equivalent between all + architectures.showsize($1,$2)-:})dnl dnl dnl dnl OpenBSDxfont( compressed size, uncompressed size ) @@ -271,27 +271,26 @@ dnl dnl ========== Various Install Instructions dnl (usually used by arch/install) dnl -dnl Short or longer installation introduction. The longer version warns -dnl about disk geometry hell. -define({:-OpenBSDInstallShortPrelude-:}, +dnl OpenBSDInstallPrelude(troublesome disk types) +dnl +dnl Installation introduction. Warns about disk geometry hell if argument +dnl is not empty. +define({:-OpenBSDInstallPrelude-:}, {:-Installing OpenBSD is a relatively complex process, but if you have this document in hand and are careful to read and remember the information which is presented to you by the install program, it -shouldn't be too much trouble.-:})dnl -dnl -define({:-OpenBSDInstallPrelude-:}, -{:-OpenBSDInstallShortPrelude - -Before you begin, you should know the geometry of your hard disk, i.e. -the sector size (note that sector sizes other than 512 bytes are not -currently supported), the number of sectors per track, the number of -tracks per cylinder (also known as the number of heads), and the -number of cylinders on the disk. The OpenBSD kernel will try to -discover these parameters on its own, and if it can it will print them -at boot time. If possible, you should use the parameters it prints. -(You might not be able to because you're sharing your disk with -another operating system, or because your disk is old enough that the -kernel can't figure out its geometry.)-:})dnl +shouldn't be too much trouble.ifelse(X$1,X,,{:- + +If the disks connected to your machine are $1, +it is recommended that you know their geometry, i.e. the sector size (note +that sector sizes other than 512 bytes are not currently supported), the +number of sectors per track, the number of tracks per cylinder (also known +as the number of heads), and the number of cylinders on the disk. The +OpenBSD kernel will try to discover these parameters on its own, and if it +can it will print them at boot time. If possible, you should use the +parameters it prints. (You might not be able to because you're sharing your +disk with another operating system, or because your disk is old enough that +the kernel can't figure out its geometry.)-:})-:})dnl dnl dnl OpenBSDInstallPart2 dnl Describes the beginning of the installation process, once the @@ -309,23 +308,28 @@ may be a better option, or at any prompt enter '!' to get a shell, from which 'exit' will return you back to that prompt (no refresh of the prompt though).-:})dnl dnl -dnl OpenBSDBootMsgs -dnl Describes the boot of the ramdisk. +dnl OpenBSDBootMsgs(warn geometry, disk type, disk type, disk type) +dnl +dnl Describes the boot of the ramdisk, the expected disk devices +dnl names, and warns bore the reader with geometry concerns if the +dnl second argument is not empty. define({:-OpenBSDBootMsgs-:}, {:- Once the kernel has loaded, you will be presented with the OpenBSD kernel boot messages. You will want to read them - to determine your disk's name and geometry. Its name will - be something like "sd0" or "wd0" and the geometry will be - printed on a line that begins with its name. As mentioned - above, you will need your disk's geometry when creating - OpenBSD partitions. You will also need to know the device - name to tell the install tools what disk to install on. If - you cannot read the messages as they scroll by, do not - worry -- you can get at this information later inside the - install program.-:})dnl -dnl -dnl OpenBSDInstallPart3(alternate common disk type description) -dnl Describes the beginning of the bsd.rd operation + to determine your disks name and geometry. Its name will + be something like ifelse(X$2,X,{:-"sd0" for SCSI drives, or "wd0" for IDE + drives-:},$2){:--:}ifelse(X$3,X,,{:-, $3-:}){:--:}ifelse(X$4,X,,{:-, $4-:}){:--:}.{:--:}ifelse(X$1,X,,{:- + As mentioned above, you will need your disks geometry (which + will be printed on a line beginning with its name) when + creating OpenBSD partitions.-:}) + You will also need to know the device name to tell the + install tools what disk to install on. If you cannot read + the messages as they scroll by, do not worry -- you can get + at this information later inside the install program.-:})dnl +dnl +dnl OpenBSDInstallPart3 +dnl +dnl Describes the beginning of the bsd.rd operation. dnl define({:-OpenBSDInstallPart3-:}, {:- After entering the terminal type you will be asked whether you @@ -336,9 +340,7 @@ define({:-OpenBSDInstallPart3-:}, you really wish to install (or upgrade). Assuming you answered yes, the install program will then tell you which disks of that type it can install on, and ask you which it - should use. The name of the disk is typically "sd0" for - SCSI drives$2. - Reply with the name of your disk.-:})dnl + should use. Reply with the name of your disk.-:})dnl dnl dnl OpenBSDInstallPart4(mention about other OS partitions) dnl Describes the disklabel operation @@ -366,8 +368,6 @@ dnl More disklabel notes(disk) define({:-OpenBSDInstallPart5-:}, {:- The swap partition (usually 'b') should have a type of "swap", all other native OpenBSD partitions should have a type of "4.2BSD". - Block and fragment sizes are usually 8192 and 1024 bytes, but can - also be 4096 and 512 or even 16384 and 2048 bytes. The install program will now label your disk and ask which file systems should be created on which partitions. It will auto- @@ -402,7 +402,7 @@ define({:-OpenBSDInstallNet-:}, Next the system will give you a list of network interfaces you can configure. For each network interface you select to configure, it will ask for the IP address to use, the symbolic host name to use, - the netmask to use, and any interface-specific flags to set. The + the netmask to use, and any interface-specific flags to set. The interface-specific flags are usually used to determine which media the network card is to use. Typically no media flags are required as autodetection normally works, but you will be prompted with a @@ -449,8 +449,8 @@ define({:-OpenBSDFTPInstall-:}, 3) The IP address (or hostname if you enabled DNS earlier in the install) of an FTP server carrying the OpenBSD OSREV distribution. - If you don't know, just hit return when - asked if you want to see a list of such hosts. + If you don't know, answer ``y'' when asked if + you want to see a list of such hosts. 4) The FTP directory holding the distribution sets. The default value of pub/OpenBSD/OSREV/MACHINE is almost always correct. @@ -473,8 +473,8 @@ define({:-OpenBSDHTTPInstall-:}, 2) The IP address (or hostname if you enabled DNS earlier in the install) of an HTTP server carrying the OpenBSD OSREV distribution. - If you don't know, just hit return when - asked if you want to see a list of such hosts. + If you don't know, answer ``y'' when asked if + you want to see a list of such hosts. 3) The directory holding the distribution sets. There is no standard location for this; You should use the directory specified @@ -681,7 +681,7 @@ dnl OpenBSDUpgrade({:-<list of available boot methods>-:})dnl dnl Parameter is optional. define({:-OpenBSDUpgrade-:}, {:-Warning! Upgrades to OpenBSD OSREV are currently only supported from the -immediately previous release. The upgrade process will also work with older +immediately previous release. The upgrade process will also work with older releases, but might not execute some migration tasks that would be necessary for a proper upgrade. The best solution, whenever possible, is to backup your data and reinstall from scratch. @@ -739,11 +739,11 @@ define({:-OpenBSDXferFloppyFromDOS-:}, {:-Creating a bootable floppy disk using DOS/Windows: First you need to get access to the OpenBSD bootable floppy - images. If you can access the distribution from the CD-ROM under + images. If you can access the distribution from the CD-ROM under DOS, you will find the bootable disks in the OSREV/MACHINE - directory. Otherwise, you will have to download them from one of + directory. Otherwise, you will have to download them from one of the OpenBSD FTP or HTTP mirror sites, using an FTP client or a web - browser. In either case, take care to do "binary" transfers, since + browser. In either case, take care to do "binary" transfers, since these are images files and any DOS cr/lf translations or control/z EOF interpretations will result in corrupted transfers. @@ -892,7 +892,7 @@ ifelse(X$4,X,,{:- dd of=${TAPE} if=$4 cd .../OSREV/MACHINE sh -x /tmp/maketape - Note that, by default, this script creates a bootable tape. If + Note that, by default, this script creates a bootable tape. If you only want to fetch the OpenBSD files from tape, but want to boot from another device, you can save time and space creating the tape this way: @@ -957,7 +957,7 @@ the following: is recommended that you upgrade the other sets, as well.-:})dnl dnl define({:-OpenBSDInstNFS-:}, -{:-Now you must populate the `/dev' directory for your client. If the server +{:-Now you must populate the `/dev' directory for your client. If the server does not run OpenBSD you might save the MAKEDEV output: eo=echo ksh MAKEDEV all > all.sh @@ -966,7 +966,7 @@ and then tailor it for your server operating system before running it. Note that MAKEDEV is written specifically for ksh, and may not work on any other Bourne shell. -There will be error messages about unknown users and groups. These errors are -inconsequential for the purpose of installing OpenBSD. However, you may -want to correct them if you plan to use the diskless setup regularly. In that +There will be error messages about unknown users and groups. These errors are +inconsequential for the purpose of installing OpenBSD. However, you may +want to correct them if you plan to use the diskless setup regularly. In that case, you may re-run MAKEDEV on your OpenBSD machine once it has booted.-:})dnl |