.\" 
.TH mcsysinforeport 1 "15 March 2002"
.ds ]W www.MagniComp.com
.SH NAME
mcsysinforeport \- MagniComp(tm) SysInfo(tm) report output format
.SH SYNOPSIS
sysinfo \-repsep '|' -format report
.SH "DESCRIPTION"
.PP
The output from
.B "-format report"
is intended to be most parsable by software, not humans.
The report format consists of multiple fields each seperated by the
.B |
(vertical pipe)
character.
Entry entry is terminated by a newline.
Each field may optionally begin and/or end with white-space (any
combination of <SPACE> and/or <TAB> characters).  
An empty field consists of no characters or only white-space appearing
between field seperators.
The content of a used field may consist of any printable ASCII character
set including, but not limited to:
.RS
.nf 
.B "a-z A-Z 0-9 <SPACE> <TAB> ..."
.fi
.RE
.PP
The first field specifies the class of information being provided.
Each class uses the remaining fields in the same general, but
varying manner
as follows:
.IP "\fIField 0 - Class\fR"
This field names the class of information being provided.  Values
correspond explicitly to 
.B "-class"
values as follows:
.RS
.IP \fBdevice\fR
Device (hardware) configuration information.
.IP \fBgeneral\fR
General information about system.
.IP \fBkernel\fR
Kernel configuration information.
.IP \fBpartition\fR
Filesystem and disk partition configuration information.
.IP \fBprinter\fR
All printer queues defined on the system both local and remote.
.IP \fBsoftware\fR
Software which is installed and registered with the OS.
.IP \fBsysconf\fR
Describes an attribute.
.IP \fBpart\fR
Remaining entry describes a 
.I partition.
.IP \fBfile\fR
Remaining entry describes a file and it's attributes.
.IP \fBtotaldisk\fR
Provides the total amount of disk space discovered.
.RE
.IP "\fIField 2 - Variable\fR"
Specifies the name of a variable which the remaining fields describe.
.IP "\fIField 3 - Value\fR"
Specifies a value of some type.
.IP "\fIField 4 - ...\fR"
The remaining fields vary in number and content based upon the
.I "Field 1 - Class"
value.
.RE
.SS "Class device"
When 
.I "Field 0"
is set to
.B device,
the information being described are individual device (hardware)
entries.
There are multiple forms of a
.B device
entry.
Each form is specified by the
.I "Field 1 Sub-Class"
field.
Each form is described in it's entirety below:

.B "Canonical definetion of a device:"
.RS
.IP "\fIField 0 - \fBdevice\fR"
The word
.B device
specifies the usage described in this section.
.IP "\fIField 1 - \fBname\fR"
The canonical definetion of a device.
.IP "\fIField 2 - Name\fR"
Specifies the name of this device.
.IP "\fIField 3 - Alt Name\fR"
A alternative name by which this device is known.
.IP "\fIField 4 - Master Name\fR"
The name of this device's master.
.IP "\fIField 5 - File List\fR"
A comma seperated list of filenames associated with this device.
.IP "\fIField 6 - Type Name\fR"
A name describing the type of device.
Each name corresponds to DT_* and DTN_* values in 
.IP "\fIField 13 - Vec\fR"
The device's kernel vector.
Generally obsolete.
.IP "\fIField 14 - Node ID\fR"
The device's unique node ID relative to the OS.
.IP "\fIField 15 - Class Name\fR"
A name describing the classification of this device relative to it's
.I Type.
These values correspond to CT_* definetions in 
.I mcsysinfo.h.
i.e.
.B SCSI,
.B IDE,
.B USB,
etc.
.IP "\fIField 16 - Class Description\fR"
A more verbose description of the device's class.
.IP "\fIField 17 - Vendor\fR"
The name of the device's vendor.
.IP "\fIField 18 - Serial #\fR"
The device's serial number.
.IP "\fIField 19 - Revision\fR"
The revision of the device.
.IP "\fIField 20 - Identifier\fR"
The device's identifier.
.IP "\fIField 21 - Part #\fR"
The part number of the device as assigned by the manufacturer.
.IP "\fIField 22 - Next Name\fR"
The name of the next device (relative to the parent) of the device hierarchy
tree.
.IP "\fIField 23 - Slave Names\fR"
The comma seperated
list of slave (children) device node names of the device hierarchy.
.IP "\fIField 24 - Capacity\fR"
The capacity (size) of the device in device specific units.
.IP "\fIField 25 - Speed\fR"
The speed of the device in device specific units.
.IP "\fIField 26 - Bus\fR"
The bus number the device is attached to.
.IP "\fIField 27 - DevNum\fR"
The device number which identifies the device.
.IP "\fIField 28 - Port\fR"
The port number the device is connected to on the bus.
.RE

.B "CpuInfo Information"
.PP
Detailed information about a CPU is indicated when field 0
is set to the word
.B device
and field 1 is set to the word
.B cpuinfo.
i.e.
.B Intel
.IP "\fIField 4 - Model\fR"
The model of CPU.
i.e. 
.B Pentium-4
.IP "\fIField 5 - Arch\fR"
The architecture of the CPU.
i.e.
.B i686
.IP "\fIField 6 - ArchVer\fR"
The version of the
CPU's architecture.
i.e.
.B IA32
.IP "\fIField 7 - Serial\fR"
The serial number of the CPU.
.IP "\fIField 8 - BitSize\fR"
The bitsize of the CPU.
i.e.
.B 32
.IP "\fIField 9 - Speed\fR"
The clock speed of the CPU.
i.e.
.B "1.1 GHz"
.IP "\fIFields 10-25\fR"
These fields are obsolete.
.IP "\fIField 26 - Has FPU\fR"
Value of
.B 1
if a Floating Point Unit (FPU) is present.
.IP "\fIField 27 - Stepping\fB"
The CPU's stepping value.
.RE

.B "CacheInfo Information"
.PP
Detailed information about a CPU is indicated when field 0
is set to the word
.B device
and field 1 is set to the word
.B cacheinfo.
The following describes the meaning of each field:
.RS
.IP "\fIField 0 - \fBdevice\fR"
The word
.B device
specifies the usage described in this section.
.IP "\fIField 1 - \fBcacheinfo\fR"
The word
.B cacheinfo
further specifies the usage described in this section.
.IP "\fIField 5 - Associativety\fR"
The associativety of the cache.
i.e.
.B 2
.IP "\fIField 6 - Lines\fR"
The number of lines of the cache.
i.e.
.B 1
.IP "\fIField 7 - Line Size\fR"
The size of each cache line.
i.e.
.B 64
.IP "\fIField 8 - TLB\fR"
The CPU's instruction TLB.
.IP "\fIField 9 - TLB Associativety\fR"
The CPU's instruction TLB associativety.
.IP "\fIField 10 - Enabled\fR"
If this field is set to 
.B 1
the cache is present and enabled.
If set to
.B 0
the cache is present, but not enabled.
If the field is unset the state is unknown.
.IP "\fIField 11 - Type\fR"
The type of cache:
.RS
.IP \fB1\fR
Instruction
.IP \fB2\fR
Data
.IP \fB3\fR
Unified
.RE
.IP "\fIField 12 - Level\fR"
The level of cache.
i.e.
.B 1
indicates L1.
.IP "\fIField 13 - Speed\fR"
The speed of the cache in nano-seconds.
.IP "\fIField 14 - Socketed\fR"
If set to 
.B 1
the cache is socketed to the CPU.
If set to 0
the cache is not socketed.
If unset, the state is unknown.
.IP "\fIField 15 - Location\fR"
The location of the cache.
.IP "\fIField 16 - SramType\fR"
The type of SRAM present.
Unclassified information about a device is provided in the form of 
a description and it's value.  The content of each field is free form
text and varies from OS to OS.  It should not be relied upon for 
consistency.
The fields are defined as follows:
.RS
.IP "\fIField 0 - \fBdevice\fR"
The word
.B device
specifies the usage described in this section.
.IP "\fIField 1 - \fBdesc\fR"
This entry provides additional, unclassified descriptive information
about this entry.
.IP "\fIField 2 - Name\fR"
Specifies the name of this entry.
.IP "\fIField 3 - Description\fR"
The description of the entry.
.IP "\fIField 4 - Value\fR"
The value of the description.
.RE

.B "NetIf Information"
.PP
Detailed information about a Network InterFace is indicated when field 0
is set to the word
.B device
and field 1 is set to the word
.B desc
and field 3 is set to the word
.B internet.
The following describes the meaning of each field:
.RS
.IP "\fIField 0 - \fBdevice\fR"
The word
.B device
specifies the usage described in this section.
.IP "\fIField 1 - \fBdesc\fR"
The word
.B desc
further specifies the usage described in this section.
.IP "\fIField 3 - \fBinternet\fR"
The word
.B internet
specifies the type of address being described.
.IP "\fIField 4 - HostAddr\fR"
Specifies the host address (usually IP) of the interface.
.IP "\fIField 5 - HostName\fR"
Specifies the host name of the interface.
.IP "\fIField 6 - NetAddr\fR"
Specifies the network address (usually IP) of the interface.
.IP "\fIField 7 - NetName\fR"
Specifies the network name of the interface.
.B general,
the following describes the usage of each field:
.RS
.IP "\fIField 0 - \fBgeneral\fR"
The word
.B general
specifies the usage described in this section.
.IP "\fIField 1 - unused\fR"
This field is unused.
.IP "\fIField 2 - Variable\fR"
Names the variable being described.
The variable matches the valid values for
.B -show
.I variable.
.IP "\fIField 3 - Description\fR"
Descriptive text of the 
.I variable.
.IP "\fIField 4 - Value\fR"
The value of this entry.
.RE

.SS "Class kernel"
When 
.I "Field 0"
is set to
.B kernel,
the following describes the usage of each field:
.RS
.IP "\fIField 0 - \fBkernel\fR"
The word
.B kernel
specifies the usage described in this section.
.IP "\fIField 1 - unused\fR"
This field is unused.
.IP "\fIField 2 - Variable\fR"
Names the variable being described.
The variable matches the valid values for
.B -show
.I variable.
.IP "\fIField 3 - Description\fR"
Descriptive text of the 
.I variable.
.IP "\fIField 4 - Value\fR"
The value of this entry.
.RE

.SS "Class partition"
When 
.I "Field 0"
is set to
.B partition,
information on filesystems and partitions are reported
The name of this partition entry relative to the
.I "Device Name/Path".
i.e
.B sda1
.IP "\fIField 4 - Base Name\fR"
The base filename of the Device Name or Path.
i.e.
.B sda1
.IP "\fIField 5 - Partition Number\fR"
The numeric partition number relative to this
.I "Device Name/Path".
i.e.
.B 1
.IP "\fIField 6 - Raw Device Path\fR"
The pathname of the raw device for this entry.
i.e.
.B /dev/rsda1
.IP "\fIField 7 - Type Name\fR"
A short name describing the type of partition this is.
i.e. 
.B EXTDOS,
.B ufs.
.IP "\fIField 8 - Type Description\fR"
A more verbose description of the type of partition.
i.e.
.B "Extended DOS".
.IP "\fIField 9 - Type Number\fR"
A numeric value representing the partition type.
.IP "\fIField 10 - Usage Status\fR"
Description of how this partition is being used.
i.e.
.B FILESYSTEM,
.B SWAP
.IP "\fIField 11 - Mount Name\fR"
If this partition contains a filesystem, then this field
describes the mounted name of the partition.
i.e. 
.B /export
.IP "\fIField 12 - Mount Options\fR"
If this is a mounted filesystem, this field describes any options used
to mount the filesystem.
.IP "\fIField 13 - Size\fR"
The total size of this partition in bytes.
.IP "\fIField 14 - Amount Used\fR"
The total amount of used space on this partition in bytes.
.IP "\fIField 15 - Sector Size\fR"
The size of a single sector in bytes.
.IP "\fIField 16 - Starting Sector\fR"
The sector number this partition starts on.
.IP "\fIField 17 - Ending Sector\fR"
The sector number this partition ends on.
.IP "\fIField 18 - Number of Sectors\fR"
is described in it's entirety below:

.RS
.B "Canonical definetion of a printer:"
.IP "\fIField 0 - \fBprinter\fR"
The word
.B printer
specifies this entry.
.IP "\fIField 1 - \fBname\fR"
The word
.B name
indicates that this entry contains the primary information regarding a printer.
.IP "\fIField 2 - Queue\fR"
The canonical name of this printer queue.
.IP "\fIField 3 - Aliases\fR"
A comma seperated list of aliases for this printer.
.IP "\fIField 4 - Description\fR"
A text description of this printer queue.
The format is usually site dependent.
.IP "\fIField 5 - Vendor\fR"
The name of the vendor who manufactures or sells this printer.
.IP "\fIField 6 - Model\fR"
The model of printer.
.IP "\fIField 7 - Protocol\fR"
The protocol used to connect to this printer.
Valid names are:
.RS
.IP "\fBLocal\fR"
The printer is attached to a local device such as a serial or parallel port.
.IP "\fBLPD\fR"
The printer is on a remote server which uses the
.B LPD
protocol for communication.
.IP "\fBSYSV\fR"
The printer is on a remote server which uses the AT&T System V printer
protocol.
.IP "\fBSMB\fR"
The printer is on a remote server which uses the Windows SMB printer protocol.
.RE
.IP "\fIField 7 - Device\fR"
The name or path of the local device, if any, on which the printer is
attached.
.IP "\fIField 8 - Server\fR"
The name of the remote server, if any, which provides service for the
printer.
.IP "\fIField 9 - RemoteQueue\fR"
The name of the remote queue on the remote
.I Server
.IP "\fIField 10 - Languages\fR"
A comma seperated list of printer languages which the printer supports.
.IP "\fIField 11 - SpoolDir\fR"
The name of the local directory used for 
about a printer entry.
.IP "\fIField 2 - Name\fR"
Specifies the name of the printer.
.IP "\fIField 3 - Description\fR"
The description of the entry.
.IP "\fIField 4 - Value\fR"
The value of the description.
.RE

.SS "Class software"
When 
.I "Field 0"
is set to
.B software,
the information being described are individual software packages.
There are multiple forms of a
.B software
entry.
Each form is specified by the
.I "Field 1 Sub-Class"
field and is described in it's entirety below:

.RS
.B "Canonical definetion of a software package:"
.IP "\fIField 0 - \fBsoftware\fR"
The word
.B software
specifies the usage described in this section.
.IP "\fIField 1 - \fBname\fR"
The canonical definetion of a software package.
.IP "\fIField 2 - Name\fR"
Specifies the name of this software package.
.IP "\fIField 3 - Type\fR"
Specifies the type of software entry as follows:
.RS
.IP \fBpkg\fR
The entry is a software package, the lowest level component.
.IP \fBproduct\fR
The entry represents an entire software product which is typically
composed of one or more software packages (pkg).
.RE
.IP "\fIField 4 - Name\fR"
Specifies the name of this software package.
This is a duplicate of field 2.
.IP "\fIField 5 - Version\fR"
The version of this software entry.
.IP "\fIField 6 - Revision\fR"
The revision of this software entry.
.IP "\fIField 7 - Desc\fR"
A brief (single-line) description of this software entry.
.IP "\fIField 8 - URL\fR"
A URL associated with this software entry.
.B SPARCV8
.IP "\fIField 15 - ISArch\fR"
The instruction set architecture (platform) this software runs on.
This is the more general platform of which the
.I Arch
is a member.
i.e.
.B IA-32,
.B SPARC
.IP "\fIField 16 - Install Date\fR"
The date the software was installed.
.IP "\fIField 17 - Build Date\fR"
The date the software was built and packaged.
.IP "\fIField 18 - Production Stamp\fR"
Some type of identifier generated by the software producer.
.IP "\fIField 19 - Base Dir\fR"
The base directory under which the software is installed.
.IP "\fIField 20 - Disk Usage\fR"
The amount of disk space this software requires for installation.
.IP "\fIField 21 - Vendor Name\fR"
The name of the vendor who produced the software.
.IP "\fIField 22 - Vendor Email\fR"
The vendor's email address.
.IP "\fIField 23 - Vendor Phone\fR"
The vendor's phone number.
.IP "\fIField 24 - Vendor Stock\fR"
The vendor's stock/identifier for this software.
.IP "\fIField 25 - Master Name\fR"
The name of the software entry to which this entry belongs.
Typically this is the package's product entry.
.IP "\fIField 26 - Master Version\fR"
The master's version.
.IP "\fIField 27 - Master Revision\fR"
The master's revision.
.IP "\fIField 28 - Desc Verbose\fR"
A verbose description describing the product.  Newlines are indicated
by 
.B \\n
strings embedded in the field.
.IP "\fIField 29 - Copyright\fR"
A copyright statement for the product.  Newlines are indicated
by 
.B \\n
strings embedded in the field.
.IP "\fIField 30 - Next\fR"
The name of the next software entry in the hierarchy.
.IP "\fIField 31 - Slaves\fR"
A comma seperated list of software entries for which this entry is the
parent.
.RE
.RS
.B "Additional information:"

.SS "Class sysconf"
When 
.I "Field 0"
is set to
.B sysconf,
the following describes the usage of each field:
.RS
.IP "\fIField 0 - \fBsysconf\fR"
The word
.B sysconf
specifies the usage described in this section.
.IP "\fIField 1 - unused\fR"
This field is unused.
.IP "\fIField 2 - Variable\fR"
Names the variable being described.
The variable matches the valid values for
.B -show
.I variable.
.IP "\fIField 3 - Description\fR"
Descriptive text of the 
.I variable.
.IP "\fIField 4 - Value\fR"
The value of this entry.
.RE

.SH NOTES
The 
.B "-format report"
format is subject to additive changes.
That is, the placement of existing fields will not be changed, but new
fields may be added.  If a field is made obsolete, it's position in
the output will remain, but the content will be empty.
.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
.SH SEE ALSO
sysinfo(1),
mcsysinfoc(3),
mcsysinfoperl(3),
sysinfo.cf(5),