Changeset 219

Timestamp:

Feb 18, 2017, 4:46:29 PM (7 years ago)

Author:

g7moreau

Message:

• Update doc

File:

• trunk/klask (modified) (9 diffs)

trunk/klask

@@ -2636 +2636 @@
 =head1 NAME
 
-klask - ports manager and finder for switch
+klask - port and search manager for switches, map management
 
 
 =head1 USAGE
 
- klask updatedb [--verbose] [--verb-description|-d] [--chk-hostname|-h] [--chk-location|-l]
+ klask updatedb [--verbose|-v] [--verb-description|-d] [--chk-hostname|-h] [--chk-location|-l]
  klask exportdb --format [txt|html]
  klask removedb computer*
- klask cleandb  [--verbose] --day number_of_day --repair-dns
-
- klask updatesw [--verbose]
+ 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 search   computer
- klask search-mac-on-switch [--verbose] [--vlan|-i vlan-id] switch mac_addr
-
- klask ip-free  [--verbose] --day number_of_day --format [txt|html] [vlan_name]
-
- klask enable  switch port
- klask disable switch port
- klask status  switch port
+ klask search-mac-on-switch [--verbose|-v] [--vlan|-i vlan-id] switch mac_addr
+
+ klask ip-free  [--verbose|-v] --day number_of_day --format [txt|html] [vlan_name]
+
+ klask enable  [--verbose|-v] switch port
+ klask disable [--verbose|-v] switch port
+ klask status  [--verbose|-v] switch port
 
 
@@ -2680 +2680 @@
 The C<fake-ip> parameter is defined in the config file.
 
-Klask has now a web site dedicated for it !
-
- http://servforge.legi.grenoble-inp.fr/projects/klask
+Klask has now a web site dedicated for it: L<http://servforge.legi.grenoble-inp.fr/projects/klask>!
 
 
@@ -2696 +2694 @@
 =head2 enable
 
+ klask enable [--verbose|-v] switch port
+
 This command activate a port on a switch by SNMP.
-So you need to give the switch and a port on the command line.
+So you need to give the switch name and a port on the command line.
 See L<ABBREVIATION FOR PORT>.
 
+You need to have the SNMP write access on the switch in order to modify it's configuration.
+
 
 =head2 disable
 
+ klask disable [--verbose|-v] switch port
+
 This command deactivate a port on a switch by SNMP.
-So you need to give the switch and a port on the command line.
+So you need to give the switch name and a port on the command line.
 See L<ABBREVIATION FOR PORT>.
 
+You need to have the SNMP write access on the switch in order to modify it's configuration.
+
 
 =head2 status
 
+ klask status [--verbose|-v] switch port
+
 This command return the status of a port number on a switch by SNMP.
-So you need to give the switch and a port on the command line.
+The return value could be C<enable> or C<disable> word.
+So you need to give the switch name and a port on the command line.
 See L<ABBREVIATION FOR PORT>.
+
 
 =head2 updatedb
@@ -2718 +2728 @@
 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.
+This file is easy to read and write because Klask use YAML format and not XML.
 
 
@@ -2739 +2749 @@
 Computer name beginning by 'float' are not really taken into account but could be remove.
 
-When reverse DNS has not be done, option --repair-dns force reverse DNS check on unkown host.
+When reverse DNS has not be done, option C<--repair-dns> force reverse DNS check on unkown host.
 
 =head2 updatesw
@@ -2750 +2760 @@
 
 This command print the content of the switch database. There is actually two format.
-One is just txt for terminal and the other is the dot format from the graphviz environnement.
+One is just C<txt> for terminal and the other is the C<dot> format from the graphviz environnement.
 
  klask exportsw --format dot > /tmp/map.dot
@@ -2756 +2766 @@
 
 
-
 =head1 CONFIGURATION
 
-Because klask need many parameters, it's not possible actually to use command line parameters for everything.
+Because Klask need many parameters, it's not possible actually to use command line parameters for everything.
 The configuration is done in a F</etc/klask/klask.conf> YAML file.
 This format have many advantage over XML, it's easier to read and to write !
@@ -2805 +2814 @@
 Maybe I will make a delete line to suppress specific computers.
 The switch section define your switch.
-You have to write the port number to ignore, this was important if your switchs are cascade
+You have to write the port number to ignore, this was important if your switchs are cascades
 (right now, method C<updatesw> find them automatically)
 and is still important if you have loop (with PVST or MSTP).
@@ -2844 +2853 @@
  /var/lib/klask/switchdb
 
+
 =head1 SEE ALSO
 
 Net::SNMP, Net::Netmask, Net::CIDR::Lite, NetAddr::IP, YAML
 
+=over
+
+=item *
+
+Web site: L<http://servforge.legi.grenoble-inp.fr/projects/klask>
+
+=item *
+
+Online Manual: L<http://servforge.legi.grenoble-inp.fr/pub/klask/klask.html>
+
+=back
+
 
 =head1 VERSION