From 24208e61377b374b4def50eb7c2336cf982c9494 Mon Sep 17 00:00:00 2001 From: Daniel Molkentin Date: Wed, 19 Jun 2013 14:29:28 +0200 Subject: [PATCH 1/9] Remove mirall man page --- doc/conf.py.in | 2 -- doc/mirall.1.rst | 38 -------------------------------------- doc/owncloud.1.rst | 2 +- 3 files changed, 1 insertion(+), 41 deletions(-) delete mode 100644 doc/mirall.1.rst diff --git a/doc/conf.py.in b/doc/conf.py.in index c8d2534ed6..3ef303b20c 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -215,8 +215,6 @@ latex_documents = [ man_pages = [ ('owncloud.1', 'owncloud', u'File synchronisation desktop utility.', [u'The ownCloud developers'], 1), - ('mirall.1', 'mirall', u'File synchronisation desktop utility.', - [u'The ownCloud developers'], 1) ] # If true, show URL addresses after external links. diff --git a/doc/mirall.1.rst b/doc/mirall.1.rst deleted file mode 100644 index 183c68bec5..0000000000 --- a/doc/mirall.1.rst +++ /dev/null @@ -1,38 +0,0 @@ -mirall(1) ---------- - -SYNOPSIS -======== - -*mirall* [`OPTIONS`...] - - -DESCRIPTION -=========== - -mirall is a file synchronisation desktop utility. -It synchronizes files on your local machine with an ownCloud Server. If you -make a change to the files on one computer, it will flow across the others -using this desktop sync clients. - -Normally you start the client by click on the desktop icon or start from the -application menu. After starting an ownCloud icon appears in the system tray. - -Options -======= -.. include:: options.rst - -Config File -=========== -.. include:: conffile.rst - -BUGS -==== - -Please report bugs at https://github.com/owncloud/core/issues. - - -SEE ALSO -======== -`csync(1)`, `mirall(1)` - diff --git a/doc/owncloud.1.rst b/doc/owncloud.1.rst index f65f42a1c2..214e9ec531 100644 --- a/doc/owncloud.1.rst +++ b/doc/owncloud.1.rst @@ -33,5 +33,5 @@ Please report bugs at https://github.com/owncloud/core/issues. SEE ALSO ======== - `csync(1)`, `mirall(1)` + `csync(1)` From fdc811721161e65b7d75211f9da10e28a9b56968 Mon Sep 17 00:00:00 2001 From: Daniel Molkentin Date: Wed, 19 Jun 2013 14:29:56 +0200 Subject: [PATCH 2/9] doc: Fix wording --- doc/owncloud.1.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/owncloud.1.rst b/doc/owncloud.1.rst index 214e9ec531..71a814634f 100644 --- a/doc/owncloud.1.rst +++ b/doc/owncloud.1.rst @@ -9,7 +9,7 @@ SYNOPSIS DESCRIPTION =========== -ownCloud is a file synchronisation desktop utility it is based on mirall. +ownCloud is a file synchronisation desktop utility based on mirall. It synchronizes files on your local machine with an ownCloud Server. If you make a change to the files on one computer, it will flow across the others using this desktop sync clients. From 35a67fab0a068d45c972466189929a5635ee32c7 Mon Sep 17 00:00:00 2001 From: Daniel Molkentin Date: Wed, 19 Jun 2013 15:05:33 +0200 Subject: [PATCH 3/9] Doc: remove now meaningless scentences --- doc/conffile.rst | 5 ----- 1 file changed, 5 deletions(-) diff --git a/doc/conffile.rst b/doc/conffile.rst index 9d7da4a61d..4742ef2437 100644 --- a/doc/conffile.rst +++ b/doc/conffile.rst @@ -16,8 +16,6 @@ It contains settings in the ini file format known from Windows. .. note:: Changes may be overwritten by using ownCloud's configuration dialog. -.. note:: The new version is less precise in this regard. - These are config settings that may be changed: ``remotePollinterval`` (default: ``30000``) @@ -26,6 +24,3 @@ These are config settings that may be changed: ``maxLogLines`` (default: ``20000``) Maximum count of log lines shown in the log window -``remotePollinterval`` - The frequency used for polling for remote changes on the ownCloud Server. - From 22a679fb8cecc9107b2bb034994bb1b86d88d1d9 Mon Sep 17 00:00:00 2001 From: Daniel Molkentin Date: Wed, 19 Jun 2013 15:06:16 +0200 Subject: [PATCH 4/9] Doc: Add back --logfile, as it still exists --- doc/options.rst | 4 +++- doc/troubleshooting.rst | 11 +++++++---- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/doc/options.rst b/doc/options.rst index ce45a0ce2d..b3d38394e1 100644 --- a/doc/options.rst +++ b/doc/options.rst @@ -3,6 +3,9 @@ ownCloud Client supports the following command line switches: ``--logwindow`` open a window to show log output at startup. +``--logfile`` `` + write log output to a single file + ``--logdir`` `` write log output to dir, one for each sync run. @@ -12,4 +15,3 @@ ownCloud Client supports the following command line switches: ``--monoicons`` Use black/white pictograms for systray. - diff --git a/doc/troubleshooting.rst b/doc/troubleshooting.rst index 325c9a6938..17d4ae1465 100644 --- a/doc/troubleshooting.rst +++ b/doc/troubleshooting.rst @@ -61,20 +61,23 @@ It is also possible to directly log to a directory, which is an useful option in case the problem only happens ocassionally. In that case it is better to create a huge amount of data, as the log window has a limited buffer. -To write logs to disk, start the client with ``--logdir ``, where ```` -is an existing directory. Each sync run will create a new file. +To write logs to disk, start the client with ``--logfile ``, where +````, where ```` +is an existing directory. In case of ``--logdir``, each sync run will create a +new file. :ownCloud server Logfile: The ownCloud server maintains an ownCloud specific logfile as well. It can and must be enabled through the ownCloud Administration page. There you can adjust -the loglevel. It is advisable to set it to a verbose level like ``Debug`` or ``Info``. +the loglevel. It is advisable to set it to a verbose level like ``Debug`` or +``Info``. The logfile can be viewed either in the web interface or can be found in the filesystem in the ownCloud server data dir. :Webserver Logfiles: Also, please take a look at your webservers error log file to check if there -are problems. For apache on linux, the error logs usually can be found at +are problems. For Apache on Linux, the error logs usually can be found at ``/var/log/apache2``. A file called ``error_log`` shows errors like PHP code problems. A file called ``access_log`` usually records all requests handled by the server. Especially the access_log is a very good debugging tool as the From 0adbc032aed088bb47d9888004d2c25b7a59bddb Mon Sep 17 00:00:00 2001 From: Daniel Molkentin Date: Wed, 19 Jun 2013 15:06:47 +0200 Subject: [PATCH 5/9] Doc: Expand trouble shooting section --- doc/troubleshooting.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/troubleshooting.rst b/doc/troubleshooting.rst index 17d4ae1465..3985119947 100644 --- a/doc/troubleshooting.rst +++ b/doc/troubleshooting.rst @@ -38,6 +38,19 @@ Here are a couple of useful steps to isolate the problem. ``propget .`` called within cadaver will return some properties of the current directory and thus be a successful WebDAV connect. +If the sync is unreliable, please ensure that the folder synced with ownCloud is +not shared with other syncing apps. Syncing a file with ownCloud and other sync +software such as Unison, rsync, Microsoft Windows Offline Folders or cloud +services such as DropBox or Microsoft SkyDrive is not supported and should not +be attempted. In the worst case, doing so can result in data loss. + +If you are operating your own server and use the local storage backend (the +default), make sure that ownCloud has exclusive access to the directory. The +files must not be modified manually. + +If you are using a different backend, you can try to exclude a bug in the +backend by reverting to the local backend. + Logfiles ======== From 9cd099056b0568932780dd43c18fdce1e28c51ca Mon Sep 17 00:00:00 2001 From: Daniel Molkentin Date: Wed, 19 Jun 2013 15:39:03 +0200 Subject: [PATCH 6/9] Doc: More structure in troubleshooting.rst --- doc/troubleshooting.rst | 36 ++++++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/doc/troubleshooting.rst b/doc/troubleshooting.rst index 3985119947..d54d9fe408 100644 --- a/doc/troubleshooting.rst +++ b/doc/troubleshooting.rst @@ -6,9 +6,10 @@ basic reasons: Either the server setup has a problem or the client has a bug. When reporting bugs, it is crucial to find out what part of the system causes the problem. -Here are a couple of useful steps to isolate the problem. +Identifying basic functionality problems +---------------------------------------- -:A general ownCloud Server test: +:Perform a general ownCloud Server test: A very first check is to verify that you can log on to ownClouds web application. Assuming your ownCloud instance is installed at ``http://yourserver.com/owncloud``, type @@ -18,7 +19,7 @@ Here are a couple of useful steps to isolate the problem. see a red warning box on the page, your server setup is not correct or needs fixes. Please verify that your server installation is working correctly. -:All desktop clients fail to connect to ownCloud: +:Problem: All desktop clients fail to connect to ownCloud: The ownCloud syncing use the built in WebDAV server of ownCloud. Verify that you can log on to ownClouds WebDAV server. Assuming your ownCloud instance is installed at ``http://yourserver.com/owncloud``, type @@ -31,22 +32,30 @@ Here are a couple of useful steps to isolate the problem. :Use a WebDAV command line tool to test: A more sophisticated test is to use a WebDAV command line client and log - into the ownCloud WebDAV server, such as a little app called cadaver, available - on Linux. It can be used to further verify that the WebDAV server is running - properly, for example by performing PROPFIND calls: + into the ownCloud WebDAV server, such as a little app called cadaver, + available on Linux. It can be used to further verify that the WebDAV server is + running properly, for example by performing PROPFIND calls: ``propget .`` called within cadaver will return some properties of the current directory and thus be a successful WebDAV connect. -If the sync is unreliable, please ensure that the folder synced with ownCloud is -not shared with other syncing apps. Syncing a file with ownCloud and other sync -software such as Unison, rsync, Microsoft Windows Offline Folders or cloud -services such as DropBox or Microsoft SkyDrive is not supported and should not -be attempted. In the worst case, doing so can result in data loss. +Isolating other issues +---------------------- + +If the sync result is unreliable, please ensure that the folder synced with +ownCloud is not shared with other syncing apps. + +.. note:: Syncing a directory with ownCloud and other sync software such as + Unison, rsync, Microsoft Windows Offline Folders or cloud services + such as DropBox or Microsoft SkyDrive is not supported and should + not be attempted. In the worst case, doing so can result in data + loss. If you are operating your own server and use the local storage backend (the -default), make sure that ownCloud has exclusive access to the directory. The -files must not be modified manually. +default), make sure that ownCloud has exclusive access to the directory. + +.. note:: The data directory on the server is exclusive to ownCloud and must + not be modified manually. If you are using a different backend, you can try to exclude a bug in the backend by reverting to the local backend. @@ -99,4 +108,3 @@ log line contains a lot of information of every request and it's result. More information about the apache logging can be found at ``http://httpd.apache.org/docs/current/logs.html``. - From bb8b58dc666250b3d212e6bdec8647fcc13daf98 Mon Sep 17 00:00:00 2001 From: Daniel Molkentin Date: Wed, 19 Jun 2013 15:48:04 +0200 Subject: [PATCH 7/9] Doc: more fixes on troubleshooting section --- doc/troubleshooting.rst | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/doc/troubleshooting.rst b/doc/troubleshooting.rst index d54d9fe408..e8dae5274a 100644 --- a/doc/troubleshooting.rst +++ b/doc/troubleshooting.rst @@ -19,8 +19,12 @@ Identifying basic functionality problems see a red warning box on the page, your server setup is not correct or needs fixes. Please verify that your server installation is working correctly. -:Problem: All desktop clients fail to connect to ownCloud: - The ownCloud syncing use the built in WebDAV server of ownCloud. +:Ensure the WebDAV API is working: + If all desktop clients fail to connect to ownCloud, but the access via the + web interface works, the problem often is a mis-configuration of the WebDAV + API. + + The ownCloud client uses the built-in WebDAV access of the server content. Verify that you can log on to ownClouds WebDAV server. Assuming your ownCloud instance is installed at ``http://yourserver.com/owncloud``, type ``http://yourserver.com/owncloud/remote.php/webdav`` into your browsers @@ -45,8 +49,8 @@ Isolating other issues If the sync result is unreliable, please ensure that the folder synced with ownCloud is not shared with other syncing apps. -.. note:: Syncing a directory with ownCloud and other sync software such as - Unison, rsync, Microsoft Windows Offline Folders or cloud services +.. note:: Syncing the same directory with ownCloud and other sync software such + as Unison, rsync, Microsoft Windows Offline Folders or cloud services such as DropBox or Microsoft SkyDrive is not supported and should not be attempted. In the worst case, doing so can result in data loss. From 6e2042cd55f93290da643180eb8549acd84511d8 Mon Sep 17 00:00:00 2001 From: Daniel Molkentin Date: Wed, 19 Jun 2013 16:04:48 +0200 Subject: [PATCH 8/9] Doc: Expand usage page --- doc/usage.rst | 39 +++++++++++++++++++++++++++++++++++---- 1 file changed, 35 insertions(+), 4 deletions(-) diff --git a/doc/usage.rst b/doc/usage.rst index 8752941526..1023f71b54 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -7,11 +7,42 @@ application menu. In the system tray, an ownCloud icon appears. .. index:: start application -A left click on the tray icon open a status dialog which gives an overview on -the configured sync folders and allows to add and remove more sync folder -connections as well as pausing a sync connection. +Overview +-------- -A right click on the tray icon gives other configuration options. +ownCloud is represented by an icon in the Desktop's system tray, also known +as notification area. + +The clients menu is accessed with a right click (Windows, Linux) or left click +(Mac OS). + +The status of the current sync can be observed in the Status dialog, available +trough the ``Open status...`` option. On Windows, a left click on the tray icon +also opens the status dialog. + +.. note:: Until the intial setup has finished, the Connection Wizard will be + shown instead when left-clicking on Windows. + +The dialog provides an overview on the configured sync folders and allows to add +and remove more sync folder connections as well as pausing a sync connection. + +Changing your password +---------------------- + +Use the ``Configure`` option. It will open the Connection Wizard, which next to +reconfiguring your connection to use a different user or server also will allow +to change the password for the local account, or to switch from HTTP to HTTPS. + +Setting up a proxy +------------------ + +By default, the configured system proxy will be picked up. This may not be +working reliable on some Linux distributions, as only the ``http_proxy`` +variable gets parsed. You can configure a proxy different from your +system default by choosing ``Configure proxy...`` from the menu. + +By default, ownCloud expects a HTTP proxy. If you want to specify a SOCKS5 +proxy instead, tick the "Use as SOCKSv5 proxy" option. Options ------- From a441b1d5624d1b9cc1aae20dc881a0c8c4acfc78 Mon Sep 17 00:00:00 2001 From: Daniel Molkentin Date: Wed, 19 Jun 2013 16:07:07 +0200 Subject: [PATCH 9/9] Bump year --- doc/conf.py.in | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/conf.py.in b/doc/conf.py.in index 3ef303b20c..f61376e7c6 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -41,7 +41,7 @@ master_doc = 'index' # General information about the project. project = u'ownCloud Client Manual' -copyright = u'2012, The ownCloud developers' +copyright = u'2013, The ownCloud developers' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -248,7 +248,7 @@ texinfo_documents = [ epub_title = u'ownCloud Client Manual' epub_author = u'The ownCloud developers' epub_publisher = u'The ownCloud developers' -epub_copyright = u'2012, The ownCloud developers' +epub_copyright = u'2013, The ownCloud developers' # The language of the text. It defaults to the language option # or en if the language is not set.