Update documentation for --upload-only & --download-only to avoid ambiguity (#960)

* Update wording on --upload-only , --download-only to avoid ambiguity
* Update --upload-only usage example to include --no-remote-delete
This commit is contained in:
abraunegg 2020-06-21 08:09:06 +10:00 committed by GitHub
parent 93163051f5
commit d8bfe846c2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 6 deletions

View file

@ -146,6 +146,10 @@ In some cases it may be desirable to 'upload only' to OneDrive. To do this use t
```text
onedrive --synchronize --upload-only
```
**Note:** If a file or folder is present on OneDrive, that does not exist locally, it will be removed. If the data on OneDrive should be kept, the following should be used:
```text
onedrive --synchronize --upload-only --no-remote-delete
```
### Increasing logging level
When running a sync it may be desirable to see additional information as to the progress and operation of the client. To do this, use the following command:
@ -680,7 +684,7 @@ Options:
--display-sync-status
Display the sync status of the client - no sync will be performed.
--download-only
Only download remote changes
Replicate the OneDrive online state locally, by only downloading changes from OneDrive. Do not upload local changes to OneDrive.
--dry-run
Perform a trial sync with no changes made
--enable-logging
@ -746,7 +750,7 @@ Options:
--synchronize
Perform a synchronization
--upload-only
Only upload to OneDrive, do not sync changes from OneDrive locally
Replicate the locally configured sync_dir state to OneDrive, by only uploading local changes to OneDrive. Do not download changes from OneDrive.
--user-agent ARG
Specify a User Agent string to the http client
--verbose -v+

View file

@ -69,7 +69,7 @@ Display what options the client will use as currently configured \- no sync will
Display the sync status of the client \- no sync will be performed.
.TP
\fB\-\-download\-only\fP
Only download remote changes
Replicate the OneDrive online state locally, by only downloading changes from OneDrive. Do not upload local changes to OneDrive.
.br
Configuration file key: \fBdownload_only\fP (default: \fBfalse\fP)
.TP
@ -192,7 +192,7 @@ Configuration file key: \fBsync_dir\fP (default: \fB~/OneDrive\fP)
Perform a synchronization
.TP
\fB\-\-upload\-only\fP
Only upload to OneDrive, do not sync changes from OneDrive locally
Replicate the locally configured sync_dir state to OneDrive, by only uploading local changes to OneDrive. Do not download changes from OneDrive.
.br
Configuration file key: \fBupload_only\fP (default: \fBfalse\fP)
.TP

View file

@ -303,7 +303,7 @@ final class Config
"Display the sync status of the client - no sync will be performed.",
&boolValues["display_sync_status"],
"download-only",
"Only download remote changes",
"Replicate the OneDrive online state locally, by only downloading changes from OneDrive. Do not upload local changes to OneDrive.",
&boolValues["download_only"],
"dry-run",
"Perform a trial sync with no changes made",
@ -399,7 +399,7 @@ final class Config
"Sync all files in sync_dir root when using sync_list.",
&boolValues["sync_root_files"],
"upload-only",
"Only upload to OneDrive, do not sync changes from OneDrive locally",
"Replicate the locally configured sync_dir state to OneDrive, by only uploading local changes to OneDrive. Do not download changes from OneDrive.",
&boolValues["upload_only"],
"user-agent",
"Specify a User Agent string to the http client",