KatharaFramework · tcaiazzi · Sep 30, 2022 · May 17, 2022 · May 17, 2022 · May 30, 2022
diff --git a/docs/kathara-connect.1.ronn b/docs/kathara-connect.1.ronn
@@ -18,10 +18,10 @@ Open a shell in device DEVICE_NAME.
     Show an help message and exit.
 
 * `-d` <DIRECTORY>, `--directory` <DIRECTORY>:
-    Specify the folder containing the lab.
+    Specify the folder containing the network scenario.
 
-    Connect to a Kathara device belonging to a lab that is located inside DIRECTORY.  
-	If no `-d` option is provided, assume the lab is located in the current directory.
+    Connect to a Kathara device belonging to a network scenario that is located inside DIRECTORY.  
+	If no `-d` option is provided, assume the network scenario is located in the current directory.
 	This option cannot be used in conjuction with `-v` or `--vdevice`.
 
 * `-v`, `--vdevice`:
@@ -51,7 +51,7 @@ Connects to a device called `pc1`, started with `kathara-vstart`(1).
 
 	kathara connect as1r1
 
-Connects to a device called `as1r1` belonging to a lab located in current folder and started with `kathara-lstart`(1).
+Connects to a device called `as1r1` belonging to a network scenario located in current folder and started with `kathara-lstart`(1).
 
 m4_include(footer.txt)
 

diff --git a/docs/kathara-exec.1.ronn b/docs/kathara-exec.1.ronn
@@ -18,10 +18,10 @@ Execute a command in the Kathara device DEVICE_NAME.
     Show an help message and exit.
 
 * `-d` <DIRECTORY>, `--directory` <DIRECTORY>:
-    Specify the folder containing the lab.
+    Specify the folder containing the network scenario.
 
-    Execute the specified command in a Kathara device belonging to a lab that is located inside DIRECTORY.  
-	If no `-d` option is provided, assume the lab is located in the current directory.
+    Execute the specified command in a Kathara device belonging to a network scenario that is located inside DIRECTORY.  
+	If no `-d` option is provided, assume the network scenario is located in the current directory.
 	This option cannot be used in conjuction with `-v` or `--vmachine`.
 
 * `-v`, `--vmachine`:
@@ -49,7 +49,7 @@ Execute the command ping into a device called `pc1`, started with `kathara-vstar
 
 	kathara exec as1r1 "ping 127.0.0.1"
 
-Execute the command ping into a device called `as1r1` belonging to a lab located in current folder and started with `kathara-lstart`(1).
+Execute the command ping into a device called `as1r1` belonging to a network scenario located in current folder and started with `kathara-lstart`(1).
 
 m4_include(footer.txt)
 

diff --git a/docs/kathara-lab-dirs.7.ronn b/docs/kathara-lab-dirs.7.ronn
@@ -1,10 +1,10 @@
 m4_changequote()
-kathara-lab-dirs(7) -- Lab directory structure
+kathara-lab-dirs(7) -- Network scenario directory structure
 =============================================
 
 ## DESCRIPTION
 
-A generic lab directory `lab-path` should have the following structure.
+A generic network scenario directory `lab-path` should have the following structure.
 
 * `lab-path/lab.conf`:
 	See `kathara-lab.conf`(5)
@@ -31,7 +31,7 @@ A generic lab directory `lab-path` should have the following structure.
 	Note that this script is executed by using the `device_shell` value specified in `kathara.conf`(5) as interpreter. If you would like to use a different interpreter, change it inside `kathara.conf`(5) or with `kathara-settings`(1).
 
 * `lab-path/shared/`:
-	This is a shared folder between the host and all the lab devices. This could be useful to transfer files between the host and a device or viceversa.
+	This is a shared folder between the host and all the network scenario devices. This could be useful to transfer files between the host and a device or viceversa.
 
 * `lab-path/shared.startup`
 	This is a shell script that will be run on every device just before `lab-path/device.startup`. It is not required to assign this script the executable permission.
@@ -44,7 +44,7 @@ A generic lab directory `lab-path` should have the following structure.
 	Note that this script is executed by using the `device_shell` value specified in `kathara.conf`(5) as interpreter. If you would like to use a different interpreter, change it inside `kathara.conf`(5) or with `kathara-settings`(1).
 
 * `lab-path/_test/`
-	This subdirectory contains information for performing a test of the lab. It may be automatically created by `kathara-ltest`(1) or may contain user created files describing customized tests. For more information about this directory, see `kathara-ltest`(1).
+	This subdirectory contains information for performing a test of the network scenario. It may be automatically created by `kathara-ltest`(1) or may contain user created files describing customized tests. For more information about this directory, see `kathara-ltest`(1).
 
 m4_include(footer.txt)
 

diff --git a/docs/kathara-lab.conf.5.ronn b/docs/kathara-lab.conf.5.ronn
@@ -1,10 +1,10 @@
 m4_changequote()
-kathara-lab.conf(5) -- Lab configuration file
+kathara-lab.conf(5) -- Network scenario configuration file
 =============================================
 
 ## DESCRIPTION
 
-The main lab configuration file. In this file you can specify the names of devices to be started, any option that should be used when launching them, and the topology of the network that connects them. Optionally, you can also provide some descriptive information for the lab, which will be displayed upon its startup. This file is not explicitly required, but running a lab without a lab.conf file is kind of useless...
+The main network scenario configuration file. In this file you can specify the names of devices to be started, any option that should be used when launching them, and the topology of the network that connects them. Optionally, you can also provide some descriptive information for the network scenario, which will be displayed upon its startup. This file is not explicitly required, but running a network scenario without a lab.conf file is kind of useless...
 
 This file is a list of `device[arg]=value` assignments, where `arg` can be an integer value or the name of an option (described below).
 
@@ -55,16 +55,16 @@ In order to establish a uniform convention, comment lines should always start wi
 * `num_terms` (integer):
     Choose the number of terminals to open for this device.
 
-## LAB META INFORMATION
+## NETWORK SCENARIO META INFORMATION
 
-It is also possible to provide descriptive information about a lab by using one of the following special assignments:
+It is also possible to provide descriptive information about a network scenario by using one of the following special assignments:
 
-+ LAB_NAME=string (a word as identifier for the lab)
-+ LAB_DESCRIPTION=string (a brief description of the purpose of the lab)
-+ LAB_VERSION=string (the version of the lab)
-+ LAB_AUTHOR=string (people who have written the lab)
-+ LAB_EMAIL=string (contacts of lab authors)
-+ LAB_WEB=string (useful web resources related to the lab)
++ LAB_NAME=string (a word as identifier for the network scenario)
++ LAB_DESCRIPTION=string (a brief description of the purpose of the network scenario)
++ LAB_VERSION=string (the version of the network scenario)
++ LAB_AUTHOR=string (people who have written the network scenario)
++ LAB_EMAIL=string (contacts of network scenario authors)
++ LAB_WEB=string (useful web resources related to the network scenario)
 
 ## EXAMPLE
 

diff --git a/docs/kathara-lab.dep.5.ronn b/docs/kathara-lab.dep.5.ronn
@@ -1,5 +1,5 @@
 m4_changequote()
-kathara-lab.dep(5) -- Lab dependencies file
+kathara-lab.dep(5) -- Network scenario dependencies file
 =============================================
 
 ## DESCRIPTION

diff --git a/docs/kathara-lab.ext.5.ronn b/docs/kathara-lab.ext.5.ronn
@@ -1,5 +1,5 @@
 m4_changequote()
-kathara-lab.ext(5) -- Lab external networks file
+kathara-lab.ext(5) -- Network scenario external networks file
 =============================================
 
 ## DESCRIPTION

diff --git a/docs/kathara-lclean.1.ronn b/docs/kathara-lclean.1.ronn
@@ -1,5 +1,5 @@
 m4_changequote()
-kathara-lclean(1) -- Stop a Kathara lab
+kathara-lclean(1) -- Stop a Kathara network scenario
 =============================================
 
 ## SYNOPSIS
@@ -8,22 +8,22 @@ kathara-lclean(1) -- Stop a Kathara lab
 
 ## DESCRIPTION
 
-Gracefully shut down a running lab.
-By default, stops all the devices of the lab. If a list of <DEVICE_NAME>s is provided, then only devices with a matching name and that are part of the lab will be halted. 
+Gracefully shut down a running network scenario.
+By default, stops all the devices of the network scenario. If a list of <DEVICE_NAME>s is provided, then only devices with a matching name and that are part of the network scenario will be halted. 
 
 ## OPTIONS
 
 * `-h`, `--help`:
     Show an help message and exit.
 
 * `-d` <DIRECTORY>, `--directory` <DIRECTORY>:
-	Specify the folder containing the lab.
+	Specify the folder containing the network scenario.
 
-	Cleans the Kathara lab that is located inside <DIRECTORY>.  
-	If no `-d` option is provided, assume the lab is located in the current directory.
+	Cleans the Kathara network scenario that is located inside <DIRECTORY>.  
+	If no `-d` option is provided, assume the network scenario is located in the current directory.
 
 * `DEVICE_NAME`:
-    A list of device names. Instead of shutting down the whole lab, only specified devices are stopped.
+    A list of device names. Instead of shutting down the whole network scenario, only specified devices are stopped.
 
 m4_include(footer.txt)
 

diff --git a/docs/kathara-lconfig.1.ronn b/docs/kathara-lconfig.1.ronn
@@ -1,39 +1,48 @@
 m4_changequote()
-kathara-lconfig(1) -- Attach network interfaces to a running Kathara device of a Kathara lab
+kathara-lconfig(1) -- Attach network interfaces to a running Kathara device of a Kathara network scenario
 =============================================
 
 ## SYNOPSIS
 
-`kathara lconfig` [`-h`] [`-d` <DIRECTORY>] `-n` <DEVICE_NAME> `--eth` <CD> [<CD> ...]  
+`kathara lconfig` [`-h`] [`-d` <DIRECTORY>] `-n` <DEVICE_NAME> (`--add` <CD> [<CD> ...] \| `--rm` <CD> [<CD> ...])  
 
 ## DESCRIPTION
 
-Attach network interfaces to running devices of a Kathara lab "on the fly". The affected device is identified by <DEVICE_NAME>, which is the name of a running device.
+Manage the network interfaces of a running Kathara device in a network scenario. The affected device is identified by <DEVICE_NAME>, which is the name of the running device in the network scenario. 
 
 ## OPTIONS
 
 * `-h`, `--help`:
     Show a help message and exit.
 
 * `-d` <DIRECTORY>, `--directory` <DIRECTORY>:
-    Specify the folder containing the lab.
+    Specify the folder containing the network scenario.
 
-    Attach network interfaces to running devices of the Kathara lab that is located inside <DIRECTORY>.
-    If no `-d` option is provided, assume the lab is located in the current directory.
+    Manage the network interfaces of running devices in a Kathara network scenario that is located inside <DIRECTORY>.
+    If no `-d` option is provided, assume the network scenario is located in the current directory.
 
 * `-n` <DEVICE_NAME>, `--name` <DEVICE_NAME>:
-    Name of the device to be connected on desired collision domains.
+    Name of the device to manage.
 
-* `--eth` <CD> [<CD> ...]:
-	Specify the collision domain for an interface.
+* `--add` <CD> [<CD> ...]:
+	Specify the collision domain to add.
 
-    Equip the device with an additional network interface attached to a (virtual) collision domain whose name is <CD>. The number of the resulting network interface is generated incrementing the number of the last network interface of the device.
+    Equip the device with an additional network interface attached to a (virtual) collision domain whose name is <CD>. The number of the resulting network interface is generated incrementing the number of the last network interface used by the device.
+
+* `--rm` <CD> [<CD> ...]:
+	Specify the collision domain to remove.
+
+    Disconnect the device from the collision domain whose name is <CD> and remove the corresponding interface.
 
 ## EXAMPLES
 
-    kathara lconfig -d path/to/lab -n pc1 --eth X Y
+    kathara lconfig -d path/to/network_scenario -n pc1 --add X Y
+
+Two new interfaces will be added to the device pc1 in the network scenario located in "path/to/network_scenario": the first one will be attached to the collision domain named X, while the other one to the collision domain named Y. Both the interfaces will have to be configured by hand inside the device (for example, by using ifconfig).
+
+    kathara vconfig -n pc1 --rm X
 
-Two new interfaces will be added to the device pc1 of the lab: the first one will be attached to the collision domain named X, while the other one to the collision domain named Y. Both the interfaces will have to be configured by hand inside the device (for example, by using ifconfig).
+pc1, in the network scenario located in "path/to/network_scenario", will be disconnected from the collision domain named X and the corresponding network interface will be removed.
 
 m4_include(footer.txt)
 

diff --git a/docs/kathara-linfo.1.ronn b/docs/kathara-linfo.1.ronn
@@ -1,5 +1,5 @@
 m4_changequote()
-kathara-linfo(1) -- Show information about a Kathara lab
+kathara-linfo(1) -- Show information about a Kathara network scenario
 =============================================
 
 ## SYNOPSIS
@@ -9,11 +9,11 @@ kathara-linfo(1) -- Show information about a Kathara lab
 
 ## DESCRIPTION
 
-Show exhaustive status of each device of the current lab. Can only be used when after the lab is started.
+Show exhaustive status of each device of the current network scenario. Can only be used when after the network scenario is started.
 
 The following information are displayed:
 
-    + `LAB_HASH`: autogenerated hash associated with a lab
+    + `LAB_HASH`: autogenerated hash associated with a network scenario
     + `DEVICE_NAME`: name of the device
     + `STATUS`: status of the device
     + `CPU %`: the percentage of the host's CPU the device is using
@@ -27,21 +27,21 @@ The following information are displayed:
     Show an help message and exit.
 
 * `-d` <DIRECTORY>, `--directory` <DIRECTORY>:
-    Specify the folder containing the lab.
+    Specify the folder containing the network scenario.
 
-    If no `-d` option is provided, assume the lab is located in the current directory.
+    If no `-d` option is provided, assume the network scenario is located in the current directory.
 
 * `-l`, `--live`:
-    Live update of lab status.
+    Live update of network scenario status.
 
     To quit the live screen, pass the `SIGINT` `signal`(7) to the process (usually CTRL+C).
 
 * `-c`, `--conf`
     Read information from lab.conf and display the following:
 
     * Descriptive information (retrieved from `kathara-lab.conf`(5))
-    * Number of devices that make up the lab
-    * Number of networks that make up the lab
+    * Number of devices that make up the network scenario
+    * Number of networks that make up the network scenario
 
 * `-n` <DEVICE_NAME>, `--name` <DEVICE_NAME>:
     Show only info about a specified device.

diff --git a/docs/kathara-list.1.ronn b/docs/kathara-list.1.ronn
@@ -13,7 +13,7 @@ Display a variety of information for all the devices of the current user.
 
 The following information are displayed:
 
-* `LAB_HASH`: autogenerated hash associated with a lab
+* `LAB_HASH`: autogenerated hash associated with a network scenario
 * `DEVICE_NAME`: name of the device
 * `STATUS`: status of the device 
 * `CPU %`: the percentage of the host's CPU the device is using
@@ -32,13 +32,13 @@ The following information are displayed:
     This option can be run only by `root` user.
 
 * `-l`, `--live`:
-    Live mode, can be used only when a lab is launched.
+    Live mode, can be used only when a network scenario is launched.
 
-    Show exhaustive live status of each device of the current lab. Can only be used when after the lab is started. This overrides the default behavior of the command described above.
+    Show exhaustive live status of each device of the current network scenario. Can only be used when after the network scenario is started. This overrides the default behavior of the command described above.
 
     The following information are displayed:
 
-        + `LAB_HASH`: autogenerated hash associated with a lab
+        + `LAB_HASH`: autogenerated hash associated with a network scenario
         + `DEVICE_NAME`: name of the device
         + `STATUS`: status of the device 
         + `CPU %`: the percentage of the host's CPU the device is using