From 2676ae43fd7d1c1dbd611685500b8df51054eee5 Mon Sep 17 00:00:00 2001 From: Alexander Amelkin Date: Thu, 13 Jun 2019 19:10:51 +0300 Subject: [PATCH] Update documentation in regard to IANA PEN registry Add information regarding IANA PEN registry locations into ipmitool and ipmievd man pages. The locations in man pages are automatically generated based on `configure` options. Partially resolves ipmitool/ipmitool#11 Signed-off-by: Alexander Amelkin --- .gitignore | 2 ++ configure.ac | 4 ++++ doc/{ipmievd.8 => ipmievd.8.in} | 10 ++++++++++ doc/{ipmitool.1 => ipmitool.1.in} | 11 ++++++++++- 4 files changed, 26 insertions(+), 1 deletion(-) rename doc/{ipmievd.8 => ipmievd.8.in} (96%) rename doc/{ipmitool.1 => ipmitool.1.in} (99%) diff --git a/.gitignore b/.gitignore index ee72220..8e53269 100644 --- a/.gitignore +++ b/.gitignore @@ -29,5 +29,7 @@ control/prototype control/rpmmacros src/ipmievd src/ipmitool +doc/ipmievd.8 +doc/ipmitool.1 cscope.out tags diff --git a/configure.ac b/configure.ac index eca43c3..6e01d4f 100644 --- a/configure.ac +++ b/configure.ac @@ -4,6 +4,7 @@ dnl m4_define([git_suffix], m4_esyscmd_s(./csv-revision)) AC_INIT([ipmitool], [1.8.18git_suffix]) AC_CONFIG_SRCDIR([src/ipmitool.c]) +AC_CONFIG_COMMANDS_PRE([export prefix=$prefix]) AC_CANONICAL_SYSTEM AM_INIT_AUTOMAKE([foreign]) AM_CONFIG_HEADER(config.h) @@ -743,6 +744,9 @@ AC_CONFIG_FILES([Makefile src/plugins/serial/Makefile src/plugins/dummy/Makefile]) +AC_CONFIG_FILES([doc/ipmitool.1], [${SED} -i -e "s%\${prefix}%$prefix%" doc/ipmitool.1]) +AC_CONFIG_FILES([doc/ipmievd.8], [${SED} -i -e "s%\${prefix}%$prefix%" doc/ipmievd.8]) + AC_OUTPUT AC_MSG_RESULT([]) diff --git a/doc/ipmievd.8 b/doc/ipmievd.8.in similarity index 96% rename from doc/ipmievd.8 rename to doc/ipmievd.8.in index a617783..ab846e0 100644 --- a/doc/ipmievd.8 +++ b/doc/ipmievd.8.in @@ -217,6 +217,16 @@ Reading Sensors... .br Waiting for Events... .br + +.SH FILES +.TP +.B @IANADIR@/enterprise-numbers +system IANA PEN registry taken from http://www.iana.org/assignments/enterprise-numbers +.TP +.B ~/@IANAUSERDIR@/enterprise-numbers +user's override for the system IANA PEN registry, this file if it exists is loaded instead +of the system registry (see above). + .SH "AUTHOR" Duncan Laurie .SH "SEE ALSO" diff --git a/doc/ipmitool.1 b/doc/ipmitool.1.in similarity index 99% rename from doc/ipmitool.1 rename to doc/ipmitool.1.in index acf1870..cac7132 100644 --- a/doc/ipmitool.1 +++ b/doc/ipmitool.1.in @@ -3817,7 +3817,16 @@ Chassis Power is on > ipmitool \-I lan \-H 1.2.3.4 \-f passfile chassis power on .br Chassis Power Control: Up/On - + +.SH FILES +.TP +.B @IANADIR@/enterprise-numbers +system IANA PEN registry taken from http://www.iana.org/assignments/enterprise-numbers +.TP +.B ~/@IANAUSERDIR@/enterprise-numbers +user's override for the system IANA PEN registry, this file if it exists is loaded instead +of the system registry (see above). + .SH "AUTHORS" Originally written by Duncan Laurie . .br