Fix documentation

This commit is contained in:
q3aql 2021-03-07 18:35:27 +01:00
parent bb6e7f68da
commit ec17637fd0
4 changed files with 120 additions and 120 deletions

View File

@ -3,26 +3,26 @@ ks-upa - Upload audio file(s) to server with rsync+ssh.
### Sintax: ### Sintax:
`ks-upa -i - Start upload` * `ks-upa -i - Start upload`
`ks-upa -r - Remove configuration` * `ks-upa -r - Remove configuration`
`ks-upa -c - Show configuration` * `ks-upa -c - Show configuration`
`ks-upa -e - Edit configuration` * `ks-upa -e - Edit configuration`
`ks-upa -v - Show version` * `ks-upa -v - Show version`
`ks-upa -h - Show help` * `ks-upa -h - Show help`
### Initialize audio file(s) upload: ### Initialize audio file(s) upload:
* For initialize audio file(s) upload only run the following command: * 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: * The first time you run the command, you will be asked for the necessary connection information:
`Enter the server user: anonymous` * `Enter the server user: anonymous`
`Enter the server key: 1234567` * `Enter the server key: 1234567`
`Enter the server URL: mypersonaldomain.es` * `Enter the server URL: mypersonaldomain.es`
`Enter the path on the server: /home/anonymous` * `Enter the path on the server: /home/anonymous`
`Enter the local path to scan: /home/local/videos` * `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. * 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: * If you want to clear the connection settings, you just need to run the following command:
`ks-upa -r` * `ks-upa -r`
### Show configuration: ### Show configuration:
* You can check the configuration with the following command: * 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: * When consulting the configuration, we will see something like this:
`Server User: anonymous` * `Server User: anonymous`
`Server Password: 1234567` * `Server Password: 1234567`
`URL (or IP) Server: mypersonaldomain.es` * `URL (or IP) Server: mypersonaldomain.es`
`Destination Path (Server): /home/anonymous` * `Destination Path (Server): /home/anonymous`
`Scan Path (Local): /home/local/videos` * `Scan Path (Local): /home/local/videos`
### Edit configuration: ### Edit configuration:
* To edit any section of the configuration, the following command would be executed: * 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: * After its execution, we will see a menu like the following one to be able to edit the desired section:
`1 - Edit User (anonymous)` * `1 - Edit User (anonymous)`
`2 - Edit Password (1234567)` * `2 - Edit Password (1234567)`
`3 - Edit Server (mypersonaldomain.es)` * `3 - Edit Server (mypersonaldomain.es)`
`4 - Edit Dest. Path (/home/anonymous)` * `4 - Edit Dest. Path (/home/anonymous)`
`5 - Edit Local Path (/home/local/videos)` * `5 - Edit Local Path (/home/local/videos)`
`.` * `.`
`6 - Exit` * `6 - Exit`
`.` * `.`
`Choose an option:` * `Choose an option:`
### Show version: ### Show version:
* You can check the version with the command: * You can check the version with the command:
`ks-upa -v` * `ks-upa -v`

View File

@ -3,26 +3,26 @@ ks-upf - Upload common file(s) to server with rsync+ssh.
### Sintax: ### Sintax:
`ks-upf -i - Start upload` * `ks-upf -i - Start upload`
`ks-upf -r - Remove configuration` * `ks-upf -r - Remove configuration`
`ks-upf -c - Show configuration` * `ks-upf -c - Show configuration`
`ks-upf -e - Edit configuration` * `ks-upf -e - Edit configuration`
`ks-upf -v - Show version` * `ks-upf -v - Show version`
`ks-upf -h - Show help` * `ks-upf -h - Show help`
### Initialize common file(s) upload: ### Initialize common file(s) upload:
* For initialize file(s) upload only un the following command: * 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: * The first time you run the command, you will be asked for the necessary connection information:
`Enter the server user: anonymous` * `Enter the server user: anonymous`
`Enter the server key: 1234567` * `Enter the server key: 1234567`
`Enter the server URL: mypersonaldomain.es` * `Enter the server URL: mypersonaldomain.es`
`Enter the path on the server: /home/anonymous` * `Enter the path on the server: /home/anonymous`
`Enter the local path to scan: /home/local/videos` * `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. * 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: * If you want to clear the connection settings, you just need to run the following command:
`ks-upf -r` * `ks-upf -r`
### Show configuration: ### Show configuration:
* You can check the configuration with the following command: * 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: * When consulting the configuration, we will see something like this:
`Server User: anonymous` * `Server User: anonymous`
`Server Password: 1234567` * `Server Password: 1234567`
`URL (or IP) Server: mypersonaldomain.es` * `URL (or IP) Server: mypersonaldomain.es`
`Destination Path (Server): /home/anonymous` * `Destination Path (Server): /home/anonymous`
`Scan Path (Local): /home/local/videos` * `Scan Path (Local): /home/local/videos`
### Edit configuration: ### Edit configuration:
* To edit any section of the configuration, the following command would be executed: * 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: * After its execution, we will see a menu like the following one to be able to edit the desired section:
`1 - Edit User (anonymous)` * `1 - Edit User (anonymous)`
`2 - Edit Password (1234567)` * `2 - Edit Password (1234567)`
`3 - Edit Server (mypersonaldomain.es)` * `3 - Edit Server (mypersonaldomain.es)`
`4 - Edit Dest. Path (/home/anonymous)` * `4 - Edit Dest. Path (/home/anonymous)`
`5 - Edit Local Path (/home/local/videos)` * `5 - Edit Local Path (/home/local/videos)`
`.` * `.`
`6 - Exit` * `6 - Exit`
`.` * `.`
`Choose an option:` * `Choose an option:`
### Show version: ### Show version:
* You can check the version with the command: * You can check the version with the command:
`ks-upf -v` * `ks-upf -v`

View File

@ -3,26 +3,26 @@ ks-upr - Upload recursively file(s) to server with rsync+ssh.
### Sintax: ### Sintax:
`ks-upr -i - Start upload` * `ks-upr -i - Start upload`
`ks-upr -r - Remove configuration` * `ks-upr -r - Remove configuration`
`ks-upr -c - Show configuration` * `ks-upr -c - Show configuration`
`ks-upr -e - Edit configuration` * `ks-upr -e - Edit configuration`
`ks-upr -v - Show version` * `ks-upr -v - Show version`
`ks-upr -h - Show help` * `ks-upr -h - Show help`
### Initialize common file(s) upload: ### Initialize common file(s) upload:
* For initialize recursively upload only un the following command: * 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: * The first time you run the command, you will be asked for the necessary connection information:
`Enter the server user: anonymous` * `Enter the server user: anonymous`
`Enter the server key: 1234567` * `Enter the server key: 1234567`
`Enter the server URL: mypersonaldomain.es` * `Enter the server URL: mypersonaldomain.es`
`Enter the path on the server: /home/anonymous` * `Enter the path on the server: /home/anonymous`
`Enter the local path to scan: /home/local/videos` * `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. * 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: * If you want to clear the connection settings, you just need to run the following command:
`ks-upr -r` * `ks-upr -r`
### Show configuration: ### Show configuration:
* You can check the configuration with the following command: * 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: * When consulting the configuration, we will see something like this:
`Server User: anonymous` * `Server User: anonymous`
`Server Password: 1234567` * `Server Password: 1234567`
`URL (or IP) Server: mypersonaldomain.es` * `URL (or IP) Server: mypersonaldomain.es`
`Destination Path (Server): /home/anonymous` * `Destination Path (Server): /home/anonymous`
`Scan Path (Local): /home/local/videos` * `Scan Path (Local): /home/local/videos`
### Edit configuration: ### Edit configuration:
* To edit any section of the configuration, the following command would be executed: * 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: * After its execution, we will see a menu like the following one to be able to edit the desired section:
`1 - Edit User (anonymous)` * `1 - Edit User (anonymous)`
`2 - Edit Password (1234567)` * `2 - Edit Password (1234567)`
`3 - Edit Server (mypersonaldomain.es)` * `3 - Edit Server (mypersonaldomain.es)`
`4 - Edit Dest. Path (/home/anonymous)` * `4 - Edit Dest. Path (/home/anonymous)`
`5 - Edit Local Path (/home/local/videos)` * `5 - Edit Local Path (/home/local/videos)`
`.` * `.`
`6 - Exit` * `6 - Exit`
`.` * `.`
`Choose an option:` * `Choose an option:`
### Show version: ### Show version:
* You can check the version with the command: * You can check the version with the command:
`ks-upr -v` * `ks-upr -v`

View File

@ -3,26 +3,26 @@ ks-upv - Upload videos file(s) to server with rynsc+ssh.
### Sintax: ### Sintax:
`ks-upv -i - Start upload` * `ks-upv -i - Start upload`
`ks-upv -r - Remove configuration` * `ks-upv -r - Remove configuration`
`ks-upv -c - Show configuration` * `ks-upv -c - Show configuration`
`ks-upv -e - Edit configuration` * `ks-upv -e - Edit configuration`
`ks-upv -v - Show version` * `ks-upv -v - Show version`
`ks-upv -h - Show help` * `ks-upv -h - Show help`
### Initialize video file(s) upload: ### Initialize video file(s) upload:
* For initialize video file(s) upload only un the following command: * 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: * The first time you run the command, you will be asked for the necessary connection information:
`Enter the server user: anonymous` * `Enter the server user: anonymous`
`Enter the server key: 1234567` * `Enter the server key: 1234567`
`Enter the server URL: mypersonaldomain.es` * `Enter the server URL: mypersonaldomain.es`
`Enter the path on the server: /home/anonymous` * `Enter the path on the server: /home/anonymous`
`Enter the local path to scan: /home/local/videos` * `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. * 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: * If you want to clear the connection settings, you just need to run the following command:
`ks-upv -r` * `ks-upv -r`
### Show configuration: ### Show configuration:
* You can check the configuration with the following command: * 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: * When consulting the configuration, we will see something like this:
`Server User: anonymous` * `Server User: anonymous`
`Server Password: 1234567` * `Server Password: 1234567`
`URL (or IP) Server: mypersonaldomain.es` * `URL (or IP) Server: mypersonaldomain.es`
`Destination Path (Server): /home/anonymous` * `Destination Path (Server): /home/anonymous`
`Scan Path (Local): /home/local/videos` * `Scan Path (Local): /home/local/videos`
### Edit configuration: ### Edit configuration:
* To edit any section of the configuration, the following command would be executed: * 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: * After its execution, we will see a menu like the following one to be able to edit the desired section:
`1 - Edit User (anonymous)` * `1 - Edit User (anonymous)`
`2 - Edit Password (1234567)` * `2 - Edit Password (1234567)`
`3 - Edit Server (mypersonaldomain.es)` * `3 - Edit Server (mypersonaldomain.es)`
`4 - Edit Dest. Path (/home/anonymous)` * `4 - Edit Dest. Path (/home/anonymous)`
`5 - Edit Local Path (/home/local/videos)` * `5 - Edit Local Path (/home/local/videos)`
`.` * `.`
`6 - Exit` * `6 - Exit`
`.` * `.`
`Choose an option:` * `Choose an option:`
### Show version: ### Show version:
* You can check the version with the command: * You can check the version with the command:
`ks-upv -v` * `ks-upv -v`