Advanced Usage

Options

When invoking the client from the command line, the following options are supported:

-h, --help
Displays all command options.
--logwindow
Opens a window displaying log output.
--logfile <filename>
Write log output to the file specified. To write to stdout, specify - as the filename.
--logdir <name>
Writes each synchronization log output in a new file in the specified directory.
--logexpire <hours>
Removes logs older than the value specified (in hours). This command is used with --logdir.
--logflush
Clears (flushes) the log file after each write action.
--confdir <dirname>
Uses the specified configuration directory.

Config File

The ownCloud Client reads a configuration file. You can locate this configuration files as follows:

On Linux distributions:
$HOME/.local/share/data/ownCloud/owncloud.cfg
On Microsoft Windows systems:
%LOCALAPPDATA%\ownCloud\owncloud.cfg
On MAC OS X systems:
$HOME/Library/Application Support/ownCloud

The configuration file contains settings using the Microsoft Windows .ini file format. You can overwrite changes using the ownCloud configuration dialog.

Note

Use caution when making changes to the ownCloud Client configuration file. Incorrect settings can produce unintended results.

You can change the following configuration settings:

  • remotePollInterval (default: 30000) – Specifies the poll time for the remote repository in milliseconds.
  • maxLogLines (default: 20000) – Specifies the maximum number of log lines displayed in the log window.

ownCloud Commandline Client

The ownCloud Client packages contain a command line client that can be used to synchronize ownCloud files to client machines. The command line client is called owncloudcmd.

owncloudcmd performs a single sync run and then exits the synchronization process. In this manner, owncloudcmd processes the differences between client and server directories and propagates the files to bring both repositories to the same state. Contrary to the GUI-based client, owncloudcmd does not repeat synchronizations on its own. It also does not monitor for file system changes.

To invoke owncloudcmd, you must provide the local and the remote repository URL using the following command:

owncloudcmd [OPTIONS...] sourcedir owncloudurl

where sourcedir is the local directory and owncloudurl is the server URL.

Note

Prior to the 1.6 version of owncloudcmd, the tool only accepted owncloud:// or ownclouds:// in place of http:// and https:// as a scheme. See Examples for details.

Other comand line switches supported by owncloudcmd include the following:

--user, -u [user]
Use user as the login name.
--password, -p [password]
Use password as the password.
-n
Use netrc (5) for login.
--non-interactive
Do not prompt for questions.
--silent, -s
Inhibits verbose log output.
--trust
Trust any SSL certificate, including invalid ones.
--httpproxy  http://[user@pass:]<server>:<port>
Uses the specified server as the HTTP proxy.

Credential Handling

By default, owncloudcmd reads the client configuration and uses the credentials of the GUI synchronization client. If no client is configured, or if you choose to use a different user to synchronize, you can specify the user password setting with the usual URL pattern. For example:

https://user:secret@192.168.178.2/remote.php/webdav

Example

To synchronize the ownCloud directory Music to the local directory media/music, through a proxy listening on port 8080, and on a gateway machine using IP address 192.168.178.1, the command line would be:

$ owncloudcmd --httpproxy http://192.168.178.1:8080 \
              $HOME/media/music \
              https://server/owncloud/remote.php/webdav/Music

owncloudcmd will enquire user name and password, unless they have been specified on the command line or -n has been passed.

Using the legacy scheme, the command line would be:

$ owncloudcmd --httpproxy http://192.168.178.1:8080 \
              $HOME/media/music \
              ownclouds://server/owncloud/remote.php/webdav/Music

Table Of Contents

Previous topic

Using the Synchronization Client

Next topic

The Automatic Updater

This Page