Preface





OpenBoot® 3.x Command Reference describes how to use Sun(TM) systems that implement firmware that responds as described by IEEE Standard 1275-1994.

Who Should Use This Book

This manual is written for all users, from systems designers to systems administrators and end users, who wish to use OpenBoot to configure and debug their systems.

Contents

This manual contains information on using OpenBoot to perform tasks such as:

If you want to write Forth programs or if you want to use the more advanced features of this firmware (such as its debugging capabilities), this manual also describes the commands of the OpenBoot Forth Interpreter.

Assumptions

This manual assumes that you are working on a system that uses Version 3.x OpenBoot. Other OpenBoot implementations may use different prompts and/or formatting, and may not support all of the tools and capabilities described in this manual.

How This Book Is Organized

Related Books

A companion document to this manual is:

For information on OpenBoot FCode, refer to:

For information about Open Firmware, see the following manual:

For more information about Forth and Forth programming, refer to:

What Typographic Changes and Symbols Mean

The following table describes the typeface changes and symbols used in this book.

-----------------------------------------------------------------------------------------------------------------------------------------------------------------
Typeface or Meaning Example Symbol -----------------------------------------------------------------------------------------------------------------------------------------------------------------
                                                                                                                     
AaBbCc123                                                          The names of commands, files, and directories;    Edit your .login file.
                                                                   on-screen computer output                         
                                                                                                                     Use ls -a to list all files.
                                                                                                                     
                                                                                                                     machine_name% You have mail.
                                                                                                                     
                                                                                                                     
                                                                                                                     
AaBbCc123                                                          What you type, contrasted with on-screen          machine_name% su
                                                                   computer output                                   
                                                                                                                     Password:
                                                                                                                     
AaBbCc123                                                          Command-line placeholder:                         To delete a file, type rm filename.
                                                                                                                                                                   
                                                                   replace with a real name or value                                                               
                                                                                                                     
AaBbCc123                                                          Book titles, new words or terms, or words to be   Read Chapter 6 in User's Guide. These are 
                                                                   emphasized                                        called class options. 
                                                                                                                     
                                                                                                                     You must be root to do this.
                                                                                                                     
Code samples are included in boxes and may display the following:                                                    
                                                                                                                     
ok                                                                 OpenBoot command prompt                           ok
                                                                                                                     
%                                                                  UNIX C shell prompt                               system%
                                                                                                                     
$                                                                  UNIX Bourne and Korn shell prompt                 system$
                                                                                                                     
#                                                                  Superuser prompt, all shells                      system#

-----------------------------------------------------------------------------------------------------------------------------------------------------------------

This manual follows a number of typographic conventions:

      Press the Return key.

    To enter Control-C, press and hold Control, then press C, then release both keys.

      Although the keyname (i.e. C in the preceding example) is shown in uppercase, the actual keystroke may be lowercase.

      To enter Escape B, press and release Escape, then press and release B.

    Although the keyname (i.e. B in the preceding example) is shown in uppercase, the actual keystroke may be lowercase.

      help [word]

    For example, the first portion of such a split table would look like:

    Table P-1 Diagnostic Test Command

------------------------------------------------------
Command Description ------------------------------------------------------
            
probe-scsi  Identify devices attached to a SCSI bus.

------------------------------------------------------

while the second portion of the same table would look like:

    Table P-2 Diagnostic Test Command (Continued)

---------------------------------------------------------------------------------------
Command Description ---------------------------------------------------------------------------------------
                         
test device-specifier    Execute the specified device's self-test method. For example:
                         
                         test floppy - test the floppy drive, if installed 
                         
                         test net - test the network connection 

---------------------------------------------------------------------------------------

Were this table contained in a single page, it would look like:

    Table P-3 Diagnostic Test Commands

---------------------------------------------------------------------------------------
Command Description ---------------------------------------------------------------------------------------
                         
probe-scsi               Identify devices attached to a SCSI bus.
                         
test device-specifier    Execute the specified device's self-test method. For example:
                         
                         test floppy - test the floppy drive, if installed 
                         
                         test net - test the network connection 

---------------------------------------------------------------------------------------

Sun Welcomes Your Comments

Please use the Reader Comment Card that accompanies this document if it is hard-copy. We are interested in improving our documentation and welcome your comments and suggestions.

Even if there is no card (on-line documentation),you can email or fax your comments to us. Please include the part number of your document in the subject line of your email or fax message.