diff --git a/UserGuide.md b/UserGuide.md index 10ebec37..6d20af59 100644 --- a/UserGuide.md +++ b/UserGuide.md @@ -224,7 +224,7 @@ Verbosity: You can increase the amount of information given by any command by pa * [`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-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-config`](contrib/docs/commands/sync-config.md)`[--delayed-uploads-wait-seconds=waitsecs | --delayed-uploads-max-attempts=attempts]` Shows and modifies global sync configuration. +* [`sync-config`](contrib/docs/commands/sync-config.md)`[--delayed-uploads-wait-seconds | --delayed-uploads-max-attempts]` Controls sync configuration. * [`exclude`](contrib/docs/commands/exclude.md)`[(-a|-d) pattern1 pattern2 pattern3]` Manages default exclusion rules in syncs. * [`backup`](contrib/docs/commands/backup.md)`(localpath remotepath --period="PERIODSTRING" --num-backups=N | [-lhda] [TAG|localpath] [--period="PERIODSTRING"] [--num-backups=N]) [--time-format=FORMAT]` Controls backups diff --git a/contrib/docs/commands/sync-config.md b/contrib/docs/commands/sync-config.md index b112bdd4..d88427ff 100644 --- a/contrib/docs/commands/sync-config.md +++ b/contrib/docs/commands/sync-config.md @@ -1,14 +1,13 @@ ### sync-config -Shows and modifies global sync configuration. +Controls sync configuration. -Usage: `sync-config [--delayed-uploads-wait-seconds=waitsecs | --delayed-uploads-max-attempts=attempts]` +Usage: `sync-config [--delayed-uploads-wait-seconds | --delayed-uploads-max-attempts]`
-Displays current configuration if no options are provided. Configuration values are persisted across restarts. +Displays current configuration. -New uploads for files that change frequently in syncs will be delayed until a wait time passes. +New uploads for files that change frequently in syncs may be delayed until a wait time passes to avoid wastes of computational resources. + Delay times and number of changes may change overtime Options: - --delayed-uploads-wait-seconds Sets the seconds to be waited before a file that's being delayed is uploaded again. Default is 30 minutes (1800 seconds). - Note: wait seconds must be between 60 and 86399 (inclusive). - --delayed-uploads-max-attempts Sets the max number of times a file can change in quick succession before it starts to get delayed. Default is 2. - Note: max attempts must be between 2 and 5 (inclusive). + --delayed-uploads-wait-seconds Shows the seconds to be waited before a file that's being delayed is uploaded again. + --delayed-uploads-max-attempts Shows the max number of times a file can change in quick succession before it starts to get delayed.diff --git a/contrib/docs/commands/sync.md b/contrib/docs/commands/sync.md index f703b60d..5baef9ff 100644 --- a/contrib/docs/commands/sync.md +++ b/contrib/docs/commands/sync.md @@ -7,7 +7,7 @@ If no argument is provided, it lists current configured synchronizations. If local and remote paths are provided, it will start synchronizing a local folder into a remote folder. If an ID/local path is provided, it will list such synchronization unless an option is specified. -Note: use the "sync-config" command to show and modify global sync configuration. +Note: use the "sync-config" command to show global sync configuration. Options: -d | --delete ID|localpath deletes a synchronization (not the files).