onedrive(1)

1ONEDRIVE(1)                      User Commands                     ONEDRIVE(1)
2
3
4

NAME

6       onedrive - folder synchronization with OneDrive
7

SYNOPSIS

9       onedrive [OPTION] --synchronize
10       onedrive [OPTION] --monitor
11       onedrive [OPTION] --display-config
12       onedrive [OPTION] --display-sync-status
13

DESCRIPTION

15       A complete tool to interact with OneDrive on Linux.
16

OPTIONS

18       Without any option given, no sync is done and the program exits.
19
20       --check-for-nomount
21              Check for the presence of .nosync in the syncdir root. If found,
22              do not perform sync.
23
24       --check-for-nosync
25              Check for the presence of .nosync in each directory.  If  found,
26              skip directory from sync.
27
28       --confdir ARG
29              Set the directory used to store the configuration files
30
31       --create-directory ARG
32              Create a directory on OneDrive - no sync will be performed.
33
34       --destination-directory ARG
35              Destination  directory for renamed or move on OneDrive - no sync
36              will be performed.
37
38       --debug-https
39              Debug OneDrive HTTPS communication.
40
41       --disable-notifications
42              Do not use desktop notifications in monitor mode
43
44       --disable-upload-validation
45              Disable upload validation when uploading to OneDrive
46
47       --display-config
48              Display what options the client will use as currently configured
49              - no sync will be performed.
50
51       --display-sync-status
52              Display  the  sync  status  of the client - no sync will be per‐
53              formed.
54
55       -d --download-only
56              Only download remote changes
57
58       --dry-run
59              Perform a trial sync with no changes made. Can ONLY be used with
60              --synchronize. Will be ignored for --monitor
61
62       --enable-logging
63              Enable client activity to a separate log file
64
65       --force-http-1.1
66              Force the use of HTTP 1.1 for all operations
67
68       --get-O365-drive-id ARG
69              Query  and return the Office 365 Drive ID for a given Office 365
70              SharePoint Shared Library
71
72       --local-first
73              Synchronize from the local directory source first, before  down‐
74              loading changes from OneDrive.
75
76       --logout
77              Logout the current user
78
79       -m --monitor
80              Keep monitoring for local and remote changes
81
82       --no-remote-delete
83              Do  not  delete  local  file  'deletes' from OneDrive when using
84              --upload-only
85
86       --print-token
87              Print the access token, useful for debugging
88
89       --resync
90              Forget the last saved state, perform a full sync
91
92       --remove-directory ARG
93              Remove a directory on OneDrive - no sync will be performed.
94
95       --single-directory ARG
96              Specify a single local directory within  the  OneDrive  root  to
97              sync.
98
99       --skip-dot-files
100              Skip dot files and folders from syncing
101
102       --skip-symlinks
103              Skip syncing of symlinks
104
105       --source-directory ARG
106              Source directory to rename or move on OneDrive - no sync will be
107              performed.
108
109       --syncdir ARG
110              Set the directory used to sync the files that are synced
111
112       --synchronize
113              Perform a synchronization
114
115       --upload-only
116              Only upload to OneDrive,  do  not  sync  changes  from  OneDrive
117              locally
118
119       -v --verbose
120              Print  more  details,  useful for debugging. Given two times (or
121              more) enables even more verbose debug statements.
122
123       --version
124              Print the version and exit
125
126       -h --help
127              This help information.
128

FEATURES

130       State caching
131
132       Real-Time file monitoring with Inotify
133
134       Resumable uploads
135
136       Support OneDrive for Business (part of Office 365)
137
138       Shared folders (OneDrive Personal)
139
140       SharePoint / Office 365 Group Drives (refer to  README.Office365.md  to
141       configure)
142
143
144

CONFIGURATION

146       You should copy the default config file into your home directory before
147       making changes:
148       mkdir -p ~/.config/onedrive
149       cp /usr/share/doc/onedrive/config ~/.config/onedrive/config
150
151       Available options:
152
153       sync_dir
154              directory where the files will be synced
155
156       skip_file
157              any files that match this pattern will be skipped during sync
158
159       skip_symlinks
160              skip symbolic links during sync, defaults to "false"
161
162       monitor_interval
163              the number of seconds by which each sync operation is undertaken
164              when idle under monitor mode, defaults to "45"
165
166       min_notif_changes
167              the  minimum  number  of  pending  incoming changes necessary to
168              trigger a desktop notification, defaults to "5"
169
170       log_dir
171              defines the directory where logging output is saved to, needs to
172              end with a slash
173
174       Pattern  are  case  insensitive.  * and ? wildcards characters are sup‐
175       ported.  Use | to separate multiple patterns.
176
177       After changing the filters (skip_file or skip_dir in your configs)  you
178       must execute onedrive --synchronize --resync.
179
180

FIRST RUN

182       After installing the application you must run it at least once from the
183       terminal to authorize it.
184
185       You will be asked to open a specific link using your web browser  where
186       you  will have to login into your Microsoft Account and give the appli‐
187       cation the permission to access your files. After  giving  the  permis‐
188       sion, you will be redirected to a blank page. Copy the URI of the blank
189       page into the application.
190
191
192

SYSTEMD INTEGRATION

194       Service files are installed into user and system directories.
195
196       OneDrive service running as root user
197              To enable this mode, run as root user
198              systemctl enable onedrive
199              systemctl start onedrive
200
201
202       OneDrive service running as root user for a non-root user
203              This mode allows starting  the  OneDrive  service  automatically
204              with system start for multiple users. For each <username> run:
205              systemctl enable onedrive@<username>
206              systemctl start onedrive@<username>
207
208
209       OneDrive service running as non-root user
210              In  this mode the service will be started when the user logs in.
211              Run as user
212              systemctl --user enable onedrive
213              systemctl --user start onedrive
214
215

LOGGING OUTPUT

217       When running onedrive all actions can be logged to a separate log file.
218       This  can  be  enabled by using the --enable-logging flag.  By default,
219       log files will be written to /var/log/onedrive.
220
221       All logfiles will be in the format  of  %username%.onedrive.log,  where
222       %username% represents the user who ran the client.
223
224
225

NOTIFICATIONS

227       If OneDrive has been compiled with support for notifications, a running
228       onedrive in monitor mode will send notifications  about  initialization
229       and errors via libnotify to the dbus.
230
231       Note  that this does not work if onedrive is started as root for a user
232       via the onedrive@<username> service.
233
234