From ec17637fd065388744941a09969c3da31553e680 Mon Sep 17 00:00:00 2001 From: q3aql Date: Sun, 7 Mar 2021 18:35:27 +0100 Subject: [PATCH] Fix documentation --- doc/ks-upa.md | 60 +++++++++++++++++++++++++-------------------------- doc/ks-upf.md | 60 +++++++++++++++++++++++++-------------------------- doc/ks-upr.md | 60 +++++++++++++++++++++++++-------------------------- doc/ks-upv.md | 60 +++++++++++++++++++++++++-------------------------- 4 files changed, 120 insertions(+), 120 deletions(-) diff --git a/doc/ks-upa.md b/doc/ks-upa.md index d9db97c..8eb3124 100644 --- a/doc/ks-upa.md +++ b/doc/ks-upa.md @@ -3,26 +3,26 @@ ks-upa - Upload audio file(s) to server with rsync+ssh. ### Sintax: - `ks-upa -i - Start upload` - `ks-upa -r - Remove configuration` - `ks-upa -c - Show configuration` - `ks-upa -e - Edit configuration` - `ks-upa -v - Show version` - `ks-upa -h - Show help` + * `ks-upa -i - Start upload` + * `ks-upa -r - Remove configuration` + * `ks-upa -c - Show configuration` + * `ks-upa -e - Edit configuration` + * `ks-upa -v - Show version` + * `ks-upa -h - Show help` ### Initialize audio file(s) upload: * For initialize audio file(s) upload only run the following command: - `ks-upa -i` + * `ks-upa -i` * The first time you run the command, you will be asked for the necessary connection information: - `Enter the server user: anonymous` - `Enter the server key: 1234567` - `Enter the server URL: mypersonaldomain.es` - `Enter the path on the server: /home/anonymous` - `Enter the local path to scan: /home/local/videos` + * `Enter the server user: anonymous` + * `Enter the server key: 1234567` + * `Enter the server URL: mypersonaldomain.es` + * `Enter the path on the server: /home/anonymous` + * `Enter the local path to scan: /home/local/videos` * Once the connection data has been entered, the local directory will be scanned to detect the audios and upload them to the server directory. @@ -30,43 +30,43 @@ ks-upa - Upload audio file(s) to server with rsync+ssh. * If you want to clear the connection settings, you just need to run the following command: - `ks-upa -r` + * `ks-upa -r` ### Show configuration: * You can check the configuration with the following command: - `ks-upa -c` + * `ks-upa -c` * When consulting the configuration, we will see something like this: - `Server User: anonymous` - `Server Password: 1234567` - `URL (or IP) Server: mypersonaldomain.es` - `Destination Path (Server): /home/anonymous` - `Scan Path (Local): /home/local/videos` + * `Server User: anonymous` + * `Server Password: 1234567` + * `URL (or IP) Server: mypersonaldomain.es` + * `Destination Path (Server): /home/anonymous` + * `Scan Path (Local): /home/local/videos` ### Edit configuration: * To edit any section of the configuration, the following command would be executed: - `ks-upa -e` + * `ks-upa -e` * After its execution, we will see a menu like the following one to be able to edit the desired section: - `1 - Edit User (anonymous)` - `2 - Edit Password (1234567)` - `3 - Edit Server (mypersonaldomain.es)` - `4 - Edit Dest. Path (/home/anonymous)` - `5 - Edit Local Path (/home/local/videos)` - `.` - `6 - Exit` - `.` - `Choose an option:` + * `1 - Edit User (anonymous)` + * `2 - Edit Password (1234567)` + * `3 - Edit Server (mypersonaldomain.es)` + * `4 - Edit Dest. Path (/home/anonymous)` + * `5 - Edit Local Path (/home/local/videos)` + * `.` + * `6 - Exit` + * `.` + * `Choose an option:` ### Show version: * You can check the version with the command: - `ks-upa -v` + * `ks-upa -v` \ No newline at end of file diff --git a/doc/ks-upf.md b/doc/ks-upf.md index 53872e3..38da650 100644 --- a/doc/ks-upf.md +++ b/doc/ks-upf.md @@ -3,26 +3,26 @@ ks-upf - Upload common file(s) to server with rsync+ssh. ### Sintax: - `ks-upf -i - Start upload` - `ks-upf -r - Remove configuration` - `ks-upf -c - Show configuration` - `ks-upf -e - Edit configuration` - `ks-upf -v - Show version` - `ks-upf -h - Show help` + * `ks-upf -i - Start upload` + * `ks-upf -r - Remove configuration` + * `ks-upf -c - Show configuration` + * `ks-upf -e - Edit configuration` + * `ks-upf -v - Show version` + * `ks-upf -h - Show help` ### Initialize common file(s) upload: * For initialize file(s) upload only un the following command: - `ks-upf -i` + * `ks-upf -i` * The first time you run the command, you will be asked for the necessary connection information: - `Enter the server user: anonymous` - `Enter the server key: 1234567` - `Enter the server URL: mypersonaldomain.es` - `Enter the path on the server: /home/anonymous` - `Enter the local path to scan: /home/local/videos` + * `Enter the server user: anonymous` + * `Enter the server key: 1234567` + * `Enter the server URL: mypersonaldomain.es` + * `Enter the path on the server: /home/anonymous` + * `Enter the local path to scan: /home/local/videos` * Once the connection data has been entered, the local directory will be scanned to detect file(s) and upload them to the server directory. @@ -30,43 +30,43 @@ ks-upf - Upload common file(s) to server with rsync+ssh. * If you want to clear the connection settings, you just need to run the following command: - `ks-upf -r` + * `ks-upf -r` ### Show configuration: * You can check the configuration with the following command: - `ks-upf -c` + * `ks-upf -c` * When consulting the configuration, we will see something like this: - `Server User: anonymous` - `Server Password: 1234567` - `URL (or IP) Server: mypersonaldomain.es` - `Destination Path (Server): /home/anonymous` - `Scan Path (Local): /home/local/videos` + * `Server User: anonymous` + * `Server Password: 1234567` + * `URL (or IP) Server: mypersonaldomain.es` + * `Destination Path (Server): /home/anonymous` + * `Scan Path (Local): /home/local/videos` ### Edit configuration: * To edit any section of the configuration, the following command would be executed: - `ks-upf -e` + * `ks-upf -e` * After its execution, we will see a menu like the following one to be able to edit the desired section: - `1 - Edit User (anonymous)` - `2 - Edit Password (1234567)` - `3 - Edit Server (mypersonaldomain.es)` - `4 - Edit Dest. Path (/home/anonymous)` - `5 - Edit Local Path (/home/local/videos)` - `.` - `6 - Exit` - `.` - `Choose an option:` + * `1 - Edit User (anonymous)` + * `2 - Edit Password (1234567)` + * `3 - Edit Server (mypersonaldomain.es)` + * `4 - Edit Dest. Path (/home/anonymous)` + * `5 - Edit Local Path (/home/local/videos)` + * `.` + * `6 - Exit` + * `.` + * `Choose an option:` ### Show version: * You can check the version with the command: - `ks-upf -v` + * `ks-upf -v` \ No newline at end of file diff --git a/doc/ks-upr.md b/doc/ks-upr.md index d249bd2..c10fb6b 100644 --- a/doc/ks-upr.md +++ b/doc/ks-upr.md @@ -3,26 +3,26 @@ ks-upr - Upload recursively file(s) to server with rsync+ssh. ### Sintax: - `ks-upr -i - Start upload` - `ks-upr -r - Remove configuration` - `ks-upr -c - Show configuration` - `ks-upr -e - Edit configuration` - `ks-upr -v - Show version` - `ks-upr -h - Show help` + * `ks-upr -i - Start upload` + * `ks-upr -r - Remove configuration` + * `ks-upr -c - Show configuration` + * `ks-upr -e - Edit configuration` + * `ks-upr -v - Show version` + * `ks-upr -h - Show help` ### Initialize common file(s) upload: * For initialize recursively upload only un the following command: - `ks-upr -i` + * `ks-upr -i` * The first time you run the command, you will be asked for the necessary connection information: - `Enter the server user: anonymous` - `Enter the server key: 1234567` - `Enter the server URL: mypersonaldomain.es` - `Enter the path on the server: /home/anonymous` - `Enter the local path to scan: /home/local/videos` + * `Enter the server user: anonymous` + * `Enter the server key: 1234567` + * `Enter the server URL: mypersonaldomain.es` + * `Enter the path on the server: /home/anonymous` + * `Enter the local path to scan: /home/local/videos` * Once the connection data has been entered, the local directory will be scanned to upload recursively them to the server directory. @@ -30,43 +30,43 @@ ks-upr - Upload recursively file(s) to server with rsync+ssh. * If you want to clear the connection settings, you just need to run the following command: - `ks-upr -r` + * `ks-upr -r` ### Show configuration: * You can check the configuration with the following command: - `ks-upr -c` + * `ks-upr -c` * When consulting the configuration, we will see something like this: - `Server User: anonymous` - `Server Password: 1234567` - `URL (or IP) Server: mypersonaldomain.es` - `Destination Path (Server): /home/anonymous` - `Scan Path (Local): /home/local/videos` + * `Server User: anonymous` + * `Server Password: 1234567` + * `URL (or IP) Server: mypersonaldomain.es` + * `Destination Path (Server): /home/anonymous` + * `Scan Path (Local): /home/local/videos` ### Edit configuration: * To edit any section of the configuration, the following command would be executed: - `ks-upr -e` + * `ks-upr -e` * After its execution, we will see a menu like the following one to be able to edit the desired section: - `1 - Edit User (anonymous)` - `2 - Edit Password (1234567)` - `3 - Edit Server (mypersonaldomain.es)` - `4 - Edit Dest. Path (/home/anonymous)` - `5 - Edit Local Path (/home/local/videos)` - `.` - `6 - Exit` - `.` - `Choose an option:` + * `1 - Edit User (anonymous)` + * `2 - Edit Password (1234567)` + * `3 - Edit Server (mypersonaldomain.es)` + * `4 - Edit Dest. Path (/home/anonymous)` + * `5 - Edit Local Path (/home/local/videos)` + * `.` + * `6 - Exit` + * `.` + * `Choose an option:` ### Show version: * You can check the version with the command: - `ks-upr -v` + * `ks-upr -v` \ No newline at end of file diff --git a/doc/ks-upv.md b/doc/ks-upv.md index ba41c53..1ca6022 100644 --- a/doc/ks-upv.md +++ b/doc/ks-upv.md @@ -3,26 +3,26 @@ ks-upv - Upload videos file(s) to server with rynsc+ssh. ### Sintax: - `ks-upv -i - Start upload` - `ks-upv -r - Remove configuration` - `ks-upv -c - Show configuration` - `ks-upv -e - Edit configuration` - `ks-upv -v - Show version` - `ks-upv -h - Show help` + * `ks-upv -i - Start upload` + * `ks-upv -r - Remove configuration` + * `ks-upv -c - Show configuration` + * `ks-upv -e - Edit configuration` + * `ks-upv -v - Show version` + * `ks-upv -h - Show help` ### Initialize video file(s) upload: * For initialize video file(s) upload only un the following command: - `ks-upv -i` + * `ks-upv -i` * The first time you run the command, you will be asked for the necessary connection information: - `Enter the server user: anonymous` - `Enter the server key: 1234567` - `Enter the server URL: mypersonaldomain.es` - `Enter the path on the server: /home/anonymous` - `Enter the local path to scan: /home/local/videos` + * `Enter the server user: anonymous` + * `Enter the server key: 1234567` + * `Enter the server URL: mypersonaldomain.es` + * `Enter the path on the server: /home/anonymous` + * `Enter the local path to scan: /home/local/videos` * Once the connection data has been entered, the local directory will be scanned to detect the videos and upload them to the server directory. @@ -30,43 +30,43 @@ ks-upv - Upload videos file(s) to server with rynsc+ssh. * If you want to clear the connection settings, you just need to run the following command: - `ks-upv -r` + * `ks-upv -r` ### Show configuration: * You can check the configuration with the following command: - `ks-upv -c` + * `ks-upv -c` * When consulting the configuration, we will see something like this: - `Server User: anonymous` - `Server Password: 1234567` - `URL (or IP) Server: mypersonaldomain.es` - `Destination Path (Server): /home/anonymous` - `Scan Path (Local): /home/local/videos` + * `Server User: anonymous` + * `Server Password: 1234567` + * `URL (or IP) Server: mypersonaldomain.es` + * `Destination Path (Server): /home/anonymous` + * `Scan Path (Local): /home/local/videos` ### Edit configuration: * To edit any section of the configuration, the following command would be executed: - `ks-upv -e` + * `ks-upv -e` * After its execution, we will see a menu like the following one to be able to edit the desired section: - `1 - Edit User (anonymous)` - `2 - Edit Password (1234567)` - `3 - Edit Server (mypersonaldomain.es)` - `4 - Edit Dest. Path (/home/anonymous)` - `5 - Edit Local Path (/home/local/videos)` - `.` - `6 - Exit` - `.` - `Choose an option:` + * `1 - Edit User (anonymous)` + * `2 - Edit Password (1234567)` + * `3 - Edit Server (mypersonaldomain.es)` + * `4 - Edit Dest. Path (/home/anonymous)` + * `5 - Edit Local Path (/home/local/videos)` + * `.` + * `6 - Exit` + * `.` + * `Choose an option:` ### Show version: * You can check the version with the command: - `ks-upv -v` + * `ks-upv -v` \ No newline at end of file