Simplify config read and arguments parsing

[sgblog.git] / README.texi

diff --git a/README.texi b/README.texi
index a0309d81dd4dd38677b4b8b27845d510b8d1e2d1..74480adf2b13b79de2e4a285f63ab67dea1b9748 100644 (file)
--- a/README.texi
+++ b/README.texi
@@ -69,7 +69,7 @@ Comments are posted through the email interface, just by sending the
 message to special address. For example:
 
 @example
-$ mutt "mailto:comment@@blog.example.com?subject=576540a5b98517b46d0efc791bb90b9121bf147e" <<EOF
+$ mutt "mailto:comment@@blog.example.com?subject=BlaBlaBla%20(576540a5b98517b46d0efc791bb90b9121bf147e)" <<EOF
 This is the comments contents.
 Could be multilined of course.
 EOF
@@ -82,11 +82,22 @@ Each comment is just a plaintext with @code{From} and @code{Date}
 headers. @code{From} is a name of email sender (with email address
 stripped off).
 
-Technically comments are stored in concatenated
-@url{https://en.wikipedia.org/wiki/Netstring, netstring}. Only
-@code{text/plain} or @code{multipart/signed+text/plain} email messages
-are accepted and only with UTF-8, US-ASCII, ISO-8859-1 character sets.
-Sane people won't send HTML email anyway, but this is just a precaution.
+Only @code{text/plain} or @code{multipart/signed+text/plain} email
+messages are accepted and only with UTF-8, US-ASCII, ISO-8859-1
+character sets. Sane people won't send HTML email anyway, but this is
+just a precaution.
+
+Comments are stored in @dfn{recfiles} --
+@url{https://www.gnu.org/software/recutils/, GNU recutils}
+human-editable plaintext database format. But they do not contain
+records description:
+
+@verbatim
+%rec: Comment
+%doc: SGBlog's comment
+%mandatory: From Date Body
+%type: Date date
+@end verbatim
 
 @node Topics
 @unnumbered Topics
@@ -118,7 +129,7 @@ CA. So either disable their usage and trust that certificate:
 @code{GOPRIVATE=go.stargrave.org/sgblog}, or clone its source code
 manually and build in place:
 @url{git://git.stargrave.org/sgblog.git},
-@url{https://git.stargrave.org/git/sgblog.git}.
+@url{https://git.stargrave.org/sgblog.git}.
 
 For enabling blog availability you have to use HTTP server with CGI
 interface. Example part of @url{http://www.lighttpd.net/, lighttpd}'s