list

Synopsis

opendmi [global options] list [command options] [filter options]

Description

The list command prints one line per structure, giving its handle, its type and the name of that type, in the order of the table. It is the way to find out what a table holds before asking opendmi-show for the details of a particular structure.

Which structures are listed is decided by the filter options, which are common to opendmi-show and opendmi-export. By default the standard and the OEM-specific structures are listed, and the inactive and the unknown ones are not.

Options

-?, -h, --help: Print help and exit.
-r, --raw: Print the fields separated by tabs rather than aligned in columns, so that the output is easy to read with cut(1) or awk(1). This is the default when the standard output is not a terminal.

Filter options

-H handle, --handle=handle: Only list the structures with the given handle, which is read as a hexadecimal number, with or without the 0x prefix. The option may be given several times.
-t type, --type=type: Only list the structures of the given type, which is either a number or a code name, e.g. 4 or processor. The option may be given several times. See opendmi-types for the types and their codes.
-s, --standard: List the structures of the types the specification defines.
-S, --no-standard: Do not list the structures of the types the specification defines.
-e, --oem: List the OEM-specific structures, which are the ones of types 128 to 255.
-E, --no-oem: Do not list the OEM-specific structures.
-i, --inactive: List the structures which the firmware has marked as inactive (type 126).
-I, --no-inactive: Do not list the inactive structures.
-u, --unknown: List the structures of the types no enabled module describes, which are left as raw data.
-U, --no-unknown: Do not list the structures of the unknown types.
-m module, --module=module: Only list the structures described by the named module, whatever type numbers the platform places them at. The module has to be enabled, either for the platform or with the global --module option, or else nothing it describes is decoded. The option may be given several times.
-M, --all-modules: Only list the structures described by the enabled modules.
-a, --all: List every structure, including the inactive and the unknown ones.

Exit status

0: Structures have been listed.
1: Data could not be read.
2: Command line is invalid.

Examples

List the structures of the local platform:

$ opendmi list

List everything a dump holds, including the structures no module describes:

$ opendmi -i smbios.bin list -a

Count the memory devices:

$ opendmi list -t memory-device -r | wc -l