From 1dc92974917e9fbaa2002c3aef5826fa1d1d0219 Mon Sep 17 00:00:00 2001
From: q3aql <q3aql@duck.com>
Date: Sat, 11 Mar 2023 15:46:16 +0100
Subject: [PATCH] Update documentation

---
 doc/ks-upa.md | 19 ++++++++++++++++---
 doc/ks-upf.md | 19 ++++++++++++++++---
 doc/ks-upr.md | 21 +++++++++++++++++----
 doc/ks-upv.md | 19 ++++++++++++++++---
 src/ks-upa    |  2 +-
 src/ks-upf    |  2 +-
 src/ks-upr    | 22 +++++++++++-----------
 src/ks-upv    |  2 +-
 8 files changed, 79 insertions(+), 27 deletions(-)

diff --git a/doc/ks-upa.md b/doc/ks-upa.md
index b9a1af1..123b8a5 100644
--- a/doc/ks-upa.md
+++ b/doc/ks-upa.md
@@ -9,6 +9,7 @@ $ ks-upa -g  - Create configuration
 $ ks-upa -r  - Remove configuration
 $ ks-upa -c  - Show configuration
 $ ks-upa -e  - Edit configuration
+$ ks-upa -p  - Generate certificate
 $ ks-upa -v  - Show version
 $ ks-upa -h  - Show help
 ```
@@ -25,10 +26,12 @@ $ ks-upa -h  - Show help
 
     ```shell
     * Enter the server user: anonymous
-    * Enter the server key: *******
+    * Enter the server password (type 'pem' for use pem certificate): *******
     * Enter the server URL: mypersonaldomain.es
     * Enter the path on the server: /home/anonymous
     * Enter the local path to scan: /home/local/videos
+    * Setting 'scp' as the default tool
+    * Setting port 22 as the default port
     ````
 
   * Once the connection data has been entered, the local directory will be scanned to detect the audios and upload them to the server directory.
@@ -53,7 +56,7 @@ $ ks-upa -h  - Show help
 
     ```shell
     * Server User: anonymous
-    * Server Password: *******
+    * Server Password/PEM: *******
     * URL (or IP) Server: mypersonaldomain.es
     * Destination Path (Server): /home/anonymous
     * Scan Path (Local): /home/local/videos
@@ -73,7 +76,7 @@ $ ks-upa -h  - Show help
   
     ```shell
     1 - Edit User (anonymous)
-    2 - Edit Password (*******)
+    2 - Edit Password/PEM (*******)
     3 - Edit Server (mypersonaldomain.es)
     4 - Edit Dest. Path (/home/anonymous)
     5 - Edit Local Path (/home/local/videos)
@@ -84,7 +87,17 @@ $ ks-upa -h  - Show help
 
     * Choose an option: 
     ````
+
+### Generate certificate (on remote machine):
+
+  * To generate certificate for connect to remote machine, run the following command:
+
+    ```shell
+    $ ks-upa -p
+    ````
     
+  * Copy the file [user]-[hostname].pem to your machine.
+
 ### Show version:
 
   * You can check the version with the command:
diff --git a/doc/ks-upf.md b/doc/ks-upf.md
index c84e668..e765189 100644
--- a/doc/ks-upf.md
+++ b/doc/ks-upf.md
@@ -9,6 +9,7 @@ $ ks-upf -g  - Create configuration
 $ ks-upf -r  - Remove configuration
 $ ks-upf -c  - Show configuration
 $ ks-upf -e  - Edit configuration
+$ ks-upf -p  - Generate certificate
 $ ks-upf -v  - Show version
 $ ks-upf -h  - Show help
 ```
@@ -25,10 +26,12 @@ $ ks-upf -h  - Show help
 
     ```shell
     * Enter the server user: anonymous
-    * Enter the server key: *******
+    * Enter the server password (type 'pem' for use pem certificate): *******
     * Enter the server URL: mypersonaldomain.es
     * Enter the path on the server: /home/anonymous
     * Enter the local path to scan: /home/local/videos
+    * Setting 'scp' as the default tool
+    * Setting port 22 as the default port
     ````
 
   * Once the connection data has been entered, the local directory will be scanned to detect file(s) and upload them to the server directory.
@@ -53,7 +56,7 @@ $ ks-upf -h  - Show help
 
     ```shell
     * Server User: anonymous
-    * Server Password: *******
+    * Server Password/PEM: *******
     * URL (or IP) Server: mypersonaldomain.es
     * Destination Path (Server): /home/anonymous
     * Scan Path (Local): /home/local/videos
@@ -73,7 +76,7 @@ $ ks-upf -h  - Show help
 
     ```shell
     1 - Edit User (anonymous)
-    2 - Edit Password (*******)
+    2 - Edit Password/PEM (*******)
     3 - Edit Server (mypersonaldomain.es)
     4 - Edit Dest. Path (/home/anonymous)
     5 - Edit Local Path (/home/local/videos)
@@ -84,7 +87,17 @@ $ ks-upf -h  - Show help
 
     * Choose an option:
     ````
+
+### Generate certificate (on remote machine):
+
+  * To generate certificate for connect to remote machine, run the following command:
+
+    ```shell
+    $ ks-upf -p
+    ````
     
+  * Copy the file [user]-[hostname].pem to your machine.
+
 ### Show version:
 
   * You can check the version with the command:
diff --git a/doc/ks-upr.md b/doc/ks-upr.md
index 3fcafcb..d38ba9f 100644
--- a/doc/ks-upr.md
+++ b/doc/ks-upr.md
@@ -9,6 +9,7 @@ $ ks-upr -g  - Create configuration
 $ ks-upr -r  - Remove configuration
 $ ks-upr -c  - Show configuration
 $ ks-upr -e  - Edit configuration
+$ ks-upr -p  - Generate certificate
 $ ks-upr -v  - Show version
 $ ks-upr -h  - Show help
 ```
@@ -25,10 +26,12 @@ $ ks-upr -h  - Show help
 
     ```shell
     * Enter the server user: anonymous
-    * Enter the server key: *******
+    * Enter the server password (type 'pem' for use pem certificate): *******
     * Enter the server URL: mypersonaldomain.es
     * Enter the path on the server: /home/anonymous
     * Enter the local path to scan: /home/local/videos
+    * Setting 'scp' as the default tool
+    * Setting port 22 as the default port
     ````
 
   * Once the connection data has been entered, the local directory will be scanned to upload recursively them to the server directory.
@@ -53,7 +56,7 @@ $ ks-upr -h  - Show help
 
     ```shell
     * Server User: anonymous
-    * Server Password: *******
+    * Server Password/PEM: *******
     * URL (or IP) Server: mypersonaldomain.es
     * Destination Path (Server): /home/anonymous
     * Scan Path (Local): /home/local/videos
@@ -73,18 +76,28 @@ $ ks-upr -h  - Show help
 
     ```shell
     1 - Edit User (anonymous)
-    2 - Edit Password (*******)
+    2 - Edit Password/PEM (*******)
     3 - Edit Server (mypersonaldomain.es)
     4 - Edit Dest. Path (/home/anonymous)
     5 - Edit Local Path (/home/local/videos)
     6 - Edit Upload Tool (scp)
-    7 - Edit Port Connection (22)
+    7 - Edit Port Connection (22))
 
     8 - Exit
 
     * Choose an option: 
     ````
+
+### Generate certificate (on remote machine):
+
+  * To generate certificate for connect to remote machine, run the following command:
+
+    ```shell
+    $ ks-upr -p
+    ````
     
+  * Copy the file [user]-[hostname].pem to your machine.
+
 ### Show version:
 
   * You can check the version with the command:
diff --git a/doc/ks-upv.md b/doc/ks-upv.md
index f14c2ef..21cf75a 100644
--- a/doc/ks-upv.md
+++ b/doc/ks-upv.md
@@ -9,6 +9,7 @@ $ ks-upv -g  - Create configuration
 $ ks-upv -r  - Remove configuration
 $ ks-upv -c  - Show configuration
 $ ks-upv -e  - Edit configuration
+$ ks-upv -p  - Generate certificate
 $ ks-upv -v  - Show version
 $ ks-upv -h  - Show help
 ```
@@ -25,10 +26,12 @@ $ ks-upv -h  - Show help
 
     ```shell
     * Enter the server user: anonymous
-    * Enter the server key: *******
+    * Enter the server password (type 'pem' for use pem certificate): *******
     * Enter the server URL: mypersonaldomain.es
     * Enter the path on the server: /home/anonymous
     * Enter the local path to scan: /home/local/videos
+    * Setting 'scp' as the default tool
+    * Setting port 22 as the default port
     ````
 
   * Once the connection data has been entered, the local directory will be scanned to detect the videos and upload them to the server directory.
@@ -53,7 +56,7 @@ $ ks-upv -h  - Show help
 
     ```shell
     * Server User: anonymous
-    * Server Password: *******
+    * Server Password/PEM: *******
     * URL (or IP) Server: mypersonaldomain.es
     * Destination Path (Server): /home/anonymous
     * Scan Path (Local): /home/local/videos
@@ -73,7 +76,7 @@ $ ks-upv -h  - Show help
 
     ```shell
     1 - Edit User (anonymous)
-    2 - Edit Password (*******)
+    2 - Edit Password/PEM (*******)
     3 - Edit Server (mypersonaldomain.es)
     4 - Edit Dest. Path (/home/anonymous)
     5 - Edit Local Path (/home/local/videos)
@@ -85,6 +88,16 @@ $ ks-upv -h  - Show help
     * Choose an option: 
     ````
     
+### Generate certificate (on remote machine):
+
+  * To generate certificate for connect to remote machine, run the following command:
+
+    ```shell
+    $ ks-upv -p
+    ````
+    
+  * Copy the file [user]-[hostname].pem to your machine.
+    
 ### Show version:
 
   * You can check the version with the command:
diff --git a/src/ks-upa b/src/ks-upa
index e03a16f..bfd79bd 100755
--- a/src/ks-upa
+++ b/src/ks-upa
@@ -478,7 +478,7 @@ function showConfig() {
       showPassword="${showPassword}*"
       totalchars=$(expr ${totalchars} + 1)
     done
-    echo "- Server Password: ${showPassword}"
+    echo "- Server Password/PEM: ${showPassword}"
     configAvailable=1
   fi
   if [ -f ${dirConfig}/ks-upload-server ] ; then
diff --git a/src/ks-upf b/src/ks-upf
index 76d2389..892aacb 100755
--- a/src/ks-upf
+++ b/src/ks-upf
@@ -505,7 +505,7 @@ function showConfig() {
       showPassword="${showPassword}*"
       totalchars=$(expr ${totalchars} + 1)
     done
-    echo "- Server Password: ${showPassword}"
+    echo "- Server Password/PEM: ${showPassword}"
     configAvailable=1
   fi
   if [ -f ${dirConfig}/ks-upload-server ] ; then
diff --git a/src/ks-upr b/src/ks-upr
index bd2214c..c6d4d67 100755
--- a/src/ks-upr
+++ b/src/ks-upr
@@ -364,7 +364,7 @@ function showConfig() {
       showPassword="${showPassword}*"
       totalchars=$(expr ${totalchars} + 1)
     done
-    echo "- Server Password: ${showPassword}"
+    echo "- Server Password/PEM: ${showPassword}"
     configAvailable=1
   fi
   if [ -f ${dirConfig}/ks-upload-server ] ; then
@@ -420,7 +420,7 @@ function editConfig() {
     editUpvTool=$(cat ${dirConfig}/ks-upload-tool 2> /dev/null)
     editUpvPort=$(cat ${dirConfig}/ks-upload-port 2> /dev/null)
     echo ""
-    echo "* ks-upv (ks-tools) v${VERSION} (${M_DATE})"
+    echo "* ks-upr (ks-tools) v${VERSION} (${M_DATE})"
     echo ""
     echo "+ Config: ${dirConfig}/ks-upload-*"
     echo ""
@@ -530,12 +530,12 @@ function createConfig() {
 # Start script
   clear
   echo ""
-  echo "* ks-upv (ks-tools) v${VERSION} (${M_DATE})"
+  echo "* ks-upr (ks-tools) v${VERSION} (${M_DATE})"
   echo ""
   checkDependencies
   # Ask the user and if it exists, read it from the config.
   if [ -f ${dirConfig}/ks-upload-user ] ; then
-    echo "+ The USER configuration already exists (Use: 'ks-upv -e' for edit)"
+    echo "+ The USER configuration already exists (Use: 'ks-upr -e' for edit)"
   else
     echo -n "* Enter the server user: " ; read USER
     user=${USER}
@@ -543,7 +543,7 @@ function createConfig() {
   fi
   # Ask the password and if it exists, read it from the config.
   if [ -f ${dirConfig}/ks-upload-pass ] ; then
-    echo "+ The PASSWORD/PEM configuration already exists (Use: 'ks-upv -e' for edit)" 
+    echo "+ The PASSWORD/PEM configuration already exists (Use: 'ks-upr -e' for edit)" 
   else
     echo -n "* Enter the server password (type 'pem' for use pem certificate): " ; read PASS
     if [ "${PASS}" == "pem" ] ; then
@@ -565,7 +565,7 @@ function createConfig() {
   fi
   # Ask the server URL and if it exists, read it from the config.
   if [ -f ${dirConfig}/ks-upload-server ] ; then
-    echo "+ The SERVER configuration already exists (Use: 'ks-upv -e' for edit)"
+    echo "+ The SERVER configuration already exists (Use: 'ks-upr -e' for edit)"
   else
     echo -n "* Enter the server URL: " ; read SERVER
     server=${SERVER}
@@ -573,7 +573,7 @@ function createConfig() {
   fi
   # Ask the path on the server and if it exists, read it from the config.
   if [ -f ${dirConfig}/ks-upload-dirserver ] ; then
-    echo "+ The SERVER PATH configuration already exists (Use: 'ks-upv -e' for edit)"
+    echo "+ The SERVER PATH configuration already exists (Use: 'ks-upr -e' for edit)"
   else
     echo -n "* Enter the path on the server: " ; read DIR_SERVER
     dirServer=${DIR_SERVER}
@@ -581,7 +581,7 @@ function createConfig() {
   fi
   # Ask the local path and if it exists, read it from the config.
   if [ -f ${dirConfig}/ks-upload-dirlocal ] ; then
-    echo "+ The LOCAL PATH configuration already exists (Use: 'ks-upv -e' for edit)"
+    echo "+ The LOCAL PATH configuration already exists (Use: 'ks-upr -e' for edit)"
   else
     echo -n "* Enter the local path to scan: " ; read DIR
     dirLocal=${DIR}
@@ -589,14 +589,14 @@ function createConfig() {
   fi
   # Configure upload tool by default
   if [ -f ${dirConfig}/ks-upload-tool ] ; then
-    echo "+ The UPLOAD TOOL configuration already exists (Use: 'ks-upv -e' for edit)"
+    echo "+ The UPLOAD TOOL configuration already exists (Use: 'ks-upr -e' for edit)"
   else
     echo "* Setting 'scp' as the default tool"
     echo "scp" > ${dirConfig}/ks-upload-tool
   fi
    # Configure port by default
   if [ -f ${dirConfig}/ks-upload-port ] ; then
-    echo "+ The PORT configuration already exists (Use: 'ks-upv -e' for edit)"
+    echo "+ The PORT configuration already exists (Use: 'ks-upr -e' for edit)"
   else
     echo "* Setting port 22 as the default port"
     echo "22" > ${dirConfig}/ks-upload-port
@@ -628,7 +628,7 @@ function showHelp() {
   echo " $ ks-upr -r  - Remove configuration"
   echo " $ ks-upr -c  - Show configuration"
   echo " $ ks-upr -e  - Edit configuration"
-  echo " $ ks-upv -p  - Generate certificate"
+  echo " $ ks-upr -p  - Generate certificate"
   echo " $ ks-upr -v  - Show version"
   echo " $ ks-upr -h  - Show help"
   echo ""
diff --git a/src/ks-upv b/src/ks-upv
index 320ef9b..98c29b5 100755
--- a/src/ks-upv
+++ b/src/ks-upv
@@ -478,7 +478,7 @@ function showConfig() {
       showPassword="${showPassword}*"
       totalchars=$(expr ${totalchars} + 1)
     done
-    echo "- Server Password: ${showPassword}"
+    echo "- Server Password/PEM: ${showPassword}"
     configAvailable=1
   fi
   if [ -f ${dirConfig}/ks-upload-server ] ; then