File s390-tools-sles11sp2-qetharp-manpage.patch of Package s390-tools

Description: qetharp: Man page improvements
Symptom:     misunderstandings
Problem:     limitations misunderstood
Solution:    reworked manpage
Problem-ID:  76863

---
 README            |    1 +
 qetharp/qetharp.8 |   29 +++++++++++++++--------------
 2 files changed, 16 insertions(+), 14 deletions(-)

--- a/README
+++ b/README
@@ -229,6 +229,7 @@ Release History:
     - lsreipl: Prevent unnecessary error messages for empty sysfs files
     - dasdinfo: Support current kernel versions
     - zipl: Add sync to ensure that all data has been written to disk
+    - qetharp: Man page improvements
 
 1.14.0
     Changes of existing tools:
--- a/qetharp/qetharp.8
+++ b/qetharp/qetharp.8
@@ -1,4 +1,4 @@
-.TH QETHARP 8 "Oct 2009" "s390-tools"
+.TH QETHARP 8 "Nov 2011" "s390-tools"
 .SH NAME
 qetharp \- querying and modifying ARP data.
 
@@ -11,7 +11,7 @@ qetharp \- querying and modifying ARP da
 .IR interface ]
 .br
 .RB [ -p
-.IR interface ] 
+.IR interface ]
 .br
 .RB [ -a
 .IR interface
@@ -28,6 +28,7 @@ qetharp \- querying and modifying ARP da
 .SH DESCRIPTION
 \fBqetharp\fR queries ARP data, such as MAC and IP addresses, from an OSA hardware ARP cache or a HiperSockets ARP cache. For OSA hardware, qetharp can also modify the cache.
 
+The command applies only to devices in layer3 mode. It supports IPv6 for HiperSockets only.
 .SH OPTIONS
 .TP
 \fB-q\fR or \fB--query \fIinterface\fR
@@ -48,19 +49,19 @@ includes IPv6 information for HiperSocke
 .TP
 
 \fB-p\fR or \fB--purge \fIinterface\fR
-flushes the OSA ARP table. This option only works with OSA devices.
+flushes the ARP cache of the OSA. The cache contains dynamic ARP entries, which the OSA adapter creates through ARP queries. After flushing the cache, the OSA adapter creates new dynamic entries. This option only works with OSA devices.
 .TP
 \fB-a\fR or \fB--add \fIinterface\fR
-adds a static ARP entry to the OSA ARP table. This option requires an IP address and a MAC address (\fB-i\fR and \fB-m\fR options).
+adds a static ARP entry to the OSA adapter card. This option requires an IP address and a MAC address (\fB-i\fR and \fB-m\fR options).
 .TP
 \fB-d\fR or \fB--delete \fIinterface\fR
-deletes a static ARP entry from the OSA ARP table. This command requires an
+deletes a static ARP entry from the OSA adapter card. This command requires an
 IP address (\fB-i\fR option).
 .TP
 \fB-i\fR or \fB--ip \fIIP_address\fR
-specifies an IP address to be added to or removed from the OSA ARP table.
+specifies an IP address to be added to or removed from the OSA adapter card.
 \fB-m\fR or \fB--mac \fIMAC_address\fR
-specifies a MAC address to be added to the OSA ARP table.
+specifies a MAC address to be added to the OSA adapter card.
 .TP
 
 \fB-v\fR or \fB--version\fR
@@ -77,21 +78,21 @@ shows all ARP entries of OSA.
 \fBqetharp -nq eth0\fR 
 shows all ARP entries of OSA without resolving host names.
 .TP
-\fBqetharp -6q eth0\fR
-shows all ARP entries including IPv6 entries of guest LAN HiperSockets.
+\fBqetharp -6q hsi0\fR
+shows all ARP entries of the HiperSockets interface including IPv6 entries.
 .TP
-\fBqetharp -n6q eth0\fR
-shows all ARP entries including IPv6 entries of guest LAN HiperSockets without resolving host names.
+\fBqetharp -n6q hsi0\fR
+shows all ARP entries of the HiperSockets interface including IPv6 entries without resolving host names.
 .TP
 \fBqetharp -p eth0\fR  
-flushes the OSA ARP table.
+flushes the OSA ARP cache for eth0.
 .TP
 \fBqetharp -a eth0 -i 1.2.3.4 -m aa:bb:cc:dd:ee:ff\fR  
-adds a static ARP entry for the IP address 1.2.3.4 to the OSA ARP table, using
+adds a static ARP entry for the IP address 1.2.3.4 to the OSA ARP cache, using
 a MAC address of aa:bb:cc:dd:ee:ff
 .TP
 \fBqetharp -d eth0 -i 1.2.3.4\fR  
-deletes the static ARP entry for the IP address 1.2.3.4 from the OSA ARP table.
+deletes the static ARP entry for the IP address 1.2.3.4 from the OSA ARP cache.
 
 .SH AUTHOR
 .nf
openSUSE Build Service is sponsored by