From 6824c5341d20bee84cf9ce001fee9218503ac90f Mon Sep 17 00:00:00 2001
From: Mohit Mehta <mohit.mehta@vyatta.com>
Date: Fri, 4 Apr 2008 23:59:50 +0000
Subject: Fix Bug 3069 Help strings should be standardized - vyatta-op help
strings standardized according to latest guideline
---
templates/show/arp/node.def | 2 +-
templates/show/bridge/node.tag/macs/node.def | 2 +-
templates/show/bridge/node.tag/node.def | 2 +-
templates/show/files/node.tag/node.def | 2 +-
templates/show/host/lookup/node.def | 2 +-
templates/show/host/lookup/node.tag/node.def | 2 +-
templates/show/interfaces/bridge/node.tag/brief/node.def | 2 +-
templates/show/interfaces/bridge/node.tag/node.def | 2 +-
templates/show/interfaces/detail/node.def | 2 +-
templates/show/interfaces/ethernet/node.tag/brief/node.def | 2 +-
templates/show/interfaces/ethernet/node.tag/node.def | 2 +-
templates/show/interfaces/ethernet/node.tag/physical/node.def | 2 +-
templates/show/interfaces/ethernet/node.tag/vif/node.def | 2 +-
.../show/interfaces/ethernet/node.tag/vif/node.tag/brief/node.def | 2 +-
templates/show/interfaces/ethernet/node.tag/vif/node.tag/node.def | 2 +-
templates/show/interfaces/loopback/node.tag/brief/node.def | 2 +-
templates/show/interfaces/loopback/node.tag/node.def | 2 +-
templates/show/interfaces/tunnel/node.tag/brief/node.def | 2 +-
templates/show/interfaces/tunnel/node.tag/node.def | 2 +-
templates/show/ip/route/cache/node.tag/node.def | 2 +-
templates/show/ip/route/forward/node.tag/node.def | 2 +-
templates/show/log/file/node.tag/node.def | 2 +-
templates/show/ntp/node.tag/node.def | 2 +-
templates/show/vrrp/interface/node.def | 3 +--
templates/show/vrrp/interface/node.tag/group/node.def | 2 +-
templates/show/vrrp/interface/node.tag/group/node.tag/node.def | 2 +-
templates/show/vrrp/interface/node.tag/node.def | 2 +-
templates/show/vrrp/node.def | 2 +-
templates/show/vrrp/summary/node.def | 2 +-
29 files changed, 29 insertions(+), 30 deletions(-)
(limited to 'templates/show')
diff --git a/templates/show/arp/node.def b/templates/show/arp/node.def
index 021f848..bac6fdb 100644
--- a/templates/show/arp/node.def
+++ b/templates/show/arp/node.def
@@ -1,2 +1,2 @@
-help: Show Address Resolution Protocol Information
+help: Show Address Resolution Protocol information
run: /usr/sbin/arp -e
diff --git a/templates/show/bridge/node.tag/macs/node.def b/templates/show/bridge/node.tag/macs/node.def
index 598a209..86cf661 100644
--- a/templates/show/bridge/node.tag/macs/node.def
+++ b/templates/show/bridge/node.tag/macs/node.def
@@ -1,2 +1,2 @@
-help: Show bridge MAC table
+help: Show bridge Media Access Control (MAC) address table
run: brctl showmacs "$3"
diff --git a/templates/show/bridge/node.tag/node.def b/templates/show/bridge/node.tag/node.def
index 0b4f163..fae7bab 100644
--- a/templates/show/bridge/node.tag/node.def
+++ b/templates/show/bridge/node.tag/node.def
@@ -1,4 +1,4 @@
-help: Show bridge information for a given bridge
+help: Show bridge information for a given bridge interface
allowed: local -a array ;
array=( /sys/class/net/br* ) ;
echo -n ${array[@]##*/}
diff --git a/templates/show/files/node.tag/node.def b/templates/show/files/node.tag/node.def
index 2aea5ab..17dcae9 100644
--- a/templates/show/files/node.tag/node.def
+++ b/templates/show/files/node.tag/node.def
@@ -1,2 +1,2 @@
-help: Show files in directory
+help: Show files in the specified directory
run: ls -lh $3
diff --git a/templates/show/host/lookup/node.def b/templates/show/host/lookup/node.def
index 79f2f1b..375d356 100644
--- a/templates/show/host/lookup/node.def
+++ b/templates/show/host/lookup/node.def
@@ -1 +1 @@
-help: Lookup host information for <host>/<IP address>
+help: Lookup host information for <hostname|IPv4 address>
diff --git a/templates/show/host/lookup/node.tag/node.def b/templates/show/host/lookup/node.tag/node.def
index 7fa6309..29bf5a7 100644
--- a/templates/show/host/lookup/node.tag/node.def
+++ b/templates/show/host/lookup/node.tag/node.def
@@ -1,3 +1,3 @@
-help: Lookup host information for <host>/<IP address>
+help: Lookup host information for specified <hostname|IPv4 address>
allowed: vyatta-allowed-hosts
run: /usr/bin/host $4
diff --git a/templates/show/interfaces/bridge/node.tag/brief/node.def b/templates/show/interfaces/bridge/node.tag/brief/node.def
index d3d213d..ca07860 100644
--- a/templates/show/interfaces/bridge/node.tag/brief/node.def
+++ b/templates/show/interfaces/bridge/node.tag/brief/node.def
@@ -1,2 +1,2 @@
-help: Show summary of a given bridge interface information
+help: Show summary of the specified bridge interface information
run: ${vyatta_bindir}/vyatta-show-interfaces.pl --intf="$4" --action=show-brief
diff --git a/templates/show/interfaces/bridge/node.tag/node.def b/templates/show/interfaces/bridge/node.tag/node.def
index 41aa6b2..d2c5eec 100644
--- a/templates/show/interfaces/bridge/node.tag/node.def
+++ b/templates/show/interfaces/bridge/node.tag/node.def
@@ -1,4 +1,4 @@
-help: Show given bridge interface information
+help: Show specified bridge interface information
allowed: local -a array ;
array=( /sys/class/net/br* ) ;
echo -n ${array[@]##*/}
diff --git a/templates/show/interfaces/detail/node.def b/templates/show/interfaces/detail/node.def
index f875ce8..08bdfa4 100644
--- a/templates/show/interfaces/detail/node.def
+++ b/templates/show/interfaces/detail/node.def
@@ -1,2 +1,2 @@
-help: Show detail information of all interfaces
+help: Show detailed information of all interfaces
run: ${vyatta_bindir}/vyatta-show-interfaces.pl --action=show
diff --git a/templates/show/interfaces/ethernet/node.tag/brief/node.def b/templates/show/interfaces/ethernet/node.tag/brief/node.def
index 98539ed..0d164bc 100644
--- a/templates/show/interfaces/ethernet/node.tag/brief/node.def
+++ b/templates/show/interfaces/ethernet/node.tag/brief/node.def
@@ -1,2 +1,2 @@
-help: Show summary of given ethernet interface information
+help: Show summary of the specified ethernet interface information
run: ${vyatta_bindir}/vyatta-show-interfaces.pl --intf="$4" --action=show-brief
diff --git a/templates/show/interfaces/ethernet/node.tag/node.def b/templates/show/interfaces/ethernet/node.tag/node.def
index b41cf8b..57a5623 100644
--- a/templates/show/interfaces/ethernet/node.tag/node.def
+++ b/templates/show/interfaces/ethernet/node.tag/node.def
@@ -1,4 +1,4 @@
-help: Show given ethernet interface information
+help: Show specified ethernet interface information
allowed: for dev in /sys/class/net/*;
do if [[ -L $dev/device ]]
then if [[ $(cat $dev/type) -eq 1 ]]
diff --git a/templates/show/interfaces/ethernet/node.tag/physical/node.def b/templates/show/interfaces/ethernet/node.tag/physical/node.def
index 3667c13..7723946 100644
--- a/templates/show/interfaces/ethernet/node.tag/physical/node.def
+++ b/templates/show/interfaces/ethernet/node.tag/physical/node.def
@@ -1,3 +1,3 @@
-help: Show physical device information of given ethernet interface
+help: Show physical device information for specified ethernet interface
allowed: ""
run: /usr/sbin/ethtool "$4"; /usr/sbin/ethtool -i "$4"
diff --git a/templates/show/interfaces/ethernet/node.tag/vif/node.def b/templates/show/interfaces/ethernet/node.tag/vif/node.def
index b3d92de..2b74427 100644
--- a/templates/show/interfaces/ethernet/node.tag/vif/node.def
+++ b/templates/show/interfaces/ethernet/node.tag/vif/node.def
@@ -1,4 +1,4 @@
-help: Show given virtual network interface information
+help: Show specified virtual network interface (vif) information
run: tput setaf ${COLOR_RED:-1} ;
echo error: need to supply vif # ;
tput op
diff --git a/templates/show/interfaces/ethernet/node.tag/vif/node.tag/brief/node.def b/templates/show/interfaces/ethernet/node.tag/vif/node.tag/brief/node.def
index 35cf9a4..7aa871e 100644
--- a/templates/show/interfaces/ethernet/node.tag/vif/node.tag/brief/node.def
+++ b/templates/show/interfaces/ethernet/node.tag/vif/node.tag/brief/node.def
@@ -1,2 +1,2 @@
-help: Show summary of given virtual network interface information
+help: Show summary of specified virtual network interface (vif) information
run: ${vyatta_bindir}/vyatta-show-interfaces.pl --intf="$4.$6" --action=show-brief
diff --git a/templates/show/interfaces/ethernet/node.tag/vif/node.tag/node.def b/templates/show/interfaces/ethernet/node.tag/vif/node.tag/node.def
index 13f196f..52bfbee 100644
--- a/templates/show/interfaces/ethernet/node.tag/vif/node.tag/node.def
+++ b/templates/show/interfaces/ethernet/node.tag/vif/node.tag/node.def
@@ -1,4 +1,4 @@
-help: Show given virtual network interface information
+help: Show specified virtual network interface (vif) information
allowed: local -a array ;
array=( /sys/class/net/${COMP_WORDS[3]}.* ) ;
echo -n ${array[@]##*.}
diff --git a/templates/show/interfaces/loopback/node.tag/brief/node.def b/templates/show/interfaces/loopback/node.tag/brief/node.def
index 85970d3..2ea8f06 100644
--- a/templates/show/interfaces/loopback/node.tag/brief/node.def
+++ b/templates/show/interfaces/loopback/node.tag/brief/node.def
@@ -1,2 +1,2 @@
-help: Show summary of given loopback interface information
+help: Show summary of specified loopback interface information
run: ${vyatta_bindir}/vyatta-show-interfaces.pl --intf="$4" --action=show-brief
diff --git a/templates/show/interfaces/loopback/node.tag/node.def b/templates/show/interfaces/loopback/node.tag/node.def
index 84f3624..3364827 100644
--- a/templates/show/interfaces/loopback/node.tag/node.def
+++ b/templates/show/interfaces/loopback/node.tag/node.def
@@ -1,4 +1,4 @@
-help: Show given loopback interface information
+help: Show specified loopback interface information
allowed: local -a array ;
array=( /sys/class/net/lo* ) ;
echo -n ${array[@]##*/}
diff --git a/templates/show/interfaces/tunnel/node.tag/brief/node.def b/templates/show/interfaces/tunnel/node.tag/brief/node.def
index 7a266ef..4c63d8e 100644
--- a/templates/show/interfaces/tunnel/node.tag/brief/node.def
+++ b/templates/show/interfaces/tunnel/node.tag/brief/node.def
@@ -1,2 +1,2 @@
-help: Show summary of given tunnel interface information
+help: Show summary of specified tunnel interface information
run: ${vyatta_bindir}/vyatta-show-interfaces.pl --intf="$4" --action=show-brief
diff --git a/templates/show/interfaces/tunnel/node.tag/node.def b/templates/show/interfaces/tunnel/node.tag/node.def
index c39ad7e..6818464 100644
--- a/templates/show/interfaces/tunnel/node.tag/node.def
+++ b/templates/show/interfaces/tunnel/node.tag/node.def
@@ -1,4 +1,4 @@
-help: Show given tunnel interface information
+help: Show specified tunnel interface information
allowed: local -a array ;
array=( /sys/class/net/tun* ) ;
echo -n ${array[@]##*/}
diff --git a/templates/show/ip/route/cache/node.tag/node.def b/templates/show/ip/route/cache/node.tag/node.def
index 85fe4e6..2cb78d5 100644
--- a/templates/show/ip/route/cache/node.tag/node.def
+++ b/templates/show/ip/route/cache/node.tag/node.def
@@ -1,3 +1,3 @@
help: Show kernel route cache for a given route
-allowed: echo -n '<network>'
+allowed: echo -n '<x.x.x.x | x.x.x.x/x>'
run: ip -s route list cache $5
diff --git a/templates/show/ip/route/forward/node.tag/node.def b/templates/show/ip/route/forward/node.tag/node.def
index 257eb0f..e1ba954 100644
--- a/templates/show/ip/route/forward/node.tag/node.def
+++ b/templates/show/ip/route/forward/node.tag/node.def
@@ -1,3 +1,3 @@
help: Show kernel route table for a given route
-allowed: echo -n '<network>'
+allowed: echo -n '<x.x.x.x | x.x.x.x/x>'
run: ip -s route list $5
diff --git a/templates/show/log/file/node.tag/node.def b/templates/show/log/file/node.tag/node.def
index 6a717a9..9171a0c 100644
--- a/templates/show/log/file/node.tag/node.def
+++ b/templates/show/log/file/node.tag/node.def
@@ -1,4 +1,4 @@
-help: Show contents of the specified user-defined log file
+help: Show contents of specified user-defined log file
allowed: local -a array ;
array=( /var/log/user/* ) ;
[ ${#array[@]} -gt 0 ] && echo -n ${array[@]##*/} || echo -n none
diff --git a/templates/show/ntp/node.tag/node.def b/templates/show/ntp/node.tag/node.def
index a4a4443..ef69a68 100644
--- a/templates/show/ntp/node.tag/node.def
+++ b/templates/show/ntp/node.tag/node.def
@@ -1,4 +1,4 @@
-help: Show date and time of given NTP server
+help: Show date and time of specified NTP server
allowed: vyatta-allowed-hosts ntp.vyatta.com ;
sed -n 's/^server[ \t]\+//p' /etc/ntp.conf
run: /usr/sbin/ntpdate -q ${3:-ntp.vyatta.com}
diff --git a/templates/show/vrrp/interface/node.def b/templates/show/vrrp/interface/node.def
index 723666e..79480a1 100644
--- a/templates/show/vrrp/interface/node.def
+++ b/templates/show/vrrp/interface/node.def
@@ -1,2 +1 @@
-help: Show VRRP information for given interface
-
+help: Show VRRP information for specified interface
diff --git a/templates/show/vrrp/interface/node.tag/group/node.def b/templates/show/vrrp/interface/node.tag/group/node.def
index a79e838..0af500d 100644
--- a/templates/show/vrrp/interface/node.tag/group/node.def
+++ b/templates/show/vrrp/interface/node.tag/group/node.def
@@ -1 +1 @@
-help: Show VRRP information for interface and group
+help: Show VRRP information for specified interface and group
diff --git a/templates/show/vrrp/interface/node.tag/group/node.tag/node.def b/templates/show/vrrp/interface/node.tag/group/node.tag/node.def
index 84e168f..1e74e2d 100644
--- a/templates/show/vrrp/interface/node.tag/group/node.tag/node.def
+++ b/templates/show/vrrp/interface/node.tag/group/node.tag/node.def
@@ -1,3 +1,3 @@
-help: Show VRRP information for interface group
+help: Show VRRP information for specified interface and group
allowed: echo -n '<VRRP_GROUP>'
run: /opt/vyatta/sbin/vyatta-show-vrrp.pl "$4" "$6"
diff --git a/templates/show/vrrp/interface/node.tag/node.def b/templates/show/vrrp/interface/node.tag/node.def
index 19b323e..860b12a 100644
--- a/templates/show/vrrp/interface/node.tag/node.def
+++ b/templates/show/vrrp/interface/node.tag/node.def
@@ -1,4 +1,4 @@
-help: Show VRRP information for interface
+help: Show VRRP information for specified interface
allowed: local -a array ;
array=( /sys/class/net/eth* ) ;
echo -n ${array[@]##*/}
diff --git a/templates/show/vrrp/node.def b/templates/show/vrrp/node.def
index 8f7a621..3842d98 100644
--- a/templates/show/vrrp/node.def
+++ b/templates/show/vrrp/node.def
@@ -1,2 +1,2 @@
-help: Show VRRP information
+help: Show Virtual Router Redundancy Protocol (VRRP) information
run: /opt/vyatta/sbin/vyatta-show-vrrp.pl
diff --git a/templates/show/vrrp/summary/node.def b/templates/show/vrrp/summary/node.def
index 33333c4..c087165 100644
--- a/templates/show/vrrp/summary/node.def
+++ b/templates/show/vrrp/summary/node.def
@@ -1,3 +1,3 @@
-help: Show VRRP summary
+help: Show summary of VRRP information
run: /opt/vyatta/sbin/vyatta-show-vrrp.pl "$3"
--
cgit v1.2.3