Update README.md

README.md

@@ -60,45 +60,68 @@ To use this tool:
 
 ```
 OMD[build]:~$ ~/local/bin/topology_data/create_topology_data.py -h
-usage: create_topology_data.py [-h] [-m] [-o OUTPUT_DIRECTORY] [-s SEED_DEVICES [SEED_DEVICES ...]] [-v] [--data-source DATA_SOURCE] [--debug] [--dont-compare] [--inventory-columns INVENTORY_COLUMNS] [--keep-domain] [--keep-max KEEP_MAX] [--lldp] [--lowercase] [--min-age MIN_AGE]
-                               [--path-in-inventory PATH_IN_INVENTORY] [--time-format TIME_FORMAT] [--uppercase]
-
-This script creates the topology data file needed for the Checkmk "network_visualization" plugin by Andreas Boesl and schnetz.
-For more information see https://forum.checkmk.com/t/network-visualization/41680 and https://exchange.checkmk.com/p/network-visualization
-
-The inventory data could be created with my inventory plugins:
+usage: create_topology_data.py [-h] [-m] [-o OUTPUT_DIRECTORY]
+                               [-s SEED_DEVICES [SEED_DEVICES ...]] [-v]
+                               [--data-source DATA_SOURCE] [--debug] [--dont-compare]
+                               [--inventory-columns INVENTORY_COLUMNS] [--keep-domain]
+                               [--keep-max KEEP_MAX] [--lldp] [--lowercase]
+                               [--min-age MIN_AGE]
+                               [--path-in-inventory PATH_IN_INVENTORY]
+                               [--time-format TIME_FORMAT] [--uppercase]
+
+This script creates the topology data file needed for the Checkmk "network_visualization"
+plugin by Andreas Boesl and schnetz. For more information see
+the announcement from schnetz: https://forum.checkmk.com/t/network-visualization/41680
+and the plugin on the Exchange: https://exchange.checkmk.com/p/network-visualization .
+
+The required inventory data can be created with my inventory plugins:
 CDP: https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_cdp_cache
 LLDP: https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_lldp_cache
 
-Version: 0.0.5-202310117 | Written by: thl-cmk, for more information see: https://thl-cmk.hopto.org
+Version: 0.0.5-202310117 | Written by: thl-cmk
+for more information see: https://thl-cmk.hopto.org
 
 options:
   -h, --help            show this help message and exit
   -m, --make-default    Set the created topology data as default
   -o OUTPUT_DIRECTORY, --output-directory OUTPUT_DIRECTORY
-                        Directory name where to save the topology data. I.e.: my_topology. Default is the actual date/time in "--time-format" format.
+                        Directory name where to save the topology data.
+                        I.e.: my_topology. Default is the actual date/time
+                        in "--time-format" format.
                         NOTE: the directory is a sub directory under "~/var/topology_data/"
   -s SEED_DEVICES [SEED_DEVICES ...], --seed-devices SEED_DEVICES [SEED_DEVICES ...]
-                        List of devices to start the topology discovery from. I.e. Core01 Core02
+                        List of devices to start the topology discovery from.
+                        I.e. Core01 Core02
   -v, --version         Print version of this script and exit
   --data-source DATA_SOURCE
-                        The source from which the topology data originates. I.e. inv_CDP for CDP data from the inventory. NOTE: right now this only an unused label.
+                        The source from which the topology data originates.
+                        I.e. inv_CDP for CDP data from the inventory.
+                        NOTE: right now this only an unused label.
   --debug               Print debug information
-  --dont-compare        Do not compare the actual topology data with the default topology data. By default, the actual
-                        topology is compared with the default topology. If the data matches, the actual topology is not saved.
-                        So, if you run this tool in a cron job, a new topology will be created only if there was a change,
-                        unless you use "--dont-compare".
+  --dont-compare        Do not compare the actual topology data with the default topology
+                        data. By default, the actual topology is compared with the default
+                        topology. If the data matches, the actual topology is not saved.
+                        So, if you run this tool in a cron job, a new topology will be
+                        created only if there was a change, unless you use "--dont-compare".
   --inventory-columns INVENTORY_COLUMNS
-                        Columns used from the inventory data. I.e. "device_id,local_port,device_port"
-                        NOTE: the columns must be in the order: neighbour, local_port, neighbour_port
+                        Columns used from the inventory data.
+                        I.e. "device_id,local_port,device_port"
+                        NOTE: the columns must be in the order: neighbour, local_port,
+                        neighbour_port
   --keep-domain         Do not remove the domain name from the neighbor name
-  --keep-max KEEP_MAX   Number of topologies to keep. The oldest topologies above keep max will be deleted.
-                        The default topologies will be always kept. The minimum value for --keep-max is 1.
-  --lldp                Set data source to inv_LLDP, inventory path to "networking,lldp_cache" and columns to "system_name,local_port_num,port_id"
+  --keep-max KEEP_MAX   Number of topologies to keep. The oldest topologies above keep
+                        max will be deleted. The minimum value for --keep-max is 1.
+                        Note: The default topologies will be always kept.
+  --lldp                Sets data source to inv_LLDP, inventory path 
+                        to "networking,lldp_cache" and columns
+                        to "system_name,local_port_num,port_id"
   --lowercase           Change neighbour names to all lower case
-  --min-age MIN_AGE     The minimum number of days before a topology is deleted by "--keep-max". Topologies that are not older than 1 days are always kept.
+  --min-age MIN_AGE     The minimum number of days before a topology is deleted
+                        by "--keep-max".
+                        Note: Topologies that are not older than 1 days are always kept.
   --path-in-inventory PATH_IN_INVENTORY
-                        Checkmk inventory path to the topology data. I.e. "networking,cdp_cache"
+                        Checkmk inventory path to the topology data.
+                        I.e. "networking,cdp_cache"
   --time-format TIME_FORMAT
                         Format string to render the time. (default: %Y-%m-%dT%H:%M:%S.%m)
   --uppercase           Change neighbour names to all upper case
@@ -109,6 +132,7 @@ for CDP (the default):
 for LLDP:
 ~/local/bin/network-topology/create_topology_data.py -s Core01 Core02 -m --lldp
 OMD[build]:~$ 
+
 ```
 
 </details>