.\" 
.TH sysinfo 1 "7 June 2002"
.ds ]W www.MagniComp.com
.SH NAME
sysinfo \- MagniComp(TM) SysInfo(TM) command displays system information in a platform neutral manner
.SH "DOCUMENTATION GUIDE"
.nf
sysinfo(1)              Overview and Command Line Interface (CLI)
mcsysinfogui(1)         Graphical User Interface (GUI)
mcsysinforeport(1)      Description of "-format report" output
mcsysinfoc(3)           C API
mcsysinfoperl(3)        Perl API
mcsysinfocf(5)          Configuration file specification
.fi
.SH SYNOPSIS
sysinfo
[
.B \-background
.I color
] 
[
.B \-be
.I path
] 
[
.B \-configdir
.I DirName
] 
[
.B \-configfile
.I FileName
] 
[
.B \-copyright
] 
[
.B \-class
.I item1,item2,...
] 
[
\-danger
]
[
.B \-display
.I name
] 
[
.B \-encode
.I EncodeType
] 
[
.B \-font
[
.B \-iconic
] 
[
.B \-infile
.I file
] 
[
.B \-msgclass
.I msgclass1,msgclass2,...
]
[
.B \-msglevel
.I msglevel1,msglevel2,...
]
[
.B \-name
.I name
] 
[
.B \-noserial
]
[
\-nw
]
[
.B \-offset 
.I amount
]
[
.B \-output 
.I file
]
[
.B \-repsep
.I string
]
[
.B \-show
.I item1,item2,...
] 
[
.B +|\-swfiles
] 
[
.B \-type
.I type1,type2,...
] 
[
.B +|\-unknown
] 
[
]
.br
.sp
sysinfo 
.B \-version
.SH DESCRIPTION
.B MagniComp(TM)'s
.B SysInfo(TM)
provides Unix/Linux System Administrators with extremely detailed,
platform independent
hardware,
software, and OS configuration data for most Unix/Linux platforms. 
.B SysInfo(TM)
enables System Administrators to quickly see a high level view of a
system's configuration or dive deeply into very low level
configuration data. You can see something as "simple" as a system's
model name or you can plunge down to detailed information on disk
drives to view a drive's serial number and RPM speed.
.PP
.B SysInfo(TM)
supports both a sophisticated Command Line Interface (CLI)
for consumption by both humans and programs,
as well as a Graphical User Interface (GUI) to browse the volumes of
data available.
.PP
Here is just some of the types of information that may be provided:
.br
.RS
.br
- Extremely detailed hardware (device) information
.br
- Kernel parameters
.br
- System configuration parameters
.br
- Installed software packages
.br
- Host name
.br
- Host name aliases
.br
- Host network addresses
.br
- Host ID
.br
- System serial number
.br
- Manufacturer of the system's hardware
.br
- System model name
.br
- CPU type
each OS.
.PP
By default
.B SysInfo(TM)
will start it's Graphical User Interface (GUI) if
the
.B $DISPLAY
environment variable is set.
If 
.B $DISPLAY
is not set
or
the
.B \-nw
option is specified,
.B SysInfo(TM)
will output to the command line.
See
.B mcsysinfogui(1)
for details on GUI usage.
.PP
When command line output is used
.B SysInfo(TM)
will
display 
by default
a "medium" level of output suitable for a quick glance at
system configuration information.
The
.B "\-msglevel all \-class all" 
options may be used to enable the maximum amount of system information.
.PP
The default command line output format is suitable for most humans.
A program parsable output format is available by specifying:
.RS
.sp
.nf
.B "\-repsep '|' -format report"
.fi
.sp
.RE
See
.B mcsysinforeport(1)
for a description of the output from this option.
Please see
.B mcsysinfoc(3)
for a description of the C API
and
.B mcsysinfoperl(3)
for the 
.B perl(1)
API.
.B SysInfo(TM)
will search for a suitable configuration file.
Searching stops when the first configuration file is found.
The following search order is used:
.br
.sp
.nf
.RS
\fB/etc/sysinfo.cf
\fIConfDir\fB/${OSname}_${OSver}.cf
\fIConfDir\fB/${OSname}_${OSmajver}.cf
\fIConfDir\fB/${OSname}.cf
\fIConfDir\fB/Default.cf
.RE
.sp
.fi
.I ConfDir
is
.B /opt/sysinfo/config
by default, but can be overridden with the
.B \-configdir
option or by specifying
.br
.sp
.nf
.RS
\fIConfDir \fBDir\fR
.RE
.sp
.fi
in the 
.B /etc/sysinfo.cf
file.  See
.I mcsysinfocf(5)
for more information.
.PP
If the file
.I /etc/sysmodel
exists, the first line of the file is read and used as the
system model name.
.SH OPTIONS
The following options are valid for all invocations except as noted:
.IP "\fB\-be \fIpath\fR"
Use 
.I Path
as the pathname to the back-end 
.I SysInfo
program to use.
.IP "\fB\-cfdir \fIDirName\fR"
This option is obsoleted by the
.B \-configdir
option.
cannot be opened for any reason, an error message is displayed and the
program will exit.
.IP "\fB\-copyright\fR"
Print the software's copyright message and exit.
.IP "\fB\-class \fIName1,Name2,...\fR"
Limit information to a specific class or classes of information.
The default class is
.B General.
.IP "\fB\-danger\fR"
Normally
.B SysInfo(tm)
checks upon startup to make sure it's running on the same platform
(OS Name, OS Version, CPU Type, and CPU Architecture (on some platforms))
as it was built on.  This option overrides/disables this check.
Using this option usually means that the information provided may be
false or incomplete.
.IP "\fB\-encode \fIEncodeType\fR"
Encode output in the specified manner
where
.I EncodeType
is one of the following:
.RS
.IP "\fBhtml\fR"
Encode as HTML.
.IP "\fBtext\fR"
Encode as ASCII text.
This is the default.
.RE
.IP "\fB\-format \fIFormatType\fR"
Specify the format layout and display of requested data.
Valid
.I FormatType
values are:
.RS
.IP "\fBcolumns\fR"
Data is formated in columns.  The output is suited for viewing in
terminal windows set to a minimum width of 80 characters.  Output will be
adjusted if the terminal width is greater than 80 characters.  Terminal
width is determined by first looking for the environment variable
.B COLUMNS.
If not set, 
the output stream 
associated with standard output is checked for terminal width.
.IP "\fBpretty\fR"
.B (DEPRECATED)
Same as
.B tree
.IP "\fBreport\fR"
Output is in a format suitable for parsing by a program.
Entries are printed one per line with fields separated by ``|''
(vertical pipe) by default.
The 
.B "sysinfo -format report"
format
(see 
.B mcsysinforeport(1) )
This option is only used when using the
.B SysInfo(tm)
GUI.
.IP "\fB\-msgclass \fImsgclass1,msgclass2,...\fR"
Specify which class of messages should be output.
The default value for
.B \-msgclass
is
.B info,warn,cerror.
The list of possible 
.I msgclass
values are:
.RS
.IP "\fBall\fR"
All of the below classes except for 
.B debug.
.IP "\fBinfo\fR"
Display normal informational messages.
All the actual useful bits of 
information about your system are output as msgclass \fBinfo\fB.
.IP "\fBwarn\fR"
Display warning messages about any condition that occurred while 
.B SysInfo(tm)
is running which may affect what information is found.
Normally these are problems such as
.B SysInfo(tm)
not running with the right permissions or certain things are missing from
the system which are not required, but may result in incomplete information.
.IP "\fBgerror\fR"
Display general error messages.
These are non-fatal errors which are usually quite normal.
For instance, a certain type of query (such as a ioctl() call) of a device
fails because it's not supported on that particular model.
.IP "\fBcerror\fR"
Display critical errors which prevent 
.B SysInfo(tm)
from continuing further.
.IP "\fBdebug\fR"
Print debugging information.
Lots of information you normally don't want to see, but which is very 
valuable for debugging problems with
.B SysInfo(tm).
.RE
.IP "\fB\-msglevel \fImsglevel1,msglevel2,...\fR"
Set the level of messages that are shown.
.I msglevels
is a comma separated list of values used to determine what
levels of message will be displayed.
This is useful if you are running 
.B SysInfo(tm)
from a script
to obtain a few specific values (e.g. System Model, CPU Architecture, etc).
.IP "\fBbrief\fR"
More than 
.B terse
but less than 
.B all.
.IP "\fBgeneral\fR"
General level of information useful for a quick look at overall system 
configuration.
This is the default.
.IP "\fBdescriptions\fR"
Like
.B general
but with more descriptive information.
.IP "\fBconfig\fR"
Similar to 
.B general
and
.B descriptions
.RE
.IP "\fB\-noserial\fR"
Disable checking for duplicate devices using serial numbers.
Normally 
.B SysInfo
will check each device's serial number (if known) against the serial
number of each previously detected device of the same class and type.
If the serial numbers
match, the new device is ignored.
This check prevents devices which are dual-ported,
such as storage arrays,
from being shown more than once.
.IP "\fB\-nw\fR"
No windows.
Force 
.B SysInfo(tm)
to use it's command line interface (CLI) even if the environment is capable of
running the
.B SysInfo(tm)
GUI.
.IP "\fB\-list [ class|format|msgclass|msglevel|show|type ]\fR"
List the possible values that may be used with an option.
With no arguments are specified, a list is valid arguments is
displayed.
When an argument is supplied, the information specific to that
argument
is displayed.
.IP "\fB\-offset \fIamount\fR"
Set the number of spaces to offset (indent) when printing
device information.
.IP "\fB\-show \fIitem1,item2,...\fR"
Show information only about each comma separated item.
Run
.B "sysinfo \-list show"
for a list of valid item arguments.
If the
.B \-class
option is not specified, then the 
.B General
class is assumed.
.IP "\fB+|-swfiles\fP"
When 
.B \+swfiles
is specified and 
.B software
class information is being displayed, a list of files and file data is
displayed for all files belonging to each package.
The default is
.B (\-swfiles)
not to display file data.
.IP "\fB\-type \fIitem1,item2,...\fR"
Limit information to a specific type of item as specified by
.I item1,item2,...
Run 
.B "sysinfo \-list type"
for a list of valid item arguments.
.IP "\fB+|-unknown\fP"
Enable (\fB+unknown\fP) or disable (\fB\-unknown\fP) showing devices
that appear to be present on the system, but are not "known" to 
.B SysInfo(tm).
This option is disabled by default.
.IP "\fB+|-unused\fP"
Enable (\fB+unused\fP) or disable (\fB\-unused\fP) showing partitions
that do not appear to be in use.
The default is 
.B \-unused.
.IP "\fB+|-useconfig\fP"
Enable (\fB+useconfig\fP) or disable (\fB\-useconfig\fP) use of
configuration files.  This option is useful if you want to run
.B SysInfo(tm)
without having the configuration files installed.
Note that only certain types of information - such as some of the
.B General
values - will be available without use of configuration files.
The default is
\fB+useconfig\fP.
.IP "\fB+|-useprom\fP"
Enable (\fB+useprom\fP) or disable (\fB\-useprom\fP) using values
obtained from the system PROM instead of interpreting values obtained
directly from the kernel.
Certain values are normally obtained by looking up a variable in
the kernel and checking the result against a table of values compiled
.SH "GUI OPTIONS"
The following options apply only when the 
.B SysInfo(tm)
GUI is invoked:
.IP "\fB\-background \fIcolor\fR"
Set the window background to
.I color
where
.I color
is a system defined name such as 
.B orange
or a numeric representation as supported by the 
.B X(1)
RGB specification.
.IP "\fB\-display \fIname\fR"
Name of display to output to.
Default is current display.
.IP "\fB\-font \fIname\fR"
Set default font for text to be
.I name.
Default is 
.B arial.
.IP "\fB\-foreground \fIcolor\fR"
Similar to
.B \-background
but sets the window foreground color instead of the background color.
.IP "\fB\-geometry \fIgeometry\fR"
Specifies an
.B X(1)
geometry defining the size and/or location of the window.
The 
.I geometry
is of form 
\fIH\fBx\fW\fR[\fIXY\fR]
(i.e.
.B 400x600+20+25
which creates a 400 x 600 window at location 20x25)
where:
.RS
.IP "\fBH\fR"
Height in pixels.
.IP "\fBW\fR"
Width in pixels.
.IP "\fBX\fR"
The X (horizontal) offset in pixels preceded by a
.B +
to indicate positive offset or a
.B -
to indicate negative offset.
.IP "\fBY\fR"
Same as with
.B 
.nf
.B sysinfo -msglevel all
.fi
.RE
.PP
The following command formats data as
a hierarchical tree,
encodes the output as HTML,
and places it in a file called
.B result.html\fR:
.RS
.nf
.B sysinfo -format tree -encode html -output result.html
.fi
.RE
.PP
This command does the same as the previous example, but provides much
more detailed information:
.RS
.nf
.B sysinfo -format tree -encode html -output result.html -msglevel all
.fi
.RE
.PP
The following command formats data in columns and rows
and
encodes the output as text (the default):
.RS
.nf
.B sysinfo -format columns
.fi
.RE
.PP
The following command formats all classes and levels of 
data in columns and rows,
encodes the output as HTML,
and
writes the results to a file called
.B result.html\fR:
.RS
.nf
.B sysinfo -class all -msglevel all -format columns -encode html -output result.html
.fi
.RE
.PP
A very useful command to use when \fBDEBUGGING\fR 
.B SysInfo(tm)
is:
.RS
.nf
.B sysinfo -msglevel all -msgclass all,debug
.fi
.B sysinfo -class kernel
.fi
.RE
.PP
The following command provides the maximum amount of data in a 
software parsable format:
.RS
.nf
.B sysinfo -msglevel all -format report -repsep '|'
.fi
.RE

.SH AUTHOR
MagniComp
.br
http://www.MagniComp.com
.SH "URL"
.B http://www.magnicomp.com/sysinfo
.SH FILES
/opt/sysinfo/config	\- Directory of config files
.br
/etc/sysinfo.cf \- Master configuration file
.br
/etc/sysmodel	\- Explicitly set the CPU model name
.SH SEE ALSO
mcsysinfogui(1),
mcsysinforeport(1),
mcsysinfoc(3),
mcsysinfoperl(3),
mcsysinfocf(5),
gethostid(2), gethostname(2), gethostbyname(3)
.SH DIAGNOSTICS
.IP "\fI%x: Unknown CPU type.\fP"
The CPU model for the current host could not be determined.
.IP "(unknown)"
Information could not be determined for this item.
.SH BUGS
.PP
Not all operating systems support interfaces to various pieces of
information that 
.B MagniComp(tm)
.B SysInfo(tm)
supports.
.PP
Some devices, mostly devices that use 
removable media such as
tape drives and floppy disks, are only indicated (shown) as
present if media is loaded in the device and it's on-line.
This occurs because the OS does not provide a software
interface to query the device when media is not loaded.
.PP
.B SunOS 
.I libkvm.
Sun patch 
.B 102555-01
is suppose to fix this problem.
.B MagniComp(tm)
.B Sysinfo(tm) 
uses a new OBP interface in
.B "SunOS 5.5"
that by-passes this problem.
.PP
Under 
.B "SunOS 4.x"
the
.B "Serial Number"
field
is left blank since the kernel usually returns incorrect information.
.PP
Under
.B "SunOS 5.x"
the
.B "Serial Number"
field
will show the serial number as obtained from the system's
.B IDPROM.
This serial number has no correspondence with the system serial
number that appears on the back of your machine.
.PP
Under
.B SunOS
there is no way to tell the difference between an MC68020 (like the
3/60) and MC68030 (like the 3/80)
based machine.