381 lines
12 KiB
Groff
381 lines
12 KiB
Groff
.TH ONEDRIVE "1" "@PACKAGE_DATE@" "@PACKAGE_VERSION@" "User Commands"
|
|
.SH NAME
|
|
onedrive \- folder synchronization with OneDrive
|
|
.SH SYNOPSIS
|
|
.B onedrive
|
|
[\fI\,OPTION\/\fR] \-\-synchronize
|
|
.br
|
|
.B onedrive
|
|
[\fI\,OPTION\/\fR] \-\-monitor
|
|
.br
|
|
.B onedrive
|
|
[\fI\,OPTION\/\fR] \-\-display-config
|
|
.br
|
|
.B onedrive
|
|
[\fI\,OPTION\/\fR] \-\-display-sync-status
|
|
.SH DESCRIPTION
|
|
A complete tool to interact with OneDrive on Linux.
|
|
.SH OPTIONS
|
|
Without any option given, no sync is done and the program exits.
|
|
.TP
|
|
\fB\-\-auth\-files\fP ARG
|
|
Perform authorization via two files passed in as \fBARG\fP in the format \fBauthUrl:responseUrl\fP.
|
|
The authorization URL is written to the \fBauthUrl\fP, then \fBonedrive\fP waits for
|
|
the file \fBresponseUrl\fP to be present, and reads the response from that file.
|
|
.TP
|
|
\fB\-\-auth\-response\fP ARG
|
|
Perform authentication not via interactive dialog but via providing the reponse url directly.
|
|
.TP
|
|
\fB\-\-check\-for\-nomount\fP
|
|
Check for the presence of .nosync in the syncdir root. If found, do not perform sync.
|
|
.br
|
|
Configuration file key: \fBcheck_nomount\fP (default: \fBfalse\fP)
|
|
.TP
|
|
\fB\-\-check\-for\-nosync\fP
|
|
Check for the presence of .nosync in each directory. If found, skip directory from sync.
|
|
.br
|
|
Configuration file key: \fBcheck_nosync\fP (default: \fBfalse\fP)
|
|
.TP
|
|
\fB\-\-classify\-as\-big\-delete\fP
|
|
Number of children in a path that is locally removed which will be classified as a 'big data delete'
|
|
.br
|
|
Configuration file key: \fBclassify_as_big_delete\fP (default: \fB1000\fP)
|
|
.TP
|
|
\fB\-\-confdir\fP ARG
|
|
Set the directory used to store the configuration files
|
|
.TP
|
|
\fB\-\-create\-directory\fP ARG
|
|
Create a directory on OneDrive \- no sync will be performed.
|
|
.TP
|
|
\fB\-\-create\-share\-link\fP ARG
|
|
Create a shareable link for an existing file on OneDrive
|
|
.TP
|
|
\fB\-\-debug\-https\fP
|
|
Debug OneDrive HTTPS communication.
|
|
.br
|
|
Configuration file key: \fBdebug_https\fP (default: \fBfalse\fP)
|
|
.TP
|
|
\fB\-\-destination\-directory\fP ARG
|
|
Destination directory for renamed or move on OneDrive \- no sync will be performed.
|
|
.TP
|
|
\fB\-\-disable\-download\-validation\fP
|
|
Disable download validation when downloading from OneDrive
|
|
.br
|
|
Configuration file key: \fBdisable_download_validation\fP (default: \fBfalse\fP)
|
|
.TP
|
|
\fB\-\-disable\-notifications\fP
|
|
Do not use desktop notifications in monitor mode
|
|
.br
|
|
Configuration file key: \fBdisable_notifications\fP (default: \fBfalse\fP)
|
|
.TP
|
|
\fB\-\-disable\-upload\-validation\fP
|
|
Disable upload validation when uploading to OneDrive
|
|
.br
|
|
Configuration file key: \fBdisable_upload_validation\fP (default: \fBfalse\fP)
|
|
.TP
|
|
\fB\-\-display\-config\fP
|
|
Display what options the client will use as currently configured \- no sync will be performed.
|
|
.TP
|
|
\fB\-\-display\-sync\-status\fP
|
|
Display the sync status of the client \- no sync will be performed.
|
|
.TP
|
|
\fB\-\-download\-only\fP
|
|
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
|
|
\fB\-\-dry\-run\fP
|
|
Perform a trial sync with no changes made. Can ONLY be used with --synchronize. Will be ignored for --monitor
|
|
.br
|
|
Configuration file key: \fBdry_run\fP (default: \fBfalse\fP)
|
|
.TP
|
|
\fB\-\-enable\-logging\fP
|
|
Enable client activity to a separate log file
|
|
.br
|
|
Configuration file key: \fBenable_logging\fP (default: \fBfalse\fP)
|
|
.TP
|
|
\fB\-\-force\fP
|
|
Force the deletion of data when a 'big delete' is detected
|
|
.TP
|
|
\fB\-\-force\-http\-2\fP
|
|
Force the use of HTTP/2 for all operations where applicable
|
|
.br
|
|
Configuration file key: \fBforce_http_2\fP (default: \fBfalse\fP)
|
|
.TP
|
|
\fB\-\-force\-sync\fP
|
|
Force a synchronization of a specific folder, only when using --synchronize --single-directory and ignore
|
|
.br
|
|
all non-default skip_dir and skip_file rules
|
|
.TP
|
|
\fB\-\-get\-O365\-drive\-id\fP ARG
|
|
Query and return the Office 365 Drive ID for a given Office 365 SharePoint Shared Library
|
|
.TP
|
|
\fB\-\-get\-file\-link\fP ARG
|
|
Display the file link of a synced file
|
|
.TP
|
|
\fB\-\-list\-shared\-folders\fP
|
|
List OneDrive Business Shared Folders
|
|
.TP
|
|
\fB\-\-local\-first\fP
|
|
Synchronize from the local directory source first, before downloading changes from OneDrive.
|
|
.br
|
|
Configuration file key: \fBlocal_first\fP (default: \fBfalse\fP)
|
|
.TP
|
|
\fB\-\-logout\fP
|
|
Logout the current user
|
|
.TP
|
|
\fB\-\-log\-dir\fP ARG
|
|
defines the directory where logging output is saved to, needs to end with a slash
|
|
.br
|
|
Configuration file key: \fBlog_dir\fP (default: \fB/var/log/onedrive/\fP)
|
|
.TP
|
|
\fB\-\-min\-notify\-changes\fP
|
|
the minimum number of pending incoming changes necessary to trigger
|
|
a desktop notification
|
|
.br
|
|
Configuration file key: \fBmin_notify_changes\fP (default: \fB5\fP)
|
|
.TP
|
|
\fB\-m \-\-modified\-by\fP ARG
|
|
Display the last modified by details of a given path
|
|
.TP
|
|
\fB\-m \-\-monitor\fP
|
|
Keep monitoring for local and remote changes
|
|
.TP
|
|
\fB\-\-monitor\-interval\fP ARG
|
|
The number of seconds by which each sync operation is undertaken when
|
|
idle under monitor mode
|
|
.br
|
|
Configuration file key: \fBmonitor_interval\fP (default: \fB300\fP)
|
|
.TP
|
|
\fB\-\-monitor\-fullscan-frequency\fP ARG
|
|
Number of sync runs before performing a full local scan of the synced directory
|
|
.br
|
|
Configuration file key: \fBmonitor_fullscan_frequency\fP (default: \fB10\fP)
|
|
.TP
|
|
\fB\-\-monitor\-log\-frequency\fP ARG
|
|
Frequency of logging in monitor mode
|
|
.br
|
|
Configuration file key: \fBmonitor_log_frequency\fP (default: \fB5\fP)
|
|
.TP
|
|
\fB\-\-no\-remote\-delete\fP
|
|
Do not delete local file 'deletes' from OneDrive when using \fB\-\-upload\-only\fR
|
|
.br
|
|
Configuration file key: \fBno_remote_delete\fP (default: \fBfalse\fP)
|
|
.TP
|
|
\fB\-\-operation\-timeout\fP ARG
|
|
Set the maximum amount of time (seconds) a file operation is allowed to take. This includes DNS resolution, connecting, data transfer, etc.
|
|
.br
|
|
Configuration file key: \fBoperation_timeout\fP (default: \fB3600\fP)
|
|
.TP
|
|
\fB\-\-print\-token\fP
|
|
Print the access token, useful for debugging
|
|
.TP
|
|
\fB\-\-reauth\fP
|
|
Reauthenticate the client with OneDrive
|
|
.TP
|
|
\fB\-\-remove\-directory\fP ARG
|
|
Remove a directory on OneDrive \- no sync will be performed.
|
|
.TP
|
|
\fB\-\-remove\-source\-files\fP
|
|
Remove source file after successful transfer to OneDrive when using \-\-upload-only
|
|
.br
|
|
Configuration file key: \fBremove_source_files\fP (default: \fBfalse\fP)
|
|
.TP
|
|
\fB\-\-resync\fP
|
|
Forget the last saved state, perform a full sync
|
|
.TP
|
|
\fB\-\-resync\-auth\fP
|
|
Approve the use of performing a --resync action without needing CLI authorization
|
|
.TP
|
|
\fB\-\-single\-directory\fP ARG
|
|
Specify a single local directory within the OneDrive root to sync.
|
|
.TP
|
|
\fB\-\-skip\-dir\fP ARG
|
|
Skip any directories that match this pattern from syncing
|
|
.TP
|
|
\fB\-\-skip\-dir\-strict\-match\fP
|
|
When matching skip_dir directories, only match explicit matches
|
|
.br
|
|
Configuration file key: \fBskip_dir_strict_match\fP (default: \fBfalse\fP)
|
|
.TP
|
|
\fB\-\-skip\-dot\-files\fP
|
|
Skip dot files and folders from syncing
|
|
.br
|
|
Configuration file key: \fBskip_dotfiles\fP (default: \fBfalse\fP)
|
|
.TP
|
|
\fB\-\-skip\-file\fP
|
|
Skip any files that match this pattern from syncing
|
|
.br
|
|
Configuration file key: \fBskip_file\fP (default: \fB~*|.~*|*.tmp\fP)
|
|
.TP
|
|
\fB\-\-skip\-size\fP ARG
|
|
Skip new files larger than this size (in MB)
|
|
.TP
|
|
\fB\-\-skip\-symlinks\fP
|
|
Skip syncing of symlinks
|
|
.br
|
|
Configuration file key: \fBskip_symlinks\fP (default: \fBfalse\fP)
|
|
.TP
|
|
\fB\-\-source\-directory\fP ARG
|
|
Source directory to rename or move on OneDrive \- no sync will be performed.
|
|
.TP
|
|
\fB\-\-space\-reservation\fP ARG
|
|
The amount of disk space to reserve (in MB) to avoid 100% disk space utilisation
|
|
.TP
|
|
\fB\-\-sync\-root\-files\fP
|
|
Sync all files in sync_dir root when using sync_list.
|
|
.TP
|
|
\fB\-\-sync\-shared\-folders\fP
|
|
Sync OneDrive Business Shared Folders
|
|
.br
|
|
Configuration file key: \fBsync_business_shared_folders\fP (default: \fBfalse\fP)
|
|
.TP
|
|
\fB\-\-syncdir\fP ARG
|
|
Set the directory used to sync the files that are synced
|
|
.br
|
|
Configuration file key: \fBsync_dir\fP (default: \fB~/OneDrive\fP)
|
|
.TP
|
|
\fB\-\-synchronize\fP
|
|
Perform a synchronization
|
|
.TP
|
|
\fB\-\-upload\-only\fP
|
|
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
|
|
\fB\-\-user\-agent\fP ARG
|
|
Set the used User Agent identifier
|
|
.br
|
|
Configuration file key: \fBuser_agent\fP (default: don't change)
|
|
.TP
|
|
\fB\-v \-\-verbose\fP
|
|
Print more details, useful for debugging. Given two times (or more)
|
|
enables even more verbose debug statements.
|
|
.TP
|
|
\fB\-\-version\fP
|
|
Print the version and exit
|
|
.TP
|
|
\fB\-h \-\-help\fP
|
|
This help information.
|
|
.PP
|
|
|
|
.SH FEATURES
|
|
|
|
State caching
|
|
|
|
Real-Time file monitoring with Inotify
|
|
|
|
File upload / download validation to ensure data integrity
|
|
|
|
Resumable uploads
|
|
|
|
Support OneDrive for Business (part of Office 365)
|
|
|
|
Shared Folder support for OneDrive Personal and OneDrive Business accounts
|
|
|
|
SharePoint / Office365 Shared Libraries
|
|
|
|
Desktop notifications via libnotify
|
|
|
|
Dry-run capability to test configuration changes
|
|
|
|
Prevent major OneDrive accidental data deletion after configuration change
|
|
|
|
Support for National cloud deployments (Microsoft Cloud for US Government, Microsoft Cloud Germany, Azure and Office 365 operated by 21Vianet in China)
|
|
|
|
|
|
.SH CONFIGURATION
|
|
|
|
You should copy the default config file into your home directory before making changes:
|
|
.nf
|
|
\fB
|
|
mkdir\ \-p\ ~/.config/onedrive
|
|
cp\ @DOCDIR@/config\ ~/.config/onedrive/config
|
|
\fP
|
|
.fi
|
|
|
|
For the supported options see the above list of command line options
|
|
for the availability of a configuration key.
|
|
.PP
|
|
Pattern are case insensitive.
|
|
\fB*\fP and \fB?\fP wildcards characters are supported.
|
|
Use \fB|\fP to separate multiple patterns.
|
|
|
|
After changing the filters (\fBskip_file\fP or \fBskip_dir\fP in your configs) you must
|
|
execute \fBonedrive --synchronize --resync\fP.
|
|
|
|
.SH FIRST RUN
|
|
|
|
After installing the application you must run it at least once from the terminal
|
|
to authorize it.
|
|
|
|
You will be asked to open a specific link using your web browser where you
|
|
will have to login into your Microsoft Account and give the application the
|
|
permission to access your files. After giving the permission, you will be
|
|
redirected to a blank page. Copy the URI of the blank page into the application.
|
|
|
|
|
|
.SH SYSTEMD INTEGRATION
|
|
|
|
Service files are installed into user and system directories.
|
|
.TP
|
|
OneDrive service running as root user
|
|
To enable this mode, run as root user
|
|
.nf
|
|
\fB
|
|
systemctl enable onedrive
|
|
systemctl start onedrive
|
|
\fP
|
|
.fi
|
|
|
|
.TP
|
|
OneDrive service running as root user for a non-root user
|
|
This mode allows starting the OneDrive service automatically with
|
|
system start for multiple users. For each \fB<username>\fP run:
|
|
.nf
|
|
\fB
|
|
systemctl enable onedrive@<username>
|
|
systemctl start onedrive@<username>
|
|
\fP
|
|
.fi
|
|
|
|
.TP
|
|
OneDrive service running as non-root user
|
|
In this mode the service will be started when the user logs in.
|
|
Run as user
|
|
.nf
|
|
\fB
|
|
systemctl --user enable onedrive
|
|
systemctl --user start onedrive
|
|
\fP
|
|
.fi
|
|
|
|
.SH LOGGING OUTPUT
|
|
|
|
When running onedrive all actions can be logged to a separate log file.
|
|
This can be enabled by using the \fB--enable-logging\fP flag.
|
|
By default, log files will be written to \fB/var/log/onedrive\fP.
|
|
|
|
All logfiles will be in the format of \fB%username%.onedrive.log\fP,
|
|
where \fB%username%\fP represents the user who ran the client.
|
|
|
|
|
|
.SH NOTIFICATIONS
|
|
|
|
If OneDrive has been compiled with support for notifications, a running
|
|
\fBonedrive\fP in monitor mode will send notifications about
|
|
initialization and errors via libnotify to the dbus.
|
|
|
|
Note that this does not work if \fBonedrive\fP is started as root
|
|
for a user via the \fBonedrive@<username>\fP service.
|
|
|
|
.SH SEE ALSO
|
|
|
|
Further examples and documentation is available in
|
|
\f[C]README.md\f[]
|
|
\f[C]docs/USAGE.md\f[]
|
|
\f[C]docs/advanced-usage.md\f[]
|
|
\f[C]docs/BusinessSharedFolders.md\f[]
|
|
\f[C]docs/SharePoint-Shared-Libraries.md\f[]
|
|
\f[C]docs/national-cloud-deployments.md\f[]
|