|
 |
4a6338 |
From 93763f99bb8404f17b177eb7cd62e7c6e8fdc14e Mon Sep 17 00:00:00 2001
|
|
|
4a6338 |
From: Jean Delvare <jdelvare@suse.de>
|
|
|
4a6338 |
Date: Tue, 29 Jan 2019 14:11:46 +0100
|
|
|
4a6338 |
Subject: [PATCH 03/11] Use comments to separate sections in manual pages
|
|
|
4a6338 |
|
|
|
4a6338 |
Blank lines are interpreted as actual blank lines in manual pages.
|
|
|
4a6338 |
Use comments instead to visually separate sections. Otherwise an
|
|
|
4a6338 |
extra blank like is inserted before every section.
|
|
|
4a6338 |
|
|
|
4a6338 |
Signed-off-by: Jean Delvare <jdelvare@suse.de>
|
|
|
4a6338 |
---
|
|
|
4a6338 |
man/biosdecode.8 | 11 ++++++++---
|
|
|
4a6338 |
man/dmidecode.8 | 18 +++++++++++-------
|
|
|
4a6338 |
man/ownership.8 | 10 +++++++---
|
|
|
4a6338 |
man/vpddecode.8 | 12 +++++++-----
|
|
|
4a6338 |
4 files changed, 33 insertions(+), 18 deletions(-)
|
|
|
4a6338 |
|
|
|
4a6338 |
diff --git a/man/biosdecode.8 b/man/biosdecode.8
|
|
|
4a6338 |
index a96eb681c136..cf7d4db01249 100644
|
|
|
4a6338 |
--- a/man/biosdecode.8
|
|
|
4a6338 |
+++ b/man/biosdecode.8
|
|
|
4a6338 |
@@ -1,10 +1,12 @@
|
|
|
4a6338 |
.TH BIOSDECODE 8 "February 2007" "dmidecode"
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH NAME
|
|
|
4a6338 |
biosdecode \- \s-1BIOS\s0 information decoder
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH SYNOPSIS
|
|
|
4a6338 |
.B biosdecode
|
|
|
4a6338 |
.RB [ OPTIONS ]
|
|
|
4a6338 |
-
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH DESCRIPTION
|
|
|
4a6338 |
.B biosdecode
|
|
|
4a6338 |
parses the \s-1BIOS\s0 memory and prints information about all structures (or
|
|
|
4a6338 |
@@ -54,7 +56,7 @@ started its life as a part of
|
|
|
4a6338 |
.B dmidecode
|
|
|
4a6338 |
but as more entry point types were added, it was moved to a different
|
|
|
4a6338 |
program.
|
|
|
4a6338 |
-
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH OPTIONS
|
|
|
4a6338 |
.TP
|
|
|
4a6338 |
.BR "-d" ", " "--dev-mem FILE"
|
|
|
4a6338 |
@@ -68,17 +70,20 @@ Display usage information and exit
|
|
|
4a6338 |
.TP
|
|
|
4a6338 |
.BR "-V" ", " "--version"
|
|
|
4a6338 |
Display the version and exit
|
|
|
4a6338 |
-
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH FILES
|
|
|
4a6338 |
.I /dev/mem
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH BUGS
|
|
|
4a6338 |
Most of the time,
|
|
|
4a6338 |
.B biosdecode
|
|
|
4a6338 |
prints too much information (you don't really care about addresses)
|
|
|
4a6338 |
or not enough (because it doesn't follow pointers and has no lookup
|
|
|
4a6338 |
tables).
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH AUTHORS
|
|
|
4a6338 |
Alan Cox, Jean Delvare
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH "SEE ALSO"
|
|
|
4a6338 |
.BR dmidecode (8),
|
|
|
4a6338 |
.BR mem (4),
|
|
|
4a6338 |
diff --git a/man/dmidecode.8 b/man/dmidecode.8
|
|
|
4a6338 |
index 52100a82435e..1f6529d99e91 100644
|
|
|
4a6338 |
--- a/man/dmidecode.8
|
|
|
4a6338 |
+++ b/man/dmidecode.8
|
|
|
4a6338 |
@@ -1,10 +1,12 @@
|
|
|
4a6338 |
.TH DMIDECODE 8 "January 2019" "dmidecode"
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH NAME
|
|
|
4a6338 |
dmidecode \- \s-1DMI\s0 table decoder
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH SYNOPSIS
|
|
|
4a6338 |
.B dmidecode
|
|
|
4a6338 |
.RB [ OPTIONS ]
|
|
|
4a6338 |
-
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH DESCRIPTION
|
|
|
4a6338 |
.B dmidecode
|
|
|
4a6338 |
is a tool for dumping a computer's \s-1DMI\s0 (some say \s-1SMBIOS\s0) table
|
|
|
4a6338 |
@@ -58,7 +60,7 @@ displayed value.
|
|
|
4a6338 |
Decoded values. The information presented of course depends on the type
|
|
|
4a6338 |
of record. Here, we learn about the board's manufacturer, model, version
|
|
|
4a6338 |
and serial number.
|
|
|
4a6338 |
-
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH OPTIONS
|
|
|
4a6338 |
.TP
|
|
|
4a6338 |
.BR "-d" ", " "--dev-mem FILE"
|
|
|
4a6338 |
@@ -158,10 +160,9 @@ is run on a system with BIOS that boasts new SMBIOS specification, which
|
|
|
4a6338 |
is not supported by the tool yet, it will print out relevant message in
|
|
|
4a6338 |
addition to requested data on the very top of the output. Thus informs the
|
|
|
4a6338 |
output data is not reliable.
|
|
|
4a6338 |
-
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH "DMI TYPES"
|
|
|
4a6338 |
The \s-1SMBIOS\s0 specification defines the following \s-1DMI\s0 types:
|
|
|
4a6338 |
-
|
|
|
4a6338 |
.TS
|
|
|
4a6338 |
r l
|
|
|
4a6338 |
__
|
|
|
4a6338 |
@@ -246,7 +247,7 @@ dmidecode --type 0,13
|
|
|
4a6338 |
dmidecode --type bios
|
|
|
4a6338 |
.IP \(bu
|
|
|
4a6338 |
dmidecode --type BIOS
|
|
|
4a6338 |
-
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH BINARY DUMP FILE FORMAT
|
|
|
4a6338 |
The binary dump files generated by --dump-bin and read using --from-dump
|
|
|
4a6338 |
are formatted as follows:
|
|
|
4a6338 |
@@ -255,7 +256,7 @@ The SMBIOS or DMI entry point is located at offset 0x00.
|
|
|
4a6338 |
It is crafted to hard-code the table address at offset 0x20.
|
|
|
4a6338 |
.IP \(bu "\w'\(bu'u+1n"
|
|
|
4a6338 |
The DMI table is located at offset 0x20.
|
|
|
4a6338 |
-
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH UUID FORMAT
|
|
|
4a6338 |
There is some ambiguity about how to interpret the UUID fields prior to SMBIOS
|
|
|
4a6338 |
specification version 2.6. There was no mention of byte swapping, and RFC 4122
|
|
|
4a6338 |
@@ -269,7 +270,7 @@ compatibility, it was decided to interpret the UUID fields according to RFC
|
|
|
4a6338 |
4122 (no byte swapping) when the SMBIOS version is older than 2.6, and to
|
|
|
4a6338 |
interpret the first 3 fields as little-endian (byte-swapped) when the SMBIOS
|
|
|
4a6338 |
version is 2.6 or later. The Linux kernel follows the same logic.
|
|
|
4a6338 |
-
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH FILES
|
|
|
4a6338 |
.I /dev/mem
|
|
|
4a6338 |
.br
|
|
|
4a6338 |
@@ -278,11 +279,14 @@ version is 2.6 or later. The Linux kernel follows the same logic.
|
|
|
4a6338 |
.br
|
|
|
4a6338 |
.I /sys/firmware/dmi/tables/DMI
|
|
|
4a6338 |
(Linux only)
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH BUGS
|
|
|
4a6338 |
More often than not, information contained in the \s-1DMI\s0 tables is inaccurate,
|
|
|
4a6338 |
incomplete or simply wrong.
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH AUTHORS
|
|
|
4a6338 |
Alan Cox, Jean Delvare
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH "SEE ALSO"
|
|
|
4a6338 |
.BR biosdecode (8),
|
|
|
4a6338 |
.BR mem (4),
|
|
|
4a6338 |
diff --git a/man/ownership.8 b/man/ownership.8
|
|
|
4a6338 |
index f24ef9437e21..71ed78844081 100644
|
|
|
4a6338 |
--- a/man/ownership.8
|
|
|
4a6338 |
+++ b/man/ownership.8
|
|
|
4a6338 |
@@ -1,10 +1,12 @@
|
|
|
4a6338 |
.TH OWNERSHIP 8 "February 2005" "dmidecode"
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH NAME
|
|
|
4a6338 |
ownership \- Compaq ownership tag retriever
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH SYNOPSIS
|
|
|
4a6338 |
.B ownership
|
|
|
4a6338 |
.RB [ OPTIONS ]
|
|
|
4a6338 |
-
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH DESCRIPTION
|
|
|
4a6338 |
.B ownership
|
|
|
4a6338 |
retrieves and prints the "ownership tag" that can be set on Compaq
|
|
|
4a6338 |
@@ -14,7 +16,7 @@ package,
|
|
|
4a6338 |
.B ownership
|
|
|
4a6338 |
doesn't print any version information, nor labels, but only the raw
|
|
|
4a6338 |
ownership tag. This should help its integration in scripts.
|
|
|
4a6338 |
-
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH OPTIONS
|
|
|
4a6338 |
.TP
|
|
|
4a6338 |
.BR "-d" ", " "--dev-mem FILE"
|
|
|
4a6338 |
@@ -25,11 +27,13 @@ Display usage information and exit
|
|
|
4a6338 |
.TP
|
|
|
4a6338 |
.BR "-V" ", " "--version"
|
|
|
4a6338 |
Display the version and exit
|
|
|
4a6338 |
-
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH FILES
|
|
|
4a6338 |
.I /dev/mem
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH AUTHOR
|
|
|
4a6338 |
Jean Delvare
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH "SEE ALSO"
|
|
|
4a6338 |
.BR biosdecode (8),
|
|
|
4a6338 |
.BR dmidecode (8),
|
|
|
4a6338 |
diff --git a/man/vpddecode.8 b/man/vpddecode.8
|
|
|
4a6338 |
index c9e4acfd2fb9..1cc2b76ce552 100644
|
|
|
4a6338 |
--- a/man/vpddecode.8
|
|
|
4a6338 |
+++ b/man/vpddecode.8
|
|
|
4a6338 |
@@ -1,10 +1,12 @@
|
|
|
4a6338 |
.TH VPDDECODE 8 "February 2007" "dmidecode"
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH NAME
|
|
|
4a6338 |
vpddecode \- \s-1VPD\s0 structure decoder
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH SYNOPSIS
|
|
|
4a6338 |
.B vpddecode
|
|
|
4a6338 |
.RB [ OPTIONS ]
|
|
|
4a6338 |
-
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH DESCRIPTION
|
|
|
4a6338 |
.B vpddecode
|
|
|
4a6338 |
prints the "vital product data" information that can be found in almost
|
|
|
4a6338 |
@@ -17,19 +19,17 @@ Box Serial Number
|
|
|
4a6338 |
Motherboard Serial Number
|
|
|
4a6338 |
.IP \(bu
|
|
|
4a6338 |
Machine Type/Model
|
|
|
4a6338 |
-
|
|
|
4a6338 |
.PP
|
|
|
4a6338 |
Some systems have these additional items:
|
|
|
4a6338 |
.IP \(bu "\w'\(bu'u+1n"
|
|
|
4a6338 |
BIOS Release Date
|
|
|
4a6338 |
.IP \(bu
|
|
|
4a6338 |
Default Flash Image File Name
|
|
|
4a6338 |
-
|
|
|
4a6338 |
.PP
|
|
|
4a6338 |
Note that these additional items are not documented by IBM, so this is
|
|
|
4a6338 |
guess work, and as such should not be blindly trusted. Feedback about
|
|
|
4a6338 |
the accuracy of these labels is welcome.
|
|
|
4a6338 |
-
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH OPTIONS
|
|
|
4a6338 |
.TP
|
|
|
4a6338 |
.BR "-d" ", " "--dev-mem FILE"
|
|
|
4a6338 |
@@ -62,11 +62,13 @@ Display usage information and exit
|
|
|
4a6338 |
.TP
|
|
|
4a6338 |
.BR "-V" ", " "--version"
|
|
|
4a6338 |
Display the version and exit
|
|
|
4a6338 |
-
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH FILES
|
|
|
4a6338 |
.I /dev/mem
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH AUTHOR
|
|
|
4a6338 |
Jean Delvare
|
|
|
4a6338 |
+.\"
|
|
|
4a6338 |
.SH "SEE ALSO"
|
|
|
4a6338 |
.BR biosdecode (8),
|
|
|
4a6338 |
.BR dmidecode (8),
|
|
|
4a6338 |
--
|
|
|
4a6338 |
2.17.1
|
|
|
4a6338 |
|