Adding man pages from upstream. Sooner or later, these will be removed, as will

all other work that's simply replicating the demidecode binary.  All this
package should provide is the python module, and some py-module-specific man
pages.


git-svn-id: svn://svn.autonomy.net.au/python-dmidecode@84 abc39116-655e-4be6-ad55-d661dc543056

1 files changed, 74 insertions, 0 deletions

diff --git a/man/vpddecode.8 b/man/vpddecode.8
new file mode 100644
index 0000000..c9e4acf
--- /dev/null
+++ b/man/vpddecode.8
@@ -0,0 +1,74 @@
+.TH VPDDECODE 8 "February 2007" "dmidecode"
+.SH NAME
+vpddecode \- \s-1VPD\s0 structure decoder
+.SH SYNOPSIS
+.B vpddecode
+.RB [ OPTIONS ]
+
+.SH DESCRIPTION
+.B vpddecode
+prints the "vital product data" information that can be found in almost
+all IBM and Lenovo computers. Available items are:
+.IP \(bu "\w'\(bu'u+1n"
+\s-1BIOS\s0 Build \s-1ID\s0
+.IP \(bu
+Box Serial Number
+.IP \(bu
+Motherboard Serial Number
+.IP \(bu
+Machine Type/Model
+
+.PP
+Some systems have these additional items:
+.IP \(bu "\w'\(bu'u+1n"
+BIOS Release Date
+.IP \(bu
+Default Flash Image File Name
+
+.PP
+Note that these additional items are not documented by IBM, so this is
+guess work, and as such should not be blindly trusted. Feedback about
+the accuracy of these labels is welcome.
+
+.SH OPTIONS
+.TP
+.BR "-d" ", " "--dev-mem FILE"
+Read memory from device \fBFILE\fR (default: \fB/dev/mem\fR)
+.TP
+.BR "-s" ", " "--string KEYWORD"
+Only display the value of the \s-1VPD\s0 string identified by \fBKEYWORD\fR.
+\fBKEYWORD\fR must be a keyword from the following list: \fBbios-build-id\fR,
+\fBbox-serial-number\fR, \fBmotherboard-serial-number\fR,
+\fBmachine-type-model\fR, \fBbios-release-date\fR.
+Each keyword corresponds to an offset and a length within the \s-1VPD\s0
+record.
+Not all strings may be defined on all \s-1VPD\s0-enabled systems.
+If \fBKEYWORD\fR is not provided or not valid, a list of all valid
+keywords is printed and
+.B vpddecode
+exits with an error.
+This option cannot be used more than once.
+Mutually exclusive with \fB--dump\fR.
+.TP
+.BR "-u" ", " "--dump"
+Do not decode the VPD records, dump their contents as hexadecimal instead.
+Note that this is still a text output, no binary data will be thrown upon
+you. ASCII equivalent is displayed when possible. This option is mainly
+useful for debugging.
+Mutually exclusive with \fB--string\fR.
+.TP
+.BR "-h" ", " "--help"
+Display usage information and exit
+.TP
+.BR "-V" ", " "--version"
+Display the version and exit
+
+.SH FILES
+.I /dev/mem
+.SH AUTHOR
+Jean Delvare
+.SH "SEE ALSO"
+.BR biosdecode (8),
+.BR dmidecode (8),
+.BR mem (4),
+.BR ownership (8)