From 732e042190302199d34b85677e86d729323e8659 Mon Sep 17 00:00:00 2001
From: Mariano Scazzariello <marianoscazzariello@gmail.com>
Date: Wed, 15 May 2024 17:32:15 +0200
Subject: [PATCH] =?UTF-8?q?Add=20`exclude`=20in=20docs=20(#294)=1B?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/kathara-lclean.1.ronn                 | 5 ++++-
 docs/kathara-lrestart.1.ronn               | 6 +++++-
 docs/kathara-lstart.1.ronn                 | 8 ++++++--
 src/Kathara/cli/command/LcleanCommand.py   | 2 +-
 src/Kathara/cli/command/LrestartCommand.py | 2 +-
 src/Kathara/cli/command/LstartCommand.py   | 2 +-
 6 files changed, 18 insertions(+), 7 deletions(-)

diff --git a/docs/kathara-lclean.1.ronn b/docs/kathara-lclean.1.ronn
index 7e32f66e..51ee27f2 100644
--- a/docs/kathara-lclean.1.ronn
+++ b/docs/kathara-lclean.1.ronn
@@ -4,7 +4,7 @@ kathara-lclean(1) -- Stop a Kathara network scenario
 
 ## SYNOPSIS
 
-`kathara lclean` [`-h`] [`-d` <DIRECTORY>] [<DEVICE_NAME> [<DEVICE_NAME> ...]]  
+`kathara lclean` [`-h`] [`-d` <DIRECTORY>] [`--exclude` <DEVICE_NAME> [<DEVICE_NAME> ...]] [<DEVICE_NAME> [<DEVICE_NAME> ...]]  
 
 ## DESCRIPTION
 
@@ -22,6 +22,9 @@ By default, stops all the devices of the network scenario. If a list of <DEVICE_
 	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.
 
+* `--exclude` [<DEVICE_NAME> [<DEVICE_NAME> ...]]
+    A list of device names. You can exclude certain devices of the network scenario from being shut down.
+
 * `DEVICE_NAME`:
     A list of device names. Instead of shutting down the whole network scenario, only specified devices are stopped.
 
diff --git a/docs/kathara-lrestart.1.ronn b/docs/kathara-lrestart.1.ronn
index 3f0a62ce..2b11c558 100644
--- a/docs/kathara-lrestart.1.ronn
+++ b/docs/kathara-lrestart.1.ronn
@@ -7,7 +7,8 @@ kathara-lrestart(1) -- Restart a Kathara network scenario
 `kathara lrestart` [`-h`] [`-F`] [`-l`]  
 [`--noterminals` | `--terminals` | `--privileged`] [`-d` <DIRECTORY>]  
 [`-o` [<OPTION> [<OPTION> ...]]] [`--xterm` <XTERM>]  
-[`--no-hosthome` \| `--hosthome`] [`--no-shared` \| `--shared`] [<DEVICE_NAME> [<DEVICE_NAME> ...]]
+[`--no-hosthome` \| `--hosthome`] [`--no-shared` \| `--shared`] [`--exclude` <DEVICE_NAME> [<DEVICE_NAME> ...]]  
+[<DEVICE_NAME> [<DEVICE_NAME> ...]]
 
 
 ## DESCRIPTION
@@ -75,6 +76,9 @@ Mainly it has the same options of `lstart` with the lack of some options (e.g. `
 
     Mount the `shared` directory inside the network scenario folder inside all devices on the special directory `/shared`. This is the default specified in `kathara.conf`(5) file.
 
+* `--exclude` [<DEVICE_NAME> [<DEVICE_NAME> ...]]
+    A list of device names. You can exclude certain devices of the network scenario from being restarted.
+
 * `DEVICE_NAME`:
     A list of device names. Instead of restarting the whole network scenario, only specified devices are restarted.
 
diff --git a/docs/kathara-lstart.1.ronn b/docs/kathara-lstart.1.ronn
index d199cc1e..729a7bda 100644
--- a/docs/kathara-lstart.1.ronn
+++ b/docs/kathara-lstart.1.ronn
@@ -6,7 +6,8 @@ kathara-lstart(1) -- Start a Kathara network scenario
 
 `kathara lstart` [`-h`] [`--noterminals` \| `--terminals` \| `--privileged`]  
 [`-d` <DIRECTORY>] [`-F`] [`-l`] [`-o` [<OPTION> [<OPTION> ...]]] [`--xterm` <XTERM>]  
-[`--print`]  [`--no-hosthome` \| `--hosthome`] [`--no-shared` \| `--shared`] [<DEVICE_NAME> [<DEVICE_NAME> ...]]
+[`--print`]  [`--no-hosthome` \| `--hosthome`] [`--no-shared` \| `--shared`] [`--exclude` <DEVICE_NAME> [<DEVICE_NAME> ...]]  
+[<DEVICE_NAME> [<DEVICE_NAME> ...]]
 
 
 ## DESCRIPTION
@@ -86,6 +87,9 @@ The configuration of a Kathara network scenario consists of some files described
 
     Mount the `shared` directory inside the network scenario folder inside all devices on the special directory `/shared`. This is the default specified in `kathara.conf`(5) file.
 
+* `--exclude` [<DEVICE_NAME> [<DEVICE_NAME> ...]]
+    A list of device names. You can exclude certain devices of the network scenario from being started.
+
 * `DEVICE_NAME`:
     A list of device names. Instead of starting the whole network scenario, only specified devices are started.
 
@@ -93,4 +97,4 @@ m4_include(footer.txt)
 
 ## SEE ALSO
 
-`kathara`(1), `kathara-lclean`(1), `kathara-lrestart`(1), `kathara-ltest`(1), `kathara-linfo`(1), `kathara-lab.conf`(5), `kathara-lab.dep`(5), `kathara-lab.ext`(5)
+`kathara`(1), `kathara-lclean`(1), `kathara-lrestart`(1), `kathara-ltest`(1), `kathara-linfo`(1), `kathara-lab.conf`(5), `kathara-lab.dep`(5), `kathara-lab.ext`(5)
\ No newline at end of file
diff --git a/src/Kathara/cli/command/LcleanCommand.py b/src/Kathara/cli/command/LcleanCommand.py
index a1de49ca..b50c71bf 100644
--- a/src/Kathara/cli/command/LcleanCommand.py
+++ b/src/Kathara/cli/command/LcleanCommand.py
@@ -37,7 +37,7 @@ def __init__(self) -> None:
             '--exclude',
             dest='excluded_machines',
             metavar='DEVICE_NAME',
-            nargs='*',
+            nargs='+',
             default=[],
             help='Exclude specified devices from clean.'
         )
diff --git a/src/Kathara/cli/command/LrestartCommand.py b/src/Kathara/cli/command/LrestartCommand.py
index cda1cbef..bb47e13a 100644
--- a/src/Kathara/cli/command/LrestartCommand.py
+++ b/src/Kathara/cli/command/LrestartCommand.py
@@ -114,7 +114,7 @@ def __init__(self) -> None:
             '--exclude',
             dest='excluded_machines',
             metavar='DEVICE_NAME',
-            nargs='*',
+            nargs='+',
             default=[],
             help='Exclude specified devices.'
         )
diff --git a/src/Kathara/cli/command/LstartCommand.py b/src/Kathara/cli/command/LstartCommand.py
index 8892a0fa..f3abc483 100644
--- a/src/Kathara/cli/command/LstartCommand.py
+++ b/src/Kathara/cli/command/LstartCommand.py
@@ -133,7 +133,7 @@ def __init__(self) -> None:
             '--exclude',
             dest='excluded_machines',
             metavar='DEVICE_NAME',
-            nargs='*',
+            nargs='+',
             default=[],
             help='Exclude specified devices from startup.'
         )