SGIKOPT(2)                                                          SGIKOPT(2)


NAME
     sgikopt - retrieve kernel option strings

C SYNOPSIS
     int sgikopt (const char *option, char *buf, int buflen);

DESCRIPTION
     The IRIX kernel saves most of the IRIS PROM Monitor environment variables
     (option strings) for later use by the kernel as well as user programs.
     sgikopt allows the user to retrieve the values of these variables.  The
     option argument specifies the name of the variable; the value of the
     option is returned in the buffer addressed by buf.  The size in bytes of
     this buffer is given by buflen.  The string returned by sgikopt is
     guaranteed to be null-terminated, even if the length of the option value
     string exceeds buflen.

     The environment variables recognized by sgikopt are as follows:


     bootfile       The name of the file to use for autobooting.

     bootmode       The type of boot performed:  m to enter the PROM Monitor
                    after clearing memory, d to enter the PROM Monitor without
                    clearing memory, or c to perform an autoboot using the
                    bootfile.

     console        The console to use:  g for graphics console, G for
                    graphics console with logo, or d for serial terminal port
                    1.

     diskless       If this variable is set, the system expects to mount it's
                    root filesystem via NFS from a server.  It may be set even
                    if a local disk is installed, in which case the local root
                    disk is ignored.

     dllogin        When diskless is set, this is the login name to use during
                    installation on a diskless machine.  See cl_init(1m) for
                    more information.

     dlserver       When diskless is set, this is the hostname of the machine
                    from which the root filesystem will be mounted.  It should
                    be set in standard IP address format.

     gfx            An variable indicating if graphics state:  alive or dead.

     hostname       The Internet host name string.

     initfile       The process control initialization program if the default,
                    /etc/init, is overridden.  See init(1M).


     initstate      The run level to override the default state present in
                    /etc/inittab. See inittab(4).

     keybd          The international keyboard type.

     monitor        Overrides the default monitor setting when an unrecognized
                    monitor is attached to an Indy system.  Specifying 'h' or
                    'H' indicates the attached monitor supports high
                    resolution mode (1280x1024 @ 60Hz).  Otherwise the default
                    resolution is low resolution (1024x768 @ 60Hz).  This
                    variable is usable only on an Indy system and is stored in
                    non-volatile RAM.

     netaddr        The Internet network address for booting across the
                    Ethernet.

     logocolor      The color of the logo while in the standalone programs,
                    and the kernel textport (no window manager running) is
                    controlled by this variable.  It is 6 hex digits, which
                    are the values for red, green, and blue in that order.
                    This is currently implemented only on the Personal Iris.

     nswap          The number of blocks to use in the swap partition; this
                    amount overrides the partition size.

     pagecolor      The color of the textport while in the standalone
                    programs, and the kernel textport (no window manager
                    running) is controlled by this variable.  It is 6 hex
                    digits, which are the values for red, green, and blue in
                    that order.  This is currently implemented only on the
                    Personal Iris.

     root           The disk that contains the root (/) file system (as it
                    would be named in the /dev/dsk directory).

     screencolor    The color of the screen background while in the standalone
                    programs, and the kernel textport (no window manager
                    running) is controlled by this variable.  It is 6 hex
                    digits, which are the values for red, green, and blue in
                    that order.  This is currently implemented only on the
                    Personal Iris.

     showconfig     If this variable is specified, the kernel will print out
                    verbose information about memory and device configuration
                    at boottime.

     srvaddr        If set, this specifies the (only) host that will be used
                    to resolve bootp requests.  It should be set in standard
                    IP address format.


     swaplo         The first block to use in the swap partition; this amount
                    overrides the default value of 0.

     sync_on_green  If this value is n, the sync information is not
                    superimposed on the green monitor line.

     tapedevice     The tape device used for software installation.

DIAGNOSTICS
     Upon successful completion, sgikopt returns 0.  Otherwise, sgikopt
     returns -1 and sets errno to indicate the error:


     [EINVAL]       The given option was not found.

     [EFAULT]       The option or buf argument specifies an invalid address.

SEE ALSO
     syssgi(2) - the SGI_GETNVRAM command provides almost the same
     functionality.


                                                                        Page 3