added chapter for log analysis

Signed-off-by: Joerg Seitter <adk@seitter.net>

1 files changed, 21 insertions, 0 deletions

diff --git a/docs/running-openadk.txt b/docs/running-openadk.txt
index dcfd7451d..d9fde48af 100644
--- a/docs/running-openadk.txt
+++ b/docs/running-openadk.txt
@@ -184,3 +184,24 @@ You can change the shell in +make menuconfig+ under +Runtime configuration+. Be
 aware of the fact that the bootup process might use some +mksh+ features to
 speedup the system start. When you change the shell for system +/bin/sh+ the
 slower startup is used as a fallback.
+
+analyzing logs
+~~~~~~~~~~~~~~
+
+Since embedded systems usually avoid writing continously on non-volatile storage
+(to avoid waer-out of the storage device) there are no logfiles under /var/log and
+/var itself is mapped onto a RAM based filesystem. 
+
+Instead the syslog daemon logs into a ciruclar memory
+buffer. The size of the memory buffer is by default 32KiB and can be changed in the 
+busybox configuration.
+
+To access the content of the buffer the +logread+ utility is used to dump the buffer.
+To get a continous output of the logbuffer -f has to be added as option.
+
+---------------------
+Usage: logread [-fF]
+
+-f Output data as log grows
+-F Same as -f, but dump buffer first
+---------------------