i2c-tools / man pages for decode-dimms & decode-vaio
PATCH 1/1 i2c-tools / man pages for decode-dimms & decode-vaio
Hello.
The attached patch introduces man pages for
the decode-dimms and the decode-vaio tool.
Please, check, modify if needed and merge.
Thanks in advance.
Regards,
Jaromir.
--
Jaromir Capik
Red Hat Czech, s.r.o.
Software Engineer / Secondary Arch
Email: [email protected]
Web: www.cz.redhat.com
Red Hat Czech s.r.o., Purkynova 99/71, 612 45, Brno, Czech Republic
IC: 27690016
eeprom/decode-dimms.1 +77 -0
@@ -0,0 +1,77 @@ +.\" +.\" decode-dimms.1 - manpage for the i2c-tools/decode-dimms utility +.\" Copyright (C) 2013 Jaromir Capik +.\" +.\" This program is free software; you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation; either version 2 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License along +.\" with this program; if not, write to the Free Software Foundation, Inc., +.\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.TH decode-dimms 1 "Oct 2013" "i2c-tools" "User Commands" +.SH NAME +decode-dimms \- Decode the information found in memory module SPD EEPROMs. +.SH SYNOPSIS +.B decode-dimms +[-c] [-f [-b]] [-x|-X file [files..]] +.br +.B decode-dimms +-h +.SH DESCRIPTION + +The purpose of the +.B decode-dimms +tool is to decode the information found in memory module SPD EEPROMs. +The SPD data is read either from the running system or dump files. +The tool requires the eeprom kernel module to be loaded. +.SH PARAMETERS +.TP +.B \-f, --format +Print nice html output +.TP +.B \-b, --bodyonly +Don't print html header (useful for postprocessing the output) +.TP +.B \--side-by-side +Display all DIMMs side-by-side if possible +.TP +.B \--merge-cells +Merge neighbour cells with identical values (side-by-side output only) +.TP +.B \-c, --checksum +Decode completely even if checksum fails +.TP +.B \-x +Read data from hexdump files +.TP +.B \-X +Same as -x except treat multibyte hex data as little endian +.TP +.B \-h, --help +Display this usage summary +.SH SEE ALSO +.BR decode-vaio (1) +.SH AUTHORS +.UR [email protected] +Philip Edelbrock +.UE +.br +.UR [email protected] +Christian Zuckschwerdt +.UE +.br +.UR [email protected] +Burkart Lingner +.UE +.br +.UR [email protected] +Jean Delvare +.UE
eeprom/decode-vaio.1 +37 -0
@@ -0,0 +1,37 @@ +.\" +.\" decode-vaio.1 - manpage for the i2c-tools/decode-vaio utility +.\" Copyright (C) 2013 Jaromir Capik +.\" +.\" This program is free software; you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation; either version 2 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License along +.\" with this program; if not, write to the Free Software Foundation, Inc., +.\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.TH decode-vaio 1 "Oct 2013" "i2c-tools" "User Commands" +.SH NAME +decode-vaio \- Decode the information found in the Sony Vaio laptop +identification EEPROMs. +.SH SYNOPSIS +.B decode-vaio +.SH DESCRIPTION + +The purpose of the +.B decode-vaio +tool is to decode the information found in the Sony Vaio laptop +identification EEPROMs. +The tool requires the eeprom kernel module to be loaded. +.SH SEE ALSO +.BR decode-dimms (1) +.SH AUTHOR +.UR [email protected] +Jean Delvare +.UE
eeprom/Module.mk +15 -4
@@ -7,9 +7,10 @@ # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. -EEPROM_DIR := eeprom +EEPROM_DIR := eeprom -EEPROM_TARGETS := decode-dimms decode-vaio ddcmon decode-edid +EEPROM_TARGETS := decode-dimms decode-vaio ddcmon decode-edid +EEPROM_MAN_TARGETS := decode-dimms.1 decode-vaio.1 # # Commands
@@ -24,6 +25,16 @@ for program in $(EEPROM_TARGETS) ; do \ $(RM) $(DESTDIR)$(bindir)/$$program ; done -install: install-eeprom +install-eeprom-man: $(addprefix $(EEPROM_DIR)/,$(EEPROM_MAN_TARGETS)) + $(INSTALL_DIR) $(DESTDIR)$(mandir)/man1 + for manual in $(EEPROM_MAN_TARGETS) ; do \ + $(INSTALL_DATA) $(EEPROM_DIR)/$$manual $(DESTDIR)$(mandir)/man1 ; done -uninstall: uninstall-eeprom +uninstall-eeprom-man: + for manual in $(EEPROM_MAN_TARGETS) ; do \ + $(RM) $(DESTDIR)$(mandir)/$$manual ; done + + +install: install-eeprom install-eeprom-man + +uninstall: uninstall-eeprom uninstall-eeprom-man
_______________________________________________
lm-sensors mailing list
[email protected]
http://lists.lm-sensors.org/mailman/listinfo/lm-sensors
Hi Jaromir,
Quoted 2 lines · Jaromir Capik
The attached patch introduces man pages for
the decode-dimms and the decode-vaio tool.
Thanks for your contribution.
Quoted 1 line
Please, check, modify if needed and merge.
Applied [1], with the following changes:
* Added the new option --no-merge-cells to decode-dimms.1
* Removed e-mail addresses, they quickly become out-of-date and contacting the original code author is generally not the right thing to do for a end user.
* Simplified Makefile integration. If manual pages are ever written for ddcmon and decode-edid, the code can be simplified even further.
[1] http://www.lm-sensors.org/changeset/6200
Thanks again,
Signature · 6 lines
Jean Delvare _______________________________________________ lm-sensors mailing list [email protected] http://lists.lm-sensors.org/mailman/listinfo/lm-sensors