Merge branch 'develop'

[nncp.git] / doc / log.texi

diff --git a/doc/log.texi b/doc/log.texi
index 3b567a0febff5a81b748d88e0f19623ad7897331..9bcff527b69f3a25612fed12449cd5332283b72f 100644 (file)
--- a/doc/log.texi
+++ b/doc/log.texi
@@ -2,7 +2,10 @@
 @unnumbered Log format
 
 Log is a plaintext file with single log entry per line. Lines are "\n"
-separated. Each line has the following format:
+separated. It is not intended to be read by human -- use @ref{nncp-log}
+utility.
+
+Each line has the following format:
 
 @verbatim
 LEVEL | DATETIME | SD | MSG
@@ -16,16 +19,17 @@ I 2017-01-09T08:42:18.990005394Z [sp-infos node="BYRRQUULEHINPKEFN7CHMSHR5I5CK7P
 I 2017-01-09T08:48:59.264847401Z [call-finish duration="10" node="BYRRQUULEHINPKEFN7CHMSHR5I5CK7PMX5HQNCYERTBAR4BOCG6Q" rxbytes="60" rxspeed="60" txbytes="108" txspeed="108"]
 @end verbatim
 
-@table @code
+@table @emph
 @item |
     Space character.
 @item LEVEL
-    Is single character log level. As a rule is is either @code{I}
-    (informational message), or @code{E} (error message).
+    Is single character log level. As a rule is is either @verb{|I|}
+    (informational message), or @verb{|E|} (error message).
 @item DATETIME
-    UTC datetime in RFC 3339 @code{2006-01-02T15:04:05.999999999Z} format.
+    UTC datetime in @url{https://tools.ietf.org/html/rfc339, RFC 3339}
+    @verb{|2006-01-02T15:04:05.999999999Z|} format.
 @item SD
-    Structured data as in RFC 5424.
+    Structured data as in @url{https://tools.ietf.org/html/rfc5424, RFC 5424}.
 @item MSG
     Arbitrary UTF-8 encoded text data.
 @end table