diff options
| author | Peter Wemm <peter@FreeBSD.org> | 1995-09-18 16:53:06 +0000 |
|---|---|---|
| committer | Peter Wemm <peter@FreeBSD.org> | 1995-09-18 16:53:06 +0000 |
| commit | 5326bef3dea504bf1e33213fdca6903b39e0a8bc (patch) | |
| tree | d8d32666544a3c5d9db7a5472c5fa4292681da66 /usr.sbin/sysinstall/help | |
| parent | 5cbf3e086c556538a726bb9438b8e4ba0c960ff7 (diff) | |
Notes
Diffstat (limited to 'usr.sbin/sysinstall/help')
| -rw-r--r-- | usr.sbin/sysinstall/help/configure.hlp | 14 | ||||
| -rw-r--r-- | usr.sbin/sysinstall/help/distributions.hlp | 88 | ||||
| -rw-r--r-- | usr.sbin/sysinstall/help/drives.hlp | 29 | ||||
| -rw-r--r-- | usr.sbin/sysinstall/help/media.hlp | 29 | ||||
| -rw-r--r-- | usr.sbin/sysinstall/help/network_device.hlp | 54 | ||||
| -rw-r--r-- | usr.sbin/sysinstall/help/options.hlp | 95 | ||||
| -rw-r--r-- | usr.sbin/sysinstall/help/partition.hlp | 122 | ||||
| -rw-r--r-- | usr.sbin/sysinstall/help/slice.hlp | 28 | ||||
| -rw-r--r-- | usr.sbin/sysinstall/help/tcp.hlp | 27 | ||||
| -rw-r--r-- | usr.sbin/sysinstall/help/usage.hlp | 54 |
10 files changed, 540 insertions, 0 deletions
diff --git a/usr.sbin/sysinstall/help/configure.hlp b/usr.sbin/sysinstall/help/configure.hlp new file mode 100644 index 0000000000000..49980d4116054 --- /dev/null +++ b/usr.sbin/sysinstall/help/configure.hlp @@ -0,0 +1,14 @@ +This menu allows you to configure your system after the installation +process is complete. At the minimum, you should probably set the +system manager's password and the system time zone. + +For extra goodies like bash, emacs, pascal, etc., you should look at +the Packages item in this menu. Currently, the Packages option is +only useful if you have a CDROM or an existing packages collection +somewhere in the file system hierarchy where the package management +tool can locate it. The automatic transfer of packages via FTP is not +yet supported! + +For setting the timezone after the system is installed, type +``tzsetup''. For more information on the general system +configuration, see the ``/etc/sysconfig'' file. diff --git a/usr.sbin/sysinstall/help/distributions.hlp b/usr.sbin/sysinstall/help/distributions.hlp new file mode 100644 index 0000000000000..b81efbfa10db6 --- /dev/null +++ b/usr.sbin/sysinstall/help/distributions.hlp @@ -0,0 +1,88 @@ +An ``X-'' prefixed before a distribution set means that the XFree86 +3.1.1u1 base distribution, libraries, manual pages, SVGA server and a +set of default fonts will be selected in addition to the set itself. + +If you select such a set, you will also be presented with a set of +menus for customizing the selections to your desired X Window System +setup. + +N.B. All references in this document to `complete source' mean the +complete source tree minus any legally encumbered cryptography code. + +The current "canned" installations are as follows: + +Developer: Base ("bin") distribution, man pages, dictionary + files, profiling libraries and the complete source tree. + + +Kern-Developer: As above, but with only kernel sources instead of + the complete source tree. + + +User: The base distribution, man pages, dictionary files and + the FreeBSD 1.x and 2.0 compatibility sets. + + +Minimal: Only the base distribution. + + +Everything: The base distribution, man pages, dictionary files, + profiling libraries, the FreeBSD 1.x and the FreeBSD 2.0 + compatibility libraries, the complete source tree, + games and your choice of XFree86 distribution components. + N.B. Still no cryptocraphy source code! + + +Custom: Allows you to modify or create your distribution set on + a piece-by-piece basis. + + +Reset: Clear all currently selected distributions. + + +--- + +When using Custom, most of the sub-distribution choices are fairly +obvious, though two possible exceptions may be the "commerce" and +"xperimnt" distributions: + + * The "commerce" directory, as its name implies, is devoted to + commercial offerings. This includes commercial products released + under special arrangement, limited functionality demos, shareware + products (you like it, you buy it), etc. + + At the time of this writing, there are unfortunately not enough + commercial offerings to justify a fully split distribution set, + so each product is available both as a subdirectory and as part + of one large archive file. If you select "commerce" from the + distributions submenus then you'll get the big file containing + the entire collection copied to your hard disk. Don't do this + unless you've got at least 10MB to devote to it! + + + * The "xperimnt" directory contains, not surprisingly, experimental + offerings. Unfinished (or work-in-progress) features, special + purpose drivers and packages, strange proof-of-concept stuff, + it's a mixed bag! Select this item on a distribution menu and + you'll get the whole collection (between 10 and 30MB). + + + If you're installing from CDROM then all of the commercial and + "experimental" offerings are also easily available in their + individual subdirectories and can be copied to hard disk at + any time. + + +You may also notice that certain distributions, like "des" and "krb", +are marked "NOT FOR EXPORT!" This is because it's illegal to +export them from the United States (or any other country which +considers encryption technology to be on its restricted export +list). Since breaking this law only gets the _originating_ site +(US!) in trouble, please do not load these distributions from U.S. +servers! + +A number of "foreign" servers do exist for the benefit of +non-U.S. sites, one of which is "skeleton.mikom.csir.co.za". + +Please get all such export restricted software from there +if you are outside the U.S., thanks! diff --git a/usr.sbin/sysinstall/help/drives.hlp b/usr.sbin/sysinstall/help/drives.hlp new file mode 100644 index 0000000000000..ef1c4fecd11cb --- /dev/null +++ b/usr.sbin/sysinstall/help/drives.hlp @@ -0,0 +1,29 @@ +If you are going to actually install some portion of FreeBSD on a +drive then PLEASE BE VERY CERTAIN that the Geometry reported in the +Partition Editor (see Installation Menu) is the correct one for your +drive and controller combination! + +IDE drives often have a certain geometry set during the PC BIOS setup, +or (in the case of larger IDE drives) have their geometry "remapped" +by either the IDE controller or a special boot-sector translation +utility such as that by OnTrack Systems. In these cases, knowing the +correct geometry gets even more complicated as it's not something you +can easily tell by looking at the drive or the PC BIOS setup. The +best way of verifying that your geometry is being correctly calculated +in such situations is to boot DOS (from the hard disk, not a floppy!) +and run the ``pfdisk'' utility provided in the tools/ subdirectory of +the FreeBSD CDROM or FTP site. It will report the geometry that DOS +sees, which is generally the correct one. + +If you have no DOS partition sharing the disk at all, then you may +find that you have better luck with Geometry detection if you create a +very small DOS partition first, before installing FreeBSD. Once +FreeBSD is installed you can always delete it again if you need the +space. + +It's actually not a bad idea (believe it or not) to have a small bootable +DOS partition on your FreeBSD machine anyway: Should the machine become +unstable or exhibit strange behavior at some point in the future (which +is not uncommon behavior for PC hardware!) you can then at least use +DOS for installing and running one of the commercially available system +diagnostic utilities. diff --git a/usr.sbin/sysinstall/help/media.hlp b/usr.sbin/sysinstall/help/media.hlp new file mode 100644 index 0000000000000..8b081bc3084ef --- /dev/null +++ b/usr.sbin/sysinstall/help/media.hlp @@ -0,0 +1,29 @@ +You can install from the following types of media: + + CDROM - requires one of the following supported CDROM drives: + + Sony CDU 31/33A + Matushita/Panasonic "Sound Blaster" CDROM. + Mitsumi FX-001{A-D} (older non-IDE drives). + SCSI - Any standard SCSI CDROM drive hooked to + a supported controller (see Hardware Guide). + + DOS - A DOS primary partition with the required FreeBSD + distribution files copied onto it (e.g. C:\FREEBSD\) + + FS - Assuming a disk or partition with an existing + FreeBSD file system and distribution set on it, + get the distribution files from there. + + Floppy - Get distribution files from one or more DOS formatted + floppies. + + FTP - Get the distribution files from an anonymous ftp server + (you will be presented with a list). + + NFS - Get the distribution files from an NFS server somewhere + (make sure that permissions on the server allow this!) + + Tape - Extract distribution files from tape into a temporary + directory and install from there. + diff --git a/usr.sbin/sysinstall/help/network_device.hlp b/usr.sbin/sysinstall/help/network_device.hlp new file mode 100644 index 0000000000000..95c42ae9534c8 --- /dev/null +++ b/usr.sbin/sysinstall/help/network_device.hlp @@ -0,0 +1,54 @@ +You can do network installations over 3 types of communications links: + + Serial port: SLIP / PPP + Parallel port: PLIP (laplink cable) + Ethernet: A standard ethernet controller (includes some PCMCIA). + +SLIP support is rather primitive and limited primarily to hard-wired +links, such as a serial cable running between a laptop computer and +another PC. The link must be hard-wired as the SLIP installation +doesn't currently offer a dialing capability; that facility is provided +with the PPP utility, which should be used in preference to SLIP +whenever possible. When you choose a serial port device, you'll +be given the option later to edit the slattach command before it's +run on the serial line. It is expected that you'll run slattach +(or some equivalent) on the other end of the link at this time and +bring up the line. FreeBSD will then install itself over the link +at speeds of up to 115.2K/baud (the recommended speed for a hardwired +cable). + +If you're using a modem then PPP is almost certainly your only +choice. Make sure that you have your service provider's information +handy as you'll need to know it fairly early in the installation +process. You will need to know, at the minimum, your service +provider's IP address and possibly your own (though you can also leave +it blank and allow PPP to negotiate it with your ISP). You will also +need to know how to use the various "AT commands" to dial the ISP with +your particular brand of modem as the PPP dialer provides only a very +simple terminal emulator and has no "modem capabilities database". + +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 port is much +higher than what is typically possible over a serial line with +speeds of up to 50k/sec. + +Finally, for the fastest possible network installation, an ethernet +adaptor is always a good choice! FreeBSD supports most common PC +ethernet cards, a table of which is provided in the FreeBSD +Hardware Guide (see the Documentation menu on the boot floppy). +If you are using one of the supported PCMCIA ethernet cards, also be +sure that it's plugged in _before_ the laptop is powered on! FreeBSD +does not, unfortunately, currently support "hot insertion" of PCMCIA +cards. + +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 to other hosts by +name rather than IP address, you'll also need a name server and +possibly the address of a gateway (if you're using PPP, it's your +provider's IP address) to use in talking to 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! diff --git a/usr.sbin/sysinstall/help/options.hlp b/usr.sbin/sysinstall/help/options.hlp new file mode 100644 index 0000000000000..c30180c4901b8 --- /dev/null +++ b/usr.sbin/sysinstall/help/options.hlp @@ -0,0 +1,95 @@ +The following options may be set from this screen: + +NFS Secure: NFS server talks only on a secure port + + This is most commonly used when talking to Sun workstations, which + will not talk NFS over "non priviledged" ports. + + +NFS Slow: User is using a slow PC or ethernet card + + Use this option if you have a slow PC (386) or an ethernet card + with poor performance being "fed" by NFS on a higher-performance + workstation. This will throttle the workstation back to prevent + the PC from becoming swamped with data. + + +FTP Abort: On transfer failure, abort + + This is pretty self-explanatory. If you're transfering from a + host that drops the connection or cannot provide a file, abort + the installation of that piece. + + +FTP Reselect: On transfer failure, ask for another host + + This is more useful to someone doing an interactive installation. + If the current host stops working, ask for a new ftp server to + resume the installation from. The install will attempt to pick + up from where it left off on the other server, if at all possible. + + +FTP Active: Use "active mode" for standard FTP + + 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 default), try active! + + +FTP Passive: Use "passive mode" for firewalled FTP + + 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. + + NOTE: ACTIVE AND PASSIVE MODES ARE NOT THE SAME AS A `PROXY' + CONNECTION, WHERE A PROXY FTP SERVER IS LISTENING ON A DIFFERENT + PORT! + + In such situations, you should specify the URL as something like: + + ftp://foo.bar.com:1234/pub/FreeBSD + + Where "1234" is the port number of the proxy ftp server. + + +Debugging: Turn on the extra debugging flag + + This turns on a lot of extra noise over on the second screen + (ALT-F2 to see it, ALT-F1 to switch back). If your installation + should fail for any reason, PLEASE turn this flag on when + attempting to reproduce the problem. It will provide a lot of + extra debugging at the failure point and may be very helpful to + the developers in tracking such problems down! + + +Yes To All: Assume "Yes" answers to all non-critical dialogs + + This flag should be used with caution. It will essentially + decide NOT to ask the user about any "boundry" conditions that + might not constitute actual errors but may be warnings indicative + of other problems. + + +FTP userpass: Specify username and password instead of anonymous. + + By default, the installation attempts to log in as the + anonymous user. If you wish to log in as someone else, + specify the username and password with this option. + + +Clear: Clear All Option Flags + + Reset all option flags back to their default values. + +---- + +Some of these items, like "FTP Active" or "FTP Passive", are actually +mutually-exclusive even though you can turn all of them on or off at +once. This is a limitation of the menuing system, and is compensated +for by checks that ensure that the various flags are not in conflict. +If you re-enter the Options menu again after leaving it, you'll see +the settings it's actually using after checking for any possible +conflicts. + diff --git a/usr.sbin/sysinstall/help/partition.hlp b/usr.sbin/sysinstall/help/partition.hlp new file mode 100644 index 0000000000000..19b6ce1235d9d --- /dev/null +++ b/usr.sbin/sysinstall/help/partition.hlp @@ -0,0 +1,122 @@ +This is the FreeBSD DiskLabel Editor. + +You should use this editor to create at least the following +filesystems: + + Name Purpose Min Size? Optional? + ---- ------- --------- --------- + / Root filesystem 20MB No + swap Swap space 2 * MEM No + /usr System & user files 80MB or more Yes + +Note: If you do not create a /usr filesystem then your / filesystem +will need to be bigger - at least 100MB. This is not recommended as +any media errors that may occur during disk I/O to user files will +corrupt the filesystem containing vital system files as well. It is +for this reason that / is generally kept on its own filesystem, where +it's basically considered "read only" by the system and hence a good +deal safer. + +Swap space is a little tricker, and the rule of "2 * MEM" is simply a +best-guess approximation and not necessarily accurate for your +intended usage of the system. If you intend to use the system heavily +in a server or multi-user application, you may be well advised to +increase this size. You may also create swap space on multiple drives +for a larger "total" swap and this is, in fact, recommended if you +have multiple, fast drives for which such load-balancing can only help +overall I/O performance. + +The /usr filesystem should be sized according to what kind of +distributions you're trying to load and how many packages you intend +to install in locations like /usr/local. You can also make /usr/local +a separate filesystem if you don't want to risk filling up your /usr +by mistake. + +Another useful filesystem to create is /var, which contains mail, news +printer spool files and other temporary items. It is a popular +candidate for a separate paritition and should be sized according to +your estimates of the amount of mail, news or spooled print jobs that +may be stored there. + +WARNING: If you do not create a separate filesystem for /var, space +for such files will be allocated out of the root (/) filesystem +instead. You may therefore wish to make the / partition bigger if you +expect a lot of mail or news and do not want to make /var its own +partition. + + +If you're new to this installation, you should also first understand +how FreeBSD 2.0.5's new "slices" paradigm for looking at disk storage +works. It's not very hard to grasp. A "fully qualified slice name", +that is the name of the file we open in /dev to talk to the slice, is +optionally broken into 3 parts: + + First you have the disk name. Assume we have two SCSI + drives in our system, which gives us `sd0' and `sd1'. + + Next you have the "Slice" (or "FDISK Partition") number, + as seen in the Partition Editor. Assume that our sd0 contains + two slices, a FreeBSD slice and a DOS slice. This gives us + sd0s1 and sd0s2. Let's also say that sd1 is completely devoted + to FreeBSD, so we have only one slice there: sd1s1. + + Next, if a slice is a FreeBSD slice, you have a number of + (confusingly named) "partitions" you can put inside of it. + These FreeBSD partitions are where various filesystems or swap + areas live, and using our hypothetical two-SCSI-disk machine + again, we might have something like the following layout on sd0: + + Name Mountpoint + ---- ---------- + sd0s1a / + sd0s1b <swap space> + sd0s1e /usr + + Because of historical convention, there is also a short-cut, + or "compatibility slice", that is maintained for easy access + to the first FreeBSD slice on a disk for those programs which + still don't know how to deal with the new slice scheme. + The compatibility slice names for our filesystem above would + look like: + + Name Mountpoint + ---- ---------- + sd0a / + sd0b <swap space> + sd0e /usr + + FreeBSD automatically maps the compatibility slice to the first + FreeBSD slice it finds (in this case, sd0s1). You may have multiple + FreeBSD slices on a drive, but only the first one may be the + compatibility slice! + + The compatibility slice will eventually be phased out, but + it is still important right now for several reasons: + + 1. Some programs, as mentioned before, still don't work + with the slice paradigm and need time to catch up. + + 2. The FreeBSD boot blocks are unable to look for + a root file system in anything but a compatibility + slice right now. This means that our root will always + show up on "sd0a" in the above scenario, even though + it really lives over on sd0s1a and would otherwise be + referred to by its full slice name. + +Once you understand all this, then the label editor becomes fairly +simple. You're either carving up the FreeBSD slices displayed at the +top of the screen into smaller pieces (displayed in the middle of the +screen) and then putting FreeBSD file systems on them, Or you're just +mounting existing partitions/slices into your filesystem hierarchy; +this editor lets you do both. Since a DOS partition is also just +another slice as far as FreeBSD is concerned, you can mount one into +in your filesystem hierarchy just as easily with this editor. For +FreeBSD partitions you can also toggle the "newfs" state so that +the partitions are either (re)created from scratch or simply checked +and mounted (the contents are preserved). + +When you're done, type `Q' to exit. + +No actual changes will be made to the disk until you (C)ommit from the +Install menu! You're working with what is essentially a copy of +the disk label(s), both here and in the FDISK Partition Editor. diff --git a/usr.sbin/sysinstall/help/slice.hlp b/usr.sbin/sysinstall/help/slice.hlp new file mode 100644 index 0000000000000..e055ca4732413 --- /dev/null +++ b/usr.sbin/sysinstall/help/slice.hlp @@ -0,0 +1,28 @@ +This is the Main Partition (or ``Slice'') Editor. + +Possible commands are printed at the bottom, and the Master Boot Record +contents are at the top. You can move up and down with the arrow keys +and can (C)reate a new partition whenever the "bar" is over a partition +whose type is set to "unused". + +The flags field has the following legend: + + '=' -- Partition is properly aligned. + '>' -- The partition doesn't end before cylinder 1024 + 'R' -- Has been marked as containing the root (/) filesystem + 'B' -- Partition employs BAD144 bad-spot handling + 'C' -- This is the FreeBSD 2.0-compatibility partition (default) + 'A' -- This partition is marked active. + +If you select a partition for Bad144 handling, it will be scanned +for bad blocks before any new filesystems are made on it. + +If no partition is marked Active, you will need to either install +a Boot Manager (the option for which will be presented later in the +installation) or set one Active before leaving this screen. + +To leave this screen, type `Q'. + +No actual changes will be made to the disk until you (C)ommit from the +Install menu! You're working with what is essentially a copy of +the disk label(s), both here and in the Label Editor. diff --git a/usr.sbin/sysinstall/help/tcp.hlp b/usr.sbin/sysinstall/help/tcp.hlp new file mode 100644 index 0000000000000..3ab5d7ca06d66 --- /dev/null +++ b/usr.sbin/sysinstall/help/tcp.hlp @@ -0,0 +1,27 @@ +This screen allows you to set up your general network parameters +(hostname, domain name, DNS server, etc) as well as the settings for a +given interface (which was selected from the menu before this screen). + +You can move through the fields with the TAB, BACK-TAB and RETURN +keys. To edit a field, use DELETE or BACKSPACE. You may also use ^A +(control-A) to go to the beginning of the line, ^E (control-E) to go +to the end, ^F (control-F) to go forward a character, ^B (control-B) +to go backward one character, ^D (control-D) to delete the character +under the cursor and ^K (control-K) to delete to the end of the line. +Basically, the standard EMACS motion sequences. + +The ``Extra options to ifconfig'' is kind of special (read: a hack :-). + +You can use it for specifying the foreign side of a PLIP or SLIP line +(simply type the foreign address in) as well as selecting a given +"link" on an ethernet card that has more than one (e.g. AUI, 10BT, +10B2, etc). The following links are recognised: + + link0 - AUI * highest precedence + link1 - BNC + link2 - UTP * lowest precedence + +That is to say that you can enter one of "link0", "link1" or "link2" +into the `Extra options' field to select a different link. + +When you're done with this form, select OK. diff --git a/usr.sbin/sysinstall/help/usage.hlp b/usr.sbin/sysinstall/help/usage.hlp new file mode 100644 index 0000000000000..b01a94b927e7d --- /dev/null +++ b/usr.sbin/sysinstall/help/usage.hlp @@ -0,0 +1,54 @@ +HOW TO USE THIS SYSTEM +====================== + +KEY ACTION +--- ------ +UP ARROW Move to previous item (or up, in a text field). +DOWN ARROW Move to next item (or down, in a text field). +TAB Move to next item or group. +RIGHT ARROW Move to next item or group (same as TAB). +SHIFT-TAB Move to previous item or group. +LEFT ARROW Move to previous item or group (same as SHIFT-TAB). +RETURN Select item. +PAGE UP In text boxes, scrolls up one page. +PAGE DOWN In text boxes, scrolls down one page. +SPACE In "radio" or multiple choice menus, toggle the current item. +F1 Help (in screens that provide it). + +If you also see small "^(-)" or "v(+)" symbols at the edges of a menu, +it means that there are more items above or below the current one that +aren't being shown (due to insufficient screen space). Using the +up/down arrow keys will cause the menu to scroll. When a symbol +disappears, it means you are at the top (or bottom) of the menu. + +In text fields, the amount of text above the current point will be +displayed as a percentage in the lower right corner. 100% means +you're at the bottom of the field. + +Selecting OK in a menu will confirm whatever action it's controlling. +Selecting Cancel will cancel the operation and generally return you to +the previous menu. + + +SPECIAL FEATURES: +================= + +It is also possible to select a menu item by typing the first +character of its name, if unique. Such "accelerator" characters will +be specially highlighted in the item name. + +The console driver also contains a scroll-back buffer for reviewing +things that may have scrolled off the screen. To use scroll-back, +press the "Scroll Lock" key on your keyboard and use the arrow or +Page Up/Page Down keys to move through the saved text. To leave +scroll-back mode, press the Scroll Lock key again. This feature +is most useful for dealing with sub-shells or other "wizard modes" +that don't use menus. + +Once the system is fully installed and running "multi-user", you will +also find that you have multiple "virtual consoles" and can use them to +have several active sessions at once. Use ALT-F<n> to switch between +them, where `F<n>' is the function key corresponding to the screen you +wish to see. By default, the system comes with 3 virtual consoles enabled. +You can create more by editing the /etc/ttys file, once the system is up, +for a maximum of 12. |
