Bug 1353981

Summary: Man page for freeipmi should display lower case version for command examples
Product: Red Hat Enterprise Linux 7 Reporter: Rachel Sibley <rasibley>
Component: freeipmiAssignee: Josef Ridky <jridky>
Status: CLOSED ERRATA QA Contact: Rachel Sibley <rasibley>
Severity: low Docs Contact:
Priority: unspecified    
Version: 7.3CC: jridky, ovasik, rasibley
Target Milestone: rcKeywords: EasyFix, ManPageChange
Target Release: ---   
Hardware: All   
OS: Unspecified   
Whiteboard:
Fixed In Version: freeipmi-1.5.7-2.el7 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of:
: 1468984 (view as bug list) Environment:
Last Closed: 2018-04-10 11:27:36 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 1465906, 1468984    

Description Rachel Sibley 2016-07-08 15:19:20 UTC
Description of problem:
Minor nitpick, but the man page for freeipmi should display lower case version for command examples.

Version-Release number of selected component (if applicable):
~]# rpm -q freeipmi
freeipmi-1.2.9-8.el7.x86_64

How reproducible:
Always

Steps to Reproduce:
1. man freeipmi
2.
3.

Actual results:
Ipmi-sensors

       A tool to read IPMI sensor readings to aid in system monitoring.

Ipmi-sel

       A tool to read and manage IPMI System Event Log (SEL) records to aid in system debugging.

Ipmipower

       A tool for remote power control.

Ipmiconsole

       A tool for Serial-over-Lan (SOL) console access.
.......

Expected results:
ipmi-sensors

       A tool to read IPMI sensor readings to aid in system monitoring.

ipmi-sel

       A tool to read and manage IPMI System Event Log (SEL) records to aid in system debugging.

ipmipower

       A tool for remote power control.

ipmiconsole

       A tool for Serial-over-Lan (SOL) console access.
.....

Additional info:
Examples are misleading:

~]# Ipmi-sensors
-bash: Ipmi-sensors: command not found

Comment 2 Josef Ridky 2017-08-29 08:41:42 UTC
Set for RHEL-7.5, due it is EasyFix and this issue could be solved with freeipmi rebase for RHEL-7.5.

Comment 7 Rachel Sibley 2017-11-17 17:23:46 UTC
Josef may I ask that you also update Rmcpping to rmcpping ? Otherwise, the remaining commands are now lower case. Thanks!

# man freeipmi
<snip>
       bmc-device

       A tool to perform advanced BMC commands, such as resetting the BMC, configuring ACPI, configuring SDR/SEL time, manually gen‐
       erating events, re-arming sensors, and configuring manufacturer settings.

       ipmiping

       An IPMI ping tool for debugging.

       Rmcpping

       A RMCP ping tool for debugging.

       ipmi-oem

       An IPMI tool for OEM specific commands.

       ipmidetect/ipmidetectd

       A tool and daemon for IPMI node detection.

       ipmiseld

       A daemon that regularly polls the SEL and stores the events to the local syslog.

       Additional information, examples, and general trouble-shooting can be found in each of the tool manpages.

Comment 9 Rachel Sibley 2017-11-27 20:53:19 UTC
Looks good, thanks !

~]# rpm -q freeipmi
freeipmi-1.5.7-2.el7.x86_64

~]# man freeipmi
<snip>
       ipmi-pet

       A tool to parse and interpret Platform Event Traps (PET).

       ipmi-dcmi

       A tool to perform Data Center Manageability Interface (DCMI) IPMI extension commands. Supports extensions for  asset  manage‐
       ment and power usage management.

       bmc-device

       A tool to perform advanced BMC commands, such as resetting the BMC, configuring ACPI, configuring SDR/SEL time, manually gen‐
       erating events, re-arming sensors, and configuring manufacturer settings.

       ipmiping

       An IPMI ping tool for debugging.

       rmcpping

       A RMCP ping tool for debugging.

       ipmi-oem

       An IPMI tool for OEM specific commands.

       ipmidetect/ipmidetectd

       A tool and daemon for IPMI node detection.

Comment 12 errata-xmlrpc 2018-04-10 11:27:36 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHEA-2018:0714