From 79785241ea87f4da34de7c422d942b37eee2ef79 Mon Sep 17 00:00:00 2001 From: Daniel Molkentin Date: Wed, 5 Jun 2013 14:57:32 +0200 Subject: [PATCH] Docs: --logdir replaces --logfile --- doc/install.rst | 2 +- doc/options.rst | 4 ++-- doc/owncloud.1.rst | 2 +- doc/troubleshooting.rst | 9 +++++---- 4 files changed, 9 insertions(+), 8 deletions(-) diff --git a/doc/install.rst b/doc/install.rst index d296dd4ce..965596dd6 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -19,7 +19,7 @@ Mac OS X Installing the ownCloud client on your Mac follows the normal app installation pattern: -1. Download the installation file Click ownCloud-1.1.1.dmg, a window with the +1. Download the installation file Click ownCloud-x.y.z.dmg, a window with the 2. ownCloud icon opens In that window, drag the ownCloud application into the 3. ‘Applications’ folder on the right hand side From ‘Applications’, choose ownCloud diff --git a/doc/options.rst b/doc/options.rst index 3e3c014d0..ce45a0ce2 100644 --- a/doc/options.rst +++ b/doc/options.rst @@ -3,8 +3,8 @@ ownCloud Client supports the following command line switches: ``--logwindow`` open a window to show log output at startup. -``--logfile`` `` - write log output to file. +``--logdir`` `` + write log output to dir, one for each sync run. ``--flushlog`` flush the log file after every write. diff --git a/doc/owncloud.1.rst b/doc/owncloud.1.rst index 4ad0648ed..f65f42a1c 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 it is 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. diff --git a/doc/troubleshooting.rst b/doc/troubleshooting.rst index 06a88a515..325c9a693 100644 --- a/doc/troubleshooting.rst +++ b/doc/troubleshooting.rst @@ -41,7 +41,7 @@ Here are a couple of useful steps to isolate the problem. Logfiles ======== -Doing effective debugging requires to provide as much as relevant logfiles as +Doing effective debugging requires to provide as much as relevant logs as possible. The log output can help you with tracking down problem, and if you report a bug, you're advised to include the output. @@ -57,11 +57,12 @@ starting the client again with this parameter. Syntax: * Mac OS X: ``/Applications/owncloud.app/Contents/MacOS/owncloud --logwindow`` * Linux: ``owncloud --logwindow`` -It is also possible to directly log into a file, which is an useful option +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 logfile than piping the whole log through the log window. +create a huge amount of data, as the log window has a limited buffer. -To create a log file, start the client with ``--logfile ``. +To write logs to disk, start the client with ``--logdir ``, where ```` +is an existing directory. Each sync run will create a new file. :ownCloud server Logfile: The ownCloud server maintains an ownCloud specific logfile as well. It can and