readme
This commit is contained in:
parent
5b249d0f13
commit
ba1ba3941d
34
README.md
34
README.md
@ -29,3 +29,37 @@ make sure in the .bashrc there is something like this
|
||||
|
||||
`export PATH=~/bin/:$PATH`
|
||||
|
||||
## Using the command
|
||||
|
||||
###### init
|
||||
Typical use of tool is starting a sync with the command
|
||||
|
||||
`masync init -l /home/luca/localsync/ -r remoteuser@server:/home/remoteuser/sync/`
|
||||
|
||||
-l option stands for the local folder you want to mirror and sync, -r option stands for the remote folder in the form known to both ssh and scp
|
||||
|
||||
###### list
|
||||
|
||||
it shows the list of all synched local folders with respective remote folder and some other usefull information: the integer id assigned to the sync,
|
||||
the current status of sync, the local folder you are keeping in sync and the remote folder.
|
||||
In the following commands you can refer the sync to apply the command with the integer id of sync using the option -s,
|
||||
or with the local folder using the option -l
|
||||
|
||||
###### stop
|
||||
|
||||
If you want to stop a sync in the list of syncs, you can refer to it either by its id or by the local folder associated with the sync
|
||||
|
||||
`masync stop -s 1 or masync stop -l /home/luca/localsync/`
|
||||
|
||||
###### start
|
||||
|
||||
If you want to resume a stopped sync in the list of syncs, you can refer to it either by its id or by the local folder associated with the sync
|
||||
|
||||
`masync start -s 1 or masync stop -l /home/luca/localsync/`
|
||||
|
||||
###### remove
|
||||
|
||||
Remove the sync from the list of all syncs, do not delete any local folder and data
|
||||
|
||||
`masync remove -s 1 or masync remove -l /home/luca/localsync/`
|
||||
|
||||
|
2
masync
2
masync
@ -42,7 +42,7 @@ myhelp() {
|
||||
echo 'LIST: '
|
||||
echo -e "\tit shows the list of all synched local folders with respective remote folder and some other usefull information: the integer id assigned to the sync,"
|
||||
echo -e "\tthe current status of sync, the local folder you are keeping in sync and the remote folder."
|
||||
echo -e "\tIn the following command you can refer the sync to apply the command with the integer id of sync using the option -s,"
|
||||
echo -e "\tIn the following commands you can refer the sync to apply the command with the integer id of sync using the option -s,"
|
||||
echo -e "\tor with the local folder using the option -l"
|
||||
echo 'STOP: '
|
||||
echo -e "\tIf you want to stop a sync in the list of syncs, you can refer to it either by its id or by the local folder associated with the sync"
|
||||
|
Loading…
Reference in New Issue
Block a user