share/man/man8/smbios.8

   1 '\" te
   2 .\" Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH SMBIOS 8 "Aug 31, 2005"
   7 .SH NAME
   8 smbios \- display the contents of a System Management BIOS image
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBsmbios\fR [\fB-BeOsx\fR] [\fB-i\fR \fIid\fR] [\fB-t\fR \fItype\fR] [\fB-w\fR \fIfile\fR] [\fIfile\fR]
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBsmbios\fR utility displays the contents of the System Management BIOS
  19 (SMBIOS) image exported by the current system or stored in a file. SMBIOS is an
  20 industry-standard mechanism for low-level system software to export hardware
  21 configuration information to higher-level system management software. The
  22 SMBIOS data format itself is defined by the Distributed Management Task Force
  23 (DMTF). Refer to http://www.dmtf.org for more information about SMBIOS and to
  24 obtain a copy of the SMBIOS specification and implementation guidelines.
  25 .sp
  26 .LP
  27 The SMBIOS image consists of a table of structures, each describing some aspect
  28 of the system software or hardware configuration. By default, \fBsmbios\fR
  29 displays the entire contents of the current SMBIOS image. If the \fB-s\fR
  30 option is specified, \fBsmbios\fR displays a summary of the structures that are
  31 present in the image. If the \fB-w\fR option is specified, \fBsmbios\fR writes
  32 a copy of the SMBIOS image to the specified file. \fBsmbios\fR can then be
  33 applied to the resulting file to display its content.
  34 .sp
  35 .LP
  36 \fBsmbios\fR attempts to display each structure and its content in a human-
  37 readable fashion. If \fBsmbios\fR does not recognize a structure's type or
  38 content, the raw hexadecimal data for the structure is displayed.
  39 .SH OPTIONS
  40 .sp
  41 .LP
  42 The following options are supported:
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fB-B\fR\fR
  47 .ad
  48 .RS 11n
  49 Disable header validation for broken BIOSes.
  50 .sp
  51 By default, \fBsmbios\fR attempts to validate the SMBIOS header by verifying
  52 the anchor strings, header checksums, and version number. This option might be
  53 necessary when a BIOS has a non-compliant header.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fB-e\fR\fR
  60 .ad
  61 .RS 11n
  62  Display the contents of the SMBIOS entry point rather than the contents of the
  63 SMBIOS structure table.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fB-i\fR \fIid\fR\fR
  70 .ad
  71 .RS 11n
  72 Display only the specified structure, named by its integer id.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fB-O\fR\fR
  79 .ad
  80 .RS 11n
  81  Display obsolete structure types.
  82 .sp
  83 By default, \fBsmbios\fR elides output for structures whose type is marked as
  84 obsolete in the DMTF SMBIOS specification.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fB-s\fR\fR
  91 .ad
  92 .RS 11n
  93 Display only a summary listing of the structure identifiers and types, instead
  94 of the content of each selected structure.
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fB-t\fR \fItype\fR\fR
 101 .ad
 102 .RS 11n
 103 Display only those structures whose type matches the specified integer type, as
 104 defined the DMTF SMBIOS specification.
 105 .RE
 106
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fB-w\fR \fIfile\fR\fR
 111 .ad
 112 .RS 11n
 113 Write a copy of the SMBIOS image to the specified file and exit.
 114 .sp
 115 The SMBIOS entry point is written to the start of the file with its structure
 116 table address set to the file offset of the structure table, and a new entry
 117 point checksum is computed.
 118 .RE
 119
 120 .sp
 121 .ne 2
 122 .na
 123 \fB\fB-x\fR\fR
 124 .ad
 125 .RS 11n
 126 Display raw hexadecimal data for the selected structures in addition to
 127 human-readable output.
 128 .sp
 129 By default, hexadecimal data is only displayed if \fBsmbios\fR cannot display
 130 human-readable output for the selected structures.
 131 .RE
 132
 133 .SH OPERANDS
 134 .sp
 135 .LP
 136 The following operands are supported:
 137 .sp
 138 .ne 2
 139 .na
 140 \fB\fIfile\fR\fR
 141 .ad
 142 .RS 8n
 143 Specifies an alternate SMBIOS image to display instead of the current system's
 144 SMBIOS image.
 145 .RE
 146
 147 .SH EXIT STATUS
 148 .sp
 149 .LP
 150 The following exit values are returned:
 151 .sp
 152 .ne 2
 153 .na
 154 \fB\fB0\fR \fR
 155 .ad
 156 .RS 6n
 157 Successful completion. All structures in the SMBIOS image were examined
 158 successfully.
 159 .RE
 160
 161 .sp
 162 .ne 2
 163 .na
 164 \fB\fB1\fR\fR
 165 .ad
 166 .RS 6n
 167 A fatal error occurred, such as failure to open the specified file or device,
 168 or corruption in the image.
 169 .RE
 170
 171 .sp
 172 .ne 2
 173 .na
 174 \fB\fB2\fR\fR
 175 .ad
 176 .RS 6n
 177 Invalid command-line options were specified.
 178 .RE
 179
 180 .SH FILES
 181 .sp
 182 .ne 2
 183 .na
 184 \fB\fB/dev/smbios\fR \fR
 185 .ad
 186 .RS 16n
 187 Kernel SMBIOS image device. This device special file is used to export a
 188 snapshot of the current system SMBIOS image.
 189 .RE
 190
 191 .SH ATTRIBUTES
 192 .sp
 193 .LP
 194 See \fBattributes\fR(5) for descriptions of the following attributes:
 195 .sp
 196
 197 .sp
 198 .TS
 199 box;
 200 c | c
 201 l | l .
 202 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 203 _
 204 Interface Stability     See below.
 205 .TE
 206
 207 .sp
 208 .LP
 209 The command-line options are Evolving. The human-readable output is Unstable.
 210 .SH SEE ALSO
 211 .sp
 212 .LP
 213 \fBprtdiag\fR(8), \fBattributes\fR(5), \fBsmbios\fR(7D)
 214 .sp
 215 .LP
 216 \fISystem Management BIOS Reference Specification\fR (see http://www.dmtf.org)
 217 .SH NOTES
 218 .sp
 219 .LP
 220 The implementation of a System Management BIOS image is entirely at the
 221 discretion of the system and BIOS vendors. Not all systems export an SMBIOS.
 222 The SMBIOS structure content varies widely between systems and BIOS vendors and
 223 frequently does not comply with the guidelines included in the specification.
 224 Some structure fields might not be filled in by the BIOS at all, and others
 225 might be filled inwith non-conforming values.