Changeset 226

Timestamp:

Feb 20, 2017, 10:24:41 AM (7 years ago)

Author:

g7moreau

Message:

• A litle more doc

File:

• trunk/klask (modified) (8 diffs)

trunk/klask

@@ -876 +876 @@
 
  klask updatedb [--verbose|-v] [--verb-description|-d] [--chk-hostname|-h] [--chk-location|-l]
- klask exportdb --format [txt|html]
+ klask exportdb [--format|-f txt|html]
  klask removedb IP* computer*
  klask cleandb  [--verbose|-v] --day number_of_day --repair-dns
 
  klask updatesw [--verbose|-v]
- klask exportsw --format [txt|dot]
-
- klask searchdb computer
+ klask exportsw [--format|-f txt|dot]
+
+ klask searchdb [--kind|-k host|mac] computer [mac-address]
  klask search   computer
- klask search-mac-on-switch switch mac_addr
-
- klask ip-free [--verbose|-v] [--day|-d days-to-death] --format [txt|html] [vlan_name]
+ klask search-mac-on-switch [--verbose|-v] [--vlan|-i vlan-id] switch mac_addr
+
+ klask ip-free [--verbose|-v] [--day|-d days-to-death] [--format|-f txt|html] [vlan_name]
 
  klask bad-vlan-id [--day|-d days_before_alert]
@@ -2661 +2661 @@
 =head1 USAGE
 
+ klask version
+ klask help
+
  klask updatedb [--verbose|-v] [--verb-description|-d] [--chk-hostname|-h] [--chk-location|-l]
- klask exportdb --format [txt|html]
+ klask exportdb [--format|-f txt|html]
  klask removedb IP* computer*
  klask cleandb  [--verbose|-v] --day number_of_day --repair-dns
 
  klask updatesw [--verbose|-v]
- klask exportsw --format [txt|dot]
-
- klask searchdb --kind [host|mac] computer [mac-address]
+ klask exportsw [--format|-f txt|dot]
+
+ klask searchdb [--kind|-k host|mac] computer [mac-address]
  klask search   computer
  klask search-mac-on-switch [--verbose|-v] [--vlan|-i vlan-id] switch mac_addr
 
- klask ip-free [--verbose|-v] [--day|-d days-to-death] --format [txt|html] [vlan_name]
+ klask ip-free [--verbose|-v] [--day|-d days-to-death] [--format|-f txt|html] [vlan_name]
 
  klask bad-vlan-id [--day|-d days_before_alert]
@@ -2714 +2717 @@
 =head2 search
 
+ klask search   computer
+
 This command takes one or more computer in argument.
 It search a computer on the network and give the port and the switch on which the computer is connected.
+
+=head2 search
+
+ klask search-mac-on-switch [--verbose|-v] [--vlan|-i vlan-id] switch mac_addr
+
+This command search a MAC address on a switch.
+The VLAN could help.
 
 
@@ -2754 +2766 @@
  klask updatedb [--verbose|-v] [--verb-description|-d] [--chk-hostname|-h] [--chk-location|-l]
 
-This command will scan networks and update a database.
-To know which are the cmputer scan, you have to configure the file F</etc/klask/klask.conf>.
-This file is easy to read and write because Klask use YAML format and not XML.
-
-Option are not stable and could be use manually when you have new switch.
+This command will scan networks and update the computer database.
+To know which are the cmputer scanned, you have to configure the file F</etc/klask/klask.conf>.
+This file is easy to read and write because Klask use YAML format and not XML
+(see L</CONFIGURATION>).
+
+Option are not stable and could be use manually when you have a new kind of switch.
 Maybe some option will be transfered in a future C<checksw> command!
 
 =head2 exportdb
 
- klask exportdb --format [txt|html]
-
-This command print the content of the database. There is actually only two format : txt and html.
+ klask exportdb [--format|-f txt|html]
+
+This command print the content of the computer database.
+There is actually only two format : TXT and HTML.
+By default, format is TXT.
 It's very easy to have more format, it's just need times...
 
@@ -2776 +2791 @@
 You can put as many IP as you want...
 
-DNS computer name could also a valid entry because a DNS resolver is done at the beginning.
+Computer DNS names are also a valid entry because a DNS resolver is executed at the beginning.
 
 =head2 cleandb
@@ -2789 +2804 @@
 In the Klask database, the float DNS entries are less important.
 
-When reverse DNS has not be done by the past, option C<--repair-dns> force reverse DNS check on all unkown host.
+When reverse DNS has not been done by the past, option C<--repair-dns> force a reverse DNS check on all unkown host.
 
 =head2 updatesw
@@ -2796 +2811 @@
 
 This command build a map of your manageable switch on your network.
-The list of the switches must be given in the file F</etc/klask/klask.conf>.
+The list of the switches must be given in the file F</etc/klask/klask.conf> (see L</CONFIGURATION>).
 
 
 =head2 exportsw
 
- klask exportsw --format [txt|dot]
+ klask exportsw [--format|-f txt|dot]
 
 This command print the content of the switch database. There is actually two format.
-One is just C<txt> for terminal and the other is the C<dot> format from the graphviz environnement.
+One is just TXT for terminal and the other is the DOT format from the graphviz environnement.
+By default, format is TXT.
 
  klask exportsw --format dot > /tmp/map.dot
@@ -2812 +2828 @@
 =head2 ip-free
 
- klask ip-free [--verbose|-v] [--day|-d days-to-death] --format [txt|html] [vlan_name]
+ klask ip-free [--verbose|-v] [--day|-d days-to-death] [--format|-f txt|html] [vlan_name]
 
 This command return IP address that was not use (detected by Klask) at this time.