Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nextcloud/desktop.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorCamila <hello@camila.codes>2020-12-07 16:52:51 +0300
committerCamila <hello@camila.codes>2020-12-07 16:52:51 +0300
commit09c2279bb5b8b5017e95984659f3de496cdcbc4d (patch)
tree8e8006afad96a82baf1c5aba44a578e2fceff316 /doc
parent4886525e08298171d71afc1deac3482d4305d4db (diff)
Update documentation on how to generate debug logs.
Minor change: bypasses => bypass. Signed-off-by: Camila <hello@camila.codes>
Diffstat (limited to 'doc')
-rw-r--r--doc/troubleshooting.rst51
1 files changed, 34 insertions, 17 deletions
diff --git a/doc/troubleshooting.rst b/doc/troubleshooting.rst
index 880aa82e7..f9644db47 100644
--- a/doc/troubleshooting.rst
+++ b/doc/troubleshooting.rst
@@ -153,10 +153,42 @@ Saving Files Directly
The Nextcloud client enables you to save log files directly to a predefined file
or directory. This is a useful option for troubleshooting sporadic issues as
-it enables you to log large amounts of data and bypasses the limited buffer
+it enables you to log large amounts of data and bypass the limited buffer
settings associated with the log window.
-To save log files to a file or a directory:
+To enable logging to a directory, stop the client and add the following to the General section in the configuration file:
+
+```
+[General]
+logDebug=true
+logExpire=<hours>
+logDir=<dir>
+```
+
+ .. note:: Independent of platform you must use slash (/) as a path reparator:
+
+ * Correct: C:/Temp
+ * Not correct: C:\Temp
+
+As an example, to keep log data for two days in a directory called temp:
+
+```
+[General]
+logDebug=true
+logExpire=48
+logDir=C:/Temp
+```
+
+Once you restart the client, you will find the log file in the ``<dir>`` defined in ``logDir``.
+
+ .. note:: You will find the configuration file in the following locations:
+
+ * Microsoft Windows systems: ``%APPDATA%\Nextcloud\nextcloud.cfg``
+ * macOS systems: ``$HOME/Library/Preferences/Nextcloud/nextcloud.cfg``
+ * Linux distributions: ``$HOME/.config/Nextcloud/nextcloud.cfg``
+
+
+Alternatively, you can start the client in the command line with parameters:
1. To save to a file, start the client using the ``--logfile <file>`` command,
where ``<file>`` is the filename to which you want to save the file.
@@ -177,21 +209,6 @@ issue the following command:
nextcloud --logdir /tmp/nextcloud_logs --logexpire 48
```
-Alternatively, you can add the following to the configuration file:
-```
-logDebug=true
-logExpire=<hours>
-logDir=<dir>
-```
-
-Once you restart the client, you will find the log file in the ``<dir>`` defined in ``logDir``.
-
- .. note:: You will find the configuration file in the following locations:
-
- * Microsoft Windows systems: ``%APPDATA%\Nextcloud\nextcloud.cfg``
- * macOS systems: ``$HOME/Library/Preferences/Nextcloud/nextcloud.cfg``
- * Linux distributions: ``$HOME/.config/Nextcloud/nextcloud.cfg``
-
Nextcloud server Log File
~~~~~~~~~~~~~~~~~~~~~~~~~