mir/MEGAcmd
2
0
Fork 0
mirror of https://github.com/meganz/MEGAcmd synced 2025-08-29 12:57:44 +00:00
Code Issues Releases Wiki Activity

docs adjustments

Browse Source
This commit is contained in:
Pablo Martin 2025-03-20 10:51:11 +01:00
parent c4e8c9486f
commit 045a6305d8
No known key found for this signature in database
GPG Key ID: 1746978B12F13D6E
3 changed files with 22 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
UserGuide.md
View File

@ -214,7 +214,7 @@ Verbosity: You can increase the amount of information given by any command by pa
* [`mv`](contrib/docs/commands/mv.md)`srcremotepath [--use-pcre] [srcremotepath2 srcremotepath3 ..] dstremotepath` Moves file(s)/folder(s) into a new location (all remotes) * [`mv`](contrib/docs/commands/mv.md)`srcremotepath [--use-pcre] [srcremotepath2 srcremotepath3 ..] dstremotepath` Moves file(s)/folder(s) into a new location (all remotes)
* [`rm`](contrib/docs/commands/rm.md)`[-r] [-f] [--use-pcre] remotepath` Deletes a remote file/folder * [`rm`](contrib/docs/commands/rm.md)`[-r] [-f] [--use-pcre] remotepath` Deletes a remote file/folder
* [`transfers`](contrib/docs/commands/transfers.md)`[-c TAG|-a] | [-r TAG|-a] | [-p TAG|-a] [--only-downloads | --only-uploads] [SHOWOPTIONS]` List or operate with transfers * [`transfers`](contrib/docs/commands/transfers.md)`[-c TAG|-a] | [-r TAG|-a] | [-p TAG|-a] [--only-downloads | --only-uploads] [SHOWOPTIONS]` List or operate with transfers
* [`speedlimit`](contrib/docs/commands/speedlimit.md)`[-u|-d|--upload-connections|--download-connections] [-h] [NEWLIMIT]` Displays/modifies upload/download rate limits * [`speedlimit`](contrib/docs/commands/speedlimit.md)`[-u|-d|--upload-connections|--download-connections] [-h] [NEWLIMIT]` Displays/modifies upload/download rate limits: either speed or max connections
* [`sync`](contrib/docs/commands/sync.md)`[localpath dstremotepath| [-dpe] [ID|localpath]` Controls synchronizations. * [`sync`](contrib/docs/commands/sync.md)`[localpath dstremotepath| [-dpe] [ID|localpath]` Controls synchronizations.
* [`sync-issues`](contrib/docs/commands/sync-issues.md)`[[--detail (ID|--all)] [--limit=rowcount] [--disable-path-collapse]] | [--enable-warning|--disable-warning]` Show all issues with current syncs * [`sync-issues`](contrib/docs/commands/sync-issues.md)`[[--detail (ID|--all)] [--limit=rowcount] [--disable-path-collapse]] | [--enable-warning|--disable-warning]` Show all issues with current syncs
* [`sync-ignore`](contrib/docs/commands/sync-ignore.md)`[--show|[--add|--add-exclusion|--remove|--remove-exclusion] filter1 filter2 ...] (ID|localpath|DEFAULT)` Manages ignore filters for syncs * [`sync-ignore`](contrib/docs/commands/sync-ignore.md)`[--show|[--add|--add-exclusion|--remove|--remove-exclusion] filter1 filter2 ...] (ID|localpath|DEFAULT)` Manages ignore filters for syncs

17
contrib/docs/commands/speedlimit.md
View File

@ -1,17 +1,20 @@
### speedlimit ### speedlimit
Displays/modifies upload/download rate limits Displays/modifies upload/download rate limits: either speed or max connections
Usage: `speedlimit [-u|-d|--upload-connections|--download-connections] [-h] [NEWLIMIT]` Usage: `speedlimit [-u|-d|--upload-connections|--download-connections] [-h] [NEWLIMIT]`
<pre> <pre>
NEWLIMIT establish the new limit in size per second (0 = no limit) NEWLIMIT is the new limit to set. If no option is provided, NEWLIMIT will be
applied for both download/upload speed limits. 0, for speeds, means unlimited.
NEWLIMIT may include (B)ytes, (K)ilobytes, (M)egabytes, (G)igabytes & (T)erabytes. NEWLIMIT may include (B)ytes, (K)ilobytes, (M)egabytes, (G)igabytes & (T)erabytes.
Examples: "1m12k3B" "3M". If no units are given, bytes are assumed Examples: "1m12k3B" "3M". If no units are given, bytes are assumed.
Options: Options:
-d Download speed limit -d Set/Read download speed limit, expressed in size per second.
-u Upload speed limit -u Set/Read dpload speed limit, expressed in size per second
--upload-connections Max number of connections for an upload transfer --upload-connections Set/Read max number of connections for an upload transfer
--download-connections Max number of connections for a download transfer --download-connections Set/Read max number of connections for a download transfer
Display options:
-h Human readable -h Human readable
Notice: these limits will be saved for the next time you execute MEGAcmd server. They will be removed if you logout. Notice: these limits will be saved for the next time you execute MEGAcmd server. They will be removed if you logout.

18
src/megacmd.cpp
View File

@ -2960,16 +2960,20 @@ string getHelpStr(const char *command, const HelpFlags& flags = {})
} }
else if (!strcmp(command, "speedlimit")) else if (!strcmp(command, "speedlimit"))
{ {
os << "Displays/modifies upload/download rate limits" << endl; os << "Displays/modifies upload/download rate limits: either speed or max connections" << endl;
os << " NEWLIMIT establish the new limit in size per second (0 = no limit)" << endl; os << endl;
os << " NEWLIMIT is the new limit to set. If no option is provided, NEWLIMIT will be " << endl;
os << " applied for both download/upload speed limits. 0, for speeds, means unlimited." << endl;
os << " NEWLIMIT may include (B)ytes, (K)ilobytes, (M)egabytes, (G)igabytes & (T)erabytes." << endl; os << " NEWLIMIT may include (B)ytes, (K)ilobytes, (M)egabytes, (G)igabytes & (T)erabytes." << endl;
os << " Examples: \"1m12k3B\" \"3M\". If no units are given, bytes are assumed" << endl; os << " Examples: \"1m12k3B\" \"3M\". If no units are given, bytes are assumed." << endl;
os << endl; os << endl;
os << "Options:" << endl; os << "Options:" << endl;
os << " -d " << "Download speed limit" << endl; os << " -d " << "Set/Read download speed limit, expressed in size per second." << endl;
os << " -u " << "Upload speed limit" << endl; os << " -u " << "Set/Read dpload speed limit, expressed in size per second" << endl;
os << " --upload-connections " << "Max number of connections for an upload transfer" << endl; os << " --upload-connections " << "Set/Read max number of connections for an upload transfer" << endl;
os << " --download-connections " << "Max number of connections for a download transfer" << endl; os << " --download-connections " << "Set/Read max number of connections for a download transfer" << endl;
os << endl;
os << "Display options:" << endl;
os << " -h " << "Human readable" << endl; os << " -h " << "Human readable" << endl;
os << endl; os << endl;
os << "Notice: these limits will be saved for the next time you execute MEGAcmd server. They will be removed if you logout." << endl; os << "Notice: these limits will be saved for the next time you execute MEGAcmd server. They will be removed if you logout." << endl;