nextcloud
/
desktop
mirror of https://github.com/nextcloud/desktop
0
0
Fork 0
Code Issues Releases Wiki Activity

Update and correct desktop client manual 

Conflicts:
	doc/accountsetup.rst
	doc/architecture.rst
	doc/navigating.rst
	doc/owncloudcmd.rst
This commit is contained in:
Carla Schroder 2014-12-31 11:27:52 -08:00
parent c2f3413dc5
commit 09f843727d
12 changed files with 157 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
doc/accountsetup.rst
View File

@ -1,34 +1,33 @@
Setting up an Account
=====================
If no account has been configured, the ownCloud Client automatically assist in
connecting to your ownCloud server after the application has been started.
When you run the ownCloud Desktop Sync client the first time, it automatically
opens the account setup wizard. Just follow these steps:
To set up an account:
1. Specify the URL to your Server. This is the same address that is used in the browser.
1. Enter the URL to your Server. This is the same address used by your Web
browser, for example ``https://example.com/owncloud``
.. image:: images/wizard_url.png
:scale: 50 %
.. note:: Make sure to use ``https://`` if the server supports it. Otherwise,
your password and all data will be transferred to the server unencrypted. This
makes it easy for third parties to intercept your communication, and getting
hold of your password!
.. note:: Always use ``https://`` if SSL encryption is enabled on your server.
Otherwise, your password and all traffic between your computer and the
ownCloud server will be transmitted in the clear and wide open for
eavesdroppers.
2. Enter the username and password. These are the same credentials used to log into the web interface.
2. Enter your username and password. These are the same credentials used to
log into the ownCloud Web interface.
.. image:: images/wizard_user.png
:scale: 50 %
3. Choose the folder with which you want the ownCloud Client to synchronize the
contents of your ownCloud account. By default, this is a folder called
`ownCloud`. This folder is created in the home directory.
3. Choose the local folder you want to store your ownCloud files in. By
default, this is a folder called ``ownCloud`` in your home directory.
.. image:: images/wizard_targetfolder.png
:scale: 50 %
The synchronization between the root directories of the ownCloud server begins.
4. The synchronization automatically begins.
.. image:: images/wizard_overview.png
:scale: 50 %
@ -39,4 +38,11 @@ When selecting a local folder that already contains data, you can choose from tw
the client are synchronized to the ownCloud server.
* :guilabel:`Start a clean sync`: When selected, all files in the local folder on the
<<<<<<< HEAD
client are deleted. These files are not synchronized to the ownCloud server.
=======
client are deleted. These files are not syncrhonized to the ownCloud server.
See :doc:`navigating` to learn how to choose specific folders to sync with on
your ownCloud server.
>>>>>>> 096511f... Update and correct desktop client manual

16
doc/architecture.rst
View File

@ -21,7 +21,12 @@ result, the ownCloud Client runs on Linux, Windows, and MacOS.
The Synchronization Process
---------------------------
<<<<<<< HEAD
The process of synchronization keeps files in two separate repositories the same. When synchronized:
=======
The process of synchronization keeps files in two separate repositories the
same. When synchronized:
>>>>>>> 096511f... Update and correct desktop client manual
- If a file is added to one repository it is copied to the other synchronized repository.
- When a file is changed in one repository, the change is propagated to any
@ -30,7 +35,11 @@ The process of synchronization keeps files in two separate repositories the same
It is important to note that the ownCloud synchronization process does not use
a typical client/server system where the server is always master. This is a
<<<<<<< HEAD
major difference between the ownCloud synchronizatin process and other systems
=======
major difference between the ownCloud synchronization process and other systems
>>>>>>> 096511f... Update and correct desktop client manual
like a file backup, where only changes to files or folders and the addition of
new files are propagated, but these files and folders are never deleted unless
explicitly deleted in the backup.
@ -60,7 +69,7 @@ To compare the modification times of two files from different systems, csync
must operate on the same base. Before ownCloud Client version 1.1.0, csync
required both device repositories to run on the exact same time. This
requirement was achieved through the use of enterprise standard `NTP time
synchronisation`_ on all machines.
synchronization`_ on all machines.
Because this timing strategy is rather fragile without the use of NTP, ownCloud
4.5 introduced a unique number (for each file?) that changes whenever the file
@ -119,8 +128,9 @@ traverses the file tree and compares the modification time of each file with an
expected value stored in its database. If the value is not the same, the client
determines that the file has been modified in the local repository.
.. note:: On the local side, the modificaton time a good attribute to use for detecting changes, because
the value does not depend on time shifts and such.
.. note:: On the local side, the modification time a good attribute to use for
detecting changes, because
the value does not depend on time shifts and such.
For the remote (that is, ownCloud server) repository, the client compares the
ETag of each file with its expected value. Again, the expected ETag value is

13
doc/autoupdate.rst
View File

@ -40,10 +40,9 @@ Linux
^^^^^
Linux distributions provide their own update tools, so ownCloud clients that use
the Linux operating system do not perform any updates on their own. Linux
operating systems do, however, check for the latest version of the ownCloud
client and passively notify the user (``Settings -> General -> Updates``) when
an update is available.
the Linux operating system do not perform any updates on their own. The client
will inform you (``Settings -> General -> Updates``) when an update is
available.
Preventing Automatic Updates
@ -64,7 +63,7 @@ update check mechanism whereas the second method prevents any manual overrides.
To prevent automatic updates, but allow manual overrides:
1. Migrate to the following directory:
1. Edit these Registry keys:
a. (32-bit) ``HKEY_LOCAL_MACHINE\Software\ownCloud\ownCloud``
b. (64-bit) ``HKEY_LOCAL_MACHINE\Software\Wow6432Node\ownCloud\ownCloud``
@ -92,10 +91,10 @@ To prevent automatic updates and disallow manual overrides:
Preventing Automatic Updates in Mac OS X Environments
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can disable the automatic update mechanism in MAC OS X operating systems
You can disable the automatic update mechanism in Mac OS X operating systems
using the system-wide ``.plist`` file. To access this file:
1. Using the Windows explorer, migrate to the following location::
1. Go to this directory::
/Library/Preferences/

13
doc/building.rst
View File

@ -16,11 +16,12 @@ Linux
-----
1. Add the `ownCloud repository from OBS`_.
2. Install the dependencies (as root, or using ``sudo``) using the following commands for your specific Linux distribution:
* Debian/Ubuntu: ``apt-get update; apt-get build-dep owncloud-client``
* openSUSE: ``zypper ref; zypper si -d owncloud-client``
* Fedora/CentOS: ``yum install yum-utils; yum-builddep owncloud-client``
2. Install the dependencies (as root, or using ``sudo``) using the following
commands for your specific Linux distribution:
* Debian/Ubuntu: ``apt-get update; apt-get build-dep owncloud-client``
* openSUSE: ``zypper ref; zypper si -d owncloud-client``
* Fedora/CentOS: ``yum install yum-utils; yum-builddep owncloud-client``
3. Follow the `generic build instructions`_.
@ -33,7 +34,7 @@ Mac OS X
--------
In additon to needing XCode (along with the command line tools), developing in
the MAC OS X environment requires extra dependencies. You can install these
the Mac OS X environment requires extra dependencies. You can install these
dependencies through MacPorts_ or Homebrew_. These dependencies are required
only on the build machine, because non-standard libs are deployed in the app
bundle.

BIN
doc/images/settings_general.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 96 KiB

After

Width:  |  Height:  |  Size: 48 KiB

4
doc/index.rst
View File

@ -1,7 +1,7 @@
.. _contents:
Contents
========
ownCloud Desktop Client Manual
==============================
.. toctree::
:maxdepth: 3

14
doc/installing.rst
View File

@ -1,11 +1,11 @@
Installing the Synchronization Client
=====================================
Installing the Desktop Synchronization Client
=============================================
The latest version of the ownCloud Synchronization Client can be obtained from
the `ownCloud Website <http://www.owncloud.com>`_. You can download and install
the client on Windows, MAC OSX, and various Linux software distrubutions. The
following sections describe specific support and installation procedures for
the different software platforms:
The latest version of the ownCloud Desktop Synchronization Client can be
obtained from the `ownCloud Website <http://www.owncloud.com>`_. You can
download and install the client on Windows, Mac OS X, and various Linux software
distrubutions. The following sections describe specific support and installation
procedures for the different software platforms:
- :ref:`installing-windows`
- :ref:`installing-macosx`

9
doc/introduction.rst
View File

@ -1,14 +1,13 @@
Introduction
============
Available for Windows, MAC OS X, and various Linux distributions, the ownCloud
Sync client is a desktop program installed on your computer. The client enables
you to:
Available for Windows, Mac OS X, and various Linux distributions, the ownCloud
Desktop Sync client enables you to:
- Specify one or more directories on your computer that you want to synchronize
to the ownCloud server.
- Always have the latest files synchronized, wherever they are located.
Changes made to any synchronized file on the computer are automatically made to
the files on the ownCloud server using the sync client.
Your files are always automatically synchronized between your ownCloud server
and local PC.

107
doc/navigating.rst
View File

@ -3,16 +3,21 @@ Using the Synchronization Client
.. index:: navigating, usage
<<<<<<< HEAD
The ownCloud Client remains in the background and is visible as an icon in the
system tray (Windows, KDE), status bar (MAC OS X), or notification area
(Ubuntu).
=======
The ownCloud Desktop Client remains in the background and is visible as an icon
in the system tray (Windows, KDE), status bar (Mac OS X), or notification area
(Linux).
>>>>>>> 096511f... Update and correct desktop client manual
.. image:: images/icon.png
This is a status indicator which uses overlay icons to indicate the
current status of your synchronization. The green circle with the white checkmark
tells you that your synchronization is current and you are connected to your
ownCloud server.
The status indicator uses overlay icons to indicate the current status of your
synchronization. The green circle with the white checkmark tells you that your
synchronization is current and you are connected to your ownCloud server.
.. image:: images/icon-syncing.png
@ -42,7 +47,11 @@ incorrect login or server URL.
Using the Desktop Client Menu
-----------------------------
<<<<<<< HEAD
A right click on the icon (left click on Ubuntu and Mac OS X) provides the
=======
A right-click on the icon opens the
>>>>>>> 096511f... Update and correct desktop client manual
following menu:
.. image:: images/menu.png
@ -51,13 +60,13 @@ following menu:
The Desktop Client menu provides the following options:
* ``Open ownCloud in browser``: Launches the ownCloud WEB interface.
* ``Open folder 'ownCloud'``: Opens the ownCloud local folder. If you have
defined multiple synchronization targets, the window displays each local
folder.
* ``Open ownCloud in browser``: Launches the ownCloud Web interface.
* ``Open folder 'ownCloud'``: Opens your local ownCloud folder. If you have
defined multiple synchronization targets, the window displays each local
folder.
* **Disk space indicator**: Indicates the amount of space currently used on the
server.
* Operation indicator: Displays the status of the current synchronization
* **Operation indicator**: Displays the status of the current synchronization
process or indicates ``Up to date`` if the server and client are in sync.
* **Recent Changes**: Displays the last six files modified by the
synchronization operations and provides access to the current
@ -74,9 +83,15 @@ Using the Account Settings Window
.. index:: account settings, user, password, Server URL
<<<<<<< HEAD
The ``Account`` window provides a summary for general settings associated with
the ownCloud account. This window enalbes you to manage any synchronized
folders in the account and enables you to modify them.
=======
The ``Account`` window provides a summary for your ownCloud account settings.
You can manage which folders and files you want to synchronize, change your
account settings, and pause and resume synchronization.
>>>>>>> 096511f... Update and correct desktop client manual
To access and modify the account settings:
@ -101,20 +116,29 @@ The fields and options in this window include:
root from the synchronization and then add individual folders that you want
to synchronize as desired.
* ``Storage Usage`` field: Indicates the storage utilization on the ownCloud
server.
* ``Storage Usage`` field: Displays how much space your files are using on the
ownCloud server.
* ``Edit Ignored Files`` button: Launches the Ignored Files Editor.
<<<<<<< HEAD
* ``Modify Account`` button: Enables you to change the ownCloud server to which
you are synchronizing. This option launches the ``Setting up an Account``
dialog (see :doc:`accountsetup`).
=======
* ``Modify Account`` button: Use this to change your ownCloud server settings
by launching the account setup wizard (see :doc:`accountsetup`).
>>>>>>> 096511f... Update and correct desktop client manual
Adding a Folder
^^^^^^^^^^^^^^^
<<<<<<< HEAD
The ``Add a Folder ...`` button enables you to add a new folder to the
=======
The ``Add Folder ...`` button enables you to add a new local folder to the
>>>>>>> 096511f... Update and correct desktop client manual
synchronization process.
To add a new folder:
@ -125,11 +149,10 @@ To add a new folder:
.. image:: images/folderwizard_local.png
2. Specify a *unique* path and alias name to the folder or use the ``Choose...``
button to locate the new folder on your system to which you want to
synchronize.
2. Type a *unique* path and alias name to the folder, or use the ``Choose...``
button to open a graphical file picker.
.. note:: Nested synchronizations are not supported. In other words, you
.. note:: Nested synchronizations are not supported. You
cannot add a folder that is already contained within another synchronized
folder. In addition, you cannot add a higher level (parent) folder that
contains a folder to which you are already synchronizing. By default, the
@ -140,12 +163,12 @@ To add a new folder:
3. Click 'Next' to continue.
A window opens prompting you to select a remote destination folder on the
ownCloud server to which you want to synchronize.
ownCloud server to synchronize.
.. image:: images/folderwizard_remote.png
4. Select a folder on the ownCloud server to which you want to synchronize your
newly added folder.
newly added local folder.
..note:: A server folder can only be synchronized with a particular client
once. If you attempt to sync the root directory, you cannot sync with
@ -156,6 +179,7 @@ newly added folder.
Editing Ignored Files
^^^^^^^^^^^^^^^^^^^^^
<<<<<<< HEAD
The :guilabel:`Ignored Files Editor` provides a list of preconfigured files
that are ignored (that is, not synchronized) by the client and server during
synchronizations. The Ignored Files Editor enables you to add patterns for
@ -163,6 +187,15 @@ files or directories that you want to exclude from the synchronization process.
In addition to using standard characters, the Ignored Files Editor enables you
to use wild cards (for example, using an asterisk ‘*’ to indicate multiple
characters or a question mark ‘?’ to incidate a single character).
=======
The :guilabel:`Ignored Files Editor` provides a list of files that are ignored
(that is, not synchronized) by the client and server during synchronizations.
You may add additional files or directories that you want to exclude from the
synchronization process. In addition to using standard characters, the Ignored
Files Editor enables you to use wild cards (for example, using an asterisk ‘*’
to indicate multiple characters or a question mark ‘?’ to incidate a single
character).
>>>>>>> 096511f... Update and correct desktop client manual
For additional information about this editor, see `Using the Ignored Files
Editor`_
@ -192,9 +225,14 @@ Using the General Settings Window
.. index:: general settings, auto start, startup, desktop notifications
<<<<<<< HEAD
The General settings window enables you to set general settings for the
ownCloud Desktop Client and provides information about the software version,
its creator, and the existance of any updates.
=======
The General settings window has options for launching the client at system
startup, notifications, and using monochrome icons.
>>>>>>> 096511f... Update and correct desktop client manual
.. image:: images/settings_general.png
@ -212,7 +250,7 @@ The settings and information contained in this window are as follows:
* ``Use Monochrome Icons`` checkbox: Provides the option to check (enable) or
uncheck (disable) the use of monochrome (visually less obtrusive) icons.
.. note:: This option can be useful on MAC OSX platforms.
.. note:: This option can be useful on Mac OS X platforms.
* ``About`` field: Provides information about the software authors along with
pertinent build conditions.
@ -237,6 +275,7 @@ synchronizations.
Specifying Proxy Settings
^^^^^^^^^^^^^^^^^^^^^^^^^
<<<<<<< HEAD
A proxy server is a server (for example, a computer system or an application)
that functions as an intermediary contact for requests from clients that are
seeking resources from other servers. For the ownCloud Desktop Client, you can
@ -247,22 +286,32 @@ define the following proxy settings:
* ``Use system proxy`` option: Default setting. Follows the systems proxy
settings. On Linux systems, this setting uses the value of the variable
``http_proxy``.
=======
* ``No Proxy`` option: Do not use a proxy.
* ``Use system proxy`` option: Default setting. Follows the systems proxy
settings.
>>>>>>> 096511f... Update and correct desktop client manual
* ``Specify proxy manually as`` option: Enables you to specify
the following custom proxy settings:
- ``HTTP(S)``: Used when you are required to use an HTTP(S) proxy server (for
example, Squid or Microsoft Forefront TMG).
- ``SOCKSv5``: Typically used in special company LAN setups, or in combination
with the OpenSSH
dynamic application level forwarding feature (see ``ssh -D``).
- ``SOCKSv5``: Typically used in special company LAN setups, or in
combination with the OpenSSH dynamic application level forwarding feature
(see ``ssh -D``).
- ``Host``: Host name or IP address of the proxy server along with the port
number. HTTP proxies typically listen over Ports 8080 (default) or 3128.
SOCKS servers typically listen over port 1080.
* ``Proxy Server requires authentication`` checkbox: Provides the option to
check (enable/require) or
uncheck (disable/not require) proxy server authentication. When not checked,
the proxy server must
be configured to allow anonymous usage. When checked, a proxy server username
and password is required.
check (enable/require) or uncheck (disable/not require) proxy server
authentication. When not checked, the proxy server must be configured to
allow anonymous usage. When checked, a proxy server username and password is
required.
Bandwidth Limiting
^^^^^^^^^^^^^^^^^^
@ -306,10 +355,16 @@ Using the Ignored Files Editor
.. index:: ignored files, exclude files, pattern
<<<<<<< HEAD
You might have some files or directories that you do not want to backup and
store on the server. To identify and exclude these files or directories, you
can use the *Ignored Files Editor* that is embedded in the ownCloud Desktop
Client.
=======
You might have some local files or directories that you do not want to backup
and store on the server. To identify and exclude these files or directories, you
can use the *Ignored Files Editor*.
>>>>>>> 096511f... Update and correct desktop client manual
.. image:: images/ignored_files_editor.png

2
doc/options.rst
View File

@ -1,7 +1,7 @@
When invoking the client from the command line, the following options are supported:
``-h``, ``--help``
Displays all the options below or, when used on Windows, opens a window displaying all options.
Displays all command options.
``--logwindow``
Opens a window displaying log output.

13
doc/owncloudcmd.rst
View File

@ -5,11 +5,13 @@ 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
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 the owncloudcmd, you must provide the local and the remote repository
urls using the following command::
To invoke ``owncloudcmd``, you must provide the local and the remote
repository
URL using the following command::
owncloudcmd [OPTIONS...] sourcedir owncloudurl
@ -46,7 +48,12 @@ Other comand line switches supported by owncloudcmd include the following:
Credential Handling
~~~~~~~~~~~~~~~~~~~
<<<<<<< HEAD
By default, owncloudcmd reads the client configuration and uses the credentials
=======
By default, ``owncloudcmd`` reads the client configuration and uses the
credentials
>>>>>>> 096511f... Update and correct desktop client manual
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::

18
doc/troubleshooting.rst
View File

@ -15,21 +15,15 @@ Identifying Basic Functionality Problems
:Performing a general ownCloud Server test:
The first step in troubleshooting synchronization issues is to verify that
you can log on to the ownCloud web application. To verify connectivity to the
ownCloud server:
- Open a browser window and enter the server address to your own server in the location/address bar.
For example, if your ownCloud instance is installed at URL address
``http://yourserver.com/owncloud``, enter ``http://yourserver.com/owncloud/``
into your browsers location/address bar.
ownCloud server try logging in via your Web browser.
If you are not prompted for your username and password, or if a red warning
box appears on the page, your server setup requires modification. Please verify
that your server installation is working correctly.
:Ensure the WebDAV API is working:
If all desktop clients fail to connect to the ownCloud Server, but access
using the web interface functions properly, the problem is often a
using the Web interface functions properly, the problem is often a
misconfiguration of the WebDAV API.
The ownCloud Client uses the built-in WebDAV access of the server content.
@ -49,11 +43,11 @@ Identifying Basic Functionality Problems
:Use a WebDAV command line tool to test:
A more sophisticated test method for troubleshooting synchronization issues
is to use a WebDAV command line client and log into the ownCloud WebDAV server.
One such command line client -- called cadaver -- is available for Linux
One such command line client -- called ``cadaver`` -- is available for Linux
distributions. You can use this application to further verify that the WebDAV
server is running properly using PROPFIND calls.
As an example, after installing the cadaver app, you can issue the
As an example, after installing the ``cadaver`` app, you can issue the
``propget`` command to obtain various properties pertaining to the current
directory and also verify WebDAV server connection.
@ -200,7 +194,7 @@ You can find more information about Apache logging at
Core Dumps
----------
On MAC OS X and Linux systems, and in the unlikely event the client software
On Mac OS X and Linux systems, and in the unlikely event the client software
crashes, the client is able to write a core dump file. Obtaining a core dump
file can assist ownCloud Customer Support tremendously in the debugging
process.