Blame SOURCES/intel-microcode2ucode.8.in

1abd92
.\" intel-microcode2ucode stub man page
1abd92
.\"
1abd92
.\" SPDX-License-Identifier: CC0-1.0
1abd92
.\"
1abd92
.TH INTEL-MICROCODE2UCODE 8 "@DATE@" "MICROCODE_CTL @VERSION@"
1abd92
.\"
1abd92
.SH NAME
1abd92
intel\-microcode2ucode \- convert Intel microcode.dat file into ucode files
1abd92
.\"
1abd92
.SH SYNOPSIS
1abd92
.SY intel\-microcode2ucode
1abd92
.RI [ MICROCODE_FILE ]
1abd92
.YS
1abd92
.\"
1abd92
.SH DESCRIPTION
1abd92
.B intel\-microcode2ucode
1abd92
parses Intel microcode combined text data file (which usually has name
1abd92
.BR microcode.dat )
1abd92
and splits it into individual binary microcode files that can be loaded by the
1abd92
Linux kernel.
1abd92
.LP
1abd92
Generated microcode files are placed into
1abd92
.B intel-ucode
1abd92
directory, which is created in the current working directory, and have file name
1abd92
format of
1abd92
.IR FF - MM - SS ,
1abd92
where
1abd92
.I FF
1abd92
is the CPU family number,
1abd92
.I MM
1abd92
is the model number, and
1abd92
.I SS
1abd92
is stepping.
1abd92
All three values are zero-filled to two digits and are hexadecimal
1abd92
(letters are in the lower case).
1abd92
.LP
1abd92
This tool is mostly of historic interest, as Intel ships separate microcode
1abd92
files now.
1abd92
.\"
1abd92
.SH OPTIONS
1abd92
.\"
1abd92
.TP
1abd92
.I MICROCODE_FILE
1abd92
Path to the
1abd92
.B microcode.dat
1abd92
file.
1abd92
If no path has been provided, the default path
1abd92
.B /lib/firmware/microcode.dat
1abd92
is used.
1abd92
If
1abd92
.B -
1abd92
(single dash) is provided as an argument, data is read from the standard input.
1abd92
.\"
1abd92
.SH EXIT STATUS
1abd92
.TP
1abd92
.B 0
1abd92
Success.
1abd92
.TP
1abd92
.B 1
1abd92
Error occurred:
1abd92
temporary buffer cannot be allocated,
1abd92
input microcode file cannot be opened,
1abd92
microcode version and/or format are unknown,
1abd92
cannot open output file,
1abd92
cannot write to the output file.
1abd92
.\"
1abd92
.SH REPORTING BUGS
1abd92
Problems with
1abd92
.B intel-microcode2ucode
1abd92
should be reported to
1abd92
.UR https://bugzilla.redhat.com/
1abd92
Red Hat Bugzilla
1abd92
.UE
1abd92
.\"
1abd92
.SH AUTHORS
1abd92
.B intel-microcode2ucode
1abd92
was written by
1abd92
Kay Sievers <kay.sievers@vrfy.org> and
1abd92
Anton Arapov <anton@redhat.com>.
1abd92
This manpage was written for Red Hat Enterprise Linux and may be
1abd92
used, modified, and/or distributed freely by anyone.
1abd92
.\"
1abd92
.SH "SEE ALSO"
1abd92
.UR https://gitlab.com\:/iucode-tool\:/iucode-tool
1abd92
iucode-tool, a tool for manipulating Intel microcode files
1abd92
.UE ,
1abd92
.LP
1abd92
.UR @MICROCODE_URL@
1abd92
Intel microcode
1abd92
.UE