From d8bfe846c29ec9c07c57c00422e0f8da4c93409d Mon Sep 17 00:00:00 2001 From: abraunegg Date: Sun, 21 Jun 2020 08:09:06 +1000 Subject: [PATCH] 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 --- docs/USAGE.md | 8 ++++++-- onedrive.1.in | 4 ++-- src/config.d | 4 ++-- 3 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/USAGE.md b/docs/USAGE.md index 40383a41..2cfc79fb 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -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+ diff --git a/onedrive.1.in b/onedrive.1.in index 52e0a32a..60f6f896 100644 --- a/onedrive.1.in +++ b/onedrive.1.in @@ -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 diff --git a/src/config.d b/src/config.d index 437b4d97..8201bbc9 100644 --- a/src/config.d +++ b/src/config.d @@ -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",