mir/MEGAcmd
2
0
Fork 0
mirror of https://github.com/meganz/MEGAcmd synced 2025-08-22 01:47:24 +00:00
Code Issues Releases Wiki Activity

doc improvements

Browse Source
This commit is contained in:
Pablo Martin 2019-02-25 19:29:07 +01:00
parent c430de90a5
commit bd720711a7
No known key found for this signature in database
GPG Key ID: 1746978B12F13D6E
6 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -118,7 +118,7 @@ This will synchronize the contents in your local and your mega folder both ways.
* You can also set remote **backups** of a local folder to keep historical snapshots
of your files. So simple as:
```
backup /path/to/myfolder /remote/path --period="0 0 4 * * *" --num-backups=10
backup /path/mega/folder /remote/path --period="0 0 4 * * *" --num-backups=10
```
This will configure a backup of "myfolder" into /remote/path that will be carried out
at 4:00 A.M. (UTC) every day. It will store the last 10 copies.
@ -126,7 +126,7 @@ This will configure a backup of "myfolder" into /remote/path that will be carrie
* You serve a location in your MEGA account via webdav:
```
webdav /path/to/myfolder
webdav /path/mega/folder
```
* Or stream a file in your MEGA account:

2
UserGuide.md
View File

@ -96,7 +96,7 @@ Additional information about synchronising folders is available in our Help Cent
### Backup configurations
MEGAcmd can set up a periodic copy of a local folder to your MEGA account using the [`backup`](#backup) command. Here is a simple example that will back up a folder immediately and then at 4am each day, keeping the 10 most recent backups: <p>
```
backup /path/to/myfolder /remote/path --period="0 0 4 * * *" --num-backups=10
backup /path/mega/folder /remote/path --period="0 0 4 * * *" --num-backups=10
```
For further information on backups, please see the [`backup`](#backup) command and the [tutorial](contrib/docs/BACKUPS.md).

12
contrib/docs/BACKUPS.md
View File

@ -5,7 +5,7 @@ Notice: the commands listed here assume you are using the interactive interactio
## Creation
Example:
backup /path/to/myfolder /remote/path --period="0 0 4 * * *" --num-backups=10
backup /path/mega/folder /remote/path --period="0 0 4 * * *" --num-backups=10
This will configure a backup of "myfolder" into /remote/path that will be carried out
at 4:00 A.M. (UTC) every day. It will store the last 10 copies.
@ -27,7 +27,7 @@ You can list the backups configured typing `backup`:
```
TAG LOCALPATH REMOTEPARENTPATH STATUS
4 /path/to/myfolder /remote/path ACTIVE
4 /path/mega/folder /remote/path ACTIVE
```
Notice the TAG. You can use it to refer to the backup if you wan to change its configuration
@ -39,7 +39,7 @@ If you type "backup -l" you will see extra information concerning the backup. He
see when the next backup is scheduled for:
```
TAG LOCALPATH REMOTEPARENTPATH STATUS
4 /path/to/myfolder /remote/path ONGOING
4 /path/mega/folder /remote/path ONGOING
Max Backups: 4
Period: "0 0 4 * * *"
Next backup scheduled for: Fri, 19 Jan 2018 04:00:00 +0000
@ -57,7 +57,7 @@ With "backup -h" you will be able to see the existing backups with their state a
```
TAG LOCALPATH REMOTEPARENTPATH STATUS
4 /path/to/myfolder /remote/path ONGOING
4 /path/mega/folder /remote/path ONGOING
-- SAVED BACKUPS --
NAME DATE STATUS FILES FOLDERS
myfolder_bk_20180115175811 15Jan2018 17:58:11 COMPLETE 33 10
@ -85,7 +85,7 @@ This will cancel all transfers and set the backup as ABORTED
Similarly you can remove a backup, to no longer backup that folder with:
```
backup -d /path/to/myfolder
backup -d /path/mega/folder
```
This will not remove the existing backups wich will be available in MEGA.
@ -97,7 +97,7 @@ backup 4 --period=2h
```
This will set our backup with TAG=4 to have a period of 2 hours.
```
backup /path/to/myfolder --num-backups=1
backup /path/mega/folder --num-backups=1
```
This will configure the backup to only keep one instance.
Notice that in order not to lose data, older instances will not be deleted until

10
contrib/docs/FTP.md
View File

@ -9,7 +9,7 @@ Notice: the commands listed here assume you are using the interactive interactio
## Serving a folder
Example:
```
ftp /path/to/myfolder
ftp /path/mega/folder
```
This will configure a FTP server that will serve "myfolder". It'll show you the URL to access that path. You just use that location to configure access [according to your specific OS](#platforms).
@ -41,7 +41,7 @@ You can list the ftp served locations typing `ftp`:
```
FTP SERVED LOCATIONS:
/path/to/myfolder: ftp://127.0.0.1:4990/XXXXXXX/myfolder
/path/mega/folder: ftp://127.0.0.1:4990/XXXXXXX/myfolder
/path/to/myfile.mp4: ftp://127.0.0.1:4990/YYYYYYY/myfile.mp4
```
@ -68,7 +68,7 @@ you can secure it with [TLS](https://wikipedia.org/wiki/Transport_Layer_Security
To serve via FTPS, you just need to pass `--tls` and the paths* to your certificate and key files (in PEM format):
```
ftp /path/to/myfolder --tls --certificate=/path/to/certificate.pem --key=/path/to/certificate.key
ftp /path/mega/folder --tls --certificate=/path/to/certificate.pem --key=/path/to/certificate.key
```
*Those paths are local paths in your machine, not in MEGA.
@ -82,11 +82,11 @@ If you want to change that configuration you will need to stop serving each and
You can stop serving a MEGA location with:
```
ftp -d /path/to/myfolder
ftp -d /path/mega/folder
```
If successfully, it will show a message indicating that the path is no longer served:
```
/path/to/myfolder no longer served via ftp
/path/mega/folder no longer served via ftp
```
## Platforms

10
contrib/docs/WEBDAV.md
View File

@ -9,7 +9,7 @@ Notice: the commands listed here assume you are using the interactive interactio
## Serving a folder
Example:
```
webdav /path/to/myfolder
webdav /path/mega/folder
```
This will configure a WEBDAV server that will serve "myfolder". It'll show you the URL to access that path. You just use that location to configure access [according to your specific OS](#platforms).
@ -42,7 +42,7 @@ You can list the webdav served locations typing `webdav`:
```
WEBDAV SERVED LOCATIONS:
/path/to/myfolder: http://127.0.0.1:4443/XXXXXXX/myfolder
/path/mega/folder: http://127.0.0.1:4443/XXXXXXX/myfolder
/path/to/myfile.mp4: http://127.0.0.1:4443/YYYYYYY/myfile.mp4
```
@ -66,7 +66,7 @@ you can secure it with [TLS](https://wikipedia.org/wiki/Transport_Layer_Security
You just need to pass `--tls` and the paths* to your certificate and key files (in PEM format):
```
webdav /path/to/myfolder --tls --certificate=/path/to/certificate.pem --key=/path/to/certificate.key
webdav /path/mega/folder --tls --certificate=/path/to/certificate.pem --key=/path/to/certificate.key
```
*Those paths are local paths in your machine, not in MEGA.
@ -80,11 +80,11 @@ If you want to change that configuration you will need to stop serving each and
You can stop serving a MEGA location with:
```
webdav -d /path/to/myfolder
webdav -d /path/mega/folder
```
If successfully, it will show a message indicating that the path is no longer served:
```
/path/to/myfolder no longer served via webdav
/path/mega/folder no longer served via webdav
```
## Platforms

2
src/megacmd.cpp
View File

@ -2182,6 +2182,7 @@ string getHelpStr(const char *command)
#endif
os << endl;
os << "*If you serve more than one location, these parameters will be ignored and use those of the first location served." << endl;
os << " If you want to change those parameters, you need to stop serving all locations and configure them again." << endl;
os << endl;
os << "Caveat: This functionality is in BETA state. If you experience any issue with this, please contact: support@mega.nz" << endl;
os << endl;
@ -2207,6 +2208,7 @@ string getHelpStr(const char *command)
#endif
os << endl;
os << "*If you serve more than one location, these parameters will be ignored and used those of the first location served." << endl;
os << " If you want to change those parameters, you need to stop serving all locations and configure them again." << endl;
os << endl;
os << "Caveat: This functionality is in BETA state. If you experience any issue with this, please contact: support@mega.nz" << endl;
os << endl;