From 62026ca49b5bff063a06e3b49864947e65cea426 Mon Sep 17 00:00:00 2001
From: Guillaume Mazoyer <respawneral@gmail.com>
Date: Wed, 6 Aug 2014 00:09:50 +0200
Subject: Reminder of the command in the help modal.

---
 includes/config.defaults.php | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

(limited to 'includes')

diff --git a/includes/config.defaults.php b/includes/config.defaults.php
index 4821da8..1c703eb 100644
--- a/includes/config.defaults.php
+++ b/includes/config.defaults.php
@@ -31,27 +31,32 @@ $config = array (
   'doc' => array (
     // Documentation for the 'show route' query
     'bgp' => array(
-      'query' => 'Show the best routes to a given destination.',
+      'command' => 'show route IP_ADDRESS',
+      'description' => 'Show the best routes to a given destination.',
       'parameter' => 'The parameter must be a valid destination. Destination means an IPv4/IPv6 address or a subnet. Masks are also accepted as part of a valid IPv4/IPv6 address.<br />Please note that some routers always need a mask to be given when looking for an IPv6 address.<br /><br />Example of valid arguments:<br /><ul><li>10.1.1.1</li><li>172.16.0.0/12</li><li>2001:db8:1337::42</li><li>2001:db8::/32</li>'
     ),
     // Documentation for the 'as-path-regex' query
     'as-path-regex' => array(
-      'query' => 'Show the routes matching the given AS path regular expression.',
+      'command' => 'show route as-path-regex AS_PATH_REGEX',
+      'description' => 'Show the routes matching the given AS path regular expression.',
       'parameter' => 'The parameter must be a valid AS path regular expression.<br />Please note that these expression can change depending on the router and its software.<br /><br />Here are some examples:<ul><li><strong>Juniper</strong> - ^AS1 AS2 .*$</li><li><strong>Cisco</strong> - ^AS1_</li><li><strong>BIRD</strong> - AS1 AS2 AS3 &hellip; ASZ</li></ul><br />You may find some help with the following link:<br /><ul><li><a href="http://www.juniper.net/techpubs/en_US/junos13.3/topics/reference/command-summary/show-route-aspath-regex.html" title="Juniper Documentation">Juniper Documentation</a></li><li><a href="http://www.cisco.com/c/en/us/support/docs/ip/border-gateway-protocol-bgp/26634-bgp-toc.html#asregexp" title="Cisco Documentation">Cisco Documentation</a></li><li><a href="http://bird.network.cz/?get_doc&f=bird-5.html" title="BIRD Documentation">BIRD Documentation</a> (search for bgpmask)</li></ul>'
     ),
     // Documentation for the 'as' query
     'as' => array(
-      'query' => 'Show the routes received from a given AS number.',
+      'command' => 'show route AS',
+      'description' => 'Show the routes received from a given AS number.',
       'parameter' => 'The parameter must be a valid 16-bit or 32-bit autonomous system number.<br />Be careful, 32-bit ASN are not handled by old routers or old router softwares.<br />Unless specified, private ASN will be considered as invalid.<br /><br />Example of valid argument:<br /><ul><li>15169</li><li>29467</li></ul>'
     ),
     // Documentation for the 'ping' query
     'ping' => array(
-      'query' => 'Send 10 pings to the given destination.',
+      'command' => 'ping IP_ADDRESS',
+      'description' => 'Send 10 pings to the given destination.',
       'parameter' => 'The parameter must be an IPv4/IPv6 address (without mask) or a fully qualified domain name.<br /><br />Example of valid arguments:<br /><ul><li>10.1.1.1</li><li>2001:db8:1337::42</li><li>example.com</li></ul>'
     ),
     // Documentation for the 'traceroute' query
     'traceroute' => array(
-      'query' => 'Display the path to a given destination.',
+      'command' =>'traceroute IP_ADDRESS',
+      'description' => 'Display the path to a given destination.',
       'parameter' => 'The parameter must be an IPv4/IPv6 address (without mask) or a fully qualified domain name.<br /><br />Example of valid arguments:<br /><ul><li>10.1.1.1</li><li>2001:db8:1337::42</li><li>example.com</li></ul>'
     )
   )
-- 
cgit v1.2.3